@vidavidorra/bunyan-pretty-stream 2.0.6 → 2.0.10

package/dist/src/bunyan-pretty-stream.d.ts

@@ -1,12 +1,9 @@
 /// <reference types="node" />
 import { Options } from './options';
-import { Stream } from 'stream';
-declare class PrettyStream extends Stream {
-    readable: boolean;
-    writable: boolean;
+import { Transform, TransformCallback } from 'stream';
+declare class PrettyStream extends Transform {
     private _formatter;
     constructor(options?: Options);
-    write(chunk: any): boolean;
-    end(): boolean;
+    _transform(chunk: any, encoding: BufferEncoding, done: TransformCallback): void;
 }
 export { PrettyStream };

package/dist/src/bunyan-pretty-stream.js

@@ -1,33 +1,38 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PrettyStream = void 0;
 const options_1 = require("./options");
-const formatter_1 = require("./formatter");
 const stream_1 = require("stream");
 const bunyan_record_1 = require("./bunyan-record");
+const formatter_1 = require("./formatter");
+const is_1 = __importDefault(require("@sindresorhus/is"));
 const helpers_1 = require("./helpers");
-class PrettyStream extends stream_1.Stream {
+class PrettyStream extends stream_1.Transform {
     constructor(options = {}) {
-        super();
-        this.readable = true;
-        this.writable = true;
+        super({ objectMode: true });
         const validation = options_1.schema.validate(options);
         if (!helpers_1.joi.isValid(validation, validation.value)) {
             throw validation.error;
         }
         this._formatter = new formatter_1.Formatter(validation.value);
     }
+    _transform(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
-    write(chunk) {
-        if (!(0, bunyan_record_1.isBunyanRecord)(chunk)) {
-            throw new Error('data is not a bunyan record, forgot to set type raw?');
+    chunk, encoding, done) {
+        if (is_1.default.string(chunk)) {
+            this.push(this._formatter.format((0, bunyan_record_1.fromString)(chunk)));
+            done();
+        }
+        else if ((0, bunyan_record_1.isBunyanRecord)(chunk)) {
+            this.push(this._formatter.format(chunk));
+            done();
+        }
+        else {
+            done(new Error('data MUST be a valid bunyan record'));
         }
-        this.emit('data', this._formatter.format(chunk));
-        return true;
-    }
-    end() {
-        this.emit('end');
-        return true;
     }
 }
 exports.PrettyStream = PrettyStream;

package/dist/src/bunyan-record.d.ts

@@ -15,4 +15,5 @@ interface BunyanCoreRecord {
 declare type BunyanRecord = BunyanCoreRecord & Record<string, unknown>;
 declare function coreFields(): string[];
 declare function isBunyanRecord(value: unknown): value is BunyanRecord;
-export { BunyanRecord, coreFields, isBunyanRecord };
+declare function fromString(json: string): BunyanRecord;
+export { BunyanRecord, coreFields, fromString, isBunyanRecord };

package/dist/src/bunyan-record.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isBunyanRecord = exports.coreFields = void 0;
+exports.isBunyanRecord = exports.fromString = exports.coreFields = void 0;
 const is_1 = __importDefault(require("@sindresorhus/is"));
 function coreFields() {
     const record = {
@@ -38,3 +38,18 @@ function isBunyanRecord(value) {
                 (is_1.default.undefined(value.src.func) || is_1.default.string(value.src.func)))));
 }
 exports.isBunyanRecord = isBunyanRecord;
+function fromString(json) {
+    const record = JSON.parse(json, (key, value) => {
+        if (key === 'time' &&
+            is_1.default.string(value) &&
+            /^((\+-)\d{2})?\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$/.test(value)) {
+            return new Date(value);
+        }
+        return value;
+    });
+    if (!isBunyanRecord(record)) {
+        throw new Error('string MUST be parsable to a valid Bunyan record');
+    }
+    return record;
+}
+exports.fromString = fromString;

package/dist/src/formatter.js

@@ -174,16 +174,21 @@ class Formatter {
         return chalk_1.default.red(` (${formattedExtras.join(', ')})`);
     }
     formatDetails(message, details) {
-        const formattedDetails = [];
+        const formatted = [];
         if (!this.isSingleLine(message)) {
-            formattedDetails.push(chalk_1.default.blue(this.indent(message, true)));
+            formatted.push(chalk_1.default.blue(this.indent(message, true)));
         }
-        formattedDetails.push(...Object.entries(details).map(([key, value]) => chalk_1.default.cyan(this.indent(`${key}: ${(0, json_stringify_pretty_compact_1.default)(value, {
+        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.jsonIndent,
             maxLength: 80,
         })}`, true))));
-        const separator = this.indent('--', true);
-        return `${formattedDetails.join(`\n${separator}\n`)}\n`;
+        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}`;
     }
     isExtra(value) {
         let stringifiedValue = JSON.stringify(value, undefined, 2);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vidavidorra/bunyan-pretty-stream",
-  "version": "2.0.6",
+  "version": "2.0.10",
   "description": "Highly configurable Bunyan stream with pretty output.",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -53,43 +53,43 @@
     "node": ">=14.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "13.1.0",
-    "@jest/globals": "27.2.0",
-    "@semantic-release/changelog": "5.0.1",
-    "@semantic-release/exec": "5.0.0",
-    "@semantic-release/git": "9.0.1",
-    "@types/bunyan": "1.8.7",
+    "@commitlint/cli": "16.1.0",
+    "@jest/globals": "27.4.6",
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/exec": "6.0.3",
+    "@semantic-release/git": "10.0.1",
+    "@types/bunyan": "1.8.8",
     "@types/clone": "2.1.1",
-    "@types/node": "14.17.15",
-    "@typescript-eslint/eslint-plugin": "4.31.0",
-    "@typescript-eslint/parser": "4.31.0",
-    "@vidavidorra/commitlint-config": "2.1.16",
+    "@types/node": "16.11.21",
+    "@typescript-eslint/eslint-plugin": "5.8.0",
+    "@typescript-eslint/parser": "5.8.0",
+    "@vidavidorra/commitlint-config": "3.2.3",
     "bunyan": "*",
     "bunyan-1.x": "npm:bunyan@1.8.15",
     "bunyan-2.x": "npm:bunyan@2.0.5",
     "clone": "2.1.2",
     "dot-prop": "6.0.1",
-    "eslint": "7.32.0",
+    "eslint": "8.5.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-jest": "24.4.0",
+    "eslint-plugin-jest": "25.3.0",
     "eslint-plugin-json": "3.1.0",
     "eslint-plugin-prettier": "4.0.0",
-    "husky": "6.0.0",
-    "jest": "27.2.0",
-    "lint-staged": "11.1.2",
+    "husky": "7.0.4",
+    "jest": "27.4.7",
+    "lint-staged": "12.3.1",
     "npm-run-all": "4.1.5",
     "pinst": "2.1.6",
-    "prettier": "2.4.0",
-    "semantic-release": "17.4.7",
-    "strip-ansi": "6.0.0",
-    "ts-jest": "27.0.5",
-    "typescript": "4.4.3"
+    "prettier": "2.5.1",
+    "semantic-release": "19.0.2",
+    "strip-ansi": "6.0.1",
+    "ts-jest": "27.1.3",
+    "typescript": "4.5.5"
   },
   "peerDependencies": {
     "bunyan": "1.8.15"
   },
   "dependencies": {
-    "@sindresorhus/is": "4.2.0",
+    "@sindresorhus/is": "4.4.0",
     "chalk": "4.1.2",
     "joi": "17.4.2",
     "json-stringify-pretty-compact": "3.0.0",