@deenruv/core 1.0.0

package/dist/config/catalog/default-collection-filters.js

@@ -0,0 +1,262 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultCollectionFilters = exports.productIdCollectionFilter = exports.variantIdCollectionFilter = exports.variantNameCollectionFilter = exports.facetValueCollectionFilter = exports.combineWithAndArg = exports.randomSuffix = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const errors_1 = require("../../common/error/errors");
+const product_variant_entity_1 = require("../../entity/product-variant/product-variant.entity");
+const collection_filter_1 = require("./collection-filter");
+const { customAlphabet } = require("nanoid");
+/**
+ * @description
+ * Used to created unique key names for DB query parameters, to avoid conflicts if the
+ * same filter is applied multiple times.
+ */
+function randomSuffix(prefix) {
+    const nanoid = customAlphabet("123456789abcdefghijklmnopqrstuvwxyz", 6);
+    return `${prefix}_${nanoid()}`;
+}
+exports.randomSuffix = randomSuffix;
+/**
+ * @description
+ * Add this to your CollectionFilter `args` object to display the standard UI component
+ * for selecting the combination mode when working with multiple filters.
+ */
+exports.combineWithAndArg = {
+    type: "boolean",
+    label: [{ languageCode: generated_types_1.LanguageCode.en, value: "Combination mode" }],
+    description: [
+        {
+            languageCode: generated_types_1.LanguageCode.en,
+            value: "If this filter is being combined with other filters, do all conditions need to be satisfied (AND), or just one or the other (OR)?",
+        },
+    ],
+    defaultValue: true,
+    ui: {
+        component: "combination-mode-form-input",
+    },
+};
+/**
+ * Filters for ProductVariants having the given facetValueIds (including parent Product)
+ */
+exports.facetValueCollectionFilter = new collection_filter_1.CollectionFilter({
+    args: {
+        facetValueIds: {
+            type: "ID",
+            list: true,
+            ui: {
+                component: "facet-value-form-input",
+            },
+            label: [{ languageCode: generated_types_1.LanguageCode.en, value: "Facet values" }],
+        },
+        containsAny: {
+            type: "boolean",
+            label: [{ languageCode: generated_types_1.LanguageCode.en, value: "Contains any" }],
+            description: [
+                {
+                    languageCode: generated_types_1.LanguageCode.en,
+                    value: "If checked, product variants must have at least one of the selected facet values. " +
+                        "If not checked, the variant must have all selected values.",
+                },
+            ],
+        },
+        combineWithAnd: exports.combineWithAndArg,
+    },
+    code: "facet-value-filter",
+    description: [
+        { languageCode: generated_types_1.LanguageCode.en, value: "Filter by facet values" },
+    ],
+    apply: (qb, args) => {
+        const ids = args.facetValueIds;
+        if (ids.length) {
+            // uuid IDs can include `-` chars, which we cannot use in a TypeORM key name.
+            const safeIdsConcat = ids.join("_").replace(/-/g, "_");
+            const idsName = `ids_${safeIdsConcat}`;
+            const countName = `count_${safeIdsConcat}`;
+            const productFacetValues = qb.connection
+                .createQueryBuilder(product_variant_entity_1.ProductVariant, "product_variant")
+                .select("product_variant.id", "variant_id")
+                .addSelect("facet_value.id", "facet_value_id")
+                .leftJoin("product_variant.facetValues", "facet_value")
+                .where(`facet_value.id IN (:...${idsName})`);
+            const variantFacetValues = qb.connection
+                .createQueryBuilder(product_variant_entity_1.ProductVariant, "product_variant")
+                .select("product_variant.id", "variant_id")
+                .addSelect("facet_value.id", "facet_value_id")
+                .leftJoin("product_variant.product", "product")
+                .leftJoin("product.facetValues", "facet_value")
+                .where(`facet_value.id IN (:...${idsName})`);
+            const union = qb.connection
+                .createQueryBuilder()
+                .select("union_table.variant_id")
+                .from(`(${productFacetValues.getQuery()} UNION ${variantFacetValues.getQuery()})`, "union_table")
+                .groupBy("variant_id")
+                .having(`COUNT(*) >= :${countName}`);
+            const variantIds = qb.connection
+                .createQueryBuilder()
+                .select("variant_ids_table.variant_id")
+                .from(`(${union.getQuery()})`, "variant_ids_table");
+            const clause = `productVariant.id IN (${variantIds.getQuery()})`;
+            const params = {
+                [idsName]: ids,
+                [countName]: args.containsAny ? 1 : ids.length,
+            };
+            if (args.combineWithAnd !== false) {
+                qb.andWhere(clause).setParameters(params);
+            }
+            else {
+                qb.orWhere(clause).setParameters(params);
+            }
+        }
+        else {
+            // If no facetValueIds are specified, no ProductVariants will be matched.
+            if (args.combineWithAnd !== false) {
+                qb.andWhere("1 = 0");
+            }
+        }
+        return qb;
+    },
+});
+exports.variantNameCollectionFilter = new collection_filter_1.CollectionFilter({
+    args: {
+        operator: {
+            type: "string",
+            ui: {
+                component: "select-form-input",
+                options: [
+                    { value: "startsWith" },
+                    { value: "endsWith" },
+                    { value: "contains" },
+                    { value: "doesNotContain" },
+                ],
+            },
+        },
+        term: { type: "string" },
+        combineWithAnd: exports.combineWithAndArg,
+    },
+    code: "variant-name-filter",
+    description: [
+        { languageCode: generated_types_1.LanguageCode.en, value: "Filter by product variant name" },
+    ],
+    apply: (qb, args) => {
+        let translationAlias = "variant_name_filter_translation";
+        const termName = randomSuffix("term");
+        const translationsJoin = qb.expressionMap.joinAttributes.find((ja) => ja.entityOrProperty === "productVariant.translations");
+        if (!translationsJoin) {
+            qb.leftJoin("productVariant.translations", translationAlias);
+        }
+        else {
+            translationAlias = translationsJoin.alias.name;
+        }
+        const LIKE = qb.connection.options.type === "postgres" ? "ILIKE" : "LIKE";
+        let clause;
+        let params;
+        switch (args.operator) {
+            case "contains":
+                clause = `${translationAlias}.name ${LIKE} :${termName}`;
+                params = {
+                    [termName]: `%${args.term}%`,
+                };
+                break;
+            case "doesNotContain":
+                clause = `${translationAlias}.name NOT ${LIKE} :${termName}`;
+                params = {
+                    [termName]: `%${args.term}%`,
+                };
+                break;
+            case "startsWith":
+                clause = `${translationAlias}.name ${LIKE} :${termName}`;
+                params = {
+                    [termName]: `${args.term}%`,
+                };
+                break;
+            case "endsWith":
+                clause = `${translationAlias}.name ${LIKE} :${termName}`;
+                params = {
+                    [termName]: `%${args.term}`,
+                };
+                break;
+            default:
+                throw new errors_1.UserInputError(`${args.operator} is not a valid operator`);
+        }
+        if (args.combineWithAnd === false) {
+            return qb.orWhere(clause, params);
+        }
+        else {
+            return qb.andWhere(clause, params);
+        }
+    },
+});
+exports.variantIdCollectionFilter = new collection_filter_1.CollectionFilter({
+    args: {
+        variantIds: {
+            type: "ID",
+            list: true,
+            label: [{ languageCode: generated_types_1.LanguageCode.en, value: "Product variants" }],
+            ui: {
+                component: "product-multi-form-input",
+                selectionMode: "variant",
+            },
+        },
+        combineWithAnd: exports.combineWithAndArg,
+    },
+    code: "variant-id-filter",
+    description: [
+        {
+            languageCode: generated_types_1.LanguageCode.en,
+            value: "Manually select product variants",
+        },
+    ],
+    apply: (qb, args) => {
+        if (args.variantIds.length === 0) {
+            return qb;
+        }
+        const variantIdsKey = randomSuffix("variantIds");
+        const clause = `productVariant.id IN (:...${variantIdsKey})`;
+        const params = { [variantIdsKey]: args.variantIds };
+        if (args.combineWithAnd === false) {
+            return qb.orWhere(clause, params);
+        }
+        else {
+            return qb.andWhere(clause, params);
+        }
+    },
+});
+exports.productIdCollectionFilter = new collection_filter_1.CollectionFilter({
+    args: {
+        productIds: {
+            type: "ID",
+            list: true,
+            label: [{ languageCode: generated_types_1.LanguageCode.en, value: "Products" }],
+            ui: {
+                component: "product-multi-form-input",
+                selectionMode: "product",
+            },
+        },
+        combineWithAnd: exports.combineWithAndArg,
+    },
+    code: "product-id-filter",
+    description: [
+        { languageCode: generated_types_1.LanguageCode.en, value: "Manually select products" },
+    ],
+    apply: (qb, args) => {
+        if (args.productIds.length === 0) {
+            return qb;
+        }
+        const productIdsKey = randomSuffix("productIds");
+        const clause = `productVariant.productId IN (:...${productIdsKey})`;
+        const params = { [productIdsKey]: args.productIds };
+        if (args.combineWithAnd === false) {
+            return qb.orWhere(clause, params);
+        }
+        else {
+            return qb.andWhere(clause, params);
+        }
+    },
+});
+exports.defaultCollectionFilters = [
+    exports.facetValueCollectionFilter,
+    exports.variantNameCollectionFilter,
+    exports.variantIdCollectionFilter,
+    exports.productIdCollectionFilter,
+];
+//# sourceMappingURL=default-collection-filters.js.map

package/dist/config/catalog/default-collection-filters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-collection-filters.js","sourceRoot":"","sources":["../../../src/config/catalog/default-collection-filters.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AAGnE,sDAA2D;AAC3D,gGAAqF;AAErF,2DAAuD;AAEvD,MAAM,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAE7C;;;;GAIG;AACH,SAAgB,YAAY,CAAC,MAAc;IACzC,MAAM,MAAM,GAAG,cAAc,CAAC,qCAAqC,EAAE,CAAC,CAAC,CAAC;IACxE,OAAO,GAAG,MAAM,IAAI,MAAM,EAAY,EAAE,CAAC;AAC3C,CAAC;AAHD,oCAGC;AAED;;;;GAIG;AACU,QAAA,iBAAiB,GAA4B;IACxD,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;IACrE,WAAW,EAAE;QACX;YACE,YAAY,EAAE,8BAAY,CAAC,EAAE;YAE7B,KAAK,EACH,mIAAmI;SACtI;KACF;IACD,YAAY,EAAE,IAAI;IAClB,EAAE,EAAE;QACF,SAAS,EAAE,6BAA6B;KACzC;CACF,CAAC;AAEF;;GAEG;AACU,QAAA,0BAA0B,GAAG,IAAI,oCAAgB,CAAC;IAC7D,IAAI,EAAE;QACJ,aAAa,EAAE;YACb,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI;YACV,EAAE,EAAE;gBACF,SAAS,EAAE,wBAAwB;aACpC;YACD,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;SAClE;QACD,WAAW,EAAE;YACX,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;YACjE,WAAW,EAAE;gBACX;oBACE,YAAY,EAAE,8BAAY,CAAC,EAAE;oBAC7B,KAAK,EACH,oFAAoF;wBACpF,4DAA4D;iBAC/D;aACF;SACF;QACD,cAAc,EAAE,yBAAiB;KAClC;IACD,IAAI,EAAE,oBAAoB;IAC1B,WAAW,EAAE;QACX,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,wBAAwB,EAAE;KACnE;IACD,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE;QAClB,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;QAE/B,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,6EAA6E;YAC7E,MAAM,aAAa,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YACvD,MAAM,OAAO,GAAG,OAAO,aAAa,EAAE,CAAC;YACvC,MAAM,SAAS,GAAG,SAAS,aAAa,EAAE,CAAC;YAC3C,MAAM,kBAAkB,GAAG,EAAE,CAAC,UAAU;iBACrC,kBAAkB,CAAC,uCAAc,EAAE,iBAAiB,CAAC;iBACrD,MAAM,CAAC,oBAAoB,EAAE,YAAY,CAAC;iBAC1C,SAAS,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;iBAC7C,QAAQ,CAAC,6BAA6B,EAAE,aAAa,CAAC;iBACtD,KAAK,CAAC,0BAA0B,OAAO,GAAG,CAAC,CAAC;YAE/C,MAAM,kBAAkB,GAAG,EAAE,CAAC,UAAU;iBACrC,kBAAkB,CAAC,uCAAc,EAAE,iBAAiB,CAAC;iBACrD,MAAM,CAAC,oBAAoB,EAAE,YAAY,CAAC;iBAC1C,SAAS,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;iBAC7C,QAAQ,CAAC,yBAAyB,EAAE,SAAS,CAAC;iBAC9C,QAAQ,CAAC,qBAAqB,EAAE,aAAa,CAAC;iBAC9C,KAAK,CAAC,0BAA0B,OAAO,GAAG,CAAC,CAAC;YAE/C,MAAM,KAAK,GAAG,EAAE,CAAC,UAAU;iBACxB,kBAAkB,EAAE;iBACpB,MAAM,CAAC,wBAAwB,CAAC;iBAChC,IAAI,CACH,IAAI,kBAAkB,CAAC,QAAQ,EAAE,UAAU,kBAAkB,CAAC,QAAQ,EAAE,GAAG,EAC3E,aAAa,CACd;iBACA,OAAO,CAAC,YAAY,CAAC;iBACrB,MAAM,CAAC,gBAAgB,SAAS,EAAE,CAAC,CAAC;YAEvC,MAAM,UAAU,GAAG,EAAE,CAAC,UAAU;iBAC7B,kBAAkB,EAAE;iBACpB,MAAM,CAAC,8BAA8B,CAAC;iBACtC,IAAI,CAAC,IAAI,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,mBAAmB,CAAC,CAAC;YAEtD,MAAM,MAAM,GAAG,yBAAyB,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC;YACjE,MAAM,MAAM,GAAG;gBACb,CAAC,OAAO,CAAC,EAAE,GAAG;gBACd,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM;aAC/C,CAAC;YACF,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC;gBAClC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACN,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;aAAM,CAAC;YACN,yEAAyE;YACzE,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC;gBAClC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,2BAA2B,GAAG,IAAI,oCAAgB,CAAC;IAC9D,IAAI,EAAE;QACJ,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,EAAE,EAAE;gBACF,SAAS,EAAE,mBAAmB;gBAC9B,OAAO,EAAE;oBACP,EAAE,KAAK,EAAE,YAAY,EAAE;oBACvB,EAAE,KAAK,EAAE,UAAU,EAAE;oBACrB,EAAE,KAAK,EAAE,UAAU,EAAE;oBACrB,EAAE,KAAK,EAAE,gBAAgB,EAAE;iBAC5B;aACF;SACF;QACD,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACxB,cAAc,EAAE,yBAAiB;KAClC;IACD,IAAI,EAAE,qBAAqB;IAC3B,WAAW,EAAE;QACX,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,gCAAgC,EAAE;KAC3E;IACD,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE;QAClB,IAAI,gBAAgB,GAAG,iCAAiC,CAAC;QACzD,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QACtC,MAAM,gBAAgB,GAAG,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAC3D,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,gBAAgB,KAAK,6BAA6B,CAC9D,CAAC;QACF,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,EAAE,CAAC,QAAQ,CAAC,6BAA6B,EAAE,gBAAgB,CAAC,CAAC;QAC/D,CAAC;aAAM,CAAC;YACN,gBAAgB,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC;QACjD,CAAC;QACD,MAAM,IAAI,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QAC1E,IAAI,MAAc,CAAC;QACnB,IAAI,MAA8B,CAAC;QACnC,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtB,KAAK,UAAU;gBACb,MAAM,GAAG,GAAG,gBAAgB,SAAS,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACzD,MAAM,GAAG;oBACP,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,GAAG;iBAC7B,CAAC;gBACF,MAAM;YACR,KAAK,gBAAgB;gBACnB,MAAM,GAAG,GAAG,gBAAgB,aAAa,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7D,MAAM,GAAG;oBACP,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,GAAG;iBAC7B,CAAC;gBACF,MAAM;YACR,KAAK,YAAY;gBACf,MAAM,GAAG,GAAG,gBAAgB,SAAS,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACzD,MAAM,GAAG;oBACP,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,GAAG;iBAC5B,CAAC;gBACF,MAAM;YACR,KAAK,UAAU;gBACb,MAAM,GAAG,GAAG,gBAAgB,SAAS,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACzD,MAAM,GAAG;oBACP,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE;iBAC5B,CAAC;gBACF,MAAM;YACR;gBACE,MAAM,IAAI,uBAAc,CAAC,GAAG,IAAI,CAAC,QAAQ,0BAA0B,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC;YAClC,OAAO,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,yBAAyB,GAAG,IAAI,oCAAgB,CAAC;IAC5D,IAAI,EAAE;QACJ,UAAU,EAAE;YACV,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;YACrE,EAAE,EAAE;gBACF,SAAS,EAAE,0BAA0B;gBACrC,aAAa,EAAE,SAAS;aACzB;SACF;QACD,cAAc,EAAE,yBAAiB;KAClC;IACD,IAAI,EAAE,mBAAmB;IACzB,WAAW,EAAE;QACX;YACE,YAAY,EAAE,8BAAY,CAAC,EAAE;YAC7B,KAAK,EAAE,kCAAkC;SAC1C;KACF;IACD,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE;QAClB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,aAAa,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,6BAA6B,aAAa,GAAG,CAAC;QAC7D,MAAM,MAAM,GAAG,EAAE,CAAC,aAAa,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;QACpD,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC;YAClC,OAAO,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,yBAAyB,GAAG,IAAI,oCAAgB,CAAC;IAC5D,IAAI,EAAE;QACJ,UAAU,EAAE;YACV,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;YAC7D,EAAE,EAAE;gBACF,SAAS,EAAE,0BAA0B;gBACrC,aAAa,EAAE,SAAS;aACzB;SACF;QACD,cAAc,EAAE,yBAAiB;KAClC;IACD,IAAI,EAAE,mBAAmB;IACzB,WAAW,EAAE;QACX,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,0BAA0B,EAAE;KACrE;IACD,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE;QAClB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,aAAa,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,oCAAoC,aAAa,GAAG,CAAC;QACpE,MAAM,MAAM,GAAG,EAAE,CAAC,aAAa,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;QACpD,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC;YAClC,OAAO,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,wBAAwB,GAAG;IACtC,kCAA0B;IAC1B,mCAA2B;IAC3B,iCAAyB;IACzB,iCAAyB;CAC1B,CAAC"}

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

@@ -0,0 +1,14 @@
+import { Injector } from "../../common/injector";
+import { PriceCalculationResult } from "../../common/types/common-types";
+import { ProductVariantPriceCalculationArgs, ProductVariantPriceCalculationStrategy } from "./product-variant-price-calculation-strategy";
+/**
+ * @description
+ * A default ProductVariant price calculation function.
+ *
+ * @docsCategory products & stock
+ */
+export declare class DefaultProductVariantPriceCalculationStrategy implements ProductVariantPriceCalculationStrategy {
+    private taxRateService;
+    init(injector: Injector): void;
+    calculate(args: ProductVariantPriceCalculationArgs): Promise<PriceCalculationResult>;
+}

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

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultProductVariantPriceCalculationStrategy = void 0;
+const round_money_1 = require("../../common/round-money");
+const utils_1 = require("../../common/utils");
+const tax_rate_service_1 = require("../../service/services/tax-rate.service");
+/**
+ * @description
+ * A default ProductVariant price calculation function.
+ *
+ * @docsCategory products & stock
+ */
+class DefaultProductVariantPriceCalculationStrategy {
+    init(injector) {
+        this.taxRateService = injector.get(tax_rate_service_1.TaxRateService);
+    }
+    async calculate(args) {
+        const { inputPrice, activeTaxZone, ctx, taxCategory } = args;
+        let price = inputPrice;
+        let priceIncludesTax = false;
+        if (ctx.channel.pricesIncludeTax) {
+            const isDefaultZone = (0, utils_1.idsAreEqual)(activeTaxZone.id, ctx.channel.defaultTaxZone.id);
+            if (isDefaultZone) {
+                priceIncludesTax = true;
+            }
+            else {
+                const taxRateForDefaultZone = await this.taxRateService.getApplicableTaxRate(ctx, ctx.channel.defaultTaxZone, taxCategory);
+                price = (0, round_money_1.roundMoney)(taxRateForDefaultZone.netPriceOf(inputPrice));
+            }
+        }
+        return {
+            price,
+            priceIncludesTax,
+        };
+    }
+}
+exports.DefaultProductVariantPriceCalculationStrategy = DefaultProductVariantPriceCalculationStrategy;
+//# sourceMappingURL=default-product-variant-price-calculation-strategy.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"default-product-variant-price-calculation-strategy.js","sourceRoot":"","sources":["../../../src/config/catalog/default-product-variant-price-calculation-strategy.ts"],"names":[],"mappings":";;;AACA,0DAAsD;AAEtD,8CAAiD;AACjD,8EAAyE;AAOzE;;;;;GAKG;AACH,MAAa,6CAA6C;IAGxD,IAAI,CAAC,QAAkB;QACrB,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,iCAAc,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,SAAS,CACb,IAAwC;QAExC,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAC7D,IAAI,KAAK,GAAG,UAAU,CAAC;QACvB,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAE7B,IAAI,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YACjC,MAAM,aAAa,GAAG,IAAA,mBAAW,EAC/B,aAAa,CAAC,EAAE,EAChB,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAC9B,CAAC;YACF,IAAI,aAAa,EAAE,CAAC;gBAClB,gBAAgB,GAAG,IAAI,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,MAAM,qBAAqB,GACzB,MAAM,IAAI,CAAC,cAAc,CAAC,oBAAoB,CAC5C,GAAG,EACH,GAAG,CAAC,OAAO,CAAC,cAAc,EAC1B,WAAW,CACZ,CAAC;gBACJ,KAAK,GAAG,IAAA,wBAAU,EAAC,qBAAqB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;YACnE,CAAC;QACH,CAAC;QAED,OAAO;YACL,KAAK;YACL,gBAAgB;SACjB,CAAC;IACJ,CAAC;CACF;AArCD,sGAqCC"}

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

@@ -0,0 +1,16 @@
+import { RequestContext } from "../../api/common/request-context";
+import { ProductVariantPrice } from "../../entity/product-variant/product-variant-price.entity";
+import { ProductVariantPriceSelectionStrategy } from "./product-variant-price-selection-strategy";
+/**
+ * @description
+ * The default strategy for selecting the price for a ProductVariant in a given Channel. It
+ * first filters all available prices to those which are in the current Channel, and then
+ * selects the first price which matches the current currency.
+ *
+ * @docsCategory configuration
+ * @docsPage ProductVariantPriceSelectionStrategy
+ * @since 2.0.0
+ */
+export declare class DefaultProductVariantPriceSelectionStrategy implements ProductVariantPriceSelectionStrategy {
+    selectPrice(ctx: RequestContext, prices: ProductVariantPrice[]): ProductVariantPrice | undefined;
+}

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

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultProductVariantPriceSelectionStrategy = void 0;
+const utils_1 = require("../../common/utils");
+/**
+ * @description
+ * The default strategy for selecting the price for a ProductVariant in a given Channel. It
+ * first filters all available prices to those which are in the current Channel, and then
+ * selects the first price which matches the current currency.
+ *
+ * @docsCategory configuration
+ * @docsPage ProductVariantPriceSelectionStrategy
+ * @since 2.0.0
+ */
+class DefaultProductVariantPriceSelectionStrategy {
+    selectPrice(ctx, prices) {
+        const pricesInChannel = prices.filter((p) => (0, utils_1.idsAreEqual)(p.channelId, ctx.channelId));
+        const priceInCurrency = pricesInChannel.find((p) => p.currencyCode === ctx.currencyCode);
+        return priceInCurrency;
+    }
+}
+exports.DefaultProductVariantPriceSelectionStrategy = DefaultProductVariantPriceSelectionStrategy;
+//# sourceMappingURL=default-product-variant-price-selection-strategy.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"default-product-variant-price-selection-strategy.js","sourceRoot":"","sources":["../../../src/config/catalog/default-product-variant-price-selection-strategy.ts"],"names":[],"mappings":";;;AACA,8CAAiD;AAKjD;;;;;;;;;GASG;AACH,MAAa,2CAA2C;IACtD,WAAW,CAAC,GAAmB,EAAE,MAA6B;QAC5D,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAC1C,IAAA,mBAAW,EAAC,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CACxC,CAAC;QACF,MAAM,eAAe,GAAG,eAAe,CAAC,IAAI,CAC1C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,GAAG,CAAC,YAAY,CAC3C,CAAC;QACF,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AAVD,kGAUC"}

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

@@ -0,0 +1,62 @@
+import { RequestContext } from "../../api/common/request-context";
+import { ProductVariantPrice } from "../../entity/product-variant/product-variant-price.entity";
+import { ProductVariantPriceUpdateStrategy } from "./product-variant-price-update-strategy";
+/**
+ * @description
+ * The options available to the {@link DefaultProductVariantPriceUpdateStrategy}.
+ *
+ * @docsCategory configuration
+ * @docsPage ProductVariantPriceUpdateStrategy
+ * @since 2.2.0
+ */
+export interface DefaultProductVariantPriceUpdateStrategyOptions {
+    /**
+     * @description
+     * When `true`, any price changes to a ProductVariant in one Channel will update any other
+     * prices of the same currencyCode in other Channels. Note that if there are different
+     * tax settings across the channels, these will not be taken into account. To handle this
+     * case, a custom strategy should be implemented.
+     */
+    syncPricesAcrossChannels: boolean;
+}
+/**
+ * @description
+ * The default {@link ProductVariantPriceUpdateStrategy} which by default will not update any other
+ * prices when a price is created, updated or deleted.
+ *
+ * If the `syncPricesAcrossChannels` option is set to `true`, then when a price is updated in one Channel,
+ * the price of the same currencyCode in other Channels will be updated to match.  Note that if there are different
+ * tax settings across the channels, these will not be taken into account. To handle this
+ * case, a custom strategy should be implemented.
+ *
+ * @example
+ * ```ts
+ * import { DefaultProductVariantPriceUpdateStrategy, DeenruvConfig } from '\@deenruv/core';
+ *
+ * export const config: DeenruvConfig = {
+ *   // ...
+ *   catalogOptions: {
+ *     // highlight-start
+ *     productVariantPriceUpdateStrategy: new DefaultProductVariantPriceUpdateStrategy({
+ *       syncPricesAcrossChannels: true,
+ *     }),
+ *     // highlight-end
+ *   },
+ *   // ...
+ * };
+ * ```
+ *
+ * @docsCategory configuration
+ * @docsPage ProductVariantPriceUpdateStrategy
+ * @since 2.2.0
+ */
+export declare class DefaultProductVariantPriceUpdateStrategy implements ProductVariantPriceUpdateStrategy {
+    private options;
+    constructor(options: DefaultProductVariantPriceUpdateStrategyOptions);
+    onPriceCreated(ctx: RequestContext, price: ProductVariantPrice): never[];
+    onPriceUpdated(ctx: RequestContext, updatedPrice: ProductVariantPrice, prices: ProductVariantPrice[]): {
+        id: import("@deenruv/common/lib/shared-types").ID;
+        price: number;
+    }[];
+    onPriceDeleted(ctx: RequestContext, deletedPrice: ProductVariantPrice, prices: ProductVariantPrice[]): never[];
+}

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

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultProductVariantPriceUpdateStrategy = void 0;
+/**
+ * @description
+ * The default {@link ProductVariantPriceUpdateStrategy} which by default will not update any other
+ * prices when a price is created, updated or deleted.
+ *
+ * If the `syncPricesAcrossChannels` option is set to `true`, then when a price is updated in one Channel,
+ * the price of the same currencyCode in other Channels will be updated to match.  Note that if there are different
+ * tax settings across the channels, these will not be taken into account. To handle this
+ * case, a custom strategy should be implemented.
+ *
+ * @example
+ * ```ts
+ * import { DefaultProductVariantPriceUpdateStrategy, DeenruvConfig } from '\@deenruv/core';
+ *
+ * export const config: DeenruvConfig = {
+ *   // ...
+ *   catalogOptions: {
+ *     // highlight-start
+ *     productVariantPriceUpdateStrategy: new DefaultProductVariantPriceUpdateStrategy({
+ *       syncPricesAcrossChannels: true,
+ *     }),
+ *     // highlight-end
+ *   },
+ *   // ...
+ * };
+ * ```
+ *
+ * @docsCategory configuration
+ * @docsPage ProductVariantPriceUpdateStrategy
+ * @since 2.2.0
+ */
+class DefaultProductVariantPriceUpdateStrategy {
+    constructor(options) {
+        this.options = options;
+    }
+    onPriceCreated(ctx, price) {
+        return [];
+    }
+    onPriceUpdated(ctx, updatedPrice, prices) {
+        if (this.options.syncPricesAcrossChannels) {
+            return prices
+                .filter((p) => p.currencyCode === updatedPrice.currencyCode)
+                .map((p) => ({
+                id: p.id,
+                price: updatedPrice.price,
+            }));
+        }
+        else {
+            return [];
+        }
+    }
+    onPriceDeleted(ctx, deletedPrice, prices) {
+        return [];
+    }
+}
+exports.DefaultProductVariantPriceUpdateStrategy = DefaultProductVariantPriceUpdateStrategy;
+//# sourceMappingURL=default-product-variant-price-update-strategy.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"default-product-variant-price-update-strategy.js","sourceRoot":"","sources":["../../../src/config/catalog/default-product-variant-price-update-strategy.ts"],"names":[],"mappings":";;;AAwBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAa,wCAAwC;IACnD,YACU,OAAwD;QAAxD,YAAO,GAAP,OAAO,CAAiD;IAC/D,CAAC;IAEJ,cAAc,CAAC,GAAmB,EAAE,KAA0B;QAC5D,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,cAAc,CACZ,GAAmB,EACnB,YAAiC,EACjC,MAA6B;QAE7B,IAAI,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC;YAC1C,OAAO,MAAM;iBACV,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,YAAY,CAAC,YAAY,CAAC;iBAC3D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACX,EAAE,EAAE,CAAC,CAAC,EAAE;gBACR,KAAK,EAAE,YAAY,CAAC,KAAK;aAC1B,CAAC,CAAC,CAAC;QACR,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAED,cAAc,CACZ,GAAmB,EACnB,YAAiC,EACjC,MAA6B;QAE7B,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAjCD,4FAiCC"}

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

@@ -0,0 +1,16 @@
+import { RequestContext } from "../../api/common/request-context";
+import { ProductVariant } from "../../entity/product-variant/product-variant.entity";
+import { StockDisplayStrategy } from "./stock-display-strategy";
+/**
+ * @description
+ * Displays the `ProductVariant.stockLevel` as either `'IN_STOCK'`, `'OUT_OF_STOCK'` or `'LOW_STOCK'`.
+ * Low stock is defined as a saleable stock level less than or equal to the `lowStockLevel` as passed in
+ * to the constructor (defaults to `2`).
+ *
+ * @docsCategory products & stock
+ */
+export declare class DefaultStockDisplayStrategy implements StockDisplayStrategy {
+    private lowStockLevel;
+    constructor(lowStockLevel?: number);
+    getStockLevel(ctx: RequestContext, productVariant: ProductVariant, saleableStockLevel: number): string;
+}

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultStockDisplayStrategy = void 0;
+/**
+ * @description
+ * Displays the `ProductVariant.stockLevel` as either `'IN_STOCK'`, `'OUT_OF_STOCK'` or `'LOW_STOCK'`.
+ * Low stock is defined as a saleable stock level less than or equal to the `lowStockLevel` as passed in
+ * to the constructor (defaults to `2`).
+ *
+ * @docsCategory products & stock
+ */
+class DefaultStockDisplayStrategy {
+    constructor(lowStockLevel = 2) {
+        this.lowStockLevel = lowStockLevel;
+    }
+    getStockLevel(ctx, productVariant, saleableStockLevel) {
+        return saleableStockLevel < 1
+            ? "OUT_OF_STOCK"
+            : saleableStockLevel <= this.lowStockLevel
+                ? "LOW_STOCK"
+                : "IN_STOCK";
+    }
+}
+exports.DefaultStockDisplayStrategy = DefaultStockDisplayStrategy;
+//# sourceMappingURL=default-stock-display-strategy.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"default-stock-display-strategy.js","sourceRoot":"","sources":["../../../src/config/catalog/default-stock-display-strategy.ts"],"names":[],"mappings":";;;AAKA;;;;;;;GAOG;AACH,MAAa,2BAA2B;IACtC,YAAoB,gBAAwB,CAAC;QAAzB,kBAAa,GAAb,aAAa,CAAY;IAAG,CAAC;IACjD,aAAa,CACX,GAAmB,EACnB,cAA8B,EAC9B,kBAA0B;QAE1B,OAAO,kBAAkB,GAAG,CAAC;YAC3B,CAAC,CAAC,cAAc;YAChB,CAAC,CAAC,kBAAkB,IAAI,IAAI,CAAC,aAAa;gBACxC,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,UAAU,CAAC;IACnB,CAAC;CACF;AAbD,kEAaC"}

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

@@ -0,0 +1,26 @@
+import { ID } from "@deenruv/common/lib/shared-types";
+import { RequestContext } from "../../api/common/request-context";
+import { Injector } from "../../common/injector";
+import { TransactionalConnection } from "../../connection/transactional-connection";
+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";
+import { AvailableStock, LocationWithQuantity, StockLocationStrategy } from "./stock-location-strategy";
+/**
+ * @description
+ * The DefaultStockLocationStrategy is the default implementation of the {@link StockLocationStrategy}.
+ * It assumes only a single StockLocation and that all stock is allocated from that location.
+ *
+ * @docsCategory products & stock
+ * @since 2.0.0
+ */
+export declare class DefaultStockLocationStrategy implements StockLocationStrategy {
+    protected connection: TransactionalConnection;
+    init(injector: Injector): void;
+    getAvailableStock(ctx: RequestContext, productVariantId: ID, stockLevels: StockLevel[]): AvailableStock;
+    forAllocation(ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number): LocationWithQuantity[] | Promise<LocationWithQuantity[]>;
+    forCancellation(ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number): Promise<LocationWithQuantity[]>;
+    forRelease(ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number): Promise<LocationWithQuantity[]>;
+    forSale(ctx: RequestContext, stockLocations: StockLocation[], orderLine: OrderLine, quantity: number): Promise<LocationWithQuantity[]>;
+    private getLocationsBasedOnAllocations;
+}

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

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultStockLocationStrategy = void 0;
+const utils_1 = require("../../common/utils");
+const transactional_connection_1 = require("../../connection/transactional-connection");
+const allocation_entity_1 = require("../../entity/stock-movement/allocation.entity");
+/**
+ * @description
+ * The DefaultStockLocationStrategy is the default implementation of the {@link StockLocationStrategy}.
+ * It assumes only a single StockLocation and that all stock is allocated from that location.
+ *
+ * @docsCategory products & stock
+ * @since 2.0.0
+ */
+class DefaultStockLocationStrategy {
+    init(injector) {
+        this.connection = injector.get(transactional_connection_1.TransactionalConnection);
+    }
+    getAvailableStock(ctx, productVariantId, stockLevels) {
+        let stockOnHand = 0;
+        let stockAllocated = 0;
+        for (const stockLevel of stockLevels) {
+            stockOnHand += stockLevel.stockOnHand;
+            stockAllocated += stockLevel.stockAllocated;
+        }
+        return { stockOnHand, stockAllocated };
+    }
+    forAllocation(ctx, stockLocations, orderLine, quantity) {
+        return [{ location: stockLocations[0], quantity }];
+    }
+    async forCancellation(ctx, stockLocations, orderLine, quantity) {
+        return this.getLocationsBasedOnAllocations(ctx, stockLocations, orderLine, quantity);
+    }
+    async forRelease(ctx, stockLocations, orderLine, quantity) {
+        return this.getLocationsBasedOnAllocations(ctx, stockLocations, orderLine, quantity);
+    }
+    async forSale(ctx, stockLocations, orderLine, quantity) {
+        return this.getLocationsBasedOnAllocations(ctx, stockLocations, orderLine, quantity);
+    }
+    async getLocationsBasedOnAllocations(ctx, stockLocations, orderLine, quantity) {
+        const allocations = await this.connection
+            .getRepository(ctx, allocation_entity_1.Allocation)
+            .find({
+            where: {
+                orderLine: { id: orderLine.id },
+            },
+        });
+        let unallocated = quantity;
+        const quantityByLocationId = new Map();
+        for (const allocation of allocations) {
+            if (unallocated <= 0) {
+                break;
+            }
+            const qtyAtLocation = quantityByLocationId.get(allocation.stockLocationId);
+            const qtyToAdd = Math.min(allocation.quantity, unallocated);
+            if (qtyAtLocation != null) {
+                quantityByLocationId.set(allocation.stockLocationId, qtyAtLocation + qtyToAdd);
+            }
+            else {
+                quantityByLocationId.set(allocation.stockLocationId, qtyToAdd);
+            }
+            unallocated -= qtyToAdd;
+        }
+        return [...quantityByLocationId.entries()].map(([locationId, qty]) => ({
+            location: stockLocations.find((l) => (0, utils_1.idsAreEqual)(l.id, locationId)),
+            quantity: qty,
+        }));
+    }
+}
+exports.DefaultStockLocationStrategy = DefaultStockLocationStrategy;
+//# sourceMappingURL=default-stock-location-strategy.js.map