@mihari/logger-koa 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mihari 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,51 @@
+# @mihari/logger-koa
+
+Koa request logging middleware for the mihari log collection library.
+
+## Installation
+
+```bash
+npm install @mihari/logger-koa koa
+```
+
+## Usage
+
+```typescript
+import Koa from "koa";
+import { mihariMiddleware } from "@mihari/logger-koa";
+
+const app = new Koa();
+
+app.use(mihariMiddleware({
+  token: "your-api-token",
+  endpoint: "https://logs.example.com",
+}));
+
+app.use(async (ctx) => {
+  ctx.body = "Hello World";
+});
+
+app.listen(3000);
+```
+
+## Logged Fields
+
+| Field | Description |
+|-------|-------------|
+| method | HTTP method (GET, POST, etc.) |
+| url | Request URL path |
+| status | Response status code |
+| responseTimeMs | Response time in milliseconds |
+| userAgent | User-Agent header value |
+| contentLength | Response content length |
+| ip | Client IP address |
+
+## Log Level Selection
+
+- 5xx responses: error
+- 4xx responses: warn
+- All other responses: info
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,53 @@
+import { MihariConfig } from "@mihari/logger-types";
+/**
+ * Minimal Koa context type to avoid requiring koa as a direct dependency.
+ */
+interface KoaContext {
+    readonly method: string;
+    readonly url: string;
+    readonly status: number;
+    readonly ip: string;
+    readonly request: {
+        readonly length?: number;
+        readonly get: (header: string) => string;
+    };
+    readonly response: {
+        readonly length?: number;
+    };
+}
+type KoaNext = () => Promise<void>;
+type KoaMiddleware = (ctx: KoaContext, next: KoaNext) => Promise<void>;
+/**
+ * Creates Koa middleware that logs every HTTP request to mihari.
+ *
+ * Captured fields:
+ * - method: HTTP method (GET, POST, etc.)
+ * - url: Request URL
+ * - status: Response status code
+ * - responseTimeMs: Time to handle the request in milliseconds
+ * - userAgent: User-Agent header
+ * - contentLength: Response content length
+ * - ip: Client IP address
+ *
+ * Usage:
+ * ```typescript
+ * import Koa from "koa";
+ * import { mihariMiddleware } from "@mihari/logger-koa";
+ *
+ * const app = new Koa();
+ *
+ * app.use(mihariMiddleware({
+ *   token: "your-token",
+ *   endpoint: "https://logs.example.com",
+ * }));
+ *
+ * app.use(async (ctx) => {
+ *   ctx.body = "Hello World";
+ * });
+ *
+ * app.listen(3000);
+ * ```
+ */
+export declare function mihariMiddleware(config: MihariConfig): KoaMiddleware;
+export default mihariMiddleware;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAY,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAE9D;;GAEG;AACH,UAAU,UAAU;IAClB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE;QAChB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;KAC1C,CAAC;IACF,QAAQ,CAAC,QAAQ,EAAE;QACjB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED,KAAK,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AACnC,KAAK,aAAa,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,aAAa,CA6BpE;AAED,eAAe,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mihariMiddleware = mihariMiddleware;
+const logger_core_1 = require("@mihari/logger-core");
+const logger_types_1 = require("@mihari/logger-types");
+/**
+ * Creates Koa middleware that logs every HTTP request to mihari.
+ *
+ * Captured fields:
+ * - method: HTTP method (GET, POST, etc.)
+ * - url: Request URL
+ * - status: Response status code
+ * - responseTimeMs: Time to handle the request in milliseconds
+ * - userAgent: User-Agent header
+ * - contentLength: Response content length
+ * - ip: Client IP address
+ *
+ * Usage:
+ * ```typescript
+ * import Koa from "koa";
+ * import { mihariMiddleware } from "@mihari/logger-koa";
+ *
+ * const app = new Koa();
+ *
+ * app.use(mihariMiddleware({
+ *   token: "your-token",
+ *   endpoint: "https://logs.example.com",
+ * }));
+ *
+ * app.use(async (ctx) => {
+ *   ctx.body = "Hello World";
+ * });
+ *
+ * app.listen(3000);
+ * ```
+ */
+function mihariMiddleware(config) {
+    const client = new logger_core_1.MihariClient(config);
+    return async (ctx, next) => {
+        const startTime = Date.now();
+        try {
+            await next();
+        }
+        finally {
+            const responseTimeMs = Date.now() - startTime;
+            const status = ctx.status;
+            const level = status >= 500
+                ? logger_types_1.LogLevel.Error
+                : status >= 400
+                    ? logger_types_1.LogLevel.Warn
+                    : logger_types_1.LogLevel.Info;
+            client.log(level, `${ctx.method} ${ctx.url} ${status}`, {
+                method: ctx.method,
+                url: ctx.url,
+                status,
+                responseTimeMs,
+                userAgent: ctx.request.get("user-agent"),
+                contentLength: ctx.response.length,
+                ip: ctx.ip,
+            });
+        }
+    };
+}
+exports.default = mihariMiddleware;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAsDA,4CA6BC;AAnFD,qDAAmD;AACnD,uDAA8D;AAsB9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,gBAAgB,CAAC,MAAoB;IACnD,MAAM,MAAM,GAAG,IAAI,0BAAY,CAAC,MAAM,CAAC,CAAC;IAExC,OAAO,KAAK,EAAE,GAAe,EAAE,IAAa,EAAiB,EAAE;QAC7D,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7B,IAAI,CAAC;YACH,MAAM,IAAI,EAAE,CAAC;QACf,CAAC;gBAAS,CAAC;YACT,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;YAC9C,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;YAE1B,MAAM,KAAK,GAAG,MAAM,IAAI,GAAG;gBACzB,CAAC,CAAC,uBAAQ,CAAC,KAAK;gBAChB,CAAC,CAAC,MAAM,IAAI,GAAG;oBACb,CAAC,CAAC,uBAAQ,CAAC,IAAI;oBACf,CAAC,CAAC,uBAAQ,CAAC,IAAI,CAAC;YAEpB,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,MAAM,EAAE,EAAE;gBACtD,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,GAAG,EAAE,GAAG,CAAC,GAAG;gBACZ,MAAM;gBACN,cAAc;gBACd,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;gBACxC,aAAa,EAAE,GAAG,CAAC,QAAQ,CAAC,MAAM;gBAClC,EAAE,EAAE,GAAG,CAAC,EAAE;aACX,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,kBAAe,gBAAgB,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@mihari/logger-koa",
+  "version": "0.1.0",
+  "description": "Koa request logging middleware for mihari",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "test": "cd ../.. && npx vitest run --config vitest.config.ts packages/koa"
+  },
+  "devDependencies": {
+    "vitest": "^3.0.0"
+  },
+  "dependencies": {
+    "@mihari/logger-core": "^0.1.0",
+    "@mihari/logger-types": "^0.1.0"
+  },
+  "peerDependencies": {
+    "koa": ">=2.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mihari/mihari-js",
+    "directory": "packages/koa"
+  },
+  "gitHead": "dc10a3217caa819965eb3a1e2ff3901a16e510aa"
+}

package/src/index.ts

@@ -0,0 +1,86 @@
+import { MihariClient } from "@mihari/logger-core";
+import { LogLevel, MihariConfig } from "@mihari/logger-types";
+
+/**
+ * Minimal Koa context type to avoid requiring koa as a direct dependency.
+ */
+interface KoaContext {
+  readonly method: string;
+  readonly url: string;
+  readonly status: number;
+  readonly ip: string;
+  readonly request: {
+    readonly length?: number;
+    readonly get: (header: string) => string;
+  };
+  readonly response: {
+    readonly length?: number;
+  };
+}
+
+type KoaNext = () => Promise<void>;
+type KoaMiddleware = (ctx: KoaContext, next: KoaNext) => Promise<void>;
+
+/**
+ * Creates Koa middleware that logs every HTTP request to mihari.
+ *
+ * Captured fields:
+ * - method: HTTP method (GET, POST, etc.)
+ * - url: Request URL
+ * - status: Response status code
+ * - responseTimeMs: Time to handle the request in milliseconds
+ * - userAgent: User-Agent header
+ * - contentLength: Response content length
+ * - ip: Client IP address
+ *
+ * Usage:
+ * ```typescript
+ * import Koa from "koa";
+ * import { mihariMiddleware } from "@mihari/logger-koa";
+ *
+ * const app = new Koa();
+ *
+ * app.use(mihariMiddleware({
+ *   token: "your-token",
+ *   endpoint: "https://logs.example.com",
+ * }));
+ *
+ * app.use(async (ctx) => {
+ *   ctx.body = "Hello World";
+ * });
+ *
+ * app.listen(3000);
+ * ```
+ */
+export function mihariMiddleware(config: MihariConfig): KoaMiddleware {
+  const client = new MihariClient(config);
+
+  return async (ctx: KoaContext, next: KoaNext): Promise<void> => {
+    const startTime = Date.now();
+
+    try {
+      await next();
+    } finally {
+      const responseTimeMs = Date.now() - startTime;
+      const status = ctx.status;
+
+      const level = status >= 500
+        ? LogLevel.Error
+        : status >= 400
+          ? LogLevel.Warn
+          : LogLevel.Info;
+
+      client.log(level, `${ctx.method} ${ctx.url} ${status}`, {
+        method: ctx.method,
+        url: ctx.url,
+        status,
+        responseTimeMs,
+        userAgent: ctx.request.get("user-agent"),
+        contentLength: ctx.response.length,
+        ip: ctx.ip,
+      });
+    }
+  };
+}
+
+export default mihariMiddleware;