@open-core/framework 1.0.4-beta.1 → 1.0.5-beta.1

package/dist/shared/logger/index.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BufferedTransport = exports.ConsoleTransport = exports.loggers = exports.coreLogger = exports.ChildLogger = exports.LoggerService = exports.DEFAULT_LOGGER_CONFIG = exports.createLoggerConfig = exports.parseLogLevel = exports.LogDomainLabels = exports.LogDomain = exports.LogLevelLabels = exports.LogLevel = void 0;
-// Types
-var logger_types_1 = require("./logger.types");
-Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return logger_types_1.LogLevel; } });
-Object.defineProperty(exports, "LogLevelLabels", { enumerable: true, get: function () { return logger_types_1.LogLevelLabels; } });
-Object.defineProperty(exports, "LogDomain", { enumerable: true, get: function () { return logger_types_1.LogDomain; } });
-Object.defineProperty(exports, "LogDomainLabels", { enumerable: true, get: function () { return logger_types_1.LogDomainLabels; } });
-Object.defineProperty(exports, "parseLogLevel", { enumerable: true, get: function () { return logger_types_1.parseLogLevel; } });
-// Config
-var logger_config_1 = require("./logger.config");
-Object.defineProperty(exports, "createLoggerConfig", { enumerable: true, get: function () { return logger_config_1.createLoggerConfig; } });
-Object.defineProperty(exports, "DEFAULT_LOGGER_CONFIG", { enumerable: true, get: function () { return logger_config_1.DEFAULT_LOGGER_CONFIG; } });
-// Service
-var logger_service_1 = require("./logger.service");
-Object.defineProperty(exports, "LoggerService", { enumerable: true, get: function () { return logger_service_1.LoggerService; } });
-Object.defineProperty(exports, "ChildLogger", { enumerable: true, get: function () { return logger_service_1.ChildLogger; } });
-// Core Logger (internal framework use)
-var core_logger_1 = require("./core-logger");
-Object.defineProperty(exports, "coreLogger", { enumerable: true, get: function () { return core_logger_1.coreLogger; } });
-Object.defineProperty(exports, "loggers", { enumerable: true, get: function () { return core_logger_1.loggers; } });
-var console_transport_1 = require("./transports/console.transport");
-Object.defineProperty(exports, "ConsoleTransport", { enumerable: true, get: function () { return console_transport_1.ConsoleTransport; } });
-var buffered_transport_1 = require("./transports/buffered.transport");
-Object.defineProperty(exports, "BufferedTransport", { enumerable: true, get: function () { return buffered_transport_1.BufferedTransport; } });

package/dist/shared/logger/logger.config.d.ts

@@ -1,47 +0,0 @@
-import { LogDomain, LogLevel } from './logger.types';
-import type { LogTransport } from './transports/transport.interface';
-/**
- * Global configuration options for the LoggerService.
- */
-export interface LoggerConfig {
-    /**
-     * Global minimum log level. Logs below this level will be ignored entirely.
-     * Individual transports can have their own minLevel that's higher than this.
-     * @default LogLevel.DEBUG
-     */
-    minLevel: LogLevel;
-    /**
-     * Default domain/origin for logs when none is provided.
-     * @default LogDomain.SERVER
-     */
-    defaultDomain: LogDomain;
-    /**
-     * Default source name to use when none is provided.
-     * @default 'App'
-     */
-    defaultSource: string;
-    /**
-     * Array of transports that will receive log entries.
-     * If empty, a default ConsoleTransport will be used.
-     */
-    transports: LogTransport[];
-}
-/**
- * Default configuration used when no custom config is provided.
- */
-export declare const DEFAULT_LOGGER_CONFIG: LoggerConfig;
-/**
- * Creates a new logger configuration by merging with defaults.
- *
- * @example
- * ```typescript
- * const config = createLoggerConfig({
- *   minLevel: LogLevel.INFO,
- *   transports: [
- *     new ConsoleTransport({ colors: true }),
- *     new MyCustomFileTransport()
- *   ]
- * })
- * ```
- */
-export declare function createLoggerConfig(partial: Partial<LoggerConfig>): LoggerConfig;

package/dist/shared/logger/logger.config.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_LOGGER_CONFIG = void 0;
-exports.createLoggerConfig = createLoggerConfig;
-const logger_types_1 = require("./logger.types");
-const console_transport_1 = require("./transports/console.transport");
-/**
- * Default configuration used when no custom config is provided.
- */
-exports.DEFAULT_LOGGER_CONFIG = {
-    minLevel: logger_types_1.LogLevel.DEBUG,
-    defaultDomain: logger_types_1.LogDomain.SERVER,
-    defaultSource: 'App',
-    transports: [new console_transport_1.ConsoleTransport()],
-};
-/**
- * Creates a new logger configuration by merging with defaults.
- *
- * @example
- * ```typescript
- * const config = createLoggerConfig({
- *   minLevel: LogLevel.INFO,
- *   transports: [
- *     new ConsoleTransport({ colors: true }),
- *     new MyCustomFileTransport()
- *   ]
- * })
- * ```
- */
-function createLoggerConfig(partial) {
-    var _a;
-    return Object.assign(Object.assign(Object.assign({}, exports.DEFAULT_LOGGER_CONFIG), partial), { transports: (_a = partial.transports) !== null && _a !== void 0 ? _a : exports.DEFAULT_LOGGER_CONFIG.transports });
-}

package/dist/shared/logger/logger.service.d.ts

@@ -1,161 +0,0 @@
-import { type LoggerConfig } from './logger.config';
-import { LogDomain, LogLevel, type LogContext } from './logger.types';
-import type { LogTransport } from './transports/transport.interface';
-/**
- * Central logging service for the framework.
- *
- * Provides structured logging with support for multiple transports,
- * log levels, and contextual metadata for traceability.
- *
- * @example
- * ```typescript
- * // Using with dependency injection
- * @injectable()
- * class MyController {
- *   constructor(private logger: LoggerService) {}
- *
- *   doSomething() {
- *     this.logger.info('Operation started', { source: 'MyController' })
- *     this.logger.debug('Processing data', { playerId: 123 })
- *   }
- * }
- * ```
- *
- * @example
- * ```typescript
- * // Manual instantiation with custom config
- * const logger = new LoggerService({
- *   minLevel: LogLevel.INFO,
- *   transports: [new ConsoleTransport(), new FileTransport()]
- * })
- * ```
- */
-export declare class LoggerService {
-    private config;
-    constructor(config?: Partial<LoggerConfig>);
-    /**
-     * Log a TRACE level message. Most verbose, for deep debugging.
-     */
-    trace(message: string, context?: LogContext): void;
-    /**
-     * Log a DEBUG level message. Development-time information.
-     */
-    debug(message: string, context?: LogContext): void;
-    /**
-     * Log an INFO level message. General operational information.
-     */
-    info(message: string, context?: LogContext): void;
-    /**
-     * Log a WARN level message. Something unexpected but not necessarily wrong.
-     */
-    warn(message: string, context?: LogContext): void;
-    /**
-     * Log an ERROR level message. Something went wrong but the app can continue.
-     */
-    error(message: string, context?: LogContext, error?: Error): void;
-    /**
-     * Log a FATAL level message. Critical error, the app may need to stop.
-     */
-    fatal(message: string, context?: LogContext, error?: Error): void;
-    /**
-     * Add a new transport to receive log entries.
-     *
-     * @example
-     * ```typescript
-     * logger.addTransport(new FileTransport({ path: './logs/app.log' }))
-     * ```
-     */
-    addTransport(transport: LogTransport): void;
-    /**
-     * Remove a transport by name.
-     */
-    removeTransport(name: string): boolean;
-    /**
-     * Get all registered transports.
-     */
-    getTransports(): readonly LogTransport[];
-    /**
-     * Clear all transports.
-     */
-    clearTransports(): void;
-    /**
-     * Update the global minimum log level.
-     */
-    setMinLevel(level: LogLevel): void;
-    /**
-     * Get the current minimum log level.
-     */
-    getMinLevel(): LogLevel;
-    /**
-     * Create a server-level logger for server-side application code.
-     * These logs will be tagged with [SERVER] domain.
-     *
-     * @example
-     * ```typescript
-     * const authLogger = logger.server('AuthController')
-     * authLogger.info('User logged in') // [SERVER] INFO [AuthController] User logged in
-     * ```
-     */
-    server(source: string): ChildLogger;
-    /**
-     * Create a framework-level logger for internal OpenCore logging.
-     * These logs will be tagged with [CORE] domain.
-     *
-     * @example
-     * ```typescript
-     * const coreLogger = logger.framework('Bootstrap')
-     * coreLogger.error('Missing config') // [CORE] ERROR [Bootstrap] Missing config
-     * ```
-     */
-    framework(source: string): ChildLogger;
-    /**
-     * Create a client-level logger for client-side code.
-     * These logs will be tagged with [CLIENT] domain.
-     *
-     * @example
-     * ```typescript
-     * const hudLogger = logger.client('HUD')
-     * hudLogger.debug('Rendering') // [CLIENT] DEBUG [HUD] Rendering
-     * ```
-     */
-    client(source: string): ChildLogger;
-    /**
-     * Create an external services logger for third-party APIs, databases, etc.
-     * These logs will be tagged with [EXTERNAL] domain.
-     *
-     * @example
-     * ```typescript
-     * const stripeLogger = logger.external('StripeAPI')
-     * stripeLogger.warn('Rate limit') // [EXTERNAL] WARN [StripeAPI] Rate limit
-     * ```
-     */
-    external(source: string): ChildLogger;
-    /**
-     * Create a child logger with custom domain.
-     * Use this when you need a specific domain not covered by the convenience methods.
-     *
-     * @example
-     * ```typescript
-     * const customLogger = logger.child('MyModule', LogDomain.EXTERNAL)
-     * ```
-     */
-    child(source: string, domain?: LogDomain): ChildLogger;
-    private log;
-}
-/**
- * A lightweight logger wrapper with a preset source and domain context.
- * Created via LoggerService.child(), .framework(), .client(), or .external()
- */
-export declare class ChildLogger {
-    private parent;
-    private source;
-    private domain?;
-    constructor(parent: LoggerService, source: string, domain?: LogDomain | undefined);
-    private buildContext;
-    trace(message: string, context?: Omit<LogContext, 'source' | 'domain'>): void;
-    debug(message: string, context?: Omit<LogContext, 'source' | 'domain'>): void;
-    info(message: string, context?: Omit<LogContext, 'source' | 'domain'>): void;
-    warn(message: string, context?: Omit<LogContext, 'source' | 'domain'>): void;
-    error(message: string, context?: Omit<LogContext, 'source' | 'domain'>, error?: Error): void;
-    fatal(message: string, context?: Omit<LogContext, 'source' | 'domain'>, error?: Error): void;
-}

package/dist/shared/logger/logger.service.js

@@ -1,279 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChildLogger = exports.LoggerService = void 0;
-const tsyringe_1 = require("tsyringe");
-const logger_config_1 = require("./logger.config");
-const logger_types_1 = require("./logger.types");
-/**
- * Central logging service for the framework.
- *
- * Provides structured logging with support for multiple transports,
- * log levels, and contextual metadata for traceability.
- *
- * @example
- * ```typescript
- * // Using with dependency injection
- * @injectable()
- * class MyController {
- *   constructor(private logger: LoggerService) {}
- *
- *   doSomething() {
- *     this.logger.info('Operation started', { source: 'MyController' })
- *     this.logger.debug('Processing data', { playerId: 123 })
- *   }
- * }
- * ```
- *
- * @example
- * ```typescript
- * // Manual instantiation with custom config
- * const logger = new LoggerService({
- *   minLevel: LogLevel.INFO,
- *   transports: [new ConsoleTransport(), new FileTransport()]
- * })
- * ```
- */
-let LoggerService = class LoggerService {
-    constructor(config) {
-        this.config = (0, logger_config_1.createLoggerConfig)(config !== null && config !== void 0 ? config : {});
-    }
-    // ─────────────────────────────────────────────────────────────────────────────
-    // Log Methods
-    // ─────────────────────────────────────────────────────────────────────────────
-    /**
-     * Log a TRACE level message. Most verbose, for deep debugging.
-     */
-    trace(message, context) {
-        this.log(logger_types_1.LogLevel.TRACE, message, context);
-    }
-    /**
-     * Log a DEBUG level message. Development-time information.
-     */
-    debug(message, context) {
-        this.log(logger_types_1.LogLevel.DEBUG, message, context);
-    }
-    /**
-     * Log an INFO level message. General operational information.
-     */
-    info(message, context) {
-        this.log(logger_types_1.LogLevel.INFO, message, context);
-    }
-    /**
-     * Log a WARN level message. Something unexpected but not necessarily wrong.
-     */
-    warn(message, context) {
-        this.log(logger_types_1.LogLevel.WARN, message, context);
-    }
-    /**
-     * Log an ERROR level message. Something went wrong but the app can continue.
-     */
-    error(message, context, error) {
-        this.log(logger_types_1.LogLevel.ERROR, message, context, error);
-    }
-    /**
-     * Log a FATAL level message. Critical error, the app may need to stop.
-     */
-    fatal(message, context, error) {
-        this.log(logger_types_1.LogLevel.FATAL, message, context, error);
-    }
-    // ─────────────────────────────────────────────────────────────────────────────
-    // Transport Management
-    // ─────────────────────────────────────────────────────────────────────────────
-    /**
-     * Add a new transport to receive log entries.
-     *
-     * @example
-     * ```typescript
-     * logger.addTransport(new FileTransport({ path: './logs/app.log' }))
-     * ```
-     */
-    addTransport(transport) {
-        this.config.transports.push(transport);
-    }
-    /**
-     * Remove a transport by name.
-     */
-    removeTransport(name) {
-        var _a;
-        const index = this.config.transports.findIndex((t) => t.name === name);
-        if (index === -1)
-            return false;
-        const [removed] = this.config.transports.splice(index, 1);
-        (_a = removed === null || removed === void 0 ? void 0 : removed.destroy) === null || _a === void 0 ? void 0 : _a.call(removed);
-        return true;
-    }
-    /**
-     * Get all registered transports.
-     */
-    getTransports() {
-        return this.config.transports;
-    }
-    /**
-     * Clear all transports.
-     */
-    clearTransports() {
-        var _a;
-        for (const transport of this.config.transports) {
-            (_a = transport.destroy) === null || _a === void 0 ? void 0 : _a.call(transport);
-        }
-        this.config.transports = [];
-    }
-    // ─────────────────────────────────────────────────────────────────────────────
-    // Configuration
-    // ─────────────────────────────────────────────────────────────────────────────
-    /**
-     * Update the global minimum log level.
-     */
-    setMinLevel(level) {
-        this.config.minLevel = level;
-    }
-    /**
-     * Get the current minimum log level.
-     */
-    getMinLevel() {
-        return this.config.minLevel;
-    }
-    // ─────────────────────────────────────────────────────────────────────────────
-    // Domain-specific Loggers
-    // ─────────────────────────────────────────────────────────────────────────────
-    /**
-     * Create a server-level logger for server-side application code.
-     * These logs will be tagged with [SERVER] domain.
-     *
-     * @example
-     * ```typescript
-     * const authLogger = logger.server('AuthController')
-     * authLogger.info('User logged in') // [SERVER] INFO [AuthController] User logged in
-     * ```
-     */
-    server(source) {
-        return new ChildLogger(this, source, logger_types_1.LogDomain.SERVER);
-    }
-    /**
-     * Create a framework-level logger for internal OpenCore logging.
-     * These logs will be tagged with [CORE] domain.
-     *
-     * @example
-     * ```typescript
-     * const coreLogger = logger.framework('Bootstrap')
-     * coreLogger.error('Missing config') // [CORE] ERROR [Bootstrap] Missing config
-     * ```
-     */
-    framework(source) {
-        return new ChildLogger(this, source, logger_types_1.LogDomain.FRAMEWORK);
-    }
-    /**
-     * Create a client-level logger for client-side code.
-     * These logs will be tagged with [CLIENT] domain.
-     *
-     * @example
-     * ```typescript
-     * const hudLogger = logger.client('HUD')
-     * hudLogger.debug('Rendering') // [CLIENT] DEBUG [HUD] Rendering
-     * ```
-     */
-    client(source) {
-        return new ChildLogger(this, source, logger_types_1.LogDomain.CLIENT);
-    }
-    /**
-     * Create an external services logger for third-party APIs, databases, etc.
-     * These logs will be tagged with [EXTERNAL] domain.
-     *
-     * @example
-     * ```typescript
-     * const stripeLogger = logger.external('StripeAPI')
-     * stripeLogger.warn('Rate limit') // [EXTERNAL] WARN [StripeAPI] Rate limit
-     * ```
-     */
-    external(source) {
-        return new ChildLogger(this, source, logger_types_1.LogDomain.EXTERNAL);
-    }
-    /**
-     * Create a child logger with custom domain.
-     * Use this when you need a specific domain not covered by the convenience methods.
-     *
-     * @example
-     * ```typescript
-     * const customLogger = logger.child('MyModule', LogDomain.EXTERNAL)
-     * ```
-     */
-    child(source, domain) {
-        return new ChildLogger(this, source, domain);
-    }
-    // ─────────────────────────────────────────────────────────────────────────────
-    // Internal
-    // ─────────────────────────────────────────────────────────────────────────────
-    log(level, message, context, error) {
-        var _a, _b;
-        // Check global minimum level
-        if (level < this.config.minLevel)
-            return;
-        const entry = {
-            level,
-            domain: (_a = context === null || context === void 0 ? void 0 : context.domain) !== null && _a !== void 0 ? _a : this.config.defaultDomain,
-            message,
-            timestamp: new Date().toISOString(),
-            context: Object.assign({ source: (_b = context === null || context === void 0 ? void 0 : context.source) !== null && _b !== void 0 ? _b : this.config.defaultSource }, context),
-            error,
-        };
-        // Dispatch to all transports that accept this level
-        for (const transport of this.config.transports) {
-            if (level >= transport.minLevel) {
-                try {
-                    transport.write(entry);
-                }
-                catch (err) {
-                    // Avoid infinite loops - just console.error transport failures
-                    console.error(`[Logger] Transport "${transport.name}" failed:`, err);
-                }
-            }
-        }
-    }
-};
-exports.LoggerService = LoggerService;
-exports.LoggerService = LoggerService = __decorate([
-    (0, tsyringe_1.injectable)(),
-    __metadata("design:paramtypes", [Object])
-], LoggerService);
-/**
- * A lightweight logger wrapper with a preset source and domain context.
- * Created via LoggerService.child(), .framework(), .client(), or .external()
- */
-class ChildLogger {
-    constructor(parent, source, domain) {
-        this.parent = parent;
-        this.source = source;
-        this.domain = domain;
-    }
-    buildContext(context) {
-        return Object.assign(Object.assign(Object.assign({}, context), { source: this.source }), (this.domain && { domain: this.domain }));
-    }
-    trace(message, context) {
-        this.parent.trace(message, this.buildContext(context));
-    }
-    debug(message, context) {
-        this.parent.debug(message, this.buildContext(context));
-    }
-    info(message, context) {
-        this.parent.info(message, this.buildContext(context));
-    }
-    warn(message, context) {
-        this.parent.warn(message, this.buildContext(context));
-    }
-    error(message, context, error) {
-        this.parent.error(message, this.buildContext(context), error);
-    }
-    fatal(message, context, error) {
-        this.parent.fatal(message, this.buildContext(context), error);
-    }
-}
-exports.ChildLogger = ChildLogger;

package/dist/shared/logger/logger.types.js

@@ -1,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogDomainLabels = exports.LogDomain = exports.LogLevelLabels = exports.LogLevel = void 0;
-exports.parseLogLevel = parseLogLevel;
-/**
- * Log severity levels ordered from most verbose to most critical.
- * The numeric values allow for easy comparison and filtering.
- */
-var LogLevel;
-(function (LogLevel) {
-    LogLevel[LogLevel["TRACE"] = 0] = "TRACE";
-    LogLevel[LogLevel["DEBUG"] = 1] = "DEBUG";
-    LogLevel[LogLevel["INFO"] = 2] = "INFO";
-    LogLevel[LogLevel["WARN"] = 3] = "WARN";
-    LogLevel[LogLevel["ERROR"] = 4] = "ERROR";
-    LogLevel[LogLevel["FATAL"] = 5] = "FATAL";
-    LogLevel[LogLevel["OFF"] = 6] = "OFF";
-})(LogLevel || (exports.LogLevel = LogLevel = {}));
-/**
- * Human-readable labels for each log level.
- */
-exports.LogLevelLabels = {
-    [LogLevel.TRACE]: 'TRACE',
-    [LogLevel.DEBUG]: 'DEBUG',
-    [LogLevel.INFO]: 'INFO',
-    [LogLevel.WARN]: 'WARN',
-    [LogLevel.ERROR]: 'ERROR',
-    [LogLevel.FATAL]: 'FATAL',
-    [LogLevel.OFF]: 'OFF',
-};
-/**
- * Domain/origin of the log entry.
- * Helps identify where the log originates from for better traceability.
- */
-var LogDomain;
-(function (LogDomain) {
-    /**
-     * Internal framework logs (OpenCore internals).
-     * Used for core errors, bootstrap messages, decorator processing, etc.
-     */
-    LogDomain["FRAMEWORK"] = "framework";
-    /**
-     * Server-side application logs.
-     * Used by resource developers for their server logic.
-     */
-    LogDomain["SERVER"] = "server";
-    /**
-     * Client-side application logs.
-     * Used by resource developers for their client logic.
-     */
-    LogDomain["CLIENT"] = "client";
-    /**
-     * External service logs.
-     * Used for third-party APIs, databases, HTTP requests, etc.
-     */
-    LogDomain["EXTERNAL"] = "external";
-})(LogDomain || (exports.LogDomain = LogDomain = {}));
-/**
- * Human-readable labels for each log domain.
- */
-exports.LogDomainLabels = {
-    [LogDomain.FRAMEWORK]: 'CORE',
-    [LogDomain.SERVER]: 'SERVER',
-    [LogDomain.CLIENT]: 'CLIENT',
-    [LogDomain.EXTERNAL]: 'EXTERNAL',
-};
-/**
- * Configuration for parsing log level from string (useful for env vars).
- */
-function parseLogLevel(value) {
-    const upper = value.toUpperCase();
-    const level = LogLevel[upper];
-    return level !== undefined ? level : LogLevel.INFO;
-}