@acmekit/core-flows 2.13.1

package/dist/product/workflows/export-products.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportProductsWorkflow = exports.exportProductsWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+const common_1 = require("../../common");
+const notification_1 = require("../../notification");
+exports.exportProductsWorkflowId = "export-products";
+/**
+ * This workflow exports products matching the specified filters. It's used by the
+ * [Export Products Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsexport).
+ *
+ * :::note
+ *
+ * This workflow doesn't return the exported products. Instead, it sends a notification to the admin
+ * users that they can download the exported products. Learn more in the [API Reference](https://docs.acmekit.com/api/admin#products_postproductsexport).
+ *
+ * :::
+ *
+ * @example
+ * To export all products:
+ *
+ * ```ts
+ * const { result } = await exportProductsWorkflow(container)
+ * .run({
+ *   input: {
+ *     select: ["*"],
+ *   }
+ * })
+ * ```
+ *
+ * To export products matching a criteria:
+ *
+ * ```ts
+ * const { result } = await exportProductsWorkflow(container)
+ * .run({
+ *   input: {
+ *     select: ["*"],
+ *     filter: {
+ *       collection_id: "pcol_123"
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * @summary
+ *
+ * Export products with filtering capabilities.
+ */
+exports.exportProductsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.exportProductsWorkflowId, (input) => {
+    const file = (0, steps_1.exportProductsStep)(input).config({
+        async: true,
+        backgroundExecution: true,
+    });
+    const failureNotification = (0, workflows_sdk_1.transform)({ input }, (data) => {
+        return [
+            {
+                // We don't need the recipient here for now, but if we want to push feed notifications to a specific user we could add it.
+                to: "",
+                channel: "feed",
+                template: "admin-ui",
+                data: {
+                    title: "Product export",
+                    description: `Failed to export products, please try again later.`,
+                },
+            },
+        ];
+    });
+    (0, notification_1.notifyOnFailureStep)(failureNotification);
+    const { data: fileDetails } = (0, common_1.useQueryGraphStep)({
+        entity: "file",
+        fields: ["id", "url"],
+        filters: { id: file.id },
+        options: { isList: false },
+    });
+    const notifications = (0, workflows_sdk_1.transform)({ fileDetails, file }, (data) => {
+        return [
+            {
+                // We don't need the recipient here for now, but if we want to push feed notifications to a specific user we could add it.
+                to: "",
+                channel: "feed",
+                template: "admin-ui",
+                data: {
+                    title: "Product export",
+                    description: "Product export completed successfully!",
+                    file: {
+                        filename: data.file.filename,
+                        url: data.fileDetails.url,
+                        mimeType: "text/csv",
+                    },
+                },
+            },
+        ];
+    });
+    (0, notification_1.sendNotificationsStep)(notifications);
+});
+//# sourceMappingURL=export-products.js.map

package/dist/product/workflows/export-products.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-products.js","sourceRoot":"","sources":["../../../src/product/workflows/export-products.ts"],"names":[],"mappings":";;;AAAA,oEAIyC;AAEzC,oCAA6C;AAC7C,yCAAgD;AAChD,qDAA+E;AAElE,QAAA,wBAAwB,GAAG,iBAAiB,CAAA;AACzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACU,QAAA,sBAAsB,GAAG,IAAA,8BAAc,EAClD,gCAAwB,EACxB,CACE,KAAoE,EAChD,EAAE;IACtB,MAAM,IAAI,GAAG,IAAA,0BAAkB,EAAC,KAAK,CAAC,CAAC,MAAM,CAAC;QAC5C,KAAK,EAAE,IAAI;QACX,mBAAmB,EAAE,IAAI;KAC1B,CAAC,CAAA;IAEF,MAAM,mBAAmB,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACxD,OAAO;YACL;gBACE,0HAA0H;gBAC1H,EAAE,EAAE,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,QAAQ,EAAE,UAAU;gBACpB,IAAI,EAAE;oBACJ,KAAK,EAAE,gBAAgB;oBACvB,WAAW,EAAE,oDAAoD;iBAClE;aACF;SACF,CAAA;IACH,CAAC,CAAC,CAAA;IACF,IAAA,kCAAmB,EAAC,mBAAmB,CAAC,CAAA;IAExC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAA,0BAAiB,EAAC;QAC9C,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;QACrB,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE;QACxB,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE;KAC3B,CAAC,CAAA;IAEF,MAAM,aAAa,GAAG,IAAA,yBAAS,EAAC,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QAC9D,OAAO;YACL;gBACE,0HAA0H;gBAC1H,EAAE,EAAE,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,QAAQ,EAAE,UAAU;gBACpB,IAAI,EAAE;oBACJ,KAAK,EAAE,gBAAgB;oBACvB,WAAW,EAAE,wCAAwC;oBACrD,IAAI,EAAE;wBACJ,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;wBAC5B,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG;wBACzB,QAAQ,EAAE,UAAU;qBACrB;iBACF;aACF;SACF,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,IAAA,oCAAqB,EAAC,aAAa,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}

package/dist/product/workflows/import-products-as-chunks.d.ts

@@ -0,0 +1,81 @@
+import type { WorkflowTypes } from "@acmekit/framework/types";
+export declare const importProductsAsChunksWorkflowId = "import-products-as-chunks";
+/**
+ * This workflow starts a product import from a CSV file in the background. It's used by the
+ * [Import Products Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsimport).
+ *
+ * You can use this workflow within your custom workflows, allowing you to wrap custom logic around product import.
+ * For example, you can import products from another system.
+ *
+ * The workflow only starts the import, but you'll have to confirm it using the [Workflow Engine](https://docs.acmekit.com/resources/infrastructure-modules/workflow-engine).
+ * The below example shows how to confirm the import.
+ *
+ * @example
+ * To start the import of a CSV file:
+ *
+ * ```ts
+ * const { result, transaction } = await importProductsAsChunksWorkflow(container)
+ * .run({
+ *   input: {
+ *     filename: "products.csv",
+ *     fileKey: "products.csv",
+ *   }
+ * })
+ * ```
+ *
+ * Notice that the workflow returns a `transaction.transactionId`. You'll use this ID to confirm the import afterwards.
+ *
+ * You confirm the import using the [Workflow Engine](https://docs.acmekit.com/resources/infrastructure-modules/workflow-engine).
+ * For example, in an API route:
+ *
+ * ```ts workflow={false}
+ * import {
+ *   AuthenticatedAcmeKitRequest,
+ *   AcmeKitResponse,
+ * } from "@acmekit/framework/http"
+ * import {
+ *   importProductsAsChunksWorkflowId,
+ *   waitConfirmationProductImportStepId,
+ * } from "@acmekit/core-flows"
+ * import type { IWorkflowEngineService } from "@acmekit/framework/types"
+ * import { Modules, TransactionHandlerType } from "@acmekit/framework/utils"
+ * import { StepResponse } from "@acmekit/framework/workflows-sdk"
+ *
+ * export const POST = async (
+ *   req: AuthenticatedAcmeKitRequest,
+ *   res: AcmeKitResponse
+ * ) => {
+ *   const workflowEngineService: IWorkflowEngineService = req.scope.resolve(
+ *     Modules.WORKFLOW_ENGINE
+ *   )
+ *   const transactionId = req.params.transaction_id
+ *
+ *   await workflowEngineService.setStepSuccess({
+ *     idempotencyKey: {
+ *       action: TransactionHandlerType.INVOKE,
+ *       transactionId,
+ *       stepId: waitConfirmationProductImportStepId,
+ *       workflowId: importProductsAsChunksWorkflowId,
+ *     },
+ *     stepResponse: new StepResponse(true),
+ *   })
+ *
+ *   res.status(202).json({})
+ * }
+ * ```
+ *
+ * :::tip
+ *
+ * This example API route uses the same implementation as the [Confirm Product Import Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsimportstransaction_idconfirm).
+ *
+ * :::
+ *
+ * @summary
+ *
+ * Import products from a CSV file.
+ */
+export declare const importProductsAsChunksWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<{
+    fileKey: string;
+    filename: string;
+}, WorkflowTypes.ProductWorkflow.ImportProductsSummary, []>;
+//# sourceMappingURL=import-products-as-chunks.d.ts.map

package/dist/product/workflows/import-products-as-chunks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-products-as-chunks.d.ts","sourceRoot":"","sources":["../../../src/product/workflows/import-products-as-chunks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAc7D,eAAO,MAAM,gCAAgC,8BAA8B,CAAA;AAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,eAAO,MAAM,8BAA8B;aAGR,MAAM;cAAY,MAAM;2DA2C1D,CAAA"}

package/dist/product/workflows/import-products-as-chunks.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.importProductsAsChunksWorkflow = exports.importProductsAsChunksWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const notification_1 = require("../../notification");
+const steps_1 = require("../steps");
+exports.importProductsAsChunksWorkflowId = "import-products-as-chunks";
+/**
+ * This workflow starts a product import from a CSV file in the background. It's used by the
+ * [Import Products Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsimport).
+ *
+ * You can use this workflow within your custom workflows, allowing you to wrap custom logic around product import.
+ * For example, you can import products from another system.
+ *
+ * The workflow only starts the import, but you'll have to confirm it using the [Workflow Engine](https://docs.acmekit.com/resources/infrastructure-modules/workflow-engine).
+ * The below example shows how to confirm the import.
+ *
+ * @example
+ * To start the import of a CSV file:
+ *
+ * ```ts
+ * const { result, transaction } = await importProductsAsChunksWorkflow(container)
+ * .run({
+ *   input: {
+ *     filename: "products.csv",
+ *     fileKey: "products.csv",
+ *   }
+ * })
+ * ```
+ *
+ * Notice that the workflow returns a `transaction.transactionId`. You'll use this ID to confirm the import afterwards.
+ *
+ * You confirm the import using the [Workflow Engine](https://docs.acmekit.com/resources/infrastructure-modules/workflow-engine).
+ * For example, in an API route:
+ *
+ * ```ts workflow={false}
+ * import {
+ *   AuthenticatedAcmeKitRequest,
+ *   AcmeKitResponse,
+ * } from "@acmekit/framework/http"
+ * import {
+ *   importProductsAsChunksWorkflowId,
+ *   waitConfirmationProductImportStepId,
+ * } from "@acmekit/core-flows"
+ * import type { IWorkflowEngineService } from "@acmekit/framework/types"
+ * import { Modules, TransactionHandlerType } from "@acmekit/framework/utils"
+ * import { StepResponse } from "@acmekit/framework/workflows-sdk"
+ *
+ * export const POST = async (
+ *   req: AuthenticatedAcmeKitRequest,
+ *   res: AcmeKitResponse
+ * ) => {
+ *   const workflowEngineService: IWorkflowEngineService = req.scope.resolve(
+ *     Modules.WORKFLOW_ENGINE
+ *   )
+ *   const transactionId = req.params.transaction_id
+ *
+ *   await workflowEngineService.setStepSuccess({
+ *     idempotencyKey: {
+ *       action: TransactionHandlerType.INVOKE,
+ *       transactionId,
+ *       stepId: waitConfirmationProductImportStepId,
+ *       workflowId: importProductsAsChunksWorkflowId,
+ *     },
+ *     stepResponse: new StepResponse(true),
+ *   })
+ *
+ *   res.status(202).json({})
+ * }
+ * ```
+ *
+ * :::tip
+ *
+ * This example API route uses the same implementation as the [Confirm Product Import Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsimportstransaction_idconfirm).
+ *
+ * :::
+ *
+ * @summary
+ *
+ * Import products from a CSV file.
+ */
+exports.importProductsAsChunksWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.importProductsAsChunksWorkflowId, (input) => {
+    const batchRequest = (0, steps_1.normalizeCsvToChunksStep)(input.fileKey);
+    (0, steps_1.waitConfirmationProductImportStep)();
+    // Q: Can we somehow access the error from the step that threw here? Or in a compensate step at least?
+    const failureNotification = (0, workflows_sdk_1.transform)({ input }, (data) => {
+        return [
+            {
+                // We don't need the recipient here for now, but if we want to push feed notifications to a specific user we could add it.
+                to: "",
+                channel: "feed",
+                template: "admin-ui",
+                data: {
+                    title: "Product import",
+                    description: `Failed to import products from file ${data.input.filename}`,
+                },
+            },
+        ];
+    });
+    (0, notification_1.notifyOnFailureStep)(failureNotification);
+    (0, steps_1.processImportChunksStep)(batchRequest);
+    const notifications = (0, workflows_sdk_1.transform)({ input }, (data) => {
+        return [
+            {
+                // We don't need the recipient here for now, but if we want to push feed notifications to a specific user we could add it.
+                to: "",
+                channel: "feed",
+                template: "admin-ui",
+                data: {
+                    title: "Product import",
+                    description: `Product import of file ${data.input.filename} completed successfully!`,
+                },
+            },
+        ];
+    });
+    (0, notification_1.sendNotificationsStep)(notifications);
+    return new workflows_sdk_1.WorkflowResponse(batchRequest.summary);
+});
+//# sourceMappingURL=import-products-as-chunks.js.map

package/dist/product/workflows/import-products-as-chunks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-products-as-chunks.js","sourceRoot":"","sources":["../../../src/product/workflows/import-products-as-chunks.ts"],"names":[],"mappings":";;;AACA,oEAKyC;AACzC,qDAA+E;AAC/E,oCAIiB;AAEJ,QAAA,gCAAgC,GAAG,2BAA2B,CAAA;AAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACU,QAAA,8BAA8B,GAAG,IAAA,8BAAc,EAC1D,wCAAgC,EAChC,CACE,KAA0D,EACa,EAAE;IACzE,MAAM,YAAY,GAAG,IAAA,gCAAwB,EAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAE5D,IAAA,yCAAiC,GAAE,CAAA;IAEnC,sGAAsG;IACtG,MAAM,mBAAmB,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACxD,OAAO;YACL;gBACE,0HAA0H;gBAC1H,EAAE,EAAE,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,QAAQ,EAAE,UAAU;gBACpB,IAAI,EAAE;oBACJ,KAAK,EAAE,gBAAgB;oBACvB,WAAW,EAAE,uCAAuC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;iBAC1E;aACF;SACF,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,IAAA,kCAAmB,EAAC,mBAAmB,CAAC,CAAA;IACxC,IAAA,+BAAuB,EAAC,YAAY,CAAC,CAAA;IAErC,MAAM,aAAa,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QAClD,OAAO;YACL;gBACE,0HAA0H;gBAC1H,EAAE,EAAE,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,QAAQ,EAAE,UAAU;gBACpB,IAAI,EAAE;oBACJ,KAAK,EAAE,gBAAgB;oBACvB,WAAW,EAAE,0BAA0B,IAAI,CAAC,KAAK,CAAC,QAAQ,0BAA0B;iBACrF;aACF;SACF,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,IAAA,oCAAqB,EAAC,aAAa,CAAC,CAAA;IACpC,OAAO,IAAI,gCAAgB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;AACnD,CAAC,CACF,CAAA"}

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

@@ -0,0 +1,79 @@
+import type { WorkflowTypes } from "@acmekit/framework/types";
+export declare const importProductsWorkflowId = "import-products";
+/**
+ * This workflow starts a product import from a CSV file in the background. It's used by the
+ * [Import Products Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsimport).
+ *
+ * You can use this workflow within your custom workflows, allowing you to wrap custom logic around product import.
+ * For example, you can import products from another system.
+ *
+ * The workflow only starts the import, but you'll have to confirm it using the [Workflow Engine](https://docs.acmekit.com/resources/infrastructure-modules/workflow-engine).
+ * The below example shows how to confirm the import.
+ *
+ * @example
+ * To start the import of a CSV file:
+ *
+ * ```ts
+ * const { result, transaction: { transactionId } } = await importProductsWorkflow(container)
+ * .run({
+ *   input: {
+ *     // example CSV content
+ *     fileContent: "title,description\nShirt,This is a shirt",
+ *     filename: "products.csv",
+ *   }
+ * })
+ * ```
+ *
+ * Notice that the workflow returns a `transaction.transactionId`. You'll use this ID to confirm the import afterwards.
+ *
+ * You confirm the import using the [Workflow Engine](https://docs.acmekit.com/resources/infrastructure-modules/workflow-engine).
+ * For example, in an API route:
+ *
+ * ```ts workflow={false}
+ * import {
+ *   AuthenticatedAcmeKitRequest,
+ *   AcmeKitResponse,
+ * } from "@acmekit/framework/http"
+ * import {
+ *   importProductsWorkflowId,
+ *   waitConfirmationProductImportStepId,
+ * } from "@acmekit/core-flows"
+ * import type { IWorkflowEngineService } from "@acmekit/framework/types"
+ * import { Modules, TransactionHandlerType } from "@acmekit/framework/utils"
+ * import { StepResponse } from "@acmekit/framework/workflows-sdk"
+ *
+ * export const POST = async (
+ *   req: AuthenticatedAcmeKitRequest,
+ *   res: AcmeKitResponse
+ * ) => {
+ *   const workflowEngineService: IWorkflowEngineService = req.scope.resolve(
+ *     Modules.WORKFLOW_ENGINE
+ *   )
+ *   const transactionId = req.params.transaction_id
+ *
+ *   await workflowEngineService.setStepSuccess({
+ *     idempotencyKey: {
+ *       action: TransactionHandlerType.INVOKE,
+ *       transactionId,
+ *       stepId: waitConfirmationProductImportStepId,
+ *       workflowId: importProductsWorkflowId,
+ *     },
+ *     stepResponse: new StepResponse(true),
+ *   })
+ *
+ *   res.status(202).json({})
+ * }
+ * ```
+ *
+ * :::tip
+ *
+ * This example API route uses the same implementation as the [Confirm Product Import Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsimporttransaction_idconfirm).
+ *
+ * :::
+ *
+ * @summary
+ *
+ * Import products from a CSV file.
+ */
+export declare const importProductsWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<WorkflowTypes.ProductWorkflow.ImportProductsDTO, WorkflowTypes.ProductWorkflow.ImportProductsSummary, []>;
+//# sourceMappingURL=import-products.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"import-products.d.ts","sourceRoot":"","sources":["../../../src/product/workflows/import-products.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAW7D,eAAO,MAAM,wBAAwB,oBAAoB,CAAA;AACzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,eAAO,MAAM,sBAAsB,qKAuDlC,CAAA"}

package/dist/product/workflows/import-products.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.importProductsWorkflow = exports.importProductsWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const notification_1 = require("../../notification");
+const steps_1 = require("../steps");
+const batch_products_1 = require("./batch-products");
+exports.importProductsWorkflowId = "import-products";
+/**
+ * This workflow starts a product import from a CSV file in the background. It's used by the
+ * [Import Products Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsimport).
+ *
+ * You can use this workflow within your custom workflows, allowing you to wrap custom logic around product import.
+ * For example, you can import products from another system.
+ *
+ * The workflow only starts the import, but you'll have to confirm it using the [Workflow Engine](https://docs.acmekit.com/resources/infrastructure-modules/workflow-engine).
+ * The below example shows how to confirm the import.
+ *
+ * @example
+ * To start the import of a CSV file:
+ *
+ * ```ts
+ * const { result, transaction: { transactionId } } = await importProductsWorkflow(container)
+ * .run({
+ *   input: {
+ *     // example CSV content
+ *     fileContent: "title,description\nShirt,This is a shirt",
+ *     filename: "products.csv",
+ *   }
+ * })
+ * ```
+ *
+ * Notice that the workflow returns a `transaction.transactionId`. You'll use this ID to confirm the import afterwards.
+ *
+ * You confirm the import using the [Workflow Engine](https://docs.acmekit.com/resources/infrastructure-modules/workflow-engine).
+ * For example, in an API route:
+ *
+ * ```ts workflow={false}
+ * import {
+ *   AuthenticatedAcmeKitRequest,
+ *   AcmeKitResponse,
+ * } from "@acmekit/framework/http"
+ * import {
+ *   importProductsWorkflowId,
+ *   waitConfirmationProductImportStepId,
+ * } from "@acmekit/core-flows"
+ * import type { IWorkflowEngineService } from "@acmekit/framework/types"
+ * import { Modules, TransactionHandlerType } from "@acmekit/framework/utils"
+ * import { StepResponse } from "@acmekit/framework/workflows-sdk"
+ *
+ * export const POST = async (
+ *   req: AuthenticatedAcmeKitRequest,
+ *   res: AcmeKitResponse
+ * ) => {
+ *   const workflowEngineService: IWorkflowEngineService = req.scope.resolve(
+ *     Modules.WORKFLOW_ENGINE
+ *   )
+ *   const transactionId = req.params.transaction_id
+ *
+ *   await workflowEngineService.setStepSuccess({
+ *     idempotencyKey: {
+ *       action: TransactionHandlerType.INVOKE,
+ *       transactionId,
+ *       stepId: waitConfirmationProductImportStepId,
+ *       workflowId: importProductsWorkflowId,
+ *     },
+ *     stepResponse: new StepResponse(true),
+ *   })
+ *
+ *   res.status(202).json({})
+ * }
+ * ```
+ *
+ * :::tip
+ *
+ * This example API route uses the same implementation as the [Confirm Product Import Admin API Route](https://docs.acmekit.com/api/admin#products_postproductsimporttransaction_idconfirm).
+ *
+ * :::
+ *
+ * @summary
+ *
+ * Import products from a CSV file.
+ */
+exports.importProductsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.importProductsWorkflowId, (input) => {
+    const batchRequest = (0, steps_1.normalizeCsvStep)(input.fileContent);
+    const summary = (0, workflows_sdk_1.transform)({ batchRequest }, (data) => {
+        return {
+            toCreate: data.batchRequest.create.length,
+            toUpdate: data.batchRequest.update.length,
+        };
+    });
+    (0, steps_1.waitConfirmationProductImportStep)();
+    // Q: Can we somehow access the error from the step that threw here? Or in a compensate step at least?
+    const failureNotification = (0, workflows_sdk_1.transform)({ input }, (data) => {
+        return [
+            {
+                // We don't need the recipient here for now, but if we want to push feed notifications to a specific user we could add it.
+                to: "",
+                channel: "feed",
+                template: "admin-ui",
+                data: {
+                    title: "Product import",
+                    description: `Failed to import products from file ${data.input.filename}`,
+                },
+            },
+        ];
+    });
+    (0, notification_1.notifyOnFailureStep)(failureNotification);
+    batch_products_1.batchProductsWorkflow
+        .runAsStep({ input: batchRequest })
+        .config({ async: true, backgroundExecution: true });
+    const notifications = (0, workflows_sdk_1.transform)({ input }, (data) => {
+        return [
+            {
+                // We don't need the recipient here for now, but if we want to push feed notifications to a specific user we could add it.
+                to: "",
+                channel: "feed",
+                template: "admin-ui",
+                data: {
+                    title: "Product import",
+                    description: `Product import of file ${data.input.filename} completed successfully!`,
+                },
+            },
+        ];
+    });
+    (0, notification_1.sendNotificationsStep)(notifications);
+    return new workflows_sdk_1.WorkflowResponse(summary);
+});
+//# sourceMappingURL=import-products.js.map

package/dist/product/workflows/import-products.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-products.js","sourceRoot":"","sources":["../../../src/product/workflows/import-products.ts"],"names":[],"mappings":";;;AACA,oEAKyC;AACzC,qDAA+E;AAC/E,oCAA8E;AAC9E,qDAAwD;AAE3C,QAAA,wBAAwB,GAAG,iBAAiB,CAAA;AACzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACU,QAAA,sBAAsB,GAAG,IAAA,8BAAc,EAClD,gCAAwB,EACxB,CACE,KAAoE,EACG,EAAE;IACzE,MAAM,YAAY,GAAG,IAAA,wBAAgB,EAAC,KAAK,CAAC,WAAW,CAAC,CAAA;IAExD,MAAM,OAAO,GAAG,IAAA,yBAAS,EAAC,EAAE,YAAY,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACnD,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM;YACzC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM;SAC1C,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,IAAA,yCAAiC,GAAE,CAAA;IAEnC,sGAAsG;IACtG,MAAM,mBAAmB,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACxD,OAAO;YACL;gBACE,0HAA0H;gBAC1H,EAAE,EAAE,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,QAAQ,EAAE,UAAU;gBACpB,IAAI,EAAE;oBACJ,KAAK,EAAE,gBAAgB;oBACvB,WAAW,EAAE,uCAAuC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;iBAC1E;aACF;SACF,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,IAAA,kCAAmB,EAAC,mBAAmB,CAAC,CAAA;IAExC,sCAAqB;SAClB,SAAS,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;SAClC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAC,CAAA;IAErD,MAAM,aAAa,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QAClD,OAAO;YACL;gBACE,0HAA0H;gBAC1H,EAAE,EAAE,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,QAAQ,EAAE,UAAU;gBACpB,IAAI,EAAE;oBACJ,KAAK,EAAE,gBAAgB;oBACvB,WAAW,EAAE,0BAA0B,IAAI,CAAC,KAAK,CAAC,QAAQ,0BAA0B;iBACrF;aACF;SACF,CAAA;IACH,CAAC,CAAC,CAAA;IACF,IAAA,oCAAqB,EAAC,aAAa,CAAC,CAAA;IACpC,OAAO,IAAI,gCAAgB,CAAC,OAAO,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}

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

@@ -0,0 +1,29 @@
+export * from "./batch-image-variants";
+export * from "./batch-variant-images";
+export * from "./batch-link-products-collection";
+export * from "./batch-product-variants";
+export * from "./batch-products";
+export * from "./batch-products-in-category";
+export * from "./create-collections";
+export * from "./create-product-options";
+export * from "./create-product-types";
+export * from "./create-product-tags";
+export * from "./create-product-variants";
+export * from "./create-products";
+export * from "./delete-collections";
+export * from "./delete-product-options";
+export * from "./delete-product-types";
+export * from "./delete-product-tags";
+export * from "./delete-product-variants";
+export * from "./delete-products";
+export * from "./update-collections";
+export * from "./update-product-options";
+export * from "./update-product-types";
+export * from "./update-product-tags";
+export * from "./update-product-variants";
+export * from "./update-products";
+export * from "./export-products";
+export * from "./import-products";
+export * from "./import-products-as-chunks";
+export * from "./upsert-variant-prices";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/product/workflows/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,0BAA0B,CAAA;AACxC,cAAc,kBAAkB,CAAA;AAChC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,wBAAwB,CAAA;AACtC,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,wBAAwB,CAAA;AACtC,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,wBAAwB,CAAA;AACtC,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,yBAAyB,CAAA"}

package/dist/product/workflows/index.js

@@ -0,0 +1,45 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./batch-image-variants"), exports);
+__exportStar(require("./batch-variant-images"), exports);
+__exportStar(require("./batch-link-products-collection"), exports);
+__exportStar(require("./batch-product-variants"), exports);
+__exportStar(require("./batch-products"), exports);
+__exportStar(require("./batch-products-in-category"), exports);
+__exportStar(require("./create-collections"), exports);
+__exportStar(require("./create-product-options"), exports);
+__exportStar(require("./create-product-types"), exports);
+__exportStar(require("./create-product-tags"), exports);
+__exportStar(require("./create-product-variants"), exports);
+__exportStar(require("./create-products"), exports);
+__exportStar(require("./delete-collections"), exports);
+__exportStar(require("./delete-product-options"), exports);
+__exportStar(require("./delete-product-types"), exports);
+__exportStar(require("./delete-product-tags"), exports);
+__exportStar(require("./delete-product-variants"), exports);
+__exportStar(require("./delete-products"), exports);
+__exportStar(require("./update-collections"), exports);
+__exportStar(require("./update-product-options"), exports);
+__exportStar(require("./update-product-types"), exports);
+__exportStar(require("./update-product-tags"), exports);
+__exportStar(require("./update-product-variants"), exports);
+__exportStar(require("./update-products"), exports);
+__exportStar(require("./export-products"), exports);
+__exportStar(require("./import-products"), exports);
+__exportStar(require("./import-products-as-chunks"), exports);
+__exportStar(require("./upsert-variant-prices"), exports);
+//# sourceMappingURL=index.js.map

package/dist/product/workflows/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/product/workflows/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,yDAAsC;AACtC,mEAAgD;AAChD,2DAAwC;AACxC,mDAAgC;AAChC,+DAA4C;AAC5C,uDAAoC;AACpC,2DAAwC;AACxC,yDAAsC;AACtC,wDAAqC;AACrC,4DAAyC;AACzC,oDAAiC;AACjC,uDAAoC;AACpC,2DAAwC;AACxC,yDAAsC;AACtC,wDAAqC;AACrC,4DAAyC;AACzC,oDAAiC;AACjC,uDAAoC;AACpC,2DAAwC;AACxC,yDAAsC;AACtC,wDAAqC;AACrC,4DAAyC;AACzC,oDAAiC;AACjC,oDAAiC;AACjC,oDAAiC;AACjC,8DAA2C;AAC3C,0DAAuC"}