@mft/moneyhub-api-client 4.8.0 → 4.12.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mft/moneyhub-api-client",
-  "version": "4.8.0",
+  "version": "4.12.1",
   "description": "Node.JS client for the Moneyhub API",
   "main": "src/index.js",
   "scripts": {
@@ -34,10 +34,10 @@
     "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",
+    "husky": "^7.0.2",
+    "mocha": "^9.1.2",
     "mocha-junit-reporter": "^2.0.0"
   },
   "husky": {

package/readme.md

@@ -369,6 +369,20 @@ const tokens = await moneyhub.createAuthRequest({
 })
 ```
 
+Creates a reverse payment auth request
+
+```javascript
+const tokens = await moneyhub.createAuthRequest({
+  redirectUri: "redirect-uri,
+  userId: "user-id",
+  connectionId: "connection-id",
+  scope:"openid reverse_payment",
+  reversePayment: {
+    paymentId: "payment-id"
+  },
+})
+```
+
 #### `completeAuthRequest`
 
 Completes an auth request succesfully
@@ -721,6 +735,31 @@ const transactions = await moneyhub.addTransaction({
 })
 ```
 
+#### `addTransactions`
+
+Add up to 50 transactions for a user. Please note, transaction must belong to an account that is transaction-able. This function uses the scopes `transactions:read:all transactions:write:all`.
+
+```javascript
+const transactions = await moneyhub.addTransactions({
+  userId: "userId",
+  transactions: [
+    {
+      amount: {
+        value: 10
+      }
+    },
+    {
+      amount: {
+        value: 25
+      }
+    }
+  ],
+  params: {
+    categorise: true // optional - enable categorisatio for transactions
+  }
+})
+```
+
 #### `deleteTransaction`
 
 Delete a transaction for a user. This function uses the scopes `transactions:write:all`..
@@ -925,6 +964,32 @@ const categoryGroups = await moneyhub.getCategoryGroups({
     },
   })
 ```
+
+#### `getStandardCategories`
+
+Get standard categories.
+
+```javascript
+
+const categories = await moneyhub.getStandardCategories({
+  params: {
+    type: "personal" // optional personal|business|all
+    },
+  })
+```
+
+#### `getStandardCategoryGroups`
+
+Get standard categories.
+
+```javascript
+
+const categoryGroups = await moneyhub.getStandardCategoryGroups({
+  params: {
+    type: "personal" // optional personal|business|all
+    },
+  })
+```
 #### `createCustomCategory`
 
 Create a custom category. This function uses the scopes `categories:read categories:write`.
@@ -1035,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",
@@ -1048,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
 })
 
@@ -1078,6 +1144,41 @@ const defaultClaims = {
 }
 ```
 
+#### `getReversePaymentAuthorizeUrl`
+
+This is a helper function that returns an authorize url to authorize a reverse payment for a payment that is reversible. This function uses the following scope with the value of the bankId provided `reverse_payment openid id:${bankId}`. It also requires the authentication to be `client_secret_jwt` or `private_key_jwt`.
+
+```javascript
+const url = await moneyhub.getReversePaymentAuthorizeUrl({
+  bankId: "Bank id to authorise payment from",
+  paymentId: "Id of payment to reverse",
+  state: "your state value",
+  nonce: "your nonce value", // optional
+  claims: claimsObject, // optional
+})
+
+// Scope used with the bankId provided
+const scope = `reverse_payment openid id:${bankId}`
+
+// Default claims if none are provided
+const defaultClaims = {
+  id_token: {
+    "mh:con_id": {
+      essential: true,
+    },
+    "mh:payment": {
+      essential: true,
+    },
+    "mh:reversePayment": {
+      essential: true,
+      value: {
+        paymentId
+      },
+    },
+  },
+}
+```
+
 #### `addPayee`
 
 This method will add a Payee. This will return an id that it is
@@ -1147,10 +1248,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: {
@@ -1233,7 +1334,7 @@ const standingOrder = await moneyhub.getStandingOrder({
 
 #### `getRegularTransactions`
 
-Get all the regular transactions for a user, there is an option to pass an account ID as a parameter as a filter. This function uses the scope `accounts:read`, `transactions:read:all` and `regular_transactions:read` 
+Get all the regular transactions for a user, there is an option to pass an account ID as a parameter as a filter. This function uses the scope `accounts:read`, `transactions:read:all` and `regular_transactions:read`
 
 ```javascript
 const queryParams = {accountID}

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__/categories.js

@@ -13,6 +13,16 @@ describe("Categories", () => {
     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)

package/src/__tests__/index.js

@@ -57,6 +57,7 @@ describe("API client", () => {
         "getTransactions",
         "getTransaction",
         "addTransaction",
+        "addTransactions",
         "updateTransaction",
         "deleteTransaction",
         "addFileToTransaction",
@@ -80,8 +81,10 @@ describe("API client", () => {
         "deleteUserConnection",
         "deleteUser",
         "getCategories",
+        "getStandardCategories",
         "getCategory",
         "getCategoryGroups",
+        "getStandardCategoryGroups",
         "createCustomCategory",
         "getStandingOrder",
         "getStandingOrders",
@@ -94,6 +97,7 @@ describe("API client", () => {
         "getReauthAuthorizeUrlForCreatedUser",
         "getRefreshAuthorizeUrlForCreatedUser",
         "getPaymentAuthorizeUrl",
+        "getReversePaymentAuthorizeUrl",
         "getStandingOrderAuthorizeUrl",
         "exchangeCodeForTokensLegacy",
         "exchangeCodeForTokens",

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

@@ -218,6 +218,8 @@ module.exports = ({client, config}) => {
       state,
       nonce,
       context,
+      readRefundAccount,
+      userId,
       claims = {},
     }) => {
       if (!state) {
@@ -247,8 +249,65 @@ module.exports = ({client, config}) => {
               payerId,
               payerType,
               context,
+              readRefundAccount,
+            },
+          },
+          ...userId && {
+            sub: {
+              value: userId
+            }
+          }
+        },
+      }
+
+      const _claims = R.mergeDeepRight(defaultClaims, claims)
+
+      const request = await requestObject({
+        scope,
+        state,
+        claims: _claims,
+        nonce,
+      })
+
+      const requestUri = await getRequestUri(request)
+      const url = getAuthorizeUrlFromRequestUri({
+        requestUri,
+      })
+      return url
+    },
+
+    getReversePaymentAuthorizeUrl: async ({
+      bankId,
+      paymentId,
+      state,
+      nonce,
+      claims = {},
+    }) => {
+      if (!state) {
+        console.error("State is required")
+        throw new Error("Missing parameters")
+      }
+
+      if (!paymentId) {
+        console.error("PayeeId is required")
+        throw new Error("Missing parameters")
+      }
+
+      const scope = `reverse_payment openid id:${bankId}`
+      const defaultClaims = {
+        id_token: {
+          "mh:con_id": {
+            essential: true,
+          },
+          "mh:reverse_payment": {
+            essential: true,
+            value: {
+              paymentId,
             },
           },
+          "mh:payment": {
+            essential: true,
+          },
         },
       }
 

package/src/requests/auth-requests.js

@@ -6,6 +6,8 @@ module.exports = ({config, request}) => {
     createAuthRequest: async ({
       redirectUri,
       payment,
+      reversePayment,
+      standingOrder,
       userId,
       connectionId,
       categorisationType,
@@ -20,6 +22,8 @@ module.exports = ({config, request}) => {
         body: {
           redirectUri,
           payment,
+          reversePayment,
+          standingOrder,
           userId,
           connectionId,
           scope,

package/src/requests/categories.js

@@ -11,6 +11,11 @@ module.exports = ({config, request}) => {
         },
       }),
 
+    getStandardCategories: async ({params = {}}) =>
+      request(`${resourceServerUrl}/standard-categories`, {
+        searchParams: params,
+      }),
+
     getCategory: async ({userId, categoryId, params = {}}) =>
       request(`${resourceServerUrl}/categories/${categoryId}`, {
         searchParams: params,
@@ -29,6 +34,11 @@ module.exports = ({config, request}) => {
         },
       }),
 
+    getStandardCategoryGroups: async ({params = {}}) =>
+      request(`${resourceServerUrl}/standard-category-groups`, {
+        searchParams: params,
+      }),
+
     createCustomCategory: async ({userId, category: {group, name}}) =>
       request(`${resourceServerUrl}/categories`, {
         method: "POST",

package/src/requests/transactions.js

@@ -26,6 +26,16 @@ module.exports = ({config, request}) => {
         },
         body: transaction
       }),
+    addTransactions: ({userId, transactions, params = {}}) =>
+      request(`${resourceServerUrl}/transactions-collection`, {
+        method: "POST",
+        searchParams: params,
+        cc: {
+          scope: "transactions:read:all transactions:write:all",
+          sub: userId,
+        },
+        body: transactions
+      }),
     updateTransaction: ({userId, transactionId, transaction}) =>
       request(`${resourceServerUrl}/transactions/${transactionId}`, {
         method: "PATCH",