@acmekit/core-flows 2.13.1

package/dist/order/workflows/fetch-shipping-option.js

@@ -0,0 +1,196 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchShippingOptionForOrderWorkflow = exports.fetchShippingOptionsForOrderWorkflowId = 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 common_1 = require("../../common");
+const schemas_1 = require("../../cart/utils/schemas");
+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.fetchShippingOptionsForOrderWorkflowId = "fetch-shipping-option";
+/**
+ * This workflow fetches a shipping option for an order. It's used in Return Merchandise Authorization (RMA) flows. It's used
+ * by other workflows, such as {@link createClaimShippingMethodWorkflow}.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around fetching
+ * shipping options for an order.
+ *
+ * @example
+ * const { result } = await fetchShippingOptionForOrderWorkflow(container)
+ * .run({
+ *   input: {
+ *     shipping_option_id: "so_123",
+ *     currency_code: "usd",
+ *     order_id: "order_123",
+ *     context: {
+ *       return_id: "ret_123",
+ *       return_items: [
+ *         {
+ *           id: "orli_123",
+ *           quantity: 1,
+ *         }
+ *       ]
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Fetch a shipping option for an order.
+ *
+ * @property hooks.setPricingContext - This hook is executed before the shipping option is fetched. You can consume this hook to set the pricing context for the shipping option. This is useful when you have custom pricing rules that depend on the context of the order.
+ *
+ * For example, assuming you have the following custom pricing rule:
+ *
+ * ```json
+ * {
+ *   "attribute": "location_id",
+ *   "operator": "eq",
+ *   "value": "sloc_123",
+ * }
+ * ```
+ *
+ * You can consume the `setPricingContext` hook to add the `location_id` context to the prices calculation:
+ *
+ * ```ts
+ * import { fetchShippingOptionForOrderWorkflow } from "@acmekit/acmekit/core-flows";
+ * import { StepResponse } from "@acmekit/workflows-sdk";
+ *
+ * fetchShippingOptionForOrderWorkflow.hooks.setPricingContext((
+ *   { shipping_option_id, currency_code, order_id, context, additional_data }, { container }
+ * ) => {
+ *   return new StepResponse({
+ *     location_id: "sloc_123", // Special price for in-store purchases
+ *   });
+ * });
+ * ```
+ *
+ * The shipping option's price will now be retrieved using the context you return.
+ *
+ * :::note
+ *
+ * Learn more about prices calculation context in the [Prices Calculation](https://docs.acmekit.com/resources/commerce-modules/pricing/price-calculation) documentation.
+ *
+ * :::
+ *
+ * @privateRemarks
+ * There can be 3 cases:
+ * 1. The shipping option is a flat rate shipping option.
+ *    In this case, pricing calculation context is not used.
+ * 2. The shipping option is a calculated shipping option.
+ *    In this case, calculate shipping price method from the provider is called.
+ * 3. The shipping option is a custom shipping option. -- TODO
+ *    In this case, we don't need to do caluclations above and just return the shipping option with the custom amount.
+ */
+exports.fetchShippingOptionForOrderWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.fetchShippingOptionsForOrderWorkflowId, function (input) {
+    const { data: initialOption } = (0, common_1.useQueryGraphStep)({
+        entity: "shipping_option",
+        filters: { id: input.shipping_option_id },
+        fields: ["id", "price_type"],
+        options: { isList: false },
+    }).config({ name: "shipping-option-query" });
+    const isCalculatedPriceShippingOption = (0, workflows_sdk_1.transform)(initialOption, (option) => option.price_type === utils_1.ShippingOptionPriceType.CALCULATED);
+    const calculatedPriceShippingOption = (0, workflows_sdk_1.when)("option-calculated", { isCalculatedPriceShippingOption }, ({ isCalculatedPriceShippingOption }) => isCalculatedPriceShippingOption).then(() => {
+        const { data: order } = (0, common_1.useQueryGraphStep)({
+            entity: "order",
+            filters: { id: input.order_id },
+            fields: ["id", "shipping_address", "items.*", "items.variant.*"],
+            options: { throwIfKeyNotFound: true, isList: false },
+        }).config({ name: "order-query" });
+        const { data: shippingOption } = (0, common_1.useQueryGraphStep)({
+            entity: "shipping_option",
+            filters: { id: input.shipping_option_id },
+            fields: [...COMMON_OPTIONS_FIELDS],
+            options: { isList: false },
+        }).config({ name: "calculated-option" });
+        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 shippingOptionsWithPrice = (0, workflows_sdk_1.transform)({
+            shippingOption,
+            prices,
+        }, ({ shippingOption, prices }) => {
+            return {
+                id: shippingOption.id,
+                name: shippingOption.name,
+                calculated_price: prices[0],
+            };
+        });
+        return shippingOptionsWithPrice;
+    });
+    const setPricingContext = (0, workflows_sdk_1.createHook)("setPricingContext", input, {
+        resultValidator: schemas_1.pricingContextResult,
+    });
+    const setPricingContextResult = setPricingContext.getResult();
+    const pricingContext = (0, workflows_sdk_1.transform)({ input, setPricingContextResult }, (data) => {
+        return {
+            ...(data.setPricingContextResult ? data.setPricingContextResult : {}),
+            currency_code: data.input.currency_code,
+        };
+    });
+    const flatRateShippingOption = (0, workflows_sdk_1.when)("option-flat", { isCalculatedPriceShippingOption }, ({ isCalculatedPriceShippingOption }) => !isCalculatedPriceShippingOption).then(() => {
+        const shippingOption = (0, common_1.useRemoteQueryStep)({
+            entry_point: "shipping_option",
+            fields: [
+                "id",
+                "name",
+                "calculated_price.calculated_amount",
+                "calculated_price.is_calculated_price_tax_inclusive",
+            ],
+            variables: {
+                id: input.shipping_option_id,
+                calculated_price: {
+                    context: pricingContext,
+                },
+            },
+            list: false,
+        }).config({ name: "flat-reate-option" });
+        return shippingOption;
+    });
+    const result = (0, workflows_sdk_1.transform)({
+        calculatedPriceShippingOption,
+        flatRateShippingOption,
+    }, ({ calculatedPriceShippingOption, flatRateShippingOption }) => {
+        return calculatedPriceShippingOption ?? flatRateShippingOption;
+    });
+    return new workflows_sdk_1.WorkflowResponse(result, { hooks: [setPricingContext] });
+});
+//# sourceMappingURL=fetch-shipping-option.js.map

package/dist/order/workflows/fetch-shipping-option.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-shipping-option.js","sourceRoot":"","sources":["../../../src/order/workflows/fetch-shipping-option.ts"],"names":[],"mappings":";;;AAOA,oEAMyC;AACzC,oDAA6E;AAC7E,mDAA4E;AAC5E,yCAAoE;AACpE,sDAA+D;AAE/D,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;AAgDY,QAAA,sCAAsC,GAAG,uBAAuB,CAAA;AAC7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACU,QAAA,mCAAmC,GAAG,IAAA,8BAAc,EAC/D,8CAAsC,EACtC,UAAU,KAA+C;IACvD,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,IAAA,0BAAiB,EAAC;QAChD,MAAM,EAAE,iBAAiB;QACzB,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,kBAAkB,EAAE;QACzC,MAAM,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC;QAC5B,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE;KAC3B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAA;IAE5C,MAAM,+BAA+B,GAAG,IAAA,yBAAS,EAC/C,aAAa,EACb,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,KAAK,+BAAuB,CAAC,UAAU,CACrE,CAAA;IAED,MAAM,6BAA6B,GAAG,IAAA,oBAAI,EACxC,mBAAmB,EACnB,EAAE,+BAA+B,EAAE,EACnC,CAAC,EAAE,+BAA+B,EAAE,EAAE,EAAE,CAAC,+BAA+B,CACzE,CAAC,IAAI,CAAC,GAAG,EAAE;QACV,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAA,0BAAiB,EAAC;YACxC,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE;YAC/B,MAAM,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,SAAS,EAAE,iBAAiB,CAAC;YAChE,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;SACrD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;QAElC,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,IAAA,0BAAiB,EAAC;YACjD,MAAM,EAAE,iBAAiB;YACzB,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,kBAAkB,EAAE;YACzC,MAAM,EAAE,CAAC,GAAG,qBAAqB,CAAC;YAClC,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE;SAC3B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAA;QAExC,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,wBAAwB,GAAG,IAAA,yBAAS,EACxC;YACE,cAAc;YACd,MAAM;SACP,EACD,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE;YAC7B,OAAO;gBACL,EAAE,EAAE,cAAc,CAAC,EAAE;gBACrB,IAAI,EAAE,cAAc,CAAC,IAAI;gBACzB,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC;aAC5B,CAAA;QACH,CAAC,CACF,CAAA;QAED,OAAO,wBAAwB,CAAA;IACjC,CAAC,CAAC,CAAA;IAEF,MAAM,iBAAiB,GAAG,IAAA,0BAAU,EAAC,mBAAmB,EAAE,KAAK,EAAE;QAC/D,eAAe,EAAE,8BAAoB;KACtC,CAAC,CAAA;IACF,MAAM,uBAAuB,GAAG,iBAAiB,CAAC,SAAS,EAAE,CAAA;IAC7D,MAAM,cAAc,GAAG,IAAA,yBAAS,EAC9B,EAAE,KAAK,EAAE,uBAAuB,EAAE,EAClC,CAAC,IAAI,EAAE,EAAE;QACP,OAAO;YACL,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC;YACrE,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa;SACxC,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,sBAAsB,GAAG,IAAA,oBAAI,EACjC,aAAa,EACb,EAAE,+BAA+B,EAAE,EACnC,CAAC,EAAE,+BAA+B,EAAE,EAAE,EAAE,CAAC,CAAC,+BAA+B,CAC1E,CAAC,IAAI,CAAC,GAAG,EAAE;QACV,MAAM,cAAc,GAAG,IAAA,2BAAkB,EAAC;YACxC,WAAW,EAAE,iBAAiB;YAC9B,MAAM,EAAE;gBACN,IAAI;gBACJ,MAAM;gBACN,oCAAoC;gBACpC,oDAAoD;aACrD;YACD,SAAS,EAAE;gBACT,EAAE,EAAE,KAAK,CAAC,kBAAkB;gBAC5B,gBAAgB,EAAE;oBAChB,OAAO,EAAE,cAAc;iBACxB;aACF;YACD,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAA;QAExC,OAAO,cAAc,CAAA;IACvB,CAAC,CAAC,CAAA;IAEF,MAAM,MAAM,GAA8C,IAAA,yBAAS,EACjE;QACE,6BAA6B;QAC7B,sBAAsB;KACvB,EACD,CAAC,EAAE,6BAA6B,EAAE,sBAAsB,EAAE,EAAE,EAAE;QAC5D,OAAO,6BAA6B,IAAI,sBAAsB,CAAA;IAChE,CAAC,CACF,CAAA;IAED,OAAO,IAAI,gCAAgB,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,iBAAiB,CAAU,EAAE,CAAC,CAAA;AAC9E,CAAC,CACF,CAAA"}

package/dist/order/workflows/get-order-detail.d.ts

@@ -0,0 +1,58 @@
+import type { OrderDetailDTO } from "@acmekit/framework/types";
+/**
+ * The data to retrieve an order's details.
+ */
+export type GetOrderDetailWorkflowInput = {
+    /**
+     * Additional filters to apply on the retrieved order.
+     */
+    filters?: {
+        /**
+         * Whether to retrieve a draft order.
+         */
+        is_draft_order?: boolean;
+        /**
+         * The ID of the customer that the order belongs to.
+         */
+        customer_id?: string;
+    };
+    /**
+     * The fields and relations to retrieve in the order. These fields
+     * are passed to [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query),
+     * so you can pass names of custom models linked to the order.
+     */
+    fields: string[];
+    /**
+     * The ID of the order to retrieve.
+     */
+    order_id: string;
+    /**
+     * The version of the order to retrieve. If not provided, the latest version
+     * of the order will be retrieved.
+     */
+    version?: number;
+};
+export declare const getOrderDetailWorkflowId = "get-order-detail";
+/**
+ * This workflow retrieves an order's details. It's used by many API routes, including
+ * [Get an Order Admin API Route](https://docs.acmekit.com/api/admin#orders_getordersid), and
+ * [Get an Order Store API Route](https://docs.acmekit.com/api/store#orders_getordersid).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to retrieve an
+ * order's details in your custom flows.
+ *
+ * @example
+ * const { result } = await getOrderDetailWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     fields: ["id", "status", "items"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Retrieve an order's details.
+ */
+export declare const getOrderDetailWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<GetOrderDetailWorkflowInput, OrderDetailDTO, []>;
+//# sourceMappingURL=get-order-detail.d.ts.map

package/dist/order/workflows/get-order-detail.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-order-detail.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/get-order-detail.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AAc9D;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,CAAA;QACxB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CAAA;IACD;;;;OAIG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,wBAAwB,qBAAqB,CAAA;AAC1D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,sBAAsB,4GAyClC,CAAA"}

package/dist/order/workflows/get-order-detail.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOrderDetailWorkflow = exports.getOrderDetailWorkflowId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+const aggregate_status_1 = require("../utils/aggregate-status");
+exports.getOrderDetailWorkflowId = "get-order-detail";
+/**
+ * This workflow retrieves an order's details. It's used by many API routes, including
+ * [Get an Order Admin API Route](https://docs.acmekit.com/api/admin#orders_getordersid), and
+ * [Get an Order Store API Route](https://docs.acmekit.com/api/store#orders_getordersid).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to retrieve an
+ * order's details in your custom flows.
+ *
+ * @example
+ * const { result } = await getOrderDetailWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     fields: ["id", "status", "items"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Retrieve an order's details.
+ */
+exports.getOrderDetailWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.getOrderDetailWorkflowId, (input) => {
+    const fields = (0, workflows_sdk_1.transform)(input, ({ fields }) => {
+        return (0, utils_1.deduplicate)([
+            ...fields,
+            "id",
+            "status",
+            "version",
+            "payment_collections.*",
+            "fulfillments.*",
+        ]);
+    });
+    const variables = (0, workflows_sdk_1.transform)({ input }, ({ input }) => {
+        return { ...input.filters, id: input.order_id, version: input.version };
+    });
+    const { data: order } = (0, common_1.useQueryGraphStep)({
+        entity: "order",
+        filters: variables,
+        fields: fields,
+        options: { throwIfKeyNotFound: true, isList: false },
+    }).config({ name: "get-order" });
+    const aggregatedOrder = (0, workflows_sdk_1.transform)({ order }, ({ order }) => {
+        const order_ = order;
+        order_.payment_status = (0, aggregate_status_1.getLastPaymentStatus)(order_);
+        order_.fulfillment_status = (0, aggregate_status_1.getLastFulfillmentStatus)(order_);
+        return order_;
+    });
+    return new workflows_sdk_1.WorkflowResponse(aggregatedOrder);
+});
+//# sourceMappingURL=get-order-detail.js.map

package/dist/order/workflows/get-order-detail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-order-detail.js","sourceRoot":"","sources":["../../../src/order/workflows/get-order-detail.ts"],"names":[],"mappings":";;;AACA,oDAAsD;AACtD,oEAKyC;AACzC,yCAAgD;AAChD,gEAGkC;AAoCrB,QAAA,wBAAwB,GAAG,kBAAkB,CAAA;AAC1D;;;;;;;;;;;;;;;;;;;;GAoBG;AACU,QAAA,sBAAsB,GAAG,IAAA,8BAAc,EAClD,gCAAwB,EACxB,CACE,KAAgD,EACd,EAAE;IACpC,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QAC7C,OAAO,IAAA,mBAAW,EAAC;YACjB,GAAG,MAAM;YACT,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,uBAAuB;YACvB,gBAAgB;SACjB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,MAAM,SAAS,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACnD,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAA;IACzE,CAAC,CAAC,CAAA;IAEF,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAA,0BAAiB,EAAC;QACxC,MAAM,EAAE,OAAO;QACf,OAAO,EAAE,SAAS;QAClB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;KACrD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAA;IAEhC,MAAM,eAAe,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACzD,MAAM,MAAM,GAAG,KAAuB,CAAA;QAEtC,MAAM,CAAC,cAAc,GAAG,IAAA,uCAAoB,EAC1C,MAAM,CAC6B,CAAA;QACrC,MAAM,CAAC,kBAAkB,GAAG,IAAA,2CAAwB,EAClD,MAAM,CACiC,CAAA;QACzC,OAAO,MAAM,CAAA;IACf,CAAC,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,eAAe,CAAC,CAAA;AAC9C,CAAC,CACF,CAAA"}

package/dist/order/workflows/get-orders-list.d.ts

@@ -0,0 +1,98 @@
+import type { OrderDTO } from "@acmekit/framework/types";
+/**
+ * The retrieved list of orders. If you passed pagination configurations in the
+ * input, the response will return an object that includes the list of
+ * orders and their pagination details. Otherwise, only the list of orders are returned.
+ */
+export type GetOrdersListWorkflowOutput = OrderDTO[] | {
+    /**
+     * The list of orders.
+     */
+    rows: OrderDTO[];
+    /**
+     * Pagination details.
+     */
+    metadata: {
+        /**
+         * The total number of orders.
+         */
+        count: number;
+        /**
+         * The number of items skipped before retrieving the returned orders.
+         */
+        skip: number;
+        /**
+         * The number of items to retrieve.
+         */
+        take: number;
+    };
+};
+export type GetOrdersListWorkflowInput = {
+    /**
+     * The fields and relations to retrieve in the order. These fields
+     * are passed to [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query),
+     * so you can pass names of custom models linked to the order.
+     */
+    fields: string[];
+    /**
+     * Filters and pagination configurations to apply on the retrieved orders.
+     */
+    variables?: Record<string, any> & {
+        /**
+         * The number of items to skip before retrieving the orders.
+         */
+        skip?: number;
+        /**
+         * The number of items to retrieve.
+         */
+        take?: number;
+        /**
+         * Fields to sort the orders by. The key is the field name, and the value is either
+         * `ASC` for ascending order or `DESC` for descending order.
+         */
+        order?: Record<string, string>;
+    };
+};
+export declare const getOrdersListWorkflowId = "get-orders-list";
+/**
+ * This workflow retrieves a list of orders. It's used by the
+ * [List Orders Admin API Route](https://docs.acmekit.com/api/admin#orders_getorders), and the
+ * [List Orders Store API Route](https://docs.acmekit.com/api/store#orders_getorders).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to retrieve a list of
+ * orders in your custom flows. For example, you can retrieve the list of orders to export them
+ * to a third-party system.
+ *
+ * @example
+ * To retrieve the list of orders:
+ *
+ * ```ts
+ * const { result } = await getOrdersListWorkflow(container)
+ * .run({
+ *   input: {
+ *     fields: ["id", "status", "items"],
+ *   }
+ * })
+ * ```
+ *
+ * To retrieve the list of orders with pagination:
+ *
+ * ```ts
+ * const { result } = await getOrdersListWorkflow(container)
+ * .run({
+ *   input: {
+ *     fields: ["id", "status", "items"],
+ *     variables: {
+ *       skip: 0,
+ *       take: 15,
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * @summary
+ *
+ * Retrieve a list of orders.
+ */
+export declare const getOrdersListWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<GetOrdersListWorkflowInput, GetOrdersListWorkflowOutput, []>;
+//# sourceMappingURL=get-orders-list.d.ts.map

package/dist/order/workflows/get-orders-list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-orders-list.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/get-orders-list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAkB,QAAQ,EAAE,MAAM,0BAA0B,CAAA;AAcxE;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GACnC,QAAQ,EAAE,GACV;IACE;;OAEG;IACH,IAAI,EAAE,QAAQ,EAAE,CAAA;IAChB;;OAEG;IACH,QAAQ,EAAE;QACR;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;QACZ;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;CACF,CAAA;AAEL,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;;OAIG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;QAChC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAC/B,CAAA;CACF,CAAA;AAED,eAAO,MAAM,uBAAuB,oBAAoB,CAAA;AACxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,eAAO,MAAM,qBAAqB,wHAsEjC,CAAA"}

package/dist/order/workflows/get-orders-list.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOrdersListWorkflow = exports.getOrdersListWorkflowId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+const aggregate_status_1 = require("../utils/aggregate-status");
+exports.getOrdersListWorkflowId = "get-orders-list";
+/**
+ * This workflow retrieves a list of orders. It's used by the
+ * [List Orders Admin API Route](https://docs.acmekit.com/api/admin#orders_getorders), and the
+ * [List Orders Store API Route](https://docs.acmekit.com/api/store#orders_getorders).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to retrieve a list of
+ * orders in your custom flows. For example, you can retrieve the list of orders to export them
+ * to a third-party system.
+ *
+ * @example
+ * To retrieve the list of orders:
+ *
+ * ```ts
+ * const { result } = await getOrdersListWorkflow(container)
+ * .run({
+ *   input: {
+ *     fields: ["id", "status", "items"],
+ *   }
+ * })
+ * ```
+ *
+ * To retrieve the list of orders with pagination:
+ *
+ * ```ts
+ * const { result } = await getOrdersListWorkflow(container)
+ * .run({
+ *   input: {
+ *     fields: ["id", "status", "items"],
+ *     variables: {
+ *       skip: 0,
+ *       take: 15,
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * @summary
+ *
+ * Retrieve a list of orders.
+ */
+exports.getOrdersListWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.getOrdersListWorkflowId, (input) => {
+    const fields = (0, workflows_sdk_1.transform)(input, ({ fields }) => {
+        return (0, utils_1.deduplicate)([
+            ...fields,
+            "id",
+            "status",
+            "version",
+            "items.*",
+            "payment_collections.status",
+            "payment_collections.amount",
+            "payment_collections.captured_amount",
+            "payment_collections.refunded_amount",
+            "fulfillments.packed_at",
+            "fulfillments.shipped_at",
+            "fulfillments.delivered_at",
+            "fulfillments.canceled_at",
+        ]);
+    });
+    const orders = (0, common_1.useRemoteQueryStep)({
+        entry_point: "orders",
+        fields,
+        variables: input.variables,
+        list: true,
+    });
+    const aggregatedOrders = (0, workflows_sdk_1.transform)({ orders, input }, ({ orders, input }) => {
+        const fields = input.fields;
+        const requiredPaymentFields = fields.some((f) => f.includes("payment_collections"));
+        const requiredFulfillmentFields = fields.some((f) => f.includes("fulfillments"));
+        const orders_ = orders;
+        const data = orders_.rows ? orders_.rows : orders_;
+        for (const order of data) {
+            const order_ = order;
+            order_.payment_status = (0, aggregate_status_1.getLastPaymentStatus)(order_);
+            order_.fulfillment_status = (0, aggregate_status_1.getLastFulfillmentStatus)(order_);
+            if (!requiredPaymentFields) {
+                // @ts-ignore
+                delete order_.payment_collections;
+            }
+            if (!requiredFulfillmentFields) {
+                // @ts-ignore
+                delete order_.fulfillments;
+            }
+        }
+        return orders;
+    });
+    return new workflows_sdk_1.WorkflowResponse(aggregatedOrders);
+});
+//# sourceMappingURL=get-orders-list.js.map

package/dist/order/workflows/get-orders-list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-orders-list.js","sourceRoot":"","sources":["../../../src/order/workflows/get-orders-list.ts"],"names":[],"mappings":";;;AACA,oDAAsD;AACtD,oEAKyC;AACzC,yCAAiD;AACjD,gEAGkC;AA4DrB,QAAA,uBAAuB,GAAG,iBAAiB,CAAA;AACxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACU,QAAA,qBAAqB,GAAG,IAAA,8BAAc,EACjD,+BAAuB,EACvB,CACE,KAA+C,EACA,EAAE;IACjD,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QAC7C,OAAO,IAAA,mBAAW,EAAC;YACjB,GAAG,MAAM;YACT,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,SAAS;YACT,4BAA4B;YAC5B,4BAA4B;YAC5B,qCAAqC;YACrC,qCAAqC;YACrC,wBAAwB;YACxB,yBAAyB;YACzB,2BAA2B;YAC3B,0BAA0B;SAC3B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,MAAM,MAAM,GAAe,IAAA,2BAAkB,EAAC;QAC5C,WAAW,EAAE,QAAQ;QACrB,MAAM;QACN,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,IAAI,EAAE,IAAI;KACX,CAAC,CAAA;IAEF,MAAM,gBAAgB,GAAG,IAAA,yBAAS,EAChC,EAAE,MAAM,EAAE,KAAK,EAAE,EACjB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE;QACpB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;QAC3B,MAAM,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAC9C,CAAC,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAClC,CAAA;QACD,MAAM,yBAAyB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAClD,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,CAC3B,CAAA;QAED,MAAM,OAAO,GAAG,MAAa,CAAA;QAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAA;QAElD,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;YACzB,MAAM,MAAM,GAAG,KAAuB,CAAA;YAEtC,MAAM,CAAC,cAAc,GAAG,IAAA,uCAAoB,EAC1C,MAAM,CAC6B,CAAA;YACrC,MAAM,CAAC,kBAAkB,GAAG,IAAA,2CAAwB,EAClD,MAAM,CACiC,CAAA;YAEzC,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC3B,aAAa;gBACb,OAAO,MAAM,CAAC,mBAAmB,CAAA;YACnC,CAAC;YACD,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBAC/B,aAAa;gBACb,OAAO,MAAM,CAAC,YAAY,CAAA;YAC5B,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC,CACF,CAAA;IAED,OAAO,IAAI,gCAAgB,CAAC,gBAAgB,CAAC,CAAA;AAC/C,CAAC,CACF,CAAA"}

package/dist/order/workflows/index.d.ts

@@ -0,0 +1,95 @@
+export * from "./add-line-items";
+export * from "./archive-orders";
+export * from "./cancel-order";
+export * from "./cancel-order-change";
+export * from "./cancel-order-fulfillment";
+export * from "./claim/begin-order-claim";
+export * from "./claim/cancel-begin-order-claim";
+export * from "./claim/cancel-claim";
+export * from "./claim/claim-add-new-item";
+export * from "./claim/claim-item";
+export * from "./claim/claim-request-item-return";
+export * from "./claim/confirm-claim-request";
+export * from "./claim/create-claim-shipping-method";
+export * from "./claim/remove-claim-add-item-action";
+export * from "./claim/remove-claim-item-action";
+export * from "./claim/remove-claim-shipping-method";
+export * from "./claim/update-claim-add-item";
+export * from "./claim/update-claim-item";
+export * from "./claim/update-claim-shipping-method";
+export * from "./complete-orders";
+export * from "./compute-adjustments-for-preview";
+export * from "./create-fulfillment";
+export * from "./create-or-update-order-payment-collection";
+export * from "./create-order";
+export * from "./create-order-change";
+export * from "./create-order-change-actions";
+export * from "./create-order-credit-lines";
+export * from "./create-order-payment-collection";
+export * from "./create-shipment";
+export * from "./decline-order-change";
+export * from "./delete-order-change";
+export * from "./delete-order-change-actions";
+export * from "./delete-order-payment-collection";
+export * from "./exchange/begin-order-exchange";
+export * from "./exchange/cancel-begin-order-exchange";
+export * from "./exchange/cancel-exchange";
+export * from "./exchange/confirm-exchange-request";
+export * from "./exchange/create-exchange-shipping-method";
+export * from "./exchange/exchange-add-new-item";
+export * from "./exchange/exchange-request-item-return";
+export * from "./exchange/remove-exchange-item-action";
+export * from "./exchange/remove-exchange-shipping-method";
+export * from "./exchange/update-exchange-add-item";
+export * from "./exchange/update-exchange-shipping-method";
+export * from "./export-orders";
+export * from "./fetch-shipping-option";
+export * from "./get-order-detail";
+export * from "./get-orders-list";
+export * from "./list-shipping-options-for-order";
+export * from "./mark-order-fulfillment-as-delivered";
+export * from "./mark-payment-collection-as-paid";
+export * from "./maybe-refresh-shipping-methods";
+export * from "./on-carry-promotions-flag-set";
+export * from "./order-edit/begin-order-edit";
+export * from "./order-edit/cancel-begin-order-edit";
+export * from "./order-edit/confirm-order-edit-request";
+export * from "./order-edit/create-order-edit-shipping-method";
+export * from "./order-edit/order-edit-add-new-item";
+export * from "./order-edit/order-edit-update-item-quantity";
+export * from "./order-edit/remove-order-edit-item-action";
+export * from "./order-edit/remove-order-edit-shipping-method";
+export * from "./order-edit/request-order-edit";
+export * from "./order-edit/update-order-edit-add-item";
+export * from "./order-edit/update-order-edit-item-quantity";
+export * from "./order-edit/update-order-edit-shipping-method";
+export * from "./return/begin-receive-return";
+export * from "./return/begin-return";
+export * from "./return/cancel-receive-return";
+export * from "./return/cancel-request-return";
+export * from "./return/cancel-return";
+export * from "./return/confirm-receive-return-request";
+export * from "./return/confirm-return-request";
+export * from "./return/create-complete-return";
+export * from "./return/create-return-shipping-method";
+export * from "./return/dismiss-item-return-request";
+export * from "./return/receive-complete-return";
+export * from "./return/receive-item-return-request";
+export * from "./return/remove-item-receive-return-action";
+export * from "./return/remove-item-return-action";
+export * from "./return/remove-return-shipping-method";
+export * from "./return/request-item-return";
+export * from "./return/update-receive-item-return-request";
+export * from "./return/update-request-item-return";
+export * from "./return/update-return";
+export * from "./return/update-return-shipping-method";
+export * from "./transfer/accept-order-transfer";
+export * from "./transfer/cancel-order-transfer";
+export * from "./transfer/decline-order-transfer";
+export * from "./transfer/request-order-transfer";
+export * from "./update-order";
+export * from "./update-order-change";
+export * from "./update-order-change-actions";
+export * from "./update-order-changes";
+export * from "./update-tax-lines";
+//# sourceMappingURL=index.d.ts.map

package/dist/order/workflows/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA;AAChC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,kCAAkC,CAAA;AAChD,cAAc,sBAAsB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,oBAAoB,CAAA;AAClC,cAAc,mCAAmC,CAAA;AACjD,cAAc,+BAA+B,CAAA;AAC7C,cAAc,sCAAsC,CAAA;AACpD,cAAc,sCAAsC,CAAA;AACpD,cAAc,kCAAkC,CAAA;AAChD,cAAc,sCAAsC,CAAA;AACpD,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,sCAAsC,CAAA;AACpD,cAAc,mBAAmB,CAAA;AACjC,cAAc,mCAAmC,CAAA;AACjD,cAAc,sBAAsB,CAAA;AACpC,cAAc,6CAA6C,CAAA;AAC3D,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,mCAAmC,CAAA;AACjD,cAAc,mBAAmB,CAAA;AACjC,cAAc,wBAAwB,CAAA;AACtC,cAAc,uBAAuB,CAAA;AACrC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,mCAAmC,CAAA;AACjD,cAAc,iCAAiC,CAAA;AAC/C,cAAc,wCAAwC,CAAA;AACtD,cAAc,4BAA4B,CAAA;AAC1C,cAAc,qCAAqC,CAAA;AACnD,cAAc,4CAA4C,CAAA;AAC1D,cAAc,kCAAkC,CAAA;AAChD,cAAc,yCAAyC,CAAA;AACvD,cAAc,wCAAwC,CAAA;AACtD,cAAc,4CAA4C,CAAA;AAC1D,cAAc,qCAAqC,CAAA;AACnD,cAAc,4CAA4C,CAAA;AAC1D,cAAc,iBAAiB,CAAA;AAC/B,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA;AAClC,cAAc,mBAAmB,CAAA;AACjC,cAAc,mCAAmC,CAAA;AACjD,cAAc,uCAAuC,CAAA;AACrD,cAAc,mCAAmC,CAAA;AACjD,cAAc,kCAAkC,CAAA;AAChD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,sCAAsC,CAAA;AACpD,cAAc,yCAAyC,CAAA;AACvD,cAAc,gDAAgD,CAAA;AAC9D,cAAc,sCAAsC,CAAA;AACpD,cAAc,8CAA8C,CAAA;AAC5D,cAAc,4CAA4C,CAAA;AAC1D,cAAc,gDAAgD,CAAA;AAC9D,cAAc,iCAAiC,CAAA;AAC/C,cAAc,yCAAyC,CAAA;AACvD,cAAc,8CAA8C,CAAA;AAC5D,cAAc,gDAAgD,CAAA;AAC9D,cAAc,+BAA+B,CAAA;AAC7C,cAAc,uBAAuB,CAAA;AACrC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,wBAAwB,CAAA;AACtC,cAAc,yCAAyC,CAAA;AACvD,cAAc,iCAAiC,CAAA;AAC/C,cAAc,iCAAiC,CAAA;AAC/C,cAAc,wCAAwC,CAAA;AACtD,cAAc,sCAAsC,CAAA;AACpD,cAAc,kCAAkC,CAAA;AAChD,cAAc,sCAAsC,CAAA;AACpD,cAAc,4CAA4C,CAAA;AAC1D,cAAc,oCAAoC,CAAA;AAClD,cAAc,wCAAwC,CAAA;AACtD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,6CAA6C,CAAA;AAC3D,cAAc,qCAAqC,CAAA;AACnD,cAAc,wBAAwB,CAAA;AACtC,cAAc,wCAAwC,CAAA;AACtD,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,mCAAmC,CAAA;AACjD,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA"}