@leyyo/common 1.3.18 → 1.3.19

package/dist/common/error.common.d.ts

@@ -8,51 +8,21 @@ export declare class ErrorCommon implements ErrorCommonLike {
     private _stats;
     readonly started: Date;
     constructor(leyyo: LeyyoLike);
-    /**
-     * Transform error as a bare object
-     *
-     * @param {Error} err - error instance
-     * @param {Opt} existing - existing parameters
-     * @param {boolean} ignoreNameMessage - ignore name & message?
-     * @param {WeakSet} weakSet - weak set to prevent duplicates
-     * @return {Opt?} - bare error object
-     * */
     private _toErrorJson;
-    /**
-     * Build error info part as `<part1/part2>`
-     *
-     * @param {Array<string|number>} parts - parts for info
-     * @return {string}
-     * */
     private _buildTextParts;
-    /** @inheritDoc */
     setConfigItem(clazz: ClassLike, conf: ErrorItemConfig): void;
-    /** @inheritDoc */
     getConfigItem(clazz: ClassLike): ErrorItemConfig;
-    /** @inheritDoc */
     emit(err: Error): void;
-    /** @inheritDoc */
     buildStack(source: Error, force?: boolean): void;
-    /** @inheritDoc */
     toJsonBasic(err: Error, existing?: Opt): Opt;
-    /** @inheritDoc */
     toJsonFull(err: Error, existing: Opt): Opt;
-    /** @inheritDoc */
     cast<E extends LeyyoErrorLike>(e: Error, params?: Opt): E;
-    /** @inheritDoc */
     forcedCast<E extends LeyyoErrorLike>(clazz: ClassLike, e: Error, params?: Opt): E;
-    /** @inheritDoc */
     addKnownPackage(packageName: string, shortName: string): void;
-    /** @inheritDoc */
     bareObj(err: Error): ErrorObject;
-    /** @inheritDoc */
     text(err: Error, ...parts: Array<string | number>): string;
-    /** @inheritDoc */
     addStat(p1: Error | ErrorCtor): number;
-    /** @inheritDoc */
     getStat(p1: Error | ErrorCtor): number;
-    /** @inheritDoc */
     clearStats(): void;
-    /** @inheritDoc */
     listStats(): Record<string, number>;
 }

package/dist/common/error.common.js

@@ -1,9 +1,8 @@
-import { getFqn, getSymbol, isClass, isEmpty, isFilledArr, isFilledObj, isObj, isText, secureJson, setSymbol, testCase } from "../function/index.js";
+import { getFqn, getSymbol, isClass, isEmpty, isFilledArr, isFilledObj, isObj, isText, secureJson, setSymbol, testCase, } from "../function/index.js";
 import * as stackTraceParser from "stacktrace-parser";
 import { FQN } from "../internal.js";
-import { KEY_ERROR_DEFAULT_MESSAGE, KEY_ERROR_EMIT, KEY_ERROR_EMITTED, KEY_ERROR_I18N, KEY_ERROR_RAISED, VAL_ERROR_UNKNOWN_MESSAGE, VAL_ERROR_UNKNOWN_NAME } from "../const/index.js";
+import { KEY_ERROR_DEFAULT_MESSAGE, KEY_ERROR_EMIT, KEY_ERROR_EMITTED, KEY_ERROR_I18N, KEY_ERROR_RAISED, VAL_ERROR_UNKNOWN_MESSAGE, VAL_ERROR_UNKNOWN_NAME, } from "../const/index.js";
 const where = `${FQN}.ErrorCommon`;
-// noinspection JSUnusedGlobalSymbols
 export class ErrorCommon {
     leyyo;
     _knownPackages;
@@ -12,16 +11,6 @@ export class ErrorCommon {
     constructor(leyyo) {
         this.leyyo = leyyo;
     }
-    // region private
-    /**
-     * Transform error as a bare object
-     *
-     * @param {Error} err - error instance
-     * @param {Opt} existing - existing parameters
-     * @param {boolean} ignoreNameMessage - ignore name & message?
-     * @param {WeakSet} weakSet - weak set to prevent duplicates
-     * @return {Opt?} - bare error object
-     * */
     _toErrorJson(err, existing, ignoreNameMessage, weakSet) {
         if (!(err instanceof Error)) {
             return undefined;
@@ -36,20 +25,22 @@ export class ErrorCommon {
             result = { ...result, ...leyyoError.params };
         }
         for (const [k, v] of Object.entries(err)) {
-            if (typeof k !== 'string' || ['undefined', 'symbol', 'function'].includes(typeof v) || v === null) {
+            if (typeof k !== "string" ||
+                ["undefined", "symbol", "function"].includes(typeof v) ||
+                v === null) {
                 continue;
             }
             switch (k) {
-                case 'name':
-                case 'message':
+                case "name":
+                case "message":
                     if (!ignoreNameMessage) {
                         result[k] = v;
                     }
                     break;
-                case 'stack':
-                case 'params':
+                case "stack":
+                case "params":
                     break;
-                case 'causedBy':
+                case "causedBy":
                     if (v instanceof Error) {
                         const causedBy = this._toErrorJson(v, {}, false, weakSet);
                         if (causedBy) {
@@ -59,7 +50,7 @@ export class ErrorCommon {
                     else if (isFilledArr(v)) {
                         const errors = v;
                         const causedErrors = [];
-                        errors.forEach(e => {
+                        errors.forEach((e) => {
                             const causedError = this._toErrorJson(e, {}, false, weakSet);
                             if (causedError) {
                                 causedErrors.push(causedError);
@@ -76,36 +67,29 @@ export class ErrorCommon {
             }
         }
     }
-    /**
-     * Build error info part as `<part1/part2>`
-     *
-     * @param {Array<string|number>} parts - parts for info
-     * @return {string}
-     * */
     _buildTextParts(parts) {
-        parts = parts.map(p => {
-            if (typeof p === 'string') {
+        parts = parts
+            .map((p) => {
+            if (typeof p === "string") {
                 p = p.trim();
-                return (p) ? p : undefined;
+                return p ? p : undefined;
             }
-            else if (typeof p === 'number') {
+            else if (typeof p === "number") {
                 return p.toString(10);
             }
             else {
                 return undefined;
             }
-        }).filter(Boolean);
-        return parts.length > 0 ? '<' + parts.join('/') + '> ' : '';
+        })
+            .filter(Boolean);
+        return parts.length > 0 ? "<" + parts.join("/") + "> " : "";
     }
-    // endregion private
-    // region public
-    /** @inheritDoc */
     setConfigItem(clazz, conf) {
         if (!isClass(clazz)) {
-            throw new this.leyyo.developerError('Invalid package name', testCase(FQN, 230), where);
+            throw new this.leyyo.developerError("Invalid package name", testCase(FQN, 230), where);
         }
         if (!isObj(conf)) {
-            throw new this.leyyo.developerError('Invalid package name', testCase(FQN, 230), where);
+            throw new this.leyyo.developerError("Invalid package name", testCase(FQN, 230), where);
         }
         if (isText(conf.message)) {
             setSymbol(clazz, KEY_ERROR_DEFAULT_MESSAGE, conf.message);
@@ -117,7 +101,6 @@ export class ErrorCommon {
             setSymbol(clazz, KEY_ERROR_I18N, conf.i18n);
         }
     }
-    /** @inheritDoc */
     getConfigItem(clazz) {
         return {
             message: getSymbol(clazz, KEY_ERROR_DEFAULT_MESSAGE),
@@ -125,25 +108,20 @@ export class ErrorCommon {
             i18n: getSymbol(clazz, KEY_ERROR_I18N),
         };
     }
-    /** @inheritDoc */
     emit(err) {
         if (!(err instanceof Error)) {
             return;
         }
-        // already emitted
         if (getSymbol(err, KEY_ERROR_EMITTED)) {
             return;
         }
         const clazz = err.constructor;
-        // error does not support to emit
         if (!getSymbol(clazz, KEY_ERROR_EMIT)) {
             return;
         }
-        // prevent duplicated emits
         setSymbol(err, KEY_ERROR_EMITTED, true);
-        this.leyyo.eventCommon.emit('error:emit', err);
+        this.leyyo.eventCommon.emit("error:emit", err);
     }
-    /** @inheritDoc */
     buildStack(source, force) {
         const err = source;
         if (!force && Array.isArray(err.stackTrace)) {
@@ -164,12 +142,12 @@ export class ErrorCommon {
             if (original) {
                 const frames = stackTraceParser.parse(original);
                 if (Array.isArray(frames)) {
-                    frames.forEach(frame => {
-                        if (['<unknown>', 'Object.<anonymous>'].includes(frame.methodName)) {
+                    frames.forEach((frame) => {
+                        if (["<unknown>", "Object.<anonymous>"].includes(frame.methodName)) {
                             frame.methodName = undefined;
                         }
                         if (frame.file) {
-                            if (frame.file.startsWith('node:')) {
+                            if (frame.file.startsWith("node:")) {
                                 frame.file = `@ ` + frame.file.substring(5);
                             }
                             else {
@@ -178,10 +156,10 @@ export class ErrorCommon {
                                         const index = frame.file.indexOf(pck);
                                         if (index >= 0) {
                                             let part = frame.file.substring(index + pck.length);
-                                            if (part.startsWith('/')) {
+                                            if (part.startsWith("/")) {
                                                 part = part.substring(1);
                                             }
-                                            if (part.startsWith('dist/')) {
+                                            if (part.startsWith("dist/")) {
                                                 part = part.substring(5);
                                             }
                                             frame.file = `#${short} ` + part;
@@ -190,7 +168,7 @@ export class ErrorCommon {
                                     }
                                 }
                             }
-                            if (frame.file.endsWith('.js') || frame.file.endsWith('.ts')) {
+                            if (frame.file.endsWith(".js") || frame.file.endsWith(".ts")) {
                                 frame.file.substring(0, frame.file.length - 3);
                             }
                         }
@@ -202,7 +180,7 @@ export class ErrorCommon {
                             line.method = frame.methodName;
                         }
                         if (frame.lineNumber !== undefined && frame.column !== undefined) {
-                            line.pos = `${frame.lineNumber ?? ''}:${frame.column ?? ''}`;
+                            line.pos = `${frame.lineNumber ?? ""}:${frame.column ?? ""}`;
                         }
                         err.stackTrace.push(line);
                     });
@@ -210,18 +188,14 @@ export class ErrorCommon {
             }
         }
         catch (e) {
-            // none
         }
     }
-    /** @inheritDoc */
     toJsonBasic(err, existing) {
         return this._toErrorJson(err, existing, true, new WeakSet());
     }
-    /** @inheritDoc */
     toJsonFull(err, existing) {
         return this._toErrorJson(err, existing, false, new WeakSet());
     }
-    /** @inheritDoc */
     cast(e, params) {
         if (!(e instanceof Error)) {
             return new this.leyyo.leyyoError(secureJson(e));
@@ -234,7 +208,6 @@ export class ErrorCommon {
         err.causedBy = e;
         return err;
     }
-    /** @inheritDoc */
     forcedCast(clazz, e, params) {
         if (!(e instanceof Error)) {
             return new this.leyyo.leyyoError(secureJson(e));
@@ -250,10 +223,9 @@ export class ErrorCommon {
         err.causedBy = e;
         return err;
     }
-    /** @inheritDoc */
     addKnownPackage(packageName, shortName) {
         if (!isText(packageName)) {
-            throw new this.leyyo.developerError('Invalid package name', testCase(FQN, 230), where);
+            throw new this.leyyo.developerError("Invalid package name", testCase(FQN, 230), where);
         }
         if (!isText(shortName)) {
             throw new this.leyyo.developerError(`Invalid short name [${packageName}]`, testCase(FQN, 231), where);
@@ -266,7 +238,6 @@ export class ErrorCommon {
         }
         this._knownPackages.set(packageName, shortName);
     }
-    /** @inheritDoc */
     bareObj(err) {
         if (err instanceof Error) {
             return {
@@ -279,15 +250,13 @@ export class ErrorCommon {
             message: VAL_ERROR_UNKNOWN_MESSAGE,
         };
     }
-    /** @inheritDoc */
     text(err, ...parts) {
-        const info = parts.length > 0 ? this._buildTextParts(parts) : '';
+        const info = parts.length > 0 ? this._buildTextParts(parts) : "";
         if (err instanceof Error) {
             return `${info}[err:${err?.name ?? VAL_ERROR_UNKNOWN_NAME}] => ^/${err?.message ?? VAL_ERROR_UNKNOWN_MESSAGE}/$`;
         }
         return `${info}[err:${VAL_ERROR_UNKNOWN_NAME}] => ^/${VAL_ERROR_UNKNOWN_MESSAGE}/$`;
     }
-    /** @inheritDoc */
     addStat(p1) {
         let num = -1;
         try {
@@ -300,7 +269,7 @@ export class ErrorCommon {
                 err[KEY_ERROR_RAISED] = true;
                 clazz = err.constructor;
             }
-            else if (typeof p1 === 'function') {
+            else if (typeof p1 === "function") {
                 clazz = p1;
             }
             else {
@@ -319,18 +288,16 @@ export class ErrorCommon {
             this._stats.set(clazz, num);
         }
         catch (e) {
-            // nothing
         }
         return num;
     }
-    /** @inheritDoc */
     getStat(p1) {
         try {
             let clazz;
             if (isObj(p1)) {
                 clazz = p1.constructor;
             }
-            else if (typeof p1 === 'function') {
+            else if (typeof p1 === "function") {
                 clazz = p1;
             }
             else {
@@ -342,18 +309,15 @@ export class ErrorCommon {
             return this._stats.get(clazz) ?? 0;
         }
         catch (e) {
-            // nothing
         }
         return 0;
     }
-    /** @inheritDoc */
     clearStats() {
         if (!this._stats) {
             return;
         }
         this._stats.clear();
     }
-    /** @inheritDoc */
     listStats() {
         if (!this._stats) {
             return {};

package/dist/common/error.pool.d.ts

@@ -1,22 +1,13 @@
 import { Inert } from "./inert.js";
 import { ErrorPoolItem, ErrorPoolLike, ErrorPoolOpt } from "./index.types.js";
 import { ClassLike, LeyyoLike } from "../base/index.js";
-/**
- * Error pool for call with name and lazy loading
- * */
 export declare class ErrorPool extends Inert<ErrorPoolItem, ClassLike, ErrorPoolOpt> implements ErrorPoolLike {
     protected leyyo: LeyyoLike;
     constructor(leyyo: LeyyoLike);
-    /** @inheritDoc */
     protected _getName(target: ClassLike): string;
-    /** @inheritDoc */
     protected _nextLoad(_item: ErrorPoolItem): Promise<void>;
-    /** @inheritDoc */
     protected _setName(target: ClassLike, _name: string): string;
-    /** @inheritDoc */
     protected _afterTargetFound(item: ErrorPoolItem): void;
-    /** @inheritDoc */
     protected _validate(target: ClassLike): boolean;
-    /** @inheritDoc */
-    define(fqn: string, target: ClassLike, opt?: Omit<ErrorPoolOpt, 'name' | 'target' | 'lazyTarget' | 'fqn'>): void;
+    define(fqn: string, target: ClassLike, opt?: Omit<ErrorPoolOpt, "name" | "target" | "lazyTarget" | "fqn">): void;
 }

package/dist/common/error.pool.js

@@ -1,27 +1,18 @@
 import { Inert } from "./inert.js";
 import { isClass } from "../function/index.js";
-// noinspection JSUnusedGlobalSymbols
-/**
- * Error pool for call with name and lazy loading
- * */
 export class ErrorPool extends Inert {
     leyyo;
     constructor(leyyo) {
-        super(leyyo, 'error', { anonymousName: 'Error' });
+        super(leyyo, "error", { anonymousName: "Error" });
         this.leyyo = leyyo;
     }
-    /** @inheritDoc */
     _getName(target) {
         return target?.name;
     }
-    /** @inheritDoc */
-    async _nextLoad(_item) {
-    }
-    /** @inheritDoc */
+    async _nextLoad(_item) { }
     _setName(target, _name) {
         return target?.name;
     }
-    /** @inheritDoc */
     _afterTargetFound(item) {
         if (item.lazyTarget) {
             delete item.lazyTarget;
@@ -32,11 +23,9 @@ export class ErrorPool extends Inert {
             i18n: item.i18n,
         });
     }
-    /** @inheritDoc */
     _validate(target) {
         return isClass(target);
     }
-    /** @inheritDoc */
     define(fqn, target, opt) {
         this.register({ ...(opt ?? {}), fqn, target });
     }

package/dist/common/event.common.d.ts

@@ -1,8 +1,5 @@
 import { EventCommonLike, EventType } from "./index.types.js";
 import { Fnc, LeyyoLike } from "../base/index.js";
-/**
- * Event common interface
- * */
 export declare class EventCommon<T extends string> implements EventCommonLike<T> {
     private leyyo;
     private readonly _emitter;
@@ -11,14 +8,9 @@ export declare class EventCommon<T extends string> implements EventCommonLike<T>
     private readonly _removedEvents;
     private readonly _deactivatedEvents;
     constructor(leyyo: LeyyoLike);
-    /** @inheritDoc */
     fork<F extends string>(): EventCommonLike<T | F>;
-    /** @inheritDoc */
     emit(name: T, ...values: Array<unknown>): boolean;
-    /** @inheritDoc */
     listen<T extends string = string>(name: EventType | T, callback: Fnc): void;
-    /** @inheritDoc */
     deactivate(name: string): boolean;
-    /** @inheritDoc */
     activate(name: string): boolean;
 }

package/dist/common/event.common.js

@@ -2,16 +2,12 @@ import { FQN } from "../internal.js";
 import { isText, testCase } from "../function/index.js";
 import EventEmitter from "node:events";
 const where = `${FQN}.EventCommon`;
-// noinspection JSUnusedGlobalSymbols
-/**
- * Event common interface
- * */
 export class EventCommon {
     leyyo;
     _emitter = new EventEmitter();
     _listenedEvents;
     _waitingEvents;
-    _removedEvents; // stored, emitted
+    _removedEvents;
     _deactivatedEvents;
     constructor(leyyo) {
         this.leyyo = leyyo;
@@ -20,17 +16,14 @@ export class EventCommon {
         this._removedEvents = this.leyyo.repoCommon.newMap(`${where}.removedEvents`);
         this._deactivatedEvents = this.leyyo.repoCommon.newSet(`${where}.deactivatedEvents`);
     }
-    /** @inheritDoc */
     fork() {
         return this;
     }
-    /** @inheritDoc */
     emit(name, ...values) {
         if (!isText(name)) {
-            throw new this.leyyo.developerError('Invalid event name', testCase(FQN, 130), where);
+            throw new this.leyyo.developerError("Invalid event name", testCase(FQN, 130), where);
         }
         if (!this._emitter.emit(name, ...values)) {
-            // It is deactivated, no collect it anymore
             if (this._deactivatedEvents.has(name)) {
                 return true;
             }
@@ -45,28 +38,26 @@ export class EventCommon {
                     parts = [item.length, item.length + 1];
                     this.leyyo.logger.warn(`Removed message. name: ${name}, times: ${parts[1]}`, {
                         where,
-                        eventName: name
+                        eventName: name,
                     });
                     item.shift();
                     this._removedEvents.set(name, parts);
                 }
                 else if (parts[0] >= 10_000) {
-                    // there are too many events, and there is no any listener, close it
                     if (parts[1] > 50_000) {
                         this.deactivate(name);
                         return false;
                     }
-                    // clear half of it
                     parts[0] = 5_000;
                     item.splice(0, 5_000);
-                    parts[1]++; // increment emitted
+                    parts[1]++;
                     this.leyyo.logger.warn(`Removed all messages. name: ${name}, times: ${parts[1]}`, {
                         where,
-                        eventName: name
+                        eventName: name,
                     });
                 }
                 else {
-                    parts[1]++; // increment emitted
+                    parts[1]++;
                     item.shift();
                 }
             }
@@ -75,12 +66,11 @@ export class EventCommon {
         }
         return true;
     }
-    /** @inheritDoc */
     listen(name, callback) {
         if (!isText(name)) {
-            throw new this.leyyo.developerError('Invalid event name', testCase(FQN, 130), where);
+            throw new this.leyyo.developerError("Invalid event name", testCase(FQN, 130), where);
         }
-        if (typeof callback !== 'function') {
+        if (typeof callback !== "function") {
             throw new this.leyyo.developerError(`Invalid listener callback [${name}]`, testCase(FQN, 131), where);
         }
         const exists = this._listenedEvents.has(name);
@@ -88,25 +78,26 @@ export class EventCommon {
             this._emitter.removeAllListeners(name);
         }
         this._emitter.on(name, callback);
-        // if there is a listener, event will be activated automatically
         this.activate(name);
         this._listenedEvents.set(name, callback);
         if (!exists) {
             if (this._waitingEvents.has(name)) {
-                this._waitingEvents.get(name).forEach(values => {
+                this._waitingEvents.get(name).forEach((values) => {
                     this._emitter.emit(name, ...values);
                 });
                 this._waitingEvents.delete(name);
             }
         }
     }
-    /** @inheritDoc */
     deactivate(name) {
         if (!isText(name)) {
-            throw new this.leyyo.developerError('Invalid event name', testCase(FQN, 132), where);
+            throw new this.leyyo.developerError("Invalid event name", testCase(FQN, 132), where);
         }
         if (this._waitingEvents.has(name)) {
-            this.leyyo.logger.warn(`Deactivated and cleared all messages. name: ${name}`, { where, eventName: name });
+            this.leyyo.logger.warn(`Deactivated and cleared all messages. name: ${name}`, {
+                where,
+                eventName: name,
+            });
             this._waitingEvents.delete(name);
         }
         if (this._removedEvents.has(name)) {
@@ -118,10 +109,9 @@ export class EventCommon {
         this._deactivatedEvents.add(name);
         return true;
     }
-    /** @inheritDoc */
     activate(name) {
         if (!isText(name)) {
-            throw new this.leyyo.developerError('Invalid event name', testCase(FQN, 133), where);
+            throw new this.leyyo.developerError("Invalid event name", testCase(FQN, 133), where);
         }
         if (this._deactivatedEvents.has(name)) {
             this._deactivatedEvents.delete(name);

package/dist/common/index.d.ts

@@ -1,11 +1,11 @@
-export * from './index.types.js';
-export * from './deploy.common.js';
-export * from './enum.pool.js';
-export * from './error.common.js';
-export * from './error.pool.js';
-export * from './event.common.js';
-export * from './inert.js';
-export * from './lifecycle.common.js';
-export * from './literal.pool.js';
-export * from './log.common.js';
-export * from './repo.common.js';
+export * from "./index.types.js";
+export * from "./deploy.common.js";
+export * from "./enum.pool.js";
+export * from "./error.common.js";
+export * from "./error.pool.js";
+export * from "./event.common.js";
+export * from "./inert.js";
+export * from "./lifecycle.common.js";
+export * from "./literal.pool.js";
+export * from "./log.common.js";
+export * from "./repo.common.js";

package/dist/common/index.js

@@ -1,11 +1,11 @@
-export * from './index.types.js';
-export * from './deploy.common.js';
-export * from './enum.pool.js';
-export * from './error.common.js';
-export * from './error.pool.js';
-export * from './event.common.js';
-export * from './inert.js';
-export * from './lifecycle.common.js';
-export * from './literal.pool.js';
-export * from './log.common.js';
-export * from './repo.common.js';
+export * from "./index.types.js";
+export * from "./deploy.common.js";
+export * from "./enum.pool.js";
+export * from "./error.common.js";
+export * from "./error.pool.js";
+export * from "./event.common.js";
+export * from "./inert.js";
+export * from "./lifecycle.common.js";
+export * from "./literal.pool.js";
+export * from "./log.common.js";
+export * from "./repo.common.js";