@deenruv/core 1.0.0

package/dist/config/catalog/default-stock-location-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-stock-location-strategy.js","sourceRoot":"","sources":["../../../src/config/catalog/default-stock-location-strategy.ts"],"names":[],"mappings":";;;AAIA,8CAAiD;AACjD,wFAAoF;AAIpF,qFAA2E;AAQ3E;;;;;;;GAOG;AACH,MAAa,4BAA4B;IAGvC,IAAI,CAAC,QAAkB;QACrB,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,kDAAuB,CAAC,CAAC;IAC1D,CAAC;IAED,iBAAiB,CACf,GAAmB,EACnB,gBAAoB,EACpB,WAAyB;QAEzB,IAAI,WAAW,GAAG,CAAC,CAAC;QACpB,IAAI,cAAc,GAAG,CAAC,CAAC;QACvB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,WAAW,IAAI,UAAU,CAAC,WAAW,CAAC;YACtC,cAAc,IAAI,UAAU,CAAC,cAAc,CAAC;QAC9C,CAAC;QACD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;IACzC,CAAC;IAED,aAAa,CACX,GAAmB,EACnB,cAA+B,EAC/B,SAAoB,EACpB,QAAgB;QAEhB,OAAO,CAAC,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,GAAmB,EACnB,cAA+B,EAC/B,SAAoB,EACpB,QAAgB;QAEhB,OAAO,IAAI,CAAC,8BAA8B,CACxC,GAAG,EACH,cAAc,EACd,SAAS,EACT,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CACd,GAAmB,EACnB,cAA+B,EAC/B,SAAoB,EACpB,QAAgB;QAEhB,OAAO,IAAI,CAAC,8BAA8B,CACxC,GAAG,EACH,cAAc,EACd,SAAS,EACT,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CACX,GAAmB,EACnB,cAA+B,EAC/B,SAAoB,EACpB,QAAgB;QAEhB,OAAO,IAAI,CAAC,8BAA8B,CACxC,GAAG,EACH,cAAc,EACd,SAAS,EACT,QAAQ,CACT,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,8BAA8B,CAC1C,GAAmB,EACnB,cAA+B,EAC/B,SAAoB,EACpB,QAAgB;QAEhB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU;aACtC,aAAa,CAAC,GAAG,EAAE,8BAAU,CAAC;aAC9B,IAAI,CAAC;YACJ,KAAK,EAAE;gBACL,SAAS,EAAE,EAAE,EAAE,EAAE,SAAS,CAAC,EAAE,EAAE;aAChC;SACF,CAAC,CAAC;QACL,IAAI,WAAW,GAAG,QAAQ,CAAC;QAC3B,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAc,CAAC;QACnD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;gBACrB,MAAM;YACR,CAAC;YACD,MAAM,aAAa,GAAG,oBAAoB,CAAC,GAAG,CAC5C,UAAU,CAAC,eAAe,CAC3B,CAAC;YACF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YAC5D,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;gBAC1B,oBAAoB,CAAC,GAAG,CACtB,UAAU,CAAC,eAAe,EAC1B,aAAa,GAAG,QAAQ,CACzB,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,oBAAoB,CAAC,GAAG,CAAC,UAAU,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;YACjE,CAAC;YACD,WAAW,IAAI,QAAQ,CAAC;QAC1B,CAAC;QACD,OAAO,CAAC,GAAG,oBAAoB,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YACrE,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,mBAAW,EAAC,CAAC,CAAC,EAAE,EAAE,UAAU,CAAC,CAAE;YACpE,QAAQ,EAAE,GAAG;SACd,CAAC,CAAC,CAAC;IACN,CAAC;CACF;AA9GD,oEA8GC"}

package/dist/config/catalog/product-variant-price-calculation-strategy.d.ts

@@ -0,0 +1,39 @@
+import { RequestContext } from "../../api/common/request-context";
+import { PriceCalculationResult } from "../../common/types/common-types";
+import { InjectableStrategy } from "../../common/types/injectable-strategy";
+import { ProductVariant } from "../../entity/product-variant/product-variant.entity";
+import { TaxCategory } from "../../entity/tax-category/tax-category.entity";
+import { Zone } from "../../entity/zone/zone.entity";
+/**
+ * @description
+ * Defines how ProductVariant are calculated based on the input price, tax zone and current request context.
+ *
+ * :::info
+ *
+ * This is configured via the `catalogOptions.productVariantPriceCalculationStrategy` property of
+ * your DeenruvConfig.
+ *
+ * :::
+ *
+ * @docsCategory  products & stock
+ * @docsPage ProductVariantPriceCalculationStrategy
+ */
+export interface ProductVariantPriceCalculationStrategy extends InjectableStrategy {
+    calculate(args: ProductVariantPriceCalculationArgs): Promise<PriceCalculationResult>;
+}
+/**
+ * @description
+ * The arguments passed the `calculate` method of the configured {@link ProductVariantPriceCalculationStrategy}.
+ *
+ * The `productVariant` argument was added in v2.1.0.
+ *
+ * @docsCategory products & stock
+ * @docsPage ProductVariantPriceCalculationStrategy
+ */
+export interface ProductVariantPriceCalculationArgs {
+    inputPrice: number;
+    productVariant: ProductVariant;
+    taxCategory: TaxCategory;
+    activeTaxZone: Zone;
+    ctx: RequestContext;
+}

package/dist/config/catalog/product-variant-price-calculation-strategy.js

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

package/dist/config/catalog/product-variant-price-calculation-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"product-variant-price-calculation-strategy.js","sourceRoot":"","sources":["../../../src/config/catalog/product-variant-price-calculation-strategy.ts"],"names":[],"mappings":""}

package/dist/config/catalog/product-variant-price-selection-strategy.d.ts

@@ -0,0 +1,22 @@
+import { RequestContext } from "../../api/common/request-context";
+import { InjectableStrategy } from "../../common/types/injectable-strategy";
+import { ProductVariantPrice } from "../../entity/product-variant/product-variant-price.entity";
+/**
+ * @description
+ * The strategy for selecting the price for a ProductVariant in a given Channel.
+ *
+ * :::info
+ *
+ * This is configured via the `catalogOptions.productVariantPriceSelectionStrategy` property of
+ * your DeenruvConfig.
+ *
+ * :::
+ *
+ * @docsCategory configuration
+ * @docsPage ProductVariantPriceSelectionStrategy
+ * @docsWeight 0
+ * @since 2.0.0
+ */
+export interface ProductVariantPriceSelectionStrategy extends InjectableStrategy {
+    selectPrice(ctx: RequestContext, prices: ProductVariantPrice[]): ProductVariantPrice | undefined | Promise<ProductVariantPrice | undefined>;
+}

package/dist/config/catalog/product-variant-price-selection-strategy.js

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

package/dist/config/catalog/product-variant-price-selection-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"product-variant-price-selection-strategy.js","sourceRoot":"","sources":["../../../src/config/catalog/product-variant-price-selection-strategy.ts"],"names":[],"mappings":""}

package/dist/config/catalog/product-variant-price-update-strategy.d.ts

@@ -0,0 +1,83 @@
+import { ID } from "@deenruv/common/lib/shared-types";
+import { RequestContext } from "../../api/common/request-context";
+import { InjectableStrategy } from "../../common/types/injectable-strategy";
+import { ProductVariantPrice } from "../../entity/product-variant/product-variant-price.entity";
+/**
+ * @description
+ * The return value of the `onPriceCreated`, `onPriceUpdated` and `onPriceDeleted` methods
+ * of the {@link ProductVariantPriceUpdateStrategy}.
+ *
+ * @docsPage ProductVariantPriceUpdateStrategy
+ * @since 2.2.0
+ */
+export interface UpdatedProductVariantPrice {
+    /**
+     * @description
+     * The ID of the ProductVariantPrice to update.
+     */
+    id: ID;
+    /**
+     * @description
+     * The new price to set.
+     */
+    price: number;
+}
+/**
+ * @description
+ * This strategy determines how updates to a ProductVariantPrice is handled in regard to
+ * any other prices which may be associated with the same ProductVariant.
+ *
+ * For instance, in a multichannel setup, if a price is updated for a ProductVariant in one
+ * Channel, this strategy can be used to update the prices in other Channels.
+ *
+ * Using custom logic, this can be made more sophisticated - for example, you could have a
+ * one-way sync that only updates prices in child channels when the price in the default
+ * channel is updated. You could also have a conditional sync which is dependent on the
+ * permissions of the current administrator, or based on custom field flags on the ProductVariant
+ * or Channel.
+ *
+ * Another use-case might be to update the prices of a ProductVariant in other currencies
+ * when a price is updated in one currency, based on the current exchange rate.
+ *
+ *
+ * :::info
+ *
+ * This is configured via the `catalogOptions.productVariantPriceUpdateStrategy` property of
+ * your DeenruvConfig.
+ *
+ * :::
+ *
+ * @docsCategory configuration
+ * @docsPage ProductVariantPriceUpdateStrategy
+ * @docsWeight 0
+ * @since 2.2.0
+ */
+export interface ProductVariantPriceUpdateStrategy extends InjectableStrategy {
+    /**
+     * @description
+     * This method is called when a ProductVariantPrice is created. It receives the created
+     * ProductVariantPrice and the array of all prices associated with the ProductVariant.
+     *
+     * It should return an array of UpdatedProductVariantPrice objects which will be used to update
+     * the prices of the specific ProductVariantPrices.
+     */
+    onPriceCreated(ctx: RequestContext, createdPrice: ProductVariantPrice, prices: ProductVariantPrice[]): UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>;
+    /**
+     * @description
+     * This method is called when a ProductVariantPrice is updated. It receives the updated
+     * ProductVariantPrice and the array of all prices associated with the ProductVariant.
+     *
+     * It should return an array of UpdatedProductVariantPrice objects which will be used to update
+     * the prices of the specific ProductVariantPrices.
+     */
+    onPriceUpdated(ctx: RequestContext, updatedPrice: ProductVariantPrice, prices: ProductVariantPrice[]): UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>;
+    /**
+     * @description
+     * This method is called when a ProductVariantPrice is deleted. It receives the deleted
+     * ProductVariantPrice and the array of all prices associated with the ProductVariant.
+     *
+     * It should return an array of UpdatedProductVariantPrice objects which will be used to update
+     * the prices of the specific ProductVariantPrices.
+     */
+    onPriceDeleted(ctx: RequestContext, deletedPrice: ProductVariantPrice, prices: ProductVariantPrice[]): UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>;
+}

package/dist/config/catalog/product-variant-price-update-strategy.js

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

package/dist/config/catalog/product-variant-price-update-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"product-variant-price-update-strategy.js","sourceRoot":"","sources":["../../../src/config/catalog/product-variant-price-update-strategy.ts"],"names":[],"mappings":""}

package/dist/config/catalog/stock-display-strategy.d.ts

@@ -0,0 +1,27 @@
+import { RequestContext } from "../../api/common/request-context";
+import { InjectableStrategy } from "../../common/types/injectable-strategy";
+import { ProductVariant } from "../../entity/product-variant/product-variant.entity";
+/**
+ * @description
+ * Defines how the `ProductVariant.stockLevel` value is obtained. It is usually not desirable
+ * to directly expose stock levels over a public API, as this could be considered a leak of
+ * sensitive information. However, the storefront will usually want to display _some_ indication
+ * of whether a given ProductVariant is in stock.
+ *
+ * :::info
+ *
+ * This is configured via the `catalogOptions.stockDisplayStrategy` property of
+ * your DeenruvConfig.
+ *
+ * :::
+ *
+ * @docsCategory products & stock
+ */
+export interface StockDisplayStrategy extends InjectableStrategy {
+    /**
+     * @description
+     * Returns a string representing the stock level, which will be used directly
+     * in the GraphQL `ProductVariant.stockLevel` field.
+     */
+    getStockLevel(ctx: RequestContext, productVariant: ProductVariant, saleableStockLevel: number): string | Promise<string>;
+}

package/dist/config/catalog/stock-display-strategy.js

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

package/dist/config/catalog/stock-display-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stock-display-strategy.js","sourceRoot":"","sources":["../../../src/config/catalog/stock-display-strategy.ts"],"names":[],"mappings":""}

package/dist/config/catalog/stock-location-strategy.d.ts

@@ -0,0 +1,82 @@
+import { ID } from "@deenruv/common/lib/shared-types";
+import { RequestContext } from "../../api/common/request-context";
+import { InjectableStrategy } from "../../common/types/injectable-strategy";
+import { OrderLine } from "../../entity/order-line/order-line.entity";
+import { StockLevel } from "../../entity/stock-level/stock-level.entity";
+import { StockLocation } from "../../entity/stock-location/stock-location.entity";
+/**
+ * @description
+ * The overall available stock for a ProductVariant as determined by the logic of the
+ * {@link StockLocationStrategy}'s `getAvailableStock` method.
+ *
+ * @docsCategory products & stock
+ * @since 2.0.0
+ * @docsPage StockLocationStrategy
+ */
+export interface AvailableStock {
+    stockOnHand: number;
+    stockAllocated: number;
+}
+/**
+ * @description
+ * Returned by the `StockLocationStrategy` methods to indicate how much stock from each
+ * location should be used in the allocation/sale/release/cancellation of an OrderLine.
+ *
+ * @docsCategory products & stock
+ * @since 2.0.0
+ * @docsPage StockLocationStrategy
+ */
+export interface LocationWithQuantity {
+    location: StockLocation;
+    quantity: number;
+}
+/**
+ * @description
+ * The StockLocationStrategy is responsible for determining which {@link StockLocation}s
+ * should be used to fulfill an {@link OrderLine} and how much stock should be allocated
+ * from each location. It is also used to determine the available stock for a given
+ * {@link ProductVariant}.
+ *
+ * :::info
+ *
+ * This is configured via the `catalogOptions.stockLocationStrategy` property of
+ * your DeenruvConfig.
+ *
+ * :::
+ *
+ * @docsCategory products & stock
+ * @docsWeight 0
+ * @since 2.0.0
+ */
+export interface StockLocationStrategy extends InjectableStrategy {
+    /**
+     * @description
+     * Returns the available stock for the given ProductVariant, taking into account
+     * the stock levels at each StockLocation.
+     */
+    getAvailableStock(ctx: RequestContext, productVariantId: ID, stockLevels: StockLevel[]): AvailableStock | Promise<AvailableStock>;
+    /**
+     * @description
+     * Determines which StockLocations should be used to when allocating stock when
+     * and Order is placed.
+     */
+    forAllocation(ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number): LocationWithQuantity[] | Promise<LocationWithQuantity[]>;
+    /**
+     * @description
+     * Determines which StockLocations should be used to when releasing allocated
+     * stock when an OrderLine is cancelled before being fulfilled.
+     */
+    forRelease(ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number): LocationWithQuantity[] | Promise<LocationWithQuantity[]>;
+    /**
+     * @description
+     * Determines which StockLocations should be used to when creating a Sale
+     * and reducing the stockOnHand upon fulfillment.
+     */
+    forSale(ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number): LocationWithQuantity[] | Promise<LocationWithQuantity[]>;
+    /**
+     * @description
+     * Determines which StockLocations should be used to when creating a Cancellation
+     * of an OrderLine which has already been fulfilled.
+     */
+    forCancellation(ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number): LocationWithQuantity[] | Promise<LocationWithQuantity[]>;
+}

package/dist/config/catalog/stock-location-strategy.js

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

package/dist/config/catalog/stock-location-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stock-location-strategy.js","sourceRoot":"","sources":["../../../src/config/catalog/stock-location-strategy.ts"],"names":[],"mappings":""}

package/dist/config/config-helpers.d.ts

@@ -0,0 +1,21 @@
+import { PartialDeenruvConfig, RuntimeDeenruvConfig } from "./deenruv-config";
+/**
+ * Reset the activeConfig object back to the initial default state.
+ */
+export declare function resetConfig(): void;
+/**
+ * Override the default config by merging in the supplied values. Should only be used prior to
+ * bootstrapping the app.
+ */
+export declare function setConfig(userConfig: PartialDeenruvConfig): Promise<void>;
+/**
+ * Ensures that the config has been loaded. This is necessary for tests which
+ * do not go through the normal bootstrap process.
+ */
+export declare function ensureConfigLoaded(): Promise<void>;
+/**
+ * Returns the app config object. In general this function should only be
+ * used before bootstrapping the app. In all other contexts, the {@link ConfigService}
+ * should be used to access config settings.
+ */
+export declare function getConfig(): Readonly<RuntimeDeenruvConfig>;

package/dist/config/config-helpers.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfig = exports.ensureConfigLoaded = exports.setConfig = exports.resetConfig = void 0;
+const path_1 = __importDefault(require("path"));
+const merge_config_1 = require("./merge-config");
+let activeConfig;
+const defaultConfigPath = path_1.default.join(__dirname, "default-config");
+/**
+ * Reset the activeConfig object back to the initial default state.
+ */
+function resetConfig() {
+    activeConfig = require(defaultConfigPath).defaultConfig;
+}
+exports.resetConfig = resetConfig;
+/**
+ * Override the default config by merging in the supplied values. Should only be used prior to
+ * bootstrapping the app.
+ */
+async function setConfig(userConfig) {
+    if (!activeConfig) {
+        activeConfig = (await import(defaultConfigPath)).defaultConfig;
+    }
+    activeConfig = (0, merge_config_1.mergeConfig)(activeConfig, userConfig);
+}
+exports.setConfig = setConfig;
+/**
+ * Ensures that the config has been loaded. This is necessary for tests which
+ * do not go through the normal bootstrap process.
+ */
+async function ensureConfigLoaded() {
+    if (!activeConfig) {
+        activeConfig = (await import(defaultConfigPath)).defaultConfig;
+    }
+}
+exports.ensureConfigLoaded = ensureConfigLoaded;
+/**
+ * Returns the app config object. In general this function should only be
+ * used before bootstrapping the app. In all other contexts, the {@link ConfigService}
+ * should be used to access config settings.
+ */
+function getConfig() {
+    if (!activeConfig) {
+        try {
+            activeConfig = require(defaultConfigPath).defaultConfig;
+        }
+        catch (e) {
+            console.log("Error loading config. If this is a test, make sure you have called ensureConfigLoaded() before using the config.");
+        }
+    }
+    return activeConfig;
+}
+exports.getConfig = getConfig;
+//# sourceMappingURL=config-helpers.js.map

package/dist/config/config-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-helpers.js","sourceRoot":"","sources":["../../src/config/config-helpers.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAExB,iDAA6C;AAG7C,IAAI,YAAkC,CAAC;AACvC,MAAM,iBAAiB,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;AACjE;;GAEG;AACH,SAAgB,WAAW;IACzB,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,aAAa,CAAC;AAC1D,CAAC;AAFD,kCAEC;AAED;;;GAGG;AACI,KAAK,UAAU,SAAS,CAAC,UAAgC;IAC9D,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,YAAY,GAAG,CAAC,MAAM,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,aAAa,CAAC;IACjE,CAAC;IACD,YAAY,GAAG,IAAA,0BAAW,EAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AACvD,CAAC;AALD,8BAKC;AAED;;;GAGG;AACI,KAAK,UAAU,kBAAkB;IACtC,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,YAAY,GAAG,CAAC,MAAM,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,aAAa,CAAC;IACjE,CAAC;AACH,CAAC;AAJD,gDAIC;AAED;;;;GAIG;AACH,SAAgB,SAAS;IACvB,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,IAAI,CAAC;YACH,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,aAAa,CAAC;QAC1D,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,OAAO,CAAC,GAAG,CACT,kHAAkH,CACnH,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAXD,8BAWC"}

package/dist/config/config.module.d.ts

@@ -0,0 +1,16 @@
+import { OnApplicationBootstrap, OnApplicationShutdown } from "@nestjs/common";
+import { ModuleRef } from "@nestjs/core";
+import { ConfigService } from "./config.service";
+export declare class ConfigModule implements OnApplicationBootstrap, OnApplicationShutdown {
+    private configService;
+    private moduleRef;
+    constructor(configService: ConfigService, moduleRef: ModuleRef);
+    onApplicationBootstrap(): Promise<void>;
+    onApplicationShutdown(signal?: string): Promise<void>;
+    private initInjectableStrategies;
+    private destroyInjectableStrategies;
+    private initConfigurableOperations;
+    private destroyConfigurableOperations;
+    private getInjectableStrategies;
+    private getConfigurableOperations;
+}

package/dist/config/config.module.js

@@ -0,0 +1,152 @@
+"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 __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigModule = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const injector_1 = require("../common/injector");
+const config_helpers_1 = require("./config-helpers");
+const config_service_1 = require("./config.service");
+let ConfigModule = class ConfigModule {
+    constructor(configService, moduleRef) {
+        this.configService = configService;
+        this.moduleRef = moduleRef;
+    }
+    async onApplicationBootstrap() {
+        await this.initInjectableStrategies();
+        await this.initConfigurableOperations();
+    }
+    async onApplicationShutdown(signal) {
+        await this.destroyInjectableStrategies();
+        await this.destroyConfigurableOperations();
+        /**
+         * When the application shuts down, we reset the activeConfig to the default. Usually this is
+         * redundant, as the app shutdown would normally coincide with the process ending. However, in some
+         * circumstances, such as when running migrations immediately followed by app bootstrap, the activeConfig
+         * will persist between these two applications and mutations e.g. to the CustomFields will result in
+         * hard-to-debug errors. So resetting is a precaution against this scenario.
+         */
+        (0, config_helpers_1.resetConfig)();
+    }
+    async initInjectableStrategies() {
+        const injector = new injector_1.Injector(this.moduleRef);
+        for (const strategy of this.getInjectableStrategies()) {
+            if (typeof strategy.init === "function") {
+                await strategy.init(injector);
+            }
+        }
+    }
+    async destroyInjectableStrategies() {
+        for (const strategy of this.getInjectableStrategies()) {
+            if (typeof strategy.destroy === "function") {
+                await strategy.destroy();
+            }
+        }
+    }
+    async initConfigurableOperations() {
+        const injector = new injector_1.Injector(this.moduleRef);
+        for (const operation of this.getConfigurableOperations()) {
+            await operation.init(injector);
+        }
+    }
+    async destroyConfigurableOperations() {
+        for (const operation of this.getConfigurableOperations()) {
+            await operation.destroy();
+        }
+    }
+    getInjectableStrategies() {
+        const { assetNamingStrategy, assetPreviewStrategy, assetStorageStrategy } = this.configService.assetOptions;
+        const { productVariantPriceCalculationStrategy, productVariantPriceSelectionStrategy, productVariantPriceUpdateStrategy, stockDisplayStrategy, stockLocationStrategy, } = this.configService.catalogOptions;
+        const { adminAuthenticationStrategy, shopAuthenticationStrategy, sessionCacheStrategy, passwordHashingStrategy, passwordValidationStrategy, } = this.configService.authOptions;
+        const { taxZoneStrategy, taxLineCalculationStrategy } = this.configService.taxOptions;
+        const { jobQueueStrategy, jobBufferStorageStrategy } = this.configService.jobQueueOptions;
+        const { mergeStrategy, checkoutMergeStrategy, orderItemPriceCalculationStrategy, process: orderProcess, orderCodeStrategy, orderByCodeAccessStrategy, stockAllocationStrategy, activeOrderStrategy, changedPriceHandlingStrategy, orderSellerStrategy, guestCheckoutStrategy, } = this.configService.orderOptions;
+        const { customFulfillmentProcess, process: fulfillmentProcess, shippingLineAssignmentStrategy, } = this.configService.shippingOptions;
+        const { customPaymentProcess, process: paymentProcess } = this.configService.paymentOptions;
+        const { entityIdStrategy: entityIdStrategyDeprecated } = this.configService;
+        const { entityIdStrategy } = this.configService.entityOptions;
+        const { healthChecks, errorHandlers } = this.configService.systemOptions;
+        const { assetImportStrategy } = this.configService.importExportOptions;
+        const { refundProcess: refundProcess } = this.configService.paymentOptions;
+        return [
+            ...adminAuthenticationStrategy,
+            ...shopAuthenticationStrategy,
+            sessionCacheStrategy,
+            passwordHashingStrategy,
+            passwordValidationStrategy,
+            assetNamingStrategy,
+            assetPreviewStrategy,
+            assetStorageStrategy,
+            taxZoneStrategy,
+            taxLineCalculationStrategy,
+            jobQueueStrategy,
+            jobBufferStorageStrategy,
+            mergeStrategy,
+            checkoutMergeStrategy,
+            orderCodeStrategy,
+            orderByCodeAccessStrategy,
+            entityIdStrategyDeprecated,
+            ...[entityIdStrategy].filter(shared_utils_1.notNullOrUndefined),
+            productVariantPriceCalculationStrategy,
+            productVariantPriceUpdateStrategy,
+            orderItemPriceCalculationStrategy,
+            ...orderProcess,
+            ...customFulfillmentProcess,
+            ...fulfillmentProcess,
+            ...customPaymentProcess,
+            ...paymentProcess,
+            stockAllocationStrategy,
+            stockDisplayStrategy,
+            ...healthChecks,
+            ...errorHandlers,
+            assetImportStrategy,
+            changedPriceHandlingStrategy,
+            ...(Array.isArray(activeOrderStrategy)
+                ? activeOrderStrategy
+                : [activeOrderStrategy]),
+            orderSellerStrategy,
+            shippingLineAssignmentStrategy,
+            stockLocationStrategy,
+            productVariantPriceSelectionStrategy,
+            guestCheckoutStrategy,
+            ...refundProcess,
+        ];
+    }
+    getConfigurableOperations() {
+        const { paymentMethodHandlers, paymentMethodEligibilityCheckers } = this.configService.paymentOptions;
+        const { collectionFilters } = this.configService.catalogOptions;
+        const { entityDuplicators } = this.configService.entityOptions;
+        const { promotionActions, promotionConditions } = this.configService.promotionOptions;
+        const { shippingCalculators, shippingEligibilityCheckers, fulfillmentHandlers, } = this.configService.shippingOptions;
+        return [
+            ...(paymentMethodEligibilityCheckers || []),
+            ...paymentMethodHandlers,
+            ...collectionFilters,
+            ...(promotionActions || []),
+            ...(promotionConditions || []),
+            ...(shippingCalculators || []),
+            ...(shippingEligibilityCheckers || []),
+            ...(fulfillmentHandlers || []),
+            ...(entityDuplicators || []),
+        ];
+    }
+};
+exports.ConfigModule = ConfigModule;
+exports.ConfigModule = ConfigModule = __decorate([
+    (0, common_1.Module)({
+        providers: [config_service_1.ConfigService],
+        exports: [config_service_1.ConfigService],
+    }),
+    __metadata("design:paramtypes", [config_service_1.ConfigService,
+        core_1.ModuleRef])
+], ConfigModule);
+//# sourceMappingURL=config.module.js.map

package/dist/config/config.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.module.js","sourceRoot":"","sources":["../../src/config/config.module.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAIwB;AACxB,uCAAyC;AACzC,mEAAsE;AAGtE,iDAA8C;AAG9C,qDAA+C;AAC/C,qDAAiD;AAM1C,IAAM,YAAY,GAAlB,MAAM,YAAY;IAGvB,YACU,aAA4B,EAC5B,SAAoB;QADpB,kBAAa,GAAb,aAAa,CAAe;QAC5B,cAAS,GAAT,SAAS,CAAW;IAC3B,CAAC;IAEJ,KAAK,CAAC,sBAAsB;QAC1B,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;QACtC,MAAM,IAAI,CAAC,0BAA0B,EAAE,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,qBAAqB,CAAC,MAAe;QACzC,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACzC,MAAM,IAAI,CAAC,6BAA6B,EAAE,CAAC;QAC3C;;;;;;WAMG;QACH,IAAA,4BAAW,GAAE,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,wBAAwB;QACpC,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,uBAAuB,EAAE,EAAE,CAAC;YACtD,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBACxC,MAAM,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,2BAA2B;QACvC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,uBAAuB,EAAE,EAAE,CAAC;YACtD,IAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;gBAC3C,MAAM,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,0BAA0B;QACtC,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9C,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,yBAAyB,EAAE,EAAE,CAAC;YACzD,MAAM,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,6BAA6B;QACzC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,yBAAyB,EAAE,EAAE,CAAC;YACzD,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;IAEO,uBAAuB;QAC7B,MAAM,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,GACvE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;QAClC,MAAM,EACJ,sCAAsC,EACtC,oCAAoC,EACpC,iCAAiC,EACjC,oBAAoB,EACpB,qBAAqB,GACtB,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;QACtC,MAAM,EACJ,2BAA2B,EAC3B,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,GAC3B,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;QACnC,MAAM,EAAE,eAAe,EAAE,0BAA0B,EAAE,GACnD,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC;QAChC,MAAM,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,GAClD,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC;QACrC,MAAM,EACJ,aAAa,EACb,qBAAqB,EACrB,iCAAiC,EACjC,OAAO,EAAE,YAAY,EACrB,iBAAiB,EACjB,yBAAyB,EACzB,uBAAuB,EACvB,mBAAmB,EACnB,4BAA4B,EAC5B,mBAAmB,EACnB,qBAAqB,GACtB,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;QACpC,MAAM,EACJ,wBAAwB,EACxB,OAAO,EAAE,kBAAkB,EAC3B,8BAA8B,GAC/B,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC;QACvC,MAAM,EAAE,oBAAoB,EAAE,OAAO,EAAE,cAAc,EAAE,GACrD,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;QACpC,MAAM,EAAE,gBAAgB,EAAE,0BAA0B,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QAC5E,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;QAC9D,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;QACzE,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC;QACvE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;QAC3E,OAAO;YACL,GAAG,2BAA2B;YAC9B,GAAG,0BAA0B;YAC7B,oBAAoB;YACpB,uBAAuB;YACvB,0BAA0B;YAC1B,mBAAmB;YACnB,oBAAoB;YACpB,oBAAoB;YACpB,eAAe;YACf,0BAA0B;YAC1B,gBAAgB;YAChB,wBAAwB;YACxB,aAAa;YACb,qBAAqB;YACrB,iBAAiB;YACjB,yBAAyB;YACzB,0BAA0B;YAC1B,GAAG,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,iCAAkB,CAAC;YAChD,sCAAsC;YACtC,iCAAiC;YACjC,iCAAiC;YACjC,GAAG,YAAY;YACf,GAAG,wBAAwB;YAC3B,GAAG,kBAAkB;YACrB,GAAG,oBAAoB;YACvB,GAAG,cAAc;YACjB,uBAAuB;YACvB,oBAAoB;YACpB,GAAG,YAAY;YACf,GAAG,aAAa;YAChB,mBAAmB;YACnB,4BAA4B;YAC5B,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,mBAAmB,CAAC;gBACpC,CAAC,CAAC,mBAAmB;gBACrB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;YAC1B,mBAAmB;YACnB,8BAA8B;YAC9B,qBAAqB;YACrB,oCAAoC;YACpC,qBAAqB;YACrB,GAAG,aAAa;SACjB,CAAC;IACJ,CAAC;IAEO,yBAAyB;QAC/B,MAAM,EAAE,qBAAqB,EAAE,gCAAgC,EAAE,GAC/D,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;QACpC,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;QAChE,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;QAC/D,MAAM,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,GAC7C,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC;QACtC,MAAM,EACJ,mBAAmB,EACnB,2BAA2B,EAC3B,mBAAmB,GACpB,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC;QACvC,OAAO;YACL,GAAG,CAAC,gCAAgC,IAAI,EAAE,CAAC;YAC3C,GAAG,qBAAqB;YACxB,GAAG,iBAAiB;YACpB,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAC;YAC3B,GAAG,CAAC,mBAAmB,IAAI,EAAE,CAAC;YAC9B,GAAG,CAAC,mBAAmB,IAAI,EAAE,CAAC;YAC9B,GAAG,CAAC,2BAA2B,IAAI,EAAE,CAAC;YACtC,GAAG,CAAC,mBAAmB,IAAI,EAAE,CAAC;YAC9B,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC;SAC7B,CAAC;IACJ,CAAC;CACF,CAAA;AA3KY,oCAAY;uBAAZ,YAAY;IAJxB,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,CAAC,8BAAa,CAAC;QAC1B,OAAO,EAAE,CAAC,8BAAa,CAAC;KACzB,CAAC;qCAKyB,8BAAa;QACjB,gBAAS;GALnB,YAAY,CA2KxB"}

package/dist/config/config.service.d.ts

@@ -0,0 +1,34 @@
+import { DynamicModule, Type } from "@nestjs/common";
+import { LanguageCode } from "@deenruv/common/lib/generated-types";
+import { DataSourceOptions } from "typeorm";
+import { CustomFields } from "./custom-field/custom-field-types";
+import { EntityIdStrategy } from "./entity/entity-id-strategy";
+import { DeenruvLogger } from "./logger/deenruv-logger";
+import { ApiOptions, AssetOptions, AuthOptions, CatalogOptions, EntityOptions, ImportExportOptions, JobQueueOptions, OrderOptions, PaymentOptions, PromotionOptions, ShippingOptions, SystemOptions, TaxOptions, DeenruvConfig, DataSourceFactoryHook } from "./deenruv-config";
+export declare class ConfigService implements DeenruvConfig {
+    private activeConfig;
+    private allCustomFieldsConfig;
+    constructor();
+    get apiOptions(): Required<ApiOptions>;
+    get authOptions(): Required<AuthOptions>;
+    get catalogOptions(): Required<CatalogOptions>;
+    get defaultChannelToken(): string | null;
+    get defaultLanguageCode(): LanguageCode;
+    get entityOptions(): Required<Omit<EntityOptions, "entityIdStrategy">> & EntityOptions;
+    get entityIdStrategy(): EntityIdStrategy<any>;
+    get assetOptions(): Required<AssetOptions>;
+    get dbConnectionOptions(): DataSourceOptions;
+    get promotionOptions(): Required<PromotionOptions>;
+    get shippingOptions(): Required<ShippingOptions>;
+    get orderOptions(): Required<OrderOptions>;
+    get paymentOptions(): Required<PaymentOptions>;
+    get taxOptions(): Required<TaxOptions>;
+    get importExportOptions(): Required<ImportExportOptions>;
+    get customFields(): Required<CustomFields>;
+    get plugins(): Array<DynamicModule | Type<any>>;
+    get logger(): DeenruvLogger;
+    get jobQueueOptions(): Required<JobQueueOptions>;
+    get systemOptions(): Required<SystemOptions>;
+    get dataSourceHooks(): DataSourceFactoryHook[];
+    private getCustomFieldsForAllEntities;
+}