@mimik/configuration 6.0.5 → 6.0.7

package/.claude/settings.local.json

@@ -0,0 +1,14 @@
+{
+  "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)"
+    ]
+  }
+}

package/.husky/pre-commit

@@ -1,4 +1,2 @@
 #!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npm run commit-ready

package/.husky/pre-push

@@ -1,4 +1,2 @@
 #!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npm run test

package/README.md

@@ -24,7 +24,7 @@ The following environment variables are used
 
 | Env variable name | Description | Value | Comments |
 | ----------------- | ----------- | ----- | -------- |
-| NODE_ENV | environnment of the microservice |  
+| NODE_ENV | environment of the microservice |  
 **Category**: sync  
 <a name="module_configuration..setConfig"></a>
 
@@ -36,7 +36,7 @@ Set the configuration of the micro-service.
 **Category**: sync  
 **Throws**:
 
-- <code>configuration.serverSettings.type</code> Will trow an error if a mandatory value is missing.
+- <code>configuration.serverSettings.type</code> Will throw an error if a mandatory value is missing.
 
 The following environment variables are being setup:
 
@@ -55,7 +55,7 @@ The following environment variables are being setup:
 | AWS_LOCAL_PROPERTIES | internal ip address to access aws instance properties | 169.254.169.254
 | MST_SET | to setup configuration without mST and oauth token setup | on | on/off
 
-The following environement variables are being used for the configuration:
+The following environment variables are being used for the configuration:
 
 | Env variable name | Description | Default | Config property | Comments |
 | ----------------- | ----------- | ------- | ----------------| -------- |
@@ -63,18 +63,18 @@ The following environement variables are being used for the configuration:
 | LOCATION_PROVIDER | location provider URL to use for ip location or `noPublic` or `environment` | noPublic | locationProvider.url or locationProvider | `see public-helper`
 | LOCATION_PROVIDER_KEY | location provider key to use to access the location provider | null | locationProvider.key | see `public-helper`
 | CLOUD_PROVIDER | cloud provider running the service | noCloud | cloudProvider | see `public-helper`
-| SERVER_ID | service id | uuid.v4() | serverSettings.id |
+| SERVER_ID | service id | crypto.randomUUID() | serverSettings.id |
 | CUSTOMER_CODE | customer code associated with the service instance | '' | serverSettings.customerCode | empty string
-| SWAGGER_FILE_DIRECTORY | directory where the api definition is located | ./api | serverSettings.api | [1]
+| SWAGGER_FILE_DIRECTORY | directory where the api definition is located | ../api | serverSettings.api | [1]
 | BITBUCKET_USERNAME | username to access bitbucket read access on the swagger repos | ' ' | serverSettings.apiBasicAuth.username
 | BITBUCKET_PASSWORD | password to access bitbucket read access on the swagger repos | ' ' | serverSettings.apiBasicAuth.password
 | SWAGGERHUB_API_KEY | apiKey to access swaggerhub | | serverSettings.apiApiKey
 | SERVER_SECURITY_SET | switch to enable or disable the token interpretation | on | serverSettings.securitySet | only active if environment is `local`
 | INTERCEPT_ERROR | switch to use or not the errorIntercept option | on | serverSettings.interceptError | must be set to off for mID
 | SERVER_PORT | port of the server |  | serverSettings.port |
-| SERVER_PUBLIC_PROTOCOL | protocol used to defined the domain address of the sevice | http: | serverSettings.public.protocol |
+| SERVER_PUBLIC_PROTOCOL | protocol used to define the domain address of the service | http: | serverSettings.public.protocol |
 | SERVER_PUBLIC_DOMAIN_NAME | domain name used to define the domain address of the service | null | serverSettings.public.domainName |
-| ADMIN_EXTERNAL_ID | external id of the admin role to be chacked in the token | admin | security.admin.externalId |
+| ADMIN_EXTERNAL_ID | external id of the admin role to be checked in the token | admin | security.admin.externalId |
 | OAUTH_CLIENT_ID | security id of the service |  | security.server.id | [2]
 | OAUTH_CLIENT_SECRET | secret of the service |  | security.server.secret | [2]
 | OAUTH_CLIENT_ACCESS_KEY | key for token signature |  | security.server.accessKey | [2]
@@ -84,8 +84,8 @@ The following environement 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 a test against in case of APIKey security | [] |
-| LOG_MODE | collector the be used to log events | sumologic | logInfo.mode | can be `sumologic`, `awsS3`, `all`, 'awsKinesis'
-| NO_STACK | disable the inclusion of a the stack in all logs | yes | logInfo.noStack
+| LOG_MODE | collector to be used to log events | sumologic | logInfo.mode | can be `sumologic`, `awsS3`, `all`, 'awsKinesis'
+| 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 |
 | EXIT_DELAY | delay to allow the log transports to flush | 2000 | logInfo.exitDelay | in milliseconds
@@ -98,9 +98,9 @@ The following environement variables are being used for the configuration:
 | ENCRYPTION_SET | switch to enable use of mongodb encryption | off | encryption.set | can be `on`, or `off`
 | MIT_URL | url for reaching mIT |  | dependencies.mIT.url |
 | MIT_AUDIENCE | audience of mIT |  | dependencies.mIT.audience | [2]
-| REGISTRATION_SET | swicht to enable user of registration | on | registration.set | can be `on` or `off`
+| 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 | registratiom.afterPostOpsSet | can be `on` or `off`
+| REGISTRATION_AFTER_POSTOPS_SET | switch to set the registration of execution 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
 
@@ -108,13 +108,13 @@ The following environement variables are being used for the configuration:
 
 [2]: defined when registering to mST
 
-When MST_SET is `off`, registration and cluster should not be enabled, so configuration.cluster.management and configuration.registration.set will be set to `off``
+When MST_SET is `off`, registration and cluster should not be enabled, so configuration.cluster.management and configuration.registration.set will be set to `off`
 
 When `sumologic` or `all` is used for `LOG_MODE` the following environment variables are used for the configuration:
 
 | Env variable name | Description | Default | Comments |
 | ----------------- | ----------- | ------- | -------- |
-| SUMO_LOGIC_ENDPOINT | endpoint of the sumologic collector to used for logs |
+| SUMO_LOGIC_ENDPOINT | endpoint of the sumologic collector used for logs |
 | SUMO_LOGIC_COLLECTOR_CODE | id of the collector in sumologic |
 
 When `awsS3` or `all` is used for `LOG_MODE` the following environment variables are used for the configuration:
@@ -138,7 +138,9 @@ When `on` is used for `TOPIC_SET` the following environment variables are used f
 | SNS_AWS_REGION | region where the topic is | ----noRegion---- |
 
 When a database is involved
+
 | Env variable name | Description | Default | Comments |
+| ----------------- | ----------- | ------- | -------- |
 | DATABASE_CONNECTION_TIMEOUT | the time to connect to the database before error is generated | 30 | in seconds
 | DATABASE_VALIDATION_CHECK | the delay before checking for connection | 1000 | in ms
 | DATABASE_RECONNECTION_OFFSET | offset for the time to reconnect to the database before error is generated | 5 | in seconds
@@ -153,16 +155,16 @@ When `mongodb` is used the following environment variables are used for the conf
 | DATABASE_PASSWORD | password to access the database | null | if missing no user/password will be used
 | MONGO_USE_SRV | to use srv connection url set to `yes` | `no` |
 | MONGO_AUTH_DATABASE | the auth database where users exists | |
-| MONGO_MAX_POOL_SIZE | the minimum number of connections in the connection pool | 5 |
-| MONGO_MIN_POOL_SIZE | the maximum number of connections in the connection pool | 10 |
-| MONGO_MAX_IDLE_TIME | the maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed | 3000 | in milliseconds
+| MONGO_MIN_POOL_SIZE | the minimum number of connections in the connection pool | 0 |
+| MONGO_MAX_POOL_SIZE | the maximum number of connections in the connection pool | 10 |
+| MONGO_MAX_IDLE_TIME | the maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed | 30000 | in milliseconds
 | MONGO_RETRY_WRITES | defines if the transaction should be tried again to write set to true or false | |
 | MONGO_WRITE_CONCERN | accepts a number or `majority` | |
 | MONGO_SSL | uses ssl connection if `yes` | `no` |
 | MONGO_SSL_VALIDATE | validates mongod server certificate against ca if set to `yes` | `yes` | `yes` if MONGO_SSL is also `yes`
 | MONGO_SSL_ALLOW_INVALID_HOSTNAMES | set to yes to allows invalid hostnames | |
 | MONGO_REPLICAT_SET | specifies the name of the replica set, if the mongod is a member of a replica set |  | not mandatory
-| MONGO_WAIT_QUEUE_MULTIPLE | a number that the driver multiples the maxPoolSize value to, to provide the maximum number of threads allowed to wait for a connection to become available from the pool |  | no mandatory
+| MONGO_WAIT_QUEUE_MULTIPLE | a number that the driver multiplies the maxPoolSize value to, to provide the maximum number of threads allowed to wait for a connection to become available from the pool |  | not mandatory
 | MONGO_WAIT_QUEUE_TIMEOUT | the maximum time in milliseconds that a thread can wait for a connection to become available |  | not mandatory
 | MONGO_SOCKET_TIMEOUT | The time in milliseconds to attempt a send or receive on a socket before the attempt times out | 20000 | in milliseconds
 | MONGO_FAMILY | IP address family | 4 | 4 -> IPV4, 6 -> IPV6
@@ -182,7 +184,7 @@ When `on` is used for `ENCRYPTION_SET` the following environment variables are u
 | ENCRYPTION_SECRET_ACCESS_KEY | if KMS is aws, secretAccessKey to connect KMS | |
 | LOCAL_MASTER_KEY |  if KMS is local, masterkey to encrypt data keys | |
 
-When `dynamodb` is used the following environement variables are used for the configuration:
+When `dynamodb` is used the following environment variables are used for the configuration:
 
 | Env variable name | Description | Default | Comments |
 | ----------------- | ----------- | ------- | -------- |
@@ -196,13 +198,13 @@ When `dynamodb` is used the following environement variables are used for the co
 | DYNAMO_SCHEMA_THROUGHPUT_WRITE | throughput write for dynamodb schema | 1 |
 | DYNAMO_SCHEMA_THROUGHPUT | throughput for dynamodb schema |
 
-`DYNAMO_SCHEMA_THROUGHPUT` takes precedence over `DYNAMO_SCHEMA_THROUGHPUT_READ` and `DYNAMO_SCHEMA_THROUGHPUT_WRITE`. If DYNAMO_SCHEMA_THROUGHPUT is set to `ON_DEMAND` then index throughput wont apply, and if DYNAMO_SCHEMA_THROUGHPUT is not set to a number the value will be 1.
+`DYNAMO_SCHEMA_THROUGHPUT` takes precedence over `DYNAMO_SCHEMA_THROUGHPUT_READ` and `DYNAMO_SCHEMA_THROUGHPUT_WRITE`. If DYNAMO_SCHEMA_THROUGHPUT is set to `ON_DEMAND` then index throughput won't apply, and if DYNAMO_SCHEMA_THROUGHPUT is not set to a number the value will be 1.
 
-When `redis` is used the following environement variables are used for the configuration:
+When `redis` is used the following environment variables are used for the configuration:
 
 | Env variable name | Description | Default | Comments |
 | ----------------- | ----------- | ------- | -------- |
-| CACHE_IP | domain of the redis server to use with port, a comma seperated list if using cluster | localhost:6379 |
+| CACHE_IP | domain of the redis server to use with port, a comma separated list if using cluster | localhost:6379 |
 | CACHE_USER | redis user if the redis service is auth protected | null |
 | CACHE_PASSWORD | redis password for the user if the redis service is auth protected | null |
 | CACHE_CLUSTER_SET | set on, when using redis in a cluster. | off |
@@ -214,9 +216,9 @@ When `redis` is used the following environement variables are used for the confi
 | CACHE_REQUEST_TTL | request time to live in cache | 10 | in seconds
 | CACHE_API_ID_TTL | API request time to live for main resource | 20 | in seconds
 | CACHE_API_OPTION_TTL | API request time to live for option | 5 | in seconds
-| REDIS_RECONNECT_TRIES | number of tries to restablish a connection | 100 |
+| REDIS_RECONNECT_TRIES | number of tries to reestablish a connection | 100 |
 | REDIS_RECONNECT_INTERVAL | time to wait before retry | 500 | in milliseconds
-| REDIS_REQUEST_MAX_MEMORY | maximum memory size of the request cache | 10 | in megabytes
+| REDIS_REQUEST_MAX_MEMORY | maximum memory size of the request cache | 10mb | in megabytes
 | REDIS_REQUEST_MAX_MEMORY_POLICY | eviction policy of the request cache | allkeys-lru |
 | REDIS_SOCKET_KEEPALIVE | keep long running connections alive for x seconds | 5000 | in seconds
 | REDIS_DISABLE_OFFLINE_QUEUE | queuing event when not connected | no |
@@ -225,6 +227,6 @@ When `redis` is used the following environement variables are used for the confi
 
 | Param | Type | Description |
 | --- | --- | --- |
-| pack | <code>string</code> | `Package.json` object to use for the configuration. |
+| pack | <code>object</code> | `Package.json` object to use for the configuration. |
 | options | <code>object</code> | Options to add to the config. |
 

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,6 +11,9 @@ 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 [
   {
@@ -23,18 +27,18 @@ export default [
       processDoc,
     },
     languageOptions: {
-      ecmaVersion: 2022,
+      ecmaVersion: ECMA_VERSION,
       globals: {
-        console: 'readonly',
-        describe: 'readonly',
-        it: 'readonly',
-        require: 'readonly',
+        ...globals.mocha,
+        ...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],
@@ -44,20 +48,36 @@ export default [
       '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-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'], // arrow isnt confusing
+      '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': ['warn', 'single'],
-      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false }],
+      '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'],
+      'processDoc/validate-document-env': ['off'],
     },
   },
 ];