@acmekit/core-flows 2.13.1

package/dist/product/workflows/update-product-variants.d.ts

@@ -0,0 +1,168 @@
+import { AdditionalData, PricingTypes, ProductTypes } from "@acmekit/framework/types";
+import { WorkflowData } from "@acmekit/framework/workflows-sdk";
+/**
+ * The data to update one or more product variants, along with custom data that's passed to the workflow's hooks.
+ */
+export type UpdateProductVariantsWorkflowInput = ({
+    /**
+     * A filter to select the product variants to update.
+     */
+    selector: ProductTypes.FilterableProductVariantProps;
+    /**
+     * The data to update in the product variants.
+     */
+    update: ProductTypes.UpdateProductVariantDTO & {
+        /**
+         * The product variant's prices.
+         */
+        prices?: Partial<PricingTypes.CreateMoneyAmountDTO>[];
+    };
+} | {
+    /**
+     * The product variants to update.
+     */
+    product_variants: (ProductTypes.UpsertProductVariantDTO & {
+        /**
+         * The product variant's prices.
+         */
+        prices?: Partial<PricingTypes.CreateMoneyAmountDTO>[];
+    })[];
+}) & AdditionalData;
+export declare const updateProductVariantsWorkflowId = "update-product-variants";
+/**
+ * This workflow updates one or more product variants. It's used by the [Update Product Variant Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsidvariantsvariant_id).
+ *
+ * This workflow has a hook that allows you to perform custom actions on the updated product variants. For example, you can pass under `additional_data` custom data that
+ * allows you to update custom data models linked to the product variants.
+ *
+ * You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around product-variant update.
+ *
+ * :::note
+ *
+ * Learn more about adding rules to the product variant's prices in the Pricing Module's
+ * [Price Rules](https://docs.acmekit.com/resources/commerce-modules/pricing/price-rules) documentation.
+ *
+ * :::
+ *
+ * @example
+ * To update product variants by their IDs:
+ *
+ * ```ts
+ * const { result } = await updateProductVariantsWorkflow(container)
+ * .run({
+ *   input: {
+ *     product_variants: [
+ *       {
+ *         id: "variant_123",
+ *         prices: [
+ *           {
+ *             amount: 10,
+ *             currency_code: "usd",
+ *           }
+ *         ]
+ *       },
+ *       {
+ *         id: "variant_321",
+ *         title: "Small Shirt",
+ *       },
+ *     ],
+ *     additional_data: {
+ *       erp_id: "123"
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * You can also update product variants by a selector:
+ *
+ * ```ts
+ * const { result } = await updateProductVariantsWorkflow(container)
+ * .run({
+ *   input: {
+ *     selector: {
+ *       product_id: "prod_123"
+ *     },
+ *     update: {
+ *       prices: [
+ *         {
+ *           amount: 10,
+ *           currency_code: "usd"
+ *         }
+ *       ]
+ *     },
+ *     additional_data: {
+ *       erp_id: "123"
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * @summary
+ *
+ * Update one or more product variants.
+ *
+ * @property hooks.productVariantsUpdated - This hook is executed after the product variants are updated. You can consume this hook to perform custom actions on the updated product variants.
+ */
+export declare const updateProductVariantsWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<UpdateProductVariantsWorkflowInput, {
+    price_set: PricingTypes.PriceSetDTO | undefined;
+    id: string;
+    title: string;
+    sku: string | null;
+    barcode: string | null;
+    ean: string | null;
+    upc: string | null;
+    allow_backorder: boolean;
+    manage_inventory: boolean;
+    thumbnail: string | null;
+    requires_shipping: boolean;
+    hs_code: string | null;
+    origin_country: string | null;
+    mid_code: string | null;
+    material: string | null;
+    weight: number | null;
+    length: number | null;
+    height: number | null;
+    width: number | null;
+    options: ProductTypes.ProductOptionValueDTO[];
+    images: ProductTypes.ProductImageDTO[];
+    metadata: Record<string, unknown> | null;
+    product?: ProductTypes.ProductDTO | null;
+    product_id: string | null;
+    variant_rank?: number | null;
+    created_at: string | Date;
+    updated_at: string | Date;
+    deleted_at: string | Date;
+}[], [import("@acmekit/framework/workflows-sdk").Hook<"productVariantsUpdated", {
+    product_variants: WorkflowData<{
+        price_set: PricingTypes.PriceSetDTO | undefined;
+        id: string;
+        title: string;
+        sku: string | null;
+        barcode: string | null;
+        ean: string | null;
+        upc: string | null;
+        allow_backorder: boolean;
+        manage_inventory: boolean;
+        thumbnail: string | null;
+        requires_shipping: boolean;
+        hs_code: string | null;
+        origin_country: string | null;
+        mid_code: string | null;
+        material: string | null;
+        weight: number | null;
+        length: number | null;
+        height: number | null;
+        width: number | null;
+        options: ProductTypes.ProductOptionValueDTO[];
+        images: ProductTypes.ProductImageDTO[];
+        metadata: Record<string, unknown> | null;
+        product?: ProductTypes.ProductDTO | null;
+        product_id: string | null;
+        variant_rank?: number | null;
+        created_at: string | Date;
+        updated_at: string | Date;
+        deleted_at: string | Date;
+    }[]>;
+    additional_data: ((Record<string, unknown> | WorkflowData<Record<string, unknown> | undefined>) & Record<string, unknown>) | undefined;
+}, unknown>]>;
+//# sourceMappingURL=update-product-variants.d.ts.map

package/dist/product/workflows/update-product-variants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-product-variants.d.ts","sourceRoot":"","sources":["../../../src/product/workflows/update-product-variants.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,YAAY,EACZ,YAAY,EACb,MAAM,0BAA0B,CAAA;AAEjC,OAAO,EACL,YAAY,EAKb,MAAM,kCAAkC,CAAA;AASzC;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,CAC7C;IACE;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC,6BAA6B,CAAA;IACpD;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC,uBAAuB,GAAG;QAC7C;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,oBAAoB,CAAC,EAAE,CAAA;KACtD,CAAA;CACF,GACD;IACE;;OAEG;IACH,gBAAgB,EAAE,CAAC,YAAY,CAAC,uBAAuB,GAAG;QACxD;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,oBAAoB,CAAC,EAAE,CAAA;KACtD,CAAC,EAAE,CAAA;CACL,CACJ,GACC,cAAc,CAAA;AAEhB,eAAO,MAAM,+BAA+B,4BAA4B,CAAA;AACxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aA+JzC,CAAA"}

package/dist/product/workflows/update-product-variants.js

@@ -0,0 +1,199 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateProductVariantsWorkflow = exports.updateProductVariantsWorkflowId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+const pricing_1 = require("../../pricing");
+const steps_1 = require("../steps");
+const get_variant_pricing_link_1 = require("../steps/get-variant-pricing-link");
+exports.updateProductVariantsWorkflowId = "update-product-variants";
+/**
+ * This workflow updates one or more product variants. It's used by the [Update Product Variant Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsidvariantsvariant_id).
+ *
+ * This workflow has a hook that allows you to perform custom actions on the updated product variants. For example, you can pass under `additional_data` custom data that
+ * allows you to update custom data models linked to the product variants.
+ *
+ * You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around product-variant update.
+ *
+ * :::note
+ *
+ * Learn more about adding rules to the product variant's prices in the Pricing Module's
+ * [Price Rules](https://docs.acmekit.com/resources/commerce-modules/pricing/price-rules) documentation.
+ *
+ * :::
+ *
+ * @example
+ * To update product variants by their IDs:
+ *
+ * ```ts
+ * const { result } = await updateProductVariantsWorkflow(container)
+ * .run({
+ *   input: {
+ *     product_variants: [
+ *       {
+ *         id: "variant_123",
+ *         prices: [
+ *           {
+ *             amount: 10,
+ *             currency_code: "usd",
+ *           }
+ *         ]
+ *       },
+ *       {
+ *         id: "variant_321",
+ *         title: "Small Shirt",
+ *       },
+ *     ],
+ *     additional_data: {
+ *       erp_id: "123"
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * You can also update product variants by a selector:
+ *
+ * ```ts
+ * const { result } = await updateProductVariantsWorkflow(container)
+ * .run({
+ *   input: {
+ *     selector: {
+ *       product_id: "prod_123"
+ *     },
+ *     update: {
+ *       prices: [
+ *         {
+ *           amount: 10,
+ *           currency_code: "usd"
+ *         }
+ *       ]
+ *     },
+ *     additional_data: {
+ *       erp_id: "123"
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * @summary
+ *
+ * Update one or more product variants.
+ *
+ * @property hooks.productVariantsUpdated - This hook is executed after the product variants are updated. You can consume this hook to perform custom actions on the updated product variants.
+ */
+exports.updateProductVariantsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.updateProductVariantsWorkflowId, (input) => {
+    // Passing prices to the product module will fail, we want to keep them for after the variant is updated.
+    const updateWithoutPrices = (0, workflows_sdk_1.transform)({ input }, (data) => {
+        if ("product_variants" in data.input) {
+            return {
+                product_variants: data.input.product_variants.map((variant) => {
+                    return {
+                        ...variant,
+                        prices: undefined,
+                    };
+                }),
+            };
+        }
+        return {
+            selector: data.input.selector,
+            update: {
+                ...data.input.update,
+                prices: undefined,
+            },
+        };
+    });
+    const updatedVariants = (0, steps_1.updateProductVariantsStep)(updateWithoutPrices);
+    const variantsToDismissInventory = (0, workflows_sdk_1.transform)({ input, updatedVariants }, (data) => {
+        const variantIds = [];
+        if ("product_variants" in data.input) {
+            for (const variant of data.input.product_variants) {
+                if (variant.id && variant.manage_inventory === false) {
+                    variantIds.push(variant.id);
+                }
+            }
+        }
+        else if (data.input.update &&
+            data.input.update?.manage_inventory === false) {
+            variantIds.push(...data.updatedVariants.map((v) => v.id));
+        }
+        return variantIds;
+    });
+    (0, steps_1.dismissProductVariantsInventoryStep)({
+        variantIds: variantsToDismissInventory,
+    });
+    // We don't want to do any pricing updates if the prices didn't change
+    const variantIds = (0, workflows_sdk_1.transform)({ input, updatedVariants }, (data) => {
+        if ("product_variants" in data.input) {
+            const variantsWithPriceUpdates = new Set(data.input.product_variants.filter((v) => !!v.prices).map((v) => v.id));
+            return data.updatedVariants
+                .map((v) => v.id)
+                .filter((id) => variantsWithPriceUpdates.has(id));
+        }
+        if (!data.input.update.prices) {
+            return [];
+        }
+        return data.updatedVariants.map((v) => v.id);
+    });
+    const variantPriceSetLinks = (0, get_variant_pricing_link_1.getVariantPricingLinkStep)({
+        ids: variantIds,
+    });
+    const pricesToUpdate = (0, workflows_sdk_1.transform)({ input, variantPriceSetLinks }, (data) => {
+        if (!data.variantPriceSetLinks.length) {
+            return {};
+        }
+        if ("product_variants" in data.input) {
+            const priceSets = data.variantPriceSetLinks
+                .map((link) => {
+                if (!("product_variants" in data.input)) {
+                    return;
+                }
+                const variant = data.input.product_variants.find((v) => v.id === link.variant_id);
+                return {
+                    id: link.price_set_id,
+                    prices: variant.prices,
+                };
+            })
+                .filter(Boolean);
+            return { price_sets: priceSets };
+        }
+        return {
+            selector: {
+                id: data.variantPriceSetLinks.map((link) => link.price_set_id),
+            },
+            update: {
+                prices: data.input.update.prices,
+            },
+        };
+    });
+    const updatedPriceSets = (0, pricing_1.updatePriceSetsStep)(pricesToUpdate);
+    // We want to correctly return the variants with their associated price sets and the prices coming from it
+    const response = (0, workflows_sdk_1.transform)({
+        variantPriceSetLinks,
+        updatedVariants,
+        updatedPriceSets,
+    }, (data) => {
+        return data.updatedVariants.map((variant) => {
+            const linkForVariant = data.variantPriceSetLinks?.find((link) => link.variant_id === variant.id);
+            const priceSetForVariant = data.updatedPriceSets?.find((priceSet) => priceSet.id === linkForVariant?.price_set_id);
+            return { ...variant, price_set: priceSetForVariant };
+        });
+    });
+    const variantIdEvents = (0, workflows_sdk_1.transform)({ response }, ({ response }) => {
+        return response?.map((v) => {
+            return { id: v.id };
+        });
+    });
+    (0, common_1.emitEventStep)({
+        eventName: utils_1.ProductVariantWorkflowEvents.UPDATED,
+        data: variantIdEvents,
+    });
+    const productVariantsUpdated = (0, workflows_sdk_1.createHook)("productVariantsUpdated", {
+        product_variants: response,
+        additional_data: input.additional_data,
+    });
+    return new workflows_sdk_1.WorkflowResponse(response, {
+        hooks: [productVariantsUpdated],
+    });
+});
+//# sourceMappingURL=update-product-variants.js.map

package/dist/product/workflows/update-product-variants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-product-variants.js","sourceRoot":"","sources":["../../../src/product/workflows/update-product-variants.ts"],"names":[],"mappings":";;;AAKA,oDAAuE;AACvE,oEAMyC;AACzC,yCAA4C;AAC5C,2CAAmD;AACnD,oCAGiB;AACjB,gFAA6E;AAmChE,QAAA,+BAA+B,GAAG,yBAAyB,CAAA;AACxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACU,QAAA,6BAA6B,GAAG,IAAA,8BAAc,EACzD,uCAA+B,EAC/B,CAAC,KAAuD,EAAE,EAAE;IAC1D,yGAAyG;IACzG,MAAM,mBAAmB,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACxD,IAAI,kBAAkB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACrC,OAAO;gBACL,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;oBAC5D,OAAO;wBACL,GAAG,OAAO;wBACV,MAAM,EAAE,SAAS;qBAClB,CAAA;gBACH,CAAC,CAAC;aACH,CAAA;QACH,CAAC;QAED,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;YAC7B,MAAM,EAAE;gBACN,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM;gBACpB,MAAM,EAAE,SAAS;aAClB;SACF,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,eAAe,GAAG,IAAA,iCAAyB,EAAC,mBAAmB,CAAC,CAAA;IAEtE,MAAM,0BAA0B,GAAG,IAAA,yBAAS,EAC1C,EAAE,KAAK,EAAE,eAAe,EAAE,EAC1B,CAAC,IAAI,EAAE,EAAE;QACP,MAAM,UAAU,GAAa,EAAE,CAAA;QAE/B,IAAI,kBAAkB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACrC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;gBAClD,IAAI,OAAO,CAAC,EAAE,IAAI,OAAO,CAAC,gBAAgB,KAAK,KAAK,EAAE,CAAC;oBACrD,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7B,CAAC;YACH,CAAC;QACH,CAAC;aAAM,IACL,IAAI,CAAC,KAAK,CAAC,MAAM;YACjB,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,gBAAgB,KAAK,KAAK,EAC7C,CAAC;YACD,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC3D,CAAC;QAED,OAAO,UAAU,CAAA;IACnB,CAAC,CACF,CAAA;IAED,IAAA,2CAAmC,EAAC;QAClC,UAAU,EAAE,0BAA0B;KACvC,CAAC,CAAA;IAEF,sEAAsE;IACtE,MAAM,UAAU,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,eAAe,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QAChE,IAAI,kBAAkB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACrC,MAAM,wBAAwB,GAAG,IAAI,GAAG,CACtC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACvE,CAAA;YAED,OAAO,IAAI,CAAC,eAAe;iBACxB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAChB,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;QACrD,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YAC9B,OAAO,EAAE,CAAA;QACX,CAAC;QAED,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,MAAM,oBAAoB,GAAG,IAAA,oDAAyB,EAAC;QACrD,GAAG,EAAE,UAAU;KAChB,CAAC,CAAA;IAEF,MAAM,cAAc,GAAG,IAAA,yBAAS,EAC9B,EAAE,KAAK,EAAE,oBAAoB,EAAE,EAC/B,CAAC,IAAI,EAAE,EAAE;QACP,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC;YACtC,OAAO,EAAE,CAAA;QACX,CAAC;QAED,IAAI,kBAAkB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,IAAI,CAAC,oBAAoB;iBACxC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACZ,IAAI,CAAC,CAAC,kBAAkB,IAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;oBACxC,OAAM;gBACR,CAAC;gBAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAC9C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,UAAU,CAC/B,CAAA;gBAEF,OAAO;oBACL,EAAE,EAAE,IAAI,CAAC,YAAY;oBACrB,MAAM,EAAE,OAAO,CAAC,MAAM;iBACW,CAAA;YACrC,CAAC,CAAC;iBACD,MAAM,CAAC,OAAO,CAAC,CAAA;YAElB,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAA;QAClC,CAAC;QAED,OAAO;YACL,QAAQ,EAAE;gBACR,EAAE,EAAE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;aACvB;YACzC,MAAM,EAAE;gBACN,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM;aACC;SACpC,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,gBAAgB,GAAG,IAAA,6BAAmB,EAAC,cAAc,CAAC,CAAA;IAE5D,0GAA0G;IAC1G,MAAM,QAAQ,GAAG,IAAA,yBAAS,EACxB;QACE,oBAAoB;QACpB,eAAe;QACf,gBAAgB;KACjB,EACD,CAAC,IAAI,EAAE,EAAE;QACP,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YAC1C,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,EAAE,IAAI,CACpD,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,KAAK,OAAO,CAAC,EAAE,CACzC,CAAA;YAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,gBAAgB,EAAE,IAAI,CACpD,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,cAAc,EAAE,YAAY,CAC3D,CAAA;YAED,OAAO,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,CAAA;QACtD,CAAC,CAAC,CAAA;IACJ,CAAC,CACF,CAAA;IAED,MAAM,eAAe,GAAG,IAAA,yBAAS,EAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC/D,OAAO,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACzB,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAA;QACrB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,sBAAa,EAAC;QACZ,SAAS,EAAE,oCAA4B,CAAC,OAAO;QAC/C,IAAI,EAAE,eAAe;KACtB,CAAC,CAAA;IAEF,MAAM,sBAAsB,GAAG,IAAA,0BAAU,EAAC,wBAAwB,EAAE;QAClE,gBAAgB,EAAE,QAAQ;QAC1B,eAAe,EAAE,KAAK,CAAC,eAAe;KACvC,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,QAAQ,EAAE;QACpC,KAAK,EAAE,CAAC,sBAAsB,CAAC;KAChC,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

package/dist/product/workflows/update-products.d.ts

@@ -0,0 +1,139 @@
+import { AdditionalData, ProductTypes, UpdateProductVariantWorkflowInputDTO } from "@acmekit/framework/types";
+import { WorkflowData } from "@acmekit/framework/workflows-sdk";
+/**
+ * Update products that match a specified selector, along with custom data that's passed to the workflow's hooks.
+ */
+export type UpdateProductsWorkflowInputSelector = {
+    /**
+     * The filters to find products to update.
+     */
+    selector: ProductTypes.FilterableProductProps;
+    /**
+     * The data to update the products with.
+     */
+    update: Omit<ProductTypes.UpdateProductDTO, "variants"> & {
+        /**
+         * The sales channels that the products are available in.
+         */
+        sales_channels?: {
+            id: string;
+        }[];
+        /**
+         * The variants to update.
+         */
+        variants?: UpdateProductVariantWorkflowInputDTO[];
+        /**
+         * The shipping profile to set.
+         */
+        shipping_profile_id?: string | null;
+    };
+} & AdditionalData;
+/**
+ * Update one or more products, along with custom data that's passed to the workflow's hooks.
+ */
+export type UpdateProductsWorkflowInputProducts = {
+    /**
+     * The products to update.
+     */
+    products: (Omit<ProductTypes.UpsertProductDTO, "variants"> & {
+        /**
+         * The sales channels that the products are available in.
+         */
+        sales_channels?: {
+            id: string;
+        }[];
+        /**
+         * The variants to update.
+         */
+        variants?: UpdateProductVariantWorkflowInputDTO[];
+        /**
+         * The shipping profile to set.
+         */
+        shipping_profile_id?: string | null;
+    })[];
+} & AdditionalData;
+/**
+ * The data to update one or more products, along with custom data that's passed to the workflow's hooks.
+ */
+export type UpdateProductWorkflowInput = UpdateProductsWorkflowInputSelector | UpdateProductsWorkflowInputProducts;
+export declare const updateProductsWorkflowId = "update-products";
+/**
+ * This workflow updates one or more products. It's used by the [Update Product Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsid).
+ *
+ * This workflow has a hook that allows you to perform custom actions on the updated products. For example, you can pass under `additional_data` custom data that
+ * allows you to update custom data models linked to the products.
+ *
+ * You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around product update.
+ *
+ * :::note
+ *
+ * Learn more about adding rules to the product variant's prices in the Pricing Module's
+ * [Price Rules](https://docs.acmekit.com/resources/commerce-modules/pricing/price-rules) documentation.
+ *
+ * :::
+ *
+ * @example
+ * To update products by their IDs:
+ *
+ * ```ts
+ * const { result } = await updateProductsWorkflow(container)
+ * .run({
+ *   input: {
+ *     products: [
+ *       {
+ *         id: "prod_123",
+ *         title: "Shirts"
+ *       },
+ *       {
+ *         id: "prod_321",
+ *         variants: [
+ *           {
+ *             id: "variant_123",
+ *             options: {
+ *               Size: "S"
+ *             }
+ *           }
+ *         ]
+ *       }
+ *     ],
+ *     additional_data: {
+ *       erp_id: "erp_123"
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * You can also update products by a selector:
+ *
+ * ```ts
+ * const { result } = await updateProductsWorkflow(container)
+ * .run({
+ *   input: {
+ *     selector: {
+ *       type_id: ["ptyp_123"]
+ *     },
+ *     update: {
+ *       description: "This is a shirt product"
+ *     },
+ *     additional_data: {
+ *       erp_id: "erp_123"
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * @summary
+ *
+ * Update one or more products with options and variants.
+ *
+ * @property hooks.productsUpdated - This hook is executed after the products are updated. You can consume this hook to perform custom actions on the updated products.
+ */
+export declare const updateProductsWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<UpdateProductWorkflowInput, ProductTypes.ProductDTO[], [import("@acmekit/framework/workflows-sdk").Hook<"productsUpdated", {
+    products: (ProductTypes.ProductDTO | WorkflowData<ProductTypes.ProductDTO>)[] & ProductTypes.ProductDTO[] & import("@acmekit/framework/workflows-sdk").WorkflowDataProperties<ProductTypes.ProductDTO[]> & {
+        config(config: {
+            name?: string;
+        } & Omit<import("@acmekit/orchestration").TransactionStepsDefinition, "next" | "uuid" | "action">): WorkflowData<ProductTypes.ProductDTO[]>;
+    } & import("@acmekit/framework/workflows-sdk").StepFunctionReturnConfig<ProductTypes.ProductDTO[]>;
+    additional_data: ((Record<string, unknown> | WorkflowData<Record<string, unknown> | undefined>) & Record<string, unknown>) | undefined;
+}, unknown>]>;
+//# sourceMappingURL=update-products.d.ts.map

package/dist/product/workflows/update-products.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-products.d.ts","sourceRoot":"","sources":["../../../src/product/workflows/update-products.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,cAAc,EAEd,YAAY,EACZ,oCAAoC,EACrC,MAAM,0BAA0B,CAAA;AAOjC,OAAO,EACL,YAAY,EAMb,MAAM,kCAAkC,CAAA;AAUzC;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC,sBAAsB,CAAA;IAC7C;;OAEG;IACH,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,GAAG;QACxD;;WAEG;QACH,cAAc,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;QACjC;;WAEG;QACH,QAAQ,CAAC,EAAE,oCAAoC,EAAE,CAAA;QACjD;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACpC,CAAA;CACF,GAAG,cAAc,CAAA;AAElB;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD;;OAEG;IACH,QAAQ,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,GAAG;QAC3D;;WAEG;QACH,cAAc,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;QACjC;;WAEG;QACH,QAAQ,CAAC,EAAE,oCAAoC,EAAE,CAAA;QACjD;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACpC,CAAC,EAAE,CAAA;CACL,GAAG,cAAc,CAAA;AAElB;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAClC,mCAAmC,GACnC,mCAAmC,CAAA;AA4PvC,eAAO,MAAM,wBAAwB,oBAAoB,CAAA;AACzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsEG;AACH,eAAO,MAAM,sBAAsB;;;gBA3T7B,CAAC;;;;aAudN,CAAA"}