docs: general fixes and improvements (#7918)

* docs improvements and changes

* updated module definition

* modules + dml changes

* fix build

* fix vale error

* fix lint errors

* fixes to stripe docs

* fix condition

* fix condition

* fix module defintion

* fix checkout

* disable UI action

* change oas preview action

* flatten provider module options

* fix lint errors

* add module link docs

* pr comments fixes

* fix vale error

* change node engine version

* links -> linkable

* add note about database name

* small fixes

* link fixes

* fix response code in api reference

* added migrations step

www/apps/resources/app/architectural-modules/cache/create/page.mdx

@@ -135,10 +135,11 @@ Create the file `src/modules/my-cache/index.ts` with the following content:
 
 ```ts title="src/modules/my-cache/index.ts"
 import MyCacheService from "./service"
+import { Module } from "@medusajs/utils"
 
-export default {
+export default Module("my-cache", {
   service: MyCacheService,
-}
+})
 ```
 
 This exports the module's definition, indicating that the `MyCacheService` is the main service of the module.
@@ -152,7 +153,7 @@ To use your Cache Module, add it to the `modules` object exported as part of the
 For example:
 
 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 

www/apps/resources/app/architectural-modules/cache/in-memory/page.mdx

@@ -31,7 +31,7 @@ npm install @medusajs/cache-inmemory
 Next, add the module into the `modules` property of the exported object in `medusa-config.js`:
 
 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 

www/apps/resources/app/architectural-modules/cache/redis/page.mdx

@@ -31,7 +31,7 @@ export const highlights = [
 ]
 
 ```js title="medusa-config.js" highlights={highlights}
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 

www/apps/resources/app/architectural-modules/event/create/page.mdx

@@ -88,12 +88,13 @@ class MyEventService extends AbstractEventBusModuleService {
 
 Create the file `src/modules/my-event/index.ts` with the following content:
 
-```ts
+```ts title="src/modules/my-event/index.ts"
 import MyEventService from "./service"
+import { Module } from "@medusajs/utils"
 
-export default {
+export default Module("my-event", {
   service: MyEventService,
-}
+})
 ```
 
 This exports the module's definition, indicating that the `MyEventService` is the main service of the module.
@@ -107,7 +108,7 @@ To use your Event Module, add it to the `modules` object exported as part of the
 For example:
 
 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 

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

@@ -29,7 +29,7 @@ npm install @medusajs/event-local
 Next, add the module into the `modules` property of the exported object in `medusa-config.js`:
 
 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 

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

@@ -35,7 +35,7 @@ export const highlights = [
 ]
 
 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 

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

@@ -33,7 +33,7 @@ The File Module accepts one provider only.
 </Note>
 
 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 
@@ -46,12 +46,9 @@ module.exports = {
         providers: [
           {
             resolve: "@medusajs/file-local-next",
+            id: "local",
             options: {
-              config: {
-                local: {
-                  // provider options...
-                },
-              },
+              // provider options...
             },
           },
         ],

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

@@ -85,7 +85,7 @@ The File Module accepts one provider only.
 </Note>
 
 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 
@@ -99,18 +99,15 @@ module.exports = {
         providers: [
           {
             resolve: "@medusajs/file-s3",
+            id: "s3",
             options: {
-              config: {
-                s3: {
-                  file_url: process.env.S3_FILE_URL,
-                  access_key_id: process.env.S3_ACCESS_KEY_ID,
-                  secret_access_key: process.env.S3_SECRET_ACCESS_KEY,
-                  region: process.env.S3_REGION,
-                  bucket: process.env.S3_BUCKET,
-                  endpoint: process.env.S3_ENDPOINT,
-                  // other options...
-                },
-              },
+              file_url: process.env.S3_FILE_URL,
+              access_key_id: process.env.S3_ACCESS_KEY_ID,
+              secret_access_key: process.env.S3_SECRET_ACCESS_KEY,
+              region: process.env.S3_REGION,
+              bucket: process.env.S3_BUCKET,
+              endpoint: process.env.S3_ENDPOINT,
+              // other options...
             },
           },
         ],

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

@@ -33,7 +33,7 @@ Only one provider can be defined for a channel.
 </Note>
 
 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 
@@ -47,12 +47,9 @@ module.exports = defineConfig({
           // ...
           {
             resolve: "@medusajs/notification-local",
+            id: "local",
             options: {
-              config: {
-                local: {
-                  channels: ["email"],
-                },
-              },
+              channels: ["email"],
             },
           },
         ],

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

@@ -31,7 +31,7 @@ When you send a notification, you specify the channel to send it through, such a
 For example:
 
 ```js title="medusa-config.js" highlights={[["19"]]}
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 
@@ -46,12 +46,9 @@ module.exports = {
           // ...
           {
             resolve: "@medusajs/notification-local",
+            id: "notification",
             options: {
-              config: {
-                local: {
-                  channels: ["email"],
-                },
-              },
+              channels: ["email"],
             },
           },
         ],

www/apps/resources/app/architectural-modules/notification/send-notification/page.mdx

@@ -33,7 +33,10 @@ export const highlights = [
 ]
 
 ```ts title="src/subscribers/product-created.ts" highlights={highlights} collapsibleLines="1-7" expandButtonLabel="Show Imports"
-import type { SubscriberArgs, SubscriberConfig } from "@medusajs/medusa"
+import type {
+  SubscriberArgs,
+  SubscriberConfig,
+} from "@medusajs/medusa"
 import { ModuleRegistrationName } from "@medusajs/utils"
 import { INotificationModuleService } from "@medusajs/types"
 

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

@@ -35,7 +35,7 @@ Only one provider can be defined for a channel.
 </Note>
 
 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 
@@ -49,14 +49,11 @@ module.exports = defineConfig({
           // ...
           {
             resolve: "@medusajs/notification-sendgrid",
+            id: "sendgrid",
             options: {
-              config: {
-                sendgrid: {
-                  channels: ["email"],
-                  api_key: process.env.SENDGRID_API_KEY,
-                  from: process.env.SENDGRID_FROM,
-                },
-              },
+              channels: ["email"],
+              api_key: process.env.SENDGRID_API_KEY,
+              from: process.env.SENDGRID_FROM,
             },
           },
         ],
@@ -130,7 +127,10 @@ export const highlights = [
 ]
 
 ```ts title="src/subscribers/product-created.ts" highlights={highlights} collapsibleLines="1-7" expandButtonLabel="Show Imports"
-import type { SubscriberArgs, SubscriberConfig } from "@medusajs/medusa"
+import type {
+  SubscriberArgs,
+  SubscriberConfig,
+} from "@medusajs/medusa"
 import { ModuleRegistrationName } from "@medusajs/utils"
 import { INotificationModuleService } from "@medusajs/types"
 

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

@@ -31,7 +31,7 @@ npm install @medusajs/workflow-engine-inmemory
 Next, add the module into the `modules` property of the exported object in `medusa-config.js`:
 
 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 

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

@@ -31,7 +31,7 @@ export const highlights = [
 ]
 
 ```js title="medusa-config.js" highlights={highlights}
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"
 
 // ...
 
@@ -42,7 +42,7 @@ module.exports = defineConfig({
       resolve: "@medusajs/workflow-engine-redis",
       options: {
         redis: {
-          url: process.emv.WE_REDIS_URL,
+          url: process.env.WE_REDIS_URL,
         },
       },
     },