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

docs: fix package names in module registration (#9590)

Browse Source 
* docs: fix package names in module registration

* update references
This commit is contained in:
Shahed Nasser
2024-10-16 10:05:07 +03:00
committed by GitHub
parent 813efeae51
commit 6efb5897dc
27 changed files with 60 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
www/apps/resources/app/architectural-modules/cache/in-memory/page.mdx vendored
View File

@@ -32,7 +32,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/cache-inmemory",
resolve: "@medusajs/medusa/cache-inmemory",
options: {
// optional options
},

2
www/apps/resources/app/architectural-modules/cache/redis/page.mdx vendored
View File

@@ -34,7 +34,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/cache-redis",
resolve: "@medusajs/medusa/cache-redis",
options: {
redisUrl: process.env.CACHE_REDIS_URL,
},

2
www/apps/resources/app/architectural-modules/event/local/page.mdx
View File

@@ -31,7 +31,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/event-bus-local"
resolve: "@medusajs/medusa/event-bus-local"
}
]
})

2
www/apps/resources/app/architectural-modules/event/redis/page.mdx
View File

@@ -38,7 +38,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/event-bus-redis",
resolve: "@medusajs/medusa/event-bus-redis",
options: {
redisUrl: process.env.EVENTS_REDIS_URL,
},

4
www/apps/resources/app/architectural-modules/file/local/page.mdx
View File

@@ -41,11 +41,11 @@ module.exports = {
// ...
modules: [
{
resolve: "@medusajs/file",
resolve: "@medusajs/medusa/file",
options: {
providers: [
{
resolve: "@medusajs/file-local-next",
resolve: "@medusajs/medusa/file-local-next",
id: "local",
options: {
// provider options...

8
www/apps/resources/app/architectural-modules/file/s3/page.mdx
View File

@@ -122,11 +122,11 @@ module.exports = {
modules: [
// ...
{
resolve: "@medusajs/file",
resolve: "@medusajs/medusa/file",
options: {
providers: [
{
resolve: "@medusajs/file-s3",
resolve: "@medusajs/medusa/file-s3",
id: "s3",
options: {
file_url: process.env.S3_FILE_URL,
@@ -354,11 +354,11 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/file",
resolve: "@medusajs/medusa/file",
options: {
providers: [
{
resolve: "@medusajs/file-s3",
resolve: "@medusajs/medusa/file-s3",
id: "s3",
options: {
// ...

4
www/apps/resources/app/architectural-modules/notification/local/page.mdx
View File

@@ -35,12 +35,12 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/notification",
resolve: "@medusajs/medusa/notification",
options: {
providers: [
// ...
{
resolve: "@medusajs/notification-local",
resolve: "@medusajs/medusa/notification-local",
id: "local",
options: {
channels: ["email"],

4
www/apps/resources/app/architectural-modules/notification/page.mdx
View File

@@ -40,12 +40,12 @@ module.exports = {
modules: [
// ...
{
resolve: "@medusajs/notification",
resolve: "@medusajs/medusa/notification",
options: {
providers: [
// ...
{
resolve: "@medusajs/notification-local",
resolve: "@medusajs/medusa/notification-local",
id: "notification",
options: {
channels: ["email"],

4
www/apps/resources/app/architectural-modules/notification/sendgrid/page.mdx
View File

@@ -46,12 +46,12 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/notification",
resolve: "@medusajs/medusa/notification",
options: {
providers: [
// ...
{
resolve: "@medusajs/notification-sendgrid",
resolve: "@medusajs/medusa/notification-sendgrid",
id: "sendgrid",
options: {
channels: ["email"],

2
www/apps/resources/app/architectural-modules/workflow-engine/in-memory/page.mdx
View File

@@ -33,7 +33,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/workflow-engine-inmemory"
resolve: "@medusajs/medusa/workflow-engine-inmemory"
}
],
})

2
www/apps/resources/app/architectural-modules/workflow-engine/redis/page.mdx
View File

@@ -34,7 +34,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/workflow-engine-redis",
resolve: "@medusajs/medusa/workflow-engine-redis",
options: {
redis: {
url: process.env.WE_REDIS_URL,

4
www/apps/resources/app/commerce-modules/auth/module-options/page.mdx
View File

@@ -35,11 +35,11 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/auth",
resolve: "@medusajs/medusa/auth",
options: {
providers: [
{
resolve: "@medusajs/auth-emailpass",
resolve: "@medusajs/medusa/auth-emailpass",
id: "emailpass",
options: {
// provider options...

4
www/apps/resources/app/commerce-modules/fulfillment/module-options/page.mdx
View File

@@ -29,11 +29,11 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/fulfillment",
resolve: "@medusajs/medusa/fulfillment",
options: {
providers: [
{
resolve: `@medusajs/fulfillment-manual`,
resolve: `@medusajs/medusa/fulfillment-manual`,
id: "manual",
options: {
// provider options...

4
www/apps/resources/app/commerce-modules/payment/module-options/page.mdx
View File

@@ -112,11 +112,11 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/payment",
resolve: "@medusajs/medusa/payment",
options: {
providers: [
{
resolve: "@medusajs/payment-stripe",
resolve: "@medusajs/medusa/payment-stripe",
id: "stripe",
options: {
// ...

4
www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx
View File

@@ -40,11 +40,11 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/payment",
resolve: "@medusajs/medusa/payment",
options: {
providers: [
{
resolve: "@medusajs/payment-stripe",
resolve: "@medusajs/medusa/payment-stripe",
id: "stripe",
options: {
apiKey: process.env.STRIPE_API_KEY,

19
www/apps/resources/app/deployment/medusa-application/railway/page.mdx
View File

@@ -121,7 +121,7 @@ So, add the following script in `package.json`:
By default, your Medusa application uses modules and providers useful for development, such as the In-Memory Cache Module or the Local File Module Provider.
It’s highly recommended to instead install modules and providers suitable for production, including:
It’s highly recommended to instead use modules and providers suitable for production, including:
- [Redis Cache Module](../../../architectural-modules/cache/redis/page.mdx)
- [Redis Event Bus Module](../../../architectural-modules/event/redis/page.mdx)
@@ -129,17 +129,6 @@ It’s highly recommended to instead install modules and providers suitable for
- [S3 File Module Provider](../../../architectural-modules/file/s3/page.mdx) (or other file module providers production-ready).
- [SendGrid Notification Module Provider](../../../architectural-modules/notification/sendgrid/page.mdx) (or other notification module providers production-ready).
For example, add the following dependencies in `package.json` for the Cache, Event Bus, and Workflow Engine modules:
```json
"dependencies": {
// ...
"@medusajs/cache-redis": "rc",
"@medusajs/event-bus-redis": "rc",
"@medusajs/workflow-engine-redis": "rc"
}
```
Then, add these modules in `medusa-config.ts`:
```ts title="medusa-config.ts"
@@ -149,19 +138,19 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/cache-redis",
resolve: "@medusajs/medusa/cache-redis",
options: {
redisUrl: process.env.REDIS_URL,
},
},
{
resolve: "@medusajs/event-bus-redis",
resolve: "@medusajs/medusa/event-bus-redis",
options: {
redisUrl: process.env.REDIS_URL,
},
},
{
resolve: "@medusajs/workflow-engine-redis",
resolve: "@medusajs/medusa/workflow-engine-redis",
options: {
redis: {
url: process.env.REDIS_URL,

8
www/apps/resources/app/recipes/digital-products/examples/standard/page.mdx
View File

@@ -1512,11 +1512,11 @@ module.exports = defineConfig({
modules: [
// ...
{
resolve: "@medusajs/fulfillment",
resolve: "@medusajs/medusa/fulfillment",
options: {
providers: [
{
resolve: "@medusajs/fulfillment-manual",
resolve: "@medusajs/medusa/fulfillment-manual",
id: "manual",
},
{
@@ -2008,11 +2008,11 @@ module.exports = defineConfig({
modules: [
// ...
{
resolve: "@medusajs/notification",
resolve: "@medusajs/medusa/notification",
options: {
providers: [
{
resolve: "@medusajs/notification-local",
resolve: "@medusajs/medusa/notification-local",
id: "local",
options: {
name: "Local Notification Provider",

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

@@ -3,7 +3,7 @@ export const generatedEditDates = {
"app/commerce-modules/auth/auth-providers/page.mdx": "2024-10-08T07:27:21.859Z",
"app/commerce-modules/auth/authentication-route/page.mdx": "2024-09-05T12:06:38.155Z",
"app/commerce-modules/auth/examples/page.mdx": "2024-10-07T15:36:17.212Z",
"app/commerce-modules/auth/module-options/page.mdx": "2024-10-07T15:33:05.989Z",
"app/commerce-modules/auth/module-options/page.mdx": "2024-10-15T12:52:08.930Z",
"app/commerce-modules/auth/page.mdx": "2024-10-08T07:38:27.522Z",
"app/commerce-modules/cart/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/cart/_events/page.mdx": "2024-07-03T19:27:13+03:00",
@@ -26,7 +26,7 @@ export const generatedEditDates = {
"app/commerce-modules/fulfillment/concepts/page.mdx": "2024-06-19T13:02:16+00:00",
"app/commerce-modules/fulfillment/fulfillment-provider/page.mdx": "2024-10-08T14:34:16.019Z",
"app/commerce-modules/fulfillment/item-fulfillment/page.mdx": "2024-10-08T14:38:15.496Z",
"app/commerce-modules/fulfillment/module-options/page.mdx": "2024-09-30T08:43:53.160Z",
"app/commerce-modules/fulfillment/module-options/page.mdx": "2024-10-15T12:51:56.118Z",
"app/commerce-modules/fulfillment/shipping-option/page.mdx": "2024-10-08T14:36:02.660Z",
"app/commerce-modules/fulfillment/page.mdx": "2024-10-08T15:03:27.436Z",
"app/commerce-modules/inventory/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
@@ -49,11 +49,11 @@ export const generatedEditDates = {
"app/commerce-modules/payment/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/payment/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/payment/examples/page.mdx": "2024-10-09T10:50:04.128Z",
"app/commerce-modules/payment/module-options/page.mdx": "2024-10-09T10:49:26.079Z",
"app/commerce-modules/payment/module-options/page.mdx": "2024-10-15T12:51:40.574Z",
"app/commerce-modules/payment/payment/page.mdx": "2024-10-09T10:59:08.463Z",
"app/commerce-modules/payment/payment-collection/page.mdx": "2024-10-09T10:56:49.510Z",
"app/commerce-modules/payment/payment-flow/page.mdx": "2024-10-09T11:18:53.332Z",
"app/commerce-modules/payment/payment-provider/stripe/page.mdx": "2024-10-09T11:09:27.471Z",
"app/commerce-modules/payment/payment-provider/stripe/page.mdx": "2024-10-15T12:51:45.236Z",
"app/commerce-modules/payment/payment-provider/page.mdx": "2024-10-09T11:07:27.269Z",
"app/commerce-modules/payment/payment-session/page.mdx": "2024-10-09T10:58:00.960Z",
"app/commerce-modules/payment/webhook-events/page.mdx": "2024-10-09T11:11:05.413Z",
@@ -124,7 +124,7 @@ export const generatedEditDates = {
"app/contribution-guidelines/docs/page.mdx": "2024-05-13T18:55:11+03:00",
"app/create-medusa-app/page.mdx": "2024-08-05T11:10:55+03:00",
"app/deployment/admin/vercel/page.mdx": "2024-07-31T17:01:33+03:00",
"app/deployment/medusa-application/railway/page.mdx": "2024-09-30T08:43:53.172Z",
"app/deployment/medusa-application/railway/page.mdx": "2024-10-15T12:50:50.981Z",
"app/deployment/storefront/vercel/page.mdx": "2024-07-26T07:21:31+00:00",
"app/deployment/page.mdx": "2024-07-25T09:55:22+03:00",
"app/integrations/page.mdx": "2024-07-19T08:49:08+00:00",
@@ -134,7 +134,7 @@ export const generatedEditDates = {
"app/nextjs-starter/page.mdx": "2024-07-01T10:21:19+03:00",
"app/recipes/b2b/page.mdx": "2024-10-03T13:07:44.153Z",
"app/recipes/commerce-automation/page.mdx": "2024-10-03T13:07:44.147Z",
"app/recipes/digital-products/examples/standard/page.mdx": "2024-10-04T09:44:55.176Z",
"app/recipes/digital-products/examples/standard/page.mdx": "2024-10-15T12:51:59.486Z",
"app/recipes/digital-products/page.mdx": "2024-10-03T13:07:44.147Z",
"app/recipes/ecommerce/page.mdx": "2024-06-09T15:18:43+02:00",
"app/recipes/integrate-ecommerce-stack/page.mdx": "2024-10-03T13:07:44.146Z",
@@ -221,29 +221,29 @@ export const generatedEditDates = {
"app/commerce-modules/api-key/page.mdx": "2024-10-07T13:57:33.042Z",
"app/commerce-modules/auth/create-actor-type/page.mdx": "2024-10-08T07:31:11.256Z",
"app/architectural-modules/page.mdx": "2024-05-28T13:25:03+03:00",
"app/architectural-modules/workflow-engine/redis/page.mdx": "2024-09-30T08:43:53.152Z",
"app/architectural-modules/workflow-engine/redis/page.mdx": "2024-10-15T12:50:59.507Z",
"app/commerce-modules/api-key/examples/page.mdx": "2024-10-07T13:58:49.457Z",
"app/architectural-modules/notification/sendgrid/page.mdx": "2024-09-30T08:43:53.151Z",
"app/architectural-modules/notification/sendgrid/page.mdx": "2024-10-15T12:51:25.569Z",
"app/commerce-modules/api-key/concepts/page.mdx": "2024-10-07T13:59:37.529Z",
"app/architectural-modules/workflow-engine/page.mdx": "2024-05-28T13:25:03+03:00",
"app/_events-reference/page.mdx": "2024-07-03T19:27:13+03:00",
"app/architectural-modules/cache/page.mdx": "2024-05-28T13:25:03+03:00",
"app/architectural-modules/file/s3/page.mdx": "2024-09-30T08:43:53.150Z",
"app/architectural-modules/file/s3/page.mdx": "2024-10-15T12:51:14.315Z",
"app/commerce-modules/api-key/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/api-key/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/architectural-modules/cache/redis/page.mdx": "2024-09-30T08:43:53.149Z",
"app/architectural-modules/event/redis/page.mdx": "2024-09-30T08:43:53.149Z",
"app/architectural-modules/event/local/page.mdx": "2024-09-30T08:43:53.149Z",
"app/architectural-modules/workflow-engine/in-memory/page.mdx": "2024-09-30T08:43:53.151Z",
"app/architectural-modules/cache/in-memory/page.mdx": "2024-09-30T08:43:53.148Z",
"app/architectural-modules/notification/local/page.mdx": "2024-09-30T08:43:53.150Z",
"app/architectural-modules/file/local/page.mdx": "2024-09-30T08:43:53.150Z",
"app/architectural-modules/cache/redis/page.mdx": "2024-10-15T12:50:01.730Z",
"app/architectural-modules/event/redis/page.mdx": "2024-10-15T12:50:40.506Z",
"app/architectural-modules/event/local/page.mdx": "2024-10-15T12:50:37.512Z",
"app/architectural-modules/workflow-engine/in-memory/page.mdx": "2024-10-15T12:50:57.249Z",
"app/architectural-modules/cache/in-memory/page.mdx": "2024-10-15T12:49:57.608Z",
"app/architectural-modules/notification/local/page.mdx": "2024-10-15T12:51:21.284Z",
"app/architectural-modules/file/local/page.mdx": "2024-10-15T12:51:07.033Z",
"app/architectural-modules/notification/send-notification/page.mdx": "2024-09-30T08:43:53.151Z",
"app/architectural-modules/file/page.mdx": "2024-07-01T10:21:19+03:00",
"app/architectural-modules/event/page.mdx": "2024-05-28T13:25:03+03:00",
"app/architectural-modules/cache/create/page.mdx": "2024-09-30T08:43:53.148Z",
"app/admin-widget-injection-zones/page.mdx": "2024-09-30T08:43:53.147Z",
"app/architectural-modules/notification/page.mdx": "2024-09-30T08:43:53.151Z",
"app/architectural-modules/notification/page.mdx": "2024-10-15T12:51:28.735Z",
"app/architectural-modules/event/create/page.mdx": "2024-09-30T08:43:53.149Z",
"app/troubleshooting/deployment/page.mdx": "2024-08-19T07:19:40.924Z",
"references/core_flows/Order/functions/core_flows.Order.orderEditUpdateItemQuantityValidationStep/page.mdx": "2024-08-20T00:10:58.913Z",

2
www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx
View File

@@ -436,7 +436,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/framework/auth",
resolve: "@medusajs/medusa/auth",
options: {
providers: [
{

2
www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx
View File

@@ -214,7 +214,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/framework/file",
resolve: "@medusajs/medusa/file",
options: {
providers: [
{

2
www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx
View File

@@ -477,7 +477,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/framework/fulfillment",
resolve: "@medusajs/medusa/fulfillment",
options: {
providers: [
{

2
www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx
View File

@@ -167,7 +167,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/framework/notification",
resolve: "@medusajs/medusa/notification",
options: {
providers: [
{

2
www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx
View File

@@ -704,7 +704,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/framework/payment",
resolve: "@medusajs/medusa/payment",
options: {
providers: [
{

2
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/auth-provider.ts
View File

@@ -59,7 +59,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/framework/auth",
resolve: "@medusajs/medusa/auth",
options: {
providers: [
{

2
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/fulfillment-provider.ts
View File

@@ -59,7 +59,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/framework/fulfillment",
resolve: "@medusajs/medusa/fulfillment",
options: {
providers: [
{

2
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/notification.ts
View File

@@ -69,7 +69,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/framework/notification",
resolve: "@medusajs/medusa/notification",
options: {
providers: [
{

2
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/payment-provider.ts
View File

@@ -68,7 +68,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/framework/payment",
resolve: "@medusajs/medusa/payment",
options: {
providers: [
{