@dereekb/util 1.2.0 → 3.0.0

package/src/lib/storage/storage.memory.d.ts

@@ -1,4 +1,4 @@
-import { Maybe } from "../value";
+import { Maybe } from '../value/maybe';
 import { StorageObject } from "./storage.object";
 export declare class MemoryStorageInstance implements StorageObject {
     private _length;

package/src/lib/storage/storage.object.d.ts

@@ -1,4 +1,4 @@
-import { Maybe } from '../value';
+import { Maybe } from '../value/maybe';
 import { StoredDataStorageKey } from './storage';
 /**
  * Limited Class/Interface for storing string values synchronously.

package/src/lib/string.d.ts

@@ -1,5 +1,5 @@
-import { MapStringFn } from "./map";
-import { Maybe } from "./value";
+import { MapStringFn } from "./map/map";
+import { Maybe } from "./value/maybe";
 /**
  * Represents a string that is made up of comma-separated values.
  *
@@ -18,3 +18,10 @@ export declare function splitCommaSeparatedStringToSet(input: Maybe<CommaSeparat
  * Undefined is returned if a null/undefined value is input.
  */
 export declare function addPlusPrefixToNumber(value?: Maybe<number>, prefix?: string): string | undefined;
+/**
+ * Capitalizes the first letter of the input.
+ *
+ * @param value
+ * @returns
+ */
+export declare function capitalizeFirstLetter(value: string): string;

package/src/lib/string.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addPlusPrefixToNumber = exports.splitCommaSeparatedStringToSet = exports.splitCommaSeparatedString = exports.caseInsensitiveString = void 0;
+exports.capitalizeFirstLetter = exports.addPlusPrefixToNumber = exports.splitCommaSeparatedStringToSet = exports.splitCommaSeparatedString = exports.caseInsensitiveString = void 0;
 function caseInsensitiveString(input) {
     return input === null || input === void 0 ? void 0 : input.toLocaleLowerCase();
 }
@@ -28,4 +28,14 @@ function addPlusPrefixToNumber(value, prefix = '+') {
     }
 }
 exports.addPlusPrefixToNumber = addPlusPrefixToNumber;
+/**
+ * Capitalizes the first letter of the input.
+ *
+ * @param value
+ * @returns
+ */
+function capitalizeFirstLetter(value) {
+    return value.charAt(0).toUpperCase() + value.slice(1);
+}
+exports.capitalizeFirstLetter = capitalizeFirstLetter;
 //# sourceMappingURL=string.js.map

package/src/lib/string.js.map

@@ -1 +1 @@
-{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../../../packages/util/src/lib/string.ts"],"names":[],"mappings":";;;AAaA,SAAgB,qBAAqB,CAAC,KAAU;IAC9C,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,EAAE,CAAC;AACpC,CAAC;AAFD,sDAEC;AAID,SAAgB,yBAAyB,CAAU,KAA8B,EAAE,QAAwB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAQ;IACxH,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAC1C,CAAC;AAHD,8DAGC;AAED,SAAgB,8BAA8B,CAAC,KAAkC;IAC/E,OAAO,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AACxE,CAAC;AAFD,wEAEC;AAED;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,KAAqB,EAAE,MAAM,GAAG,GAAG;IACvE,IAAI,KAAK,IAAI,IAAI,EAAE;QACjB,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC;KACvD;SAAM;QACL,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AAND,sDAMC"}
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../../../packages/util/src/lib/string.ts"],"names":[],"mappings":";;;AAcA,SAAgB,qBAAqB,CAAC,KAAU;IAC9C,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,EAAE,CAAC;AACpC,CAAC;AAFD,sDAEC;AAID,SAAgB,yBAAyB,CAAU,KAA8B,EAAE,QAAwB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAQ;IACxH,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAC1C,CAAC;AAHD,8DAGC;AAED,SAAgB,8BAA8B,CAAC,KAAkC;IAC/E,OAAO,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AACxE,CAAC;AAFD,wEAEC;AAED;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,KAAqB,EAAE,MAAM,GAAG,GAAG;IACvE,IAAI,KAAK,IAAI,IAAI,EAAE;QACjB,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC;KACvD;SAAM;QACL,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AAND,sDAMC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,KAAa;IACjD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACxD,CAAC;AAFD,sDAEC"}

package/src/lib/tree/index.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./tree"), exports);
-(0, tslib_1.__exportStar)(require("./tree.expand"), exports);
-(0, tslib_1.__exportStar)(require("./tree.flatten"), exports);
-(0, tslib_1.__exportStar)(require("./tree.array"), exports);
+tslib_1.__exportStar(require("./tree"), exports);
+tslib_1.__exportStar(require("./tree.expand"), exports);
+tslib_1.__exportStar(require("./tree.flatten"), exports);
+tslib_1.__exportStar(require("./tree.array"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/tree/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/tree/index.ts"],"names":[],"mappings":";;;AAAA,sDAAuB;AACvB,6DAA8B;AAC9B,8DAA+B;AAC/B,4DAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/tree/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB;AACvB,wDAA8B;AAC9B,yDAA+B;AAC/B,uDAA6B"}

package/src/lib/tree/tree.expand.d.ts

@@ -1,5 +1,5 @@
 import { TreeNode, TreeNodeWithoutChildren } from "./tree";
-import { Maybe } from "../value";
+import { Maybe } from "../value/maybe";
 /**
  * ExpandTreeFunction configuration.
  */

package/src/lib/type.d.ts

@@ -1,6 +1,13 @@
-export declare type ClassType<T> = {
+/**
+ * Class typing, restricted to types that have a constructor via the new keyword.
+ */
+export declare type ClassType<T = any> = {
     new (...args: any[]): T;
 };
+/**
+ * Similar to ClassType, but allows for abstract classes.
+ */
+export declare type ClassLikeType<T = any> = abstract new (...args: any[]) => T;
 /**
  * Special type used to defined other type definitions that state the defined type has every key of one type, but each key has a single/new value type.
  */
@@ -8,3 +15,12 @@ export declare type KeyValueTransformMap<T, V, K extends keyof T = keyof T> = {
     [k in K]: V;
 };
 export declare type BooleanKeyValueTransformMap<T> = KeyValueTransformMap<T, boolean>;
+export declare type RemoveIndex<T> = {
+    [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K];
+};
+/**
+ * Custom typing used to only retain known keys on types that have a [key: string] in their type.
+ *
+ * https://stackoverflow.com/questions/51954558/how-can-i-remove-a-wider-type-from-a-union-type-without-removing-its-subtypes-in/51955852#51955852
+ */
+export declare type KnownKeys<T> = keyof RemoveIndex<T>;

package/src/lib/value/equal.d.ts

@@ -0,0 +1,41 @@
+import { IterableOrValue } from './../iterable/iterable';
+/**
+ * Function used for equivalence comparisons on an object.
+ */
+export declare type IsEqualFunction<T = any> = (a: T, b: T) => boolean;
+/**
+ * Used to check if the input object is considered equal to the current context.
+ */
+export declare type IsEqualContext<T = any> = (x: T) => boolean;
+/**
+ * Similar to IsEqualContext, but supports an array of objects.
+ *
+ * Used to check if the input object or array of objects are considered equal to the current context.
+ */
+export declare type AreEqualContext<T = any> = (x: IterableOrValue<T>) => boolean;
+/**
+ * Creates an IsEqualContext
+ *
+ * @param contextValue
+ * @param fn
+ * @returns
+ */
+export declare function isEqualContext<T>(contextValue: T, fn: IsEqualFunction<T>): IsEqualContext<T>;
+/**
+ * Creates an AreEqualContext
+ *
+ * @param contextValue
+ * @param fn
+ * @returns
+ */
+export declare function areEqualContext<T>(contextValue: T, fn: IsEqualFunction<T>): AreEqualContext<T>;
+/**
+ * Returns true if all input values are equal.
+ *
+ * Arrays that are empty or have one value will return true by default.
+ *
+ * @param values
+ * @param fn
+ * @returns
+ */
+export declare function allObjectsAreEqual<T>(values: IterableOrValue<T>, fn: IsEqualFunction<T>): boolean;

package/src/lib/value/equal.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.allObjectsAreEqual = exports.areEqualContext = exports.isEqualContext = void 0;
+const iterable_1 = require("./../iterable/iterable");
+/**
+ * Creates an IsEqualContext
+ *
+ * @param contextValue
+ * @param fn
+ * @returns
+ */
+function isEqualContext(contextValue, fn) {
+    return (value) => {
+        return fn(contextValue, value);
+    };
+}
+exports.isEqualContext = isEqualContext;
+/**
+ * Creates an AreEqualContext
+ *
+ * @param contextValue
+ * @param fn
+ * @returns
+ */
+function areEqualContext(contextValue, fn) {
+    const isEqual = isEqualContext(contextValue, fn);
+    return (input) => {
+        let areEqual = false;
+        if ((0, iterable_1.isIterable)(input)) {
+            areEqual = !(0, iterable_1.existsInIterable)(input, (x) => !isEqual(x));
+        }
+        else {
+            areEqual = isEqual(input);
+        }
+        return areEqual;
+    };
+}
+exports.areEqualContext = areEqualContext;
+/**
+ * Returns true if all input values are equal.
+ *
+ * Arrays that are empty or have one value will return true by default.
+ *
+ * @param values
+ * @param fn
+ * @returns
+ */
+function allObjectsAreEqual(values, fn) {
+    if ((0, iterable_1.isIterable)(values)) {
+        const firstValues = (0, iterable_1.takeValuesFromIterable)(values, 2);
+        return (firstValues.length > 1) ? areEqualContext(firstValues[0], fn)(values) : true;
+    }
+    return true;
+}
+exports.allObjectsAreEqual = allObjectsAreEqual;
+//# sourceMappingURL=equal.js.map

package/src/lib/value/equal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"equal.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/equal.ts"],"names":[],"mappings":";;;AAAA,qDAAuJ;AAmBvJ;;;;;;GAMG;AACH,SAAgB,cAAc,CAAI,YAAe,EAAE,EAAsB;IACvE,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,OAAO,EAAE,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC;AACJ,CAAC;AAJD,wCAIC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAAI,YAAe,EAAE,EAAsB;IACxE,MAAM,OAAO,GAAG,cAAc,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAEjD,OAAO,CAAC,KAAyB,EAAE,EAAE;QACnC,IAAI,QAAQ,GAAG,KAAK,CAAC;QAErB,IAAI,IAAA,qBAAU,EAAC,KAAK,CAAC,EAAE;YACrB,QAAQ,GAAG,CAAC,IAAA,2BAAgB,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;SACzD;aAAM;YACL,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;SAC3B;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;AACJ,CAAC;AAdD,0CAcC;AAED;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAAI,MAA0B,EAAE,EAAsB;IACtF,IAAI,IAAA,qBAAU,EAAC,MAAM,CAAC,EAAE;QACtB,MAAM,WAAW,GAAG,IAAA,iCAAsB,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACtD,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;KACtF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAPD,gDAOC"}

package/src/lib/value/index.d.ts

@@ -0,0 +1,4 @@
+export * from './equal';
+export * from './map';
+export * from './maybe';
+export * from './modifier';

package/src/lib/value/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./equal"), exports);
+tslib_1.__exportStar(require("./map"), exports);
+tslib_1.__exportStar(require("./maybe"), exports);
+tslib_1.__exportStar(require("./modifier"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/value/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,gDAAsB;AACtB,kDAAwB;AACxB,qDAA2B"}

package/src/lib/value/map.d.ts

@@ -0,0 +1,13 @@
+import { Maybe } from "./maybe";
+/**
+ * Converts one value to another.
+ */
+export declare type MapFunction<I, O> = (input: I) => O;
+/**
+ * Converts values from the input, and applies them to the target if a target is supplied.
+ */
+export declare type ApplyMapFunction<I, O> = (input: I, target?: Maybe<Partial<O>>) => O;
+/**
+ * Converts values from the input, and applies them to the target if a target is supplied.
+ */
+export declare type ApplyMapFunctionWithOptions<I, O, C> = (input: I, target?: Maybe<Partial<O>>, options?: Maybe<C>) => O;

package/src/lib/value/map.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"map.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/map.ts"],"names":[],"mappings":""}

package/src/lib/{value.d.ts → value/maybe.d.ts}

@@ -1,7 +1,15 @@
+/**
+ * A null/undefined value.
+ */
+export declare type MaybeNot = null | undefined;
+/**
+ * A non-null/undefined value.
+ */
+export declare type MaybeSo<T = any> = T extends MaybeNot ? never : T;
 /**
  * A value that might exist, or be null/undefined instead.
  */
-export declare type Maybe<T> = T | null | undefined;
+export declare type Maybe<T> = T | MaybeNot;
 /**
  * Returns true if the value is not null or undefined.
  *
@@ -33,6 +41,41 @@ export declare function hasValueOrNotEmpty(value: number): true;
 export declare function hasValueOrNotEmpty(value: ''): false;
 export declare function hasValueOrNotEmpty(value: null): false;
 export declare function hasValueOrNotEmpty(value: undefined): false;
+/**
+ * True if the input is MaybeNot and not false.
+ *
+ * @param value
+ * @returns
+ */
+export declare function isMaybeNotAndNotFalse(value: any): boolean;
+/**
+ * True if the input is MaybeNot.
+ *
+ * @param value
+ * @returns
+ */
+export declare function isMaybeNot(value: any): value is MaybeNot;
+/**
+ * True if the input is MaybeSo
+ *
+ * @param value
+ * @returns
+ */
+export declare function isMaybeSo<T>(value: Maybe<T>): value is MaybeSo<T>;
+/**
+ * True if the input is MaybeNot and true.
+ *
+ * @param value
+ * @returns
+ */
+export declare function isMaybeNotOrTrue(value: any): value is MaybeNot | true;
+/**
+ * True if the input is not null/undefined/false.
+ *
+ * @param value
+ * @returns
+ */
+export declare function isDefinedAndNotFalse(value: any): boolean;
 /**
  * Returns true if both the inputs are not null/undefined but the same value.
  *
@@ -40,4 +83,4 @@ export declare function hasValueOrNotEmpty(value: undefined): false;
  * @param b
  * @returns
  */
-export declare function isSameNonNullValue<T>(a: Maybe<T>, b: Maybe<T>): a is T;
+export declare function isSameNonNullValue<T>(a: Maybe<T>, b: Maybe<T>): a is NonNullable<T>;

package/src/lib/value/maybe.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSameNonNullValue = exports.isDefinedAndNotFalse = exports.isMaybeNotOrTrue = exports.isMaybeSo = exports.isMaybeNot = exports.isMaybeNotAndNotFalse = exports.hasValueOrNotEmpty = exports.hasNonNullValue = void 0;
+function hasNonNullValue(value) {
+    return value != null;
+}
+exports.hasNonNullValue = hasNonNullValue;
+function hasValueOrNotEmpty(value) {
+    if (Array.isArray(value)) {
+        return value.length > 0;
+    }
+    else {
+        return value != null && value !== '';
+    }
+}
+exports.hasValueOrNotEmpty = hasValueOrNotEmpty;
+/**
+ * True if the input is MaybeNot and not false.
+ *
+ * @param value
+ * @returns
+ */
+function isMaybeNotAndNotFalse(value) {
+    return value == null && value !== false;
+}
+exports.isMaybeNotAndNotFalse = isMaybeNotAndNotFalse;
+/**
+ * True if the input is MaybeNot.
+ *
+ * @param value
+ * @returns
+ */
+function isMaybeNot(value) {
+    return value == null;
+}
+exports.isMaybeNot = isMaybeNot;
+/**
+ * True if the input is MaybeSo
+ *
+ * @param value
+ * @returns
+ */
+function isMaybeSo(value) {
+    return !isMaybeNot(value);
+}
+exports.isMaybeSo = isMaybeSo;
+/**
+ * True if the input is MaybeNot and true.
+ *
+ * @param value
+ * @returns
+ */
+function isMaybeNotOrTrue(value) {
+    return value == null || value === true;
+}
+exports.isMaybeNotOrTrue = isMaybeNotOrTrue;
+/**
+ * True if the input is not null/undefined/false.
+ *
+ * @param value
+ * @returns
+ */
+function isDefinedAndNotFalse(value) {
+    return value != null && value !== false;
+}
+exports.isDefinedAndNotFalse = isDefinedAndNotFalse;
+/**
+ * Returns true if both the inputs are not null/undefined but the same value.
+ *
+ * @param a
+ * @param b
+ * @returns
+ */
+function isSameNonNullValue(a, b) {
+    return (a === b && a != null);
+}
+exports.isSameNonNullValue = isSameNonNullValue;
+//# sourceMappingURL=maybe.js.map

package/src/lib/value/maybe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maybe.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/maybe.ts"],"names":[],"mappings":";;;AA8BA,SAAgB,eAAe,CAAI,KAAe;IAChD,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC;AAFD,0CAEC;AAmBD,SAAgB,kBAAkB,CAAC,KAAU;IAC3C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;KACzB;SAAM;QACL,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;KACtC;AACH,CAAC;AAND,gDAMC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,KAAU;IAC9C,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,KAAK,CAAC;AAC1C,CAAC;AAFD,sDAEC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,KAAU;IACnC,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC;AAFD,gCAEC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CAAI,KAAe;IAC1C,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC;AAFD,8BAEC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,KAAU;IACzC,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,IAAI,CAAC;AACzC,CAAC;AAFD,4CAEC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,KAAU;IAC7C,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,KAAK,CAAC;AAC1C,CAAC;AAFD,oDAEC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAI,CAAW,EAAE,CAAW;IAC5D,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;AAChC,CAAC;AAFD,gDAEC"}

package/src/lib/value/modifier.d.ts

@@ -0,0 +1,58 @@
+import { ArrayOrValue } from "../array";
+import { Maybe } from "./maybe";
+/**
+ * Modifier key
+ */
+export declare type ModifierKey = string;
+/**
+ * Modifies the input value.
+ */
+export declare type ModifierFunction<T> = (input: T) => void;
+/**
+ * A modifier that has a key and modify function.
+ */
+export interface Modifier<T> {
+    /**
+     * Modifier key.
+     */
+    readonly key: ModifierKey;
+    /**
+     *
+     */
+    readonly modify: ModifierFunction<T>;
+}
+/**
+ * Creates a new modifier
+ *
+ * @param key
+ * @param modify
+ * @returns
+ */
+export declare function modifier<T>(key: string, modify: ModifierFunction<T>): Modifier<T>;
+/**
+ * Map of Modifiers keyed by the modifier key.
+ */
+export declare type ModifierMap<T> = Map<ModifierKey, Modifier<T>>;
+/**
+ * Adds a modifier to the modifier map and returns the map.
+ *
+ * @param modifier
+ * @param map
+ * @returns
+ */
+export declare function addModifiers<T>(modifiers: ArrayOrValue<Modifier<T>>, map?: Maybe<ModifierMap<T>>): ModifierMap<T>;
+/**
+ * Removes a modifier from the modifier map and returns the map.
+ *
+ * @param modifier
+ * @param map
+ */
+export declare function removeModifiers<T>(modifiers: ArrayOrValue<Modifier<T>>, map: Maybe<ModifierMap<T>>): ModifierMap<T>;
+export declare function modifierMapToFunction<T>(map: Maybe<ModifierMap<T>>): ModifierFunction<T>;
+/**
+ * Converts a ModifierMap to a ModifierFunction if the map is input or has functions. Otherwise returns undefined.
+ *
+ * @param map
+ * @returns
+ */
+export declare function maybeModifierMapToFunction<T>(map: Maybe<ModifierMap<T>>): Maybe<ModifierFunction<T>>;

package/src/lib/value/modifier.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.maybeModifierMapToFunction = exports.modifierMapToFunction = exports.removeModifiers = exports.addModifiers = exports.modifier = void 0;
+const array_1 = require("../array");
+/**
+ * Creates a new modifier
+ *
+ * @param key
+ * @param modify
+ * @returns
+ */
+function modifier(key, modify) {
+    return {
+        key,
+        modify
+    };
+}
+exports.modifier = modifier;
+/**
+ * Adds a modifier to the modifier map and returns the map.
+ *
+ * @param modifier
+ * @param map
+ * @returns
+ */
+function addModifiers(modifiers, map) {
+    if (!map) {
+        map = new Map();
+    }
+    (0, array_1.forEachWithArray)(modifiers, (modifier) => map.set(modifier.key, modifier));
+    return map;
+}
+exports.addModifiers = addModifiers;
+/**
+ * Removes a modifier from the modifier map and returns the map.
+ *
+ * @param modifier
+ * @param map
+ */
+function removeModifiers(modifiers, map) {
+    if (map) {
+        (0, array_1.forEachWithArray)(modifiers, (modifier) => map.delete(modifier.key));
+    }
+    else {
+        map = new Map();
+    }
+    return map;
+}
+exports.removeModifiers = removeModifiers;
+function modifierMapToFunction(map) {
+    var _a;
+    return (_a = maybeModifierMapToFunction(map)) !== null && _a !== void 0 ? _a : (() => undefined);
+}
+exports.modifierMapToFunction = modifierMapToFunction;
+/**
+ * Converts a ModifierMap to a ModifierFunction if the map is input or has functions. Otherwise returns undefined.
+ *
+ * @param map
+ * @returns
+ */
+function maybeModifierMapToFunction(map) {
+    const fns = [];
+    map === null || map === void 0 ? void 0 : map.forEach((x) => fns.push(x.modify));
+    return (input) => {
+        fns.forEach((fn) => fn(input));
+    };
+}
+exports.maybeModifierMapToFunction = maybeModifierMapToFunction;
+//# sourceMappingURL=modifier.js.map

package/src/lib/value/modifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modifier.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/modifier.ts"],"names":[],"mappings":";;;AAAA,oCAA0D;AA8B1D;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAI,GAAW,EAAE,MAA2B;IAClE,OAAO;QACL,GAAG;QACH,MAAM;KACP,CAAC;AACJ,CAAC;AALD,4BAKC;AAOD;;;;;;GAMG;AACH,SAAgB,YAAY,CAAI,SAAoC,EAAE,GAA2B;IAC/F,IAAI,CAAC,GAAG,EAAE;QACR,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;KACjB;IAED,IAAA,wBAAgB,EAAC,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,GAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE5E,OAAO,GAAG,CAAC;AACb,CAAC;AARD,oCAQC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAI,SAAoC,EAAE,GAA0B;IACjG,IAAI,GAAG,EAAE;QACP,IAAA,wBAAgB,EAAC,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,GAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;KACtE;SAAM;QACL,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;KACjB;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AARD,0CAQC;AAGD,SAAgB,qBAAqB,CAAI,GAA0B;;IACjE,OAAO,MAAA,0BAA0B,CAAC,GAAG,CAAC,mCAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;AAC9D,CAAC;AAFD,sDAEC;AAGD;;;;;GAKG;AACH,SAAgB,0BAA0B,CAAI,GAA0B;IACtE,MAAM,GAAG,GAA0B,EAAE,CAAC;IACtC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IACxC,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC;AACJ,CAAC;AAND,gEAMC"}

package/src/test/index.d.ts

@@ -1,2 +1,3 @@
 export * from './jest';
 export * from './jest.wrap';
+export * from './jest.function';

package/src/test/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./jest"), exports);
-(0, tslib_1.__exportStar)(require("./jest.wrap"), exports);
+tslib_1.__exportStar(require("./jest"), exports);
+tslib_1.__exportStar(require("./jest.wrap"), exports);
+tslib_1.__exportStar(require("./jest.function"), exports);
 //# sourceMappingURL=index.js.map

package/src/test/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/util/src/test/index.ts"],"names":[],"mappings":";;;AAAA,sDAAuB;AACvB,2DAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/util/src/test/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB;AACvB,sDAA4B;AAC5B,0DAAgC"}

package/src/test/jest.d.ts

@@ -1,3 +1,4 @@
+import { PromiseOrValue } from '@dereekb/util';
 /**
  * A fixture instance that is generated new for each test run.
  */
@@ -13,6 +14,8 @@ export interface JestTestFixture<I> {
 export declare type JestTestContextFixtureClearInstanceFunction = () => void;
 /**
  * JestTestFixture with additional functions that the JestTestContextFactory sees for managing the instance.
+ *
+ * The fixture is used as a refernce point for the Instance that is changed between each test.
  */
 export interface JestTestContextFixture<I> extends JestTestFixture<I> {
     /**
@@ -32,6 +35,13 @@ export declare abstract class AbstractJestTestContextFixture<I> implements JestT
     get instance(): I;
     setInstance(instance: I): JestTestContextFixtureClearInstanceFunction;
 }
+/**
+ * Abstract JestTestContextFixture instance with a parent.
+ */
+export declare abstract class AbstractChildJestTestContextFixture<I, P extends JestTestContextFixture<any>> extends AbstractJestTestContextFixture<I> {
+    readonly parent: P;
+    constructor(parent: P);
+}
 export declare type JestBuildTestsWithContextFunction<F> = (fixture: F) => void;
 /**
  * Used for Jest tests to execute a number of tests using the fixture.
@@ -49,7 +59,7 @@ export interface JestTestContextBuilderConfig<I, F extends JestTestContextFixtur
      */
     buildConfig: (config?: Partial<C>) => C;
     /**
-     * Builds a new fixture to use across all tests encapsulated tests.
+     * Builds a new fixture to use across all encapsulated tests.
      */
     buildFixture: (config: C) => F;
     /**
@@ -78,3 +88,13 @@ export interface JestTestContextBuilderConfig<I, F extends JestTestContextFixtur
  * @returns
  */
 export declare function jestTestContextBuilder<I, F extends JestTestContextFixture<I>, C>(builder: JestTestContextBuilderConfig<I, F, C>): JestTestContextBuilderFunction<I, F, C>;
+export interface UseJestContextFixture<C extends JestTestContextFixture<I>, I> {
+    readonly fixture: C;
+    readonly buildTests: JestBuildTestsWithContextFunction<C>;
+    initInstance(): PromiseOrValue<I>;
+    destroyInstance?(instance: I): PromiseOrValue<void>;
+}
+/**
+ * Creates a test context and jest configurations that will initialize an instance
+ */
+export declare function useJestContextFixture<C extends JestTestContextFixture<I>, I>(config: UseJestContextFixture<C, I>): void;

package/src/test/jest.function.d.ts

@@ -0,0 +1,9 @@
+import { Getter } from "../lib/getter/getter";
+export interface UseJestFunctionFixture<I extends (...args: any[]) => O, O = any> {
+    fn: Getter<I>;
+}
+export declare type JestFunctionFixtureBuildTests<I> = (fn: I) => void;
+/**
+ * Creates a test context and jest configurations that provides a function to build tests based on the configuration.
+ */
+export declare function useJestFunctionFixture<I extends (...args: any[]) => O, O = any>(config: UseJestFunctionFixture<I, O>, buildTests: JestFunctionFixtureBuildTests<I>): void;

package/src/test/jest.function.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useJestFunctionFixture = void 0;
+const function_forward_1 = require("../lib/function/function.forward");
+/**
+ * Creates a test context and jest configurations that provides a function to build tests based on the configuration.
+ */
+function useJestFunctionFixture(config, buildTests) {
+    const { fn } = config;
+    const forward = (0, function_forward_1.forwardFunction)(fn);
+    buildTests(forward);
+}
+exports.useJestFunctionFixture = useJestFunctionFixture;
+//# sourceMappingURL=jest.function.js.map

package/src/test/jest.function.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.function.js","sourceRoot":"","sources":["../../../../../packages/util/src/test/jest.function.ts"],"names":[],"mappings":";;;AAAA,uEAAmE;AASnE;;GAEG;AACH,SAAgB,sBAAsB,CAA2C,MAAoC,EAAE,UAA4C;IACjK,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;IAEtB,MAAM,OAAO,GAAG,IAAA,kCAAe,EAAC,EAAE,CAAC,CAAC;IACpC,UAAU,CAAC,OAAO,CAAC,CAAC;AACtB,CAAC;AALD,wDAKC"}