3.0.0

.gitlab-ci.yml

@@ -100,10 +100,9 @@ codequality:
   only:
     - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker

package.json

@@ -1,10 +1,11 @@
 {
   "name": "@mojoio/tink",
-  "version": "1.0.10",
+  "version": "3.0.0",
   "private": false,
   "description": "an unofficial api abstraction for tink.com",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
@@ -12,16 +13,17 @@
     "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsbuild": "^2.1.61",
-    "@gitzone/tsbundle": "^1.0.78",
+    "@gitzone/tsbundle": "^1.0.102",
-    "@gitzone/tstest": "^1.0.64",
+    "@gitzone/tstest": "^1.0.70",
     "@pushrocks/qenv": "^4.0.10",
-    "@pushrocks/tapbundle": "^4.0.7",
+    "@pushrocks/tapbundle": "^5.0.3",
-    "@types/node": "^17.0.18",
+    "@types/node": "^17.0.25",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
+    "@pushrocks/smartdelay": "^2.0.13",
     "@pushrocks/smartrequest": "^1.1.56"
   },
   "browserslist": [

readme.md

@@ -28,8 +28,28 @@ Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20W
 Use TypeScript for best inclass intellisense
 
 ```typescript
+// this example assumes toplevel await
 import * as tink from '@mojoio/tink';
 
+const tinkAccount = new TinkAccount('<clientId>', '<clientSecret>');
+const tinkUser = await tinkAccount.createTinkUser('<YourOwnUniqueUserId/externalUserId>');
+const tinkLinkUrl = await tinkUser.getTinkLink('<marketCode like DE>');
+
+// present the link to your user to connect their bank accounts to the tink platform.
+
+const tinkProviderConsents = await tinkUser.getProviderConsents();
+
+for (const providerConsent of tinkProviderConsents) {
+  const bankAccounts = await providerConsent.getBankAccounts();
+  for (const bankAccount of bankAccounts) {
+    const transactions = bankAccount.getTransactions();
+  }
+}
+
+// additional stuff
+const existingTinkUser = await tinkAccount.getUser('<YourOwnUniqueUserId/externalUserId>');
+await existingTinkuser.delete(); // delete the user on the tink platform
+```
 
 ## Contribution
 

test/test.nonci.ts

@@ -3,7 +3,7 @@ import * as qenv from '@pushrocks/qenv';
 
 const testQenv = new qenv.Qenv('./', './.nogit/');
 
-import * as tink from '../ts/index';
+import * as tink from '../ts/index.js';
 
 let tinkTestAccount: tink.TinkAccount;
 
@@ -19,19 +19,21 @@ tap.test('should report tink as healthy', async () => {
   await expectAsync(tinkTestAccount.getTinkHealthyBoolean()).toBeTrue();
 });
 
-tap.test('should create a valid request', async (toolsArg) => {
+tap.test('should create a tink user', async (toolsArg) => {
-  const tinkuser: tink.TinkUser = await tinkTestAccount.getTinkUser("user_1234_abc");
+  await tinkTestAccount.createTinkUser('user_1234_abc');
-  console.log(tinkuser);
-  console.log(await tinkuser.getTinkLinkForMarket()); // defaults to 'DE';
-  console.log(await tinkuser.getProviderConsents())
-  await toolsArg.delayFor(10000);
 })
 
+tap.test('should create a valid request', async (toolsArg) => {
+  const tinkuser: tink.TinkUser = await tinkTestAccount.getTinkUser('user_1234_abc');
+  console.log(tinkuser);
+  console.log(await tinkuser.getTinkLinkForMarket()); // defaults to 'DE';
+  console.log(await tinkuser.getProviderConsents());
+});
+
 tap.test('should delete existing users', async () => {
-  process.exit(0);
   expect(tinkTestAccount).toBeInstanceOf(tink.TinkAccount);
   const tinkUser = new tink.TinkUser(tinkTestAccount, null, 'user_1234_abc');
   await tinkUser.delete();
-})
+});
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@mojoio/tink',
+  version: '3.0.0',
+  description: 'an unofficial api abstraction for tink.com'
+}

ts/index.ts

@@ -1,2 +1,3 @@
-export * from './tink.classes.tinkaccount';
+export * from './tink.classes.tinkaccount.js';
-export * from './tink.classes.tinkuser';
+export * from './tink.classes.tinkuser.js';
+export * from './tink.classes.tinkproviderconsent.js';

ts/tink.classes.tinkaccount.ts

@@ -1,16 +1,16 @@
-import * as plugins from './tink.plugins';
+import * as plugins from './tink.plugins.js';
 
-import { TinkUser } from './tink.classes.tinkuser';
+import { TinkUser } from './tink.classes.tinkuser.js';
 
 export class TinkAccount {
   public clientId: string;
-  private clientSecret: string;
+  private _clientSecret: string;
 
-  private apiBaseUrl: string = 'https://api.tink.com';
+  private _apiBaseUrl: string = 'https://api.tink.com';
 
   constructor(clientIdArg: string, clientSecretArg: string) {
     this.clientId = clientIdArg;
-    this.clientSecret = clientSecretArg;
+    this._clientSecret = clientSecretArg;
   }
 
   public async getTinkHealthyBoolean(): Promise<boolean> {
@@ -26,7 +26,7 @@ export class TinkAccount {
   public async getClientAccessTokenForScope(scopeArg: string): Promise<string> {
     // lets get an accessToken for the request
     const response = await plugins.smartrequest.postFormDataUrlEncoded(
-      `${this.apiBaseUrl}/api/v1/oauth/token`,
+      `${this._apiBaseUrl}/api/v1/oauth/token`,
       {
         keepAlive: false,
       },
@@ -37,7 +37,7 @@ export class TinkAccount {
         },
         {
           key: 'client_secret',
-          content: this.clientSecret,
+          content: this._clientSecret,
         },
         {
           key: 'grant_type',
@@ -65,7 +65,7 @@ export class TinkAccount {
   ) {
     const accessToken = await this.getClientAccessTokenForScope('authorization:grant');
     const response = await plugins.smartrequest.postFormDataUrlEncoded(
-      `${this.apiBaseUrl}/api/v1/oauth/authorization-grant/delegate`,
+      `${this._apiBaseUrl}/api/v1/oauth/authorization-grant/delegate`,
       {
         keepAlive: false,
         headers: {
@@ -107,7 +107,7 @@ export class TinkAccount {
   public async getUserAccessToken(authorizationCode: string): Promise<string> {
     const accessToken = await this.getClientAccessTokenForScope('authorization:grant');
     const response = await plugins.smartrequest.postFormDataUrlEncoded(
-      `${this.apiBaseUrl}/api/v1/oauth/token`,
+      `${this._apiBaseUrl}/api/v1/oauth/token`,
       {
         keepAlive: false,
       },
@@ -122,7 +122,7 @@ export class TinkAccount {
         },
         {
           key: 'client_secret',
-          content: this.clientSecret,
+          content: this._clientSecret,
         },
         {
           key: 'grant_type',
@@ -153,7 +153,7 @@ export class TinkAccount {
     } else {
       console.log('tink is healthy, continuing...');
     }
-    const response = await plugins.smartrequest.request(`${this.apiBaseUrl}${optionsArg.urlArg}`, {
+    const response = await plugins.smartrequest.request(`${this._apiBaseUrl}${optionsArg.urlArg}`, {
       keepAlive: false,
       headers: {
         Authorization: `Bearer ${optionsArg.accessToken}`,

ts/tink.classes.tinkproviderconsent.ts

@@ -1,6 +1,6 @@
-import * as plugins from './tink.plugins';
+import * as plugins from './tink.plugins.js';
 
-import { TinkUser } from './tink.classes.tinkuser';
+import { TinkUser } from './tink.classes.tinkuser.js';
 
 /**
  * a provider consent maps to tinks bank consents
@@ -19,8 +19,8 @@ export class TinkProviderConsent {
       urlArg: '/api/v1/provider-consents',
       accessToken,
       methodArg: 'GET',
-      payloadArg: null
+      payloadArg: null,
-    })
+    });
     console.log(responseData);
     return returnProviderConsents;
   }

ts/tink.classes.tinkuser.ts

@@ -1,7 +1,7 @@
-import * as plugins from './tink.plugins';
+import * as plugins from './tink.plugins.js';
 
-import { TinkAccount } from './tink.classes.tinkaccount';
+import { TinkAccount } from './tink.classes.tinkaccount.js';
-import { TinkProviderConsent } from './tink.classes.tinkproviderconsent';
+import { TinkProviderConsent } from './tink.classes.tinkproviderconsent.js';
 
 export class TinkUser {
   // STATIC
@@ -80,8 +80,6 @@ export class TinkUser {
   public tinkUserId: string;
   public externalUserIdArg: string;
 
-  public authorizationToken: string;
-
   constructor(tinkAccountrefArg: TinkAccount, tinkUserIdArg: string, externalUserIdArg: string) {
     this.tinkAccountRef = tinkAccountrefArg;
     this.tinkUserId = tinkUserIdArg;
@@ -111,13 +109,24 @@ export class TinkUser {
    * gets a tink link that can be used by a user to connect accounts
    * @returns
    */
-  public async getTinkLinkForMarket(countryIdArg: string = 'DE'): Promise<string> {
+  public async getTinkLinkForMarket(linkOptionsArg: {
+    countryId: string;
+    redirectUrl: string;
+    testProviderBool?: boolean;
+  } = {
+    countryId: 'DE',
+    redirectUrl: 'https://console.tink.com/callback',
+    testProviderBool: true
+  }): Promise<string> {
+    if (typeof linkOptionsArg.testProviderBool !== 'boolean') {
+      linkOptionsArg.testProviderBool = false;
+    }
     const authorizationCode = await this.tinkAccountRef.getUserAuthorizationCode(
       this.externalUserIdArg,
       'df05e4b379934cd09963197cc855bfe9', // this is a hardcoded app id for tink link, as recommended by tink.com
       'authorization:read,authorization:grant,credentials:refresh,credentials:read,credentials:write,providers:read,user:read'
     );
-    const tinkLinkUrl = `https://link.tink.com/1.0/business-transactions/connect-accounts?client_id=${'teststate'}&redirect_uri=https://console.tink.com/callback&authorization_code=${authorizationCode}&market=${countryIdArg}`;
+    const tinkLinkUrl = `https://link.tink.com/1.0/business-transactions/connect-accounts?client_id=${'teststate'}&redirect_uri=${linkOptionsArg.redirectUrl}&authorization_code=${authorizationCode}&market=${linkOptionsArg.countryId}&test=${linkOptionsArg.testProviderBool}`;
     return tinkLinkUrl;
   }
 

ts/tink.plugins.ts

@@ -1,6 +1,6 @@
 // @pushrocks scope
+import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartpromise from '@pushrocks/smartpromise';
 
-export {
+export { smartdelay, smartrequest, smartpromise };
-  smartrequest
-}