@odg/json-log 0.0.1 → 1.0.0

package/dist/lib/JSONLoggerPlugin.d.ts

@@ -1,113 +0,0 @@
-import { type LogLevel, type LoggerParserInterface, type LoggerPluginInterface } from "@odg/log";
-import { type ResponseInterface, type RequestInterface } from "@odg/message";
-import { type LoggerObjectRequestInterface, type ExceptionObjectLoggerInterface, type LoggerObjectInterface } from "../Interfaces";
-export declare class JSONLoggerPlugin implements LoggerPluginInterface {
-    protected readonly appName: string;
-    protected readonly instanceId?: string | undefined;
-    protected readonly maxExceptionPreview: number;
-    /**
-     * Identifier for the current log
-     *
-     * @type {string}
-     */
-    protected identifier?: string;
-    constructor(appName: string, instanceId?: string | undefined, maxExceptionPreview?: number);
-    /**
-     * Plugin parser Function return new message with JSON format
-     *
-     * @param {LoggerParserInterface} data Received Data params
-     * @returns {Promise<LoggerParserInterface>}
-     */
-    parser(data: LoggerParserInterface): Promise<LoggerParserInterface>;
-    logJSON(level: LogLevel, message: unknown): Promise<LoggerObjectInterface>;
-    /**
-     * Define a unique identifier for the current request, for
-     * Example: Request ID, Transaction ID, Crawler Process, etc
-     *
-     * @param {string} identifier Unique identifier
-     * @memberof JSONLoggerPlugin
-     */
-    setIdentifier(identifier: string): void;
-    /**
-     * Return instance HostName, identifier
-     *
-     * @returns {string}
-     */
-    protected getInstance(): string;
-    /**
-     * Return git tag name
-     *
-     * @returns {Promise<string>}
-     */
-    protected getGitRelease(): Promise<string>;
-    /**
-     * Return git tag name
-     *
-     * @returns {Promise<string>}
-     */
-    protected getGitBranch(): Promise<string>;
-    /**
-     * If Message is a Exception, parse to ExceptionObjectLoggerInterface
-     *
-     * @param {unknown} exception Possible Exception
-     * @returns {Promise<ExceptionObjectLoggerInterface | undefined>}
-     */
-    protected parseException(exception: unknown): Promise<ExceptionObjectLoggerInterface | undefined>;
-    /**
-     * If Message is a Exception, get All Exception Preview and parse to ExceptionObjectLoggerInterface
-     *
-     * @param {unknown} exception Possible Exception
-     * @returns {Promise<ExceptionObjectLoggerInterface | undefined>}
-     */
-    protected parseExceptionPreview(exception: unknown): Promise<ExceptionObjectLoggerInterface[] | undefined>;
-    /**
-     * Parser Request and Response
-     *
-     * @protected
-     * @param {unknown} message Possible Message/Request
-     * @returns {Promise<LoggerObjectRequestInterface | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    protected parseRequest(message: unknown): Promise<LoggerObjectRequestInterface | undefined>;
-    /**
-     * Get Response
-     *
-     * @protected
-     * @param {unknown} message Possible Request/Message
-     * @returns {Promise<ResponseInterface<unknown, unknown> | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    protected getResponseMessage(message: unknown): Promise<ResponseInterface<unknown, unknown> | undefined>;
-    /**
-     * Get Request
-     *
-     * @protected
-     * @param {unknown} message Possible Request/Message
-     * @returns {Promise<ResponseInterface<unknown, unknown> | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    protected getRequestMessage(message: unknown): Promise<RequestInterface<unknown> | undefined>;
-    /**
-     * Check Is Message Response or Request or Exception Message
-     *
-     * @protected
-     * @param {unknown} message Possible Message/Request
-     * @returns {Promise<boolean>}
-     * @memberof JSONLoggerPlugin
-     */
-    protected isRequestOrResponseMessage(message: unknown): Promise<boolean>;
-    /**
-     * Check is Response Message
-     *
-     * @param {unknown} message Possible Response/Message
-     * @returns {boolean}
-     */
-    protected isResponseMessage(message: unknown): message is ResponseInterface<unknown, unknown>;
-    /**
-     * Check is Request Message
-     *
-     * @param {unknown} message Possible Request/Message
-     * @returns {boolean}
-     */
-    protected isRequestMessage(message: unknown): message is RequestInterface<unknown>;
-}

package/dist/lib/JSONLoggerPlugin.js

@@ -1,215 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.JSONLoggerPlugin = void 0;
-const node_child_process_1 = require("node:child_process");
-const node_util_1 = require("node:util");
-const exception_1 = require("@odg/exception");
-const message_1 = require("@odg/message");
-const error_stack_parser_1 = __importDefault(require("error-stack-parser"));
-class JSONLoggerPlugin {
-    constructor(appName, instanceId, maxExceptionPreview = 10) {
-        this.appName = appName;
-        this.instanceId = instanceId;
-        this.maxExceptionPreview = maxExceptionPreview;
-    }
-    /**
-     * Plugin parser Function return new message with JSON format
-     *
-     * @param {LoggerParserInterface} data Received Data params
-     * @returns {Promise<LoggerParserInterface>}
-     */
-    async parser(data) {
-        return {
-            ...data,
-            message: await this.logJSON(data.level, data.message),
-        };
-    }
-    async logJSON(level, message) {
-        return {
-            "type": level,
-            "index": this.appName,
-            "instance": this.getInstance(),
-            "identifier": this.identifier,
-            "gitRelease": await this.getGitRelease().catch(() => void 0),
-            "gitBranch": await this.getGitBranch().catch(() => void 0),
-            "exception": await this.parseException(message),
-            "exceptionPreview": await this.parseExceptionPreview(message),
-            "request": await this.parseRequest(message),
-            "createdAt": new Date(),
-        };
-    }
-    /**
-     * Define a unique identifier for the current request, for
-     * Example: Request ID, Transaction ID, Crawler Process, etc
-     *
-     * @param {string} identifier Unique identifier
-     * @memberof JSONLoggerPlugin
-     */
-    setIdentifier(identifier) {
-        this.identifier = identifier;
-    }
-    /**
-     * Return instance HostName, identifier
-     *
-     * @returns {string}
-     */
-    getInstance() {
-        return this.instanceId
-            || process.env.HOSTNAME
-            || process.env.CONTAINER_ID
-            || "unknown";
-    }
-    /**
-     * Return git tag name
-     *
-     * @returns {Promise<string>}
-     */
-    async getGitRelease() {
-        const command = (0, node_util_1.promisify)(node_child_process_1.exec);
-        const gitVersion = await command("git describe --tags --abbrev=41");
-        return gitVersion.stdout.trim();
-    }
-    /**
-     * Return git tag name
-     *
-     * @returns {Promise<string>}
-     */
-    async getGitBranch() {
-        const command = (0, node_util_1.promisify)(node_child_process_1.exec);
-        const gitVersion = await command("git rev-parse --abbrev-ref HEAD");
-        return gitVersion.stdout.trim();
-    }
-    /**
-     * If Message is a Exception, parse to ExceptionObjectLoggerInterface
-     *
-     * @param {unknown} exception Possible Exception
-     * @returns {Promise<ExceptionObjectLoggerInterface | undefined>}
-     */
-    async parseException(exception) {
-        var _a, _b, _c, _d;
-        if (!(exception instanceof Error))
-            return;
-        const trace = exception.stack ? error_stack_parser_1.default.parse(exception) : undefined;
-        return {
-            "type": exception.name,
-            "message": exception.message,
-            "fileException": (_a = trace === null || trace === void 0 ? void 0 : trace[0]) === null || _a === void 0 ? void 0 : _a.getFileName(),
-            "functionName": (_b = trace === null || trace === void 0 ? void 0 : trace[0]) === null || _b === void 0 ? void 0 : _b.getFunctionName(),
-            "fileLine": (_c = trace === null || trace === void 0 ? void 0 : trace[0]) === null || _c === void 0 ? void 0 : _c.getLineNumber(),
-            "fileColumn": (_d = trace === null || trace === void 0 ? void 0 : trace[0]) === null || _d === void 0 ? void 0 : _d.getColumnNumber(),
-            "tracker": exception.stack,
-        };
-    }
-    /**
-     * If Message is a Exception, get All Exception Preview and parse to ExceptionObjectLoggerInterface
-     *
-     * @param {unknown} exception Possible Exception
-     * @returns {Promise<ExceptionObjectLoggerInterface | undefined>}
-     */
-    async parseExceptionPreview(exception) {
-        if (!(exception instanceof exception_1.Exception))
-            return;
-        const exceptionCollection = [];
-        let exceptionBase = exception.preview;
-        let exceptionCount = 0;
-        do {
-            const parsedException = await this.parseException(exceptionBase);
-            if (parsedException)
-                exceptionCollection.push(parsedException);
-            exceptionBase = exceptionBase === null || exceptionBase === void 0 ? void 0 : exceptionBase.preview;
-        } while (exceptionBase && ++exceptionCount < this.maxExceptionPreview);
-        return exceptionCollection;
-    }
-    /**
-     * Parser Request and Response
-     *
-     * @protected
-     * @param {unknown} message Possible Message/Request
-     * @returns {Promise<LoggerObjectRequestInterface | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    async parseRequest(message) {
-        if (!await this.isRequestOrResponseMessage(message))
-            return;
-        const request = await this.getRequestMessage(message);
-        const response = await this.getResponseMessage(message);
-        return {
-            ...request,
-            response: response && {
-                ...Object.fromEntries(Object.entries(response).filter(([key]) => key !== "request")),
-            },
-        };
-    }
-    /**
-     * Get Response
-     *
-     * @protected
-     * @param {unknown} message Possible Request/Message
-     * @returns {Promise<ResponseInterface<unknown, unknown> | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    async getResponseMessage(message) {
-        if (message instanceof message_1.MessageException)
-            return message.response;
-        if (this.isResponseMessage(message))
-            return message;
-        return undefined;
-    }
-    /**
-     * Get Request
-     *
-     * @protected
-     * @param {unknown} message Possible Request/Message
-     * @returns {Promise<ResponseInterface<unknown, unknown> | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    async getRequestMessage(message) {
-        if (message instanceof message_1.MessageException)
-            return message.request;
-        if (this.isRequestMessage(message))
-            return message;
-        if (this.isResponseMessage(message))
-            return message.request;
-        return undefined;
-    }
-    /**
-     * Check Is Message Response or Request or Exception Message
-     *
-     * @protected
-     * @param {unknown} message Possible Message/Request
-     * @returns {Promise<boolean>}
-     * @memberof JSONLoggerPlugin
-     */
-    async isRequestOrResponseMessage(message) {
-        return message instanceof message_1.MessageException
-            || this.isResponseMessage(message)
-            || this.isRequestMessage(message);
-    }
-    /**
-     * Check is Response Message
-     *
-     * @param {unknown} message Possible Response/Message
-     * @returns {boolean}
-     */
-    isResponseMessage(message) {
-        return Object.prototype.hasOwnProperty.call(message, "data")
-            && Object.prototype.hasOwnProperty.call(message, "status")
-            && Object.prototype.hasOwnProperty.call(message, "headers")
-            && Object.prototype.hasOwnProperty.call(message, "request");
-    }
-    /**
-     * Check is Request Message
-     *
-     * @param {unknown} message Possible Request/Message
-     * @returns {boolean}
-     */
-    isRequestMessage(message) {
-        return Object.prototype.hasOwnProperty.call(message, "url")
-            && Object.prototype.hasOwnProperty.call(message, "method");
-    }
-}
-exports.JSONLoggerPlugin = JSONLoggerPlugin;
-//# sourceMappingURL=JSONLoggerPlugin.js.map

package/dist/lib/JSONLoggerPlugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"JSONLoggerPlugin.js","sourceRoot":"","sources":["../../src/lib/JSONLoggerPlugin.ts"],"names":[],"mappings":";;;;;;AAAA,2DAA0C;AAC1C,yCAAsC;AAEtC,8CAA2C;AAM3C,0CAA+F;AAC/F,4EAAkD;AAQlD,MAAa,gBAAgB;IASzB,YACuB,OAAe,EACf,UAAmB,EACnB,sBAA8B,EAAE;QAFhC,YAAO,GAAP,OAAO,CAAQ;QACf,eAAU,GAAV,UAAU,CAAS;QACnB,wBAAmB,GAAnB,mBAAmB,CAAa;IACnD,CAAC;IAEL;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,IAA2B;QAC3C,OAAO;YACH,GAAG,IAAI;YACP,OAAO,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;SACxD,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,KAAe,EAAE,OAAgB;QAClD,OAAO;YACH,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE;YAC9B,YAAY,EAAE,IAAI,CAAC,UAAU;YAC7B,YAAY,EAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;YAC5D,WAAW,EAAE,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;YAC1D,WAAW,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;YAC/C,kBAAkB,EAAE,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC;YAC7D,SAAS,EAAE,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC;YAC3C,WAAW,EAAE,IAAI,IAAI,EAAE;SAC1B,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,UAAkB;QACnC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACO,WAAW;QACjB,OAAO,IAAI,CAAC,UAAW;eAChB,OAAO,CAAC,GAAG,CAAC,QAAS;eACrB,OAAO,CAAC,GAAG,CAAC,YAAa;eACzB,SAAS,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,aAAa;QACzB,MAAM,OAAO,GAAG,IAAA,qBAAS,EAAC,yBAAI,CAAC,CAAC;QAChC,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,iCAAiC,CAAC,CAAC;QAEpE,OAAO,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,YAAY;QACxB,MAAM,OAAO,GAAG,IAAA,qBAAS,EAAC,yBAAI,CAAC,CAAC;QAChC,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,iCAAiC,CAAC,CAAC;QAEpE,OAAO,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,cAAc,CAAC,SAAkB;;QAC7C,IAAI,CAAC,CAAC,SAAS,YAAY,KAAK,CAAC;YAAE,OAAO;QAC1C,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,4BAAgB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAE9E,OAAO;YACH,MAAM,EAAE,SAAS,CAAC,IAAI;YACtB,SAAS,EAAE,SAAS,CAAC,OAAO;YAC5B,eAAe,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAG,CAAC,CAAC,0CAAE,WAAW,EAAE;YAC1C,cAAc,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAG,CAAC,CAAC,0CAAE,eAAe,EAAE;YAC7C,UAAU,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAG,CAAC,CAAC,0CAAE,aAAa,EAAE;YACvC,YAAY,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAG,CAAC,CAAC,0CAAE,eAAe,EAAE;YAC3C,SAAS,EAAE,SAAS,CAAC,KAAK;SAC7B,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,qBAAqB,CAAC,SAAkB;QACpD,IAAI,CAAC,CAAC,SAAS,YAAY,qBAAS,CAAC;YAAE,OAAO;QAE9C,MAAM,mBAAmB,GAAqC,EAAE,CAAC;QACjE,IAAI,aAAa,GAAG,SAAS,CAAC,OAAO,CAAC;QACtC,IAAI,cAAc,GAAG,CAAC,CAAC;QAEvB,GAAG;YACC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;YACjE,IAAI,eAAe;gBAAE,mBAAmB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAC/D,aAAa,GAAG,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,CAAC;SAC1C,QAAQ,aAAa,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC,mBAAmB,EAAE;QAEvE,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,YAAY,CAAC,OAAgB;QACzC,IAAI,CAAC,MAAM,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC;YAAE,OAAO;QAC5D,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAExD,OAAO;YACH,GAAG,OAAO;YACV,QAAQ,EAAE,QAAQ,IAAI;gBAClB,GAAI,MAAM,CAAC,WAAW,CAClB,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,GAAG,CAAE,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,CAAC,CACT;aAC7D;SACJ,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,kBAAkB,CAAC,OAAgB;QAC/C,IAAI,OAAO,YAAY,0BAAgB;YAAE,OAAO,OAAO,CAAC,QAAQ,CAAC;QACjE,IAAI,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC;YAAE,OAAO,OAAO,CAAC;QAEpD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,iBAAiB,CAAC,OAAgB;QAC9C,IAAI,OAAO,YAAY,0BAAgB;YAAE,OAAO,OAAO,CAAC,OAAO,CAAC;QAChE,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC;YAAE,OAAO,OAAO,CAAC;QACnD,IAAI,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC;YAAE,OAAO,OAAO,CAAC,OAAO,CAAC;QAE5D,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,0BAA0B,CAAC,OAAgB;QACvD,OAAO,OAAO,YAAY,0BAAgB;eACnC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC;eAC/B,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACO,iBAAiB,CAAC,OAAgB;QACxC,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC;eACrD,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC;eACvD,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC;eACxD,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACO,gBAAgB,CAAC,OAAgB;QACvC,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC;eACpD,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACnE,CAAC;CAEJ;AAjOD,4CAiOC"}

package/dist/lib/ParserException.d.ts

@@ -1,3 +0,0 @@
-import { Exception } from "@odg/exception";
-export declare class ExceptionPluginLogger extends Exception {
-}

package/dist/lib/ParserException.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExceptionPluginLogger = void 0;
-const exception_1 = require("@odg/exception");
-class ExceptionPluginLogger extends exception_1.Exception {
-}
-exports.ExceptionPluginLogger = ExceptionPluginLogger;
-//# sourceMappingURL=ParserException.js.map

package/dist/lib/ParserException.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ParserException.js","sourceRoot":"","sources":["../../src/lib/ParserException.ts"],"names":[],"mappings":";;;AAAA,8CAA2C;AAE3C,MAAa,qBAAsB,SAAQ,qBAAS;CAEnD;AAFD,sDAEC"}

package/dist/logs/JSONLoggerPlugin.d.ts

@@ -1,113 +0,0 @@
-import { type LogLevel, type LoggerParserInterface, type LoggerPluginInterface } from "@odg/log";
-import { type ResponseInterface, type RequestInterface } from "@odg/message";
-import { type LoggerObjectRequestInterface, type ExceptionObjectLoggerInterface, type LoggerObjectInterface } from "../Interfaces";
-export declare class JSONLoggerPlugin implements LoggerPluginInterface {
-    protected readonly appName: string;
-    protected readonly instanceId?: string | undefined;
-    protected readonly maxExceptionPreview: number;
-    /**
-     * Identifier for the current log
-     *
-     * @type {string}
-     */
-    protected identifier?: string;
-    constructor(appName: string, instanceId?: string | undefined, maxExceptionPreview?: number);
-    /**
-     * Plugin parser Function return new message with JSON format
-     *
-     * @param {LoggerParserInterface} data Received Data params
-     * @returns {Promise<LoggerParserInterface>}
-     */
-    parser(data: LoggerParserInterface): Promise<LoggerParserInterface>;
-    logJSON(level: LogLevel, message: unknown): Promise<LoggerObjectInterface>;
-    /**
-     * Define a unique identifier for the current request, for
-     * Example: Request ID, Transaction ID, Crawler Process, etc
-     *
-     * @param {string} identifier Unique identifier
-     * @memberof JSONLoggerPlugin
-     */
-    setIdentifier(identifier: string): void;
-    /**
-     * Return instance HostName, identifier
-     *
-     * @returns {string}
-     */
-    protected getInstance(): string;
-    /**
-     * Return git tag name
-     *
-     * @returns {Promise<string>}
-     */
-    protected getGitRelease(): Promise<string>;
-    /**
-     * Return git tag name
-     *
-     * @returns {Promise<string>}
-     */
-    protected getGitBranch(): Promise<string>;
-    /**
-     * If Message is a Exception, parse to ExceptionObjectLoggerInterface
-     *
-     * @param {unknown} exception Possible Exception
-     * @returns {Promise<ExceptionObjectLoggerInterface | undefined>}
-     */
-    protected parseException(exception: unknown): Promise<ExceptionObjectLoggerInterface | undefined>;
-    /**
-     * If Message is a Exception, get All Exception Preview and parse to ExceptionObjectLoggerInterface
-     *
-     * @param {unknown} exception Possible Exception
-     * @returns {Promise<ExceptionObjectLoggerInterface | undefined>}
-     */
-    protected parseExceptionPreview(exception: unknown): Promise<ExceptionObjectLoggerInterface[] | undefined>;
-    /**
-     * Parser Request and Response
-     *
-     * @protected
-     * @param {unknown} message Possible Message/Request
-     * @returns {Promise<LoggerObjectRequestInterface | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    protected parseRequest(message: unknown): Promise<LoggerObjectRequestInterface | undefined>;
-    /**
-     * Get Response
-     *
-     * @protected
-     * @param {unknown} message Possible Request/Message
-     * @returns {Promise<ResponseInterface<unknown, unknown> | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    protected getResponseMessage(message: unknown): Promise<ResponseInterface<unknown, unknown> | undefined>;
-    /**
-     * Get Request
-     *
-     * @protected
-     * @param {unknown} message Possible Request/Message
-     * @returns {Promise<ResponseInterface<unknown, unknown> | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    protected getRequestMessage(message: unknown): Promise<RequestInterface<unknown> | undefined>;
-    /**
-     * Check Is Message Response or Request or Exception Message
-     *
-     * @protected
-     * @param {unknown} message Possible Message/Request
-     * @returns {Promise<boolean>}
-     * @memberof JSONLoggerPlugin
-     */
-    protected isRequestOrResponseMessage(message: unknown): Promise<boolean>;
-    /**
-     * Check is Response Message
-     *
-     * @param {unknown} message Possible Response/Message
-     * @returns {boolean}
-     */
-    protected isResponseMessage(message: unknown): message is ResponseInterface<unknown, unknown>;
-    /**
-     * Check is Request Message
-     *
-     * @param {unknown} message Possible Request/Message
-     * @returns {boolean}
-     */
-    protected isRequestMessage(message: unknown): message is RequestInterface<unknown>;
-}

package/dist/logs/JSONLoggerPlugin.js

@@ -1,215 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.JSONLoggerPlugin = void 0;
-const node_child_process_1 = require("node:child_process");
-const node_util_1 = require("node:util");
-const exception_1 = require("@odg/exception");
-const message_1 = require("@odg/message");
-const error_stack_parser_1 = __importDefault(require("error-stack-parser"));
-class JSONLoggerPlugin {
-    constructor(appName, instanceId, maxExceptionPreview = 10) {
-        this.appName = appName;
-        this.instanceId = instanceId;
-        this.maxExceptionPreview = maxExceptionPreview;
-    }
-    /**
-     * Plugin parser Function return new message with JSON format
-     *
-     * @param {LoggerParserInterface} data Received Data params
-     * @returns {Promise<LoggerParserInterface>}
-     */
-    async parser(data) {
-        return {
-            ...data,
-            message: await this.logJSON(data.level, data.message),
-        };
-    }
-    async logJSON(level, message) {
-        return {
-            "type": level,
-            "index": this.appName,
-            "instance": this.getInstance(),
-            "identifier": this.identifier,
-            "gitRelease": await this.getGitRelease().catch(() => void 0),
-            "gitBranch": await this.getGitBranch().catch(() => void 0),
-            "exception": await this.parseException(message),
-            "exceptionPreview": await this.parseExceptionPreview(message),
-            "request": await this.parseRequest(message),
-            "createdAt": new Date(),
-        };
-    }
-    /**
-     * Define a unique identifier for the current request, for
-     * Example: Request ID, Transaction ID, Crawler Process, etc
-     *
-     * @param {string} identifier Unique identifier
-     * @memberof JSONLoggerPlugin
-     */
-    setIdentifier(identifier) {
-        this.identifier = identifier;
-    }
-    /**
-     * Return instance HostName, identifier
-     *
-     * @returns {string}
-     */
-    getInstance() {
-        return this.instanceId
-            || process.env.HOSTNAME
-            || process.env.CONTAINER_ID
-            || "unknown";
-    }
-    /**
-     * Return git tag name
-     *
-     * @returns {Promise<string>}
-     */
-    async getGitRelease() {
-        const command = (0, node_util_1.promisify)(node_child_process_1.exec);
-        const gitVersion = await command("git describe --tags --abbrev=41");
-        return gitVersion.stdout.trim();
-    }
-    /**
-     * Return git tag name
-     *
-     * @returns {Promise<string>}
-     */
-    async getGitBranch() {
-        const command = (0, node_util_1.promisify)(node_child_process_1.exec);
-        const gitVersion = await command("git rev-parse --abbrev-ref HEAD");
-        return gitVersion.stdout.trim();
-    }
-    /**
-     * If Message is a Exception, parse to ExceptionObjectLoggerInterface
-     *
-     * @param {unknown} exception Possible Exception
-     * @returns {Promise<ExceptionObjectLoggerInterface | undefined>}
-     */
-    async parseException(exception) {
-        var _a, _b, _c, _d;
-        if (!(exception instanceof Error))
-            return;
-        const trace = exception.stack ? error_stack_parser_1.default.parse(exception) : undefined;
-        return {
-            "type": exception.name,
-            "message": exception.message,
-            "fileException": (_a = trace === null || trace === void 0 ? void 0 : trace[0]) === null || _a === void 0 ? void 0 : _a.getFileName(),
-            "functionName": (_b = trace === null || trace === void 0 ? void 0 : trace[0]) === null || _b === void 0 ? void 0 : _b.getFunctionName(),
-            "fileLine": (_c = trace === null || trace === void 0 ? void 0 : trace[0]) === null || _c === void 0 ? void 0 : _c.getLineNumber(),
-            "fileColumn": (_d = trace === null || trace === void 0 ? void 0 : trace[0]) === null || _d === void 0 ? void 0 : _d.getColumnNumber(),
-            "tracker": exception.stack,
-        };
-    }
-    /**
-     * If Message is a Exception, get All Exception Preview and parse to ExceptionObjectLoggerInterface
-     *
-     * @param {unknown} exception Possible Exception
-     * @returns {Promise<ExceptionObjectLoggerInterface | undefined>}
-     */
-    async parseExceptionPreview(exception) {
-        if (!(exception instanceof exception_1.Exception))
-            return;
-        const exceptionCollection = [];
-        let exceptionBase = exception.preview;
-        let exceptionCount = 0;
-        do {
-            const parsedException = await this.parseException(exceptionBase);
-            if (parsedException)
-                exceptionCollection.push(parsedException);
-            exceptionBase = exceptionBase === null || exceptionBase === void 0 ? void 0 : exceptionBase.preview;
-        } while (exceptionBase && ++exceptionCount < this.maxExceptionPreview);
-        return exceptionCollection;
-    }
-    /**
-     * Parser Request and Response
-     *
-     * @protected
-     * @param {unknown} message Possible Message/Request
-     * @returns {Promise<LoggerObjectRequestInterface | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    async parseRequest(message) {
-        if (!await this.isRequestOrResponseMessage(message))
-            return;
-        const request = await this.getRequestMessage(message);
-        const response = await this.getResponseMessage(message);
-        return {
-            ...request,
-            response: response && {
-                ...Object.fromEntries(Object.entries(response).filter(([key]) => key !== "request")),
-            },
-        };
-    }
-    /**
-     * Get Response
-     *
-     * @protected
-     * @param {unknown} message Possible Request/Message
-     * @returns {Promise<ResponseInterface<unknown, unknown> | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    async getResponseMessage(message) {
-        if (message instanceof message_1.MessageException)
-            return message.response;
-        if (this.isResponseMessage(message))
-            return message;
-        return undefined;
-    }
-    /**
-     * Get Request
-     *
-     * @protected
-     * @param {unknown} message Possible Request/Message
-     * @returns {Promise<ResponseInterface<unknown, unknown> | undefined>}
-     * @memberof JSONLoggerPlugin
-     */
-    async getRequestMessage(message) {
-        if (message instanceof message_1.MessageException)
-            return message.request;
-        if (this.isRequestMessage(message))
-            return message;
-        if (this.isResponseMessage(message))
-            return message.request;
-        return undefined;
-    }
-    /**
-     * Check Is Message Response or Request or Exception Message
-     *
-     * @protected
-     * @param {unknown} message Possible Message/Request
-     * @returns {Promise<boolean>}
-     * @memberof JSONLoggerPlugin
-     */
-    async isRequestOrResponseMessage(message) {
-        return message instanceof message_1.MessageException
-            || this.isResponseMessage(message)
-            || this.isRequestMessage(message);
-    }
-    /**
-     * Check is Response Message
-     *
-     * @param {unknown} message Possible Response/Message
-     * @returns {boolean}
-     */
-    isResponseMessage(message) {
-        return Object.prototype.hasOwnProperty.call(message, "data")
-            && Object.prototype.hasOwnProperty.call(message, "status")
-            && Object.prototype.hasOwnProperty.call(message, "headers")
-            && Object.prototype.hasOwnProperty.call(message, "request");
-    }
-    /**
-     * Check is Request Message
-     *
-     * @param {unknown} message Possible Request/Message
-     * @returns {boolean}
-     */
-    isRequestMessage(message) {
-        return Object.prototype.hasOwnProperty.call(message, "url")
-            && Object.prototype.hasOwnProperty.call(message, "method");
-    }
-}
-exports.JSONLoggerPlugin = JSONLoggerPlugin;
-//# sourceMappingURL=JSONLoggerPlugin.js.map