feat(): Add modules options autocomplete to medusa config (#14465)

* feat(): Add modules options autocomplete to medusa config

* feat(): Add modules options autocomplete to medusa config

* Create great-lies-decide.md

* feat(): Add modules options autocomplete to medusa config

.changeset/great-lies-decide.md

@@ -0,0 +1,14 @@
+---
+"@medusajs/analytics": patch
+"@medusajs/auth": patch
+"@medusajs/cache-redis": patch
+"@medusajs/caching": patch
+"@medusajs/event-bus-redis": patch
+"@medusajs/file": patch
+"@medusajs/locking": patch
+"@medusajs/notification": patch
+"@medusajs/payment": patch
+"@medusajs/workflow-engine-redis": patch
+---
+
+feat(): Add modules options autocomplete to medusa config

packages/modules/analytics/src/index.ts

@@ -1,3 +1,4 @@
+import "./types"
 import { Module, Modules } from "@medusajs/framework/utils"
 import AnalyticsService from "./services/analytics-service"
 import loadProviders from "./loaders/providers"

packages/modules/analytics/src/types/index.ts

@@ -22,3 +22,10 @@ export type AnalyticsModuleOptions = Partial<ModuleServiceInitializeOptions> & {
     options?: Record<string, unknown>
   }[]
 }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/analytics": AnalyticsModuleOptions
+    "@medusajs/medusa/analytics": AnalyticsModuleOptions
+  }
+}

packages/modules/auth/src/index.ts

@@ -1,3 +1,4 @@
+import "./types"
 import { AuthModuleService } from "@services"
 import loadProviders from "./loaders/providers"
 import { Module, Modules } from "@medusajs/framework/utils"

packages/modules/auth/src/types/index.ts

@@ -46,3 +46,10 @@ export interface MedusaCloudAuthProviderOptions {
   callback_url: string
   disabled: boolean
 }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/auth": AuthModuleOptions
+    "@medusajs/medusa/auth": AuthModuleOptions
+  }
+}

packages/modules/cache-inmemory/src/types/index.ts

@@ -15,3 +15,10 @@ export type InMemoryCacheModuleOptions = {
    */
   ttl?: number
 }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/cache-inmemory": InMemoryCacheModuleOptions
+    "@medusajs/medusa/cache-inmemory": InMemoryCacheModuleOptions
+  }
+}

packages/modules/cache-redis/src/types/index.ts

@@ -25,3 +25,10 @@ export type RedisCacheModuleOptions = {
    */
   namespace?: string
 }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/cache-redis": RedisCacheModuleOptions
+    "@medusajs/medusa/cache-redis": RedisCacheModuleOptions
+  }
+}

packages/modules/caching/src/index.ts

@@ -1,3 +1,4 @@
+import "./types"
 import { Module, Modules } from "@medusajs/framework/utils"
 import { default as loadHash } from "./loaders/hash"
 import { default as loadProviders } from "./loaders/providers"

packages/modules/caching/src/types/index.ts

@@ -88,3 +88,10 @@ export type CachingModuleOptions = Partial<ModuleServiceInitializeOptions> & {
     options?: Record<string, unknown>
   }[]
 }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/caching": CachingModuleOptions
+    "@medusajs/medusa/caching": CachingModuleOptions
+  }
+}

packages/modules/event-bus-redis/src/types/index.ts

@@ -69,3 +69,10 @@ export type EventBusRedisModuleOptions = {
    */
   jobOptions?: EmitOptions
 }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/event-bus-redis": EventBusRedisModuleOptions
+    "@medusajs/medusa/event-bus-redis": EventBusRedisModuleOptions
+  }
+}

packages/modules/file/src/index.ts

@@ -1,3 +1,4 @@
+import "./types"
 import { FileModuleService } from "@services"
 import loadProviders from "./loaders/providers"
 import { Module, Modules } from "@medusajs/framework/utils"

packages/modules/file/src/types/index.ts

@@ -27,3 +27,10 @@ export type FileModuleOptions = Partial<ModuleServiceInitializeOptions> & {
     options?: Record<string, unknown>
   }
 }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/file": FileModuleOptions
+    "@medusajs/medusa/file": FileModuleOptions
+  }
+}

packages/modules/fulfillment/src/index.ts

@@ -1,3 +1,4 @@
+import "./types"
 import { FulfillmentModuleService } from "@services"
 import loadProviders from "./loaders/providers"
 import { Module, Modules } from "@medusajs/framework/utils"

packages/modules/fulfillment/src/types/index.ts

@@ -33,3 +33,10 @@ export type FulfillmentModuleOptions =
       options?: Record<string, unknown>
     }[]
   }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/fulfillment": FulfillmentModuleOptions
+    "@medusajs/medusa/fulfillment": FulfillmentModuleOptions
+  }
+}

packages/modules/locking/src/index.ts

@@ -1,3 +1,4 @@
+import "./types"
 import { Module, Modules } from "@medusajs/framework/utils"
 import { default as loadProviders } from "./loaders/providers"
 import LockingModuleService from "./services/locking-module"

packages/modules/locking/src/types/index.ts

@@ -31,3 +31,10 @@ export type LockingModuleOptions = Partial<ModuleServiceInitializeOptions> & {
     options?: Record<string, unknown>
   }[]
 }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/locking": LockingModuleOptions
+    "@medusajs/medusa/locking": LockingModuleOptions
+  }
+}

packages/modules/notification/src/index.ts

@@ -1,3 +1,4 @@
+import "./types"
 import { NotificationModuleService } from "@services"
 import loadProviders from "./loaders/providers"
 import { Module, Modules } from "@medusajs/framework/utils"

packages/modules/notification/src/types/index.ts

@@ -45,3 +45,10 @@ export type MedusaCloudEmailOptions = {
   environment_handle?: string
   sandbox_handle?: string
 }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/notification": NotificationModuleOptions
+    "@medusajs/medusa/notification": NotificationModuleOptions
+  }
+}

packages/modules/payment/src/index.ts

@@ -1,3 +1,4 @@
+import "./types"
 import { PaymentModuleService } from "@services"
 import loadProviders from "./loaders/providers"
 import { Module, Modules } from "@medusajs/framework/utils"

packages/modules/payment/src/types/index.ts

@@ -27,3 +27,10 @@ export type PaymentModuleOptions = Partial<ModuleServiceInitializeOptions> & {
     options?: Record<string, unknown>
   }[]
 }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/payment": PaymentModuleOptions
+    "@medusajs/medusa/payment": PaymentModuleOptions
+  }
+}

packages/modules/workflow-engine-redis/src/index.ts

@@ -1,3 +1,4 @@
+import "./types"
 import { Module, Modules } from "@medusajs/framework/utils"
 import { WorkflowsModuleService } from "@services"
 import { loadUtils, redisConnection } from "./loaders"

packages/modules/workflow-engine-redis/src/types/index.ts

@@ -177,3 +177,10 @@ export type RedisWorkflowsOptions = {
     options?: RedisOptions
   }
 }
+
+declare module "@medusajs/types" {
+  interface ModuleOptions {
+    "@medusajs/workflow-engine-redis": RedisWorkflowsOptions
+    "@medusajs/medusa/workflow-engine-redis": RedisWorkflowsOptions
+  }
+}