@dereekb/util 0.0.1

package/src/lib/storage/storage.memory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.memory.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/storage/storage.memory.ts"],"names":[],"mappings":";;;AAGA,MAAa,qBAAqB;IAAlC;QAEU,YAAO,GAAG,CAAC,CAAC;QACZ,aAAQ,GAA8B,EAAE,CAAC;IA0CnD,CAAC;IAxCC,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,GAAG,CAAC,KAAa;;QACf,OAAO,MAAA,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,mCAAI,IAAI,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,GAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,CAAC,GAAW;;QACjB,OAAO,MAAA,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC;IACpC,CAAC;IAED,OAAO,CAAC,GAAW,EAAE,IAAmB;QACtC,IAAI,IAAI,IAAI,IAAI,EAAE;YAChB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;gBACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;aACjC;YAED,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;SACnC;IACH,CAAC;IAED,UAAU,CAAC,GAAW;QACpB,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;YACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAE,sBAAsB;YAClD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;SACjC;IACH,CAAC;IAED,KAAK;QACH,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;IACnB,CAAC;CAEF;AA7CD,sDA6CC;AAEY,QAAA,qBAAqB,GAAG,IAAI,qBAAqB,EAAE,CAAC"}

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

@@ -0,0 +1,32 @@
+import { Maybe } from '../value';
+import { StoredDataStorageKey } from './storage';
+/**
+ * Limited Class/Interface for storing string values synchronously.
+ */
+export declare abstract class SimpleStorageObject {
+    abstract getItem(key: StoredDataStorageKey): Maybe<string>;
+    abstract setItem(key: StoredDataStorageKey, item: Maybe<string>): void;
+    abstract removeItem(key: StoredDataStorageKey): void;
+}
+/**
+ * Synchronous Class/Interface for storing string values.
+ *
+ * Has the same interface as localStorage for the web.
+ */
+export declare abstract class StorageObject extends SimpleStorageObject {
+    abstract readonly length: number;
+    /**
+     * Returns the string key for the index.
+     *
+     * Returns null if no key available.
+     */
+    abstract key(index: number): string | null;
+}
+export declare abstract class FullStorageObject extends StorageObject {
+    abstract readonly isPersistant: boolean;
+    abstract readonly isAvailable: boolean;
+    abstract removeAll(): string[];
+}
+export declare class StorageObjectUtility {
+    static allKeysFromStorageObject(storageObject: StorageObject, prefix?: string): StoredDataStorageKey[];
+}

package/src/lib/storage/storage.object.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageObjectUtility = exports.FullStorageObject = exports.StorageObject = exports.SimpleStorageObject = void 0;
+const array_1 = require("../array");
+/**
+ * Limited Class/Interface for storing string values synchronously.
+ */
+class SimpleStorageObject {
+}
+exports.SimpleStorageObject = SimpleStorageObject;
+/**
+ * Synchronous Class/Interface for storing string values.
+ *
+ * Has the same interface as localStorage for the web.
+ */
+class StorageObject extends SimpleStorageObject {
+}
+exports.StorageObject = StorageObject;
+class FullStorageObject extends StorageObject {
+}
+exports.FullStorageObject = FullStorageObject;
+class StorageObjectUtility {
+    static allKeysFromStorageObject(storageObject, prefix) {
+        const length = storageObject.length;
+        let result;
+        if (length > 0) {
+            result = (0, array_1.range)({ start: 0, end: length }).map((x) => storageObject.key(x)).filter(array_1.filterMaybeValuesFn);
+            if (prefix) {
+                result = result.filter((x) => x.startsWith(prefix));
+            }
+        }
+        else {
+            result = [];
+        }
+        return result;
+    }
+}
+exports.StorageObjectUtility = StorageObjectUtility;
+//# sourceMappingURL=storage.object.js.map

package/src/lib/storage/storage.object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.object.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/storage/storage.object.ts"],"names":[],"mappings":";;;AACA,oCAAsD;AAGtD;;GAEG;AACH,MAAsB,mBAAmB;CAQxC;AARD,kDAQC;AAED;;;;GAIG;AACH,MAAsB,aAAc,SAAQ,mBAAmB;CAW9D;AAXD,sCAWC;AAED,MAAsB,iBAAkB,SAAQ,aAAa;CAQ5D;AARD,8CAQC;AAED,MAAa,oBAAoB;IAE/B,MAAM,CAAC,wBAAwB,CAAC,aAA4B,EAAE,MAAe;QAC3E,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC;QACpC,IAAI,MAA8B,CAAC;QAEnC,IAAI,MAAM,GAAG,CAAC,EAAE;YACd,MAAM,GAAG,IAAA,aAAK,EAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,2BAAmB,CAAC,CAAC;YAEvG,IAAI,MAAM,EAAE;gBACV,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;aACrD;SACF;aAAM;YACL,MAAM,GAAG,EAAE,CAAC;SACb;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CAEF;AAnBD,oDAmBC"}

package/src/lib/string.d.ts

@@ -0,0 +1,19 @@
+import { MapStringFn } from "./map";
+import { Maybe } from "./value";
+/**
+ * Represents a string that is made up of comma-separated values.
+ *
+ * I.E. 0,1,2
+ */
+export declare type CommaSeparatedString<T = any> = string;
+export declare function caseInsensitiveString(input: string): string;
+export declare function caseInsensitiveString(input: undefined): undefined;
+export declare function caseInsensitiveString(input: Maybe<string>): Maybe<string>;
+export declare function splitCommaSeparatedString(input: CommaSeparatedString<string>): string[];
+export declare function splitCommaSeparatedString<T = any>(input: CommaSeparatedString<T>, mapFn: MapStringFn<T>): T[];
+/**
+ * Adds a plus prefix to the input value and converts it to a string. If the value is negative or 0, no prefix is added.
+ *
+ * Undefined is returned if a null/undefined value is input.
+ */
+export declare function addPlusPrefixToNumber(value?: Maybe<number>, prefix?: string): string | undefined;

package/src/lib/string.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addPlusPrefixToNumber = exports.splitCommaSeparatedString = exports.caseInsensitiveString = void 0;
+function caseInsensitiveString(input) {
+    return input === null || input === void 0 ? void 0 : input.toLocaleLowerCase();
+}
+exports.caseInsensitiveString = caseInsensitiveString;
+function splitCommaSeparatedString(input, mapFn = (x) => x) {
+    const splits = input.split(',');
+    return splits.map(x => mapFn(x.trim()));
+}
+exports.splitCommaSeparatedString = splitCommaSeparatedString;
+/**
+ * Adds a plus prefix to the input value and converts it to a string. If the value is negative or 0, no prefix is added.
+ *
+ * Undefined is returned if a null/undefined value is input.
+ */
+function addPlusPrefixToNumber(value, prefix = '+') {
+    if (value != null) {
+        return (value > 0) ? `${prefix}${value}` : `${value}`;
+    }
+    else {
+        return undefined;
+    }
+}
+exports.addPlusPrefixToNumber = addPlusPrefixToNumber;
+//# sourceMappingURL=string.js.map

package/src/lib/string.js.map

@@ -0,0 +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;;;;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"}

package/src/lib/type.d.ts

@@ -0,0 +1,9 @@
+export declare type ClassType<T> = {
+    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.
+ */
+export declare type KeyValueTransformMap<T, V, K extends keyof T = keyof T> = {
+    [k in K]: V;
+};

package/src/lib/type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=type.js.map

package/src/lib/type.js.map

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

package/src/lib/value.d.ts

@@ -0,0 +1,43 @@
+/**
+ * A value that might exist, or be null/undefined instead.
+ */
+export declare type Maybe<T> = T | null | undefined;
+/**
+ * Returns true if the value is not null or undefined.
+ *
+ * @param value
+ * @returns
+ */
+export declare function hasNonNullValue<T>(value: Maybe<T>): value is T;
+export declare function hasNonNullValue(value: any): boolean;
+export declare function hasNonNullValue(value: true): true;
+export declare function hasNonNullValue(value: false): true;
+export declare function hasNonNullValue(value: number): true;
+export declare function hasNonNullValue(value: ''): true;
+export declare function hasNonNullValue(value: null): false;
+export declare function hasNonNullValue(value: undefined): false;
+/**
+ * Whether or not the input has any value.
+ *
+ * Will return false for:
+ * - empty arrays
+ * - empty strings
+ * - null/undefined values.
+ *
+ * NaN has undefined behavior.
+ */
+export declare function hasValueOrNotEmpty(value: any): boolean;
+export declare function hasValueOrNotEmpty(value: true): true;
+export declare function hasValueOrNotEmpty(value: false): true;
+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;
+/**
+ * Returns true if both the inputs are not null/undefined but the same value.
+ *
+ * @param a
+ * @param b
+ * @returns
+ */
+export declare function isSameNonNullValue<T>(a: Maybe<T>, b: Maybe<T>): a is T;

package/src/lib/value.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSameNonNullValue = 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;
+/**
+ * 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=value.js.map

package/src/lib/value.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"value.js","sourceRoot":"","sources":["../../../../../packages/util/src/lib/value.ts"],"names":[],"mappings":";;;AAuBA,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;;;;;;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/test/index.d.ts

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

package/src/test/index.js

@@ -0,0 +1,6 @@
+"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);
+//# sourceMappingURL=index.js.map

package/src/test/index.js.map

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

package/src/test/jest.d.ts

@@ -0,0 +1,80 @@
+/**
+ * A fixture instance that is generated new for each test run.
+ */
+export declare type JestTestFixtureInstance<I> = I;
+/**
+ * The test fixture is used as a singleton across tests used in a single context.
+ *
+ * This allows us to define tests while referencing the instance.
+ */
+export interface JestTestFixture<I> {
+    readonly instance: JestTestFixtureInstance<I>;
+}
+export declare type JestTestContextFixtureClearInstanceFunction = () => void;
+/**
+ * JestTestFixture with additional functions that the JestTestContextFactory sees for managing the instance.
+ */
+export interface JestTestContextFixture<I> extends JestTestFixture<I> {
+    /**
+     * Sets the instance before the tests run, and returns a function to clean the instance later.
+     *
+     * If called again before the instance is finished being used, this should thrown an exception.
+     *
+     * @param instance
+     */
+    setInstance(instance: I): JestTestContextFixtureClearInstanceFunction;
+}
+/**
+ * Abstract JestTestContextFixture instance.
+ */
+export declare abstract class AbstractJestTestContextFixture<I> implements JestTestContextFixture<I> {
+    private _instance?;
+    get instance(): I;
+    setInstance(instance: I): JestTestContextFixtureClearInstanceFunction;
+}
+export declare type JestBuildTestsWithContextFunction<F> = (fixture: F) => void;
+/**
+ * Used for Jest tests to execute a number of tests using the fixture.
+ *
+ * The fixture is automatically setup and torn down each test per the configuration with a clean fixture instance.
+ */
+export declare type JestTestContextFactory<F> = (buildTests: JestBuildTestsWithContextFunction<F>) => void;
+/**
+ * Used to configure a JestTestContextFactory for building tests.
+ */
+export declare type JestTestContextBuilderFunction<I, F extends JestTestContextFixture<I>, C> = (config?: Partial<C>) => JestTestContextFactory<F>;
+export interface JestTestContextBuilderConfig<I, F extends JestTestContextFixture<I>, C> {
+    /**
+     * Builds a config given the optional, partial input config. This is used across all tests.
+     */
+    buildConfig: (config?: Partial<C>) => C;
+    /**
+     * Builds a new fixture to use across all tests encapsulated tests.
+     */
+    buildFixture: (config: C) => F;
+    /**
+     * Arbitrary before each function, called before the instance is setup.
+     */
+    beforeEach?: () => Promise<void>;
+    /**
+     * Use for building an instance.
+     *
+     * When the promise resolves it should be ready to be used by the test being executed.
+     */
+    setupInstance: (config: C) => Promise<I>;
+    /**
+     * Use for cleaning up the instance before the next test.
+     */
+    teardownInstance: (instance: I, config: C) => Promise<void>;
+    /**
+     * Arbitrary after each function.
+     */
+    afterEach?: () => Promise<void>;
+}
+/**
+ * Creates a JestTestContextBuilderFunction given the input builder.
+ *
+ * @param builder
+ * @returns
+ */
+export declare function jestTestContextBuilder<I, F extends JestTestContextFixture<I>, C>(builder: JestTestContextBuilderConfig<I, F, C>): JestTestContextBuilderFunction<I, F, C>;

package/src/test/jest.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jestTestContextBuilder = 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;
+/**
+ * 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);
+            let instance;
+            let clearInstance;
+            // Before
+            if (builder.beforeEach != null) {
+                beforeEach(builder.beforeEach);
+            }
+            // Create an instance
+            beforeEach(() => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+                try {
+                    instance = yield builder.setupInstance(config);
+                    clearInstance = fixture.setInstance(instance);
+                }
+                catch (e) {
+                    console.error('Failed building a test instance due to an error in buildInstance(). Error: ', e);
+                    clearInstance();
+                    throw e;
+                }
+            }));
+            /**
+             * Build tests by passing the fixture to the testing functions.
+             *
+             * This will inject all tests and sub Jest lifecycle items.
+             */
+            buildTests(fixture);
+            // Cleanup
+            afterEach(() => (0, 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.');
+                }
+                try {
+                    yield builder.teardownInstance(instance, config);
+                    instance = undefined;
+                }
+                catch (e) {
+                    console.error('Failed due to error in destroyingInstance()');
+                    throw e;
+                }
+            }));
+            if (builder.afterEach != null) {
+                afterEach(builder.afterEach);
+            }
+        };
+    };
+}
+exports.jestTestContextBuilder = jestTestContextBuilder;
+//# sourceMappingURL=jest.js.map

package/src/test/jest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.js","sourceRoot":"","sources":["../../../../../packages/util/src/test/jest.ts"],"names":[],"mappings":";;;;AAgCA;;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;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;YAC7C,IAAI,QAAW,CAAC;YAChB,IAAI,aAA0D,CAAC;YAE/D,SAAS;YACT,IAAI,OAAO,CAAC,UAAU,IAAI,IAAI,EAAE;gBAC9B,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;aAChC;YAED,qBAAqB;YACrB,UAAU,CAAC,GAAS,EAAE;gBACpB,IAAI;oBACF,QAAQ,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;oBAC/C,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;iBAC/C;gBAAC,OAAO,CAAC,EAAE;oBACV,OAAO,CAAC,KAAK,CAAC,6EAA6E,EAAE,CAAC,CAAC,CAAC;oBAChG,aAAa,EAAE,CAAC;oBAChB,MAAM,CAAC,CAAC;iBACT;YACH,CAAC,CAAA,CAAC,CAAC;YAEH;;;;eAIG;YACH,UAAU,CAAC,OAAO,CAAC,CAAC;YAEpB,UAAU;YACV,SAAS,CAAC,GAAS,EAAE;gBACnB,aAAa,EAAE,CAAC;gBAEhB,IAAI,OAAO,CAAC,QAAQ,IAAI,IAAI,EAAE;oBAC5B,OAAO,CAAC,IAAI,CAAC,mFAAmF,CAAC,CAAC;iBACnG;gBAED,IAAI;oBACF,MAAM,OAAO,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBACjD,QAAQ,GAAG,SAAgB,CAAC;iBAC7B;gBAAC,OAAO,CAAC,EAAE;oBACV,OAAO,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;oBAC7D,MAAM,CAAC,CAAC;iBACT;YACH,CAAC,CAAA,CAAC,CAAC;YAEH,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE;gBAC7B,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;aAC9B;QACH,CAAC,CAAA;IACH,CAAC,CAAC;AACJ,CAAC;AAvDD,wDAuDC"}

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

@@ -0,0 +1,61 @@
+import { AbstractJestTestContextFixture, JestTestContextFactory } from "./jest";
+export declare abstract class AbstractWrappedFixture<F> {
+    readonly fixture: F;
+    constructor(fixture: F);
+}
+export declare abstract class AbstractWrappedFixtureWithInstance<I, F> extends AbstractJestTestContextFixture<I> {
+    readonly parent: F;
+    constructor(parent: F);
+}
+/**
+ * Used to wrap a JestTestContextFactory of one fixture type to another.
+ *
+ * This is useful for cases where the base fixture may be used in a lot of places and contexts, but the wrapped version can configure
+ * tests more specifically.
+ */
+export declare type JestTestWrappedContextFactoryBuilder<W, F> = (factory: JestTestContextFactory<F>) => JestTestContextFactory<W>;
+export interface JestWrapTestContextConfig<W, F, E = any> {
+    /**
+     * Wraps the fixture. This occurs once before any tests execute.
+     */
+    wrapFixture: (fixture: F) => W;
+    /**
+     * Use for doing any setup that may be required on a per-test basis.
+     *
+     * This occurs before every test, but after the fixture's instance has already been configured.
+     *
+     * The setup can return an effect. This effect is passed to the teardown function later, if provided.
+     */
+    setupWrap?: (wrap: W) => Promise<E>;
+    /**
+     * Use for cleaning up the instance before the next function.
+     *
+     * This occurs after every test, but after the fixture's instance has already been configured.
+     */
+    teardownWrap?: (wrap: W, effect: E) => Promise<void>;
+}
+/**
+ * Wraps the input JestTestContextFactory to emit another type of Fixture for tests.
+ *
+ * @returns
+ */
+export declare function wrapJestTestContextFactory<W, F, E = any>(config: JestWrapTestContextConfig<W, F, E>): (factory: JestTestContextFactory<F>) => JestTestContextFactory<W>;
+export interface InstanceJestWrapTestContextConfig<I, W extends AbstractWrappedFixtureWithInstance<I, F>, F> extends Pick<JestWrapTestContextConfig<W, F>, 'wrapFixture'> {
+    /**
+     * Creates a new instance for the tests.
+     */
+    makeInstance: (wrap: W) => I | Promise<I>;
+    /**
+     * Use for doing any setup that may be required on a per-test basis.
+     *
+     * This occurs before every test, but after the fixture's instance has already been configured.
+     */
+    setupInstance?: (instance: I, wrap: W) => void | Promise<void>;
+    /**
+     * Use for cleaning up the instance before the next function.
+     *
+     * This occurs after every test, but after the fixture's instance has already been configured.
+     */
+    teardownInstance?: (instance: I) => void | Promise<void>;
+}
+export declare function instanceWrapJestTestContextFactory<I, W extends AbstractWrappedFixtureWithInstance<I, F>, F>(config: InstanceJestWrapTestContextConfig<I, W, F>): (factory: JestTestContextFactory<F>) => JestTestContextFactory<W>;

package/src/test/jest.wrap.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceWrapJestTestContextFactory = exports.wrapJestTestContextFactory = exports.AbstractWrappedFixtureWithInstance = exports.AbstractWrappedFixture = void 0;
+const tslib_1 = require("tslib");
+const jest_1 = require("./jest");
+class AbstractWrappedFixture {
+    constructor(fixture) {
+        this.fixture = fixture;
+    }
+}
+exports.AbstractWrappedFixture = AbstractWrappedFixture;
+class AbstractWrappedFixtureWithInstance extends jest_1.AbstractJestTestContextFixture {
+    constructor(parent) {
+        super();
+        this.parent = parent;
+    }
+}
+exports.AbstractWrappedFixtureWithInstance = AbstractWrappedFixtureWithInstance;
+/**
+ * Wraps the input JestTestContextFactory to emit another type of Fixture for tests.
+ *
+ * @returns
+ */
+function wrapJestTestContextFactory(config) {
+    return (factory) => {
+        return (buildTests) => {
+            factory((inputFixture) => {
+                const wrap = config.wrapFixture(inputFixture);
+                let effect;
+                if (config.setupWrap != null) {
+                    beforeEach(() => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+                        effect = yield config.setupWrap(wrap);
+                    }));
+                }
+                buildTests(wrap);
+                if (config.teardownWrap != null) {
+                    afterEach(() => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+                        yield config.teardownWrap(wrap, effect);
+                    }));
+                }
+            });
+        };
+    };
+}
+exports.wrapJestTestContextFactory = wrapJestTestContextFactory;
+function instanceWrapJestTestContextFactory(config) {
+    return wrapJestTestContextFactory({
+        wrapFixture: config.wrapFixture,
+        setupWrap: (wrap) => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            const instance = yield config.makeInstance(wrap);
+            const effect = wrap.setInstance(instance);
+            if (config.setupInstance) {
+                yield config.setupInstance(instance, wrap);
+            }
+            return effect;
+        }),
+        teardownWrap: (wrap, deleteInstanceEffect) => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            deleteInstanceEffect();
+            if (config.teardownInstance) {
+                yield config.teardownInstance(wrap.instance);
+            }
+        })
+    });
+}
+exports.instanceWrapJestTestContextFactory = instanceWrapJestTestContextFactory;
+//# sourceMappingURL=jest.wrap.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"jest.wrap.js","sourceRoot":"","sources":["../../../../../packages/util/src/test/jest.wrap.ts"],"names":[],"mappings":";;;;AAAA,iCAAgK;AAEhK,MAAsB,sBAAsB;IAE1C,YAAqB,OAAU;QAAV,YAAO,GAAP,OAAO,CAAG;IAAI,CAAC;CAErC;AAJD,wDAIC;AAED,MAAsB,kCAAyC,SAAQ,qCAAiC;IAEtG,YAAqB,MAAS;QAC5B,KAAK,EAAE,CAAC;QADW,WAAM,GAAN,MAAM,CAAG;IAE9B,CAAC;CAEF;AAND,gFAMC;AAmCD;;;;GAIG;AACH,SAAgB,0BAA0B,CAAgB,MAA0C;IAClG,OAAO,CAAC,OAAkC,EAAE,EAAE;QAC5C,OAAO,CAAC,UAAgD,EAAE,EAAE;YAC1D,OAAO,CAAC,CAAC,YAAe,EAAE,EAAE;gBAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;gBAC9C,IAAI,MAAS,CAAC;gBAEd,IAAI,MAAM,CAAC,SAAS,IAAI,IAAI,EAAE;oBAC5B,UAAU,CAAC,GAAS,EAAE;wBACpB,MAAM,GAAG,MAAM,MAAM,CAAC,SAAU,CAAC,IAAI,CAAC,CAAC;oBACzC,CAAC,CAAA,CAAC,CAAC;iBACJ;gBAED,UAAU,CAAC,IAAI,CAAC,CAAC;gBAEjB,IAAI,MAAM,CAAC,YAAY,IAAI,IAAI,EAAE;oBAC/B,SAAS,CAAC,GAAS,EAAE;wBACnB,MAAM,MAAM,CAAC,YAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;oBAC3C,CAAC,CAAA,CAAC,CAAC;iBACJ;YAEH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;IACJ,CAAC,CAAA;AACH,CAAC;AAxBD,gEAwBC;AA0BD,SAAgB,kCAAkC,CAA2D,MAAkD;IAC7J,OAAO,0BAA0B,CAAoD;QACnF,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,SAAS,EAAE,CAAO,IAAO,EAAE,EAAE;YAC3B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACjD,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAE1C,IAAI,MAAM,CAAC,aAAa,EAAE;gBACxB,MAAM,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;aAC5C;YAED,OAAO,MAAM,CAAC;QAChB,CAAC,CAAA;QACD,YAAY,EAAE,CAAO,IAAO,EAAE,oBAAiE,EAAE,EAAE;YACjG,oBAAoB,EAAE,CAAC;YAEvB,IAAI,MAAM,CAAC,gBAAgB,EAAE;gBAC3B,MAAM,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC9C;QACH,CAAC,CAAA;KACF,CAAC,CAAC;AACL,CAAC;AArBD,gFAqBC"}