@mimik/local 6.0.12 → 7.0.0

package/README.md

@@ -1,7 +1,7 @@
 <a name="module_local"></a>
 
 ## local
-Set of function for local deployment.
+Set of functions for local deployment.
 
 The following files are expected to exist:
 In the directory above the server root directory: `mSTConfig.json`, `mIDConfig.json`, `mITConfig.json`,`sumoLog.json`, `kinesisLog.json`, `s3Log.json`, `customerConfig.json`, `key.json`, `locationConfig.json` are being set. If they don't exist at the launch of the script, default will be setup.
@@ -63,9 +63,9 @@ Similar properties than for mSTConfig on `domainName` and `port` apply.
    "region": "region of the Kinesis implementation",
    "accessKeyId": "access key id of Kinesis",
    "secretAccessKey": "secret access key for Kinesis",
-   "streamNameInfo": "name of the kiniesis stream for info",
-   "streamNameError": "name of the kiniesis stream for error",
-   "streamNameOther": "name of the kiniesis stream for all the other levels"
+   "streamNameInfo": "name of the Kinesis stream for info",
+   "streamNameError": "name of the Kinesis stream for error",
+   "streamNameOther": "name of the Kinesis stream for all the other levels"
  }
 ```
 - for `s3Log.json`:
@@ -103,7 +103,7 @@ See `mST` `README.md` file for an example of a customer configuration. This may
 - in the `local` directory of the server root directory: two files `start.json` and `testStart.json` may exit. `start.json` is used when `npm start` is executed, `testStart.json` is used when `npm test` is executed.
 If the files don't exist `exampe-start.json` is used to create `start.json` and `testStart.json`.
 Additionally `example-testStart.json` is used when to create `testStart.json`. The values in `example-testStart.json` take precedence over the values in `example-start.json`.
-The configuration of these files depends on the configuration parameters of the server. If the files
+The configuration of these files depends on the configuration parameters of the server.
 The following is an example of start.json file for `mIT`:
 ``` javascript
  {
@@ -119,11 +119,11 @@ The following is an example of start.json file for `mIT`:
  }
 ```
 While all the files use the `.json` extension it is still possible to add comments `//` in the file to make the file more explicit or to remove some parameters.
-There are reserved environement variable used by the library for configuration:
+There are reserved environement variables used by the library for configuration:
 - `oauthImplicitNeeded`: if the service handles user token the implicit configuration is needed
 - `mIDNeeded`: if the service has mID as a target
 - `locationNeeded`: if location translation is needed
-- `standAlone`: if the service need to be operated without other service. If the service has targets most likely 500 errors will be generated
+- `standAlone`: if the service needs to be operated without other service. If the service has targets most likely 500 errors will be generated
 
 If SERVER_ID is not set in the start.json or testStart.json file, SERVER_ID will be assigned with a uuid.v4.
 
@@ -131,7 +131,7 @@ For test in json file (`server-test.json`) is created in `.`.
 This file contains informations needed to start the test:
 ``` javascript
  {
-   "start": "information needed to setup the environement variable for the test",
+   "start": "information needed to setup the environement variables for the test",
    "CUSTOMER_NAME": "name of the customer to setup customer config",
    "CUSTOMER_CODE": "code of the customer to setup coustomer config, `not available for MST`",
    "BASE_PATH": "base path of the API",
@@ -144,7 +144,9 @@ In standAlone mode the test can easily get the token using `oauth-helper-temp`.
 
 **Example**  
 ```js
-const local = require('@mimik/local');
+import local from '@mimik/local';
+or
+import { mSTTestSetup, mSTSetup, mITTestSetup, mITSetup, testSetup, setup, dotFiles, scripts, unScripts, commitCheckMsg, start2process, testJsonFile} from '@mimik/local';
 ```
 
 * [local](#module_local)
@@ -179,7 +181,7 @@ The following files are needed to perform these actions:
 | `../s3Log.json` | The S3 information
 | `../mSTConfig.json` | The config for mST
 | `../mITConfig.json` | The config for mIT
-| `./local/testStart.json` | The local configuration. If it does not exist start.json and if sart.json does not exist start-example.json will be used to create start.json  
+| `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json  
 **Category**: sync  
 <a name="module_local..mSTSetup"></a>
 
@@ -226,9 +228,9 @@ When in stand alone, the following actions are being performed:
 
 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
 2. get an admin token for that service
-3. generate a json object store in a file under .
+3. generate a JSON object store in a file under .
 
-In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error
+In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
 
 When mST and other servers are present, the following actions are being performed:
 
@@ -238,7 +240,7 @@ When mST and other servers are present, the following actions are being performe
 4. register an admin client for that service in mST
 5. get an admin token for that service
 6. get an admin token for mID if needed
-7. generate a json object store in a file under .
+7. generate a JSON object store in a file under .
 
 The following files are needed to perform these actions:
 
@@ -249,7 +251,7 @@ The following files are needed to perform these actions:
 | `../s3Log.json` | The S3 information
 | `../mSTConfig.json` | The config for mST
 | `../mITConfig.json` | The config for mIT
-| `./local/testStart.json` | The local configuration. If it does not exist start.json and if sart.json does not exist start-example.json will be used to create start.json  
+| `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json  
 **Category**: sync  
 <a name="module_local..setup"></a>
 
@@ -272,13 +274,12 @@ When in stand alone, the following actions are being performed:
 2. get an admin token for that service
 3. generate a shell script to start the server
 
-In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error
+In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
 
 When mST is present, the following actions are being performed:
 
-
 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
-2. get an Admin token for mST
+2. get an admin token for mST
 3. register the service in mST
 4. generate a shell script to start the server
 
@@ -312,9 +313,9 @@ When in stand alone, the following actions are being performed:
 
 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
 2. get an admin token for that service
-3. generate a json object store in a file under .
+3. generate a JSON object store in a file under .
 
-In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error
+In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
 
 When mST and other servers are present, the following actions are being performed:
 
@@ -338,7 +339,7 @@ The following files are needed to perform these actions:
 | `../mITConfig.json` | The config for mIT
 | `../mIDConfig.json` | The config for mID
 | `../customerConfig.json` | The mST customer config
-| `./local/testStart.json` | The local configuration. If it does not exist start.json and if sart.json does not exist start-example.json will be used to create start.json  
+| `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json  
 **Category**: sync  
 <a name="module_local..setup"></a>
 
@@ -361,13 +362,12 @@ When in stand alone, the following actions are being performed:
 2. get an admin token for that service
 3. generate a shell script to start the server
 
-In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error
+In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
 
 When mST and other servers are present, the following actions are being performed:
 
-
 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
-2. get an Admin token for mST
+2. get an admin token for mST
 3. setup the customer in mST
 4. register the service in mST
 5. generate a shell script to start the server

package/configuration/config.js

@@ -1,47 +1,38 @@
+const DEFAULT_MIT_PORT = 8050;
+const DEFAULT_MID_PORT = 8015;
+const DEFAULT_MST_PORT = 8025;
+
 const adminExternalIdBase = 'admin_default_local';
 
-module.exports = {
-  adminExternalIdBase,
-  mSTConfigFile: '../mSTConfig.json',
-  mITConfigFile: '../mITConfig.json',
-  mIDConfigFile: '../mIDConfig.json',
-  sumoFile: '../sumo.json',
-  customerConfigFile: '../customerConfig.json',
+export const config = {
   APIProvider: 'https://api.swaggerhub.com/apis',
-  swaggerExt: 'swagger.json',
-  defaultDirectory: './api',
-  testJsonFile: './server-test.json',
-  shellFile: './server-start.sh',
-  startFile: './local/start.json',
-  testStartFile: './local/testStart.json',
-  exampleStartFile: './local/start-example.json',
-  DEFAULT_MST: {
-    basePath: '/mST/v1',
+  DEFAULT_MID: {
+    basePath: '/mID/v1',
     protocol: 'http:',
     domainName: 'localhost',
-    port: 8025,
+    port: DEFAULT_MID_PORT,
+    implicit: {
+      key: 'a-secret-key',
+      audience: 'https://mimik',
+    },
     admin: {
-      clientId: '12345',
-      clientSecret: 'timeForSecret',
+      externalId: `${adminExternalIdBase}_mID`,
     },
   },
   DEFAULT_MIT: {
     basePath: '/mIT/v1',
     protocol: 'http:',
     domainName: 'localhost',
-    port: 8050,
+    port: DEFAULT_MIT_PORT,
   },
-  DEFAULT_MID: {
-    basePath: '/mID/v1',
+  DEFAULT_MST: {
+    basePath: '/mST/v1',
     protocol: 'http:',
     domainName: 'localhost',
-    port: 8015,
-    implicit: {
-      key: 'a-secret-key',
-      audience: 'https://mimik',
-    },
+    port: DEFAULT_MST_PORT,
     admin: {
-      externalId: `${adminExternalIdBase}_mID`,
+      clientId: '12345',
+      clientSecret: 'timeForSecret',
     },
   },
   DEFAULT_SUMO: {
@@ -50,4 +41,17 @@ module.exports = {
       code: '--- default code ---',
     },
   },
+  adminExternalIdBase,
+  customerConfigFile: '../customerConfig.json',
+  defaultDirectory: './api',
+  exampleStartFile: './local/start-example.json',
+  mIDConfigFile: '../mIDConfig.json',
+  mITConfigFile: '../mITConfig.json',
+  mSTConfigFile: '../mSTConfig.json',
+  shellFile: './server-start.sh',
+  startFile: './local/start.json',
+  sumoFile: '../sumo.json',
+  swaggerExt: 'swagger.json',
+  testJsonFile: './server-test.json',
+  testStartFile: './local/testStart.json',
 };

package/dotFiles/eslint.config.js

@@ -0,0 +1,63 @@
+import importPlugin from 'eslint-plugin-import';
+import js from '@eslint/js';
+import processDoc from '@mimik/eslint-plugin-document-env';
+import stylistic from '@stylistic/eslint-plugin';
+
+const MAX_LENGTH_LINE = 180;
+const MAX_FUNCTION_PARAMETERS = 6;
+const MAX_LINES_IN_FILES = 600;
+const MAX_LINES_IN_FUNCTION = 150;
+const MAX_STATEMENTS_IN_FUNCTION = 45;
+const MIN_KEYS_IN_OBJECT = 10;
+const MAX_COMPLEXITY = 30;
+
+export default [
+  {
+    ignores: ['mochawesome-report/**', 'node_modules/**', 'dist/**'],
+  },
+  importPlugin.flatConfigs.recommended,
+  stylistic.configs.recommended,
+  js.configs.all,
+  {
+    plugins: {
+      processDoc,
+    },
+    languageOptions: {
+      ecmaVersion: 2022,
+      globals: {
+        console: 'readonly',
+        describe: 'readonly',
+        it: 'readonly',
+        require: 'readonly',
+      },
+      sourceType: 'module',
+    },
+    rules: {
+      '@stylistic/brace-style': ['warn', 'stroustrup', { allowSingleLine: true }],
+      '@stylistic/line-comment-position': ['off'],
+      '@stylistic/semi': ['error', 'always'],
+      'capitalized-comments': ['off'],
+      'complexity': ['error', MAX_COMPLEXITY],
+      'curly': ['off'],
+      'id-length': ['error', { exceptions: ['x', 'y', 'z', 'i', 'j', 'k'] }],
+      'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
+      'import/no-unresolved': ['error', { amd: true, caseSensitiveStrict: true, commonjs: true }],
+      'init-declarations': ['off'],
+      'linebreak-style': ['off'],
+      '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'], // arrow isnt confusing
+      'no-inline-comments': ['off'],
+      'no-process-env': ['error'],
+      'no-ternary': ['off'],
+      'no-undefined': ['off'],
+      'one-var': ['error', 'never'],
+      'processDoc/validate-document-env': ['error'],
+      'quotes': ['warn', 'single'],
+      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false }],
+    },
+  },
+];

package/eslint.config.js

@@ -0,0 +1,65 @@
+import importPlugin from 'eslint-plugin-import';
+import js from '@eslint/js';
+import processDoc from '@mimik/eslint-plugin-document-env';
+import stylistic from '@stylistic/eslint-plugin';
+
+const MAX_LENGTH_LINE = 180;
+const MAX_FUNCTION_PARAMETERS = 6;
+const MAX_LINES_IN_FILES = 600;
+const MAX_LINES_IN_FUNCTION = 150;
+const MAX_STATEMENTS_IN_FUNCTION = 80;
+const MIN_KEYS_IN_OBJECT = 10;
+const MAX_COMPLEXITY = 80;
+const MAX_DEPTH = 6;
+
+export default [
+  {
+    ignores: ['mochawesome-report/**', 'node_modules/**', 'dist/**'],
+  },
+  importPlugin.flatConfigs.recommended,
+  stylistic.configs.recommended,
+  js.configs.all,
+  {
+    plugins: {
+      processDoc,
+    },
+    languageOptions: {
+      ecmaVersion: 2022,
+      globals: {
+        console: 'readonly',
+        describe: 'readonly',
+        it: 'readonly',
+        require: 'readonly',
+      },
+      sourceType: 'module',
+    },
+    rules: {
+      '@stylistic/brace-style': ['warn', 'stroustrup', { allowSingleLine: true }],
+      '@stylistic/line-comment-position': ['off'],
+      '@stylistic/semi': ['error', 'always'],
+      'capitalized-comments': ['off'],
+      'complexity': ['error', MAX_COMPLEXITY],
+      'curly': ['off'],
+      'id-length': ['error', { exceptions: ['x', 'y', 'z', 'i', 'j', 'k'] }],
+      'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
+      'import/no-unresolved': ['error', { amd: true, caseSensitiveStrict: true, commonjs: true }],
+      'init-declarations': ['off'],
+      'linebreak-style': ['off'],
+      'max-depth': ['error', MAX_DEPTH],
+      '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'], // arrow isnt confusing
+      'no-inline-comments': ['off'],
+      'no-process-env': ['error'],
+      'no-ternary': ['off'],
+      'no-undefined': ['off'],
+      'one-var': ['error', 'never'],
+      'processDoc/validate-document-env': ['error'],
+      'quotes': ['warn', 'single'],
+      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false }],
+    },
+  },
+];