asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: added workflow hooks docs + changed workflow response (#8364)

Browse Source 
* docs: added workflow hooks docs + changed workflow response

* Update page.mdx
This commit is contained in:
Shahed Nasser
2024-07-31 17:01:33 +03:00
committed by GitHub
parent 27837b8833
commit 6f973d9f2b
29 changed files with 321 additions and 167 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/recipes/commerce-automation/page.mdx
+2 -4
View File
@@ -485,7 +485,7 @@ export const syncProductsWorkflowHighlight = [
import {
StepResponse,
createStep,
createWorkflow
createWorkflow,
} from "@medusajs/workflows-sdk"
type RetrieveStoreStepInput = {
@@ -597,9 +597,7 @@ export const syncProductsWorkflowHighlight = [
store_id: string
}
export const syncProductsWorkflow = createWorkflow<
SyncProductsWorkflowInput, {}
>(
export const syncProductsWorkflow = createWorkflow(
"sync-products-workflow",
function ({ store_id }: SyncProductsWorkflowInput) {
const { store } = retrieveStoreStep({
www/apps/resources/app/recipes/integrate-ecommerce-stack/page.mdx
+15 -14
View File
@@ -163,24 +163,25 @@ Workflows guarantee data consistency through their compensation feature. You can
For example, create the following workflow in `src/workflows/create-product.ts`:
export const workflowHighlights = [
["18", "createInErpStep", "A step that creates a product in the ERP system."],
["21", "erpModuleService", "Resolve the ERP Module's main service."],
["24", "productModuleService", "Resolve the Product Module's main service."],
["28", "retrieve", "Retrieve the created product's data."],
["30", "createProduct", "Create the product in the ERP system."],
["34", "update", "Update the product in Medusa with the ID of the ERP product."],
["43", "erpId", "Pass the ERP product's ID to the compensation function."],
["44", "productId", "Pass the product's ID to the compensation function."],
["46", "", "Define a compensation function that rolls back changes when an error occurs."],
["53", "deleteProduct", "Undo creating the product in the ERP system by deleting it."],
["54", "update", "Update the product in Medusa to remove the ERP product's ID."]
["19", "createInErpStep", "A step that creates a product in the ERP system."],
["22", "erpModuleService", "Resolve the ERP Module's main service."],
["25", "productModuleService", "Resolve the Product Module's main service."],
["29", "retrieve", "Retrieve the created product's data."],
["31", "createProduct", "Create the product in the ERP system."],
["35", "update", "Update the product in Medusa with the ID of the ERP product."],
["44", "erpId", "Pass the ERP product's ID to the compensation function."],
["45", "productId", "Pass the product's ID to the compensation function."],
["47", "", "Define a compensation function that rolls back changes when an error occurs."],
["54", "deleteProduct", "Undo creating the product in the ERP system by deleting it."],
["55", "update", "Update the product in Medusa to remove the ERP product's ID."]
]
```ts title="src/workflows/create-product.ts" highlights={workflowHighlights} collapsibleLines="1-9" expandButtonLabel="Show Imports"
```ts title="src/workflows/create-product.ts" highlights={workflowHighlights} collapsibleLines="1-10" expandButtonLabel="Show Imports"
import {
createStep,
StepResponse,
createWorkflow
createWorkflow,
WorkflowResponse,
} from "@medusajs/workflows-sdk"
import { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
@@ -240,7 +241,7 @@ export const workflowHighlights = [
>("create-product-in-systems", function (input) {
const erpData = createInErpStep(input)
return erpData
return new WorkflowResponse(erpData)
})
export default createProductWorkflow
www/apps/resources/app/recipes/marketplace/examples/vendors/page.mdx
Vendored
+32 -26
View File
@@ -292,12 +292,15 @@ In the compensation function, which runs if an error occurs in the workflow, it
Then, create the workflow at `src/workflows/marketplace/create-vendor-admin/index.ts` with the following content:
export const vendorAdminWorkflowHighlights = [
["20", "createVendorAdminStep", "Create the vendor admin."],
["24", "setAuthAppMetadataStep", "Step is imported from `@medusajs/core-flows`."]
["23", "createVendorAdminStep", "Create the vendor admin."],
["27", "setAuthAppMetadataStep", "Step is imported from `@medusajs/core-flows`."]
]
```ts title="src/workflows/marketplace/create-vendor-admin/index.ts" highlights={vendorAdminWorkflowHighlights}
import { createWorkflow } from "@medusajs/workflows-sdk"
import {
createWorkflow,
WorkflowResponse,
} from "@medusajs/workflows-sdk"
import {
setAuthAppMetadataStep,
} from "@medusajs/core-flows"
@@ -326,7 +329,7 @@ const createVendorAdminWorkflow = createWorkflow(
value: vendorAdmin.id,
})
return vendorAdmin
return new WorkflowResponse(vendorAdmin)
}
)
@@ -457,7 +460,7 @@ Next, create the file `src/api/middlewares.ts` with the following content:
```ts title="src/api/middlewares.ts"
import {
defineMiddlewares,
authenticate
authenticate,
} from "@medusajs/medusa"
export default defineMiddlewares({
@@ -709,13 +712,13 @@ Finally, in `src/api/middlewares.ts`, apply a middleware on the create products
```ts title="src/api/middlewares.ts"
import {
defineMiddlewares,
authenticate
authenticate,
} from "@medusajs/medusa"
import {
validateAndTransformBody
validateAndTransformBody,
} from "@medusajs/medusa/dist/api/utils/validate-body"
import {
AdminCreateProduct
AdminCreateProduct,
} from "@medusajs/medusa/dist/api/admin/products/validators"
export default defineMiddlewares({
@@ -1002,7 +1005,7 @@ try {
const items = vendorsItems[vendorId]
const vendor = vendors.find((v) => v.id === vendorId)!
const {result: childOrder} = await createOrdersWorkflow(
const { result: childOrder } = await createOrdersWorkflow(
container
)
.run({
@@ -1123,19 +1126,22 @@ The compensation function cancels all child orders received from the step. It us
Finally, create the workflow at the file `src/workflows/marketplace/create-vendor-orders/index.ts`:
export const createVendorOrdersWorkflowHighlights = [
["18", "useRemoteQueryStep", "Retrieve the cart's details."],
["26", "completeCartWorkflow", "Create the parent order from the cart."],
["32", "groupVendorItemsStep", "Group the items by their vendor."],
["39", "createVendorOrdersStep", "Create child orders for each vendor"],
["44", "createRemoteLinkStep", "Create the links returned by the previous step."]
["21", "useRemoteQueryStep", "Retrieve the cart's details."],
["29", "completeCartWorkflow", "Create the parent order from the cart."],
["35", "groupVendorItemsStep", "Group the items by their vendor."],
["42", "createVendorOrdersStep", "Create child orders for each vendor"],
["47", "createRemoteLinkStep", "Create the links returned by the previous step."]
]
```ts title="src/workflows/marketplace/create-vendor-orders/index.ts" collapsibleLines="1-10" expandMoreLabel="Show Imports"
import { createWorkflow } from "@medusajs/workflows-sdk"
```ts title="src/workflows/marketplace/create-vendor-orders/index.ts" collapsibleLines="1-13" expandMoreLabel="Show Imports"
import {
createWorkflow,
WorkflowResponse,
} from "@medusajs/workflows-sdk"
import {
useRemoteQueryStep,
createRemoteLinkStep,
completeCartWorkflow
completeCartWorkflow,
} from "@medusajs/core-flows"
import { CartDTO } from "@medusajs/types"
import groupVendorItemsStep from "./steps/group-vendor-items"
@@ -1150,7 +1156,7 @@ const createVendorOrdersWorkflow = createWorkflow(
(input: WorkflowInput) => {
const cart = useRemoteQueryStep({
entry_point: "cart",
fields: ['items.*'],
fields: ["items.*"],
variables: { id: input.cart_id },
list: false,
throw_if_key_not_found: true,
@@ -1158,28 +1164,28 @@ const createVendorOrdersWorkflow = createWorkflow(
const order = completeCartWorkflow.runAsStep({
input: {
id: cart.id
}
id: cart.id,
},
})
const { vendorsItems } = groupVendorItemsStep({
cart
cart,
})
const {
orders: vendorOrders,
linkDefs
linkDefs,
} = createVendorOrdersStep({
parentOrder: order,
vendorsItems
vendorsItems,
})
createRemoteLinkStep(linkDefs)
return {
return new WorkflowResponse({
parent_order: order,
vendor_orders: vendorOrders
}
vendor_orders: vendorOrders,
})
}
)