@hkdigital/lib-core 0.3.11 → 0.3.13

package/dist/logging/internal/adapters/pino.js

@@ -1,142 +1,160 @@
-/**
- * Pino adapter for server-side logging
- */
-
-import pino from 'pino';
-import { dev } from '$app/environment';
-
-/**
- * Pino adapter that bridges Logger events to pino
- */
-export class PinoAdapter {
-  #projectRoot = null;
-
-  /**
-   * Create a new PinoAdapter
-   *
-   * @param {Object} [options] - Pino configuration options
-   */
-  constructor(options = {}) {
-    // Determine project root once for stack trace cleaning
-    this.#projectRoot = import.meta.env.VITE_PROJECT_ROOT || process.cwd();
-    const baseOptions = {
-      serializers: {
-        err: (err) => {
-          const chain = [];
-          let current = err;
-          let isFirst = true;
-
-          while (current) {
-            /** @type {import('./typedef').ErrorSummary} */
-            const serialized = {
-              name: current.name,
-              message: current.message,
-              ...(isFirst &&
-                this.pino.level === 'debug' && {
-                  stack: this.#cleanStackTrace(current.stack)
-                })
-            };
-
-            // Include HttpError-specific properties
-            if (current.status !== undefined) {
-              serialized.status = current.status;
-            }
-            if (current.details !== undefined) {
-              serialized.details = current.details;
-            }
-
-            chain.push(serialized);
-            current = current.cause;
-            isFirst = false;
-          }
-
-          return { errorChain: chain };
-        }
-      }
-    };
-
-    const devOptions = dev
-      ? {
-          level: 'debug',
-          transport: {
-            target: 'pino-pretty',
-            options: {
-              colorize: true
-            }
-          }
-        }
-      : {};
-
-    this.pino = pino({ ...baseOptions, ...devOptions, ...options });
-  }
-
-  /**
-   * Clean stack trace by removing project root path
-   *
-   * @param {string} stack - Original stack trace
-   * @returns {string} Cleaned stack trace
-   */
-  #cleanStackTrace(stack) {
-    if (!stack || !this.#projectRoot) {
-      return stack;
-    }
-
-    // Escape special regex characters in the project root path
-    const escapedRoot = this.#projectRoot.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-    
-    // Replace project root path with relative path, but only after "at " to avoid 
-    // accidental replacements in error messages or other parts of the stack
-    // Match the project root followed by a path separator
-    const regex = new RegExp(`(\\s+at\\s+.*\\()${escapedRoot}[\\/\\\\]`, 'g');
-    
-    return stack.replace(regex, '$1');
-  }
-
-  /**
-   * Handle log events from Logger
-   *
-   * @param {Object} logEvent - Log event from Logger
-   */
-  handleLog(logEvent) {
-    const { level, message, details, source, timestamp } = logEvent;
-
-    const logData = {
-      source,
-      timestamp
-    };
-
-    // Check if details contains an error and promote it to err property for pino serializer
-    if (details) {
-      if (details instanceof Error) {
-        // details is directly an error
-        logData.err = details;
-      } else if (details.error instanceof Error) {
-        // details has an error property
-        logData.err = details.error;
-        // Include other details except the error
-        const { error, ...otherDetails } = details;
-        if (Object.keys(otherDetails).length > 0) {
-          logData.details = otherDetails;
-        }
-      } else {
-        // No error found in details, include all details
-        logData.details = details;
-      }
-    }
-
-    this.pino[level](logData, message);
-  }
-
-  /**
-   * Create a child logger with additional context
-   *
-   * @param {Object} context - Additional context data
-   * @returns {PinoAdapter} New adapter instance with context
-   */
-  child(context) {
-    const childPino = this.pino.child(context);
-    const adapter = new PinoAdapter();
-    adapter.pino = childPino;
-    return adapter;
-  }
-}
+/**
+ * Pino adapter for server-side logging
+ */
+
+import pino from 'pino';
+import { dev } from '$app/environment';
+
+/**
+ * Pino adapter that bridges Logger events to pino
+ */
+export class PinoAdapter {
+  #projectRoot = null;
+
+  /**
+   * Create a new PinoAdapter
+   *
+   * @param {Object} [options] - Pino configuration options
+   */
+  constructor(options = {}) {
+    // Determine project root once for stack trace cleaning
+    this.#projectRoot = import.meta.env.VITE_PROJECT_ROOT || process.cwd();
+    const baseOptions = {
+      serializers: {
+        err: (err) => {
+          const chain = [];
+          let current = err;
+          let isFirst = true;
+
+          while (current) {
+            /** @type {import('./typedef').ErrorSummary} */
+            const serialized = {
+              name: current.name,
+              message: current.message,
+              ...(isFirst &&
+                this.pino.level === 'debug' && {
+                  stack: this.#cleanStackTrace(current.stack)
+                })
+            };
+
+            // Include HttpError-specific properties
+            if (current.status !== undefined) {
+              serialized.status = current.status;
+            }
+            if (current.details !== undefined) {
+              serialized.details = current.details;
+            }
+
+            chain.push(serialized);
+            current = current.cause;
+            isFirst = false;
+          }
+
+          return { errorChain: chain };
+        }
+      }
+    };
+
+    // Add error handling for missing pino-pretty in dev
+    if (dev) {
+      const devOptions = {
+        level: 'debug',
+        transport: {
+          target: 'pino-pretty',
+          options: {
+            colorize: true
+          }
+        }
+      };
+
+      try {
+        this.pino = pino({ ...baseOptions, ...devOptions, ...options });
+      } catch (error) {
+        if (error.message.includes('pino-pretty')) {
+          const errorMessage = `
+╭─────────────────────────────────────────────────────────────╮
+│                     Missing Dependency                      │
+├─────────────────────────────────────────────────────────────┤
+│  'pino-pretty' is required for development logging          │
+│  Install it with: pnpm add -D pino-pretty                   │
+╰─────────────────────────────────────────────────────────────╯`;
+          console.error(errorMessage);
+          throw new Error('pino-pretty is required for development mode');
+        }
+        throw error;
+      }
+    } else {
+      this.pino = pino({ ...baseOptions, ...options });
+    }
+  }
+
+  /**
+   * Clean stack trace by removing project root path
+   *
+   * @param {string} stack - Original stack trace
+   * @returns {string} Cleaned stack trace
+   */
+  #cleanStackTrace(stack) {
+    if (!stack || !this.#projectRoot) {
+      return stack;
+    }
+
+    // Escape special regex characters in the project root path
+    const escapedRoot = this.#projectRoot.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+    
+    // Replace project root path with relative path, but only after "at " to avoid 
+    // accidental replacements in error messages or other parts of the stack
+    // Match the project root followed by a path separator
+    const regex = new RegExp(`(\\s+at\\s+.*\\()${escapedRoot}[\\/\\\\]`, 'g');
+    
+    return stack.replace(regex, '$1');
+  }
+
+  /**
+   * Handle log events from Logger
+   *
+   * @param {Object} logEvent - Log event from Logger
+   */
+  handleLog(logEvent) {
+    const { level, message, details, source, timestamp } = logEvent;
+
+    const logData = {
+      source,
+      timestamp
+    };
+
+    // Check if details contains an error and promote it to err property for pino serializer
+    if (details) {
+      if (details instanceof Error) {
+        // details is directly an error
+        logData.err = details;
+      } else if (details.error instanceof Error) {
+        // details has an error property
+        logData.err = details.error;
+        // Include other details except the error
+        const { error, ...otherDetails } = details;
+        if (Object.keys(otherDetails).length > 0) {
+          logData.details = otherDetails;
+        }
+      } else {
+        // No error found in details, include all details
+        logData.details = details;
+      }
+    }
+
+    this.pino[level](logData, message);
+  }
+
+  /**
+   * Create a child logger with additional context
+   *
+   * @param {Object} context - Additional context data
+   * @returns {PinoAdapter} New adapter instance with context
+   */
+  child(context) {
+    const childPino = this.pino.child(context);
+    const adapter = new PinoAdapter();
+    adapter.pino = childPino;
+    return adapter;
+  }
+}

package/dist/logging/internal/adapters/typedef.js

@@ -1,10 +1,10 @@
-/**
- * @typedef {Object} ErrorSummary
- * @property {string} name - The name of the exception/error
- * @property {string} message - The error message
- * @property {string} [stack] Stack trace (in debug mode for first exception)
- * @property {number} [status] - HTTP status code (for HttpError instances)
- * @property {*} [details] - Additional error details (for HttpError instances)
- */
-
- export default {};
+/**
+ * @typedef {Object} ErrorSummary
+ * @property {string} name - The name of the exception/error
+ * @property {string} message - The error message
+ * @property {string} [stack] Stack trace (in debug mode for first exception)
+ * @property {number} [status] - HTTP status code (for HttpError instances)
+ * @property {*} [details] - Additional error details (for HttpError instances)
+ */
+
+ export default {};

package/dist/logging/internal/{unified-logger/constants.js → constants.js}

@@ -1,22 +1,22 @@
-
-// Log level and log event names
-export const DEBUG = 'debug';
-export const INFO = 'info';
-export const WARN = 'warn';
-export const ERROR = 'error';
-
-// Use NONE to set log level to disable all logging
-export const NONE = 'none';
-
-// Level values for filtering (higher = more important)
-export const LEVELS = {
-  [DEBUG]: 1,
-  [INFO]: 2,
-  [WARN]: 3,
-  [ERROR]: 4,
-  [NONE]: 5
-};
-
-// Event name for generic events
-export const LOG = 'log';
-
+
+// Log level and log event names
+export const DEBUG = 'debug';
+export const INFO = 'info';
+export const WARN = 'warn';
+export const ERROR = 'error';
+
+// Use NONE to set log level to disable all logging
+export const NONE = 'none';
+
+// Level values for filtering (higher = more important)
+export const LEVELS = {
+  [DEBUG]: 1,
+  [INFO]: 2,
+  [WARN]: 3,
+  [ERROR]: 4,
+  [NONE]: 5
+};
+
+// Event name for generic events
+export const LOG = 'log';
+

package/dist/logging/internal/factories/client.d.ts

@@ -7,4 +7,4 @@
  * @returns {Logger} Configured logger instance
  */
 export function createClientLogger(name: string, level?: string, consoleOptions?: any): Logger;
-import { Logger } from '../unified-logger';
+import { Logger } from '../logger/index.js';

package/dist/logging/internal/factories/client.js

@@ -1,21 +1,21 @@
-import { Logger } from '../unified-logger';
-import { ConsoleAdapter } from '../adapters/console.js';
-import { INFO } from '../unified-logger/constants.js';
-
-/**
- * Create a client-side logger with console adapter
- *
- * @param {string} name
- * @param {string} [level=INFO] - Initial log level
- * @param {Object} [consoleOptions] - Additional console options
- * @returns {Logger} Configured logger instance
- */
-export function createClientLogger(name, level = INFO, consoleOptions = {}) {
-  const logger = new Logger(name, level);
-  const adapter = new ConsoleAdapter({ ...consoleOptions, level });
-
-  // Connect adapter to logger events
-  logger.on('log', (logEvent) => adapter.handleLog(logEvent));
-
-  return logger;
-}
+import { Logger } from '../logger/index.js';
+import { ConsoleAdapter } from '../adapters/console.js';
+import { INFO } from '../constants.js';
+
+/**
+ * Create a client-side logger with console adapter
+ *
+ * @param {string} name
+ * @param {string} [level=INFO] - Initial log level
+ * @param {Object} [consoleOptions] - Additional console options
+ * @returns {Logger} Configured logger instance
+ */
+export function createClientLogger(name, level = INFO, consoleOptions = {}) {
+  const logger = new Logger(name, level);
+  const adapter = new ConsoleAdapter({ ...consoleOptions, level });
+
+  // Connect adapter to logger events
+  logger.on('log', (logEvent) => adapter.handleLog(logEvent));
+
+  return logger;
+}

package/dist/logging/internal/factories/server.d.ts

@@ -7,4 +7,4 @@
  * @returns {Logger} Configured logger instance
  */
 export function createServerLogger(name: string, level?: string, pinoOptions?: any): Logger;
-import { Logger } from '../unified-logger';
+import { Logger } from '../logger/index.js';

package/dist/logging/internal/factories/server.js

@@ -1,22 +1,22 @@
-import { Logger } from '../unified-logger';
-
-import { PinoAdapter } from '../adapters/pino.js';
-import { INFO } from '../unified-logger/constants.js';
-
-/**
- * Create a server-side logger with pino adapter
- *
- * @param {string} name
- * @param {string} [level=INFO] - Initial log level
- * @param {Object} [pinoOptions] - Additional pino options
- * @returns {Logger} Configured logger instance
- */
-export function createServerLogger(name, level = INFO, pinoOptions = {}) {
-  const logger = new Logger(name, level);
-  const adapter = new PinoAdapter(pinoOptions);
-
-  // Connect adapter to logger events
-  logger.on('log', (logEvent) => adapter.handleLog(logEvent));
-
-  return logger;
-}
+import { Logger } from '../logger/index.js';
+
+import { PinoAdapter } from '../adapters/pino.js';
+import { INFO } from '../constants.js';
+
+/**
+ * Create a server-side logger with pino adapter
+ *
+ * @param {string} name
+ * @param {string} [level=INFO] - Initial log level
+ * @param {Object} [pinoOptions] - Additional pino options
+ * @returns {Logger} Configured logger instance
+ */
+export function createServerLogger(name, level = INFO, pinoOptions = {}) {
+  const logger = new Logger(name, level);
+  const adapter = new PinoAdapter(pinoOptions);
+
+  // Connect adapter to logger events
+  logger.on('log', (logEvent) => adapter.handleLog(logEvent));
+
+  return logger;
+}

package/dist/logging/internal/factories/universal.d.ts

@@ -4,6 +4,6 @@
  * @param {string} serviceName - Name of the service
  * @param {string} [level] - Initial log level
  * @param {Object} [options] - Additional options
- * @returns {import('../unified-logger').Logger} Configured logger instance
+ * @returns {import('../logger').Logger} Configured logger instance
  */
-export function createLogger(serviceName: string, level?: string, options?: any): import("../unified-logger").Logger;
+export function createLogger(serviceName: string, level?: string, options?: any): import("../logger").Logger;

package/dist/logging/internal/factories/universal.js

@@ -1,22 +1,22 @@
-/**
- * Universal logger factory that auto-detects environment
- */
-import { browser } from '$app/environment';
-import { createServerLogger } from './server.js';
-import { createClientLogger } from './client.js';
-
-/**
- * Create a logger that works in both server and client environments
- *
- * @param {string} serviceName - Name of the service
- * @param {string} [level] - Initial log level
- * @param {Object} [options] - Additional options
- * @returns {import('../unified-logger').Logger} Configured logger instance
- */
-export function createLogger(serviceName, level, options = {}) {
-  if (browser) {
-    return createClientLogger(serviceName, level, options);
-  } else {
-    return createServerLogger(serviceName, level, options);
-  }
-}
+/**
+ * Universal logger factory that auto-detects environment
+ */
+import { browser } from '$app/environment';
+import { createServerLogger } from './server.js';
+import { createClientLogger } from './client.js';
+
+/**
+ * Create a logger that works in both server and client environments
+ *
+ * @param {string} serviceName - Name of the service
+ * @param {string} [level] - Initial log level
+ * @param {Object} [options] - Additional options
+ * @returns {import('../logger').Logger} Configured logger instance
+ */
+export function createLogger(serviceName, level, options = {}) {
+  if (browser) {
+    return createClientLogger(serviceName, level, options);
+  } else {
+    return createServerLogger(serviceName, level, options);
+  }
+}

package/dist/logging/internal/{unified-logger → logger}/Logger.d.ts

@@ -70,9 +70,9 @@ export default class Logger extends EventEmitter {
      * forwarded to this logger.
      *
      * @param {string} eventName
-     * @param {import('./typedef.js').LogEventData} eventData
+     * @param {import('../typedef.js').LogEventData} eventData
      */
-    logFromEvent(eventName: string, eventData: import("./typedef.js").LogEventData): boolean;
+    logFromEvent(eventName: string, eventData: import("../typedef.js").LogEventData): boolean;
     #private;
 }
 import { EventEmitter } from '../../../classes/event-emitter';