Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: replace ModuleRegistrationName with Modules #9142

Merged
merged 1 commit into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ import type {
AuthenticatedMedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"
import { ICustomerModuleService } from "@medusajs/types"

export const GET = async (
Expand All @@ -129,7 +129,7 @@ export const GET = async (
if (req.auth_context?.actor_id) {
// retrieve customer
const customerModuleService: ICustomerModuleService = req.scope.resolve(
ModuleRegistrationName.CUSTOMER
Modules.CUSTOMER
)

const customer = await customerModuleService.retrieveCustomer(
Expand All @@ -154,15 +154,15 @@ import type {
AuthenticatedMedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"
import { IUserModuleService } from "@medusajs/types"

export const GET = async (
req: AuthenticatedMedusaRequest,
res: MedusaResponse
) => {
const userModuleService: IUserModuleService = req.scope.resolve(
ModuleRegistrationName.USER
Modules.USER
)

const user = await userModuleService.retrieveUser(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ import {
ExecArgs,
IProductModuleService,
} from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

export default async function myScript({ container }: ExecArgs) {
const productModuleService: IProductModuleService = container.resolve(
ModuleRegistrationName.PRODUCT
Modules.PRODUCT
)

const [, count] = await productModuleService
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ export const updateProductHighlights = [
```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 { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"
import { UpdateProductAndErpWorkflowInput } from ".."

const updateProduct = createStep(
"update-product",
async (input: UpdateProductAndErpWorkflowInput, context) => {
const productModuleService: IProductModuleService =
context.container.resolve(ModuleRegistrationName.PRODUCT)
context.container.resolve(Modules.PRODUCT)

const { id } = input
const previousProductData =
Expand All @@ -72,7 +72,7 @@ const updateProduct = createStep(
// compensation function
async ({ previousProductData }, context) => {
const productModuleService: IProductModuleService =
context.container.resolve(ModuleRegistrationName.PRODUCT)
context.container.resolve(Modules.PRODUCT)

const { id, type, options, variants, ...previousData } = previousProductData

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ So, when you execute the `hello-world` workflow, it continues its execution in t

Once the workflow's execution reaches an async step, it'll wait in the background for the step to succeed or fail before it moves to the rest of the steps.

To change fail or succeed a step, use the workflow engine's main service that is registered in the Medusa Container under the `ModuleRegistrationName.WORKFLOW_ENGINE` (or `workflowsModuleService`) key.
To change fail or succeed a step, use the workflow engine's main service that is registered in the Medusa Container under the `Modules.WORKFLOW_ENGINE` (or `workflowsModuleService`) key.

### Retrieve Transaction ID

Expand Down Expand Up @@ -103,7 +103,7 @@ export const successStatusHighlights = [

```ts highlights={successStatusHighlights} collapsibleLines="1-9" expandButtonLabel="Show Imports"
import {
ModuleRegistrationName,
Modules,
TransactionHandlerType,
} from "@medusajs/utils";
import {
Expand All @@ -122,7 +122,7 @@ export const setStepSuccessStep = createStep(
{ container }
) {
const workflowEngineService = container.resolve(
ModuleRegistrationName.WORKFLOW_ENGINE
Modules.WORKFLOW_ENGINE
);

await workflowEngineService.setStepSuccess({
Expand Down Expand Up @@ -221,7 +221,7 @@ export const failureStatusHighlights = [

```ts highlights={failureStatusHighlights} collapsibleLines="1-9" expandButtonLabel="Show Imports"
import {
ModuleRegistrationName,
Modules,
TransactionHandlerType,
} from "@medusajs/utils";
import {
Expand All @@ -240,7 +240,7 @@ export const setStepFailureStep = createStep(
{ container }
) {
const workflowEngineService = container.resolve(
ModuleRegistrationName.WORKFLOW_ENGINE
Modules.WORKFLOW_ENGINE
);

await workflowEngineService.setStepFailure({
Expand Down Expand Up @@ -282,15 +282,15 @@ import myWorkflow from "../../../workflows/hello-world"
import {
IWorkflowEngineService,
} from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

export async function GET(req: MedusaRequest, res: MedusaResponse) {
const { transaction, result } = await myWorkflow(req.scope).run()

const workflowEngineService = req.scope.resolve<
IWorkflowEngineService
>(
ModuleRegistrationName.WORKFLOW_ENGINE
Modules.WORKFLOW_ENGINE
)

const subscriptionOptions = {
Expand Down
8 changes: 4 additions & 4 deletions www/apps/book/app/basics/commerce-modules/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ For example, you saw this code snippet in the [Medusa container chapter](../medu
```ts highlights={[["10"]]}
import type { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

export const GET = async (
req: MedusaRequest,
res: MedusaResponse
) => {
const productModuleService: IProductModuleService = req.scope.resolve(
ModuleRegistrationName.PRODUCT
Modules.PRODUCT
)

const [, count] = await productModuleService
Expand All @@ -46,10 +46,10 @@ export const GET = async (
}
```

When you resolve the `ModuleRegistrationName.PRODUCT` (or `productModuleService`) registration name, you're actually resolving the main service of the Product Module.
When you resolve the `Modules.PRODUCT` (or `productModuleService`) registration name, you're actually resolving the main service of the Product Module.

<Note title="Tip">

To resolve the main service of any commerce module, use the registration name defined in the `ModuleRegistrationName` enum imported from `@medusajs/utils`.
To resolve the main service of any commerce module, use the registration name defined in the `Modules` enum imported from `@medusajs/utils`.

</Note>
6 changes: 3 additions & 3 deletions www/apps/book/app/basics/events-and-subscribers/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,20 +85,20 @@ For example:
export const highlights = [
["7", "container", "Recieve the Medusa Container in the object parameter."],
["10", "resolve", "Resolve the Product Module's main service."],
["10", "ModuleRegistrationName.PRODUCT", "The module's registration name imported from `@medusajs/utils`."]
["10", "Modules.PRODUCT", "The module's registration name imported from `@medusajs/utils`."]
]

```ts title="src/subscribers/product-created.ts" highlights={highlights}
import { SubscriberArgs, type SubscriberConfig } from "@medusajs/medusa"
import { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

export default async function productCreateHandler({
event: { data },
container,
}: SubscriberArgs<{ id: string }>) {
const productModuleService: IProductModuleService =
container.resolve(ModuleRegistrationName.PRODUCT)
container.resolve(Modules.PRODUCT)

const productId = data.id

Expand Down
6 changes: 3 additions & 3 deletions www/apps/book/app/basics/medusa-container/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,22 @@ export const highlights = [
["9", "resolve", "Resolve the Product Module's main service."],
[
"10",
"ModuleRegistrationName.PRODUCT",
"Modules.PRODUCT",
"The resource registration name imported from `@medusajs/utils`.",
],
]

```ts highlights={highlights}
import type { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

export const GET = async (
req: MedusaRequest,
res: MedusaResponse
) => {
const productModuleService: IProductModuleService = req.scope.resolve(
ModuleRegistrationName.PRODUCT
Modules.PRODUCT
)

const [, count] = await productModuleService
Expand Down
6 changes: 3 additions & 3 deletions www/apps/book/app/basics/scheduled-jobs/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,21 +87,21 @@ For example:

export const highlights = [
["11", "resolve", "Resolve the Product Module's main service."],
["11", "ModuleRegistrationName.PRODUCT", "The module's registration name imported from `@medusajs/utils`."]
["11", "Modules.PRODUCT", "The module's registration name imported from `@medusajs/utils`."]
]

```ts title="src/jobs/hello-world.ts" highlights={highlights}
import {
IProductModuleService,
MedusaContainer,
} from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

export default async function myCustomJob(
container: MedusaContainer
) {
const productModuleService: IProductModuleService =
container.resolve(ModuleRegistrationName.PRODUCT)
container.resolve(Modules.PRODUCT)

const [, count] = await productModuleService.listAndCountProducts()

Expand Down
10 changes: 5 additions & 5 deletions www/apps/book/app/basics/workflows/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ To execute the workflow, invoke it passing the Medusa container as a parameter.
type SubscriberArgs,
} from "@medusajs/medusa"
import myWorkflow from "../workflows/hello-world"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"
import { IUserModuleService } from "@medusajs/types"

export default async function handleCustomerCreate({
Expand All @@ -136,7 +136,7 @@ To execute the workflow, invoke it passing the Medusa container as a parameter.
}: SubscriberArgs<{ id: string }>) {
const userId = data.id
const userModuleService: IUserModuleService = container.resolve(
ModuleRegistrationName.USER
Modules.USER
)

const user = await userModuleService.retrieveUser(userId)
Expand Down Expand Up @@ -231,7 +231,7 @@ export const highlights = [
["12", "resolve", "Resolve the Product Module's main service."],
[
"12",
"ModuleRegistrationName.PRODUCT",
"Modules.PRODUCT",
"The resource registration name imported from `@medusajs/utils`.",
],
]
Expand All @@ -244,11 +244,11 @@ import {
WorkflowResponse,
} from "@medusajs/workflows-sdk"
import { IProductModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

const step1 = createStep("step-1", async (_, context) => {
const productModuleService: IProductModuleService =
context.container.resolve(ModuleRegistrationName.PRODUCT)
context.container.resolve(Modules.PRODUCT)

const [, count] = await productModuleService.listAndCountProducts()

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ import type {
SubscriberArgs,
SubscriberConfig,
} from "@medusajs/medusa"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"
import { INotificationModuleService } from "@medusajs/types"

export default async function productCreateHandler({
event: { data },
container,
}: SubscriberArgs<{ id: string }>) {
const notificationModuleService: INotificationModuleService =
container.resolve(ModuleRegistrationName.NOTIFICATION)
container.resolve(Modules.NOTIFICATION)

await notificationModuleService.createNotifications({
to: "[email protected]",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,15 +144,15 @@ import type {
SubscriberArgs,
SubscriberConfig,
} from "@medusajs/medusa"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"
import { INotificationModuleService } from "@medusajs/types"

export default async function productCreateHandler({
event: { data },
container,
}: SubscriberArgs<{ id: string }>) {
const notificationModuleService: INotificationModuleService =
container.resolve(ModuleRegistrationName.NOTIFICATION)
container.resolve(Modules.NOTIFICATION)

await notificationModuleService.createNotifications({
to: "[email protected]",
Expand Down
20 changes: 10 additions & 10 deletions www/apps/resources/app/commerce-modules/api-key/examples/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ In this guide, you’ll find common examples of how you can use the API Key Modu
```ts
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { IApiKeyModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

export async function POST(request: MedusaRequest, res: MedusaResponse) {
const apiKeyModuleService: IApiKeyModuleService = request.scope.resolve(
ModuleRegistrationName.API_KEY
Modules.API_KEY
)

const apiKey = await apiKeyModuleService.createApiKeys({
Expand Down Expand Up @@ -71,11 +71,11 @@ export async function POST(request: Request) {
```ts
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { IApiKeyModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

export async function GET(request: MedusaRequest, res: MedusaResponse) {
const apiKeyModuleService: IApiKeyModuleService = request.scope.resolve(
ModuleRegistrationName.API_KEY
Modules.API_KEY
)

res.json({
Expand Down Expand Up @@ -114,14 +114,14 @@ export async function GET(request: Request) {
```ts collapsibleLines="1-9" expandButtonLabel="Show Imports"
import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { IApiKeyModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

export async function POST(
request: AuthenticatedMedusaRequest,
res: MedusaResponse
) {
const apiKeyModuleService: IApiKeyModuleService = request.scope.resolve(
ModuleRegistrationName.API_KEY
Modules.API_KEY
)

const revokedKey = await apiKeyModuleService.revoke(request.params.id, {
Expand Down Expand Up @@ -175,11 +175,11 @@ export async function POST(request: Request, { params }: ContextType) {
```ts
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { IApiKeyModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

export async function POST(request: MedusaRequest, res: MedusaResponse) {
const apiKeyModuleService: IApiKeyModuleService = request.scope.resolve(
ModuleRegistrationName.API_KEY
Modules.API_KEY
)

const authenticatedToken = await apiKeyModuleService.authenticate(
Expand Down Expand Up @@ -235,14 +235,14 @@ export async function POST(request: Request, { params }: ContextType) {
MedusaResponse,
} from "@medusajs/medusa"
import { IApiKeyModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { Modules } from "@medusajs/utils"

export async function POST(
request: AuthenticatedMedusaRequest,
res: MedusaResponse
) {
const apiKeyModuleService: IApiKeyModuleService = request.scope.resolve(
ModuleRegistrationName.API_KEY
Modules.API_KEY
)

const revokedKey = await apiKeyModuleService.revoke(request.params.id, {
Expand Down
Loading
Loading