@acmekit/core-flows 2.13.1

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

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFulfillmentWorkflow = exports.createFulfillmentWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+const common_1 = require("../../common");
+exports.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.
+ */
+exports.createFulfillmentWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createFulfillmentWorkflowId, (input) => {
+    const location = (0, common_1.useRemoteQueryStep)({
+        entry_point: "stock_location",
+        fields: [
+            "id",
+            "name",
+            "metadata",
+            "created_at",
+            "updated_at",
+            "address.id",
+            "address.address_1",
+            "address.address_2",
+            "address.city",
+            "address.country_code",
+            "address.phone",
+            "address.province",
+            "address.postal_code",
+            "address.metadata",
+        ],
+        variables: { id: input.location_id },
+        list: false,
+        throw_if_key_not_found: true,
+    }).config({ name: "get-location" });
+    const stepInput = (0, workflows_sdk_1.transform)({ input, location }, ({ input, location }) => {
+        return {
+            ...input,
+            location,
+        };
+    });
+    // When we have support for hooks with a return this would be a great
+    // place to put a hook for people to collect additional data they would
+    // like to pass down to the provider.
+    //
+    // const providerDataHook = createHook("getProviderData", stepInput)
+    //
+    // The collected provider data would be passed to createFulfillment in a
+    // additional_provider_data: Record<string, unknown> field.
+    const result = (0, steps_1.createFulfillmentStep)(stepInput);
+    return new workflows_sdk_1.WorkflowResponse(result);
+});
+//# sourceMappingURL=create-fulfillment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-fulfillment.js","sourceRoot":"","sources":["../../../src/fulfillment/workflows/create-fulfillment.ts"],"names":[],"mappings":";;;AAKA,oEAKyC;AACzC,oCAAgD;AAChD,yCAAiD;AAEpC,QAAA,2BAA2B,GAAG,6BAA6B,CAAA;AACxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACU,QAAA,yBAAyB,GAAG,IAAA,8BAAc,EACrD,mCAA2B,EAC3B,CACE,KAAuE,EACrC,EAAE;IACpC,MAAM,QAAQ,GAAqB,IAAA,2BAAkB,EAAC;QACpD,WAAW,EAAE,gBAAgB;QAC7B,MAAM,EAAE;YACN,IAAI;YACJ,MAAM;YACN,UAAU;YACV,YAAY;YACZ,YAAY;YACZ,YAAY;YACZ,mBAAmB;YACnB,mBAAmB;YACnB,cAAc;YACd,sBAAsB;YACtB,eAAe;YACf,kBAAkB;YAClB,qBAAqB;YACrB,kBAAkB;SACnB;QACD,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,WAAW,EAAE;QACpC,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAA;IAEnC,MAAM,SAAS,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE;QACvE,OAAO;YACL,GAAG,KAAK;YACR,QAAQ;SACT,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,qEAAqE;IACrE,uEAAuE;IACvE,qCAAqC;IACrC,EAAE;IACF,oEAAoE;IACpE,EAAE;IACF,wEAAwE;IACxE,2DAA2D;IAE3D,MAAM,MAAM,GAAG,IAAA,6BAAqB,EAAC,SAAS,CAAC,CAAA;IAE/C,OAAO,IAAI,gCAAgB,CAAC,MAAM,CAAC,CAAA;AACrC,CAAC,CACF,CAAA"}

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

@@ -0,0 +1,52 @@
+import { FulfillmentDTO, FulfillmentWorkflow } from "@acmekit/framework/types";
+export declare const createReturnFulfillmentWorkflowId = "create-return-fulfillment-workflow";
+/**
+ * This workflow creates a fulfillment for a return. It's used by other return-related workflows,
+ * such as {@link createAndCompleteReturnOrderWorkflow}.
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * create a fulfillment for a return 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 createReturnFulfillmentWorkflow(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 for a return.
+ */
+export declare const createReturnFulfillmentWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<FulfillmentWorkflow.CreateFulfillmentWorkflowInput, FulfillmentDTO, []>;
+//# sourceMappingURL=create-return-fulfillment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-return-fulfillment.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/workflows/create-return-fulfillment.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,mBAAmB,EAEpB,MAAM,0BAA0B,CAAA;AAUjC,eAAO,MAAM,iCAAiC,uCACR,CAAA;AACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,eAAO,MAAM,+BAA+B,mIAuC3C,CAAA"}

package/dist/fulfillment/workflows/create-return-fulfillment.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createReturnFulfillmentWorkflow = exports.createReturnFulfillmentWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+const common_1 = require("../../common");
+exports.createReturnFulfillmentWorkflowId = "create-return-fulfillment-workflow";
+/**
+ * This workflow creates a fulfillment for a return. It's used by other return-related workflows,
+ * such as {@link createAndCompleteReturnOrderWorkflow}.
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * create a fulfillment for a return 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 createReturnFulfillmentWorkflow(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 for a return.
+ */
+exports.createReturnFulfillmentWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createReturnFulfillmentWorkflowId, (input) => {
+    const location = (0, common_1.useRemoteQueryStep)({
+        entry_point: "stock_location",
+        fields: [
+            "id",
+            "name",
+            "metadata",
+            "created_at",
+            "updated_at",
+            "address.id",
+            "address.address_1",
+            "address.address_2",
+            "address.city",
+            "address.country_code",
+            "address.phone",
+            "address.province",
+            "address.postal_code",
+            "address.metadata",
+        ],
+        variables: { id: input.location_id },
+        list: false,
+        throw_if_key_not_found: true,
+    }).config({ name: "get-location" });
+    const stepInput = (0, workflows_sdk_1.transform)({ input, location }, ({ input, location }) => {
+        return {
+            ...input,
+            location,
+        };
+    });
+    const result = (0, steps_1.createReturnFulfillmentStep)(stepInput);
+    return new workflows_sdk_1.WorkflowResponse(result);
+});
+//# sourceMappingURL=create-return-fulfillment.js.map

package/dist/fulfillment/workflows/create-return-fulfillment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-return-fulfillment.js","sourceRoot":"","sources":["../../../src/fulfillment/workflows/create-return-fulfillment.ts"],"names":[],"mappings":";;;AAKA,oEAKyC;AACzC,oCAAsD;AACtD,yCAAiD;AAEpC,QAAA,iCAAiC,GAC5C,oCAAoC,CAAA;AACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACU,QAAA,+BAA+B,GAAG,IAAA,8BAAc,EAC3D,yCAAiC,EACjC,CACE,KAAuE,EACrC,EAAE;IACpC,MAAM,QAAQ,GAAqB,IAAA,2BAAkB,EAAC;QACpD,WAAW,EAAE,gBAAgB;QAC7B,MAAM,EAAE;YACN,IAAI;YACJ,MAAM;YACN,UAAU;YACV,YAAY;YACZ,YAAY;YACZ,YAAY;YACZ,mBAAmB;YACnB,mBAAmB;YACnB,cAAc;YACd,sBAAsB;YACtB,eAAe;YACf,kBAAkB;YAClB,qBAAqB;YACrB,kBAAkB;SACnB;QACD,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,WAAW,EAAE;QACpC,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAA;IAEnC,MAAM,SAAS,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE;QACvE,OAAO;YACL,GAAG,KAAK;YACR,QAAQ;SACT,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,MAAM,GAAG,IAAA,mCAA2B,EAAC,SAAS,CAAC,CAAA;IAErD,OAAO,IAAI,gCAAgB,CAAC,MAAM,CAAC,CAAA;AACrC,CAAC,CACF,CAAA"}

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

@@ -0,0 +1,38 @@
+import type { FulfillmentWorkflow, ServiceZoneDTO } from "@acmekit/framework/types";
+/**
+ * The service zones to create.
+ */
+export type CreateServiceZonesWorkflowOutput = ServiceZoneDTO[];
+export declare const createServiceZonesWorkflowId = "create-service-zones-workflow";
+/**
+ * This workflow creates one or more service zones. It's used by the
+ * [Add Service Zone to Fulfillment Set Admin API Route](https://docs.acmekit.com/api/admin#fulfillment-sets_postfulfillmentsetsidservicezones).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * create service zones within your custom flows.
+ *
+ * @example
+ * const { result } = await createServiceZonesWorkflow(container)
+ * .run({
+ *   input: {
+ *     data: [
+ *       {
+ *         name: "US",
+ *         fulfillment_set_id: "fuset_123",
+ *         geo_zones: [
+ *           {
+ *             type: "country",
+ *             country_code: "us",
+ *           }
+ *         ]
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create one or more service zones.
+ */
+export declare const createServiceZonesWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<FulfillmentWorkflow.CreateServiceZonesWorkflowInput, CreateServiceZonesWorkflowOutput, []>;
+//# sourceMappingURL=create-service-zones.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-service-zones.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/workflows/create-service-zones.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACf,MAAM,0BAA0B,CAAA;AAQjC;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG,cAAc,EAAE,CAAA;AAE/D,eAAO,MAAM,4BAA4B,kCAAkC,CAAA;AAC3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,0BAA0B,sJAOtC,CAAA"}

package/dist/fulfillment/workflows/create-service-zones.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createServiceZonesWorkflow = exports.createServiceZonesWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+exports.createServiceZonesWorkflowId = "create-service-zones-workflow";
+/**
+ * This workflow creates one or more service zones. It's used by the
+ * [Add Service Zone to Fulfillment Set Admin API Route](https://docs.acmekit.com/api/admin#fulfillment-sets_postfulfillmentsetsidservicezones).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * create service zones within your custom flows.
+ *
+ * @example
+ * const { result } = await createServiceZonesWorkflow(container)
+ * .run({
+ *   input: {
+ *     data: [
+ *       {
+ *         name: "US",
+ *         fulfillment_set_id: "fuset_123",
+ *         geo_zones: [
+ *           {
+ *             type: "country",
+ *             country_code: "us",
+ *           }
+ *         ]
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create one or more service zones.
+ */
+exports.createServiceZonesWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createServiceZonesWorkflowId, (input) => {
+    return new workflows_sdk_1.WorkflowResponse((0, steps_1.createServiceZonesStep)(input.data));
+});
+//# sourceMappingURL=create-service-zones.js.map

package/dist/fulfillment/workflows/create-service-zones.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-service-zones.js","sourceRoot":"","sources":["../../../src/fulfillment/workflows/create-service-zones.ts"],"names":[],"mappings":";;;AAIA,oEAIyC;AACzC,oCAAiD;AAOpC,QAAA,4BAA4B,GAAG,+BAA+B,CAAA;AAC3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACU,QAAA,0BAA0B,GAAG,IAAA,8BAAc,EACtD,oCAA4B,EAC5B,CACE,KAAwE,EACpB,EAAE;IACtD,OAAO,IAAI,gCAAgB,CAAC,IAAA,8BAAsB,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;AACjE,CAAC,CACF,CAAA"}

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

@@ -0,0 +1,30 @@
+import type { FulfillmentWorkflow } from "@acmekit/framework/types";
+export declare const createShipmentWorkflowId = "create-shipment-workflow";
+/**
+ * This workflow creates shipments for a fulfillment. It's used by the
+ * [Create Shipment Admin API Route](https://docs.acmekit.com/api/admin#fulfillments_postfulfillmentsidshipment).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * create shipments within your custom flows.
+ *
+ * @example
+ * const { result } = await createShipmentWorkflow(container)
+ * .run({
+ *   input: {
+ *     id: "ful_123",
+ *     labels: [
+ *       {
+ *         tracking_url: "https://example.com",
+ *         tracking_number: "123",
+ *         label_url: "https://example.com"
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create a shipment for a fulfillment.
+ */
+export declare const createShipmentWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<FulfillmentWorkflow.CreateShipmentWorkflowInput, import("@acmekit/framework/types").FulfillmentDTO, []>;
+//# sourceMappingURL=create-shipment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-shipment.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/workflows/create-shipment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAUnE,eAAO,MAAM,wBAAwB,6BAA6B,CAAA;AAClE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,sBAAsB,mKAgBlC,CAAA"}

package/dist/fulfillment/workflows/create-shipment.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createShipmentWorkflow = exports.createShipmentWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+const update_fulfillment_1 = require("./update-fulfillment");
+exports.createShipmentWorkflowId = "create-shipment-workflow";
+/**
+ * This workflow creates shipments for a fulfillment. It's used by the
+ * [Create Shipment Admin API Route](https://docs.acmekit.com/api/admin#fulfillments_postfulfillmentsidshipment).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * create shipments within your custom flows.
+ *
+ * @example
+ * const { result } = await createShipmentWorkflow(container)
+ * .run({
+ *   input: {
+ *     id: "ful_123",
+ *     labels: [
+ *       {
+ *         tracking_url: "https://example.com",
+ *         tracking_number: "123",
+ *         label_url: "https://example.com"
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create a shipment for a fulfillment.
+ */
+exports.createShipmentWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createShipmentWorkflowId, (input) => {
+    (0, steps_1.validateShipmentStep)(input.id);
+    const update = (0, workflows_sdk_1.transform)({ input }, (data) => ({
+        ...data.input,
+        shipped_at: new Date(),
+    }));
+    return new workflows_sdk_1.WorkflowResponse(update_fulfillment_1.updateFulfillmentWorkflow.runAsStep({
+        input: update,
+    }));
+});
+//# sourceMappingURL=create-shipment.js.map

package/dist/fulfillment/workflows/create-shipment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-shipment.js","sourceRoot":"","sources":["../../../src/fulfillment/workflows/create-shipment.ts"],"names":[],"mappings":";;;AACA,oEAKyC;AACzC,oCAA+C;AAC/C,6DAAgE;AAEnD,QAAA,wBAAwB,GAAG,0BAA0B,CAAA;AAClE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACU,QAAA,sBAAsB,GAAG,IAAA,8BAAc,EAClD,gCAAwB,EACxB,CAAC,KAAoE,EAAE,EAAE;IACvE,IAAA,4BAAoB,EAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IAE9B,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7C,GAAG,IAAI,CAAC,KAAK;QACb,UAAU,EAAE,IAAI,IAAI,EAAE;KACvB,CAAC,CAAC,CAAA;IAEH,OAAO,IAAI,gCAAgB,CACzB,8CAAyB,CAAC,SAAS,CAAC;QAClC,KAAK,EAAE,MAAM;KACd,CAAC,CACH,CAAA;AACH,CAAC,CACF,CAAA"}

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

@@ -0,0 +1,83 @@
+import type { FulfillmentWorkflow } from "@acmekit/framework/types";
+/**
+ * The data to create the shipping options.
+ */
+export type CreateShippingOptionsWorkflowInput = FulfillmentWorkflow.CreateShippingOptionsWorkflowInput[];
+export declare const createShippingOptionsWorkflowId = "create-shipping-options-workflow";
+/**
+ * This workflow creates one or more shipping options. It's used by the
+ * [Create Shipping Option Admin API Route](https://docs.acmekit.com/api/admin#shipping-options_postshippingoptions).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * create shipping options within your custom flows.
+ *
+ * @example
+ * To calculate a shipping option with flat rate prices:
+ *
+ * :::note
+ *
+ * Learn more about adding rules to the shipping option's prices in the Pricing Module's
+ * [Price Rules](https://docs.acmekit.com/resources/commerce-modules/pricing/price-rules) documentation.
+ *
+ * :::
+ *
+ * ```ts
+ * const { result } = await createShippingOptionsWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       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: "flat",
+ *       prices: [
+ *         {
+ *           amount: 500,
+ *           currency_code: "usd"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * })
+ * ```
+ *
+ * To calculate shipping option with calculated prices, set `price_type` to `calculated` and don't pass a `prices` array:
+ *
+ * :::note
+ *
+ * You can calculate the shipping option's price for a cart using the [calculateShippingOptionsPricesWorkflow](https://docs.acmekit.com/resources/references/acmekit-workflows/calculateShippingOptionsPricesWorkflow).
+ *
+ * :::
+ *
+ * ```ts
+ * const { result } = await createShippingOptionsWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       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",
+ *     }
+ *   ]
+ * })
+ * ```
+ *
+ * @summary
+ *
+ * Create shipping options.
+ */
+export declare const createShippingOptionsWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<CreateShippingOptionsWorkflowInput, FulfillmentWorkflow.CreateShippingOptionsWorkflowOutput, []>;
+//# sourceMappingURL=create-shipping-options.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-shipping-options.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/workflows/create-shipping-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAkBnE;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAC5C,mBAAmB,CAAC,kCAAkC,EAAE,CAAA;AAE1D,eAAO,MAAM,+BAA+B,qCACR,CAAA;AACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,eAAO,MAAM,6BAA6B,4JAyFzC,CAAA"}

package/dist/fulfillment/workflows/create-shipping-options.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createShippingOptionsWorkflow = exports.createShippingOptionsWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+const set_shipping_options_price_sets_1 = require("../steps/set-shipping-options-price-sets");
+const validate_fulfillment_providers_1 = require("../steps/validate-fulfillment-providers");
+const validate_shipping_option_prices_1 = require("../steps/validate-shipping-option-prices");
+const common_1 = require("../../common");
+const utils_1 = require("@acmekit/framework/utils");
+exports.createShippingOptionsWorkflowId = "create-shipping-options-workflow";
+/**
+ * This workflow creates one or more shipping options. It's used by the
+ * [Create Shipping Option Admin API Route](https://docs.acmekit.com/api/admin#shipping-options_postshippingoptions).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to
+ * create shipping options within your custom flows.
+ *
+ * @example
+ * To calculate a shipping option with flat rate prices:
+ *
+ * :::note
+ *
+ * Learn more about adding rules to the shipping option's prices in the Pricing Module's
+ * [Price Rules](https://docs.acmekit.com/resources/commerce-modules/pricing/price-rules) documentation.
+ *
+ * :::
+ *
+ * ```ts
+ * const { result } = await createShippingOptionsWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       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: "flat",
+ *       prices: [
+ *         {
+ *           amount: 500,
+ *           currency_code: "usd"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * })
+ * ```
+ *
+ * To calculate shipping option with calculated prices, set `price_type` to `calculated` and don't pass a `prices` array:
+ *
+ * :::note
+ *
+ * You can calculate the shipping option's price for a cart using the [calculateShippingOptionsPricesWorkflow](https://docs.acmekit.com/resources/references/acmekit-workflows/calculateShippingOptionsPricesWorkflow).
+ *
+ * :::
+ *
+ * ```ts
+ * const { result } = await createShippingOptionsWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       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",
+ *     }
+ *   ]
+ * })
+ * ```
+ *
+ * @summary
+ *
+ * Create shipping options.
+ */
+exports.createShippingOptionsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createShippingOptionsWorkflowId, (input) => {
+    (0, workflows_sdk_1.parallelize)((0, validate_fulfillment_providers_1.validateFulfillmentProvidersStep)(input), (0, validate_shipping_option_prices_1.validateShippingOptionPricesStep)(input));
+    const data = (0, workflows_sdk_1.transform)(input, (data) => {
+        const shippingOptionsIndexToPrices = data.map((option, index) => {
+            /**
+             * Flat rate ShippingOptions always needs to provide a price array.
+             *
+             * For calculated pricing we create an "empty" price set
+             * so we can have simpler update flow for both cases and allow updating price_type.
+             */
+            const prices = option.prices ?? [];
+            return {
+                shipping_option_index: index,
+                prices,
+            };
+        });
+        return {
+            shippingOptions: data,
+            shippingOptionsIndexToPrices,
+        };
+    });
+    const createdShippingOptions = (0, steps_1.upsertShippingOptionsStep)(data.shippingOptions);
+    const eventData = (0, workflows_sdk_1.transform)(createdShippingOptions, (data) => {
+        return data.map((option) => {
+            return { id: option.id };
+        });
+    });
+    const normalizedShippingOptionsPrices = (0, workflows_sdk_1.transform)({
+        shippingOptions: createdShippingOptions,
+        shippingOptionsIndexToPrices: data.shippingOptionsIndexToPrices,
+    }, (data) => {
+        const shippingOptionsPrices = data.shippingOptionsIndexToPrices.map(({ shipping_option_index, prices }) => {
+            return {
+                id: data.shippingOptions[shipping_option_index].id,
+                prices,
+            };
+        });
+        return {
+            shippingOptionsPrices,
+        };
+    });
+    const shippingOptionsPriceSetsLinkData = (0, steps_1.createShippingOptionsPriceSetsStep)(normalizedShippingOptionsPrices.shippingOptionsPrices);
+    const normalizedLinkData = (0, workflows_sdk_1.transform)({
+        shippingOptionsPriceSetsLinkData,
+    }, (data) => {
+        return data.shippingOptionsPriceSetsLinkData.map((item) => {
+            return {
+                id: item.id,
+                price_sets: [item.priceSetId],
+            };
+        });
+    });
+    (0, workflows_sdk_1.parallelize)((0, set_shipping_options_price_sets_1.setShippingOptionsPriceSetsStep)(normalizedLinkData), (0, common_1.emitEventStep)({
+        eventName: utils_1.ShippingOptionWorkflowEvents.CREATED,
+        data: eventData,
+    }));
+    return new workflows_sdk_1.WorkflowResponse(createdShippingOptions);
+});
+//# sourceMappingURL=create-shipping-options.js.map

package/dist/fulfillment/workflows/create-shipping-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-shipping-options.js","sourceRoot":"","sources":["../../../src/fulfillment/workflows/create-shipping-options.ts"],"names":[],"mappings":";;;AACA,oEAMyC;AACzC,oCAGiB;AACjB,8FAA0F;AAC1F,4FAA0F;AAC1F,8FAA2F;AAC3F,yCAA4C;AAC5C,oDAAuE;AAQ1D,QAAA,+BAA+B,GAC1C,kCAAkC,CAAA;AACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACU,QAAA,6BAA6B,GAAG,IAAA,8BAAc,EACzD,uCAA+B,EAC/B,CACE,KAAuD,EACoB,EAAE;IAC7E,IAAA,2BAAW,EACT,IAAA,iEAAgC,EAAC,KAAK,CAAC,EACvC,IAAA,kEAAgC,EAAC,KAAK,CAAC,CACxC,CAAA;IAED,MAAM,IAAI,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE;QACrC,MAAM,4BAA4B,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YAC9D;;;;;eAKG;YACH,MAAM,MAAM,GAAI,MAAc,CAAC,MAAM,IAAI,EAAE,CAAA;YAC3C,OAAO;gBACL,qBAAqB,EAAE,KAAK;gBAC5B,MAAM;aACP,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,OAAO;YACL,eAAe,EAAE,IAAI;YACrB,4BAA4B;SAC7B,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,sBAAsB,GAAG,IAAA,iCAAyB,EACtD,IAAI,CAAC,eAAe,CACrB,CAAA;IAED,MAAM,SAAS,GAAG,IAAA,yBAAS,EAAC,sBAAsB,EAAE,CAAC,IAAI,EAAE,EAAE;QAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAA;QAC1B,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,MAAM,+BAA+B,GAAG,IAAA,yBAAS,EAC/C;QACE,eAAe,EAAE,sBAAsB;QACvC,4BAA4B,EAAE,IAAI,CAAC,4BAA4B;KAChE,EACD,CAAC,IAAI,EAAE,EAAE;QACP,MAAM,qBAAqB,GAAG,IAAI,CAAC,4BAA4B,CAAC,GAAG,CACjE,CAAC,EAAE,qBAAqB,EAAE,MAAM,EAAE,EAAE,EAAE;YACpC,OAAO;gBACL,EAAE,EAAE,IAAI,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC,EAAE;gBAClD,MAAM;aACP,CAAA;QACH,CAAC,CACF,CAAA;QAED,OAAO;YACL,qBAAqB;SACtB,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,gCAAgC,GAAG,IAAA,0CAAkC,EACzE,+BAA+B,CAAC,qBAAqB,CACtD,CAAA;IAED,MAAM,kBAAkB,GAAG,IAAA,yBAAS,EAClC;QACE,gCAAgC;KACjC,EACD,CAAC,IAAI,EAAE,EAAE;QACP,OAAO,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACxD,OAAO;gBACL,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,UAAU,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC;aAC9B,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CACF,CAAA;IAED,IAAA,2BAAW,EACT,IAAA,iEAA+B,EAAC,kBAAkB,CAAC,EACnD,IAAA,sBAAa,EAAC;QACZ,SAAS,EAAE,oCAA4B,CAAC,OAAO;QAC/C,IAAI,EAAE,SAAS;KAChB,CAAC,CACH,CAAA;IACD,OAAO,IAAI,gCAAgB,CAAC,sBAAsB,CAAC,CAAA;AACrD,CAAC,CACF,CAAA"}