Merge pull request #56 from datalust/dev

4.0.0

Author: nblumhardt

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [ dev ]
+  pull_request:
+    branches: [ dev ]
+
+jobs:
+  test-seq:
+    name: Build and Test
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+
+    services:
+      seq:
+        image: datalust/seq:latest
+        ports:
+          - 5341:80
+          - 5342:5342
+        env:
+          ACCEPT_EULA: Y
+          SEQ_FIRSTRUN_NOAUTHENTICATION: True
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm run build
+    - run: npm test
+    - run: npm run test:integration
+    - run: cd example && npm link && node example.js

.github/workflows/node.js.yml

@@ -1,6 +1,3 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-
 name: Publish
 
 on:
@@ -31,4 +28,4 @@ jobs:
       - run: npm ci
       - run: npm publish
         env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.github/workflows/npm-publish.yml

@@ -3,6 +3,9 @@ logs
 *.log
 npm-debug.log*
 
+# Build output
+/dist
+
 # Runtime data
 pids
 *.pid

.gitignore

@@ -2,21 +2,69 @@
 
 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.
 
+**Now written in TypeScript** with automatic type definitions and full ES Module support!
+
+## Installation
+
+```bash
+npm install pino-seq
+```
+
+## Usage
+
 Use the `createStream()` method to create a Pino stream configuration, passing `serverUrl`, `apiKey` and batching parameters.
 
-```js
+This example works in both JavaScript and TypeScript projects:
+
+```javascript
 import pino from 'pino';
-import pinoToSeq from 'pino-seq';
+import { createStream } from 'pino-seq';
 
-let stream = pinoToSeq.createStream({ serverUrl: 'http://localhost:5341' });
-let logger = pino({ name: 'pino-seq example' }, stream);
+// Create a stream to Seq
+const stream = createStream({ 
+  serverUrl: 'http://localhost:5341',
+  apiKey: 'your-api-key' // optional
+});
 
+// Create a Pino logger
+const logger = pino({ name: 'pino-seq example' }, stream);
+
+// Log some messages
 logger.info('Hello Seq, from Pino');
 
-let frLogger = logger.child({ lang: 'fr' });
+// Child loggers work too
+const frLogger = logger.child({ lang: 'fr' });
 frLogger.warn('au reviour');
+
+// Flush logs before exit
+await stream.flush();
 ```
 
-### Acknowledgements
+For TypeScript projects with explicit typing:
+
+```typescript
+import { createStream, PinoSeqStreamConfig } from 'pino-seq';
+
+const config: PinoSeqStreamConfig = {
+  serverUrl: 'http://localhost:5341',
+  // ... see Configuration section below for all options
+};
+const stream = createStream(config);
+```
+
+## Configuration
+
+The `createStream()` function accepts a configuration object with the following properties:
+
+- `serverUrl` (string): The URL of your Seq server
+- `apiKey` (string, optional): API key for authentication
+- `logOtherAs` (string, optional): Log level for unstructured messages ('Verbose', 'Debug', 'Information', 'Warning', 'Error', 'Fatal')
+- `additionalProperties` (object, optional): Additional properties to add to all log events
+- `maxBatchingTime` (number, optional): Maximum time in milliseconds to wait before sending a batch
+- `eventSizeLimit` (number, optional): Maximum size of a single event
+- `batchSizeLimit` (number, optional): Maximum size of a batch
+- `onError` (function, optional): Error handler callback
+
+## Acknowledgements
 
 Originally by Simi Hartstein and published as `simihartstein/pino-seq`; maintainership transferred to Datalust at version 0.5.

.vscode/launch.json

@@ -1,12 +1,24 @@
-"use strict";
+// This example works in both JavaScript and TypeScript projects
+// For TypeScript: rename to .ts or use as-is (types will be inferred)
 
 import pino from 'pino';
-import pinoToSeq from '../index.js';
+import { createStream } from 'pino-seq';
 
-let stream = pinoToSeq.createStream({serverUrl: "http://localhost:5341"});
-let logger = pino({name: "pino-seq example"}, stream);
+// Create a stream to Seq
+const stream = createStream({ 
+  serverUrl: 'http://localhost:5341',
+  apiKey: 'your-api-key' // optional
+});
 
-logger.info("Hello Seq, from Pino");
+// Create a Pino logger
+const logger = pino({ name: 'pino-seq example' }, stream);
 
-let frLogger = logger.child({lang: "fr"});
-frLogger.warn("au reviour");
+// Log some messages
+logger.info('Hello Seq, from Pino');
+
+// Child loggers work too
+const frLogger = logger.child({ lang: 'fr' });
+frLogger.warn('au reviour');
+
+// Flush logs before exit
+await stream.flush();