@mimik/api-helper 2.0.0 → 2.0.2

package/README.md

@@ -13,10 +13,10 @@ import { apiSetup, securityLib, getAPIFile, validateSecuritySchemes, extractProp
         * [~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, buidDirectory, correlationId, options)](#module_api-helper..setupServerFiles) ⇒ <code>Promise</code>
+        * [~setupServerFiles(apiFilename, controllersDirectory, buildDirectory, correlationId, options)](#module_api-helper..setupServerFiles) ⇒ <code>Promise</code>
     * _sync_
         * [~validateSecuritySchemes(apiDefinition, correlationId)](#module_api-helper..validateSecuritySchemes) ⇒
-        * [~extractProperties(apiDefinition, controllersDirectory, buidDirectory, correlationId)](#module_api-helper..extractProperties) ⇒
+        * [~extractProperties(apiDefinition, controllersDirectory, buildDirectory, correlationId)](#module_api-helper..extractProperties) ⇒
 
 <a name="module_api-helper..securityLib"></a>
 
@@ -29,7 +29,7 @@ Implement the security flows for the API.
 
 - <code>Promise</code> An error is thrown if the initiatilization failed.
 
-This function is used to setup the followung security handlers for the API:
+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,
@@ -111,7 +111,7 @@ Gets the API file from swaggerhub and store it in the give PATH location.
 
 <a name="module_api-helper..setupServerFiles"></a>
 
-### api-helper~setupServerFiles(apiFilename, controllersDirectory, buidDirectory, correlationId, options) ⇒ <code>Promise</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)  
@@ -128,7 +128,7 @@ 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. |
-| buidDirectory | <code>PATH.&lt;string&gt;</code> | = Directory where the register file will be stored. |
+| 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 activites. |
 | options | <code>object</code> | Options associated with the call. Use to pass `metrics` to `rpRetry` and `apiKey`` to access private API. |
 
@@ -153,7 +153,7 @@ Validates the known SecuritySchemes: `SystemSecurity`, `AdminSecurity`, `UserSec
 
 <a name="module_api-helper..extractProperties"></a>
 
-### api-helper~extractProperties(apiDefinition, controllersDirectory, buidDirectory, correlationId) ⇒
+### 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)  
@@ -169,6 +169,6 @@ Extracts the properties from API definiton and creates a file binding the handle
 | --- | --- | --- |
 | apiDefinition | <code>object</code> | JSON object containing the API definition. |
 | controllersDirectory | <code>PATH.&lt;string&gt;</code> | Directory to find the controller files. |
-| buidDirectory | <code>PATH.&lt;string&gt;</code> | = Directory where the register file will be stored. |
+| 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 activites. |
 

package/index.js

@@ -67,7 +67,7 @@ const POSTFIX_INDEX = 3;
  * &fulfil {object} The API file itself.
  * @throws {Promise} An error is thrown if the initiatilization failed.
  *
- * This function is used to setup the followung security handlers for the API:
+ * 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,
@@ -406,7 +406,7 @@ export const validateSecuritySchemes = (apiDefinition, correlationId) => {
  * @requires fs
  * @param {object} apiDefinition - JSON object containing the API definition.
  * @param {PATH.<string>} controllersDirectory - Directory to find the controller files.
- * @param {PATH.<string>} buidDirectory = Directory where the register file will be stored.
+ * @param {PATH.<string>} buildDirectory - Directory where the register file will be stored.
  * @param {UUID.<string>} correlationId - CorrelationId when logging activites.
  * @return null
  * @throws An error is thrown for many reasons, like operationId does not exist in controllers, controller dies not exist...
@@ -492,7 +492,7 @@ export const extractProperties = (apiDefinition, controllersDirectory, buildDire
  * @requires path
  * @param {PATH.<string>} apiFilename -  Name of the file where the API file will be stored.
  * @param {PATH.<string>} controllersDirectory - Directory to find the controller files.
- * @param {PATH.<string>} buidDirectory = Directory where the register file will be stored.
+ * @param {PATH.<string>} buildDirectory - Directory where the register file will be stored.
  * @param {UUID.<string>} correlationId - CorrelationId when logging activites.
  * @param {object} options - Options associated with the call. Use to pass `metrics` to `rpRetry` and `apiKey`` to access private API.
  * @return {Promise}.

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@mimik/api-helper",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "helper for openAPI backend and mimik service",
   "main": "./index.js",
-  "type": "module",  "scripts": {
+  "type": "module",  
+  "scripts": {
     "lint": "eslint . --no-error-on-unmatched-pattern",
     "docs": "jsdoc2md index.js > README.md",
     "test": "echo \"Error: no test specified\" && exit 0",
@@ -47,7 +48,7 @@
   "devDependencies": {
     "@eslint/js": "9.31.0",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
-    "@stylistic/eslint-plugin": "5.2.0",
+    "@stylistic/eslint-plugin": "5.2.2",
     "eslint": "9.31.0",
     "eslint-plugin-import": "2.32.0",
     "husky": "9.1.7",