node-logy 0.1.1 → 0.1.3

package/dist/index.d.ts

@@ -1,99 +1,256 @@
-import type types = require("./types");
+import { LogLevelType } from "./protocol";
 /**
- * Represents a logger used to log to node's stdout console and also save logs to log files.
- * Uses a seperate process that writes to log file while the main logger in your application process is non blocking
+ * Timestamp format options
  */
-declare class NodeLogger {
+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>;
     /**
-     * Holds the options passed to the logger
+     * 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 ref to the go binary that we write to the stdin of
+     * 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 _spawnRef;
+    private _initializeDirectory;
     /**
-     * Indicates if flush has been sent
+     * Extract call site information (file:line:column) from stack trace
      */
-    private _isFlushing;
+    private _getCallSite;
     /**
-     * Tracks the UTC date (YYYY-MM-DD) to handle daily file rotation
+     * Check if a log level should be processed based on filtering rules
      */
-    private _currentDateStr;
+    private _shouldLog;
     /**
-     * Pass additional options on initialization to change the logger's behaviour
-     * @param options Change the behaviour of the logger
+     * Verifies the log directory is writable
      */
-    constructor(options?: Partial<types.NodeLoggerOptions>);
+    private _verifyWritable;
     /**
-     * Helper to format a date into a UTC YYYY-MM-DD string
+     * Get the string representation of a log level
      */
-    private getUtcDateString;
+    private _getLevelString;
     /**
-     * Checks if the UTC day has changed
+     * Format timestamp based on the configured timestampType
      */
-    private checkDateRotation;
+    private _formatTimestamp;
     /**
-     * Trys to find the `node_process` file which spawn the protcol handler
-     * @returns The path to the file or undefined
+     * Apply custom format string to date
+     * Tokens: YYYY=year, MM=month, DD=day, HH=hour, mm=minute, ss=second, ms=millisecond
      */
-    private findNodeProcessFile;
+    private _applyCustomFormat;
     /**
-     * Log information
-     * @param level The specific level of log message
-     * @param content A message or error object or object
-     * @param contents Any other messages or error objects
+     * Convert any value to string representation
      */
-    private log;
+    private _stringify;
     /**
-     * Logs an informational message to the console
-     * @param message The message to log
-     * @param messages Any other message objects or error objects
+     * Format a log message with optional fields
      */
-    info(message: unknown, ...messages: unknown[]): void;
+    private _formatMessage;
     /**
-     * Logs a warning message to the console
-     * @param message The message to log
-     * @param messages Any other message objects or error objects
+     * Apply color to the entire message if colored output is enabled
      */
-    warn(message: unknown, ...messages: unknown[]): void;
+    private _colorize;
     /**
-     * Logs an error message to the console.
-     * It is recommended you pass the actual error object so we can print as much information as possible.
-     *
-     * For example:
-     *
-     * ```ts
-     * logger.error(new Error(""));
-     * ```
-     * @param messageOrError The error object or message to log
-     * @param messages Any other message objects or error objects
+     * 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
      */
-    error(messageOrError: unknown, ...messages: unknown[]): void;
+    log(level: LogLevelType, message: any, ...messages: any[]): void;
     /**
-     * Used to write any remaning logs to the stdin and close the sidecar logger - NEEDS to be called on app exit or on app cleanup
-     * as if not it will keep the app alive and wait for flush command
+     * 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>;
     /**
-     * Captures the stack trace of the caller of the logger (not the logger itself)
+     * Used to reload / refresh the process
      */
-    private getLogCallStack;
+    reload(): Promise<void>;
     /**
-     * Write to the stdin of the process in the protocol defined
-     * @param request The request payload
+     * Used to shut down the child process and clean up
      */
-    private writeToStdin;
+    shutdown(): Promise<void>;
     /**
-     * Extracts as much information as possible from an error or object or any other type and returns it as a string, if it has multiple fields to it
-     * then they will be serpated by new lines
-     * @param object The error object or any object to extract information from
-     * @returns A detailed string representation of the error/object
+     * Get current logger options (read-only copy)
      */
-    private extractInfo;
+    get options(): Readonly<LoggerOptions>;
 }
-declare const _default: {
-    NodeLogger: typeof NodeLogger;
-};
-export = _default;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,YAAY,KAAK,GAAG,QAAQ,SAAS,CAAC,CAAC;AAwBvC;;;GAGG;AACH,cAAM,UAAU;IACd;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA0B;IAE1C;;OAEG;IACH,OAAO,CAAC,SAAS,CAA6D;IAE9E;;OAEG;IACH,OAAO,CAAC,WAAW,CAAS;IAE5B;;OAEG;IACH,OAAO,CAAC,eAAe,CAAS;IAEhC;;;OAGG;gBACS,OAAO,GAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAkB;IA6CtE;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAOxB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAczB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAY3B;;;;;OAKG;IACH,OAAO,CAAC,GAAG;IAoDX;;;;OAIG;IACI,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE;IAIpD;;;;OAIG;IACI,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE;IAIpD;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,cAAc,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE;IAI5D;;;OAGG;IACI,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAiC7B;;OAEG;IACH,OAAO,CAAC,eAAe;IAYvB;;;OAGG;IACH,OAAO,CAAC,YAAY;IA6BpB;;;;;OAKG;IACH,OAAO,CAAC,WAAW;CA2FpB;;;;AAED,kBAEE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.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"}