itivrutaha 3.2.1 → 3.2.2

package/dist/config.d.ts

@@ -0,0 +1,61 @@
+import { type ChalkInstance } from 'chalk';
+export interface Scope<ScopeName> {
+    name: ScopeName;
+    color: ChalkInstance;
+}
+export interface LogType<Name> {
+    name: Name;
+    emoji: string;
+    color: ChalkInstance;
+}
+export interface UnifiedData<ScopeName> {
+    scope?: ScopeName;
+    msg: string | Error;
+    [key: string]: any;
+}
+export interface Config<ScopeName, LogTypeName> {
+    theme: string;
+    timeFormat: string;
+    scopes: Scope<ScopeName>[];
+    types: LogType<LogTypeName>[];
+    typeFilterFn: () => string[];
+}
+export declare function makeConfig<const T extends Config<string, string>>(config: T): T;
+export declare const defaultConfig: {
+    readonly timeFormat: "hh:mm:ss dd-MM-yyyy";
+    readonly theme: `:time ${string} :scope :emoji :type :msg :data`;
+    readonly typeFilterFn: () => string[];
+    readonly scopes: [{
+        readonly name: "app";
+        readonly color: ChalkInstance;
+    }];
+    readonly types: [{
+        readonly emoji: "✅";
+        readonly name: "success";
+        readonly color: ChalkInstance;
+    }, {
+        readonly emoji: "ℹ️";
+        readonly name: "info";
+        readonly color: ChalkInstance;
+    }, {
+        readonly emoji: "👍";
+        readonly name: "okay";
+        readonly color: ChalkInstance;
+    }, {
+        readonly emoji: "✍️";
+        readonly name: "note";
+        readonly color: ChalkInstance;
+    }, {
+        readonly emoji: "🧐";
+        readonly name: "verbose";
+        readonly color: ChalkInstance;
+    }, {
+        readonly emoji: "⚠️";
+        readonly name: "warning";
+        readonly color: ChalkInstance;
+    }, {
+        readonly emoji: "🚨";
+        readonly name: "error";
+        readonly color: ChalkInstance;
+    }];
+};

package/dist/config.js

@@ -0,0 +1,61 @@
+/*
+ *  Contains configuration related code.
+ *  Created On 15 January 2024
+ */
+import chalk, {} from 'chalk';
+export function makeConfig(config) {
+    return config;
+}
+export const defaultConfig = makeConfig({
+    timeFormat: 'hh:mm:ss dd-MM-yyyy',
+    theme: `:time ${chalk.gray.dim('•')} :scope :emoji :type :msg :data`,
+    typeFilterFn: () => {
+        const environment = process.env['ITIVRUTAHA_LOG_FILTER'] || process.env['itivrutaha_log_filter'];
+        if (!environment)
+            return ['success', 'info', 'okay', 'note', 'verbose', 'warning', 'error'];
+        return environment.trim().toLowerCase().split(',');
+    },
+    scopes: [
+        {
+            name: 'app',
+            color: chalk.redBright
+        }
+    ],
+    types: [
+        {
+            emoji: '✅',
+            name: 'success',
+            color: chalk.greenBright,
+        },
+        {
+            emoji: 'ℹ️',
+            name: 'info',
+            color: chalk.blueBright,
+        },
+        {
+            emoji: '👍',
+            name: 'okay',
+            color: chalk.gray,
+        },
+        {
+            emoji: '✍️',
+            name: 'note',
+            color: chalk.magentaBright,
+        },
+        {
+            emoji: '🧐',
+            name: 'verbose',
+            color: chalk.cyanBright,
+        },
+        {
+            emoji: '⚠️',
+            name: 'warning',
+            color: chalk.yellowBright
+        },
+        {
+            emoji: '🚨',
+            name: 'error',
+            color: chalk.redBright
+        },
+    ]
+});

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { defaultConfig } from './config.js';
+export { itivrutaha, type ExtractScopes } from './itivrutaha.js';

package/dist/index.js

@@ -0,0 +1,6 @@
+/*
+ *  Entry file for itivrutaha logging module.
+ *  Created On 29 October 2023
+ */
+export { defaultConfig } from './config.js';
+export { itivrutaha } from './itivrutaha.js';

package/dist/itivrutaha.d.ts

@@ -0,0 +1,3 @@
+import { type Config, type UnifiedData } from './config.js';
+export declare function itivrutaha<Scope extends string, LogTypeName extends string>(config: Config<Scope, LogTypeName>): { [Type in LogTypeName]: (msgOrData: string | UnifiedData<Scope> | Error, data?: any, scope?: Scope) => void; };
+export type ExtractScopes<T> = T extends ReturnType<typeof itivrutaha<infer S extends string, any>> ? S : never;

package/dist/itivrutaha.js

@@ -0,0 +1,15 @@
+/*
+ *  Contains an exportable logger function.
+ *  Created On 29 October 2023
+ */
+import {} from './config.js';
+import { render } from './renderer.js';
+export function itivrutaha(config) {
+    // calculate the log type filter values at load
+    const typeFilter = config.typeFilterFn();
+    // return all the log functions
+    return config.types.reduce((previous, current) => ({
+        ...previous,
+        [current.name]: render(config, current, typeFilter)
+    }), {});
+}

package/dist/renderer.d.ts

@@ -0,0 +1,2 @@
+import { type Config, type LogType, type UnifiedData } from './config.js';
+export declare function render<ScopeName, LogTypeName extends string>(config: Config<ScopeName, LogTypeName>, type: LogType<LogTypeName>, filter: LogTypeName[]): (msgOrData: string | UnifiedData<ScopeName> | Error, data?: any, scope?: ScopeName) => void;

package/dist/renderer.js

@@ -0,0 +1,52 @@
+/*
+ *  Renders a single log line by consuming an object.
+ *  Created On 15 January 2024
+ */
+import {} from './config.js';
+import { filterObject } from './utilts.js';
+import * as variables from './variables/index.js';
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function line(config, type, msg, scopeName, data) {
+    // filter internal keys from data
+    if (data)
+        data = filterObject(data, ['msg', 'scope']);
+    console.log(config.theme
+        .replace(/:time/g, variables.time(config))
+        .replace(/:scope/g, variables.scope(config, scopeName))
+        .replace(/:emoji/g, variables.emoji(type))
+        .replace(/:type/g, variables.type(type))
+        .replace(/:msg/g, msg instanceof Error ? msg.message : msg)
+        .replace(/:data/g, variables.data(data)));
+    if (msg instanceof Error) {
+        console.log(msg);
+    }
+    // whether there's an error instance in data
+    for (const key in data) {
+        const value = data[key];
+        if (value instanceof Error) {
+            console.log(value);
+        }
+    }
+}
+export function render(config, type, filter) {
+    // consume all the log objects
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return (msgOrData, data, scope) => {
+        // filter based on filter function from config
+        if (!filter.includes(type.name))
+            return;
+        if (msgOrData instanceof Error || typeof msgOrData == 'string') {
+            // seperate arguments
+            line(config, type, msgOrData, scope, data);
+        }
+        else {
+            // unified data
+            // ensure scope & data are not given in both placces
+            if (scope)
+                throw Error('Specifying scope as argument is not allowed');
+            if (data)
+                throw Error('Specifying data separately is not allowed');
+            line(config, type, msgOrData.msg, msgOrData.scope, msgOrData);
+        }
+    };
+}

package/dist/utilts.d.ts

@@ -0,0 +1 @@
+export declare function filterObject(obj: Record<string, any>, keysToExclude: string[]): Record<string, any>;

package/dist/utilts.js

@@ -0,0 +1,8 @@
+/*
+ *  Contains small utility functions used across this project.
+ *  Created On 15 January 2024
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function filterObject(obj, keysToExclude) {
+    return Object.fromEntries(Object.entries(obj).filter(([key]) => !keysToExclude.includes(key)));
+}

package/dist/variables/data.d.ts

@@ -0,0 +1 @@
+export declare function data(input: any): string;

package/dist/variables/data.js

@@ -0,0 +1,40 @@
+/*
+ *  Renders the ":data" variable.
+ *  Created On 15 January 2024
+ */
+import chalk from 'chalk';
+import { highlight } from 'cli-highlight';
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function formatJSON(data) {
+    return JSON.stringify(data)
+        .replace(/{"/g, '{ "')
+        .replace(/"}/g, '" }')
+        .replace(/,"/g, ', "')
+        .replace(/":/g, '": ');
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function data(input) {
+    if (!input)
+        return '';
+    let str = '';
+    for (const key in input) {
+        const value = input[key];
+        const keyBlock = `${chalk.cyanBright(key)}${chalk.whiteBright('=')}`;
+        if (value instanceof Error) {
+            str = str.concat(keyBlock).concat(chalk.magentaBright(value.message)).concat(' ');
+        }
+        else if (typeof value == 'object') {
+            str = str.concat(keyBlock).concat(highlight(formatJSON(value), {
+                language: 'json',
+                ignoreIllegals: true,
+            })).concat(' ');
+        }
+        else if (typeof value == 'string') {
+            str = str.concat(keyBlock).concat(chalk.magentaBright(value)).concat(' ');
+        }
+        else {
+            str = str.concat(keyBlock).concat(chalk.magentaBright(JSON.stringify(value))).concat(' ');
+        }
+    }
+    return str.trim();
+}

package/dist/variables/emoji.d.ts

@@ -0,0 +1,2 @@
+import { type LogType } from '../config.js';
+export declare function emoji<LogTypeName extends string>(type: LogType<LogTypeName>): string;

package/dist/variables/emoji.js

@@ -0,0 +1,8 @@
+/*
+ *  Renders the ":emoji" variable if an emoji is specified.
+ *  Created On 15 January 2024
+ */
+import {} from '../config.js';
+export function emoji(type) {
+    return type.emoji.trim();
+}

package/dist/variables/index.d.ts

@@ -0,0 +1,5 @@
+export * from './time.js';
+export * from './type.js';
+export * from './data.js';
+export * from './emoji.js';
+export * from './scope.js';

package/dist/variables/index.js

@@ -0,0 +1,9 @@
+/*
+ *  Exports all render functions neatly as single package.
+ *  Created On 15 January 2024
+ */
+export * from './time.js';
+export * from './type.js';
+export * from './data.js';
+export * from './emoji.js';
+export * from './scope.js';

package/dist/variables/scope.d.ts

@@ -0,0 +1,2 @@
+import { type Config } from '../config.js';
+export declare function scope<ScopeName, LogTypeName extends string>(config: Config<ScopeName, LogTypeName>, scopeName?: ScopeName): string;

package/dist/variables/scope.js

@@ -0,0 +1,11 @@
+/*
+ *  Renders ":scope" variable with the current log line's scope.
+ *  Created On 15 January 2024
+ */
+import {} from '../config.js';
+export function scope(config, scopeName) {
+    const scope = scopeName ? config.scopes.find(sco => sco.name == scopeName) : config.scopes[0];
+    if (!scope)
+        throw new Error('Scope not found');
+    return scope.color(scope.name);
+}

package/dist/variables/time.d.ts

@@ -0,0 +1,2 @@
+import { type Config } from '../config.js';
+export declare function time<ScopeName, LogTypeName extends string>(config: Config<ScopeName, LogTypeName>): string;

package/dist/variables/time.js

@@ -0,0 +1,10 @@
+/*
+ *  Renders the ":time" variable printing current time.
+ *  Created On 15 January 2024
+ */
+import chalk from 'chalk';
+import format from 'date-format';
+import {} from '../config.js';
+export function time(config) {
+    return chalk.gray.dim(format.asString(config.timeFormat));
+}

package/dist/variables/type.d.ts

@@ -0,0 +1,2 @@
+import { type LogType } from '../config.js';
+export declare function type<LogTypeName extends string>(type: LogType<LogTypeName>): string;

package/dist/variables/type.js

@@ -0,0 +1,8 @@
+/*
+ *  Renders the ":type" variable.
+ *  Created On 15 January 2024
+ */
+import {} from '../config.js';
+export function type(type) {
+    return type.color(type.name);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "itivrutaha",
     "description": "( इतिवृत्तः ) — An 👌 easy-to-use, 🛠️ configurable, Bun-first ⚡ console logger.",
-    "version": "3.2.1",
+    "version": "3.2.2",
     "license": "MIT",
     "type": "module",
     "main": "dist/index.js",