@mimik/configuration 6.0.8 → 6.0.10

package/README.md

@@ -84,7 +84,7 @@ The following environment variables are being used for the configuration:
 | OAUTH_GENERIC_PREVIOUS_KEY | key for the token signature before change the public key | | security.generic.previousKey | [2]
 | OAUTH_GENERIC_AUDIENCE | url representing the generic of the service type to mST | noGeneric | security.generic.audience | [2]
 | API_KEYS | list of API Keys which are tested against in case of APIKey security | [] |
-| LOG_MODE | collector to be used to log events | sumologic | logInfo.mode | can be `sumologic`, `awsS3`, `all`, 'awsKinesis'
+| LOG_MODE | collector to be used to log events | sumologic | logInfo.mode | can be `sumologic`, `awsS3`, `all`, `awsKinesis`, `none`
 | NO_STACK | disable the inclusion of the stack in all logs | yes | logInfo.noStack
 | FILTER_FILE | path for the filter file definition | null | logInfo.filterFile |
 | USER_DEFINITIONS_FILE | path for the custom user definitions | null | userDefinitions.file |
@@ -100,7 +100,7 @@ The following environment variables are being used for the configuration:
 | MIT_AUDIENCE | audience of mIT |  | dependencies.mIT.audience | [2]
 | REGISTRATION_SET | switch to enable use of registration | on | registration.set | can be `on` or `off`
 | REGISTRATION_RETRY | retry time for registering to mIT | 3000 | registration.retry | in milliseconds
-| REGISTRATION_AFTER_POSTOPS_SET | switch to set the registration of execution the postOps | off | registration.afterPostOpsSet | can be `on` or `off`
+| REGISTRATION_AFTER_POSTOPS_SET | switch to set the registration after the execution of the postOps | off | registration.afterPostOpsSet | can be `on` or `off`
 | `$_URL`.toUpperCase() | cluster information | self | dependencies.`(SERVER_TYPE)`.url | should not be used
 | `${configuration.serverSettings.type}_AUDIENCE`.toUpperCase() | cluster information |  | dependencies.`(SERVER_TYPE)`.audience | [2], but should not be used
 

package/index.js

@@ -496,7 +496,7 @@ configuration.locationProvider = setupLocationProvider();
  * | OAUTH_GENERIC_PREVIOUS_KEY | key for the token signature before change the public key | | security.generic.previousKey | [2]
  * | OAUTH_GENERIC_AUDIENCE | url representing the generic of the service type to mST | noGeneric | security.generic.audience | [2]
  * | API_KEYS | list of API Keys which are tested against in case of APIKey security | [] |
- * | LOG_MODE | collector to be used to log events | sumologic | logInfo.mode | can be `sumologic`, `awsS3`, `all`, 'awsKinesis'
+ * | LOG_MODE | collector to be used to log events | sumologic | logInfo.mode | can be `sumologic`, `awsS3`, `all`, `awsKinesis`, `none`
  * | NO_STACK | disable the inclusion of the stack in all logs | yes | logInfo.noStack
  * | FILTER_FILE | path for the filter file definition | null | logInfo.filterFile |
  * | USER_DEFINITIONS_FILE | path for the custom user definitions | null | userDefinitions.file |
@@ -512,7 +512,7 @@ configuration.locationProvider = setupLocationProvider();
  * | MIT_AUDIENCE | audience of mIT |  | dependencies.mIT.audience | [2]
  * | REGISTRATION_SET | switch to enable use of registration | on | registration.set | can be `on` or `off`
  * | REGISTRATION_RETRY | retry time for registering to mIT | 3000 | registration.retry | in milliseconds
- * | REGISTRATION_AFTER_POSTOPS_SET | switch to set the registration of execution the postOps | off | registration.afterPostOpsSet | can be `on` or `off`
+ * | REGISTRATION_AFTER_POSTOPS_SET | switch to set the registration after the execution of the postOps | off | registration.afterPostOpsSet | can be `on` or `off`
  * | `${configuration.serverSettings.type}_URL`.toUpperCase() | cluster information | self | dependencies.`(SERVER_TYPE)`.url | should not be used
  * | `${configuration.serverSettings.type}_AUDIENCE`.toUpperCase() | cluster information |  | dependencies.`(SERVER_TYPE)`.audience | [2], but should not be used
  *
@@ -647,7 +647,8 @@ export const setConfig = (pack, options) => {
     else process.env.SWAGGER_FILE_PROVIDER = 'bitbucket';
   }
 
-  const apiFilename = `${process.env.SWAGGER_FILE_ACCOUNT}${SWAGGER_SEP}${process.env.SWAGGER_FILE_NAME}${SWAGGER_SEP}${process.env.SWAGGER_FILE_VERSION}${SWAGGER_SEP}${SWAGGER_EXT}`;
+  const apiFilename = `${process.env.SWAGGER_FILE_ACCOUNT}${SWAGGER_SEP}`
+    + `${process.env.SWAGGER_FILE_NAME}${SWAGGER_SEP}${process.env.SWAGGER_FILE_VERSION}${SWAGGER_SEP}${SWAGGER_EXT}`;
 
   configuration.serverSettings.name = process.env.SERVER_NAME;
   configuration.serverSettings.type = process.env.SERVER_TYPE;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/configuration",
-  "version": "6.0.8",
+  "version": "6.0.10",
   "description": "Common configuration for mimik services",
   "main": "./index.js",
   "exports": "./index.js",
@@ -21,32 +21,33 @@
   "author": "mimik technology inc <support@mimik.com> (https://developer.mimik.com/)",
   "license": "MIT",
   "engines": {
-    "node": ">=24"
+    "node": ">=24.0.0"
   },
   "repository": {
     "type": "git",
     "url": "https://bitbucket.org/mimiktech/configuration"
   },
   "dependencies": {
-    "@mimik/request-helper": "^2.0.5",
-    "@mimik/sumologic-winston-logger": "^2.1.13",
+    "@mimik/request-helper": "^2.0.6",
+    "@mimik/sumologic-winston-logger": "^2.2.2",
     "@mimik/user-filters": "^2.0.4",
     "ip": "2.0.1"
   },
   "devDependencies": {
-    "@eslint/js": "9.39.3",
-    "@mimik/eslint-plugin-document-env": "^2.0.8",
-    "@stylistic/eslint-plugin": "5.9.0",
+    "@eslint/js": "9.39.4",
+    "@mimik/eslint-plugin-document-env": "^2.0.9",
+    "@mimik/eslint-plugin-logger": "^1.0.3",
+    "@stylistic/eslint-plugin": "5.10.0",
     "c8": "11.0.0",
     "chai": "6.2.2",
-    "eslint": "9.39.3",
+    "eslint": "9.39.4",
     "eslint-plugin-import": "2.32.0",
     "esmock": "2.7.3",
-    "globals": "17.3.0",
+    "globals": "17.4.0",
     "husky": "9.1.7",
     "mocha": "11.7.5",
     "mochawesome": "7.1.4",
     "jsdoc-to-markdown": "9.1.3",
-    "sinon": "21.0.1"
+    "sinon": "21.0.3"
   }
 }

package/.claude/settings.local.json

@@ -1,15 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(npm run lint)",
-      "Bash(cat /Users/niburger/Projects/mimik/common/response-helper-145/test/*.js)",
-      "Bash(ls -d /Users/niburger/Projects/mimik/common/*/test/)",
-      "Bash(grep -rl \"esmock\" /Users/niburger/Projects/mimik/common/*/package.json)",
-      "Bash(npm install)",
-      "Bash(npm test)",
-      "Bash(npx eslint test/)",
-      "Bash(npx eslint test/ --fix)",
-      "Bash(git status -u)"
-    ]
-  }
-}

package/.husky/pre-commit

@@ -1,2 +0,0 @@
-#!/bin/sh
-npm run commit-ready

package/.husky/pre-push

@@ -1,2 +0,0 @@
-#!/bin/sh
-npm run test

package/eslint.config.js

@@ -1,87 +0,0 @@
-import globals from 'globals';
-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;
-const ECMA_VERSION = 'latest';
-const MAX_DEPTH = 6;
-const ALLOWED_CONSTANTS = [0, 1, -1];
-
-export default [
-  {
-    ignores: ['mochawesome-report/**', 'node_modules/**', 'dist/**'],
-  },
-  importPlugin.flatConfigs.recommended,
-  stylistic.configs.recommended,
-  js.configs.all,
-  {
-    plugins: {
-      processDoc,
-    },
-    languageOptions: {
-      ecmaVersion: ECMA_VERSION,
-      globals: {
-        ...globals.nodeBuiltin,
-      },
-      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],
-      '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': ['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-params': ['error', MAX_FUNCTION_PARAMETERS],
-      'max-statements': ['warn', MAX_STATEMENTS_IN_FUNCTION],
-      'no-confusing-arrow': ['off'],
-      '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'],
-    languageOptions: {
-      globals: {
-        ...globals.mocha,
-      },
-    },
-    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'],
-      'processDoc/validate-document-env': ['off'],
-    },
-  },
-];

package/manual-test/test-config.js

@@ -1,48 +0,0 @@
-/* eslint-disable no-console */
-import './testEnv.js';
-import { setConfig } from '../index.js';
-// import Config from '../index.js';
-
-const pack = {
-  swaggerFile: {
-    version: '2.0.6',
-    account: 'mimiktech',
-    name: 'swagger-mds',
-  },
-  mimik: {
-    type: 'test-pack-type',
-  },
-};
-const config = {
-  database: {
-    type: 'mongodb',
-    table: {
-      itResource: 'itResource',
-      lease: 'lease',
-    },
-  },
-  dependencies: {
-    'mIT': {
-      audience: 'test-audience',
-      url: 'test-url',
-    },
-    'test-pack-type': {
-      audience: 'test-pack-type-audience',
-    },
-  },
-  security: {
-    server: {
-      id: 'test-security-id',
-      secret: 'test-security-secret',
-      accessKey: 'test-security-access-key',
-      audience: 'test-security-audience',
-      issuer: 'test-security-issuer',
-    },
-  },
-  serverSettings: {
-    type: 'test-type',
-  },
-};
-
-const configuration = setConfig(pack, config);
-console.log(configuration);

package/manual-test/testEnv.js

@@ -1,21 +0,0 @@
-/* eslint no-process-env: "off" */
-import process from 'process';
-
-/**
- *
- * Test configuration Configuration.
- *
- * @description The following environment variables are needed to configure configuration:
- *
- * | Env variable name | Description | Default | Comments |
- * | ----------------- | ----------- | ------- | -------- |
- * | DATABASE_NAME | name of the database to use for mongodb
- * | MONGO_REPLICAT_SET | set to a value for Boolean()
- * | SUMO_LOGIC_ENDPOINT | dummy endpoint for sumologic
- * | SUMO_LOGIC_COLLECTOR_CODE | dummy collector code for sumologic
- */
-
-process.env.DATABASE_NAME = 'test-database-name';
-process.env.MONGO_REPLICAT_SET = 'test-mongo-replicat-set';
-process.env.SUMO_LOGIC_ENDPOINT = 'test-logInfo-sumologic-endpoint';
-process.env.SUMO_LOGIC_COLLECTOR_CODE = 'test-logInfo-sumologic-code';