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

docs: add note to tutorials related to types (#13720)

Browse Source
This commit is contained in:
Shahed Nasser
2025-10-09 14:52:23 +03:00
committed by GitHub
parent 85f543e01d
commit 2cfd0dfc6e
13 changed files with 99 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
www/apps/resources/app/how-to-tutorials/tutorials/agentic-commerce/page.mdx
View File

@@ -340,12 +340,6 @@ You also pass an `options` property with module options, including the signature
Your module is now ready for use. You'll build workflows around it in the following steps.
<Note title="Tip">
To avoid type errors when using the module's service in the next step, start the Medusa application once with the `npm run dev` or `yarn dev` command. This generates the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
---
## Step 3: Send Product Feed
@@ -703,6 +697,12 @@ The final step is `sendProductFeedStep`, which sends product feed XML to AI agen
Create the file `src/workflows/steps/send-product-feed.ts` with the following content:
<Note>
If you get a type error on resolving the Agentic Commerce Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
```ts title="src/workflows/steps/send-product-feed.ts"
import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"
import { AGENTIC_COMMERCE_MODULE } from "../../modules/agentic-commerce"

6
www/apps/resources/app/how-to-tutorials/tutorials/invoice-generator/page.mdx
View File

@@ -435,6 +435,12 @@ The workflow that manages invoice configurations will have a single step that up
To create a step, create the file `src/workflows/steps/update-invoice-config.ts` with the following content:
<Note>
If you get a type error on resolving the Invoice Generator Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
export const updateInvoiceConfigHighlights = [
["19", "prevData", "Retrieve the invoice configurations before the update."],
["23", "updatedData", "Update the invoice configurations with the new data."],

6
www/apps/resources/app/how-to-tutorials/tutorials/loyalty-points/page.mdx
View File

@@ -621,6 +621,12 @@ To return data from a step, you return an instance of `StepResponse` from the Wo
If the order's cart has a loyalty promotion, you need to deduct points from the customer's loyalty points. To do this, create the file `src/workflows/steps/deduct-purchase-points.ts` with the following content:
<Note>
If you get a type error on resolving the Loyalty Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
export const deductStepHighlights = [
["18", "loyaltyModuleService", "Resolve the Loyalty Module's service."],
["22", "calculatePointsFromAmount", "Calculate the points to deduct from the promotion's amount."],

31
www/apps/resources/app/how-to-tutorials/tutorials/preorder/page.mdx
View File

@@ -531,6 +531,12 @@ The `updatePreorderVariantStep` updates an existing pre-order variant.
To create the step, create the file `src/workflows/steps/update-preorder-variant.ts` with the following content:
<Note>
If you get a type error on resolving the Preorder Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
export const updatePreorderVariantStepHighlights = [
["16", "preorderModuleService", "Resolve the Preorder Module's service from the Medusa container."],
["20", "oldData", "Retrieve existing record to undo updates if an error occurs."],
@@ -542,6 +548,7 @@ export const updatePreorderVariantStepHighlights = [
```ts title="src/workflows/steps/update-preorder-variant.ts" highlights={updatePreorderVariantStepHighlights}
import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"
import { PREORDER_MODULE } from "../../modules/preorder"
import {
PreorderVariantStatus,
} from "../../modules/preorder/models/preorder-variant"
@@ -557,7 +564,7 @@ export const updatePreorderVariantStep = createStep(
"update-preorder-variant",
async (input: StepInput, { container }) => {
const preorderModuleService = container.resolve(
"preorder"
PREORDER_MODULE
)
const oldData = await preorderModuleService.retrievePreorderVariant(
@@ -576,7 +583,7 @@ export const updatePreorderVariantStep = createStep(
}
const preorderModuleService = container.resolve(
"preorder"
PREORDER_MODULE
)
await preorderModuleService.updatePreorderVariants({
@@ -624,6 +631,7 @@ export const createPreorderVariantStepHighlights = [
```ts title="src/workflows/steps/create-preorder-variant.ts" highlights={createPreorderVariantStepHighlights}
import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"
import { PREORDER_MODULE } from "../../modules/preorder"
type StepInput = {
variant_id: string
@@ -634,7 +642,7 @@ export const createPreorderVariantStep = createStep(
"create-preorder-variant",
async (input: StepInput, { container }) => {
const preorderModuleService = container.resolve(
"preorder"
PREORDER_MODULE
)
const preorderVariant = await preorderModuleService.createPreorderVariants(
@@ -649,7 +657,7 @@ export const createPreorderVariantStep = createStep(
}
const preorderModuleService = container.resolve(
"preorder"
PREORDER_MODULE
)
await preorderModuleService.deletePreorderVariants(preorderVariantId)
@@ -946,6 +954,7 @@ export const disablePreorderVariantStepHighlights = [
```ts title="src/workflows/steps/disable-preorder-variant.ts" highlights={disablePreorderVariantStepHighlights}
import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"
import { PREORDER_MODULE } from "../../modules/preorder"
import {
PreorderVariantStatus,
} from "../../modules/preorder/models/preorder-variant"
@@ -957,7 +966,7 @@ type StepInput = {
export const disablePreorderVariantStep = createStep(
"disable-preorder-variant",
async ({ id }: StepInput, { container }) => {
const preorderModuleService = container.resolve("preorder")
const preorderModuleService = container.resolve(PREORDER_MODULE)
const oldData = await preorderModuleService.retrievePreorderVariant(id)
@@ -973,7 +982,7 @@ export const disablePreorderVariantStep = createStep(
return
}
const preorderModuleService = container.resolve("preorder")
const preorderModuleService = container.resolve(PREORDER_MODULE)
await preorderModuleService.updatePreorderVariants({
id: preorderVariant.id,
@@ -1665,6 +1674,7 @@ export const createPreordersStepHighlights = [
```ts title="src/workflows/steps/create-preorders.ts" highlights={createPreordersStepHighlights}
import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"
import { PREORDER_MODULE } from "../../modules/preorder"
type StepInput = {
preorder_variant_ids: string[]
@@ -1677,7 +1687,7 @@ export const createPreordersStep = createStep(
preorder_variant_ids,
order_id,
}: StepInput, { container }) => {
const preorderModuleService = container.resolve("preorder")
const preorderModuleService = container.resolve(PREORDER_MODULE)
const preorders = await preorderModuleService.createPreorders(
preorder_variant_ids.map((id) => ({
@@ -1693,7 +1703,7 @@ export const createPreordersStep = createStep(
return
}
const preorderModuleService = container.resolve("preorder")
const preorderModuleService = container.resolve(PREORDER_MODULE)
await preorderModuleService.deletePreorders(preorderIds)
}
@@ -2700,6 +2710,7 @@ export const updatePreordersHighlights = [
```ts title="src/workflows/steps/update-preorders.ts" highlights={updatePreordersHighlights}
import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"
import { PreorderStatus } from "../../modules/preorder/models/preorder"
import { PREORDER_MODULE } from "../../modules/preorder"
type StepInput = {
id: string
@@ -2711,7 +2722,7 @@ type StepInput = {
export const updatePreordersStep = createStep(
"update-preorders",
async (preorders: StepInput, { container }) => {
const preorderModuleService = container.resolve("preorder")
const preorderModuleService = container.resolve(PREORDER_MODULE)
const oldPreorders = await preorderModuleService.listPreorders({
id: preorders.map((preorder) => preorder.id),
@@ -2728,7 +2739,7 @@ export const updatePreordersStep = createStep(
return
}
const preorderModuleService = container.resolve("preorder")
const preorderModuleService = container.resolve(PREORDER_MODULE)
await preorderModuleService.updatePreorders(
preorders.map((preorder) => ({

6
www/apps/resources/app/how-to-tutorials/tutorials/product-builder/page.mdx
View File

@@ -711,6 +711,12 @@ The `createProductBuilderStep` creates a new product builder configuration.
To create the step, create the file `src/workflows/steps/create-product-builder.ts` with the following content:
<Note>
If you get a type error on resolving the Product Builder Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
export const createProductBuilderStepHighlights = [
["11", "productBuilderModuleService", "Resolve the module service from container."],
["13", "productBuilder", "Create the product builder record."],

6
www/apps/resources/app/how-to-tutorials/tutorials/product-reviews/page.mdx
View File

@@ -399,6 +399,12 @@ The `useQueryGraphStep` step is provided by Medusa in its `@medusajs/medusa/core
In the second step of the workflow, you create the review. To create a step, create the file `src/workflows/steps/create-review.ts` with the following content:
<Note>
If you get a type error on resolving the Product Review Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
export const createReviewHighlights = [
["22", "reviewModuleService", "Resolve the Review Module's service"],
["26", "createReviews", "Create the review"],

6
www/apps/resources/app/integrations/guides/algolia/page.mdx
View File

@@ -419,6 +419,12 @@ In the second step of the workflow, you create or update indexes in Algolia for
To create the step, create the file `src/workflows/steps/sync-products.ts` with the following content:
<Note>
If you get a type error on resolving the Algolia Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
```ts title="src/workflows/steps/sync-products.ts"
import { ProductDTO } from "@medusajs/framework/types"
import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"

6
www/apps/resources/app/integrations/guides/contentful/page.mdx
View File

@@ -1297,6 +1297,12 @@ In the second step, you create the retrieved products in Contentful.
To create the step, create the file `src/workflows/steps/create-products-contentful.ts` with the following content:
<Note>
If you get a type error on resolving the Contentful Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
export const createProductsContentfulStepHighlights = [
["12", `"create-products-contentful-step"`, "The step's unique name."],
["13", "input", "The step's input."],

6
www/apps/resources/app/integrations/guides/magento/page.mdx
View File

@@ -735,6 +735,12 @@ The first step of the workflow retrieves and returns the products from Magento.
In your plugin, create the file `src/workflows/steps/get-magento-products.ts` with the following content:
<Note>
If you get a type error on resolving the Magento Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
![Diagram showcasing the get-magento-products file to create](https://res.cloudinary.com/dza7lstvk/image/upload/v1739349590/Medusa%20Resources/magento-5_ueb4wn.jpg)
```ts title="src/workflows/steps/get-magento-products.ts"

6
www/apps/resources/app/integrations/guides/meilisearch/page.mdx
View File

@@ -396,6 +396,12 @@ In the second step of the workflow, you create or update indexes in Meilisearch
To create the step, create the file `src/workflows/steps/sync-products.ts` with the following content:
<Note>
If you get a type error on resolving the Meilisearch Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
```ts title="src/workflows/steps/sync-products.ts"
import { ProductDTO } from "@medusajs/framework/types"
import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"

6
www/apps/resources/app/integrations/guides/payload/page.mdx
View File

@@ -1462,6 +1462,12 @@ The `createPayloadItemsStep` will create an item in a Payload collection, such a
To create the step, create the file `src/workflows/steps/create-payload-items.ts` with the following content:
<Note>
If you get a type error on resolving the Payload Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
export const createPayloadItemsStepHighlights = [
["13", "payloadModuleService", "Resolve the Payload Module's service from the Medusa container."],
["15", "createdItems", "Create items in Payload."],

6
www/apps/resources/app/integrations/guides/sanity/page.mdx
View File

@@ -674,6 +674,12 @@ The syncing workflow will have a single step that syncs products provided as an
So, to implement that step, create the file `src/workflows/sanity-sync-products/steps/sync.ts` with the following content:
<Note>
If you get a type error on resolving the Sanity Module, run the Medusa application once with the `npm run dev` or `yarn dev` command to generate the necessary type definitions, as explained in the [Automatically Generated Types guide](!docs!/learn/fundamentals/generated-types).
</Note>
export const syncStepHighlights = [
["13", "createStep", "Create a step."],
["15", "container", "The Medusa container to resolve resources."],

24
www/apps/resources/generated/edit-dates.mjs
View File

@@ -3134,7 +3134,7 @@ export const generatedEditDates = {
"references/product/interfaces/product.FilterableProductProps/page.mdx": "2025-06-25T10:11:42.703Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductVariantRequest/page.mdx": "2024-12-09T13:21:34.309Z",
"references/types/WorkflowTypes/ProductWorkflow/interfaces/types.WorkflowTypes.ProductWorkflow.ExportProductsDTO/page.mdx": "2025-06-25T10:11:40.398Z",
"app/integrations/guides/sanity/page.mdx": "2025-06-26T12:41:14.249Z",
"app/integrations/guides/sanity/page.mdx": "2025-10-09T11:31:06.326Z",
"references/api_key/types/api_key.FindConfigOrder/page.mdx": "2024-11-25T17:49:28.715Z",
"references/auth/types/auth.FindConfigOrder/page.mdx": "2024-11-25T17:49:28.887Z",
"references/cart/types/cart.FindConfigOrder/page.mdx": "2024-11-25T17:49:29.455Z",
@@ -6036,7 +6036,7 @@ export const generatedEditDates = {
"app/nextjs-starter/guides/revalidate-cache/page.mdx": "2025-05-01T15:33:42.490Z",
"app/storefront-development/cart/totals/page.mdx": "2025-09-15T15:13:56.268Z",
"app/storefront-development/checkout/order-confirmation/page.mdx": "2025-08-14T15:58:36.610Z",
"app/how-to-tutorials/tutorials/product-reviews/page.mdx": "2025-06-26T12:34:50.976Z",
"app/how-to-tutorials/tutorials/product-reviews/page.mdx": "2025-10-09T11:28:53.803Z",
"app/troubleshooting/data-models/default-fields/page.mdx": "2025-03-21T06:59:06.775Z",
"app/troubleshooting/medusa-admin/blocked-request/page.mdx": "2025-03-21T06:53:34.854Z",
"app/troubleshooting/nextjs-starter-rewrites/page.mdx": "2025-03-21T07:09:08.901Z",
@@ -6047,10 +6047,10 @@ export const generatedEditDates = {
"app/troubleshooting/workflow-errors/step-x-defined/page.mdx": "2025-03-21T07:09:02.741Z",
"app/troubleshooting/workflow-errors/when-then/page.mdx": "2025-03-21T08:35:45.145Z",
"app/how-to-tutorials/tutorials/abandoned-cart/page.mdx": "2025-06-26T11:45:57.112Z",
"app/integrations/guides/algolia/page.mdx": "2025-09-17T07:36:03.845Z",
"app/integrations/guides/magento/page.mdx": "2025-05-20T07:51:40.716Z",
"app/integrations/guides/algolia/page.mdx": "2025-10-09T11:29:19.704Z",
"app/integrations/guides/magento/page.mdx": "2025-10-09T11:30:09.533Z",
"app/js-sdk/auth/overview/page.mdx": "2025-03-28T08:05:32.622Z",
"app/how-to-tutorials/tutorials/loyalty-points/page.mdx": "2025-06-26T11:58:07.874Z",
"app/how-to-tutorials/tutorials/loyalty-points/page.mdx": "2025-10-09T11:27:14.961Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.plugin/page.mdx": "2025-04-11T09:04:55.084Z",
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.createAddress/page.mdx": "2025-05-20T07:51:40.936Z",
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.deleteAddress/page.mdx": "2025-04-11T09:04:54.015Z",
@@ -6196,7 +6196,7 @@ export const generatedEditDates = {
"references/core_flows/interfaces/core_flows.ValidateDraftOrderStepInput/page.mdx": "2025-09-12T14:10:34.664Z",
"app/commerce-modules/product/guides/variant-inventory/page.mdx": "2025-04-25T14:22:42.329Z",
"app/troubleshooting/validation-error/page.mdx": "2025-04-25T14:14:57.568Z",
"app/integrations/guides/contentful/page.mdx": "2025-06-26T11:55:43.353Z",
"app/integrations/guides/contentful/page.mdx": "2025-10-09T11:29:45.742Z",
"references/modules/events/page.mdx": "2025-06-27T07:31:07.646Z",
"references/module_events/module_events.Auth/page.mdx": "2025-05-20T07:51:40.956Z",
"references/module_events/module_events.Cart/page.mdx": "2025-05-20T07:51:40.956Z",
@@ -6556,15 +6556,15 @@ export const generatedEditDates = {
"app/commerce-modules/promotion/promotion-taxes/page.mdx": "2025-06-27T15:44:46.638Z",
"app/troubleshooting/payment/page.mdx": "2025-07-16T10:20:24.799Z",
"app/recipes/personalized-products/example/page.mdx": "2025-07-22T08:53:58.182Z",
"app/how-to-tutorials/tutorials/preorder/page.mdx": "2025-09-09T14:02:55.378Z",
"app/how-to-tutorials/tutorials/preorder/page.mdx": "2025-10-09T11:33:06.479Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.archive/page.mdx": "2025-09-12T14:10:49.018Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.complete/page.mdx": "2025-09-12T14:10:49.024Z",
"app/commerce-modules/cart/cart-totals/page.mdx": "2025-07-31T15:18:13.978Z",
"app/commerce-modules/order/order-totals/page.mdx": "2025-07-31T15:12:10.633Z",
"app/commerce-modules/user/invite-user-subscriber/page.mdx": "2025-08-01T12:01:54.551Z",
"app/how-to-tutorials/tutorials/invoice-generator/page.mdx": "2025-09-16T05:51:22.285Z",
"app/how-to-tutorials/tutorials/product-builder/page.mdx": "2025-09-15T10:44:37.801Z",
"app/integrations/guides/payload/page.mdx": "2025-09-08T15:06:32.588Z",
"app/how-to-tutorials/tutorials/invoice-generator/page.mdx": "2025-10-09T11:26:43.515Z",
"app/how-to-tutorials/tutorials/product-builder/page.mdx": "2025-10-09T11:28:24.756Z",
"app/integrations/guides/payload/page.mdx": "2025-10-09T11:30:44.665Z",
"references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getToken/page.mdx": "2025-08-14T12:59:55.678Z",
"app/commerce-modules/order/draft-orders/page.mdx": "2025-08-26T09:21:49.780Z",
"app/troubleshooting/scheduled-job-not-running/page.mdx": "2025-08-29T11:32:54.117Z",
@@ -6608,9 +6608,9 @@ export const generatedEditDates = {
"references/core_flows/Locking/Steps_Locking/variables/core_flows.Locking.Steps_Locking.acquireLockStepId/page.mdx": "2025-09-15T09:52:14.218Z",
"references/core_flows/Locking/Steps_Locking/variables/core_flows.Locking.Steps_Locking.releaseLockStepId/page.mdx": "2025-09-15T09:52:14.219Z",
"references/core_flows/Locking/core_flows.Locking.Steps_Locking/page.mdx": "2025-09-15T09:52:14.217Z",
"app/integrations/guides/meilisearch/page.mdx": "2025-09-17T08:34:58.966Z",
"app/integrations/guides/meilisearch/page.mdx": "2025-10-09T11:30:25.084Z",
"app/nextjs-starter/guides/storefront-returns/page.mdx": "2025-09-22T06:02:00.580Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.views/page.mdx": "2025-09-18T17:04:59.240Z",
"app/how-to-tutorials/tutorials/agentic-commerce/page.mdx": "2025-10-02T07:14:50.956Z",
"app/how-to-tutorials/tutorials/agentic-commerce/page.mdx": "2025-10-09T11:25:48.831Z",
"app/storefront-development/production-optimizations/page.mdx": "2025-10-03T13:28:37.909Z"
}