@cichol/logger 4.2.2 → 4.3.1

package/README.md

@@ -28,7 +28,7 @@ $ npm install --save @cichol/logger
 
 [MIT Licensed](../../LICENSE).
 
-[github actions badge]: https://img.shields.io/github/workflow/status/morrighan/packages/On%20default/develop?style=flat-square
+[github actions badge]: https://img.shields.io/github/actions/workflow/status/morrighan/packages/default.yml?branch=develop&style=flat-square
 [github actions]: https://github.com/morrighan/packages/actions
 [license badge]: https://img.shields.io/github/license/morrighan/packages.svg?style=flat-square
 [npm package version badge]: https://img.shields.io/npm/v/@cichol/logger.svg?style=flat-square

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cichol/logger",
-    "version": "4.2.2",
+    "version": "4.3.1",
     "description": "A logger based on `winston` for personal projects.",
     "homepage": "https://github.com/morrighan/packages",
     "bugs": {
@@ -46,7 +46,7 @@
         "winston": "^3.14.2"
     },
     "engines": {
-        "node": "^20.13.1",
+        "node": "^20.16.0",
         "npm": "^10.8.0"
     },
     "publishConfig": {

package/types/classes/logger.d.ts

@@ -0,0 +1,32 @@
+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

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

package/types/formatters/morgan.d.ts

@@ -0,0 +1,7 @@
+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<HttpRequest>>;
+export default _default;

package/types/handlers/debug.d.ts

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,13 @@
+type LoggingData = {
+    level: string;
+    message: string;
+} & Record<PropertyKey, any>;
+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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,12 @@
+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 type LoggingLevelName = (typeof handlers extends (infer T)[] ? T : never)['name'];
+export default handlers;

package/types/handlers/info.d.ts

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,13 @@
+type LoggingData = {
+    level: string;
+    message: string;
+} & Record<PropertyKey, any>;
+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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,5 @@
+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

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

package/types/helpers/constants.d.ts

@@ -0,0 +1,18 @@
+export declare const ExecutionMode: {
+    readonly DevelopmentMode: "development";
+    readonly ProductionMode: "production";
+};
+export declare const ClusteringMode: {
+    readonly MasterProcess: 0;
+    readonly WorkerProcess: 1;
+};
+export declare const ThreadingMode: {
+    readonly MainThread: 0;
+    readonly WorkerThread: 1;
+};
+export type ExecutionMode = typeof ExecutionMode[keyof typeof ExecutionMode];
+export type ClusteringMode = typeof ClusteringMode[keyof typeof ClusteringMode];
+export type ThreadingMode = typeof ThreadingMode[keyof typeof ThreadingMode];
+export declare const executionMode: ExecutionMode;
+export declare const clusteringMode: ClusteringMode;
+export declare const threadingMode: ThreadingMode;

package/types/helpers/label-decorator.d.ts

@@ -0,0 +1,2 @@
+import ColorScheme from './color-scheme';
+export default function decorateLabel<T extends string>(label: T, scheme: ColorScheme): T;

package/types/helpers/logging-level.d.ts

@@ -0,0 +1,13 @@
+declare const LoggingLevel: {
+    readonly Fatal: 0;
+    readonly Error: 1;
+    readonly Warning: 2;
+    readonly Notice: 3;
+    readonly Info: 3;
+    readonly Http: 4;
+    readonly Query: 4;
+    readonly Verbose: 5;
+    readonly Debug: 5;
+};
+type LoggingLevel = typeof LoggingLevel[keyof typeof LoggingLevel];
+export default LoggingLevel;

package/types/index.d.ts

@@ -0,0 +1 @@
+export { default } from './classes/logger';