evlog 0.0.0-reserved → 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Environment context automatically included in every log event
+ */
+interface EnvironmentContext {
+    /** Service name (auto-detected from package.json or configurable) */
+    service: string;
+    /** Environment: 'development', 'production', 'test', etc. */
+    environment: 'development' | 'production' | 'test' | string;
+    /** Application version (auto-detected from package.json) */
+    version?: string;
+    /** Git commit hash (auto-detected from CI/CD env vars) */
+    commitHash?: string;
+    /** Deployment region (auto-detected from cloud provider env vars) */
+    region?: string;
+}
+/**
+ * Logger configuration options
+ */
+interface LoggerConfig {
+    /** Environment context overrides */
+    env?: Partial<EnvironmentContext>;
+    /** Enable pretty printing (auto-detected: true in dev, false in prod) */
+    pretty?: boolean;
+}
+/**
+ * Base structure for all wide events
+ */
+interface BaseWideEvent {
+    timestamp: string;
+    level: 'info' | 'error' | 'warn' | 'debug';
+    service: string;
+    environment: string;
+    version?: string;
+    commitHash?: string;
+    region?: string;
+}
+/**
+ * Wide event with arbitrary additional fields
+ */
+type WideEvent = BaseWideEvent & Record<string, unknown>;
+/**
+ * Request-scoped logger for building wide events
+ *
+ * @example
+ * ```ts
+ * const logger = useLogger(event)
+ * logger.set({ user: { id: '123' } })
+ * logger.set({ cart: { items: 3 } })
+ * // emit() is called automatically by the plugin
+ * ```
+ */
+interface RequestLogger {
+    /**
+     * Add context to the wide event (shallow merge)
+     */
+    set: <T extends Record<string, unknown>>(context: T) => void;
+    /**
+     * Log an error and capture its details
+     */
+    error: (error: Error | string, context?: Record<string, unknown>) => void;
+    /**
+     * Emit the final wide event with all accumulated context
+     */
+    emit: (overrides?: Record<string, unknown>) => void;
+    /**
+     * Get the current accumulated context
+     */
+    getContext: () => Record<string, unknown>;
+}
+/**
+ * Log level type
+ */
+type LogLevel = 'info' | 'error' | 'warn' | 'debug';
+/**
+ * Simple logging API - as easy as console.log
+ *
+ * @example
+ * ```ts
+ * log.info('auth', 'User logged in')
+ * log.error({ action: 'payment', error: 'failed' })
+ * ```
+ */
+interface Log {
+    /**
+     * Log an info message or wide event
+     * @example log.info('auth', 'User logged in')
+     * @example log.info({ action: 'login', userId: '123' })
+     */
+    info(tag: string, message: string): void;
+    info(event: Record<string, unknown>): void;
+    /**
+     * Log an error message or wide event
+     * @example log.error('payment', 'Payment failed')
+     * @example log.error({ action: 'payment', error: 'declined' })
+     */
+    error(tag: string, message: string): void;
+    error(event: Record<string, unknown>): void;
+    /**
+     * Log a warning message or wide event
+     * @example log.warn('api', 'Rate limit approaching')
+     * @example log.warn({ action: 'api', remaining: 10 })
+     */
+    warn(tag: string, message: string): void;
+    warn(event: Record<string, unknown>): void;
+    /**
+     * Log a debug message or wide event
+     * @example log.debug('cache', 'Cache miss')
+     * @example log.debug({ action: 'cache', key: 'user_123' })
+     */
+    debug(tag: string, message: string): void;
+    debug(event: Record<string, unknown>): void;
+}
+/**
+ * Error options for creating structured errors
+ */
+interface ErrorOptions {
+    /** What actually happened */
+    message: string;
+    /** Why this error occurred */
+    why?: string;
+    /** How to fix this issue */
+    fix?: string;
+    /** Link to documentation or more information */
+    link?: string;
+    /** The original error that caused this */
+    cause?: Error;
+}
+/**
+ * H3 event context with evlog logger attached
+ */
+interface EvlogEventContext {
+    log?: RequestLogger;
+}
+
+export type { BaseWideEvent, EnvironmentContext, ErrorOptions, EvlogEventContext, Log, LogLevel, LoggerConfig, RequestLogger, WideEvent };

package/dist/types.mjs

@@ -0,0 +1 @@
+

package/dist/utils.d.mts

@@ -0,0 +1,43 @@
+import { EnvironmentContext } from './types.mjs';
+
+/**
+ * Format duration for display
+ * < 1s: shows milliseconds (e.g., "42ms")
+ * >= 1s: shows seconds (e.g., "1.5s")
+ */
+declare function formatDuration(ms: number): string;
+/**
+ * Check if running on server
+ */
+declare function isServer(): boolean;
+/**
+ * Check if running on client
+ */
+declare function isClient(): boolean;
+/**
+ * Check if in development mode
+ */
+declare function isDev(): boolean;
+/**
+ * Auto-detect environment context from env variables
+ */
+declare function detectEnvironment(): Partial<EnvironmentContext>;
+declare const colors: {
+    readonly reset: "\u001B[0m";
+    readonly bold: "\u001B[1m";
+    readonly dim: "\u001B[2m";
+    readonly red: "\u001B[31m";
+    readonly green: "\u001B[32m";
+    readonly yellow: "\u001B[33m";
+    readonly blue: "\u001B[34m";
+    readonly magenta: "\u001B[35m";
+    readonly cyan: "\u001B[36m";
+    readonly white: "\u001B[37m";
+    readonly gray: "\u001B[90m";
+};
+/**
+ * Get color for log level
+ */
+declare function getLevelColor(level: string): string;
+
+export { colors, detectEnvironment, formatDuration, getLevelColor, isClient, isDev, isServer };

package/dist/utils.d.ts

@@ -0,0 +1,43 @@
+import { EnvironmentContext } from './types.js';
+
+/**
+ * Format duration for display
+ * < 1s: shows milliseconds (e.g., "42ms")
+ * >= 1s: shows seconds (e.g., "1.5s")
+ */
+declare function formatDuration(ms: number): string;
+/**
+ * Check if running on server
+ */
+declare function isServer(): boolean;
+/**
+ * Check if running on client
+ */
+declare function isClient(): boolean;
+/**
+ * Check if in development mode
+ */
+declare function isDev(): boolean;
+/**
+ * Auto-detect environment context from env variables
+ */
+declare function detectEnvironment(): Partial<EnvironmentContext>;
+declare const colors: {
+    readonly reset: "\u001B[0m";
+    readonly bold: "\u001B[1m";
+    readonly dim: "\u001B[2m";
+    readonly red: "\u001B[31m";
+    readonly green: "\u001B[32m";
+    readonly yellow: "\u001B[33m";
+    readonly blue: "\u001B[34m";
+    readonly magenta: "\u001B[35m";
+    readonly cyan: "\u001B[36m";
+    readonly white: "\u001B[37m";
+    readonly gray: "\u001B[90m";
+};
+/**
+ * Get color for log level
+ */
+declare function getLevelColor(level: string): string;
+
+export { colors, detectEnvironment, formatDuration, getLevelColor, isClient, isDev, isServer };

package/dist/utils.mjs

@@ -0,0 +1,57 @@
+function formatDuration(ms) {
+  if (ms < 1e3) {
+    return `${Math.round(ms)}ms`;
+  }
+  return `${(ms / 1e3).toFixed(2)}s`;
+}
+function isServer() {
+  return typeof window === "undefined";
+}
+function isClient() {
+  return typeof window !== "undefined";
+}
+function isDev() {
+  if (typeof process !== "undefined" && process.env.NODE_ENV) {
+    return process.env.NODE_ENV !== "production";
+  }
+  return true;
+}
+function detectEnvironment() {
+  const env = typeof process !== "undefined" ? process.env : {};
+  return {
+    environment: env.NODE_ENV || "development",
+    service: env.SERVICE_NAME || "app",
+    version: env.APP_VERSION,
+    commitHash: env.COMMIT_SHA || env.GITHUB_SHA || env.VERCEL_GIT_COMMIT_SHA || env.CF_PAGES_COMMIT_SHA,
+    region: env.VERCEL_REGION || env.AWS_REGION || env.FLY_REGION || env.CF_REGION
+  };
+}
+const colors = {
+  reset: "\x1B[0m",
+  bold: "\x1B[1m",
+  dim: "\x1B[2m",
+  red: "\x1B[31m",
+  green: "\x1B[32m",
+  yellow: "\x1B[33m",
+  blue: "\x1B[34m",
+  magenta: "\x1B[35m",
+  cyan: "\x1B[36m",
+  white: "\x1B[37m",
+  gray: "\x1B[90m"
+};
+function getLevelColor(level) {
+  switch (level) {
+    case "error":
+      return colors.red;
+    case "warn":
+      return colors.yellow;
+    case "info":
+      return colors.cyan;
+    case "debug":
+      return colors.gray;
+    default:
+      return colors.white;
+  }
+}
+
+export { colors, detectEnvironment, formatDuration, getLevelColor, isClient, isDev, isServer };

package/package.json

@@ -1,7 +1,95 @@
 {
   "name": "evlog",
-  "version": "0.0.0-reserved",
-  "description": "Placeholder package",
-  "main": "index.js",
-  "license": "MIT"
-}
+  "version": "0.1.0",
+  "description": "Wide event logging library with structured error handling. Inspired by LoggingSucks.",
+  "author": "HugoRCD <contact@hrcd.fr>",
+  "homepage": "https://github.com/HugoRCD/evlog",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/HugoRCD/evlog.git"
+  },
+  "bugs": {
+    "url": "https://github.com/HugoRCD/evlog/issues"
+  },
+  "keywords": [
+    "logging",
+    "wide-events",
+    "structured-logging",
+    "errors",
+    "nuxt",
+    "nitro",
+    "typescript"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./nuxt": {
+      "types": "./dist/nuxt/module.d.mts",
+      "import": "./dist/nuxt/module.mjs"
+    },
+    "./nitro": {
+      "types": "./dist/nitro/plugin.d.mts",
+      "import": "./dist/nitro/plugin.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/index.d.mts"
+      ],
+      "nuxt": [
+        "./dist/nuxt/module.d.mts"
+      ],
+      "nitro": [
+        "./dist/nitro/plugin.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "dev:prepare": "unbuild --stub",
+    "release": "bun run lint && bun run test && bun run build && changelogen --release && npm publish && git push --follow-tags",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "echo 'Typecheck handled by build'"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^4.3.0"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^3.1.1",
+    "@nuxt/schema": "^4.3.0",
+    "@nuxt/test-utils": "^3.23.0",
+    "changelogen": "^0.6.2",
+    "h3": "^1.15.0",
+    "nitropack": "^2.13.0",
+    "nuxt": "^4.3.0",
+    "typescript": "^5.9.3",
+    "unbuild": "^3.5.0"
+  },
+  "peerDependencies": {
+    "h3": "^1.13.0",
+    "nitropack": "^2.10.0"
+  },
+  "peerDependenciesMeta": {
+    "h3": {
+      "optional": true
+    },
+    "nitropack": {
+      "optional": true
+    }
+  }
+}

package/index.js

@@ -1 +0,0 @@
-// placeholder