Add TypeScript types for Pino logger (#82)

Author: akselinurmio

loggers/pino/index.d.ts

@@ -0,0 +1,32 @@
+import type { LoggerOptions } from "pino";
+
+interface Config {
+  /**
+   * Whether to convert a logged `err` field to ECS error fields.
+   * Default true, to match Pino's default of having an `err` serializer.
+   */
+  convertErr?: boolean;
+  /**
+   * Whether to convert logged `req` and `res` HTTP request and response fields
+   * to ECS HTTP, User agent, and URL fields. Default false.
+   */
+  convertReqRes?: boolean;
+  /**
+   * Whether to automatically integrate with
+   * Elastic APM (https://github.com/elastic/apm-agent-nodejs). If a started
+   * APM agent is detected, then log records will include the following
+   * fields:
+   *
+   * - "service.name" - the configured serviceName in the agent
+   * - "event.dataset" - set to "$serviceName.log" for correlation in Kibana
+   * - "trace.id", "transaction.id", and "span.id" - if there is a current
+   *   active trace when the log call is made
+   *
+   * Default true.
+   */
+  apmIntegration?: boolean;
+}
+
+declare function createEcsPinoOptions(config?: Config): LoggerOptions;
+
+export = createEcsPinoOptions;

loggers/pino/package.json

@@ -6,6 +6,7 @@
   "files": [
     "index.js"
   ],
+  "types": "index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/elastic/ecs-logging-nodejs.git"
@@ -37,6 +38,7 @@
     "@elastic/ecs-helpers": "^1.1.0"
   },
   "devDependencies": {
+    "@types/pino": "^6.3.9",
     "ajv": "^7.0.3",
     "ajv-formats": "^1.5.1",
     "elastic-apm-node": "^3.14.0",