@mihari/logger-winston 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,43 @@
+# @mihari/logger-winston
+
+Winston transport for the mihari log collection library.
+
+## Installation
+
+```bash
+npm install @mihari/logger-winston winston
+```
+
+## Usage
+
+```typescript
+import winston from "winston";
+import { MihariWinstonTransport } from "@mihari/logger-winston";
+
+const logger = winston.createLogger({
+  transports: [
+    new MihariWinstonTransport({
+      mihariConfig: {
+        token: "your-api-token",
+        endpoint: "https://logs.example.com",
+      },
+    }),
+  ],
+});
+
+logger.info("Hello from winston");
+```
+
+## Level Mapping
+
+| Winston Level | Mihari Level |
+|--------------|-------------|
+| silly, debug | debug |
+| verbose, info | info |
+| warn, warning | warn |
+| error | error |
+| crit, emerg, alert | fatal |
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+import Transport from "winston-transport";
+import { MihariConfig } from "@mihari/logger-types";
+interface WinstonLogInfo {
+    level: string;
+    message: string;
+    [key: string]: unknown;
+}
+export interface MihariWinstonOptions extends Transport.TransportStreamOptions {
+    readonly mihariConfig: MihariConfig;
+}
+/**
+ * Winston transport that forwards logs to mihari.
+ *
+ * Usage:
+ * ```typescript
+ * import winston from "winston";
+ * import { MihariWinstonTransport } from "@mihari/logger-winston";
+ *
+ * const logger = winston.createLogger({
+ *   transports: [
+ *     new MihariWinstonTransport({
+ *       mihariConfig: {
+ *         token: "your-token",
+ *         endpoint: "https://logs.example.com",
+ *       },
+ *     }),
+ *   ],
+ * });
+ *
+ * logger.info("Hello from winston");
+ * ```
+ */
+export declare class MihariWinstonTransport extends Transport {
+    private readonly client;
+    constructor(options: MihariWinstonOptions);
+    log(info: WinstonLogInfo, callback: () => void): void;
+    close(): Promise<void>;
+}
+export default MihariWinstonTransport;
+//# 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":"AAAA,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAE1C,OAAO,EAAY,YAAY,EAAE,MAAM,sBAAsB,CAAC;AA4B9D,UAAU,cAAc;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,oBAAqB,SAAQ,SAAS,CAAC,sBAAsB;IAC5E,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;CACrC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,sBAAuB,SAAQ,SAAS;IACnD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,OAAO,EAAE,oBAAoB;IAKzC,GAAG,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAqB/C,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7B;AAED,eAAe,sBAAsB,CAAC"}

package/dist/index.js

@@ -0,0 +1,85 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MihariWinstonTransport = void 0;
+const winston_transport_1 = __importDefault(require("winston-transport"));
+const logger_core_1 = require("@mihari/logger-core");
+const logger_types_1 = require("@mihari/logger-types");
+/**
+ * Maps winston level strings to mihari LogLevel values.
+ */
+function mapWinstonLevel(level) {
+    switch (level) {
+        case "silly":
+        case "debug":
+            return logger_types_1.LogLevel.Debug;
+        case "verbose":
+        case "info":
+            return logger_types_1.LogLevel.Info;
+        case "warn":
+        case "warning":
+            return logger_types_1.LogLevel.Warn;
+        case "error":
+            return logger_types_1.LogLevel.Error;
+        case "crit":
+        case "critical":
+        case "emerg":
+        case "alert":
+            return logger_types_1.LogLevel.Fatal;
+        default:
+            return logger_types_1.LogLevel.Info;
+    }
+}
+/**
+ * Winston transport that forwards logs to mihari.
+ *
+ * Usage:
+ * ```typescript
+ * import winston from "winston";
+ * import { MihariWinstonTransport } from "@mihari/logger-winston";
+ *
+ * const logger = winston.createLogger({
+ *   transports: [
+ *     new MihariWinstonTransport({
+ *       mihariConfig: {
+ *         token: "your-token",
+ *         endpoint: "https://logs.example.com",
+ *       },
+ *     }),
+ *   ],
+ * });
+ *
+ * logger.info("Hello from winston");
+ * ```
+ */
+class MihariWinstonTransport extends winston_transport_1.default {
+    constructor(options) {
+        super(options);
+        this.client = new logger_core_1.MihariClient(options.mihariConfig);
+    }
+    log(info, callback) {
+        setImmediate(() => {
+            this.emit("logged", info);
+        });
+        const { level, message, ...metadata } = info;
+        const mihariLevel = mapWinstonLevel(level);
+        // Remove winston internal Symbol properties by extracting
+        // only string-keyed properties
+        const cleanMeta = {};
+        for (const key of Object.keys(metadata)) {
+            if (key !== "splat") {
+                cleanMeta[key] = metadata[key];
+            }
+        }
+        this.client.log(mihariLevel, message, cleanMeta);
+        callback();
+    }
+    async close() {
+        await this.client.shutdown();
+    }
+}
+exports.MihariWinstonTransport = MihariWinstonTransport;
+exports.default = MihariWinstonTransport;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,0EAA0C;AAC1C,qDAAmD;AACnD,uDAA8D;AAE9D;;GAEG;AACH,SAAS,eAAe,CAAC,KAAa;IACpC,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,OAAO,CAAC;QACb,KAAK,OAAO;YACV,OAAO,uBAAQ,CAAC,KAAK,CAAC;QACxB,KAAK,SAAS,CAAC;QACf,KAAK,MAAM;YACT,OAAO,uBAAQ,CAAC,IAAI,CAAC;QACvB,KAAK,MAAM,CAAC;QACZ,KAAK,SAAS;YACZ,OAAO,uBAAQ,CAAC,IAAI,CAAC;QACvB,KAAK,OAAO;YACV,OAAO,uBAAQ,CAAC,KAAK,CAAC;QACxB,KAAK,MAAM,CAAC;QACZ,KAAK,UAAU,CAAC;QAChB,KAAK,OAAO,CAAC;QACb,KAAK,OAAO;YACV,OAAO,uBAAQ,CAAC,KAAK,CAAC;QACxB;YACE,OAAO,uBAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;AACH,CAAC;AAYD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,sBAAuB,SAAQ,2BAAS;IAGnD,YAAY,OAA6B;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,IAAI,0BAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACvD,CAAC;IAED,GAAG,CAAC,IAAoB,EAAE,QAAoB;QAC5C,YAAY,CAAC,GAAG,EAAE;YAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC7C,MAAM,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAE3C,0DAA0D;QAC1D,+BAA+B;QAC/B,MAAM,SAAS,GAA4B,EAAE,CAAC;QAC9C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxC,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;gBACpB,SAAS,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;QACjD,QAAQ,EAAE,CAAC;IACb,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC/B,CAAC;CACF;AAhCD,wDAgCC;AAED,kBAAe,sBAAsB,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@mihari/logger-winston",
+  "version": "0.1.0",
+  "description": "Winston transport for mihari log collection",
+  "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/winston"
+  },
+  "devDependencies": {
+    "vitest": "^3.0.0"
+  },
+  "dependencies": {
+    "@mihari/logger-core": "^0.1.0",
+    "@mihari/logger-types": "^0.1.0",
+    "winston-transport": "^4.7.0"
+  },
+  "peerDependencies": {
+    "winston": ">=3.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mihari/mihari-js",
+    "directory": "packages/winston"
+  },
+  "gitHead": "dc10a3217caa819965eb3a1e2ff3901a16e510aa"
+}

package/src/index.ts

@@ -0,0 +1,97 @@
+import Transport from "winston-transport";
+import { MihariClient } from "@mihari/logger-core";
+import { LogLevel, MihariConfig } from "@mihari/logger-types";
+
+/**
+ * Maps winston level strings to mihari LogLevel values.
+ */
+function mapWinstonLevel(level: string): LogLevel {
+  switch (level) {
+    case "silly":
+    case "debug":
+      return LogLevel.Debug;
+    case "verbose":
+    case "info":
+      return LogLevel.Info;
+    case "warn":
+    case "warning":
+      return LogLevel.Warn;
+    case "error":
+      return LogLevel.Error;
+    case "crit":
+    case "critical":
+    case "emerg":
+    case "alert":
+      return LogLevel.Fatal;
+    default:
+      return LogLevel.Info;
+  }
+}
+
+interface WinstonLogInfo {
+  level: string;
+  message: string;
+  [key: string]: unknown;
+}
+
+export interface MihariWinstonOptions extends Transport.TransportStreamOptions {
+  readonly mihariConfig: MihariConfig;
+}
+
+/**
+ * Winston transport that forwards logs to mihari.
+ *
+ * Usage:
+ * ```typescript
+ * import winston from "winston";
+ * import { MihariWinstonTransport } from "@mihari/logger-winston";
+ *
+ * const logger = winston.createLogger({
+ *   transports: [
+ *     new MihariWinstonTransport({
+ *       mihariConfig: {
+ *         token: "your-token",
+ *         endpoint: "https://logs.example.com",
+ *       },
+ *     }),
+ *   ],
+ * });
+ *
+ * logger.info("Hello from winston");
+ * ```
+ */
+export class MihariWinstonTransport extends Transport {
+  private readonly client: MihariClient;
+
+  constructor(options: MihariWinstonOptions) {
+    super(options);
+    this.client = new MihariClient(options.mihariConfig);
+  }
+
+  log(info: WinstonLogInfo, callback: () => void): void {
+    setImmediate(() => {
+      this.emit("logged", info);
+    });
+
+    const { level, message, ...metadata } = info;
+    const mihariLevel = mapWinstonLevel(level);
+
+    // Remove winston internal Symbol properties by extracting
+    // only string-keyed properties
+    const cleanMeta: Record<string, unknown> = {};
+    for (const key of Object.keys(metadata)) {
+      if (key !== "splat") {
+        cleanMeta[key] = metadata[key];
+      }
+    }
+
+    this.client.log(mihariLevel, message, cleanMeta);
+    callback();
+  }
+
+  async close(): Promise<void> {
+    await this.client.shutdown();
+  }
+}
+
+export default MihariWinstonTransport;