refactor: drop using internal modules (#258)

* fix: invalid deps

* refactor: cache module

* refactor: router module

* refactor: check module

* refactor: randomphrase & model modules

* refactor: shared module

* refactor: deferredJob module

* refactor: validate & shared & requests module

* fix: broken Dockerfile & lack of deps

* ci: fix linting smells

* refactor: api & typescript exports

.circleci/config.yml

@@ -187,8 +187,6 @@ jobs:
       - checkout
       - restore_cache:
           key: dependency-cache-v3-{{ checksum "src/package-lock.json" }}
-          paths:
-            - src/node_modules
       - run:
           name: Create dir for lint results
           command: cd src && mkdir -p /lintresults
@@ -207,8 +205,6 @@ jobs:
       - checkout
       - restore_cache:
           key: dependency-cache-v3-{{ checksum "src/package-lock.json" }}
-          paths:
-            - src/node_modules
       - run:
           name: Create dir for test results
           command: mkdir -p ./audit/results
@@ -217,7 +213,6 @@ jobs:
           command: cd src && npm run audit:check --silent -- --json > ../audit/results/auditResults.json
       - store_artifacts:
           path: ./audit/results
-          prefix: audit
 
   audit-licenses:
     executor: default-docker
@@ -230,14 +225,11 @@ jobs:
           <<: *defaults_license_scanner
       - restore_cache:
           key: dependency-cache-v3-{{ checksum "src/package-lock.json" }}
-          paths:
-            - src/node_modules
       - run:
           name: Run the license-scanner
           command: cd /tmp/license-scanner && pathToRepo=$CIRCLE_WORKING_DIRECTORY make run
       - store_artifacts:
           path: /tmp/license-scanner/results
-          prefix: licenses
 
   build-local:
     executor: default-machine
@@ -272,7 +264,6 @@ jobs:
           command: cd /tmp/license-scanner && mode=docker dockerImages=mojaloop/$CIRCLE_PROJECT_REPONAME:local make run
       - store_artifacts:
           path: /tmp/license-scanner/results
-          prefix: licenses
 
   image-scan:
     executor: anchore/anchore_engine
@@ -333,8 +324,6 @@ jobs:
       - checkout
       - restore_cache:
           key: dependency-cache-v3-{{ checksum "src/package-lock.json" }}
-          paths:
-            - src/node_modules
       - run:
           name: Configure git
           command: |

Dockerfile

@@ -11,14 +11,6 @@ WORKDIR /src/
 # relying on docker-compose.
 COPY ./src/package.json ./package.json
 COPY ./src/package-lock.json ./package-lock.json
-COPY ./src/lib/cache/package.json ./lib/cache/package.json
-COPY ./src/lib/check/package.json ./lib/check/package.json
-COPY ./src/lib/model/lib/requests/package.json ./lib/model/lib/requests/package.json
-COPY ./src/lib/model/lib/shared/package.json ./lib/model/lib/shared/package.json
-COPY ./src/lib/model/package.json ./lib/model/package.json
-COPY ./src/lib/randomphrase/package.json ./lib/randomphrase/package.json
-COPY ./src/lib/router/package.json ./lib/router/package.json
-COPY ./src/lib/validate/package.json ./lib/validate/package.json
 RUN npm ci --only=production
 
 FROM node:14.15-alpine

src/InboundServer/handlers.js

@@ -13,11 +13,11 @@
 
 'use strict';
 
-const Model = require('@internal/model').InboundTransfersModel;
-const PartiesModel = require('@internal/model').PartiesModel;
-const QuotesModel = require('@internal/model').QuotesModel;
-const TransfersModel = require('@internal/model').TransfersModel;
-const AuthorizationsModel = require('@internal/model').AuthorizationsModel;
+const Model = require('../lib/model').InboundTransfersModel;
+const PartiesModel = require('../lib/model').PartiesModel;
+const QuotesModel = require('../lib/model').QuotesModel;
+const TransfersModel = require('../lib/model').TransfersModel;
+const AuthorizationsModel = require('../lib/model').AuthorizationsModel;
 
 /**
  * Handles a GET /authorizations/{id} request

src/InboundServer/index.js

@@ -20,8 +20,8 @@ const EventEmitter = require('events');
 
 const { WSO2Auth } = require('@mojaloop/sdk-standard-components');
 
-const Validate = require('@internal/validate');
-const router = require('@internal/router');
+const Validate = require('../lib/validate');
+const router = require('../lib/router');
 const handlers = require('./handlers');
 const middlewares = require('./middlewares');
 

src/InboundServer/middlewares.js

@@ -10,7 +10,7 @@
 
 const coBody = require('co-body');
 
-const randomPhrase = require('@internal/randomphrase');
+const randomPhrase = require('../lib/randomphrase');
 const { Jws, Errors } = require('@mojaloop/sdk-standard-components');
 
 /**

src/OutboundServer/api.yaml

@@ -407,7 +407,7 @@ paths:
       operationId: PartiesByTypeAndID
       responses:
         '200':
-          $ref: '#/components/responses/partiesByIdResponse'
+          $ref: '#/components/responses/partiesByIdSuccess'
         '404':
           $ref: '#/components/responses/partiesByIdError404'
   '/parties/{Type}/{ID}/{SubId}':
@@ -427,7 +427,7 @@ paths:
       operationId: PartiesSubIdByTypeAndID
       responses:
         '200':
-          $ref: '#/components/responses/partiesByIdResponse'
+          $ref: '#/components/responses/partiesByIdSuccess'
         '404':
           $ref: '#/components/responses/partiesByIdError404'
   /quotes:
@@ -2115,6 +2115,19 @@ components:
         - WAITING_FOR_ACTION
         - COMPLETED
         - ERROR_OCCURRED
+    partiesByIdResponse:
+      title: partiesByIdResponse
+      type: object
+      description: 'GET /parties/{Type}/{ID} response object'
+      properties:
+        party:
+          $ref: '#/components/schemas/Party'
+          description: Information regarding the requested Party.
+        currentState:
+          $ref: '#/components/schemas/async2SyncCurrentState'
+      required:
+        - party
+        - currentState
     QuotesPostRequest:
       title: QuotesPostRequest
       type: object
@@ -2607,22 +2620,12 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/errorAccountsResponse'
-    partiesByIdResponse:
-      description: PartiesByIdResponse
+    partiesByIdSuccess:
+      description: PartiesByIdSuccess
       content:
         application/json:
           schema:
-            type: object
-            description: 'GET /parties/{Type}/{ID} response object'
-            properties:
-              party:
-                $ref: '#/components/schemas/Party'
-                description: Information regarding the requested Party.
-              currentState:
-                $ref: '#/components/schemas/async2SyncCurrentState'
-            required:
-              - party
-              - currentState
+            $ref: '#/components/schemas/partiesByIdResponse'
     partiesByIdError404:
       description: PartiesByIdError404
       content:

src/OutboundServer/api_interfaces/index.d.ts

@@ -91,6 +91,7 @@ export declare namespace Schemas {
   type PartyPersonalInfo = components["schemas"]["PartyPersonalInfo"];
   type Party = components["schemas"]["Party"];
   type async2SyncCurrentState = components["schemas"]["async2SyncCurrentState"];
+  type partiesByIdResponse = components["schemas"]["partiesByIdResponse"];
   type QuotesPostRequest = components["schemas"]["QuotesPostRequest"];
   type quotesPostRequest = components["schemas"]["quotesPostRequest"];
   type quotesPostResponse = components["schemas"]["quotesPostResponse"];

src/OutboundServer/api_interfaces/openapi.d.ts

@@ -288,14 +288,14 @@ export interface operations {
   /** The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by ,  and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1). */
   PartiesByTypeAndID: {
     responses: {
-      200: components["responses"]["partiesByIdResponse"];
+      200: components["responses"]["partiesByIdSuccess"];
       404: components["responses"]["partiesByIdError404"];
     };
   };
   /** The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by ,  and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1). */
   PartiesSubIdByTypeAndID: {
     responses: {
-      200: components["responses"]["partiesByIdResponse"];
+      200: components["responses"]["partiesByIdSuccess"];
       404: components["responses"]["partiesByIdError404"];
     };
   };
@@ -1085,6 +1085,12 @@ export interface components {
       | "WAITING_FOR_ACTION"
       | "COMPLETED"
       | "ERROR_OCCURRED";
+    /** GET /parties/{Type}/{ID} response object */
+    partiesByIdResponse: {
+      /** Information regarding the requested Party. */
+      party: components["schemas"]["Party"];
+      currentState: components["schemas"]["async2SyncCurrentState"];
+    };
     /** The object sent in the POST /quotes request. */
     QuotesPostRequest: {
       /** Common ID between the FSPs for the quote object, decided by the Payer FSP. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction. */
@@ -1341,14 +1347,10 @@ export interface components {
         "application/json": components["schemas"]["errorAccountsResponse"];
       };
     };
-    /** PartiesByIdResponse */
-    partiesByIdResponse: {
+    /** PartiesByIdSuccess */
+    partiesByIdSuccess: {
       content: {
-        "application/json": {
-          /** Information regarding the requested Party. */
-          party: components["schemas"]["Party"];
-          currentState: components["schemas"]["async2SyncCurrentState"];
-        };
+        "application/json": components["schemas"]["partiesByIdResponse"];
       };
     };
     /** PartiesByIdError404 */

src/OutboundServer/api_template/components/responses/partiesByIdSuccess.yaml

@@ -0,0 +1,5 @@
+description:  PartiesByIdSuccess
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/partiesByIdResponse.yaml

src/OutboundServer/api_template/components/schemas/partiesByIdResponse.yaml

@@ -0,0 +1,13 @@
+  title: partiesByIdResponse
+  type: object
+  description: 'GET /parties/{Type}/{ID} response object'
+  properties:
+    party:
+      $ref: >-
+        ../../../../node_modules/@mojaloop/api-snippets/thirdparty/openapi3/components/schemas/Party.yaml
+      description: Information regarding the requested Party.
+    currentState:
+      $ref: ../schemas/async2SyncCurrentState.yaml
+  required:
+    - party
+    - currentState

src/OutboundServer/api_template/paths/parties_Type_ID.yaml

@@ -15,6 +15,6 @@ get:
   operationId: PartiesByTypeAndID
   responses:
     '200':
-      $ref: ../components/responses/partiesByIdResponse.yaml
+      $ref: ../components/responses/partiesByIdSuccess.yaml
     '404':
       $ref: ../components/responses/partiesByIdError404.yaml

src/OutboundServer/api_template/paths/parties_Type_ID_SubId.yaml

@@ -17,6 +17,6 @@ get:
   operationId: PartiesSubIdByTypeAndID
   responses:
     '200':
-      $ref: ../components/responses/partiesByIdResponse.yaml
+      $ref: ../components/responses/partiesByIdSuccess.yaml
     '404':
       $ref: ../components/responses/partiesByIdError404.yaml

src/OutboundServer/handlers.js

@@ -25,7 +25,7 @@ const {
     QuotesModel,
     TransfersModel,
     AuthorizationsModel
-} = require('@internal/model');
+} = require('../lib/model');
 
 
 /**

src/OutboundServer/index.js

@@ -20,8 +20,8 @@ const cors = require('@koa/cors');
 
 const { WSO2Auth } = require('@mojaloop/sdk-standard-components');
 
-const Validate = require('@internal/validate');
-const router = require('@internal/router');
+const Validate = require('../lib/validate');
+const router = require('../lib/router');
 const handlers = require('./handlers');
 const middlewares = require('./middlewares');
 

src/OutboundServer/middlewares.js

@@ -9,7 +9,7 @@
  **************************************************************************/
 
 
-const { ProxyModel } = require('@internal/model');
+const { ProxyModel } = require('../lib/model');
 const { applyState, createErrorHandler, createLogger, createRequestIdGenerator } =
     require('../InboundServer/middlewares');
 

src/TestServer/index.js

@@ -16,8 +16,8 @@ const yaml = require('js-yaml');
 const fs = require('fs').promises;
 const path = require('path');
 
-const Validate = require('@internal/validate');
-const router = require('@internal/router');
+const Validate = require('../lib/validate');
+const router = require('../lib/router');
 const handlers = require('./handlers');
 const middlewares = require('../InboundServer/middlewares');
 

src/index.d.ts

@@ -1,5 +1 @@
-import * as OutboundAPI from './OutboundServer/api_interfaces';
-declare const _default: {
-  OutboundAPI: typeof OutboundAPI;
-};
-export default _default;
+export * as OutboundAPI from './OutboundServer/api_interfaces';

src/index.js

@@ -23,10 +23,10 @@ const TestServer = require('./TestServer');
 // scheme adapter as a service
 const InboundServerMiddleware = require('./InboundServer/middlewares.js');
 const OutboundServerMiddleware = require('./OutboundServer/middlewares.js');
-const Router = require('@internal/router');
-const Validate = require('@internal/validate');
-const RandomPhrase = require('@internal/randomphrase');
-const Cache = require('@internal/cache');
+const Router = require('./lib/router');
+const Validate = require('./lib/validate');
+const RandomPhrase = require('./lib/randomphrase');
+const Cache = require('./lib/cache');
 const { Logger } = require('@mojaloop/sdk-standard-components');
 
 /**

src/lib/model/Async2SyncModel.js

@@ -13,7 +13,7 @@ const util = require('util');
 
 const PSM = require('./common').PersistentStateMachine;
 const MojaloopRequests = require('@mojaloop/sdk-standard-components').MojaloopRequests;
-const deferredJob = require('@internal/shared/deferredJob');
+const deferredJob = require('./lib').deferredJob;
 
 function generate({
     /**