How do I disable core modules?

[prakhar-perennial]

I am trying to build a customized system that will link to e-commerce websites and an ERP. Due to the nature of the project, some of the commerce modules are redundant and I would like to remove them. After a lot of searching and going through the documentation, I could not find a way to do it in the current version. But it seems that it was possible in the older versions by removing the dependencies from the package JSON. Was the feature removed or is there some new way of doing it now?

[Vallabh-Mahanta]

The feature is still available in the current version, but it's implemented differently than in older versions.

The available core modules that you can disable include:

1. Product
2. Cart
3. Order
4. Customer
5. Region
6. Sales Channel
7. Pricing
8. Promotion
9. Tax
10. Currency
11. Payment
12. Fulfillment
13. Inventory
14. Stock Location
    And more...

In your medusa-config.js or medusa-config.ts file, you can disable modules in two ways

File Location :
medusa/packages/core/types/src/common/config-module.ts
medusa/integration-tests/modules/medusa-config.js

• Set a module to false :

   module.exports = {
     modules: {
       [Modules.PRODUCT]: false,  // This will disable the product module
       [Modules.CART]: false,     // This will disable the cart module
       // ... other modules
     }
   }

• Use the disable property:

   module.exports = {
     modules: {
       [Modules.PRODUCT]: {
         disable: true
       },
       [Modules.CART]: {
         disable: true
       }
       // ... other modules
     }
   }

[prakhar-perennial]

Thanks for the quick reply. That is very helpful.

[Vallabh-Mahanta]

Glad it Helped!!!

[prakhar-perennial]

@Vallabh-Mahanta is this documented somewhere? The "modules" seems to be of type array not object.

module.exports = defineConfig({
  projectConfig: {
    databaseUrl: process.env.DATABASE_URL,
    http: {
      storeCors: process.env.STORE_CORS!,
      adminCors: process.env.ADMIN_CORS!,
      authCors: process.env.AUTH_CORS!,
      jwtSecret: process.env.JWT_SECRET || "supersecret",
      cookieSecret: process.env.COOKIE_SECRET || "supersecret",
    }
  },
  modules: [],
})

[Vallabh-Mahanta]

@prakhar-perennial The modules configuration in Medusa can be either an array or an object, but the recommended way is to use an object.

The reason for this is:

The type definition in packages/core/types/src/common/config-module.ts shows that modules is defined as:

modules?: Record<
  string,
  boolean | Partial<InternalModuleDeclaration | ExternalModuleDeclaration>
>

The resolveModules function in packages/core/utils/src/common/define-config.ts expects an object where each key is a module name and the value can be:

• boolean to enable/disable the module
• An object with module configuration options

The array format is kept for backward compatibility, but the object format is the recommended way as it provides better type safety.

I haven't seen any documentation for it, but the objects are mostly used everywhere in the codebase.

[prakhar-perennial]

Thanks for the detailed explanation. The example in the module section confused me.