feat: added missing types and maintenance fixes (#428)

* feat: added missing types and maintenance fixes

* feat: added missing types and maintenance fixes

.nvmrc

@@ -1 +1 @@
-18.17.1
+18.20.4

CODEOWNERS

@@ -6,7 +6,7 @@
 ## @global-owner1 and @global-owner2 will be requested for
 ## review when someone opens a pull request.
 #*       @global-owner1 @global-owner2
-* @mdebarros @elnyry-sam-k @vijayg10 @kleyow @oderayi
+* @bushjames @elnyry-sam-k @vijayg10 @kleyow @oderayi @shashi165 @gibaros
 
 ## Order is important; the last matching pattern takes the most
 ## precedence. When someone opens a pull request that only

package.json

@@ -61,9 +61,9 @@
     "@hapi/catbox": "12.1.1",
     "@hapi/catbox-memory": "5.0.1",
     "@hapi/hapi": "21.3.12",
-    "@hapi/joi": "17.1.1",
     "@hapi/joi-date": "2.0.1",
     "@mojaloop/inter-scheme-proxy-cache-lib": "2.3.1",
+    "@mojaloop/sdk-standard-components": "19.6.3",
     "axios": "1.7.9",
     "clone": "2.1.2",
     "dotenv": "16.4.7",
@@ -72,6 +72,7 @@
     "fast-safe-stringify": "^2.1.1",
     "immutable": "5.0.3",
     "ioredis": "^5.4.2",
+    "joi": "17.13.3",
     "lodash": "4.17.21",
     "mustache": "4.2.0",
     "openapi-backend": "5.11.1",

src/index.d.ts

@@ -1,4 +1,5 @@
 import { Utils as HapiUtil, Server } from '@hapi/hapi'
+import { Joi } from 'joi'
 import { ILogger } from '@mojaloop/central-services-logger/src/contextLogger'
 
 declare namespace CentralServicesShared {
@@ -663,6 +664,9 @@ declare namespace CentralServicesShared {
   type ProtocolResources = string[]
   type ProtocolVersions = (string | symbol)[]
   type ApiTypeValues = 'fspiop' | 'iso20022'
+  type APIDocumentationPluginOptions = 
+  | { documentPath: string; document?: never }
+  | { document?: string; documentPath?: never }
 
   type LoggingPluginOptions = {
     log?: ILogger,
@@ -694,10 +698,40 @@ declare namespace CentralServicesShared {
       defaultProtocolResources: ProtocolResources
       defaultProtocolVersions: ProtocolVersions
     };
+    OpenapiBackendValidator: {
+      plugin: {
+        name: string,
+        register: (server: Server) => void
+      }
+    };
+    HapiEventPlugin: {
+      plugin: {
+        name: string,
+        register: (server: Server) => void
+      }      
+    };
+    customCurrencyCodeValidation: (joi: Joi) => {
+      base: Joi.StringSchema;
+      type: string;
+      messages: {
+        'currency.base': string;
+      };
+      rules: {
+        currency: {
+          validate: (value: string, helpers: any) => string | any;
+        };
+      };
+    };
+    APIDocumentation: {
+      plugin: {
+        name: string,
+        register: (server: Server, options: APIDocumentationPluginOptions) => void
+      }
+    };
     loggingPlugin: {
       name: string,
       register: (server: Server, options?: LoggingPluginOptions) => Promise<void>
-    }
+    };
     API_TYPES: Record<ApiTypeValues, ApiTypeValues>;
   }
   // todo: define the rest of the types

src/util/hapi/plugins/apiDocumentation.js

@@ -27,7 +27,7 @@ const APIDocBuilder = require('../../documentation').APIDocBuilder
 
 /**
  * Hapi plugin to add '/swagger.json' and '/documentation' endpoints.
- * It generates API documenation from supplied OpenAPI spec (json or yaml).
+ * It generates API documentation from supplied OpenAPI spec (json or yaml).
  *
  * options.documentPath - Full path to the OpenAPI (fka Swagger) document (JSON or YAML). Mutually exclusive to `document` option.
  * options.document     - OpenAPI document as string. Mutually exclusive to `documentPath` option.

src/util/hapi/plugins/headerValidation.js

@@ -6,7 +6,7 @@
 // accuracy of this statement has not been thoroughly tested.
 
 const { Factory: { createFSPIOPError }, Enums } = require('@mojaloop/central-services-error-handling')
-const RootJoi = require('@hapi/joi')
+const RootJoi = require('joi')
 const DateExtension = require('@hapi/joi-date')
 const Joi = RootJoi.extend(DateExtension)
 const { API_TYPES, MAX_CONTENT_LENGTH } = require('../../../constants')

test/unit/healthCheck/HealthCheck.test.js

@@ -26,7 +26,7 @@
 
 const Test = require('tapes')(require('tape'))
 const Sinon = require('sinon')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 
 const HealthCheck = require('../../../src/healthCheck').HealthCheck
 

test/unit/util/hapi/plugins/customCurrencyCodeExtension.test.js

@@ -24,7 +24,7 @@
  ******/
 
 const Test = require('tape')
-const BaseJoi = require('@hapi/joi')
+const BaseJoi = require('joi')
 const currencyExtension = require('../../../../../src/util/hapi/plugins/customCurrencyCodeExtension')
 const Joi = BaseJoi.extend(currencyExtension)
 

test/unit/util/hapi/plugins/rawPayloadToDataUri.test.js

@@ -27,7 +27,7 @@
 const Hapi = require('@hapi/hapi')
 const Test = require('tapes')(require('tape'))
 const Sinon = require('sinon')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const StreamingProtocol = require('../../../../../src/util').StreamingProtocol
 
 const init = async (options) => {