nightingale-json-formatter 15.0.0 → 16.1.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [16.1.0](https://github.com/christophehurpeau/nightingale/compare/v16.0.0...v16.1.0) (2025-03-30)
+
+Version bump for dependency: nightingale
+
+
+## [16.0.0](https://github.com/christophehurpeau/nightingale/compare/v15.0.0...v16.0.0) (2025-03-30)
+
+### ⚠ BREAKING CHANGES
+
+* drop node 18
+
+### Features
+
+* drop node 18 ([1b11a55](https://github.com/christophehurpeau/nightingale/commit/1b11a55dd24c9435be50519a748316079f554414))
+
+### Bug Fixes
+
+* fix lib exports ([5b562b2](https://github.com/christophehurpeau/nightingale/commit/5b562b245aac1aa86b728a9433f3c9d28c62fe04))
+
+Version bump for dependency: nightingale
+
+
 ## [15.0.0](https://github.com/christophehurpeau/nightingale/compare/v14.2.1...v15.0.0) (2023-12-25)
 
 

package/README.md

@@ -1,27 +1,29 @@
-<h3 align="center">
+<h1 align="center">
   nightingale-json-formatter
-</h3>
+</h1>
 
 <p align="center">
-  Nightingale JSON formatter
+  Deprecated: use JSONFormatter from nightingale
 </p>
 
 <p align="center">
-  <a href="https://npmjs.org/package/nightingale-json-formatter"><img src="https://img.shields.io/npm/v/nightingale-json-formatter.svg?style=flat-square"></a>
-  <a href="https://npmjs.org/package/nightingale-json-formatter"><img src="https://img.shields.io/npm/dw/nightingale-json-formatter.svg?style=flat-square"></a>
-  <a href="https://npmjs.org/package/nightingale-json-formatter"><img src="https://img.shields.io/node/v/nightingale-json-formatter.svg?style=flat-square"></a>
-  <a href="https://npmjs.org/package/nightingale-json-formatter"><img src="https://img.shields.io/npm/types/nightingale-json-formatter.svg?style=flat-square"></a>
+  <a href="https://npmjs.org/package/nightingale-json-formatter"><img src="https://img.shields.io/npm/v/nightingale-json-formatter.svg?style=flat-square" alt="npm version"></a>
+  <a href="https://npmjs.org/package/nightingale-json-formatter"><img src="https://img.shields.io/npm/dw/nightingale-json-formatter.svg?style=flat-square" alt="npm downloads"></a>
+  <a href="https://npmjs.org/package/nightingale-json-formatter"><img src="https://img.shields.io/node/v/nightingale-json-formatter.svg?style=flat-square" alt="node version"></a>
+  <a href="https://npmjs.org/package/nightingale-json-formatter"><img src="https://img.shields.io/npm/types/nightingale-json-formatter.svg?style=flat-square" alt="types"></a>
   <a href="https://codecov.io/gh/christophehurpeau/nightingale"><img src="https://img.shields.io/codecov/c/github/christophehurpeau/nightingale/master.svg?style=flat-square"></a>
 </p>
 
 ## Install
 
 ```sh
-npm install --save nightingale-json-formatter
+npm install --save nightingale
 ```
 
 ## Usage
 
 ```js
-import jsonFormatter from 'nightingale-json-formatter';
+import { JSONFormatter } from "nightingale";
+
+JSONFormatter.format(record);
 ```

package/lib/index.js

@@ -0,0 +1,3 @@
+import { JSONFormatter } from "nightingale";
+
+export default JSONFormatter.format;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nightingale-json-formatter",
-  "version": "15.0.0",
-  "description": "Nightingale JSON formatter",
+  "version": "16.1.0",
+  "description": "Deprecated: use JSONFormatter from nightingale",
   "keywords": [
     "nightingale",
     "nightingale-formatter"
@@ -16,72 +16,28 @@
   "homepage": "https://github.com/christophehurpeau/nightingale",
   "type": "module",
   "engines": {
-    "node": ">=18.12.0"
+    "node": ">=20.9.0"
   },
-  "browserslist": {
-    "production": [
-      "defaults",
-      "> 0.2%",
-      "not ie < 12",
-      "not safari < 10",
-      "not ios_saf < 10"
-    ]
-  },
-  "main": "./dist/index-node18.mjs",
-  "types": "./dist/definitions/index.d.ts",
-  "module": "./dist/index-browser.es.js",
-  "browser": "./dist/index-browser.es.js",
+  "sideEffects": false,
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
-    ".": {
-      "types": "./dist/definitions/index.d.ts",
-      "node": {
-        "import": "./dist/index-node18.mjs"
-      },
-      "browser": {
-        "import": "./dist/index-browser.es.js"
-      }
-    }
+    ".": "./lib/index.js"
   },
-  "sideEffects": false,
   "files": [
-    "src",
-    "dist"
+    "lib"
   ],
   "scripts": {
-    "build": "yarn clean:build && rollup --config rollup.config.mjs && yarn run build:definitions",
-    "build:definitions": "tsc -p tsconfig.json",
     "clean": "yarn clean:build",
-    "clean:build": "pob-babel-clean-out dist",
     "lint": "yarn run lint:eslint",
-    "lint:eslint": "yarn ../.. run eslint --report-unused-disable-directives --resolve-plugins-relative-to . --quiet packages/nightingale-json-formatter",
+    "lint:eslint": "yarn ../.. run eslint --quiet packages/nightingale-json-formatter",
     "test": "yarn ../../ run test -- packages/nightingale-json-formatter",
     "watch": "yarn clean:build && rollup --config rollup.config.mjs --watch"
   },
+  "pob": {},
   "prettier": "@pob/root/prettier-config",
-  "pob": {
-    "babelEnvs": [
-      {
-        "target": "node",
-        "version": "18"
-      },
-      {
-        "target": "browser"
-      }
-    ],
-    "entries": [
-      "index"
-    ]
-  },
   "dependencies": {
-    "nightingale-formatter": "15.0.0",
-    "nightingale-types": "15.0.0"
-  },
-  "devDependencies": {
-    "@babel/core": "7.23.6",
-    "@babel/preset-env": "7.23.6",
-    "nightingale-levels": "15.0.0",
-    "pob-babel": "38.0.0",
-    "typescript": "5.3.3"
+    "nightingale": "16.1.0"
   }
 }

package/dist/definitions/index.d.ts

@@ -1,3 +0,0 @@
-import type { LogRecord, Metadata } from 'nightingale-types';
-export default function format<T extends Metadata>(record: LogRecord<T>): string;
-//# sourceMappingURL=index.d.ts.map

package/dist/definitions/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAqC7D,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,CAAC,SAAS,QAAQ,EAC/C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GACnB,MAAM,CASR"}

package/dist/definitions/index.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.test.d.ts.map

package/dist/definitions/index.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/index.test.ts"],"names":[],"mappings":""}

package/dist/index-browser.es.js

@@ -1,38 +0,0 @@
-function map2object(map) {
-  const object = {};
-  map.forEach((value, key) => {
-    if (typeof key === 'object') {
-      // ignore key
-      return;
-    }
-    object[String(key)] = value;
-  });
-  return object;
-}
-function stringify(value, space) {
-  return JSON.stringify(value, (key, objectValue) => {
-    if (objectValue instanceof Map) {
-      return map2object(objectValue);
-    }
-    if (objectValue instanceof Error) {
-      return {
-        message: objectValue.message,
-        stack: objectValue.stack
-      };
-    }
-    return objectValue;
-  }, space);
-}
-function format(record) {
-  return stringify({
-    key: record.key,
-    level: record.level,
-    datetime: record.datetime,
-    message: record.message,
-    metadata: record.metadata,
-    extra: record.extra
-  });
-}
-
-export { format as default };
-//# sourceMappingURL=index-browser.es.js.map

package/dist/index-browser.es.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-browser.es.js","sources":["../src/index.ts"],"sourcesContent":["import type { LogRecord, Metadata } from 'nightingale-types';\n\nfunction map2object(map: Map<unknown, unknown>): unknown {\n  const object: Record<string, unknown> = {};\n\n  map.forEach((value, key) => {\n    if (typeof key === 'object') {\n      // ignore key\n      return;\n    }\n\n    object[String(key)] = value;\n  });\n\n  return object;\n}\n\nfunction stringify(value: unknown, space?: number | string): string {\n  return JSON.stringify(\n    value,\n    (key, objectValue) => {\n      if (objectValue instanceof Map) {\n        return map2object(objectValue);\n      }\n      if (objectValue instanceof Error) {\n        return {\n          message: objectValue.message,\n          stack: objectValue.stack,\n        };\n      }\n\n      return objectValue as unknown;\n    },\n    space,\n  );\n}\n\nexport default function format<T extends Metadata>(\n  record: LogRecord<T>,\n): string {\n  return stringify({\n    key: record.key,\n    level: record.level,\n    datetime: record.datetime,\n    message: record.message,\n    metadata: record.metadata,\n    extra: record.extra,\n  });\n}\n"],"names":["map2object","map","object","forEach","value","key","String","stringify","space","JSON","objectValue","Map","Error","message","stack","format","record","level","datetime","metadata","extra"],"mappings":"AAEA,SAASA,UAAUA,CAACC,GAA0B,EAAW;EACvD,MAAMC,MAA+B,GAAG,EAAE,CAAA;AAE1CD,EAAAA,GAAG,CAACE,OAAO,CAAC,CAACC,KAAK,EAAEC,GAAG,KAAK;AAC1B,IAAA,IAAI,OAAOA,GAAG,KAAK,QAAQ,EAAE;AAC3B;AACA,MAAA,OAAA;AACF,KAAA;AAEAH,IAAAA,MAAM,CAACI,MAAM,CAACD,GAAG,CAAC,CAAC,GAAGD,KAAK,CAAA;AAC7B,GAAC,CAAC,CAAA;AAEF,EAAA,OAAOF,MAAM,CAAA;AACf,CAAA;AAEA,SAASK,SAASA,CAACH,KAAc,EAAEI,KAAuB,EAAU;EAClE,OAAOC,IAAI,CAACF,SAAS,CACnBH,KAAK,EACL,CAACC,GAAG,EAAEK,WAAW,KAAK;IACpB,IAAIA,WAAW,YAAYC,GAAG,EAAE;MAC9B,OAAOX,UAAU,CAACU,WAAW,CAAC,CAAA;AAChC,KAAA;IACA,IAAIA,WAAW,YAAYE,KAAK,EAAE;MAChC,OAAO;QACLC,OAAO,EAAEH,WAAW,CAACG,OAAO;QAC5BC,KAAK,EAAEJ,WAAW,CAACI,KAAAA;OACpB,CAAA;AACH,KAAA;AAEA,IAAA,OAAOJ,WAAW,CAAA;GACnB,EACDF,KACF,CAAC,CAAA;AACH,CAAA;AAEe,SAASO,MAAMA,CAC5BC,MAAoB,EACZ;AACR,EAAA,OAAOT,SAAS,CAAC;IACfF,GAAG,EAAEW,MAAM,CAACX,GAAG;IACfY,KAAK,EAAED,MAAM,CAACC,KAAK;IACnBC,QAAQ,EAAEF,MAAM,CAACE,QAAQ;IACzBL,OAAO,EAAEG,MAAM,CAACH,OAAO;IACvBM,QAAQ,EAAEH,MAAM,CAACG,QAAQ;IACzBC,KAAK,EAAEJ,MAAM,CAACI,KAAAA;AAChB,GAAC,CAAC,CAAA;AACJ;;;;"}

package/dist/index-node18.mjs

@@ -1,38 +0,0 @@
-function map2object(map) {
-  const object = {};
-  map.forEach((value, key) => {
-    if (typeof key === 'object') {
-      // ignore key
-      return;
-    }
-    object[String(key)] = value;
-  });
-  return object;
-}
-function stringify(value, space) {
-  return JSON.stringify(value, (key, objectValue) => {
-    if (objectValue instanceof Map) {
-      return map2object(objectValue);
-    }
-    if (objectValue instanceof Error) {
-      return {
-        message: objectValue.message,
-        stack: objectValue.stack
-      };
-    }
-    return objectValue;
-  }, space);
-}
-function format(record) {
-  return stringify({
-    key: record.key,
-    level: record.level,
-    datetime: record.datetime,
-    message: record.message,
-    metadata: record.metadata,
-    extra: record.extra
-  });
-}
-
-export { format as default };
-//# sourceMappingURL=index-node18.mjs.map

package/dist/index-node18.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-node18.mjs","sources":["../src/index.ts"],"sourcesContent":["import type { LogRecord, Metadata } from 'nightingale-types';\n\nfunction map2object(map: Map<unknown, unknown>): unknown {\n  const object: Record<string, unknown> = {};\n\n  map.forEach((value, key) => {\n    if (typeof key === 'object') {\n      // ignore key\n      return;\n    }\n\n    object[String(key)] = value;\n  });\n\n  return object;\n}\n\nfunction stringify(value: unknown, space?: number | string): string {\n  return JSON.stringify(\n    value,\n    (key, objectValue) => {\n      if (objectValue instanceof Map) {\n        return map2object(objectValue);\n      }\n      if (objectValue instanceof Error) {\n        return {\n          message: objectValue.message,\n          stack: objectValue.stack,\n        };\n      }\n\n      return objectValue as unknown;\n    },\n    space,\n  );\n}\n\nexport default function format<T extends Metadata>(\n  record: LogRecord<T>,\n): string {\n  return stringify({\n    key: record.key,\n    level: record.level,\n    datetime: record.datetime,\n    message: record.message,\n    metadata: record.metadata,\n    extra: record.extra,\n  });\n}\n"],"names":["map2object","map","object","forEach","value","key","String","stringify","space","JSON","objectValue","Map","Error","message","stack","format","record","level","datetime","metadata","extra"],"mappings":"AAEA,SAASA,UAAUA,CAACC,GAA0B,EAAW;EACvD,MAAMC,MAA+B,GAAG,EAAE,CAAA;AAE1CD,EAAAA,GAAG,CAACE,OAAO,CAAC,CAACC,KAAK,EAAEC,GAAG,KAAK;AAC1B,IAAA,IAAI,OAAOA,GAAG,KAAK,QAAQ,EAAE;AAC3B;AACA,MAAA,OAAA;AACF,KAAA;AAEAH,IAAAA,MAAM,CAACI,MAAM,CAACD,GAAG,CAAC,CAAC,GAAGD,KAAK,CAAA;AAC7B,GAAC,CAAC,CAAA;AAEF,EAAA,OAAOF,MAAM,CAAA;AACf,CAAA;AAEA,SAASK,SAASA,CAACH,KAAc,EAAEI,KAAuB,EAAU;EAClE,OAAOC,IAAI,CAACF,SAAS,CACnBH,KAAK,EACL,CAACC,GAAG,EAAEK,WAAW,KAAK;IACpB,IAAIA,WAAW,YAAYC,GAAG,EAAE;MAC9B,OAAOX,UAAU,CAACU,WAAW,CAAC,CAAA;AAChC,KAAA;IACA,IAAIA,WAAW,YAAYE,KAAK,EAAE;MAChC,OAAO;QACLC,OAAO,EAAEH,WAAW,CAACG,OAAO;QAC5BC,KAAK,EAAEJ,WAAW,CAACI,KAAAA;OACpB,CAAA;AACH,KAAA;AAEA,IAAA,OAAOJ,WAAW,CAAA;GACnB,EACDF,KACF,CAAC,CAAA;AACH,CAAA;AAEe,SAASO,MAAMA,CAC5BC,MAAoB,EACZ;AACR,EAAA,OAAOT,SAAS,CAAC;IACfF,GAAG,EAAEW,MAAM,CAACX,GAAG;IACfY,KAAK,EAAED,MAAM,CAACC,KAAK;IACnBC,QAAQ,EAAEF,MAAM,CAACE,QAAQ;IACzBL,OAAO,EAAEG,MAAM,CAACH,OAAO;IACvBM,QAAQ,EAAEH,MAAM,CAACG,QAAQ;IACzBC,KAAK,EAAEJ,MAAM,CAACI,KAAAA;AAChB,GAAC,CAAC,CAAA;AACJ;;;;"}

package/src/.eslintrc.json

@@ -1,27 +0,0 @@
-{
-  "root": true,
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": "packages/nightingale-json-formatter/tsconfig.json"
-  },
-  "plugins": ["@typescript-eslint"],
-  "extends": ["@pob/eslint-config-typescript"],
-  "ignorePatterns": ["*.d.ts"],
-  "overrides": [
-    {
-      "files": ["**/*.test.ts", "__tests__/**/*.ts"],
-      "extends": ["@pob/eslint-config-typescript/test"],
-      "env": {
-        "jest": true
-      },
-      "rules": {
-        "import/no-extraneous-dependencies": [
-          "error",
-          {
-            "devDependencies": true
-          }
-        ]
-      }
-    }
-  ]
-}

package/src/index.test.ts

@@ -1,62 +0,0 @@
-import { Level } from 'nightingale-levels';
-import format from '.';
-
-test('format record', () => {
-  const record = {
-    key: 'record.key',
-    level: Level.INFO,
-    datetime: new Date(2000, 1, 1, 1, 0, 0),
-    message: 'record.message',
-    metadata: {},
-    extra: {},
-  };
-
-  expect(format(record)).toBe(JSON.stringify(record));
-});
-
-test('format error', () => {
-  const error = new Error('test message');
-  const record = {
-    key: 'record.key',
-    level: Level.INFO,
-    datetime: new Date(2000, 1, 1, 1, 0, 0),
-    message: 'record.message',
-    metadata: {
-      error,
-    },
-    extra: {},
-  };
-
-  expect(format(record)).toBe(
-    JSON.stringify({
-      ...record,
-      metadata: { error: { message: 'test message', stack: error.stack } },
-    }),
-  );
-});
-
-test('format map', () => {
-  const map = new Map<unknown, unknown>([
-    [1, 'value1'],
-    ['2', 'value2'],
-    ['3', 3],
-    [{}, 'ignore value'],
-  ]);
-  const record = {
-    key: 'record.key',
-    level: Level.INFO,
-    datetime: new Date(2000, 1, 1, 1, 0, 0),
-    message: 'record.message',
-    metadata: {
-      map,
-    },
-    extra: {},
-  };
-
-  expect(format(record)).toBe(
-    JSON.stringify({
-      ...record,
-      metadata: { map: { '1': 'value1', '2': 'value2', '3': 3 } },
-    }),
-  );
-});

package/src/index.ts

@@ -1,49 +0,0 @@
-import type { LogRecord, Metadata } from 'nightingale-types';
-
-function map2object(map: Map<unknown, unknown>): unknown {
-  const object: Record<string, unknown> = {};
-
-  map.forEach((value, key) => {
-    if (typeof key === 'object') {
-      // ignore key
-      return;
-    }
-
-    object[String(key)] = value;
-  });
-
-  return object;
-}
-
-function stringify(value: unknown, space?: number | string): string {
-  return JSON.stringify(
-    value,
-    (key, objectValue) => {
-      if (objectValue instanceof Map) {
-        return map2object(objectValue);
-      }
-      if (objectValue instanceof Error) {
-        return {
-          message: objectValue.message,
-          stack: objectValue.stack,
-        };
-      }
-
-      return objectValue as unknown;
-    },
-    space,
-  );
-}
-
-export default function format<T extends Metadata>(
-  record: LogRecord<T>,
-): string {
-  return stringify({
-    key: record.key,
-    level: record.level,
-    datetime: record.datetime,
-    message: record.message,
-    metadata: record.metadata,
-    extra: record.extra,
-  });
-}