@micro-cms/express-adapter 1.0.20 → 1.0.22

package/README.md

@@ -0,0 +1,51 @@
+# @micro-cms/express-adapter
+
+The glue between the Micro-CMS runtime and the Express.js framework. This module automatically discovers API routes defined by other CMS modules and binds them to your Express application.
+
+## Features
+
+- **Automatic Route Discovery:** Polls the CMS runtime for all registered `route-provider` capabilities.
+- **Middleware Mapping:** Translates abstract middleware keys used in modules to real Express middleware functions.
+- **Error Handling:** Provides a standardized wrapper for catching and reporting errors in CMS routes.
+- **Prefix Support:** Allows mounting all CMS routes under a specific base path (e.g., `/api/admin`).
+
+## Installation
+
+```bash
+pnpm add @micro-cms/express-adapter
+```
+
+## Basic Usage
+
+```javascript
+import express from 'express';
+import { createApp } from '@micro-cms/core';
+import { bindExpressRoutes } from '@micro-cms/express-adapter';
+import resourceModule from '@micro-cms/resource-module';
+
+const app = express();
+const cms = createApp();
+
+// Load modules
+cms.use(resourceModule);
+await cms.start();
+
+// Bind CMS routes to Express
+bindExpressRoutes({
+  app,
+  cms,
+  routePrefix: '/api/v1',
+  middlewareMap: {
+    'admin-auth': (req, res, next) => {
+      // Your auth logic here
+      next();
+    }
+  }
+});
+
+app.listen(3000);
+```
+
+## How It Works
+
+Modules like `@micro-cms/resource-module` provide generic `RouteDefinition` objects (containing method, path, and handler) to the CMS runtime. The Express Adapter iterates through these definitions and calls `app.get()`, `app.post()`, etc., on your Express instance, effectively "mounting" the CMS functionality into your existing server.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@micro-cms/express-adapter",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "description": "Express.js framework adapter for Micro-CMS",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,5 +16,14 @@
     "@types/express": "^4.17.0",
     "typescript": "^5.3.3",
     "tsup": "^8.0.2"
-  }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/teamoremi/micro-cms.git",
+    "directory": "packages/express-adapter"
+  },
+  "bugs": {
+    "url": "https://github.com/teamoremi/micro-cms/issues"
+  },
+  "homepage": "https://github.com/teamoremi/micro-cms/tree/master/packages/express-adapter#readme"
 }