@api3/commons 0.7.0 → 0.7.1

package/dist/config-parsing/index.d.ts

@@ -1,12 +1,12 @@
 import dotenv from 'dotenv';
 import { z } from 'zod';
-export declare const secretNamePattern: RegExp;
-export declare const secretNameSchema: z.ZodString;
-export declare const secretsSchema: z.ZodRecord<z.ZodString, z.ZodString>;
-export declare const nonBlankSecretsSchema: z.ZodRecord<z.ZodString, z.ZodString>;
+export declare const strictSecretNamePattern: RegExp;
+export declare const strictSecretNameSchema: z.ZodString;
+export declare const nonBlankSecretValueSchema: z.ZodString;
 export type Secrets = Record<string, string>;
 export interface InterpolationOptions {
-    allowBlankSecretValue: boolean;
+    allowBlankSecretValue?: boolean;
+    validateSecretName?: boolean;
 }
 export type AnyObject = Record<string, unknown>;
 export declare function interpolateSecretsIntoConfig<T = AnyObject>(config: T, secrets: unknown, options?: InterpolationOptions): T;

package/dist/config-parsing/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config-parsing/index.ts"],"names":[],"mappings":"AAEA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,iBAAiB,QAAqB,CAAC;AAEpD,eAAO,MAAM,gBAAgB,aAEoF,CAAC;AAElH,eAAO,MAAM,aAAa,uCAAyC,CAAC;AAEpE,eAAO,MAAM,qBAAqB,uCAGjC,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAe7C,MAAM,WAAW,oBAAoB;IACnC,qBAAqB,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEhD,wBAAgB,4BAA4B,CAAC,CAAC,GAAG,SAAS,EACxD,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,oBAAsD,KA0BhE;AAED,eAAO,MAAM,WAAW,SAAU,MAAM,6BAA6C,CAAC;AAEtF,eAAO,MAAM,UAAU,SAAU,MAAM,QAA2C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config-parsing/index.ts"],"names":[],"mappings":"AAEA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,uBAAuB,QAAqB,CAAC;AAE1D,eAAO,MAAM,sBAAsB,aAKhC,CAAC;AAEJ,eAAO,MAAM,yBAAyB,aAA2D,CAAC;AAElG,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAe7C,MAAM,WAAW,oBAAoB;IACnC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEhD,wBAAgB,4BAA4B,CAAC,CAAC,GAAG,SAAS,EACxD,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,oBAAoB,KA4B/B;AAED,eAAO,MAAM,WAAW,SAAU,MAAM,6BAA6C,CAAC;AAEtF,eAAO,MAAM,UAAU,SAAU,MAAM,QAA2C,CAAC"}

package/dist/config-parsing/index.js

@@ -3,18 +3,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadConfig = exports.loadSecrets = exports.interpolateSecretsIntoConfig = exports.nonBlankSecretsSchema = exports.secretsSchema = exports.secretNameSchema = exports.secretNamePattern = void 0;
+exports.loadConfig = exports.loadSecrets = exports.interpolateSecretsIntoConfig = exports.nonBlankSecretValueSchema = exports.strictSecretNameSchema = exports.strictSecretNamePattern = void 0;
 const node_fs_1 = require("node:fs");
 const dotenv_1 = __importDefault(require("dotenv"));
 const reduce_1 = __importDefault(require("lodash/reduce"));
 const template_1 = __importDefault(require("lodash/template"));
 const zod_1 = require("zod");
-exports.secretNamePattern = /^[A-Z][\dA-Z_]*$/;
-exports.secretNameSchema = zod_1.z
+exports.strictSecretNamePattern = /^[A-Z][\dA-Z_]*$/;
+exports.strictSecretNameSchema = zod_1.z
     .string()
-    .regex(exports.secretNamePattern, `Secret name is not a valid. Secret name must match ${exports.secretNamePattern.toString()}`);
-exports.secretsSchema = zod_1.z.record(exports.secretNameSchema, zod_1.z.string());
-exports.nonBlankSecretsSchema = zod_1.z.record(exports.secretNameSchema, zod_1.z.string().min(1, { message: 'Secret cannot be blank' }));
+    .regex(exports.strictSecretNamePattern, `Secret name is not a valid. Secret name must match ${exports.strictSecretNamePattern.toString()}`);
+exports.nonBlankSecretValueSchema = zod_1.z.string().min(1, { message: 'Secret cannot be blank' });
 // Regular expression that does not match anything, ensuring no escaping or interpolation happens
 // https://github.com/lodash/lodash/blob/4.17.15/lodash.js#L199
 // eslint-disable-next-line prefer-named-capture-group
@@ -27,9 +26,11 @@ const ES_MATCH_REGEXP = /(?<!\\)\${([^\\}]*(?:\\.[^\\}]*)*)}/g;
 // because "\\" becomes "\\\\" when converted to string
 // eslint-disable-next-line prefer-named-capture-group
 const ESCAPED_ES_MATCH_REGEXP = /\\\\(\${([^\\}]*(?:\\.[^\\}]*)*)})/g;
-function interpolateSecretsIntoConfig(config, secrets, options = { allowBlankSecretValue: true }) {
-    const { allowBlankSecretValue } = options;
-    const validatedSecrets = (allowBlankSecretValue ? exports.secretsSchema : exports.nonBlankSecretsSchema).parse(secrets);
+function interpolateSecretsIntoConfig(config, secrets, options) {
+    const { allowBlankSecretValue = true, validateSecretName = true } = options ?? {};
+    const secretNameSchema = validateSecretName ? exports.strictSecretNameSchema : zod_1.z.string();
+    const secretValueSchema = allowBlankSecretValue ? zod_1.z.string() : exports.nonBlankSecretValueSchema;
+    const validatedSecrets = zod_1.z.record(secretNameSchema, secretValueSchema).parse(secrets);
     const stringifiedSecrets = (0, reduce_1.default)(validatedSecrets, (acc, value, key) => {
         return {
             ...acc,

package/dist/config-parsing/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/config-parsing/index.ts"],"names":[],"mappings":";;;;;;AAAA,qCAAuC;AAEvC,oDAA4B;AAC5B,2DAAmC;AACnC,+DAAuC;AACvC,6BAAwB;AAEX,QAAA,iBAAiB,GAAG,kBAAkB,CAAC;AAEvC,QAAA,gBAAgB,GAAG,OAAC;KAC9B,MAAM,EAAE;KACR,KAAK,CAAC,yBAAiB,EAAE,sDAAsD,yBAAiB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAErG,QAAA,aAAa,GAAG,OAAC,CAAC,MAAM,CAAC,wBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AAEvD,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAC3C,wBAAgB,EAChB,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC,CACzD,CAAC;AAIF,iGAAiG;AACjG,+DAA+D;AAC/D,sDAAsD;AACtD,MAAM,eAAe,GAAG,MAAM,CAAC;AAC/B,gFAAgF;AAChF,+DAA+D;AAC/D,sDAAsD;AACtD,MAAM,eAAe,GAAG,sCAAsC,CAAC;AAC/D,wHAAwH;AACxH,uDAAuD;AACvD,sDAAsD;AACtD,MAAM,uBAAuB,GAAG,qCAAqC,CAAC;AAQtE,SAAgB,4BAA4B,CAC1C,MAAS,EACT,OAAgB,EAChB,UAAgC,EAAE,qBAAqB,EAAE,IAAI,EAAE;IAE/D,MAAM,EAAE,qBAAqB,EAAE,GAAG,OAAO,CAAC;IAC1C,MAAM,gBAAgB,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,qBAAa,CAAC,CAAC,CAAC,6BAAqB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAExG,MAAM,kBAAkB,GAAG,IAAA,gBAAM,EAC/B,gBAAgB,EAChB,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QAClB,OAAO;YACL,GAAG,GAAG;YACN,8GAA8G;YAC9G,wBAAwB;YACxB,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SAC1C,CAAC;IACJ,CAAC,EACD,EAAa,CACd,CAAC;IAEF,MAAM,kBAAkB,GAAG,IAAA,kBAAQ,EAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QAC1D,MAAM,EAAE,eAAe;QACvB,QAAQ,EAAE,eAAe;QACzB,WAAW,EAAE,eAAe;KAC7B,CAAC,CAAC,kBAAkB,CAAC,CAAC;IACvB,oHAAoH;IACpH,2CAA2C;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAM,CAAC;AACvF,CAAC;AA7BD,oEA6BC;AAEM,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,gBAAM,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAAzE,QAAA,WAAW,eAA8D;AAE/E,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAAtE,QAAA,UAAU,cAA4D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/config-parsing/index.ts"],"names":[],"mappings":";;;;;;AAAA,qCAAuC;AAEvC,oDAA4B;AAC5B,2DAAmC;AACnC,+DAAuC;AACvC,6BAAwB;AAEX,QAAA,uBAAuB,GAAG,kBAAkB,CAAC;AAE7C,QAAA,sBAAsB,GAAG,OAAC;KACpC,MAAM,EAAE;KACR,KAAK,CACJ,+BAAuB,EACvB,sDAAsD,+BAAuB,CAAC,QAAQ,EAAE,EAAE,CAC3F,CAAC;AAES,QAAA,yBAAyB,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC,CAAC;AAIlG,iGAAiG;AACjG,+DAA+D;AAC/D,sDAAsD;AACtD,MAAM,eAAe,GAAG,MAAM,CAAC;AAC/B,gFAAgF;AAChF,+DAA+D;AAC/D,sDAAsD;AACtD,MAAM,eAAe,GAAG,sCAAsC,CAAC;AAC/D,wHAAwH;AACxH,uDAAuD;AACvD,sDAAsD;AACtD,MAAM,uBAAuB,GAAG,qCAAqC,CAAC;AAStE,SAAgB,4BAA4B,CAC1C,MAAS,EACT,OAAgB,EAChB,OAA8B;IAE9B,MAAM,EAAE,qBAAqB,GAAG,IAAI,EAAE,kBAAkB,GAAG,IAAI,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAClF,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,CAAC,CAAC,8BAAsB,CAAC,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;IAClF,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,iCAAyB,CAAC;IACzF,MAAM,gBAAgB,GAAG,OAAC,CAAC,MAAM,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAEtF,MAAM,kBAAkB,GAAG,IAAA,gBAAM,EAC/B,gBAAgB,EAChB,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QAClB,OAAO;YACL,GAAG,GAAG;YACN,8GAA8G;YAC9G,wBAAwB;YACxB,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SAC1C,CAAC;IACJ,CAAC,EACD,EAAa,CACd,CAAC;IAEF,MAAM,kBAAkB,GAAG,IAAA,kBAAQ,EAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QAC1D,MAAM,EAAE,eAAe;QACvB,QAAQ,EAAE,eAAe;QACzB,WAAW,EAAE,eAAe;KAC7B,CAAC,CAAC,kBAAkB,CAAC,CAAC;IACvB,oHAAoH;IACpH,2CAA2C;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAM,CAAC;AACvF,CAAC;AA/BD,oEA+BC;AAEM,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,gBAAM,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAAzE,QAAA,WAAW,eAA8D;AAE/E,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAAtE,QAAA,UAAU,cAA4D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@api3/commons",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "keywords": [],
   "license": "MIT",
   "engines": {

package/src/config-parsing/index.test.ts

@@ -127,6 +127,38 @@ describe(interpolateSecretsIntoConfig.name, () => {
     );
   });
 
+  it('allows parsing secrets without validating secret names', () => {
+    const rawSecrets = {
+      SECRET_A: 'secretValueA',
+      SECRET_B: 'secretValueB',
+      'CANNOT-CONTAIN-HYPHEN': 'invalid',
+      lowercasedSecret: 'valid',
+    };
+
+    expect(() => interpolateSecretsIntoConfig(rawConfig, rawSecrets)).toThrow(
+      new ZodError([
+        {
+          validation: 'regex',
+          code: 'invalid_string',
+          message: 'Secret name is not a valid. Secret name must match /^[A-Z][\\dA-Z_]*$/',
+          path: ['CANNOT-CONTAIN-HYPHEN'],
+        },
+        {
+          validation: 'regex',
+          code: 'invalid_string',
+          message: 'Secret name is not a valid. Secret name must match /^[A-Z][\\dA-Z_]*$/',
+          path: ['lowercasedSecret'],
+        },
+      ])
+    );
+
+    expect(interpolateSecretsIntoConfig(rawConfig, rawSecrets, { validateSecretName: false })).toStrictEqual({
+      property: 'value',
+      secretA: 'secretValueA',
+      secretB: 'secretValueB',
+    });
+  });
+
   it('provides up to date README examples', () => {
     // Basic interpolation
     const basicInterpolationConfig = {

package/src/config-parsing/index.ts

@@ -5,18 +5,16 @@ import reduce from 'lodash/reduce';
 import template from 'lodash/template';
 import { z } from 'zod';
 
-export const secretNamePattern = /^[A-Z][\dA-Z_]*$/;
+export const strictSecretNamePattern = /^[A-Z][\dA-Z_]*$/;
 
-export const secretNameSchema = z
+export const strictSecretNameSchema = z
   .string()
-  .regex(secretNamePattern, `Secret name is not a valid. Secret name must match ${secretNamePattern.toString()}`);
-
-export const secretsSchema = z.record(secretNameSchema, z.string());
+  .regex(
+    strictSecretNamePattern,
+    `Secret name is not a valid. Secret name must match ${strictSecretNamePattern.toString()}`
+  );
 
-export const nonBlankSecretsSchema = z.record(
-  secretNameSchema,
-  z.string().min(1, { message: 'Secret cannot be blank' })
-);
+export const nonBlankSecretValueSchema = z.string().min(1, { message: 'Secret cannot be blank' });
 
 export type Secrets = Record<string, string>;
 
@@ -34,7 +32,8 @@ const ES_MATCH_REGEXP = /(?<!\\)\${([^\\}]*(?:\\.[^\\}]*)*)}/g;
 const ESCAPED_ES_MATCH_REGEXP = /\\\\(\${([^\\}]*(?:\\.[^\\}]*)*)})/g;
 
 export interface InterpolationOptions {
-  allowBlankSecretValue: boolean;
+  allowBlankSecretValue?: boolean;
+  validateSecretName?: boolean;
 }
 
 export type AnyObject = Record<string, unknown>;
@@ -42,10 +41,12 @@ export type AnyObject = Record<string, unknown>;
 export function interpolateSecretsIntoConfig<T = AnyObject>(
   config: T,
   secrets: unknown,
-  options: InterpolationOptions = { allowBlankSecretValue: true }
+  options?: InterpolationOptions
 ) {
-  const { allowBlankSecretValue } = options;
-  const validatedSecrets = (allowBlankSecretValue ? secretsSchema : nonBlankSecretsSchema).parse(secrets);
+  const { allowBlankSecretValue = true, validateSecretName = true } = options ?? {};
+  const secretNameSchema = validateSecretName ? strictSecretNameSchema : z.string();
+  const secretValueSchema = allowBlankSecretValue ? z.string() : nonBlankSecretValueSchema;
+  const validatedSecrets = z.record(secretNameSchema, secretValueSchema).parse(secrets);
 
   const stringifiedSecrets = reduce(
     validatedSecrets,