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

package/src/__tests__/auth-urls.js

@@ -1,126 +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")
-  })
-
-  it("gets a reconsent url for a user", async () => {
-    const userId = config.testUserIdWithconnection
-    const connections = await moneyhub.getUserConnections({
-      userId
-    })
-    const connectionId = connections.data.length ? connections.data[0].id : undefined
-    const url = await moneyhub.getReconsentAuthorizeUrlForCreatedUser({
-      state,
-      nonce,
-      bankId,
-      userId: "some-user-id",
-      connectionId
-    })
-
-    const {request} = querystring.parse(url)
-    const payload = parseJwt(request)
-
-    expect(url).to.be.a("string")
-    expect(payload).to.have.nested.property("claims.id_token.mh:consent")
-    expect(payload).to.have.nested.property("claims.id_token.mh:con_id")
-  })
-})

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,166 +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",
-        "listBetaConnections",
-        "getOpenIdConfig",
-        "registerUser",
-        "getUsers",
-        "getSCIMUsers",
-        "getUser",
-        "getUserConnections",
-        "deleteUserConnection",
-        "deleteUser",
-        "getConnectionSyncs",
-        "getSync",
-        "updateUserConnection",
-        "getCategories",
-        "getStandardCategories",
-        "getCategory",
-        "getCategoryGroups",
-        "getStandardCategoryGroups",
-        "createCustomCategory",
-        "getStandingOrder",
-        "getStandingOrders",
-        "getRegularTransactions",
-        "getRentalRecords",
-        "createRentalRecord",
-        "deleteRentalRecord",
-        "getRecurringPayments",
-        "getRecurringPayment",
-        "makeRecurringPayment",
-        "revokeRecurringPayment",
-        "getSpendingAnalysis",
-        "getSpendingGoals",
-        "getSpendingGoal",
-        "createSpendingGoal",
-        "updateSpendingGoal",
-        "deleteSpendingGoal",
-        "getSavingsGoals",
-        "getSavingsGoal",
-        "createSavingsGoal",
-        "updateSavingsGoal",
-        "deleteSavingsGoal",
-        "getAuthorizeUrl",
-        "getAuthorizeUrlFromRequestUri",
-        "requestObject",
-        "getRequestUri",
-        "getAuthorizeUrlForCreatedUser",
-        "getReauthAuthorizeUrlForCreatedUser",
-        "getReconsentAuthorizeUrlForCreatedUser",
-        "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")
-  })
-
-})

package/src/__tests__/rental-records.js

@@ -1,90 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-const Moneyhub = require("..")
-const config = require("../../test/test-client-config")
-const {expect, assert} = require("chai")
-
-const testRentalData = {
-  title: "Title",
-  firstName: "firstName",
-  lastName: "lastName",
-  birthdate: "2000-11-19",
-  addressLine1: "First address line",
-  addressLine2: "Second address line",
-  addressLine3: "Third address line",
-  addressLine4: "Fourth address line",
-  postalCode: "CA12345",
-  tenancyStartDate: "2020-11-19",
-  rentalAmount: {
-    value: 10000
-  },
-  rentalFrequency: "monthly",
-}
-
-describe("Rental records", () => {
-  let moneyhub
-  let seriesId
-  let rentalId
-  const userId = config.testUserIdWithconnection
-
-  before(async () => {
-    moneyhub = await Moneyhub(config)
-    const {data: regularTransactions} = await moneyhub.getRegularTransactions({userId})
-    seriesId = regularTransactions[0].seriesId
-    const {data: rentals} = await moneyhub.getRentalRecords({userId})
-    if (rentals.length) {
-      const existingRentalId = rentals[0].id
-      await moneyhub.deleteRentalRecord({userId, rentalId: existingRentalId})
-    }
-  })
-
-  beforeEach(async () => {
-    const {data} = await moneyhub.createRentalRecord({rentalData: {...testRentalData, seriesId}, userId})
-    rentalId = data.id
-  })
-
-  afterEach(async () => {
-    try {
-      await moneyhub.deleteRentalRecord({userId, rentalId})
-    } catch (e) {
-      if (!e.message.includes("404")) {
-        throw e
-      }
-    }
-
-  })
-
-  it("get rental record", async () => {
-    const {data} = await moneyhub.getRentalRecords({userId})
-    expect(data.length).to.be.above(0)
-    expect(data[0]).to.have.property("seriesId")
-  })
-
-  it("create rental record", async () => {
-    const {data} = await moneyhub.getRentalRecords({userId})
-    expect(data.length).to.be.above(0)
-    assert.containsAllKeys(data[0], {
-      title: "Title",
-      firstName: "firstName",
-      lastName: "lastName",
-      birthdate: "2000-11-19",
-      addressLine1: "First address line",
-      addressLine2: "Second address line",
-      addressLine3: "Third address line",
-      addressLine4: "Fourth address line",
-      postalCode: "CA12345",
-      tenancyStartDate: "2020-11-19",
-      rentalAmount: {
-        value: 10000,
-        currency: "GBP"
-      },
-      rentalFrequency: "monthly",
-    })
-  })
-
-  it("delete rental record", async () => {
-    await moneyhub.deleteRentalRecord({userId, rentalId})
-    const {data} = await moneyhub.getRentalRecords({userId})
-    expect(data.length).to.eql(0)
-  })
-
-})

package/src/__tests__/savings-goals.js

@@ -1,68 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-const Moneyhub = require("../")
-const config = require("../../test/test-client-config")
-const {expect} = require("chai")
-
-describe("Savings Goals", () => {
-  let moneyhub
-  let userId
-  let goalId
-  let accountId
-
-  before(async () => {
-    moneyhub = await Moneyhub(config)
-    const user = await moneyhub.registerUser({clientUserId: "some-random-id"})
-    userId = user.userId
-    const account = await moneyhub.createAccount({userId, account: {
-      accountName: "Account name",
-      providerName: "Provider name",
-      type: "cash:current",
-      accountType: "personal",
-      balance: {
-        date: "2018-08-12",
-        amount: {
-          value: 300023
-        }
-      }
-    }})
-    accountId = account.data.id
-  })
-
-  it("can create a savings goal", async () => {
-    const goal = await moneyhub.createSavingsGoal({
-      userId,
-      name: "savings",
-      amount: {value: 100},
-      accounts: [{id: accountId}]
-    })
-    goalId = goal.data.id
-    expect(goal.data.name).to.equal("savings")
-    expect(goal.data.amount.value).to.equal(100)
-  })
-
-  it("can get a savings goal", async () => {
-    const goal = await moneyhub.getSavingsGoal({userId, goalId})
-    expect(goal.data.id).to.equal(goalId)
-  })
-
-  it("can get all savings goals", async () => {
-    const goals = await moneyhub.getSavingsGoals({}, userId)
-    expect(goals.data.length).to.be.greaterThan(0)
-  })
-
-  it("can get all savings goals with limit", async () => {
-    const goals = await moneyhub.getSavingsGoals({limit: 1}, userId)
-    expect(goals.data.length).to.equal(1)
-  })
-
-  it("can update a savings goal", async () => {
-    const goal = await moneyhub.updateSavingsGoal({goalId, userId, amount: {value: 329}, name: "new-name"})
-    expect(goal.data.amount.value).to.equal(329)
-    expect(goal.data.name).to.equal("new-name")
-  })
-
-  it("can delete a savings goal", async () => {
-    const result = await moneyhub.deleteSavingsGoal({userId, goalId})
-    expect(result).to.equal(204)
-  })
-})