@mimik/local 7.1.5 → 7.1.7

package/README.md

@@ -73,6 +73,14 @@ The same `domainName`/`port` rules as in `mSTConfig.json` apply.
    "streamNameInfo": "Name of the Kinesis stream for info",
    "streamNameError": "Name of the Kinesis stream for errors",
    "streamNameOther": "Name of the Kinesis stream for all other levels"
+   "maxEvents": "Number of events buffered before sending to Kinesis",
+   "timeout": "Number of minutes before a timeout triggers sending to Kinesis",
+   "maxSize": "Maximum size in bytes before sending to Kinesis",
+   "maxRetries": "Maximum retries to connect to Kinesis",
+   "httpOptions": {
+      "socketTimeout": "Socket timeout for the HTTP handler (in millisecond)",
+      "connectionTimeout": "Connection timeout for the HTTP handler (in millisecond)",
+   }
  }
 ```
 
@@ -83,9 +91,9 @@ The same `domainName`/`port` rules as in `mSTConfig.json` apply.
    "accessKeyId": "Access key ID for S3",
    "secretAccessKey": "Secret access key for S3",
    "bucketname": "Name of the S3 bucket used to store information",
-   "maxEvents": "Number of events buffered before sending to S3 (integer)",
-   "timeout": "Number of seconds before a timeout triggers sending to S3 (integer)",
-   "maxSize": "Maximum size in bytes before sending to S3 (integer)"
+   "maxEvents": "Number of events buffered before sending to S3",
+   "timeout": "Number of minutes before a timeout triggers sending to S3",
+   "maxSize": "Maximum size in bytes before sending to S3"
  }
 ```
 
@@ -111,9 +119,9 @@ The same `domainName`/`port` rules as in `mSTConfig.json` apply.
 A property may be defined for each `serverType` involved. If the `serverType` does not exist, the `default` entry is used.
 
 - for `customerConfig.json`: see `mST` `README.md` file for an example of a customer configuration. This may have to be updated to reflect the new server.
-- In the `local` directory under the server’s root directory: two files, `start.json` and `testStart.json`, may exist. `start.json` is used when `npm start` is executed; `testStart.json` is used when `npm test` is executed.
-If these files don’t exist, `example-start.json` is used to create `start.json` and `testStart.json`. Additionally, `example-testStart.json` is used to create `testStart.json`; values in `example-testStart.json` take precedence over values in `example-start.json`.
-The configuration of these files depends on the server’s configuration parameters.
+- In the `local` directory under the server's root directory: two files, `start.json` and `testStart.json`, may exist. `start.json` is used when `npm start` is executed; `testStart.json` is used when `npm test` is executed.
+If these files don't exist, `example-start.json` is used to create `start.json` and `testStart.json`. Additionally, `example-testStart.json` is used to create `testStart.json`; values in `example-testStart.json` take precedence over values in `example-start.json`.
+The configuration of these files depends on the server's configuration parameters.
 
 Example `start.json` for `mIT`:
 ```javascript

package/dotFiles/eslint.config.js

@@ -1,4 +1,5 @@
 /* eslint-disable import/no-extraneous-dependencies */
+import globals from 'globals';
 import importPlugin from 'eslint-plugin-import';
 import js from '@eslint/js';
 import processDoc from '@mimik/eslint-plugin-document-env';
@@ -10,8 +11,8 @@ 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;
-const ECMA_VERSION = 2022;
+const MAX_COMPLEXITY = 60;
+const ECMA_VERSION = 'latest';
 const MAX_DEPTH = 6;
 const ALLOWED_CONSTANTS = [0, 1, -1];
 
@@ -29,6 +30,7 @@ export default [
     languageOptions: {
       ecmaVersion: ECMA_VERSION,
       globals: {
+        ...globals.nodeBuiltin,
         console: 'readonly',
         describe: 'readonly',
         it: 'readonly',

package/eslint.config.js

@@ -1,3 +1,4 @@
+import globals from 'globals';
 import importPlugin from 'eslint-plugin-import';
 import js from '@eslint/js';
 import processDoc from '@mimik/eslint-plugin-document-env';
@@ -10,7 +11,7 @@ const MAX_LINES_IN_FUNCTION = 150;
 const MAX_STATEMENTS_IN_FUNCTION = 80;
 const MIN_KEYS_IN_OBJECT = 10;
 const MAX_COMPLEXITY = 80;
-const ECMA_VERSION = 2022;
+const ECMA_VERSION = 'latest';
 const MAX_DEPTH = 6;
 const ALLOWED_CONSTANTS = [0, 1, -1];
 
@@ -28,6 +29,7 @@ export default [
     languageOptions: {
       ecmaVersion: ECMA_VERSION,
       globals: {
+        ...globals.nodeBuiltin,
         console: 'readonly',
         describe: 'readonly',
         it: 'readonly',

package/index.js

@@ -128,6 +128,14 @@ const getBasePath = apiDef => apiDef.basePath || apiDef.servers[FIRST].url;
  *    "streamNameInfo": "Name of the Kinesis stream for info",
  *    "streamNameError": "Name of the Kinesis stream for errors",
  *    "streamNameOther": "Name of the Kinesis stream for all other levels"
+ *    "maxEvents": "Number of events buffered before sending to Kinesis",
+ *    "timeout": "Number of minutes before a timeout triggers sending to Kinesis",
+ *    "maxSize": "Maximum size in bytes before sending to Kinesis",
+ *    "maxRetries": "Maximum retries to connect to Kinesis",
+ *    "httpOptions": {
+ *       "socketTimeout": "Socket timeout for the HTTP handler (in millisecond)",
+ *       "connectionTimeout": "Connection timeout for the HTTP handler (in millisecond)",
+ *    }
  *  }
  * ```
  *
@@ -138,9 +146,9 @@ const getBasePath = apiDef => apiDef.basePath || apiDef.servers[FIRST].url;
  *    "accessKeyId": "Access key ID for S3",
  *    "secretAccessKey": "Secret access key for S3",
  *    "bucketname": "Name of the S3 bucket used to store information",
- *    "maxEvents": "Number of events buffered before sending to S3 (integer)",
- *    "timeout": "Number of seconds before a timeout triggers sending to S3 (integer)",
- *    "maxSize": "Maximum size in bytes before sending to S3 (integer)"
+ *    "maxEvents": "Number of events buffered before sending to S3",
+ *    "timeout": "Number of minutes before a timeout triggers sending to S3",
+ *    "maxSize": "Maximum size in bytes before sending to S3"
  *  }
  * ```
  *
@@ -166,9 +174,9 @@ const getBasePath = apiDef => apiDef.basePath || apiDef.servers[FIRST].url;
  * A property may be defined for each `serverType` involved. If the `serverType` does not exist, the `default` entry is used.
  *
  * - for `customerConfig.json`: see `mST` `README.md` file for an example of a customer configuration. This may have to be updated to reflect the new server.
- * - In the `local` directory under the server’s root directory: two files, `start.json` and `testStart.json`, may exist. `start.json` is used when `npm start` is executed; `testStart.json` is used when `npm test` is executed.
- * If these files don’t exist, `example-start.json` is used to create `start.json` and `testStart.json`. Additionally, `example-testStart.json` is used to create `testStart.json`; values in `example-testStart.json` take precedence over values in `example-start.json`.
- * The configuration of these files depends on the server’s configuration parameters.
+ * - In the `local` directory under the server's root directory: two files, `start.json` and `testStart.json`, may exist. `start.json` is used when `npm start` is executed; `testStart.json` is used when `npm test` is executed.
+ * If these files don't exist, `example-start.json` is used to create `start.json` and `testStart.json`. Additionally, `example-testStart.json` is used to create `testStart.json`; values in `example-testStart.json` take precedence over values in `example-start.json`.
+ * The configuration of these files depends on the server's configuration parameters.
  *
  * Example `start.json` for `mIT`:
  * ```javascript

package/lib/common.js

@@ -4,6 +4,12 @@ import process from 'node:process';
 const S3_MAX_EVENTS = 10;
 const S3_TIMEOUT = 1;
 const S3_MAX_SIZE = 5;
+const KINESIS_MAX_EVENTS = 10;
+const KINESIS_TIMEOUT = 1;
+const KINESIS_MAX_SIZE = 5;
+const KINESIS_MAX_RETRIES = 2;
+const KINESIS_SOCKET_TIMEOUT = 5000;
+const KINESIS_CONNECTION_TIMEOUT = 5000;
 
 const DEFAULT_MST_PORT = 8025;
 const DEFAULT_MIT_PORT = 8050;
@@ -54,21 +60,31 @@ const DEFAULT = {
   },
 
   KINESISLOG: {
-    region: '--- default region ---',
     accessKeyId: '--- default accessKey Id',
+    region: '--- default region ---',
     secretAccessKey: '--- default secret accessKey ---',
-    streamNameInfo: '--- default streamName Info ---',
     streamNameError: '--- default streamName Error ---',
+    streamNameInfo: '--- default streamName Info ---',
     streamNameOther: '--- default streamName Other ---',
+
+    httpOptions: {
+      socketTimeout: KINESIS_SOCKET_TIMEOUT,
+      connectionTimeout: KINESIS_CONNECTION_TIMEOUT,
+    },
+    maxEvents: KINESIS_MAX_EVENTS,
+    maxRetries: KINESIS_MAX_RETRIES,
+    maxSize: KINESIS_MAX_SIZE,
+    timeout: KINESIS_TIMEOUT,
   },
   S3LOG: {
-    region: '--- default region ---',
+    bucketname: '--- default bucketname ---',
     accessKeyId: '--- default accessKey Id',
+    region: '--- default region ---',
     secretAccessKey: '--- default secret accessKey ---',
-    bucketname: '--- default bucketname ---',
+
     maxEvents: S3_MAX_EVENTS,
-    timeout: S3_TIMEOUT,
     maxSize: S3_MAX_SIZE,
+    timeout: S3_TIMEOUT,
   },
   SUMOLOG: {
     default: {

package/lib/helpers.js

@@ -123,12 +123,12 @@ const baseUrl = (serverType, regType, config, literal) => {
  *
  * @function retrieve
  * @category sync
- * @params {string} regType - Type of registration to be excuted.
+ * @params {string} regType - Type of registration to be executed.
  * @params {PATH<string>} filename - Filename to retrieve. If the filename does not retrieve any file altFilename will be used.
  * @params options {object} - Options to be added for the retrieval
  * @return {object} The JSON object contained in the file.
  *
- * The options parameters has the folowing structure:
+ * The options parameters has the following structure:
  *``` javascript
  * {
  *    sourceFilename: {PATH<string>}, // Source filename to use if altFilename does not retrieve any file.

package/lib/tasks.js

@@ -149,8 +149,8 @@ const startSetup = (config, origStart) => {
     let sumoLog = config.sumoLog[type];
 
     if (!sumoLog) {
-      if (!config.sumoLog.default) exitError(regType, Error(`missing sumologic default config in ${DEFAULT.FILE.sumoLogFile}`));
-      console.log('- using ' + 'default value'.warn + ' for sumologic');
+      if (!config.sumoLog.default) exitError(regType, Error(`missing Sumologic default config in ${DEFAULT.FILE.sumoLogFile}`));
+      console.log('- using ' + 'default value'.warn + ' for Sumologic');
       sumoLog = config.sumoLog.default;
     }
     start.SUMO_LOGIC_ENDPOINT ||= sumoLog.url;
@@ -245,7 +245,7 @@ const startSetup = (config, origStart) => {
  * @function getAPI
  * @category async
  * @param {PATH<string>} directory - Directory to store the API file.
- * @param {object} swaggerFile - Information from package.swaggeFile.
+ * @param {object} swaggerFile - Information from package.swaggerFile.
  * @param {string} key - `bitbucket` with username password to access the bitbucket account or string to access `swaggerhub`.
  * .
  * @return {Promise}.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/local",
-  "version": "7.1.5",
+  "version": "7.1.7",
   "description": "Local setup configuration for normal and test operation",
   "main": "./index.js",
   "type": "module",
@@ -32,23 +32,24 @@
     "url": "https://bitbucket.org/mimiktech/local"
   },
   "dependencies": {
-    "@eslint/js": "9.37.0",
+    "@eslint/js": "9.39.1",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
     "@mimik/git-hooks": "^2.0.0",
     "@mimik/request-helper": "^2.0.2",
-    "@stylistic/eslint-plugin": "5.4.0",
-    "axios": "1.12.2",
+    "@stylistic/eslint-plugin": "5.6.1",
+    "axios": "1.13.2",
     "bluebird": "3.7.2",
     "c8": "10.1.3",
-    "chai": "6.2.0",
+    "chai": "6.2.1",
     "colors": "1.4.0",
     "comment-json": "4.4.1",
-    "eslint": "9.37.0",
+    "eslint": "9.39.1",
     "eslint-plugin-import": "2.32.0",
+    "globals": "16.5.0",
     "husky": "9.1.7",
     "ip": "2.0.1",
     "js-base64": "3.7.8",
-    "js-yaml": "4.1.0",
+    "js-yaml": "4.1.1",
     "jsdoc-to-markdown": "9.1.3",
     "lodash.difference": "4.5.0",
     "lodash.find": "4.6.0",
@@ -58,12 +59,12 @@
     "lodash.isobject": "3.0.2",
     "lodash.split": "4.4.2",
     "lodash.union": "4.6.0",
-    "mocha": "11.7.4",
+    "mocha": "11.7.5",
     "mochawesome": "7.1.4",
     "rewire": "9.0.1",
     "sinon": "21.0.0",
     "supertest": "7.1.4",
-    "swagger-client": "3.35.7",
+    "swagger-client": "3.36.0",
     "uuid": "11.1.0"
   }
 }