Merge pull request #23 from mojaloop/ft/core-connector-template

feat: core connector template documentation

.gitignore

@@ -5,4 +5,8 @@
 .idea/
 
 # Node
-node_modules/
+node_modules/
+
+#Environment
+dist/
+.env

.husky/commit-msg

@@ -1 +1,3 @@
+#!/bin/bash
+
 npx --no -- commitlint --edit $1

.husky/pre-commit

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 for dir in */; do
     if [[ $dir == *-core-connector/ ]]; then
     cd $dir 

.husky/pre-push

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 for dir in */; do
     if [[ $dir == *-core-connector/ ]]; then
     cd $dir 

README.md

@@ -49,6 +49,5 @@ npm i
 ```
 
 # Building the core connector
-To build a new core connector refer to the core connector template guide [here](./TEMPLATE.md) to refactor your newly created connector for the new dfsp
-
+To build a new core connector refer to the core connector template guide [here](./docs/README.md) to refactor your newly created connector for the new dfsp
 

airtel-core-connector/package.json

@@ -63,7 +63,7 @@
     "eslint-plugin-promise": "^6.1.1",
     "husky": "^9.0.11",
     "jest": "^29.7.0",
-    "lint-staged": "^15.2.9",
+    "lint-staged": "^15.2.10",
     "nodemon": "^3.0.3",
     "npm-check-updates": "^16.14.20",
     "npm-run-all": "^4.1.5",

core-connector-template/.env.example

@@ -9,6 +9,8 @@ DFSP_SERVER_HOST=0.0.0.0
 DFSP_SERVER_PORT=3004
 SDK_SERVER_HOST=0.0.0.0
 SDK_SERVER_PORT=3003
+DFSP_API_SPEC_FILE=./src/api-spec/core-connector-api-spec-dfsp.yml
+SDK_API_SPEC_FILE=./src/api-spec/core-connector-api-spec-sdk.yml
 
 #Mojaloop Connector
 #Do not put the trailing slash on the url

core-connector-template/src/api-spec/core-connector-api-spec-dfsp.yml

@@ -43,6 +43,7 @@ paths:
   /send-money:
     post:
       summary: Send Money endpoint 
+      operationId: sendMoney
       description: >- 
         The Endpoint used by the DFSP Operations application to initiate send money 
         requests to the mojaloop connector
@@ -76,6 +77,7 @@ paths:
   /send-money/{id}:
     put:
       summary: Confirm send money
+      operationId: sendMoneyUpdate
       parameters:
         - name: id
           in: path
@@ -249,7 +251,6 @@ components:
           example: "1.10"
         expiryDateTime:
           type: string
-          format: date-time
           example: "2024-08-01T12:00:00Z"
     sendMoneyResponse:
       type: object
@@ -274,7 +275,6 @@ components:
           example: "1.10"
         expiryDateTime:
           type: string
-          format: date-time
           example: "2024-08-01T12:00:00Z"
     sendMoneyRequest:
       type: object
@@ -311,7 +311,6 @@ components:
           example: "9876543210"
         dateOfBirth:
           type: string
-          format: date
           example: "1985-04-12"
         geoLocationData:
           description: >-

core-connector-template/src/config.ts

@@ -1,6 +1,5 @@
 import "dotenv/config";
 import Convict from 'convict';
-import { TSDKSchemeAdapterConfig } from './domain/SDKClient';
 import { TCBSConfig } from "./domain/CBSClient";
 
 interface IConfigSchema {
@@ -9,8 +8,12 @@ interface IConfigSchema {
         SDK_SERVER_PORT: number;
         DFSP_SERVER_HOST: string;
         DFSP_SERVER_PORT: number;
+        DFSP_API_SPEC_FILE: string;
+        SDK_API_SPEC_FILE: string;
     };
-    sdkSchemeAdapter: TSDKSchemeAdapterConfig;
+    sdkSchemeAdapter: {
+        SDK_BASE_URL: string;
+    }
     cbs:TCBSConfig;
 }
 
@@ -40,6 +43,18 @@ const config = Convict<IConfigSchema>({
             default: null, // required
             env: 'DFSP_SERVER_PORT',
         },
+        DFSP_API_SPEC_FILE: {
+            doc: 'DFSP operations app Server host',
+            format: String,
+            default: null, // required
+            env: 'DFSP_API_SPEC_FILE',
+        },
+        SDK_API_SPEC_FILE: {
+            doc: 'DFSP operations app Server host',
+            format: String,
+            default: null, // required
+            env: 'SDK_API_SPEC_FILE',
+        },
     },
     sdkSchemeAdapter: {
         SDK_BASE_URL: {

core-connector-template/src/core-connector-svc/dfspCoreConnectorRoutes.ts

@@ -32,14 +32,23 @@ import { Request, ResponseToolkit, ServerRoute } from '@hapi/hapi';
 import OpenAPIBackend, { Context } from 'openapi-backend';
 import { BaseRoutes } from './BaseRoutes';
 import { TCbsSendMoneyRequest, TCBSUpdateSendMoneyRequest } from 'src/domain/CBSClient';
+import config from '../config';
 
-const API_SPEC_FILE = './src/api-spec/core-connector-api-spec-dfsp.yml';
+const API_SPEC_FILE = config.get("server.DFSP_API_SPEC_FILE");
 
 export class DFSPCoreConnectorRoutes extends BaseRoutes {
     private readonly aggregate: CoreConnectorAggregate;
     private readonly routes: ServerRoute[] = [];
     private readonly logger: ILogger;
 
+    // Register openapi spec operationIds and route handler functions here
+    private readonly handlers = {
+        sendMoney: this.initiateTransfer.bind(this),
+        sendMoneyUpdate: this.updateInitiatedTransfer.bind(this),
+        validationFail: async (context: Context, req: Request, h: ResponseToolkit) => h.response({ error: context.validation.errors }).code(412),
+        notFound: async (context: Context, req: Request, h: ResponseToolkit) => h.response({ error: 'Not found' }).code(404),
+    };
+
     constructor(aggregate: CoreConnectorAggregate, logger: ILogger) {
         super();
         this.aggregate = aggregate;
@@ -49,12 +58,7 @@ export class DFSPCoreConnectorRoutes extends BaseRoutes {
     async init() {
         const api = new OpenAPIBackend({
             definition: API_SPEC_FILE,
-            handlers: {
-                transfers: this.initiateTransfer.bind(this),
-                updateTransfer: this.updateInitiatedTransfer.bind(this),
-                validationFail: async (context, req, h) => h.response({ error: context.validation.errors }).code(412),
-                notFound: async (context, req, h) => h.response({ error: 'Not found' }).code(404),
-            },
+            handlers: this.getHandlers(),
         });
 
         await api.init();
@@ -90,6 +94,10 @@ export class DFSPCoreConnectorRoutes extends BaseRoutes {
         return this.routes;
     }
 
+    private getHandlers(){
+        return this.handlers;
+    }
+
     private async initiateTransfer(context: Context, request: Request, h: ResponseToolkit) {
         const transfer = request.payload as TCbsSendMoneyRequest;
         try {