evlog 1.6.0 → 1.7.0

package/dist/adapters/sentry.d.ts

@@ -1,78 +0,0 @@
-import { DrainContext, WideEvent } from '../types.js';
-
-interface SentryConfig {
-    /** Sentry DSN */
-    dsn: string;
-    /** Environment override (defaults to event.environment) */
-    environment?: string;
-    /** Release version override (defaults to event.version) */
-    release?: string;
-    /** Additional tags to attach as attributes */
-    tags?: Record<string, string>;
-    /** Request timeout in milliseconds. Default: 5000 */
-    timeout?: number;
-}
-/** Sentry Log attribute value with type annotation */
-interface SentryAttributeValue {
-    value: string | number | boolean;
-    type: 'string' | 'integer' | 'double' | 'boolean';
-}
-/** Sentry Structured Log payload */
-interface SentryLog {
-    timestamp: number;
-    trace_id: string;
-    level: 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
-    body: string;
-    severity_number: number;
-    attributes?: Record<string, SentryAttributeValue>;
-}
-declare function toSentryLog(event: WideEvent, config: SentryConfig): SentryLog;
-/**
- * Create a drain function for sending logs to Sentry.
- *
- * Sends wide events as Sentry Structured Logs, visible in Explore > Logs
- * in the Sentry dashboard.
- *
- * Configuration priority (highest to lowest):
- * 1. Overrides passed to createSentryDrain()
- * 2. runtimeConfig.evlog.sentry
- * 3. runtimeConfig.sentry
- * 4. Environment variables: NUXT_SENTRY_*, SENTRY_*
- *
- * @example
- * ```ts
- * // Zero config - just set NUXT_SENTRY_DSN env var
- * nitroApp.hooks.hook('evlog:drain', createSentryDrain())
- *
- * // With overrides
- * nitroApp.hooks.hook('evlog:drain', createSentryDrain({
- *   dsn: 'https://public@o0.ingest.sentry.io/123',
- * }))
- * ```
- */
-declare function createSentryDrain(overrides?: Partial<SentryConfig>): (ctx: DrainContext) => Promise<void>;
-/**
- * Send a single event to Sentry as a structured log.
- *
- * @example
- * ```ts
- * await sendToSentry(event, {
- *   dsn: process.env.SENTRY_DSN!,
- * })
- * ```
- */
-declare function sendToSentry(event: WideEvent, config: SentryConfig): Promise<void>;
-/**
- * Send a batch of events to Sentry as structured logs via the Envelope endpoint.
- *
- * @example
- * ```ts
- * await sendBatchToSentry(events, {
- *   dsn: process.env.SENTRY_DSN!,
- * })
- * ```
- */
-declare function sendBatchToSentry(events: WideEvent[], config: SentryConfig): Promise<void>;
-
-export { createSentryDrain, sendBatchToSentry, sendToSentry, toSentryLog };
-export type { SentryAttributeValue, SentryConfig, SentryLog };

package/dist/error.d.ts

@@ -1,63 +0,0 @@
-import { ErrorOptions } from './types.js';
-
-/**
- * Structured error with context for better debugging
- *
- * @example
- * ```ts
- * throw new EvlogError({
- *   message: 'Failed to sync repository',
- *   status: 503,
- *   why: 'GitHub API rate limit exceeded',
- *   fix: 'Wait 1 hour or use a different token',
- *   link: 'https://docs.github.com/en/rest/rate-limit',
- *   cause: originalError,
- * })
- * ```
- */
-declare class EvlogError extends Error {
-    /** HTTP status code */
-    readonly status: number;
-    readonly why?: string;
-    readonly fix?: string;
-    readonly link?: string;
-    constructor(options: ErrorOptions | string);
-    /** HTTP status text (alias for message) */
-    get statusText(): string;
-    /** HTTP status code (alias for compatibility) */
-    get statusCode(): number;
-    /** HTTP status message (alias for compatibility) */
-    get statusMessage(): string;
-    /** Structured data for serialization */
-    get data(): {
-        why?: string;
-        fix?: string;
-        link?: string;
-    } | undefined;
-    toString(): string;
-    toJSON(): Record<string, unknown>;
-}
-/**
- * Create a structured error with context for debugging and user-facing messages.
- *
- * @param options - Error message string or full options object
- * @returns EvlogError with HTTP metadata (`status`, `statusText`) and `data`; also includes `statusCode` and `statusMessage` for legacy compatibility
- *
- * @example
- * ```ts
- * // Simple error
- * throw createError('Something went wrong')
- *
- * // Structured error with context
- * throw createError({
- *   message: 'Payment failed',
- *   status: 402,
- *   why: 'Card declined by issuer',
- *   fix: 'Try a different payment method',
- *   link: 'https://docs.example.com/payments',
- * })
- * ```
- */
-declare function createError(options: ErrorOptions | string): EvlogError;
-
-export { EvlogError, createError, createError as createEvlogError };

package/dist/index.d.ts

@@ -1,5 +0,0 @@
-export { EvlogError, createError, createError as createEvlogError } from './error.js';
-export { createRequestLogger, getEnvironment, initLogger, log, shouldKeep } from './logger.js';
-export { useLogger } from './runtime/server/useLogger.js';
-export { parseError } from './runtime/utils/parseError.js';
-export { BaseWideEvent, DrainContext, EnvironmentContext, ErrorOptions, H3EventContext, IngestPayload, Log, LogLevel, LoggerConfig, ParsedError, RequestLogger, RequestLoggerOptions, SamplingConfig, SamplingRates, ServerEvent, TailSamplingCondition, TailSamplingContext, TransportConfig, WideEvent } from './types.js';

package/dist/logger.d.ts

@@ -1,40 +0,0 @@
-import { RequestLoggerOptions, RequestLogger, EnvironmentContext, LoggerConfig, Log, TailSamplingContext } from './types.js';
-
-/**
- * Initialize the logger with configuration.
- * Call this once at application startup.
- */
-declare function initLogger(config?: LoggerConfig): void;
-/**
- * Evaluate tail sampling conditions to determine if a log should be force-kept.
- * Returns true if ANY condition matches (OR logic).
- */
-declare function shouldKeep(ctx: TailSamplingContext): boolean;
-/**
- * Simple logging API - as easy as console.log
- *
- * @example
- * ```ts
- * log.info('auth', 'User logged in')
- * log.error({ action: 'payment', error: 'failed' })
- * ```
- */
-declare const log: Log;
-/**
- * Create a request-scoped logger for building wide events.
- *
- * @example
- * ```ts
- * const log = createRequestLogger({ method: 'POST', path: '/checkout' })
- * log.set({ user: { id: '123' } })
- * log.set({ cart: { items: 3 } })
- * log.emit()
- * ```
- */
-declare function createRequestLogger(options?: RequestLoggerOptions): RequestLogger;
-/**
- * Get the current environment context.
- */
-declare function getEnvironment(): EnvironmentContext;
-
-export { createRequestLogger, getEnvironment, initLogger, log, shouldKeep };

package/dist/nitro/errorHandler.d.ts

@@ -1,13 +0,0 @@
-import * as nitropack from 'nitropack';
-
-/**
- * Custom Nitro error handler that properly serializes EvlogError.
- * This ensures that 'data' (containing 'why', 'fix', 'link') is preserved
- * in the JSON response regardless of the underlying HTTP framework.
- *
- * For non-EvlogError, it preserves Nitro's default response shape while
- * sanitizing internal error details in production for 5xx errors.
- */
-declare const _default: nitropack.NitroErrorHandler;
-
-export { _default as default };

package/dist/nitro/plugin.d.ts

@@ -1,5 +0,0 @@
-import * as nitropack from 'nitropack';
-
-declare const _default: nitropack.NitroAppPlugin;
-
-export { _default as default };

package/dist/nuxt/module.d.ts

@@ -1,171 +0,0 @@
-import * as _nuxt_schema from '@nuxt/schema';
-import { EnvironmentContext, RouteConfig, SamplingConfig, TransportConfig } from '../types.js';
-
-interface ModuleOptions {
-    /**
-     * Environment context overrides.
-     */
-    env?: Partial<EnvironmentContext>;
-    /**
-     * Enable pretty printing.
-     * @default true in development, false in production
-     */
-    pretty?: boolean;
-    /**
-     * Route patterns to include in logging.
-     * Supports glob patterns like '/api/**'.
-     * If not set, all routes are logged.
-     * @example ['/api/**', '/auth/**']
-     */
-    include?: string[];
-    /**
-     * Route patterns to exclude from logging.
-     * Supports glob patterns like '/api/_nuxt_icon/**'.
-     * Exclusions take precedence over inclusions.
-     * @example ['/api/_nuxt_icon/**', '/health']
-     */
-    exclude?: string[];
-    /**
-     * Route-specific service configuration.
-     * Allows setting different service names for different routes.
-     * Patterns are matched using glob syntax.
-     *
-     * @example
-     * ```ts
-     * routes: {
-     *   '/api/foo/**': { service: 'service1' },
-     *   '/api/bar/**': { service: 'service2' }
-     * }
-     * ```
-     */
-    routes?: Record<string, RouteConfig>;
-    /**
-     * Sampling configuration for filtering logs.
-     * Allows configuring what percentage of logs to keep per level.
-     *
-     * @example
-     * ```ts
-     * sampling: {
-     *   rates: {
-     *     info: 10,    // Keep 10% of info logs
-     *     warn: 50,    // Keep 50% of warning logs
-     *     debug: 5,    // Keep 5% of debug logs
-     *     error: 100,  // Always keep errors (default)
-     *   }
-     * }
-     * ```
-     */
-    sampling?: SamplingConfig;
-    /**
-     * Transport configuration for sending client logs to the server.
-     *
-     * @example
-     * ```ts
-     * transport: {
-     *   enabled: true,  // Send logs to server API
-     *   endpoint: '/api/_evlog/ingest'  // Custom endpoint
-     * }
-     * ```
-     */
-    transport?: TransportConfig;
-    /**
-     * Axiom adapter configuration.
-     * When configured, use `createAxiomDrain()` from `evlog/axiom` to send logs.
-     *
-     * @example
-     * ```ts
-     * axiom: {
-     *   dataset: 'my-app-logs',
-     *   token: process.env.AXIOM_TOKEN,
-     * }
-     * ```
-     */
-    axiom?: {
-        /** Axiom dataset name */
-        dataset: string;
-        /** Axiom API token */
-        token: string;
-        /** Organization ID (required for Personal Access Tokens) */
-        orgId?: string;
-        /** Base URL for Axiom API. Default: https://api.axiom.co */
-        baseUrl?: string;
-        /** Request timeout in milliseconds. Default: 5000 */
-        timeout?: number;
-    };
-    /**
-     * OTLP adapter configuration.
-     * When configured, use `createOTLPDrain()` from `evlog/otlp` to send logs.
-     *
-     * @example
-     * ```ts
-     * otlp: {
-     *   endpoint: 'http://localhost:4318',
-     *   headers: {
-     *     'Authorization': `Basic ${process.env.GRAFANA_TOKEN}`,
-     *   },
-     * }
-     * ```
-     */
-    otlp?: {
-        /** OTLP HTTP endpoint (e.g., http://localhost:4318) */
-        endpoint: string;
-        /** Override service name (defaults to event.service) */
-        serviceName?: string;
-        /** Additional resource attributes */
-        resourceAttributes?: Record<string, string | number | boolean>;
-        /** Custom headers (e.g., for authentication) */
-        headers?: Record<string, string>;
-        /** Request timeout in milliseconds. Default: 5000 */
-        timeout?: number;
-    };
-    /**
-     * PostHog adapter configuration.
-     * When configured, use `createPostHogDrain()` from `evlog/posthog` to send logs.
-     *
-     * @example
-     * ```ts
-     * posthog: {
-     *   apiKey: process.env.POSTHOG_API_KEY,
-     * }
-     * ```
-     */
-    posthog?: {
-        /** PostHog project API key */
-        apiKey: string;
-        /** PostHog host URL. Default: https://us.i.posthog.com */
-        host?: string;
-        /** PostHog event name. Default: evlog_wide_event */
-        eventName?: string;
-        /** Override distinct_id (defaults to event.service) */
-        distinctId?: string;
-        /** Request timeout in milliseconds. Default: 5000 */
-        timeout?: number;
-    };
-    /**
-     * Sentry adapter configuration.
-     * When configured, use `createSentryDrain()` from `evlog/sentry` to send logs.
-     *
-     * @example
-     * ```ts
-     * sentry: {
-     *   dsn: process.env.SENTRY_DSN,
-     * }
-     * ```
-     */
-    sentry?: {
-        /** Sentry DSN */
-        dsn: string;
-        /** Environment override (defaults to event.environment) */
-        environment?: string;
-        /** Release version override (defaults to event.version) */
-        release?: string;
-        /** Additional tags to attach as attributes */
-        tags?: Record<string, string>;
-        /** Request timeout in milliseconds. Default: 5000 */
-        timeout?: number;
-    };
-}
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
-
-export { _default as default };
-export type { ModuleOptions };

package/dist/runtime/client/log.d.ts

@@ -1,10 +0,0 @@
-import { TransportConfig, Log } from '../../types.js';
-
-declare function initLog(options?: {
-    pretty?: boolean;
-    service?: string;
-    transport?: TransportConfig;
-}): void;
-declare const log: Log;
-
-export { initLog, log };

package/dist/runtime/client/plugin.d.ts

@@ -1,3 +0,0 @@
-declare const _default: any;
-
-export { _default as default };

package/dist/runtime/server/routes/_evlog/ingest.post.d.ts

@@ -1,5 +0,0 @@
-import * as h3 from 'h3';
-
-declare const _default: h3.EventHandler<h3.EventHandlerRequest, Promise<null>>;
-
-export { _default as default };

package/dist/runtime/server/useLogger.d.ts

@@ -1,28 +0,0 @@
-import { ServerEvent, RequestLogger } from '../../types.js';
-
-/**
- * Returns the request logger attached to the given server event.
- *
- * @param event - The current server event containing the context with the logger.
- * @param service - Optional service name to override the default service.
- * @returns The request-scoped logger.
- * @throws Error if the logger is not initialized on the event context.
- *
- * @example
- * export default defineEventHandler((event) => {
- *   const log = useLogger(event)
- *   log.set({ foo: 'bar' })
- *   // ...
- * })
- *
- * @example
- * // Override service name for specific routes
- * export default defineEventHandler((event) => {
- *   const log = useLogger(event, 'payment-service')
- *   log.set({ foo: 'bar' })
- *   // ...
- * })
- */
-declare function useLogger(event: ServerEvent, service?: string): RequestLogger;
-
-export { useLogger };

package/dist/runtime/utils/parseError.d.ts

@@ -1,5 +0,0 @@
-import { ParsedError } from '../../types.js';
-
-declare function parseError(error: unknown): ParsedError;
-
-export { ParsedError, parseError };

package/dist/shared/evlog.Bc35pxiY.mjs

@@ -1,10 +0,0 @@
-function getRuntimeConfig() {
-  try {
-    const { useRuntimeConfig } = require("nitropack/runtime");
-    return useRuntimeConfig();
-  } catch {
-    return void 0;
-  }
-}
-
-export { getRuntimeConfig as g };