alepha 0.9.3 → 0.9.4

package/logger.cjs

@@ -0,0 +1,8 @@
+'use strict';
+var m = require('@alepha/logger');
+Object.keys(m).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return m[k]; }
+	});
+});

package/logger.d.ts

@@ -0,0 +1,222 @@
+import * as _alepha_core0 from "alepha";
+import { Alepha, KIND, LogLevel, LoggerInterface, Static } from "alepha";
+import * as _sinclair_typebox0 from "@sinclair/typebox";
+
+//#region src/providers/LogDestinationProvider.d.ts
+declare abstract class LogDestinationProvider {
+  abstract write(message: string, entry: LogEntry): void;
+}
+//#endregion
+//#region src/providers/LogFormatterProvider.d.ts
+declare abstract class LogFormatterProvider {
+  abstract format(entry: LogEntry): string;
+}
+//#endregion
+//#region src/services/Logger.d.ts
+declare class Logger implements LoggerInterface {
+  protected readonly alepha: Alepha;
+  protected readonly formatter: LogFormatterProvider;
+  protected readonly destination: LogDestinationProvider;
+  protected readonly levels: Record<string, number>;
+  protected readonly service: string;
+  protected readonly module: string;
+  protected readonly app?: string;
+  protected appLogLevel: string;
+  protected logLevel: LogLevel;
+  constructor(service: string, module: string);
+  get context(): string | undefined;
+  get level(): string;
+  parseLevel(level: string, app: string): LogLevel;
+  asLogLevel(something: string): LogLevel;
+  error(message: string, data?: unknown): void;
+  warn(message: string, data?: unknown): void;
+  info(message: string, data?: unknown): void;
+  debug(message: string, data?: unknown): void;
+  trace(message: string, data?: unknown): void;
+  protected log(level: LogLevel, message: string, data?: unknown): void;
+}
+interface LogEntry {
+  level: LogLevel;
+  message: string;
+  service: string;
+  module: string;
+  context?: string;
+  data?: object | Error | string;
+  app?: string;
+  timestamp: Date;
+}
+//#endregion
+//#region src/descriptors/$logger.d.ts
+/**
+ * Create a logger.
+ *
+ * `name` is optional, by default it will use the name of the service.
+ *
+ * @example
+ * ```ts
+ * import { $logger } from "alepha";
+ *
+ * class MyService {
+ * 	log = $logger();
+ *
+ * 	constructor() {
+ * 	    // print something like '[23:45:53.326] INFO <app.App>: App is ready!'
+ * 		this.log.info("Service initialized");
+ * 	}
+ * }
+ * ```
+ */
+declare const $logger: {
+  (options?: LoggerDescriptorOptions): Logger;
+  [KIND]: typeof Logger;
+};
+interface LoggerDescriptorOptions {
+  name?: string;
+}
+//#endregion
+//#region src/providers/ConsoleColorProvider.d.ts
+declare class ConsoleColorProvider {
+  protected env: {
+    NO_COLOR?: string | undefined;
+    FORCE_COLOR?: string | undefined;
+  };
+  readonly colors: {
+    reset: string;
+    grey: string;
+    red: string;
+    orange: string;
+    green: string;
+    blue: string;
+    white: string;
+    cyan: string;
+    darkGrey: string;
+    silent: string;
+    error: string;
+    warn: string;
+    info: string;
+    debug: string;
+    trace: string;
+  };
+  protected enabled: boolean;
+  constructor();
+  colorize(color: keyof typeof (void 0).colors, text: string, reset?: string): string;
+}
+//#endregion
+//#region src/providers/ConsoleDestinationProvider.d.ts
+declare class ConsoleDestinationProvider extends LogDestinationProvider {
+  write(message: string): void;
+}
+//#endregion
+//#region src/providers/JsonFormatterProvider.d.ts
+declare class JsonFormatterProvider extends LogFormatterProvider {
+  format(entry: LogEntry): string;
+  protected formatJsonError(error: Error): object;
+}
+//#endregion
+//#region src/providers/MemoryDestinationProvider.d.ts
+declare class MemoryDestinationProvider extends LogDestinationProvider {
+  protected entries: Array<LogEntry & {
+    formatted: string;
+  }>;
+  readonly options: {
+    maxEntries: number;
+  };
+  write(formatted: string, entry: LogEntry): void;
+  get logs(): (LogEntry & {
+    formatted: string;
+  })[];
+  clear(): void;
+}
+//#endregion
+//#region src/providers/SimpleFormatterProvider.d.ts
+declare class SimpleFormatterProvider extends LogFormatterProvider {
+  protected color: ConsoleColorProvider;
+  format(entry: LogEntry): string;
+  formatTimestamp(d: Date): string;
+  protected pad2: (n: number) => string;
+  protected pad3: (n: number) => string;
+  protected formatError(error: Error): string;
+}
+//#endregion
+//#region src/index.d.ts
+declare const envSchema: _alepha_core0.TObject<{
+  /**
+   * Default log level for the application.
+   *
+   * Default by environment:
+   * - dev = info
+   * - prod = info
+   * - test = error
+   *
+   * Levels are: "trace" | "debug" | "info" | "warn" | "error" | "silent"
+   *
+   * Level can be set for a specific module:
+   *
+   * @example
+   * LOG_LEVEL=my.module.name:debug,info # Set debug level for my.module.name and info for all other modules
+   * LOG_LEVEL=alepha:trace, info # Set trace level for all alepha modules and info for all other modules
+   */
+  LOG_LEVEL: _alepha_core0.TOptional<_alepha_core0.TString>;
+  /**
+   * Built-in log formats.
+   * - "json" - JSON format, useful for structured logging and log aggregation. {@link JsonFormatterProvider}
+   * - "text" - Simple text format, human-readable, with colors. {@link SimpleFormatterProvider}
+   * - "raw" - Raw format, no formatting, just the message.  {@link RawFormatterProvider}
+   */
+  LOG_FORMAT: _alepha_core0.TOptional<_sinclair_typebox0.TUnsafe<"json" | "text" | "raw">>;
+}>;
+declare module "alepha" {
+  interface Env extends Partial<Static<typeof envSchema>> {}
+  interface State {
+    logLevel?: string;
+  }
+}
+/**
+ * Minimalist logger module for Alepha.
+ *
+ * It offers a global logger interface (info, warn, ...) via the `$logger` descriptor.
+ *
+ * ```ts
+ * import { $logger } from "alepha/logger";
+ *
+ * class App {
+ *   log = $logger();
+ * }
+ * ```
+ *
+ * ### Formatting and Destinations
+ *
+ * `AlephaLogger` is **extensible**, destinations and formatters can be added or replaced.
+ *
+ * Default log destinations are:
+ * - ConsoleDestinationProvider: logs to the console.
+ * - MemoryDestinationProvider: stores logs in memory for later retrieval.
+ *
+ * Default log formatters are:
+ * - JsonFormatterProvider: formats logs as JSON.
+ * - SimpleFormatterProvider: formats logs as simple text (with colors when possible).
+ * - RawFormatterProvider: formats logs as raw text without any formatting.
+ *
+ * ### Log Level
+ *
+ * You can configure the log level and format via environment variables:
+ *
+ * - `LOG_LEVEL`: Sets the default log level for the application.
+ * - `LOG_FORMAT`: Sets the default log format for the application.
+ *
+ * ```bash
+ * LOG_LEVEL=debug LOG_FORMAT=json node src/index.ts
+ * ```
+ *
+ * Log level is also available in the state as `logLevel`, which can be used to dynamically change the log level at runtime.
+ * ```ts
+ * alepha.state("logLevel", "debug");
+ * ```
+ *
+ * Log level is $module aware, meaning you can set different log levels for different modules.
+ * For example, you can set `LOG_LEVEL=my.module.name:debug,info` to set the log level to debug for `my.module.name` and info for all other modules.
+ */
+declare const AlephaLogger: _alepha_core0.Service<_alepha_core0.Module>;
+//#endregion
+export { $logger, AlephaLogger, ConsoleColorProvider, ConsoleDestinationProvider, JsonFormatterProvider, LogDestinationProvider, LogEntry, LogFormatterProvider, Logger, LoggerDescriptorOptions, MemoryDestinationProvider, SimpleFormatterProvider };
+//# sourceMappingURL=index.d.ts.map

package/logger.js

@@ -0,0 +1 @@
+export * from '@alepha/logger'

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "alepha",
-	"version": "0.9.3",
+	"version": "0.9.4",
 	"type": "module",
 	"engines": {
 		"node": ">=22.0.0"
@@ -15,49 +15,51 @@
 	"main": "./core.js",
 	"types": "./core.d.ts",
 	"dependencies": {
-		"@alepha/batch": "0.9.3",
-		"@alepha/bucket": "0.9.3",
-		"@alepha/cache": "0.9.3",
-		"@alepha/cache-redis": "0.9.3",
-		"@alepha/command": "0.9.3",
-		"@alepha/core": "0.9.3",
-		"@alepha/datetime": "0.9.3",
-		"@alepha/file": "0.9.3",
-		"@alepha/lock": "0.9.3",
-		"@alepha/lock-redis": "0.9.3",
-		"@alepha/postgres": "0.9.3",
-		"@alepha/queue": "0.9.3",
-		"@alepha/queue-redis": "0.9.3",
-		"@alepha/react": "0.9.3",
-		"@alepha/react-auth": "0.9.3",
-		"@alepha/react-form": "0.9.3",
-		"@alepha/react-head": "0.9.3",
-		"@alepha/react-i18n": "0.9.3",
-		"@alepha/redis": "0.9.3",
-		"@alepha/retry": "0.9.3",
-		"@alepha/router": "0.9.3",
-		"@alepha/scheduler": "0.9.3",
-		"@alepha/security": "0.9.3",
-		"@alepha/server": "0.9.3",
-		"@alepha/server-cache": "0.9.3",
-		"@alepha/server-compress": "0.9.3",
-		"@alepha/server-cookies": "0.9.3",
-		"@alepha/server-cors": "0.9.3",
-		"@alepha/server-health": "0.9.3",
-		"@alepha/server-helmet": "0.9.3",
-		"@alepha/server-links": "0.9.3",
-		"@alepha/server-metrics": "0.9.3",
-		"@alepha/server-multipart": "0.9.3",
-		"@alepha/server-proxy": "0.9.3",
-		"@alepha/server-security": "0.9.3",
-		"@alepha/server-static": "0.9.3",
-		"@alepha/server-swagger": "0.9.3",
-		"@alepha/topic": "0.9.3",
-		"@alepha/topic-redis": "0.9.3",
-		"@alepha/vite": "0.9.3"
+		"@alepha/batch": "0.9.4",
+		"@alepha/bucket": "0.9.4",
+		"@alepha/cache": "0.9.4",
+		"@alepha/cache-redis": "0.9.4",
+		"@alepha/command": "0.9.4",
+		"@alepha/core": "0.9.4",
+		"@alepha/datetime": "0.9.4",
+		"@alepha/file": "0.9.4",
+		"@alepha/lock": "0.9.4",
+		"@alepha/lock-redis": "0.9.4",
+		"@alepha/logger": "0.9.4",
+		"@alepha/postgres": "0.9.4",
+		"@alepha/queue": "0.9.4",
+		"@alepha/queue-redis": "0.9.4",
+		"@alepha/react": "0.9.4",
+		"@alepha/react-auth": "0.9.4",
+		"@alepha/react-form": "0.9.4",
+		"@alepha/react-head": "0.9.4",
+		"@alepha/react-i18n": "0.9.4",
+		"@alepha/redis": "0.9.4",
+		"@alepha/retry": "0.9.4",
+		"@alepha/router": "0.9.4",
+		"@alepha/scheduler": "0.9.4",
+		"@alepha/security": "0.9.4",
+		"@alepha/server": "0.9.4",
+		"@alepha/server-cache": "0.9.4",
+		"@alepha/server-compress": "0.9.4",
+		"@alepha/server-cookies": "0.9.4",
+		"@alepha/server-cors": "0.9.4",
+		"@alepha/server-health": "0.9.4",
+		"@alepha/server-helmet": "0.9.4",
+		"@alepha/server-links": "0.9.4",
+		"@alepha/server-metrics": "0.9.4",
+		"@alepha/server-multipart": "0.9.4",
+		"@alepha/server-proxy": "0.9.4",
+		"@alepha/server-security": "0.9.4",
+		"@alepha/server-static": "0.9.4",
+		"@alepha/server-swagger": "0.9.4",
+		"@alepha/topic": "0.9.4",
+		"@alepha/topic-redis": "0.9.4",
+		"@alepha/vite": "0.9.4",
+		"react": "^19.1.1"
 	},
 	"devDependencies": {
-		"tsdown": "^0.13.2"
+		"tsdown": "^0.14.1"
 	},
 	"scripts": {
 		"build": "node build.ts"
@@ -123,6 +125,11 @@
 			"require": "./lock/redis.cjs",
 			"types": "./lock/redis.d.ts"
 		},
+		"./logger": {
+			"import": "./logger.js",
+			"require": "./logger.cjs",
+			"types": "./logger.d.ts"
+		},
 		"./postgres": {
 			"import": "./postgres.js",
 			"require": "./postgres.cjs",
@@ -286,6 +293,7 @@
 		"file",
 		"lock",
 		"lock-redis",
+		"logger",
 		"postgres",
 		"queue",
 		"queue-redis",