@mft/moneyhub-api-client 4.11.0 → 4.14.0

package/.github/workflows/main.yml

@@ -0,0 +1,24 @@
+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/CHANGELOG.md

@@ -1,3 +1,11 @@
+4.13.0 / 2022-01-05
+==================
+
+**Features**
+
+* Add getRentalRecords
+* Add createRentalRecord
+* Add deleteRentalRecord
 
 4.0.0 / 2021-01-11
 ==================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mft/moneyhub-api-client",
-  "version": "4.11.0",
+  "version": "4.14.0",
   "description": "Node.JS client for the Moneyhub API",
   "main": "src/index.js",
   "scripts": {
@@ -22,7 +22,7 @@
   "license": "ISC",
   "dependencies": {
     "form-data": "^3.0.0",
-    "got": "^11.8.1",
+    "got": "^11.8.3",
     "jose": "^2.0.5",
     "openid-client": "^4.2.2",
     "ramda": "^0.27.1"
@@ -34,11 +34,11 @@
     "command-line-args": "^5.1.1",
     "command-line-usage": "^6.1.1",
     "config": "^3.3.6",
-    "eslint": "^6.8.0",
+    "eslint": "^7.32.0",
     "express": "^4.17.1",
-    "husky": "^4.3.6",
-    "mocha": "^8.2.1",
-    "mocha-junit-reporter": "^2.0.0"
+    "husky": "^7.0.2",
+    "mocha": "^9.2.0",
+    "mocha-junit-reporter": "^2.0.2"
   },
   "husky": {
     "hooks": {

package/readme.md

@@ -1100,10 +1100,10 @@ This is a helper function that returns an authorize url to authorize a payment t
 
 ```javascript
 const url = await moneyhub.getPaymentAuthorizeUrl({
-  bankId: "Bank id to authorise payment from",
-  payeeId: "Id of payee",
+  bankId: "Bank id to authorise payment from", // required
+  payeeId: "Id of payee", // required
   payeeType: "Payee type [api-payee|mh-user-account]", // optional - defaults to api-payee
-  payerId: "Id of payer", // requird only if payerType is defined
+  payerId: "Id of payer", // required only if payerType is defined
   payerType: "Payer type [mh-user-account]", // required only if payerId is used
   amount: "Amount in pence to authorize payment",
   payeeRef: "Payee reference",
@@ -1113,6 +1113,7 @@ const url = await moneyhub.getPaymentAuthorizeUrl({
   state: "your state value",
   nonce: "your nonce value", // optional
   context: "Payment context [Other,BillPayment,PartyToParty]", // optional - defaults to PartyToParty
+  userId: "Moneyhub API User ID you wish to attach to the payment" // optional
   claims: claimsObject, // optional
 })
 
@@ -1152,6 +1153,7 @@ const url = await moneyhub.getReversePaymentAuthorizeUrl({
   bankId: "Bank id to authorise payment from",
   paymentId: "Id of payment to reverse",
   state: "your state value",
+  amount: "reverse payment amount" // optional
   nonce: "your nonce value", // optional
   claims: claimsObject, // optional
 })
@@ -1247,10 +1249,10 @@ This is a helper function that returns an authorize url to authorize a standng o
 
 ```javascript
 const url = await moneyhub.getStandingOrderAuthorizeUrl({
-  bankId: "Bank id to authorise payment from",
-  payeeId: "Id of payee",
+  bankId: "Bank id to authorise payment from", // required
+  payeeId: "Id of payee", // required
   payeeType: "Payee type [api-payee|mh-user-account]", // optional - defaults to api-payee
-  payerId: "Id of payer", // requird only if payerType is defined
+  payerId: "Id of payer", // required only if payerType is defined
   payerType: "Payer type [mh-user-account]", // required only if payerId is used
   reference: "The reference for standing order",
   frequency: {
@@ -1343,6 +1345,57 @@ const regulartransactions = await moneyhub.getRegularTransactions({
 })
 ```
 
+### Rental records
+
+#### `getRentalRecords`
+
+This method will return the rental record for the user. Requires the scope `rental_records:read`.
+
+```javascript
+const getRentalRecordResponse = await moneyhub.getRentalRecords({
+  userId: "user-id"
+})
+const rentalRecord = getRentalRecordResponse.data[0]
+```
+
+#### `createRentalRecord`
+
+This method will create a rental record for the user. Requires the scope `rental_records:write`. Please note only one rental record can exist for a user.
+
+```javascript
+const createRentalRecordResponse = await moneyhub.createRentalRecord({
+  userId: "user-id",
+  rentalData: {
+    title: "Title",
+    firstName: "firstName",
+    lastName: "lastName",
+    birthdate: "2000-11-19",
+    addressLine1: "First address line",
+    addressLine2: "Second address line", // optional
+    addressLine3: "Third address line", // optional
+    addressLine4: "Fourth address line", // optional
+    postalCode: "CA12345",
+    tenancyStartDate: "2020-11-19",
+    rentalAmount: {
+      value: 10000
+    },
+    rentalFrequency: "monthly",
+  }
+})
+const createdRentalRecord = createRentalRecordResponse.data
+```
+
+#### `deleteRentalRecord`
+
+This method deletes the rental record for a user.
+
+```javascript
+await moneyhub.deleteRentalRecord({
+  userId: "user-id",
+  rentalId: "rental-id"
+})
+```
+
 ### Financial Connections
 
 #### `listConnections`

package/src/__tests__/accounts.js

@@ -4,10 +4,8 @@ const config = require("../../test/test-client-config")
 const {expect} = require("chai")
 
 describe("Accounts", () => {
-  let moneyhub
-  let accountId
-  let pensionId
-  const userId = config.testUserId
+  let manualAccountId, moneyhub
+  const {testUserId: userId, testAccountId: accountId, testPensionId: pensionId} = config
 
   before(async () => {
     moneyhub = await Moneyhub(config)
@@ -15,9 +13,12 @@ describe("Accounts", () => {
 
   it("get accounts", async () => {
     const accounts = await moneyhub.getAccounts({userId})
-    expect(accounts.data.length).to.eql(11)
-    accountId = accounts.data.find(a => a.type === "cash:current").id
-    pensionId = accounts.data.find(a => a.type === "pension").id
+    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 () => {
@@ -64,12 +65,12 @@ describe("Accounts", () => {
     }
 
     const {data: {id}} = await moneyhub.createAccount({userId, account})
-    accountId = id
+    manualAccountId = id
     expect(id).to.not.be.undefined
   })
 
   it("deletes manual account", async () => {
-    const status = await moneyhub.deleteAccount({userId, accountId})
+    const status = await moneyhub.deleteAccount({userId, accountId: manualAccountId})
     expect(status).to.eql(204)
   })
 })

package/src/__tests__/index.js

@@ -89,6 +89,9 @@ describe("API client", () => {
         "getStandingOrder",
         "getStandingOrders",
         "getRegularTransactions",
+        "getRentalRecords",
+        "createRentalRecord",
+        "deleteRentalRecord",
         "getAuthorizeUrl",
         "getAuthorizeUrlFromRequestUri",
         "requestObject",

package/src/__tests__/rental-records.js

@@ -0,0 +1,90 @@
+/* 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__/transaction-splits.js

@@ -2,40 +2,61 @@
 const Moneyhub = require("..")
 const config = require("../../test/test-client-config")
 const {expect} = require("chai")
-const userId = config.testUserId
+const {testUserId: userId, testAccountId: accountId} = config
 const R = require("ramda")
+
 describe("Transaction Splits", () => {
   let moneyhub
-  let transaction
   let transactionId
   let splitId
+
+  const splitTestBaseInput = {
+    userId,
+    splits: [
+      {
+        categoryId: "std:39577c49-350f-45a4-8ec3-48ce205585fb",
+        amount: -1500,
+        description: "Split 1"
+      },
+      {
+        categoryId: "std:7daf3d79-98dd-4c85-b3cc-6d7ffd83fce9",
+        amount: -800,
+        description: "Split 2"
+      }
+    ]
+  }
+
   before(async () => {
     moneyhub = await Moneyhub(config)
-    const {data} = await moneyhub.getTransactions({
-      userId,
-      params: {limit: 1},
-    })
-    transaction = R.head(data)
-    transactionId = transaction.id
+    const transaction = {
+      accountId,
+      "amount": {
+        "value": -2300
+      },
+      "categoryId": "std:4b0255f0-0309-4509-9e05-4b4e386f9b0d",
+      "categoryIdConfirmed": true,
+      "longDescription": "New transaction",
+      "shortDescription": "transaction",
+      "notes": "notes",
+      "status": "posted",
+      "date": "2018-07-10T12:00:00+00:00"
+    }
+
+    const {data} = await moneyhub.addTransaction({userId, transaction})
+    transactionId = data.id
+  })
+
+  beforeEach(async () => {
+    const {data} = await moneyhub.splitTransaction({...splitTestBaseInput, transactionId})
+    splitId = data[0].id
+  })
+
+  after(async () => {
+    await moneyhub.deleteTransaction({userId, transactionId})
   })
 
   it("can split a transaction", async () => {
-    const {data: splits} = await moneyhub.splitTransaction({
-      userId,
-      transactionId,
-      splits: [
-        {
-          categoryId: "std:39577c49-350f-45a4-8ec3-48ce205585fb",
-          amount: transaction.amount.value / 2,
-          description: "Split 1"
-        },
-        {
-          categoryId: "std:7daf3d79-98dd-4c85-b3cc-6d7ffd83fce9",
-          amount: transaction.amount.value / 2,
-          description: "Split 2"
-        }
-      ]
-    })
+    const {data: splits} = await moneyhub.splitTransaction({...splitTestBaseInput, transactionId})
 
     expect(splits).to.have.length(2)
   })
@@ -45,8 +66,9 @@ describe("Transaction Splits", () => {
       userId,
       transactionId,
     })
-    splitId = R.path([0, "id"], splits)
     expect(splits).to.have.length(2)
+    expect(R.path([0, "amount"], splits)).to.be.oneOf([-1500, -800])
+    expect(R.path([0, "description"], splits)).to.be.oneOf(["Split 1", "Split 2"])
   })
 
   it("can update a transactions splits", async () => {
@@ -58,7 +80,6 @@ describe("Transaction Splits", () => {
         description: "New Description"
       }
     })
-
     expect(splits).to.have.length(2)
     expect(R.path([0, "description"], splits)).to.equal("New Description")
   })

package/src/get-auth-urls.js

@@ -219,6 +219,7 @@ module.exports = ({client, config}) => {
       nonce,
       context,
       readRefundAccount,
+      userId,
       claims = {},
     }) => {
       if (!state) {
@@ -251,6 +252,11 @@ module.exports = ({client, config}) => {
               readRefundAccount,
             },
           },
+          ...userId && {
+            sub: {
+              value: userId
+            }
+          }
         },
       }
 
@@ -275,6 +281,7 @@ module.exports = ({client, config}) => {
       paymentId,
       state,
       nonce,
+      amount,
       claims = {},
     }) => {
       if (!state) {
@@ -297,6 +304,7 @@ module.exports = ({client, config}) => {
             essential: true,
             value: {
               paymentId,
+              amount,
             },
           },
           "mh:payment": {

package/src/index.js

@@ -20,6 +20,7 @@ const requestFactories = [
   require("./requests/categories"),
   require("./requests/standing-orders"),
   require("./requests/regular-transactions"),
+  require("./requests/rental-records")
 ]
 const DEFAULT_TIMEOUT = 60000
 
@@ -51,8 +52,6 @@ module.exports = async (apiClientConfig) => {
     timeout,
   })
 
-  Issuer.defaultHttpOptions = {timeout}
-
   const moneyhubIssuer = await Issuer.discover(identityServiceUrl + "/oidc")
 
   const client = new moneyhubIssuer.Client(

package/src/requests/rental-records.js

@@ -0,0 +1,41 @@
+module.exports = ({config, request}) => {
+  const {resourceServerUrl} = config
+
+  return {
+    getRentalRecords: async ({userId}) =>
+      request(
+        `${resourceServerUrl}/rental-records`,
+        {
+          cc: {
+            scope: "rental_records:read",
+            sub: userId,
+          },
+        },
+      ),
+    createRentalRecord: async ({userId, rentalData}) => {
+      return await request(
+        `${resourceServerUrl}/rental-records`,
+        {
+          method: "POST",
+          cc: {
+            scope: "rental_records:write",
+            sub: userId,
+          },
+          body: rentalData,
+        },
+      )
+    },
+    deleteRentalRecord: async ({userId, rentalId}) => {
+      return await request(
+        `${resourceServerUrl}/rental-records/${rentalId}`,
+        {
+          method: "DELETE",
+          cc: {
+            scope: "rental_records:write",
+            sub: userId,
+          },
+        },
+      )
+    },
+  }
+}