chore(workflows, core-flows): Split workflows tooling and definitions (…

…#5705)

.changeset/fresh-birds-serve.md

@@ -0,0 +1,8 @@
+---
+"@medusajs/core-flows": patch
+"@medusajs/orchestration": patch
+"@medusajs/medusa": patch
+"@medusajs/workflows-sdk": patch
+---
+
+chore(workflows, core-flows, ...): Split workflows tooling and definitions

.eslintignore

@@ -22,7 +22,8 @@ packages/*
 !packages/create-medusa-app
 !packages/product
 !packages/orchestration
-!packages/workflows
+!packages/workflows-sdk
+!packages/core-flows
 
 
 **/models/*

.eslintrc.js

@@ -97,7 +97,8 @@ module.exports = {
           "./packages/create-medusa-app/tsconfig.json",
           "./packages/product/tsconfig.json",
           "./packages/orchestration/tsconfig.json",
-          "./packages/workflows/tsconfig.spec.json",
+          "./packages/workflows-sdk/tsconfig.spec.json",
+          "./packages/core-flows/tsconfig.spec.json",
         ],
       },
       rules: {

integration-tests/plugins/__tests__/workflows/inventory/create-inventory-items.ts

@@ -3,8 +3,9 @@ import { IInventoryService, WorkflowTypes } from "@medusajs/types"
 import {
   CreateInventoryItemActions,
   createInventoryItems,
-  pipe,
-} from "@medusajs/workflows"
+} from "@medusajs/core-flows"
+
+import { pipe } from "@medusajs/workflows-sdk"
 import path from "path"
 import { startBootstrapApp } from "../../../../environment-helpers/bootstrap-app"
 import { getContainer } from "../../../../environment-helpers/use-container"

integration-tests/plugins/__tests__/workflows/product/create-product.ts

@@ -1,15 +1,15 @@
 import { ModuleRegistrationName } from "@medusajs/modules-sdk"
 import { IProductModuleService, WorkflowTypes } from "@medusajs/types"
 import {
+  createProducts,
   CreateProductsActions,
   Handlers,
-  createProducts,
-  pipe,
-} from "@medusajs/workflows"
+} from "@medusajs/core-flows"
 import path from "path"
 import { startBootstrapApp } from "../../../../environment-helpers/bootstrap-app"
 import { getContainer } from "../../../../environment-helpers/use-container"
 import { initDb, useDb } from "../../../../environment-helpers/use-db"
+import { pipe } from "@medusajs/workflows-sdk"
 
 jest.setTimeout(30000)
 

integration-tests/plugins/__tests__/workflows/product/update-product.ts

@@ -1,10 +1,10 @@
 import { WorkflowTypes } from "@medusajs/types"
 import {
   Handlers,
-  pipe,
   updateProducts,
   UpdateProductsActions,
-} from "@medusajs/workflows"
+} from "@medusajs/core-flows"
+import { pipe } from "@medusajs/workflows-sdk"
 import path from "path"
 
 import { startBootstrapApp } from "../../../../environment-helpers/bootstrap-app"

integration-tests/plugins/__tests__/workflows/utils/composer/compose.ts

@@ -6,7 +6,7 @@ import {
   parallelize,
   StepResponse,
   transform,
-} from "@medusajs/workflows"
+} from "@medusajs/workflows-sdk"
 
 jest.setTimeout(30000)
 

integration-tests/plugins/medusa-config.js

@@ -1,5 +1,5 @@
 const { Modules } = require("@medusajs/modules-sdk")
-const { Workflows } = require("@medusajs/workflows")
+const { Workflows } = require("@medusajs/core-flows")
 const DB_HOST = process.env.DB_HOST
 const DB_USERNAME = process.env.DB_USERNAME
 const DB_PASSWORD = process.env.DB_PASSWORD

packages/core-flows/CHANGELOG.md

@@ -0,0 +1 @@
+# @medusajs/core-flows

packages/core-flows/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@medusajs/core-flows",
+  "version": "0.0.1",
+  "description": "Set of workflow definitions for Medusa",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medusajs/medusa",
+    "directory": "packages/core-flows"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "Medusa",
+  "license": "MIT",
+  "devDependencies": {
+    "@medusajs/types": "^1.11.7",
+    "cross-env": "^5.2.1",
+    "jest": "^29.6.3",
+    "rimraf": "^5.0.1",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "@medusajs/modules-sdk": "^1.12.3",
+    "@medusajs/orchestration": "^0.4.4",
+    "@medusajs/utils": "^1.11.0",
+    "@medusajs/workflows-sdk": "^0.1.0",
+    "awilix": "^8.0.1",
+    "ulid": "^2.3.0"
+  },
+  "scripts": {
+    "prepublishOnly": "cross-env NODE_ENV=production tsc --build",
+    "build": "rimraf dist && tsc --build",
+    "watch": "tsc --build --watch",
+    "test": "jest --runInBand --bail --forceExit --passWithNoTests"
+  }
+}

packages/workflows/src/definition/cart/create-cart.ts → packages/core-flows/src/definition/cart/create-cart.ts

@@ -13,7 +13,7 @@ import {
   RegionHandlers,
   SalesChannelHandlers,
 } from "../../handlers"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 
 enum CreateCartActions {
   setContext = "setContext",

packages/workflows/src/definition/index.ts → packages/core-flows/src/definition/index.ts

@@ -1,4 +1,4 @@
 export * from "./cart"
 export * from "./product"
 export * from "./inventory"
-export * from './price-list'
+export * from "./price-list"

packages/workflows/src/definition/inventory/create-inventory-item.ts → packages/core-flows/src/definition/inventory/create-inventory-item.ts

@@ -3,7 +3,7 @@ import {
   TransactionStepsDefinition,
   WorkflowManager,
 } from "@medusajs/orchestration"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 
 import { InventoryTypes, WorkflowTypes } from "@medusajs/types"
 import { InventoryHandlers } from "../../handlers"

packages/workflows/src/definition/price-list/create-price-lists.ts → packages/core-flows/src/definition/price-list/create-price-lists.ts

@@ -3,7 +3,7 @@ import {
   WorkflowManager,
 } from "@medusajs/orchestration"
 import { PricingTypes, WorkflowTypes } from "@medusajs/types"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 
 import { Workflows } from "../../definitions"
 import { PriceListHandlers } from "../../handlers"

packages/workflows/src/definition/price-list/index.ts → packages/core-flows/src/definition/price-list/index.ts

@@ -1,5 +1,6 @@
 export * from "./create-price-lists"
 export * from "./remove-price-lists"
+export * from "./remove-price-list-prices"
 export * from "./remove-product-prices"
 export * from "./remove-variant-prices"
 export * from "./update-price-lists"

packages/workflows/src/definition/price-list/remove-price-list-prices.ts → packages/core-flows/src/definition/price-list/remove-price-list-prices.ts

@@ -3,7 +3,7 @@ import {
   WorkflowManager,
 } from "@medusajs/orchestration"
 import { WorkflowTypes } from "@medusajs/types"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 
 import { Workflows } from "../../definitions"
 import { PriceListHandlers } from "../../handlers"
@@ -62,7 +62,7 @@ WorkflowManager.register(
   handlers
 )
 
-export const removePriceListProductPrices = exportWorkflow<
+export const removePriceListPrices = exportWorkflow<
   WorkflowTypes.PriceListWorkflow.RemovePriceListPricesWorkflowInputDTO,
   string[]
 >(

packages/workflows/src/definition/price-list/remove-price-lists.ts → packages/core-flows/src/definition/price-list/remove-price-lists.ts

@@ -3,7 +3,7 @@ import {
   TransactionStepsDefinition,
   WorkflowManager,
 } from "@medusajs/orchestration"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 
 import { PriceListHandlers } from "../../handlers"
 import { Workflows } from "../../definitions"

packages/workflows/src/definition/price-list/remove-product-prices.ts → packages/core-flows/src/definition/price-list/remove-product-prices.ts

@@ -3,7 +3,7 @@ import {
   WorkflowManager,
 } from "@medusajs/orchestration"
 import { WorkflowTypes } from "@medusajs/types"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 
 import { Workflows } from "../../definitions"
 import { PriceListHandlers } from "../../handlers"

packages/workflows/src/definition/price-list/remove-variant-prices.ts → packages/core-flows/src/definition/price-list/remove-variant-prices.ts

@@ -3,7 +3,7 @@ import {
   WorkflowManager,
 } from "@medusajs/orchestration"
 import { WorkflowTypes } from "@medusajs/types"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 
 import { Workflows } from "../../definitions"
 import { PriceListHandlers } from "../../handlers"

packages/workflows/src/definition/price-list/update-price-lists.ts → packages/core-flows/src/definition/price-list/update-price-lists.ts

@@ -3,7 +3,7 @@ import {
   WorkflowManager,
 } from "@medusajs/orchestration"
 import { WorkflowTypes } from "@medusajs/types"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 
 import { Workflows } from "../../definitions"
 import { PriceListHandlers } from "../../handlers"

packages/workflows/src/definition/product/create-product-variants.ts → packages/core-flows/src/definition/product/create-product-variants.ts

@@ -3,7 +3,7 @@ import {
   WorkflowManager,
 } from "@medusajs/orchestration"
 import { InputAlias, Workflows } from "../../definitions"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 
 import { ProductTypes, WorkflowTypes } from "@medusajs/types"
 import { ProductHandlers } from "../../handlers"

packages/workflows/src/definition/product/create-products.ts → packages/core-flows/src/definition/product/create-products.ts

@@ -3,7 +3,7 @@ import {
   TransactionStepsDefinition,
   WorkflowManager,
 } from "@medusajs/orchestration"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 
 import { ProductTypes, WorkflowTypes } from "@medusajs/types"
 import {

packages/workflows/src/definition/product/prepare-create-inventory-items.ts → packages/core-flows/src/definition/product/prepare-create-inventory-items.ts

@@ -1,5 +1,5 @@
 import { ProductTypes } from "@medusajs/types"
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 
 type AssociationTaggedVariant = ProductTypes.ProductVariantDTO & {
   _associationTag?: string

packages/workflows/src/definition/product/update-product-variants.ts → packages/core-flows/src/definition/product/update-product-variants.ts

@@ -3,7 +3,7 @@ import {
   WorkflowManager,
 } from "@medusajs/orchestration"
 import { InputAlias, Workflows } from "../../definitions"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 
 import { ProductTypes, WorkflowTypes } from "@medusajs/types"
 import { ProductHandlers } from "../../handlers"

packages/workflows/src/definition/product/update-products.ts → packages/core-flows/src/definition/product/update-products.ts

@@ -8,7 +8,7 @@ import { InputAlias, Workflows } from "../../definitions"
 import { InventoryHandlers, ProductHandlers } from "../../handlers"
 import * as MiddlewareHandlers from "../../handlers/middlewares"
 import { detachSalesChannelFromProducts } from "../../handlers/product"
-import { exportWorkflow, pipe } from "../../helper"
+import { exportWorkflow, pipe } from "@medusajs/workflows-sdk"
 import { CreateProductsActions } from "./create-products"
 import { prepareCreateInventoryItems } from "./prepare-create-inventory-items"
 import { UpdateProductVariantsActions } from "./update-product-variants"
@@ -137,7 +137,7 @@ const handlers = new Map<string, any>([
             },
           ],
         },
-        MiddlewareHandlers.mapData((d) => ({
+        MiddlewareHandlers.mapData((d: any) => ({
           productsHandleSalesChannelsMap:
             d.preparedData.productHandleAddedChannelsMap,
         })),
@@ -157,7 +157,7 @@ const handlers = new Map<string, any>([
             },
           ],
         },
-        MiddlewareHandlers.mapData((d) => ({
+        MiddlewareHandlers.mapData((d: any) => ({
           productsHandleSalesChannelsMap:
             d.preparedData.productHandleAddedChannelsMap,
         })),
@@ -183,7 +183,7 @@ const handlers = new Map<string, any>([
             },
           ],
         },
-        MiddlewareHandlers.mapData((d) => ({
+        MiddlewareHandlers.mapData((d: any) => ({
           productsHandleSalesChannelsMap:
             d.preparedData.productHandleRemovedChannelsMap,
         })),
@@ -204,7 +204,7 @@ const handlers = new Map<string, any>([
             },
           ],
         },
-        MiddlewareHandlers.mapData((d) => ({
+        MiddlewareHandlers.mapData((d: any) => ({
           productsHandleSalesChannelsMap:
             d.preparedData.productHandleRemovedChannelsMap,
         })),

packages/workflows/src/handlers/address/find-or-create-addresses.ts → packages/core-flows/src/handlers/address/find-or-create-addresses.ts

@@ -1,7 +1,7 @@
 import { AddressDTO } from "@medusajs/types"
 import { MedusaError } from "@medusajs/utils"
 
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 
 type AddressesDTO = {
   shipping_address_id?: string

packages/workflows/src/handlers/cart/attach-line-items-to-cart.ts → packages/core-flows/src/handlers/cart/attach-line-items-to-cart.ts

@@ -1,7 +1,7 @@
 import { CartWorkflow } from "@medusajs/types"
 import { SalesChannelFeatureFlag } from "@medusajs/utils"
 
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 
 type HandlerInputData = {
   line_items: {

packages/workflows/src/handlers/cart/create-cart.ts → packages/core-flows/src/handlers/cart/create-cart.ts

@@ -1,5 +1,5 @@
 import { CartDTO } from "@medusajs/types"
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 
 enum Aliases {
   SalesChannel = "SalesChannel",

packages/workflows/src/handlers/cart/remove-cart.ts → packages/core-flows/src/handlers/cart/remove-cart.ts

@@ -1,4 +1,4 @@
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 
 enum Aliases {
   Cart = "cart",

packages/workflows/src/handlers/cart/retrieve-cart.ts → packages/core-flows/src/handlers/cart/retrieve-cart.ts

@@ -1,5 +1,5 @@
 import { CartDTO } from "@medusajs/types"
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 
 type HandlerInputData = {
   cart: {

packages/workflows/src/handlers/common/set-context.ts → packages/core-flows/src/handlers/common/set-context.ts

@@ -1,4 +1,4 @@
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 
 type ContextDTO = {
   context?: Record<any, any>

packages/workflows/src/handlers/customer/find-or-create-customer.ts → packages/core-flows/src/handlers/customer/find-or-create-customer.ts

@@ -1,6 +1,6 @@
 import { validateEmail } from "@medusajs/utils"
 
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 
 type CustomerDTO = {
   customer_id?: string

packages/workflows/src/handlers/inventory/attach-inventory-items.ts → packages/core-flows/src/handlers/inventory/attach-inventory-items.ts

@@ -1,5 +1,5 @@
 import { InventoryItemDTO } from "@medusajs/types"
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 
 export async function attachInventoryItems({
   container,

packages/workflows/src/handlers/inventory/create-inventory-items.ts → packages/core-flows/src/handlers/inventory/create-inventory-items.ts

@@ -1,5 +1,5 @@
 import { IInventoryService, InventoryItemDTO } from "@medusajs/types"
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 import { promiseAll } from "@medusajs/utils"
 
 type Result = {

packages/workflows/src/handlers/inventory/detach-inventory-items.ts → packages/core-flows/src/handlers/inventory/detach-inventory-items.ts

@@ -1,5 +1,5 @@
 import { InventoryItemDTO } from "@medusajs/types"
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 import { promiseAll } from "@medusajs/utils"
 
 export async function detachInventoryItems({

packages/workflows/src/handlers/inventory/remove-inventory-items.ts → packages/core-flows/src/handlers/inventory/remove-inventory-items.ts

@@ -1,5 +1,5 @@
 import { InventoryItemDTO } from "@medusajs/types"
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 
 export async function removeInventoryItems({
   container,

packages/workflows/src/handlers/inventory/restore-inventory-items.ts → packages/core-flows/src/handlers/inventory/restore-inventory-items.ts

@@ -3,7 +3,7 @@ import {
   InventoryItemDTO,
   SharedContext,
 } from "@medusajs/types"
-import { WorkflowArguments } from "../../helper"
+import { WorkflowArguments } from "@medusajs/workflows-sdk"
 
 export async function restoreInventoryItems({
   container,