@mojaloop/api-snippets 17.2.4 → 17.3.0-snapshot.0

package/package.json

@@ -1,39 +1,53 @@
 {
   "name": "@mojaloop/api-snippets",
-  "version": "17.2.4",
+  "version": "17.3.0-snapshot.0",
   "description": "Mojaloop API specification reusable snippets",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
     "audit:fix": "npm audit fix",
     "audit:check": "npx audit-ci --config ./audit-ci.jsonc",
-    "build": "npm run build:openapi; npm run build:dto; npm run build:schemas; tsc -p ./tsconfig.build.json",
-    "build:dto": "npm run build:dto:v1.0; npm run build:dto:v1.1; npm run build:dto:thirdparty; npm run build:dto:sdk-scheme-adapter;",
-    "build:schemas": "npm run build:schemas:sdk-scheme-adapter:backend; npm run build:schemas:sdk-scheme-adapter:outbound;",
+    "build": "npm run build:openapi; npm run build:dto; npm run build:schemas:v2.0.0; npm run build:schemas:v2.1.0; tsc -p ./tsconfig.build.json",
+    "build:dto": "npm run build:dto:v1.0; npm run build:dto:v1.1; npm run build:dto:v2.0; npm run build:dto:thirdparty; npm run build:dto:sdk-scheme-adapter:v2.0.0; npm run build:dto:sdk-scheme-adapter:v2.1.0;",
+    "build:schemas:v2.0.0": "npm run build:schemas:sdk-scheme-adapter:backend:v2.0.0; npm run build:schemas:sdk-scheme-adapter:outbound:v2.0.0;",
+    "build:schemas:v2.1.0": "npm run build:schemas:sdk-scheme-adapter:backend:v2.1.0; npm run build:schemas:sdk-scheme-adapter:outbound:v2.1.0;",
     "build:dto:v1.0": "openapi-typescript docs/fspiop-rest-v1.0-openapi3-snippets.yaml --output src/fspiop/v1_0/openapi.ts",
     "build:dto:v1.1": "openapi-typescript docs/fspiop-rest-v1.1-openapi3-snippets.yaml --output src/fspiop/v1_1/openapi.ts",
+    "build:dto:v2.0": "openapi-typescript docs/fspiop-rest-v2.0-openapi3-snippets.yaml --output src/fspiop/v2_0/openapi.ts",
     "build:dto:thirdparty": "openapi-typescript docs/thirdparty-openapi3-snippets.yaml --output src/thirdparty/openapi.ts",
-    "build:dto:sdk-scheme-adapter": "npm run build:dto:sdk-scheme-adapter:backend; npm run build:dto:sdk-scheme-adapter:outbound;",
-    "build:dto:sdk-scheme-adapter:backend": "openapi-typescript docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_0_0/backend/openapi.ts",
-    "build:dto:sdk-scheme-adapter:outbound": "openapi-typescript docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_0_0/outbound/openapi.ts",
-    "build:openapi": "npm run build:v1.0; npm run build:v1.1; npm run build:thirdparty; npm run build:sdk-scheme-adapter:backend; npm run build:sdk-scheme-adapter:outbound;",
+    "build:dto:sdk-scheme-adapter:v2.0.0": "npm run build:dto:sdk-scheme-adapter:backend:v2.0.0; npm run build:dto:sdk-scheme-adapter:outbound:v2.0.0;",
+    "build:dto:sdk-scheme-adapter:v2.1.0": "npm run build:dto:sdk-scheme-adapter:backend:v2.1.0; npm run build:dto:sdk-scheme-adapter:outbound:v2.1.0;",
+    "build:dto:sdk-scheme-adapter:backend:v2.0.0": "openapi-typescript docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_0_0/backend/openapi.ts",
+    "build:dto:sdk-scheme-adapter:outbound:v2.0.0": "openapi-typescript docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_0_0/outbound/openapi.ts",
+    "build:dto:sdk-scheme-adapter:backend:v2.1.0": "openapi-typescript docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_1_0/backend/openapi.ts",
+    "build:dto:sdk-scheme-adapter:outbound:v2.1.0": "openapi-typescript docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_1_0/outbound/openapi.ts",
+    "build:openapi": "npm run build:v1.0; npm run build:v1.1; npm run build:v2.0; npm run build:thirdparty; npm run build:sdk-scheme-adapter:v2.0.0; npm run build:sdk-scheme-adapter:v2.1.0;",
     "build:v1.0": "openapi bundle --output docs/fspiop-rest-v1.0-openapi3-snippets.yaml --ext yaml fspiop/v1_0/openapi3/openapi.yaml && swagger-cli validate docs/fspiop-rest-v1.0-openapi3-snippets.yaml",
     "build:v1.1": "openapi bundle --output docs/fspiop-rest-v1.1-openapi3-snippets.yaml --ext yaml fspiop/v1_1/openapi3/openapi.yaml && swagger-cli validate docs/fspiop-rest-v1.1-openapi3-snippets.yaml",
+    "build:v2.0": "openapi bundle --output docs/fspiop-rest-v2.0-openapi3-snippets.yaml --ext yaml fspiop/v2_0/openapi3/openapi.yaml && swagger-cli validate docs/fspiop-rest-v2.0-openapi3-snippets.yaml",
     "build:thirdparty": "openapi bundle --output docs/thirdparty-openapi3-snippets.yaml --ext yaml thirdparty/v1_0/openapi3/openapi.yaml && swagger-cli validate docs/thirdparty-openapi3-snippets.yaml",
     "build:thirdparty-dfsp": "swagger-cli bundle -o ./thirdparty/v1_0/openapi3/thirdparty-dfsp-api.yaml -t yaml ./thirdparty/v1_0/openapi3/thirdparty-dfsp-api.template.yaml",
     "build:thirdparty-pisp": "swagger-cli bundle -o ./thirdparty/v1_0/openapi3/thirdparty-pisp-api.yaml -t yaml ./thirdparty/v1_0/openapi3/thirdparty-pisp-api.template.yaml",
-    "build:sdk-scheme-adapter:backend": "openapi bundle --output docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_0_0/backend/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml",
-    "build:sdk-scheme-adapter:outbound": "openapi bundle --output docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_0_0/outbound/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml",
-    "build:schemas:sdk-scheme-adapter:backend": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_0_0/backend",
-    "build:schemas:sdk-scheme-adapter:outbound": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_0_0/outbound",
+    "build:sdk-scheme-adapter:v2.0.0": "npm run build:sdk-scheme-adapter:backend:v2.0.0; npm run build:sdk-scheme-adapter:outbound:v2.0.0;",
+    "build:sdk-scheme-adapter:v2.1.0": "npm run build:sdk-scheme-adapter:backend:v2.1.0; npm run build:sdk-scheme-adapter:outbound:v2.1.0;",
+    "build:sdk-scheme-adapter:backend:v2.0.0": "openapi bundle --output docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_0_0/backend/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml",
+    "build:sdk-scheme-adapter:outbound:v2.0.0": "openapi bundle --output docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_0_0/outbound/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml",
+    "build:sdk-scheme-adapter:backend:v2.1.0": "openapi bundle --output docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_1_0/backend/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml",
+    "build:sdk-scheme-adapter:outbound:v2.1.0": "openapi bundle --output docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_1_0/outbound/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml",
+    "build:schemas:sdk-scheme-adapter:backend:v2.0.0": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_0_0/backend",
+    "build:schemas:sdk-scheme-adapter:outbound:v2.0.0": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_0_0/outbound",
+    "build:schemas:sdk-scheme-adapter:backend:v2.1.0": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_1_0/backend",
+    "build:schemas:sdk-scheme-adapter:outbound:v2.1.0": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_1_0/outbound",
     "lint": "eslint --ext ts --ext js test src",
     "lint:fix": "eslint --fix --ext ts --ext js test src",
-    "prepare": "npm run build",
+    "prepare": "husky install && npm run build",
     "dep:check": "ncu -e 2",
     "dep:update": "ncu -u",
     "release": "standard-version --releaseCommitMessageFormat 'chore(release): {{currentTag}} [skip ci]'",
     "snapshot": "standard-version --no-verify --skip.changelog --prerelease snapshot --releaseCommitMessageFormat 'chore(snapshot): {{currentTag}}'",
-    "test:unit": "jest --testMatch '**/test/dto/*.(test|spec).ts'"
+    "test": "npm run test:unit",
+    "test:unit": "jest --testMatch '**/test/dto/*.(test|spec).ts'",
+    "dev:watch": "browser-sync start --server 'docs' --cwd 'docs'  --files '*.yaml'"
   },
   "lint-staged": {
     "*.{js,ts}": "eslint --cache --fix"
@@ -58,12 +72,12 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.1.2",
-    "commander": "^11.0.0",
+    "commander": "^11.1.0",
     "jest-ts-auto-mock": "^2.1.0",
     "js-yaml": "^4.1.0",
     "json-refs": "^3.0.15",
     "openapi-types": "^12.1.3",
-    "openapi-typescript": "^6.5.3",
+    "openapi-typescript": "^6.7.1",
     "ts-auto-mock": "^3.7.1"
   },
   "overrides": {
@@ -71,37 +85,38 @@
     "@types/responselike": "^1.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.7.1",
-    "@commitlint/config-conventional": "^17.7.0",
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
     "@redocly/openapi-cli": "^1.0.0-beta.94",
-    "@types/jest": "^29.5.4",
-    "@typescript-eslint/eslint-plugin": "^6.4.1",
-    "@typescript-eslint/parser": "^6.4.1",
+    "@types/jest": "^29.5.9",
+    "@typescript-eslint/eslint-plugin": "^6.12.0",
+    "@typescript-eslint/parser": "^6.12.0",
     "audit-ci": "^6.6.1",
+    "browser-sync": "^2.29.3",
     "diff": "^5.1.0",
-    "eslint": "^8.47.0",
+    "eslint": "^8.54.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-import-resolver-typescript": "^3.6.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-cucumber": "^2.0.0",
-    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-standard": "^5.0.0",
     "husky": "8.0.3",
-    "jest": "^29.6.3",
+    "jest": "^29.7.0",
     "jest-junit": "^16.0.0",
-    "lint-staged": "^14.0.1",
-    "npm-check-updates": "^16.13.0",
-    "prettier": "^3.0.2",
+    "lint-staged": "^15.1.0",
+    "npm-check-updates": "^16.14.11",
+    "prettier": "^3.1.0",
     "standard-version": "^9.5.0",
     "swagger-cli": "^4.0.4",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
     "ts-patch": "^3.0.2",
     "tslib": "^2.6.2",
-    "typescript": "^5.1.6"
+    "typescript": "^5.3.2"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/sdk-bulk.yaml

@@ -17,7 +17,7 @@ info:
     the term "FSP" is equal to the term "DFSP".
   license:
     name: Apache License Version 2.0, January 2004
-    url: https://github.com/mojaloop/documentation/blob/master/LICENSE.md
+    url: https://github.com/mojaloop/documentation/blob/main/LICENSE.md
   version: 1.0.0
 paths:
   /:

package/sdk-outbound-old.yaml

@@ -17,7 +17,7 @@ info:
     the term "FSP" is equal to the term "DFSP".
   license:
     name: 'Apache License Version 2.0, January 2004'
-    url: 'https://github.com/mojaloop/documentation/blob/master/LICENSE.md'
+    url: 'https://github.com/mojaloop/documentation/blob/main/LICENSE.md'
   version: 2.0.0
 paths:
   /:

package/sdk-scheme-adapter/v2_0_0/components/schemas/getPartiesResponse.yaml

@@ -4,7 +4,6 @@ description: 'The object sent in the GET /parties/{Type}/{ID} callback.'
 properties:
   body:
     $ref: ./Party.yaml
-    description: Information regarding the requested Party.
   headers:
     type: object
 required:

package/sdk-scheme-adapter/v2_0_0/components/schemas/partiesByIdResponse.yaml

@@ -6,7 +6,6 @@ properties:
     properties:
       body:
         $ref: ./Party.yaml
-        description: Information regarding the requested Party.
       headers:
         type: object
     required:

package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayResponse.yaml

@@ -32,9 +32,4 @@ properties:
   transactionRequestResponse:
     $ref: ./TransactionRequestResponse.yaml
   lastError:
-    description: >
-      Object representing the last error to occur during a transfer process.
-      This may be a Mojaloop API error returned from another entity in the
-      scheme or an object representing other types of error e.g. exceptions that
-      may occur inside the scheme adapter.
     $ref: ./transferError.yaml

package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayTransferResponse.yaml

@@ -69,9 +69,4 @@ properties:
       headers:
         type: object
   lastError:
-    description: >
-      Object representing the last error to occur during a transfer process.
-      This may be a Mojaloop API error returned from another entity in the
-      scheme or an object representing other types of error e.g. exceptions that
-      may occur inside the scheme adapter.
     $ref: ./transferError.yaml

package/sdk-scheme-adapter/v2_0_0/components/schemas/simpleQuotesPostRequest.yaml

@@ -2,7 +2,6 @@ title: simpleQuotesPostRequest
 type: object
 properties:
   fspId:
-    title: destination DFSP requested to calculate the quote
     $ref: ./FspId.yaml
   quotesPostRequest:
     $ref: ./QuotesPostRequest.yaml

package/sdk-scheme-adapter/v2_0_0/components/schemas/transferError.yaml

@@ -1,7 +1,8 @@
 type: object
 description: >-
-  This object represents a Mojaloop API error received at any time during the
-  transfer process
+  This may be a Mojaloop API error returned from another entity in the
+  scheme or an object representing other types of error e.g. exceptions that
+  may occur inside the scheme adapter.
 properties:
   httpStatusCode:
     type: integer

package/sdk-scheme-adapter/v2_0_0/components/schemas/transferResponse.yaml

@@ -69,11 +69,6 @@ properties:
       headers:
         type: object
   lastError:
-    description: >
-      Object representing the last error to occur during a transfer process.
-      This may be a Mojaloop API error returned from another entity in the
-      scheme or an object representing other types of error e.g. exceptions that
-      may occur inside the scheme adapter.
     $ref: ./transferError.yaml
   skipPartyLookup:
     description: >-

package/sdk-scheme-adapter/v2_0_0/outbound/openapi.yaml

@@ -17,7 +17,7 @@ info:
     the term "FSP" is equal to the term "DFSP".
   license:
     name: Apache License Version 2.0, January 2004
-    url: https://github.com/mojaloop/documentation/blob/master/LICENSE.md
+    url: https://github.com/mojaloop/documentation/blob/main/LICENSE.md
   version: 1.0.0
 paths:
   /: