@voiceflow/logger 1.0.0 → 1.0.1

package/README.md

@@ -1,2 +1,26 @@
+[![circle ci](https://circleci.com/gh/voiceflow/logger.svg?style=shield&circle-token=8c4e4ce8d04d87f16e903bd7e1ccab194a118262)](https://circleci.com/gh/voiceflow/logger)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=voiceflow_logger&metric=coverage)](https://sonarcloud.io/dashboard?id=voiceflow_logger)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=voiceflow_logger&metric=alert_status)](https://sonarcloud.io/dashboard?id=voiceflow_logger)
+
 # logger
-Logging package for unified logging features
+
+A standardized package for logging built on `pino`.
+
+## Usage
+
+```ts
+import { createLogger, LogLevel, LogFormat } from '@voiceflow/logger';
+
+const logger = createLogger({ format: LogFormat.JSON, level: LogLevel.INFO });
+
+const inlineLogger = createLogger({ format: LogFormat.INLINE, level: LogLevel.WARN });
+
+const detailedLogger = createLogger({ format: LogFormat.DETAILED, level: LogLevel.TRACE });
+
+logger.trace('this is a trace log');
+logger.debug('this is a debug log');
+logger.info('this is an info log');
+logger.warn('this is a warning log');
+logger.error('this is an error log');
+logger.fatal('this is a fatal log');
+```

package/build/detailed.logger.d.ts

@@ -0,0 +1,4 @@
+import pino from 'pino';
+import { LogLevel } from './log-level.enum';
+export declare const createDetailedConfig: (level: LogLevel) => pino.LoggerOptions;
+export declare const createDetailedLogger: (level: LogLevel) => import("pino").Logger<never>;

package/build/detailed.logger.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDetailedLogger = exports.createDetailedConfig = void 0;
+const pino_1 = __importDefault(require("pino"));
+const maximal_1 = require("./serializers/maximal");
+const createDetailedConfig = (level) => ({
+    level,
+    transport: { target: 'pino-pretty' },
+    serializers: maximal_1.MaximalSerializer,
+});
+exports.createDetailedConfig = createDetailedConfig;
+const createDetailedLogger = (level) => (0, pino_1.default)((0, exports.createDetailedConfig)(level));
+exports.createDetailedLogger = createDetailedLogger;
+//# sourceMappingURL=detailed.logger.js.map

package/build/detailed.logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detailed.logger.js","sourceRoot":"","sources":["../src/detailed.logger.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAGxB,mDAA0D;AAEnD,MAAM,oBAAoB,GAAG,CAAC,KAAe,EAAsB,EAAE,CAAC,CAAC;IAC5E,KAAK;IACL,SAAS,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE;IACpC,WAAW,EAAE,2BAAiB;CAC/B,CAAC,CAAC;AAJU,QAAA,oBAAoB,wBAI9B;AAEI,MAAM,oBAAoB,GAAG,CAAC,KAAe,EAAE,EAAE,CAAC,IAAA,cAAI,EAAC,IAAA,4BAAoB,EAAC,KAAK,CAAC,CAAC,CAAC;AAA9E,QAAA,oBAAoB,wBAA0D"}

package/build/http.logger.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node/http" />
+import { Options } from 'pino-http';
+import { LoggerOptions } from './logger-options.interface';
+export declare const createHTTPConfig: ({ format, level }: LoggerOptions) => Options;
+export declare const createHTTPLogger: (options: LoggerOptions) => import("pino-http").HttpLogger<import("http").IncomingMessage, import("http").ServerResponse, never>;

package/build/http.logger.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHTTPLogger = exports.createHTTPConfig = void 0;
+/* eslint-disable sonarjs/no-nested-template-literals */
+const colorette_1 = require("colorette");
+const pino_http_1 = __importDefault(require("pino-http"));
+const ts_pattern_1 = require("ts-pattern");
+const detailed_logger_1 = require("./detailed.logger");
+const inline_logger_1 = require("./inline.logger");
+const json_logger_1 = require("./json.logger");
+const log_format_enum_1 = require("./log-format.enum");
+const log_level_enum_1 = require("./log-level.enum");
+const utils_1 = require("./utils");
+const createHTTPConfig = ({ format, level }) => (Object.assign({ customLogLevel: (_req, res) => {
+        if ((0, utils_1.isWarnResponse)(res))
+            return log_level_enum_1.LogLevel.WARN;
+        if ((0, utils_1.isErrorResponse)(res))
+            return log_level_enum_1.LogLevel.ERROR;
+        return log_level_enum_1.LogLevel.INFO;
+    }, wrapSerializers: true }, (0, ts_pattern_1.match)(format)
+    .with(log_format_enum_1.LogFormat.INLINE, () => (Object.assign({ customSuccessMessage: (req, res) => `${(0, utils_1.getColorizer)(res)(`(${res.statusCode})`)} ${(0, colorette_1.white)(`${req.method} ${req.url}`)} ${(0, colorette_1.gray)(`(${req.socket.remoteAddress}:${req.socket.remotePort})`)}`, customErrorMessage: (req, res) => {
+        var _a;
+        return `${(0, utils_1.getColorizer)(res)(`(${res.statusCode})`)} ${(0, colorette_1.white)(`${req.method} ${req.url} -`)} ${(0, colorette_1.gray)(`(${req.socket.remoteAddress}:${req.socket.remotePort})`)} ${(_a = res.err) === null || _a === void 0 ? void 0 : _a.message}`;
+    } }, (0, inline_logger_1.createInlineConfig)(level))))
+    .with(log_format_enum_1.LogFormat.DETAILED, () => (0, detailed_logger_1.createDetailedConfig)(level))
+    .otherwise(() => (0, json_logger_1.createJSONConfig)(level))));
+exports.createHTTPConfig = createHTTPConfig;
+const createHTTPLogger = (options) => (0, pino_http_1.default)((0, exports.createHTTPConfig)(options));
+exports.createHTTPLogger = createHTTPLogger;
+//# sourceMappingURL=http.logger.js.map

package/build/http.logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.logger.js","sourceRoot":"","sources":["../src/http.logger.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAwD;AACxD,yCAAwC;AACxC,0DAA8C;AAC9C,2CAAmC;AAEnC,uDAAyD;AACzD,mDAAqD;AACrD,+CAAiD;AACjD,uDAA8C;AAC9C,qDAA4C;AAE5C,mCAAwE;AAEjE,MAAM,gBAAgB,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,EAAiB,EAAW,EAAE,CAAC,iBAC7E,cAAc,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QAC5B,IAAI,IAAA,sBAAc,EAAC,GAAG,CAAC;YAAE,OAAO,yBAAQ,CAAC,IAAI,CAAC;QAC9C,IAAI,IAAA,uBAAe,EAAC,GAAG,CAAC;YAAE,OAAO,yBAAQ,CAAC,KAAK,CAAC;QAChD,OAAO,yBAAQ,CAAC,IAAI,CAAC;IACvB,CAAC,EACD,eAAe,EAAE,IAAI,IAElB,IAAA,kBAAK,EAAqB,MAAM,CAAC;KACjC,IAAI,CAAC,2BAAS,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,iBAC5B,oBAAoB,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CACjC,GAAG,IAAA,oBAAY,EAAC,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,UAAU,GAAG,CAAC,IAAI,IAAA,iBAAK,EAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,IAAA,gBAAI,EACtF,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa,IAAI,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,CACzD,EAAE,EACL,kBAAkB,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;;QAC/B,OAAA,GAAG,IAAA,oBAAY,EAAC,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,UAAU,GAAG,CAAC,IAAI,IAAA,iBAAK,EAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,IAAA,gBAAI,EACxF,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa,IAAI,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,CACzD,IAAI,MAAA,GAAG,CAAC,GAAG,0CAAE,OAAO,EAAE,CAAA;KAAA,IACtB,IAAA,kCAAkB,EAAC,KAAK,CAAC,EAC5B,CAAC;KACF,IAAI,CAAC,2BAAS,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,sCAAoB,EAAC,KAAK,CAAC,CAAC;KAC3D,SAAS,CAAC,GAAG,EAAE,CAAC,IAAA,8BAAgB,EAAC,KAAK,CAAC,CAAC,EAC3C,CAAC;AAtBU,QAAA,gBAAgB,oBAsB1B;AAEI,MAAM,gBAAgB,GAAG,CAAC,OAAsB,EAAE,EAAE,CAAC,IAAA,mBAAQ,EAAC,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC,CAAC;AAAnF,QAAA,gBAAgB,oBAAmE"}

package/build/inline.logger.d.ts

@@ -0,0 +1,4 @@
+import pino from 'pino';
+import { LogLevel } from './log-level.enum';
+export declare const createInlineConfig: (level: LogLevel) => pino.LoggerOptions;
+export declare const createInlineLogger: (level: LogLevel) => import("pino").Logger<never>;

package/build/inline.logger.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createInlineLogger = exports.createInlineConfig = void 0;
+const pino_1 = __importDefault(require("pino"));
+const minimal_1 = require("./serializers/minimal");
+const createInlineConfig = (level) => ({
+    level,
+    transport: {
+        target: 'pino-pretty',
+        options: { include: 'time,level' },
+    },
+    serializers: minimal_1.MinimalSerializer,
+});
+exports.createInlineConfig = createInlineConfig;
+const createInlineLogger = (level) => (0, pino_1.default)((0, exports.createInlineConfig)(level));
+exports.createInlineLogger = createInlineLogger;
+//# sourceMappingURL=inline.logger.js.map

package/build/inline.logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inline.logger.js","sourceRoot":"","sources":["../src/inline.logger.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAGxB,mDAA0D;AAEnD,MAAM,kBAAkB,GAAG,CAAC,KAAe,EAAsB,EAAE,CAAC,CAAC;IAC1E,KAAK;IACL,SAAS,EAAE;QACT,MAAM,EAAE,aAAa;QACrB,OAAO,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE;KACnC;IACD,WAAW,EAAE,2BAAiB;CAC/B,CAAC,CAAC;AAPU,QAAA,kBAAkB,sBAO5B;AAEI,MAAM,kBAAkB,GAAG,CAAC,KAAe,EAAE,EAAE,CAAC,IAAA,cAAI,EAAC,IAAA,0BAAkB,EAAC,KAAK,CAAC,CAAC,CAAC;AAA1E,QAAA,kBAAkB,sBAAwD"}

package/build/json.logger.d.ts

@@ -0,0 +1,4 @@
+import pino from 'pino';
+import { LogLevel } from './log-level.enum';
+export declare const createJSONConfig: (level: LogLevel) => pino.LoggerOptions;
+export declare const createJSONLogger: (level: LogLevel) => import("pino").Logger<never>;

package/build/json.logger.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createJSONLogger = exports.createJSONConfig = void 0;
+const pino_1 = __importDefault(require("pino"));
+const minimal_1 = require("./serializers/minimal");
+const createJSONConfig = (level) => ({
+    level,
+    serializers: minimal_1.MinimalSerializer,
+});
+exports.createJSONConfig = createJSONConfig;
+const createJSONLogger = (level) => (0, pino_1.default)((0, exports.createJSONConfig)(level));
+exports.createJSONLogger = createJSONLogger;
+//# sourceMappingURL=json.logger.js.map

package/build/json.logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.logger.js","sourceRoot":"","sources":["../src/json.logger.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAGxB,mDAA0D;AAEnD,MAAM,gBAAgB,GAAG,CAAC,KAAe,EAAsB,EAAE,CAAC,CAAC;IACxE,KAAK;IACL,WAAW,EAAE,2BAAiB;CAC/B,CAAC,CAAC;AAHU,QAAA,gBAAgB,oBAG1B;AAEI,MAAM,gBAAgB,GAAG,CAAC,KAAe,EAAE,EAAE,CAAC,IAAA,cAAI,EAAC,IAAA,wBAAgB,EAAC,KAAK,CAAC,CAAC,CAAC;AAAtE,QAAA,gBAAgB,oBAAsD"}

package/build/log-format.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum LogFormat {
+    DETAILED = "detailed",
+    INLINE = "inline",
+    JSON = "json"
+}

package/build/log-format.enum.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogFormat = void 0;
+var LogFormat;
+(function (LogFormat) {
+    LogFormat["DETAILED"] = "detailed";
+    LogFormat["INLINE"] = "inline";
+    LogFormat["JSON"] = "json";
+})(LogFormat = exports.LogFormat || (exports.LogFormat = {}));
+//# sourceMappingURL=log-format.enum.js.map

package/build/log-format.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-format.enum.js","sourceRoot":"","sources":["../src/log-format.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,0BAAa,CAAA;AACf,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB"}

package/build/log-level.enum.d.ts

@@ -0,0 +1,8 @@
+export declare enum LogLevel {
+    FATAL = "fatal",
+    ERROR = "error",
+    WARN = "warn",
+    INFO = "info",
+    DEBUG = "debug",
+    TRACE = "trace"
+}

package/build/log-level.enum.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["FATAL"] = "fatal";
+    LogLevel["ERROR"] = "error";
+    LogLevel["WARN"] = "warn";
+    LogLevel["INFO"] = "info";
+    LogLevel["DEBUG"] = "debug";
+    LogLevel["TRACE"] = "trace";
+})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
+//# sourceMappingURL=log-level.enum.js.map

package/build/log-level.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-level.enum.js","sourceRoot":"","sources":["../src/log-level.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,2BAAe,CAAA;AACjB,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB"}

package/build/logger-options.interface.d.ts

@@ -0,0 +1,6 @@
+import { LogFormat } from './log-format.enum';
+import { LogLevel } from './log-level.enum';
+export interface LoggerOptions {
+    level: LogLevel;
+    format: LogFormat;
+}

package/build/logger-options.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=logger-options.interface.js.map

package/build/logger-options.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger-options.interface.js","sourceRoot":"","sources":["../src/logger-options.interface.ts"],"names":[],"mappings":""}

package/build/logger.d.ts

@@ -0,0 +1,3 @@
+import { LoggerOptions } from './logger-options.interface';
+export declare const DEFAULT_OPTIONS: LoggerOptions;
+export declare const createLogger: (options?: Partial<LoggerOptions>) => import("pino").Logger<never>;

package/build/logger.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLogger = exports.DEFAULT_OPTIONS = void 0;
+const lodash_merge_1 = __importDefault(require("lodash.merge"));
+const detailed_logger_1 = require("./detailed.logger");
+const inline_logger_1 = require("./inline.logger");
+const json_logger_1 = require("./json.logger");
+const log_format_enum_1 = require("./log-format.enum");
+const log_level_enum_1 = require("./log-level.enum");
+exports.DEFAULT_OPTIONS = {
+    format: log_format_enum_1.LogFormat.JSON,
+    level: log_level_enum_1.LogLevel.INFO,
+};
+const createLogger = (options = {}) => {
+    const { format, level } = (0, lodash_merge_1.default)({}, exports.DEFAULT_OPTIONS, options);
+    switch (format) {
+        case log_format_enum_1.LogFormat.DETAILED:
+            return (0, detailed_logger_1.createDetailedLogger)(level);
+        case log_format_enum_1.LogFormat.INLINE:
+            return (0, inline_logger_1.createInlineLogger)(level);
+        case log_format_enum_1.LogFormat.JSON:
+        default:
+            return (0, json_logger_1.createJSONLogger)(level);
+    }
+};
+exports.createLogger = createLogger;
+//# sourceMappingURL=logger.js.map

package/build/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;;;;;AAAA,gEAAkC;AAElC,uDAAyD;AACzD,mDAAqD;AACrD,+CAAiD;AACjD,uDAA8C;AAC9C,qDAA4C;AAG/B,QAAA,eAAe,GAAkB;IAC5C,MAAM,EAAE,2BAAS,CAAC,IAAI;IACtB,KAAK,EAAE,yBAAQ,CAAC,IAAI;CACrB,CAAC;AAEK,MAAM,YAAY,GAAG,CAAC,UAAkC,EAAE,EAAE,EAAE;IACnE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAA,sBAAM,EAAC,EAAE,EAAE,uBAAe,EAAE,OAAO,CAAC,CAAC;IAE/D,QAAQ,MAAM,EAAE;QACd,KAAK,2BAAS,CAAC,QAAQ;YACrB,OAAO,IAAA,sCAAoB,EAAC,KAAK,CAAC,CAAC;QACrC,KAAK,2BAAS,CAAC,MAAM;YACnB,OAAO,IAAA,kCAAkB,EAAC,KAAK,CAAC,CAAC;QACnC,KAAK,2BAAS,CAAC,IAAI,CAAC;QACpB;YACE,OAAO,IAAA,8BAAgB,EAAC,KAAK,CAAC,CAAC;KAClC;AACH,CAAC,CAAC;AAZW,QAAA,YAAY,gBAYvB"}

package/build/main.d.ts

@@ -0,0 +1,9 @@
+export * from './detailed.logger';
+export * from './http.logger';
+export * from './inline.logger';
+export * from './json.logger';
+export * from './log-format.enum';
+export * from './log-level.enum';
+export * from './logger';
+export * from './logger-options.interface';
+export type { Logger } from 'pino';

package/build/main.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./detailed.logger"), exports);
+__exportStar(require("./http.logger"), exports);
+__exportStar(require("./inline.logger"), exports);
+__exportStar(require("./json.logger"), exports);
+__exportStar(require("./log-format.enum"), exports);
+__exportStar(require("./log-level.enum"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./logger-options.interface"), exports);
+//# sourceMappingURL=main.js.map

package/build/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,gDAA8B;AAC9B,kDAAgC;AAChC,gDAA8B;AAC9B,oDAAkC;AAClC,mDAAiC;AACjC,2CAAyB;AACzB,6DAA2C"}

package/build/serializers/maximal.d.ts

@@ -0,0 +1,24 @@
+import { SerializedError, SerializedRequest, SerializedResponse } from 'pino';
+export declare const MaximalSerializer: {
+    req: (req: SerializedRequest) => {
+        id: string | undefined;
+        method: string;
+        url: string;
+        query: Record<string, string>;
+        params: Record<string, string>;
+        headers: {
+            [k: string]: string;
+        };
+        remoteAddress: string;
+        remotePort: number;
+    };
+    res: (res: SerializedResponse) => {
+        statusCode: number;
+        headers: Record<string, string>;
+    };
+    err: (err: SerializedError) => {
+        type: string;
+        message: string;
+        stack: string;
+    };
+};

package/build/serializers/maximal.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaximalSerializer = void 0;
+exports.MaximalSerializer = {
+    req: (req) => ({
+        id: req.id,
+        method: req.method,
+        url: req.url,
+        query: req.query,
+        params: req.params,
+        headers: Object.fromEntries(Object.entries(req.headers).filter(([key]) => key === 'authorization')),
+        remoteAddress: req.remoteAddress,
+        remotePort: req.remotePort,
+    }),
+    res: (res) => ({
+        statusCode: res.statusCode,
+        headers: res.headers,
+    }),
+    err: (err) => ({
+        type: err.type,
+        message: err.message,
+        stack: err.stack,
+    }),
+};
+//# sourceMappingURL=maximal.js.map

package/build/serializers/maximal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maximal.js","sourceRoot":"","sources":["../../src/serializers/maximal.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAG;IAC/B,GAAG,EAAE,CAAC,GAAsB,EAAE,EAAE,CAAC,CAAC;QAChC,EAAE,EAAE,GAAG,CAAC,EAAE;QACV,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,GAAG,EAAE,GAAG,CAAC,GAAG;QACZ,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,eAAe,CAAC,CAAC;QACnG,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,UAAU,EAAE,GAAG,CAAC,UAAU;KAC3B,CAAC;IACF,GAAG,EAAE,CAAC,GAAuB,EAAE,EAAE,CAAC,CAAC;QACjC,UAAU,EAAE,GAAG,CAAC,UAAU;QAC1B,OAAO,EAAE,GAAG,CAAC,OAAO;KACrB,CAAC;IACF,GAAG,EAAE,CAAC,GAAoB,EAAE,EAAE,CAAC,CAAC;QAC9B,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,KAAK,EAAE,GAAG,CAAC,KAAK;KACjB,CAAC;CACH,CAAC"}

package/build/serializers/minimal.d.ts

@@ -0,0 +1,19 @@
+import { SerializedError, SerializedRequest, SerializedResponse } from 'pino';
+export declare const MinimalSerializer: {
+    req: (req: SerializedRequest) => {
+        method: string;
+        url: string;
+        query: Record<string, string>;
+        params: Record<string, string>;
+        remoteAddress: string;
+        remotePort: number;
+    };
+    res: (res: SerializedResponse) => {
+        statusCode: number;
+    };
+    err: (err: SerializedError) => {
+        type: string;
+        message: string;
+        stack: string;
+    };
+};

package/build/serializers/minimal.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MinimalSerializer = void 0;
+exports.MinimalSerializer = {
+    req: (req) => ({
+        method: req.method,
+        url: req.url,
+        query: req.query,
+        params: req.params,
+        remoteAddress: req.remoteAddress,
+        remotePort: req.remotePort,
+    }),
+    res: (res) => ({
+        statusCode: res.statusCode,
+    }),
+    err: (err) => ({
+        type: err.type,
+        message: err.message,
+        stack: err.stack,
+    }),
+};
+//# sourceMappingURL=minimal.js.map

package/build/serializers/minimal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"minimal.js","sourceRoot":"","sources":["../../src/serializers/minimal.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAG;IAC/B,GAAG,EAAE,CAAC,GAAsB,EAAE,EAAE,CAAC,CAAC;QAChC,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,GAAG,EAAE,GAAG,CAAC,GAAG;QACZ,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,UAAU,EAAE,GAAG,CAAC,UAAU;KAC3B,CAAC;IACF,GAAG,EAAE,CAAC,GAAuB,EAAE,EAAE,CAAC,CAAC;QACjC,UAAU,EAAE,GAAG,CAAC,UAAU;KAC3B,CAAC;IACF,GAAG,EAAE,CAAC,GAAoB,EAAE,EAAE,CAAC,CAAC;QAC9B,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,KAAK,EAAE,GAAG,CAAC,KAAK;KACjB,CAAC;CACH,CAAC"}

package/build/utils.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="colorette" />
+import { ServerResponse } from 'node:http';
+export declare const isWarnResponse: (res: ServerResponse) => boolean;
+export declare const isErrorResponse: (res: ServerResponse) => boolean | Error;
+export declare const getColorizer: (res: ServerResponse) => import("colorette").Color;

package/build/utils.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getColorizer = exports.isErrorResponse = exports.isWarnResponse = void 0;
+const colorette_1 = require("colorette");
+const isWarnResponse = (res) => res.statusCode >= 400 && res.statusCode <= 499;
+exports.isWarnResponse = isWarnResponse;
+const isErrorResponse = (res) => res.err || (res.statusCode >= 500 && res.statusCode <= 599);
+exports.isErrorResponse = isErrorResponse;
+const getColorizer = (res) => {
+    if ((0, exports.isWarnResponse)(res))
+        return colorette_1.yellow;
+    if ((0, exports.isErrorResponse)(res))
+        return colorette_1.red;
+    return colorette_1.green;
+};
+exports.getColorizer = getColorizer;
+//# sourceMappingURL=utils.js.map

package/build/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAEA,yCAA+C;AAExC,MAAM,cAAc,GAAG,CAAC,GAAmB,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC;AAAzF,QAAA,cAAc,kBAA2E;AAC/F,MAAM,eAAe,GAAG,CAAC,GAAmB,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC;AAAvG,QAAA,eAAe,mBAAwF;AAC7G,MAAM,YAAY,GAAG,CAAC,GAAmB,EAAE,EAAE;IAClD,IAAI,IAAA,sBAAc,EAAC,GAAG,CAAC;QAAE,OAAO,kBAAM,CAAC;IACvC,IAAI,IAAA,uBAAe,EAAC,GAAG,CAAC;QAAE,OAAO,eAAG,CAAC;IACrC,OAAO,iBAAK,CAAC;AACf,CAAC,CAAC;AAJW,QAAA,YAAY,gBAIvB"}

package/package.json

@@ -1,76 +1,79 @@
 {
   "name": "@voiceflow/logger",
   "description": "Common logger for Voiceflow backend microservices",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "Frank Gu <frank@voiceflow.com>",
+  "bugs": {
+    "url": "https://github.com/voiceflow/logger/issues"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
   "dependencies": {
-    "express-pino-logger": "^4.0.0",
-    "pino": "^5.14.0"
+    "colorette": "2.0.19",
+    "lodash.merge": "4.6.2",
+    "pino": "8.17.2",
+    "pino-http": "8.6.1",
+    "pino-pretty": "9.4.1",
+    "ts-pattern": "^4.0.5"
   },
   "devDependencies": {
-    "@commitlint/cli": "^8.0.0",
-    "@commitlint/config-conventional": "^8.0.0",
-    "@voiceflow/commitlint-config": "^1.0.1",
-    "@voiceflow/eslint-config": "^2.0.4",
-    "@voiceflow/git-branch-check": "^1.0.2",
-    "@voiceflow/prettier-config": "^1.0.4",
-    "chai": "^4.2.0",
-    "chai-as-promised": "^7.1.1",
-    "codacy-coverage": "^3.4.0",
-    "commitizen": "^3.1.1",
-    "cz-conventional-changelog": "2.1.0",
-    "eslint": "^6.0.1",
-    "fixpack": "^2.3.1",
-    "husky": "^3.0.0",
-    "jest": "^24.8.0",
-    "lint-staged": "^9.2.0",
-    "mocha": "^6.1.4",
-    "nyc": "^14.1.1",
-    "prettier": "^1.18.2",
-    "prettier-eslint-cli": "^5.0.0",
-    "prettier-stylelint": "^0.4.2",
-    "pretty-quick": "^1.11.1",
-    "semantic-release": "^15.13.18",
-    "sinon": "^7.3.2"
+    "@commitlint/cli": "17.1.2",
+    "@istanbuljs/nyc-config-typescript": "1.0.2",
+    "@types/chai": "4.3.3",
+    "@types/lodash.merge": "^4.6.7",
+    "@types/mocha": "9.1.1",
+    "@voiceflow/commitlint-config": "2.0.0",
+    "@voiceflow/eslint-config": "7.0.0",
+    "@voiceflow/git-branch-check": "1.4.0",
+    "@voiceflow/prettier-config": "1.2.1",
+    "@voiceflow/semantic-release-config": "1.1.0",
+    "@voiceflow/tsconfig": "1.4.8",
+    "chai": "4.3.6",
+    "commitizen": "4.2.5",
+    "cz-conventional-changelog": "^3.3.0",
+    "depcheck": "^1.4.3",
+    "eslint": "8.23.1",
+    "eslint-output": "^3.0.1",
+    "fixpack": "^4.0.0",
+    "husky": "8.0.1",
+    "istanbul": "^0.4.5",
+    "lint-staged": "13.0.3",
+    "mocha": "10.0.0",
+    "nyc": "^15.1.0",
+    "prettier": "2.7.1",
+    "ts-mocha": "10.0.0",
+    "tsc-alias": "1.7.0",
+    "typescript": "4.8.3"
   },
   "files": [
-    "lib/**/*",
-    "*.js"
+    "build/"
+  ],
+  "homepage": "https://github.com/voiceflow/logger#readme",
+  "keywords": [
+    "voiceflow"
   ],
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "pre-commit": "lint-staged",
-      "pre-push": "git-branch-check"
-    }
-  },
   "license": "ISC",
-  "lint-staged": {
-    "package.json": [
-      "fixpack",
-      "git add"
-    ],
-    "**/*.js": [
-      "eslint --fix",
-      "prettier-eslint --write",
-      "git add"
-    ]
-  },
-  "main": "index.js",
+  "main": "build/main.js",
   "prettier": "@voiceflow/prettier-config",
-  "release": {
-    "branch": "production"
-  },
   "repository": "git@github.com:voiceflow/logger.git",
   "scripts": {
-    "commit": "git-cz",
-    "integration": "mocha --use_strict --exit \"tests/**/*.it.js\"",
-    "lint": "eslint \"**/*.js\" --fix",
-    "lint:quiet": "yarn lint -- --quiet",
-    "prepare": "fixpack",
-    "send-coverage": "cat ./coverage/lcov.info | codacy-coverage",
-    "test": "nyc mocha --use_strict --exit \"tests/**/*.unit.js\" \"tests/**/*.it.js\"",
-    "unit": "mocha --use_strict --exit \"tests/**/*.unit.js\"",
-    "update": "yarn install"
-  }
+    "build": "yarn clean && tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
+    "clean": "rimraf build",
+    "commit": "cz",
+    "eslint-output": "eslint-output",
+    "lint": "eslint '**/*.{js,ts}'",
+    "lint:output": "yarn run eslint-output --quiet \"**/*.{js,ts}\"",
+    "lint:report": "yarn lint:output",
+    "tdd": "yarn test --watch",
+    "test": "yarn test:run",
+    "test:dependencies": "depcheck",
+    "test:integration": "NODE_ENV=test nyc --report-dir nyc_coverage_integration ts-mocha --paths --config ./config/test/.mocharc.yml 'test/**/*.it.ts'",
+    "test:run": "NODE_ENV=test nyc ts-mocha --paths --config ./config/test/.mocharc.yml 'test/**/*.{unit,it}.ts'",
+    "test:single": "NODE_ENV=test ts-mocha --paths --config ./config/test/.mocharc.yml",
+    "test:unit": "NODE_ENV=test nyc --report-dir=nyc_coverage_unit ts-mocha --paths --config ./config/test/.mocharc.yml 'test/**/*.unit.ts'"
+  },
+  "types": "build/main.d.ts"
 }

package/.eslintrc.js

@@ -1,24 +0,0 @@
-module.exports = {
-  extends: '@voiceflow/eslint-config',
-  rules: {
-    'no-continue': 'off',
-    'no-process-env': 'off',
-    'class-methods-use-this': 'off', // migrating away from classes anyways
-    'require-jsdoc': 'off', // not sure we want this
-    quotes: ['error', 'single', 'avoid-escape'],
-    'valid-jsdoc': 'off',
-    'func-names': 'off',
-    // disabled temporarily by setting as warnings
-    'eslint-comments/disable-enable-pair': 'warn',
-    'eslint-comments/no-unlimited-disable': 'warn',
-    'promise/always-return': 'warn',
-    'promise/param-names': 'warn',
-    'sonarjs/cognitive-complexity': 'warn',
-    'sonarjs/no-duplicate-string': 'warn',
-    'sonarjs/no-identical-functions': 'warn',
-    'sonarjs/no-useless-catch': 'warn',
-    'sonarjs/no-collapsible-if': 'warn',
-    'sonarjs/prefer-object-literal': 'warn',
-    'consistent-return': 'warn',
-  },
-};

package/commitlint.config.js

@@ -1,5 +0,0 @@
-'use strict';
-
-module.exports = {
-  extends: ['@voiceflow/commitlint-config'],
-};

package/index.js

@@ -1,5 +0,0 @@
-'use strict';
-
-const Logger = require('./lib/logger');
-
-module.exports = Logger;

package/lib/logger/index.js

@@ -1,5 +0,0 @@
-'use strict';
-
-const Logger = require('./logger');
-
-module.exports = Logger;

package/lib/logger/logger.js

@@ -1,65 +0,0 @@
-'use strict';
-
-const pino = require('pino');
-const expressPino = require('express-pino-logger');
-
-const { Caller } = require('../utils');
-const Prettifier = require('../../../pino-pretty');
-
-const defaultConfigs = {
-  level: 'info',
-  stackTrace: true,
-  pretty: true, 
-};
-
-class Logger {
-  constructor(config) {
-    this.config = config != null ? config : defaultConfigs;
-    this.baseLoggerConfig = {
-      level: this.config.level || defaultConfigs.level,
-      base: null,
-    };
-
-    if(this.config.pretty){
-      this.baseLoggerConfig.prettifier = Prettifier;
-      this.baseLoggerConfig.prettyPrint = {
-        levelFirst: true, 
-        translateTime: true,
-      };
-    }
-
-    this.baseLogger = pino(this.baseLoggerConfig);
-    this.middlewareLogger = expressPino({
-      logger: this.baseLogger, // Use the instantiated base logger
-    });
-  }
-
-  trace(...params) {
-    this.baseLogger.trace(...params);
-  }
-
-  debug(...params) {
-    this.baseLogger.debug(...params);
-  }
-
-  info(...params) {
-    this.baseLogger.info(...params);
-  }
-
-  warn(...params) {
-    const logPayload = Caller.identify(params); // Full stack trace not needed for warnings
-    this.baseLogger.warn(...logPayload);
-  }
-
-  error(...params) {
-    const logPayload = Caller.identify(params, this.config.stackTrace);
-    this.baseLogger.error(...logPayload);
-  }
-
-  fatal(...params) {
-    const logPayload = Caller.identify(params, this.config.stackTrace);
-    this.baseLogger.fatal(...logPayload);
-  }
-}
-
-module.exports = Logger;

package/lib/utils/caller.js

@@ -1,26 +0,0 @@
-'use strict';
-
-const STACKTRACE_OFFSET = 2;
-const LINE_OFFSET = 7;
-
-class Caller {
-  static identify(params, stackTrace = false) {
-    const callStack = Error()
-      .stack.split('\n')
-      .slice(STACKTRACE_OFFSET);
-    const callFunction = callStack.filter((s) => !s.includes('node_modules/pino') && !s.includes('node_modules\\pino'))[1].substr(LINE_OFFSET);
-    const callerObj = {
-      stack: stackTrace ? callStack : callFunction,
-    };
-
-    if (typeof params[0] === 'object') {
-      params[0].stack = callerObj.stack;
-    } else {
-      params.unshift(callerObj);
-    }
-
-    return params;
-  }
-}
-
-module.exports = Caller;

package/lib/utils/index.js

@@ -1,7 +0,0 @@
-'use strict';
-
-const Caller = require('./caller');
-
-module.exports = {
-  Caller,
-};

package/test.js

@@ -1,5 +0,0 @@
-const logger = require('./');
-
-const instance = new logger();
-
-instance.warn("asfd");