@abbacchio/transport 0.1.2 → 0.1.3

package/README.md

@@ -0,0 +1,121 @@
+# @abbacchio/transport
+
+Node.js log transports for sending logs to [Abbacchio](https://github.com/pekonchan/pino-live) - a real-time log viewer dashboard.
+
+Supports **Pino**, **Winston**, **Bunyan**, and **Console**.
+
+## Installation
+
+```bash
+npm install @abbacchio/transport
+```
+
+## Usage
+
+### Pino
+
+```typescript
+import pino from "pino";
+
+const logger = pino({
+  transport: {
+    targets: [
+      { target: "pino-pretty" },
+      {
+        target: "@abbacchio/transport/transports/pino",
+        options: {
+          url: "http://localhost:4000/api/logs",
+          channel: "my-app",
+        },
+      },
+    ],
+  },
+});
+
+logger.info({ user: "john" }, "User logged in");
+```
+
+### Winston
+
+```typescript
+import winston from "winston";
+import { winstonTransport } from "@abbacchio/transport/transports/winston";
+
+const logger = winston.createLogger({
+  transports: [
+    new winston.transports.Console(),
+    winstonTransport({
+      url: "http://localhost:4000/api/logs",
+      channel: "my-app",
+    }),
+  ],
+});
+
+logger.info("User logged in", { user: "john" });
+```
+
+### Bunyan
+
+```typescript
+import bunyan from "bunyan";
+import { bunyanStream } from "@abbacchio/transport/transports/bunyan";
+
+const logger = bunyan.createLogger({
+  name: "myapp",
+  streams: [
+    { stream: process.stdout },
+    bunyanStream({
+      url: "http://localhost:4000/api/logs",
+      channel: "my-app",
+    }),
+  ],
+});
+
+logger.info({ user: "john" }, "User logged in");
+```
+
+### Console
+
+```typescript
+import { interceptConsole, restoreConsole } from "@abbacchio/transport/transports/console";
+
+interceptConsole({
+  url: "http://localhost:4000/api/logs",
+  channel: "my-app",
+  passthrough: true,
+});
+
+console.log("This will be sent to Abbacchio!");
+
+restoreConsole();
+```
+
+## Options
+
+| Option      | Type   | Default                          | Description                             |
+| ----------- | ------ | -------------------------------- | --------------------------------------- |
+| `url`       | string | `http://localhost:4000/api/logs` | Abbacchio server URL                    |
+| `channel`   | string | `default`                        | Channel name for multi-app support      |
+| `secretKey` | string | -                                | Encryption key (enables E2E encryption) |
+| `batchSize` | number | `10`                             | Send batch when this many logs accumulate |
+| `interval`  | number | `1000`                           | Send batch after this many ms           |
+| `headers`   | object | `{}`                             | Additional HTTP headers                 |
+
+## End-to-End Encryption
+
+Add `secretKey` to encrypt logs before sending:
+
+```typescript
+{
+  target: "@abbacchio/transport/transports/pino",
+  options: {
+    url: "http://localhost:4000/api/logs",
+    channel: "my-app",
+    secretKey: process.env.LOG_SECRET_KEY,
+  },
+}
+```
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abbacchio/transport",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Node.js log transports for Pino, Winston, and Bunyan - send logs to Abbacchio",
   "type": "module",
   "main": "dist/index.js",
@@ -10,8 +10,9 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
-    "./transports/pino": {
+    "./pino": {
       "types": "./dist/transports/pino.d.ts",
+      "require": "./pino-transport.cjs",
       "default": "./dist/transports/pino.js"
     },
     "./transports/winston": {
@@ -27,6 +28,10 @@
       "default": "./dist/transports/console.js"
     }
   },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
+  },
   "keywords": [
     "pino",
     "winston",
@@ -42,15 +47,24 @@
     "pino-abstract-transport": "^3.0.0",
     "winston-transport": "^4.9.0"
   },
+  "peerDependencies": {
+    "pino": "^8.0.0 || ^9.0.0"
+  },
+  "peerDependenciesMeta": {
+    "pino": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@types/node": "^22.10.5",
+    "pino": "^9.0.0",
     "typescript": "^5.7.2"
   },
   "engines": {
     "node": ">=18"
   },
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mood-agency/abbacchio"
   }
-}
+}

package/pino-transport.cjs

@@ -0,0 +1,30 @@
+'use strict'
+
+/**
+ * CommonJS wrapper for the Pino transport.
+ *
+ * Pino runs transports in worker threads using require(), which doesn't
+ * work well with ESM subpath exports. This CJS wrapper allows users to
+ * simply use: target: '@abbacchio/transport'
+ *
+ * @example
+ * ```javascript
+ * const pino = require('pino');
+ *
+ * const logger = pino({
+ *   transport: {
+ *     target: '@abbacchio/transport',
+ *     options: {
+ *       url: 'http://localhost:4000/api/logs',
+ *       channel: 'my-app',
+ *     },
+ *   },
+ * });
+ * ```
+ */
+
+// Dynamic import the ESM module
+module.exports = async function(opts) {
+  const { default: pinoTransport } = await import('./dist/transports/pino.js');
+  return pinoTransport(opts);
+};