elysia-wide-event 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jay Choi
+
+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,92 @@
+# elysia-wide-event
+
+[![license](https://img.shields.io/github/license/choiexe1/elysia-wide-event)](./LICENSE)
+[![Bun](https://img.shields.io/badge/Bun-%23000000.svg?logo=bun&logoColor=white)](https://bun.sh)
+[![한국어](https://img.shields.io/badge/lang-한국어-blue.svg)](./docs/README.ko.md)
+
+Wide event logging plugin for [Elysia](https://elysiajs.com). Aggregates all request context into a single structured log line for better observability.
+
+Inspired by [Logging Sucks](https://loggingsucks.com/) - the wide event pattern that makes debugging actually enjoyable.
+
+![elysia-wide-event output](./images/image.png)
+
+> **Bun + Elysia only.** This plugin is designed specifically for the Bun runtime and Elysia framework. Node.js is not supported.
+
+## Features
+
+- **Context Accumulation**: Collect data throughout request lifecycle via `wideEvent.set()`
+- **Flexible Output**: Pretty colored output or JSON - you choose
+- **Request ID**: Auto-generates or extracts from `x-request-id` header
+- **Performance Metrics**: Automatic request duration tracking
+
+## Installation
+
+```bash
+bun add elysia-wide-event
+```
+
+## Quick Start
+
+```typescript
+import { Elysia } from "elysia";
+import { wideEvent } from "elysia-wide-event";
+
+const app = new Elysia()
+  .use(wideEvent())
+  .post("/users", ({ wideEvent, body }) => {
+    wideEvent.set("user", { email: body.email });
+
+    const userId = "abc-123";
+    wideEvent.set("result", { userId });
+
+    return { success: true };
+  })
+  .listen(3000);
+```
+
+## Output
+
+See the screenshot above for output examples. Pretty colored output by default, JSON with `json: true` option.
+
+## Options
+
+```typescript
+wideEvent({
+  generateRequestId: () => crypto.randomUUID(),
+  requestIdHeader: "x-request-id",
+  json: false,
+});
+```
+
+| Option              | Type           | Default             | Description                             |
+| ------------------- | -------------- | ------------------- | --------------------------------------- |
+| `generateRequestId` | `() => string` | `crypto.randomUUID` | Custom request ID generator             |
+| `requestIdHeader`   | `string`       | `"x-request-id"`    | Header for incoming request ID          |
+| `json`              | `boolean`      | `false`             | Output as JSON instead of pretty format |
+
+## API
+
+### `wideEvent.set(key, data)`
+
+Add context to the current request log.
+
+```typescript
+wideEvent.set("auth", { userId: "123", role: "admin" });
+```
+
+### `wideEvent.error({ type, message })`
+
+Log error details.
+
+```typescript
+wideEvent.error({ type: "ValidationError", message: "Invalid email" });
+```
+
+## Requirements
+
+- Bun >= 1.0.0
+- Elysia >= 1.0.0
+
+## License
+
+MIT

package/dist/formatter.d.ts

@@ -0,0 +1,12 @@
+import type { LogData } from "./types";
+export declare const colors: {
+    readonly reset: "\u001B[0m";
+    readonly dim: "\u001B[2m";
+    readonly green: "\u001B[32m";
+    readonly red: "\u001B[31m";
+    readonly yellow: "\u001B[33m";
+    readonly blue: "\u001B[34m";
+};
+export declare function formatTime(): string;
+export declare function formatData(data: LogData): string;
+//# sourceMappingURL=formatter.d.ts.map

package/dist/formatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../src/formatter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC,eAAO,MAAM,MAAM;;;;;;;CAOT,CAAC;AAEX,wBAAgB,UAAU,IAAI,MAAM,CAEnC;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAIhD"}

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import { Elysia } from "elysia";
+import type { WideEventOptions, FlushableLogger } from "./types";
+export type { LogData, ErrorData, WideEventLogger, WideEventOptions, } from "./types";
+export declare const wideEvent: (options?: WideEventOptions) => Elysia<"", {
+    decorator: {};
+    store: {};
+    derive: {
+        readonly wideEvent: FlushableLogger;
+        readonly requestId: string;
+    };
+    resolve: {};
+}, {
+    typebox: {};
+    error: {};
+}, {
+    schema: {};
+    standaloneSchema: {};
+    macro: {};
+    macroFn: {};
+    parser: {};
+    response: import("elysia").ExtractErrorFromHandle<{
+        readonly wideEvent: FlushableLogger;
+        readonly requestId: string;
+    }>;
+}, {}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}>;
+export default wideEvent;
+//# 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,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAGjE,YAAY,EACV,OAAO,EACP,SAAS,EACT,eAAe,EACf,gBAAgB,GACjB,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,SAAS,GAAI,UAAS,gBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0BvD,CAAC;AAEF,eAAe,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,113 @@
+// @bun
+// src/index.ts
+import { Elysia } from "elysia";
+
+// src/formatter.ts
+var colors = {
+  reset: "\x1B[0m",
+  dim: "\x1B[2m",
+  green: "\x1B[32m",
+  red: "\x1B[31m",
+  yellow: "\x1B[33m",
+  blue: "\x1B[34m"
+};
+function formatTime() {
+  return new Date().toISOString().slice(11, 19);
+}
+function formatData(data) {
+  return Object.entries(data).map(([k, v]) => `${k}=${JSON.stringify(v)}`).join(" ");
+}
+
+// src/logger.ts
+class RequestEventLogger {
+  requestId;
+  method;
+  path;
+  useJson;
+  startTime;
+  fields = new Map;
+  errorData;
+  headerTime;
+  constructor(requestId, method, path, useJson) {
+    this.requestId = requestId;
+    this.method = method;
+    this.path = path;
+    this.useJson = useJson;
+    this.startTime = Date.now();
+    this.headerTime = formatTime();
+  }
+  set(key, data) {
+    this.fields.set(key, data);
+  }
+  error(error) {
+    this.errorData = error;
+  }
+  flush(status) {
+    const durationMs = Date.now() - this.startTime;
+    if (this.useJson) {
+      this.flushJson(status, durationMs);
+    } else {
+      this.flushDev(status, durationMs);
+    }
+  }
+  flushDev(status, durationMs) {
+    const statusColor = status >= 400 ? colors.red : colors.green;
+    console.log(`
+${colors.dim}[${this.headerTime}]${colors.reset} ` + `${colors.yellow}${this.method} ${this.path}${colors.reset} ` + `${statusColor}${status}${colors.reset} ` + `${colors.dim}${durationMs}ms${colors.reset}`);
+    for (const [key, data] of this.fields) {
+      console.log(`  ${colors.blue}${key}:${colors.reset} ${formatData(data)}`);
+    }
+    if (this.errorData) {
+      const errorMsg = this.errorData.message ? `${this.errorData.type}: ${this.errorData.message}` : this.errorData.type;
+      console.log(`  ${colors.red}\u2717${colors.reset} ${errorMsg}`);
+    }
+  }
+  flushJson(status, durationMs) {
+    const record = {
+      timestamp: new Date().toISOString(),
+      request_id: this.requestId,
+      method: this.method,
+      path: this.path,
+      status,
+      duration_ms: durationMs
+    };
+    for (const [key, data] of this.fields) {
+      record[key] = data;
+    }
+    if (this.errorData) {
+      record.error = this.errorData;
+      console.error(JSON.stringify(record));
+    } else {
+      console.log(JSON.stringify(record));
+    }
+  }
+}
+function createLogger(requestId, method, path, useJson) {
+  return new RequestEventLogger(requestId, method, path, useJson);
+}
+
+// src/index.ts
+var wideEvent = (options = {}) => {
+  const {
+    generateRequestId = () => crypto.randomUUID(),
+    requestIdHeader = "x-request-id",
+    json = false
+  } = options;
+  return new Elysia({ name: "elysia-wide-event" }).derive({ as: "global" }, (ctx) => {
+    const requestId = ctx.request.headers.get(requestIdHeader) ?? generateRequestId();
+    const method = ctx.request.method;
+    const path = new URL(ctx.request.url).pathname;
+    const wideEvent2 = createLogger(requestId, method, path, json);
+    return { wideEvent: wideEvent2, requestId };
+  }).onAfterResponse({ as: "global" }, ({ wideEvent: wideEvent2, set }) => {
+    if (!wideEvent2)
+      return;
+    const status = typeof set.status === "number" ? set.status : 200;
+    wideEvent2.flush(status);
+  });
+};
+var src_default = wideEvent;
+export {
+  wideEvent,
+  src_default as default
+};

package/dist/logger.d.ts

@@ -0,0 +1,19 @@
+import type { LogData, ErrorData, WideEventLogger, FlushableLogger } from "./types";
+export declare class RequestEventLogger implements WideEventLogger {
+    private requestId;
+    private method;
+    private path;
+    private useJson;
+    private startTime;
+    private fields;
+    private errorData?;
+    private headerTime;
+    constructor(requestId: string, method: string, path: string, useJson: boolean);
+    set(key: string, data: LogData): void;
+    error(error: ErrorData): void;
+    flush(status: number): void;
+    private flushDev;
+    private flushJson;
+}
+export declare function createLogger(requestId: string, method: string, path: string, useJson: boolean): FlushableLogger;
+//# sourceMappingURL=logger.d.ts.map

package/dist/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,SAAS,EACT,eAAe,EAEf,eAAe,EAChB,MAAM,SAAS,CAAC;AAGjB,qBAAa,kBAAmB,YAAW,eAAe;IAOtD,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,OAAO;IATjB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,MAAM,CAAmC;IACjD,OAAO,CAAC,SAAS,CAAC,CAAY;IAC9B,OAAO,CAAC,UAAU,CAAS;gBAGjB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO;IAM1B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI;IAIrC,KAAK,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAI7B,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAU3B,OAAO,CAAC,QAAQ;IAsBhB,OAAO,CAAC,SAAS;CAqBlB;AAED,wBAAgB,YAAY,CAC1B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,GACf,eAAe,CAEjB"}

package/dist/types.d.ts

@@ -0,0 +1,44 @@
+export interface LogData {
+    [key: string]: unknown;
+}
+export interface ErrorData {
+    type: string;
+    code?: string;
+    message?: string;
+    [key: string]: unknown;
+}
+export interface WideEventLogger {
+    set: (key: string, data: LogData) => void;
+    error: (error: ErrorData) => void;
+}
+export interface WideEventOptions {
+    /**
+     * Custom request ID generator
+     * @default crypto.randomUUID()
+     */
+    generateRequestId?: () => string;
+    /**
+     * Request ID header name to use from incoming request
+     * @default "x-request-id"
+     */
+    requestIdHeader?: string;
+    /**
+     * Output format: true for JSON, false for pretty colored output
+     * @default false
+     */
+    json?: boolean;
+}
+export interface WideEventRecord {
+    timestamp: string;
+    request_id: string;
+    method: string;
+    path: string;
+    status?: number;
+    duration_ms?: number;
+    error?: ErrorData;
+    [key: string]: unknown;
+}
+export type FlushableLogger = WideEventLogger & {
+    flush: (status: number) => void;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IAC1C,KAAK,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,MAAM,CAAC;IAEjC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CACjC,CAAC"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "elysia-wide-event",
+  "version": "0.1.0",
+  "description": "Wide event logging plugin for Elysia - structured logging with request context",
+  "author": "Jay Choi",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/choiexe1/elysia-wide-event"
+  },
+  "keywords": [
+    "elysia",
+    "plugin",
+    "logging",
+    "wide-event",
+    "structured-logging",
+    "observability",
+    "bun"
+  ],
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir ./dist --target bun --external elysia && bun run build:types",
+    "build:types": "tsc -p tsconfig.build.json",
+    "prepublishOnly": "bun run build"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  },
+  "peerDependencies": {
+    "elysia": ">=1.0.0"
+  },
+  "devDependencies": {
+    "bun-types": "latest",
+    "elysia": "latest",
+    "typescript": "^5.0.0"
+  }
+}