chore: setting up core connector template

TEMPLATE.md

@@ -50,6 +50,11 @@ git clone https://github.com/mojaloop/ml-reference-connectors.git
 To understand the code structure and how to refactor this code base for a new connector, please refer to the section for [code structure](#core-structure-and-architecture)
 
 # Core structure and Architecture
+
+Below is an output of the directory structure of the core connector template.
+
+To use this template, you will need to understand it's structure, the changing components and the static components which you should not worry about.
+
 ```bash
 .
 ├── Dockerfile
@@ -81,7 +86,8 @@ To understand the code structure and how to refactor this code base for a new co
 
 12 directories, 15 files
 ```
-<!-- todo: add code structure -->
+# Components 
+The template contains the
 
 # Configuration.
 All configuration for any core connector should be put in environment variables.

core-connector-template/.env.example

@@ -1,3 +1,5 @@
+# CBS Config
+
 FINERACT_TENANT_ID=default
 FINERACT_AUTH_MODE=basic
 FINERACT_USERNAME=mifos
@@ -8,10 +10,14 @@ FINERACT_BANK_COUNTRY_CODE=UG
 FINERACT_CHECK_DIGITS=68
 FINERACT_LOCALE=en
 FINERACT_PAYMENT_TYPE_ID=1
-SDK_SERVER_HOST=0.0.0.0
-SDK_SERVER_PORT=3003
 DFSP_SERVER_HOST=0.0.0.0
 DFSP_SERVER_PORT=3004
 #Do not put the trailing slash on the url
 FINERACT_BASE_URL=https://demo.mifos.io/fineract-provider/api/v1
-SDK_BASE_URL=http://localhost:4010
+SUPPORTED_ID_TYPE=MSISDN
+
+#Mojaloop Connector
+#Do not put the trailing slash on the url
+SDK_BASE_URL=http://localhost:4010
+SDK_SERVER_HOST=0.0.0.0
+SDK_SERVER_PORT=3003

core-connector-template/package.json

@@ -1,12 +1,13 @@
 {
-  "name": "@mojaloop/mifos-core-connector",
+  "name": "@mojaloop/core-connector-template",
   "version": "1.3.0",
   "description": "A connector that facilitates payments between a Mojaloop Connector (SDK Scheme Adapter) and a Core Banking system",
   "main": "dist/index.js",
   "scripts": {
     "test": "npm run test:unit",
     "test:functional": "jest --testMatch='**/func/**/*.test.ts' --coverage --collectCoverageFrom='**/src/**/*.ts' --detectOpenHandles",
     "test:unit": "jest --testMatch='**/unit/**/*.test.ts'",
+    "test:int": "jest --testMatch='**/int/**/*.test.ts'",
     "test:unit:cov": "npm run test:unit -- --coverage",
     "prepare": "husky || true",
     "clean": "npm run clean:npm; npm run clean:dist",
@@ -15,8 +16,8 @@
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "build": "tsc",
-    "build:docker": "docker build -t mifos-core-connector:local .",
-    "start:docker": "npm run build:docker && docker run -p 127.0.0.1:3000:3000/tcp mifos-core-connector:local",
+    "build:docker": "docker build -t core-connector-template:local .",
+    "start:docker": "npm run build:docker && docker run -p 127.0.0.1:3000:3000/tcp core-connector-template:local",
     "watch": "tsc -w",
     "start": "npm run start:no-build",
     "start:no-build": "node dist/src/index.js",
@@ -30,17 +31,17 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/mojaloop/mifos-core-connector.git"
+    "url": "https://github.com/mojaloop/core-connector-template.git"
   },
   "keywords": [
     "g2p"
   ],
   "author": "Elijah Okello",
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/mojaloop/mifos-core-connector/issues"
+    "url": "https://github.com/mojaloop/core-connector-template/issues"
   },
-  "homepage": "https://github.com/mojaloop/mifos-core-connector#readme",
+  "homepage": "https://github.com/mojaloop/core-connector-template#readme",
   "devDependencies": {
     "@commitlint/cli": "^18.6.1",
     "@commitlint/config-conventional": "^18.6.3",
@@ -72,7 +73,7 @@
     "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@hapi/hapi": "^21.3.10",
+    "@hapi/hapi": "^21.3.10", 
     "@mojaloop/central-services-logger": "^11.3.1",
     "axios": "^1.6.8",
     "convict": "^6.2.4",

core-connector-template/src/config.ts

@@ -1,3 +1,4 @@
+import "dotenv/config";
 import Convict from 'convict';
 import { IdType, TFineractConfig } from './domain/CBSClient';
 import { TSDKSchemeAdapterConfig } from './domain/SDKClient';

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

@@ -35,7 +35,7 @@ import config from '../config';
 import { CoreConnectorRoutes } from './coreConnectorRoutes';
 import { loggerFactory } from '../infra/logger';
 import { createPlugins } from '../plugins';
-import { FineractClientFactory } from '../domain/CBSClient';
+import { CBSClientFactory } from '../domain/CBSClient';
 import { SDKClientFactory } from '../domain/SDKClient';
 import { DFSPCoreConnectorRoutes } from './dfspCoreConnectorRoutes';
 
@@ -50,7 +50,7 @@ export class Service {
     static async start(httpClient: IHTTPClient = AxiosClientFactory.createAxiosClientInstance()) {
         this.httpClient = httpClient;
         const fineractConfig = config.get('fineract');
-        const fineractClient = FineractClientFactory.createClient({
+        const fineractClient = CBSClientFactory.createClient({
             fineractConfig: fineractConfig,
             httpClient: this.httpClient,
             logger: logger,

core-connector-template/src/domain/CBSClient/CBSClient.ts

@@ -53,7 +53,7 @@ export const ROUTES = Object.freeze({
     charges: 'charges',
 });
 
-export class FineractClient implements IFineractClient {
+export class CBSClient implements IFineractClient {
     fineractConfig: TFineractConfig;
     httpClient: IHTTPClient;
     logger: ILogger;

core-connector-template/src/domain/CBSClient/CBSClientFactory.ts

@@ -26,12 +26,12 @@
  ******/
 'use strict';
 
-import { FineractClient } from './FineractClient';
+import { CBSClient } from './CBSClient';
 import { TFineractClientFactoryDeps } from './types';
 
-export class FineractClientFactory {
+export class CBSClientFactory {
     static createClient(finClientfactoryDeps: TFineractClientFactoryDeps) {
-        return new FineractClient(
+        return new CBSClient(
             finClientfactoryDeps.fineractConfig,
             finClientfactoryDeps.httpClient,
             finClientfactoryDeps.logger,

core-connector-template/src/domain/CBSClient/index.ts

@@ -26,7 +26,7 @@
  ******/
 'use strict';
 
-export * from './FineractClientFactory';
-export * from './FineractClient';
+export * from './CBSClientFactory';
+export * from './CBSClient';
 export * from './errors';
 export * from './types';

core-connector-template/src/domain/CBSClient/types.ts

@@ -290,3 +290,5 @@ export type TFineractCharge = {
 };
 
 export type TFineractGetChargeResponse = TFineractCharge[];
+
+

core-connector-template/test/func/fineract_client.test.ts

@@ -26,7 +26,7 @@
  ******/
 'use strict';
 
-import { FineractClientFactory, TFineractConfig } from '../../src/domain/CBSClient';
+import { CBSClientFactory, TFineractConfig } from '../../src/domain/CBSClient';
 import { loggerFactory } from '../../src/infra/logger';
 import config from '../../src/config';
 import { AxiosClientFactory } from '../../src/infra/axiosHttpClient';
@@ -35,7 +35,7 @@ const logger = loggerFactory({ context: 'Mifos Core Connector Tests' });
 const fineractConfig = config.get('fineract') as TFineractConfig;
 
 const httpClient = AxiosClientFactory.createAxiosClientInstance();
-const fineractClient = FineractClientFactory.createClient({
+const fineractClient = CBSClientFactory.createClient({
     fineractConfig,
     httpClient,
     logger,

core-connector-template/test/unit/domain/coreConnectorAgg.test.ts

@@ -27,7 +27,7 @@ import axios from 'axios';
 import MockAdapter from 'axios-mock-adapter';
 
 import { CoreConnectorAggregate, TtransferRequest, ValidationError } from '../../../src/domain';
-import { FineractClientFactory, FineractError, IFineractClient } from '../../../src/domain/CBSClient';
+import { CBSClientFactory, FineractError, IFineractClient } from '../../../src/domain/CBSClient';
 import {
     ISDKClient,
     SDKClientError,
@@ -61,7 +61,7 @@ describe('CoreConnectorAggregate Tests -->', () => {
         mockAxios.reset();
         const httpClient = AxiosClientFactory.createAxiosClientInstance();
         sdkClient = SDKClientFactory.getSDKClientInstance(logger, httpClient, SDK_URL);
-        fineractClient = FineractClientFactory.createClient({
+        fineractClient = CBSClientFactory.createClient({
             fineractConfig,
             httpClient,
             logger,

core-connector-template/test/unit/index.test.ts

@@ -27,7 +27,7 @@
 import { randomUUID } from 'crypto';
 import { AxiosClientFactory } from '../../src/infra/axiosHttpClient';
 import config from '../../src/config';
-import { FineractClientFactory } from '../../src/domain/CBSClient';
+import { CBSClientFactory } from '../../src/domain/CBSClient';
 import { TFineractConfig } from '../../src/domain/CBSClient';
 import { loggerFactory } from '../../src/infra/logger';
 import { CoreConnectorAggregate, TQuoteRequest, TtransferRequest } from '../../src/domain';
@@ -37,7 +37,7 @@ const logger = loggerFactory({ context: 'Mifos Core Connector Tests' });
 const fineractConfig = config.get('fineract') as TFineractConfig;
 
 const httpClient = AxiosClientFactory.createAxiosClientInstance();
-const fineractClient = FineractClientFactory.createClient({
+const fineractClient = CBSClientFactory.createClient({
     fineractConfig,
     httpClient,
     logger,