@contrast/config 1.9.0 → 1.11.0

package/lib/index.d.ts

@@ -14,7 +14,14 @@
  */
 
 import { ProtectRuleMode, Rule } from '@contrast/common';
-import { Level } from 'pino';
+import { LevelWithSilent } from 'pino';
+
+export type Level =
+  | 'error'
+  | 'warn'
+  | 'info'
+  | 'debug'
+  | 'trace';
 
 export type SyslogLevel =
   | 'alert'
@@ -30,7 +37,7 @@ export interface Config {
 
   _default: Record<string, any>;
   _flat: Record<string, any>;
-  _sources: Record<string, 'DEFAULT' | 'ENV' | 'YAML' | 'ContrastUI'>;
+  _sources: Record<string, 'DEFAULT_VALUE' | 'ENVIRONMENT_VARIABLE' | 'USER_CONFIGURATION_FILE' | 'CONTRAST_UI'>;
   api: {
     enable: boolean;
     api_key: string;
@@ -50,6 +57,7 @@ export interface Config {
     polling: {
       app_activity_ms: number;
       app_settings_ms: number;
+      app_update_ms: number;
       server_settings_ms: number;
     };
 
@@ -69,7 +77,7 @@ export interface Config {
        * Minimum log level. 'silent' disables logging entirely.
        * Default: `'error'`
        */
-      level: Level | 'silent';
+      level: LevelWithSilent;
 
       /** Default: `'node-contrast'` */
       path: string;
@@ -79,8 +87,8 @@ export interface Config {
     };
 
     security_logger: {
-      /** Default: `'debug'` */
-      level: SyslogLevel;
+      /** Default: `'error'` */
+      level: Level;
 
       /** Default: `'security'` */
       path: string;
@@ -167,6 +175,10 @@ export interface Config {
     session_metadtata: string | null;
   };
 
+  assess: {
+    tags: string;
+  };
+
   protect: {
     enable: boolean;
 

package/lib/options.js

@@ -231,13 +231,11 @@ const agent = [
   },
   {
     name: 'agent.security_logger.level',
-    default: 'debug',
+    default: 'error',
     arg: '<level>',
     fn: lowercase,
-    // NOTE: syslog actually specifies 8 levels, starting with 0-emergency, but
-    // we do not let the user set emergency for whatever reason
-    enum: ['alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug'],
-    desc: 'security logging level (alert, crit, err, warning, notice, info, debug)',
+    enum: ['error', 'warn', 'info', 'debug', 'trace'],
+    desc: 'security logging level (error, warn, info, debug, trace)',
   },
   {
     name: 'agent.security_logger.path',
@@ -369,21 +367,28 @@ const agent = [
     arg: '<ms>',
     default: 30000,
     fn: parseNum,
-    desc: 'how often (in ms), application activity messages are sent',
+    desc: 'how often (in ms) application activity messages are sent to the UI',
+  },
+  {
+    name: 'agent.polling.app_update_ms',
+    arg: '<ms>',
+    default: 30000,
+    fn: parseNum,
+    desc: 'how often (in ms) application updates are sent to the UI'
   },
   {
     name: 'agent.polling.app_settings_ms',
     arg: '<ms>',
     default: 30000,
     fn: parseNum,
-    desc: 'how often (in ms), application settings polls are sent',
+    desc: 'how often (in ms) application settings polls are sent to the UI',
   },
   {
     name: 'agent.polling.server_settings_ms',
     arg: '<ms>',
     default: 30000,
     fn: parseNum,
-    desc: 'how often (in ms), server settings polls are sent',
+    desc: 'how often (in ms) server settings polls are sent to the UI',
   }
 ];
 

package/lib/util.js

@@ -242,9 +242,9 @@ function mergeOptions() {
     let isFromDefault, origin;
 
     if (env != null || autoEnv != null) {
-      origin = 'ENV';
+      origin = 'ENVIRONMENT_VARIABLE';
     } else if (fileFlag != null) {
-      origin = 'YAML';
+      origin = 'USER_CONFIGURATION_FILE';
     }
 
     // env > file > default
@@ -257,7 +257,7 @@ function mergeOptions() {
     if (optEnum && optEnum.indexOf(value) === -1) {
       value = fn(optDefault);
       isFromDefault = true;
-      origin = 'DEFAULT';
+      origin = 'DEFAULT_VALUE';
     }
 
     // set default last and separately, so that we can mark that the option was
@@ -265,7 +265,7 @@ function mergeOptions() {
     if (value === undefined) {
       value = fn(optDefault);
       isFromDefault = true;
-      origin = 'DEFAULT';
+      origin = 'DEFAULT_VALUE';
     }
 
     setConfig(options, name, value, isFromDefault, origin);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/config",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "description": "An API for discovering Contrast agent configuration data",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -17,7 +17,7 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.7.0",
+    "@contrast/common": "1.9.0",
     "yaml": "^2.2.2"
   }
 }