jsonspecific 0.0.1-security → 3.14.7

package/docs/web.md

@@ -0,0 +1,269 @@
+# Web Frameworks
+
+Since HTTP logging is a primary use case, Pino has first-class support for the Node.js
+web framework ecosystem.
+
+- [Web Frameworks](#web-frameworks)
+  - [Pino with Fastify](#pino-with-fastify)
+  - [Pino with Express](#pino-with-express)
+  - [Pino with Hapi](#pino-with-hapi)
+  - [Pino with Restify](#pino-with-restify)
+  - [Pino with Koa](#pino-with-koa)
+  - [Pino with Node core `http`](#pino-with-node-core-http)
+  - [Pino with Nest](#pino-with-nest)
+  - [Pino with H3](#pino-with-h3)
+
+<a id="fastify"></a>
+## Pino with Fastify
+
+The Fastify web framework comes bundled with Pino by default, simply set Fastify's
+`logger` option to `true` and use `request.log` or `reply.log` for log messages that correspond
+to each request:
+
+```js
+const fastify = require('fastify')({
+  logger: true
+})
+
+fastify.get('/', async (request, reply) => {
+  request.log.info('something')
+  return { hello: 'world' }
+})
+
+fastify.listen({ port: 3000 }, (err) => {
+  if (err) {
+    fastify.log.error(err)
+    process.exit(1)
+  }
+})
+```
+
+The `logger` option can also be set to an object, which will be passed through directly
+as the [`pino` options object](/docs/api.md#options-object).
+
+See the [fastify documentation](https://www.fastify.io/docs/latest/Reference/Logging/) for more information.
+
+<a id="express"></a>
+## Pino with Express
+
+```sh
+npm install pino-http
+```
+
+```js
+const app = require('express')()
+const pino = require('pino-http')()
+
+app.use(pino)
+
+app.get('/', function (req, res) {
+  req.log.info('something')
+  res.send('hello world')
+})
+
+app.listen(3000)
+```
+
+See the [pino-http README](https://npm.im/pino-http) for more info.
+
+<a id="hapi"></a>
+## Pino with Hapi
+
+```sh
+npm install hapi-pino
+```
+
+```js
+'use strict'
+
+const Hapi = require('@hapi/hapi')
+const Pino = require('hapi-pino');
+
+async function start () {
+  // Create a server with a host and port
+  const server = Hapi.server({
+    host: 'localhost',
+    port: 3000
+  })
+
+  // Add the route
+  server.route({
+    method: 'GET',
+    path: '/',
+    handler: async function (request, h) {
+      // request.log is HAPI's standard way of logging
+      request.log(['a', 'b'], 'Request into hello world')
+
+      // a pino instance can also be used, which will be faster
+      request.logger.info('In handler %s', request.path)
+
+      return 'hello world'
+    }
+  })
+
+  await server.register(Pino)
+
+  // also as a decorated API
+  server.logger.info('another way for accessing it')
+
+  // and through Hapi standard logging system
+  server.log(['subsystem'], 'third way for accessing it')
+
+  await server.start()
+
+  return server
+}
+
+start().catch((err) => {
+  console.log(err)
+  process.exit(1)
+})
+```
+
+See the [hapi-pino README](https://npm.im/hapi-pino) for more info.
+
+<a id="restify"></a>
+## Pino with Restify
+
+```sh
+npm install restify-pino-logger
+```
+
+```js
+const server = require('restify').createServer({name: 'server'})
+const pino = require('restify-pino-logger')()
+
+server.use(pino)
+
+server.get('/', function (req, res) {
+  req.log.info('something')
+  res.send('hello world')
+})
+
+server.listen(3000)
+```
+
+See the [restify-pino-logger README](https://npm.im/restify-pino-logger) for more info.
+
+<a id="koa"></a>
+## Pino with Koa
+
+```sh
+npm install koa-pino-logger
+```
+
+```js
+const Koa = require('koa')
+const app = new Koa()
+const pino = require('koa-pino-logger')()
+
+app.use(pino)
+
+app.use((ctx) => {
+  ctx.log.info('something else')
+  ctx.body = 'hello world'
+})
+
+app.listen(3000)
+```
+
+See the [koa-pino-logger README](https://github.com/pinojs/koa-pino-logger) for more info.
+
+<a id="http"></a>
+## Pino with Node core `http`
+
+```sh
+npm install pino-http
+```
+
+```js
+const http = require('http')
+const server = http.createServer(handle)
+const logger = require('pino-http')()
+
+function handle (req, res) {
+  logger(req, res)
+  req.log.info('something else')
+  res.end('hello world')
+}
+
+server.listen(3000)
+```
+
+See the [pino-http README](https://npm.im/pino-http) for more info.
+
+
+<a id="nest"></a>
+## Pino with Nest
+
+```sh
+npm install nestjs-pino
+```
+
+```ts
+import { NestFactory } from '@nestjs/core'
+import { Controller, Get, Module } from '@nestjs/common'
+import { LoggerModule, Logger } from 'nestjs-pino'
+
+@Controller()
+export class AppController {
+  constructor(private readonly logger: Logger) {}
+
+  @Get()
+  getHello() {
+    this.logger.log('something')
+    return `Hello world`
+  }
+}
+
+@Module({
+  controllers: [AppController],
+  imports: [LoggerModule.forRoot()]
+})
+class MyModule {}
+
+async function bootstrap() {
+  const app = await NestFactory.create(MyModule)
+  await app.listen(3000)
+}
+bootstrap()
+```
+
+See the [nestjs-pino README](https://npm.im/nestjs-pino) for more info.
+
+
+<a id="h3"></a>
+## Pino with H3
+
+```sh
+npm install pino-http h3
+```
+
+Save as `server.mjs`:
+
+```js
+import { createApp, createRouter, eventHandler, fromNodeMiddleware } from "h3";
+import pino from 'pino-http'
+
+export const app = createApp();
+
+const router = createRouter();
+app.use(router);
+app.use(fromNodeMiddleware(pino()))
+
+app.use(eventHandler((event) => {
+  event.node.req.log.info('something')
+  return 'hello world'
+}))
+
+router.get(
+  "/",
+  eventHandler((event) => {
+    return { path: event.path, message: "Hello World!" };
+  }),
+);
+```
+
+Execute `npx --yes listhen -w --open ./server.mjs`.
+
+See the [pino-http README](https://npm.im/pino-http) for more info.

package/docsify/sidebar.md

@@ -0,0 +1,26 @@
+* [Readme](/)
+* [API](/docs/api.md)
+* [Browser API](/docs/browser.md)
+* [Redaction](/docs/redaction.md)
+* [Child Loggers](/docs/child-loggers.md)
+* [Transports](/docs/transports.md)
+* [Web Frameworks](/docs/web.md)
+* [Pretty Printing](/docs/pretty.md)
+* [Asynchronous Logging](/docs/asynchronous.md)
+* [Ecosystem](/docs/ecosystem.md)
+* [Benchmarks](/docs/benchmarks.md)
+* [Long Term Support](/docs/lts.md)
+* [Help](/docs/help.md)
+  * [Log rotation](/docs/help.md#rotate)
+  * [Reopening log files](/docs/help.md#reopening)
+  * [Saving to multiple files](/docs/help.md#multiple)
+  * [Log filtering](/docs/help.md#filter-logs)
+  * [Transports and systemd](/docs/help.md#transport-systemd)
+  * [Duplicate keys](/docs/help.md#dupe-keys)
+  * [Log levels as labels instead of numbers](/docs/help.md#level-string)
+  * [Pino with `debug`](/docs/help.md#debug)
+  * [Unicode and Windows terminal](/docs/help.md#windows)
+  * [Mapping Pino Log Levels to Google Cloud Logging (Stackdriver) Severity Levels](/docs/help.md#stackdriver)
+  * [Avoid Message Conflict](/docs/help.md#avoid-message-conflict)
+  * [Best performance for logging to `stdout`](/docs/help.md#best-performance-for-stdout)
+  * [Testing](/docs/help.md#testing)

package/examples/basic.js

@@ -0,0 +1,43 @@
+'use strict'
+
+// Pino's primary usage writes ndjson to `stdout`:
+const pino = require('..')()
+
+// However, if "human readable" output is desired,
+// `pino-pretty` can be provided as the destination
+// stream by uncommenting the following line in place
+// of the previous declaration:
+// const pino = require('..')(require('pino-pretty')())
+
+pino.info('hello world')
+pino.error('this is at error level')
+pino.info('the answer is %d', 42)
+pino.info({ obj: 42 }, 'hello world')
+pino.info({ obj: 42, b: 2 }, 'hello world')
+pino.info({ nested: { obj: 42 } }, 'nested')
+setImmediate(() => {
+  pino.info('after setImmediate')
+})
+pino.error(new Error('an error'))
+
+const child = pino.child({ a: 'property' })
+child.info('hello child!')
+
+const childsChild = child.child({ another: 'property' })
+childsChild.info('hello baby..')
+
+pino.debug('this should be mute')
+
+pino.level = 'trace'
+
+pino.debug('this is a debug statement')
+
+pino.child({ another: 'property' }).debug('this is a debug statement via child')
+pino.trace('this is a trace statement')
+
+pino.debug('this is a "debug" statement with "')
+
+pino.info(new Error('kaboom'))
+pino.info(null)
+
+pino.info(new Error('kaboom'), 'with', 'a', 'message')

package/examples/transport.js

@@ -0,0 +1,68 @@
+'use strict'
+
+const pino = require('..')
+const { tmpdir } = require('node:os')
+const { join } = require('node:path')
+
+const file = join(tmpdir(), `pino-${process.pid}-example`)
+
+const transport = pino.transport({
+  targets: [{
+    level: 'warn',
+    target: 'pino/file',
+    options: {
+      destination: file
+    }
+    /*
+  }, {
+    level: 'info',
+    target: 'pino-elasticsearch',
+    options: {
+      node: 'http://localhost:9200'
+    }
+    */
+  }, {
+    level: 'info',
+    target: 'pino-pretty'
+  }]
+})
+
+const logger = pino(transport)
+
+logger.info({
+  file
+}, 'logging destination')
+
+logger.info('hello world')
+logger.error('this is at error level')
+logger.info('the answer is %d', 42)
+logger.info({ obj: 42 }, 'hello world')
+logger.info({ obj: 42, b: 2 }, 'hello world')
+logger.info({ nested: { obj: 42 } }, 'nested')
+logger.warn('WARNING!')
+setImmediate(() => {
+  logger.info('after setImmediate')
+})
+logger.error(new Error('an error'))
+
+const child = logger.child({ a: 'property' })
+child.info('hello child!')
+
+const childsChild = child.child({ another: 'property' })
+childsChild.info('hello baby..')
+
+logger.debug('this should be mute')
+
+logger.level = 'trace'
+
+logger.debug('this is a debug statement')
+
+logger.child({ another: 'property' }).debug('this is a debug statement via child')
+logger.trace('this is a trace statement')
+
+logger.debug('this is a "debug" statement with "')
+
+logger.info(new Error('kaboom'))
+logger.info(null)
+
+logger.info(new Error('kaboom'), 'with', 'a', 'message')

package/file.js

@@ -0,0 +1,12 @@
+'use strict'
+
+const pino = require('./pino')
+const { once } = require('node:events')
+
+module.exports = async function (opts = {}) {
+  const destOpts = Object.assign({}, opts, { dest: opts.destination || 1, sync: false })
+  delete destOpts.destination
+  const destination = pino.destination(destOpts)
+  await once(destination, 'ready')
+  return destination
+}

package/inc-version.sh

@@ -0,0 +1,42 @@
+#!/bin/bash 
+
+set -e
+
+PATH=./node_modules/.bin:${PATH}
+CURRENT_VERSION=$(jq -r .version package.json)
+
+case ${1} in
+  Major | MAJOR | major)
+    LEVEL=major
+    ;;
+
+  Minor | MINOR | minor)
+    LEVEL=minor
+    ;;
+
+  Patch | PATCH | patch)
+    LEVEL=patch
+    ;;
+
+  *)
+    LEVEL=patch
+    ;;
+esac
+
+NEW_VERSION=$(semver -i ${LEVEL} ${CURRENT_VERSION})
+echo "${CURRENT_VERSION} => ${NEW_VERSION}"
+read -n 1 -s -r -p "Press any key to continue (ctrl+c to abort)..."
+echo ""
+
+echo "Patching package.json..."
+cat package.json | \
+  jq --arg vers "${NEW_VERSION}" '.version = $vers' | \
+  tee package.json 1>/dev/null
+
+echo "Patching lib/meta.js ..."
+SED_SCRIPT=$(printf 's/%s/%s/' ${CURRENT_VERSION//\./\\.} ${NEW_VERSION//\./\\.})
+cat ./lib/meta.js | \
+  sed -e ${SED_SCRIPT} | \
+  tee ./lib/meta.js 1>/dev/null
+
+echo "Done."

package/index.html

@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Pino - Super fast, all natural JSON logger for Node.js</title>
+  <meta name="description" content="Super fast, all natural JSON logger for Node.js">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify-themeable/dist/css/theme-simple.css">
+  <style>
+    :root {
+      --base-font-size: 16px;
+      --theme-color: rgb(104, 118, 52);
+      --link-color:  rgb(104, 118, 52);
+      --link-color--hover: rgb(137, 152, 100);
+      --sidebar-name-margin: 0;
+      --sidebar-name-padding: 0;
+      --code-font-size: .9em;
+    }
+    .sidebar > h1 {
+      margin-bottom: -.75em;
+      margin-top: .75em;
+    }
+    .sidebar > h1 img {
+      height: 4em;
+    }
+    .markdown-section a code {
+      color: var(--link-color)!important;
+    }
+    .markdown-section code:not([class*="lang-"]):not([class*="language-"]) {
+      white-space: unset
+    }
+  </style>
+  <link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
+  <link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
+</head>
+<body>
+  <div id="app"></div>
+</body>
+<script>
+  window.$docsify = {
+    name: 'pino',
+    logo: './pino-tree.png',
+    loadSidebar: 'docsify/sidebar.md',
+    repo: 'https://github.com/pinojs/pino',
+    auto2top: true,
+    ga: 'UA-103155139-1'
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>
+<!-- To enable syntax highlighting on TypeScript codes: -->
+<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-typescript.min.js"></script>
+
+</html>

package/lib/caller.js

@@ -0,0 +1,30 @@
+'use strict'
+
+function noOpPrepareStackTrace (_, stack) {
+  return stack
+}
+
+module.exports = function getCallers () {
+  const originalPrepare = Error.prepareStackTrace
+  Error.prepareStackTrace = noOpPrepareStackTrace
+  const stack = new Error().stack
+  Error.prepareStackTrace = originalPrepare
+
+  if (!Array.isArray(stack)) {
+    return undefined
+  }
+
+  const entries = stack.slice(2)
+
+  const fileNames = []
+
+  for (const entry of entries) {
+    if (!entry) {
+      continue
+    }
+
+    fileNames.push(entry.getFileName())
+  }
+
+  return fileNames
+}

package/lib/constants.js

@@ -0,0 +1,28 @@
+/**
+ * Represents default log level values
+ *
+ * @enum {number}
+ */
+const DEFAULT_LEVELS = {
+  trace: 10,
+  debug: 20,
+  info: 30,
+  warn: 40,
+  error: 50,
+  fatal: 60
+}
+
+/**
+ * Represents sort order direction: `ascending` or `descending`
+ *
+ * @enum {string}
+ */
+const SORTING_ORDER = {
+  ASC: 'ASC',
+  DESC: 'DESC'
+}
+
+module.exports = {
+  DEFAULT_LEVELS,
+  SORTING_ORDER
+}

package/lib/deprecations.js

@@ -0,0 +1,8 @@
+'use strict'
+
+const warning = require('process-warning')()
+module.exports = warning
+
+// const warnName = 'PinoWarning'
+
+// warning.create(warnName, 'PINODEP010', 'A new deprecation')