@vidavidorra/bunyan-pretty-stream 3.0.17 → 4.0.0-beta.1

package/dist/src/formatter/formatter.js

@@ -1,200 +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.Formatter = void 0;
-const bunyan_record_1 = require("../bunyan-record");
-const options_1 = require("../options");
-const extras_1 = require("./extras");
-const bunyan_1 = __importDefault(require("bunyan"));
-const chalk_1 = __importDefault(require("chalk"));
-const is_1 = __importDefault(require("@sindresorhus/is"));
-const moment_1 = __importDefault(require("moment"));
-const path_1 = __importDefault(require("path"));
-const json_stringify_pretty_compact_1 = __importDefault(require("json-stringify-pretty-compact"));
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function sanitise(obj) {
-    Object.entries(obj).forEach(([key, value]) => {
-        if (is_1.default.undefined(value)) {
-            delete obj[key];
-        }
-        else if (is_1.default.object(value)) {
-            sanitise(value);
-        }
-    });
-    return obj;
-}
-class Formatter {
-    constructor(options) {
-        this._regex = {
-            newLine: /\r\n|\r|\n/,
-            whitespace: /\s/,
-        };
-        this._internalOptions = {
-            timeFormat: {
-                short: 'HH:mm:ss.SSS',
-                long: 'YYYY-MM-DD[T]HH:mm:ss.SSS',
-            },
-        };
-        const parsedOptions = options_1.schema.parse(options);
-        parsedOptions.basePath = path_1.default.normalize(parsedOptions.basePath);
-        this._options = parsedOptions;
-        this._levels = {
-            [bunyan_1.default.levelFromName.trace]: chalk_1.default.gray('TRACE'),
-            [bunyan_1.default.levelFromName.debug]: chalk_1.default.blue('DEBUG'),
-            [bunyan_1.default.levelFromName.info]: chalk_1.default.green(' INFO'),
-            [bunyan_1.default.levelFromName.warn]: chalk_1.default.magenta(' WARN'),
-            [bunyan_1.default.levelFromName.error]: chalk_1.default.red('ERROR'),
-            [bunyan_1.default.levelFromName.fatal]: chalk_1.default.bgRed('FATAL'),
-        };
-    }
-    parse(record) {
-        const parsed = {
-            version: record.v,
-            level: record.level,
-            name: record.name,
-            hostname: record.hostname,
-            pid: record.pid,
-            time: (0, moment_1.default)(record.time),
-            message: record.msg,
-            source: record.src,
-            extras: new extras_1.Extras(this._options.extras.maxLength),
-            details: sanitise(record),
-        };
-        Object.keys(parsed.details).forEach((key) => {
-            if ((0, bunyan_record_1.coreFields)().includes(key)) {
-                delete parsed.details[key];
-            }
-        });
-        if (!this._options.show.extras) {
-            return parsed;
-        }
-        const leftOvers = is_1.default.undefined(this._options.extras.key)
-            ? parsed.details
-            : parsed.details[this._options.extras.key];
-        if (!is_1.default.nonEmptyObject(leftOvers)) {
-            return parsed;
-        }
-        Object.entries(leftOvers).forEach(([key, value]) => {
-            if (parsed.extras.parseAndAdd(key, value)) {
-                delete leftOvers[key];
-            }
-        });
-        return parsed;
-    }
-    format(record) {
-        const parsedRecord = this.parse(record);
-        return [
-            this.formatTime((0, moment_1.default)(parsedRecord.time)),
-            this.formatLevel(parsedRecord.level),
-            ':',
-            this.formatName(parsedRecord.name),
-            this.formatPid(parsedRecord.pid),
-            this.formatHostname(parsedRecord.hostname),
-            this.formatSource(parsedRecord.source),
-            this.formatMessage(parsedRecord.message),
-            this.formatExtras(parsedRecord.extras),
-            this._options.newLineCharacter,
-            this.formatDetails(parsedRecord.message, parsedRecord.details),
-        ].join('');
-    }
-    formatTime(time) {
-        if (!this._options.show.time) {
-            return '';
-        }
-        let format = this._options.time.format;
-        if (this._options.time.type === 'short') {
-            format = this._internalOptions.timeFormat.short;
-        }
-        else if (this._options.time.type === 'long') {
-            format = this._internalOptions.timeFormat.long;
-        }
-        if (!this._options.time.local) {
-            time.utc();
-            format = format.concat('[Z]');
-        }
-        return `[${time.format(format)}]`;
-    }
-    formatLevel(level) {
-        const prefix = this._options.show.time ? ' ' : '';
-        return `${prefix}${this._levels[level]}`;
-    }
-    formatName(name) {
-        if (!this._options.show.name) {
-            return '';
-        }
-        return ` ${name}`;
-    }
-    formatPid(pid) {
-        if (!this._options.show.pid) {
-            return '';
-        }
-        const prefix = this._options.show.name ? '/' : ' ';
-        return `${prefix}${pid}`;
-    }
-    formatHostname(hostname) {
-        if (!this._options.show.hostname) {
-            return '';
-        }
-        return [
-            ' ',
-            this._options.show.name || this._options.show.pid ? 'on ' : '',
-            hostname,
-        ].join('');
-    }
-    formatSource(source) {
-        if (!this._options.show.source || is_1.default.undefined(source)) {
-            return '';
-        }
-        const file = path_1.default.relative(this._options.basePath, source.file);
-        const formattedSource = [
-            ` (${file}:${source.line}`,
-            !is_1.default.undefined(source.func) ? ` in ${source.func}` : '',
-            ')',
-        ].join('');
-        return chalk_1.default.green(formattedSource);
-    }
-    formatMessage(message) {
-        if (!this.isSingleLine(message)) {
-            return '';
-        }
-        return chalk_1.default.blue(` ${message}`);
-    }
-    formatExtras(extras) {
-        const formattedExtras = extras.format();
-        return formattedExtras.length === 0 ? '' : chalk_1.default.red(` ${formattedExtras}`);
-    }
-    formatDetails(message, details) {
-        const formatted = [];
-        if (!this.isSingleLine(message)) {
-            formatted.push(chalk_1.default.blue(this.indent(message, true)));
-        }
-        formatted.push(...Object.entries(details).map(([key, value]) => chalk_1.default.cyan(this.indent(`${key}: ${(0, json_stringify_pretty_compact_1.default)(value, {
-            indent: this._options.indent.json,
-            maxLength: 80,
-        })}`, true))));
-        const separator = [
-            this._options.newLineCharacter,
-            this.indent('--', true),
-            this._options.newLineCharacter,
-        ].join('');
-        const suffix = formatted.length > 0 ? this._options.newLineCharacter : '';
-        return `${formatted.join(separator)}${suffix}`;
-    }
-    isSingleLine(string) {
-        return !this._regex.newLine.test(string);
-    }
-    containsWhitespace(string) {
-        return this._regex.whitespace.test(string);
-    }
-    indent(input, leading = false) {
-        const indentation = ' '.repeat(this._options.indent.details);
-        const prefix = leading ? indentation : '';
-        const formatted = input
-            .split(this._regex.newLine)
-            .join(`${this._options.newLineCharacter}${indentation}`);
-        return `${prefix}${formatted}`;
-    }
-}
-exports.Formatter = Formatter;

package/dist/src/formatter/index.d.ts

@@ -1,2 +0,0 @@
-import { Formatter } from './formatter';
-export { Formatter };

package/dist/src/formatter/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Formatter = void 0;
-const formatter_1 = require("./formatter");
-Object.defineProperty(exports, "Formatter", { enumerable: true, get: function () { return formatter_1.Formatter; } });

package/dist/src/index.d.ts

@@ -1,3 +0,0 @@
-import { Logger } from './logger';
-import { PrettyStream } from './bunyan-pretty-stream';
-export { PrettyStream, Logger };

package/dist/src/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrettyStream = void 0;
-const bunyan_pretty_stream_1 = require("./bunyan-pretty-stream");
-Object.defineProperty(exports, "PrettyStream", { enumerable: true, get: function () { return bunyan_pretty_stream_1.PrettyStream; } });

package/dist/src/logger.js

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

package/dist/src/options.d.ts

@@ -1,151 +0,0 @@
-import { z } from 'zod';
-declare const schema: z.ZodObject<{
-    show: z.ZodDefault<z.ZodObject<{
-        time: z.ZodDefault<z.ZodBoolean>;
-        name: z.ZodDefault<z.ZodBoolean>;
-        hostname: z.ZodDefault<z.ZodBoolean>;
-        pid: z.ZodDefault<z.ZodBoolean>;
-        source: z.ZodDefault<z.ZodBoolean>;
-        extras: z.ZodDefault<z.ZodBoolean>;
-    }, "strict", z.ZodTypeAny, {
-        source: boolean;
-        name: boolean;
-        time: boolean;
-        hostname: boolean;
-        pid: boolean;
-        extras: boolean;
-    }, {
-        source?: boolean | undefined;
-        name?: boolean | undefined;
-        time?: boolean | undefined;
-        hostname?: boolean | undefined;
-        pid?: boolean | undefined;
-        extras?: boolean | undefined;
-    }>>;
-    extras: z.ZodDefault<z.ZodObject<{
-        key: z.ZodOptional<z.ZodString>;
-        maxLength: z.ZodDefault<z.ZodObject<{
-            key: z.ZodDefault<z.ZodNumber>;
-            value: z.ZodDefault<z.ZodNumber>;
-            total: z.ZodDefault<z.ZodNumber>;
-        }, "strict", z.ZodTypeAny, {
-            key: number;
-            total: number;
-            value: number;
-        }, {
-            key?: number | undefined;
-            total?: number | undefined;
-            value?: number | undefined;
-        }>>;
-    }, "strict", z.ZodTypeAny, {
-        key?: string | undefined;
-        maxLength: {
-            key: number;
-            total: number;
-            value: number;
-        };
-    }, {
-        key?: string | undefined;
-        maxLength?: {
-            key?: number | undefined;
-            total?: number | undefined;
-            value?: number | undefined;
-        } | undefined;
-    }>>;
-    indent: z.ZodDefault<z.ZodObject<{
-        details: z.ZodDefault<z.ZodNumber>;
-        json: z.ZodDefault<z.ZodNumber>;
-    }, "strict", z.ZodTypeAny, {
-        details: number;
-        json: number;
-    }, {
-        details?: number | undefined;
-        json?: number | undefined;
-    }>>;
-    basePath: z.ZodDefault<z.ZodString>;
-    newLineCharacter: z.ZodDefault<z.ZodEnum<["\r", "\n", "\r\n"]>>;
-    time: z.ZodDefault<z.ZodObject<{
-        type: z.ZodDefault<z.ZodEnum<["short", "long", "format"]>>;
-        /**
-         * Display local time instead of UTC.
-         */
-        local: z.ZodDefault<z.ZodBoolean>;
-        /**
-         * Time format as specified by the `Moment.js` [format options](
-         * https://momentjs.com/docs/#/displaying/format/).
-         *
-         * @note The time zone, `Z` or `ZZ`, should be omitted as `Z` is
-         * automatically to the format if the time is UTC.
-         * @note The `Z` display suffix for UTC times is automatically added to
-         * the format and should be omitted.
-         */
-        format: z.ZodDefault<z.ZodString>;
-    }, "strict", z.ZodTypeAny, {
-        type: "long" | "short" | "format";
-        format: string;
-        local: boolean;
-    }, {
-        type?: "long" | "short" | "format" | undefined;
-        format?: string | undefined;
-        local?: boolean | undefined;
-    }>>;
-}, "strict", z.ZodTypeAny, {
-    show: {
-        source: boolean;
-        name: boolean;
-        time: boolean;
-        hostname: boolean;
-        pid: boolean;
-        extras: boolean;
-    };
-    time: {
-        type: "long" | "short" | "format";
-        format: string;
-        local: boolean;
-    };
-    extras: {
-        key?: string | undefined;
-        maxLength: {
-            key: number;
-            total: number;
-            value: number;
-        };
-    };
-    indent: {
-        details: number;
-        json: number;
-    };
-    basePath: string;
-    newLineCharacter: "\r" | "\n" | "\r\n";
-}, {
-    show?: {
-        source?: boolean | undefined;
-        name?: boolean | undefined;
-        time?: boolean | undefined;
-        hostname?: boolean | undefined;
-        pid?: boolean | undefined;
-        extras?: boolean | undefined;
-    } | undefined;
-    time?: {
-        type?: "long" | "short" | "format" | undefined;
-        format?: string | undefined;
-        local?: boolean | undefined;
-    } | undefined;
-    extras?: {
-        key?: string | undefined;
-        maxLength?: {
-            key?: number | undefined;
-            total?: number | undefined;
-            value?: number | undefined;
-        } | undefined;
-    } | undefined;
-    indent?: {
-        details?: number | undefined;
-        json?: number | undefined;
-    } | undefined;
-    basePath?: string | undefined;
-    newLineCharacter?: "\r" | "\n" | "\r\n" | undefined;
-}>;
-type Options = z.input<typeof schema>;
-type ParsedOptions = z.infer<typeof schema>;
-export { Options, ParsedOptions, schema };

package/dist/src/options.js

@@ -1,68 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.schema = void 0;
-const bunyan_record_1 = require("./bunyan-record");
-const zod_1 = require("zod");
-const schema = zod_1.z
-    .object({
-    show: zod_1.z
-        .object({
-        time: zod_1.z.boolean().default(true),
-        name: zod_1.z.boolean().default(false),
-        hostname: zod_1.z.boolean().default(false),
-        pid: zod_1.z.boolean().default(false),
-        source: zod_1.z.boolean().default(false),
-        extras: zod_1.z.boolean().default(true),
-    })
-        .strict()
-        .default({}),
-    extras: zod_1.z
-        .object({
-        key: zod_1.z
-            .string()
-            .min(1)
-            .regex(new RegExp(`^((?!(${(0, bunyan_record_1.coreFields)().join('|')})).)*$`))
-            .optional(),
-        maxLength: zod_1.z
-            .object({
-            key: zod_1.z.number().int().positive().default(20),
-            value: zod_1.z.number().int().positive().default(50),
-            total: zod_1.z.number().int().positive().default(500),
-        })
-            .strict()
-            .default({}),
-    })
-        .strict()
-        .default({}),
-    indent: zod_1.z
-        .object({
-        details: zod_1.z.number().int().nonnegative().default(4),
-        json: zod_1.z.number().int().nonnegative().default(2),
-    })
-        .strict()
-        .default({}),
-    basePath: zod_1.z.string().min(1).default('/'),
-    newLineCharacter: zod_1.z.enum(['\r', '\n', '\r\n']).default('\n'),
-    time: zod_1.z
-        .object({
-        type: zod_1.z.enum(['short', 'long', 'format']).default('long'),
-        /**
-         * Display local time instead of UTC.
-         */
-        local: zod_1.z.boolean().default(false),
-        /**
-         * Time format as specified by the `Moment.js` [format options](
-         * https://momentjs.com/docs/#/displaying/format/).
-         *
-         * @note The time zone, `Z` or `ZZ`, should be omitted as `Z` is
-         * automatically to the format if the time is UTC.
-         * @note The `Z` display suffix for UTC times is automatically added to
-         * the format and should be omitted.
-         */
-        format: zod_1.z.string().min(1).default('YYYY-MM-DD[T]HH:mm:ss.SSS'),
-    })
-        .strict()
-        .default({}),
-})
-    .strict();
-exports.schema = schema;