@zuplo/cli 7.0.2 → 7.1.1

package/node_modules/pino/docs/api.md

@@ -22,6 +22,7 @@
   * [logger\[Symbol.for('pino.serializers')\]](#serializers)
   * [Event: 'level-change'](#level-change)
   * [logger.version](#version)
+  * [logger.msgPrefix](#msgPrefix)
 * [Statics](#statics)
   * [pino.destination()](#pino-destination)
   * [pino.transport()](#pino-transport)
@@ -36,6 +37,9 @@
   * [DestinationStream](#destinationstream)
 * [Types](#types)
   * [Level](#level-1)
+* [TypeScript](#typescript)
+  * [Module Augmentation](#module-augmentation)
+  * [LogFnFields Interface](#logfnfields-interface)
 
 <a id="export"></a>
 ## `pino([options], [destination]) => logger`
@@ -375,6 +379,23 @@ const hooks = {
 }
 ```
 
+
+<a id="streamWrite"></a>
+##### `streamWrite`
+
+Allows for manipulating the _stringified_ JSON log data just before writing to various transports.
+
+The method receives the stringified JSON and must return valid stringified JSON.
+
+For example:
+```js
+const hooks = {
+  streamWrite (s) {
+    return s.replaceAll('sensitive-api-key', 'XXX')
+  }
+}
+```
+
 <a id=opt-formatters></a>
 #### `formatters` (Object)
 
@@ -467,7 +488,7 @@ child.info('User authenticated!')
 <a id=opt-base></a>
 #### `base` (Object)
 
-Default: `{pid: process.pid, hostname: os.hostname}`
+Default: `{pid: process.pid, hostname: os.hostname()}`
 
 Key-value object added as child logger to each log line.
 
@@ -739,7 +760,7 @@ from `msg` to another string as preferred.
 The `message` string may contain a printf style string with support for
 the following placeholders:
 
-* `%s` – string placeholder
+* `%s` – string placeholder, every non-string value passed in will have `.toString()` called.
 * `%d` – digit placeholder
 * `%O`, `%o`, and `%j` – object placeholder
 
@@ -926,6 +947,7 @@ const child = logger.child({foo: 'bar'}, {level: 'debug'})
 child.debug('debug!') // will log as the `level` property set the level to debug
 ```
 
+<a id="options-msgPrefix"></a>
 ##### `options.msgPrefix` (String)
 
 Default: `undefined`
@@ -1157,6 +1179,13 @@ Exposes the Pino package version. Also available on the exported `pino` function
 
 * See [`pino.version`](#pino-version)
 
+<a id="msgPrefix"></a>
+### `logger.msgPrefix` (String|Undefined)
+
+Exposes the cumulative `msgPrefix` of the logger.
+
+* See [`options.msgPrefix`](#options-msgPrefix)
+
 ## Statics
 
 <a id="pino-destination"></a>
@@ -1290,6 +1319,9 @@ module.exports = function build () {
 }
 ```
 
+Note that _any `'error'`_ event emitted by the transport must be considered a fatal error and the process must be terminated.
+Error events are not recoverable.
+
 For more on transports, how they work, and how to create them see the [`Transports documentation`](/docs/transports.md).
 
 * See [`Transports`](/docs/transports.md)
@@ -1300,10 +1332,15 @@ For more on transports, how they work, and how to create them see the [`Transpor
 * `target`:  The transport to pass logs through. This may be an installed module name or an absolute path.
 * `options`:  An options object which is serialized (see [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)), passed to the worker thread, parsed and then passed to the exported transport function.
 * `worker`: [Worker thread](https://nodejs.org/api/worker_threads.html#worker_threads_new_worker_filename_options) configuration options. Additionally, the `worker` option supports `worker.autoEnd`. If this is set to `false` logs will not be flushed on process exit. It is then up to the developer to call `transport.end()` to flush logs.
-* `targets`: May be specified instead of `target`. Must be an array of transport configurations and/or pipelines. Transport configurations include the aforementioned `options` and `target` options plus a `level` option which will send only logs above a specified level to a transport.
+* `targets`: May be specified instead of `target`. Must be an array of transport configurations and/or pipelines. Transport configurations include the aforementioned `options` and `target` options plus a `level` option which will send only logs above a specified level to that transport. If `level` is omitted, it defaults to `info`.
 * `pipeline`: May be specified instead of `target`. Must be an array of transport configurations. Transport configurations include the aforementioned `options` and `target` options. All intermediate steps in the pipeline _must_ be `Transform` streams and not `Writable`.
 * `dedupe`: See [pino.multistream options](#pino-multistream)
 
+Notes:
+- The top-level `level` in `pino.transport({ ... })` is not used for filtering.
+- With a single `target` (or a single `pipeline`), filtering is controlled by `logger.level`.
+- Per-transport level filtering is applied when using `targets` (multi-destination mode).
+
 <a id="pino-multistream"></a>
 
 ### `pino.multistream(streamsArray, opts) => MultiStreamRes`
@@ -1394,6 +1431,7 @@ The `pino.stdTimeFunctions` object provides a very small set of common functions
 * `pino.stdTimeFunctions.unixTime`: Seconds since Unix epoch
 * `pino.stdTimeFunctions.nullTime`: Clears timestamp property (Used when `timestamp: false`)
 * `pino.stdTimeFunctions.isoTime`: ISO 8601-formatted time in UTC
+* `pino.stdTimeFunctions.isoTimeNano`: RFC 3339-formatted time in UTC with nanosecond precision
 
 * See [`timestamp` option](#opt-timestamp)
 
@@ -1432,14 +1470,24 @@ Exposes the Pino package version. Also available on the logger instance.
     - Returns: [MultiStreamRes](#multistreamres)
 
  Add `dest` stream to the array of streams of the current instance.
- * `flushSync()`
-   - Returns: `undefined`
+ *  `flushSync()`
+    - Returns: `undefined`
 
  Call `flushSync` on each stream held by the current instance.
+
+ * `lastId`
+   - number
+
+ The ID assigned to the last stream assigned to the current instance.
  * `minLevel`
    - number
 
  The minimum level amongst all the streams held by the current instance.
+
+ * `remove(id)`
+   - `id` [number]
+
+ Removes a stream from the array of streams of the current instance using its assigned ID.
  * `streams`
     - Returns: [StreamEntry[]](#streamentry)
 
@@ -1468,3 +1516,78 @@ Exposes the Pino package version. Also available on the logger instance.
 ### `Level`
 
   * Values: `"fatal"` | `"error"` | `"warn"` | `"info"` | `"debug"` | `"trace"`
+
+## TypeScript
+
+### Module Augmentation
+
+Pino supports TypeScript module augmentation to extend its type definitions. This allows you to customize the logging behavior to fit your application's specific requirements.
+
+#### `LogFnFields` Interface
+
+The `LogFnFields` interface can be augmented to control what fields are allowed in logging method objects. This is particularly useful for:
+
+- Preventing certain fields from being logged (for security or compliance reasons)
+- Enforcing specific field types across your application
+- Enforcing consistent structured logging
+
+##### Banning Fields
+
+You can ban specific fields from being passed to logging methods by setting them to `never`. This helps prevent users from unintentionally overriding fields that are already set in the logger's `base` option, or clarifies that these fields are predefined.
+
+```typescript
+declare module "pino" {
+  interface LogFnFields {
+    service?: never;
+    version?: never;
+  }
+}
+
+
+// These will now cause TypeScript errors
+logger.info({ service: 'other-api', message: 'success' })   // ❌
+logger.info({ message: 'success' })     // ✅
+```
+
+##### Enforcing Field Types
+
+You can also enforce specific types for certain fields:
+
+```typescript
+declare module "pino" {
+  interface LogFnFields {
+    userId?: string;
+    requestId?: string;
+  }
+}
+
+// These will cause TypeScript errors
+logger.info({ userId: 123 })           // ❌ Error: userId must be string
+logger.info({ requestId: null })       // ❌ Error: requestId must be string
+
+// This works fine
+logger.info({ userId: '123' })     // ✅ Works fine
+```
+
+##### Enforcing Structured Logging
+
+Required fields (non-optional) enforce consistent structured logging by requiring specific fields in all log objects:
+
+```typescript
+declare module "pino" {
+  interface LogFnFields {
+    userId: string
+  }
+}
+
+logger.info({ userId: '123' }) // ✅ Works fine
+logger.info({}) // ❌ Property 'userId' is missing in type '{}'
+```
+
+**Note**: Required fields will cause TypeScript errors when logging certain types like `Error` objects that don't contain the required properties:
+
+```typescript
+logger.error(new Error('test')) // ❌ Property 'userId' is missing in type 'Error'
+```
+
+This ensures that all log entries include required context fields, promoting consistent logging practices.

package/node_modules/pino/docs/browser.md

@@ -27,6 +27,21 @@ pino.info('hi') // creates and logs {msg: 'hi', level: 30, time: <ts>}
 
 When `write` is set, `asObject` will always be `true`.
 
+### `asObjectBindingsOnly` (Boolean)
+
+```js
+const pino = require('pino')({browser: {asObjectBindingsOnly: true}})
+```
+
+The `asObjectBindingsOnly` option is similar to `asObject` but will keep the message
+and arguments unformatted. This allows to defer formatting the message to the
+actual call to `console` methods, where browsers then have richer formatting in
+their devtools than when pino will format the message to a string first.
+
+```js
+pino.info('hello %s', 'world') // creates and logs {level: 30, time: <ts>}, 'hello %s', 'world'
+```
+
 ### `formatters` (Object)
 
 An object containing functions for formatting the shape of the log lines. When provided, it enables the logger to produce a pino-like log object with customized formatting. Currently, it supports formatting for the `level` object only.
@@ -46,6 +61,42 @@ const formatters = {
 ```
 
 
+### `reportCaller` (Boolean)
+
+Attempts to capture and include the originating callsite (file:line:column) for each log call in the browser logger.
+
+- When used together with `asObject` (or when `formatters` are provided), the callsite is added as a `caller` string property on the emitted log object.
+- In the default mode (non‑object), the callsite string is appended as the last argument passed to the corresponding `console` method. This makes the location visible in the console output even though the console’s clickable header still points to Pino internals.
+
+```js
+// Object mode: adds `caller` to the log object
+const pino = require('pino')({
+  browser: {
+    asObject: true,
+    reportCaller: true
+  }
+})
+
+pino.info('hello')
+// -> { level: 30, msg: 'hello', time: <ts>, caller: '/path/to/file.js:10:15' }
+
+// Default mode: appends the caller string as the last console argument
+const pino2 = require('pino')({
+  browser: {
+    reportCaller: true
+  }
+})
+
+pino2.info('hello')
+// -> console receives: 'hello', '/path/to/file.js:10:15'
+```
+
+Notes:
+
+- This is a best‑effort feature that parses the JavaScript Error stack. Stack formats vary across engines.
+- The clickable link shown by devtools for a console message is determined by where `console.*` is invoked and cannot be changed by libraries; `reportCaller` surfaces the user callsite alongside the log message.
+
+
 ### `write` (Function | Object)
 
 Instead of passing log messages to `console.log` they can be passed to

package/node_modules/pino/docs/diagnostics.md

@@ -0,0 +1,16 @@
+# Diagnostics
+
+Pino provides [tracing channel](tc) events that allow insight into the
+internal workings of the library. The currently supported events are:
+
++ `tracing:pino_asJson:start`: emitted when the final serialization process
+  of logs is started. The emitted event payload has the following fields:
+  - `instance`: the Pino instance associated with the function
+  - `arguments`: the arguments passed to the function
++ `tracing:pino_asJson:end`: emitted at the end of the final serialization
+  process. The emitted event payload has the following fields:
+  - `instance`: the Pino instance associated with the function
+  - `arguments`: the arguments passed to the function
+  - `result`: the finalized, newline delimited, log line as a string
+
+[tc]: https://nodejs.org/docs/latest/api/diagnostics_channel.html#tracingchannel-channels

package/node_modules/pino/docs/ecosystem.md

@@ -16,10 +16,10 @@ Please send a PR to add new modules!
 Pino to log requests within [express](https://expressjs.com/).
 + [`koa-pino-logger`](https://github.com/pinojs/koa-pino-logger): use Pino to
 log requests within [Koa](https://koajs.com/).
-+ [`rill-pino-logger`](https://github.com/pinojs/rill-pino-logger): use Pino as
-the logger for the [Rill framework](https://rill.site/).
 + [`restify-pino-logger`](https://github.com/pinojs/restify-pino-logger): use
 Pino to log requests within [restify](http://restify.com/).
++ [`rill-pino-logger`](https://github.com/pinojs/rill-pino-logger): use Pino as
+the logger for the [Rill framework](https://rill.site/).
 
 ### Utilities
 + [`pino-arborsculpture`](https://github.com/pinojs/pino-arborsculpture): change
@@ -27,6 +27,7 @@ log levels at runtime.
 + [`pino-caller`](https://github.com/pinojs/pino-caller): add callsite to the log line.
 + [`pino-clf`](https://github.com/pinojs/pino-clf): reformat Pino logs into
 Common Log Format.
++ [`pino-console`](https://github.com/pinojs/pino-console): adapter for the [WHATWG Console](https://console.spec.whatwg.org/) spec. 
 + [`pino-debug`](https://github.com/pinojs/pino-debug): use Pino to interpret
 [`debug`](https://npm.im/debug) logs.
 + [`pino-elasticsearch`](https://github.com/pinojs/pino-elasticsearch): send
@@ -43,10 +44,10 @@ for [Hapi](https://hapijs.com/).
 requests with the core `http` module.
 + [`pino-http-print`](https://github.com/pinojs/pino-http-print): reformat Pino
 logs into traditional [HTTPD](https://httpd.apache.org/) style request logs.
-+ [`pino-multi-stream`](https://github.com/pinojs/pino-multi-stream): send
-logs to multiple destination streams (slow!).
 + [`pino-mongodb`](https://github.com/pinojs/pino-mongodb): store Pino logs
 in a MongoDB database.
++ [`pino-multi-stream`](https://github.com/pinojs/pino-multi-stream): send
+logs to multiple destination streams (slow!).
 + [`pino-noir`](https://github.com/pinojs/pino-noir): redact sensitive information
 in logs.
 + [`pino-pretty`](https://github.com/pinojs/pino-pretty): basic prettifier to
@@ -59,25 +60,27 @@ core object serializers used within Pino.
 to standard syslog format.
 + [`pino-tee`](https://github.com/pinojs/pino-tee): pipe Pino logs into files
 based upon log levels.
-+ [`pino-toke`](https://github.com/pinojs/pino-toke): reformat Pino logs
-according to a given format string.
 + [`pino-test`](https://github.com/pinojs/pino-test): a set of utilities for 
 verifying logs generated by the Pino logger.
++ [`pino-toke`](https://github.com/pinojs/pino-toke): reformat Pino logs
+according to a given format string.
 
 
 <a id="community"></a>
 ## Community
 
++ [`@google-cloud/pino-logging-gcp-config`](https://www.npmjs.com/package/@google-cloud/pino-logging-gcp-config): Config helper and formatter to output [Google Cloud Platform Structured Logging](https://cloud.google.com/logging/docs/structured-logging)
++ [`@newrelic/pino-enricher`](https://github.com/newrelic/newrelic-node-log-extensions/blob/main/packages/pino-log-enricher): a log customization to add New Relic context to use [Logs In Context](https://docs.newrelic.com/docs/logs/logs-context/logs-in-context/)
++ [`cloud-pine`](https://github.com/metcoder95/cloud-pine): transport that provides abstraction and compatibility with [`@google-cloud/logging`](https://www.npmjs.com/package/@google-cloud/logging).
++ [`cls-proxify`](https://github.com/keenondrums/cls-proxify): integration of pino and [CLS](https://github.com/jeff-lewis/cls-hooked). Useful for creating dynamically configured child loggers (e.g. with added trace ID) for each request.
++ [`crawlee-pino`](https://github.com/imyelo/crawlee-pino): use Pino to log within Crawlee
++ [`eslint-plugin-pino`](https://github.com/orzarchi/eslint-plugin-pino): linting rules for pino usage, primarly for preventing missing context in logs due to incorrect argument order.
 + [`pino-colada`](https://github.com/lrlna/pino-colada): cute ndjson formatter for pino.
++ [`pino-dev`](https://github.com/dnjstrom/pino-dev): simple prettifier for pino with built-in support for common ecosystem packages.
 + [`pino-fluentd`](https://github.com/davidedantonio/pino-fluentd): send Pino logs to Elasticsearch,
 MongoDB, and many [others](https://www.fluentd.org/dataoutputs) via Fluentd.
++ [`pino-lambda`](https://github.com/FormidableLabs/pino-lambda): log transport for cloudwatch support inside aws-lambda 
 + [`pino-pretty-min`](https://github.com/unjello/pino-pretty-min): a minimal
 prettifier inspired by the [logrus](https://github.com/sirupsen/logrus) logger.
 + [`pino-rotating-file`](https://github.com/homeaway/pino-rotating-file): a hapi-pino log transport for splitting logs into separate, automatically rotating files.
-+ [`cls-proxify`](https://github.com/keenondrums/cls-proxify): integration of pino and [CLS](https://github.com/jeff-lewis/cls-hooked). Useful for creating dynamically configured child loggers (e.g. with added trace ID) for each request.
 + [`pino-tiny`](https://github.com/holmok/pino-tiny): a tiny (and extensible?) little log formatter for pino.
-+ [`pino-dev`](https://github.com/dnjstrom/pino-dev): simple prettifier for pino with built-in support for common ecosystem packages.
-+ [`@newrelic/pino-enricher`](https://github.com/newrelic/newrelic-node-log-extensions/blob/main/packages/pino-log-enricher): a log customization to add New Relic context to use [Logs In Context](https://docs.newrelic.com/docs/logs/logs-context/logs-in-context/)
-+ [`pino-lambda`](https://github.com/FormidableLabs/pino-lambda): log transport for cloudwatch support inside aws-lambda 
-+ [`cloud-pine`](https://github.com/metcoder95/cloud-pine): transport that provides abstraction and compatibility with [`@google-cloud/logging`](https://www.npmjs.com/package/@google-cloud/logging).
-+ [`crawlee-pino`](https://github.com/imyelo/crawlee-pino): use Pino to log within Crawlee

package/node_modules/pino/docs/help.md

@@ -125,7 +125,7 @@ ExecStart=/bin/sh -c '/path/to/node app.js | pino-transport'
 
 Pino's default log destination is the singular destination of `stdout`. While
 not recommended for performance reasons, multiple destinations can be targeted
-by using [`pino.multistream`](/doc/api.md#pino-multistream).
+by using [`pino.multistream`](/docs/api.md#pino-multistream).
 
 In this example, we use `stderr` for `error` level logs and `stdout` as default
 for all other levels (e.g. `debug`, `info`, and `warn`).
@@ -260,6 +260,32 @@ module.exports = function createLogger(options) {
 }
 ```
 
+A library that configures Pino for
+[Google Cloud Structured Logging](https://cloud.google.com/logging/docs/structured-logging)
+is available at:
+[@google-cloud/pino-logging-gcp-config](https://www.npmjs.com/package/@google-cloud/pino-logging-gcp-config)
+
+This library has the following features:
+
++ Converts Pino log levels to Google Cloud Logging log levels, as above
++ Uses `message` instead of `msg` for the message key, as above
++ Adds a millisecond-granularity timestamp in the 
+  [structure](https://cloud.google.com/logging/docs/agent/logging/configuration#timestamp-processing)
+  recognised by Google Cloud Logging eg: \
+  `"timestamp":{"seconds":1445470140,"nanos":123000000}`
++ Adds a sequential
+  [`insertId`](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#FIELDS.insert_id)
+  to ensure log messages with identical timestamps are ordered correctly.
++ Logs including an `Error` object have the
+  [`stack_trace`](https://cloud.google.com/error-reporting/docs/formatting-error-messages#log-error)
+  property set so that the error is forwarded to Google Cloud Error Reporting.
++ Includes a
+  [`ServiceContext`](https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext)
+  object in the logs for Google Cloud Error Reporting, auto detected from the
+  environment if not specified
++ Maps the OpenTelemetry properties `span_id`, `trace_id`, and `trace_flags`
+  to the equivalent Google Cloud Logging fields.
+
 <a id="grafana-loki"></a>
 ## Using Grafana Loki to evaluate pino logs in a kubernetes cluster
 
@@ -316,4 +342,4 @@ if you have broader logging requirements.
 <a id="testing"></a>
 ## Testing
 
-See [`pino-test`](https://github.com/pinojs/pino-test).
+See [`pino-test`](https://github.com/pinojs/pino-test).