@deenruv/core 1.0.0

package/dist/migrate.js

@@ -0,0 +1,239 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateMigration = exports.revertLastMigration = exports.runMigrations = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const picocolors_1 = __importDefault(require("picocolors"));
+const typeorm_1 = require("typeorm");
+const MysqlDriver_1 = require("typeorm/driver/mysql/MysqlDriver");
+const StringUtils_1 = require("typeorm/util/StringUtils");
+const bootstrap_1 = require("./bootstrap");
+const config_helpers_1 = require("./config/config-helpers");
+/**
+ * @description
+ * Runs any pending database migrations. See [TypeORM migration docs](https://typeorm.io/#/migrations)
+ * for more information about the underlying migration mechanism.
+ *
+ * @docsCategory migration
+ */
+async function runMigrations(userConfig) {
+    const config = await (0, bootstrap_1.preBootstrapConfig)(userConfig);
+    const dataSource = new typeorm_1.DataSource(createConnectionOptions(config));
+    for (const hook of config.dataSourceHooks || []) {
+        await hook(dataSource);
+    }
+    const connection = await dataSource.initialize();
+    const migrationsRan = [];
+    try {
+        const migrations = await disableForeignKeysForSqLite(connection, () => connection.runMigrations({ transaction: "each" }));
+        for (const migration of migrations) {
+            log(picocolors_1.default.green(`Successfully ran migration: ${migration.name}`));
+            migrationsRan.push(migration.name);
+        }
+    }
+    catch (e) {
+        log(picocolors_1.default.red("An error occurred when running migrations:"));
+        log(e.message);
+        if (isRunningFromDeenruvCli()) {
+            throw e;
+        }
+        else {
+            process.exitCode = 1;
+        }
+    }
+    finally {
+        await checkMigrationStatus(connection);
+        await connection.close();
+        (0, config_helpers_1.resetConfig)();
+    }
+    return migrationsRan;
+}
+exports.runMigrations = runMigrations;
+async function checkMigrationStatus(dataSource) {
+    const builderLog = await dataSource.driver.createSchemaBuilder().log();
+    if (builderLog.upQueries.length) {
+        log(picocolors_1.default.yellow("Your database schema does not match your current configuration. Generate a new migration for the following changes:"));
+        for (const query of builderLog.upQueries) {
+            log(" - " + picocolors_1.default.yellow(query.query));
+        }
+    }
+}
+/**
+ * @description
+ * Reverts the last applied database migration. See [TypeORM migration docs](https://typeorm.io/#/migrations)
+ * for more information about the underlying migration mechanism.
+ *
+ * @docsCategory migration
+ */
+async function revertLastMigration(userConfig) {
+    const config = await (0, bootstrap_1.preBootstrapConfig)(userConfig);
+    const dataSource = new typeorm_1.DataSource(createConnectionOptions(config));
+    for (const hook of config.dataSourceHooks || []) {
+        await hook(dataSource);
+    }
+    const connection = await dataSource.initialize();
+    for (const hook of config.dataSourceHooks || []) {
+        await hook(connection);
+    }
+    try {
+        await disableForeignKeysForSqLite(connection, () => connection.undoLastMigration({ transaction: "each" }));
+    }
+    catch (e) {
+        log(picocolors_1.default.red("An error occurred when reverting migration:"));
+        log(e.message);
+        if (isRunningFromDeenruvCli()) {
+            throw e;
+        }
+        else {
+            process.exitCode = 1;
+        }
+    }
+    finally {
+        await connection.close();
+        (0, config_helpers_1.resetConfig)();
+    }
+}
+exports.revertLastMigration = revertLastMigration;
+/**
+ * @description
+ * Generates a new migration file based on any schema changes (e.g. adding or removing CustomFields).
+ * See [TypeORM migration docs](https://typeorm.io/#/migrations) for more information about the
+ * underlying migration mechanism.
+ *
+ * @docsCategory migration
+ */
+async function generateMigration(userConfig, options) {
+    const config = await (0, bootstrap_1.preBootstrapConfig)(userConfig);
+    const dataSource = new typeorm_1.DataSource(createConnectionOptions(config));
+    for (const hook of config.dataSourceHooks || []) {
+        await hook(dataSource);
+    }
+    const connection = await dataSource.initialize();
+    for (const hook of config.dataSourceHooks || []) {
+        await hook(connection);
+    }
+    // TODO: This can hopefully be simplified if/when TypeORM exposes this CLI command directly.
+    // See https://github.com/typeorm/typeorm/issues/4494
+    const sqlInMemory = await connection.driver.createSchemaBuilder().log();
+    const upSqls = [];
+    const downSqls = [];
+    let migrationName;
+    // mysql is exceptional here because it uses ` character in to escape names in queries, that's why for mysql
+    // we are using simple quoted string instead of template string syntax
+    if (connection.driver instanceof MysqlDriver_1.MysqlDriver) {
+        sqlInMemory.upQueries.forEach((upQuery) => {
+            upSqls.push('        await queryRunner.query("' +
+                upQuery.query.replace(new RegExp('"', "g"), '\\"') +
+                '", ' +
+                JSON.stringify(upQuery.parameters) +
+                ");");
+        });
+        sqlInMemory.downQueries.forEach((downQuery) => {
+            downSqls.push('        await queryRunner.query("' +
+                downQuery.query.replace(new RegExp('"', "g"), '\\"') +
+                '", ' +
+                JSON.stringify(downQuery.parameters) +
+                ");");
+        });
+    }
+    else {
+        sqlInMemory.upQueries.forEach((upQuery) => {
+            upSqls.push("        await queryRunner.query(`" +
+                upQuery.query.replace(new RegExp("`", "g"), "\\`") +
+                "`, " +
+                JSON.stringify(upQuery.parameters) +
+                ");");
+        });
+        sqlInMemory.downQueries.forEach((downQuery) => {
+            downSqls.push("        await queryRunner.query(`" +
+                downQuery.query.replace(new RegExp("`", "g"), "\\`") +
+                "`, " +
+                JSON.stringify(downQuery.parameters) +
+                ");");
+        });
+    }
+    if (upSqls.length) {
+        if (options.name) {
+            const timestamp = new Date().getTime();
+            const filename = timestamp.toString() + "-" + options.name + ".ts";
+            const directory = options.outputDir;
+            const fileContent = getTemplate(options.name, timestamp, upSqls, downSqls.reverse());
+            const outputPath = directory
+                ? path_1.default.join(directory, filename)
+                : path_1.default.join(process.cwd(), filename);
+            await fs_extra_1.default.ensureFile(outputPath);
+            fs_extra_1.default.writeFileSync(outputPath, fileContent);
+            log(picocolors_1.default.green(`Migration ${picocolors_1.default.blue(outputPath)} has been generated successfully.`));
+            migrationName = outputPath;
+        }
+    }
+    else {
+        log(picocolors_1.default.yellow("No changes in database schema were found - cannot generate a migration."));
+    }
+    await connection.close();
+    (0, config_helpers_1.resetConfig)();
+    return migrationName;
+}
+exports.generateMigration = generateMigration;
+function createConnectionOptions(userConfig) {
+    return Object.assign({ logging: ["query", "error", "schema"] }, userConfig.dbConnectionOptions, {
+        subscribers: [],
+        synchronize: false,
+        migrationsRun: false,
+        dropSchema: false,
+        logger: "advanced-console",
+    });
+}
+/**
+ * There is a bug in TypeORM which causes db schema changes to fail with SQLite. This
+ * is a work-around for the issue.
+ * See https://github.com/typeorm/typeorm/issues/2576#issuecomment-499506647
+ */
+async function disableForeignKeysForSqLite(connection, work) {
+    const isSqLite = connection.options.type === "sqlite" ||
+        connection.options.type === "better-sqlite3";
+    if (isSqLite) {
+        await connection.query("PRAGMA foreign_keys=OFF");
+    }
+    const result = await work();
+    if (isSqLite) {
+        await connection.query("PRAGMA foreign_keys=ON");
+    }
+    return result;
+}
+/**
+ * Gets contents of the migration file.
+ */
+function getTemplate(name, timestamp, upSqls, downSqls) {
+    return `import {MigrationInterface, QueryRunner} from "typeorm";
+
+export class ${(0, StringUtils_1.camelCase)(name, true)}${timestamp} implements MigrationInterface {
+
+   public async up(queryRunner: QueryRunner): Promise<void> {
+${upSqls.join(`
+`)}
+   }
+
+   public async down(queryRunner: QueryRunner): Promise<void> {
+${downSqls.join(`
+`)}
+   }
+
+}
+`;
+}
+function log(message) {
+    // If running from within the Deenruv CLI, we allow the CLI app
+    // to handle the logging.
+    if (isRunningFromDeenruvCli()) {
+        return;
+    }
+    console.log(message);
+}
+function isRunningFromDeenruvCli() {
+    return process.env.DEENRUV_RUNNING_IN_CLI != null;
+}
+//# sourceMappingURL=migrate.js.map

package/dist/migrate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrate.js","sourceRoot":"","sources":["../src/migrate.ts"],"names":[],"mappings":";;;;;;AAAA,wDAA0B;AAC1B,gDAAwB;AACxB,4DAA4B;AAC5B,qCAAwD;AACxD,kEAA+D;AAC/D,0DAAqD;AAErD,2CAAiD;AACjD,4DAAsD;AAuBtD;;;;;;GAMG;AACI,KAAK,UAAU,aAAa,CACjC,UAAkC;IAElC,MAAM,MAAM,GAAG,MAAM,IAAA,8BAAkB,EAAC,UAAU,CAAC,CAAC;IACpD,MAAM,UAAU,GAAG,IAAI,oBAAU,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,eAAe,IAAI,EAAE,EAAE,CAAC;QAChD,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;IACjD,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,MAAM,2BAA2B,CAAC,UAAU,EAAE,GAAG,EAAE,CACpE,UAAU,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAClD,CAAC;QACF,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,GAAG,CAAC,oBAAE,CAAC,KAAK,CAAC,+BAA+B,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAC/D,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,GAAG,CAAC,oBAAE,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC,CAAC;QAC1D,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,uBAAuB,EAAE,EAAE,CAAC;YAC9B,MAAM,CAAC,CAAC;QACV,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;YAAS,CAAC;QACT,MAAM,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACvC,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;QACzB,IAAA,4BAAW,GAAE,CAAC;IAChB,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAhCD,sCAgCC;AAED,KAAK,UAAU,oBAAoB,CAAC,UAAsB;IACxD,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC,GAAG,EAAE,CAAC;IACvE,IAAI,UAAU,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QAChC,GAAG,CACD,oBAAE,CAAC,MAAM,CACP,qHAAqH,CACtH,CACF,CAAC;QACF,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,SAAS,EAAE,CAAC;YACzC,GAAG,CAAC,KAAK,GAAG,oBAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,mBAAmB,CAAC,UAAkC;IAC1E,MAAM,MAAM,GAAG,MAAM,IAAA,8BAAkB,EAAC,UAAU,CAAC,CAAC;IACpD,MAAM,UAAU,GAAG,IAAI,oBAAU,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,eAAe,IAAI,EAAE,EAAE,CAAC;QAChD,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;IACjD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,eAAe,IAAI,EAAE,EAAE,CAAC;QAChD,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IACD,IAAI,CAAC;QACH,MAAM,2BAA2B,CAAC,UAAU,EAAE,GAAG,EAAE,CACjD,UAAU,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CACtD,CAAC;IACJ,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,GAAG,CAAC,oBAAE,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC,CAAC;QAC3D,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,uBAAuB,EAAE,EAAE,CAAC;YAC9B,MAAM,CAAC,CAAC;QACV,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;YAAS,CAAC;QACT,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;QACzB,IAAA,4BAAW,GAAE,CAAC;IAChB,CAAC;AACH,CAAC;AA1BD,kDA0BC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,iBAAiB,CACrC,UAAkC,EAClC,OAAyB;IAEzB,MAAM,MAAM,GAAG,MAAM,IAAA,8BAAkB,EAAC,UAAU,CAAC,CAAC;IACpD,MAAM,UAAU,GAAG,IAAI,oBAAU,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,eAAe,IAAI,EAAE,EAAE,CAAC;QAChD,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;IACjD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,eAAe,IAAI,EAAE,EAAE,CAAC;QAChD,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IACD,4FAA4F;IAC5F,qDAAqD;IACrD,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC,GAAG,EAAE,CAAC;IACxE,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,aAAiC,CAAC;IAEtC,4GAA4G;IAC5G,sEAAsE;IACtE,IAAI,UAAU,CAAC,MAAM,YAAY,yBAAW,EAAE,CAAC;QAC7C,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACxC,MAAM,CAAC,IAAI,CACT,mCAAmC;gBACjC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC;gBAClD,KAAK;gBACL,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC;gBAClC,IAAI,CACP,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC5C,QAAQ,CAAC,IAAI,CACX,mCAAmC;gBACjC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC;gBACpD,KAAK;gBACL,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC;gBACpC,IAAI,CACP,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACxC,MAAM,CAAC,IAAI,CACT,mCAAmC;gBACjC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC;gBAClD,KAAK;gBACL,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC;gBAClC,IAAI,CACP,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC5C,QAAQ,CAAC,IAAI,CACX,mCAAmC;gBACjC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC;gBACpD,KAAK;gBACL,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC;gBACpC,IAAI,CACP,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YACvC,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,GAAG,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC;YACnE,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;YACpC,MAAM,WAAW,GAAG,WAAW,CAC7B,OAAO,CAAC,IAAW,EACnB,SAAS,EACT,MAAM,EACN,QAAQ,CAAC,OAAO,EAAE,CACnB,CAAC;YACF,MAAM,UAAU,GAAG,SAAS;gBAC1B,CAAC,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC;gBAChC,CAAC,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC;YACvC,MAAM,kBAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAChC,kBAAE,CAAC,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;YAE1C,GAAG,CACD,oBAAE,CAAC,KAAK,CACN,aAAa,oBAAE,CAAC,IAAI,CAAC,UAAU,CAAC,mCAAmC,CACpE,CACF,CAAC;YACF,aAAa,GAAG,UAAU,CAAC;QAC7B,CAAC;IACH,CAAC;SAAM,CAAC;QACN,GAAG,CACD,oBAAE,CAAC,MAAM,CACP,yEAAyE,CAC1E,CACF,CAAC;IACJ,CAAC;IACD,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;IACzB,IAAA,4BAAW,GAAE,CAAC;IACd,OAAO,aAAa,CAAC;AACvB,CAAC;AAhGD,8CAgGC;AAED,SAAS,uBAAuB,CAC9B,UAAkC;IAElC,OAAO,MAAM,CAAC,MAAM,CAClB,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,EACzC,UAAU,CAAC,mBAAmB,EAC9B;QACE,WAAW,EAAE,EAAE;QACf,WAAW,EAAE,KAAK;QAClB,aAAa,EAAE,KAAK;QACpB,UAAU,EAAE,KAAK;QACjB,MAAM,EAAE,kBAAkB;KAC3B,CACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,2BAA2B,CACxC,UAAsB,EACtB,IAAsB;IAEtB,MAAM,QAAQ,GACZ,UAAU,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ;QACpC,UAAU,CAAC,OAAO,CAAC,IAAI,KAAK,gBAAgB,CAAC;IAC/C,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,UAAU,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACpD,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;IAC5B,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,UAAU,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAClB,IAAY,EACZ,SAAiB,EACjB,MAAgB,EAChB,QAAkB;IAElB,OAAO;;eAEM,IAAA,uBAAS,EAAC,IAAI,EAAE,IAAI,CAAC,GAAG,SAAS;;;EAG9C,MAAM,CAAC,IAAI,CAAC;CACb,CAAC;;;;EAIA,QAAQ,CAAC,IAAI,CAAC;CACf,CAAC;;;;CAID,CAAC;AACF,CAAC;AAED,SAAS,GAAG,CAAC,OAAe;IAC1B,+DAA+D;IAC/D,yBAAyB;IACzB,IAAI,uBAAuB,EAAE,EAAE,CAAC;QAC9B,OAAO;IACT,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AACvB,CAAC;AAED,SAAS,uBAAuB;IAC9B,OAAO,OAAO,CAAC,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC;AACpD,CAAC"}

package/dist/plugin/deenruv-plugin.d.ts

@@ -0,0 +1,138 @@
+import { ModuleMetadata } from "@nestjs/common/interfaces";
+import { Type } from "@deenruv/common/lib/shared-types";
+import { DocumentNode, GraphQLScalarType } from "graphql";
+import { RuntimeDeenruvConfig } from "../config/deenruv-config";
+/**
+ * @description
+ * Defines the metadata of a Deenruv plugin. This interface is an superset of the [Nestjs ModuleMetadata](https://docs.nestjs.com/modules)
+ * (which allows the definition of `imports`, `exports`, `providers` and `controllers`), which means
+ * that any Nestjs Module is a valid Deenruv plugin. In addition, the DeenruvPluginMetadata allows the definition of
+ * extra properties specific to Deenruv.
+ *
+ * @docsCategory plugin
+ * @docsPage DeenruvPluginMetadata
+ */
+export interface DeenruvPluginMetadata extends ModuleMetadata {
+    /**
+     * @description
+     * A function which can modify the {@link DeenruvConfig} object before the server bootstraps.
+     */
+    configuration?: PluginConfigurationFn;
+    /**
+     * @description
+     * The plugin may extend the default Deenruv GraphQL shop api by providing extended
+     * schema definitions and any required resolvers.
+     */
+    shopApiExtensions?: APIExtensionDefinition;
+    /**
+     * @description
+     * The plugin may extend the default Deenruv GraphQL admin api by providing extended
+     * schema definitions and any required resolvers.
+     */
+    adminApiExtensions?: APIExtensionDefinition;
+    /**
+     * @description
+     * The plugin may define custom [TypeORM database entities](https://typeorm.io/#/entities).
+     */
+    entities?: Array<Type<any>> | (() => Array<Type<any>>);
+    /**
+     * @description
+     * The plugin should define a valid [semver version string](https://www.npmjs.com/package/semver) to indicate which versions of
+     * Deenruv core it is compatible with. Attempting to use a plugin with an incompatible
+     * version of Deenruv will result in an error and the server will be unable to bootstrap.
+     *
+     * If a plugin does not define this property, a message will be logged on bootstrap that the plugin is not
+     * guaranteed to be compatible with the current version of Deenruv.
+     *
+     * To effectively disable this check for a plugin, you can use an overly-permissive string such as `>0.0.0`.
+     *
+     * @example
+     * ```ts
+     * compatibility: '^2.0.0'
+     * ```
+     *
+     * @since 2.0.0
+     */
+    compatibility?: string;
+}
+/**
+ * @description
+ * An object which allows a plugin to extend the Deenruv GraphQL API.
+ *
+ * @docsCategory plugin
+ * @docsPage DeenruvPluginMetadata
+ * */
+export interface APIExtensionDefinition {
+    /**
+     * @description
+     * Extensions to the schema.
+     *
+     * @example
+     * ```ts
+     * const schema = gql`extend type SearchReindexResponse {
+     *     timeTaken: Int!
+     *     indexedItemCount: Int!
+     * }`;
+     * ```
+     */
+    schema?: DocumentNode | (() => DocumentNode | undefined);
+    /**
+     * @description
+     * An array of resolvers for the schema extensions. Should be defined as [Nestjs GraphQL resolver](https://docs.nestjs.com/graphql/resolvers-map)
+     * classes, i.e. using the Nest `\@Resolver()` decorator etc.
+     */
+    resolvers?: Array<Type<any>> | (() => Array<Type<any>>);
+    /**
+     * @description
+     * A map of GraphQL scalar types which should correspond to any custom scalars defined in your schema.
+     * Read more about defining custom scalars in the
+     * [Apollo Server Custom Scalars docs](https://www.apollographql.com/docs/apollo-server/schema/custom-scalars)
+     *
+     * @since 1.7.0
+     */
+    scalars?: Record<string, GraphQLScalarType> | (() => Record<string, GraphQLScalarType>);
+}
+/**
+ * @description
+ * This method is called before the app bootstraps and should be used to perform any needed modifications to the {@link DeenruvConfig}.
+ *
+ * @docsCategory plugin
+ * @docsPage DeenruvPluginMetadata
+ */
+export type PluginConfigurationFn = (config: RuntimeDeenruvConfig) => RuntimeDeenruvConfig | Promise<RuntimeDeenruvConfig>;
+/**
+ * @description
+ * The DeenruvPlugin decorator is a means of configuring and/or extending the functionality of the Deenruv server. A Deenruv plugin is
+ * a [Nestjs Module](https://docs.nestjs.com/modules), with optional additional metadata defining things like extensions to the GraphQL API, custom
+ * configuration or new database entities.
+ *
+ * As well as configuring the app, a plugin may also extend the GraphQL schema by extending existing types or adding
+ * entirely new types. Database entities and resolvers can also be defined to handle the extended GraphQL types.
+ *
+ * @example
+ * ```ts
+ * import { Controller, Get } from '\@nestjs/common';
+ * import { Ctx, PluginCommonModule, ProductService, RequestContext, DeenruvPlugin } from '\@deenruv/core';
+ *
+ * \@Controller('products')
+ * export class ProductsController {
+ *     constructor(private productService: ProductService) {}
+ *
+ *     \@Get()
+ *     findAll(\@Ctx() ctx: RequestContext) {
+ *         return this.productService.findAll(ctx);
+ *     }
+ * }
+ *
+ *
+ * //A simple plugin which adds a REST endpoint for querying products.
+ * \@DeenruvPlugin({
+ *     imports: [PluginCommonModule],
+ *     controllers: [ProductsController],
+ * })
+ * export class RestPlugin {}
+ * ```
+ *
+ * @docsCategory plugin
+ */
+export declare function DeenruvPlugin(pluginMetadata: DeenruvPluginMetadata): ClassDecorator;

package/dist/plugin/deenruv-plugin.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeenruvPlugin = void 0;
+const common_1 = require("@nestjs/common");
+const constants_1 = require("@nestjs/common/constants");
+const core_1 = require("@nestjs/core");
+const pick_1 = require("@deenruv/common/lib/pick");
+const plugin_metadata_1 = require("./plugin-metadata");
+/**
+ * @description
+ * The DeenruvPlugin decorator is a means of configuring and/or extending the functionality of the Deenruv server. A Deenruv plugin is
+ * a [Nestjs Module](https://docs.nestjs.com/modules), with optional additional metadata defining things like extensions to the GraphQL API, custom
+ * configuration or new database entities.
+ *
+ * As well as configuring the app, a plugin may also extend the GraphQL schema by extending existing types or adding
+ * entirely new types. Database entities and resolvers can also be defined to handle the extended GraphQL types.
+ *
+ * @example
+ * ```ts
+ * import { Controller, Get } from '\@nestjs/common';
+ * import { Ctx, PluginCommonModule, ProductService, RequestContext, DeenruvPlugin } from '\@deenruv/core';
+ *
+ * \@Controller('products')
+ * export class ProductsController {
+ *     constructor(private productService: ProductService) {}
+ *
+ *     \@Get()
+ *     findAll(\@Ctx() ctx: RequestContext) {
+ *         return this.productService.findAll(ctx);
+ *     }
+ * }
+ *
+ *
+ * //A simple plugin which adds a REST endpoint for querying products.
+ * \@DeenruvPlugin({
+ *     imports: [PluginCommonModule],
+ *     controllers: [ProductsController],
+ * })
+ * export class RestPlugin {}
+ * ```
+ *
+ * @docsCategory plugin
+ */
+function DeenruvPlugin(pluginMetadata) {
+    return (target) => {
+        for (const metadataProperty of Object.values(plugin_metadata_1.PLUGIN_METADATA)) {
+            const property = metadataProperty;
+            if (pluginMetadata[property] != null) {
+                Reflect.defineMetadata(property, pluginMetadata[property], target);
+            }
+        }
+        const nestModuleMetadata = (0, pick_1.pick)(pluginMetadata, Object.values(constants_1.MODULE_METADATA));
+        // Automatically add any of the Plugin's "providers" to the "exports" array. This is done
+        // because when a plugin defines GraphQL resolvers, these resolvers are used to dynamically
+        // created a new Module in the ApiModule, and if those resolvers depend on any providers,
+        // the must be exported. See the function {@link createDynamicGraphQlModulesForPlugins}
+        // for the implementation.
+        // However, we must omit any global providers (https://github.com/deenruv-ecommerce/deenruv/issues/837)
+        const nestGlobalProviderTokens = [
+            core_1.APP_INTERCEPTOR,
+            core_1.APP_FILTER,
+            core_1.APP_GUARD,
+            core_1.APP_PIPE,
+        ];
+        const exportedProviders = (nestModuleMetadata.providers || []).filter((provider) => {
+            if (isNamedProvider(provider)) {
+                if (nestGlobalProviderTokens.includes(provider.provide)) {
+                    return false;
+                }
+            }
+            return true;
+        });
+        nestModuleMetadata.exports = [
+            ...(nestModuleMetadata.exports || []),
+            ...exportedProviders,
+        ];
+        (0, common_1.Module)(nestModuleMetadata)(target);
+    };
+}
+exports.DeenruvPlugin = DeenruvPlugin;
+function isNamedProvider(provider) {
+    return provider.hasOwnProperty("provide");
+}
+//# sourceMappingURL=deenruv-plugin.js.map

package/dist/plugin/deenruv-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deenruv-plugin.js","sourceRoot":"","sources":["../../src/plugin/deenruv-plugin.ts"],"names":[],"mappings":";;;AAAA,2CAAoE;AACpE,wDAA2D;AAE3D,uCAAgF;AAChF,mDAAgD;AAMhD,uDAAoD;AA2GpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,SAAgB,aAAa,CAC3B,cAAqC;IAErC,OAAO,CAAC,MAAgB,EAAE,EAAE;QAC1B,KAAK,MAAM,gBAAgB,IAAI,MAAM,CAAC,MAAM,CAAC,iCAAe,CAAC,EAAE,CAAC;YAC9D,MAAM,QAAQ,GAAG,gBAA+C,CAAC;YACjE,IAAI,cAAc,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;gBACrC,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;QACD,MAAM,kBAAkB,GAAG,IAAA,WAAI,EAC7B,cAAc,EACd,MAAM,CAAC,MAAM,CAAC,2BAAe,CAAQ,CACtC,CAAC;QACF,yFAAyF;QACzF,2FAA2F;QAC3F,yFAAyF;QACzF,uFAAuF;QACvF,0BAA0B;QAC1B,uGAAuG;QACvG,MAAM,wBAAwB,GAAG;YAC/B,sBAAe;YACf,iBAAU;YACV,gBAAS;YACT,eAAQ;SACT,CAAC;QACF,MAAM,iBAAiB,GAAG,CAAC,kBAAkB,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CACnE,CAAC,QAAQ,EAAE,EAAE;YACX,IAAI,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC9B,IAAI,wBAAwB,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAc,CAAC,EAAE,CAAC;oBAC/D,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CACF,CAAC;QACF,kBAAkB,CAAC,OAAO,GAAG;YAC3B,GAAG,CAAC,kBAAkB,CAAC,OAAO,IAAI,EAAE,CAAC;YACrC,GAAG,iBAAiB;SACrB,CAAC;QACF,IAAA,eAAM,EAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC,CAAC;AACJ,CAAC;AA1CD,sCA0CC;AAED,SAAS,eAAe,CACtB,QAAkB;IAElB,OAAO,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;AAC5C,CAAC"}

package/dist/plugin/default-job-queue-plugin/default-job-queue-plugin.d.ts

@@ -0,0 +1,177 @@
+import { Type } from "@deenruv/common/lib/shared-types";
+import { Job } from "../../job-queue/job";
+import { BackoffStrategy } from "../../job-queue/polling-job-queue-strategy";
+/**
+ * @description
+ * Configuration options for the DefaultJobQueuePlugin. These values get passed into the
+ * {@link SqlJobQueueStrategy}.
+ *
+ * @docsCategory JobQueue
+ * @docsPage DefaultJobQueuePlugin
+ */
+export interface DefaultJobQueueOptions {
+    /**
+     * @description
+     * The interval in ms between polling the database for new jobs. If many job queues
+     * are active, the polling may cause undue load on the database, in which case this value
+     * should be increased to e.g. 1000.
+     *
+     * @default 200
+     */
+    pollInterval?: number | ((queueName: string) => number);
+    /**
+     * @description
+     * How many jobs from a given queue to process concurrently.
+     *
+     * @default 1
+     */
+    concurrency?: number;
+    /**
+     * @description
+     * The strategy used to decide how long to wait before retrying a failed job.
+     *
+     * @default () => 1000
+     */
+    backoffStrategy?: BackoffStrategy;
+    /**
+     * @description
+     * When a job is added to the JobQueue using `JobQueue.add()`, the calling
+     * code may specify the number of retries in case of failure. This option allows
+     * you to override that number and specify your own number of retries based on
+     * the job being added.
+     *
+     * @example
+     * ```ts
+     * setRetries: (queueName, job) => {
+     *   if (queueName === 'send-email') {
+     *     // Override the default number of retries
+     *     // for the 'send-email' job because we have
+     *     // a very unreliable email service.
+     *     return 10;
+     *   }
+     *   return job.retries;
+     * }
+     *  ```
+     * @param queueName
+     * @param job
+     */
+    setRetries?: (queueName: string, job: Job) => number;
+    /**
+     * @description
+     * If set to `true`, the database will be used to store buffered jobs. This is
+     * recommended for production.
+     *
+     * When enabled, a new `JobRecordBuffer` database entity will be defined which will
+     * require a migration when first enabling this option.
+     *
+     * @since 1.3.0
+     */
+    useDatabaseForBuffer?: boolean;
+    /**
+     * @description
+     * The timeout in ms which the queue will use when attempting a graceful shutdown.
+     * That means when the server is shut down but a job is running, the job queue will
+     * wait for the job to complete before allowing the server to shut down. If the job
+     * does not complete within this timeout window, the job will be forced to stop
+     * and the server will shut down anyway.
+     *
+     * @since 2.2.0
+     * @default 20_000
+     */
+    gracefulShutdownTimeout?: number;
+}
+/**
+ * @description
+ * A plugin which configures Deenruv to use the SQL database to persist the JobQueue jobs using the {@link SqlJobQueueStrategy}. If you add this
+ * plugin to an existing Deenruv installation, you'll need to run a [database migration](/guides/developer-guide/migrations), since this
+ * plugin will add a new "job_record" table to the database.
+ *
+ * @example
+ * ```ts
+ * import { DefaultJobQueuePlugin, DeenruvConfig } from '\@deenruv/core';
+ *
+ * export const config: DeenruvConfig = {
+ *   // Add an instance of the plugin to the plugins array
+ *   plugins: [
+ *     DefaultJobQueuePlugin,
+ *   ],
+ * };
+ * ```
+ *
+ * ## Configuration
+ *
+ * It is possible to configure the behaviour of the {@link SqlJobQueueStrategy} by passing options to the static `init()` function:
+ *
+ * ### pollInterval
+ * The interval in ms between polling for new jobs. The default is 200ms.
+ * Using a longer interval reduces load on the database but results in a slight
+ * delay in processing jobs. For more control, it is possible to supply a function which can specify
+ * a pollInterval based on the queue name:
+ *
+ * @example
+ * ```ts
+ * export const config: DeenruvConfig = {
+ *   plugins: [
+ *     DefaultJobQueuePlugin.init({
+ *       pollInterval: queueName => {
+ *         if (queueName === 'cart-recovery-email') {
+ *           // This queue does not need to be polled so frequently,
+ *           // so we set a longer interval in order to reduce load
+ *           // on the database.
+ *           return 10000;
+ *         }
+ *         return 200;
+ *       },
+ *     }),
+ *   ],
+ * };
+ * ```
+ * ### concurrency
+ * The number of jobs to process concurrently per worker. Defaults to 1.
+ *
+ * ### backoffStrategy
+ * Defines the backoff strategy used when retrying failed jobs. In other words, if a job fails
+ * and is configured to be re-tried, how long should we wait before the next attempt?
+ *
+ * By default, a job will be retried as soon as possible, but in some cases this is not desirable. For example,
+ * a job may interact with an unreliable 3rd-party API which is sensitive to too many requests. In this case, an
+ * exponential backoff may be used which progressively increases the delay between each subsequent retry.
+ *
+ * @example
+ * ```ts
+ * export const config: DeenruvConfig = {
+ *   plugins: [
+ *     DefaultJobQueuePlugin.init({
+ *       pollInterval: 5000,
+ *       concurrency: 2
+ *       backoffStrategy: (queueName, attemptsMade, job) => {
+ *         if (queueName === 'transcode-video') {
+ *           // exponential backoff example
+ *           return (attemptsMade ** 2) * 1000;
+ *         }
+ *
+ *         // A default delay for all other queues
+ *         return 1000;
+ *       },
+ *       setRetries: (queueName, job) => {
+ *         if (queueName === 'send-email') {
+ *           // Override the default number of retries
+ *           // for the 'send-email' job because we have
+ *           // a very unreliable email service.
+ *           return 10;
+ *         }
+ *         return job.retries;
+ *       }
+ *     }),
+ *   ],
+ * };
+ * ```
+ *
+ * @docsCategory JobQueue
+ * @docsWeight 0
+ */
+export declare class DefaultJobQueuePlugin {
+    /** @internal */
+    static options: DefaultJobQueueOptions;
+    static init(options: DefaultJobQueueOptions): Type<DefaultJobQueuePlugin>;
+}