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

chore: move ModuleRegistrationName to utils (#7911)

Browse Source
This commit is contained in:
Carlos R. L. Rodrigues
2024-07-03 06:30:56 -03:00
committed by GitHub
parent 46f15b4909
commit a7844efd09
339 changed files with 7203 additions and 7620 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/book/app/advanced-development/api-routes/protected-routes/page.mdx
+23 -29
View File
@@ -30,15 +30,9 @@ To disable the authentication guard on custom routes under the `/admin` or `/sto
For example:
```ts title="src/api/store/customers/me/custom/route.ts" highlights={[["15"]]} apiTesting testApiUrl="http://localhost:9000/store/customers/me/custom" testApiMethod="GET"
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
import type { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
export const GET = async (
req: MedusaRequest,
res: MedusaResponse
) => {
export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
res.json({
message: "Hello",
})
@@ -62,15 +56,16 @@ import type {
AuthenticatedMedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ModuleRegistrationName } from "@medusajs/utils"
import { ICustomerModuleService } from "@medusajs/types"
export const GET = async (
req: AuthenticatedMedusaRequest,
res: MedusaResponse
) => {
const customerModuleService: ICustomerModuleService =
req.scope.resolve(ModuleRegistrationName.CUSTOMER)
const customerModuleService: ICustomerModuleService = req.scope.resolve(
ModuleRegistrationName.CUSTOMER
)
const customer = await customerModuleService.retrieve(
req.auth_context.actor_id
@@ -95,7 +90,7 @@ import type {
AuthenticatedMedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ModuleRegistrationName } from "@medusajs/utils"
import { IUserModuleService } from "@medusajs/types"
export const GET = async (
@@ -106,9 +101,7 @@ export const GET = async (
ModuleRegistrationName.USER
)
const user = await userService.retrieve(
req.auth_context.actor_id
)
const user = await userService.retrieve(req.auth_context.actor_id)
// ...
}
@@ -125,29 +118,30 @@ To protect custom API Routes that don’t start with `/store/customers/me` or `/
For example:
export const highlights = [
["11", "authenticate", "Only authenticated admin users can access routes starting with `/custom/admin`"],
["17", "authenticate", "Only authenticated customers can access routes starting with `/custom/customers`"]
[
"11",
"authenticate",
"Only authenticated admin users can access routes starting with `/custom/admin`",
],
[
"17",
"authenticate",
"Only authenticated customers can access routes starting with `/custom/customers`",
],
]
```ts title="src/api/middlewares.ts" highlights={highlights}
import {
MiddlewaresConfig,
authenticate,
} from "@medusajs/medusa"
import { MiddlewaresConfig, authenticate } from "@medusajs/medusa"
export const config: MiddlewaresConfig = {
routes: [
{
matcher: "/custom/admin*",
middlewares: [
authenticate("user", ["session", "bearer", "api-key"]),
],
middlewares: [authenticate("user", ["session", "bearer", "api-key"])],
},
{
matcher: "/custom/customer*",
middlewares: [
authenticate("customer", ["session", "bearer"]),
],
middlewares: [authenticate("customer", ["session", "bearer"])],
},
],
}
@@ -158,5 +152,5 @@ The `authenticate` middleware function accepts three parameters:
1. The type of user authenticating. Use `user` for authenticating admin users, and `customer` for authenticating customers.
2. An array of the types of authentication methods allowed. Both `user` and `customer` scopes support `session` and `bearer`. The `admin` scope also supports the `api-key` authentication method.
3. An optional object of options having the following properties:
1. `allowUnauthenticated`: (default: `false`) A boolean indicating whether authentication is required. For example, you may have an API route where you want to access the logged-in customer if available, but guest customers can still access it too. In that case, enable the `allowUnauthenticated` option.
2. `allowUnregistered`: (default: `false`) A boolean indicating whether new users can be authenticated.
1. `allowUnauthenticated`: (default: `false`) A boolean indicating whether authentication is required. For example, you may have an API route where you want to access the logged-in customer if available, but guest customers can still access it too. In that case, enable the `allowUnauthenticated` option.
2. `allowUnregistered`: (default: `false`) A boolean indicating whether new users can be authenticated.
www/apps/book/app/advanced-development/custom-cli-scripts/page.mdx
+7 -13
View File
@@ -19,17 +19,13 @@ To create a custom CLI script, create a TypeScript or JavaScript file under the
For example, create the file `src/scripts/my-script.ts` with the following content:
```ts title="src/scripts/my-script.ts"
import {
ExecArgs,
IProductModuleService,
} from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ExecArgs, IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
export default async function myScript({
container,
}: ExecArgs) {
const productModuleService: IProductModuleService =
container.resolve(ModuleRegistrationName.PRODUCT)
export default async function myScript({ container }: ExecArgs) {
const productModuleService: IProductModuleService = container.resolve(
ModuleRegistrationName.PRODUCT
)
const [, count] = await productModuleService.listAndCount()
@@ -60,9 +56,7 @@ For example:
```ts
import { ExecArgs } from "@medusajs/types"
export default async function myScript({
args,
}: ExecArgs) {
export default async function myScript({ args }: ExecArgs) {
console.log(`The arguments you passed: ${args}`)
}
```
www/apps/book/app/advanced-development/loaders/outside-modules/page.mdx
+8 -11
View File
@@ -22,9 +22,7 @@ For example, create the file `src/loaders/hello-world.ts` with the following con
```ts title="src/loaders/hello-world.ts"
export default function () {
console.log(
"[HELLO LOADER] Just started the Medusa application!"
)
console.log("[HELLO LOADER] Just started the Medusa application!")
}
```
@@ -51,11 +49,12 @@ For example:
```ts title="src/loaders/hello-world.ts" collapsibleLines="1-5" expandButtonLabel="Show Imports"
import { MedusaContainer } from "@medusajs/medusa"
import { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ModuleRegistrationName } from "@medusajs/utils"
export default async function (container: MedusaContainer) {
const productModuleService: IProductModuleService =
container.resolve(ModuleRegistrationName.PRODUCT)
const productModuleService: IProductModuleService = container.resolve(
ModuleRegistrationName.PRODUCT
)
const [, count] = await productModuleService.listAndCount()
@@ -78,13 +77,11 @@ import { MedusaContainer } from "@medusajs/medusa"
import { ConfigModule } from "@medusajs/types"
export default async function (
container: MedusaContainer,
container: MedusaContainer,
config: ConfigModule
) {
console.log(`You have ${
Object.values(config.modules || {}).length
} modules!`)
console.log(`You have ${Object.values(config.modules || {}).length} modules!`)
}
```
This loader logs on application start-up the number of modules defined in your Medusa configurations.
This loader logs on application start-up the number of modules defined in your Medusa configurations.
www/apps/book/app/advanced-development/workflows/advanced-example/page.mdx
+63 -67
View File
@@ -26,7 +26,6 @@ In the file, add the type of the expected workflow input:
import { UpdateProductDTO } from "@medusajs/types"
export type UpdateProductAndErpWorkflowInput = UpdateProductDTO
```
The expected input is the data to update in the product along with the product’s ID.
@@ -41,18 +40,23 @@ Create the file `src/workflows/update-product-erp/steps/update-product.ts` with
export const updateProductHighlights = [
["13", "resolve", "Resolve the `ProductService` from the Medusa container."],
["16", "previousProductData", "Retrieve the `previousProductData` to pass it to the compensation function."],
[
"16",
"previousProductData",
"Retrieve the `previousProductData` to pass it to the compensation function.",
],
["19", "", "Update the product."],
["39", "", "Revert the product’s data using the `previousProductData` passed from the step to the compensation function."]
[
"39",
"",
"Revert the product’s data using the `previousProductData` passed from the step to the compensation function.",
],
]
```ts title="src/workflows/update-product-erp/steps/update-product.ts" highlights={updateProductHighlights} collapsibleLines="1-9" expandButtonLabel="Show Imports"
import {
createStep,
StepResponse,
} from "@medusajs/workflows-sdk"
import { createStep, StepResponse } from "@medusajs/workflows-sdk"
import { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ModuleRegistrationName } from "@medusajs/utils"
import { UpdateProductAndErpWorkflowInput } from ".."
const updateProduct = createStep(
@@ -62,8 +66,7 @@ const updateProduct = createStep(
context.container.resolve(ModuleRegistrationName.PRODUCT)
const { id } = input
const previousProductData =
await productModuleService.retrieve(id)
const previousProductData = await productModuleService.retrieve(id)
const product = await productModuleService.update(id, input)
@@ -77,37 +80,28 @@ const updateProduct = createStep(
const productModuleService: IProductModuleService =
context.container.resolve(ModuleRegistrationName.PRODUCT)
const {
id,
type,
options,
variants,
...previousData
} = previousProductData
const { id, type, options, variants, ...previousData } = previousProductData
await productModuleService.update(
id,
{
...previousData,
variants: variants.map((variant) => {
const variantOptions = {}
await productModuleService.update(id, {
...previousData,
variants: variants.map((variant) => {
const variantOptions = {}
variant.options.forEach((option) => {
variantOptions[option.option.title] = option.value
})
variant.options.forEach((option) => {
variantOptions[option.option.title] = option.value
})
return {
...variant,
options: variantOptions,
}
}),
options: options.map((option) => ({
...option,
values: option.values.map((value) => value.value),
})),
type_id: type.id,
}
)
return {
...variant,
options: variantOptions,
}
}),
options: options.map((option) => ({
...option,
values: option.values.map((value) => value.value),
})),
type_id: type.id,
})
}
)
@@ -139,17 +133,30 @@ The `ErpModuleService` used is assumed to be created in a module.
Create the file `src/workflows/update-product-erp/steps/update-erp.ts` with the following content:
export const updateErpHighlights = [
["12", "resolve", "Resolve the `erpModuleService` from the Medusa container."],
["17", "previousErpData", "Retrieve the `previousErpData` to pass it to the compensation function."],
["21", "updateProductErpData", "Update the product’s ERP data and return the data from the ERP system."],
["37", "updateProductErpData", "Revert the product's data in the ERP system to its previous state using the `previousErpData`."]
[
"12",
"resolve",
"Resolve the `erpModuleService` from the Medusa container.",
],
[
"17",
"previousErpData",
"Retrieve the `previousErpData` to pass it to the compensation function.",
],
[
"21",
"updateProductErpData",
"Update the product’s ERP data and return the data from the ERP system.",
],
[
"37",
"updateProductErpData",
"Revert the product's data in the ERP system to its previous state using the `previousErpData`.",
],
]
```ts title="src/workflows/update-product-erp/steps/update-erp.ts" highlights={updateErpHighlights} collapsibleLines="1-8" expandButtonLabel="Show Imports"
import {
createStep,
StepResponse,
} from "@medusajs/workflows-sdk"
import { createStep, StepResponse } from "@medusajs/workflows-sdk"
import { UpdateProductAndErpWorkflowInput } from ".."
import ErpModuleService from "../../../modules/erp/service"
@@ -162,14 +169,12 @@ const updateErp = createStep(
const { id, ...updatedData } = input
// get previous ERP data
const previousErpData =
await erpModuleService.retrieveProductErpDetails(id)
const previousErpData = await erpModuleService.retrieveProductErpDetails(id)
const updatedErpData =
await erpModuleService.updateProductErpData(
id,
updatedData
)
const updatedErpData = await erpModuleService.updateProductErpData(
id,
updatedData
)
return new StepResponse(updatedErpData, {
// pass to compensation function
@@ -179,13 +184,9 @@ const updateErp = createStep(
},
// compensation function
async ({ previousErpData, productId }, context) => {
const erpService: ErpModuleService =
context.container.resolve("erpService")
const erpService: ErpModuleService = context.container.resolve("erpService")
await erpService.updateProductErpData(
productId,
previousErpData
)
await erpService.updateProductErpData(productId, previousErpData)
}
)
@@ -253,10 +254,7 @@ import updateProductAndErpWorkflow, {
UpdateProductAndErpWorkflowInput,
} from "../../../../../workflows/update-product-erp"
type ProductErpReq = Omit<
UpdateProductAndErpWorkflowInput,
"id"
>
type ProductErpReq = Omit<UpdateProductAndErpWorkflowInput, "id">
export const POST = async (
req: MedusaRequest<ProductErpReq>,
@@ -268,9 +266,7 @@ export const POST = async (
...req.body,
}
const { result } = await updateProductAndErpWorkflow(
req.scope
).run({
const { result } = await updateProductAndErpWorkflow(req.scope).run({
input: productData,
})
@@ -280,4 +276,4 @@ export const POST = async (
In this `POST` API route, you retrieve the product’s ID from the path parameter and the data to update from the request body. You then execute the workflow by passing it the retrieved data as an input.
The route returns the result of the workflow, which is an object holding both the update product’s details and the ERP details.
The route returns the result of the workflow, which is an object holding both the update product’s details and the ERP details.
www/apps/book/app/advanced-development/workflows/long-running-workflow/page.mdx
+23 -36
View File
@@ -23,10 +23,7 @@ A workflow is considered long-running if at least one step has its `async` confi
For example, consider the following workflow and steps:
```ts title="src/workflows/hello-world.ts" highlights={[["13"]]} collapsibleLines="1-10" expandButtonLabel="Show More"
import {
createStep,
createWorkflow,
} from "@medusajs/workflows-sdk"
import { createStep, createWorkflow } from "@medusajs/workflows-sdk"
const step1 = createStep("step-1", async () => {
// ...
@@ -50,19 +47,18 @@ type WorkflowOutput = {
message: string
}
const myWorkflow = createWorkflow<
{},
WorkflowOutput
>({
name: "hello-world",
}, function () {
step1()
step2()
step3()
})
const myWorkflow = createWorkflow<{}, WorkflowOutput>(
{
name: "hello-world",
},
function () {
step1()
step2()
step3()
}
)
export default myWorkflow
```
The second step has in its configuration object `async` set to true. This indicates that this step is an asynchronous step.
@@ -89,26 +85,15 @@ export const highlights = [
]
```ts title="src/api/store/workflows/route.ts" highlights={highlights} collapsibleLines="1-11" expandButtonLabel="Show Imports"
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
import type { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import myWorkflow from "../../../workflows/hello-world"
import {
IWorkflowEngineService,
} from "@medusajs/workflows-sdk"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { IWorkflowEngineService } from "@medusajs/workflows-sdk"
import { ModuleRegistrationName } from "@medusajs/utils"
export async function GET(
req: MedusaRequest,
res: MedusaResponse
) {
const { transaction, result } = await myWorkflow(req.scope)
.run()
export async function GET(req: MedusaRequest, res: MedusaResponse) {
const { transaction, result } = await myWorkflow(req.scope).run()
const workflowEngine = req.scope.resolve<
IWorkflowEngineService
>(
const workflowEngine = req.scope.resolve<IWorkflowEngineService>(
ModuleRegistrationName.WORKFLOW_ENGINE
)
@@ -137,18 +122,20 @@ The `subscribe` method accepts an object having three properties:
{
name: "workflowId",
type: "`string`",
description: "The name of the workflow."
description: "The name of the workflow.",
},
{
name: "transactionId",
type: "`string`",
description: "The ID of the workflow exection's transaction. The transaction's details are returned in the response of the workflow execution."
description:
"The ID of the workflow exection's transaction. The transaction's details are returned in the response of the workflow execution.",
},
{
name: "subscriber",
type: "`string`",
description: "The function executed when the workflow execution's status changes. The function receives a data object. It has an `eventType` property, which you use to check the status of the workflow execution."
}
description:
"The function executed when the workflow execution's status changes. The function receives a data object. It has an `eventType` property, which you use to check the status of the workflow execution.",
},
]}
sectionTitle="Access Long-Running Workflow Status and Result"
/>
www/apps/book/app/basics/commerce-modules/page.mdx
+7 -12
View File
@@ -23,19 +23,14 @@ Similarly to your custom module, a commerce module's main service is registered
For example, you saw this code snippet in the [Medusa container chapter](../medusa-container/page.mdx):
```ts highlights={[["13"]]}
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
import type { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ModuleRegistrationName } from "@medusajs/utils"
export const GET = async (
req: MedusaRequest,
res: MedusaResponse
) => {
const productModuleService: IProductModuleService =
req.scope.resolve(ModuleRegistrationName.PRODUCT)
export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
const productModuleService: IProductModuleService = req.scope.resolve(
ModuleRegistrationName.PRODUCT
)
const [, count] = await productModuleService.listAndCount()
@@ -51,4 +46,4 @@ When you resolve the `ModuleRegistrationName.PRODUCT` (or `productModuleService`
To resolve the main service of any commerce module, use the registration name defined in the `ModuleRegistrationName` enum imported from `@medusajs/modules-sdk`.
</Note>
</Note>
www/apps/book/app/basics/events-and-subscribers/page.mdx
+12 -10
View File
@@ -43,7 +43,7 @@ The above subscriber listens to the `product.created` event. Whenever the event
{/* TODO add when we have the admin dashboard to use with V2 for easy testing. */}
{/* ### Test Subscriber
{/\* ### Test Subscriber
To test the subscriber, start the Medusa application:
@@ -58,7 +58,7 @@ info: Processing product.created which has 1 subscribers
A product is created
```
The first message indicates that the `product.created` event was emitted, and the second one is the message logged from the subscriber. */}
The first message indicates that the `product.created` event was emitted, and the second one is the message logged from the subscriber. \*/}
---
@@ -83,23 +83,25 @@ For example:
export const highlights = [
["10", "container", "Recieve the Medusa Container in the object parameter."],
["13", "resolve", "Resolve the Product Module's main service."],
["13", "ModuleRegistrationName.PRODUCT", "The resource registration name imported from `@medusajs/modules-sdk`."]
[
"13",
"ModuleRegistrationName.PRODUCT",
"The resource registration name imported from `@medusajs/modules-sdk`.",
],
]
```ts title="src/subscribers/product-created.ts" highlights={highlights}
import {
SubscriberArgs,
type SubscriberConfig,
} from "@medusajs/medusa"
import { SubscriberArgs, type SubscriberConfig } from "@medusajs/medusa"
import { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ModuleRegistrationName } from "@medusajs/utils"
export default async function productCreateHandler({
data,
container,
}: SubscriberArgs<Record<string, string>>) {
const productModuleService: IProductModuleService =
container.resolve(ModuleRegistrationName.PRODUCT)
const productModuleService: IProductModuleService = container.resolve(
ModuleRegistrationName.PRODUCT
)
const product = await productModuleService.retrieve(data.id)
www/apps/book/app/basics/medusa-container/page.mdx
+11 -12
View File
@@ -16,23 +16,22 @@ For example, in a custom API route you can resolve any service registered in the
export const highlights = [
["13", "resolve", "Resolve the Product Module's main service."],
["13", "ModuleRegistrationName.PRODUCT", "The resource registration name imported from `@medusajs/modules-sdk`."]
[
"13",
"ModuleRegistrationName.PRODUCT",
"The resource registration name imported from `@medusajs/modules-sdk`.",
],
]
```ts highlights={highlights}
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
import type { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ModuleRegistrationName } from "@medusajs/utils"
export const GET = async (
req: MedusaRequest,
res: MedusaResponse
) => {
const productModuleService: IProductModuleService =
req.scope.resolve(ModuleRegistrationName.PRODUCT)
export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
const productModuleService: IProductModuleService = req.scope.resolve(
ModuleRegistrationName.PRODUCT
)
const [, count] = await productModuleService.listAndCount()
www/apps/book/app/basics/workflows/page.mdx
+24 -28
View File
@@ -25,10 +25,7 @@ A workflow is made of a series of steps. A step is created using the `createStep
Create the file `src/workflows/hello-world.ts` with the following content:
```ts title="src/workflows/hello-world.ts"
import {
createStep,
StepResponse,
} from "@medusajs/workflows-sdk"
import { createStep, StepResponse } from "@medusajs/workflows-sdk"
const step1 = createStep("step-1", async () => {
return new StepResponse(`Hello from step one!`)
@@ -44,12 +41,9 @@ type WorkflowInput = {
name: string
}
const step2 = createStep(
"step-2",
async ({ name }: WorkflowInput) => {
return new StepResponse(`Hello ${name} from step two!`)
}
)
const step2 = createStep("step-2", async ({ name }: WorkflowInput) => {
return new StepResponse(`Hello ${name} from step two!`)
})
```
### 2. Create a Workflow
@@ -68,21 +62,20 @@ type WorkflowOutput = {
message: string
}
const myWorkflow = createWorkflow<
WorkflowInput,
WorkflowOutput
>("hello-world", function (input) {
const str1 = step1()
// to pass input
const str2 = step2(input)
const myWorkflow = createWorkflow<WorkflowInput, WorkflowOutput>(
"hello-world",
function (input) {
const str1 = step1()
// to pass input
const str2 = step2(input)
return {
message: str1,
return {
message: str1,
}
}
})
)
export default myWorkflow
```
This creates a `hello-world` workflow. When you create a workflow, it’s constructed but not executed yet.
@@ -226,7 +219,11 @@ For example:
export const highlights = [
["15", "resolve", "Resolve the Product Module's main service."],
["15", "ModuleRegistrationName.PRODUCT", "The resource registration name imported from `@medusajs/modules-sdk`."]
[
"15",
"ModuleRegistrationName.PRODUCT",
"The resource registration name imported from `@medusajs/modules-sdk`.",
],
]
```ts title="src/workflows/product-count.ts" highlights={highlights} collapsibleLines="1-12" expandButtonLabel="Show Imports"
@@ -236,18 +233,17 @@ import {
createWorkflow,
} from "@medusajs/workflows-sdk"
import { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ModuleRegistrationName } from "@medusajs/utils"
type WorkflowOutput = {
count: number
}
const step1 = createStep("step-1", async (_, context) => {
const productModuleService: IProductModuleService =
context.container.resolve(ModuleRegistrationName.PRODUCT)
return new StepResponse(
(await productModuleService.listAndCount())[1]
const productModuleService: IProductModuleService = context.container.resolve(
ModuleRegistrationName.PRODUCT
)
return new StepResponse((await productModuleService.listAndCount())[1])
})
const myWorkflow = createWorkflow<unknown, WorkflowOutput>(
@@ -264,4 +260,4 @@ const myWorkflow = createWorkflow<unknown, WorkflowOutput>(
export default myWorkflow
```
In the step, you resolve the Product Module's main service and use it to retrieve the product count.
In the step, you resolve the Product Module's main service and use it to retrieve the product count.