{ "$schema": "https://registry.mercurjs.com/registry.json", "name": "@mercurjs", "homepage": "https://mercurjs.com", "items": [ { "name": "reviews", "description": "A review system with product and seller reviews, ratings, customer/vendor/admin API routes, and workflows.", "dependencies": [], "registryDependencies": [], "docs": "## Configuration\n\nAdd the review module to your `medusa-config.ts`:\n\n```ts\nmodules: [\n {\n resolve: './modules/reviews',\n },\n]\n```\n\n## Middlewares\n\nAdd the review middlewares to your `api/middlewares.ts`:\n\n```ts\nimport { defineMiddlewares } from \"@medusajs/medusa\";\nimport { adminReviewsMiddlewares } from \"./admin/reviews/middlewares\";\nimport { vendorReviewsMiddlewares } from \"./vendor/reviews/middlewares\";\nimport { storeReviewMiddlewares } from \"./store/reviews/middlewares\";\n\nexport default defineMiddlewares({\n routes: [...adminReviewsMiddlewares, ...vendorReviewsMiddlewares, ...storeReviewMiddlewares],\n});\n```\n\nIf you already have a `middlewares.ts` file, merge the review middleware imports and spread them into your existing `routes` array.\n\n## Database Migrations\n\nAfter installing the block and adding the module configuration, generate and run the migrations to create the necessary tables in your database:\n\n```bash\nnpx medusa db:generate reviews\nnpx medusa db:migrate\n```", "files": [ { "path": "reviews/modules/reviews/index.ts", "type": "registry:api" }, { "path": "reviews/modules/reviews/service.ts", "type": "registry:api" }, { "path": "reviews/modules/reviews/models/review.ts", "type": "registry:api" }, { "path": "reviews/modules/reviews/types/index.ts", "type": "registry:api" }, { "path": "reviews/modules/reviews/types/common.ts", "type": "registry:api" }, { "path": "reviews/modules/reviews/types/mutations.ts", "type": "registry:api" }, { "path": "reviews/links/customer-review.ts", "type": "registry:api" }, { "path": "reviews/links/order-review.ts", "type": "registry:api" }, { "path": "reviews/links/product-review.ts", "type": "registry:api" }, { "path": "reviews/links/seller-review.ts", "type": "registry:api" }, { "path": "reviews/workflows/review/index.ts", "type": "registry:api" }, { "path": "reviews/workflows/review/steps/index.ts", "type": "registry:api" }, { "path": "reviews/workflows/review/steps/create-review.ts", "type": "registry:api" }, { "path": "reviews/workflows/review/steps/update-review.ts", "type": "registry:api" }, { "path": "reviews/workflows/review/steps/delete-review.ts", "type": "registry:api" }, { "path": "reviews/workflows/review/steps/validate-review.ts", "type": "registry:api" }, { "path": "reviews/workflows/review/workflows/index.ts", "type": "registry:api" }, { "path": "reviews/workflows/review/workflows/create-review.ts", "type": "registry:api" }, { "path": "reviews/workflows/review/workflows/update-review.ts", "type": "registry:api" }, { "path": "reviews/workflows/review/workflows/delete-review.ts", "type": "registry:api" }, { "path": "reviews/api/admin/reviews/route.ts", "type": "registry:api" }, { "path": "reviews/api/admin/reviews/middlewares.ts", "type": "registry:api" }, { "path": "reviews/api/admin/reviews/query-config.ts", "type": "registry:api" }, { "path": "reviews/api/admin/reviews/validators.ts", "type": "registry:api" }, { "path": "reviews/api/admin/reviews/[id]/route.ts", "type": "registry:api" }, { "path": "reviews/api/store/reviews/route.ts", "type": "registry:api" }, { "path": "reviews/api/store/reviews/middlewares.ts", "type": "registry:api" }, { "path": "reviews/api/store/reviews/helpers.ts", "type": "registry:api" }, { "path": "reviews/api/store/reviews/query-config.ts", "type": "registry:api" }, { "path": "reviews/api/store/reviews/validators.ts", "type": "registry:api" }, { "path": "reviews/api/store/reviews/[id]/route.ts", "type": "registry:api" }, { "path": "reviews/api/vendor/reviews/middlewares.ts", "type": "registry:api" }, { "path": "reviews/api/vendor/reviews/helpers.ts", "type": "registry:api" }, { "path": "reviews/api/vendor/reviews/query-config.ts", "type": "registry:api" }, { "path": "reviews/api/vendor/reviews/validators.ts", "type": "registry:api" }, { "path": "reviews/api/vendor/reviews/route.ts", "type": "registry:api" }, { "path": "reviews/api/vendor/reviews/[id]/route.ts", "type": "registry:api" }, { "path": "reviews/vendor/hooks/api/reviews.tsx", "type": "registry:vendor" }, { "path": "reviews/vendor/hooks/table/columns/use-review-table-columns.tsx", "type": "registry:vendor" }, { "path": "reviews/vendor/hooks/table/filters/use-review-table-filters.tsx", "type": "registry:vendor" }, { "path": "reviews/vendor/hooks/table/query/use-review-table-query.tsx", "type": "registry:vendor" }, { "path": "reviews/vendor/routes/reviews/page.tsx", "type": "registry:vendor" }, { "path": "reviews/vendor/routes/reviews/[id]/page.tsx", "type": "registry:vendor" }, { "path": "reviews/vendor/routes/reviews/[id]/breadcrumb.tsx", "type": "registry:vendor" }, { "path": "reviews/admin/hooks/api/reviews.tsx", "type": "registry:admin" }, { "path": "reviews/admin/hooks/table/columns/use-review-table-columns.tsx", "type": "registry:admin" }, { "path": "reviews/admin/hooks/table/filters/use-review-table-filters.tsx", "type": "registry:admin" }, { "path": "reviews/admin/hooks/table/query/use-review-table-query.tsx", "type": "registry:admin" }, { "path": "reviews/admin/routes/reviews/page.tsx", "type": "registry:admin" }, { "path": "reviews/admin/routes/reviews/[id]/page.tsx", "type": "registry:admin" }, { "path": "reviews/admin/routes/reviews/[id]/breadcrumb.tsx", "type": "registry:admin" } ], "categories": [ "reviews" ] }, { "name": "product-import-export", "description": "CSV product import & export for vendors. Includes API routes, workflows, and vendor portal drawers.", "dependencies": [ "multer", "@types/multer", "@medusajs/core-flows" ], "registryDependencies": [], "docs": "## Product Import/Export Block\n\n### Dependencies\n\nInstall dependencies in the **API workspace** (not the project root):\n\n```bash\ncd packages/api\nbun add @medusajs/core-flows multer @types/multer\n```\n\n### Configuration\n\nNo additional modules needed \u2014 uses built-in Medusa product CSV steps.\n\n### Middleware Setup\n\nAdd the import middleware to your `api/middlewares.ts`:\n\n```ts\nimport { defineMiddlewares } from '@medusajs/medusa'\nimport { productImportExportMiddlewares } from './vendor/products/middlewares'\n\nexport default defineMiddlewares({\n routes: [...productImportExportMiddlewares],\n})\n```\n\n### Run codegen\n\nAfter installing the block, regenerate SDK types:\n\n```bash\nnpx @mercurjs/cli@latest codegen\n```\n\n### Vendor Navigation\n\nThe block includes a `products/page.tsx` that overrides the default product list page, adding Import and Export buttons in the header. The buttons open drawer routes at `/products/import` and `/products/export`.", "files": [ { "path": "product-import-export/workflows/steps/get-seller-products.ts", "type": "registry:api" }, { "path": "product-import-export/workflows/steps/validate-products-to-import.ts", "type": "registry:api" }, { "path": "product-import-export/workflows/import-seller-products.ts", "type": "registry:api" }, { "path": "product-import-export/workflows/export-seller-products.ts", "type": "registry:api" }, { "path": "product-import-export/api/vendor/products/import/route.ts", "type": "registry:api" }, { "path": "product-import-export/api/vendor/products/export/route.ts", "type": "registry:api" }, { "path": "product-import-export/api/vendor/products/helpers/helpers.ts", "type": "registry:api" }, { "path": "product-import-export/api/vendor/products/middlewares.ts", "type": "registry:api" }, { "path": "product-import-export/vendor/hooks/api/product-import-export.tsx", "type": "registry:vendor" }, { "path": "product-import-export/vendor/routes/products/page.tsx", "type": "registry:vendor" }, { "path": "product-import-export/vendor/routes/products/import/page.tsx", "type": "registry:vendor" }, { "path": "product-import-export/vendor/routes/products/import/components/upload-import.tsx", "type": "registry:vendor" }, { "path": "product-import-export/vendor/routes/products/import/components/import-summary.tsx", "type": "registry:vendor" }, { "path": "product-import-export/vendor/routes/products/import/helpers/import-template.ts", "type": "registry:vendor" }, { "path": "product-import-export/vendor/routes/products/export/page.tsx", "type": "registry:vendor" } ], "categories": [ "api", "workflow", "vendor" ] }, { "name": "wishlist", "description": "Customer wishlist with product bookmarking, pricing context, and store API endpoints.", "dependencies": [], "registryDependencies": [], "docs": "## Configuration\n\nAdd the wishlist module to your `medusa-config.ts`:\n\n```ts\nmodules: [\n {\n resolve: './modules/wishlist',\n },\n]\n```\n\n## Database Migrations\n\nAfter installing the block and adding the module configuration, generate and run the migrations to create the necessary tables in your database:\n\n```bash\nnpx medusa db:generate wishlist\nnpx medusa db:migrate\n```\n\n## Middlewares\n\nAdd the wishlist middlewares to your `api/middlewares.ts`:\n\n```ts\nimport { defineMiddlewares } from \"@medusajs/medusa\";\nimport { storeWishlistMiddlewares } from \"./store/wishlist/middlewares\";\n\nexport default defineMiddlewares({\n routes: [...storeWishlistMiddlewares],\n});\n```\n\nIf you already have a `middlewares.ts` file, merge the wishlist middleware imports and spread them into your existing `routes` array.\n\n## Run codegen\n\nAfter installing the block, regenerate SDK types:\n\n```bash\nnpx @mercurjs/cli@latest codegen\n```", "files": [ { "path": "wishlist/modules/wishlist/index.ts", "type": "registry:api" }, { "path": "wishlist/modules/wishlist/service.ts", "type": "registry:api" }, { "path": "wishlist/modules/wishlist/models/wishlist.ts", "type": "registry:api" }, { "path": "wishlist/modules/wishlist/types.ts", "type": "registry:api" }, { "path": "wishlist/modules/wishlist/utils.ts", "type": "registry:api" }, { "path": "wishlist/links/customer-wishlist.ts", "type": "registry:api" }, { "path": "wishlist/links/wishlist-product.ts", "type": "registry:api" }, { "path": "wishlist/workflows/wishlist/steps/create-wishlist.ts", "type": "registry:api" }, { "path": "wishlist/workflows/wishlist/steps/delete-wishlist.ts", "type": "registry:api" }, { "path": "wishlist/workflows/wishlist/workflows/create-wishlist.ts", "type": "registry:api" }, { "path": "wishlist/workflows/wishlist/workflows/delete-wishlist.ts", "type": "registry:api" }, { "path": "wishlist/api/middlewares.ts", "type": "registry:api" }, { "path": "wishlist/api/store/wishlist/route.ts", "type": "registry:api" }, { "path": "wishlist/api/store/wishlist/middlewares.ts", "type": "registry:api" }, { "path": "wishlist/api/store/wishlist/validators.ts", "type": "registry:api" }, { "path": "wishlist/api/store/wishlist/query-config.ts", "type": "registry:api" }, { "path": "wishlist/api/store/wishlist/product/[reference_id]/route.ts", "type": "registry:api" } ], "categories": [ "module", "workflow", "api" ] }, { "name": "vendor-notifications", "description": "Vendor notification feed with bell icon in navbar and vendor API endpoint.", "dependencies": [], "registryDependencies": [], "docs": "## Vendor Notifications\n\nThis block adds vendor notifications: a bell icon in the navbar and a `GET /vendor/notifications` API endpoint.\n\n### 1. Notification Provider\n\nAdd the `seller_feed` channel to the local notification provider in `medusa-config.ts`:\n\n```ts\n{\n resolve: '@medusajs/medusa/notification',\n options: {\n providers: [\n {\n resolve: '@medusajs/medusa/notification-local',\n id: 'local',\n options: {\n channels: ['feed', 'seller_feed']\n }\n }\n ]\n }\n}\n```\n\n### 2. Middleware Setup\n\nImport `vendorNotificationMiddlewares` and add it to your `src/api/middlewares.ts`:\n\n```ts\nimport { defineMiddlewares } from \"@medusajs/medusa\";\nimport { vendorNotificationMiddlewares } from \"./vendor/notifications/middlewares\";\n\nexport default defineMiddlewares({\n routes: [\n // ...your existing middlewares,\n ...vendorNotificationMiddlewares,\n ],\n});\n```\n\n### 3. TopbarActions Component\n\nRegister the `TopbarActions` component in your vendor app's `vite.config.ts`:\n\n```ts\nimport { mercurDashboardPlugin } from '@mercurjs/dashboard-sdk'\n\nexport default defineConfig({\n plugins: [\n react(),\n mercurDashboardPlugin({\n medusaConfigPath: '../../packages/api/medusa-config.ts',\n components: {\n TopbarActions: './components/topbar-actions',\n },\n }),\n ],\n})\n```\n\n### 4. Sending Notifications\n\nCreate a subscriber to send notifications to sellers. Example (`src/subscribers/seller-product-notification.ts`):\n\n```ts\nimport type { SubscriberArgs, SubscriberConfig } from \"@medusajs/framework\"\nimport { ContainerRegistrationKeys, Modules } from \"@medusajs/framework/utils\"\n\nexport default async function handler({\n event: { data },\n container,\n}: SubscriberArgs<{ id: string }>) {\n const query = container.resolve(ContainerRegistrationKeys.QUERY)\n const notificationService = container.resolve(Modules.NOTIFICATION)\n\n // Example: look up the seller linked to a product\n const { data: [product] } = await query.graph({\n entity: \"product\",\n fields: [\"id\", \"title\", \"seller.*\"],\n filters: { id: data.id },\n })\n\n if (!product?.seller?.id) return\n\n await notificationService.createNotifications({\n to: product.seller.id,\n channel: \"seller_feed\",\n template: \"product-created\",\n data: {\n title: \"Product created\",\n description: `Your product \\\"${product.title}\\\" has been created.`,\n },\n })\n}\n\nexport const config: SubscriberConfig = {\n event: \"product.created\",\n}\n```\n\n### 5. Run codegen\n\n```bash\nnpx @mercurjs/cli@latest codegen\n```", "files": [ { "path": "vendor-notifications/api/middlewares.ts", "type": "registry:api" }, { "path": "vendor-notifications/api/vendor/notifications/route.ts", "type": "registry:api" }, { "path": "vendor-notifications/api/vendor/notifications/middlewares.ts", "type": "registry:api" }, { "path": "vendor-notifications/api/vendor/notifications/validators.ts", "type": "registry:api" }, { "path": "vendor-notifications/api/vendor/notifications/query-config.ts", "type": "registry:api" }, { "path": "vendor-notifications/api/vendor/notifications/helpers.ts", "type": "registry:api" }, { "path": "vendor-notifications/vendor/components/topbar-actions.tsx", "type": "registry:vendor" } ], "categories": [ "api", "vendor" ] }, { "name": "algolia", "description": "Algolia search integration with product indexing, event-driven sync, and store search API.", "dependencies": [ "algoliasearch" ], "registryDependencies": [], "docs": "## Configuration\n\nAdd the algolia module to your `medusa-config.ts`:\n\n```ts\nmodules: [\n {\n resolve: './modules/algolia',\n options: {\n appId: process.env.ALGOLIA_APP_ID,\n apiKey: process.env.ALGOLIA_API_KEY,\n },\n },\n]\n```\n\n## Environment Variables\n\n```\nALGOLIA_APP_ID=your_algolia_app_id\nALGOLIA_API_KEY=your_algolia_admin_api_key\n```\n\n## Middlewares\n\nAdd algolia middlewares to your `api/middlewares.ts`:\n\n```ts\nimport { defineMiddlewares } from \"@medusajs/medusa\";\nimport { algoliaMiddlewares } from \"./store/products/search/middlewares\";\n\nexport default defineMiddlewares({\n routes: [...algoliaMiddlewares],\n});\n```\n\nIf you already have a `middlewares.ts` file, merge the algolia middleware imports and spread them into your existing `routes` array.\n\n## Database Migrations\n\nAfter installing the block, run migrations for the new links:\n\n```bash\nnpx medusa db:migrate\n```\n\n## Run codegen\n\nAfter installing, regenerate SDK types:\n\n```bash\nnpx @mercurjs/cli@latest codegen\n```", "files": [ { "path": "algolia/modules/algolia/index.ts", "type": "registry:api" }, { "path": "algolia/modules/algolia/service.ts", "type": "registry:api" }, { "path": "algolia/modules/algolia/types.ts", "type": "registry:api" }, { "path": "algolia/workflows/algolia/steps/sync-algolia-products.ts", "type": "registry:api" }, { "path": "algolia/workflows/algolia/workflows/sync-algolia.ts", "type": "registry:api" }, { "path": "algolia/subscribers/algolia-product-events-bridge.ts", "type": "registry:api" }, { "path": "algolia/subscribers/algolia-products-changed.ts", "type": "registry:api" }, { "path": "algolia/subscribers/algolia-products-deleted.ts", "type": "registry:api" }, { "path": "algolia/subscribers/utils/algolia-product.ts", "type": "registry:api" }, { "path": "algolia/subscribers/algolia-fulfillment-set-changed.ts", "type": "registry:api" }, { "path": "algolia/subscribers/algolia-inventory-item-changed.ts", "type": "registry:api" }, { "path": "algolia/subscribers/algolia-service-zone-changed.ts", "type": "registry:api" }, { "path": "algolia/subscribers/algolia-shipping-option-changed.ts", "type": "registry:api" }, { "path": "algolia/subscribers/algolia-stock-location-changed.ts", "type": "registry:api" }, { "path": "algolia/api/middlewares.ts", "type": "registry:api" }, { "path": "algolia/api/admin/algolia/route.ts", "type": "registry:api" }, { "path": "algolia/api/store/products/search/route.ts", "type": "registry:api" }, { "path": "algolia/api/store/products/search/middlewares.ts", "type": "registry:api" }, { "path": "algolia/api/store/products/search/validators.ts", "type": "registry:api" } ], "categories": [ "module", "workflow", "api", "link" ] }, { "name": "requests", "description": "Admin approval system powered by the Custom Fields module. Admins can list, review, accept or reject entity requests.", "dependencies": [], "registryDependencies": [], "docs": "## Prerequisites\n\nThis block requires the **Custom Fields module** (`@mercurjs/core/modules/custom-fields`). Make sure it is registered in your `medusa-config.ts`.\n\n## Configuration\n\nAdd request-related custom fields to the entities you want to support approval workflows for. Product already has a built-in `status` field, so you only need to configure custom fields for other entities.\n\nAdd these fields to your Custom Fields module options in `medusa-config.ts`:\n\n```ts\n{\n resolve: \"@mercurjs/core/modules/custom-fields\",\n options: {\n customFields: {\n ProductCollection: {\n request_status: {\n type: \"enum\",\n enum: [\"draft\", \"pending\", \"accepted\", \"rejected\"],\n defaultValue: \"draft\",\n },\n submitter_id: { type: \"string\", nullable: true },\n reviewer_id: { type: \"string\", nullable: true },\n reviewer_note: { type: \"text\", nullable: true },\n },\n // Add the same fields to other entities as needed:\n // ProductCategory, ProductType, ProductTag\n },\n },\n}\n```\n\n## Middlewares\n\nAdd the request middlewares to your `api/middlewares.ts`:\n\n```ts\nimport { defineMiddlewares } from \"@medusajs/medusa\";\nimport { adminRequestsMiddlewares } from \"./admin/requests/middlewares\";\nimport { vendorProductCollectionRequestsMiddlewares } from \"./vendor/requests/product-collections/middlewares\";\nimport { vendorProductCategoryRequestsMiddlewares } from \"./vendor/requests/product-categories/middlewares\";\nimport { vendorProductTypeRequestsMiddlewares } from \"./vendor/requests/product-types/middlewares\";\nimport { vendorProductTagRequestsMiddlewares } from \"./vendor/requests/product-tags/middlewares\";\n\nexport default defineMiddlewares({\n routes: [\n ...adminRequestsMiddlewares,\n ...vendorProductCollectionRequestsMiddlewares,\n ...vendorProductCategoryRequestsMiddlewares,\n ...vendorProductTypeRequestsMiddlewares,\n ...vendorProductTagRequestsMiddlewares,\n ],\n});\n```\n\nIf you already have a `middlewares.ts` file, merge the middleware imports and spread them into your existing `routes` array.\n\n## Database Migrations\n\nAfter updating the custom fields configuration, run migrations:\n\n```bash\nnpx medusa db:migrate\n```\n\n## Run codegen\n\nAfter installing the block, regenerate SDK types:\n\n```bash\nnpx @mercurjs/cli@latest codegen\n```\n\n## API Endpoints\n\n### Admin\n\n- `GET /admin/requests/:type` \u2014 List entities with request custom fields (filterable by `request_status`, `submitter_id`)\n- `GET /admin/requests/:type/:id` \u2014 Retrieve entity with request custom fields\n- `POST /admin/requests/:type/:id/accept` \u2014 Accept a request\n- `POST /admin/requests/:type/:id/reject` \u2014 Reject a request\n\nSupported `:type` values: `product_collection`, `product_category`, `product_type`, `product_tag`\n\n### Vendor\n\n- `GET /vendor/requests/product-collections` \u2014 List vendor's collection requests\n- `POST /vendor/requests/product-collections` \u2014 Create a collection request\n- `GET /vendor/requests/product-categories` \u2014 List vendor's category requests\n- `POST /vendor/requests/product-categories` \u2014 Create a category request\n- `GET /vendor/requests/product-types` \u2014 List vendor's type requests\n- `POST /vendor/requests/product-types` \u2014 Create a type request\n- `GET /vendor/requests/product-tags` \u2014 List vendor's tag requests\n- `POST /vendor/requests/product-tags` \u2014 Create a tag request", "files": [ { "path": "requests/types/index.ts", "type": "registry:api" }, { "path": "requests/workflows/requests/steps/index.ts", "type": "registry:api" }, { "path": "requests/workflows/requests/steps/validate-request-status.ts", "type": "registry:api" }, { "path": "requests/workflows/requests/workflows/index.ts", "type": "registry:api" }, { "path": "requests/workflows/requests/workflows/accept-request.ts", "type": "registry:api" }, { "path": "requests/workflows/requests/workflows/reject-request.ts", "type": "registry:api" }, { "path": "requests/workflows/requests/workflows/create-product-collection-request.ts", "type": "registry:api" }, { "path": "requests/api/admin/requests/validators.ts", "type": "registry:api" }, { "path": "requests/api/admin/requests/query-config.ts", "type": "registry:api" }, { "path": "requests/api/admin/requests/middlewares.ts", "type": "registry:api" }, { "path": "requests/api/admin/requests/[type]/route.ts", "type": "registry:api" }, { "path": "requests/api/admin/requests/[type]/[id]/route.ts", "type": "registry:api" }, { "path": "requests/api/admin/requests/[type]/[id]/accept/route.ts", "type": "registry:api" }, { "path": "requests/api/admin/requests/[type]/[id]/reject/route.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-collections/route.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-collections/validators.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-collections/query-config.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-collections/middlewares.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-collections/helpers.ts", "type": "registry:api" }, { "path": "requests/workflows/requests/workflows/create-product-category-request.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-categories/route.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-categories/validators.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-categories/query-config.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-categories/middlewares.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-categories/helpers.ts", "type": "registry:api" }, { "path": "requests/workflows/requests/workflows/create-product-type-request.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-types/route.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-types/validators.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-types/query-config.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-types/middlewares.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-types/helpers.ts", "type": "registry:api" }, { "path": "requests/workflows/requests/workflows/create-product-tag-request.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-tags/route.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-tags/validators.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-tags/query-config.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-tags/middlewares.ts", "type": "registry:api" }, { "path": "requests/api/vendor/requests/product-tags/helpers.ts", "type": "registry:api" }, { "path": "requests/api/store/requests/helpers.ts", "type": "registry:api" }, { "path": "requests/api/store/requests/middlewares.ts", "type": "registry:api" }, { "path": "requests/workflows/hooks/seller-created.ts", "type": "registry:api" }, { "path": "requests/admin/hooks/api/requests.tsx", "type": "registry:admin" }, { "path": "requests/admin/hooks/table/columns/use-request-table-columns.tsx", "type": "registry:admin" }, { "path": "requests/admin/hooks/table/filters/use-request-table-filters.tsx", "type": "registry:admin" }, { "path": "requests/admin/hooks/table/query/use-request-table-query.tsx", "type": "registry:admin" }, { "path": "requests/admin/routes/requests/page.tsx", "type": "registry:admin" }, { "path": "requests/admin/routes/requests/categories/page.tsx", "type": "registry:admin" }, { "path": "requests/admin/routes/requests/collections/page.tsx", "type": "registry:admin" }, { "path": "requests/admin/routes/requests/tags/page.tsx", "type": "registry:admin" }, { "path": "requests/admin/routes/requests/types/page.tsx", "type": "registry:admin" }, { "path": "requests/admin/routes/requests/[type]/[id]/page.tsx", "type": "registry:admin" }, { "path": "requests/vendor/hooks/api/requests.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/hooks/table/columns/use-request-table-columns.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/hooks/table/filters/use-request-table-filters.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/hooks/table/query/use-request-table-query.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/routes/requests/page.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/routes/requests/categories/page.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/routes/requests/categories/create/page.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/routes/requests/collections/page.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/routes/requests/collections/create/page.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/routes/requests/tags/page.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/routes/requests/tags/create/page.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/routes/requests/types/page.tsx", "type": "registry:vendor" }, { "path": "requests/vendor/routes/requests/types/create/page.tsx", "type": "registry:vendor" } ], "categories": [ "api", "workflow" ] }, { "name": "vendor-chat", "description": "TalkJS chat integration for vendors. Provides a vendor API endpoint to retrieve seller conversations from TalkJS.", "dependencies": [ "@talkjs/react" ], "registryDependencies": [], "docs": "## Vendor Chat (TalkJS)\n\nThis block adds a TalkJS chat integration for vendors, exposing a `GET /vendor/talkjs` endpoint that retrieves conversations for the authenticated seller and a Messages page in the vendor portal.\n\n### Environment Variables\n\nAdd the following to your `.env`:\n\n```\nVITE_TALK_JS_APP_ID=your_talkjs_app_id\nTALKJS_SECRET_API_KEY=your_talkjs_secret_api_key\n```\n\n### Vite Configuration\n\nAdd the `__TALK_JS_APP_ID__` define to your vendor portal's `vite.config.ts`:\n\n```ts\nconst TALK_JS_APP_ID = env.VITE_TALK_JS_APP_ID || \"\"\n\nexport default defineConfig({\n // ...\n define: {\n __TALK_JS_APP_ID__: JSON.stringify(TALK_JS_APP_ID),\n },\n})\n```\n\n### Run codegen\n\nAfter installing the block, regenerate SDK types:\n\n```bash\nnpx @mercurjs/cli@latest codegen\n```", "files": [ { "path": "vendor-chat/api/vendor/talkjs/route.ts", "type": "registry:api" }, { "path": "vendor-chat/vendor/routes/messages/page.tsx", "type": "registry:vendor" } ], "categories": [ "api", "vendor" ] }, { "name": "meilisearch", "description": "Opt-in Meilisearch search block for multi-vendor marketplaces with real-time seller-aware indexing, seller lifecycle sync, and injection-safe smart filtering.", "dependencies": [ "meilisearch" ], "registryDependencies": [], "docs": "## Prerequisites\n\nInstall and run a Meilisearch instance:\n\n```bash\ndocker run -d -p 7700:7700 getmeili/meilisearch\n```\n\n## Environment Variables\n\nAdd to your `.env` file:\n\n```env\nMEILISEARCH_HOST=http://localhost:7700\nMEILISEARCH_API_KEY=your_master_key_here\n```\n\n## Module Configuration\n\nAdd to your `medusa-config.ts`:\n\n```ts\nexport default defineConfig({\n modules: [\n {\n resolve: './modules/meilisearch',\n options: {\n host: process.env.MEILISEARCH_HOST,\n apiKey: process.env.MEILISEARCH_API_KEY,\n },\n },\n ],\n})\n```\n\n## Middlewares\n\nAdd to your `api/middlewares.ts`:\n\n```ts\nimport { defineMiddlewares } from \"@medusajs/medusa\";\nimport { allMeilisearchMiddlewares } from \"./meilisearch/api/middlewares\";\n\nexport default defineMiddlewares({\n routes: [...allMeilisearchMiddlewares],\n});\n```\n\n## Initial Sync\n\nAfter starting the server, trigger a full re-index:\n\n```bash\ncurl -X POST http://localhost:9000/admin/meilisearch/sync \\\n -H \"Authorization: Bearer YOUR_ADMIN_TOKEN\"\n```\n\n## Search\n\n```bash\ncurl -X POST http://localhost:9000/store/meilisearch/products \\\n -H \"Content-Type: application/json\" \\\n -H \"x-publishable-api-key: YOUR_KEY\" \\\n -d '{\"query\": \"shoes\", \"filters\": {\"price_min\": 50, \"price_max\": 200}}'\n```", "files": [ { "path": "meilisearch/modules/meilisearch/index.ts", "type": "registry:api" }, { "path": "meilisearch/modules/meilisearch/service.ts", "type": "registry:api" }, { "path": "meilisearch/modules/meilisearch/types.ts", "type": "registry:api" }, { "path": "meilisearch/subscribers/utils/meilisearch-product.ts", "type": "registry:api" }, { "path": "meilisearch/subscribers/meilisearch-product-events-bridge.ts", "type": "registry:api" }, { "path": "meilisearch/subscribers/meilisearch-products-changed.ts", "type": "registry:api" }, { "path": "meilisearch/subscribers/meilisearch-products-deleted.ts", "type": "registry:api" }, { "path": "meilisearch/subscribers/meilisearch-seller-suspended.ts", "type": "registry:api" }, { "path": "meilisearch/subscribers/meilisearch-seller-unsuspended.ts", "type": "registry:api" }, { "path": "meilisearch/workflows/meilisearch/steps/sync-meilisearch-products.ts", "type": "registry:api" }, { "path": "meilisearch/workflows/meilisearch/workflows/sync-meilisearch.ts", "type": "registry:api" }, { "path": "meilisearch/api/middlewares.ts", "type": "registry:api" }, { "path": "meilisearch/api/admin/meilisearch/route.ts", "type": "registry:api" }, { "path": "meilisearch/api/store/meilisearch/products/search/validators.ts", "type": "registry:api" }, { "path": "meilisearch/api/store/meilisearch/products/search/middlewares.ts", "type": "registry:api" }, { "path": "meilisearch/api/store/meilisearch/products/search/route.ts", "type": "registry:api" } ], "categories": [ "search" ] } ] }