@voiceflow/common 7.25.3 → 7.26.0

package/build/common/utils/array.d.ts

@@ -37,4 +37,30 @@ export declare const filterOutNullish: <T>(items: readonly T[]) => NonNullable<T
 export declare const filterAndGetLastRemovedValue: <T>(list: T[], filter: (item: T) => boolean) => [T[], T | null];
 export declare const inferUnion: <T extends ArrayLike<unknown>>(array: T) => import("../types").SafeArray<T[number], T>;
 export declare const toArray: <T>(valueOrArray: T | T[]) => T[];
+/**
+ * Merge together two arrays, if two items have the same identity based on the {@link identify} function
+ * they will be merged together using the {@link merge} function provided.
+ * @param items Array of items as a starting base.
+ * @param newItems Array of items to merge in.
+ * @param identify Function returning how to identify an item in the array
+ * @param merge Function given two matching item identifiers, returning a single merged result
+ * @example
+ * const existingItems = [{a: 1, b: [1, 2, 3]}, {a: 2, b: [4]}];
+ * const newItems = [{a: 1, b: [5]}, {a: 3, b: [6, 7]}];
+ *
+ * const items = mergeByIdentifier(
+ *   existingItems,
+ *   newItems,
+ *   (item) => item.a,
+ *   (existingItem, newItem) => {
+ *     return {
+ *       ...existingItem,
+ *       b: [...existingItem.b, ...newItem.b]
+ *     }
+ *   }
+ * );
+ *
+ * items == [{a: 1, b: [1, 2, 3, 5]}, {a: 2, b: [4]}, {a: 3, b: [6, 7]}];
+ */
+export declare const mergeByIdentifier: <T>(items: T[], newItems: T[], identify: (item: T, index: number) => string, merge: (item1: T, item2: T) => T) => T[];
 export {};

package/build/common/utils/array.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toArray = exports.inferUnion = exports.filterAndGetLastRemovedValue = exports.filterOutNullish = exports.isNotNullish = exports.isNullish = exports.asyncForEach = exports.hasIdenticalMembers = exports.diff = exports.findUnion = exports.createMap = exports.createEntries = exports.separate = exports.reorder = exports.tail = exports.head = exports.toggleMembership = exports.append = exports.insertAll = exports.insert = exports.replace = exports.withoutValues = exports.withoutValue = exports.without = exports.unique = void 0;
+exports.mergeByIdentifier = exports.toArray = exports.inferUnion = exports.filterAndGetLastRemovedValue = exports.filterOutNullish = exports.isNotNullish = exports.isNullish = exports.asyncForEach = exports.hasIdenticalMembers = exports.diff = exports.findUnion = exports.createMap = exports.createEntries = exports.separate = exports.reorder = exports.tail = exports.head = exports.toggleMembership = exports.append = exports.insertAll = exports.insert = exports.replace = exports.withoutValues = exports.withoutValue = exports.without = exports.unique = void 0;
 const unique = (items) => Array.from(new Set(items));
 exports.unique = unique;
 const without = (items, index) => (index < 0 ? items : [...items.slice(0, index), ...items.slice(index + 1)]);
@@ -125,3 +125,42 @@ const inferUnion = (array) => array;
 exports.inferUnion = inferUnion;
 const toArray = (valueOrArray) => (Array.isArray(valueOrArray) ? valueOrArray : [valueOrArray]);
 exports.toArray = toArray;
+/**
+ * Merge together two arrays, if two items have the same identity based on the {@link identify} function
+ * they will be merged together using the {@link merge} function provided.
+ * @param items Array of items as a starting base.
+ * @param newItems Array of items to merge in.
+ * @param identify Function returning how to identify an item in the array
+ * @param merge Function given two matching item identifiers, returning a single merged result
+ * @example
+ * const existingItems = [{a: 1, b: [1, 2, 3]}, {a: 2, b: [4]}];
+ * const newItems = [{a: 1, b: [5]}, {a: 3, b: [6, 7]}];
+ *
+ * const items = mergeByIdentifier(
+ *   existingItems,
+ *   newItems,
+ *   (item) => item.a,
+ *   (existingItem, newItem) => {
+ *     return {
+ *       ...existingItem,
+ *       b: [...existingItem.b, ...newItem.b]
+ *     }
+ *   }
+ * );
+ *
+ * items == [{a: 1, b: [1, 2, 3, 5]}, {a: 2, b: [4]}, {a: 3, b: [6, 7]}];
+ */
+const mergeByIdentifier = (items, newItems, identify, merge) => {
+    const newItemsMap = new Map(newItems.map((newItem, i) => [identify(newItem, i), newItem]));
+    const result = items.map((item, i) => {
+        const itemIdentity = identify(item, i);
+        const matchingNewItem = newItemsMap.get(itemIdentity);
+        if (matchingNewItem) {
+            newItemsMap.delete(itemIdentity);
+            return merge(item, matchingNewItem);
+        }
+        return item;
+    });
+    return result.concat(Array.from(newItemsMap.values()));
+};
+exports.mergeByIdentifier = mergeByIdentifier;

package/build/common/utils/slot.d.ts

@@ -4,3 +4,23 @@ export declare const addPrebuiltEntities: <A extends {
 }>(entities: A[], prebuiltEntities: Record<string, string[]>) => A[];
 export declare const getUniqueSamples: (input: string) => string[];
 export declare const getAllSamples: (inputs?: string[]) => string[];
+/**
+ * Return a tuple of synonyms, the first value being the first synonym, the next being the remaining synonyms
+ */
+export declare const getValueWithSynonyms: (input: string) => [string, string[]];
+/**
+ * Map through all slot annotations in the given string input.
+ * For each annotation, the callbackFn will be called with the slot's key and name, returning a key and name.
+ * @param input String with slot annotations.
+ * @param callbackFn Map function called with the key and name of the slot.
+ * @returns Input with mapped slot annotations
+ * @example const result = mapSlotAnnotations("Hello {{[slot].id}}", ({key, name}) => ({key: key + '2', slot: slot + '2'});
+ * result === "Hello {{[slot2].id2}}"
+ */
+export declare const mapSlotAnnotations: (input: string, callbackFn: (slot: {
+    key: string;
+    name: string;
+}) => {
+    key: string;
+    name: string;
+}) => string;

package/build/common/utils/slot.js

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAllSamples = exports.getUniqueSamples = exports.addPrebuiltEntities = void 0;
+exports.mapSlotAnnotations = exports.getValueWithSynonyms = exports.getAllSamples = exports.getUniqueSamples = exports.addPrebuiltEntities = void 0;
 const uniqBy_1 = __importDefault(require("lodash/uniqBy"));
+const constants_1 = require("../constants");
 const addPrebuiltEntities = (entities, prebuiltEntities) => entities.map((entity) => {
     if (prebuiltEntities[entity.key]) {
         return Object.assign(Object.assign({}, entity), { inputs: [...entity.inputs, ...prebuiltEntities[entity.key]] });
@@ -17,3 +18,27 @@ exports.getUniqueSamples = getUniqueSamples;
 // spread all synonyms into string array ['car, automobile', 'plane, jet'] => ['car', 'automobile', 'plane', 'jet']
 const getAllSamples = (inputs = []) => inputs.flatMap((input) => input.split(',')).filter((sample) => !!sample.trim());
 exports.getAllSamples = getAllSamples;
+/**
+ * Return a tuple of synonyms, the first value being the first synonym, the next being the remaining synonyms
+ */
+const getValueWithSynonyms = (input) => {
+    const [value, ...synonyms] = input.split(',').map((str) => str.trim());
+    return [value, synonyms];
+};
+exports.getValueWithSynonyms = getValueWithSynonyms;
+/**
+ * Map through all slot annotations in the given string input.
+ * For each annotation, the callbackFn will be called with the slot's key and name, returning a key and name.
+ * @param input String with slot annotations.
+ * @param callbackFn Map function called with the key and name of the slot.
+ * @returns Input with mapped slot annotations
+ * @example const result = mapSlotAnnotations("Hello {{[slot].id}}", ({key, name}) => ({key: key + '2', slot: slot + '2'});
+ * result === "Hello {{[slot2].id2}}"
+ */
+const mapSlotAnnotations = (input, callbackFn) => {
+    return input.replace(constants_1.SLOT_REGEXP, (_, slotName, slotKey) => {
+        const { key, name } = callbackFn({ key: slotKey, name: slotName });
+        return `{{[${name}].${key}}}`;
+    });
+};
+exports.mapSlotAnnotations = mapSlotAnnotations;

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

@@ -37,4 +37,30 @@ export declare const filterOutNullish: <T>(items: readonly T[]) => NonNullable<T
 export declare const filterAndGetLastRemovedValue: <T>(list: T[], filter: (item: T) => boolean) => [T[], T | null];
 export declare const inferUnion: <T extends ArrayLike<unknown>>(array: T) => import("../types").SafeArray<T[number], T>;
 export declare const toArray: <T>(valueOrArray: T | T[]) => T[];
+/**
+ * Merge together two arrays, if two items have the same identity based on the {@link identify} function
+ * they will be merged together using the {@link merge} function provided.
+ * @param items Array of items as a starting base.
+ * @param newItems Array of items to merge in.
+ * @param identify Function returning how to identify an item in the array
+ * @param merge Function given two matching item identifiers, returning a single merged result
+ * @example
+ * const existingItems = [{a: 1, b: [1, 2, 3]}, {a: 2, b: [4]}];
+ * const newItems = [{a: 1, b: [5]}, {a: 3, b: [6, 7]}];
+ *
+ * const items = mergeByIdentifier(
+ *   existingItems,
+ *   newItems,
+ *   (item) => item.a,
+ *   (existingItem, newItem) => {
+ *     return {
+ *       ...existingItem,
+ *       b: [...existingItem.b, ...newItem.b]
+ *     }
+ *   }
+ * );
+ *
+ * items == [{a: 1, b: [1, 2, 3, 5]}, {a: 2, b: [4]}, {a: 3, b: [6, 7]}];
+ */
+export declare const mergeByIdentifier: <T>(items: T[], newItems: T[], identify: (item: T, index: number) => string, merge: (item1: T, item2: T) => T) => T[];
 export {};

package/build/esm/utils/array.js

@@ -97,3 +97,41 @@ export const filterAndGetLastRemovedValue = (list, filter) => {
 };
 export const inferUnion = (array) => array;
 export const toArray = (valueOrArray) => (Array.isArray(valueOrArray) ? valueOrArray : [valueOrArray]);
+/**
+ * Merge together two arrays, if two items have the same identity based on the {@link identify} function
+ * they will be merged together using the {@link merge} function provided.
+ * @param items Array of items as a starting base.
+ * @param newItems Array of items to merge in.
+ * @param identify Function returning how to identify an item in the array
+ * @param merge Function given two matching item identifiers, returning a single merged result
+ * @example
+ * const existingItems = [{a: 1, b: [1, 2, 3]}, {a: 2, b: [4]}];
+ * const newItems = [{a: 1, b: [5]}, {a: 3, b: [6, 7]}];
+ *
+ * const items = mergeByIdentifier(
+ *   existingItems,
+ *   newItems,
+ *   (item) => item.a,
+ *   (existingItem, newItem) => {
+ *     return {
+ *       ...existingItem,
+ *       b: [...existingItem.b, ...newItem.b]
+ *     }
+ *   }
+ * );
+ *
+ * items == [{a: 1, b: [1, 2, 3, 5]}, {a: 2, b: [4]}, {a: 3, b: [6, 7]}];
+ */
+export const mergeByIdentifier = (items, newItems, identify, merge) => {
+    const newItemsMap = new Map(newItems.map((newItem, i) => [identify(newItem, i), newItem]));
+    const result = items.map((item, i) => {
+        const itemIdentity = identify(item, i);
+        const matchingNewItem = newItemsMap.get(itemIdentity);
+        if (matchingNewItem) {
+            newItemsMap.delete(itemIdentity);
+            return merge(item, matchingNewItem);
+        }
+        return item;
+    });
+    return result.concat(Array.from(newItemsMap.values()));
+};

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

@@ -4,3 +4,23 @@ export declare const addPrebuiltEntities: <A extends {
 }>(entities: A[], prebuiltEntities: Record<string, string[]>) => A[];
 export declare const getUniqueSamples: (input: string) => string[];
 export declare const getAllSamples: (inputs?: string[]) => string[];
+/**
+ * Return a tuple of synonyms, the first value being the first synonym, the next being the remaining synonyms
+ */
+export declare const getValueWithSynonyms: (input: string) => [string, string[]];
+/**
+ * Map through all slot annotations in the given string input.
+ * For each annotation, the callbackFn will be called with the slot's key and name, returning a key and name.
+ * @param input String with slot annotations.
+ * @param callbackFn Map function called with the key and name of the slot.
+ * @returns Input with mapped slot annotations
+ * @example const result = mapSlotAnnotations("Hello {{[slot].id}}", ({key, name}) => ({key: key + '2', slot: slot + '2'});
+ * result === "Hello {{[slot2].id2}}"
+ */
+export declare const mapSlotAnnotations: (input: string, callbackFn: (slot: {
+    key: string;
+    name: string;
+}) => {
+    key: string;
+    name: string;
+}) => string;

package/build/esm/utils/slot.js

@@ -1,4 +1,5 @@
 import _uniqBy from 'lodash/uniqBy';
+import { SLOT_REGEXP } from '../constants';
 export const addPrebuiltEntities = (entities, prebuiltEntities) => entities.map((entity) => {
     if (prebuiltEntities[entity.key]) {
         return Object.assign(Object.assign({}, entity), { inputs: [...entity.inputs, ...prebuiltEntities[entity.key]] });
@@ -8,3 +9,25 @@ export const addPrebuiltEntities = (entities, prebuiltEntities) => entities.map(
 export const getUniqueSamples = (input) => _uniqBy(input.split(','), (sample) => sample.toLowerCase());
 // spread all synonyms into string array ['car, automobile', 'plane, jet'] => ['car', 'automobile', 'plane', 'jet']
 export const getAllSamples = (inputs = []) => inputs.flatMap((input) => input.split(',')).filter((sample) => !!sample.trim());
+/**
+ * Return a tuple of synonyms, the first value being the first synonym, the next being the remaining synonyms
+ */
+export const getValueWithSynonyms = (input) => {
+    const [value, ...synonyms] = input.split(',').map((str) => str.trim());
+    return [value, synonyms];
+};
+/**
+ * Map through all slot annotations in the given string input.
+ * For each annotation, the callbackFn will be called with the slot's key and name, returning a key and name.
+ * @param input String with slot annotations.
+ * @param callbackFn Map function called with the key and name of the slot.
+ * @returns Input with mapped slot annotations
+ * @example const result = mapSlotAnnotations("Hello {{[slot].id}}", ({key, name}) => ({key: key + '2', slot: slot + '2'});
+ * result === "Hello {{[slot2].id2}}"
+ */
+export const mapSlotAnnotations = (input, callbackFn) => {
+    return input.replace(SLOT_REGEXP, (_, slotName, slotKey) => {
+        const { key, name } = callbackFn({ key: slotKey, name: slotName });
+        return `{{[${name}].${key}}}`;
+    });
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@voiceflow/common",
   "description": "Junk drawer of utility functions",
-  "version": "7.25.3",
+  "version": "7.26.0",
   "author": "Voiceflow",
   "bugs": {
     "url": "https://github.com/voiceflow/libs/issues"
@@ -64,10 +64,10 @@
     "build:esm": "ttsc --project ./tsconfig.build.json --module esnext --outDir ./build/esm",
     "clean": "rimraf build",
     "commit": "cz",
-    "lint": "eslint \"**/*.{js,ts}\"",
+    "lint": "eslint \"{src,tests}/**/*.{js,ts}\"",
     "lint:fix": "yarn lint --fix",
     "lint:quiet": "yarn lint --quiet",
-    "lint:report": "eslint-output --quiet \"**/*.{js,ts}\"",
+    "lint:report": "eslint-output --quiet \"{src,tests}/**/*.{js,ts}\"",
     "tdd": "yarn test --watch",
     "test": "yarn test:run",
     "test:dependencies": "depcheck",
@@ -76,5 +76,5 @@
     "test:single": "NODE_ENV=test ts-mocha --paths --config config/tests/mocharc.yml",
     "test:unit": "NODE_ENV=test nyc --report-dir=nyc_coverage_unit ts-mocha --paths --config config/tests/mocharc.yml 'tests/**/*.unit.ts'"
   },
-  "gitHead": "af1863006aa5748d2f373bff4a9aaa69b3a20333"
+  "gitHead": "2fba77e43ad98b87529f9d8d59ea983f60f14a50"
 }