@mft/moneyhub-api-client 4.15.1 → 4.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mft/moneyhub-api-client",
-  "version": "4.15.1",
+  "version": "4.18.0",
   "description": "Node.JS client for the Moneyhub API",
   "main": "src/index.js",
   "scripts": {
@@ -21,23 +21,23 @@
   "repository": "moneyhub/moneyhub-api-client",
   "license": "ISC",
   "dependencies": {
-    "form-data": "^3.0.0",
+    "form-data": "^3.0.1",
     "got": "^11.8.3",
     "jose": "^2.0.5",
-    "openid-client": "^4.2.2",
-    "ramda": "^0.27.1"
+    "openid-client": "^4.9.1",
+    "ramda": "^0.27.2"
   },
   "devDependencies": {
     "@mft/eslint-config-momentumft": "^4.0.0",
-    "body-parser": "^1.19.0",
-    "chai": "^4.2.0",
-    "command-line-args": "^5.1.1",
+    "body-parser": "^1.19.2",
+    "chai": "^4.3.6",
+    "command-line-args": "^5.2.1",
     "command-line-usage": "^6.1.1",
-    "config": "^3.3.6",
+    "config": "^3.3.7",
     "eslint": "^7.32.0",
-    "express": "^4.17.1",
-    "husky": "^7.0.2",
-    "mocha": "^9.2.0",
+    "express": "^4.17.3",
+    "husky": "^7.0.4",
+    "mocha": "^9.2.2",
     "mocha-junit-reporter": "^2.0.2"
   },
   "husky": {

package/readme.md

@@ -89,10 +89,18 @@ const moneyhub = await Moneyhub({
 Once the api client has been initialised it provides a simple promise based interface with the following methods:
 
 ### Auth API
+The options below can be set on the following URL generating methods:
+- `getAuthorizeUrl`
+- `getAuthorizeUrlForCreatedUser`
+- `getReauthAuthorizeUrlForCreatedUser`
+- `getRefreshAuthorizeUrlForCreatedUser`
 
+The `expirationDateTime` and `transactionFromDateTime` options can be set according to the [AIS Consents documentation](https://docs.moneyhubenterprise.com/docs/ais-consents)
+
+Set `enableAsync` to true if you wish to make an AIS connection that won't wait for accounts and transactions to be fetched.
 #### `getAuthorizeUrl`
 
-This method returns an authorize url for your API client. You can redirect a user to this url, after which they will be redirected back to your `redirect_uri`.
+This method returns an authorize url for your API client. You can redirect a user to this url, after which they will be redirected back to your `redirect_uri`. 
 
 [Financial institutions](https://docs.moneyhubenterprise.com/docs/bank-connections)
 
@@ -100,13 +108,17 @@ This method returns an authorize url for your API client. You can redirect a use
 
 [Claims](https://docs.moneyhubenterprise.com/docs/claims)
 
+
 ```javascript
 const url = await moneyhub.getAuthorizeUrl({
   scope: "openid bank-id-scope other-data-scopes",
   state: " your state value", // optional
   nonce: "your nonce value", //optional
   claims: claimsObject, // optional
-  permissions: ["ReadBeneficiariesDetail"] // optional - set of extra permissions to set for auth URL
+  permissions: ["ReadBeneficiariesDetail"], // optional - set of extra permissions to set for auth URL
+  expirationDateTime: "2022-09-01T00:00:00.000Z", // optional
+  transactionFromDateTime: "2020-09-01T00:00:00.000Z", // optional,
+  enableAsync: false // optional
 })
 
 // Default claims if none are provided
@@ -139,7 +151,8 @@ const url = await moneyhub.getAuthorizeUrlForCreatedUser({
   state: "your state value", // optional
   nonce: "your nonce value", // optional
   claims: claimsObject, // optional
-  permissions: ["ReadBeneficiariesDetail"] // optional - set of extra permissions to set for auth URL
+  permissions: ["ReadBeneficiariesDetail"], // optional - set of extra permissions to set for auth URL
+  enableAsync: false // optional
 })
 
 // Scope used with the bankId provided
@@ -170,6 +183,7 @@ const url = await moneyhub.getReauthAuthorizeUrlForCreatedUser({
   state: "your state value", // optional
   nonce: "your nonce value", // optional
   claims: claimsObject, // optional
+  enableAsync: false // optional
 })
 
 // Default claims if none are provided
@@ -198,6 +212,7 @@ const url = await moneyhub.getRefreshAuthorizeUrlForCreatedUser({
   state: "your state value", // optional
   nonce: "your nonce value", // optional
   claims: claimsObject, // optional
+  enableAsync: false // optional
 })
 
 // Default claims if none are provided
@@ -511,6 +526,30 @@ const user = await moneyhub.deleteUserConnection({
   })
 ```
 
+#### `getConnectionSyncs`
+
+Retrieve the syncs for a given connection ID.
+```javascript
+const syncs = await moneyhub.getConnectionSyncs({
+  userId: "user-id",
+  connectionId: "connection-id",
+  params: {
+    limit: 10,
+    offset: 0
+  }
+})
+```
+
+#### `getSync`
+
+Retrieve the syncs for the given sync ID.
+```javascript
+const syncs = await moneyhub.getSync({
+  userId: "user-id",
+  syncId: "sync-id"
+})
+```
+
 ### Data API
 
 #### `getAccounts`

package/src/__tests__/index.js

@@ -80,6 +80,8 @@ describe("API client", () => {
         "getUserConnections",
         "deleteUserConnection",
         "deleteUser",
+        "getConnectionSyncs",
+        "getSync",
         "getCategories",
         "getStandardCategories",
         "getCategory",

package/src/__tests__/transaction-splits.js

@@ -67,7 +67,7 @@ describe("Transaction Splits", () => {
       transactionId,
     })
     expect(splits).to.have.length(2)
-    expect(R.path([0, "amount"], splits)).to.be.oneOf([-1500, -800])
+    expect(R.path([0, "amount", "value"], splits)).to.be.oneOf([-1500, -800])
     expect(R.path([0, "description"], splits)).to.be.oneOf(["Split 1", "Split 2"])
   })
 

package/src/get-auth-urls.js

@@ -30,7 +30,16 @@ module.exports = ({client, config}) => {
     return claims
   }
 
-  const getAuthorizeUrl = ({state, scope, nonce, claims = {}, permissions}) => {
+  const getAuthorizeUrl = ({
+    state,
+    scope,
+    nonce,
+    claims = {},
+    permissions,
+    enableAsync,
+    expirationDateTime,
+    transactionFromDateTime,
+  }) => {
     const defaultClaims = {
       id_token: {
         sub: {
@@ -39,6 +48,21 @@ module.exports = ({client, config}) => {
         "mh:con_id": {
           essential: true,
         },
+        ...(expirationDateTime || transactionFromDateTime) && {
+          "mh:consent": {
+            "essential": true,
+            "value": {
+              ...expirationDateTime && {expirationDateTime},
+              ...transactionFromDateTime && {transactionFromDateTime},
+            }
+          }
+        },
+        ...enableAsync && {
+          "mh:sync": {
+            "essential": true,
+            "value": {"enableAsync": true}
+          }
+        }
       },
     }
 
@@ -116,7 +140,10 @@ module.exports = ({client, config}) => {
       nonce,
       userId,
       claims = {},
-      permissions
+      permissions,
+      expirationDateTime,
+      transactionFromDateTime,
+      enableAsync,
     }) => {
       const scope = `id:${bankId} openid`
       const defaultClaims = {
@@ -140,6 +167,9 @@ module.exports = ({client, config}) => {
         nonce,
         scope,
         claims: _claims,
+        expirationDateTime,
+        transactionFromDateTime,
+        enableAsync,
       })
       return url
     },
@@ -150,6 +180,9 @@ module.exports = ({client, config}) => {
       state,
       nonce,
       claims = {},
+      expirationDateTime,
+      transactionFromDateTime,
+      enableAsync,
     }) => {
       const scope = "openid reauth"
       const defaultClaims = {
@@ -171,6 +204,9 @@ module.exports = ({client, config}) => {
         nonce,
         scope,
         claims: _claims,
+        expirationDateTime,
+        transactionFromDateTime,
+        enableAsync,
       })
       return url
     },
@@ -181,6 +217,9 @@ module.exports = ({client, config}) => {
       state,
       nonce,
       claims = {},
+      expirationDateTime,
+      transactionFromDateTime,
+      enableAsync
     }) => {
       const scope = "openid refresh"
       const defaultClaims = {
@@ -202,6 +241,9 @@ module.exports = ({client, config}) => {
         scope,
         nonce,
         claims: _claims,
+        expirationDateTime,
+        transactionFromDateTime,
+        enableAsync
       })
       return url
     },

package/src/request.js

@@ -1,4 +1,26 @@
 const got = require("got")
+const R = require("ramda")
+
+const getResponseBody = err => {
+  let body = {}
+  try {
+    const {code, message, details} = JSON.parse(R.pathOr("{}", ["response", "body"], err))
+    body = {code, message, details: typeof details === "object" ? JSON.stringify(details) : details}
+  // eslint-disable-next-line no-empty
+  } catch (e) {
+    body = {}
+  }
+
+  return body
+}
+
+const attachErrorDetails = err => {
+  const {code, message, details} = getResponseBody(err)
+  err.error = code
+  err.error_description = message
+  err.error_details = details
+  throw err
+}
 
 module.exports = ({client, options: {timeout}}) => async (url, opts = {}) => {
   const gotOpts = {
@@ -28,7 +50,9 @@ module.exports = ({client, options: {timeout}}) => async (url, opts = {}) => {
   const req = got(url, gotOpts)
   if (opts.returnStatus) {
     return req.then(res => res.statusCode)
+      .catch(attachErrorDetails)
   }
 
   return req.json()
+    .catch(attachErrorDetails)
 }

package/src/requests/unauthenticated.js

@@ -1,8 +1,10 @@
 module.exports = ({config, request}) => {
   const {resourceServerUrl, identityServiceUrl} = config
   return {
-    getGlobalCounterparties: () =>
-      request(resourceServerUrl + "/global-counterparties"),
+    getGlobalCounterparties: (params = {}) =>
+      request(resourceServerUrl + "/global-counterparties", {
+        searchParams: params,
+      }),
     listConnections: () =>
       request(identityServiceUrl + "/oidc/.well-known/all-connections"),
     listAPIConnections: () =>

package/src/requests/users-and-connections.js

@@ -60,5 +60,20 @@ module.exports = ({config, request}) => {
           scope: "user:delete",
         },
       }),
+
+    getConnectionSyncs: async ({userId, connectionId, params = {}}) =>
+      request(`${usersEndpoint}/${userId}/connections/${connectionId}/syncs`, {
+        searchParams: params,
+        cc: {
+          scope: "user:read"
+        }
+      }),
+
+    getSync: async ({userId, syncId}) =>
+      request(`${usersEndpoint}/${userId}/syncs/${syncId}`, {
+        cc: {
+          scope: "user:read"
+        }
+      })
   }
 }