@cichol/logger 4.0.0 → 4.2.2

package/releases/esm.js

@@ -1,10 +1,7 @@
-import _Symbol from '@babel/runtime-corejs3/core-js/symbol';
-import _filterInstanceProperty from '@babel/runtime-corejs3/core-js/instance/filter';
-import _mapInstanceProperty from '@babel/runtime-corejs3/core-js/instance/map';
-import _trimInstanceProperty from '@babel/runtime-corejs3/core-js/instance/trim';
-import _Reflect$hasOwnMetadata from '@babel/runtime-corejs3/core-js/reflect/has-own-metadata';
-import _Reflect$getOwnMetadata from '@babel/runtime-corejs3/core-js/reflect/get-own-metadata';
-import _Reflect$defineMetadata from '@babel/runtime-corejs3/core-js/reflect/define-metadata';
+import _Symbol from 'core-js-pure/stable/symbol/index.js';
+import _filterInstanceProperty from 'core-js-pure/stable/instance/filter.js';
+import _mapInstanceProperty from 'core-js-pure/stable/instance/map.js';
+import _trimInstanceProperty from 'core-js-pure/stable/instance/trim.js';
 import 'reflect-metadata';
 import { STATUS_CODES, IncomingMessage, ServerResponse } from 'http';
 import { PassThrough } from 'stream';
@@ -13,16 +10,16 @@ import lodash from 'lodash';
 import morgan from 'morgan';
 import * as winston from 'winston';
 import { format } from 'winston';
-import _findInstanceProperty from '@babel/runtime-corejs3/core-js/instance/find';
-import _Reflect$apply from '@babel/runtime-corejs3/core-js/reflect/apply';
+import _findInstanceProperty from 'core-js-pure/stable/instance/find.js';
+import _Reflect$apply from 'core-js-pure/stable/reflect/apply.js';
 import chalk from 'chalk';
 import rTracer from 'cls-rtracer';
 import { DateTime } from 'luxon';
-import _Map from '@babel/runtime-corejs3/core-js/map';
+import _Map from 'core-js-pure/stable/map/index.js';
 import process, { version, env } from 'process';
-import _Symbol$for from '@babel/runtime-corejs3/core-js/symbol/for';
-import _startsWithInstanceProperty from '@babel/runtime-corejs3/core-js/instance/starts-with';
-import _sliceInstanceProperty from '@babel/runtime-corejs3/core-js/instance/slice';
+import _Symbol$for from 'core-js-pure/stable/symbol/for.js';
+import _startsWithInstanceProperty from 'core-js-pure/stable/instance/starts-with.js';
+import _sliceInstanceProperty from 'core-js-pure/stable/instance/slice.js';
 import path from 'path';
 import highlight from 'cli-highlight';
 import prettyBytes from 'pretty-bytes';
@@ -47,16 +44,18 @@ const LoggingLevel = {
   Debug: 5
 };
 
-const colorizerMap = new _Map(); // Helpers.
+// Constants.
+const colorizerMap = new _Map();
 
+// Helpers.
 function createScheme(options) {
   const nextIndex = colorizerMap.size;
   const colorizer = chalk.bgHex(options.background).hex(options.foreground);
   colorizerMap.set(nextIndex, colorizer);
   return nextIndex;
-} // Color definitions.
-
+}
 
+// Color definitions.
 const ColorValue = {
   // Basic colors.
   White: '#FFFFFF',
@@ -98,10 +97,12 @@ const ColorScheme = {
 function getChalkOf(colorSet) {
   return colorizerMap.get(colorSet) ?? chalk;
 }
+
 /* eslint-enable no-use-before-define */
 
 // Node.js built-in APIs.
 
+// Constants.
 const {
   isTTY
 } = process.stdout;
@@ -110,61 +111,51 @@ function decorateLabel(label, scheme) {
   if (isNotOnCLI) {
     return label;
   }
-
   const chalk = getChalkOf(scheme);
   const decoratedLabel = chalk.bold(` ${label} `);
   return decoratedLabel;
 }
 
+// Type definitions.
+
 // Constants.
 const rootPath = process.cwd();
 const conjunction = ` ${chalk.blue('──')} `;
+const splat = _Symbol$for('splat');
 
-const splat = _Symbol$for('splat'); // Handler metadata.
-
-
+// Handler metadata.
 const name$8 = 'error';
 const level$8 = LoggingLevel.Error;
 const label$8 = decorateLabel('ERROR', ColorScheme.Critical);
-
 function mapLocationOfErrorThrown(filename) {
   let target = path.relative(rootPath, filename);
-
   if (_startsWithInstanceProperty(target).call(target, 'node_modules')) {
     target = chalk.gray(target).replace(/node_modules[\\/]([^\\/]+)(.*)/, (matches, moduleName, trailing) => `node_modules${path.sep}${chalk.bold.underline(moduleName)}${chalk.gray(trailing)}` // eslint-disable-line max-len
     );
   } else {
     target = `${chalk.gray(path.dirname(target) + path.sep)}${chalk.bold.underline(path.basename(target))}`;
   }
-
   return target;
 }
-
 function handle$1(data) {
   var _context, _context2, _context3;
-
   const {
     [splat]: [error] = []
   } = data;
-
   if (!(error instanceof Error)) {
     return undefined;
   }
-
   const {
     name,
     message,
     stack: rawStack = ''
   } = error;
-
   const stack = _mapInstanceProperty(_context = _mapInstanceProperty(_context2 = _mapInstanceProperty(_context3 = _sliceInstanceProperty(rawStack).call(rawStack, name.length + message.length + 3).split('\n')).call(_context3, line => line.replace(/^\s+at /g, ''))).call(_context2, line => path.isAbsolute(line) ? `<anonymous>${conjunction}${mapLocationOfErrorThrown(line)}` : line)).call(_context, line => line.replace(/^(.+) \((.+)\)$/, (matches, contextName, rawLocation) => {
     let location;
-
     if (rawLocation === '<anonymous>') {
       location = chalk.gray(rawLocation);
     } else {
       const [filename, line, column] = rawLocation.split(':');
-
       if (path.isAbsolute(filename)) {
         const target = mapLocationOfErrorThrown(path.relative(rootPath, filename));
         const trailing = chalk.gray(`:${line}:${column}`);
@@ -173,10 +164,8 @@ function handle$1(data) {
         location = chalk.gray(`https://github.com/${chalk.bold.underline('nodejs')}/node/blob/${version}/lib/${filename}#L${line}`); // eslint-disable-line max-len
       }
     }
-
     return `${contextName}${conjunction}${location}`;
   })).join('\n');
-
   const label = decorateLabel(name, ColorScheme.Critical);
   const payload = `${message}\n\n${stack}\n`;
   return {
@@ -187,28 +176,30 @@ function handle$1(data) {
 
 var ErrorHandler = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    name: name$8,
-    level: level$8,
+    default: handle$1,
     label: label$8,
-    'default': handle$1
+    level: level$8,
+    name: name$8
 });
 
 // Local helpers.
 
+// Handler metadata.
 const name$7 = 'fatal';
 const level$7 = LoggingLevel.Fatal;
 const label$7 = decorateLabel('FATAL', ColorScheme.Critical);
 
 var FatalHandler = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    name: name$7,
-    level: level$7,
+    default: handle$1,
     label: label$7,
-    'default': handle$1
+    level: level$7,
+    name: name$7
 });
 
 // Local helpers.
 
+// Handler metadata.
 const name$6 = 'warning';
 const level$6 = LoggingLevel.Warning;
 const label$6 = decorateLabel('WARNING', ColorScheme.Warning);
@@ -216,14 +207,15 @@ var warning = null;
 
 var WarningHandler = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    name: name$6,
-    level: level$6,
+    default: warning,
     label: label$6,
-    'default': warning
+    level: level$6,
+    name: name$6
 });
 
 // Local helpers.
 
+// Handler metadata.
 const name$5 = 'notice';
 const level$5 = LoggingLevel.Notice;
 const label$5 = decorateLabel('NOTICE', ColorScheme.Regular);
@@ -231,14 +223,15 @@ var notice = null;
 
 var NoticeHandler = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    name: name$5,
-    level: level$5,
+    default: notice,
     label: label$5,
-    'default': notice
+    level: level$5,
+    name: name$5
 });
 
 // Local helpers.
 
+// Handler metadata.
 const name$4 = 'info';
 const level$4 = LoggingLevel.Info;
 const label$4 = decorateLabel('INFO', ColorScheme.Regular);
@@ -246,14 +239,15 @@ var info = null;
 
 var InfoHandler = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    name: name$4,
-    level: level$4,
+    default: info,
     label: label$4,
-    'default': info
+    level: level$4,
+    name: name$4
 });
 
 // Local helpers.
 
+// Handler metadata.
 const name$3 = 'http';
 const level$3 = LoggingLevel.Http;
 const label$3 = decorateLabel('HTTP', ColorScheme.Http);
@@ -261,14 +255,16 @@ var http = null;
 
 var HttpHandler = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    name: name$3,
-    level: level$3,
+    default: http,
     label: label$3,
-    'default': http
+    level: level$3,
+    name: name$3
 });
 
 // Highlight.js
 
+// Type definitions.
+
 // Handler metadata.
 const name$2 = 'query';
 const level$2 = LoggingLevel.Query;
@@ -285,14 +281,15 @@ function handle(data) {
 
 var QueryHandler = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    name: name$2,
-    level: level$2,
+    default: handle,
     label: label$2,
-    'default': handle
+    level: level$2,
+    name: name$2
 });
 
 // Local helpers.
 
+// Handler metadata.
 const name$1 = 'verbose';
 const level$1 = LoggingLevel.Verbose;
 const label$1 = decorateLabel('VERBOSE', ColorScheme.Loud);
@@ -300,14 +297,15 @@ var verbose = null;
 
 var VerboseHandler = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    name: name$1,
-    level: level$1,
+    default: verbose,
     label: label$1,
-    'default': verbose
+    level: level$1,
+    name: name$1
 });
 
 // Local helpers.
 
+// Handler metadata.
 const name = 'debug';
 const level = LoggingLevel.Debug;
 const label = decorateLabel('DEBUG', ColorScheme.Loud);
@@ -315,10 +313,10 @@ var debug = null;
 
 var DebugHandler = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    name: name,
-    level: level,
+    default: debug,
     label: label,
-    'default': debug
+    level: level,
+    name: name
 });
 
 // Handler implementations.
@@ -328,34 +326,30 @@ var formatForCLI = format.printf(data => {
   const timestamp = chalk.gray(DateTime.now().toISO({
     includeOffset: true
   }));
-
   const handler = _findInstanceProperty(handlers).call(handlers, ({
     name
   }) => name === data.level);
-
   const fallback = {
     label: handler?.label,
     payload: data.message
   };
+  const performHandle = handler?.default ?? (() => fallback);
 
-  const performHandle = handler?.default ?? (() => fallback); // Execute handler and then, get decorated payload.
-
-
+  // Execute handler and then, get decorated payload.
   const {
     label,
     payload
   } = _Reflect$apply(performHandle, undefined, [data]) ?? fallback;
   let extraFingerprint;
-
   if (handler?.level === LoggingLevel.Http) {
     extraFingerprint = data.transactionId ? `(Transaction-ID = ${data.transactionId})` : `(Request-ID = ${rTracer.id()})`;
   }
-
   return `${label} ${timestamp}${extraFingerprint ? ` ${extraFingerprint}` : ''}\n${payload}`;
 });
 
 // Node.js built-in APIs.
 
+// Type definitions.
 const ExecutionMode = {
   DevelopmentMode: 'development',
   ProductionMode: 'production'
@@ -370,74 +364,71 @@ cluster.isPrimary ?? cluster.isMaster ? ClusteringMode.MasterProcess : Clusterin
 
 // Node.js built-in APIs.
 
+// Type definitions.
+
 // Helpers.
 function decorateStatusCode(statusCode) {
   const groupOfCode = Math.floor(Number(statusCode) / 100) * 100;
   const baseMessage = `${statusCode} ${STATUS_CODES[statusCode]}`;
-
   switch (groupOfCode) {
     case 200:
       {
         return chalk.green(baseMessage);
       }
-
     case 300:
       {
         return chalk.magenta(baseMessage);
       }
-
     case 400:
     case 500:
       {
         return chalk.red(baseMessage);
       }
-
     default:
       {
         return chalk.gray(baseMessage);
       }
   }
 }
-
 function formatForMorgan(tokens, request, response) {
   function _(token, ...subArgs) {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
     return tokens[token](request, response, ...subArgs);
-  } // Raw values.
-
+  }
 
+  // Raw values.
   const method = _('method');
-
   const URL = _('url');
-
   const httpVersion = `HTTP/${_('http-version')}`;
   const statusCode = Number(_('status'));
   const contentLength = Number(_('res', 'content-length') ?? -1);
-  const responseTime = Number(_('response-time') ?? -1); // Decorated values.
+  const responseTime = Number(_('response-time') ?? -1);
 
+  // Decorated values.
   const $method = chalk.bold(method);
   const $version = chalk.rgb(98, 177, 255)(httpVersion);
   const $statusCode = decorateStatusCode(statusCode);
   const $contentLength = contentLength >= 0 ? prettyBytes(contentLength) : '? B';
-  const $responseTime = responseTime >= 0 ? prettyMs(responseTime) : ''; // Additional information.
+  const $responseTime = responseTime >= 0 ? prettyMs(responseTime) : '';
 
+  // Additional information.
   const metadata = `(${$contentLength}, ${$responseTime})`;
   return [`→ ${$method} ${URL} ${$version}`, `← ${$version} ${$statusCode} ${metadata}`].join('\n');
 }
-
 var formatForMorgan$1 = executionMode === ExecutionMode.DevelopmentMode ? formatForMorgan : morgan.combined;
 
 var _context, _context2;
 
+// Type definitions.
+
 // Transports.
 const {
   Console: ConsoleTransport
-} = winston.transports; // Keys in order to access private properties.
+} = winston.transports;
 
+// Keys in order to access private properties.
 const KeyOfInstance = _Symbol('@cichol/logger::classes/logger::Instance');
-
 const KeyOfPassport = _Symbol('@cichol/logger::classes/logger::Passport');
-
 class Logger {
   #logger = winston.createLogger({
     levels: _filterInstanceProperty(_context = _mapInstanceProperty(_context2 = lodash(handlers)).call(_context2, ({
@@ -457,30 +448,26 @@ class Logger {
       this.log('http', _trimInstanceProperty(data).call(data));
     })
   });
-
   constructor(passport) {
     if (passport !== KeyOfPassport) {
       throw new ReferenceError('Logger class cannot be constructed in directly');
     }
   }
-
   static get instance() {
     if (this !== Logger) {
       throw new ReferenceError('Logger class is not inheritable');
     }
-
-    if (_Reflect$hasOwnMetadata(KeyOfInstance, Logger)) {
-      return _Reflect$getOwnMetadata(KeyOfInstance, Logger);
+    if (Reflect.hasOwnMetadata(KeyOfInstance, Logger)) {
+      return Reflect.getOwnMetadata(KeyOfInstance, Logger);
     }
-
     const instance = new Logger(KeyOfPassport);
-
     try {
       return instance;
     } finally {
-      _Reflect$defineMetadata(KeyOfInstance, instance, Logger);
+      Reflect.defineMetadata(KeyOfInstance, instance, Logger);
     }
   }
+
   /**
    * Logging message with specific level.
    *
@@ -489,38 +476,47 @@ class Logger {
    * @param args Additional metadata.
    */
 
+  /**
+   * Logging HTTP I/O.
+   *
+   * @param request Node.js built-in `IncomingMessage` instance from `http` module.
+   * @param response Node.js built-in `ServerResponse` instance from `http` module.
+   */
+
+  /**
+   * Logging errors in detail.
+   *
+   * @param error
+   */
 
   log(...args) {
     const logger = this.#logger;
     const morgan = this.#morgan;
-
     switch (true) {
       case args.length >= 2 && args[0] instanceof IncomingMessage && args[1] instanceof ServerResponse:
         {
           const [request, response] = args;
           return Promise$1.fromCallback(callback => morgan(request, response, callback));
         }
-
       case args.length >= 1 && args[0] instanceof Error:
         {
-          const [error, ...data] = args; // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+          const [error, ...data] = args;
 
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
           logger.log('error', error.message, error, ...data);
           return undefined;
         }
-
       default:
         {
-          const [level, message, ...data] = args; // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+          const [level, message, ...data] = args;
 
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
           logger.log(level, message, ...data);
           return undefined;
         }
     }
   }
-
 }
-
 var logger = Logger.instance;
 
 export { logger as default };

package/types/classes/logger.d.ts

@@ -1,33 +0,0 @@
-/// <reference types="node" />
-import 'reflect-metadata';
-import { IncomingMessage as HttpRequest, ServerResponse as HttpResponse } from 'http';
-import Promise from 'bluebird';
-import type { LoggingLevelName } from '../handlers';
-declare class Logger {
-    #private;
-    private constructor();
-    static get instance(): Logger;
-    /**
-     * Logging message with specific level.
-     *
-     * @param level
-     * @param message
-     * @param args Additional metadata.
-     */
-    log(level: LoggingLevelName, message: string, ...args: any[]): void;
-    /**
-     * Logging HTTP I/O.
-     *
-     * @param request Node.js built-in `IncomingMessage` instance from `http` module.
-     * @param response Node.js built-in `ServerResponse` instance from `http` module.
-     */
-    log(request: HttpRequest, response: HttpResponse): Promise<void>;
-    /**
-     * Logging errors in detail.
-     *
-     * @param error
-     */
-    log(error: Error): void;
-}
-declare const _default: Logger;
-export default _default;

package/types/formatters/command-line.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("logform").Format;
-export default _default;

package/types/formatters/morgan.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage as HttpRequest, ServerResponse as HttpResponse } from 'http';
-import morgan from 'morgan';
-declare module 'morgan' {
-    const combined: morgan.FormatFn;
-}
-declare const _default: morgan.FormatFn<HttpRequest, HttpResponse>;
-export default _default;

package/types/handlers/debug.d.ts

@@ -1,5 +0,0 @@
-export declare const name = "debug";
-export declare const level: 5;
-export declare const label: "DEBUG";
-declare const _default: null;
-export default _default;

package/types/handlers/error.d.ts

@@ -1,13 +0,0 @@
-declare type LoggingData = {
-    level: string;
-    message: string;
-} & Record<PropertyKey, any>;
-declare type HandledData = {
-    label: string;
-    payload: string;
-};
-export declare const name = "error";
-export declare const level: 1;
-export declare const label: "ERROR";
-export default function handle(data: LoggingData): HandledData | undefined;
-export {};

package/types/handlers/fatal.d.ts

@@ -1,4 +0,0 @@
-export declare const name = "fatal";
-export declare const level: 0;
-export declare const label: "FATAL";
-export { default } from './error';

package/types/handlers/http.d.ts

@@ -1,5 +0,0 @@
-export declare const name = "http";
-export declare const level: 4;
-export declare const label: "HTTP";
-declare const _default: null;
-export default _default;

package/types/handlers/index.d.ts

@@ -1,12 +0,0 @@
-import * as FatalHandler from './fatal';
-import * as ErrorHandler from './error';
-import * as WarningHandler from './warning';
-import * as NoticeHandler from './notice';
-import * as InfoHandler from './info';
-import * as HttpHandler from './http';
-import * as QueryHandler from './query';
-import * as VerboseHandler from './verbose';
-import * as DebugHandler from './debug';
-declare const handlers: (typeof FatalHandler | typeof ErrorHandler | typeof WarningHandler | typeof NoticeHandler | typeof InfoHandler | typeof HttpHandler | typeof QueryHandler | typeof VerboseHandler | typeof DebugHandler)[];
-export declare type LoggingLevelName = (typeof handlers extends (infer T)[] ? T : never)['name'];
-export default handlers;

package/types/handlers/info.d.ts

@@ -1,5 +0,0 @@
-export declare const name = "info";
-export declare const level: 3;
-export declare const label: "INFO";
-declare const _default: null;
-export default _default;

package/types/handlers/notice.d.ts

@@ -1,5 +0,0 @@
-export declare const name = "notice";
-export declare const level: 3;
-export declare const label: "NOTICE";
-declare const _default: null;
-export default _default;

package/types/handlers/query.d.ts

@@ -1,13 +0,0 @@
-declare type LoggingData = {
-    level: string;
-    message: string;
-} & Record<PropertyKey, any>;
-declare type HandledData = {
-    label: string;
-    payload: string;
-};
-export declare const name = "query";
-export declare const level: 4;
-export declare const label: "QUERY";
-export default function handle(data: LoggingData): HandledData | undefined;
-export {};

package/types/handlers/verbose.d.ts

@@ -1,5 +0,0 @@
-export declare const name = "verbose";
-export declare const level: 5;
-export declare const label: "VERBOSE";
-declare const _default: null;
-export default _default;

package/types/handlers/warning.d.ts

@@ -1,5 +0,0 @@
-export declare const name = "warning";
-export declare const level: 2;
-export declare const label: "WARNING";
-declare const _default: null;
-export default _default;

package/types/helpers/color-scheme.d.ts

@@ -1,12 +0,0 @@
-import { Chalk } from 'chalk';
-declare const ColorScheme: {
-    readonly Critical: number;
-    readonly Warning: number;
-    readonly Regular: number;
-    readonly Http: number;
-    readonly Query: number;
-    readonly Loud: number;
-};
-declare type ColorScheme = typeof ColorScheme[keyof typeof ColorScheme];
-export declare function getChalkOf(colorSet: ColorScheme): Chalk;
-export default ColorScheme;