@basalt.lab/basalt-logger 1.10.0 → 1.11.2

package/build/chunk-9w8d7dhh.js

@@ -0,0 +1,3 @@
+import{randomUUID as v}from"crypto";class w extends Error{cause;_uuidError=v();_date=new Date;_code;_fileName="";_line=0;_column=0;constructor(q){super(q?.key?.[0]||"error.unknown");if(super.name="BasaltError",this.cause=q?.cause,this._code=q?.key?.[1]||500,Error.captureStackTrace){Error.captureStackTrace(this,this.constructor);let u=this.stack?.split(`
+`)[1]?.trim(),j=u?.match(/:(\d+):(\d+)\)$/);if(this._fileName=u?.split("(")[1]?.split(":")[0]||"",j)this._line=j[1]?parseInt(j[1],10):0,this._column=j[2]?parseInt(j[2],10):0}}get uuidError(){return this._uuidError}get date(){return this._date}get fileName(){return this._fileName}get line(){return this._line}get column(){return this._column}get code(){return this._code}}var A={STRATEGY_ALREADY_ADDED:["error.basalt-logger.strategy_already_added",500],STRATEGY_NOT_FOUND:["error.basalt-logger.strategy_not_found",500],NO_STRATEGY_ADDED:["error.basalt-logger.no_strategy_added",500]};
+export{w as b,A as c};

package/build/chunk-fjqkpbx0.js

@@ -0,0 +1,2 @@
+import{b as z,c as C}from"./chunk-9w8d7dhh.js";import{Transform as H}from"stream";class I{_strategies=new Map;_logStream;_pendingLogs=[];_maxPendingLogs=1e4;_writing=!1;constructor(){this._logStream=new H({objectMode:!0,transform:(q,w,x)=>{this.executeStrategies(q.level,new Date(q.date),q.object,q.strategiesNames),x()}})}addStrategy(q,w){if(this._strategies.has(q))throw new z({key:C.STRATEGY_ALREADY_ADDED,cause:{strategyName:q}});this._strategies.set(q,w)}removeStrategy(q){if(!this._strategies.has(q))throw new z({key:C.STRATEGY_NOT_FOUND,cause:{strategyName:q}});this._strategies.delete(q)}clearStrategies(){this._strategies.clear()}error(q,w){this.out("ERROR",q,w)}warn(q,w){this.out("WARN",q,w)}info(q,w){this.out("INFO",q,w)}debug(q,w){this.out("DEBUG",q,w)}log(q,w){this.out("LOG",q,w)}executeStrategies(q,w,x,D){for(let F of D)this._strategies.get(F)?.log(q,w,x)}out(q,w,x=[...this._strategies.keys()]){if(this._strategies.size===0)throw new z({key:C.NO_STRATEGY_ADDED});if(this._pendingLogs.length>=this._maxPendingLogs)return;let D={date:new Date().toISOString(),level:q,object:w,strategiesNames:x};if(this._pendingLogs.push(D),!this._writing)this._writing=!0,setImmediate(this.writeLog.bind(this))}writeLog(){let q=!0;while(q&&this._pendingLogs.length>0){let w=this._pendingLogs.shift();q=this._logStream.write(w)}if(!q)this._logStream.once("drain",this.writeLog.bind(this));else this._writing=!1}}
+export{I as a};

package/build/common/error/basalt.error.d.ts

@@ -1,24 +1,46 @@
 /**
  * Represents the options for the Basalt error.
  */
-export interface BasaltErrorOptions {
+export interface BasaltErrorOptions<T = unknown> {
     /**
      * The error key.
      */
-    messageKey: string;
+    key?: [string, number] | undefined;
     /**
-     * The status code.
+     * The cause of the error.
      */
-    code?: number;
-    /**
-     * The error detail.
-     */
-    detail?: unknown;
+    cause?: T;
 }
 /**
- * BasaltError is a class that represents an error entity with a unique identifier.
+ * Basalt error class that extends the ({@link Error}) class and provides additional properties. (uuidError, date, code, fileName, line, column)
+ *
+ * @typeparam T - The type of the cause of the error.
+ *
+ * @example
+ * The following example demonstrates how to throw a new instance of the Basalt error.
+ * ```typescript
+ * try {
+ *   throw new BasaltError();
+ * } catch (error) {
+ *  console.log(error instanceof BasaltError); // true
+ *  console.log(error instanceof Error); // true
+ *  // u can access to uuidError, date, code, fileName, line, column, message, name, stack, cause
+ * }
+ * ```
+ * @example
+ * The following example demonstrates how to create a new instance of the Basalt error with provided type for the cause.
+ * ```typescript
+ * const basaltError: BasaltError<{ foo: 'bar' }> = new BasaltError({
+ *     key: 'error.unknown',
+ *     cause: {
+ *         foo: 'bar',
+ *     },
+ * });
+ * console.log(basaltError.cause); // { foo: 'bar' } if you make ctrl + space after cause. you will see the properties of the cause
+ * ```
  */
-export declare class BasaltError extends Error {
+export declare class BasaltError<T = unknown> extends Error {
+    readonly cause: T | undefined;
     /**
      * The unique identifier of the error.
      * This identifier is used to track the error in the logs.
@@ -29,41 +51,49 @@ export declare class BasaltError extends Error {
      */
     private readonly _date;
     /**
-     * The error code.
+     * The error code. (HTTP status code)
      */
     private readonly _code;
     /**
-     * The error detail.
+     * The fileName where the error occurred (if available).
      */
-    private readonly _detail;
+    private readonly _fileName;
     /**
-     * Creates a new instance of the ErrorEntity class.
+     * The line number where the error occurred (if available).
+     */
+    private readonly _line;
+    /**
+     * The column number where the error occurred (if available).
+     */
+    private readonly _column;
+    /**
+     * Creates a new instance of the Basalt error.
      *
-     * @param basaltErrorOptions - The options to create the error entity. ({@link BasaltErrorOptions})
+     * @param basaltErrorOptions - The options for the Basalt error. ({@link BasaltErrorOptions})
      */
-    constructor(basaltErrorOptions: Readonly<BasaltErrorOptions>);
+    constructor(basaltErrorOptions?: Readonly<BasaltErrorOptions<T>>);
     /**
      * Gets the unique identifier of the error.
-     *
-     * @returns The unique identifier of the error.
      */
     get uuidError(): string;
     /**
      * Gets the date when the error was created.
-     *
-     * @returns The date when the error was created.
      */
     get date(): Date;
     /**
-     * Gets the error code.
-     *
-     * @returns The error code.
+     * Gets the fileName where the error occurred (if available).
      */
-    get code(): number;
+    get fileName(): string;
     /**
-     * Gets the error detail.
-     *
-     * @returns The error detail.
+     * Gets the line number where the error occurred (if available).
+     */
+    get line(): number;
+    /**
+     * Gets the column number where the error occurred (if available).
      */
-    get detail(): unknown;
+    get column(): number;
+    /**
+     * Gets the error code.
+     */
+    get code(): number;
 }

package/build/common/error/global.error.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Error keys for the Basalt logger
+ */
+export declare const GLOBAL_ERRORS: Record<string, [string, number]>;

package/build/common/error/index.d.ts

@@ -1,2 +1,2 @@
 export * from './basalt.error.ts';
-export * from './keys.error.ts';
+export * from './global.error.ts';

package/build/common/error/index.js

@@ -1 +1 @@
-import"../../chunk-x3cvtn7y.js";import{b as a,c as b}from"../../chunk-kadx22tz.js";export{b as ErrorKeys,a as BasaltError};
+import"../../chunk-x3cvtn7y.js";import{b as a,c as b}from"../../chunk-9w8d7dhh.js";export{b as GLOBAL_ERRORS,a as BasaltError};

package/build/common/i18n/index.d.ts

@@ -0,0 +1,9 @@
+import ar from './ar.json';
+import de from './de.json';
+import en from './en.json';
+import es from './es.json';
+import fr from './fr.json';
+import it from './it.json';
+import ja from './ja.json';
+import ko from './ko.json';
+export { ar, de, en, es, fr, it, ja, ko };

package/build/common/i18n/index.js

@@ -0,0 +1 @@
+var a={error:{"basalt-logger":{no_strategy_added:"لم يتم إضافة أي استراتيجية",strategy_already_added:"الاستراتيجية مضافة بالفعل",strategy_not_found:"الاستراتيجية غير موجودة"}}};var r={error:{"basalt-logger":{no_strategy_added:"Keine Strategie hinzugefügt",strategy_already_added:"Strategie bereits hinzugefügt",strategy_not_found:"Strategie nicht gefunden"}}};var o={error:{"basalt-logger":{no_strategy_added:"No strategy added",strategy_already_added:"Strategy already added",strategy_not_found:"Strategy not found"}}};var n={error:{"basalt-logger":{no_strategy_added:"No se ha añadido ninguna estrategia",strategy_already_added:"Estrategia ya añadida",strategy_not_found:"Estrategia no encontrada"}}};var _={error:{"basalt-logger":{no_strategy_added:"Aucune stratégie ajoutée",strategy_already_added:"La stratégie a déjà été ajoutée",strategy_not_found:"Stratégie non trouvée"}}};var i={error:{"basalt-logger":{no_strategy_added:"Nessuna strategia aggiunta",strategy_already_added:"Strategia già aggiunta",strategy_not_found:"Strategia non trovata"}}};var f={error:{"basalt-logger":{no_strategy_added:"戦略が追加されていません",strategy_already_added:"戦略はすでに追加されています",strategy_not_found:"戦略が見つかりません"}}};var p={error:{"basalt-logger":{no_strategy_added:"전략이 추가되지 않았습니다",strategy_already_added:"전략이 이미 추가되었습니다",strategy_not_found:"전략을 찾을 수 없습니다"}}};export{p as ko,f as ja,i as it,_ as fr,n as es,o as en,r as de,a as ar};

package/build/domain/service/basaltLogger.service.d.ts

@@ -24,7 +24,8 @@ export declare class BasaltLogger {
      */
     private _writing;
     /**
-     * Initializes the BasaltLogger.
+     * Initializes the BasaltLogger, creates the log stream ({@link Transform}).
+     * The log stream processes the log entries and executes the logging strategies.
      */
     constructor();
     /**
@@ -33,7 +34,7 @@ export declare class BasaltLogger {
      * @param name - The name of the strategy.
      * @param strategy - The strategy to add. ({@link LoggerStrategy})
      *
-     * @throws ({@link BasaltError}) - If the strategy is already added. ({@link ErrorKeys.STRATEGY_ALREADY_ADDED})
+     * @throws ({@link BasaltError}) - If the strategy is already added. ({@link GLOBAL_ERRORS.STRATEGY_ALREADY_ADDED})
      */
     addStrategy(name: string, strategy: LoggerStrategy): void;
     /**
@@ -41,7 +42,7 @@ export declare class BasaltLogger {
      *
      * @param name - The name of the strategy.
      *
-     * @throws ({@link BasaltError}) - If the strategy is not found. ({@link ErrorKeys.STRATEGY_NOT_FOUND})
+     * @throws ({@link BasaltError}) - If the strategy is not found. ({@link GLOBAL_ERRORS.STRATEGY_NOT_FOUND})
      */
     removeStrategy(name: string): void;
     /**
@@ -53,6 +54,8 @@ export declare class BasaltLogger {
      *
      * @param object - The object to log.
      * @param strategiesNames - The names of the strategies to use. (default: all strategies)
+     *
+     * @throws ({@link BasaltError}) - If no strategy is added. ({@link GLOBAL_ERRORS.NO_STRATEGY_ADDED})
      */
     error(object: unknown, strategiesNames?: string[]): void;
     /**
@@ -60,6 +63,8 @@ export declare class BasaltLogger {
      *
      * @param object - The object to log.
      * @param strategiesNames - The names of the strategies to use. (default: all strategies)
+     *
+     * @throws ({@link BasaltError}) - If no strategy is added. ({@link GLOBAL_ERRORS.NO_STRATEGY_ADDED})
      */
     warn(object: unknown, strategiesNames?: string[]): void;
     /**
@@ -67,6 +72,8 @@ export declare class BasaltLogger {
      *
      * @param object - The object to log.
      * @param strategiesNames - The names of the strategies to use. (default: all strategies)
+     *
+     * @throws ({@link BasaltError}) - If no strategy is added. ({@link GLOBAL_ERRORS.NO_STRATEGY_ADDED})
      */
     info(object: unknown, strategiesNames?: string[]): void;
     /**
@@ -99,7 +106,7 @@ export declare class BasaltLogger {
      * @param object - The object to log.
      * @param strategiesNames - The names of the strategies to use. (default: all strategies)
      *
-     * @throws ({@link BasaltError}) - If no strategy is added. ({@link ErrorKeys.NO_STRATEGY_ADDED})
+     * @throws ({@link BasaltError}) - If no strategy is added. ({@link GLOBAL_ERRORS.NO_STRATEGY_ADDED})
      */
     private out;
     /**

package/build/domain/service/basaltLogger.service.js

@@ -1 +1 @@
-import{a}from"../../chunk-xymy9zxw.js";import"../../chunk-kadx22tz.js";import"../../chunk-mcf4zz53.js";export{a as BasaltLogger};
+import{a}from"../../chunk-fjqkpbx0.js";import"../../chunk-9w8d7dhh.js";import"../../chunk-mcf4zz53.js";export{a as BasaltLogger};

package/build/index.js

@@ -1 +1 @@
-import"./chunk-x3cvtn7y.js";import"./chunk-amcnfafr.js";import{a as u}from"./chunk-xymy9zxw.js";import{b as l,c as p}from"./chunk-kadx22tz.js";import{d as w,e as z}from"./chunk-wp46zt40.js";import{f as q}from"./chunk-mcf4zz53.js";export{q as LogLevels,z as FileLoggerStrategy,p as ErrorKeys,w as ConsoleLoggerStrategy,u as BasaltLogger,l as BasaltError};
+import"./chunk-x3cvtn7y.js";import"./chunk-amcnfafr.js";import{a as u}from"./chunk-fjqkpbx0.js";import{b as l,c as p}from"./chunk-9w8d7dhh.js";import{d as w,e as z}from"./chunk-wp46zt40.js";import{f as q}from"./chunk-mcf4zz53.js";export{q as LogLevels,p as GLOBAL_ERRORS,z as FileLoggerStrategy,w as ConsoleLoggerStrategy,u as BasaltLogger,l as BasaltError};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basalt.lab/basalt-logger",
-  "version": "1.10.0",
+  "version": "1.11.2",
   "description": "Logger module for Basalt Framework",
   "type": "module",
   "types": "./build/index.d.ts",
@@ -34,6 +34,11 @@
       "types": "./build/domain/service/strategy/index.d.js",
       "import": "./build/domain/service/strategy/index.js",
       "require": "./build/domain/service/strategy/index.js"
+    },
+    "./translation": {
+      "types": "./build/common/i18n/index.d.js",
+      "import": "./build/common/i18n/index.js",
+      "require": "./build/common/i18n/index.js"
     }
   },
   "scripts": {
@@ -61,17 +66,67 @@
     "url": "https://github.com/Basalt-Lab/basalt-logger/issues"
   },
   "devDependencies": {
-    "@types/bun": "^1.1.13",
-    "@types/node": "^22.9.0",
-    "@eslint/js": "^9.14.0",
-    "@stylistic/eslint-plugin": "^2.10.1",
-    "eslint": "^9.14.0",
-    "eslint-plugin-tsdoc": "^0.3.0",
-    "globals": "^15.12.0",
-    "typescript-eslint": "^8.13.0",
+    "@types/bun": "^1.1.14",
+    "@types/node": "^22.10.2",
+    "@eslint/js": "^9.17.0",
+    "@stylistic/eslint-plugin": "^2.12.1",
+    "eslint": "^9.17.0",
+    "eslint-plugin-tsdoc": "^0.4.0",
+    "typescript-eslint": "^8.18.1",
     "tsc-alias": "^1.8.10",
-    "tslib": "^2.8.1",
-    "typedoc": "^0.26.11",
-    "typescript": "^5.6.3"
+    "typedoc": "^0.27.5",
+    "typescript": "^5.7.2"
+  },
+  "changelog": {
+    "types": {
+      "feat": {
+        "title": "🚀 Enhancements",
+        "semver": "minor"
+      },
+      "perf": {
+        "title": "⚡ Performance",
+        "semver": "patch"
+      },
+      "fix": {
+        "title": "🔧 Fixes",
+        "semver": "patch"
+      },
+      "refactor": {
+        "title": "🧹 Refactors",
+        "semver": "patch"
+      },
+      "docs": {
+        "title": "📖 Documentation",
+        "semver": "patch"
+      },
+      "build": {
+        "title": "📦 Build",
+        "semver": "patch"
+      },
+      "types": {
+        "title": "🌊 Types",
+        "semver": "patch"
+      },
+      "chore": {
+        "title": "🦉 Chore"
+      },
+      "examples": {
+        "title": "🏀 Examples"
+      },
+      "test": {
+        "title": "🧪 Tests"
+      },
+      "style": {
+        "title": "🎨 Styles"
+      },
+      "ci": {
+        "title": "🤖 CI"
+      }
+    },
+    "templates": {
+      "commitMessage": "chore(🦉): v{{newVersion}}",
+      "tagMessage": "v{{newVersion}}",
+      "tagBody": "v{{newVersion}}"
+    }
   }
-}
+}

package/build/chunk-kadx22tz.js

@@ -1,2 +0,0 @@
-import{randomUUID as k}from"crypto";class q extends Error{_uuidError=k();_date=new Date;_code;_detail;constructor(j){super();if(this._code=j.code??500,this.message=j.messageKey,this._detail=j.detail,this.name="BasaltError",Error.captureStackTrace)Error.captureStackTrace(this,this.constructor)}get uuidError(){return this._uuidError}get date(){return this._date}get code(){return this._code}get detail(){return this._detail}}var x={STRATEGY_ALREADY_ADDED:"error.basalt-logger.strategy_already_added",STRATEGY_NOT_FOUND:"error.basalt-logger.strategy_not_found",NO_STRATEGY_ADDED:"error.basalt-logger.no_strategy_added"};
-export{q as b,x as c};

package/build/chunk-xymy9zxw.js

@@ -1,2 +0,0 @@
-import{b as z,c as A}from"./chunk-kadx22tz.js";import{Transform as F}from"stream";class G{_strategies=new Map;_logStream;_pendingLogs=[];_maxPendingLogs=1e4;_writing=!1;constructor(){this._logStream=new F({objectMode:!0,transform:(q,w,x)=>{this.executeStrategies(q.level,new Date(q.date),q.object,q.strategiesNames),x()}})}addStrategy(q,w){if(this._strategies.has(q))throw new z({messageKey:A.STRATEGY_ALREADY_ADDED,detail:{strategyName:q}});this._strategies.set(q,w)}removeStrategy(q){if(!this._strategies.has(q))throw new z({messageKey:A.STRATEGY_NOT_FOUND,detail:{strategyName:q}});this._strategies.delete(q)}clearStrategies(){this._strategies.clear()}error(q,w){this.out("ERROR",q,w)}warn(q,w){this.out("WARN",q,w)}info(q,w){this.out("INFO",q,w)}debug(q,w){this.out("DEBUG",q,w)}log(q,w){this.out("LOG",q,w)}executeStrategies(q,w,x,C){for(let D of C)this._strategies.get(D)?.log(q,w,x)}out(q,w,x=[...this._strategies.keys()]){if(this._strategies.size===0)throw new z({messageKey:A.NO_STRATEGY_ADDED});if(this._pendingLogs.length>=this._maxPendingLogs)return;let C={date:new Date().toISOString(),level:q,object:w,strategiesNames:x};if(this._pendingLogs.push(C),!this._writing)this._writing=!0,setImmediate(this.writeLog.bind(this))}writeLog(){let q=!0;while(q&&this._pendingLogs.length>0){let w=this._pendingLogs.shift();q=this._logStream.write(w)}if(!q)this._logStream.once("drain",this.writeLog.bind(this));else this._writing=!1}}
-export{G as a};

package/build/common/error/keys.error.d.ts

@@ -1,16 +0,0 @@
-/**
- * Error keys for the Basalt logger
- */
-export declare const ErrorKeys: {
-    /**
-     * Interpolation :
-     * - strategyName : The name of the strategy.
-     */
-    STRATEGY_ALREADY_ADDED: string;
-    /**
-     * Interpolation :
-     * - strategyName : The name of the strategy
-     */
-    STRATEGY_NOT_FOUND: string;
-    NO_STRATEGY_ADDED: string;
-};