node-logy 0.1.0 → 0.1.2

package/dist/logger.d.ts

@@ -0,0 +1,256 @@
+import { LogLevelType } from "./protocol";
+/**
+ * Timestamp format options
+ */
+export type TimestampType = "iso" | "locale" | "utc" | "unix" | "unix_ms" | "date" | "time" | "datetime" | "short" | "custom";
+/**
+ * Options to change the logger
+ */
+export type LoggerOptions = {
+    /**
+     * Where to store the log files output
+     */
+    basePath: string;
+    /**
+     * If this logger should save logs to log files
+     */
+    saveToLogFiles: boolean;
+    /**
+     * If this logger log's should be printed to the stdout of the process
+     */
+    outputToConsole: boolean;
+    /**
+     * If the output to console should be colored
+     */
+    useColoredOutput: boolean;
+    /**
+     * Map of specific log level and what color to use
+     */
+    colorMap: Record<LogLevelType, string>;
+    /**
+     * If it should add timestamps to logs
+     */
+    showTimeStamps: boolean;
+    /**
+     * Which timestamp format to use (only applies when showTimeStamps is true)
+     */
+    timestampType: TimestampType;
+    /**
+     * Custom timestamp format string (only used when timestampType is "custom")
+     * Use tokens: YYYY=year, MM=month, DD=day, HH=hour, mm=minute, ss=second, ms=millisecond
+     */
+    customTimestampFormat?: string;
+    /**
+     * If it should show log level
+     */
+    showLogLevel: boolean;
+    /**
+     * Map a specific log level with a string value use for it
+     */
+    logLevelMap: Record<LogLevelType, string>;
+    /**
+     * Minimum log level to process (filters out lower levels)
+     */
+    minLevel?: LogLevelType;
+    /**
+     * Maximum log level to process (filters out higher levels)
+     */
+    maxLevel?: LogLevelType;
+    /**
+     * Specific levels to include (whitelist)
+     */
+    includeLevels?: LogLevelType[];
+    /**
+     * Specific levels to exclude (blacklist)
+     */
+    excludeLevels?: LogLevelType[];
+    /**
+     * Filter function to determine if a log should be processed
+     */
+    filter?: (level: LogLevelType, message: any) => boolean;
+    /**
+     * Include process ID in logs
+     */
+    showProcessId?: boolean;
+    /**
+     * Include hostname in logs
+     */
+    showHostname?: boolean;
+    /**
+     * Include environment name (dev/prod) in logs
+     */
+    environment?: string;
+    /**
+     * Show where it was called at (file:line:column)
+     */
+    showCallSite?: boolean;
+};
+/**
+ * Custom error for logger initialization failures
+ */
+export declare class LoggerInitializationError extends Error {
+    constructor(message: string);
+}
+/**
+ * Used to log to console and also the log files
+ */
+export declare class Logger {
+    /**
+     * Local refrence to options passed
+     */
+    private _options;
+    /**
+     * Holds the spawned side car process
+     */
+    private _process;
+    /**
+     * Holds the process stdout buffer content
+     */
+    private _processStdoutBuffer;
+    /**
+     * Used to encode request to / from binary protocol
+     */
+    private _requestEncoder;
+    /**
+     * Used to encode responses to / from binary protocol
+     */
+    private _responseEncoder;
+    /**
+     * A requests id
+     */
+    private _id;
+    /**
+     * Gets the next ID if it exceeds 1 million then rolls back to zero
+     */
+    private _getNextId;
+    /**
+     * Holds pending requests that expect a response
+     */
+    private _pending;
+    constructor(options?: Partial<LoggerOptions>);
+    /**
+     * Get the path to the server / sidecar
+     * @returns Path to the server
+     */
+    private _getServerFilePath;
+    /**
+     * Inits the side car process
+     */
+    private _initProcess;
+    /**
+     * Writes to the stdin of the process
+     */
+    private _writeToStdin;
+    /**
+     * Clears pending requests on process exit/error
+     */
+    private _clearPending;
+    /**
+     * Parses the stdout buffer produced by the spawned process
+     * Uses ResponseEncoder for all protocol operations
+     */
+    private _parseProcessStdout;
+    /**
+     * Handle a decoded response
+     */
+    private _handleResponse;
+    /**
+     * Resolve any pending requests that expected a response
+     * @param response The response
+     */
+    private _resolvePending;
+    /**
+     * Send a request that expects a response to the sidecar process
+     * @param request The request to send that expects a response
+     */
+    private _sendRequest;
+    /**
+     * Validates the basePath option
+     */
+    private _validateBasePath;
+    /**
+     * Creates the log directory if file logging is enabled
+     */
+    private _initializeDirectory;
+    /**
+     * Extract call site information (file:line:column) from stack trace
+     */
+    private _getCallSite;
+    /**
+     * Check if a log level should be processed based on filtering rules
+     */
+    private _shouldLog;
+    /**
+     * Verifies the log directory is writable
+     */
+    private _verifyWritable;
+    /**
+     * Get the string representation of a log level
+     */
+    private _getLevelString;
+    /**
+     * Format timestamp based on the configured timestampType
+     */
+    private _formatTimestamp;
+    /**
+     * Apply custom format string to date
+     * Tokens: YYYY=year, MM=month, DD=day, HH=hour, mm=minute, ss=second, ms=millisecond
+     */
+    private _applyCustomFormat;
+    /**
+     * Convert any value to string representation
+     */
+    private _stringify;
+    /**
+     * Format a log message with optional fields
+     */
+    private _formatMessage;
+    /**
+     * Apply color to the entire message if colored output is enabled
+     */
+    private _colorize;
+    /**
+     * Log a specific level and content
+     * @param level The specific level to log
+     * @param message The content of the message
+     * @param messages Any addtional messages
+     */
+    log(level: LogLevelType, message: any, ...messages: any[]): void;
+    /**
+     * Convenience method for INFO level
+     */
+    info(message: any, ...messages: any[]): void;
+    /**
+     * Convenience method for WARN level
+     */
+    warn(message: any, ...messages: any[]): void;
+    /**
+     * Convenience method for ERROR level
+     */
+    error(message: any, ...messages: any[]): void;
+    /**
+     * Convenience method for DEBUG level
+     */
+    debug(message: any, ...messages: any[]): void;
+    /**
+     * Convenience method for FATAL level
+     */
+    fatal(message: any, ...messages: any[]): void;
+    /**
+     * Flush remaning buffer to log files
+     */
+    flush(): Promise<void>;
+    /**
+     * Used to reload / refresh the process
+     */
+    reload(): Promise<void>;
+    /**
+     * Used to shut down the child process and clean up
+     */
+    shutdown(): Promise<void>;
+    /**
+     * Get current logger options (read-only copy)
+     */
+    get options(): Readonly<LoggerOptions>;
+}
+//# 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":"AAEA,OAAO,EAEL,YAAY,EAMb,MAAM,YAAY,CAAC;AAIpB;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,KAAK,GACL,QAAQ,GACR,KAAK,GACL,MAAM,GACN,SAAS,GACT,MAAM,GACN,MAAM,GACN,UAAU,GACV,OAAO,GACP,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,aAAa,EAAE,aAAa,CAAC;IAE7B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC;IAExD;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAoDF;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,KAAK;gBACtC,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+C;IAE/D;;OAEG;IACH,OAAO,CAAC,oBAAoB,CAA2B;IAEvD;;OAEG;IACH,OAAO,CAAC,eAAe,CAAwB;IAE/C;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAyB;IAEjD;;OAEG;IACH,OAAO,CAAC,GAAG,CAAK;IAEhB;;OAEG;IACH,OAAO,CAAC,UAAU,CAMhB;IAEF;;OAEG;IACH,OAAO,CAAC,QAAQ,CAMF;gBAEF,OAAO,GAAE,OAAO,CAAC,aAAa,CAAM;IAuBhD;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAI1B;;OAEG;IACH,OAAO,CAAC,YAAY;IAsCpB;;OAEG;IACH,OAAO,CAAC,aAAa;IASrB;;OAEG;IACH,OAAO,CAAC,aAAa;IAQrB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAgC3B;;OAEG;IACH,OAAO,CAAC,eAAe;IAUvB;;;OAGG;IACH,OAAO,CAAC,eAAe;IAYvB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAkCpB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAsBzB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAkB5B;;OAEG;IACH,OAAO,CAAC,YAAY;IA0CpB;;OAEG;IACH,OAAO,CAAC,UAAU;IAyClB;;OAEG;IACH,OAAO,CAAC,eAAe;IAcvB;;OAEG;IACH,OAAO,CAAC,eAAe;IAIvB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAgDxB;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;OAEG;IACH,OAAO,CAAC,UAAU;IA0ElB;;OAEG;IACH,OAAO,CAAC,cAAc;IA0DtB;;OAEG;IACH,OAAO,CAAC,SAAS;IASjB;;;;;OAKG;IACH,GAAG,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI;IAsChE;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI;IAI5C;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI;IAI5C;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI;IAI7C;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI;IAI7C;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI;IAI7C;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAStB;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IASvB;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IASzB;;OAEG;IACH,IAAI,OAAO,IAAI,QAAQ,CAAC,aAAa,CAAC,CAErC;CACF"}