@hoajs/request-id 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0 / 2025-10-09
+
+- init

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 - present, Hoa contributors
+
+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,39 @@
+## @hoajs/request-id
+
+Request ID middleware for Hoa.
+
+## Installation
+
+```bash
+$ npm i @hoajs/request-id --save
+```
+
+## Quick Start
+
+```js
+import { Hoa } from 'hoa'
+import { requestId } from '@hoajs/request-id'
+
+const app = new Hoa()
+app.use(requestId())
+
+app.use(async (ctx) => {
+  ctx.res.body = `Hello, ${ctx.state.requestId}!`
+})
+
+export default app
+```
+
+## Documentation
+
+The documentation is available on [hoa-js.com](https://hoa-js.com/middleware/request-id.html)
+
+## Test (100% coverage)
+
+```sh
+$ npm test
+```
+
+## License
+
+MIT

package/dist/cjs/request-id.js

@@ -0,0 +1,56 @@
+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);
+var request_id_exports = {};
+__export(request_id_exports, {
+  default: () => request_id_default,
+  requestId: () => requestId
+});
+module.exports = __toCommonJS(request_id_exports);
+function requestId(options = {}) {
+  const limitLength = options.limitLength ?? 255;
+  const headerName = options.headerName ?? "X-Request-Id";
+  const generator = options.generator ?? (() => crypto.randomUUID());
+  return async function hoaRequestId(ctx, next) {
+    let reqId = headerName ? ctx.req.get(headerName) : void 0;
+    if (!reqId || reqId.length > limitLength || /[^\w-]/.test(reqId)) {
+      reqId = generator(ctx);
+    }
+    ctx.state.requestId = reqId;
+    try {
+      await next();
+    } catch (err) {
+      const errHeaders = err.headers ? Object.fromEntries(new Headers(err.headers).entries()) : {};
+      if (headerName) {
+        errHeaders[headerName] = reqId;
+        err.headers = errHeaders;
+      } else if (err.headers) {
+        err.headers = errHeaders;
+      }
+      throw err;
+    } finally {
+      if (headerName) {
+        ctx.res.set(headerName, reqId);
+      }
+    }
+  };
+}
+var request_id_default = requestId;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  requestId
+});

package/dist/esm/request-id.js

@@ -0,0 +1,33 @@
+function requestId(options = {}) {
+  const limitLength = options.limitLength ?? 255;
+  const headerName = options.headerName ?? "X-Request-Id";
+  const generator = options.generator ?? (() => crypto.randomUUID());
+  return async function hoaRequestId(ctx, next) {
+    let reqId = headerName ? ctx.req.get(headerName) : void 0;
+    if (!reqId || reqId.length > limitLength || /[^\w-]/.test(reqId)) {
+      reqId = generator(ctx);
+    }
+    ctx.state.requestId = reqId;
+    try {
+      await next();
+    } catch (err) {
+      const errHeaders = err.headers ? Object.fromEntries(new Headers(err.headers).entries()) : {};
+      if (headerName) {
+        errHeaders[headerName] = reqId;
+        err.headers = errHeaders;
+      } else if (err.headers) {
+        err.headers = errHeaders;
+      }
+      throw err;
+    } finally {
+      if (headerName) {
+        ctx.res.set(headerName, reqId);
+      }
+    }
+  };
+}
+var request_id_default = requestId;
+export {
+  request_id_default as default,
+  requestId
+};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@hoajs/request-id",
+  "version": "0.1.0",
+  "description": "Request ID middleware for Hoa.",
+  "main": "./dist/cjs/request-id.js",
+  "type": "module",
+  "module": "./dist/esm/request-id.js",
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/esm/request-id.js",
+      "require": "./dist/cjs/request-id.js",
+      "default": "./dist/esm/request-id.js"
+    }
+  },
+  "files": [
+    "dist",
+    "types",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "build": "tsup",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "prepublishOnly": "npm run lint && npm run test && npm run build",
+    "prepare": "husky"
+  },
+  "author": "nswbmw",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hoa-js/request-id.git"
+  },
+  "keywords": [
+    "hoa",
+    "middleware",
+    "requestId",
+    "request-id",
+    "x-request-id"
+  ],
+  "devDependencies": {
+    "@commitlint/cli": "20.1.0",
+    "@commitlint/config-conventional": "20.0.0",
+    "eslint": "9.37.0",
+    "globals": "16.4.0",
+    "hoa": "0.1.0",
+    "husky": "9.1.7",
+    "jest": "30.2.0",
+    "neostandard": "0.12.2",
+    "tsup": "8.5.0"
+  },
+  "peerDependencies": {
+    "hoa": "*"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,15 @@
+import type { HoaContext } from 'hoa'
+
+export type RequestIdGenerator = (ctx: HoaContext) => string
+
+export interface RequestIdOptions {
+  limitLength?: number
+  headerName?: string
+  generator?: RequestIdGenerator
+}
+
+export type RequestIdMiddleware = (ctx: HoaContext, next: () => Promise<void>) => Promise<void>
+
+export function requestId(options?: RequestIdOptions): RequestIdMiddleware
+
+export default requestId