pino-seq 1.1.0 → 2.0.0

package/.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x, 22.x]
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
@@ -27,4 +27,5 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - run: npm ci
     - run: npm run build --if-present
-    - run: npm test
+    - run: npm test
+    - run: ./cli.js --help

package/README.md

@@ -1,6 +1,6 @@
 # pino-seq ![Build](https://github.com/datalust/pino-seq/workflows/Test/badge.svg) ![Publish](https://github.com/datalust/pino-seq/workflows/Publish/badge.svg) [![NPM](https://img.shields.io/npm/v/pino-seq.svg)](https://www.npmjs.com/package/pino-seq)
 
-A stream to send [Pino](https://github.com/pinojs/pino) events to [Seq](https://datalust.co/seq). Tested with Node.js versions 4.2.2 and up.
+A stream to send [Pino](https://github.com/pinojs/pino) events to [Seq](https://datalust.co/seq). Tested with Node.js versions 18.x and up.
 
 ### Out-of-process (transport) usage <sup>recommended</sup>
 
@@ -9,7 +9,7 @@ First, install and use `pino` in your Node.js app, following the instructions in
 This will look something like:
 
 ```js
-const logger = require('pino')();
+const logger = (await import('pino'))();
 logger.info('Hello, World!');
 ```
 
@@ -47,8 +47,8 @@ node your-app.js 2> >(pino-seq --logOtherAs Error --serverUrl http://localhost:5
 Use the `createStream()` method to create a Pino stream configuration, passing `serverUrl`, `apiKey` and batching parameters.
 
 ```js
-let pino = require('pino');
-let pinoToSeq = require('pino-seq');
+import pino from 'pino';
+import pinoToSeq from 'pino-seq';
 
 let stream = pinoToSeq.createStream({ serverUrl: 'http://localhost:5341' });
 let logger = pino({ name: 'pino-seq example' }, stream);

package/cli.js

@@ -1,14 +1,11 @@
 #!/usr/bin/env node
 
-const program = require('commander');
-const split2 = require('split2');
-
-const pkg = require('./package.json');
-const pinoSeq = require('./index');
+import { program } from 'commander';
+import split2 from 'split2';
+import pinoSeq from './index.js';
 
 function main() {
   program
-    .version(pkg.version)
     .option('-s, --serverUrl <serverUrl>', 'Seq server instance')
     .option('-k, --apiKey <apiKey>', 'Seq API key')
     .option(

package/example/example.js

@@ -1,7 +1,7 @@
 "use strict";
 
-let pino = require('pino');
-let pinoToSeq = require('../index');
+import pino from 'pino';
+import pinoToSeq from '../index.js';
 
 let stream = pinoToSeq.createStream({serverUrl: "http://localhost:5341"});
 let logger = pino({name: "pino-seq example"}, stream);

package/example/example.ts

@@ -1,6 +1,5 @@
-import * as Pino from "pino"
-import * as PinoSeq from ".."
-
+import Pino from "pino"
+import PinoSeq from ".."
 
 const stream = PinoSeq.createStream({serverUrl: "http://localhost:5341"});
 
@@ -13,3 +12,5 @@ logger.info("Hello Seq, from Pino");
 
 const frLogger = logger.child({lang: "fr"});
 frLogger.warn("au reviour");
+
+stream.flush().then((_) => console.log('flushed'));

package/index.d.ts

@@ -11,7 +11,9 @@ declare namespace PinoSeq {
     onError?: (e: Error) => void;
   }
 
-  function createStream(config: PinoSeq.SeqConfig): Writable;
+  function createStream(config: PinoSeq.SeqConfig): Writable & {
+    flush: () => Promise<Boolean>;
+  };
 }
 
 export = PinoSeq;

package/index.js

@@ -1,8 +1,8 @@
 "use strict";
 
-let PinoSeqStream = require('./pinoSeqStream');
+import { PinoSeqStream } from './pinoSeqStream.js';
 
-module.exports = {
+export default {
   createStream: config => {
     config = config || {};
     return new PinoSeqStream(config);

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "pino-seq",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "A stream that sends Pino log events to Seq",
   "main": "index.js",
+  "types": "index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "node ./node_modules/mocha/bin/mocha",
-    "test:cli": "node ./test/cli_tests.js | node ./cli.js --property application='pino-seq'",
+    "test": "mocha",
     "start": "node ./example/example.js",
-    "start:ts": "ts-node ./example/example.ts"
+    "start:ts": "tsx ./example/example.ts"
   },
   "bin": {
     "pino-seq": "./cli.js"
@@ -27,18 +28,17 @@
   },
   "homepage": "https://github.com/datalust/pino-seq#readme",
   "devDependencies": {
-    "@types/pino": "^5.8.6",
-    "mocha": "^7.1.1",
-    "ts-node": "^8.1.0",
-    "typescript": "^3.4.4"
+    "mocha": "^11.2.2",
+    "tsx": "^4.19.4",
+    "typescript": "^5.8.3"
   },
   "dependencies": {
-    "commander": "^2.20.0",
-    "seq-logging": "^2.2.0",
-    "split2": "^3.1.1",
-    "pino": "^6.7.0"
+    "commander": "^13.1.0",
+    "seq-logging": "^3.0.0",
+    "split2": "^4.2.0",
+    "pino": "^9.6.0"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   }
 }

package/pinoSeqStream.js

@@ -1,7 +1,7 @@
 "use strict";
 
-let stream = require('stream');
-let seq = require('seq-logging');
+import stream from 'stream';
+import { Logger as SeqLogger } from 'seq-logging';
 
 let LEVEL_NAMES = {
   10: 'Verbose',
@@ -22,7 +22,7 @@ class PinoSeqStream extends stream.Writable {
     this._logOtherAs = logOtherAs;
     this._bufferTime = false;
     this._buffer = [];
-    this._logger = new seq.Logger(loggerConfig);
+    this._logger = new SeqLogger(loggerConfig);
   }
 
   _write(message, enc, cb) {
@@ -98,6 +98,11 @@ class PinoSeqStream extends stream.Writable {
     }
   }
 
+  flush() {
+    this.flushBuffer();
+    return this._logger.flush();
+  }
+
   // Force the underlying logger to flush at the time of the call
   // and wait for pending writes to complete
   _final(callback) {
@@ -109,4 +114,4 @@ class PinoSeqStream extends stream.Writable {
   }
 }
 
-module.exports = PinoSeqStream;
+export { PinoSeqStream };

package/test/pinoSeqSteam_tests.js

@@ -1,6 +1,6 @@
 "use strict";
 
-let PinoSeqStream = require('../pinoSeqStream');
+import { PinoSeqStream } from '../pinoSeqStream.js';
 
 describe('PinoSeqStream', () => {
    describe('constructor', () => {

package/test/cli_tests.js

@@ -1,20 +0,0 @@
-"use strict";
-
-const pino = require('pino')({
-  level: 'trace'
-});
-
-pino.trace('trace message');
-pino.debug('debug message');
-pino.info('info message');
-pino.warn('warn message');
-pino.error(new Error('error message'));
-pino.fatal('fatal message');
-
-const logWithProperties = pino.child({
-  a: 1,
-  trace_id: '6112be4ab9f113c499dbf4817e503a69',
-  span_id: '2f2b39a596fc76cd',
-});
-
-logWithProperties.info('info with properties');