@easydocs/express 0.1.4

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 EasyDocs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# @easydocs/express
+
+EasyDocs middleware for [Express](https://expressjs.com/).
+
+## Install
+
+```bash
+npm install @easydocs/express
+```
+
+## Usage
+
+```ts
+import express from 'express'
+import { easydocs } from '@easydocs/express'
+
+const app = express()
+app.use(express.json())
+app.use(easydocs())
+
+// Your routes — nothing changes here
+app.get('/users', (req, res) => res.json({ users: [] }))
+
+app.listen(3000)
+```
+
+The documentation dashboard runs at `http://localhost:4999` (start it with `npx @easydocs/dashboard` or run `apps/dashboard` in dev).
+
+## Configuration
+
+```ts
+app.use(easydocs({
+  ai: {
+    provider: 'anthropic', // 'openai' | 'anthropic' | 'ollama'
+    model: 'claude-3-5-sonnet-20241022',
+  },
+  storage: {
+    url: 'file:/path/to/custom.sqlite',
+  },
+  capture: {
+    ignoreRoutes: ['/health', '/metrics'],
+  },
+}))
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `OPENAI_API_KEY` | OpenAI API key (auto-detected) |
+| `ANTHROPIC_API_KEY` | Anthropic API key (auto-detected) |
+| `EASYDOCS_DB_URL` | SQLite path, e.g. `file:~/.easydocs/db.sqlite` |

package/dist/index.cjs

@@ -0,0 +1,56 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  easydocs: () => easydocs
+});
+module.exports = __toCommonJS(index_exports);
+var import_core = require("@easydocs/core");
+function easydocs(config) {
+  return function easydocsMiddleware(req, res, next) {
+    const startedAt = Date.now();
+    const originalJson = res.json.bind(res);
+    res.json = function(body) {
+      (0, import_core.capture)(
+        {
+          method: req.method,
+          path: req.route?.path ?? req.path,
+          query: req.query,
+          params: req.params,
+          body: req.body,
+          response: body,
+          status: res.statusCode,
+          requestHeaders: req.headers,
+          responseHeaders: res.getHeaders(),
+          durationMs: Date.now() - startedAt
+        },
+        config
+      );
+      return originalJson(body);
+    };
+    next();
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  easydocs
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { capture } from '@easydocs/core'\nimport type { EasyDocsConfig } from '@easydocs/core'\nimport type { Request, Response, NextFunction } from 'express'\n\nexport function easydocs(config?: EasyDocsConfig) {\n  return function easydocsMiddleware(req: Request, res: Response, next: NextFunction) {\n    const startedAt = Date.now()\n    const originalJson = res.json.bind(res)\n\n    res.json = function (body: unknown) {\n      capture(\n        {\n          method: req.method as import('@easydocs/core').HttpMethod,\n          path: req.route?.path ?? req.path,\n          query: req.query as Record<string, string>,\n          params: req.params as Record<string, string>,\n          body: req.body,\n          response: body,\n          status: res.statusCode,\n          requestHeaders: req.headers as Record<string, string>,\n          responseHeaders: res.getHeaders() as Record<string, string>,\n          durationMs: Date.now() - startedAt,\n        },\n        config\n      )\n      return originalJson(body)\n    }\n\n    next()\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAwB;AAIjB,SAAS,SAAS,QAAyB;AAChD,SAAO,SAAS,mBAAmB,KAAc,KAAe,MAAoB;AAClF,UAAM,YAAY,KAAK,IAAI;AAC3B,UAAM,eAAe,IAAI,KAAK,KAAK,GAAG;AAEtC,QAAI,OAAO,SAAU,MAAe;AAClC;AAAA,QACE;AAAA,UACE,QAAQ,IAAI;AAAA,UACZ,MAAM,IAAI,OAAO,QAAQ,IAAI;AAAA,UAC7B,OAAO,IAAI;AAAA,UACX,QAAQ,IAAI;AAAA,UACZ,MAAM,IAAI;AAAA,UACV,UAAU;AAAA,UACV,QAAQ,IAAI;AAAA,UACZ,gBAAgB,IAAI;AAAA,UACpB,iBAAiB,IAAI,WAAW;AAAA,UAChC,YAAY,KAAK,IAAI,IAAI;AAAA,QAC3B;AAAA,QACA;AAAA,MACF;AACA,aAAO,aAAa,IAAI;AAAA,IAC1B;AAEA,SAAK;AAAA,EACP;AACF;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,6 @@
+import { EasyDocsConfig } from '@easydocs/core';
+import { Request, Response, NextFunction } from 'express';
+
+declare function easydocs(config?: EasyDocsConfig): (req: Request, res: Response, next: NextFunction) => void;
+
+export { easydocs };

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { EasyDocsConfig } from '@easydocs/core';
+import { Request, Response, NextFunction } from 'express';
+
+declare function easydocs(config?: EasyDocsConfig): (req: Request, res: Response, next: NextFunction) => void;
+
+export { easydocs };

package/dist/index.js

@@ -0,0 +1,31 @@
+// src/index.ts
+import { capture } from "@easydocs/core";
+function easydocs(config) {
+  return function easydocsMiddleware(req, res, next) {
+    const startedAt = Date.now();
+    const originalJson = res.json.bind(res);
+    res.json = function(body) {
+      capture(
+        {
+          method: req.method,
+          path: req.route?.path ?? req.path,
+          query: req.query,
+          params: req.params,
+          body: req.body,
+          response: body,
+          status: res.statusCode,
+          requestHeaders: req.headers,
+          responseHeaders: res.getHeaders(),
+          durationMs: Date.now() - startedAt
+        },
+        config
+      );
+      return originalJson(body);
+    };
+    next();
+  };
+}
+export {
+  easydocs
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { capture } from '@easydocs/core'\nimport type { EasyDocsConfig } from '@easydocs/core'\nimport type { Request, Response, NextFunction } from 'express'\n\nexport function easydocs(config?: EasyDocsConfig) {\n  return function easydocsMiddleware(req: Request, res: Response, next: NextFunction) {\n    const startedAt = Date.now()\n    const originalJson = res.json.bind(res)\n\n    res.json = function (body: unknown) {\n      capture(\n        {\n          method: req.method as import('@easydocs/core').HttpMethod,\n          path: req.route?.path ?? req.path,\n          query: req.query as Record<string, string>,\n          params: req.params as Record<string, string>,\n          body: req.body,\n          response: body,\n          status: res.statusCode,\n          requestHeaders: req.headers as Record<string, string>,\n          responseHeaders: res.getHeaders() as Record<string, string>,\n          durationMs: Date.now() - startedAt,\n        },\n        config\n      )\n      return originalJson(body)\n    }\n\n    next()\n  }\n}\n"],"mappings":";AAAA,SAAS,eAAe;AAIjB,SAAS,SAAS,QAAyB;AAChD,SAAO,SAAS,mBAAmB,KAAc,KAAe,MAAoB;AAClF,UAAM,YAAY,KAAK,IAAI;AAC3B,UAAM,eAAe,IAAI,KAAK,KAAK,GAAG;AAEtC,QAAI,OAAO,SAAU,MAAe;AAClC;AAAA,QACE;AAAA,UACE,QAAQ,IAAI;AAAA,UACZ,MAAM,IAAI,OAAO,QAAQ,IAAI;AAAA,UAC7B,OAAO,IAAI;AAAA,UACX,QAAQ,IAAI;AAAA,UACZ,MAAM,IAAI;AAAA,UACV,UAAU;AAAA,UACV,QAAQ,IAAI;AAAA,UACZ,gBAAgB,IAAI;AAAA,UACpB,iBAAiB,IAAI,WAAW;AAAA,UAChC,YAAY,KAAK,IAAI,IAAI;AAAA,QAC3B;AAAA,QACA;AAAA,MACF;AACA,aAAO,aAAa,IAAI;AAAA,IAC1B;AAEA,SAAK;AAAA,EACP;AACF;","names":[]}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@easydocs/express",
+  "version": "0.1.4",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "description": "EasyDocs middleware for Express",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@easydocs/core": "0.1.4"
+  },
+  "peerDependencies": {
+    "express": ">=4.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "express": "^5.0.0",
+    "tsup": "^8.3.0",
+    "typescript": "^5"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
+  }
+}