@geeko/log 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Metwas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above Copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR Copyright HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# Geeko Log

package/dist/global/provider.tokens.d.ts

@@ -0,0 +1,2 @@
+export declare const LOG_OPTIONS_PROVIDER: string;
+export declare const LOG_TEMPLATE_PROVIDER: string;

package/dist/global/provider.tokens.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOG_TEMPLATE_PROVIDER = exports.LOG_OPTIONS_PROVIDER = void 0;
+exports.LOG_OPTIONS_PROVIDER = "LOG_OPTIONS_PROVIDER";
+exports.LOG_TEMPLATE_PROVIDER = "LOG_TEMPLATE_PROVIDER";

package/dist/global/templates.d.ts

@@ -0,0 +1,7 @@
+import { Badge, Template } from "../types/LogOptions";
+export declare const appBadge: Badge;
+export declare const processBadge: Badge;
+export declare const timestampBadge: Badge;
+export declare const messageBadge: Badge;
+export declare const titleBadge: Badge;
+export declare const GeekoBadgeTemplate: Template;

package/dist/global/templates.js

@@ -0,0 +1,115 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeekoBadgeTemplate = exports.titleBadge = exports.messageBadge = exports.timestampBadge = exports.processBadge = exports.appBadge = void 0;
+const strings_1 = require("../tools/strings");
+const chalk = __importStar(require("chalk"));
+exports.appBadge = {
+    tag: "Geeko",
+    style: (text, options) => {
+        const level = options?.level;
+        text = ` ${text} `;
+        switch (level) {
+            case "error":
+                return chalk.bgRedBright.black.bold(text);
+            case "verbose":
+                return chalk.bgMagentaBright.black.bold(text);
+            case "warn":
+                return chalk.bgYellow.black.bold(text);
+            default:
+                return chalk.bgGreenBright.black.bold(text);
+        }
+        ;
+    }
+};
+exports.processBadge = {
+    tag: "process",
+    style: (text, options) => {
+        return chalk.blackBright(process.pid);
+    }
+};
+exports.timestampBadge = {
+    key: "timestamp",
+    style: (text, options) => {
+        return text;
+    }
+};
+exports.messageBadge = {
+    key: "message",
+    style: (text, options) => {
+        if (typeof text === "object") {
+            text = (0, strings_1.pretty)(text);
+        }
+        const level = options?.level;
+        switch (level) {
+            case "error":
+                return chalk.redBright(text);
+            case "verbose":
+                return chalk.magentaBright(text);
+            case "warn":
+                return chalk.yellow(text);
+            default:
+                return chalk.greenBright(text);
+        }
+        ;
+    }
+};
+exports.titleBadge = {
+    key: "title",
+    style: (text, options) => {
+        const level = options?.level;
+        text = ` ${text || options?.label || "-"} `;
+        switch (level) {
+            case "error":
+                return chalk.bgRedBright.black.bold(text);
+            case "verbose":
+                return chalk.bgMagentaBright.black.bold(text);
+            case "warn":
+                return chalk.bgYellow.black.bold(text);
+            default:
+                return chalk.bgGreenBright.black.bold(text);
+        }
+        ;
+    }
+};
+exports.GeekoBadgeTemplate = {
+    badges: [exports.appBadge, exports.processBadge, exports.timestampBadge, exports.titleBadge, exports.messageBadge],
+    gap: {
+        tag: " ",
+        style: (text, options) => {
+            return text;
+        }
+    }
+};

package/dist/main.d.ts

@@ -0,0 +1,4 @@
+export * from "./types/LogConstructorOptions";
+export * from "./services/LogService";
+export * from "./types/LogOptions";
+export * from "./tools/logger";

package/dist/main.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types/LogConstructorOptions"), exports);
+__exportStar(require("./services/LogService"), exports);
+__exportStar(require("./types/LogOptions"), exports);
+__exportStar(require("./tools/logger"), exports);

package/dist/services/LogService.d.ts

@@ -0,0 +1,23 @@
+import { LogConstructorOptions } from "../types/LogConstructorOptions";
+export declare const CLI_SHIFT_UP: string;
+export declare const CLI_CLEAR_LINE: string;
+export declare class LogService {
+    constructor(options?: LogConstructorOptions);
+    private _title;
+    private _level;
+    private _logger;
+    private _template;
+    private _spinner;
+    private _loading;
+    info(message: string): void;
+    warn(message: string): void;
+    verbose(message: string): void;
+    error(error: Error | string): void;
+    debug(message: string): void;
+    format(formatter: any): void;
+    getMetadata(): any;
+    setTitle(title: string): void;
+    branch(title: string, options?: LogConstructorOptions): LogService;
+    spinner(enabled?: boolean, marker?: string): void;
+    private _log;
+}

package/dist/services/LogService.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogService = exports.CLI_CLEAR_LINE = exports.CLI_SHIFT_UP = void 0;
+const logger_1 = require("../tools/logger");
+const ConsoleTransport_1 = require("../transports/ConsoleTransport");
+const nanospinner_1 = require("nanospinner");
+const winston_1 = require("winston");
+exports.CLI_SHIFT_UP = "\x1B[1A";
+exports.CLI_CLEAR_LINE = "\x1B[2K";
+class LogService {
+    constructor(options) {
+        this._logger = options?.logger ?? (0, winston_1.createLogger)({
+            level: options?.level ?? "info",
+            transports: [
+                new ConsoleTransport_1.SonicConsoleTransport()
+            ]
+        });
+        this._template = options?.template ?? logger_1.appBadgeTemplate;
+        this._title = options?.title ?? "App";
+        this._level = options?.level ?? "info";
+        this.format((0, logger_1.createDefaultLogger)(this._title));
+        if (options?.level !== "debug") {
+            process.removeAllListeners("warning");
+        }
+    }
+    _title = "App";
+    _level = "info";
+    _logger = void 0;
+    _template = void 0;
+    _spinner = void 0;
+    _loading = false;
+    info(message) {
+        this._log("info", message);
+    }
+    warn(message) {
+        this._log("warn", message);
+    }
+    verbose(message) {
+        this._log("verbose", message);
+    }
+    error(error) {
+        this._log("error", (error?.["message"] ? error["message"] : error));
+    }
+    debug(message) {
+        this._log("debug", message);
+    }
+    format(formatter) {
+        if (this._logger) {
+            this._logger.format = formatter;
+        }
+        this._spinner = (0, nanospinner_1.createSpinner)(void 0, {
+            color: this._template?.accent ?? "green"
+        });
+    }
+    getMetadata() {
+        return {
+            template: this._template
+        };
+    }
+    setTitle(title) {
+        if (typeof title === "string") {
+            this._title = title;
+            this.format((0, logger_1.createDefaultLogger)(this._title));
+        }
+    }
+    branch(title, options) {
+        const metadata = this.getMetadata();
+        const parentTemplate = metadata?.["template"] || logger_1.appBadgeTemplate;
+        const logger = (0, winston_1.createLogger)({
+            transports: this._logger.transports.slice(0)
+        });
+        const logService = new LogService({
+            level: options?.level ?? this._level,
+            template: parentTemplate,
+            logger: logger,
+            title: title
+        });
+        return logService;
+    }
+    spinner(enabled, marker) {
+        this._loading = enabled;
+        if (enabled) {
+            this._spinner.start({
+                text: " "
+            });
+        }
+        else {
+            this._spinner.success({
+                mark: marker ?? " ",
+                text: " "
+            });
+            process.stdout.write(exports.CLI_SHIFT_UP);
+            process.stdout.write(exports.CLI_CLEAR_LINE);
+        }
+    }
+    _log(method, message) {
+        this._logger[method](message, this.getMetadata());
+        if (this._loading) {
+            this._spinner.update({ text: message });
+            process.stdout.write(exports.CLI_SHIFT_UP);
+            process.stdout.write(exports.CLI_CLEAR_LINE);
+        }
+    }
+}
+exports.LogService = LogService;

package/dist/tools/logger.d.ts

@@ -0,0 +1,15 @@
+import { Badge, Template } from '../types/LogOptions';
+export declare let JSON_TAB_SIZE: number;
+export declare const createDefaultLogger: any;
+export declare function echo<T>(value: T): T;
+export declare const createTemplateString: any;
+export declare const createBadgeString: any;
+export declare const pretty: any;
+export declare const appBadge: Badge;
+export declare const processBadge: Badge;
+export declare const paddingBadge: Badge;
+export declare const timestampBadge: Badge;
+export declare const messageBadge: Badge;
+export declare const titleBadge: Badge;
+export declare const appBadgeTemplate: Template;
+export declare const textTemplate: Template;

package/dist/tools/logger.js

@@ -0,0 +1,155 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.textTemplate = exports.appBadgeTemplate = exports.titleBadge = exports.messageBadge = exports.timestampBadge = exports.paddingBadge = exports.processBadge = exports.appBadge = exports.pretty = exports.createBadgeString = exports.createTemplateString = exports.createDefaultLogger = exports.JSON_TAB_SIZE = void 0;
+exports.echo = echo;
+const winston_1 = require("winston");
+const chalk_1 = __importDefault(require("chalk"));
+const { combine, timestamp, label, printf } = winston_1.format;
+exports.JSON_TAB_SIZE = 4;
+const defaultFormatter = printf(({ level, message, label, timestamp }) => {
+    return `${timestamp} [${label}] ${level}: ${message}`;
+});
+const createDefaultLogger = (header) => {
+    return combine(label({ label: header }), timestamp(), defaultFormatter);
+};
+exports.createDefaultLogger = createDefaultLogger;
+function echo(value) {
+    return value;
+}
+;
+const createTemplateString = (template, artifacts) => {
+    const badges = template?.["badges"];
+    const length = Array.isArray(badges) ? badges.length : 0;
+    let index = 0;
+    let builder = "";
+    for (; index < length; index++) {
+        const badge = (0, exports.createBadgeString)(badges[index], artifacts);
+        if (typeof badge === "string") {
+            builder += badge;
+            builder += " ";
+        }
+    }
+    return builder;
+};
+exports.createTemplateString = createTemplateString;
+const createBadgeString = (badge, artifacts) => {
+    const styling = typeof badge["style"] === "function" ? badge["style"] : echo;
+    const tag = artifacts?.[badge["key"]] || badge["tag"] || "";
+    return styling(tag, artifacts);
+};
+exports.createBadgeString = createBadgeString;
+const pretty = (message) => {
+    return JSON.stringify(message, null, exports.JSON_TAB_SIZE);
+};
+exports.pretty = pretty;
+exports.appBadge = {
+    tag: "App",
+    style: (text, options) => {
+        const level = options?.level;
+        text = ` ${text} `;
+        switch (level) {
+            case "error":
+                return chalk_1.default.bgRedBright.black.bold(text);
+            case "verbose":
+            case "debug":
+                return chalk_1.default.bgGray.black.bold(text);
+            case "warn":
+                return chalk_1.default.bgYellow.black.bold(text);
+            default:
+                return chalk_1.default.bgGreenBright.black.bold(text);
+        }
+        ;
+    }
+};
+exports.processBadge = {
+    tag: "process",
+    style: (text, options) => {
+        return chalk_1.default.blackBright(process.pid);
+    }
+};
+exports.paddingBadge = {
+    tag: "",
+    style: (text, options) => {
+        const level = options?.level;
+        text = ` ${text} `;
+        switch (level) {
+            case "error":
+                return chalk_1.default.bgRedBright.black.bold(text);
+            case "verbose":
+            case "debug":
+                return chalk_1.default.bgGray.black.bold(text);
+            case "warn":
+                return chalk_1.default.bgYellow.black.bold(text);
+            default:
+                return chalk_1.default.bgGreenBright.black.bold(text);
+        }
+        ;
+    }
+};
+exports.timestampBadge = {
+    key: "timestamp",
+    style: (text, options) => {
+        return text;
+    }
+};
+exports.messageBadge = {
+    key: "message",
+    style: (text, options) => {
+        if (typeof text === "object") {
+            text = (0, exports.pretty)(text);
+        }
+        const level = options?.level;
+        switch (level) {
+            case "error":
+                return chalk_1.default.redBright(text);
+            case "verbose":
+            case "debug":
+                return chalk_1.default.gray.bold(text);
+            case "warn":
+                return chalk_1.default.yellow(text);
+            default:
+                return chalk_1.default.greenBright(text);
+        }
+        ;
+    }
+};
+exports.titleBadge = {
+    key: "title",
+    style: (text, options) => {
+        const level = options?.level;
+        text = ` ${text || options?.label || "-"} `;
+        switch (level) {
+            case "error":
+                return chalk_1.default.bgRedBright.black.bold(text);
+            case "verbose":
+            case "debug":
+                return chalk_1.default.bgMagentaBright.black.bold(text);
+            case "warn":
+                return chalk_1.default.bgYellow.black.bold(text);
+            default:
+                return chalk_1.default.bgGreenBright.black.bold(text);
+        }
+        ;
+    }
+};
+exports.appBadgeTemplate = {
+    badges: [exports.appBadge, exports.processBadge, exports.timestampBadge, exports.titleBadge, exports.messageBadge],
+    gap: {
+        tag: " ",
+        style: (text, options) => {
+            return text;
+        }
+    }
+};
+exports.textTemplate = {
+    badges: [exports.messageBadge],
+    gap: {
+        tag: " ",
+        style: (text, options) => {
+            return text;
+        }
+    }
+};

package/dist/tools/strings.d.ts

@@ -0,0 +1,2 @@
+export declare let JSON_TAB_SIZE: number;
+export declare const pretty: any;

package/dist/tools/strings.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pretty = exports.JSON_TAB_SIZE = void 0;
+exports.JSON_TAB_SIZE = 4;
+const pretty = (message) => {
+    return JSON.stringify(message, null, exports.JSON_TAB_SIZE);
+};
+exports.pretty = pretty;

package/dist/tools/template.d.ts

@@ -0,0 +1,3 @@
+export declare function echo<T>(value: T): T;
+export declare const createTemplateString: any;
+export declare const createBadgeString: any;

package/dist/tools/template.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBadgeString = exports.createTemplateString = void 0;
+exports.echo = echo;
+function echo(value) {
+    return value;
+}
+;
+const createTemplateString = (template, artifacts) => {
+    const badges = template?.["badges"];
+    const length = Array.isArray(badges) ? badges.length : 0;
+    let index = 0;
+    let builder = "";
+    for (; index < length; index++) {
+        const badge = (0, exports.createBadgeString)(badges[index], artifacts);
+        if (typeof badge === "string") {
+            builder += badge + " ";
+        }
+    }
+    return builder;
+};
+exports.createTemplateString = createTemplateString;
+const createBadgeString = (badge, artifacts) => {
+    const styling = typeof badge["style"] === "function" ? badge["style"] : echo;
+    const tag = artifacts?.[badge["key"]] || badge["tag"] || "";
+    return styling(tag, artifacts);
+};
+exports.createBadgeString = createBadgeString;

package/dist/transports/ConsoleTransport.d.ts

@@ -0,0 +1,7 @@
+import Transport from "winston-transport";
+import { SonicBoom } from "sonic-boom";
+export declare const sonic: SonicBoom;
+export declare class SonicConsoleTransport extends Transport {
+    constructor(options?: Transport.TransportStreamOptions);
+    log(information: any, callback?: Function): void;
+}

package/dist/transports/ConsoleTransport.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SonicConsoleTransport = exports.sonic = void 0;
+const logger_1 = require("../tools/logger");
+const winston_transport_1 = __importDefault(require("winston-transport"));
+const sonic_boom_1 = require("sonic-boom");
+const node_os_1 = require("node:os");
+exports.sonic = new sonic_boom_1.SonicBoom({
+    fd: process.stdout.fd,
+    sync: true
+});
+class SonicConsoleTransport extends winston_transport_1.default {
+    constructor(options) {
+        super(options);
+    }
+    log(information, callback) {
+        const template = information?.["template"];
+        exports.sonic.write((template ? (0, logger_1.createTemplateString)(template, information) : information) + node_os_1.EOL);
+        if (typeof callback === "function") {
+            callback();
+        }
+    }
+}
+exports.SonicConsoleTransport = SonicConsoleTransport;

package/dist/types/LogConstructorOptions.d.ts

@@ -0,0 +1,6 @@
+import { LogOptions } from "./LogOptions";
+import { Logger } from "winston";
+export type LogConstructorOptions = {
+    title?: string;
+    logger?: Logger;
+} & LogOptions;

package/dist/types/LogConstructorOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/LogOptions.d.ts

@@ -0,0 +1,22 @@
+export type Style = (text: string, options?: LogOptions) => string;
+export type LogLevel = "info" | "warn" | "error" | "debug" | "verbose";
+export type LogOptions = {
+    level: LogLevel;
+    label?: string;
+    template?: Template;
+};
+export type LogOutput = {
+    marker?: string;
+    load?: boolean;
+};
+export type Badge = {
+    style: Style;
+    tag?: string;
+    key?: string;
+};
+export type Template = {
+    accent?: string;
+    artifacts?: any;
+    badges: Array<Badge>;
+    gap: Badge;
+};

package/dist/types/LogOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,35 @@
+{
+       "name": "@geeko/log",
+       "version": "1.0.0",
+       "description": "",
+       "main": "./dist/main.js",
+       "directories": {
+              "test": "test"
+       },
+       "scripts": {
+              "build": "rm -rf ./dist/ && tsc -p ./tsconfig.json",
+              "pub": "npm run build && npm publish --access=public",
+              "test": "echo \"Error: no test specified\" && exit 1"
+       },
+       "repository": {
+              "type": "git",
+              "url": "git+https://github.com/Metwas/geeko-log.git"
+       },
+       "author": "Metwas",
+       "license": "MIT",
+       "bugs": {
+              "url": "https://github.com/Metwas/geeko-log/issues"
+       },
+       "homepage": "https://github.com/Metwas/geeko-log#readme",
+       "dependencies": {
+              "chalk": "4.1.2",
+              "chalk-animation": "^2.0.3",
+              "nanospinner": "^1.2.2",
+              "sonic-boom": "^4.2.0",
+              "winston": "^3.17.0"
+       },
+       "devDependencies": {
+              "@types/node": "^20.19.9",
+              "typescript": "^5.8.3"
+       }
+}