@acmekit/core-flows 2.13.2 → 2.13.4

package/dist/order/workflows/mark-order-fulfillment-as-delivered.d.ts

@@ -1,92 +0,0 @@
-import { FulfillmentDTO, OrderDTO } from "@acmekit/framework/types";
-/**
- * The data to validate the order fulfillment deliverability.
- */
-export type OrderFulfillmentDeliverabilityValidationStepInput = {
-    /**
-     * The order to validate the fulfillment deliverability for.
-     */
-    order: OrderDTO & {
-        /**
-         * The fulfillments in the order.
-         */
-        fulfillments: FulfillmentDTO[];
-    };
-    /**
-     * The fulfillment to validate the deliverability for.
-     */
-    fulfillment: FulfillmentDTO;
-};
-export declare const orderFulfillmentDeliverablilityValidationStepId = "order-fulfillment-deliverability-validation";
-/**
- * This step validates that the order fulfillment can be delivered. If the order is cancelled,
- * the items to mark as delivered don't exist in the order, or the fulfillment doesn't exist in the order,
- * the step will throw an error.
- *
- * :::note
- *
- * You can retrieve an order and fulfillment'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 data = orderFulfillmentDeliverablilityValidationStep({
- *   order: {
- *     id: "order_123",
- *     fulfillments: [
- *       {
- *         id: "ful_123",
- *         // other fulfillment details...
- *       }
- *     ]
- *     // other order details...
- *   },
- *   fulfillment: {
- *     id: "ful_123",
- *     // other fulfillment details...
- *   }
- * })
- */
-export declare const orderFulfillmentDeliverablilityValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<{
-    order: OrderDTO & {
-        fulfillments: FulfillmentDTO[];
-    };
-    fulfillment: FulfillmentDTO;
-}, unknown>;
-/**
- * The details to mark a fulfillment in an order as delivered.
- */
-export type MarkOrderFulfillmentAsDeliveredWorkflowInput = {
-    /**
-     * The ID of the order to mark the fulfillment as delivered in.
-     */
-    orderId: string;
-    /**
-     * The ID of the fulfillment to mark as delivered.
-     */
-    fulfillmentId: string;
-};
-export declare const markOrderFulfillmentAsDeliveredWorkflowId = "mark-order-fulfillment-as-delivered-workflow";
-/**
- * This workflow marks a fulfillment in an order as delivered. It's used by the
- * [Mark Fulfillment as Delivered Admin API Route](https://docs.acmekit.com/api/admin#orders_postordersidfulfillmentsfulfillment_idmarkasdelivered).
- *
- * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
- * marking a fulfillment as delivered.
- *
- * @example
- * const { result } = await markOrderFulfillmentAsDeliveredWorkflow(container)
- * .run({
- *   input: {
- *     orderId: "order_123",
- *     fulfillmentId: "ful_123",
- *   }
- * })
- *
- * @summary
- *
- * Mark a fulfillment in an order as delivered.
- */
-export declare const markOrderFulfillmentAsDeliveredWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<MarkOrderFulfillmentAsDeliveredWorkflowInput, undefined, []>;
-//# sourceMappingURL=mark-order-fulfillment-as-delivered.d.ts.map

package/dist/order/workflows/mark-order-fulfillment-as-delivered.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mark-order-fulfillment-as-delivered.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/mark-order-fulfillment-as-delivered.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EAEd,QAAQ,EAIT,MAAM,0BAA0B,CAAA;AAkCjC;;GAEG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG;QAChB;;WAEG;QACH,YAAY,EAAE,cAAc,EAAE,CAAA;KAC/B,CAAA;IACD;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,+CAA+C,gDACb,CAAA;AAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,6CAA6C;WAM/C,QAAQ,GAAG;QAAE,YAAY,EAAE,cAAc,EAAE,CAAA;KAAE;iBACvC,cAAc;WAuB9B,CAAA;AA4DD;;GAEG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,eAAO,MAAM,yCAAyC,iDACN,CAAA;AAChD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,uCAAuC,wHAiEnD,CAAA"}

package/dist/order/workflows/mark-order-fulfillment-as-delivered.js

@@ -1,162 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.markOrderFulfillmentAsDeliveredWorkflow = exports.markOrderFulfillmentAsDeliveredWorkflowId = exports.orderFulfillmentDeliverablilityValidationStep = exports.orderFulfillmentDeliverablilityValidationStepId = void 0;
-const utils_1 = require("@acmekit/framework/utils");
-const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
-const common_1 = require("../../common");
-const fulfillment_1 = require("../../fulfillment");
-const register_delivery_1 = require("../steps/register-delivery");
-const order_validation_1 = require("../utils/order-validation");
-const locking_1 = require("../../locking");
-exports.orderFulfillmentDeliverablilityValidationStepId = "order-fulfillment-deliverability-validation";
-/**
- * This step validates that the order fulfillment can be delivered. If the order is cancelled,
- * the items to mark as delivered don't exist in the order, or the fulfillment doesn't exist in the order,
- * the step will throw an error.
- *
- * :::note
- *
- * You can retrieve an order and fulfillment'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 data = orderFulfillmentDeliverablilityValidationStep({
- *   order: {
- *     id: "order_123",
- *     fulfillments: [
- *       {
- *         id: "ful_123",
- *         // other fulfillment details...
- *       }
- *     ]
- *     // other order details...
- *   },
- *   fulfillment: {
- *     id: "ful_123",
- *     // other fulfillment details...
- *   }
- * })
- */
-exports.orderFulfillmentDeliverablilityValidationStep = (0, workflows_sdk_1.createStep)(exports.orderFulfillmentDeliverablilityValidationStepId, async ({ fulfillment, order, }) => {
-    (0, order_validation_1.throwIfOrderIsCancelled)({ order });
-    const orderFulfillment = order.fulfillments?.find((f) => f.id === fulfillment.id);
-    if (!orderFulfillment) {
-        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Fulfillment with id ${fulfillment.id} not found in the order`);
-    }
-    (0, order_validation_1.throwIfItemsDoesNotExistsInOrder)({
-        order,
-        inputItems: order.items.map((i) => ({
-            id: i.id,
-            quantity: i.quantity,
-        })),
-    });
-});
-function prepareRegisterDeliveryData({ fulfillment, order, }) {
-    const orderFulfillment = order.fulfillments.find((f) => f.id === fulfillment.id);
-    const lineItemIds = new Array(...new Set(orderFulfillment.items.map((i) => i.line_item_id)));
-    return {
-        order_id: order.id,
-        reference: utils_1.Modules.FULFILLMENT,
-        reference_id: orderFulfillment.id,
-        items: lineItemIds.map((lineItemId) => {
-            // find order item
-            const orderItem = order.items.find((i) => i.id === lineItemId);
-            // find inventory items
-            const iitems = orderItem.variant?.inventory_items;
-            // find fulfillment item
-            const fitem = orderFulfillment.items.find((i) => i.line_item_id === lineItemId);
-            let quantity = fitem.quantity;
-            // NOTE: if the order item has an inventory kit or `required_qunatity` > 1, fulfillment items wont't match 1:1 with order items.
-            // - for each inventory item in the kit, a fulfillment item will be created i.e. one line item could have multiple fulfillment items
-            // - the quantity of the fulfillment item will be the quantity of the order item multiplied by the required quantity of the inventory item
-            //
-            //   We need to take this into account when marking the fulfillment as delivered to compute quantity of line items being delivered based on fulfillment items and qunatities.
-            //   NOTE: for now we only need to find one inventory item of a line item to compute this since when a fulfillment is created all inventory items are fulfilled together.
-            //   If we allow to cancel partial fulfillments for an order item, we need to change this.
-            //
-            if (iitems?.length) {
-                const iitem = iitems.find((i) => i.inventory.id === fitem.inventory_item_id);
-                if (iitem)
-                    quantity = utils_1.MathBN.div(quantity, iitem.required_quantity);
-            }
-            return {
-                id: lineItemId,
-                quantity,
-            };
-        }),
-    };
-}
-exports.markOrderFulfillmentAsDeliveredWorkflowId = "mark-order-fulfillment-as-delivered-workflow";
-/**
- * This workflow marks a fulfillment in an order as delivered. It's used by the
- * [Mark Fulfillment as Delivered Admin API Route](https://docs.acmekit.com/api/admin#orders_postordersidfulfillmentsfulfillment_idmarkasdelivered).
- *
- * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
- * marking a fulfillment as delivered.
- *
- * @example
- * const { result } = await markOrderFulfillmentAsDeliveredWorkflow(container)
- * .run({
- *   input: {
- *     orderId: "order_123",
- *     fulfillmentId: "ful_123",
- *   }
- * })
- *
- * @summary
- *
- * Mark a fulfillment in an order as delivered.
- */
-exports.markOrderFulfillmentAsDeliveredWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.markOrderFulfillmentAsDeliveredWorkflowId, (input) => {
-    const { fulfillmentId, orderId } = input;
-    const { data: fulfillment } = (0, common_1.useQueryGraphStep)({
-        entity: "fulfillment",
-        filters: { id: fulfillmentId },
-        fields: ["id"],
-        options: { throwIfKeyNotFound: true, isList: false },
-    }).config({ name: "get-fulfillment" });
-    const { data: order } = (0, common_1.useQueryGraphStep)({
-        entity: "order",
-        filters: { id: orderId },
-        fields: [
-            "id",
-            "summary",
-            "total",
-            "currency_code",
-            "region_id",
-            "fulfillments.id",
-            "fulfillments.items.id",
-            "fulfillments.items.quantity",
-            "fulfillments.items.line_item_id",
-            "fulfillments.items.inventory_item_id",
-            "items.id",
-            "items.quantity",
-            "items.variant.manage_inventory",
-            "items.variant.inventory_items.inventory.id",
-            "items.variant.inventory_items.required_quantity",
-        ],
-        options: { throwIfKeyNotFound: true, isList: false },
-    }).config({ name: "order-query" });
-    (0, exports.orderFulfillmentDeliverablilityValidationStep)({ order, fulfillment });
-    const deliveryData = (0, workflows_sdk_1.transform)({ order, fulfillment }, prepareRegisterDeliveryData);
-    (0, locking_1.acquireLockStep)({
-        key: orderId,
-        timeout: 2,
-        ttl: 10,
-    });
-    const deliveredFulfillment = fulfillment_1.markFulfillmentAsDeliveredWorkflow.runAsStep({
-        input: { id: fulfillment.id },
-    });
-    (0, locking_1.releaseLockStep)({
-        key: orderId,
-    });
-    (0, register_delivery_1.registerOrderDeliveryStep)(deliveryData);
-    (0, common_1.emitEventStep)({
-        eventName: utils_1.FulfillmentWorkflowEvents.DELIVERY_CREATED,
-        data: { id: deliveredFulfillment.id },
-    });
-    return new workflows_sdk_1.WorkflowResponse(void 0);
-});
-//# sourceMappingURL=mark-order-fulfillment-as-delivered.js.map

package/dist/order/workflows/mark-order-fulfillment-as-delivered.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mark-order-fulfillment-as-delivered.js","sourceRoot":"","sources":["../../../src/order/workflows/mark-order-fulfillment-as-delivered.ts"],"names":[],"mappings":";;;AASA,oDAKiC;AACjC,oEAMyC;AACzC,yCAA+D;AAC/D,mDAAsE;AACtE,kEAAsE;AACtE,gEAGkC;AAClC,2CAAgE;AAgCnD,QAAA,+CAA+C,GAC1D,6CAA6C,CAAA;AAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACU,QAAA,6CAA6C,GAAG,IAAA,0BAAU,EACrE,uDAA+C,EAC/C,KAAK,EAAE,EACL,WAAW,EACX,KAAK,GAIN,EAAE,EAAE;IACH,IAAA,0CAAuB,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;IAElC,MAAM,gBAAgB,GAAG,KAAK,CAAC,YAAY,EAAE,IAAI,CAC/C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,WAAW,CAAC,EAAE,CAC/B,CAAA;IAED,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,uBAAuB,WAAW,CAAC,EAAE,yBAAyB,CAC/D,CAAA;IACH,CAAC;IAED,IAAA,mDAAgC,EAAC;QAC/B,KAAK;QACL,UAAU,EAAE,KAAK,CAAC,KAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnC,EAAE,EAAE,CAAC,CAAC,EAAE;YACR,QAAQ,EAAE,CAAC,CAAC,QAAQ;SACrB,CAAC,CAAC;KACJ,CAAC,CAAA;AACJ,CAAC,CACF,CAAA;AAED,SAAS,2BAA2B,CAAC,EACnC,WAAW,EACX,KAAK,GAIN;IACC,MAAM,gBAAgB,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAC9C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,WAAW,CAAC,EAAE,CAC9B,CAAA;IAEF,MAAM,WAAW,GAAG,IAAI,KAAK,CAC3B,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAC9D,CAAA;IAED,OAAO;QACL,QAAQ,EAAE,KAAK,CAAC,EAAE;QAClB,SAAS,EAAE,eAAO,CAAC,WAAW;QAC9B,YAAY,EAAE,gBAAgB,CAAC,EAAE;QACjC,KAAK,EAAE,WAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;YACrC,kBAAkB;YAClB,MAAM,SAAS,GAAG,KAAK,CAAC,KAAM,CAAC,IAAI,CACjC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,UAAU,CACA,CAAA;YAC5B,uBAAuB;YACvB,MAAM,MAAM,GAAG,SAAU,CAAC,OAAO,EAAE,eAAe,CAAA;YAClD,wBAAwB;YACxB,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,UAAU,CACpC,CAAA;YAEF,IAAI,QAAQ,GAAmB,KAAK,CAAC,QAAQ,CAAA;YAE7C,gIAAgI;YAChI,oIAAoI;YACpI,0IAA0I;YAC1I,EAAE;YACF,6KAA6K;YAC7K,yKAAyK;YACzK,0FAA0F;YAC1F,EAAE;YAEF,IAAI,MAAM,EAAE,MAAM,EAAE,CAAC;gBACnB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CACvB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,KAAK,KAAK,CAAC,iBAAiB,CAClD,CAAA;gBACD,IAAG,KAAK;oBACN,QAAQ,GAAG,cAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;YAC5D,CAAC;YAED,OAAO;gBACL,EAAE,EAAE,UAAoB;gBACxB,QAAQ;aACT,CAAA;QACH,CAAC,CAAC;KACH,CAAA;AACH,CAAC;AAgBY,QAAA,yCAAyC,GACpD,8CAA8C,CAAA;AAChD;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,uCAAuC,GAAG,IAAA,8BAAc,EACnE,iDAAyC,EACzC,CAAC,KAAiE,EAAE,EAAE;IACpE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;IAExC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAA,0BAAiB,EAAC;QAC9C,MAAM,EAAE,aAAa;QACrB,OAAO,EAAE,EAAE,EAAE,EAAE,aAAa,EAAE;QAC9B,MAAM,EAAE,CAAC,IAAI,CAAC;QACd,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;KACrD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAA;IAEtC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAA,0BAAiB,EAAC;QACxC,MAAM,EAAE,OAAO;QACf,OAAO,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE;QACxB,MAAM,EAAE;YACN,IAAI;YACJ,SAAS;YACT,OAAO;YACP,eAAe;YACf,WAAW;YACX,iBAAiB;YACjB,uBAAuB;YACvB,6BAA6B;YAC7B,iCAAiC;YACjC,sCAAsC;YACtC,UAAU;YACV,gBAAgB;YAChB,gCAAgC;YAChC,4CAA4C;YAC5C,iDAAiD;SAClD;QACD,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;KACrD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;IAElC,IAAA,qDAA6C,EAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAA;IAErE,MAAM,YAAY,GAAG,IAAA,yBAAS,EAC5B,EAAE,KAAK,EAAE,WAAW,EAAE,EACtB,2BAA2B,CAC5B,CAAA;IAED,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,OAAO;QACZ,OAAO,EAAE,CAAC;QACV,GAAG,EAAE,EAAE;KACR,CAAC,CAAA;IAEF,MAAM,oBAAoB,GAAG,gDAAkC,CAAC,SAAS,CAAC;QACxE,KAAK,EAAE,EAAE,EAAE,EAAE,WAAW,CAAC,EAAE,EAAE;KAC9B,CAAC,CAAA;IAEF,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,OAAO;KACb,CAAC,CAAA;IAEF,IAAA,6CAAyB,EAAC,YAAY,CAAC,CAAA;IAEvC,IAAA,sBAAa,EAAC;QACZ,SAAS,EAAE,iCAAyB,CAAC,gBAAgB;QACrD,IAAI,EAAE,EAAE,EAAE,EAAE,oBAAoB,CAAC,EAAE,EAAE;KACtC,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,CAAC,CAAA;AACrC,CAAC,CACF,CAAA"}

package/dist/order/workflows/mark-payment-collection-as-paid.d.ts

@@ -1,70 +0,0 @@
-import type { PaymentCollectionDTO } from "@acmekit/framework/types";
-/**
- * The details of the payment collection to validate.
- */
-export type ThrowUnlessPaymentCollectionNotePaidInput = {
-    /**
-     * The payment collection to validate.
-     */
-    paymentCollection: PaymentCollectionDTO;
-};
-/**
- * This step validates that the payment collection is not paid. If not valid,
- * the step will throw an error.
- *
- * :::note
- *
- * You can retrieve a payment collection'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 data = throwUnlessPaymentCollectionNotPaid({
- *   paymentCollection: {
- *     id: "paycol_123",
- *     // other payment details...
- *   }
- * })
- */
-export declare const throwUnlessPaymentCollectionNotPaid: import("@acmekit/framework/workflows-sdk").StepFunction<ThrowUnlessPaymentCollectionNotePaidInput, unknown>;
-/**
- * The data to mark a payment collection as paid.
- */
-export type MarkPaymentCollectionAsPaidInput = {
-    /**
-     * The ID of the payment collection to mark as paid.
-     */
-    payment_collection_id: string;
-    /**
-     * The ID of the order that the payment collection belongs to.
-     */
-    order_id: string;
-    /**
-     * The ID of the user marking the payment collection as completed.
-     */
-    captured_by?: string;
-};
-export declare const markPaymentCollectionAsPaidId = "mark-payment-collection-as-paid";
-/**
- * This workflow marks a payment collection for an order as paid. It's used by the
- * [Mark Payment Collection as Paid Admin API Route](https://docs.acmekit.com/api/admin#payment-collections_postpaymentcollectionsidmarkaspaid).
- *
- * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
- * marking a payment collection for an order as paid.
- *
- * @example
- * const { result } = await markPaymentCollectionAsPaid(container)
- * .run({
- *   input: {
- *     order_id: "order_123",
- *     payment_collection_id: "paycol_123",
- *   }
- * })
- *
- * @summary
- *
- * Mark a payment collection for an order as paid.
- */
-export declare const markPaymentCollectionAsPaid: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<MarkPaymentCollectionAsPaidInput, import("@acmekit/framework/types").PaymentDTO | null, []>;
-//# sourceMappingURL=mark-payment-collection-as-paid.d.ts.map

package/dist/order/workflows/mark-payment-collection-as-paid.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mark-payment-collection-as-paid.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/mark-payment-collection-as-paid.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAepE;;GAEG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD;;OAEG;IACH,iBAAiB,EAAE,oBAAoB,CAAA;CACxC,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,mCAAmC,6GAU/C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAA;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAGD,eAAO,MAAM,6BAA6B,oCAAoC,CAAA;AAC9E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,2BAA2B,uJAmCvC,CAAA"}

package/dist/order/workflows/mark-payment-collection-as-paid.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.markPaymentCollectionAsPaid = exports.markPaymentCollectionAsPaidId = exports.throwUnlessPaymentCollectionNotPaid = void 0;
-const utils_1 = require("@acmekit/framework/utils");
-const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
-const common_1 = require("../../common");
-const payment_1 = require("../../payment");
-const payment_collection_1 = require("../../payment-collection");
-/**
- * This step validates that the payment collection is not paid. If not valid,
- * the step will throw an error.
- *
- * :::note
- *
- * You can retrieve a payment collection'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 data = throwUnlessPaymentCollectionNotPaid({
- *   paymentCollection: {
- *     id: "paycol_123",
- *     // other payment details...
- *   }
- * })
- */
-exports.throwUnlessPaymentCollectionNotPaid = (0, workflows_sdk_1.createStep)("validate-existing-payment-collection", ({ paymentCollection }) => {
-    if (paymentCollection.status !== "not_paid") {
-        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.NOT_ALLOWED, `Can only mark 'not_paid' payment collection as paid`);
-    }
-});
-const systemPaymentProviderId = "pp_system_default";
-exports.markPaymentCollectionAsPaidId = "mark-payment-collection-as-paid";
-/**
- * This workflow marks a payment collection for an order as paid. It's used by the
- * [Mark Payment Collection as Paid Admin API Route](https://docs.acmekit.com/api/admin#payment-collections_postpaymentcollectionsidmarkaspaid).
- *
- * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
- * marking a payment collection for an order as paid.
- *
- * @example
- * const { result } = await markPaymentCollectionAsPaid(container)
- * .run({
- *   input: {
- *     order_id: "order_123",
- *     payment_collection_id: "paycol_123",
- *   }
- * })
- *
- * @summary
- *
- * Mark a payment collection for an order as paid.
- */
-exports.markPaymentCollectionAsPaid = (0, workflows_sdk_1.createWorkflow)(exports.markPaymentCollectionAsPaidId, (input) => {
-    const { data: paymentCollection } = (0, common_1.useQueryGraphStep)({
-        entity: "payment_collection",
-        filters: { id: input.payment_collection_id },
-        fields: ["id", "status", "amount"],
-        options: { throwIfKeyNotFound: true, isList: false },
-    }).config({ name: "get-payment-collection" });
-    (0, exports.throwUnlessPaymentCollectionNotPaid)({ paymentCollection });
-    const paymentSession = payment_collection_1.createPaymentSessionsWorkflow.runAsStep({
-        input: {
-            payment_collection_id: paymentCollection.id,
-            provider_id: systemPaymentProviderId,
-            data: {},
-            context: {},
-        },
-    });
-    const payment = (0, payment_1.authorizePaymentSessionStep)({
-        id: paymentSession.id,
-    });
-    payment_1.capturePaymentWorkflow.runAsStep({
-        input: {
-            payment_id: payment.id,
-            captured_by: input.captured_by,
-            amount: paymentCollection.amount,
-        },
-    });
-    return new workflows_sdk_1.WorkflowResponse(payment);
-});
-//# sourceMappingURL=mark-payment-collection-as-paid.js.map

package/dist/order/workflows/mark-payment-collection-as-paid.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mark-payment-collection-as-paid.js","sourceRoot":"","sources":["../../../src/order/workflows/mark-payment-collection-as-paid.ts"],"names":[],"mappings":";;;AACA,oDAAuD;AACvD,oEAKyC;AACzC,yCAAgD;AAChD,2CAGsB;AACtB,iEAAwE;AAYxE;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,mCAAmC,GAAG,IAAA,0BAAU,EAC3D,sCAAsC,EACtC,CAAC,EAAE,iBAAiB,EAA6C,EAAE,EAAE;IACnE,IAAI,iBAAiB,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QAC5C,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,WAAW,EAC9B,qDAAqD,CACtD,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA;AAoBD,MAAM,uBAAuB,GAAG,mBAAmB,CAAA;AACtC,QAAA,6BAA6B,GAAG,iCAAiC,CAAA;AAC9E;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,2BAA2B,GAAG,IAAA,8BAAc,EACvD,qCAA6B,EAC7B,CAAC,KAAqD,EAAE,EAAE;IACxD,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,IAAA,0BAAiB,EAAC;QACpD,MAAM,EAAE,oBAAoB;QAC5B,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,qBAAqB,EAAE;QAC5C,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC;QAClC,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;KACrD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC,CAAA;IAE7C,IAAA,2CAAmC,EAAC,EAAE,iBAAiB,EAAE,CAAC,CAAA;IAE1D,MAAM,cAAc,GAAG,kDAA6B,CAAC,SAAS,CAAC;QAC7D,KAAK,EAAE;YACL,qBAAqB,EAAE,iBAAiB,CAAC,EAAE;YAC3C,WAAW,EAAE,uBAAuB;YACpC,IAAI,EAAE,EAAE;YACR,OAAO,EAAE,EAAE;SACZ;KACF,CAAC,CAAA;IAEF,MAAM,OAAO,GAAG,IAAA,qCAA2B,EAAC;QAC1C,EAAE,EAAE,cAAc,CAAC,EAAE;KACtB,CAAC,CAAA;IAEF,gCAAsB,CAAC,SAAS,CAAC;QAC/B,KAAK,EAAE;YACL,UAAU,EAAE,OAAO,CAAC,EAAE;YACtB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,MAAM,EAAE,iBAAiB,CAAC,MAAM;SACjC;KACF,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,OAAO,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}

package/dist/order/workflows/maybe-refresh-shipping-methods.d.ts

@@ -1,55 +0,0 @@
-import { CalculatedRMAShippingContext } from "@acmekit/framework/types";
-/**
- * The data to create a shipping method for an order edit.
- */
-export type MaybeRefreshShippingMethodsWorkflowInput = {
-    /**
-     * The ID of the shipping method to refresh.
-     */
-    shipping_method_id: string;
-    /**
-     * The ID of the order.
-     */
-    order_id: string;
-    /**
-     * The ID of the ADD SHIPPING action to update.
-     */
-    action_id: string;
-    /**
-     * Data to pass for the shipping calculation.
-     */
-    context: CalculatedRMAShippingContext;
-};
-export declare const maybeRefreshShippingMethodsWorkflowId = "maybe-refresh-shipping-methods";
-/**
- * This workflows refreshes shipping method prices of an order and its changes. It's used in Return Merchandise Authorization (RMA) flows. It's used
- * by other workflows, such as {@link refreshExchangeShippingWorkflow}.
- *
- * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
- * refreshing shipping methods in your custom flows.
- *
- * @example
- * const { result } = await maybeRefreshShippingMethodsWorkflow(container)
- * .run({
- *   input: {
- *     shipping_method_id: "shipping_method_123",
- *     order_id: "order_123",
- *     action_id: "orchact_123",
- *     context: {
- *       return_id: "ret_123",
- *       return_items: [
- *         {
- *            id: "orli_123",
- *            quantity: 1,
- *         }
- *       ]
- *     }
- *  }
- * })
- *
- * @summary
- *
- * Refreshes the shipping method prices of an order and its changes.
- */
-export declare const maybeRefreshShippingMethodsWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<MaybeRefreshShippingMethodsWorkflowInput, void, []>;
-//# sourceMappingURL=maybe-refresh-shipping-methods.d.ts.map

package/dist/order/workflows/maybe-refresh-shipping-methods.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"maybe-refresh-shipping-methods.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/maybe-refresh-shipping-methods.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,4BAA4B,EAE7B,MAAM,0BAA0B,CAAA;AA0CjC;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,OAAO,EAAE,4BAA4B,CAAA;CACtC,CAAA;AAED,eAAO,MAAM,qCAAqC,mCAChB,CAAA;AAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,mCAAmC,+GAwG/C,CAAA"}

package/dist/order/workflows/maybe-refresh-shipping-methods.js

@@ -1,132 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.maybeRefreshShippingMethodsWorkflow = exports.maybeRefreshShippingMethodsWorkflowId = void 0;
-const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
-const utils_1 = require("@acmekit/framework/utils");
-const steps_1 = require("../../fulfillment/steps");
-const steps_2 = require("../steps");
-const common_1 = require("../../common");
-const COMMON_OPTIONS_FIELDS = [
-    "id",
-    "name",
-    "price_type",
-    "service_zone_id",
-    "service_zone.fulfillment_set_id",
-    "service_zone.fulfillment_set.type",
-    "service_zone.fulfillment_set.location.*",
-    "service_zone.fulfillment_set.location.address.*",
-    "shipping_profile_id",
-    "provider_id",
-    "data",
-    "type.id",
-    "type.label",
-    "type.description",
-    "type.code",
-    "provider.id",
-    "provider.is_enabled",
-    "rules.attribute",
-    "rules.value",
-    "rules.operator",
-];
-exports.maybeRefreshShippingMethodsWorkflowId = "maybe-refresh-shipping-methods";
-/**
- * This workflows refreshes shipping method prices of an order and its changes. It's used in Return Merchandise Authorization (RMA) flows. It's used
- * by other workflows, such as {@link refreshExchangeShippingWorkflow}.
- *
- * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
- * refreshing shipping methods in your custom flows.
- *
- * @example
- * const { result } = await maybeRefreshShippingMethodsWorkflow(container)
- * .run({
- *   input: {
- *     shipping_method_id: "shipping_method_123",
- *     order_id: "order_123",
- *     action_id: "orchact_123",
- *     context: {
- *       return_id: "ret_123",
- *       return_items: [
- *         {
- *            id: "orli_123",
- *            quantity: 1,
- *         }
- *       ]
- *     }
- *  }
- * })
- *
- * @summary
- *
- * Refreshes the shipping method prices of an order and its changes.
- */
-exports.maybeRefreshShippingMethodsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.maybeRefreshShippingMethodsWorkflowId, function (input) {
-    const shippingMethodQuery = (0, common_1.useQueryGraphStep)({
-        entity: "order_shipping_method",
-        fields: ["id", "shipping_option_id"],
-        filters: {
-            id: input.shipping_method_id,
-        },
-    }).config({ name: "fetch-shipping-method" });
-    const shippingMethod = (0, workflows_sdk_1.transform)(shippingMethodQuery, ({ data }) => data[0]);
-    const shippingOptionQuery = (0, common_1.useQueryGraphStep)({
-        entity: "shipping_option",
-        fields: [...COMMON_OPTIONS_FIELDS],
-        filters: { id: shippingMethod.shipping_option_id },
-        options: {
-            cache: {
-                enable: true,
-            },
-        },
-    }).config({ name: "calculated-option" });
-    const shippingOption = (0, workflows_sdk_1.transform)(shippingOptionQuery, ({ data }) => data[0]);
-    const isCalculatedPriceShippingOption = (0, workflows_sdk_1.transform)(shippingOption, (option) => option?.price_type === utils_1.ShippingOptionPriceType.CALCULATED);
-    (0, workflows_sdk_1.when)({ isCalculatedPriceShippingOption, shippingOption }, ({ isCalculatedPriceShippingOption, shippingOption }) => isCalculatedPriceShippingOption).then(() => {
-        const orderQuery = (0, common_1.useQueryGraphStep)({
-            entity: "order",
-            fields: ["id", "shipping_address", "items.*", "items.variant.*"],
-            filters: { id: input.order_id },
-            options: { throwIfKeyNotFound: true },
-        }).config({ name: "order-query" });
-        const order = (0, workflows_sdk_1.transform)(orderQuery, (data) => data[0]);
-        const calculateShippingOptionsPricesData = (0, workflows_sdk_1.transform)({
-            shippingOption,
-            order,
-            input,
-        }, ({ shippingOption, order, input }) => {
-            return [
-                {
-                    id: shippingOption.id,
-                    optionData: shippingOption.data,
-                    context: {
-                        ...order,
-                        ...input.context,
-                        from_location: shippingOption.service_zone.fulfillment_set.location,
-                    },
-                    // data: {}, // TODO: add data
-                    provider_id: shippingOption.provider_id,
-                },
-            ];
-        });
-        const prices = (0, steps_1.calculateShippingOptionsPricesStep)(calculateShippingOptionsPricesData);
-        const updateData = (0, workflows_sdk_1.transform)({
-            shippingOption,
-            prices,
-            input,
-        }, ({ prices, input }) => {
-            return [
-                {
-                    id: input.action_id,
-                    amount: prices[0].calculated_amount,
-                },
-                {
-                    id: input.shipping_method_id,
-                    amount: prices[0].calculated_amount,
-                    is_custom_amount: false,
-                },
-            ];
-        });
-        (0, workflows_sdk_1.parallelize)((0, steps_2.updateOrderChangeActionsStep)([updateData[0]]), (0, steps_2.updateOrderShippingMethodsStep)([updateData[1]]));
-    });
-    return new workflows_sdk_1.WorkflowResponse(void 0);
-});
-//# sourceMappingURL=maybe-refresh-shipping-methods.js.map

package/dist/order/workflows/maybe-refresh-shipping-methods.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"maybe-refresh-shipping-methods.js","sourceRoot":"","sources":["../../../src/order/workflows/maybe-refresh-shipping-methods.ts"],"names":[],"mappings":";;;AAIA,oEAMyC;AACzC,oDAAkE;AAClE,mDAA4E;AAC5E,oCAGiB;AACjB,yCAAgD;AAEhD,MAAM,qBAAqB,GAAG;IAC5B,IAAI;IACJ,MAAM;IACN,YAAY;IACZ,iBAAiB;IACjB,iCAAiC;IACjC,mCAAmC;IACnC,yCAAyC;IACzC,iDAAiD;IACjD,qBAAqB;IACrB,aAAa;IACb,MAAM;IAEN,SAAS;IACT,YAAY;IACZ,kBAAkB;IAClB,WAAW;IAEX,aAAa;IACb,qBAAqB;IAErB,iBAAiB;IACjB,aAAa;IACb,gBAAgB;CACjB,CAAA;AAwBY,QAAA,qCAAqC,GAChD,gCAAgC,CAAA;AAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACU,QAAA,mCAAmC,GAAG,IAAA,8BAAc,EAC/D,6CAAqC,EACrC,UACE,KAA+C;IAE/C,MAAM,mBAAmB,GAAG,IAAA,0BAAiB,EAAC;QAC5C,MAAM,EAAE,uBAAuB;QAC/B,MAAM,EAAE,CAAC,IAAI,EAAE,oBAAoB,CAAC;QACpC,OAAO,EAAE;YACP,EAAE,EAAE,KAAK,CAAC,kBAAkB;SAC7B;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAA;IAE5C,MAAM,cAAc,GAAG,IAAA,yBAAS,EAAC,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAE5E,MAAM,mBAAmB,GAAG,IAAA,0BAAiB,EAAC;QAC5C,MAAM,EAAE,iBAAiB;QACzB,MAAM,EAAE,CAAC,GAAG,qBAAqB,CAAC;QAClC,OAAO,EAAE,EAAE,EAAE,EAAE,cAAc,CAAC,kBAAkB,EAAE;QAClD,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,IAAI;aACb;SACF;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAA;IAExC,MAAM,cAAc,GAAG,IAAA,yBAAS,EAAC,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAE5E,MAAM,+BAA+B,GAAG,IAAA,yBAAS,EAC/C,cAAc,EACd,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,+BAAuB,CAAC,UAAU,CACtE,CAAA;IAED,IAAA,oBAAI,EACF,EAAE,+BAA+B,EAAE,cAAc,EAAE,EACnD,CAAC,EAAE,+BAA+B,EAAE,cAAc,EAAE,EAAE,EAAE,CACtD,+BAA+B,CAClC,CAAC,IAAI,CAAC,GAAG,EAAE;QACV,MAAM,UAAU,GAAG,IAAA,0BAAiB,EAAC;YACnC,MAAM,EAAE,OAAO;YACf,MAAM,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,SAAS,EAAE,iBAAiB,CAAC;YAChE,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE;YAC/B,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE;SACtC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;QAElC,MAAM,KAAK,GAAG,IAAA,yBAAS,EAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;QAEtD,MAAM,kCAAkC,GAAG,IAAA,yBAAS,EAClD;YACE,cAAc;YACd,KAAK;YACL,KAAK;SACN,EACD,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE;YACnC,OAAO;gBACL;oBACE,EAAE,EAAE,cAAc,CAAC,EAAY;oBAC/B,UAAU,EAAE,cAAc,CAAC,IAAI;oBAC/B,OAAO,EAAE;wBACP,GAAG,KAAK;wBACR,GAAG,KAAK,CAAC,OAAO;wBAChB,aAAa,EACX,cAAc,CAAC,YAAY,CAAC,eAAe,CAAC,QAAQ;qBACvD;oBACD,8BAA8B;oBAC9B,WAAW,EAAE,cAAc,CAAC,WAAW;iBACL;aACrC,CAAA;QACH,CAAC,CACF,CAAA;QAED,MAAM,MAAM,GAAG,IAAA,0CAAkC,EAC/C,kCAAkC,CACnC,CAAA;QAED,MAAM,UAAU,GAAG,IAAA,yBAAS,EAC1B;YACE,cAAc;YACd,MAAM;YACN,KAAK;SACN,EACD,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE;YACpB,OAAO;gBACL;oBACE,EAAE,EAAE,KAAK,CAAC,SAAS;oBACnB,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB;iBACpC;gBACD;oBACE,EAAE,EAAE,KAAK,CAAC,kBAAkB;oBAC5B,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB;oBACnC,gBAAgB,EAAE,KAAK;iBACxB;aACF,CAAA;QACH,CAAC,CACF,CAAA;QAED,IAAA,2BAAW,EACT,IAAA,oCAA4B,EAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAC7C,IAAA,sCAA8B,EAAC,CAAC,UAAU,CAAC,CAAC,CAAE,CAAC,CAAC,CACjD,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,CAAC,CAAA;AACrC,CAAC,CACF,CAAA"}