OBP-TypeScript scripts

Author: mark-tesobe

.eslintrc.cjs

@@ -0,0 +1,16 @@
+module.exports = {
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint", "eslint-plugin-tsdoc"],
+  root: true,
+  rules: {
+    "@typescript-eslint/no-namespace": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    semi: [2, "always"],
+    quotes: [2, "double", { avoidEscape: true }],
+  },
+  plugins: ["jest"],
+  env: {
+    "jest/globals": true,
+  },
+};

.gitignore

@@ -0,0 +1,4 @@
+/config.json
+/node_modules
+/dist
+yarn-error.log

.prettierignore

@@ -0,0 +1,3 @@
+dist
+node_modules
+docs

.prettierrc.json

@@ -0,0 +1,80 @@
+# obp-sdk-ts
+
+## Usage
+
+#### Symlink
+
+Checkout the obp-sdk-ts library from https://github.com/mark-tesobe/OBP-SDK.
+Inside the obp-sdk repository folder, execute the **yarn link** command.
+
+```
+  yarn link
+```
+
+To link the **obp-sdk-ts** library into your app, run the command inside your app.
+
+```
+  yarn link obp-sdk-ts
+```
+
+#### Example
+
+```typescript
+import {
+  API,
+  APIClientConfig,
+  DirectLoginAuthentication,
+  Version,
+  get,
+  create,
+  Bank,
+  Account,
+  Transaction,
+  GetTransactionsForAccountFull,
+  TransactionRequestAccountBody,
+  CreateTransactionRequestAccount,
+} from "obp-sdk-ts/src";
+
+(async () => {
+  const directLogin: DirectLoginAuthentication = {
+    username: process.env.OBP_USERNAME || "",
+    password: process.env.OBP_PASSWORD || "",
+    consumerKey: process.env.OBP_CONSUMER_KEY || "",
+  };
+  const clientConfig: APIClientConfig = {
+    baseUri: "https://apisandbox.openbankproject.com",
+    version: Version.v500,
+    authentication: directLogin,
+  };
+  const banks = await get<API.Bank>(clientConfig, Bank);
+  const account = await get<API.Account>(clientConfig, Account);
+
+  const transactionFn = get<API.Transaction>(clientConfig, Transaction);
+  // Get transaction for account full.
+  const transactionsForAccountFull = await transactionFn(
+    GetTransactionsForAccountFull
+  )("bankId", "accountId", "viewId");
+
+  // New transaction body.
+  const body: TransactionRequestAccountBody = {
+    description: "Dummy transaction full data",
+    to: {
+      bank_id: "bankId",
+      account_id: "accountId",
+    },
+    value: {
+      currency: "EUR",
+      amount: 1.0,
+    },
+  };
+  // Create transaction request account.
+  await create<API.Transaction>(
+    clientConfig,
+    Transaction
+  )(CreateTransactionRequestAccount)(
+    "bankId",
+    "accountId",
+    "viewId"
+  )(body);
+})();
+```

README.md

@@ -0,0 +1,55 @@
+import { describe, test, expect } from "@jest/globals";
+import {
+  API,
+  Version,
+  APIClientConfig,
+  DirectLoginAuthentication,
+  get,
+  Account,
+} from "../src";
+import { GetAccountsByBankId } from "../src/api/account";
+import { getRequest, apiCallWithCustomURIPath } from "../src/api/client";
+
+const directLogin: DirectLoginAuthentication = {
+  username: global.obpUsername,
+  password: global.obpPassword,
+  consumerKey: global.obpConsumerKey,
+};
+
+const clientConfig: APIClientConfig = {
+  baseUri: global.obpBaseUri,
+  version: global.obpVersion as Version,
+  authentication: directLogin,
+};
+
+describe("Account", () => {
+  test("get<API.Account> ByBankId should be able to get the OBP Accounts data.", async () => {
+    const accounts = await get<API.Account>(
+      clientConfig,
+      Account
+    )(GetAccountsByBankId)(global.obpTestBankId);
+
+    expect(accounts).toBeDefined();
+  });
+
+  test("get<API.Account> should be able to get the OBP Accounts data.", async () => {
+    const accounts = await get<API.Account>(
+      clientConfig,
+      Account
+    )(`/banks/${global.obpTestBankId}/accounts`);
+
+    expect(accounts).toBeDefined();
+  });
+
+  test("apiCallWithCustomURIPath should be able to get the OBP Accounts data.", async () => {
+    const customPathCall = apiCallWithCustomURIPath<API.Account>(
+      clientConfig,
+      getRequest
+    );
+    const accounts = await customPathCall(
+      `/banks/${global.obpTestBankId}/accounts`
+    );
+
+    expect(accounts).toBeDefined();
+  });
+});

__tests__/account.test.ts

@@ -0,0 +1,27 @@
+import { describe, test, expect } from "@jest/globals";
+import {
+  API,
+  APIClientConfig,
+  DirectLoginAuthentication,
+  Version,
+  get,
+  Bank,
+  GetBanks,
+} from "../src/api";
+
+describe("Bank", () => {
+  test("get<API.Bank> should be able to get the OBP Bank data.", async () => {
+    const directLogin: DirectLoginAuthentication = {
+      username: global.obpUsername,
+      password: global.obpPassword,
+      consumerKey: global.obpConsumerKey,
+    };
+    const clientConfig: APIClientConfig = {
+      baseUri: global.obpBaseUri,
+      version: global.obpVersion as Version,
+      authentication: directLogin,
+    };
+    const banks = await get<API.Bank>(clientConfig, Bank)(GetBanks);
+    expect(banks).toBeDefined();
+  });
+});

__tests__/bank.test.ts

@@ -0,0 +1,38 @@
+import { describe, test, expect } from "@jest/globals";
+import {
+  API,
+  APIClientConfig,
+  DirectLoginAuthentication,
+  Version,
+  get,
+  Customer,
+  GetCustomersAtBank,
+  GetCustomersAtAnyBank,
+} from "../src/api";
+
+const directLogin: DirectLoginAuthentication = {
+  username: global.obpUsername,
+  password: global.obpPassword,
+  consumerKey: global.obpConsumerKey,
+};
+const clientConfig: APIClientConfig = {
+  baseUri: global.obpBaseUri,
+  version: global.obpVersion as Version,
+  authentication: directLogin,
+};
+describe("Customer", () => {
+  test("get<API.Customer> GetCustomersAtBank should be able to get the OBP Customer data.", async () => {
+    const customers = await get<API.Customer>(
+      clientConfig,
+      Customer
+    )(GetCustomersAtBank)(global.obpTestBankId);
+    expect(customers).toBeDefined();
+  });
+  test("get<API.Customer> GetCustomersAtAnyBank should be able to get the OBP Customer data.", async () => {
+    const customers = await get<API.Customer>(
+      clientConfig,
+      Customer
+    )(GetCustomersAtAnyBank);
+    expect(customers).toBeDefined();
+  });
+});

__tests__/customer.test.ts

@@ -0,0 +1,29 @@
+import { describe, test, expect } from "@jest/globals";
+import {
+  API,
+  APIClientConfig,
+  DirectLoginAuthentication,
+  Version,
+  get,
+  KYC,
+  GetKYCStatus,
+} from "../src/api";
+
+describe("KYC", () => {
+  test("get<API.KYC> GetKYCStatus should be able to get the OBP KYC Status data.", async () => {
+    const directLogin: DirectLoginAuthentication = {
+      username: global.obpUsername,
+      password: global.obpPassword,
+      consumerKey: global.obpConsumerKey,
+    };
+    const clientConfig: APIClientConfig = {
+      baseUri: global.obpBaseUri,
+      version: global.obpVersion as Version,
+      authentication: directLogin,
+    };
+    const kycStatus = await get<API.KYC>(clientConfig, KYC)(GetKYCStatus)(
+      "9e6b2f45-a449-4e87-b772-e74cc9d42448"
+    );
+    expect(kycStatus).toBeDefined();
+  });
+});

__tests__/kyc.test.ts

@@ -0,0 +1,35 @@
+import { describe, test, expect } from "@jest/globals";
+import {
+  API,
+  APIClientConfig,
+  DirectLoginAuthentication,
+  Version,
+  get,
+  Metadata,
+  GetTagsOnAccount,
+} from "../src/api";
+
+describe("Metadata", () => {
+  test("get<API.Metadata> should be able to get the OBP Metadata data.", async () => {
+    const directLogin: DirectLoginAuthentication = {
+      username: global.obpUsername,
+      password: global.obpPassword,
+      consumerKey: global.obpConsumerKey,
+    };
+    const clientConfig: APIClientConfig = {
+      baseUri: global.obpBaseUri,
+      version: global.obpVersion as Version,
+      authentication: directLogin,
+    };
+    const tagsOnAccount = await get<API.Metadata>(
+      clientConfig,
+      Metadata
+    )(GetTagsOnAccount)(
+      global.obpTestBankId,
+      "9e6b2f45-a449-4e87-b772-e74cc9d42448",
+      "owner"
+    );
+    console.log(tagsOnAccount);
+    expect(tagsOnAccount).toBeDefined();
+  });
+});

__tests__/metadata.test.ts

@@ -0,0 +1,74 @@
+import { describe, test, expect } from "@jest/globals";
+import {
+  API,
+  Version,
+  APIClientConfig,
+  DirectLoginAuthentication,
+  create,
+  get,
+  Transaction,
+} from "../src/api";
+import {
+  GetTransactionsForAccountFull,
+  CreateTransactionRequestAccount,
+  TransactionRequestAccountBody,
+} from "../src/api/transaction";
+
+const directLogin: DirectLoginAuthentication = {
+  username: global.obpUsername,
+  password: global.obpPassword,
+  consumerKey: global.obpConsumerKey,
+};
+const clientConfig: APIClientConfig = {
+  baseUri: global.obpBaseUri,
+  version: global.obpVersion as Version,
+  authentication: directLogin,
+};
+const bankId = global.obpTestBankId;
+const accountId = "9e6b2f45-a449-4e87-b772-e74cc9d42448";
+const viewId = "owner";
+
+describe("Transaction", () => {
+  test("get<API.Transaction> ByBankId should be able to get the OBP Transactions data.", async () => {
+    const transactions = await get<API.Transaction>(
+      clientConfig,
+      Transaction
+    )(GetTransactionsForAccountFull)(bankId, accountId, viewId);
+
+    expect(transactions).toBeDefined();
+  });
+
+  test("get<API.Transaction> should be able to get the OBP Transactions data.", async () => {
+    const transactions = await get<API.Transaction>(
+      clientConfig,
+      Transaction
+    )(`/banks/${bankId}/accounts/${accountId}/${viewId}/transactions`);
+
+    expect(transactions).toBeDefined();
+  });
+
+  test("create<API.Transaction, TransactionFullBody> should be able to createn an OBP Transaction Full data.", async () => {
+    const body: TransactionRequestAccountBody = {
+      description: "test transaction full data",
+      to: {
+        bank_id: bankId,
+        account_id: accountId,
+      },
+      value: {
+        currency: "EUR",
+        amount: 1.0,
+      },
+    };
+    const transactions = await create<API.Transaction>(
+      clientConfig,
+      Transaction
+    )(CreateTransactionRequestAccount)(
+      bankId,
+      accountId,
+      viewId,
+      "SANDBOX_TAN"
+    )(body);
+
+    expect(transactions).toBeDefined();
+  });
+});

__tests__/transaction.test.ts

@@ -0,0 +1,27 @@
+import { describe, test, expect } from "@jest/globals";
+import {
+  API,
+  APIClientConfig,
+  DirectLoginAuthentication,
+  Version,
+  get,
+  User,
+  Current,
+} from "../src/api";
+
+describe("User", () => {
+  test("get<API.User> Current should be able to get the Current User.", async () => {
+    const directLogin: DirectLoginAuthentication = {
+      username: global.obpUsername,
+      password: global.obpPassword,
+      consumerKey: global.obpConsumerKey,
+    };
+    const clientConfig: APIClientConfig = {
+      baseUri: global.obpBaseUri,
+      version: global.obpVersion as Version,
+      authentication: directLogin,
+    };
+    const users = await get<API.User>(clientConfig, User)(Current);
+    expect(users).toBeDefined();
+  });
+});