@acmekit/core-flows 2.13.1

package/dist/fulfillment/steps/validate-shipment.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateShipmentStep = exports.validateShipmentStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.validateShipmentStepId = "validate-shipment";
+/**
+ * This step validates that a shipment can be created for a fulfillment.
+ * If the shipment has already been created, the fulfillment has been canceled,
+ * or the fulfillment does not have a shipping option, the step throws an error.
+ */
+exports.validateShipmentStep = (0, workflows_sdk_1.createStep)(exports.validateShipmentStepId, async (id, { container }) => {
+    const service = container.resolve(utils_1.Modules.FULFILLMENT);
+    const fulfillment = await service.retrieveFulfillment(id, {
+        select: ["shipped_at", "canceled_at", "shipping_option_id"],
+    });
+    if (fulfillment.shipped_at) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.NOT_ALLOWED, "Shipment has already been created");
+    }
+    if (fulfillment.canceled_at) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.NOT_ALLOWED, "Cannot create shipment for a canceled fulfillment");
+    }
+    if (!fulfillment.shipping_option_id) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.NOT_ALLOWED, "Cannot create shipment without a Shipping Option");
+    }
+    return new workflows_sdk_1.StepResponse(void 0);
+});
+//# sourceMappingURL=validate-shipment.js.map

package/dist/fulfillment/steps/validate-shipment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-shipment.js","sourceRoot":"","sources":["../../../src/fulfillment/steps/validate-shipment.ts"],"names":[],"mappings":";;;AACA,oDAAgE;AAChE,oEAA2E;AAO9D,QAAA,sBAAsB,GAAG,mBAAmB,CAAA;AACzD;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,IAAA,0BAAU,EAC5C,8BAAsB,EACtB,KAAK,EAAE,EAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAC/B,eAAO,CAAC,WAAW,CACpB,CAAA;IACD,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,EAAE,EAAE;QACxD,MAAM,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC;KAC5D,CAAC,CAAA;IAEF,IAAI,WAAW,CAAC,UAAU,EAAE,CAAC;QAC3B,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,WAAW,EAC9B,mCAAmC,CACpC,CAAA;IACH,CAAC;IAED,IAAI,WAAW,CAAC,WAAW,EAAE,CAAC;QAC5B,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,WAAW,EAC9B,mDAAmD,CACpD,CAAA;IACH,CAAC;IAED,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,CAAC;QACpC,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,WAAW,EAC9B,kDAAkD,CACnD,CAAA;IACH,CAAC;IAED,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAC,CAAA;AACjC,CAAC,CACF,CAAA"}

package/dist/fulfillment/steps/validate-shipping-option-prices.d.ts

@@ -0,0 +1,32 @@
+import type { FulfillmentWorkflow } from "@acmekit/framework/types";
+/**
+ * The data to validate shipping option prices.
+ */
+export type ValidateShippingOptionPricesStepInput = (FulfillmentWorkflow.CreateShippingOptionsWorkflowInput | FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput)[];
+export declare const validateShippingOptionPricesStepId = "validate-shipping-option-prices";
+/**
+ * This step validates that shipping options can be created based on provided price configuration.
+ *
+ * For flat rate prices, it validates that regions exist for the shipping option prices.
+ * For calculated prices, it validates with the fulfillment provider if the price can be calculated.
+ *
+ * If not valid, the step throws an error.
+ *
+ * @example
+ * const data = validateShippingOptionPricesStep([
+ *   {
+ *     name: "Standard Shipping",
+ *     service_zone_id: "serzo_123",
+ *     shipping_profile_id: "sp_123",
+ *     provider_id: "prov_123",
+ *     type: {
+ *       label: "Standard",
+ *       description: "Standard shipping",
+ *       code: "standard"
+ *     },
+ *     price_type: "calculated",
+ *   }
+ * ])
+ */
+export declare const validateShippingOptionPricesStep: import("@acmekit/framework/workflows-sdk").StepFunction<ValidateShippingOptionPricesStepInput, undefined>;
+//# sourceMappingURL=validate-shipping-option-prices.d.ts.map

package/dist/fulfillment/steps/validate-shipping-option-prices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-shipping-option-prices.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/steps/validate-shipping-option-prices.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AASnE;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG,CAChD,mBAAmB,CAAC,kCAAkC,GACtD,mBAAmB,CAAC,kCAAkC,CACzD,EAAE,CAAA;AAEH,eAAO,MAAM,kCAAkC,oCACZ,CAAA;AAEnC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,gCAAgC,2GAmG5C,CAAA"}

package/dist/fulfillment/steps/validate-shipping-option-prices.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateShippingOptionPricesStep = exports.validateShippingOptionPricesStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.validateShippingOptionPricesStepId = "validate-shipping-option-prices";
+/**
+ * This step validates that shipping options can be created based on provided price configuration.
+ *
+ * For flat rate prices, it validates that regions exist for the shipping option prices.
+ * For calculated prices, it validates with the fulfillment provider if the price can be calculated.
+ *
+ * If not valid, the step throws an error.
+ *
+ * @example
+ * const data = validateShippingOptionPricesStep([
+ *   {
+ *     name: "Standard Shipping",
+ *     service_zone_id: "serzo_123",
+ *     shipping_profile_id: "sp_123",
+ *     provider_id: "prov_123",
+ *     type: {
+ *       label: "Standard",
+ *       description: "Standard shipping",
+ *       code: "standard"
+ *     },
+ *     price_type: "calculated",
+ *   }
+ * ])
+ */
+exports.validateShippingOptionPricesStep = (0, workflows_sdk_1.createStep)(exports.validateShippingOptionPricesStepId, async (options, { container }) => {
+    const fulfillmentModuleService = container.resolve(utils_1.Modules.FULFILLMENT);
+    const optionIds = options.map((option) => option.id);
+    if (optionIds.length) {
+        /**
+         * This means we are validating an update of shipping options.
+         * We need to ensure that all shipping options have price_type set
+         * to correctly determine price updates.
+         *
+         * (On create, price_type must be defined already.)
+         */
+        const shippingOptions = await fulfillmentModuleService.listShippingOptions({
+            id: optionIds,
+        }, { select: ["id", "price_type", "provider_id"] });
+        const optionsMap = new Map(shippingOptions.map((option) => [option.id, option]));
+        options.forEach((option) => {
+            option.price_type =
+                option.price_type ?? optionsMap.get(option.id)?.price_type;
+            option.provider_id =
+                option.provider_id ?? optionsMap.get(option.id)?.provider_id;
+        });
+    }
+    const flatRatePrices = [];
+    const calculatedOptions = [];
+    options.forEach((option) => {
+        if (option.price_type === utils_1.ShippingOptionPriceType.FLAT) {
+            flatRatePrices.push(...(option.prices ?? []));
+        }
+        if (option.price_type === utils_1.ShippingOptionPriceType.CALCULATED) {
+            calculatedOptions.push(option);
+        }
+    });
+    const validation = await fulfillmentModuleService.validateShippingOptionsForPriceCalculation(calculatedOptions);
+    if (validation.some((v) => !v)) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Cannot calcuate pricing for: [${calculatedOptions
+            .filter((o, i) => !validation[i])
+            .map((o) => o.name)
+            .join(", ")}] shipping option(s).`);
+    }
+    const regionIdSet = new Set();
+    flatRatePrices.forEach((price) => {
+        if ("region_id" in price && price.region_id) {
+            regionIdSet.add(price.region_id);
+        }
+    });
+    if (regionIdSet.size === 0) {
+        return new workflows_sdk_1.StepResponse(void 0);
+    }
+    const regionService = container.resolve(utils_1.Modules.REGION);
+    const regionList = await regionService.listRegions({
+        id: Array.from(regionIdSet),
+    });
+    if (regionList.length !== regionIdSet.size) {
+        const missingRegions = Array.from(regionIdSet).filter((id) => !regionList.some((region) => region.id === id));
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Cannot create prices for non-existent regions. Region with ids [${missingRegions.join(", ")}] were not found.`);
+    }
+    return new workflows_sdk_1.StepResponse(void 0);
+});
+//# sourceMappingURL=validate-shipping-option-prices.js.map

package/dist/fulfillment/steps/validate-shipping-option-prices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-shipping-option-prices.js","sourceRoot":"","sources":["../../../src/fulfillment/steps/validate-shipping-option-prices.ts"],"names":[],"mappings":";;;AACA,oDAIiC;AACjC,oEAA2E;AAW9D,QAAA,kCAAkC,GAC7C,iCAAiC,CAAA;AAEnC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACU,QAAA,gCAAgC,GAAG,IAAA,0BAAU,EACxD,0CAAkC,EAClC,KAAK,EAAE,OAA8C,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACtE,MAAM,wBAAwB,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,WAAW,CAAC,CAAA;IAEvE,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAC3B,CAAC,MAAM,EAAE,EAAE,CACR,MAAiE,CAAC,EAAE,CACxE,CAAA;IAED,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;QACrB;;;;;;WAMG;QACH,MAAM,eAAe,GACnB,MAAM,wBAAwB,CAAC,mBAAmB,CAChD;YACE,EAAE,EAAE,SAAS;SACd,EACD,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,aAAa,CAAC,EAAE,CAChD,CAAA;QAEH,MAAM,UAAU,GAAG,IAAI,GAAG,CACxB,eAAe,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CACrD,CAEA;QACC,OACD,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACnB,MAAM,CAAC,UAAU;gBACf,MAAM,CAAC,UAAU,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,UAAU,CAAA;YAC5D,MAAM,CAAC,WAAW;gBAChB,MAAM,CAAC,WAAW,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,WAAW,CAAA;QAChE,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,cAAc,GAClB,EAAE,CAAA;IACJ,MAAM,iBAAiB,GAA0C,EAAE,CAAA;IAEnE,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACzB,IAAI,MAAM,CAAC,UAAU,KAAK,+BAAuB,CAAC,IAAI,EAAE,CAAC;YACvD,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAA;QAC/C,CAAC;QACD,IAAI,MAAM,CAAC,UAAU,KAAK,+BAAuB,CAAC,UAAU,EAAE,CAAC;YAC7D,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAChC,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,UAAU,GACd,MAAM,wBAAwB,CAAC,0CAA0C,CACvE,iBAA8C,CAC/C,CAAA;IAEH,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,iCAAiC,iBAAiB;aAC/C,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;aAChC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;aAClB,IAAI,CAAC,IAAI,CAAC,uBAAuB,CACrC,CAAA;IACH,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAA;IAErC,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC/B,IAAI,WAAW,IAAI,KAAK,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YAC5C,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QAClC,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,IAAI,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAC,CAAA;IACjC,CAAC;IAED,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,MAAM,CAAC,CAAA;IACvD,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC;QACjD,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC;KAC5B,CAAC,CAAA;IAEF,IAAI,UAAU,CAAC,MAAM,KAAK,WAAW,CAAC,IAAI,EAAE,CAAC;QAC3C,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CACnD,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CACvD,CAAA;QACD,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,mEAAmE,cAAc,CAAC,IAAI,CACpF,IAAI,CACL,mBAAmB,CACrB,CAAA;IACH,CAAC;IAED,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAC,CAAA;AACjC,CAAC,CACF,CAAA"}

package/dist/fulfillment/workflows/batch-shipping-option-rules.d.ts

@@ -0,0 +1,55 @@
+import { BatchWorkflowInput, BatchWorkflowOutput, CreateShippingOptionRuleDTO, ShippingOptionRuleDTO, UpdateShippingOptionRuleDTO } from "@acmekit/framework/types";
+/**
+ * The data to manage the shipping option rules in bulk.
+ *
+ * @property create - The shipping option rules to create.
+ * @property update - The shipping option rules to update.
+ * @property delete - The IDs of the shipping option rules to delete.
+ */
+export interface BatchShippingOptionRulesInput extends BatchWorkflowInput<CreateShippingOptionRuleDTO, UpdateShippingOptionRuleDTO> {
+}
+/**
+ * The result of managing the shipping option rules in bulk.
+ *
+ * @property created - The shipping option rules that were created.
+ * @property updated - The shipping option rules that were updated.
+ * @property deleted - The IDs of the shipping option rules that were deleted.
+ */
+export interface BatchShippingOptionRulesOutput extends BatchWorkflowOutput<ShippingOptionRuleDTO> {
+}
+export declare const batchShippingOptionRulesWorkflowId = "batch-shipping-option-rules";
+/**
+ * This workflow manages shipping option rules allowing you to create, update, or delete them. It's used by the
+ * [Manage the Rules of Shipping Option Admin API Route](https://docs.acmekit.com/api/admin#shipping-options_postshippingoptionsidrulesbatch).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * manage shipping option rules within your custom flows.
+ *
+ * @example
+ * const { result } = await batchShippingOptionRulesWorkflow(container)
+ * .run({
+ *   input: {
+ *     create: [
+ *       {
+ *         attribute: "customer_group",
+ *         value: "cusgrp_123",
+ *         operator: "eq",
+ *         shipping_option_id: "so_123"
+ *       }
+ *     ],
+ *     update: [
+ *       {
+ *         id: "sor_123",
+ *         operator: "in"
+ *       }
+ *     ],
+ *     delete: ["sor_321"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Manage shipping option rules.
+ */
+export declare const batchShippingOptionRulesWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<BatchShippingOptionRulesInput, BatchShippingOptionRulesOutput, []>;
+//# sourceMappingURL=batch-shipping-option-rules.d.ts.map

package/dist/fulfillment/workflows/batch-shipping-option-rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch-shipping-option-rules.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/workflows/batch-shipping-option-rules.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,2BAA2B,EAC3B,qBAAqB,EACrB,2BAA2B,EAC5B,MAAM,0BAA0B,CAAA;AAcjC;;;;;;GAMG;AACH,MAAM,WAAW,6BAA8B,SAAQ,kBAAkB,CACvE,2BAA2B,EAC3B,2BAA2B,CAC5B;CAAG;AAEJ;;;;;;GAMG;AACH,MAAM,WAAW,8BAA+B,SAAQ,mBAAmB,CAAC,qBAAqB,CAAC;CAAG;AAErG,eAAO,MAAM,kCAAkC,gCAAgC,CAAA;AAC/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,gCAAgC,8HAwB5C,CAAA"}

package/dist/fulfillment/workflows/batch-shipping-option-rules.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.batchShippingOptionRulesWorkflow = exports.batchShippingOptionRulesWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+const update_shipping_option_rules_1 = require("../steps/update-shipping-option-rules");
+exports.batchShippingOptionRulesWorkflowId = "batch-shipping-option-rules";
+/**
+ * This workflow manages shipping option rules allowing you to create, update, or delete them. It's used by the
+ * [Manage the Rules of Shipping Option Admin API Route](https://docs.acmekit.com/api/admin#shipping-options_postshippingoptionsidrulesbatch).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * manage shipping option rules within your custom flows.
+ *
+ * @example
+ * const { result } = await batchShippingOptionRulesWorkflow(container)
+ * .run({
+ *   input: {
+ *     create: [
+ *       {
+ *         attribute: "customer_group",
+ *         value: "cusgrp_123",
+ *         operator: "eq",
+ *         shipping_option_id: "so_123"
+ *       }
+ *     ],
+ *     update: [
+ *       {
+ *         id: "sor_123",
+ *         operator: "in"
+ *       }
+ *     ],
+ *     delete: ["sor_321"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Manage shipping option rules.
+ */
+exports.batchShippingOptionRulesWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.batchShippingOptionRulesWorkflowId, (input) => {
+    const actionInputs = (0, workflows_sdk_1.transform)({ input }, (data) => {
+        const { create, update, delete: del } = data.input;
+        return {
+            createInput: { data: create ?? [] },
+            updateInput: { data: update ?? [] },
+            deleteInput: { ids: del ?? [] },
+        };
+    });
+    const [created, updated, deleted] = (0, workflows_sdk_1.parallelize)((0, steps_1.createShippingOptionRulesStep)(actionInputs.createInput), (0, update_shipping_option_rules_1.updateShippingOptionRulesStep)(actionInputs.updateInput), (0, steps_1.deleteShippingOptionRulesStep)(actionInputs.deleteInput));
+    return new workflows_sdk_1.WorkflowResponse((0, workflows_sdk_1.transform)({ created, deleted, updated }, (data) => data));
+});
+//# sourceMappingURL=batch-shipping-option-rules.js.map

package/dist/fulfillment/workflows/batch-shipping-option-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch-shipping-option-rules.js","sourceRoot":"","sources":["../../../src/fulfillment/workflows/batch-shipping-option-rules.ts"],"names":[],"mappings":";;;AAOA,oEAMyC;AACzC,oCAGiB;AACjB,wFAAqF;AAuBxE,QAAA,kCAAkC,GAAG,6BAA6B,CAAA;AAC/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACU,QAAA,gCAAgC,GAAG,IAAA,8BAAc,EAC5D,0CAAkC,EAClC,CACE,KAAkD,EACA,EAAE;IACpD,MAAM,YAAY,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACjD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAA;QAClD,OAAO;YACL,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,IAAI,EAAE,EAAE;YACnC,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,IAAI,EAAE,EAAE;YACnC,WAAW,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,EAAE;SAChC,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,IAAA,2BAAW,EAC7C,IAAA,qCAA6B,EAAC,YAAY,CAAC,WAAW,CAAC,EACvD,IAAA,4DAA6B,EAAC,YAAY,CAAC,WAAW,CAAC,EACvD,IAAA,qCAA6B,EAAC,YAAY,CAAC,WAAW,CAAC,CACxD,CAAA;IAED,OAAO,IAAI,gCAAgB,CACzB,IAAA,yBAAS,EAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CACzD,CAAA;AACH,CAAC,CACF,CAAA"}

package/dist/fulfillment/workflows/calculate-shipping-options-prices.d.ts

@@ -0,0 +1,39 @@
+import type { FulfillmentWorkflow } from "@acmekit/framework/types";
+export declare const calculateShippingOptionsPricesWorkflowId = "calculate-shipping-options-prices-workflow";
+/**
+ * This workflow calculates the prices for one or more shipping options in a cart. It's used by the
+ * [Calculate Shipping Option Price Store API Route](https://docs.acmekit.com/api/store#shipping-options_postshippingoptionsidcalculate).
+ *
+ * :::note
+ *
+ * Calculating shipping option prices may require sending requests to third-party fulfillment services.
+ * This depends on the implementation of the fulfillment provider associated with the shipping option.
+ *
+ * :::
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * calculate the prices of shipping options within your custom flows.
+ *
+ * @example
+ * const { result } = await calculateShippingOptionsPricesWorkflow(container)
+ * .run({
+ *   input: {
+ *     cart_id: "cart_123",
+ *     shipping_options: [
+ *       {
+ *         id: "so_123",
+ *         data: {
+ *           // custom data relevant for the fulfillment provider
+ *           carrier_code: "ups",
+ *         }
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Calculate shipping option prices in a cart.
+ */
+export declare const calculateShippingOptionsPricesWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowInput, FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowOutput, []>;
+//# sourceMappingURL=calculate-shipping-options-prices.d.ts.map

package/dist/fulfillment/workflows/calculate-shipping-options-prices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculate-shipping-options-prices.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/workflows/calculate-shipping-options-prices.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAWnE,eAAO,MAAM,wCAAwC,+CACP,CAAA;AAC9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,sCAAsC,kMAoGlD,CAAA"}

package/dist/fulfillment/workflows/calculate-shipping-options-prices.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateShippingOptionsPricesWorkflow = exports.calculateShippingOptionsPricesWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+const common_1 = require("../../common");
+const fields_1 = require("../../cart/utils/fields");
+exports.calculateShippingOptionsPricesWorkflowId = "calculate-shipping-options-prices-workflow";
+/**
+ * This workflow calculates the prices for one or more shipping options in a cart. It's used by the
+ * [Calculate Shipping Option Price Store API Route](https://docs.acmekit.com/api/store#shipping-options_postshippingoptionsidcalculate).
+ *
+ * :::note
+ *
+ * Calculating shipping option prices may require sending requests to third-party fulfillment services.
+ * This depends on the implementation of the fulfillment provider associated with the shipping option.
+ *
+ * :::
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * calculate the prices of shipping options within your custom flows.
+ *
+ * @example
+ * const { result } = await calculateShippingOptionsPricesWorkflow(container)
+ * .run({
+ *   input: {
+ *     cart_id: "cart_123",
+ *     shipping_options: [
+ *       {
+ *         id: "so_123",
+ *         data: {
+ *           // custom data relevant for the fulfillment provider
+ *           carrier_code: "ups",
+ *         }
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Calculate shipping option prices in a cart.
+ */
+exports.calculateShippingOptionsPricesWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.calculateShippingOptionsPricesWorkflowId, (input) => {
+    const ids = (0, workflows_sdk_1.transform)({ input }, ({ input }) => input.shipping_options.map((so) => so.id));
+    const shippingOptionsQuery = (0, common_1.useQueryGraphStep)({
+        entity: "shipping_option",
+        filters: { id: ids },
+        fields: ["id", "provider_id", "data", "service_zone.fulfillment_set_id"],
+    }).config({ name: "shipping-options-query" });
+    const cartQuery = (0, common_1.useQueryGraphStep)({
+        entity: "cart",
+        filters: { id: input.cart_id },
+        fields: fields_1.cartFieldsForCalculateShippingOptionsPrices,
+    }).config({ name: "cart-query" });
+    const fulfillmentSetId = (0, workflows_sdk_1.transform)({ shippingOptionsQuery }, ({ shippingOptionsQuery }) => shippingOptionsQuery.data.map((so) => so.service_zone.fulfillment_set_id));
+    const locationFulfillmentSetQuery = (0, common_1.useQueryGraphStep)({
+        entity: "location_fulfillment_set",
+        filters: { fulfillment_set_id: fulfillmentSetId },
+        fields: ["id", "stock_location_id", "fulfillment_set_id"],
+    }).config({ name: "location-fulfillment-set-query" });
+    const locationIds = (0, workflows_sdk_1.transform)({ locationFulfillmentSetQuery }, ({ locationFulfillmentSetQuery }) => locationFulfillmentSetQuery.data.map((lfs) => lfs.stock_location_id));
+    const locationQuery = (0, common_1.useQueryGraphStep)({
+        entity: "stock_location",
+        filters: { id: locationIds },
+        fields: ["id", "name", "address.*"],
+    }).config({ name: "location-query" });
+    const data = (0, workflows_sdk_1.transform)({
+        shippingOptionsQuery,
+        cartQuery,
+        input,
+        locationFulfillmentSetQuery,
+        locationQuery,
+    }, ({ shippingOptionsQuery, cartQuery, input, locationFulfillmentSetQuery, locationQuery, }) => {
+        const shippingOptions = shippingOptionsQuery.data;
+        const cart = cartQuery.data[0];
+        const locations = locationQuery.data;
+        const locationFulfillmentSetMap = new Map(locationFulfillmentSetQuery.data.map((lfs) => [
+            lfs.fulfillment_set_id,
+            lfs.stock_location_id,
+        ]));
+        const shippingOptionDataMap = new Map(input.shipping_options.map((so) => [so.id, so.data]));
+        return shippingOptions.map((shippingOption) => ({
+            id: shippingOption.id,
+            provider_id: shippingOption.provider_id,
+            optionData: shippingOption.data,
+            data: shippingOptionDataMap.get(shippingOption.id) ?? {},
+            context: {
+                ...cart,
+                from_location: locations.find((l) => l.id ===
+                    locationFulfillmentSetMap.get(shippingOption.service_zone.fulfillment_set_id)),
+            },
+        }));
+    });
+    const prices = (0, steps_1.calculateShippingOptionsPricesStep)(data);
+    return new workflows_sdk_1.WorkflowResponse(prices);
+});
+//# sourceMappingURL=calculate-shipping-options-prices.js.map

package/dist/fulfillment/workflows/calculate-shipping-options-prices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculate-shipping-options-prices.js","sourceRoot":"","sources":["../../../src/fulfillment/workflows/calculate-shipping-options-prices.ts"],"names":[],"mappings":";;;AACA,oEAKyC;AACzC,oCAA6D;AAC7D,yCAAgD;AAChD,oDAAqF;AAExE,QAAA,wCAAwC,GACnD,4CAA4C,CAAA;AAC9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACU,QAAA,sCAAsC,GAAG,IAAA,8BAAc,EAClE,gDAAwC,EACxC,CACE,KAAoF,EACA,EAAE;IACtF,MAAM,GAAG,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAC7C,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAC1C,CAAA;IAED,MAAM,oBAAoB,GAAG,IAAA,0BAAiB,EAAC;QAC7C,MAAM,EAAE,iBAAiB;QACzB,OAAO,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE;QACpB,MAAM,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,iCAAiC,CAAC;KACzE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC,CAAA;IAE7C,MAAM,SAAS,GAAG,IAAA,0BAAiB,EAAC;QAClC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE;QAC9B,MAAM,EAAE,oDAA2C;KACpD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAA;IAEjC,MAAM,gBAAgB,GAAG,IAAA,yBAAS,EAChC,EAAE,oBAAoB,EAAE,EACxB,CAAC,EAAE,oBAAoB,EAAE,EAAE,EAAE,CAC3B,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAC3B,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,kBAAkB,CAC3C,CACJ,CAAA;IAED,MAAM,2BAA2B,GAAG,IAAA,0BAAiB,EAAC;QACpD,MAAM,EAAE,0BAA0B;QAClC,OAAO,EAAE,EAAE,kBAAkB,EAAE,gBAAgB,EAAE;QACjD,MAAM,EAAE,CAAC,IAAI,EAAE,mBAAmB,EAAE,oBAAoB,CAAC;KAC1D,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,gCAAgC,EAAE,CAAC,CAAA;IAErD,MAAM,WAAW,GAAG,IAAA,yBAAS,EAC3B,EAAE,2BAA2B,EAAE,EAC/B,CAAC,EAAE,2BAA2B,EAAE,EAAE,EAAE,CAClC,2BAA2B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,CACvE,CAAA;IAED,MAAM,aAAa,GAAG,IAAA,0BAAiB,EAAC;QACtC,MAAM,EAAE,gBAAgB;QACxB,OAAO,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;QAC5B,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC;KACpC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAA;IAErC,MAAM,IAAI,GAAG,IAAA,yBAAS,EACpB;QACE,oBAAoB;QACpB,SAAS;QACT,KAAK;QACL,2BAA2B;QAC3B,aAAa;KACd,EACD,CAAC,EACC,oBAAoB,EACpB,SAAS,EACT,KAAK,EACL,2BAA2B,EAC3B,aAAa,GACd,EAAE,EAAE;QACH,MAAM,eAAe,GAAG,oBAAoB,CAAC,IAAI,CAAA;QACjD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAE9B,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAA;QACpC,MAAM,yBAAyB,GAAG,IAAI,GAAG,CACvC,2BAA2B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC;YAC5C,GAAG,CAAC,kBAAkB;YACtB,GAAG,CAAC,iBAAiB;SACtB,CAAC,CACH,CAAA;QAED,MAAM,qBAAqB,GAAG,IAAI,GAAG,CACnC,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CACrD,CAAA;QAED,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YAC9C,EAAE,EAAE,cAAc,CAAC,EAAE;YACrB,WAAW,EAAE,cAAc,CAAC,WAAW;YACvC,UAAU,EAAE,cAAc,CAAC,IAAI;YAC/B,IAAI,EAAE,qBAAqB,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE;YACxD,OAAO,EAAE;gBACP,GAAG,IAAI;gBACP,aAAa,EAAE,SAAS,CAAC,IAAI,CAC3B,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,EAAE;oBACJ,yBAAyB,CAAC,GAAG,CAC3B,cAAc,CAAC,YAAY,CAAC,kBAAkB,CAC/C,CACJ;aACF;SACF,CAAC,CAAC,CAAA;IACL,CAAC,CACF,CAAA;IAED,MAAM,MAAM,GAAG,IAAA,0CAAkC,EAAC,IAAI,CAAC,CAAA;IAEvD,OAAO,IAAI,gCAAgB,CAAC,MAAM,CAAC,CAAA;AACrC,CAAC,CACF,CAAA"}

package/dist/fulfillment/workflows/cancel-fulfillment.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The data to cancel a fulfillment.
+ */
+export type CancelFulfillmentWorkflowInput = {
+    /**
+     * The ID of the fulfillment to cancel.
+     */
+    id: string;
+};
+export declare const cancelFulfillmentWorkflowId = "cancel-fulfillment-workflow";
+/**
+ * This workflow cancels a fulfillment. It's used by the
+ * [Cancel Fulfillment Admin API Route](https://docs.acmekit.com/api/admin#fulfillments_postfulfillmentsidcancel).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * cancel a fulfillment within your custom flows.
+ *
+ * @example
+ * const { result } = await cancelFulfillmentWorkflow(container)
+ * .run({
+ *   input: {
+ *     id: "ful_123"
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Cancel a fulfillment.
+ */
+export declare const cancelFulfillmentWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<CancelFulfillmentWorkflowInput, unknown, any[]>;
+//# sourceMappingURL=cancel-fulfillment.d.ts.map

package/dist/fulfillment/workflows/cancel-fulfillment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-fulfillment.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/workflows/cancel-fulfillment.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,eAAO,MAAM,2BAA2B,gCAAgC,CAAA;AACxE;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,yBAAyB,2GAKrC,CAAA"}

package/dist/fulfillment/workflows/cancel-fulfillment.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cancelFulfillmentWorkflow = exports.cancelFulfillmentWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+exports.cancelFulfillmentWorkflowId = "cancel-fulfillment-workflow";
+/**
+ * This workflow cancels a fulfillment. It's used by the
+ * [Cancel Fulfillment Admin API Route](https://docs.acmekit.com/api/admin#fulfillments_postfulfillmentsidcancel).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * cancel a fulfillment within your custom flows.
+ *
+ * @example
+ * const { result } = await cancelFulfillmentWorkflow(container)
+ * .run({
+ *   input: {
+ *     id: "ful_123"
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Cancel a fulfillment.
+ */
+exports.cancelFulfillmentWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.cancelFulfillmentWorkflowId, (input) => {
+    (0, steps_1.cancelFulfillmentStep)(input.id);
+});
+//# sourceMappingURL=cancel-fulfillment.js.map

package/dist/fulfillment/workflows/cancel-fulfillment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-fulfillment.js","sourceRoot":"","sources":["../../../src/fulfillment/workflows/cancel-fulfillment.ts"],"names":[],"mappings":";;;AAAA,oEAA+E;AAC/E,oCAAgD;AAYnC,QAAA,2BAA2B,GAAG,6BAA6B,CAAA;AACxE;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,yBAAyB,GAAG,IAAA,8BAAc,EACrD,mCAA2B,EAC3B,CAAC,KAAmD,EAAE,EAAE;IACtD,IAAA,6BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC,CAAA;AACjC,CAAC,CACF,CAAA"}

package/dist/fulfillment/workflows/create-fulfillment.d.ts

@@ -0,0 +1,52 @@
+import { FulfillmentDTO, FulfillmentWorkflow } from "@acmekit/framework/types";
+export declare const createFulfillmentWorkflowId = "create-fulfillment-workflow";
+/**
+ * This workflow creates a fulfillment, which can be used for an order, return, exchanges, and similar concepts.
+ * The workflow is used by the [Create Fulfillment Admin API Route](https://docs.acmekit.com/api/admin#fulfillments_postfulfillments).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * create a fulfillment within your custom flows.
+ *
+ * :::note
+ *
+ * You can retrieve an order's details using [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query),
+ * or [useQueryGraphStep](https://docs.acmekit.com/resources/references/acmekit-workflows/steps/useQueryGraphStep).
+ *
+ * :::
+ *
+ * @example
+ * const { result } = await createFulfillmentWorkflow(container)
+ * .run({
+ *   input: {
+ *     location_id: "sloc_123",
+ *     provider_id: "provider_123",
+ *     delivery_address: {
+ *       first_name: "John",
+ *       last_name: "Doe",
+ *       address_1: "Test street 1",
+ *       city: "Stockholm",
+ *       country_code: "se",
+ *       postal_code: "12345",
+ *       phone: "123456789"
+ *     },
+ *     items: [
+ *       {
+ *         quantity: 1,
+ *         sku: "shirt",
+ *         title: "Shirt",
+ *         barcode: "123"
+ *       }
+ *     ],
+ *     order: {
+ *       id: "order_123"
+ *       // other order details...
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create a fulfillment.
+ */
+export declare const createFulfillmentWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<FulfillmentWorkflow.CreateFulfillmentWorkflowInput, FulfillmentDTO, []>;
+//# sourceMappingURL=create-fulfillment.d.ts.map

package/dist/fulfillment/workflows/create-fulfillment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-fulfillment.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/workflows/create-fulfillment.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,mBAAmB,EAEpB,MAAM,0BAA0B,CAAA;AAUjC,eAAO,MAAM,2BAA2B,gCAAgC,CAAA;AACxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,eAAO,MAAM,yBAAyB,mIAgDrC,CAAA"}