@ontrails/pino 1.0.0-beta.18 → 1.0.0-beta.19

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @ontrails/pino
 
+## 1.0.0-beta.19
+
+### Patch Changes
+
+- ed5926b: Add missing TSDoc for public adapter and sink boundary types.
+- Updated dependencies [1eb5bdc]
+  - @ontrails/observe@1.0.0-beta.19
+
 ## 1.0.0-beta.18
 
 ### Minor Changes

package/README.md

@@ -8,13 +8,11 @@ Pino adapter package for `@ontrails/observe`.
 bun add @ontrails/observe @ontrails/pino pino
 ```
 
-`pino` is supplied by your application. `@ontrails/pino` has no hard runtime
-dependency on it.
+`pino` is supplied by your application. `@ontrails/pino` has no hard runtime dependency on it.
 
 ## Usage
 
-Use `createPinoSink(...)` when you already have a Pino-shaped logger and want
-Trails log records to flow into it:
+Use `createPinoSink(...)` when you already have a Pino-shaped logger and want Trails log records to flow into it:
 
 ```typescript
 import pino from 'pino';
@@ -23,10 +21,7 @@ import { createPinoSink } from '@ontrails/pino';
 const sink = createPinoSink(pino());
 ```
 
-The package does not depend on `pino`; it accepts any object shaped like a Pino
-logger through `PinoLoggerLike`. Records are forwarded in Pino's object-first
-style as `logger.info(payload, message)`, preserving the metadata already
-redacted by Trails.
+The package does not depend on `pino`; it accepts any object shaped like a Pino logger through `PinoLoggerLike`. Records are forwarded in Pino's object-first style as `logger.info(payload, message)`, preserving the metadata already redacted by Trails.
 
 ```typescript
 import pino from 'pino';
@@ -44,15 +39,13 @@ const graph = topo('app', trails, {
 
 ## Structural Logger Shape
 
-`PinoLoggerLike` requires `trace`, `debug`, `info`, `warn`, `error`, and
-`fatal` methods that accept `(payload, message)`. The sink forwards:
+`PinoLoggerLike` requires `trace`, `debug`, `info`, `warn`, `error`, and `fatal` methods that accept `(payload, message)`. The sink forwards:
 
 - `record.message` as the Pino message argument.
 - `record.category`, `record.timestamp`, and `record.metadata` in the payload.
 - `silent` records as no-ops.
 
-If a required method is missing at runtime, the sink throws instead of silently
-dropping the record.
+If a required method is missing at runtime, the sink throws instead of silently dropping the record.
 
 ## Publishing
 
@@ -63,9 +56,7 @@ bun run publish:check
 bun run publish:registry-check
 ```
 
-`publish:registry-check` is read-only. Before the first registry publication it
-may report `@ontrails/pino` as a first-time package candidate. Actual package
-publication still goes through the repo script:
+`publish:registry-check` is read-only. Before the first registry publication it may report `@ontrails/pino` as a first-time package candidate. Actual package publication still goes through the repo script:
 
 ```bash
 bun run publish:packages

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ontrails/pino",
-  "version": "1.0.0-beta.18",
+  "version": "1.0.0-beta.19",
   "files": [
     "src/**/*.ts",
     "!src/**/__tests__/**",
@@ -22,6 +22,6 @@
     "clean": "rm -rf dist *.tsbuildinfo"
   },
   "peerDependencies": {
-    "@ontrails/observe": "^1.0.0-beta.17"
+    "@ontrails/observe": "^1.0.0-beta.19"
   }
 }

package/src/index.ts

@@ -5,6 +5,9 @@ import type { LogLevel, LogRecord, LogSink } from '@ontrails/observe';
  */
 export const pinoPackageName = '@ontrails/pino';
 
+/**
+ * Signature for a Pino-compatible logger method used when forwarding Trails records.
+ */
 export type PinoLogMethod = (
   payload: Record<string, unknown>,
   message?: string