Compare commits

..

20 Commits

Author SHA1 Message Date
5abc4e7976 1.0.22 2020-08-25 12:57:15 +00:00
58f4855cb6 fix(core): update 2020-08-25 12:57:14 +00:00
c34846c82f 1.0.21 2020-08-21 01:37:32 +00:00
2656f1a9a9 fix(core): update 2020-08-21 01:37:31 +00:00
e63d24eb13 1.0.20 2020-08-21 01:33:31 +00:00
f0e27bf7c8 fix(core): update 2020-08-21 01:33:30 +00:00
282d2bdf24 1.0.19 2020-08-21 01:31:49 +00:00
04cb6f042f fix(core): update 2020-08-21 01:31:49 +00:00
423bd22903 1.0.18 2020-08-20 01:20:16 +00:00
5295bf272e fix(core): update 2020-08-20 01:20:15 +00:00
752c585e26 1.0.17 2020-08-20 01:08:06 +00:00
a3bfd49d6e fix(core): update 2020-08-20 01:08:05 +00:00
838de2b8bc 1.0.16 2020-06-20 01:47:53 +00:00
01dbf842e9 fix(core): update 2020-06-20 01:47:53 +00:00
9fbaac20d3 1.0.15 2019-12-15 23:07:47 +00:00
270d1406c5 fix(transactions): enter a starting transaction 2019-12-15 23:07:46 +00:00
3cec57e3e7 1.0.14 2019-12-15 17:21:55 +00:00
cebb8a5555 fix(core): update 2019-12-15 17:21:54 +00:00
c3f60959c4 1.0.13 2019-12-15 17:21:24 +00:00
dc97525de6 fix(core): update 2019-12-15 17:21:23 +00:00
14 changed files with 10301 additions and 684 deletions

4
.gitignore vendored
View File

@ -15,8 +15,6 @@ node_modules/
# builds # builds
dist/ dist/
dist_web/ dist_*/
dist_serve/
dist_ts_web/
# custom # custom

View File

@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache: cache:
paths: paths:
- .npmci_cache/ - .npmci_cache/
key: "$CI_BUILD_STAGE" key: '$CI_BUILD_STAGE'
stages: stages:
- security - security
- test - test
- release - release
- metadata - metadata
# ==================== # ====================
# security stage # security stage
@ -18,21 +18,36 @@ stages:
mirror: mirror:
stage: security stage: security
script: script:
- npmci git mirror - npmci git mirror
only:
- tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
snyk: auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci npm prepare
- npmci command npm install -g snyk - npmci command npm install --production --ignore-scripts
- npmci command npm install --ignore-scripts - npmci command npm config set registry https://registry.npmjs.org
- npmci command snyk test - npmci command npm audit --audit-level=high --only=prod --production
tags: tags:
- docker - docker
- notpriv
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ==================== # ====================
# test stage # test stage
@ -41,37 +56,36 @@ snyk:
testStable: testStable:
stage: test stage: test
script: script:
- npmci npm prepare - npmci npm prepare
- npmci node install stable - npmci node install stable
- npmci npm install - npmci npm install
- npmci npm test - npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- priv
testBuild: testBuild:
stage: test stage: test
script: script:
- npmci npm prepare - npmci npm prepare
- npmci node install stable - npmci node install stable
- npmci npm install - npmci npm install
- npmci command npm run build - npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- notpriv
release: release:
stage: release stage: release
script: script:
- npmci node install stable - npmci node install stable
- npmci npm publish - npmci npm publish
only: only:
- tags - tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
# ==================== # ====================
# metadata stage # metadata stage
@ -79,35 +93,39 @@ release:
codequality: codequality:
stage: metadata stage: metadata
allow_failure: true allow_failure: true
only:
- tags
script: script:
- npmci command npm install -g tslint typescript - npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install - npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts" - npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags: tags:
- docker - lossless
- priv - docker
- priv
trigger: trigger:
stage: metadata stage: metadata
script: script:
- npmci trigger - npmci trigger
only: only:
- tags - tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
pages: pages:
image: hosttoday/ht-docker-dbase:npmci
services:
- docker:stable-dind
stage: metadata stage: metadata
script: script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc - npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci npm install
- npmci command tsdoc - npmci command tsdoc
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
only: only:
@ -115,5 +133,5 @@ pages:
artifacts: artifacts:
expire_in: 1 week expire_in: 1 week
paths: paths:
- public - public
allow_failure: true allow_failure: true

View File

@ -11,7 +11,13 @@
}, },
"gitzone": { "gitzone": {
"type": "object", "type": "object",
"description": "settings for gitzone" "description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm", "wcc"]
}
}
} }
} }
} }

View File

@ -1,5 +1,6 @@
{ {
"gitzone": { "gitzone": {
"projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "mojoio", "gitscope": "mojoio",
@ -14,4 +15,4 @@
"npmGlobalTools": [], "npmGlobalTools": [],
"npmAccessLevel": "public" "npmAccessLevel": "public"
} }
} }

10671
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,10 +1,10 @@
{ {
"name": "@mojoio/bunq", "name": "@mojoio/bunq",
"version": "1.0.12", "version": "1.0.22",
"private": false, "private": false,
"description": "a bunq api abstraction package", "description": "a bunq api abstraction package",
"main": "dist/index.js", "main": "dist_ts/index.js",
"typings": "dist/index.d.ts", "typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
@ -13,19 +13,34 @@
"format": "(gitzone format)" "format": "(gitzone format)"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.0.22", "@gitzone/tsbuild": "^2.1.25",
"@gitzone/tstest": "^1.0.15", "@gitzone/tstest": "^1.0.44",
"@pushrocks/qenv": "^4.0.6", "@pushrocks/qenv": "^4.0.10",
"@pushrocks/tapbundle": "^3.0.7", "@pushrocks/tapbundle": "^3.2.9",
"@types/node": "^10.11.7", "@types/node": "^14.6.0",
"tslint": "^5.11.0", "tslint": "^6.1.3",
"tslint-config-prettier": "^1.15.0" "tslint-config-prettier": "^1.15.0"
}, },
"dependencies": { "dependencies": {
"@bunq-community/bunq-js-client": "^0.42.1", "@bunq-community/bunq-js-client": "^1.1.2",
"@pushrocks/smartcrypto": "^1.0.9", "@pushrocks/smartcrypto": "^1.0.9",
"@pushrocks/smartfile": "^7.0.6", "@pushrocks/smartfile": "^8.0.0",
"@pushrocks/smartpromise": "^3.0.6", "@pushrocks/smartpromise": "^3.0.6",
"json-store": "^1.0.0" "json-store": "^1.0.0"
} },
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
]
} }

39
readme.md Normal file
View File

@ -0,0 +1,39 @@
# @mojoio/bunq
a bunq api abstraction package
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/bunq)
* [gitlab.com (source)](https://gitlab.com/mojoio/bunq)
* [github.com (source mirror)](https://github.com/mojoio/bunq)
* [docs (typedoc)](https://mojoio.gitlab.io/bunq/)
## Status for master
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/mojoio/bunq/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/mojoio/bunq/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@mojoio/bunq)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/mojoio/bunq)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@mojoio/bunq)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@mojoio/bunq)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@mojoio/bunq)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage
Use Typescript for best in class intellisense.
## Contribution
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

View File

@ -9,7 +9,7 @@ let testBunqAccount: bunq.BunqAccount;
const testBunqOptions: bunq.IBunqConstructorOptions = { const testBunqOptions: bunq.IBunqConstructorOptions = {
apiKey: testQenv.getEnvVarOnDemand('BUNQ_APIKEY'), apiKey: testQenv.getEnvVarOnDemand('BUNQ_APIKEY'),
deviceName: 'mojoiobunqpackage', deviceName: 'mojoiobunqpackage',
environment: 'SANDBOX' environment: 'SANDBOX',
}; };
tap.test('should create a valid bunq account', async () => { tap.test('should create a valid bunq account', async () => {
@ -36,6 +36,6 @@ tap.test('should get transactions', async () => {
tap.test('should stop the instance', async () => { tap.test('should stop the instance', async () => {
await testBunqAccount.stop(); await testBunqAccount.stop();
}) });
tap.start(); tap.start();

View File

@ -1,6 +1,6 @@
import * as plugins from './bunq.plugins'; import * as plugins from './bunq.plugins';
import * as paths from './bunq.paths'; import * as paths from './bunq.paths';
import { MonetaryAccount } from './bunq.classes.monetaryaccount'; import { BunqMonetaryAccount } from './bunq.classes.monetaryaccount';
export interface IBunqConstructorOptions { export interface IBunqConstructorOptions {
deviceName: string; deviceName: string;
@ -37,13 +37,17 @@ export class BunqAccount {
await plugins.smartfile.fs.ensureFile(paths.bunqJsonProductionFile, '{}'); await plugins.smartfile.fs.ensureFile(paths.bunqJsonProductionFile, '{}');
await plugins.smartfile.fs.ensureFile(paths.bunqJsonSandboxFile, '{}'); await plugins.smartfile.fs.ensureFile(paths.bunqJsonSandboxFile, '{}');
let apiKey: string; let apiKey: string;
if (this.options.environment === 'SANDBOX') { if (this.options.environment === 'SANDBOX') {
this.bunqJSClient = new plugins.bunqCommunityClient.default(plugins.JSONFileStore(paths.bunqJsonSandboxFile)); this.bunqJSClient = new plugins.bunqCommunityClient.default(
plugins.JSONFileStore(paths.bunqJsonSandboxFile)
);
apiKey = await this.bunqJSClient.api.sandboxUser.post(); apiKey = await this.bunqJSClient.api.sandboxUser.post();
console.log(apiKey); console.log(apiKey);
} else { } else {
this.bunqJSClient = new plugins.bunqCommunityClient.default(plugins.JSONFileStore(paths.bunqJsonProductionFile)); this.bunqJSClient = new plugins.bunqCommunityClient.default(
plugins.JSONFileStore(paths.bunqJsonProductionFile)
);
apiKey = this.options.apiKey; apiKey = this.options.apiKey;
} }
@ -73,6 +77,8 @@ export class BunqAccount {
const users = await this.bunqJSClient.api.user.list(); const users = await this.bunqJSClient.api.user.list();
if (users.UserPerson) { if (users.UserPerson) {
this.userId = users.UserPerson.id; this.userId = users.UserPerson.id;
} else if (users.UserApiKey) {
this.userId = users.UserApiKey.id;
} else if (users.UserCompany) { } else if (users.UserCompany) {
this.userId = users.UserCompany.id; this.userId = users.UserCompany.id;
} else { } else {
@ -81,18 +87,25 @@ export class BunqAccount {
} }
public async getAccounts() { public async getAccounts() {
const apiMonetaryAccounts = await this.bunqJSClient.api.monetaryAccount.list(this.userId); const apiMonetaryAccounts = await this.bunqJSClient.api.monetaryAccount
const accountsArray: MonetaryAccount[] = []; .list(this.userId, {})
.catch((e) => {
console.log(e);
});
const accountsArray: BunqMonetaryAccount[] = [];
for (const apiAccount of apiMonetaryAccounts) { for (const apiAccount of apiMonetaryAccounts) {
accountsArray.push(MonetaryAccount.fromAPIObject(this, apiAccount)); accountsArray.push(BunqMonetaryAccount.fromAPIObject(this, apiAccount));
} }
return accountsArray; return accountsArray;
} }
/**
* stops the instance
*/
public async stop() { public async stop() {
if (this.bunqJSClient) { if (this.bunqJSClient) {
this.bunqJSClient.setKeepAlive(false); this.bunqJSClient.setKeepAlive(false);
this.bunqJSClient.destroyApiSession(); await this.bunqJSClient.destroyApiSession();
this.bunqJSClient = null; this.bunqJSClient = null;
} }
} }

View File

@ -1,13 +1,13 @@
import * as plugins from './bunq.plugins'; import * as plugins from './bunq.plugins';
import { BunqAccount } from './bunq.classes.account'; import { BunqAccount } from './bunq.classes.account';
import { Transaction } from './bunq.classes.transaction'; import { BunqTransaction } from './bunq.classes.transaction';
export type TAccountType = 'joint' | 'savings' | 'bank'; export type TAccountType = 'joint' | 'savings' | 'bank';
/** /**
* a monetary account * a monetary account
*/ */
export class MonetaryAccount { export class BunqMonetaryAccount {
public static fromAPIObject(bunqAccountRef: BunqAccount, apiObject: any) { public static fromAPIObject(bunqAccountRef: BunqAccount, apiObject: any) {
const newMonetaryAccount = new this(bunqAccountRef); const newMonetaryAccount = new this(bunqAccountRef);
@ -32,7 +32,7 @@ export class MonetaryAccount {
throw new Error('unknown accoun type'); throw new Error('unknown accoun type');
} }
Object.assign(newMonetaryAccount, apiObject[accessor], {type}); Object.assign(newMonetaryAccount, apiObject[accessor], { type });
return newMonetaryAccount; return newMonetaryAccount;
} }
@ -82,7 +82,6 @@ export class MonetaryAccount {
public auto_save_id: null; public auto_save_id: null;
public all_auto_save_id: any[]; public all_auto_save_id: any[];
public bunqAccountRef: BunqAccount; public bunqAccountRef: BunqAccount;
constructor(bunqAccountRefArg: BunqAccount) { constructor(bunqAccountRefArg: BunqAccount) {
this.bunqAccountRef = bunqAccountRefArg; this.bunqAccountRef = bunqAccountRefArg;
@ -91,11 +90,24 @@ export class MonetaryAccount {
/** /**
* gets all transactions no this account * gets all transactions no this account
*/ */
public async getTransactions() { public async getTransactions(startingIdArg: number | false = false) {
const apiTransactions = await this.bunqAccountRef.bunqJSClient.api.payment.list(this.bunqAccountRef.userId, this.id); const paginationOptions: {
const transactionsArray: Transaction[] = []; count?: number;
newer_id?: number | false;
older_id?: number | false;
} = {
count: 200,
newer_id: startingIdArg,
};
const apiTransactions = await this.bunqAccountRef.bunqJSClient.api.payment.list(
this.bunqAccountRef.userId,
this.id,
paginationOptions
);
const transactionsArray: BunqTransaction[] = [];
for (const apiTransaction of apiTransactions) { for (const apiTransaction of apiTransactions) {
transactionsArray.push(Transaction.fromApiObject(this, apiTransaction)); transactionsArray.push(BunqTransaction.fromApiObject(this, apiTransaction));
} }
return transactionsArray; return transactionsArray;
} }

View File

@ -1,14 +1,13 @@
import * as plugins from './bunq.plugins'; import * as plugins from './bunq.plugins';
import { MonetaryAccount } from './bunq.classes.monetaryaccount'; import { BunqMonetaryAccount } from './bunq.classes.monetaryaccount';
export class Transaction { export class BunqTransaction {
public static fromApiObject(monetaryAccountRefArg: MonetaryAccount, apiObjectArg: any) { public static fromApiObject(monetaryAccountRefArg: BunqMonetaryAccount, apiObjectArg: any) {
const newTransaction = new this(monetaryAccountRefArg); const newTransaction = new this(monetaryAccountRefArg);
Object.assign(newTransaction, apiObjectArg); Object.assign(newTransaction, apiObjectArg.Payment);
return newTransaction; return newTransaction;
} }
public id: number; public id: number;
public created: string; public created: string;
public updated: string; public updated: string;
@ -21,7 +20,31 @@ export class Transaction {
public type: 'MASTERCARD' | 'BUNQ'; public type: 'MASTERCARD' | 'BUNQ';
public merchant_reference: null; public merchant_reference: null;
public alias: [Object]; public alias: [Object];
public counterparty_alias: [Object]; public counterparty_alias: {
iban: string,
is_light: any,
display_name: string,
avatar: {
uuid: string,
image: [
{
attachment_public_uuid: string,
height: number,
width: number,
content_type: string,
},
],
anchor_uuid: null,
},
label_user: {
uuid: null,
display_name: string,
country: string,
avatar: null,
public_nick_name: string,
},
country: string,
};
public attachment: []; public attachment: [];
public geolocation: null; public geolocation: null;
public batch_id: null; public batch_id: null;
@ -36,10 +59,9 @@ export class Transaction {
value: string; value: string;
}; };
public monetaryAccountRef: MonetaryAccount; public monetaryAccountRef: BunqMonetaryAccount;
constructor(monetaryAccountRefArg: MonetaryAccount) { constructor(monetaryAccountRefArg: BunqMonetaryAccount) {
this.monetaryAccountRef = monetaryAccountRefArg; this.monetaryAccountRef = monetaryAccountRefArg;
} }
}
}

View File

@ -4,4 +4,4 @@ export const packageDir = plugins.path.join(__dirname, '../');
export const nogitDir = plugins.path.join(packageDir, './.nogit/'); export const nogitDir = plugins.path.join(packageDir, './.nogit/');
export const bunqJsonProductionFile = plugins.path.join(nogitDir, 'bunqproduction.json'); export const bunqJsonProductionFile = plugins.path.join(nogitDir, 'bunqproduction.json');
export const bunqJsonSandboxFile = plugins.path.join(nogitDir, 'bunqsandbox.json'); export const bunqJsonSandboxFile = plugins.path.join(nogitDir, 'bunqsandbox.json');

View File

@ -1,23 +1,17 @@
// node natice // node natice
import * as path from 'path'; import * as path from 'path';
export { export { path };
path
};
// @pushrocks scope // @pushrocks scope
import * as smartcrypto from '@pushrocks/smartcrypto'; import * as smartcrypto from '@pushrocks/smartcrypto';
import * as smartfile from '@pushrocks/smartfile'; import * as smartfile from '@pushrocks/smartfile';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@pushrocks/smartpromise';
export { export { smartcrypto, smartfile, smartpromise };
smartcrypto,
smartfile,
smartpromise,
};
// third party // third party
import JSONFileStore from "@bunq-community/bunq-js-client/dist/Stores/JSONFileStore"; import JSONFileStore from '@bunq-community/bunq-js-client/dist/Stores/JSONFileStore';
import * as bunqCommunityClient from '@bunq-community/bunq-js-client'; import * as bunqCommunityClient from '@bunq-community/bunq-js-client';
export { JSONFileStore, bunqCommunityClient }; export { JSONFileStore, bunqCommunityClient };

View File

@ -1 +1,3 @@
export * from './bunq.classes.account'; export * from './bunq.classes.account';
export * from './bunq.classes.monetaryaccount';
export * from './bunq.classes.transaction';