softkave-node-utils 0.1.0

package/build/src/mongodb/constants.d.ts

@@ -0,0 +1,4 @@
+declare const kMongoConstants: {
+    indexNotUniqueErrorCode: number;
+};
+export default kMongoConstants;

package/build/src/mongodb/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const kMongoConstants = {
+    indexNotUniqueErrorCode: 11000,
+};
+exports.default = kMongoConstants;
+//# sourceMappingURL=constants.js.map

package/build/src/mongodb/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/mongodb/constants.ts"],"names":[],"mappings":";;AAAA,MAAM,eAAe,GAAG;IACtB,uBAAuB,EAAE,KAAK;CAC/B,CAAC;AAEF,kBAAe,eAAe,CAAC"}

package/build/src/mongodb/utils.d.ts

@@ -0,0 +1,20 @@
+import { SchemaDefinitionProperty } from 'mongoose';
+import { Agent } from '../definitions/agent';
+export declare function ensureMongoTypeFields<T extends object>(schema: {
+    [path in keyof Required<T>]: SchemaDefinitionProperty<T[path]>;
+}): { [path in keyof Required<T>]: SchemaDefinitionProperty<T[path]>; };
+export declare const agentSchema: {
+    agentId: SchemaDefinitionProperty<string>;
+    agentType: SchemaDefinitionProperty<string>;
+    agentTokenId: SchemaDefinitionProperty<string>;
+};
+export declare const resourceSchema: {
+    resourceId: SchemaDefinitionProperty<string>;
+    createdAt: SchemaDefinitionProperty<number>;
+    lastUpdatedAt: SchemaDefinitionProperty<number>;
+    lastUpdatedBy: SchemaDefinitionProperty<Agent | undefined>;
+    createdBy: SchemaDefinitionProperty<Agent | undefined>;
+    deletedBy: SchemaDefinitionProperty<Agent | undefined>;
+    isDeleted: SchemaDefinitionProperty<boolean>;
+    deletedAt: SchemaDefinitionProperty<number | undefined>;
+};

package/build/src/mongodb/utils.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resourceSchema = exports.agentSchema = exports.ensureMongoTypeFields = void 0;
+// ensures all the fields defined in the type are added to the schema
+// TODO: do deep check to make sure that internal schemas are checked too
+// eslint-disable-next-line @typescript-eslint/ban-types
+function ensureMongoTypeFields(schema) {
+    return schema;
+}
+exports.ensureMongoTypeFields = ensureMongoTypeFields;
+exports.agentSchema = ensureMongoTypeFields({
+    agentId: { type: String },
+    agentType: { type: String },
+    agentTokenId: { type: String },
+});
+exports.resourceSchema = ensureMongoTypeFields({
+    resourceId: { type: String, unique: true, index: true },
+    createdAt: { type: Number, default: () => Date.now() },
+    lastUpdatedAt: { type: Number, default: () => Date.now() },
+    createdBy: { type: exports.agentSchema },
+    lastUpdatedBy: { type: exports.agentSchema },
+    isDeleted: { type: Boolean, index: true },
+    deletedBy: { type: exports.agentSchema },
+    deletedAt: { type: Number },
+});
+//# sourceMappingURL=utils.js.map

package/build/src/mongodb/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/mongodb/utils.ts"],"names":[],"mappings":";;;AAIA,qEAAqE;AACrE,yEAAyE;AACzE,wDAAwD;AACxD,SAAgB,qBAAqB,CAAmB,MAEvD;IACC,OAAO,MAAM,CAAC;AAChB,CAAC;AAJD,sDAIC;AAEY,QAAA,WAAW,GAAG,qBAAqB,CAAQ;IACtD,OAAO,EAAE,EAAC,IAAI,EAAE,MAAM,EAAC;IACvB,SAAS,EAAE,EAAC,IAAI,EAAE,MAAM,EAAC;IACzB,YAAY,EAAE,EAAC,IAAI,EAAE,MAAM,EAAC;CAC7B,CAAC,CAAC;AAEU,QAAA,cAAc,GAAG,qBAAqB,CAAW;IAC5D,UAAU,EAAE,EAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAC;IACrD,SAAS,EAAE,EAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAC;IACpD,aAAa,EAAE,EAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAC;IACxD,SAAS,EAAE,EAAC,IAAI,EAAE,mBAAW,EAAC;IAC9B,aAAa,EAAE,EAAC,IAAI,EAAE,mBAAW,EAAC;IAClC,SAAS,EAAE,EAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAC;IACvC,SAAS,EAAE,EAAC,IAAI,EAAE,mBAAW,EAAC;IAC9B,SAAS,EAAE,EAAC,IAAI,EAAE,MAAM,EAAC;CAC1B,CAAC,CAAC"}

package/build/src/testUtils/context/email/MockTestEmailProviderContext.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="jest" />
+import { ITestEmailProviderContext } from '../types';
+export default class MockTestEmailProviderContext implements ITestEmailProviderContext {
+    sendEmail: jest.Mock<any, any, any>;
+    dispose: jest.Mock<any, any, any>;
+}

package/build/src/testUtils/context/email/MockTestEmailProviderContext.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class MockTestEmailProviderContext {
+    constructor() {
+        this.sendEmail = jest.fn().mockName('sendEmail');
+        this.dispose = jest.fn().mockName('close');
+    }
+}
+exports.default = MockTestEmailProviderContext;
+//# sourceMappingURL=MockTestEmailProviderContext.js.map

package/build/src/testUtils/context/email/MockTestEmailProviderContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockTestEmailProviderContext.js","sourceRoot":"","sources":["../../../../../src/testUtils/context/email/MockTestEmailProviderContext.ts"],"names":[],"mappings":";;AAEA,MAAqB,4BAA4B;IAAjD;QAGE,cAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC5C,YAAO,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;CAAA;AALD,+CAKC"}

package/build/src/testUtils/context/email/NoopEmailProviderContext.d.ts

@@ -0,0 +1,6 @@
+import { noopAsync } from 'softkave-js-utils';
+import { IEmailProviderContext } from '../../../contexts/email/types';
+export default class NoopEmailProviderContext implements IEmailProviderContext {
+    sendEmail: typeof noopAsync;
+    dispose: typeof noopAsync;
+}

package/build/src/testUtils/context/email/NoopEmailProviderContext.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const softkave_js_utils_1 = require("softkave-js-utils");
+class NoopEmailProviderContext {
+    constructor() {
+        this.sendEmail = softkave_js_utils_1.noopAsync;
+        this.dispose = softkave_js_utils_1.noopAsync;
+    }
+}
+exports.default = NoopEmailProviderContext;
+//# sourceMappingURL=NoopEmailProviderContext.js.map

package/build/src/testUtils/context/email/NoopEmailProviderContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NoopEmailProviderContext.js","sourceRoot":"","sources":["../../../../../src/testUtils/context/email/NoopEmailProviderContext.ts"],"names":[],"mappings":";;AAAA,yDAA4C;AAG5C,MAAqB,wBAAwB;IAA7C;QACE,cAAS,GAAG,6BAAS,CAAC;QACtB,YAAO,GAAG,6BAAS,CAAC;IACtB,CAAC;CAAA;AAHD,2CAGC"}

package/build/src/testUtils/context/email/TestSESEmailProviderContext.d.ts

@@ -0,0 +1,8 @@
+import { AWSConfig } from '../../../utils/aws';
+import { ITestEmailProviderContext } from '../types';
+export default class TestSESEmailProviderContext implements ITestEmailProviderContext {
+    private client;
+    sendEmail: ITestEmailProviderContext['sendEmail'];
+    dispose: ITestEmailProviderContext['dispose'];
+    constructor(params: AWSConfig);
+}

package/build/src/testUtils/context/email/TestSESEmailProviderContext.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const SESEmailProviderContext_1 = require("../../../contexts/email/SESEmailProviderContext");
+const mock_1 = require("../../helpers/mock");
+class TestSESEmailProviderContext {
+    constructor(params) {
+        this.client = new SESEmailProviderContext_1.SESEmailProviderContext(params);
+        this.sendEmail = jest.fn(this.client.sendEmail).mockName('sendEmail');
+        this.dispose = jest.fn(this.client.dispose).mockName('close');
+        (0, mock_1.mockWith)(this.client, this);
+    }
+}
+exports.default = TestSESEmailProviderContext;
+//# sourceMappingURL=TestSESEmailProviderContext.js.map

package/build/src/testUtils/context/email/TestSESEmailProviderContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestSESEmailProviderContext.js","sourceRoot":"","sources":["../../../../../src/testUtils/context/email/TestSESEmailProviderContext.ts"],"names":[],"mappings":";;AAAA,6FAAwF;AAExF,6CAA4C;AAG5C,MAAqB,2BAA2B;IAQ9C,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,iDAAuB,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACtE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAE9D,IAAA,eAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC9B,CAAC;CACF;AAfD,8CAeC"}

package/build/src/testUtils/context/types.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="jest" />
+import { AnyFn } from 'softkave-js-utils';
+import { IEmailProviderContext } from '../../contexts/email/types';
+export type LayerJestMock<T extends {
+    [key: string]: any;
+}> = {
+    [K in keyof T]: T[K] extends AnyFn ? jest.Mock<ReturnType<T[K]>, Parameters<T[K]>> : T[K];
+};
+export type ITestEmailProviderContext = LayerJestMock<IEmailProviderContext>;

package/build/src/testUtils/context/types.js

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

package/build/src/testUtils/context/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/testUtils/context/types.ts"],"names":[],"mappings":""}

package/build/src/testUtils/generate/utils.d.ts

@@ -0,0 +1,37 @@
+import { AnyFn, AnyObject, OrPromise } from 'softkave-js-utils';
+export type GeneratePartialTestDataFn<T> = (index: number, indexItem: T, cache: Record<string, unknown>) => Partial<T>;
+export declare const defaultGeneratePartialTestDataFn: GeneratePartialTestDataFn<unknown>;
+export declare function generateTestList<T, TCache extends Record<string, unknown> = Record<string, unknown>>(generareFullDataFn: (index: number, cache: Record<string, unknown>) => T, count?: number, generatePartialDataFn?: GeneratePartialTestDataFn<T>, cache?: TCache): T[];
+export type GenerateTestFieldsDef<T extends AnyObject, TOtherArgs extends unknown[] = unknown[]> = {
+    [K in keyof T]: AnyFn<[K, ...TOtherArgs], OrPromise<T[K]>>;
+};
+export declare function generateTestFields<T extends AnyObject>(def: GenerateTestFieldsDef<T>, ...otherArgs: unknown[]): Promise<Partial<T>>;
+export declare enum TestFieldsPresetCombinations {
+    /** Generates a total of N combinations where N is the number of keys present
+     * in the object, and for each entry, there'd be only one field generated. E.g
+     * ```typescript
+     * const def = {one: () => 1, two: () => 2};
+     * const testFields = [
+     *    {one: 1},
+     *    {two: 2}
+     * ];
+     * ``` */
+    oneOfEach = "oneOfEach",
+    /** Generates a total of N combinations where N is the number of keys present
+     * in the object, and for each entry, there'd be the key and other keys that came before. E.g
+     * ```typescript
+     * const def = {one: () => 1, two: () => 2, three: () => 3};
+     * const testFields = [
+     *    {one: 1},
+     *    {one: 1, two: 2},
+     *    {one: 1, two: 2, three: 3},
+     * ];
+     * ``` */
+    incrementallyAdd = "incrementallyAdd"
+}
+export declare function generateTestFieldsCombinations<T extends AnyObject>(def: GenerateTestFieldsDef<T>, factor: TestFieldsPresetCombinations, ...otherArgs: unknown[]): Promise<Array<Partial<T>>>;
+export interface MatchGenerate<TData, TContexts extends unknown[] = unknown[]> {
+    matcher: AnyFn<TContexts, OrPromise<boolean>>;
+    generator: AnyFn<TContexts, OrPromise<TData>>;
+}
+export declare function matchGenerators<TData, TContexts extends unknown[]>(generators: Array<MatchGenerate<TData, TContexts>>, ...args: TContexts): Promise<TData | undefined>;

package/build/src/testUtils/generate/utils.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchGenerators = exports.generateTestFieldsCombinations = exports.TestFieldsPresetCombinations = exports.generateTestFields = exports.generateTestList = exports.defaultGeneratePartialTestDataFn = void 0;
+const lodash_1 = require("lodash");
+const softkave_js_utils_1 = require("softkave-js-utils");
+const defaultGeneratePartialTestDataFn = () => ({});
+exports.defaultGeneratePartialTestDataFn = defaultGeneratePartialTestDataFn;
+function generateTestList(generareFullDataFn, count = 20, generatePartialDataFn = () => ({}), cache = {}) {
+    const data = [];
+    for (let i = 0; i < count; i++) {
+        const f = generareFullDataFn(i, cache);
+        const item = (0, softkave_js_utils_1.mergeObjects)(f, generatePartialDataFn(i, f, cache), {
+            arrayUpdateStrategy: 'replace',
+        });
+        data.push(item);
+    }
+    return data;
+}
+exports.generateTestList = generateTestList;
+async function generateTestFields(def, ...otherArgs) {
+    const acc = {};
+    await Promise.all(Object.entries(def).map(async ([key, genFn]) => {
+        acc[key] = await genFn(key, ...otherArgs);
+        return acc;
+    }));
+    return acc;
+}
+exports.generateTestFields = generateTestFields;
+var TestFieldsPresetCombinations;
+(function (TestFieldsPresetCombinations) {
+    /** Generates a total of N combinations where N is the number of keys present
+     * in the object, and for each entry, there'd be only one field generated. E.g
+     * ```typescript
+     * const def = {one: () => 1, two: () => 2};
+     * const testFields = [
+     *    {one: 1},
+     *    {two: 2}
+     * ];
+     * ``` */
+    TestFieldsPresetCombinations["oneOfEach"] = "oneOfEach";
+    /** Generates a total of N combinations where N is the number of keys present
+     * in the object, and for each entry, there'd be the key and other keys that came before. E.g
+     * ```typescript
+     * const def = {one: () => 1, two: () => 2, three: () => 3};
+     * const testFields = [
+     *    {one: 1},
+     *    {one: 1, two: 2},
+     *    {one: 1, two: 2, three: 3},
+     * ];
+     * ``` */
+    TestFieldsPresetCombinations["incrementallyAdd"] = "incrementallyAdd";
+})(TestFieldsPresetCombinations || (exports.TestFieldsPresetCombinations = TestFieldsPresetCombinations = {}));
+async function generateTestFieldsCombinations(def, factor, ...otherArgs) {
+    if (factor === TestFieldsPresetCombinations.incrementallyAdd) {
+        return await Promise.all(Object.keys(def).map((unused, index, keys) => {
+            const subDef = (0, lodash_1.pick)(def, keys.slice(0, index + 1));
+            return generateTestFields(subDef, ...otherArgs);
+        }));
+    }
+    else if (factor === TestFieldsPresetCombinations.oneOfEach) {
+        return await Promise.all(Object.keys(def).map(key => {
+            const subDef = (0, lodash_1.pick)(def, [key]);
+            return generateTestFields(subDef, ...otherArgs);
+        }));
+    }
+    return [];
+}
+exports.generateTestFieldsCombinations = generateTestFieldsCombinations;
+async function matchGenerators(generators, ...args) {
+    for (const { generator, matcher } of generators) {
+        const matches = await matcher(...args);
+        if (matches) {
+            return generator(...args);
+        }
+    }
+    return undefined;
+}
+exports.matchGenerators = matchGenerators;
+//# sourceMappingURL=utils.js.map

package/build/src/testUtils/generate/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/testUtils/generate/utils.ts"],"names":[],"mappings":";;;AAAA,mCAA4B;AAC5B,yDAA4E;AAQrE,MAAM,gCAAgC,GAEzC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAFF,QAAA,gCAAgC,oCAE9B;AAEf,SAAgB,gBAAgB,CAI9B,kBAAwE,EACxE,KAAK,GAAG,EAAE,EACV,wBAAsD,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAChE,QAAgB,EAAY;IAE5B,MAAM,IAAI,GAAQ,EAAE,CAAC;IACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;QAC9B,MAAM,CAAC,GAAG,kBAAkB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACvC,MAAM,IAAI,GAAG,IAAA,gCAAY,EAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE;YAC/D,mBAAmB,EAAE,SAAS;SAC/B,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KACjB;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAlBD,4CAkBC;AASM,KAAK,UAAU,kBAAkB,CACtC,GAA6B,EAC7B,GAAG,SAAoB;IAEvB,MAAM,GAAG,GAAc,EAAE,CAAC;IAC1B,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC7C,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;QAC1C,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,GAAiB,CAAC;AAC3B,CAAC;AAbD,gDAaC;AAED,IAAY,4BAsBX;AAtBD,WAAY,4BAA4B;IACtC;;;;;;;;aAQS;IACT,uDAAuB,CAAA;IACvB;;;;;;;;;aASS;IACT,qEAAqC,CAAA;AACvC,CAAC,EAtBW,4BAA4B,4CAA5B,4BAA4B,QAsBvC;AAEM,KAAK,UAAU,8BAA8B,CAClD,GAA6B,EAC7B,MAAoC,EACpC,GAAG,SAAoB;IAEvB,IAAI,MAAM,KAAK,4BAA4B,CAAC,gBAAgB,EAAE;QAC5D,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC3C,MAAM,MAAM,GAAG,IAAA,aAAI,EACjB,GAAG,EACH,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CACG,CAAC;YAC9B,OAAO,kBAAkB,CAAI,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;QACrD,CAAC,CAAC,CACH,CAAC;KACH;SAAM,IAAI,MAAM,KAAK,4BAA4B,CAAC,SAAS,EAAE;QAC5D,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACzB,MAAM,MAAM,GAAG,IAAA,aAAI,EAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAA6B,CAAC;YAC5D,OAAO,kBAAkB,CAAI,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;QACrD,CAAC,CAAC,CACH,CAAC;KACH;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAzBD,wEAyBC;AAOM,KAAK,UAAU,eAAe,CACnC,UAAkD,EAClD,GAAG,IAAe;IAElB,KAAK,MAAM,EAAC,SAAS,EAAE,OAAO,EAAC,IAAI,UAAU,EAAE;QAC7C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;QAEvC,IAAI,OAAO,EAAE;YACX,OAAO,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;SAC3B;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAbD,0CAaC"}

package/build/src/testUtils/helpers/assertion.d.ts

@@ -0,0 +1,25 @@
+export declare function expectContainsEveryItemInForAnyType<T2, T1>(received: T1[], expected: T2[], receivedIndexer: (item: T1) => string, expectedIndexer: (item: T2) => string): void;
+/**
+ * Checks that `received` contains every item in `expected` using the `indexer`
+ * provided. The `indexer` should return a unique string for each unique item in
+ * the list. Also, the same unique string should be returned for the same item
+ * no matter how many times `indexer` is called.
+ */
+export declare function expectContainsEveryItemIn<T2, T1 extends T2>(received: T1[], expected: T2[], indexer: (item: T2) => string): void;
+export declare function expectContainsNoneInForAnyType<T2, T1>(received: T1[], expected: T2[], receivedIndexer: (item: T1) => string, expectedIndexer: (item: T2) => string): void;
+/**
+ * Checks that `received` contains none of the items in `expected` using the `indexer`
+ * provided. The `indexer` should return a unique string for each unique item in
+ * the list. Also, the same unique string should be returned for the same item
+ * no matter how many times `indexer` is called.
+ */
+export declare function expectContainsNoneIn<T2, T1 extends T2>(received: T1[], expected: T2[], indexer: (item: T2) => string): void;
+export declare function expectContainsExactlyForAnyType<T2, T1>(received: T1[], expected: T2[], receivedIndexer: (item: T1) => string, expectedIndexer: (item: T2) => string): void;
+/**
+ * Checks that `received` and `expected` contains the same items using the
+ * `indexer` provided. The `indexer` should return a unique string for each
+ * unique item in the list. Also, the same unique string should be returned for
+ * the same item no matter how many times `indexer` is called.
+ */
+export declare function expectContainsExactly<T2, T1 extends T2>(received: T1[], expected: T2[], indexer: (item: T2) => string): void;
+export declare function expectListSubsetMatch(list01: unknown[], list02: unknown[]): void;

package/build/src/testUtils/helpers/assertion.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expectListSubsetMatch = exports.expectContainsExactly = exports.expectContainsExactlyForAnyType = exports.expectContainsNoneIn = exports.expectContainsNoneInForAnyType = exports.expectContainsEveryItemIn = exports.expectContainsEveryItemInForAnyType = void 0;
+const softkave_js_utils_1 = require("softkave-js-utils");
+function expectContainsEveryItemInForAnyType(received, expected, receivedIndexer, expectedIndexer) {
+    const receivedMap = (0, softkave_js_utils_1.indexArray)(received, { indexer: receivedIndexer });
+    expected.forEach(item1 => {
+        const k = expectedIndexer(item1);
+        const item2 = receivedMap[k];
+        expect(item2).toBeTruthy();
+    });
+}
+exports.expectContainsEveryItemInForAnyType = expectContainsEveryItemInForAnyType;
+/**
+ * Checks that `received` contains every item in `expected` using the `indexer`
+ * provided. The `indexer` should return a unique string for each unique item in
+ * the list. Also, the same unique string should be returned for the same item
+ * no matter how many times `indexer` is called.
+ */
+function expectContainsEveryItemIn(received, expected, indexer) {
+    expectContainsEveryItemInForAnyType(received, expected, indexer, indexer);
+}
+exports.expectContainsEveryItemIn = expectContainsEveryItemIn;
+function expectContainsNoneInForAnyType(received, expected, receivedIndexer, expectedIndexer) {
+    const receivedMap = (0, softkave_js_utils_1.indexArray)(received, { indexer: receivedIndexer });
+    expected.forEach(item1 => {
+        const k = expectedIndexer(item1);
+        const item2 = receivedMap[k];
+        expect(item2).toBeFalsy();
+    });
+}
+exports.expectContainsNoneInForAnyType = expectContainsNoneInForAnyType;
+/**
+ * Checks that `received` contains none of the items in `expected` using the `indexer`
+ * provided. The `indexer` should return a unique string for each unique item in
+ * the list. Also, the same unique string should be returned for the same item
+ * no matter how many times `indexer` is called.
+ */
+function expectContainsNoneIn(received, expected, indexer) {
+    expectContainsNoneInForAnyType(received, expected, indexer, indexer);
+}
+exports.expectContainsNoneIn = expectContainsNoneIn;
+function expectContainsExactlyForAnyType(received, expected, receivedIndexer, expectedIndexer) {
+    expect(received.length).toEqual(expected.length);
+    expectContainsEveryItemInForAnyType(received, expected, receivedIndexer, expectedIndexer);
+}
+exports.expectContainsExactlyForAnyType = expectContainsExactlyForAnyType;
+/**
+ * Checks that `received` and `expected` contains the same items using the
+ * `indexer` provided. The `indexer` should return a unique string for each
+ * unique item in the list. Also, the same unique string should be returned for
+ * the same item no matter how many times `indexer` is called.
+ */
+function expectContainsExactly(received, expected, indexer) {
+    expectContainsExactlyForAnyType(received, expected, indexer, indexer);
+}
+exports.expectContainsExactly = expectContainsExactly;
+function expectListSubsetMatch(list01, list02) {
+    const subsetLength = Math.min(list01.length, list02.length);
+    return expect(list01.slice(0, subsetLength)).toEqual(list02.slice(0, subsetLength));
+}
+exports.expectListSubsetMatch = expectListSubsetMatch;
+//# sourceMappingURL=assertion.js.map

package/build/src/testUtils/helpers/assertion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertion.js","sourceRoot":"","sources":["../../../../src/testUtils/helpers/assertion.ts"],"names":[],"mappings":";;;AAAA,yDAA6C;AAE7C,SAAgB,mCAAmC,CACjD,QAAc,EACd,QAAc,EACd,eAAqC,EACrC,eAAqC;IAErC,MAAM,WAAW,GAAG,IAAA,8BAAU,EAAC,QAAQ,EAAE,EAAC,OAAO,EAAE,eAAe,EAAC,CAAC,CAAC;IACrE,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACvB,MAAM,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;IAC7B,CAAC,CAAC,CAAC;AACL,CAAC;AAZD,kFAYC;AAED;;;;;GAKG;AACH,SAAgB,yBAAyB,CACvC,QAAc,EACd,QAAc,EACd,OAA6B;IAE7B,mCAAmC,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAC5E,CAAC;AAND,8DAMC;AAED,SAAgB,8BAA8B,CAC5C,QAAc,EACd,QAAc,EACd,eAAqC,EACrC,eAAqC;IAErC,MAAM,WAAW,GAAG,IAAA,8BAAU,EAAC,QAAQ,EAAE,EAAC,OAAO,EAAE,eAAe,EAAC,CAAC,CAAC;IACrE,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACvB,MAAM,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC;IAC5B,CAAC,CAAC,CAAC;AACL,CAAC;AAZD,wEAYC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,QAAc,EACd,QAAc,EACd,OAA6B;IAE7B,8BAA8B,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AACvE,CAAC;AAND,oDAMC;AAED,SAAgB,+BAA+B,CAC7C,QAAc,EACd,QAAc,EACd,eAAqC,EACrC,eAAqC;IAErC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACjD,mCAAmC,CACjC,QAAQ,EACR,QAAQ,EACR,eAAe,EACf,eAAe,CAChB,CAAC;AACJ,CAAC;AAbD,0EAaC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,QAAc,EACd,QAAc,EACd,OAA6B;IAE7B,+BAA+B,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AACxE,CAAC;AAND,sDAMC;AAED,SAAgB,qBAAqB,CAAC,MAAiB,EAAE,MAAiB;IACxE,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5D,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,OAAO,CAClD,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAC9B,CAAC;AACJ,CAAC;AALD,sDAKC"}

package/build/src/testUtils/helpers/binary.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Readable } from 'stream';
+export declare function expectBinaryEqual(body: Buffer | Readable, expectedBody: Buffer | Readable): Promise<void>;

package/build/src/testUtils/helpers/binary.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expectBinaryEqual = void 0;
+const assert_1 = __importDefault(require("assert"));
+const streamToBuffer_1 = require("../../utils/streamToBuffer");
+async function expectBinaryEqual(body, expectedBody) {
+    const [bodyBuffer, expectedBuffer] = await Promise.all([
+        Buffer.isBuffer(body) ? body : (0, streamToBuffer_1.streamToBuffer)(body),
+        Buffer.isBuffer(expectedBody) ? expectedBody : (0, streamToBuffer_1.streamToBuffer)(expectedBody),
+    ]);
+    (0, assert_1.default)(bodyBuffer);
+    (0, assert_1.default)(expectedBuffer);
+    expect(expectedBuffer.equals(bodyBuffer)).toBe(true);
+}
+exports.expectBinaryEqual = expectBinaryEqual;
+//# sourceMappingURL=binary.js.map

package/build/src/testUtils/helpers/binary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary.js","sourceRoot":"","sources":["../../../../src/testUtils/helpers/binary.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAE5B,+DAA0D;AAEnD,KAAK,UAAU,iBAAiB,CACrC,IAAuB,EACvB,YAA+B;IAE/B,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACrD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,+BAAc,EAAC,IAAI,CAAC;QACnD,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAA,+BAAc,EAAC,YAAY,CAAC;KAC5E,CAAC,CAAC;IAEH,IAAA,gBAAM,EAAC,UAAU,CAAC,CAAC;IACnB,IAAA,gBAAM,EAAC,cAAc,CAAC,CAAC;IACvB,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvD,CAAC;AAZD,8CAYC"}

package/build/src/testUtils/helpers/error.d.ts

@@ -0,0 +1,3 @@
+import { AnyFn } from 'softkave-js-utils';
+export declare function assertErrorHasName(error: unknown, expectedErrorNames: string[]): void;
+export declare function expectErrorThrown(fn: AnyFn, expected?: string[] | AnyFn<[unknown], boolean | string | void>, finallyFn?: AnyFn): Promise<void>;

package/build/src/testUtils/helpers/error.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expectErrorThrown = exports.assertErrorHasName = void 0;
+const assert = require("assert");
+const lodash_1 = require("lodash");
+const util_1 = require("util");
+function assertErrorHasName(error, expectedErrorNames) {
+    const errorList = (0, lodash_1.isArray)(error) ? error : [error];
+    const matchedTypes = expectedErrorNames.map(name => errorList.find(item => (item === null || item === void 0 ? void 0 : item.name) === name));
+    const missingTypes = [];
+    expectedErrorNames.forEach((name, i) => {
+        if (!matchedTypes[i]) {
+            missingTypes.push(name);
+        }
+    });
+    const missingError = new Error(`${missingTypes.join(', ')} not found in \n${(0, util_1.format)(error)}`);
+    assert(missingTypes.length === 0, missingError);
+}
+exports.assertErrorHasName = assertErrorHasName;
+async function expectErrorThrown(fn, expected, finallyFn) {
+    try {
+        await fn();
+        assert.fail('Error not thrown');
+    }
+    catch (error) {
+        if ((0, lodash_1.isFunction)(expected)) {
+            const assertionResult = expected(error);
+            if (!(0, lodash_1.isUndefined)(assertionResult)) {
+                assert(assertionResult === true, (0, lodash_1.isString)(assertionResult) ? assertionResult : 'Expectation not met');
+            }
+        }
+        else if (expected) {
+            assertErrorHasName(error, expected);
+        }
+    }
+    finally {
+        if (finallyFn) {
+            finallyFn();
+        }
+    }
+}
+exports.expectErrorThrown = expectErrorThrown;
+//# sourceMappingURL=error.js.map

package/build/src/testUtils/helpers/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../../src/testUtils/helpers/error.ts"],"names":[],"mappings":";;;AAAA,iCAAkC;AAClC,mCAAkE;AAElE,+BAA4B;AAE5B,SAAgB,kBAAkB,CAChC,KAAc,EACd,kBAA4B;IAE5B,MAAM,SAAS,GAAG,IAAA,gBAAO,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACnD,MAAM,YAAY,GAAG,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CACjD,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,MAAK,IAAI,CAAC,CAC5C,CAAC;IACF,MAAM,YAAY,GAAa,EAAE,CAAC;IAClC,kBAAkB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QACrC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE;YACpB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,IAAI,KAAK,CAC5B,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,IAAA,aAAM,EAAC,KAAK,CAAC,EAAE,CAC7D,CAAC;IAEF,MAAM,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,YAAY,CAAC,CAAC;AAClD,CAAC;AApBD,gDAoBC;AAEM,KAAK,UAAU,iBAAiB,CACrC,EAAS,EACT,QAA+D,EAC/D,SAAiB;IAEjB,IAAI;QACF,MAAM,EAAE,EAAE,CAAC;QACX,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;KACjC;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,IAAA,mBAAU,EAAC,QAAQ,CAAC,EAAE;YACxB,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;YAExC,IAAI,CAAC,IAAA,oBAAW,EAAC,eAAe,CAAC,EAAE;gBACjC,MAAM,CACJ,eAAe,KAAK,IAAI,EACxB,IAAA,iBAAQ,EAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,qBAAqB,CACpE,CAAC;aACH;SACF;aAAM,IAAI,QAAQ,EAAE;YACnB,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;SACrC;KACF;YAAS;QACR,IAAI,SAAS,EAAE;YACb,SAAS,EAAE,CAAC;SACb;KACF;AACH,CAAC;AA1BD,8CA0BC"}

package/build/src/testUtils/helpers/mock.d.ts

@@ -0,0 +1,2 @@
+import { AnyObject } from 'softkave-js-utils';
+export declare function mockWith(source: AnyObject, dest: AnyObject): void;

package/build/src/testUtils/helpers/mock.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockWith = void 0;
+const lodash_1 = require("lodash");
+function mockWith(source, dest) {
+    for (const key in source) {
+        let value = source[key];
+        if ((0, lodash_1.isFunction)(value)) {
+            value = jest.fn(value).mockName(key);
+        }
+        dest[key] = value;
+    }
+}
+exports.mockWith = mockWith;
+//# sourceMappingURL=mock.js.map

package/build/src/testUtils/helpers/mock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock.js","sourceRoot":"","sources":["../../../../src/testUtils/helpers/mock.ts"],"names":[],"mappings":";;;AAAA,mCAAkC;AAGlC,SAAgB,QAAQ,CAAC,MAAiB,EAAE,IAAe;IACzD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;QACxB,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAExB,IAAI,IAAA,mBAAU,EAAC,KAAK,CAAC,EAAE;YACrB,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SACtC;QAED,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;KACnB;AACH,CAAC;AAVD,4BAUC"}

package/build/src/testUtils/helpers/mongodb.d.ts

@@ -0,0 +1,3 @@
+import { Connection } from 'mongoose';
+export declare function dropMongoDBAndEndConnection(connection?: Connection | null): Promise<void>;
+export declare function genDbName(): string;

package/build/src/testUtils/helpers/mongodb.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.genDbName = exports.dropMongoDBAndEndConnection = void 0;
+const faker_1 = require("@faker-js/faker");
+async function dropMongoDBAndEndConnection(connection) {
+    if (!connection) {
+        return;
+    }
+    await connection.dropDatabase();
+    await connection.close();
+}
+exports.dropMongoDBAndEndConnection = dropMongoDBAndEndConnection;
+function genDbName() {
+    return faker_1.faker.lorem.words(5).replace(/ /g, '_');
+}
+exports.genDbName = genDbName;
+//# sourceMappingURL=mongodb.js.map

package/build/src/testUtils/helpers/mongodb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongodb.js","sourceRoot":"","sources":["../../../../src/testUtils/helpers/mongodb.ts"],"names":[],"mappings":";;;AAAA,2CAAsC;AAG/B,KAAK,UAAU,2BAA2B,CAC/C,UAA8B;IAE9B,IAAI,CAAC,UAAU,EAAE;QACf,OAAO;KACR;IAED,MAAM,UAAU,CAAC,YAAY,EAAE,CAAC;IAChC,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;AAC3B,CAAC;AATD,kEASC;AAED,SAAgB,SAAS;IACvB,OAAO,aAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AACjD,CAAC;AAFD,8BAEC"}

package/build/src/testUtils/helpers/testFns.d.ts

@@ -0,0 +1,30 @@
+import { AnyFn, AnyObject, OrArray, OrPromise } from 'softkave-js-utils';
+import { SemanticProviderMutationOpOptions } from '../../contexts/semantic/types';
+import { ServerRequest } from '../../contexts/types';
+import { Endpoint, InferEndpointParams, InferEndpointResult, PaginatedResult, PaginationQuery } from '../../endpoints/types';
+export declare function mutationTest(name: string, fn: AnyFn<[SemanticProviderMutationOpOptions]>, timeout?: number): void;
+export declare function completeTests(): Promise<void>;
+export declare function startTesting(): void;
+type TestFn = (name: string, fn: AnyFn, timeout?: number) => void;
+export interface SoftkaveTest {
+    run: TestFn;
+    only: TestFn;
+}
+export declare const softkaveTest: SoftkaveTest;
+export interface PerformPaginationTestParams<T extends Endpoint<AnyObject, PaginatedResult>> {
+    params: Omit<InferEndpointParams<T>, keyof PaginationQuery>;
+    otherTestsFn?: AnyFn<[InferEndpointResult<T>]>;
+    req: ServerRequest;
+    count: number;
+    pageSize?: number;
+    fields: OrArray<keyof InferEndpointResult<T>>;
+}
+export declare function performPaginationTest<T extends Endpoint<any, PaginatedResult>>(endpoint: T, props: PerformPaginationTestParams<T>): Promise<void>;
+export declare function expectFields<T extends AnyObject>(resources: T[], fields: Partial<T>): void;
+export interface MatchExpect<TContexts extends unknown[] = unknown[]> {
+    matcher: AnyFn<TContexts, OrPromise<boolean>>;
+    expect: AnyFn<TContexts, OrPromise<void>>;
+}
+export declare function matchExpects<TContexts extends unknown[]>(expects: Array<MatchExpect<TContexts>>, ...args: TContexts): Promise<void>;
+export declare function testCombinations<TCombination extends AnyObject>(combinations: TCombination[], fn: AnyFn<[TCombination]>): Promise<void>;
+export {};