unnbound-logger-sdk 2.0.10 → 3.0.0

package/dist/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * unnbound-logger
- *
- * A structured logging library built on Pino with TypeScript support.
- * Provides consistent, well-typed logging across different operational contexts.
- */
-import { UnnboundLogger } from './unnbound-logger';
-import { LogLevel, LogType, HttpMethod, LoggerOptions, GeneralLogOptions, HttpRequestLogOptions, HttpResponseLogOptions, SftpTransactionLogOptions, DbQueryTransactionLogOptions, Log, LogTransaction, HttpRequestLog, HttpResponseLog, SftpTransactionLog, DbQueryTransactionLog, SerializableError } from './types';
-import { clearTraceId } from './utils/logger-utils';
-export { UnnboundLogger, LogLevel, LogType, HttpMethod, LoggerOptions, GeneralLogOptions, HttpRequestLogOptions, HttpResponseLogOptions, SftpTransactionLogOptions, DbQueryTransactionLogOptions, Log, LogTransaction, HttpRequestLog, HttpResponseLog, SftpTransactionLog, DbQueryTransactionLog, SerializableError, clearTraceId, };

package/dist/types.d.ts

@@ -1,132 +0,0 @@
-/**
- * Type definitions for structured logging library
- */
-/**
- * Available log levels
- */
-export type LogLevel = "info" | "debug" | "error" | "warn";
-/**
- * Available log types
- */
-export type LogType = "general" | "httpRequest" | "httpResponse" | "sftpTransaction" | "dbQueryTransaction";
-/**
- * HTTP methods supported for HTTP logging
- */
-export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'HEAD';
-export interface SerializableError {
-    name: string;
-    message: string;
-    stack?: string;
-}
-export interface Log<T extends LogType = 'general'> {
-    logId: string;
-    level: LogLevel;
-    type: T;
-    message: string;
-    serviceId: string;
-    deploymentId: string;
-    workflowId: string;
-    traceId: string;
-    requestId: string;
-    error?: SerializableError;
-}
-export interface LogTransaction<T extends LogType> extends Log<T> {
-    duration: number;
-}
-export interface HttpRequestLog extends LogTransaction<'httpRequest'> {
-    httpRequest: {
-        url: string;
-        method: string;
-        headers: Record<string, string>;
-        ip?: string;
-        body?: unknown;
-    };
-}
-export interface HttpResponseLog extends LogTransaction<'httpResponse'> {
-    httpResponse: {
-        url: string;
-        method: string;
-        headers: Record<string, string>;
-        ip?: string;
-        status: number;
-        body?: unknown;
-    };
-}
-export interface SftpTransactionLog extends LogTransaction<'sftpTransaction'> {
-    sftp: {
-        host: string;
-        username: string;
-        operation: 'upload' | 'download' | 'list' | 'delete' | 'rename' | 'stat';
-        path: string;
-        status: 'success' | 'failure';
-        bytesTransferred?: number;
-        filesListed?: number;
-        sourcePath?: string;
-    };
-}
-export interface DbQueryTransactionLog extends LogTransaction<'dbQueryTransaction'> {
-    db: {
-        instance: string;
-        vendor: 'postgres' | 'mysql' | 'mssql' | 'mongodb';
-        query?: string;
-        status: 'success' | 'failure';
-        rowsReturned?: number;
-        rowsAffected?: number;
-    };
-}
-/**
- * Configuration options for the logger
- */
-export interface LoggerOptions {
-    /** Optional trace header key */
-    traceHeaderKey?: string;
-    /** Routes to ignore in trace middleware (supports glob patterns) */
-    ignoreTraceRoutes?: string[];
-    /** Routes to ignore in axios trace middleware (supports glob patterns) */
-    ignoreAxiosTraceRoutes?: string[];
-}
-/**
- * Options for general logs
- */
-export interface GeneralLogOptions {
-    /** Log level override */
-    level?: LogLevel;
-    /** Custom trace ID */
-    traceId?: string;
-    /** Custom request ID */
-    requestId?: string;
-    /** Custom metadata */
-    [key: string]: unknown;
-}
-/**
- * Options for HTTP request logs
- */
-export interface HttpRequestLogOptions extends GeneralLogOptions {
-    /** Start time of the request for duration calculation */
-    startTime?: number;
-}
-/**
- * Options for HTTP response logs
- */
-export interface HttpResponseLogOptions extends HttpRequestLogOptions {
-    /** Duration of the request in milliseconds */
-    duration?: number;
-}
-/**
- * Options for SFTP transaction logs
- */
-export interface SftpTransactionLogOptions extends GeneralLogOptions {
-    /** Start time of the transaction for duration calculation */
-    startTime?: number;
-    /** Duration of the transaction in milliseconds */
-    duration?: number;
-}
-/**
- * Options for database query transaction logs
- */
-export interface DbQueryTransactionLogOptions extends GeneralLogOptions {
-    /** Start time of the query for duration calculation */
-    startTime?: number;
-    /** Duration of the query in milliseconds */
-    duration?: number;
-}

package/dist/types.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * Type definitions for structured logging library
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/unnbound-logger.d.ts

@@ -1,124 +0,0 @@
-import { LogLevel, LoggerOptions, GeneralLogOptions, HttpRequestLogOptions, HttpResponseLogOptions, SftpTransactionLogOptions, DbQueryTransactionLogOptions, Log, HttpRequestLog, HttpResponseLog, SftpTransactionLog, DbQueryTransactionLog } from './types';
-import { Request, Response, NextFunction } from 'express';
-import { InternalAxiosRequestConfig } from 'axios';
-declare module 'axios' {
-    interface InternalAxiosRequestConfig {
-        metadata?: {
-            startTime: number;
-            requestId?: string;
-        };
-    }
-}
-/**
- * UnnboundLogger provides typed, structured logging using Pino
- */
-export declare class UnnboundLogger {
-    private logger;
-    private workflowId;
-    private workflowUrl;
-    private serviceId;
-    private deploymentId;
-    private traceHeaderKey;
-    private ignoreTraceRoutes;
-    private ignoreAxiosTraceRoutes;
-    /**
-     * Creates a new UnnboundLogger instance
-     * @param options - Configuration options for the logger
-     */
-    constructor(options?: LoggerOptions);
-    /**
-     * Checks if a path matches any of the ignore patterns
-     * @param path - The path to check
-     * @param patterns - Array of glob patterns to match against
-     * @returns boolean indicating if the path should be ignored
-     */
-    private shouldIgnorePath;
-    /**
-     * Logs a general message
-     * @param level - Log level
-     * @param message - Log message
-     * @param options - Additional logging options
-     */
-    log(level: LogLevel, message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log;
-    /**
-     * Logs an error message
-     * @param message - Error message or object
-     * @param options - Additional logging options
-     */
-    error(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log;
-    /**
-     * Logs a warning message
-     * @param message - Warning message
-     * @param options - Additional logging options
-     */
-    warn(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log;
-    /**
-     * Logs an info message
-     * @param message - Info message
-     * @param options - Additional logging options
-     */
-    info(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log;
-    /**
-     * Logs a debug message
-     * @param message - Debug message
-     * @param options - Additional logging options
-     */
-    debug(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log;
-    /**
-     * Constructs the full URL from request information
-     * @param req - Express request object
-     * @returns Full URL string
-     */
-    private constructFullUrl;
-    /**
-     * Logs an HTTP request
-     * @param req - Express request object
-     * @param options - Additional logging options
-     * @returns The request ID for correlating with the response
-     */
-    httpRequest(req: Request, options?: HttpRequestLogOptions): HttpRequestLog;
-    /**
-     * Logs an HTTP response
-     * @param res - Express response object
-     * @param req - Express request object
-     * @param options - Additional logging options
-     */
-    httpResponse(res: Response, req: Request, options?: HttpResponseLogOptions): HttpResponseLog;
-    /**
-     * Logs an SFTP transaction
-     * @param operation - SFTP operation details
-     * @param options - Additional logging options
-     */
-    sftpTransaction(operation: {
-        host: string;
-        username: string;
-        operation: 'upload' | 'download' | 'list' | 'delete' | 'rename' | 'stat';
-        path: string;
-        status: 'success' | 'failure';
-        bytesTransferred?: number;
-        filesListed?: number;
-        sourcePath?: string;
-    }, options?: SftpTransactionLogOptions): SftpTransactionLog;
-    /**
-     * Logs a database query transaction
-     * @param query - Database query details
-     * @param options - Additional logging options
-     */
-    dbQueryTransaction(query: {
-        instance: string;
-        vendor: 'postgres' | 'mysql' | 'mssql' | 'mongodb';
-        query?: string;
-        status: 'success' | 'failure';
-        rowsReturned?: number;
-        rowsAffected?: number;
-    }, options?: DbQueryTransactionLogOptions): DbQueryTransactionLog;
-    traceMiddleware: (req: Request, res: Response, next: NextFunction) => void;
-    axiosTraceMiddleware: {
-        onFulfilled: (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig;
-        onRejected: (error: any) => any;
-    };
-    axiosResponseInterceptor: {
-        onFulfilled: (response: any) => any;
-        onRejected: (error: any) => any;
-    };
-}