@deenruv/core 1.0.0

package/dist/plugin/dynamic-plugin-api.module.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDynamicGraphQlModulesForPlugins = exports.createDynamicGraphQlModulesForPlugins = void 0;
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const config_helpers_1 = require("../config/config-helpers");
+const plugin_metadata_1 = require("./plugin-metadata");
+const dynamicApiModuleClassMap = {};
+/**
+ * This function dynamically creates a Nest module to house any GraphQL resolvers defined by
+ * any configured plugins.
+ */
+function createDynamicGraphQlModulesForPlugins(apiType) {
+    return (0, config_helpers_1.getConfig)()
+        .plugins.map((plugin) => {
+        const pluginModule = (0, plugin_metadata_1.isDynamicModule)(plugin) ? plugin.module : plugin;
+        const resolvers = (0, plugin_metadata_1.graphQLResolversFor)(plugin, apiType) || [];
+        if (resolvers.length) {
+            const className = dynamicClassName(pluginModule, apiType);
+            dynamicApiModuleClassMap[className] = class {
+            };
+            Object.defineProperty(dynamicApiModuleClassMap[className], "name", {
+                value: className,
+            });
+            const { imports } = (0, plugin_metadata_1.getModuleMetadata)(pluginModule);
+            return {
+                module: dynamicApiModuleClassMap[className],
+                imports: [pluginModule, ...imports],
+                providers: [...resolvers],
+            };
+        }
+    })
+        .filter(shared_utils_1.notNullOrUndefined);
+}
+exports.createDynamicGraphQlModulesForPlugins = createDynamicGraphQlModulesForPlugins;
+/**
+ * This function retrieves any dynamic modules which were created with createDynamicGraphQlModulesForPlugins.
+ */
+function getDynamicGraphQlModulesForPlugins(apiType) {
+    return (0, config_helpers_1.getConfig)()
+        .plugins.map((plugin) => {
+        const pluginModule = (0, plugin_metadata_1.isDynamicModule)(plugin) ? plugin.module : plugin;
+        const resolvers = (0, plugin_metadata_1.graphQLResolversFor)(plugin, apiType) || [];
+        const className = dynamicClassName(pluginModule, apiType);
+        return dynamicApiModuleClassMap[className];
+    })
+        .filter(shared_utils_1.notNullOrUndefined);
+}
+exports.getDynamicGraphQlModulesForPlugins = getDynamicGraphQlModulesForPlugins;
+function dynamicClassName(module, apiType) {
+    return (module.name + "Dynamic" + (apiType === "shop" ? "Shop" : "Admin") + "Module");
+}
+//# sourceMappingURL=dynamic-plugin-api.module.js.map

package/dist/plugin/dynamic-plugin-api.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dynamic-plugin-api.module.js","sourceRoot":"","sources":["../../src/plugin/dynamic-plugin-api.module.ts"],"names":[],"mappings":";;;AAEA,mEAAsE;AAEtE,6DAAqD;AAErD,uDAI2B;AAE3B,MAAM,wBAAwB,GAAkC,EAAE,CAAC;AAEnE;;;GAGG;AACH,SAAgB,qCAAqC,CACnD,OAAyB;IAEzB,OAAO,IAAA,0BAAS,GAAE;SACf,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QACtB,MAAM,YAAY,GAAG,IAAA,iCAAe,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;QACtE,MAAM,SAAS,GAAG,IAAA,qCAAmB,EAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QAE7D,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACrB,MAAM,SAAS,GAAG,gBAAgB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAC1D,wBAAwB,CAAC,SAAS,CAAC,GAAG;aAAQ,CAAC;YAC/C,MAAM,CAAC,cAAc,CAAC,wBAAwB,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE;gBACjE,KAAK,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,mCAAiB,EAAC,YAAY,CAAC,CAAC;YACpD,OAAO;gBACL,MAAM,EAAE,wBAAwB,CAAC,SAAS,CAAC;gBAC3C,OAAO,EAAE,CAAC,YAAY,EAAE,GAAG,OAAO,CAAC;gBACnC,SAAS,EAAE,CAAC,GAAG,SAAS,CAAC;aAC1B,CAAC;QACJ,CAAC;IACH,CAAC,CAAC;SACD,MAAM,CAAC,iCAAkB,CAAC,CAAC;AAChC,CAAC;AAvBD,sFAuBC;AAED;;GAEG;AACH,SAAgB,kCAAkC,CAChD,OAAyB;IAEzB,OAAO,IAAA,0BAAS,GAAE;SACf,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QACtB,MAAM,YAAY,GAAG,IAAA,iCAAe,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;QACtE,MAAM,SAAS,GAAG,IAAA,qCAAmB,EAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QAE7D,MAAM,SAAS,GAAG,gBAAgB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC,CAAC;SACD,MAAM,CAAC,iCAAkB,CAAC,CAAC;AAChC,CAAC;AAZD,gFAYC;AAED,SAAS,gBAAgB,CACvB,MAAiB,EACjB,OAAyB;IAEzB,OAAO,CACL,MAAM,CAAC,IAAI,GAAG,SAAS,GAAG,CAAC,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,QAAQ,CAC7E,CAAC;AACJ,CAAC"}

package/dist/plugin/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./default-search-plugin/index";
+export * from "./default-job-queue-plugin/default-job-queue-plugin";
+export * from "./default-job-queue-plugin/job-record-buffer.entity";
+export * from "./default-job-queue-plugin/sql-job-buffer-storage-strategy";
+export * from "./deenruv-plugin";
+export * from "./plugin-common.module";
+export * from "./plugin-utils";

package/dist/plugin/index.js

@@ -0,0 +1,24 @@
+"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("./default-search-plugin/index"), exports);
+__exportStar(require("./default-job-queue-plugin/default-job-queue-plugin"), exports);
+__exportStar(require("./default-job-queue-plugin/job-record-buffer.entity"), exports);
+__exportStar(require("./default-job-queue-plugin/sql-job-buffer-storage-strategy"), exports);
+__exportStar(require("./deenruv-plugin"), exports);
+__exportStar(require("./plugin-common.module"), exports);
+__exportStar(require("./plugin-utils"), exports);
+//# sourceMappingURL=index.js.map

package/dist/plugin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/plugin/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,sFAAoE;AACpE,sFAAoE;AACpE,6FAA2E;AAC3E,mDAAiC;AACjC,yDAAuC;AACvC,iDAA+B"}

package/dist/plugin/plugin-common.module.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @description
+ * This module provides the common services, configuration, and event bus capabilities
+ * required by a typical plugin. It should be imported into plugins to avoid having to
+ * repeat the same boilerplate for each individual plugin.
+ *
+ * The PluginCommonModule exports:
+ *
+ * * `EventBusModule`, allowing the injection of the {@link EventBus} service.
+ * * `ServiceModule` allowing the injection of any of the various entity services such as ProductService, OrderService etc.
+ * * `ConfigModule`, allowing the injection of the ConfigService.
+ * * `JobQueueModule`, allowing the injection of the {@link JobQueueService}.
+ * * `HealthCheckModule`, allowing the injection of the {@link HealthCheckRegistryService}.
+ *
+ * @docsCategory plugin
+ */
+export declare class PluginCommonModule {
+}

package/dist/plugin/plugin-common.module.js

@@ -0,0 +1,68 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginCommonModule = void 0;
+const common_1 = require("@nestjs/common");
+const cache_module_1 = require("../cache/cache.module");
+const config_module_1 = require("../config/config.module");
+const connection_module_1 = require("../connection/connection.module");
+const data_import_module_1 = require("../data-import/data-import.module");
+const event_bus_module_1 = require("../event-bus/event-bus.module");
+const health_check_module_1 = require("../health-check/health-check.module");
+const i18n_module_1 = require("../i18n/i18n.module");
+const job_queue_module_1 = require("../job-queue/job-queue.module");
+const process_context_module_1 = require("../process-context/process-context.module");
+const service_module_1 = require("../service/service.module");
+/**
+ * @description
+ * This module provides the common services, configuration, and event bus capabilities
+ * required by a typical plugin. It should be imported into plugins to avoid having to
+ * repeat the same boilerplate for each individual plugin.
+ *
+ * The PluginCommonModule exports:
+ *
+ * * `EventBusModule`, allowing the injection of the {@link EventBus} service.
+ * * `ServiceModule` allowing the injection of any of the various entity services such as ProductService, OrderService etc.
+ * * `ConfigModule`, allowing the injection of the ConfigService.
+ * * `JobQueueModule`, allowing the injection of the {@link JobQueueService}.
+ * * `HealthCheckModule`, allowing the injection of the {@link HealthCheckRegistryService}.
+ *
+ * @docsCategory plugin
+ */
+let PluginCommonModule = class PluginCommonModule {
+};
+exports.PluginCommonModule = PluginCommonModule;
+exports.PluginCommonModule = PluginCommonModule = __decorate([
+    (0, common_1.Module)({
+        imports: [
+            event_bus_module_1.EventBusModule,
+            config_module_1.ConfigModule,
+            connection_module_1.ConnectionModule.forPlugin(),
+            service_module_1.ServiceModule,
+            job_queue_module_1.JobQueueModule,
+            health_check_module_1.HealthCheckModule,
+            cache_module_1.CacheModule,
+            i18n_module_1.I18nModule,
+            process_context_module_1.ProcessContextModule,
+            data_import_module_1.DataImportModule,
+        ],
+        exports: [
+            event_bus_module_1.EventBusModule,
+            config_module_1.ConfigModule,
+            connection_module_1.ConnectionModule.forPlugin(),
+            service_module_1.ServiceModule,
+            job_queue_module_1.JobQueueModule,
+            health_check_module_1.HealthCheckModule,
+            cache_module_1.CacheModule,
+            i18n_module_1.I18nModule,
+            process_context_module_1.ProcessContextModule,
+            data_import_module_1.DataImportModule,
+        ],
+    })
+], PluginCommonModule);
+//# sourceMappingURL=plugin-common.module.js.map

package/dist/plugin/plugin-common.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-common.module.js","sourceRoot":"","sources":["../../src/plugin/plugin-common.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AAExC,wDAAoD;AACpD,2DAAuD;AACvD,uEAAmE;AACnE,0EAAqE;AACrE,oEAA+D;AAC/D,6EAAwE;AACxE,qDAAiD;AACjD,oEAA+D;AAC/D,sFAAiF;AACjF,8DAA0D;AAE1D;;;;;;;;;;;;;;;GAeG;AA2BI,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;CAAG,CAAA;AAArB,gDAAkB;6BAAlB,kBAAkB;IA1B9B,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,iCAAc;YACd,4BAAY;YACZ,oCAAgB,CAAC,SAAS,EAAE;YAC5B,8BAAa;YACb,iCAAc;YACd,uCAAiB;YACjB,0BAAW;YACX,wBAAU;YACV,6CAAoB;YACpB,qCAAgB;SACjB;QACD,OAAO,EAAE;YACP,iCAAc;YACd,4BAAY;YACZ,oCAAgB,CAAC,SAAS,EAAE;YAC5B,8BAAa;YACb,iCAAc;YACd,uCAAiB;YACjB,0BAAW;YACX,wBAAU;YACV,6CAAoB;YACpB,qCAAgB;SACjB;KACF,CAAC;GACW,kBAAkB,CAAG"}

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

@@ -0,0 +1,22 @@
+import { DynamicModule } from "@nestjs/common";
+import { Type } from "@deenruv/common/lib/shared-types";
+import { APIExtensionDefinition, PluginConfigurationFn } from "./deenruv-plugin";
+export declare const PLUGIN_METADATA: {
+    CONFIGURATION: string;
+    SHOP_API_EXTENSIONS: string;
+    ADMIN_API_EXTENSIONS: string;
+    ENTITIES: string;
+    COMPATIBILITY: string;
+};
+export declare function getEntitiesFromPlugins(plugins?: Array<Type<any> | DynamicModule>): Array<Type<any>>;
+export declare function getModuleMetadata(module: Type<any>): {
+    controllers: any;
+    providers: any;
+    imports: any;
+    exports: any;
+};
+export declare function getPluginAPIExtensions(plugins: Array<Type<any> | DynamicModule>, apiType: "shop" | "admin"): APIExtensionDefinition[];
+export declare function getCompatibility(plugin: Type<any> | DynamicModule): string | undefined;
+export declare function getConfigurationFunction(plugin: Type<any> | DynamicModule): PluginConfigurationFn | undefined;
+export declare function graphQLResolversFor(plugin: Type<any> | DynamicModule, apiType: "shop" | "admin"): Array<Type<any>>;
+export declare function isDynamicModule(input: Type<any> | DynamicModule): input is DynamicModule;

package/dist/plugin/plugin-metadata.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDynamicModule = exports.graphQLResolversFor = exports.getConfigurationFunction = exports.getCompatibility = exports.getPluginAPIExtensions = exports.getModuleMetadata = exports.getEntitiesFromPlugins = exports.PLUGIN_METADATA = void 0;
+const constants_1 = require("@nestjs/common/constants");
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+exports.PLUGIN_METADATA = {
+    CONFIGURATION: "configuration",
+    SHOP_API_EXTENSIONS: "shopApiExtensions",
+    ADMIN_API_EXTENSIONS: "adminApiExtensions",
+    ENTITIES: "entities",
+    COMPATIBILITY: "compatibility",
+};
+function getEntitiesFromPlugins(plugins) {
+    if (!plugins) {
+        return [];
+    }
+    return plugins
+        .map((p) => reflectMetadata(p, exports.PLUGIN_METADATA.ENTITIES))
+        .reduce((all, entities) => {
+        const resolvedEntities = typeof entities === "function" ? entities() : (entities !== null && entities !== void 0 ? entities : []);
+        return [...all, ...resolvedEntities];
+    }, []);
+}
+exports.getEntitiesFromPlugins = getEntitiesFromPlugins;
+function getModuleMetadata(module) {
+    return {
+        controllers: Reflect.getMetadata(constants_1.MODULE_METADATA.CONTROLLERS, module) || [],
+        providers: Reflect.getMetadata(constants_1.MODULE_METADATA.PROVIDERS, module) || [],
+        imports: Reflect.getMetadata(constants_1.MODULE_METADATA.IMPORTS, module) || [],
+        exports: Reflect.getMetadata(constants_1.MODULE_METADATA.EXPORTS, module) || [],
+    };
+}
+exports.getModuleMetadata = getModuleMetadata;
+function getPluginAPIExtensions(plugins, apiType) {
+    const extensions = apiType === "shop"
+        ? plugins.map((p) => reflectMetadata(p, exports.PLUGIN_METADATA.SHOP_API_EXTENSIONS))
+        : plugins.map((p) => reflectMetadata(p, exports.PLUGIN_METADATA.ADMIN_API_EXTENSIONS));
+    return extensions.filter(shared_utils_1.notNullOrUndefined);
+}
+exports.getPluginAPIExtensions = getPluginAPIExtensions;
+function getCompatibility(plugin) {
+    return reflectMetadata(plugin, exports.PLUGIN_METADATA.COMPATIBILITY);
+}
+exports.getCompatibility = getCompatibility;
+function getConfigurationFunction(plugin) {
+    return reflectMetadata(plugin, exports.PLUGIN_METADATA.CONFIGURATION);
+}
+exports.getConfigurationFunction = getConfigurationFunction;
+function graphQLResolversFor(plugin, apiType) {
+    var _a;
+    const apiExtensions = apiType === "shop"
+        ? reflectMetadata(plugin, exports.PLUGIN_METADATA.SHOP_API_EXTENSIONS)
+        : reflectMetadata(plugin, exports.PLUGIN_METADATA.ADMIN_API_EXTENSIONS);
+    return apiExtensions
+        ? typeof apiExtensions.resolvers === "function"
+            ? apiExtensions.resolvers()
+            : ((_a = apiExtensions.resolvers) !== null && _a !== void 0 ? _a : [])
+        : [];
+}
+exports.graphQLResolversFor = graphQLResolversFor;
+function reflectMetadata(metatype, metadataKey) {
+    if (isDynamicModule(metatype)) {
+        return Reflect.getMetadata(metadataKey, metatype.module);
+    }
+    else {
+        return Reflect.getMetadata(metadataKey, metatype);
+    }
+}
+function isDynamicModule(input) {
+    return !!input.module;
+}
+exports.isDynamicModule = isDynamicModule;
+//# sourceMappingURL=plugin-metadata.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-metadata.js","sourceRoot":"","sources":["../../src/plugin/plugin-metadata.ts"],"names":[],"mappings":";;;AACA,wDAA2D;AAE3D,mEAAsE;AAOzD,QAAA,eAAe,GAAG;IAC7B,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,mBAAmB;IACxC,oBAAoB,EAAE,oBAAoB;IAC1C,QAAQ,EAAE,UAAU;IACpB,aAAa,EAAE,eAAe;CAC/B,CAAC;AAEF,SAAgB,sBAAsB,CACpC,OAA0C;IAE1C,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,OAAO;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,EAAE,uBAAe,CAAC,QAAQ,CAAC,CAAC;SACxD,MAAM,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;QACxB,MAAM,gBAAgB,GACpB,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CAAC;QACjE,OAAO,CAAC,GAAG,GAAG,EAAE,GAAG,gBAAgB,CAAC,CAAC;IACvC,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC;AAbD,wDAaC;AAED,SAAgB,iBAAiB,CAAC,MAAiB;IACjD,OAAO;QACL,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,2BAAe,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,EAAE;QAC3E,SAAS,EAAE,OAAO,CAAC,WAAW,CAAC,2BAAe,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE;QACvE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,2BAAe,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE;QACnE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,2BAAe,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE;KACpE,CAAC;AACJ,CAAC;AAPD,8CAOC;AAED,SAAgB,sBAAsB,CACpC,OAAyC,EACzC,OAAyB;IAEzB,MAAM,UAAU,GACd,OAAO,KAAK,MAAM;QAChB,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAChB,eAAe,CAAC,CAAC,EAAE,uBAAe,CAAC,mBAAmB,CAAC,CACxD;QACH,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAChB,eAAe,CAAC,CAAC,EAAE,uBAAe,CAAC,oBAAoB,CAAC,CACzD,CAAC;IAER,OAAO,UAAU,CAAC,MAAM,CAAC,iCAAkB,CAAC,CAAC;AAC/C,CAAC;AAdD,wDAcC;AAED,SAAgB,gBAAgB,CAC9B,MAAiC;IAEjC,OAAO,eAAe,CAAC,MAAM,EAAE,uBAAe,CAAC,aAAa,CAAC,CAAC;AAChE,CAAC;AAJD,4CAIC;AAED,SAAgB,wBAAwB,CACtC,MAAiC;IAEjC,OAAO,eAAe,CAAC,MAAM,EAAE,uBAAe,CAAC,aAAa,CAAC,CAAC;AAChE,CAAC;AAJD,4DAIC;AAED,SAAgB,mBAAmB,CACjC,MAAiC,EACjC,OAAyB;;IAEzB,MAAM,aAAa,GACjB,OAAO,KAAK,MAAM;QAChB,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,uBAAe,CAAC,mBAAmB,CAAC;QAC9D,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,uBAAe,CAAC,oBAAoB,CAAC,CAAC;IAEpE,OAAO,aAAa;QAClB,CAAC,CAAC,OAAO,aAAa,CAAC,SAAS,KAAK,UAAU;YAC7C,CAAC,CAAC,aAAa,CAAC,SAAS,EAAE;YAC3B,CAAC,CAAC,CAAC,MAAA,aAAa,CAAC,SAAS,mCAAI,EAAE,CAAC;QACnC,CAAC,CAAC,EAAE,CAAC;AACT,CAAC;AAdD,kDAcC;AAED,SAAS,eAAe,CACtB,QAAmC,EACnC,WAAmB;IAEnB,IAAI,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;SAAM,CAAC;QACN,OAAO,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;AACH,CAAC;AAED,SAAgB,eAAe,CAC7B,KAAgC;IAEhC,OAAO,CAAC,CAAE,KAAuB,CAAC,MAAM,CAAC;AAC3C,CAAC;AAJD,0CAIC"}

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

@@ -0,0 +1,79 @@
+import { RequestHandler } from "express";
+/**
+ * @description
+ * Creates a proxy middleware which proxies the given route to the given port.
+ * Useful for plugins which start their own servers but should be accessible
+ * via the main Deenruv url.
+ *
+ * @example
+ * ```ts
+ * // Example usage in the `configuration` method of a DeenruvPlugin.
+ * // Imagine that we have started a Node server on port 5678
+ * // running some service which we want to access via the `/my-plugin/`
+ * // route of the main Deenruv server.
+ * \@DeenruvPlugin({
+ *   configuration: (config: Required<DeenruvConfig>) => {
+ *       config.apiOptions.middleware.push({
+ *           handler: createProxyHandler({
+ *               label: 'Admin UI',
+ *               route: 'my-plugin',
+ *               port: 5678,
+ *           }),
+ *           route: 'my-plugin',
+ *       });
+ *       return config;
+ *   }
+ * })
+ * export class MyPlugin {}
+ * ```
+ *
+ * @docsCategory Plugin
+ * @docsPage Plugin Utilities
+ */
+export declare function createProxyHandler(options: ProxyOptions): RequestHandler;
+/**
+ * @description
+ * Options to configure proxy middleware via {@link createProxyHandler}.
+ *
+ * @docsCategory Plugin
+ * @docsPage Plugin Utilities
+ */
+export interface ProxyOptions {
+    /**
+     * @description
+     * A human-readable label for the service which is being proxied. Used to
+     * generate more informative logs.
+     */
+    label: string;
+    /**
+     * @description
+     * The route of the Deenruv server which will act as the proxy url.
+     */
+    route: string;
+    /**
+     * @description
+     * The port on which the service being proxied is running.
+     */
+    port: number;
+    /**
+     * @description
+     * The hostname of the server on which the service being proxied is running.
+     *
+     * @default 'localhost'
+     */
+    hostname?: string;
+    /**
+     * @description
+     * An optional base path on the proxied server.
+     */
+    basePath?: string;
+}
+/**
+ * Use this function to add a line to the bootstrap log output listing a service added
+ * by this plugin.
+ */
+export declare function registerPluginStartupMessage(serviceName: string, path: string): void;
+export declare function getPluginStartupMessages(): ReadonlyArray<{
+    label: string;
+    path: string;
+}>;

package/dist/plugin/plugin-utils.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPluginStartupMessages = exports.registerPluginStartupMessage = exports.createProxyHandler = void 0;
+const http_proxy_middleware_1 = require("http-proxy-middleware");
+const config_1 = require("../config");
+/**
+ * @description
+ * Creates a proxy middleware which proxies the given route to the given port.
+ * Useful for plugins which start their own servers but should be accessible
+ * via the main Deenruv url.
+ *
+ * @example
+ * ```ts
+ * // Example usage in the `configuration` method of a DeenruvPlugin.
+ * // Imagine that we have started a Node server on port 5678
+ * // running some service which we want to access via the `/my-plugin/`
+ * // route of the main Deenruv server.
+ * \@DeenruvPlugin({
+ *   configuration: (config: Required<DeenruvConfig>) => {
+ *       config.apiOptions.middleware.push({
+ *           handler: createProxyHandler({
+ *               label: 'Admin UI',
+ *               route: 'my-plugin',
+ *               port: 5678,
+ *           }),
+ *           route: 'my-plugin',
+ *       });
+ *       return config;
+ *   }
+ * })
+ * export class MyPlugin {}
+ * ```
+ *
+ * @docsCategory Plugin
+ * @docsPage Plugin Utilities
+ */
+function createProxyHandler(options) {
+    const route = options.route.charAt(0) === "/" ? options.route : "/" + options.route;
+    const proxyHostname = options.hostname || "localhost";
+    const middleware = (0, http_proxy_middleware_1.createProxyMiddleware)({
+        // TODO: how do we detect https?
+        target: `http://${proxyHostname}:${options.port}`,
+        pathRewrite: {
+            [`^${route}`]: "/" + (options.basePath || ""),
+        },
+        logProvider(provider) {
+            return {
+                log(message) {
+                    config_1.Logger.debug(message, options.label);
+                },
+                debug(message) {
+                    config_1.Logger.debug(message, options.label);
+                },
+                info(message) {
+                    config_1.Logger.debug(message, options.label);
+                },
+                warn(message) {
+                    config_1.Logger.warn(message, options.label);
+                },
+                error(message) {
+                    config_1.Logger.error(message, options.label);
+                },
+            };
+        },
+    });
+    return middleware;
+}
+exports.createProxyHandler = createProxyHandler;
+const pluginStartupMessages = [];
+/**
+ * Use this function to add a line to the bootstrap log output listing a service added
+ * by this plugin.
+ */
+function registerPluginStartupMessage(serviceName, path) {
+    pluginStartupMessages.push({ label: serviceName, path });
+}
+exports.registerPluginStartupMessage = registerPluginStartupMessage;
+function getPluginStartupMessages() {
+    return pluginStartupMessages;
+}
+exports.getPluginStartupMessages = getPluginStartupMessages;
+//# sourceMappingURL=plugin-utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-utils.js","sourceRoot":"","sources":["../../src/plugin/plugin-utils.ts"],"names":[],"mappings":";;;AACA,iEAA8D;AAE9D,sCAAwE;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,kBAAkB,CAAC,OAAqB;IACtD,MAAM,KAAK,GACT,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC;IACxE,MAAM,aAAa,GAAG,OAAO,CAAC,QAAQ,IAAI,WAAW,CAAC;IACtD,MAAM,UAAU,GAAG,IAAA,6CAAqB,EAAC;QACvC,gCAAgC;QAChC,MAAM,EAAE,UAAU,aAAa,IAAI,OAAO,CAAC,IAAI,EAAE;QACjD,WAAW,EAAE;YACX,CAAC,IAAI,KAAK,EAAE,CAAC,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;SAC9C;QACD,WAAW,CAAC,QAAQ;YAClB,OAAO;gBACL,GAAG,CAAC,OAAe;oBACjB,eAAM,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;gBACD,KAAK,CAAC,OAAe;oBACnB,eAAM,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;gBACD,IAAI,CAAC,OAAe;oBAClB,eAAM,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;gBACD,IAAI,CAAC,OAAe;oBAClB,eAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;gBACtC,CAAC;gBACD,KAAK,CAAC,OAAe;oBACnB,eAAM,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;aACF,CAAC;QACJ,CAAC;KACF,CAAC,CAAC;IACH,OAAO,UAAU,CAAC;AACpB,CAAC;AA/BD,gDA+BC;AAwCD,MAAM,qBAAqB,GAA2C,EAAE,CAAC;AAEzE;;;GAGG;AACH,SAAgB,4BAA4B,CAC1C,WAAmB,EACnB,IAAY;IAEZ,qBAAqB,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;AAC3D,CAAC;AALD,oEAKC;AAED,SAAgB,wBAAwB;IAItC,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AALD,4DAKC"}

package/dist/plugin/plugin.module.d.ts

@@ -0,0 +1,8 @@
+import { DynamicModule } from "@nestjs/common";
+/**
+ * This module collects and re-exports all providers defined in plugins so that they can be used in other
+ * modules.
+ */
+export declare class PluginModule {
+    static forRoot(): DynamicModule;
+}

package/dist/plugin/plugin.module.js

@@ -0,0 +1,32 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var PluginModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginModule = void 0;
+const common_1 = require("@nestjs/common");
+const config_helpers_1 = require("../config/config-helpers");
+const config_module_1 = require("../config/config.module");
+/**
+ * This module collects and re-exports all providers defined in plugins so that they can be used in other
+ * modules.
+ */
+let PluginModule = PluginModule_1 = class PluginModule {
+    static forRoot() {
+        return {
+            module: PluginModule_1,
+            imports: [...(0, config_helpers_1.getConfig)().plugins],
+        };
+    }
+};
+exports.PluginModule = PluginModule;
+exports.PluginModule = PluginModule = PluginModule_1 = __decorate([
+    (0, common_1.Module)({
+        imports: [config_module_1.ConfigModule],
+    })
+], PluginModule);
+//# sourceMappingURL=plugin.module.js.map

package/dist/plugin/plugin.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.module.js","sourceRoot":"","sources":["../../src/plugin/plugin.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAuD;AAEvD,6DAAqD;AACrD,2DAAuD;AAEvD;;;GAGG;AAII,IAAM,YAAY,oBAAlB,MAAM,YAAY;IACvB,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,MAAM,EAAE,cAAY;YACpB,OAAO,EAAE,CAAC,GAAG,IAAA,0BAAS,GAAE,CAAC,OAAO,CAAC;SAClC,CAAC;IACJ,CAAC;CACF,CAAA;AAPY,oCAAY;uBAAZ,YAAY;IAHxB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,4BAAY,CAAC;KACxB,CAAC;GACW,YAAY,CAOxB"}

package/dist/process-context/index.d.ts

@@ -0,0 +1 @@
+export { ProcessContext } from "./process-context";

package/dist/process-context/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessContext = void 0;
+var process_context_1 = require("./process-context");
+Object.defineProperty(exports, "ProcessContext", { enumerable: true, get: function () { return process_context_1.ProcessContext; } });
+//# sourceMappingURL=index.js.map

package/dist/process-context/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/process-context/index.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AAA1C,iHAAA,cAAc,OAAA"}

package/dist/process-context/process-context.d.ts

@@ -0,0 +1,39 @@
+type ProcessContextType = "server" | "worker";
+/**
+ * @description
+ * The ProcessContext can be injected into your providers & modules in order to know whether it
+ * is being executed in the context of the main Deenruv server or the worker.
+ *
+ * @example
+ * ```ts
+ * import { Injectable, OnApplicationBootstrap } from '\@nestjs/common';
+ * import { ProcessContext } from '\@deenruv/core';
+ *
+ * \@Injectable()
+ * export class MyService implements OnApplicationBootstrap {
+ *   constructor(private processContext: ProcessContext) {}
+ *
+ *   onApplicationBootstrap() {
+ *     if (this.processContext.isServer) {
+ *       // code which will only execute when running in
+ *       // the server process
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @docsCategory common
+ */
+export declare class ProcessContext {
+    get isServer(): boolean;
+    get isWorker(): boolean;
+}
+/**
+ * @description
+ * Should only be called in the core bootstrap functions in order to establish
+ * the current process context.
+ *
+ * @internal
+ */
+export declare function setProcessContext(context: ProcessContextType): void;
+export {};

package/dist/process-context/process-context.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setProcessContext = exports.ProcessContext = void 0;
+let currentContext = "server";
+/**
+ * @description
+ * The ProcessContext can be injected into your providers & modules in order to know whether it
+ * is being executed in the context of the main Deenruv server or the worker.
+ *
+ * @example
+ * ```ts
+ * import { Injectable, OnApplicationBootstrap } from '\@nestjs/common';
+ * import { ProcessContext } from '\@deenruv/core';
+ *
+ * \@Injectable()
+ * export class MyService implements OnApplicationBootstrap {
+ *   constructor(private processContext: ProcessContext) {}
+ *
+ *   onApplicationBootstrap() {
+ *     if (this.processContext.isServer) {
+ *       // code which will only execute when running in
+ *       // the server process
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @docsCategory common
+ */
+class ProcessContext {
+    get isServer() {
+        return currentContext === "server";
+    }
+    get isWorker() {
+        return currentContext === "worker";
+    }
+}
+exports.ProcessContext = ProcessContext;
+/**
+ * @description
+ * Should only be called in the core bootstrap functions in order to establish
+ * the current process context.
+ *
+ * @internal
+ */
+function setProcessContext(context) {
+    currentContext = context;
+}
+exports.setProcessContext = setProcessContext;
+//# sourceMappingURL=process-context.js.map

package/dist/process-context/process-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-context.js","sourceRoot":"","sources":["../../src/process-context/process-context.ts"],"names":[],"mappings":";;;AAGA,IAAI,cAAc,GAAuB,QAAQ,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,cAAc;IACzB,IAAI,QAAQ;QACV,OAAO,cAAc,KAAK,QAAQ,CAAC;IACrC,CAAC;IACD,IAAI,QAAQ;QACV,OAAO,cAAc,KAAK,QAAQ,CAAC;IACrC,CAAC;CACF;AAPD,wCAOC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAC,OAA2B;IAC3D,cAAc,GAAG,OAAO,CAAC;AAC3B,CAAC;AAFD,8CAEC"}

package/dist/process-context/process-context.module.d.ts

@@ -0,0 +1,2 @@
+export declare class ProcessContextModule {
+}

package/dist/process-context/process-context.module.js

@@ -0,0 +1,22 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessContextModule = void 0;
+const common_1 = require("@nestjs/common");
+const process_context_1 = require("./process-context");
+let ProcessContextModule = class ProcessContextModule {
+};
+exports.ProcessContextModule = ProcessContextModule;
+exports.ProcessContextModule = ProcessContextModule = __decorate([
+    (0, common_1.Global)(),
+    (0, common_1.Module)({
+        providers: [process_context_1.ProcessContext],
+        exports: [process_context_1.ProcessContext],
+    })
+], ProcessContextModule);
+//# sourceMappingURL=process-context.module.js.map

package/dist/process-context/process-context.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-context.module.js","sourceRoot":"","sources":["../../src/process-context/process-context.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAA+D;AAE/D,uDAAmD;AAO5C,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;CAAG,CAAA;AAAvB,oDAAoB;+BAApB,oBAAoB;IALhC,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,CAAC,gCAAc,CAAC;QAC3B,OAAO,EAAE,CAAC,gCAAc,CAAC;KAC1B,CAAC;GACW,oBAAoB,CAAG"}