@voiceflow/common 8.9.3 → 8.11.0

package/build/cjs/utils/variables.d.ts

@@ -5,15 +5,21 @@ export declare const splitVariableName: (inner: string, options?: {
     id: string;
     path: string;
 };
-export declare function replaceVariables(phrase: string | undefined | null, variables: Record<string, unknown>, modifier?: (variable: unknown) => unknown, options?: {
+export declare function replaceVariables(phrase: string | undefined | null, variables: Record<string, unknown>, options?: {
+    modifier?: (variable: unknown) => unknown;
     trim?: boolean;
     keepTypeIfOnlyVariable?: false;
 }): string;
-export declare function replaceVariables(phrase: string | undefined | null, variables: Record<string, unknown>, modifier?: (variable: unknown) => unknown, options?: {
+export declare function replaceVariables(phrase: string | undefined | null, variables: Record<string, unknown>, options: {
+    modifier?: (variable: unknown) => unknown;
     trim?: boolean;
     keepTypeIfOnlyVariable: true;
 }): unknown;
 export declare const sanitizeVariables: (variables: Record<string, unknown>) => Record<string, unknown>;
 export declare const transformStringVariableToNumber: (str: string | number | null) => number | string | null;
-export declare const deepVariableSubstitution: <T>(bodyData: T, variableMap: Record<string, unknown>) => T;
+export declare const deepVariableSubstitution: <T>(bodyData: T, variableMap: Record<string, unknown>, options?: {
+    trim?: boolean;
+    modifier?: (variable: unknown) => unknown;
+    keepTypeIfOnlyVariable?: boolean;
+}) => T;
 //# sourceMappingURL=variables.d.ts.map

package/build/cjs/utils/variables.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../../src/utils/variables.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,gBAAgB,UACpB,MAAM,SACN,MAAM,aACF,OAAO,MAAM,EAAE,OAAO,CAAC,aACvB,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,KACxC,OAmBF,CAAC;AAEF,eAAO,MAAM,iBAAiB,UACrB,MAAM,YACJ;IAAE,iBAAiB,EAAE,OAAO,CAAA;CAAE;;;CAiCxC,CAAC;AAEF,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACjC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,EACzC,OAAO,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,sBAAsB,CAAC,EAAE,KAAK,CAAA;CAAE,GAC3D,MAAM,CAAC;AACV,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACjC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,EACzC,OAAO,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,sBAAsB,EAAE,IAAI,CAAA;CAAE,GACzD,OAAO,CAAC;AAuBX,eAAO,MAAM,iBAAiB,cAAe,OAAO,MAAM,EAAE,OAAO,CAAC,KAAG,OAAO,MAAM,EAAE,OAAO,CASrF,CAAC;AAET,eAAO,MAAM,+BAA+B,QAAS,MAAM,GAAG,MAAM,GAAG,IAAI,KAAG,MAAM,GAAG,MAAM,GAAG,IAY/F,CAAC;AAEF,eAAO,MAAM,wBAAwB,gBAAiB,CAAC,eAAe,OAAO,MAAM,EAAE,OAAO,CAAC,KAAG,CA2B/F,CAAC"}
+{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../../src/utils/variables.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,gBAAgB,UACpB,MAAM,SACN,MAAM,aACF,OAAO,MAAM,EAAE,OAAO,CAAC,aACxB,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,KACvC,OAoBF,CAAC;AAEF,eAAO,MAAM,iBAAiB,UACrB,MAAM,YACJ;IAAE,iBAAiB,EAAE,OAAO,CAAA;CAAE;;;CAiCxC,CAAC;AAEF,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACjC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,sBAAsB,CAAC,EAAE,KAAK,CAAA;CAAE,GACtG,MAAM,CAAC;AACV,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACjC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,sBAAsB,EAAE,IAAI,CAAA;CAAE,GACnG,OAAO,CAAC;AA6BX,eAAO,MAAM,iBAAiB,cAAe,OAAO,MAAM,EAAE,OAAO,CAAC,KAAG,OAAO,MAAM,EAAE,OAAO,CASrF,CAAC;AAET,eAAO,MAAM,+BAA+B,QAAS,MAAM,GAAG,MAAM,GAAG,IAAI,KAAG,MAAM,GAAG,MAAM,GAAG,IAY/F,CAAC;AAEF,eAAO,MAAM,wBAAwB,gBACzB,CAAC,eACE,OAAO,MAAM,EAAE,OAAO,CAAC,YAC1B;IAAE,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;IAAC,sBAAsB,CAAC,EAAE,OAAO,CAAA;CAAE,KACxG,CA2BF,CAAC"}

package/build/cjs/utils/variables.js

@@ -6,17 +6,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deepVariableSubstitution = exports.transformStringVariableToNumber = exports.sanitizeVariables = exports.replaceVariables = exports.splitVariableName = exports.variableReplacer = void 0;
 const constants_1 = require("../constants");
 const get_js_1 = __importDefault(require("lodash/get.js"));
-const variableReplacer = (match, inner, variables, modifier) => {
+const variableReplacer = (match, inner, variables, modifier = (val) => val) => {
     const { id, path } = (0, exports.splitVariableName)(inner);
     if (!(id in variables)) {
         return match;
     }
     if (!path) {
-        return typeof modifier === 'function' ? modifier(variables[id]) : variables[id];
+        return modifier(variables[id]);
     }
     try {
         const variable = typeof variables[id] === 'string' ? JSON.parse(variables[id]) : variables[id];
-        return typeof modifier === 'function' ? modifier((0, get_js_1.default)(variable, path, 0)) : (0, get_js_1.default)(variable, path, 0);
+        return modifier((0, get_js_1.default)(variable, path, 0));
     }
     catch (err) {
         if (err?.message.includes('is not valid JSON')) {
@@ -56,16 +56,17 @@ const splitVariableName = (inner, options = { pathWithDotPrefix: false }) => {
     };
 };
 exports.splitVariableName = splitVariableName;
-function replaceVariables(phrase, variables, modifier = undefined, { trim = true, keepTypeIfOnlyVariable = false } = {}) {
-    if (!phrase || (trim && !phrase.trim())) {
+function replaceVariables(phrase, variables, { trim = true, modifier, keepTypeIfOnlyVariable = false, } = {}) {
+    const formattedPhrase = trim ? phrase?.trim() : phrase;
+    if (!formattedPhrase) {
         return '';
     }
-    if (keepTypeIfOnlyVariable && phrase.match(constants_1.VARIABLE_ONLY_REGEXP)) {
+    if (keepTypeIfOnlyVariable && formattedPhrase.match(constants_1.VARIABLE_ONLY_REGEXP)) {
         // remove the curly braces {} from phrase to get the inner
-        const inner = phrase.slice(1, -1);
-        return (0, exports.variableReplacer)(phrase, inner, variables, modifier);
+        const inner = formattedPhrase.slice(1, -1);
+        return (0, exports.variableReplacer)(formattedPhrase, inner, variables, modifier);
     }
-    return phrase.replace(constants_1.READABLE_VARIABLE_REGEXP, (match, inner) => String((0, exports.variableReplacer)(match, inner, variables, modifier)));
+    return formattedPhrase.replace(constants_1.READABLE_VARIABLE_REGEXP, (match, inner) => String((0, exports.variableReplacer)(match, inner, variables, modifier)));
 }
 exports.replaceVariables = replaceVariables;
 // turn float variables to 4 decimal places
@@ -90,16 +91,16 @@ const transformStringVariableToNumber = (str) => {
     return Number.isNaN(number) ? str : number;
 };
 exports.transformStringVariableToNumber = transformStringVariableToNumber;
-const deepVariableSubstitution = (bodyData, variableMap) => {
-    const _recurse = (subCollection, modifier) => {
+const deepVariableSubstitution = (bodyData, variableMap, options) => {
+    const _recurse = (subCollection) => {
         if (!subCollection) {
             return subCollection;
         }
         if (typeof subCollection === 'string') {
-            return replaceVariables(subCollection, variableMap, modifier);
+            return replaceVariables(subCollection, variableMap, options);
         }
         if (Array.isArray(subCollection)) {
-            return subCollection.map((v) => _recurse(v, modifier));
+            return subCollection.map((v) => _recurse(v));
         }
         if (typeof subCollection === 'object') {
             Object.keys(subCollection).forEach((key) => {

package/build/esm/utils/variables.d.ts

@@ -5,15 +5,21 @@ export declare const splitVariableName: (inner: string, options?: {
     id: string;
     path: string;
 };
-export declare function replaceVariables(phrase: string | undefined | null, variables: Record<string, unknown>, modifier?: (variable: unknown) => unknown, options?: {
+export declare function replaceVariables(phrase: string | undefined | null, variables: Record<string, unknown>, options?: {
+    modifier?: (variable: unknown) => unknown;
     trim?: boolean;
     keepTypeIfOnlyVariable?: false;
 }): string;
-export declare function replaceVariables(phrase: string | undefined | null, variables: Record<string, unknown>, modifier?: (variable: unknown) => unknown, options?: {
+export declare function replaceVariables(phrase: string | undefined | null, variables: Record<string, unknown>, options: {
+    modifier?: (variable: unknown) => unknown;
     trim?: boolean;
     keepTypeIfOnlyVariable: true;
 }): unknown;
 export declare const sanitizeVariables: (variables: Record<string, unknown>) => Record<string, unknown>;
 export declare const transformStringVariableToNumber: (str: string | number | null) => number | string | null;
-export declare const deepVariableSubstitution: <T>(bodyData: T, variableMap: Record<string, unknown>) => T;
+export declare const deepVariableSubstitution: <T>(bodyData: T, variableMap: Record<string, unknown>, options?: {
+    trim?: boolean;
+    modifier?: (variable: unknown) => unknown;
+    keepTypeIfOnlyVariable?: boolean;
+}) => T;
 //# sourceMappingURL=variables.d.ts.map

package/build/esm/utils/variables.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../../src/utils/variables.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,gBAAgB,UACpB,MAAM,SACN,MAAM,aACF,OAAO,MAAM,EAAE,OAAO,CAAC,aACvB,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,KACxC,OAmBF,CAAC;AAEF,eAAO,MAAM,iBAAiB,UACrB,MAAM,YACJ;IAAE,iBAAiB,EAAE,OAAO,CAAA;CAAE;;;CAiCxC,CAAC;AAEF,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACjC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,EACzC,OAAO,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,sBAAsB,CAAC,EAAE,KAAK,CAAA;CAAE,GAC3D,MAAM,CAAC;AACV,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACjC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,EACzC,OAAO,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,sBAAsB,EAAE,IAAI,CAAA;CAAE,GACzD,OAAO,CAAC;AAuBX,eAAO,MAAM,iBAAiB,cAAe,OAAO,MAAM,EAAE,OAAO,CAAC,KAAG,OAAO,MAAM,EAAE,OAAO,CASrF,CAAC;AAET,eAAO,MAAM,+BAA+B,QAAS,MAAM,GAAG,MAAM,GAAG,IAAI,KAAG,MAAM,GAAG,MAAM,GAAG,IAY/F,CAAC;AAEF,eAAO,MAAM,wBAAwB,gBAAiB,CAAC,eAAe,OAAO,MAAM,EAAE,OAAO,CAAC,KAAG,CA2B/F,CAAC"}
+{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../../src/utils/variables.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,gBAAgB,UACpB,MAAM,SACN,MAAM,aACF,OAAO,MAAM,EAAE,OAAO,CAAC,aACxB,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,KACvC,OAoBF,CAAC;AAEF,eAAO,MAAM,iBAAiB,UACrB,MAAM,YACJ;IAAE,iBAAiB,EAAE,OAAO,CAAA;CAAE;;;CAiCxC,CAAC;AAEF,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACjC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,sBAAsB,CAAC,EAAE,KAAK,CAAA;CAAE,GACtG,MAAM,CAAC;AACV,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACjC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,sBAAsB,EAAE,IAAI,CAAA;CAAE,GACnG,OAAO,CAAC;AA6BX,eAAO,MAAM,iBAAiB,cAAe,OAAO,MAAM,EAAE,OAAO,CAAC,KAAG,OAAO,MAAM,EAAE,OAAO,CASrF,CAAC;AAET,eAAO,MAAM,+BAA+B,QAAS,MAAM,GAAG,MAAM,GAAG,IAAI,KAAG,MAAM,GAAG,MAAM,GAAG,IAY/F,CAAC;AAEF,eAAO,MAAM,wBAAwB,gBACzB,CAAC,eACE,OAAO,MAAM,EAAE,OAAO,CAAC,YAC1B;IAAE,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;IAAC,sBAAsB,CAAC,EAAE,OAAO,CAAA;CAAE,KACxG,CA2BF,CAAC"}

package/build/esm/utils/variables.js

@@ -1,16 +1,16 @@
 import { READABLE_VARIABLE_REGEXP, VARIABLE_ONLY_REGEXP } from '../constants/index.js';
 import _get from 'lodash/get.js';
-export const variableReplacer = (match, inner, variables, modifier) => {
+export const variableReplacer = (match, inner, variables, modifier = (val) => val) => {
     const { id, path } = splitVariableName(inner);
     if (!(id in variables)) {
         return match;
     }
     if (!path) {
-        return typeof modifier === 'function' ? modifier(variables[id]) : variables[id];
+        return modifier(variables[id]);
     }
     try {
         const variable = typeof variables[id] === 'string' ? JSON.parse(variables[id]) : variables[id];
-        return typeof modifier === 'function' ? modifier(_get(variable, path, 0)) : _get(variable, path, 0);
+        return modifier(_get(variable, path, 0));
     }
     catch (err) {
         if (err?.message.includes('is not valid JSON')) {
@@ -48,16 +48,17 @@ export const splitVariableName = (inner, options = { pathWithDotPrefix: false })
         path: inner.slice(firstSquareBracketIndex),
     };
 };
-export function replaceVariables(phrase, variables, modifier = undefined, { trim = true, keepTypeIfOnlyVariable = false } = {}) {
-    if (!phrase || (trim && !phrase.trim())) {
+export function replaceVariables(phrase, variables, { trim = true, modifier, keepTypeIfOnlyVariable = false, } = {}) {
+    const formattedPhrase = trim ? phrase?.trim() : phrase;
+    if (!formattedPhrase) {
         return '';
     }
-    if (keepTypeIfOnlyVariable && phrase.match(VARIABLE_ONLY_REGEXP)) {
+    if (keepTypeIfOnlyVariable && formattedPhrase.match(VARIABLE_ONLY_REGEXP)) {
         // remove the curly braces {} from phrase to get the inner
-        const inner = phrase.slice(1, -1);
-        return variableReplacer(phrase, inner, variables, modifier);
+        const inner = formattedPhrase.slice(1, -1);
+        return variableReplacer(formattedPhrase, inner, variables, modifier);
     }
-    return phrase.replace(READABLE_VARIABLE_REGEXP, (match, inner) => String(variableReplacer(match, inner, variables, modifier)));
+    return formattedPhrase.replace(READABLE_VARIABLE_REGEXP, (match, inner) => String(variableReplacer(match, inner, variables, modifier)));
 }
 // turn float variables to 4 decimal places
 export const sanitizeVariables = (variables) => Object.entries(variables).reduce((acc, [key, value]) => {
@@ -79,16 +80,16 @@ export const transformStringVariableToNumber = (str) => {
     const number = Number(str);
     return Number.isNaN(number) ? str : number;
 };
-export const deepVariableSubstitution = (bodyData, variableMap) => {
-    const _recurse = (subCollection, modifier) => {
+export const deepVariableSubstitution = (bodyData, variableMap, options) => {
+    const _recurse = (subCollection) => {
         if (!subCollection) {
             return subCollection;
         }
         if (typeof subCollection === 'string') {
-            return replaceVariables(subCollection, variableMap, modifier);
+            return replaceVariables(subCollection, variableMap, options);
         }
         if (Array.isArray(subCollection)) {
-            return subCollection.map((v) => _recurse(v, modifier));
+            return subCollection.map((v) => _recurse(v));
         }
         if (typeof subCollection === 'object') {
             Object.keys(subCollection).forEach((key) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voiceflow/common",
-  "version": "8.9.3",
+  "version": "8.11.0",
   "description": "Junk drawer of utility functions",
   "keywords": [
     "voiceflow"
@@ -88,5 +88,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "249577031363d019cf797d827a44ab6089e3faa3"
+  "gitHead": "f36349e81e2cc0cdee06b6c74d68f41116a7072e"
 }