@mimik/api-helper 2.0.8 → 2.0.10

package/.nycrc

@@ -0,0 +1,4 @@
+{
+  "exclude": ["gulpfile.js"],
+  "reporter": ["lcov", "text"]
+}

package/README.md

@@ -4,65 +4,91 @@
 **Example**  
 ```js
 import apiHelper from '@mimik/api-helper';
-// or
+or
 import { apiSetup, securityLib, getAPIFile, validateSecuritySchemes, extractProperties, setupServerFiles } from '@mimik/api-helper';
 ```
 
 * [api-helper](#module_api-helper)
     * _async_
-        * [~apiSetup(setup, registeredOperations, securityHandlers, extraFormats, config, correlationId)](#module_api-helper..apiSetup) ⇒ <code>Promise.&lt;object&gt;</code>
-        * [~getAPIFile(apiFilename, correlationId, options)](#module_api-helper..getAPIFile) ⇒ <code>Promise.&lt;object&gt;</code>
-        * [~setupServerFiles(apiFilename, controllersDirectory, buildDirectory, correlationId, options)](#module_api-helper..setupServerFiles) ⇒ <code>Promise.&lt;object&gt;</code>
+        * [~securityLib(config)](#module_api-helper..securityLib)
+        * [~apiSetup(setup, registeredOperations, securityHandlers, extraFormats, config, correlationId)](#module_api-helper..apiSetup) ⇒ <code>Promise</code>
+        * [~getAPIFile(apiFilename, correlationId, options)](#module_api-helper..getAPIFile) ⇒ <code>Promise</code>
+        * [~setupServerFiles(apiFilename, controllersDirectory, buildDirectory, correlationId, options)](#module_api-helper..setupServerFiles) ⇒ <code>Promise</code>
     * _sync_
-        * [~securityLib(config)](#module_api-helper..securityLib) ⇒ <code>object</code>
-        * [~validateSecuritySchemes(apiDefinition, correlationId)](#module_api-helper..validateSecuritySchemes) ⇒ <code>Array.&lt;string&gt;</code>
-        * [~extractProperties(apiDefinition, controllersDirectory, buildDirectory, correlationId)](#module_api-helper..extractProperties) ⇒ <code>void</code>
+        * [~validateSecuritySchemes(apiDefinition, correlationId)](#module_api-helper..validateSecuritySchemes) ⇒
+        * [~extractProperties(apiDefinition, controllersDirectory, buildDirectory, correlationId)](#module_api-helper..extractProperties) ⇒
+
+<a name="module_api-helper..securityLib"></a>
+
+### api-helper~securityLib(config)
+Implement the security flows for the API.
+
+**Kind**: inner method of [<code>api-helper</code>](#module_api-helper)  
+**Category**: async  
+**Throws**:
+
+- <code>Promise</code> An error is thrown if the initiatilization failed.
+
+This function is used to setup the following security handlers for the API:
+- `SystemSecurity` - used for the system operations, like /system, /onbehalf
+- `AdminSecurity` - used for the admin operations, like /admin,
+- `UserSecurity` - used for the user operations, like /user,
+- `ApiKeySecurity` - used for the API key operations, like /apikey,
+The security handlers are used to validate the tokens and scopes for the API operations.
+
+**Requires**: <code>module:@mimik/swagger-helper</code>, <code>module:jsonwebtoken</code>, <code>module:lodash</code>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| config | <code>object</code> | Configuration of the service. &fulfil {object} The API file itself. |
 
 <a name="module_api-helper..apiSetup"></a>
 
-### api-helper~apiSetup(setup, registeredOperations, securityHandlers, extraFormats, config, correlationId) ⇒ <code>Promise.&lt;object&gt;</code>
-Setup the API to be used for a service
+### api-helper~apiSetup(setup, registeredOperations, securityHandlers, extraFormats, config, correlationId) ⇒ <code>Promise</code>
+Setup the API to be use for a service
 
 **Kind**: inner method of [<code>api-helper</code>](#module_api-helper)  
-**Returns**: <code>Promise.&lt;object&gt;</code> - The API file itself.  
+**Returns**: <code>Promise</code> - .
+&fulfil {object} The API file itself.  
 **Category**: async  
 **Throws**:
 
-- <code>Promise</code> An error is thrown if the initialization failed.
+- <code>Promise</code> An error is thrown if the initiatilization failed.
 
 The following scheme names are reserved: `SystemSecurity`, `AdminSecurity`, `UserSecurity`, `PeerSecurity`, `ApiKeySecurity`.
 The following security schemes can be defaulted: `SystemSecurity`, `AdminSecurity`, `UserSecurity`, `ApiKeySecurity`.
 The secOptions in the options property passed when using `init` allows the following operations:
 - introduce a customer security scheme, in this case secOptions contains: { newSecurityScheme: {function}newSecurityHandler },
 - disable a security scheme that is defined in the swagger API, in this case secOptions contains: { securitySchemeToDisable: { {boolean}notEnabled: true } },
-- overwrite an existing security scheme, in this case secOptions contains: { securitySchemeToOverwrite: {function}newSecurityHandler }.
+- overwite an existing security scheme, in this case secOptions contains: { securitySchemeToOverwrite: {function}newSecurityHandler }.
 If the secOptions is not present either to introduce, disable or overwrite a security scheme that is present in the swagger API file an error is generated.
 If the secOptions contains unused security schemes, an error is generated.
 
 The default formats for validation are: `date`, `time`, `date-time`, `byte`, `uuid`, `uri`, `email`, `ipv4`, `ipv6`, `semver`, `ip`.
 
-**Requires**: <code>module:@mimik/response-helper</code>, <code>module:@mimik/sumologic-winston-logger</code>, <code>module:lodash.difference</code>, <code>module:openapi-backend</code>  
+**Requires**: <code>module:@mimik/response-helper</code>, <code>module:@mimik/sumologic-winston-logger</code>, <code>module:@mimik/swagger-helper</code>, <code>module:ajv-formats</code>, <code>module:fs</code>, <code>module:jsonwebtoken</code>, <code>module:lodash</code>  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| setup | <code>object</code> | Object containing the apiFilename and the existing security schemes in the API definition. |
+| setup | <code>object</code> | Object containing the apiFilename and the exisiting security schemes in the API definition. |
 | registeredOperations | <code>object</code> | List of the operation to register for the API. |
 | securityHandlers | <code>object</code> | List of the security handlers to add for the service. |
-| extraFormats | <code>object</code> | list of the formats to add for validating properties. |
+| extraFormats | <code>object</code> | list of the formats to add for validatng properties. |
 | config | <code>object</code> | Configuration of the service. |
-| correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activities. |
+| correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activites. |
 
 <a name="module_api-helper..getAPIFile"></a>
 
-### api-helper~getAPIFile(apiFilename, correlationId, options) ⇒ <code>Promise.&lt;object&gt;</code>
-Gets the API file from swaggerhub and store it in the given PATH location.
+### api-helper~getAPIFile(apiFilename, correlationId, options) ⇒ <code>Promise</code>
+Gets the API file from swaggerhub and store it in the give PATH location.
 
 **Kind**: inner method of [<code>api-helper</code>](#module_api-helper)  
-**Returns**: <code>Promise.&lt;object&gt;</code> - The API file itself.  
+**Returns**: <code>Promise</code> - .
+&fulfil {object} The API file itself.  
 **Category**: async  
 **Throws**:
 
-- <code>Promise</code> An error is thrown if the apiFilename resolution generates an error or the request to the API provider fails or the file cannot be saved.
+- <code>Promise</code> An error is  thrown if the apiFilename resolution generates an error or the request to the API provider fails or the file connot be saved.
 
 `apiInfo` options has the following format:
 ``` javascript
@@ -72,29 +98,29 @@ Gets the API file from swaggerhub and store it in the given PATH location.
      "username": "username for bitbucket",
      "password": "password for bitbucket"
    },
-   "apiApiKey": "apiKey for access private API on swaggerhub, can be optional if the API is accessible publicly"
+   "apiApiKey": "apiKey for access private API on swaggerhub, can be optional if the API is accessible publically"
 }
-```
 
 **Requires**: <code>module:@mimik/request-retry</code>, <code>module:@mimik/response-helper</code>, <code>module:@mimik/sumologic-winston-logger</code>, <code>module:fs</code>, <code>module:js-yaml</code>, <code>module:path</code>  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | apiFilename | <code>PATH.&lt;string&gt;</code> | Name of the file where the API file will be stored. |
-| correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activities. |
+| correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activites. |
 | options | <code>object</code> | Options associated with the call. Use to pass `metrics` to `rpRetry` and `apiInfo` to access the api file in the api provider. |
 
 <a name="module_api-helper..setupServerFiles"></a>
 
-### api-helper~setupServerFiles(apiFilename, controllersDirectory, buildDirectory, correlationId, options) ⇒ <code>Promise.&lt;object&gt;</code>
+### api-helper~setupServerFiles(apiFilename, controllersDirectory, buildDirectory, correlationId, options) ⇒ <code>Promise</code>
 Setup and validates files for the server
 
 **Kind**: inner method of [<code>api-helper</code>](#module_api-helper)  
-**Returns**: <code>Promise.&lt;object&gt;</code> - The API file, the API filename, the existing known security schemes and the defined security schemes.  
+**Returns**: <code>Promise</code> - .
+&fulfil {object} The API file, the API filename, the existing known security schemes and the defined security schemes.  
 **Category**: async  
 **Throws**:
 
-- <code>Promise</code> An error is thrown for many reasons associated with getAPIFile or validateSecuritySchemes or extractProperties.
+- <code>Promise</code> An error is thrown for many reasons assocated with getAPIFile or validateSecuritySchemes or extractProperties.
 
 **Requires**: <code>module:@mimik/request-retry</code>, <code>module:@mimik/response-helper</code>, <code>module:@mimik/sumologic-winston-logger</code>, <code>module:fs</code>, <code>module:js-yaml</code>, <code>module:path</code>  
 
@@ -103,59 +129,39 @@ Setup and validates files for the server
 | apiFilename | <code>PATH.&lt;string&gt;</code> | Name of the file where the API file will be stored. |
 | controllersDirectory | <code>PATH.&lt;string&gt;</code> | Directory to find the controller files. |
 | buildDirectory | <code>PATH.&lt;string&gt;</code> | Directory where the register file will be stored. |
-| correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activities. |
-| options | <code>object</code> | Options associated with the call. Use to pass `metrics` to `rpRetry` and `apiKey` to access private API. |
-
-<a name="module_api-helper..securityLib"></a>
-
-### api-helper~securityLib(config) ⇒ <code>object</code>
-Implement the security flows for the API.
-
-**Kind**: inner method of [<code>api-helper</code>](#module_api-helper)  
-**Returns**: <code>object</code> - An object containing `SystemSecurity`, `AdminSecurity`, `UserSecurity`, and `ApiKeySecurity` handlers.
-
-This function is used to setup the following security handlers for the API:
-- `SystemSecurity` - used for the system operations, like /system, /onbehalf
-- `AdminSecurity` - used for the admin operations, like /admin,
-- `UserSecurity` - used for the user operations, like /user,
-- `ApiKeySecurity` - used for the API key operations, like /apikey,
-The security handlers are used to validate the tokens and scopes for the API operations.  
-**Category**: sync  
-**Requires**: <code>module:@mimik/swagger-helper</code>, <code>module:jsonwebtoken</code>, <code>module:lodash</code>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| config | <code>object</code> | Configuration of the service. |
+| correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activites. |
+| options | <code>object</code> | Options associated with the call. Use to pass `metrics` to `rpRetry` and `apiKey`` to access private API. |
 
 <a name="module_api-helper..validateSecuritySchemes"></a>
 
-### api-helper~validateSecuritySchemes(apiDefinition, correlationId) ⇒ <code>Array.&lt;string&gt;</code>
+### api-helper~validateSecuritySchemes(apiDefinition, correlationId) ⇒
 Validates the known SecuritySchemes: `SystemSecurity`, `AdminSecurity`, `UserSecurity`, `PeerSecurity`, `ApiKeySecurity`.
 
 **Kind**: inner method of [<code>api-helper</code>](#module_api-helper)  
-**Returns**: <code>Array.&lt;string&gt;</code> - An array of the known securitySchemes that are in the API definition.  
+**Returns**: An array of the known securitySchemes that are in the API definition.  
 **Category**: sync  
 **Throws**:
 
-- An error is thrown if a validation fails.
+- An error is thrown for the first validation fails.
 
 **Requires**: <code>module:@mimik/sumologic-winston-logger</code>, <code>module:@mimik/response-helper</code>  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | apiDefinition | <code>object</code> | JSON object containing the API definition. |
-| correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activities. |
+| correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activites. |
 
 <a name="module_api-helper..extractProperties"></a>
 
-### api-helper~extractProperties(apiDefinition, controllersDirectory, buildDirectory, correlationId) ⇒ <code>void</code>
-Extracts the properties from API definition and creates a file binding the handler with the controller operations.
+### api-helper~extractProperties(apiDefinition, controllersDirectory, buildDirectory, correlationId) ⇒
+Extracts the properties from API definiton and creates a file binding the handler with the controller operations.
 
 **Kind**: inner method of [<code>api-helper</code>](#module_api-helper)  
+**Returns**: null  
 **Category**: sync  
 **Throws**:
 
-- An error is thrown for many reasons, like operationId does not exist in controllers, controller does not exist...
+- An error is thrown for many reasons, like operationId does not exist in controllers, controller dies not exist...
 
 **Requires**: <code>module:@mimik/response-helper</code>, <code>module:@mimik/sumologic-winston-logger</code>, <code>module:fs</code>  
 
@@ -164,5 +170,5 @@ Extracts the properties from API definition and creates a file binding the handl
 | apiDefinition | <code>object</code> | JSON object containing the API definition. |
 | controllersDirectory | <code>PATH.&lt;string&gt;</code> | Directory to find the controller files. |
 | buildDirectory | <code>PATH.&lt;string&gt;</code> | Directory where the register file will be stored. |
-| correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activities. |
+| correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activites. |
 

package/eslint.config.js

@@ -1,4 +1,3 @@
-import globals from 'globals';
 import importPlugin from 'eslint-plugin-import';
 import js from '@eslint/js';
 import processDoc from '@mimik/eslint-plugin-document-env';
@@ -11,9 +10,6 @@ const MAX_LINES_IN_FUNCTION = 150;
 const MAX_STATEMENTS_IN_FUNCTION = 45;
 const MIN_KEYS_IN_OBJECT = 10;
 const MAX_COMPLEXITY = 30;
-const ECMA_VERSION = 'latest';
-const MAX_DEPTH = 6;
-const ALLOWED_CONSTANTS = [0, 1, -1];
 
 export default [
   {
@@ -27,18 +23,18 @@ export default [
       processDoc,
     },
     languageOptions: {
-      ecmaVersion: ECMA_VERSION,
+      ecmaVersion: 2022,
       globals: {
-        ...globals.mocha,
-        ...globals.nodeBuiltin,
+        console: 'readonly',
+        describe: 'readonly',
+        it: 'readonly',
+        require: 'readonly',
       },
       sourceType: 'module',
     },
     rules: {
       '@stylistic/brace-style': ['warn', 'stroustrup', { allowSingleLine: true }],
       '@stylistic/line-comment-position': ['off'],
-      '@stylistic/max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true, ignoreStrings: true, ignoreRegExpLiterals: true }],
-      '@stylistic/quotes': ['warn', 'single'],
       '@stylistic/semi': ['error', 'always'],
       'capitalized-comments': ['off'],
       'complexity': ['error', MAX_COMPLEXITY],
@@ -48,35 +44,20 @@ export default [
       'import/no-unresolved': ['error', { amd: true, caseSensitiveStrict: true, commonjs: true }],
       'init-declarations': ['off'],
       'linebreak-style': ['off'],
-      'max-depth': ['error', MAX_DEPTH],
-      'max-len': ['off'],
-      'max-lines': ['warn', { max: MAX_LINES_IN_FILES, skipComments: true, skipBlankLines: true }],
-      'max-lines-per-function': ['warn', { max: MAX_LINES_IN_FUNCTION, skipComments: true, skipBlankLines: true }],
+      'max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true }],
+      'max-lines': ['warn', { max: MAX_LINES_IN_FILES, skipComments: true }],
+      'max-lines-per-function': ['warn', { max: MAX_LINES_IN_FUNCTION, skipComments: true }],
       'max-params': ['error', MAX_FUNCTION_PARAMETERS],
       'max-statements': ['warn', MAX_STATEMENTS_IN_FUNCTION],
-      'no-confusing-arrow': ['off'],
+      'no-confusing-arrow': ['off'], // arrow isnt confusing
       'no-inline-comments': ['off'],
-      'no-magic-numbers': ['error', { ignore: ALLOWED_CONSTANTS, enforceConst: true, detectObjects: true }],
       'no-process-env': ['error'],
       'no-ternary': ['off'],
       'no-undefined': ['off'],
       'one-var': ['error', 'never'],
       'processDoc/validate-document-env': ['error'],
-      'quotes': ['off'],
-      'sort-imports': ['error', { allowSeparatedGroups: true }],
-      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false, allowLineSeparatedGroups: true }],
-    },
-  },
-  {
-    files: ['test/**/*.js'],
-    rules: {
-      'class-methods-use-this': ['off'],
-      'max-classes-per-file': ['off'],
-      'max-lines': ['off'],
-      'max-lines-per-function': ['off'],
-      'max-statements': ['off'],
-      'no-empty-function': ['off'],
-      'no-magic-numbers': ['off'],
+      'quotes': ['warn', 'single'],
+      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false }],
     },
   },
 ];