1.0.16

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@mojoio/tink",
-  "version": "1.0.4",
+  "version": "1.0.16",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@mojoio/tink",
-      "version": "1.0.4",
+      "version": "1.0.16",
       "license": "MIT",
       "dependencies": {
         "@pushrocks/smartrequest": "^1.1.56"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojoio/tink",
-  "version": "1.0.4",
+  "version": "1.0.16",
   "private": false,
   "description": "an unofficial api abstraction for tink.com",
   "main": "dist_ts/index.js",

readme.md

@@ -27,6 +27,32 @@ 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
 
 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). :)

test/test.nonci.ts

@@ -19,8 +19,19 @@ tap.test('should report tink as healthy', async () => {
   await expectAsync(tinkTestAccount.getTinkHealthyBoolean()).toBeTrue();
 });
 
-tap.test('should create a valid request', async () => {
-  await tinkTestAccount.request('', 'POST', '', {});
+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())
+  await toolsArg.delayFor(10000);
+})
+
+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/index.ts

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

ts/tink.classes.tinkaccount.ts

@@ -1,8 +1,13 @@
 import * as plugins from './tink.plugins';
+
+import { TinkUser } from './tink.classes.tinkuser';
+
 export class TinkAccount {
-  private clientId: string;
+  public clientId: string;
   private clientSecret: string;
 
+  private apiBaseUrl: string = 'https://api.tink.com';
+
   constructor(clientIdArg: string, clientSecretArg: string) {
     this.clientId = clientIdArg;
     this.clientSecret = clientSecretArg;
@@ -11,29 +16,20 @@ export class TinkAccount {
   public async getTinkHealthyBoolean(): Promise<boolean> {
     const response = await plugins.smartrequest.request(
       'https://api.tink.com/api/v1/monitoring/healthy',
-      {}
+      {
+        keepAlive: false,
+      }
     );
     return response.body === 'ok';
   }
 
-  // the request method for tink respecting platform specific stuff
-  // e.g. certain headers if needed
-  public async request(
-    urlArg: string,
-    methodArg: 'POST' | 'GET',
-    scopeArg: string,
-    payloadArg: any
-  ) {
-    // check health
-    if (!(await this.getTinkHealthyBoolean())) {
-      throw new Error('TINK is not healthy tight now. Please try again later.');
-    } else {
-      console.log('tink is healthy, continuing...');
-    }
+  public async getClientAccessTokenForScope(scopeArg: string): Promise<string> {
     // lets get an accessToken for the request
     const response = await plugins.smartrequest.postFormDataUrlEncoded(
-      'https://api.tink.com/api/v1/oauth/token',
-      {},
+      `${this.apiBaseUrl}/api/v1/oauth/token`,
+      {
+        keepAlive: false,
+      },
       [
         {
           key: 'client_id',
@@ -49,11 +45,134 @@ export class TinkAccount {
         },
         {
           key: 'scope',
-          content: 'user:read',
+          content: scopeArg,
         },
       ]
     );
+    if (response.statusCode !== 200) {
+      console.log(response.statusCode);
+      console.log(response.body);
+      throw new Error('there was an error aquiring an access token.');
+    }
+    const clientAccessToken = response.body.access_token;
+    return clientAccessToken;
+  }
+
+  public async getUserAuthorizationCode(
+    externalUserIdArg: string,
+    actorCLientIdArg: string,
+    scopeArg: string
+  ) {
+    const accessToken = await this.getClientAccessTokenForScope('authorization:grant');
+    const response = await plugins.smartrequest.postFormDataUrlEncoded(
+      `${this.apiBaseUrl}/api/v1/oauth/authorization-grant/delegate`,
+      {
+        keepAlive: false,
+        headers: {
+          Authorization: `Bearer ${accessToken}`,
+        },
+      },
+      [
+        {
+          key: 'response_type',
+          content: 'code',
+        },
+        {
+          key: 'actor_client_id',
+          content: actorCLientIdArg,
+        },
+        {
+          key: 'external_user_id',
+          content: externalUserIdArg,
+        },
+        {
+          key: 'id_hint',
+          content: 'Hello there',
+        },
+        {
+          key: 'scope',
+          content: scopeArg,
+        },
+      ]
+    );
+
+    if (response.statusCode !== 200) {
+      console.log(response.body);
+      throw new Error('there was an error aquiring an access token.');
+    }
+    const userAuthorizationCode = response.body.code;
+    return userAuthorizationCode;
+  }
+
+  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`,
+      {
+        keepAlive: false,
+      },
+      [
+        {
+          key: 'code',
+          content: authorizationCode,
+        },
+        {
+          key: 'client_id',
+          content: this.clientId,
+        },
+        {
+          key: 'client_secret',
+          content: this.clientSecret,
+        },
+        {
+          key: 'grant_type',
+          content: 'authorization_code',
+        },
+      ]
+    );
+
+    if (response.statusCode !== 200) {
+      console.log(response.body);
+      throw new Error('there was an error aquiring an access token.');
+    }
+    const userAccessToken = response.body.access_token;
+    return userAccessToken;
+  }
+
+  // the request method for tink respecting platform specific stuff
+  // e.g. certain headers if needed
+  public async request(optionsArg: {
+    urlArg: string;
+    methodArg: 'POST' | 'GET';
+    accessToken: string;
+    payloadArg: any;
+  }) {
+    // check health
+    if (!(await this.getTinkHealthyBoolean())) {
+      throw new Error('TINK is not healthy right now. Please try again later.');
+    } else {
+      console.log('tink is healthy, continuing...');
+    }
+    const response = await plugins.smartrequest.request(`${this.apiBaseUrl}${optionsArg.urlArg}`, {
+      keepAlive: false,
+      headers: {
+        Authorization: `Bearer ${optionsArg.accessToken}`,
+        'Content-Type': 'application/json',
+      },
+      method: optionsArg.methodArg,
+      requestBody: JSON.stringify(optionsArg.payloadArg),
+    });
     console.log(response.statusCode);
-    console.log(response.body);
+    return response.body;
+  }
+
+  public async getTinkUser(externalUserIdArg: string) {
+    const tinkuser = await TinkUser.getTinkUser(this, externalUserIdArg);
+    return tinkuser;
+  }
+
+  public async createTinkUser(externalUserIdArg: string) {
+    const tinkuser = await TinkUser.createNewTinkUser(this, externalUserIdArg);
+    return tinkuser;
   }
 }

ts/tink.classes.tinkproviderconsent.ts

@@ -0,0 +1,30 @@
+import * as plugins from './tink.plugins';
+
+import { TinkUser } from './tink.classes.tinkuser';
+
+/**
+ * a provider consent maps to tinks bank consents
+ */
+export class TinkProviderConsent {
+  // STATIC
+  public static async getProviderConsentsForUser(tinkUserRefArg: TinkUser) {
+    const returnProviderConsents: TinkProviderConsent[] = [];
+    const authorizationCode = await tinkUserRefArg.tinkAccountRef.getUserAuthorizationCode(
+      tinkUserRefArg.externalUserIdArg,
+      tinkUserRefArg.tinkAccountRef.clientId,
+      'accounts:read,balances:read,transactions:read,provider-consents:read'
+    );
+    const accessToken = await tinkUserRefArg.tinkAccountRef.getUserAccessToken(authorizationCode);
+    const responseData = await tinkUserRefArg.tinkAccountRef.request({
+      urlArg: '/api/v1/provider-consents',
+      accessToken,
+      methodArg: 'GET',
+      payloadArg: null
+    })
+    console.log(responseData);
+    return returnProviderConsents;
+  }
+
+  // INSTANCE
+  constructor(tinkUserRefArg: TinkUser) {}
+}

ts/tink.classes.tinkuser.ts

@@ -1 +1,127 @@
-import * as plugins from './tink.plugins';
+import * as plugins from './tink.plugins';
+
+import { TinkAccount } from './tink.classes.tinkaccount';
+import { TinkProviderConsent } from './tink.classes.tinkproviderconsent';
+
+export class TinkUser {
+  // STATIC
+  public static async createNewTinkUser(tinkAccountArg: TinkAccount, externalUserIdArg: string) {
+    const accessToken = await tinkAccountArg.getClientAccessTokenForScope('user:create');
+    const responseData: {
+      external_user_id: string;
+      user_id: string;
+    } = await tinkAccountArg.request({
+      urlArg: '/api/v1/user/create',
+      accessToken,
+      methodArg: 'POST',
+      payloadArg: {
+        external_user_id: externalUserIdArg,
+        market: 'DE',
+        locale: 'en_US',
+      },
+    });
+
+    const newTinkUser = await TinkUser.getTinkUser(tinkAccountArg, externalUserIdArg);
+    return newTinkUser;
+  }
+
+  public static async getTinkUser(tinkAccountArg: TinkAccount, externalUserIdArg: string) {
+    const authorizationCode = await tinkAccountArg.getUserAuthorizationCode(
+      externalUserIdArg,
+      tinkAccountArg.clientId,
+      'user:read'
+    );
+    const accessToken = await tinkAccountArg.getUserAccessToken(authorizationCode);
+    const responseData: {
+      appId: string;
+      created: string;
+      externalUserId: string;
+      flags: string[];
+      id: string;
+      nationalId: string;
+      profile: {
+        // cashbackEnabled: boolean; // deprecated
+        currency: string;
+        locale: string;
+        market: string;
+        notificationSettings: {
+          balance: boolean;
+          budget: boolean;
+          doubleCharge: boolean;
+          einvoices: boolean;
+          fraud: boolean;
+          income: boolean;
+          largeExpense: boolean;
+          leftToSpend: boolean;
+          loanUpdate: boolean;
+          summaryMonthly: boolean;
+          summaryWeekly: boolean;
+          transaction: boolean;
+          unusualAccount: boolean;
+          unusualCategory: boolean;
+        };
+        periodAdjustedDay: 25;
+        periodMode: 'MONTHLY_ADJUSTED' | 'MONTHLY';
+        timeZone: string;
+      };
+      // username: string; // not relevant
+    } = await tinkAccountArg.request({
+      urlArg: '/api/v1/user',
+      accessToken,
+      methodArg: 'GET',
+      payloadArg: null,
+    });
+    const newTinkUser = new TinkUser(tinkAccountArg, responseData.id, responseData.externalUserId);
+    return newTinkUser;
+  }
+
+  // INSTANCE
+  public tinkAccountRef: TinkAccount;
+  public tinkUserId: string;
+  public externalUserIdArg: string;
+
+  constructor(tinkAccountrefArg: TinkAccount, tinkUserIdArg: string, externalUserIdArg: string) {
+    this.tinkAccountRef = tinkAccountrefArg;
+    this.tinkUserId = tinkUserIdArg;
+    this.externalUserIdArg = externalUserIdArg;
+  }
+
+  /**
+   * deletes the user
+   */
+  public async delete() {
+    const authorizationCode = await this.tinkAccountRef.getUserAuthorizationCode(
+      this.externalUserIdArg,
+      this.tinkAccountRef.clientId,
+      'user:delete'
+    );
+    const accessToken = await this.tinkAccountRef.getUserAccessToken(authorizationCode);
+    const response = await this.tinkAccountRef.request({
+      methodArg: 'POST',
+      accessToken,
+      payloadArg: {},
+      urlArg: '/api/v1/user/delete',
+    });
+    console.log(`successfully deleted user with externalId ${this.externalUserIdArg}`);
+  }
+
+  /**
+   * gets a tink link that can be used by a user to connect accounts
+   * @returns
+   */
+  public async getTinkLinkForMarket(countryIdArg: string = 'DE'): Promise<string> {
+    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}`;
+    return tinkLinkUrl;
+  }
+
+  public async getProviderConsents(): Promise<TinkProviderConsent[]> {
+    const providerConsents: TinkProviderConsent[] =
+      await TinkProviderConsent.getProviderConsentsForUser(this);
+    return providerConsents;
+  }
+}