@x-oasis/log 0.1.1 → 0.1.2

package/README.md

@@ -335,6 +335,10 @@ This library is designed to work in all modern browsers. It uses standard browse
 
 Full TypeScript support with comprehensive type definitions included.
 
+## Reading More
+- [loglayer](https://github.com/loglayer/loglayer)
+- [loglevel](https://github.com/pimterry/loglevel)
+
 ## License
 
 ISC

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@x-oasis/log",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "A friendly logging library for browser environments",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "module": "dist/log.esm.js",
+  "files": [
+    "dist",
+    "index.ts"
+  ],
   "publishConfig": {
     "access": "public"
   },

package/.turbo/turbo-build.log

@@ -1,26 +0,0 @@
-
-> @x-oasis/log@0.1.1 build /home/runner/work/x-oasis/x-oasis/packages/error/log
-> tsdx build --tsconfig tsconfig.build.json
-
-@rollup/plugin-replace: 'preventAssignment' currently defaults to false. It is recommended to set this option to `true`, as the next major version will default this option to `true`.
-@rollup/plugin-replace: 'preventAssignment' currently defaults to false. It is recommended to set this option to `true`, as the next major version will default this option to `true`.
-⠙ Creating entry file
-⠙ Building modules
-✓ Creating entry file 4.5 secs
-⠹ Building modules
-⠸ Building modules
-⠼ Building modules
-⠴ Building modules
-⠦ Building modules
-⠧ Building modules
-⠇ Building modules
-⠏ Building modules
-⠋ Building modules
-⠙ Building modules
-⠹ Building modules
-⠸ Building modules
-⠼ Building modules
-[tsdx]: Your rootDir is currently set to "./". Please change your rootDir to "./src".
-TSDX has deprecated setting tsconfig.compilerOptions.rootDir to "./" as it caused buggy output for declarationMaps and more.
-You may also need to change your include to remove "test", which also caused declarations to be unnecessarily created for test files.
-✓ Building modules 14.7 secs

package/CHANGELOG.md

@@ -1,17 +0,0 @@
-# @x-oasis/log
-
-## 0.1.1
-
-### Patch Changes
-
-- f1aae14: bump version
-
-## 0.1.0
-
-### Initial Release
-
-- Initial release of the log library
-- Support for multiple log levels (trace, debug, info, warn, error)
-- Browser-friendly API with chainable methods
-- Context and metadata support
-- Configurable log levels and output handlers

package/src/index.ts

@@ -1,39 +0,0 @@
-import { Logger } from './logger';
-import { LogLevel } from './types';
-
-export { Logger, LogLevel };
-export type {
-  LogEntry,
-  LoggerOptions,
-  LoggerChain,
-  OutputHandler,
-} from './types';
-
-/**
- * Default logger instance
- */
-export const defaultLogger = new Logger();
-
-/**
- * Convenience methods using the default logger
- */
-export const log = {
-  trace: (message: string, context?: Record<string, unknown>) =>
-    defaultLogger.trace(message, context),
-  debug: (message: string, context?: Record<string, unknown>) =>
-    defaultLogger.debug(message, context),
-  info: (message: string, context?: Record<string, unknown>) =>
-    defaultLogger.info(message, context),
-  warn: (message: string, context?: Record<string, unknown>) =>
-    defaultLogger.warn(message, context),
-  error: (message: string, context?: Record<string, unknown>) =>
-    defaultLogger.error(message, context),
-  setLevel: (level: LogLevel | keyof typeof LogLevel) =>
-    defaultLogger.setLevel(level),
-  withContext: (context: Record<string, unknown>) =>
-    defaultLogger.withContext(context),
-  withPrefix: (prefix: string) => defaultLogger.withPrefix(prefix),
-  chain: () => defaultLogger.chain(),
-};
-
-export default Logger;

package/src/logger.ts

@@ -1,247 +0,0 @@
-import {
-  LogLevel,
-  LogEntry,
-  LoggerOptions,
-  LoggerChain,
-  OutputHandler,
-} from './types';
-import { parseLogLevel, createConsoleHandler } from './utils';
-
-/**
- * Main Logger class
- */
-export class Logger {
-  private level: LogLevel;
-  private handler: OutputHandler;
-  private enableTimestamp: boolean;
-  private defaultContext?: Record<string, unknown>;
-  private defaultPrefix?: string;
-
-  constructor(options: LoggerOptions = {}) {
-    this.level = options.level ? parseLogLevel(options.level) : LogLevel.INFO;
-    this.handler = options.handler || createConsoleHandler();
-    this.enableTimestamp =
-      options.enableTimestamp !== undefined ? options.enableTimestamp : true;
-    this.defaultContext = options.defaultContext;
-    this.defaultPrefix = options.defaultPrefix;
-  }
-
-  /**
-   * Set the minimum log level
-   */
-  setLevel(level: LogLevel | keyof typeof LogLevel): void {
-    this.level = parseLogLevel(level);
-  }
-
-  /**
-   * Get the current log level
-   */
-  getLevel(): LogLevel {
-    return this.level;
-  }
-
-  /**
-   * Set a custom output handler
-   */
-  setHandler(handler: OutputHandler): void {
-    this.handler = handler;
-  }
-
-  /**
-   * Set default context that will be included in all logs
-   */
-  setDefaultContext(context: Record<string, unknown>): void {
-    this.defaultContext = context;
-  }
-
-  /**
-   * Set default prefix for all log messages
-   */
-  setDefaultPrefix(prefix: string): void {
-    this.defaultPrefix = prefix;
-  }
-
-  /**
-   * Create a chainable logger instance
-   */
-  chain(): LoggerChain {
-    return new LoggerChainBuilder(this);
-  }
-
-  /**
-   * Log at trace level
-   */
-  trace(message: string, context?: Record<string, unknown>): void {
-    this.log(LogLevel.TRACE, message, context);
-  }
-
-  /**
-   * Log at debug level
-   */
-  debug(message: string, context?: Record<string, unknown>): void {
-    this.log(LogLevel.DEBUG, message, context);
-  }
-
-  /**
-   * Log at info level
-   */
-  info(message: string, context?: Record<string, unknown>): void {
-    this.log(LogLevel.INFO, message, context);
-  }
-
-  /**
-   * Log at warn level
-   */
-  warn(message: string, context?: Record<string, unknown>): void {
-    this.log(LogLevel.WARN, message, context);
-  }
-
-  /**
-   * Log at error level
-   */
-  error(message: string, context?: Record<string, unknown>): void {
-    this.log(LogLevel.ERROR, message, context);
-  }
-
-  /**
-   * Internal log method
-   */
-  private log(
-    level: LogLevel,
-    message: string,
-    context?: Record<string, unknown>
-  ): void {
-    if (level < this.level) {
-      return;
-    }
-
-    const entry: LogEntry = {
-      level,
-      message,
-      timestamp: this.enableTimestamp ? Date.now() : 0,
-      prefix: this.defaultPrefix,
-    };
-
-    // Merge default context with provided context
-    if (this.defaultContext || context) {
-      entry.context = {
-        ...this.defaultContext,
-        ...context,
-      };
-    }
-
-    this.handler(entry);
-  }
-
-  /**
-   * Create a chainable logger with initial context
-   */
-  withContext(context: Record<string, unknown>): LoggerChain {
-    return new LoggerChainBuilder(this).withContext(context);
-  }
-
-  /**
-   * Create a chainable logger with initial prefix
-   */
-  withPrefix(prefix: string): LoggerChain {
-    return new LoggerChainBuilder(this).withPrefix(prefix);
-  }
-}
-
-/**
- * Chainable logger builder
- */
-class LoggerChainBuilder implements LoggerChain {
-  private logger: Logger;
-  private context?: Record<string, unknown>;
-  private metadata?: Record<string, unknown>;
-  private errorObj?: Error;
-  private prefix?: string;
-
-  constructor(logger: Logger) {
-    this.logger = logger;
-  }
-
-  withContext(context: Record<string, unknown>): LoggerChain {
-    this.context = {
-      ...this.context,
-      ...context,
-    };
-    return this;
-  }
-
-  withMetadata(metadata: Record<string, unknown>): LoggerChain {
-    this.metadata = {
-      ...this.metadata,
-      ...metadata,
-    };
-    return this;
-  }
-
-  withError(error: Error): LoggerChain {
-    this.errorObj = error;
-    return this;
-  }
-
-  withPrefix(prefix: string): LoggerChain {
-    this.prefix = prefix;
-    return this;
-  }
-
-  private createEntry(level: LogLevel, message: string): LogEntry {
-    const entry: LogEntry = {
-      level,
-      message,
-      timestamp: this.logger['enableTimestamp'] ? Date.now() : 0,
-      prefix: this.prefix || this.logger['defaultPrefix'],
-    };
-
-    // Merge contexts
-    const defaultContext = this.logger['defaultContext'];
-    if (defaultContext || this.context) {
-      entry.context = {
-        ...defaultContext,
-        ...this.context,
-      };
-    }
-
-    if (this.metadata) {
-      entry.metadata = this.metadata;
-    }
-
-    if (this.errorObj) {
-      entry.error = this.errorObj;
-    }
-
-    return entry;
-  }
-
-  private log(level: LogLevel, message: string): void {
-    if (level < this.logger.getLevel()) {
-      return;
-    }
-
-    const entry = this.createEntry(level, message);
-    this.logger['handler'](entry);
-  }
-
-  trace(message: string): void {
-    this.log(LogLevel.TRACE, message);
-  }
-
-  debug(message: string): void {
-    this.log(LogLevel.DEBUG, message);
-  }
-
-  info(message: string): void {
-    this.log(LogLevel.INFO, message);
-  }
-
-  warn(message: string): void {
-    this.log(LogLevel.WARN, message);
-  }
-
-  error(message: string): void {
-    this.log(LogLevel.ERROR, message);
-  }
-}

package/src/types.ts

@@ -1,109 +0,0 @@
-/**
- * Log levels in order of severity
- */
-export enum LogLevel {
-  TRACE = 0,
-  DEBUG = 1,
-  INFO = 2,
-  WARN = 3,
-  ERROR = 4,
-  SILENT = 5,
-}
-
-/**
- * Log entry data structure
- */
-export interface LogEntry {
-  level: LogLevel;
-  message: string;
-  timestamp: number;
-  context?: Record<string, unknown>;
-  metadata?: Record<string, unknown>;
-  error?: Error;
-  prefix?: string;
-}
-
-/**
- * Output handler function type
- */
-export type OutputHandler = (entry: LogEntry) => void;
-
-/**
- * Logger configuration options
- */
-export interface LoggerOptions {
-  /**
-   * Minimum log level to output (default: LogLevel.INFO)
-   */
-  level?: LogLevel | keyof typeof LogLevel;
-
-  /**
-   * Custom output handler (default: console)
-   */
-  handler?: OutputHandler;
-
-  /**
-   * Enable timestamps in log entries (default: true)
-   */
-  enableTimestamp?: boolean;
-
-  /**
-   * Default context that will be included in all logs
-   */
-  defaultContext?: Record<string, unknown>;
-
-  /**
-   * Default prefix for all log messages
-   */
-  defaultPrefix?: string;
-}
-
-/**
- * Chainable logger interface
- */
-export interface LoggerChain {
-  /**
-   * Add context data that will be included in this log entry
-   */
-  withContext(context: Record<string, unknown>): LoggerChain;
-
-  /**
-   * Add metadata that will be included in this log entry
-   */
-  withMetadata(metadata: Record<string, unknown>): LoggerChain;
-
-  /**
-   * Add an error object to this log entry
-   */
-  withError(error: Error): LoggerChain;
-
-  /**
-   * Add a prefix to this log message
-   */
-  withPrefix(prefix: string): LoggerChain;
-
-  /**
-   * Log at trace level
-   */
-  trace(message: string): void;
-
-  /**
-   * Log at debug level
-   */
-  debug(message: string): void;
-
-  /**
-   * Log at info level
-   */
-  info(message: string): void;
-
-  /**
-   * Log at warn level
-   */
-  warn(message: string): void;
-
-  /**
-   * Log at error level
-   */
-  error(message: string): void;
-}

package/src/utils.ts

@@ -1,63 +0,0 @@
-import { LogLevel, LogEntry } from './types';
-
-/**
- * Convert log level string to LogLevel enum
- */
-export function parseLogLevel(
-  level: LogLevel | keyof typeof LogLevel
-): LogLevel {
-  if (typeof level === 'number') {
-    return level;
-  }
-  return LogLevel[level] ?? LogLevel.INFO;
-}
-
-/**
- * Get log level name
- */
-export function getLogLevelName(level: LogLevel): string {
-  return LogLevel[level] ?? 'UNKNOWN';
-}
-
-/**
- * Default console output handler
- */
-export function createConsoleHandler(): (entry: LogEntry) => void {
-  const consoleMethods: Record<number, typeof console.log> = {
-    [LogLevel.TRACE]: console.trace || console.debug,
-    [LogLevel.DEBUG]: console.debug,
-    [LogLevel.INFO]: console.info,
-    [LogLevel.WARN]: console.warn,
-    [LogLevel.ERROR]: console.error,
-  };
-
-  return (entry) => {
-    const method = consoleMethods[entry.level] || console.log;
-    const parts: unknown[] = [];
-
-    // Add prefix if present
-    if (entry.prefix) {
-      parts.push(entry.prefix);
-    }
-
-    // Add message
-    parts.push(entry.message);
-
-    // Add context if present
-    if (entry.context && Object.keys(entry.context).length > 0) {
-      parts.push('\nContext:', entry.context);
-    }
-
-    // Add metadata if present
-    if (entry.metadata && Object.keys(entry.metadata).length > 0) {
-      parts.push('\nMetadata:', entry.metadata);
-    }
-
-    // Add error if present
-    if (entry.error) {
-      parts.push('\nError:', entry.error);
-    }
-
-    method(...parts);
-  };
-}

package/test/test.spec.ts

@@ -1,333 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { Logger, LogLevel } from '../src';
-// import { log } from '../src';
-
-describe('Logger', () => {
-  let mockHandler: ReturnType<typeof vi.fn>;
-  let logger: Logger;
-
-  beforeEach(() => {
-    mockHandler = vi.fn();
-    logger = new Logger({
-      handler: mockHandler,
-      enableTimestamp: false,
-    });
-  });
-
-  describe('Basic logging', () => {
-    it('should log at trace level', () => {
-      logger.setLevel(LogLevel.TRACE);
-      logger.trace('test message');
-
-      expect(mockHandler).toHaveBeenCalledTimes(1);
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          level: LogLevel.TRACE,
-          message: 'test message',
-        })
-      );
-    });
-
-    it('should log at debug level', () => {
-      logger.setLevel(LogLevel.DEBUG);
-      logger.debug('test message');
-
-      expect(mockHandler).toHaveBeenCalledTimes(1);
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          level: LogLevel.DEBUG,
-          message: 'test message',
-        })
-      );
-    });
-
-    it('should log at info level', () => {
-      logger.info('test message');
-
-      expect(mockHandler).toHaveBeenCalledTimes(1);
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          level: LogLevel.INFO,
-          message: 'test message',
-        })
-      );
-    });
-
-    it('should log at warn level', () => {
-      logger.warn('test message');
-
-      expect(mockHandler).toHaveBeenCalledTimes(1);
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          level: LogLevel.WARN,
-          message: 'test message',
-        })
-      );
-    });
-
-    it('should log at error level', () => {
-      logger.error('test message');
-
-      expect(mockHandler).toHaveBeenCalledTimes(1);
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          level: LogLevel.ERROR,
-          message: 'test message',
-        })
-      );
-    });
-  });
-
-  describe('Log level filtering', () => {
-    it('should not log messages below the set level', () => {
-      logger.setLevel(LogLevel.WARN);
-      logger.trace('trace message');
-      logger.debug('debug message');
-      logger.info('info message');
-
-      expect(mockHandler).not.toHaveBeenCalled();
-
-      logger.warn('warn message');
-      logger.error('error message');
-
-      expect(mockHandler).toHaveBeenCalledTimes(2);
-    });
-
-    it('should log all messages when level is TRACE', () => {
-      logger.setLevel(LogLevel.TRACE);
-      logger.trace('trace');
-      logger.debug('debug');
-      logger.info('info');
-      logger.warn('warn');
-      logger.error('error');
-
-      expect(mockHandler).toHaveBeenCalledTimes(5);
-    });
-  });
-
-  describe('Context support', () => {
-    it('should include context in log entries', () => {
-      logger.info('test message', { userId: '123', action: 'login' });
-
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          context: {
-            userId: '123',
-            action: 'login',
-          },
-        })
-      );
-    });
-
-    it('should merge default context with provided context', () => {
-      logger.setDefaultContext({ app: 'my-app', version: '1.0.0' });
-      logger.info('test message', { userId: '123' });
-
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          context: {
-            app: 'my-app',
-            version: '1.0.0',
-            userId: '123',
-          },
-        })
-      );
-    });
-  });
-
-  describe('Chainable API', () => {
-    it('should support chaining with context', () => {
-      logger
-        .chain()
-        .withContext({ userId: '123' })
-        .withContext({ action: 'login' })
-        .info('User logged in');
-
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          context: {
-            userId: '123',
-            action: 'login',
-          },
-          message: 'User logged in',
-        })
-      );
-    });
-
-    it('should support chaining with metadata', () => {
-      logger
-        .chain()
-        .withMetadata({ duration: 150, status: 'success' })
-        .info('Request completed');
-
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          metadata: {
-            duration: 150,
-            status: 'success',
-          },
-          message: 'Request completed',
-        })
-      );
-    });
-
-    it('should support chaining with error', () => {
-      const error = new Error('Something went wrong');
-      logger.chain().withError(error).error('Operation failed');
-
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          error,
-          message: 'Operation failed',
-        })
-      );
-    });
-
-    it('should support chaining with prefix', () => {
-      logger.chain().withPrefix('[API]').info('Request received');
-
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          prefix: '[API]',
-          message: 'Request received',
-        })
-      );
-    });
-
-    it('should support complex chaining', () => {
-      const error = new Error('Validation failed');
-      logger
-        .chain()
-        .withContext({ userId: '123' })
-        .withMetadata({ field: 'email', value: 'invalid' })
-        .withError(error)
-        .withPrefix('[VALIDATION]')
-        .warn('Validation error');
-
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          context: { userId: '123' },
-          metadata: { field: 'email', value: 'invalid' },
-          error,
-          prefix: '[VALIDATION]',
-          message: 'Validation error',
-        })
-      );
-    });
-  });
-
-  describe('withContext and withPrefix methods', () => {
-    it('should create chainable logger with context', () => {
-      logger.withContext({ userId: '123' }).info('User action');
-
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          context: { userId: '123' },
-        })
-      );
-    });
-
-    it('should create chainable logger with prefix', () => {
-      logger.withPrefix('[APP]').info('Application started');
-
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          prefix: '[APP]',
-        })
-      );
-    });
-  });
-
-  describe('Default prefix', () => {
-    it('should include default prefix in all logs', () => {
-      logger.setDefaultPrefix('[MY-APP]');
-      logger.info('Test message');
-
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          prefix: '[MY-APP]',
-        })
-      );
-    });
-
-    it('should allow overriding default prefix with chain prefix', () => {
-      logger.setDefaultPrefix('[DEFAULT]');
-      logger.chain().withPrefix('[OVERRIDE]').info('Test message');
-
-      expect(mockHandler).toHaveBeenCalledWith(
-        expect.objectContaining({
-          prefix: '[OVERRIDE]',
-        })
-      );
-    });
-  });
-
-  describe('Timestamp', () => {
-    it('should include timestamp when enabled', () => {
-      const loggerWithTimestamp = new Logger({
-        handler: mockHandler,
-        enableTimestamp: true,
-      });
-      loggerWithTimestamp.info('test');
-
-      const call = mockHandler.mock.calls[0][0];
-      expect(call.timestamp).toBeGreaterThan(0);
-    });
-
-    it('should not include timestamp when disabled', () => {
-      logger.info('test');
-
-      const call = mockHandler.mock.calls[0][0];
-      expect(call.timestamp).toBe(0);
-    });
-  });
-
-  describe('Log level string parsing', () => {
-    it('should accept log level as string', () => {
-      logger.setLevel('DEBUG');
-      logger.setLevel('WARN');
-      logger.setLevel('ERROR');
-
-      expect(logger.getLevel()).toBe(LogLevel.ERROR);
-    });
-
-    it('should default to INFO for invalid string', () => {
-      logger.setLevel('INVALID' as any);
-      expect(logger.getLevel()).toBe(LogLevel.INFO);
-    });
-  });
-});
-
-// describe('Default logger (log)', () => {
-//   it('should provide convenience methods', () => {
-//     const originalConsole = console.info;
-//     const mockConsole = vi.fn();
-//     console.info = mockConsole;
-
-//     try {
-//       log.info('test message');
-//       expect(mockConsole).toHaveBeenCalled();
-//     } finally {
-//       console.info = originalConsole;
-//     }
-//   });
-
-//   it('should support setLevel', () => {
-//     expect(() => log.setLevel(LogLevel.DEBUG)).not.toThrow();
-//   });
-
-//   it('should support withContext', () => {
-//     const chain = log.withContext({ test: 'value' });
-//     expect(chain).toBeDefined();
-//   });
-
-//   it('should support withPrefix', () => {
-//     const chain = log.withPrefix('[TEST]');
-//     expect(chain).toBeDefined();
-//   });
-
-//   it('should support chain', () => {
-//     const chain = log.chain();
-//     expect(chain).toBeDefined();
-//   });
-// });

package/tsconfig.build.json

@@ -1,11 +0,0 @@
-{
-  "extends": "../../../tsconfig.build.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "esModuleInterop": true
-  },
-
-  "include": [
-    "src/**/*"
-  ]
-}

package/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "extends": "../../../tsconfig.json",
-  "compilerOptions": {
-    "jsx": "react",
-    "esModuleInterop": true
-  }
-}

package/vitest.config.ts

@@ -1,21 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-  test: {
-    globals: true,
-    include: ['test/**/*.(spec|test).ts'],
-    exclude: ['node_modules/**'],
-    threads: false,
-
-    coverage: {
-      provider: 'istanbul',
-    },
-  },
-
-  resolve: {
-    alias: {},
-  },
-  define: {
-    __DEV__: false,
-  },
-});