@contrast/config 1.26.0 → 1.26.2

package/lib/index.d.ts

@@ -184,10 +184,20 @@ export interface Config {
     node: {
       /** Location to look for the app's package.json. Default: `process.cwd()` */
       app_root: string;
-      /** Default: `true` */
-      enable_rewrite: boolean;
-      /** Default: `true` */
-      enable_source_maps: boolean;
+      rewrite: {
+        /** Default: `true` */
+        enable: boolean;
+        cache: {
+          /** Default: `true` */
+          enable: boolean;
+          /** Default: `./.contrast` */
+          path: string;
+        }
+      };
+      source_maps: {
+        /** Default: `true` */
+        enable: boolean;
+      };
       library_usage: {
         reporting: {
           /** Default: `true` */
@@ -296,10 +306,6 @@ export interface Config {
   setValue(name: string, value: any, source: ConfigSource): void;
 }
 
-interface Core {
-  config: Config;
-}
-
-declare function init(core: Core): Config;
+declare function init(core: { config?: Config }): Config;
 
 export = init;

package/lib/options.js

@@ -77,7 +77,7 @@ const parseNum = (val) => {
  * The module currently houses all new common config settings.
  *
  * Other settings include:
- * - fn: a function to run on the original value (eg type coercion or sanitizing). returns undefined if it can't do anything with the value it is given.
+ * - fn: a function to run on the original value (eg type coercion or sanitizing). Returns undefined if it can't do anything with the value it is given.
  * - enum: validation of whether type matches enumerated value
  *
  * NOTE: I'm not sure if validation should also be specified and handled here.
@@ -89,6 +89,13 @@ const parseNum = (val) => {
  * @type {import('.').ConfigOption[]}
  */
 const options = [
+  {
+    name: 'enable',
+    arg: '[true]',
+    default: true,
+    fn: castBoolean,
+    desc: 'Set to `false` to disable Contrast agent.',
+  },
   // api
   {
     name: 'api.enable',
@@ -411,7 +418,7 @@ Example - \`/opt/Contrast/contrast.log\` creates a log in the \`/opt/Contrast\`
     name: 'agent.node.cmd_ignore_list',
     arg: '<commands>',
     default: '',
-    fn: (arg) => arg.split(',').filter((v)=> v),
+    fn: (arg) => arg.split(',').filter((v) => v),
     desc: 'comma-separated list of commands that will not startup the agent if agent is required; npm* will ignore all npm executables but not your application\'s scripts'
   },
   {
@@ -422,7 +429,7 @@ Example - \`/opt/Contrast/contrast.log\` creates a log in the \`/opt/Contrast\`
   },
   {
     // NOTE: not in common config.
-    name: 'agent.node.enable_rewrite',
+    name: 'agent.node.rewrite.enable',
     arg: '[false]',
     default: true,
     fn: castBoolean,
@@ -430,11 +437,28 @@ Example - \`/opt/Contrast/contrast.log\` creates a log in the \`/opt/Contrast\`
   },
   {
     // NOTE: not in common config.
-    name: 'agent.node.enable_source_maps',
+    name: 'agent.node.rewrite.cache.enable',
+    arg: '[false]',
+    default: true,
+    fn: castBoolean,
+    desc: 'Set to `false` to disable caching rewritten source code files.',
+  },
+  {
+    // NOTE: not in common config.
+    name: 'agent.node.rewrite.cache.path',
+    arg: '<path>',
+    default: '.contrast',
+    fn: toAbsolutePath,
+    desc: "Set the directory in which to cache rewritten source code files. Defaults to `.contrast/` in the application's current working directory.",
+  },
+  {
+    // NOTE: not in common config.
+    name: 'agent.node.source_maps.enable',
     arg: '[false]',
     default: true,
     fn: castBoolean,
-    desc: 'Set to `true` to enable source map support in reporting.',
+    // TODO: update description once we support handling and chaining source maps.
+    desc: 'Set to `false` to disable source map generation.',
   },
   // agent.node.library_usage.reporting
   {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/config",
-  "version": "1.26.0",
+  "version": "1.26.2",
   "description": "An API for discovering Contrast agent configuration data",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",