The complete open source platform to run your entire marketplace. Storefront, vendor panel, admin console, and integrations in one enterprise-grade platform you own.
Custom Module
A module is a package of reusable functionalities. It can be integrated into your Medusa application without affecting the overall system. You can create a module as part of a plugin.
Learn more about modules in this documentation.
To create a module:
1. Create a Data Model
A data model represents a table in the database. You create a data model in a TypeScript or JavaScript file under the models directory of a module.
For example, create the file src/modules/blog/models/post.ts with the following content:
import { model } from "@medusajs/framework/utils"
const Post = model.define("post", {
id: model.id().primaryKey(),
title: model.text(),
})
export default Post
2. Create a Service
A module must define a service. A service is a TypeScript or JavaScript class holding methods related to a business logic or commerce functionality.
For example, create the file src/modules/blog/service.ts with the following content:
import { MedusaService } from "@medusajs/framework/utils"
import Post from "./models/post"
class BlogModuleService extends MedusaService({
Post,
}){
}
export default BlogModuleService
3. Export Module Definition
A module must have an index.ts file in its root directory that exports its definition. The definition specifies the main service of the module.
For example, create the file src/modules/blog/index.ts with the following content:
import BlogModuleService from "./service"
import { Module } from "@medusajs/framework/utils"
export const BLOG_MODULE = "blog"
export default Module(BLOG_MODULE, {
service: BlogModuleService,
})
4. Generate Migrations
To generate migrations for your module, run the following command in the plugin's directory:
npx medusa plugin:db:genreate
Use Module
You can use the module in customizations within the plugin or within the Medusa application using this plugin. When the plugin is added to a Medusa application, all its modules are registered as well.
For example, to use the module in an API route:
import { MedusaRequest, MedusaResponse } from "@medusajs/framework"
import BlogModuleService from "../../../modules/blog/service"
import { BLOG_MODULE } from "../../../modules/blog"
export async function GET(
req: MedusaRequest,
res: MedusaResponse
): Promise<void> {
const blogModuleService: BlogModuleService = req.scope.resolve(
BLOG_MODULE
)
const posts = await blogModuleService.listPosts()
res.json({
posts
})
}
Module Options
When you register the plugin in the Medusa application, it can accept options. These options are passed to the modules within the plugin:
import { defineConfig } from "@medusajs/framework/utils"
module.exports = defineConfig({
// ...
plugins: [
{
resolve: "@myorg/plugin-name",
options: {
apiKey: process.env.API_KEY,
},
},
],
})
Learn more about module options in this documentation.