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

package/src/index.js

@@ -1,85 +0,0 @@
-const {Issuer, custom} = require("openid-client")
-const R = require("ramda")
-const {JWKS} = require("jose")
-const getAuthUrlsFactory = require("./get-auth-urls")
-const getTokensFactory = require("./tokens")
-const requestFactories = [
-  require("./requests/accounts"),
-  require("./requests/auth-requests"),
-  require("./requests/beneficiaries"),
-  require("./requests/payees"),
-  require("./requests/payments"),
-  require("./requests/projects"),
-  require("./requests/sync"),
-  require("./requests/tax"),
-  require("./requests/transactions"),
-  require("./requests/transaction-files"),
-  require("./requests//transaction-splits"),
-  require("./requests/unauthenticated"),
-  require("./requests/users-and-connections"),
-  require("./requests/categories"),
-  require("./requests/standing-orders"),
-  require("./requests/regular-transactions"),
-  require("./requests/rental-records"),
-  require("./requests/recurring-payments"),
-  require("./requests/spending-analysis"),
-  require("./requests/spending-goals"),
-  require("./requests/savings-goals.js"),
-]
-const DEFAULT_TIMEOUT = 60000
-
-module.exports = async (apiClientConfig) => {
-  const config = R.evolve(
-    {
-      identityServiceUrl: (value) => value.replace("/oidc", ""),
-    },
-    apiClientConfig
-  )
-
-  const {
-    identityServiceUrl,
-    options = {},
-    client: {
-      client_id,
-      client_secret,
-      id_token_signed_response_alg,
-      request_object_signing_alg,
-      redirect_uri,
-      keys,
-      token_endpoint_auth_method,
-    },
-  } = config
-
-  const {timeout = DEFAULT_TIMEOUT} = options
-
-  custom.setHttpOptionsDefaults({
-    timeout,
-  })
-
-  const moneyhubIssuer = await Issuer.discover(identityServiceUrl + "/oidc")
-
-  const client = new moneyhubIssuer.Client(
-    {
-      client_id,
-      client_secret,
-      id_token_signed_response_alg,
-      redirect_uri,
-      token_endpoint_auth_method,
-      request_object_signing_alg,
-    },
-    {keys}
-  )
-
-  client[custom.clock_tolerance] = 10
-
-  const request = require("./request")({client, options: {timeout}})
-
-  const moneyhub = {
-    ...R.mergeAll(requestFactories.map((fn) => fn({request, config}))),
-    ...getAuthUrlsFactory({client, config}),
-    ...getTokensFactory({client, config}),
-
-    keys: () => (keys && keys.length ? JWKS.asKeyStore({keys}).toJWKS() : null),
-  }
-  return moneyhub
-}

package/src/request.js

@@ -1,58 +0,0 @@
-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 = {
-    method: opts.method || "GET",
-    headers: opts.headers || {},
-    searchParams: opts.searchParams,
-    timeout,
-  }
-
-  if (opts.cc) {
-    const {access_token} = await client.grant({
-      grant_type: "client_credentials",
-      scope: opts.cc.scope,
-      sub: opts.cc.sub,
-    })
-    gotOpts.headers.Authorization = `Bearer ${access_token}`
-  }
-
-  if (opts.body) {
-    gotOpts.json = opts.body
-  }
-
-  if (opts.form) {
-    gotOpts.body = opts.form
-  }
-
-  const req = got(url, gotOpts)
-  if (opts.returnStatus) {
-    return req.then(res => res.statusCode)
-      .catch(attachErrorDetails)
-  }
-
-  return req.json()
-    .catch(attachErrorDetails)
-}

package/src/requests/accounts.js

@@ -1,146 +0,0 @@
-module.exports = ({config, request}) => {
-  const {resourceServerUrl} = config
-
-  return {
-    getAccounts: async ({userId, params = {}}) =>
-      request(`${resourceServerUrl}/accounts`, {
-        searchParams: params,
-        cc: {
-          scope: "accounts:read",
-          sub: userId,
-        },
-      }),
-
-
-    getAccountsWithDetails: async ({userId, params = {}}) =>
-      request(`${resourceServerUrl}/accounts`, {
-        searchParams: params,
-        cc: {
-          scope: "accounts:read accounts_details:read",
-          sub: userId,
-        },
-      }),
-
-    getAccount: async ({userId, accountId}) =>
-      request(`${resourceServerUrl}/accounts/${accountId}`, {
-        cc: {
-          scope: "accounts:read",
-          sub: userId,
-        },
-      }),
-
-    getAccountBalances: async ({userId, accountId}) =>
-      request(`${resourceServerUrl}/accounts/${accountId}/balances`, {
-        cc: {
-          scope: "accounts:read",
-          sub: userId,
-        },
-      }),
-
-    getAccountWithDetails: async ({userId, accountId}) =>
-      request(`${resourceServerUrl}/accounts/${accountId}`, {
-        cc: {
-          scope: "accounts:read accounts_details:read",
-          sub: userId,
-        },
-      }),
-
-    getAccountHoldings: async ({userId, accountId}) =>
-      request(`${resourceServerUrl}/accounts/${accountId}/holdings`, {
-        cc: {
-          scope: "accounts:read",
-          sub: userId,
-        },
-      }),
-
-    getAccountHoldingsWithMatches: async ({userId, accountId}) =>
-      request(
-        `${resourceServerUrl}/accounts/${accountId}/holdings-with-matches`,
-        {
-          cc: {
-            scope: "accounts:read",
-            sub: userId,
-          },
-        },
-      ),
-
-    getAccountHolding: async ({userId, accountId, holdingId}) =>
-      request(
-        `${resourceServerUrl}/accounts/${accountId}/holdings/${holdingId}`,
-        {
-          cc: {
-            scope: "accounts:read",
-            sub: userId,
-          },
-        },
-      ),
-
-    getAccountCounterparties: async ({userId, accountId}) =>
-      request(`${resourceServerUrl}/accounts/${accountId}/counterparties`, {
-        cc: {
-          scope: "accounts:read transactions:read:all",
-          sub: userId,
-        },
-      }),
-
-    getAccountRecurringTransactions: async ({userId, accountId}) =>
-      request(
-        `${resourceServerUrl}/accounts/${accountId}/recurring-transactions`,
-        {
-          method: "POST",
-          cc: {
-            scope: "accounts:read transactions:read:all",
-            sub: userId,
-          },
-        },
-      ),
-
-    getAccountStandingOrders: async ({userId, accountId}) =>
-      request(
-        `${resourceServerUrl}/accounts/${accountId}/standing-orders`,
-        {
-          cc: {
-            scope: "accounts:read standing_orders:read",
-            sub: userId,
-          },
-        },
-      ),
-
-    getAccountStandingOrdersWithDetail: async ({userId, accountId}) =>
-      request(
-        `${resourceServerUrl}/accounts/${accountId}/standing-orders`,
-        {
-          cc: {
-            scope: "accounts:read standing_orders_detail:read",
-            sub: userId,
-          },
-        },
-      ),
-
-    createAccount: async ({userId, account}) =>
-      request(
-        `${resourceServerUrl}/accounts`,
-        {
-          method: "POST",
-          cc: {
-            scope: "accounts:read accounts:write:all",
-            sub: userId,
-          },
-          body: account
-        },
-      ),
-
-    deleteAccount: async ({userId, accountId}) =>
-      request(
-        `${resourceServerUrl}/accounts/${accountId}`,
-        {
-          method: "DELETE",
-          cc: {
-            scope: "accounts:write:all",
-            sub: userId,
-          },
-          returnStatus: true,
-        },
-      ),
-  }
-}

package/src/requests/auth-requests.js

@@ -1,61 +0,0 @@
-module.exports = ({config, request}) => {
-  const {identityServiceUrl} = config
-  const authRequestEndpoint = identityServiceUrl + "/auth-requests"
-
-  return {
-    createAuthRequest: async ({
-      redirectUri,
-      payment,
-      reversePayment,
-      standingOrder,
-      userId,
-      connectionId,
-      categorisationType,
-      scope,
-      permissions,
-    }) =>
-      request(authRequestEndpoint, {
-        method: "POST",
-        cc: {
-          scope: "auth_requests:write",
-        },
-        body: {
-          redirectUri,
-          payment,
-          reversePayment,
-          standingOrder,
-          userId,
-          connectionId,
-          scope,
-          categorisationType,
-          permissions,
-        },
-      }),
-
-    completeAuthRequest: async ({id, authParams}) =>
-      request(`${authRequestEndpoint}/${id}`, {
-        method: "PATCH",
-        cc: {
-          scope: "auth_requests:write",
-        },
-        body: {
-          authParams,
-        },
-      }),
-
-    getAllAuthRequests: async (params) =>
-      request(authRequestEndpoint, {
-        searchParams: params,
-        cc: {
-          scope: "auth_requests:read",
-        },
-      }),
-
-    getAuthRequest: async ({id}) =>
-      request(`${authRequestEndpoint}/${id}`, {
-        cc: {
-          scope: "auth_requests:read",
-        },
-      }),
-  }
-}

package/src/requests/beneficiaries.js

@@ -1,31 +0,0 @@
-module.exports = ({config, request}) => {
-  const {resourceServerUrl} = config
-  const BENEFICIARIES_READ_SCOPE = "beneficiaries:read"
-  const BENEFICIARIES_DETAIL_READ_SCOPE = "beneficiaries_detail:read"
-  const getOneBeneficiary = ({id, userId, scope}) =>
-    request(`${resourceServerUrl}/beneficiaries/${id}`, {
-      cc: {
-        sub: userId,
-        scope,
-      },
-    })
-
-  const getAllBeneficiaries = ({params, userId, scope}) =>
-    request(`${resourceServerUrl}/beneficiaries`, {
-      searchParams: params,
-      cc: {
-        sub: userId,
-        scope,
-      },
-    })
-  return {
-    getBeneficiary: ({id, userId}) =>
-      getOneBeneficiary({id, userId, scope: BENEFICIARIES_READ_SCOPE}),
-    getBeneficiaryWithDetail: ({id, userId}) =>
-      getOneBeneficiary({id, userId, scope: BENEFICIARIES_DETAIL_READ_SCOPE}),
-    getBeneficiaries: ({userId, params = {}}) =>
-      getAllBeneficiaries({params, userId, scope: BENEFICIARIES_READ_SCOPE}),
-    getBeneficiariesWithDetail: ({userId, params = {}}) =>
-      getAllBeneficiaries({params, userId, scope: BENEFICIARIES_DETAIL_READ_SCOPE})
-  }
-}

package/src/requests/categories.js

@@ -1,55 +0,0 @@
-module.exports = ({config, request}) => {
-  const {resourceServerUrl} = config
-
-  return {
-    getCategories: async ({userId, params = {}}) =>
-      request(`${resourceServerUrl}/categories`, {
-        searchParams: params,
-        cc: {
-          scope: "categories:read",
-          sub: userId,
-        },
-      }),
-
-    getStandardCategories: async ({params = {}}) =>
-      request(`${resourceServerUrl}/standard-categories`, {
-        searchParams: params,
-      }),
-
-    getCategory: async ({userId, categoryId, params = {}}) =>
-      request(`${resourceServerUrl}/categories/${categoryId}`, {
-        searchParams: params,
-        cc: {
-          scope: "categories:read",
-          sub: userId,
-        },
-      }),
-
-    getCategoryGroups: async ({userId, params = {}}) =>
-      request(`${resourceServerUrl}/category-groups`, {
-        searchParams: params,
-        cc: {
-          scope: "categories:read",
-          sub: userId,
-        },
-      }),
-
-    getStandardCategoryGroups: async ({params = {}}) =>
-      request(`${resourceServerUrl}/standard-category-groups`, {
-        searchParams: params,
-      }),
-
-    createCustomCategory: async ({userId, category: {group, name}}) =>
-      request(`${resourceServerUrl}/categories`, {
-        method: "POST",
-        cc: {
-          scope: "categories:read categories:write",
-          sub: userId,
-        },
-        body: {
-          group,
-          name
-        }
-      }),
-  }
-}

package/src/requests/payees.js

@@ -1,29 +0,0 @@
-module.exports = ({config, request}) => {
-  const {identityServiceUrl} = config
-
-  return {
-    addPayee: async ({accountNumber, sortCode, name, externalId, userId}) =>
-      request(`${identityServiceUrl}/payees`, {
-        method: "POST",
-        body: {accountNumber, sortCode, name, externalId, userId},
-        cc: {
-          scope: "payee:create",
-        },
-      }),
-
-    getPayees: (params = {}) =>
-      request(`${identityServiceUrl}/payees`, {
-        searchParams: params,
-        cc: {
-          scope: "payee:read",
-        },
-      }),
-
-    getPayee: async ({id}) =>
-      request(`${identityServiceUrl}/payees/${id}`, {
-        cc: {
-          scope: "payee:read",
-        },
-      }),
-  }
-}

package/src/requests/payments.js

@@ -1,35 +0,0 @@
-module.exports = ({config, request}) => {
-  const {identityServiceUrl} = config
-
-  const getPayment = ({id}) =>
-    request(`${identityServiceUrl}/payments/${id}`, {
-      cc: {
-        scope: "payment:read",
-      },
-    })
-
-  return {
-    getPayment,
-    getPayments: (params = {}) =>
-      request(`${identityServiceUrl}/payments`, {
-        searchParams: params,
-        cc: {
-          scope: "payment:read",
-        },
-      }),
-
-    getPaymentFromIDToken: async ({idToken}) => {
-      try {
-        const payload = JSON.parse(
-          Buffer.from(idToken.split(".")[1], "base64").toString(),
-        )
-        const paymentId = payload["mh:payment"]
-        return getPayment({id: paymentId})
-      } catch (e) {
-        throw new Error(
-          "Error retrieving payment from passed in ID Token: " + e.message,
-        )
-      }
-    },
-  }
-}

package/src/requests/projects.js

@@ -1,51 +0,0 @@
-module.exports = ({config, request}) => {
-  const {resourceServerUrl} = config
-
-  return {
-    getProjects: async ({userId, params = {}}) =>
-      request(`${resourceServerUrl}/projects`, {
-        searchParams: params,
-        cc: {
-          scope: "projects:read",
-          sub: userId,
-        },
-      }),
-    getProject: async ({userId, projectId}) =>
-      request(`${resourceServerUrl}/projects/${projectId}`, {
-        cc: {
-          scope: "projects:read",
-          sub: userId,
-        },
-      }),
-
-    addProject: async ({userId, project}) =>
-      request(`${resourceServerUrl}/projects`, {
-        method: "POST",
-        cc: {
-          scope: "projects:write",
-          sub: userId,
-        },
-        body: project,
-      }),
-
-    updateProject: async ({userId, projectId, project}) =>
-      request(`${resourceServerUrl}/projects/${projectId}`, {
-        method: "PATCH",
-        cc: {
-          scope: "projects:write",
-          sub: userId,
-        },
-        body: project,
-      }),
-
-    deleteProject: async ({userId, projectId}) =>
-      request(`${resourceServerUrl}/projects/${projectId}`, {
-        method: "DELETE",
-        cc: {
-          scope: "projects:delete",
-          sub: userId,
-        },
-        returnStatus: true,
-      }),
-  }
-}

package/src/requests/recurring-payments.js

@@ -1,37 +0,0 @@
-module.exports = ({config, request}) => {
-  const {identityServiceUrl} = config
-
-  return {
-    getRecurringPayments: async (params = {}) =>
-      request(`${identityServiceUrl}/recurring-payments`, {
-        searchParams: params,
-        cc: {
-          scope: "recurring_payment:read",
-        },
-      }),
-
-    getRecurringPayment: async ({recurringPaymentId}) =>
-      request(`${identityServiceUrl}/recurring-payments/${recurringPaymentId}`, {
-        cc: {
-          scope: "recurring_payment:read",
-        },
-      }),
-
-    makeRecurringPayment: async ({recurringPaymentId, payment}) =>
-      request(`${identityServiceUrl}/recurring-payments/${recurringPaymentId}/pay`, {
-        method: "POST",
-        body: payment,
-        cc: {
-          scope: "recurring_payment:create",
-        },
-      }),
-
-    revokeRecurringPayment: async ({recurringPaymentId}) =>
-      request(`${identityServiceUrl}/recurring-payments/${recurringPaymentId}`, {
-        method: "DELETE",
-        cc: {
-          scope: "recurring_payment:create",
-        },
-      }),
-  }
-}

package/src/requests/regular-transactions.js

@@ -1,17 +0,0 @@
-module.exports = ({config, request}) => {
-  const {resourceServerUrl} = config
-
-  return {
-    getRegularTransactions: async ({userId, params}) =>
-      request(
-        `${resourceServerUrl}/regular-transactions`,
-        {
-          searchParams: params,
-          cc: {
-            scope: "accounts:read regular_transactions:read transactions:read:all",
-            sub: userId,
-          },
-        },
-      ),
-  }
-}

package/src/requests/rental-records.js

@@ -1,41 +0,0 @@
-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,
-          },
-        },
-      )
-    },
-  }
-}

package/src/requests/savings-goals.js

@@ -1,49 +0,0 @@
-module.exports = ({config, request}) => {
-  const {resourceServerUrl} = config
-  const savingsGoalsEndpoint = resourceServerUrl + "/savings-goals"
-
-  return {
-    getSavingsGoals: async (params = {}, userId) =>
-      request(savingsGoalsEndpoint, {
-        searchParams: params,
-        cc: {
-          scope: "savings_goals:read",
-          sub: userId,
-        },
-      }),
-    getSavingsGoal: async ({goalId, userId}) =>
-      request(`${savingsGoalsEndpoint}/${goalId}`, {
-        cc: {
-          scope: "savings_goals:read",
-          sub: userId,
-        },
-      }),
-    createSavingsGoal: async ({name, imageUrl, notes, accounts, amount, userId}) =>
-      request(savingsGoalsEndpoint, {
-        method: "POST",
-        cc: {
-          scope: "savings_goals:read savings_goals:write:all",
-          sub: userId,
-        },
-        body: {name, imageUrl, notes, accounts, amount},
-      }),
-    updateSavingsGoal: async ({goalId, name, amount, imageUrl, notes, accounts, userId}) =>
-      request(`${savingsGoalsEndpoint}/${goalId}`, {
-        method: "PATCH",
-        cc: {
-          scope: "savings_goals:read savings_goals:write",
-          sub: userId,
-        },
-        body: {name, amount, imageUrl, notes, accounts},
-      }),
-    deleteSavingsGoal: async ({goalId, userId}) =>
-      request(`${savingsGoalsEndpoint}/${goalId}`, {
-        method: "DELETE",
-        cc: {
-          scope: "savings_goals:write:all",
-          sub: userId,
-        },
-        returnStatus: true
-      }),
-  }
-}