standard-log 7.1.0 → 9.0.0

package/cjs/testUtil.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="jest" />
+import type { LogEntry } from './types.js';
+export declare function rangeEntries(start: number, end: number, expected: any): any[][];
+export declare function assertSSF(err: Error, filename: string): void;
+export declare function logEntriesToString(logs: LogEntry[]): string;
+export declare function wrapTest<F>(fn: (test: jest.It) => F): F & {
+    only: F;
+    skip: F;
+};
+//# sourceMappingURL=testUtil.d.ts.map

package/cjs/testUtil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testUtil.d.ts","sourceRoot":"","sources":["../ts/testUtil.ts"],"names":[],"mappings":";AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAE1C,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,WAErE;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,QAGrD;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,QAAQ,EAAE,UAElD;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC;;;EAEnD"}

package/cjs/testUtil.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapTest = exports.logEntriesToString = exports.assertSSF = exports.rangeEntries = void 0;
+var ramda_1 = __importDefault(require("ramda"));
+var formatter_js_1 = require("./formatter.js");
+var platform_js_1 = require("./platform.js");
+function rangeEntries(start, end, expected) {
+    return ramda_1.default.range(start, end).map(function (value) { return ([value, expected]); });
+}
+exports.rangeEntries = rangeEntries;
+function assertSSF(err, filename) {
+    var _a;
+    var firstStackTrace = (_a = err.stack) === null || _a === void 0 ? void 0 : _a.split('\n')[1];
+    expect(firstStackTrace).toMatch(filename);
+}
+exports.assertSSF = assertSSF;
+function logEntriesToString(logs) {
+    return logs.map(platform_js_1.toInspectLogEntry).map(formatter_js_1.plainLogFormatter).join('\n');
+}
+exports.logEntriesToString = logEntriesToString;
+function wrapTest(fn) {
+    return Object.assign(fn(test), { only: fn(test.only), skip: fn(test.skip) });
+}
+exports.wrapTest = wrapTest;
+//# sourceMappingURL=testUtil.js.map

package/cjs/testUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testUtil.js","sourceRoot":"","sources":["../ts/testUtil.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAqB;AACrB,+CAAkD;AAClD,6CAAiD;AAGjD,SAAgB,YAAY,CAAC,KAAa,EAAE,GAAW,EAAE,QAAa;IACpE,OAAO,eAAC,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAnB,CAAmB,CAAC,CAAA;AAC9D,CAAC;AAFD,oCAEC;AAED,SAAgB,SAAS,CAAC,GAAU,EAAE,QAAgB;;IACpD,IAAM,eAAe,GAAG,MAAA,GAAG,CAAC,KAAK,0CAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IACjD,MAAM,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;AAC3C,CAAC;AAHD,8BAGC;AAED,SAAgB,kBAAkB,CAAC,IAAgB;IACjD,OAAO,IAAI,CAAC,GAAG,CAAC,+BAAiB,CAAC,CAAC,GAAG,CAAC,gCAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACtE,CAAC;AAFD,gDAEC;AAED,SAAgB,QAAQ,CAAI,EAAwB;IAClD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AAC9E,CAAC;AAFD,4BAEC","sourcesContent":["import R from 'ramda'\nimport { plainLogFormatter } from './formatter.js'\nimport { toInspectLogEntry } from './platform.js'\nimport type { LogEntry } from './types.js'\n\nexport function rangeEntries(start: number, end: number, expected: any) {\n  return R.range(start, end).map(value => ([value, expected]))\n}\n\nexport function assertSSF(err: Error, filename: string) {\n  const firstStackTrace = err.stack?.split('\\n')[1]\n  expect(firstStackTrace).toMatch(filename)\n}\n\nexport function logEntriesToString(logs: LogEntry[]) {\n  return logs.map(toInspectLogEntry).map(plainLogFormatter).join('\\n')\n}\n\nexport function wrapTest<F>(fn: (test: jest.It) => F) {\n  return Object.assign(fn(test), { only: fn(test.only), skip: fn(test.skip) })\n}\n"]}

package/{lib → cjs}/types.d.ts

@@ -1,13 +1,12 @@
-export declare type LogMode = 'development' | 'production' | 'test';
-export declare type LogMethodNames = 'emergency' | 'alert' | 'critical' | 'error' | 'warn' | 'notice' | 'info' | 'debug' | 'trace' | 'planck';
-export declare type LogMethod = (...args: any[]) => void;
-export declare type LogFunction = ((log: LogMethod) => void) | (() => string);
-export declare type LogEntry = {
-    id: string;
-    level: number;
-    args: any[];
-    timestamp: Date;
+export declare type StandardLogOptions<CustomLevelNames extends string = string> = {
+    customLevels: Record<CustomLevelNames, number>;
+    logLevel: number;
+    reporters: LogReporter[];
 };
+export interface LoggerOptions {
+    level?: number;
+    writeTo?: LogReporter | ReporterFilter;
+}
 export declare type Logger<T extends string = LogMethodNames> = {
     readonly id: string;
     /**
@@ -22,17 +21,28 @@ export declare type Logger<T extends string = LogMethodNames> = {
     on(level: number | T, logFunction: LogFunction): void;
     /**
      * Write custom log entries.
-     * This can be used along with `captureLogs()` to rewrite the logs at a later time.
      */
     write(entry: LogEntry): void;
 } & {
     [k in T]: LogMethod;
 };
+/**
+ * Names of the standard log methods.
+ */
+export declare type LogMethodNames = 'emergency' | 'alert' | 'critical' | 'error' | 'warn' | 'notice' | 'info' | 'debug' | 'trace' | 'planck';
+export declare type LogEntry = {
+    id: string;
+    level: number;
+    args: any[];
+    timestamp: Date;
+};
+export declare type LogMethod = (...args: any[]) => void;
+export declare type LogFunction = ((log: LogMethod) => void) | (() => string);
 export declare type ReporterFilter = string | RegExp | ((reporterId: string) => boolean);
 /**
  * Formats a log entry.
  * Depends on the reporter, it can expect a different return type.
- * By default the return type is `any[]` which `console` accepts.
+ * By default the return type is `any[]` which the `console` accepts.
  */
 export declare type LogFormatter<T = any[]> = (entry: LogEntry) => T;
 /**
@@ -43,31 +53,24 @@ export declare type LogLevelEntry = {
     name: string;
     level: number;
 };
-export declare type LogLevelListener = (logLevelEntry: LogLevelEntry) => void;
-export declare type LogReporter<T = any> = {
-    id: string;
+export interface LogReporter<T = any> {
+    readonly id: string;
     /**
      * Specifies the formatter to be used by the reporter.
      * Using this you can customize how the reporter writes the log entry.
-     * This is readonly in production mode.
      */
-    formatter: LogFormatter<T>;
+    readonly formatter: LogFormatter<T>;
     /**
      * Specifies a filter to determine should the log be written.
-     * This is readonly in production mode.
      */
-    filter?: LogFilter;
+    readonly filter?: LogFilter;
     /**
      * Indicate if this is a console reporter.
      * There is only one console reporter can be present in the system.
-     * If a new console reporter is added,
-     * it will be used in place of the existing one.
-     * However, existing filter will be carried over to ensure logs should not be shown remain not shown.
-     * If the new reporter also contains a filter, they will be combined.
      */
-    isConsoleReporter?: boolean;
+    readonly isConsoleReporter?: boolean;
     write(entry: LogEntry): void;
-};
+}
 export declare type LogReporterOptions<T = any> = {
     id?: string;
     /**
@@ -81,4 +84,10 @@ export declare type LogReporterOptions<T = any> = {
     filter?: LogFilter;
 };
 export declare type LogLevel = number;
+export interface ConsoleLike {
+    debug(...args: any[]): void;
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+}
 //# sourceMappingURL=types.d.ts.map

package/cjs/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../ts/types.ts"],"names":[],"mappings":"AAAA,oBAAY,kBAAkB,CAAC,gBAAgB,SAAS,MAAM,GAAG,MAAM,IAAI;IACzE,YAAY,EAAE,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,WAAW,EAAE,CAAA;CACzB,CAAA;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,WAAW,GAAG,cAAc,CAAA;CACvC;AAED,oBAAY,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,cAAc,IAAI;IACtD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC5B,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,EAAE,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IACtD;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;CAC7B,GAAG;KAAG,CAAC,IAAI,CAAC,GAAG,SAAS;CAAE,CAAA;AAE3B;;GAEG;AACH,oBAAY,cAAc,GAAG,WAAW,GAAG,OAAO,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAA;AAErI,oBAAY,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,SAAS,EAAE,IAAI,CAAA;CAChB,CAAA;AAED,oBAAY,SAAS,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;AAEhD,oBAAY,WAAW,GAAG,CAAC,CAAC,GAAG,EAAE,SAAS,KAAK,IAAI,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;AAErE,oBAAY,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,CAAA;AAEhF;;;;GAIG;AACH,oBAAY,YAAY,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,KAAK,CAAC,CAAA;AAE5D;;GAEG;AACH,oBAAY,SAAS,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAA;AAEpD,oBAAY,aAAa,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3D,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IACrC,KAAK,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;CAC7B;AAED,oBAAY,kBAAkB,CAAC,CAAC,GAAG,GAAG,IAAI;IACxC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB,CAAA;AAED,oBAAY,QAAQ,GAAG,MAAM,CAAA;AAE7B,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC5B,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC3B,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC3B,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;CAC7B"}

package/cjs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../ts/types.ts"],"names":[],"mappings":"","sourcesContent":["export type StandardLogOptions<CustomLevelNames extends string = string> = {\n  customLevels: Record<CustomLevelNames, number>,\n  logLevel: number,\n  reporters: LogReporter[]\n}\n\nexport interface LoggerOptions {\n  level?: number,\n  writeTo?: LogReporter | ReporterFilter\n}\n\nexport type Logger<T extends string = LogMethodNames> = {\n  readonly id: string,\n  /**\n   * Logger local log level.\n   */\n  level?: number,\n  /**\n   * Logs with an increment counter.\n   * This is useful during debugging to check for steps executed.\n   */\n  count(...args: any[]): void,\n  on(level: number | T, logFunction: LogFunction): void,\n  /**\n   * Write custom log entries.\n   */\n  write(entry: LogEntry): void\n} & { [k in T]: LogMethod }\n\n/**\n * Names of the standard log methods.\n */\nexport type LogMethodNames = 'emergency' | 'alert' | 'critical' | 'error' | 'warn' | 'notice' | 'info' | 'debug' | 'trace' | 'planck'\n\nexport type LogEntry = {\n  id: string,\n  level: number,\n  // args instead of messages because it is `any[]` instead of `string[]`\n  args: any[],\n  timestamp: Date\n}\n\nexport type LogMethod = (...args: any[]) => void\n\nexport type LogFunction = ((log: LogMethod) => void) | (() => string)\n\nexport type ReporterFilter = string | RegExp | ((reporterId: string) => boolean)\n\n/**\n * Formats a log entry.\n * Depends on the reporter, it can expect a different return type.\n * By default the return type is `any[]` which the `console` accepts.\n */\nexport type LogFormatter<T = any[]> = (entry: LogEntry) => T\n\n/**\n * Determines whether the entry should be written.\n */\nexport type LogFilter = (entry: LogEntry) => boolean\n\nexport type LogLevelEntry = { name: string, level: number }\n\nexport interface LogReporter<T = any> {\n  readonly id: string,\n  /**\n   * Specifies the formatter to be used by the reporter.\n   * Using this you can customize how the reporter writes the log entry.\n   */\n  readonly formatter: LogFormatter<T>,\n  /**\n   * Specifies a filter to determine should the log be written.\n   */\n  readonly filter?: LogFilter,\n  /**\n   * Indicate if this is a console reporter.\n   * There is only one console reporter can be present in the system.\n   */\n  readonly isConsoleReporter?: boolean,\n  write(entry: LogEntry): void\n}\n\nexport type LogReporterOptions<T = any> = {\n  id?: string,\n  /**\n   * Specifies the formatter to be used by the reporter.\n   * Using this you can customize how the reporter writes the log entry.\n   */\n  formatter?: LogFormatter<T>,\n  /**\n   * Specifies a filter to determine should the log be written.\n   */\n  filter?: LogFilter\n}\n\nexport type LogLevel = number\n\nexport interface ConsoleLike {\n  debug(...args: any[]): void,\n  info(...args: any[]): void,\n  warn(...args: any[]): void,\n  error(...args: any[]): void,\n}\n"]}

package/cjs/types.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.spec.d.ts.map

package/cjs/types.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.spec.d.ts","sourceRoot":"","sources":["../ts/types.spec.ts"],"names":[],"mappings":""}

package/cjs/types.spec.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var type_plus_1 = require("type-plus");
+test('LogReporter can specify what kind of LogFormatter it accepts', function () {
+    type_plus_1.assertType.isFalse(false);
+});
+//# sourceMappingURL=types.spec.js.map

package/cjs/types.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.spec.js","sourceRoot":"","sources":["../ts/types.spec.ts"],"names":[],"mappings":";;AACA,uCAAiD;AAGjD,IAAI,CAAC,8DAA8D,EAAE;IACnE,sBAAU,CAAC,OAAO,CAAC,KAA0E,CAAC,CAAA;AAChG,CAAC,CAAC,CAAA","sourcesContent":["import { Stream } from 'stream'\nimport { assertType, CanAssign } from 'type-plus'\nimport { LogFormatter, LogReporter } from './types.js'\n\ntest('LogReporter can specify what kind of LogFormatter it accepts', () => {\n  assertType.isFalse(false as CanAssign<LogFormatter<Stream>, LogReporter<string>['formatter']>)\n})\n"]}