@oconde/radar 0.0.0-stage → 0.2.0

package/dist/client-DbBsXgpj.d.ts

@@ -0,0 +1,130 @@
+import { UserInfo, LogLevel, RequestInfo, RuntimeInfo, CheckInStatus, ExceptionInfo } from './protocol/index.js';
+
+type HeaderValue = string | string[] | number | undefined;
+type RequestLike = {
+    method?: string;
+    url?: string;
+    originalUrl?: string;
+    baseUrl?: string;
+    route?: {
+        path?: unknown;
+    };
+    params?: Record<string, unknown>;
+    query?: unknown;
+    headers: Record<string, HeaderValue>;
+    body?: unknown;
+    ip?: string;
+    socket?: {
+        remoteAddress?: string;
+    };
+};
+type ResponseLike = {
+    statusCode: number;
+    setHeader(name: string, value: string): unknown;
+    once(event: 'finish', listener: () => void): unknown;
+};
+type RadarContext = {
+    requestId: string;
+    startedAt: number;
+    req?: RequestLike;
+    route?: string;
+    user?: UserInfo;
+};
+
+type RadarMiddleware = (req: RequestLike, res: ResponseLike, next: (error?: unknown) => void) => void;
+
+type RedactMode = 'mask' | 'none';
+type RequestDetail = 'full' | 'route';
+type RadarOptions = {
+    key?: string;
+    endpoint?: string;
+    environment?: string;
+    release?: string;
+    enabled?: boolean;
+    console?: boolean;
+    minLevel?: LogLevel;
+    redact?: RedactMode;
+    requestDetail?: RequestDetail;
+    logRequests?: boolean;
+    ignorePaths?: string[];
+    captureUnhandled?: boolean;
+    debug?: boolean;
+};
+type ResolvedOptions = {
+    key: string | undefined;
+    endpoint: string;
+    environment: string;
+    release: string | undefined;
+    enabled: boolean;
+    console: boolean;
+    minLevel: LogLevel;
+    redact: RedactMode;
+    requestDetail: RequestDetail;
+    logRequests: boolean;
+    ignorePaths: string[];
+    captureUnhandled: boolean;
+    debug: boolean;
+};
+
+type MapLocator = (file: string) => string | null;
+type EnrichOptions = {
+    mapLocator?: MapLocator;
+    inferFunctionNames?: boolean;
+};
+
+type Attributes = Record<string, unknown>;
+type LogRequestOptions = {
+    level?: LogLevel;
+    redact?: RedactMode;
+};
+type CheckInOptions = {
+    checkInId?: string;
+    durationMs?: number;
+};
+type CaptureExceptionOptions = {
+    handled?: boolean;
+    level?: 'error' | 'fatal';
+    request?: RequestInfo | null;
+    attrs?: Attributes;
+    runtime?: RuntimeInfo | null;
+    enrich?: EnrichOptions;
+};
+declare class RadarClient {
+    private options;
+    private transport;
+    private initialized;
+    private closed;
+    private readonly captured;
+    get isEnabled(): boolean;
+    get settings(): Readonly<ResolvedOptions>;
+    init(options?: RadarOptions): void;
+    debug(message: string, data?: Attributes): void;
+    info(message: string, data?: Attributes): void;
+    warn(message: string, data?: Attributes): void;
+    error(message: string, data?: Attributes): void;
+    logRequest(title: string, data?: Attributes, options?: LogRequestOptions): void;
+    captureError(error: unknown, data?: Attributes): void;
+    captureUnhandled(error: unknown, level: 'error' | 'fatal'): void;
+    setUser(user: UserInfo): void;
+    track<T>(name: string, fn: () => T | Promise<T>, data?: Attributes): Promise<T>;
+    withContext<T>(fn: () => T, options?: {
+        requestId?: string;
+    }): T;
+    checkIn(slug: string, status: CheckInStatus, options?: CheckInOptions): Promise<void>;
+    cron<T>(slug: string, fn: () => T | Promise<T>): Promise<T>;
+    middleware(): RadarMiddleware;
+    shouldLogRequest(req: RequestLike): boolean;
+    logHttpRequest(context: RadarContext, status: number): void;
+    flush(timeoutMs?: number): Promise<void>;
+    close(timeoutMs?: number): Promise<void>;
+    private emitLog;
+    captureException(exception: ExceptionInfo, options?: CaptureExceptionOptions): void;
+    private emitError;
+    private emitException;
+    private print;
+    private safely;
+    private debugWarn;
+    private writeWarning;
+}
+
+export { type Attributes as A, type CaptureExceptionOptions as C, type EnrichOptions as E, type LogRequestOptions as L, type MapLocator as M, RadarClient as R, type CheckInOptions as a, type RadarMiddleware as b, type RadarOptions as c, type RedactMode as d, type RequestLike as e, type ResponseLike as f };