@dereekb/util 2.1.0 → 4.0.1

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.
  *
@@ -34,12 +42,33 @@ 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 null/undefined and not 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 isUndefinedAndNotFalse(value: any): boolean;
+export declare function isMaybeNotOrTrue(value: any): value is MaybeNot | true;
 /**
  * True if the input is not null/undefined/false.
  *
@@ -54,4 +83,4 @@ export declare function isDefinedAndNotFalse(value: any): boolean;
  * @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.js → value/maybe.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSameNonNullValue = exports.isDefinedAndNotFalse = exports.isUndefinedAndNotFalse = exports.hasValueOrNotEmpty = exports.hasNonNullValue = void 0;
+exports.isSameNonNullValue = exports.isDefinedAndNotFalse = exports.isMaybeNotOrTrue = exports.isMaybeSo = exports.isMaybeNot = exports.isMaybeNotAndNotFalse = exports.hasValueOrNotEmpty = exports.hasNonNullValue = void 0;
 function hasNonNullValue(value) {
     return value != null;
 }
@@ -15,15 +15,45 @@ function hasValueOrNotEmpty(value) {
 }
 exports.hasValueOrNotEmpty = hasValueOrNotEmpty;
 /**
- * True if the input is null/undefined and not false.
+ * True if the input is MaybeNot and not false.
  *
  * @param value
  * @returns
  */
-function isUndefinedAndNotFalse(value) {
+function isMaybeNotAndNotFalse(value) {
     return value == null && value !== false;
 }
-exports.isUndefinedAndNotFalse = isUndefinedAndNotFalse;
+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.
  *
@@ -45,4 +75,4 @@ function isSameNonNullValue(a, b) {
     return (a === b && a != null);
 }
 exports.isSameNonNullValue = isSameNonNullValue;
-//# sourceMappingURL=value.js.map
+//# 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/test/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+## [4.0.1](https://github.com/dereekb/dbx-components/compare/v4.0.0-dev...v4.0.1) (2022-05-14)
+
+
+
+# [4.0.0](https://github.com/dereekb/dbx-components/compare/v3.0.0...v4.0.0) (2022-05-14)

package/test/README.md

@@ -0,0 +1,11 @@
+# util-test
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test util-test` to execute the unit tests via [Jest](https://jestjs.io).
+
+## Running lint
+
+Run `nx lint util-test` to execute the lint via [ESLint](https://eslint.org/).

package/test/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@dereekb/util/test",
+  "version": "4.0.1",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "dependencies": {},
+  "peerDependencies": {
+    "@dereekb/util": "4.0.1",
+    "make-error": "^1.3.0",
+    "extra-set": "^2.2.11",
+    "change-case": "^4.1.2",
+    "tslib": "^2.0.0"
+  }
+}

package/test/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib';

package/test/src/index.js

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

package/test/src/index.js.map

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

package/{src/test → test/src/lib}/index.d.ts

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

package/test/src/lib/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+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/test/src/lib/index.js.map

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

package/{src/test → test/src/lib}/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/test/src/lib/jest.function.d.ts

@@ -0,0 +1,9 @@
+import { Getter } from "@dereekb/util";
+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/test/src/lib/jest.function.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useJestFunctionFixture = void 0;
+const util_1 = require("@dereekb/util");
+/**
+ * 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, util_1.forwardFunction)(fn);
+    buildTests(forward);
+}
+exports.useJestFunctionFixture = useJestFunctionFixture;
+//# sourceMappingURL=jest.function.js.map

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

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

package/test/src/lib/jest.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useJestContextFixture = exports.jestTestContextBuilder = exports.AbstractChildJestTestContextFixture = exports.AbstractJestTestContextFixture = void 0;
+const tslib_1 = require("tslib");
+/**
+ * Abstract JestTestContextFixture instance.
+ */
+class AbstractJestTestContextFixture {
+    get instance() {
+        return this._instance;
+    }
+    setInstance(instance) {
+        if (this._instance != null) {
+            throw new Error(`The testing fixture is locked. Don't call setInstance() directly.`);
+        }
+        this._instance = instance;
+        return () => {
+            delete this._instance;
+        };
+    }
+}
+exports.AbstractJestTestContextFixture = AbstractJestTestContextFixture;
+/**
+ * Abstract JestTestContextFixture instance with a parent.
+ */
+class AbstractChildJestTestContextFixture extends AbstractJestTestContextFixture {
+    constructor(parent) {
+        super();
+        this.parent = parent;
+    }
+}
+exports.AbstractChildJestTestContextFixture = AbstractChildJestTestContextFixture;
+/**
+ * Creates a JestTestContextBuilderFunction given the input builder.
+ *
+ * @param builder
+ * @returns
+ */
+function jestTestContextBuilder(builder) {
+    return (inputConfig) => {
+        const config = builder.buildConfig(inputConfig);
+        return (buildTests) => {
+            const fixture = builder.buildFixture(config);
+            // Before
+            if (builder.beforeEach != null) {
+                beforeEach(builder.beforeEach);
+            }
+            useJestContextFixture({
+                fixture,
+                /**
+                 * Build tests by passing the fixture to the testing functions.
+                 *
+                 * This will inject all tests and sub Jest lifecycle items.
+                 */
+                buildTests,
+                initInstance: () => builder.setupInstance(config),
+                destroyInstance: (instance) => builder.teardownInstance(instance, config)
+            });
+            // After
+            if (builder.afterEach != null) {
+                afterEach(builder.afterEach);
+            }
+        };
+    };
+}
+exports.jestTestContextBuilder = jestTestContextBuilder;
+/**
+ * Creates a test context and jest configurations that will initialize an instance
+ */
+function useJestContextFixture(config) {
+    const { buildTests, fixture, initInstance, destroyInstance } = config;
+    let clearInstance;
+    let instance;
+    // Create an instance
+    beforeEach(() => tslib_1.__awaiter(this, void 0, void 0, function* () {
+        try {
+            instance = yield initInstance();
+            clearInstance = fixture.setInstance(instance);
+        }
+        catch (e) {
+            console.error('Failed building a test instance due to an error in buildInstance(). Error: ', e);
+            if (clearInstance) {
+                clearInstance();
+            }
+            throw e;
+        }
+    }));
+    // Cleanup
+    afterEach(() => tslib_1.__awaiter(this, void 0, void 0, function* () {
+        clearInstance();
+        if (fixture.instance != null) {
+            console.warn('Expected instance to be set on fixture for cleanup but was set to something else.');
+        }
+        if (destroyInstance) {
+            try {
+                yield destroyInstance(instance);
+                instance = undefined;
+            }
+            catch (e) {
+                console.error('Failed due to error in destroyInstance()');
+                throw e;
+            }
+        }
+    }));
+    buildTests(fixture);
+}
+exports.useJestContextFixture = useJestContextFixture;
+//# sourceMappingURL=jest.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"jest.js","sourceRoot":"","sources":["../../../../../../packages/util/test/src/lib/jest.ts"],"names":[],"mappings":";;;;AAoCA;;GAEG;AACH,MAAsB,8BAA8B;IAIlD,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAU,CAAC;IACzB,CAAC;IAED,WAAW,CAAC,QAAW;QACrB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;SACtF;QAED,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,OAAO,GAAG,EAAE;YACV,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC,CAAC;IACJ,CAAC;CAEF;AApBD,wEAoBC;AAED;;GAEG;AACH,MAAsB,mCAA8E,SAAQ,8BAAiC;IAE3I,YAAqB,MAAS;QAC5B,KAAK,EAAE,CAAC;QADW,WAAM,GAAN,MAAM,CAAG;IAE9B,CAAC;CAEF;AAND,kFAMC;AAmDD;;;;;GAKG;AACH,SAAgB,sBAAsB,CAA4C,OAA8C;IAC9H,OAAO,CAAC,WAAwB,EAAE,EAAE;QAClC,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAEhD,OAAO,CAAC,UAAgD,EAAE,EAAE;YAC1D,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAE7C,SAAS;YACT,IAAI,OAAO,CAAC,UAAU,IAAI,IAAI,EAAE;gBAC9B,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;aAChC;YAED,qBAAqB,CAAC;gBACpB,OAAO;gBACP;;;;mBAIG;gBACH,UAAU;gBACV,YAAY,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC;gBACjD,eAAe,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC;aAC1E,CAAC,CAAC;YAEH,QAAQ;YACR,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE;gBAC7B,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;aAC9B;QACH,CAAC,CAAA;IACH,CAAC,CAAC;AACJ,CAAC;AA9BD,wDA8BC;AASD;;GAEG;AACH,SAAgB,qBAAqB,CAAyC,MAAmC;IAC/G,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;IAEtE,IAAI,aAA0D,CAAC;IAC/D,IAAI,QAAW,CAAC;IAEhB,qBAAqB;IACrB,UAAU,CAAC,GAAS,EAAE;QACpB,IAAI;YACF,QAAQ,GAAG,MAAM,YAAY,EAAE,CAAC;YAChC,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;SAC/C;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,6EAA6E,EAAE,CAAC,CAAC,CAAC;YAEhG,IAAI,aAAa,EAAE;gBACjB,aAAa,EAAE,CAAC;aACjB;YAED,MAAM,CAAC,CAAC;SACT;IACH,CAAC,CAAA,CAAC,CAAC;IAEH,UAAU;IACV,SAAS,CAAC,GAAS,EAAE;QACnB,aAAa,EAAE,CAAC;QAEhB,IAAI,OAAO,CAAC,QAAQ,IAAI,IAAI,EAAE;YAC5B,OAAO,CAAC,IAAI,CAAC,mFAAmF,CAAC,CAAC;SACnG;QAED,IAAI,eAAe,EAAE;YACnB,IAAI;gBACF,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAC;gBAChC,QAAQ,GAAG,SAAgB,CAAC;aAC7B;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;gBAC1D,MAAM,CAAC,CAAC;aACT;SACF;IACH,CAAC,CAAA,CAAC,CAAC;IAEH,UAAU,CAAC,OAAO,CAAC,CAAC;AACtB,CAAC;AA1CD,sDA0CC"}