@mft/moneyhub-api-client 4.18.0 → 5.0.0-0

package/.eslintrc

@@ -1,9 +0,0 @@
----
-{
-  extends: "./node_modules/@mft/eslint-config-momentumft/index.js",
-  rules: {
-    "camelcase": "off",
-    "comma-dangle": "off",
-  }
-
-}

package/.github/workflows/main.yml

@@ -1,24 +0,0 @@
-name: npm audit
-
-on:
-  pull_request:
-  push:
-    branches:
-  schedule:
-    - cron: '0 10 * * *'
-
-jobs:
-  scan:
-    name: npm audit
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: install dependencies
-        run: npm ci
-      - uses: oke-py/npm-audit-action@v1.8.4
-        with:
-          audit_level: moderate
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          issue_assignees: oke-py
-          issue_labels: vulnerability,test
-          dedupe_issues: true

package/resources/scripts/pre-commit.sh

@@ -1,43 +0,0 @@
-#!/bin/bash
-
-red='\033[0;31m'
-NC='\033[0m' # No Color
-
-function hasOnlys {
-  onlys=$(git diff --cached -G "(describe|it)\.(only|skip)" | grep "^+[^+]" | grep -E "(describe|it)\.(only|skip)")
-  if [ $(echo $onlys | wc -c) -gt 1 ]
-  then
-    echo ""
-    echo -e "${red}WARNING!!"
-    echo -e "-----------------------${NC}"
-    echo "You have '.only/.skip' calls in your tests:"
-    echo ""
-    echo $onlys
-    echo ""
-    echo "No commit made.  Please fix these errors then commit again."
-    exit 1
-  fi
-}
-
-function hasLogs {
-  addedLogs=$(git diff -- src --cached -G "(console.log|debugger)" | grep "^+[^+]" | grep -E "(console.log|debugger)")
-  if [ $(echo $addedLogs | wc -c) -gt 1 ]
-  then
-    echo ""
-    echo -e "${red}WARNING!!"
-    echo -e "-----------------------${NC}"
-    echo "You have 'console.log' calls in your code:"
-    echo ""
-    echo $addedLogs
-    echo ""
-    echo "No commit made.  Please fix these errors then commit again."
-    exit 1
-  fi
-}
-
-echo git precommit:checking for omitted unit tests...
-hasOnlys
-echo git precommit:checking for console.logs...
-hasLogs
-
-exit 0

package/src/__tests__/accounts.js

@@ -1,76 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-const Moneyhub = require("..")
-const config = require("../../test/test-client-config")
-const {expect} = require("chai")
-
-describe("Accounts", () => {
-  let manualAccountId, moneyhub
-  const {testUserId: userId, testAccountId: accountId, testPensionId: pensionId} = config
-
-  before(async () => {
-    moneyhub = await Moneyhub(config)
-  })
-
-  it("get accounts", async () => {
-    const accounts = await moneyhub.getAccounts({userId})
-    expect(accounts.data.length).to.be.at.least(11)
-    const cashAccount = accounts.data.find(a => a.type === "cash:current")
-    const pension = accounts.data.find(a => a.type === "pension")
-
-    expect(cashAccount).to.not.be.undefined
-    expect(pension).to.not.be.undefined
-  })
-
-  it("get account", async () => {
-    const {data: account} = await moneyhub.getAccount({userId, accountId})
-    expect(account.id).to.eql(accountId)
-  })
-
-  it("get counterparties", async () => {
-    const {data: counterparties} = await moneyhub.getAccountCounterparties({
-      userId,
-      accountId
-    })
-    expect(counterparties.length).to.be.greaterThan(10)
-  })
-
-  it("get holdings", async () => {
-    const {data: holdings} = await moneyhub.getAccountHoldings({
-      userId,
-      accountId: pensionId
-    })
-    expect(holdings[0].items.length).to.be.greaterThan(5)
-  })
-
-  xit("get recurring transactions", async () => {
-    const {data: recurring} = await moneyhub.getAccountRecurringTransactions({
-      userId,
-      accountId
-    })
-    expect(recurring.length).to.be.greaterThan(10)
-  })
-
-  it("creates a manual account", async () => {
-    const account = {
-      "accountName": "Account name",
-      "providerName": "Provider name",
-      "type": "cash:current",
-      "accountType": "personal",
-      "balance": {
-        "date": "2018-08-12",
-        "amount": {
-          "value": 300023
-        }
-      }
-    }
-
-    const {data: {id}} = await moneyhub.createAccount({userId, account})
-    manualAccountId = id
-    expect(id).to.not.be.undefined
-  })
-
-  it("deletes manual account", async () => {
-    const status = await moneyhub.deleteAccount({userId, accountId: manualAccountId})
-    expect(status).to.eql(204)
-  })
-})

package/src/__tests__/auth-requests.js

@@ -1,33 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-const Moneyhub = require("..")
-const config = require("../../test/test-client-config")
-const {expect} = require("chai")
-
-describe("Auth requests", () => {
-  let moneyhub
-
-  before(async () => {
-    moneyhub = await Moneyhub(config)
-  })
-
-  it("creates payment auth request", async () => {
-    const {testPayeeId} = config
-    const {data} = await moneyhub.createAuthRequest({
-      scope: "openid payment id:1ffe704d39629a929c8e293880fb449a",
-      payment: {
-        payeeId: testPayeeId,
-        amount: 15,
-        payeeRef: "Payee ref",
-        payerRef: "Payer ref",
-      },
-      redirectUri: config.client.redirect_uri,
-    })
-    expect(data).to.have.property("id")
-    expect(data).to.have.property("status", "pending")
-    expect(data).to.have.property("redirectParams")
-    expect(data.redirectParams).to.have.property("authUrl")
-    expect(data.redirectParams).to.have.property("returnUrl")
-    expect(data.redirectParams).to.have.property("state")
-
-  })
-})

package/src/__tests__/auth-urls.js

@@ -1,104 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-const Moneyhub = require("..")
-const config = require("../../test/test-client-config")
-const {expect} = require("chai")
-const querystring = require("querystring")
-
-const bankId = "1ffe704d39629a929c8e293880fb449a"
-const state = "sample-state"
-const nonce = "sample-nonce"
-
-const parseJwt = (token) => {
-  const base64String = token.split(".")[1]
-  const decodedValue = JSON.parse(Buffer.from(base64String,
-    "base64").toString("ascii"))
-  return decodedValue
-}
-
-describe("Auth Urls", () => {
-  let moneyhub
-
-  before(async () => {
-    moneyhub = await Moneyhub(config)
-  })
-
-  it("gets a basic auth url", async () => {
-    const url = await moneyhub.getAuthorizeUrl({
-      state,
-      nonce,
-      scope: `openid id:${bankId} accounts:read`,
-    })
-
-    const {request} = querystring.parse(url)
-    const payload = parseJwt(request)
-
-    expect(url).to.be.a("string")
-    expect(payload).to.not.have.nested.property("claims.id_token.mh:consent.value.permissions")
-  })
-
-  it("gets a basic auth url with permissions", async () => {
-    const url = await moneyhub.getAuthorizeUrl({
-      state,
-      nonce,
-      scope: `openid id:${bankId} accounts:read`,
-      permissions: ["permission-1"]
-    })
-
-    const {request} = querystring.parse(url)
-    const payload = parseJwt(request)
-
-    expect(url).to.be.a("string")
-    expect(payload).to.have.deep.nested.property("claims.id_token.mh:consent.value.permissions", ["permission-1"])
-  })
-
-  it("gets an auth url for a user", async () => {
-    const url = await moneyhub.getAuthorizeUrlForCreatedUser({
-      state,
-      nonce,
-      bankId,
-      userId: "some-user-id",
-    })
-
-    const {request} = querystring.parse(url)
-    const payload = parseJwt(request)
-
-    expect(url).to.be.a("string")
-    expect(payload).to.not.have.nested.property("claims.id_token.mh:consent.value.permissions")
-  })
-
-  it("gets an auth url for a user with extra permissions", async () => {
-    const url = await moneyhub.getAuthorizeUrlForCreatedUser({
-      state,
-      nonce,
-      bankId,
-      userId: "some-user-id",
-      permissions: ["permission-1"]
-    })
-
-    const {request} = querystring.parse(url)
-    const payload = parseJwt(request)
-
-    expect(url).to.be.a("string")
-    expect(payload).to.have.deep.nested.property("claims.id_token.mh:consent.value.permissions", ["permission-1"])
-  })
-
-  it("gets a payment auth url", async () => {
-    const payee = await moneyhub.addPayee({
-      accountNumber: "12345678",
-      sortCode: "123456",
-      name: "Test",
-    })
-
-    const url = await moneyhub.getPaymentAuthorizeUrl({
-      bankId,
-      payeeId: payee.data.id,
-      amount: 1,
-      payeeRef: "some-ref",
-      payerRef: "another-ref",
-      state,
-      nonce,
-    })
-
-    expect(url).to.be.a("string")
-  })
-})

package/src/__tests__/categories.js

@@ -1,92 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-const Moneyhub = require("..")
-const config = require("../../test/test-client-config")
-const {expect} = require("chai")
-
-describe("Categories", () => {
-  let moneyhub
-  let categoryId
-
-  const userId = config.testUserId
-
-  before(async () => {
-    moneyhub = await Moneyhub(config)
-  })
-
-  it("get standard categories", async () => {
-    const categories = await moneyhub.getStandardCategories({params: {type: "personal"}})
-    expect(categories.data.length).to.be.at.least(50)
-  })
-
-  it("get standard category groups", async () => {
-    const categories = await moneyhub.getStandardCategoryGroups({params: {type: "all"}})
-    expect(categories.data.length).to.be.at.least(24)
-  })
-
-  it("get personal categories", async () => {
-    const categories = await moneyhub.getCategories({userId, params: {limit: 100}})
-    expect(categories.data.length).to.be.at.least(50)
-  })
-
-  it("get personal category", async () => {
-    const {data: categories} = await moneyhub.getCategories({
-      userId,
-      params: {type: "personal"},
-    })
-    const categoryId = categories[0].categoryId
-    const category = await moneyhub.getCategory({userId, categoryId})
-    expect(category.data.categoryId).to.eql(categoryId)
-  })
-
-  it("get personal category groups", async () => {
-    const groups = await moneyhub.getCategoryGroups({userId})
-    expect(groups.data.length).to.equal(16)
-  })
-
-  it("get business categories", async () => {
-    const categories = await moneyhub.getCategories({
-      userId,
-      params: {type: "business"},
-    })
-    expect(categories.data.length).to.equal(22)
-    categoryId = categories.data.find((a) => a.key === "business-loans")
-      .categoryId
-  })
-
-  it("get business category", async () => {
-    const category = await moneyhub.getCategory({
-      userId,
-      categoryId,
-      params: {type: "business"},
-    })
-    expect(category.data).to.eql({
-      categoryId: "std:28a30a62-6699-40a6-b24a-ed2671019824",
-      group: "group:105",
-      key: "business-loans",
-    })
-  })
-
-  it("get business category groups", async () => {
-    const groups = await moneyhub.getCategoryGroups({
-      userId,
-      params: {type: "business"},
-    })
-    expect(groups.data.length).to.equal(8)
-  })
-
-  it("get all categories", async () => {
-    const categories = await moneyhub.getCategories({
-      userId,
-      params: {type: "all", limit: 200},
-    })
-    expect(categories.data.length).to.be.above(80)
-  })
-
-  it("creates custom category", async () => {
-    const category = await moneyhub.createCustomCategory({
-      userId,
-      category: {group: "group:1", name: "custom-category"},
-    })
-    expect(category.data.name).to.equal("custom-category")
-  })
-})

package/src/__tests__/index.js

@@ -1,152 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-const Moneyhub = require("../")
-const config = require("../../test/test-client-config")
-const {expect} = require("chai")
-
-describe("API client", () => {
-  describe("Client configuration", () => {
-    let moneyhub
-    before(async () => {
-      if (config.mode !== "TEST") {
-        throw new Error("These tests require example config to be set to test mode")
-      }
-      moneyhub = await Moneyhub(config)
-    })
-
-    it("should create client", () => {
-      expect(moneyhub).to.be.an("object")
-    })
-
-    it("should export the required functions", () => {
-      expect(Object.keys(moneyhub)).to.deep.equal([
-        "getAccounts",
-        "getAccountsWithDetails",
-        "getAccount",
-        "getAccountBalances",
-        "getAccountWithDetails",
-        "getAccountHoldings",
-        "getAccountHoldingsWithMatches",
-        "getAccountHolding",
-        "getAccountCounterparties",
-        "getAccountRecurringTransactions",
-        "getAccountStandingOrders",
-        "getAccountStandingOrdersWithDetail",
-        "createAccount",
-        "deleteAccount",
-        "createAuthRequest",
-        "completeAuthRequest",
-        "getAllAuthRequests",
-        "getAuthRequest",
-        "getBeneficiary",
-        "getBeneficiaryWithDetail",
-        "getBeneficiaries",
-        "getBeneficiariesWithDetail",
-        "addPayee",
-        "getPayees",
-        "getPayee",
-        "getPayment",
-        "getPayments",
-        "getPaymentFromIDToken",
-        "getProjects",
-        "getProject",
-        "addProject",
-        "updateProject",
-        "deleteProject",
-        "syncUserConnection",
-        "getTaxReturn",
-        "getTransactions",
-        "getTransaction",
-        "addTransaction",
-        "addTransactions",
-        "updateTransaction",
-        "deleteTransaction",
-        "addFileToTransaction",
-        "getTransactionFiles",
-        "getTransactionFile",
-        "deleteTransactionFile",
-        "splitTransaction",
-        "getTransactionSplits",
-        "patchTransactionSplit",
-        "deleteTransactionSplits",
-        "getGlobalCounterparties",
-        "listConnections",
-        "listAPIConnections",
-        "listTestConnections",
-        "getOpenIdConfig",
-        "registerUser",
-        "getUsers",
-        "getSCIMUsers",
-        "getUser",
-        "getUserConnections",
-        "deleteUserConnection",
-        "deleteUser",
-        "getConnectionSyncs",
-        "getSync",
-        "getCategories",
-        "getStandardCategories",
-        "getCategory",
-        "getCategoryGroups",
-        "getStandardCategoryGroups",
-        "createCustomCategory",
-        "getStandingOrder",
-        "getStandingOrders",
-        "getRegularTransactions",
-        "getRentalRecords",
-        "createRentalRecord",
-        "deleteRentalRecord",
-        "getRecurringPayments",
-        "getRecurringPayment",
-        "makeRecurringPayment",
-        "revokeRecurringPayment",
-        "getAuthorizeUrl",
-        "getAuthorizeUrlFromRequestUri",
-        "requestObject",
-        "getRequestUri",
-        "getAuthorizeUrlForCreatedUser",
-        "getReauthAuthorizeUrlForCreatedUser",
-        "getRefreshAuthorizeUrlForCreatedUser",
-        "getPaymentAuthorizeUrl",
-        "getReversePaymentAuthorizeUrl",
-        "getRecurringPaymentAuthorizeUrl",
-        "getStandingOrderAuthorizeUrl",
-        "exchangeCodeForTokensLegacy",
-        "exchangeCodeForTokens",
-        "refreshTokens",
-        "getClientCredentialTokens",
-        "keys",
-      ])
-    })
-
-    describe("utility methods", () => {
-      it("exports public keys", async () => {
-        const keys = await moneyhub.keys()
-        expect(keys.keys.length).to.eql(config.client.keys.length)
-      })
-
-      it("lists connections", async () => {
-        const connections = await moneyhub.listConnections()
-        expect(connections.length).to.be.greaterThan(100)
-      })
-
-      it("lists api connections", async () => {
-        const connections = await moneyhub.listAPIConnections()
-        expect(connections.length).to.be.greaterThan(10)
-      })
-
-      it("lists test connections", async () => {
-        const connections = await moneyhub.listTestConnections()
-        expect(connections.length).to.be.lessThan(10)
-      })
-
-      it("gets OpenID config", async () => {
-        const openIdConfig = await moneyhub.getOpenIdConfig()
-        expect(openIdConfig.issuer).to.be.a("string")
-      })
-
-      it("gets global counterparties", async () => {
-        const counterparties = await moneyhub.getGlobalCounterparties()
-        expect(counterparties.data.length).to.be.greaterThan(100)
-      })
-    })
-  })
-})

package/src/__tests__/payees.js

@@ -1,39 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-const Moneyhub = require("..")
-const config = require("../../test/test-client-config")
-const {expect} = require("chai")
-
-describe("Payees", () => {
-  let moneyhub
-  let payeeId
-
-  before(async () => {
-    moneyhub = await Moneyhub(config)
-  })
-
-  it("add payee", async () => {
-    const payee = await moneyhub.addPayee({
-      accountNumber: "12345678",
-      sortCode: "123456",
-      name: "Test",
-    })
-    expect(payee.data.accountNumber).to.eql("12345678")
-    payeeId = payee.data.id
-  })
-
-  it("get payee", async () => {
-    const payee = await moneyhub.getPayee({
-      id: payeeId,
-    })
-    expect(payee.data.accountNumber).to.eql("12345678")
-    expect(payee.data.id).to.eql(payeeId)
-  })
-
-  it("get payees", async () => {
-    const payees = await moneyhub.getPayees({
-      limit: 1,
-    })
-    expect(payees.data.length).to.eql(1)
-    expect(payees.data[0].name).to.be.a("string")
-  })
-})

package/src/__tests__/payments.js

@@ -1,34 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-const Moneyhub = require("..")
-const config = require("../../test/test-client-config")
-const {expect} = require("chai")
-
-describe("Payments", () => {
-  let moneyhub
-  let paymentId
-
-  before(async () => {
-    moneyhub = await Moneyhub(config)
-  })
-
-  it("gets payment from token", async () => {
-    const {data: payment} = await moneyhub.getPaymentFromIDToken({
-      idToken: config.testPaymentIdToken,
-    })
-    paymentId = payment.id
-    expect(paymentId).to.be.a("string")
-  })
-
-  it("gets payment by id", async () => {
-    const {data: payment} = await moneyhub.getPayment({
-      id: paymentId
-    })
-    expect(payment.id).to.eql(paymentId)
-    expect(payment.status).to.eql("completed")
-  })
-
-  it("gets payments", async () => {
-    const {data: payments} = await moneyhub.getPayments({limit: 1})
-    expect(payments.length).to.eql(1)
-  })
-})

package/src/__tests__/projects.js

@@ -1,56 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-const Moneyhub = require("..")
-const config = require("../../test/test-client-config")
-const {expect} = require("chai")
-
-const userId = config.testUserId
-
-describe("Projects", () => {
-  let moneyhub
-  let projectId
-  before(async () => {
-    moneyhub = await Moneyhub(config)
-  })
-
-  it("can create a project", async () => {
-    const {data: project} = await moneyhub.addProject({
-      userId,
-      project: {
-        name: "Test Project",
-        type: "RentalProject",
-      },
-    })
-
-    expect(project.name).to.eql("Test Project")
-    expect(project.id).to.be.a("string")
-    projectId = project.id
-  })
-
-  it("can get a project", async () => {
-    const {data: project} = await moneyhub.getProject({userId, projectId})
-    expect(project.id).to.eql(projectId)
-  })
-
-  it("can get projects", async () => {
-    const {data: projects} = await moneyhub.getProjects({
-      userId,
-      params: {limit: 1},
-    })
-    expect(projects.length).to.eql(1)
-  })
-
-  it("can update a project", async () => {
-    const {data: project} = await moneyhub.updateProject({
-      userId,
-      projectId,
-      project: {name: "Updated"},
-    })
-    expect(project.id).to.eql(projectId)
-    expect(project.name).to.eql("Updated")
-  })
-
-  it("can delete a project", async () => {
-    const status = await moneyhub.deleteProject({userId, projectId})
-    expect(status).to.eql(204)
-  })
-})

package/src/__tests__/regular-transactions.js

@@ -1,20 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-const Moneyhub = require("..")
-const config = require("../../test/test-client-config")
-const {expect} = require("chai")
-
-describe.skip("Regular transactions", () => {
-  let moneyhub
-  const userId = config.testUserId
-
-  before(async () => {
-    moneyhub = await Moneyhub(config)
-  })
-
-  it("get regular transactions", async () => {
-    const {data} = await moneyhub.getRegularTransactions({userId})
-    expect(data.length).to.be.above(0)
-    expect(data[0]).to.have.property("seriesId")
-  })
-
-})