@deenruv/testing 1.0.0

package/lib/data-population/populate-for-testing.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.populateForTesting = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const cli_1 = require("@deenruv/core/cli");
+const populate_customers_1 = require("./populate-customers");
+/**
+ * Clears all tables from the database and populates with (deterministic) random data.
+ */
+async function populateForTesting(config, bootstrapFn, options) {
+    var _a;
+    config.dbConnectionOptions.logging = false;
+    const logging = options.logging === undefined ? true : options.logging;
+    const originalRequireVerification = config.authOptions.requireVerification;
+    config.authOptions.requireVerification = false;
+    const app = await bootstrapFn(config);
+    const logFn = (message) => (logging ? console.log(message) : null);
+    await (0, cli_1.populateInitialData)(app, options.initialData);
+    await populateProducts(app, options.productsCsvPath, logging);
+    await (0, cli_1.populateCollections)(app, options.initialData);
+    await (0, populate_customers_1.populateCustomers)(app, (_a = options.customerCount) !== null && _a !== void 0 ? _a : 10, logFn);
+    config.authOptions.requireVerification = originalRequireVerification;
+    return app;
+}
+exports.populateForTesting = populateForTesting;
+async function populateProducts(app, productsCsvPath, logging) {
+    if (!productsCsvPath) {
+        if (logging) {
+            console.log("\nNo product data provided, skipping product import");
+        }
+        return;
+    }
+    const importResult = await (0, cli_1.importProductsFromCsv)(app, productsCsvPath, generated_types_1.LanguageCode.en);
+    if (importResult.errors && importResult.errors.length) {
+        console.log(`${importResult.errors.length} errors encountered when importing product data:`);
+        console.log(importResult.errors.join("\n"));
+    }
+    if (logging) {
+        console.log(`\nImported ${importResult.imported} products`);
+    }
+}
+//# sourceMappingURL=populate-for-testing.js.map

package/lib/data-population/populate-for-testing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"populate-for-testing.js","sourceRoot":"","sources":["../../src/data-population/populate-for-testing.ts"],"names":[],"mappings":";;;AACA,yEAAmE;AAEnE,2CAI2B;AAI3B,6DAAyD;AAEzD;;GAEG;AACI,KAAK,UAAU,kBAAkB,CACtC,MAA+B,EAC/B,WAAkD,EAClD,OAA0B;;IAEzB,MAAM,CAAC,mBAA2B,CAAC,OAAO,GAAG,KAAK,CAAC;IACpD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACvE,MAAM,2BAA2B,GAAG,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC;IAC3E,MAAM,CAAC,WAAW,CAAC,mBAAmB,GAAG,KAAK,CAAC;IAE/C,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;IAEtC,MAAM,KAAK,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAE3E,MAAM,IAAA,yBAAmB,EAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IACpD,MAAM,gBAAgB,CAAC,GAAG,EAAE,OAAO,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,IAAA,yBAAmB,EAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IACpD,MAAM,IAAA,sCAAiB,EAAC,GAAG,EAAE,MAAA,OAAO,CAAC,aAAa,mCAAI,EAAE,EAAE,KAAK,CAAC,CAAC;IAEjE,MAAM,CAAC,WAAW,CAAC,mBAAmB,GAAG,2BAA2B,CAAC;IACrE,OAAO,GAAG,CAAC;AACb,CAAC;AArBD,gDAqBC;AAED,KAAK,UAAU,gBAAgB,CAC7B,GAA4B,EAC5B,eAAmC,EACnC,OAAgB;IAEhB,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,qDAAqD,CAAC,CAAC;QACrE,CAAC;QACD,OAAO;IACT,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,IAAA,2BAAqB,EAC9C,GAAG,EACH,eAAe,EACf,8BAAY,CAAC,EAAE,CAChB,CAAC;IACF,IAAI,YAAY,CAAC,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACtD,OAAO,CAAC,GAAG,CACT,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,kDAAkD,CAChF,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,CAAC,GAAG,CAAC,cAAc,YAAY,CAAC,QAAQ,WAAW,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC"}

package/lib/error-result-guard.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @description
+ * Convenience method for creating an {@link ErrorResultGuard}. Takes a predicate function which
+ * tests whether the input is considered successful (true) or an error result (false).
+ *
+ * Note that the resulting variable must _still_ be type annotated in order for the TypeScript
+ * type inference to work as expected:
+ *
+ * @example
+ * ```ts
+ * const orderResultGuard: ErrorResultGuard<AddItemToOrderResult>
+ *   = createErrorResultGuard(order => !!order.lines);
+ * ```
+ * @docsCategory testing
+ */
+export declare function createErrorResultGuard<T>(testFn: (input: T) => boolean): ErrorResultGuard<T>;
+/**
+ * @description
+ * A utility class which is used to assert the success of an operation
+ * which returns a union type of `SuccessType | ErrorResponse [ | ErrorResponse ]`.
+ * The methods of this class are used to:
+ * 1. assert that the result is a success or error case
+ * 2. narrow the type so that TypeScript can correctly infer the properties of the result.
+ *
+ * @example
+ * ```ts
+ * const orderResultGuard: ErrorResultGuard<AddItemToOrderResult>
+ *   = createErrorResultGuard(order => !!order.lines);
+ *
+ * it('errors when quantity is negative', async () => {
+ *    const { addItemToOrder } = await shopClient.query<AddItemToOrder.Query, AddItemToOrder.Mutation>(ADD_ITEM_TO_ORDER, {
+ *      productVariantId: 42, quantity: -1,
+ *    });
+ *
+ *    // The test will fail
+ *    orderResultGuard.assertErrorResult(addItemToOrder);
+ *
+ *    // the type of `addItemToOrder` has now been
+ *    // narrowed to only include the ErrorResult types.
+ *    expect(addItemToOrder.errorCode).toBe(ErrorCode.NegativeQuantityError);
+ * }
+ * ```
+ * @docsCategory testing
+ */
+export declare class ErrorResultGuard<T> {
+    private testFn;
+    constructor(testFn: (input: T) => boolean);
+    /**
+     * @description
+     * A type guard which returns `true` if the input passes the `testFn` predicate.
+     */
+    isSuccess(input: T | any): input is T;
+    /**
+     * @description
+     * Asserts (using the testing library's `fail()` function) that the input is
+     * successful, i.e. it passes the `testFn`.
+     */
+    assertSuccess<R>(input: T | R): asserts input is T;
+    /**
+     * @description
+     * Asserts (using the testing library's `fail()` function) that the input is
+     * not successful, i.e. it does not pass the `testFn`.
+     */
+    assertErrorResult<R>(input: T | R): asserts input is R;
+}

package/lib/error-result-guard.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorResultGuard = exports.createErrorResultGuard = void 0;
+const assert_1 = require("assert");
+/**
+ * @description
+ * Convenience method for creating an {@link ErrorResultGuard}. Takes a predicate function which
+ * tests whether the input is considered successful (true) or an error result (false).
+ *
+ * Note that the resulting variable must _still_ be type annotated in order for the TypeScript
+ * type inference to work as expected:
+ *
+ * @example
+ * ```ts
+ * const orderResultGuard: ErrorResultGuard<AddItemToOrderResult>
+ *   = createErrorResultGuard(order => !!order.lines);
+ * ```
+ * @docsCategory testing
+ */
+function createErrorResultGuard(testFn) {
+    return new ErrorResultGuard(testFn);
+}
+exports.createErrorResultGuard = createErrorResultGuard;
+/**
+ * @description
+ * A utility class which is used to assert the success of an operation
+ * which returns a union type of `SuccessType | ErrorResponse [ | ErrorResponse ]`.
+ * The methods of this class are used to:
+ * 1. assert that the result is a success or error case
+ * 2. narrow the type so that TypeScript can correctly infer the properties of the result.
+ *
+ * @example
+ * ```ts
+ * const orderResultGuard: ErrorResultGuard<AddItemToOrderResult>
+ *   = createErrorResultGuard(order => !!order.lines);
+ *
+ * it('errors when quantity is negative', async () => {
+ *    const { addItemToOrder } = await shopClient.query<AddItemToOrder.Query, AddItemToOrder.Mutation>(ADD_ITEM_TO_ORDER, {
+ *      productVariantId: 42, quantity: -1,
+ *    });
+ *
+ *    // The test will fail
+ *    orderResultGuard.assertErrorResult(addItemToOrder);
+ *
+ *    // the type of `addItemToOrder` has now been
+ *    // narrowed to only include the ErrorResult types.
+ *    expect(addItemToOrder.errorCode).toBe(ErrorCode.NegativeQuantityError);
+ * }
+ * ```
+ * @docsCategory testing
+ */
+class ErrorResultGuard {
+    constructor(testFn) {
+        this.testFn = testFn;
+    }
+    /**
+     * @description
+     * A type guard which returns `true` if the input passes the `testFn` predicate.
+     */
+    isSuccess(input) {
+        return this.testFn(input);
+    }
+    /**
+     * @description
+     * Asserts (using the testing library's `fail()` function) that the input is
+     * successful, i.e. it passes the `testFn`.
+     */
+    assertSuccess(input) {
+        if (!this.isSuccess(input)) {
+            (0, assert_1.fail)(`Unexpected error: ${JSON.stringify(input)}`);
+        }
+    }
+    /**
+     * @description
+     * Asserts (using the testing library's `fail()` function) that the input is
+     * not successful, i.e. it does not pass the `testFn`.
+     */
+    assertErrorResult(input) {
+        if (this.isSuccess(input)) {
+            (0, assert_1.fail)("Should have errored");
+        }
+    }
+}
+exports.ErrorResultGuard = ErrorResultGuard;
+//# sourceMappingURL=error-result-guard.js.map

package/lib/error-result-guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-result-guard.js","sourceRoot":"","sources":["../src/error-result-guard.ts"],"names":[],"mappings":";;;AAAA,mCAA8B;AAE9B;;;;;;;;;;;;;;GAcG;AACH,SAAgB,sBAAsB,CACpC,MAA6B;IAE7B,OAAO,IAAI,gBAAgB,CAAI,MAAM,CAAC,CAAC;AACzC,CAAC;AAJD,wDAIC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,gBAAgB;IAC3B,YAAoB,MAA6B;QAA7B,WAAM,GAAN,MAAM,CAAuB;IAAG,CAAC;IAErD;;;OAGG;IACH,SAAS,CAAC,KAAc;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAU,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAI,KAAY;QAC3B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,IAAA,aAAI,EAAC,qBAAqB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAI,KAAY;QAC/B,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,IAAA,aAAI,EAAC,qBAAqB,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;CACF;AAhCD,4CAgCC"}

package/lib/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./simple-graphql-client";
+export * from "./test-server";
+export * from "./config/test-config";
+export * from "./create-test-environment";
+export * from "./data-population/clear-all-tables";
+export * from "./data-population/populate-customers";
+export * from "./error-result-guard";
+export * from "./initializers/initializers";
+export * from "./initializers/test-db-initializer";
+export * from "./initializers/mysql-initializer";
+export * from "./initializers/postgres-initializer";
+export * from "./initializers/sqljs-initializer";
+export * from "./testing-logger";
+export * from "./types";

package/lib/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./simple-graphql-client"), exports);
+__exportStar(require("./test-server"), exports);
+__exportStar(require("./config/test-config"), exports);
+__exportStar(require("./create-test-environment"), exports);
+__exportStar(require("./data-population/clear-all-tables"), exports);
+__exportStar(require("./data-population/populate-customers"), exports);
+__exportStar(require("./error-result-guard"), exports);
+__exportStar(require("./initializers/initializers"), exports);
+__exportStar(require("./initializers/test-db-initializer"), exports);
+__exportStar(require("./initializers/mysql-initializer"), exports);
+__exportStar(require("./initializers/postgres-initializer"), exports);
+__exportStar(require("./initializers/sqljs-initializer"), exports);
+__exportStar(require("./testing-logger"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,gDAA8B;AAC9B,uDAAqC;AACrC,4DAA0C;AAC1C,qEAAmD;AACnD,uEAAqD;AACrD,uDAAqC;AACrC,8DAA4C;AAC5C,qEAAmD;AACnD,mEAAiD;AACjD,sEAAoD;AACpD,mEAAiD;AACjD,mDAAiC;AACjC,0CAAwB"}

package/lib/initializers/initializers.d.ts

@@ -0,0 +1,14 @@
+import { DataSourceOptions } from "typeorm";
+import { TestDbInitializer } from "./test-db-initializer";
+export type InitializerRegistry = {
+    [type in DataSourceOptions["type"]]?: TestDbInitializer<any>;
+};
+/**
+ * @description
+ * Registers a {@link TestDbInitializer} for the given database type. Should be called before invoking
+ * {@link createTestEnvironment}.
+ *
+ * @docsCategory testing
+ */
+export declare function registerInitializer(type: DataSourceOptions["type"], initializer: TestDbInitializer<any>): void;
+export declare function getInitializerFor(type: DataSourceOptions["type"]): TestDbInitializer<any>;

package/lib/initializers/initializers.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInitializerFor = exports.registerInitializer = void 0;
+const initializerRegistry = {};
+/**
+ * @description
+ * Registers a {@link TestDbInitializer} for the given database type. Should be called before invoking
+ * {@link createTestEnvironment}.
+ *
+ * @docsCategory testing
+ */
+function registerInitializer(type, initializer) {
+    initializerRegistry[type] = initializer;
+}
+exports.registerInitializer = registerInitializer;
+function getInitializerFor(type) {
+    const initializer = initializerRegistry[type];
+    if (!initializer) {
+        throw new Error(`No initializer has been registered for the database type "${type}"`);
+    }
+    return initializer;
+}
+exports.getInitializerFor = getInitializerFor;
+//# sourceMappingURL=initializers.js.map

package/lib/initializers/initializers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initializers.js","sourceRoot":"","sources":["../../src/initializers/initializers.ts"],"names":[],"mappings":";;;AAQA,MAAM,mBAAmB,GAAwB,EAAE,CAAC;AAEpD;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,IAA+B,EAC/B,WAAmC;IAEnC,mBAAmB,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;AAC1C,CAAC;AALD,kDAKC;AAED,SAAgB,iBAAiB,CAC/B,IAA+B;IAE/B,MAAM,WAAW,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC9C,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CACb,6DAA6D,IAAI,GAAG,CACrE,CAAC;IACJ,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAVD,8CAUC"}

package/lib/initializers/mysql-initializer.d.ts

@@ -0,0 +1,10 @@
+import { MysqlConnectionOptions } from "typeorm/driver/mysql/MysqlConnectionOptions";
+import { TestDbInitializer } from "./test-db-initializer";
+export declare class MysqlInitializer implements TestDbInitializer<MysqlConnectionOptions> {
+    private conn;
+    init(testFileName: string, connectionOptions: MysqlConnectionOptions): Promise<MysqlConnectionOptions>;
+    populate(populateFn: () => Promise<void>): Promise<void>;
+    destroy(): Promise<void>;
+    private getMysqlConnection;
+    private getDbNameFromFilename;
+}

package/lib/initializers/mysql-initializer.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MysqlInitializer = void 0;
+const path_1 = __importDefault(require("path"));
+const util_1 = require("util");
+class MysqlInitializer {
+    async init(testFileName, connectionOptions) {
+        const dbName = this.getDbNameFromFilename(testFileName);
+        this.conn = await this.getMysqlConnection(connectionOptions);
+        connectionOptions.database = dbName;
+        connectionOptions.synchronize = true;
+        const query = (0, util_1.promisify)(this.conn.query).bind(this.conn);
+        await query(`DROP DATABASE IF EXISTS ${dbName}`);
+        await query(`CREATE DATABASE IF NOT EXISTS ${dbName}`);
+        return connectionOptions;
+    }
+    async populate(populateFn) {
+        await populateFn();
+    }
+    async destroy() {
+        await (0, util_1.promisify)(this.conn.end).bind(this.conn)();
+    }
+    async getMysqlConnection(connectionOptions) {
+        const { createConnection } = await import("mysql");
+        const conn = createConnection({
+            host: connectionOptions.host,
+            port: connectionOptions.port,
+            user: connectionOptions.username,
+            password: connectionOptions.password,
+        });
+        const connect = (0, util_1.promisify)(conn.connect).bind(conn);
+        await connect();
+        return conn;
+    }
+    getDbNameFromFilename(filename) {
+        return "e2e_" + path_1.default.basename(filename).replace(/[^a-z0-9_]/gi, "_");
+    }
+}
+exports.MysqlInitializer = MysqlInitializer;
+//# sourceMappingURL=mysql-initializer.js.map

package/lib/initializers/mysql-initializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mysql-initializer.js","sourceRoot":"","sources":["../../src/initializers/mysql-initializer.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAGxB,+BAAiC;AAIjC,MAAa,gBAAgB;IAG3B,KAAK,CAAC,IAAI,CACR,YAAoB,EACpB,iBAAyC;QAEzC,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QACxD,IAAI,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QAC5D,iBAAyB,CAAC,QAAQ,GAAG,MAAM,CAAC;QAC5C,iBAAyB,CAAC,WAAW,GAAG,IAAI,CAAC;QAC9C,MAAM,KAAK,GAAG,IAAA,gBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzD,MAAM,KAAK,CAAC,2BAA2B,MAAM,EAAE,CAAC,CAAC;QACjD,MAAM,KAAK,CAAC,iCAAiC,MAAM,EAAE,CAAC,CAAC;QACvD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,UAA+B;QAC5C,MAAM,UAAU,EAAE,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,IAAA,gBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IACnD,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC9B,iBAAyC;QAEzC,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;QACnD,MAAM,IAAI,GAAG,gBAAgB,CAAC;YAC5B,IAAI,EAAE,iBAAiB,CAAC,IAAI;YAC5B,IAAI,EAAE,iBAAiB,CAAC,IAAI;YAC5B,IAAI,EAAE,iBAAiB,CAAC,QAAQ;YAChC,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;SACrC,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,IAAA,gBAAS,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,MAAM,OAAO,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,qBAAqB,CAAC,QAAgB;QAC5C,OAAO,MAAM,GAAG,cAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;IACvE,CAAC;CACF;AA5CD,4CA4CC"}

package/lib/initializers/postgres-initializer.d.ts

@@ -0,0 +1,10 @@
+import { PostgresConnectionOptions } from "typeorm/driver/postgres/PostgresConnectionOptions";
+import { TestDbInitializer } from "./test-db-initializer";
+export declare class PostgresInitializer implements TestDbInitializer<PostgresConnectionOptions> {
+    private client;
+    init(testFileName: string, connectionOptions: PostgresConnectionOptions): Promise<PostgresConnectionOptions>;
+    populate(populateFn: () => Promise<void>): Promise<void>;
+    destroy(): void | Promise<void>;
+    private getPostgresConnection;
+    private getDbNameFromFilename;
+}

package/lib/initializers/postgres-initializer.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostgresInitializer = void 0;
+const path_1 = __importDefault(require("path"));
+class PostgresInitializer {
+    async init(testFileName, connectionOptions) {
+        const dbName = this.getDbNameFromFilename(testFileName);
+        connectionOptions.database = dbName;
+        connectionOptions.synchronize = true;
+        this.client = await this.getPostgresConnection(connectionOptions);
+        await this.client.query(`DROP DATABASE IF EXISTS ${dbName}`);
+        await this.client.query(`CREATE DATABASE ${dbName}`);
+        return connectionOptions;
+    }
+    async populate(populateFn) {
+        await populateFn();
+    }
+    destroy() {
+        return this.client.end();
+    }
+    async getPostgresConnection(connectionOptions) {
+        const { Client } = require("pg");
+        const client = new Client({
+            host: connectionOptions.host,
+            port: connectionOptions.port,
+            user: connectionOptions.username,
+            password: connectionOptions.password,
+            database: "postgres",
+        });
+        await client.connect();
+        return client;
+    }
+    getDbNameFromFilename(filename) {
+        return "e2e_" + path_1.default.basename(filename).replace(/[^a-z0-9_]/gi, "_");
+    }
+}
+exports.PostgresInitializer = PostgresInitializer;
+//# sourceMappingURL=postgres-initializer.js.map

package/lib/initializers/postgres-initializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgres-initializer.js","sourceRoot":"","sources":["../../src/initializers/postgres-initializer.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAKxB,MAAa,mBAAmB;IAG9B,KAAK,CAAC,IAAI,CACR,YAAoB,EACpB,iBAA4C;QAE5C,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QACvD,iBAAyB,CAAC,QAAQ,GAAG,MAAM,CAAC;QAC5C,iBAAyB,CAAC,WAAW,GAAG,IAAI,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;QAClE,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,MAAM,EAAE,CAAC,CAAC;QAC7D,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC;QACrD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,UAA+B;QAC5C,MAAM,UAAU,EAAE,CAAC;IACrB,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;IAC3B,CAAC;IAEO,KAAK,CAAC,qBAAqB,CACjC,iBAA4C;QAE5C,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;YACxB,IAAI,EAAE,iBAAiB,CAAC,IAAI;YAC5B,IAAI,EAAE,iBAAiB,CAAC,IAAI;YAC5B,IAAI,EAAE,iBAAiB,CAAC,QAAQ;YAChC,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;YACpC,QAAQ,EAAE,UAAU;SACrB,CAAC,CAAC;QACH,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,qBAAqB,CAAC,QAAgB;QAC5C,OAAO,MAAM,GAAG,cAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;IACvE,CAAC;CACF;AA1CD,kDA0CC"}

package/lib/initializers/sqljs-initializer.d.ts

@@ -0,0 +1,19 @@
+import { SqljsConnectionOptions } from "typeorm/driver/sqljs/SqljsConnectionOptions";
+import { TestDbInitializer } from "./test-db-initializer";
+export declare class SqljsInitializer implements TestDbInitializer<SqljsConnectionOptions> {
+    private dataDir;
+    private postPopulateTimeoutMs;
+    private dbFilePath;
+    private connectionOptions;
+    /**
+     * @param dataDir
+     * @param postPopulateTimeoutMs Allows you to specify a timeout to wait after the population
+     * step and before the server is shut down. Can resolve occasional race condition issues with
+     * the job queue.
+     */
+    constructor(dataDir: string, postPopulateTimeoutMs?: number);
+    init(testFileName: string, connectionOptions: SqljsConnectionOptions): Promise<SqljsConnectionOptions>;
+    populate(populateFn: () => Promise<void>): Promise<void>;
+    destroy(): void | Promise<void>;
+    private getDbFilePath;
+}

package/lib/initializers/sqljs-initializer.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SqljsInitializer = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+class SqljsInitializer {
+    /**
+     * @param dataDir
+     * @param postPopulateTimeoutMs Allows you to specify a timeout to wait after the population
+     * step and before the server is shut down. Can resolve occasional race condition issues with
+     * the job queue.
+     */
+    constructor(dataDir, postPopulateTimeoutMs = 0) {
+        this.dataDir = dataDir;
+        this.postPopulateTimeoutMs = postPopulateTimeoutMs;
+    }
+    async init(testFileName, connectionOptions) {
+        this.dbFilePath = this.getDbFilePath(testFileName);
+        this.connectionOptions = connectionOptions;
+        connectionOptions.location =
+            this.dbFilePath;
+        return connectionOptions;
+    }
+    async populate(populateFn) {
+        if (!fs_1.default.existsSync(this.dbFilePath)) {
+            const dirName = path_1.default.dirname(this.dbFilePath);
+            if (!fs_1.default.existsSync(dirName)) {
+                fs_1.default.mkdirSync(dirName);
+            }
+            this.connectionOptions.autoSave =
+                true;
+            this.connectionOptions.synchronize =
+                true;
+            await populateFn();
+            await new Promise((resolve) => setTimeout(resolve, this.postPopulateTimeoutMs));
+            this.connectionOptions.autoSave =
+                false;
+            this.connectionOptions.synchronize =
+                false;
+        }
+    }
+    destroy() {
+        return undefined;
+    }
+    getDbFilePath(testFileName) {
+        const dbFileName = path_1.default.basename(testFileName) + ".sqlite";
+        const dbFilePath = path_1.default.join(this.dataDir, dbFileName);
+        return dbFilePath;
+    }
+}
+exports.SqljsInitializer = SqljsInitializer;
+//# sourceMappingURL=sqljs-initializer.js.map

package/lib/initializers/sqljs-initializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqljs-initializer.js","sourceRoot":"","sources":["../../src/initializers/sqljs-initializer.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAOxB,MAAa,gBAAgB;IAI3B;;;;;OAKG;IACH,YACU,OAAe,EACf,wBAAgC,CAAC;QADjC,YAAO,GAAP,OAAO,CAAQ;QACf,0BAAqB,GAArB,qBAAqB,CAAY;IACxC,CAAC;IAEJ,KAAK,CAAC,IAAI,CACR,YAAoB,EACpB,iBAAyC;QAEzC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QACnD,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC1C,iBAAqD,CAAC,QAAQ;YAC7D,IAAI,CAAC,UAAU,CAAC;QAClB,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,UAA+B;QAC5C,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACpC,MAAM,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC9C,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5B,YAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACxB,CAAC;YACA,IAAI,CAAC,iBAAqD,CAAC,QAAQ;gBAClE,IAAI,CAAC;YACN,IAAI,CAAC,iBAAqD,CAAC,WAAW;gBACrE,IAAI,CAAC;YACP,MAAM,UAAU,EAAE,CAAC;YACnB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAC5B,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAChD,CAAC;YACD,IAAI,CAAC,iBAAqD,CAAC,QAAQ;gBAClE,KAAK,CAAC;YACP,IAAI,CAAC,iBAAqD,CAAC,WAAW;gBACrE,KAAK,CAAC;QACV,CAAC;IACH,CAAC;IAED,OAAO;QACL,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,aAAa,CAAC,YAAoB;QACxC,MAAM,UAAU,GAAG,cAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;QAC3D,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACvD,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAxDD,4CAwDC"}

package/lib/initializers/test-db-initializer.d.ts

@@ -0,0 +1,42 @@
+import { BaseConnectionOptions } from "typeorm/connection/BaseConnectionOptions";
+/**
+ * @description
+ * Defines how the e2e TestService sets up a particular DB to run a single test suite.
+ * The `\@deenruv/testing` package ships with initializers for sql.js, MySQL & Postgres.
+ *
+ * Custom initializers can be created by implementing this interface and registering
+ * it with the {@link registerInitializer} function:
+ *
+ * @example
+ * ```ts
+ * export class CockroachDbInitializer implements TestDbInitializer<CockroachConnectionOptions> {
+ *     // database-specific implementation goes here
+ * }
+ *
+ * registerInitializer('cockroachdb', new CockroachDbInitializer());
+ * ```
+ *
+ * @docsCategory testing
+ */
+export interface TestDbInitializer<T extends BaseConnectionOptions> {
+    /**
+     * @description
+     * Responsible for creating a database for the current test suite.
+     * Typically, this method will:
+     *
+     * * use the testFileName parameter to derive a database name
+     * * create the database
+     * * mutate the `connetionOptions` object to point to that new database
+     */
+    init(testFileName: string, connectionOptions: T): Promise<T>;
+    /**
+     * @description
+     * Execute the populateFn to populate your database.
+     */
+    populate(populateFn: () => Promise<void>): Promise<void>;
+    /**
+     * @description
+     * Clean up any resources used during the init() phase (i.e. close open DB connections)
+     */
+    destroy(): void | Promise<void>;
+}

package/lib/initializers/test-db-initializer.js

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

package/lib/initializers/test-db-initializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-db-initializer.js","sourceRoot":"","sources":["../../src/initializers/test-db-initializer.ts"],"names":[],"mappings":""}

package/lib/simple-graphql-client.d.ts

@@ -0,0 +1,86 @@
+import { TypedDocumentNode } from "@graphql-typed-document-node/core";
+import { DeenruvConfig } from "@deenruv/core";
+import { DocumentNode } from "graphql";
+import { RequestInit, Response } from "node-fetch";
+import { QueryParams } from "./types";
+/**
+ * @description
+ * A minimalistic GraphQL client for populating and querying test data.
+ *
+ * @docsCategory testing
+ */
+export declare class SimpleGraphQLClient {
+    private deenruvConfig;
+    private apiUrl;
+    private authToken;
+    private channelToken;
+    private headers;
+    constructor(deenruvConfig: Required<DeenruvConfig>, apiUrl?: string);
+    /**
+     * @description
+     * Sets the authToken to be used in each GraphQL request.
+     */
+    setAuthToken(token: string): void;
+    /**
+     * @description
+     * Sets the authToken to be used in each GraphQL request.
+     */
+    setChannelToken(token: string | null): void;
+    /**
+     * @description
+     * Returns the authToken currently being used.
+     */
+    getAuthToken(): string;
+    /**
+     * @description
+     * Performs both query and mutation operations.
+     */
+    query<T = any, V extends Record<string, any> = Record<string, any>>(query: DocumentNode | TypedDocumentNode<T, V>, variables?: V, queryParams?: QueryParams): Promise<T>;
+    /**
+     * @description
+     * Performs a raw HTTP request to the given URL, but also includes the authToken & channelToken
+     * headers if they have been set. Useful for testing non-GraphQL endpoints, e.g. for plugins
+     * which make use of REST controllers.
+     */
+    fetch(url: string, options?: RequestInit): Promise<Response>;
+    /**
+     * @description
+     * Performs a query or mutation and returns the resulting status code.
+     */
+    queryStatus<T = any, V extends Record<string, any> = Record<string, any>>(query: DocumentNode, variables?: V): Promise<number>;
+    /**
+     * @description
+     * Attempts to log in with the specified credentials.
+     */
+    asUserWithCredentials(username: string, password: string): Promise<any>;
+    /**
+     * @description
+     * Logs in as the SuperAdmin user.
+     */
+    asSuperAdmin(): Promise<void>;
+    /**
+     * @description
+     * Logs out so that the client is then treated as an anonymous user.
+     */
+    asAnonymousUser(): Promise<void>;
+    private makeGraphQlRequest;
+    private getResult;
+    /**
+     * @description
+     * Perform a file upload mutation.
+     *
+     * Upload spec: https://github.com/jaydenseric/graphql-multipart-request-spec
+     * Discussion of issue: https://github.com/jaydenseric/apollo-upload-client/issues/32
+     */
+    fileUploadMutation(options: {
+        mutation: DocumentNode;
+        filePaths: string[];
+        mapVariables: (filePaths: string[]) => any;
+    }): Promise<any>;
+}
+export declare class ClientError extends Error {
+    response: any;
+    request: any;
+    constructor(response: any, request: any);
+    private static extractMessage;
+}