@fgv/ts-utils 5.1.0-30 → 5.1.0-31

package/dist/packlets/logging/index.js

@@ -22,4 +22,6 @@
 export * from './bootLogger';
 export * from './logger';
 export * from './logReporter';
+export * from './multiLogger';
+export * from './retainingLogger';
 //# sourceMappingURL=index.js.map

package/dist/packlets/logging/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/logging/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nexport * from './bootLogger';\nexport * from './logger';\nexport * from './logReporter';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/logging/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nexport * from './bootLogger';\nexport * from './logger';\nexport * from './logReporter';\nexport * from './multiLogger';\nexport * from './retainingLogger';\n"]}

package/dist/packlets/logging/logger.js

@@ -160,6 +160,7 @@ export class LoggerBase {
     log(level, message, ...parameters) {
         if (shouldLog(level, this.logLevel)) {
             const formatted = this._format(message, ...parameters);
+            this._logStructured(level, formatted, message, parameters);
             return this._log(formatted, level);
         }
         return this._suppressLog(level, message, ...parameters);
@@ -178,6 +179,21 @@ export class LoggerBase {
         const joined = strings.join('');
         return joined;
     }
+    /**
+     * Inner hook called for logged messages alongside {@link Logging.LoggerBase._log | _log},
+     * exposing the structured `(level, formatted, message, parameters)` form before it is
+     * collapsed to the formatted string. The default implementation is a no-op; subclasses
+     * that need to retain structured records (e.g. {@link Logging.RetainingLogger | RetainingLogger})
+     * override this. Fired only in the `shouldLog` branch, so suppressed messages never reach it.
+     * @param __level - The {@link MessageLogLevel | level} of the message.
+     * @param __formatted - The formatted message (same string passed to `_log`).
+     * @param __message - The raw message argument before formatting.
+     * @param __parameters - The raw parameter arguments before formatting.
+     * @public
+     */
+    _logStructured(__level, __formatted, __message, __parameters) {
+        /* no-op; subclasses that retain structured records override this */
+    }
     /**
      * Inner method called for suppressed log messages.
      * @public

package/dist/packlets/logging/logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../src/packlets/logging/logger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAA4B,aAAa,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAQ3E;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,OAAwB,EAAE,QAA0B;IAC5E,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,CAAC,2CAA2C;IAC1D,CAAC;IACD,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,CAAC,iCAAiC;IACjD,CAAC;IACD,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC,CAAC,oDAAoD;IACpE,CAAC;IACD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,OAAO;YACV,OAAO,OAAO,KAAK,OAAO,CAAC;QAC7B,KAAK,SAAS;YACZ,OAAO,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,OAAO,CAAC;QACtD,KAAK,MAAM;YACT,OAAO,OAAO,KAAK,QAAQ,CAAC;IAChC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc,EAAE,SAAkB;IAClE,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,EAAE,CAAC;IAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,IAAI,GAAG,KAAK,iBAAiB,EAAE,CAAC;QAC9B,OAAO,aAAa,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;aAC9C,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,OAAO,OAAO,CAAC,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;QACnF,CAAC,CAAC;aACD,SAAS,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAmFD;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,MAAe;IAC5C,OAAO,CACL,OAAQ,MAAwB,CAAC,eAAe,KAAK,UAAU;QAC/D,OAAQ,MAAwB,CAAC,cAAc,KAAK,UAAU,CAC/D,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,OAAgB,UAAU;IAM9B,YAAsB,QAA2B;QALjD;;WAEG;QACI,aAAQ,GAAqB,MAAM,CAAC;QAGzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,MAAM,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACI,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,OAAe,EAAE,MAAe;QACrD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,OAAe,EAAE,MAAe;QACpD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACI,GAAG,CACR,KAAsB,EACtB,OAAiB,EACjB,GAAG,UAAqB;QAExB,IAAI,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACpC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;YACvD,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACO,OAAO,CAAC,OAAiB,EAAE,GAAG,UAAqB;QAC3D,MAAM,GAAG,GAAG,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;QACjE,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACO,YAAY,CACpB,OAAwB,EACxB,SAAmB,EACnB,GAAG,YAAuB;QAE1B,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;CAUF;AAED;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,UAAU;IAa5C;;;OAGG;IACH,YAAmB,QAA2B;QAC5C,KAAK,CAAC,QAAQ,CAAC,CAAC;QAjBlB;;;WAGG;QACK,YAAO,GAAa,EAAE,CAAC;QAE/B;;;WAGG;QACK,gBAAW,GAAa,EAAE,CAAC;IAQnC,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED;;;OAGG;IACO,IAAI,CAAC,OAAe,EAAE,OAAwB;QACtD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACO,YAAY,CACpB,KAAsB,EACtB,OAAiB,EACjB,GAAG,UAAqB;QAExB,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;QACvD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3C;;;OAGG;IACH,YAAmB,QAA2B;QAC5C,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,IAAI,CAAC,OAAe,EAAE,KAAsB;QACpD,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,OAAO;gBACV,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACvB,MAAM;YACR,KAAK,SAAS;gBACZ,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACtB,MAAM;YACR,KAAK,MAAM;gBACT,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACtB,MAAM;YACR;gBACE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACrB,MAAM;QACV,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,UAAW,SAAQ,UAAU;IACxC;;;OAGG;IACH,YAAmB,QAA2B;QAC5C,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,IAAI,CAAC,OAAe,EAAE,OAAwB;QACtD,QAAQ;QACR,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\nimport { MessageLogLevel, Success, captureResult, succeed } from '../base';\n\n/**\n * The level of logging to be used.\n * @public\n */\nexport type ReporterLogLevel = 'all' | 'detail' | 'info' | 'warning' | 'error' | 'silent';\n\n/**\n * Compares two log levels.\n * @param message - The first log level.\n * @param reporter - The second log level.\n * @returns `true` if the message should be logged, `false` if it should be suppressed.\n * @public\n */\nexport function shouldLog(message: MessageLogLevel, reporter: ReporterLogLevel): boolean {\n  if (reporter === 'all') {\n    return true; // 'all' logs everything, including 'quiet'\n  }\n  if (reporter === 'silent') {\n    return false; // 'silent' suppresses everything\n  }\n  if (message === 'quiet') {\n    return false; // 'quiet' messages only show when reporter is 'all'\n  }\n  switch (reporter) {\n    case 'error':\n      return message === 'error';\n    case 'warning':\n      return message === 'warning' || message === 'error';\n    case 'info':\n      return message !== 'detail';\n  }\n  return true;\n}\n\n/**\n * Stringifies an arbitrary value for logging.\n * @param value - The value to stringify.\n * @returns The stringified value.\n * @param maxLength - The maximum length of the stringified value.\n * @public\n */\nexport function stringifyLogValue(value: unknown, maxLength?: number): string {\n  maxLength = maxLength ?? 40;\n  if (typeof value === 'string') {\n    return value;\n  }\n  const str = String(value);\n  if (str === '[object Object]') {\n    return captureResult(() => JSON.stringify(value))\n      .onSuccess((s) => {\n        return succeed(s.length < maxLength ? s : s.substring(0, maxLength - 3) + '...');\n      })\n      .orDefault(str);\n  }\n  return str;\n}\n\n/**\n * Generic Result-aware logger interface with multiple levels of logging.\n * @public\n */\nexport interface ILogger {\n  /**\n   * The level of logging to be used.\n   */\n  readonly logLevel: ReporterLogLevel;\n\n  /**\n   * Logs a message at the given level.\n   * @param level - The level of the message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  log(level: MessageLogLevel, message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n\n  /**\n   * Logs a detail message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n\n  /**\n   * Logs an info message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  info(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n\n  /**\n   * Logs a warning message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n\n  /**\n   * Logs an error message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  error(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n}\n\n/**\n * Extended logger interface that supports logging a short summary message at a\n * primary level (error/warn) while emitting the full detail at `detail` level.\n *\n * The detail is suppressed by default (requires log level `'detail'` or `'all'`),\n * keeping the primary log clean while preserving the full context for debugging.\n * @public\n */\nexport interface IDetailLogger extends ILogger {\n  /**\n   * Logs a short error summary at `error` level, then emits `detail` at `detail` level.\n   * @param message - Short human-readable summary.\n   * @param detail - Full detail (e.g. raw converter error) logged at `detail` level.\n   */\n  errorWithDetail(message: string, detail: unknown): Success<string | undefined>;\n\n  /**\n   * Logs a short warning summary at `warning` level, then emits `detail` at `detail` level.\n   * @param message - Short human-readable summary.\n   * @param detail - Full detail logged at `detail` level.\n   */\n  warnWithDetail(message: string, detail: unknown): Success<string | undefined>;\n}\n\n/**\n * Type guard that checks whether a logger implements {@link IDetailLogger}.\n * @param logger - The logger to check.\n * @returns `true` if the logger implements `IDetailLogger`.\n * @public\n */\nexport function isDetailLogger(logger: ILogger): logger is IDetailLogger {\n  return (\n    typeof (logger as IDetailLogger).errorWithDetail === 'function' &&\n    typeof (logger as IDetailLogger).warnWithDetail === 'function'\n  );\n}\n\n/**\n * Abstract base class which implements {@link Logging.IDetailLogger | IDetailLogger}.\n * @public\n */\nexport abstract class LoggerBase implements IDetailLogger {\n  /**\n   * The level of logging to be used.\n   */\n  public logLevel: ReporterLogLevel = 'info';\n\n  protected constructor(logLevel?: ReporterLogLevel) {\n    this.logLevel = logLevel ?? 'info';\n  }\n\n  /**\n   * Logs a detail message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  public detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('detail', message, ...parameters);\n  }\n\n  /**\n   * Logs an info message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  public info(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('info', message, ...parameters);\n  }\n\n  /**\n   * Logs a warning message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  public warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('warning', message, ...parameters);\n  }\n\n  /**\n   * Logs an error message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  public error(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('error', message, ...parameters);\n  }\n\n  /**\n   * Logs a short error summary at `error` level, then emits `detail` at `detail` level.\n   * @param message - Short human-readable summary.\n   * @param detail - Full detail (e.g. raw converter error) logged at `detail` level.\n   */\n  public errorWithDetail(message: string, detail: unknown): Success<string | undefined> {\n    this.detail(detail);\n    return this.error(message);\n  }\n\n  /**\n   * Logs a short warning summary at `warning` level, then emits `detail` at `detail` level.\n   * @param message - Short human-readable summary.\n   * @param detail - Full detail logged at `detail` level.\n   */\n  public warnWithDetail(message: string, detail: unknown): Success<string | undefined> {\n    this.detail(detail);\n    return this.warn(message);\n  }\n\n  /**\n   * Logs a message at the given level.\n   * @param level - The level of the message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  public log(\n    level: MessageLogLevel,\n    message?: unknown,\n    ...parameters: unknown[]\n  ): Success<string | undefined> {\n    if (shouldLog(level, this.logLevel)) {\n      const formatted = this._format(message, ...parameters);\n      return this._log(formatted, level);\n    }\n    return this._suppressLog(level, message, ...parameters);\n  }\n\n  /**\n   * Formats a message and parameters into a string.\n   * @param message - The message to format.\n   * @param parameters - The parameters to format.\n   * @returns The formatted message.\n   * @public\n   */\n  protected _format(message?: unknown, ...parameters: unknown[]): string {\n    const raw = [message, ...parameters];\n    const filtered = raw.filter((m): m is string => m !== undefined);\n    const strings = filtered.map((m) => stringifyLogValue(m));\n    const joined = strings.join('');\n    return joined;\n  }\n\n  /**\n   * Inner method called for suppressed log messages.\n   * @public\n   */\n  protected _suppressLog(\n    __level: MessageLogLevel,\n    __message?: unknown,\n    ...__parameters: unknown[]\n  ): Success<undefined> {\n    return succeed(undefined);\n  }\n\n  /**\n   * Inner method called for logged messages. Should be implemented by derived classes.\n   * @param message - The message to log.\n   * @param level - The {@link MessageLogLevel | level} of the message.\n   * @returns `Success` with the logged message, or `Success` with `undefined` if the message is suppressed.\n   * @public\n   */\n  protected abstract _log(message: string, level: MessageLogLevel): Success<string | undefined>;\n}\n\n/**\n * An in-memory logger that stores logged and suppressed messages.\n * @public\n */\nexport class InMemoryLogger extends LoggerBase {\n  /**\n   * The messages that have been logged.\n   * @internal\n   */\n  private _logged: string[] = [];\n\n  /**\n   * The messages that have been suppressed.\n   * @internal\n   */\n  private _suppressed: string[] = [];\n\n  /**\n   * Creates a new in-memory logger.\n   * @param logLevel - The level of logging to be used.\n   */\n  public constructor(logLevel?: ReporterLogLevel) {\n    super(logLevel);\n  }\n\n  /**\n   * The messages that have been logged.\n   */\n  public get logged(): string[] {\n    return this._logged;\n  }\n\n  /**\n   * The messages that have been suppressed.\n   */\n  public get suppressed(): string[] {\n    return this._suppressed;\n  }\n\n  /**\n   * Clears the logged and suppressed messages.\n   */\n  public clear(): void {\n    this._logged = [];\n    this._suppressed = [];\n  }\n\n  /**\n   * {@inheritDoc Logging.LoggerBase._log}\n   * @internal\n   */\n  protected _log(message: string, __level: MessageLogLevel): Success<string | undefined> {\n    this._logged.push(message);\n    return succeed(message);\n  }\n\n  /**\n   * {@inheritDoc Logging.LoggerBase._suppressLog}\n   * @internal\n   */\n  protected _suppressLog(\n    level: MessageLogLevel,\n    message?: unknown,\n    ...parameters: unknown[]\n  ): Success<undefined> {\n    const formatted = this._format(message, ...parameters);\n    this._suppressed.push(formatted);\n    return succeed(undefined);\n  }\n}\n\n/**\n * A console logger that outputs messages to the console.\n * @public\n */\nexport class ConsoleLogger extends LoggerBase {\n  /**\n   * Creates a new console logger.\n   * @param logLevel - The level of logging to be used.\n   */\n  public constructor(logLevel?: ReporterLogLevel) {\n    super(logLevel);\n  }\n\n  /**\n   * {@inheritDoc Logging.LoggerBase._log}\n   * @internal\n   */\n  protected _log(message: string, level: MessageLogLevel): Success<string | undefined> {\n    switch (level) {\n      case 'error':\n        console.error(message);\n        break;\n      case 'warning':\n        console.warn(message);\n        break;\n      case 'info':\n        console.info(message);\n        break;\n      default:\n        console.log(message);\n        break;\n    }\n    return succeed(message);\n  }\n}\n\n/**\n * A no-op {@link Logging.LoggerBase | LoggerBase} that does not log anything.\n * @public\n */\nexport class NoOpLogger extends LoggerBase {\n  /**\n   * Creates a new no-op logger.\n   * @param logLevel - The level of logging to be used.\n   */\n  public constructor(logLevel?: ReporterLogLevel) {\n    super(logLevel);\n  }\n\n  /**\n   * {@inheritDoc Logging.LoggerBase._log}\n   * @internal\n   */\n  protected _log(message: string, __level: MessageLogLevel): Success<string | undefined> {\n    // no-op\n    return succeed(message);\n  }\n}\n"]}
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../src/packlets/logging/logger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAA4B,aAAa,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAQ3E;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,OAAwB,EAAE,QAA0B;IAC5E,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,CAAC,2CAA2C;IAC1D,CAAC;IACD,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,CAAC,iCAAiC;IACjD,CAAC;IACD,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC,CAAC,oDAAoD;IACpE,CAAC;IACD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,OAAO;YACV,OAAO,OAAO,KAAK,OAAO,CAAC;QAC7B,KAAK,SAAS;YACZ,OAAO,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,OAAO,CAAC;QACtD,KAAK,MAAM;YACT,OAAO,OAAO,KAAK,QAAQ,CAAC;IAChC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc,EAAE,SAAkB;IAClE,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,EAAE,CAAC;IAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,IAAI,GAAG,KAAK,iBAAiB,EAAE,CAAC;QAC9B,OAAO,aAAa,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;aAC9C,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,OAAO,OAAO,CAAC,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;QACnF,CAAC,CAAC;aACD,SAAS,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAmFD;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,MAAe;IAC5C,OAAO,CACL,OAAQ,MAAwB,CAAC,eAAe,KAAK,UAAU;QAC/D,OAAQ,MAAwB,CAAC,cAAc,KAAK,UAAU,CAC/D,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,OAAgB,UAAU;IAM9B,YAAsB,QAA2B;QALjD;;WAEG;QACI,aAAQ,GAAqB,MAAM,CAAC;QAGzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,MAAM,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACI,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,OAAe,EAAE,MAAe;QACrD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,OAAe,EAAE,MAAe;QACpD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACI,GAAG,CACR,KAAsB,EACtB,OAAiB,EACjB,GAAG,UAAqB;QAExB,IAAI,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACpC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;YACvD,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACO,OAAO,CAAC,OAAiB,EAAE,GAAG,UAAqB;QAC3D,MAAM,GAAG,GAAG,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;QACjE,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;OAWG;IACO,cAAc,CACtB,OAAwB,EACxB,WAAmB,EACnB,SAAmB,EACnB,YAAiC;QAEjC,oEAAoE;IACtE,CAAC;IAED;;;OAGG;IACO,YAAY,CACpB,OAAwB,EACxB,SAAmB,EACnB,GAAG,YAAuB;QAE1B,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;CAUF;AAED;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,UAAU;IAa5C;;;OAGG;IACH,YAAmB,QAA2B;QAC5C,KAAK,CAAC,QAAQ,CAAC,CAAC;QAjBlB;;;WAGG;QACK,YAAO,GAAa,EAAE,CAAC;QAE/B;;;WAGG;QACK,gBAAW,GAAa,EAAE,CAAC;IAQnC,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED;;;OAGG;IACO,IAAI,CAAC,OAAe,EAAE,OAAwB;QACtD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACO,YAAY,CACpB,KAAsB,EACtB,OAAiB,EACjB,GAAG,UAAqB;QAExB,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;QACvD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3C;;;OAGG;IACH,YAAmB,QAA2B;QAC5C,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,IAAI,CAAC,OAAe,EAAE,KAAsB;QACpD,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,OAAO;gBACV,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACvB,MAAM;YACR,KAAK,SAAS;gBACZ,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACtB,MAAM;YACR,KAAK,MAAM;gBACT,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACtB,MAAM;YACR;gBACE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACrB,MAAM;QACV,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,UAAW,SAAQ,UAAU;IACxC;;;OAGG;IACH,YAAmB,QAA2B;QAC5C,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,IAAI,CAAC,OAAe,EAAE,OAAwB;QACtD,QAAQ;QACR,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\nimport { MessageLogLevel, Success, captureResult, succeed } from '../base';\n\n/**\n * The level of logging to be used.\n * @public\n */\nexport type ReporterLogLevel = 'all' | 'detail' | 'info' | 'warning' | 'error' | 'silent';\n\n/**\n * Compares two log levels.\n * @param message - The first log level.\n * @param reporter - The second log level.\n * @returns `true` if the message should be logged, `false` if it should be suppressed.\n * @public\n */\nexport function shouldLog(message: MessageLogLevel, reporter: ReporterLogLevel): boolean {\n  if (reporter === 'all') {\n    return true; // 'all' logs everything, including 'quiet'\n  }\n  if (reporter === 'silent') {\n    return false; // 'silent' suppresses everything\n  }\n  if (message === 'quiet') {\n    return false; // 'quiet' messages only show when reporter is 'all'\n  }\n  switch (reporter) {\n    case 'error':\n      return message === 'error';\n    case 'warning':\n      return message === 'warning' || message === 'error';\n    case 'info':\n      return message !== 'detail';\n  }\n  return true;\n}\n\n/**\n * Stringifies an arbitrary value for logging.\n * @param value - The value to stringify.\n * @returns The stringified value.\n * @param maxLength - The maximum length of the stringified value.\n * @public\n */\nexport function stringifyLogValue(value: unknown, maxLength?: number): string {\n  maxLength = maxLength ?? 40;\n  if (typeof value === 'string') {\n    return value;\n  }\n  const str = String(value);\n  if (str === '[object Object]') {\n    return captureResult(() => JSON.stringify(value))\n      .onSuccess((s) => {\n        return succeed(s.length < maxLength ? s : s.substring(0, maxLength - 3) + '...');\n      })\n      .orDefault(str);\n  }\n  return str;\n}\n\n/**\n * Generic Result-aware logger interface with multiple levels of logging.\n * @public\n */\nexport interface ILogger {\n  /**\n   * The level of logging to be used.\n   */\n  readonly logLevel: ReporterLogLevel;\n\n  /**\n   * Logs a message at the given level.\n   * @param level - The level of the message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  log(level: MessageLogLevel, message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n\n  /**\n   * Logs a detail message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n\n  /**\n   * Logs an info message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  info(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n\n  /**\n   * Logs a warning message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n\n  /**\n   * Logs an error message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  error(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;\n}\n\n/**\n * Extended logger interface that supports logging a short summary message at a\n * primary level (error/warn) while emitting the full detail at `detail` level.\n *\n * The detail is suppressed by default (requires log level `'detail'` or `'all'`),\n * keeping the primary log clean while preserving the full context for debugging.\n * @public\n */\nexport interface IDetailLogger extends ILogger {\n  /**\n   * Logs a short error summary at `error` level, then emits `detail` at `detail` level.\n   * @param message - Short human-readable summary.\n   * @param detail - Full detail (e.g. raw converter error) logged at `detail` level.\n   */\n  errorWithDetail(message: string, detail: unknown): Success<string | undefined>;\n\n  /**\n   * Logs a short warning summary at `warning` level, then emits `detail` at `detail` level.\n   * @param message - Short human-readable summary.\n   * @param detail - Full detail logged at `detail` level.\n   */\n  warnWithDetail(message: string, detail: unknown): Success<string | undefined>;\n}\n\n/**\n * Type guard that checks whether a logger implements {@link IDetailLogger}.\n * @param logger - The logger to check.\n * @returns `true` if the logger implements `IDetailLogger`.\n * @public\n */\nexport function isDetailLogger(logger: ILogger): logger is IDetailLogger {\n  return (\n    typeof (logger as IDetailLogger).errorWithDetail === 'function' &&\n    typeof (logger as IDetailLogger).warnWithDetail === 'function'\n  );\n}\n\n/**\n * Abstract base class which implements {@link Logging.IDetailLogger | IDetailLogger}.\n * @public\n */\nexport abstract class LoggerBase implements IDetailLogger {\n  /**\n   * The level of logging to be used.\n   */\n  public logLevel: ReporterLogLevel = 'info';\n\n  protected constructor(logLevel?: ReporterLogLevel) {\n    this.logLevel = logLevel ?? 'info';\n  }\n\n  /**\n   * Logs a detail message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  public detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('detail', message, ...parameters);\n  }\n\n  /**\n   * Logs an info message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  public info(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('info', message, ...parameters);\n  }\n\n  /**\n   * Logs a warning message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  public warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('warning', message, ...parameters);\n  }\n\n  /**\n   * Logs an error message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  public error(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('error', message, ...parameters);\n  }\n\n  /**\n   * Logs a short error summary at `error` level, then emits `detail` at `detail` level.\n   * @param message - Short human-readable summary.\n   * @param detail - Full detail (e.g. raw converter error) logged at `detail` level.\n   */\n  public errorWithDetail(message: string, detail: unknown): Success<string | undefined> {\n    this.detail(detail);\n    return this.error(message);\n  }\n\n  /**\n   * Logs a short warning summary at `warning` level, then emits `detail` at `detail` level.\n   * @param message - Short human-readable summary.\n   * @param detail - Full detail logged at `detail` level.\n   */\n  public warnWithDetail(message: string, detail: unknown): Success<string | undefined> {\n    this.detail(detail);\n    return this.warn(message);\n  }\n\n  /**\n   * Logs a message at the given level.\n   * @param level - The level of the message.\n   * @param message - The message to log.\n   * @param parameters - The parameters to log.\n   * @returns `Success` with the logged message if the level is enabled, or\n   * `Success` with `undefined` if the message is suppressed.\n   */\n  public log(\n    level: MessageLogLevel,\n    message?: unknown,\n    ...parameters: unknown[]\n  ): Success<string | undefined> {\n    if (shouldLog(level, this.logLevel)) {\n      const formatted = this._format(message, ...parameters);\n      this._logStructured(level, formatted, message, parameters);\n      return this._log(formatted, level);\n    }\n    return this._suppressLog(level, message, ...parameters);\n  }\n\n  /**\n   * Formats a message and parameters into a string.\n   * @param message - The message to format.\n   * @param parameters - The parameters to format.\n   * @returns The formatted message.\n   * @public\n   */\n  protected _format(message?: unknown, ...parameters: unknown[]): string {\n    const raw = [message, ...parameters];\n    const filtered = raw.filter((m): m is string => m !== undefined);\n    const strings = filtered.map((m) => stringifyLogValue(m));\n    const joined = strings.join('');\n    return joined;\n  }\n\n  /**\n   * Inner hook called for logged messages alongside {@link Logging.LoggerBase._log | _log},\n   * exposing the structured `(level, formatted, message, parameters)` form before it is\n   * collapsed to the formatted string. The default implementation is a no-op; subclasses\n   * that need to retain structured records (e.g. {@link Logging.RetainingLogger | RetainingLogger})\n   * override this. Fired only in the `shouldLog` branch, so suppressed messages never reach it.\n   * @param __level - The {@link MessageLogLevel | level} of the message.\n   * @param __formatted - The formatted message (same string passed to `_log`).\n   * @param __message - The raw message argument before formatting.\n   * @param __parameters - The raw parameter arguments before formatting.\n   * @public\n   */\n  protected _logStructured(\n    __level: MessageLogLevel,\n    __formatted: string,\n    __message?: unknown,\n    __parameters?: readonly unknown[]\n  ): void {\n    /* no-op; subclasses that retain structured records override this */\n  }\n\n  /**\n   * Inner method called for suppressed log messages.\n   * @public\n   */\n  protected _suppressLog(\n    __level: MessageLogLevel,\n    __message?: unknown,\n    ...__parameters: unknown[]\n  ): Success<undefined> {\n    return succeed(undefined);\n  }\n\n  /**\n   * Inner method called for logged messages. Should be implemented by derived classes.\n   * @param message - The message to log.\n   * @param level - The {@link MessageLogLevel | level} of the message.\n   * @returns `Success` with the logged message, or `Success` with `undefined` if the message is suppressed.\n   * @public\n   */\n  protected abstract _log(message: string, level: MessageLogLevel): Success<string | undefined>;\n}\n\n/**\n * An in-memory logger that stores logged and suppressed messages.\n * @public\n */\nexport class InMemoryLogger extends LoggerBase {\n  /**\n   * The messages that have been logged.\n   * @internal\n   */\n  private _logged: string[] = [];\n\n  /**\n   * The messages that have been suppressed.\n   * @internal\n   */\n  private _suppressed: string[] = [];\n\n  /**\n   * Creates a new in-memory logger.\n   * @param logLevel - The level of logging to be used.\n   */\n  public constructor(logLevel?: ReporterLogLevel) {\n    super(logLevel);\n  }\n\n  /**\n   * The messages that have been logged.\n   */\n  public get logged(): string[] {\n    return this._logged;\n  }\n\n  /**\n   * The messages that have been suppressed.\n   */\n  public get suppressed(): string[] {\n    return this._suppressed;\n  }\n\n  /**\n   * Clears the logged and suppressed messages.\n   */\n  public clear(): void {\n    this._logged = [];\n    this._suppressed = [];\n  }\n\n  /**\n   * {@inheritDoc Logging.LoggerBase._log}\n   * @internal\n   */\n  protected _log(message: string, __level: MessageLogLevel): Success<string | undefined> {\n    this._logged.push(message);\n    return succeed(message);\n  }\n\n  /**\n   * {@inheritDoc Logging.LoggerBase._suppressLog}\n   * @internal\n   */\n  protected _suppressLog(\n    level: MessageLogLevel,\n    message?: unknown,\n    ...parameters: unknown[]\n  ): Success<undefined> {\n    const formatted = this._format(message, ...parameters);\n    this._suppressed.push(formatted);\n    return succeed(undefined);\n  }\n}\n\n/**\n * A console logger that outputs messages to the console.\n * @public\n */\nexport class ConsoleLogger extends LoggerBase {\n  /**\n   * Creates a new console logger.\n   * @param logLevel - The level of logging to be used.\n   */\n  public constructor(logLevel?: ReporterLogLevel) {\n    super(logLevel);\n  }\n\n  /**\n   * {@inheritDoc Logging.LoggerBase._log}\n   * @internal\n   */\n  protected _log(message: string, level: MessageLogLevel): Success<string | undefined> {\n    switch (level) {\n      case 'error':\n        console.error(message);\n        break;\n      case 'warning':\n        console.warn(message);\n        break;\n      case 'info':\n        console.info(message);\n        break;\n      default:\n        console.log(message);\n        break;\n    }\n    return succeed(message);\n  }\n}\n\n/**\n * A no-op {@link Logging.LoggerBase | LoggerBase} that does not log anything.\n * @public\n */\nexport class NoOpLogger extends LoggerBase {\n  /**\n   * Creates a new no-op logger.\n   * @param logLevel - The level of logging to be used.\n   */\n  public constructor(logLevel?: ReporterLogLevel) {\n    super(logLevel);\n  }\n\n  /**\n   * {@inheritDoc Logging.LoggerBase._log}\n   * @internal\n   */\n  protected _log(message: string, __level: MessageLogLevel): Success<string | undefined> {\n    // no-op\n    return succeed(message);\n  }\n}\n"]}

package/dist/packlets/logging/multiLogger.js

@@ -0,0 +1,104 @@
+/*
+ * Copyright (c) 2020 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { succeed } from '../base';
+/**
+ * Verbosity rank for each {@link Logging.ReporterLogLevel | ReporterLogLevel}, materializing
+ * the {@link Logging.shouldLog | shouldLog} ordering. A higher rank is more permissive
+ * (emits strictly more message levels).
+ * @internal
+ */
+const verbosityRank = {
+    silent: 0,
+    error: 1,
+    warning: 2,
+    info: 3,
+    detail: 4,
+    all: 5
+};
+/**
+ * An {@link Logging.ILogger | ILogger} that fans every log call out to N child loggers,
+ * each applying its own threshold.
+ *
+ * @remarks
+ * The composite does not pre-filter — it forwards the raw `(level, message, ...params)`
+ * to each child's public method so each child formats and filters per its own rules.
+ * This lets a single pinned logger feed, for example, a {@link Logging.ConsoleLogger | ConsoleLogger}
+ * (stdout) and a {@link Logging.RetainingLogger | RetainingLogger} (observability buffer)
+ * with independent log levels.
+ *
+ * @public
+ */
+export class MultiLogger {
+    /**
+     * Creates a new multi logger.
+     * @param loggers - The child loggers to fan calls out to.
+     */
+    constructor(loggers) {
+        this._loggers = [...loggers];
+    }
+    /**
+     * The most-verbose (most-permissive) level among the children, so an upstream
+     * `shouldLog` gate does not suppress a call before it can fan out to a more
+     * permissive child. Computed on access, since a child's level may change.
+     */
+    get logLevel() {
+        return this._loggers.reduce((most, logger) => (verbosityRank[logger.logLevel] > verbosityRank[most] ? logger.logLevel : most), 'silent');
+    }
+    /**
+     * {@inheritDoc Logging.ILogger.log}
+     */
+    log(level, message, ...parameters) {
+        let logged;
+        for (const logger of this._loggers) {
+            const value = logger.log(level, message, ...parameters).value;
+            if (value !== undefined) {
+                logged = value;
+            }
+        }
+        return succeed(logged);
+    }
+    /**
+     * {@inheritDoc Logging.ILogger.detail}
+     */
+    detail(message, ...parameters) {
+        return this.log('detail', message, ...parameters);
+    }
+    /**
+     * {@inheritDoc Logging.ILogger.info}
+     */
+    info(message, ...parameters) {
+        return this.log('info', message, ...parameters);
+    }
+    /**
+     * {@inheritDoc Logging.ILogger.warn}
+     */
+    warn(message, ...parameters) {
+        return this.log('warning', message, ...parameters);
+    }
+    /**
+     * {@inheritDoc Logging.ILogger.error}
+     */
+    error(message, ...parameters) {
+        return this.log('error', message, ...parameters);
+    }
+}
+//# sourceMappingURL=multiLogger.js.map

package/dist/packlets/logging/multiLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multiLogger.js","sourceRoot":"","sources":["../../../src/packlets/logging/multiLogger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAA4B,OAAO,EAAE,MAAM,SAAS,CAAC;AAG5D;;;;;GAKG;AACH,MAAM,aAAa,GAAqC;IACtD,MAAM,EAAE,CAAC;IACT,KAAK,EAAE,CAAC;IACR,OAAO,EAAE,CAAC;IACV,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;IACT,GAAG,EAAE,CAAC;CACP,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,WAAW;IAOtB;;;OAGG;IACH,YAAmB,OAA+B;QAChD,IAAI,CAAC,QAAQ,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CACzB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,EACjG,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,GAAG,CACR,KAAsB,EACtB,OAAiB,EACjB,GAAG,UAAqB;QAExB,IAAI,MAA0B,CAAC;QAC/B,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC,KAAK,CAAC;YAC9D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,GAAG,KAAK,CAAC;YACjB,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACnD,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\nimport { MessageLogLevel, Success, succeed } from '../base';\nimport { ILogger, ReporterLogLevel } from './logger';\n\n/**\n * Verbosity rank for each {@link Logging.ReporterLogLevel | ReporterLogLevel}, materializing\n * the {@link Logging.shouldLog | shouldLog} ordering. A higher rank is more permissive\n * (emits strictly more message levels).\n * @internal\n */\nconst verbosityRank: Record<ReporterLogLevel, number> = {\n  silent: 0,\n  error: 1,\n  warning: 2,\n  info: 3,\n  detail: 4,\n  all: 5\n};\n\n/**\n * An {@link Logging.ILogger | ILogger} that fans every log call out to N child loggers,\n * each applying its own threshold.\n *\n * @remarks\n * The composite does not pre-filter — it forwards the raw `(level, message, ...params)`\n * to each child's public method so each child formats and filters per its own rules.\n * This lets a single pinned logger feed, for example, a {@link Logging.ConsoleLogger | ConsoleLogger}\n * (stdout) and a {@link Logging.RetainingLogger | RetainingLogger} (observability buffer)\n * with independent log levels.\n *\n * @public\n */\nexport class MultiLogger implements ILogger {\n  /**\n   * The child loggers calls are fanned out to.\n   * @internal\n   */\n  private readonly _loggers: ReadonlyArray<ILogger>;\n\n  /**\n   * Creates a new multi logger.\n   * @param loggers - The child loggers to fan calls out to.\n   */\n  public constructor(loggers: ReadonlyArray<ILogger>) {\n    this._loggers = [...loggers];\n  }\n\n  /**\n   * The most-verbose (most-permissive) level among the children, so an upstream\n   * `shouldLog` gate does not suppress a call before it can fan out to a more\n   * permissive child. Computed on access, since a child's level may change.\n   */\n  public get logLevel(): ReporterLogLevel {\n    return this._loggers.reduce<ReporterLogLevel>(\n      (most, logger) => (verbosityRank[logger.logLevel] > verbosityRank[most] ? logger.logLevel : most),\n      'silent'\n    );\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.log}\n   */\n  public log(\n    level: MessageLogLevel,\n    message?: unknown,\n    ...parameters: unknown[]\n  ): Success<string | undefined> {\n    let logged: string | undefined;\n    for (const logger of this._loggers) {\n      const value = logger.log(level, message, ...parameters).value;\n      if (value !== undefined) {\n        logged = value;\n      }\n    }\n    return succeed(logged);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.detail}\n   */\n  public detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('detail', message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.info}\n   */\n  public info(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('info', message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.warn}\n   */\n  public warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('warning', message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.error}\n   */\n  public error(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('error', message, ...parameters);\n  }\n}\n"]}

package/dist/packlets/logging/retainingLogger.js

@@ -0,0 +1,161 @@
+/*
+ * Copyright (c) 2020 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { succeed } from '../base';
+import { LoggerBase, shouldLog } from './logger';
+/**
+ * An {@link Logging.ILogger | ILogger} that retains structured log records in a bounded
+ * most-recent-N ring, with a query API supporting min-severity filtering and
+ * since-cursor incremental paging.
+ *
+ * @remarks
+ * Records are captured via the {@link Logging.LoggerBase._logStructured | _logStructured} hook,
+ * so the full structured form (`level` + formatted `message` + raw `args`) is retained.
+ * The logger emits nowhere itself — pair it with a {@link Logging.MultiLogger | MultiLogger}
+ * to also feed a {@link Logging.ConsoleLogger | ConsoleLogger} or other durable sink.
+ *
+ * @public
+ */
+export class RetainingLogger extends LoggerBase {
+    /**
+     * Creates a new retaining logger.
+     * @param logLevel - The level of logging to retain. Defaults to `'detail'` to capture
+     * broadly and filter at query time.
+     * @param maxRecords - The maximum number of records to retain. Defaults to `1000`.
+     * @param now - Injected clock returning milliseconds since epoch. Defaults to `Date.now`.
+     */
+    constructor(logLevel = 'detail', maxRecords = 1000, now = () => Date.now()) {
+        super(logLevel);
+        /**
+         * The backing store, used as a circular buffer. Grows lazily up to `_capacity`,
+         * after which records overwrite the oldest slot in place — eviction is O(1), with
+         * no `shift()` re-indexing regardless of capacity.
+         * @internal
+         */
+        this._buffer = [];
+        /**
+         * Index of the oldest retained record within `_buffer` once the ring is full.
+         * @internal
+         */
+        this._head = 0;
+        /**
+         * The number of valid records currently retained (`<= _capacity`).
+         * @internal
+         */
+        this._count = 0;
+        /**
+         * The most recently assigned sequence number; monotonic, stable across eviction
+         * and {@link Logging.RetainingLogger.clear | clear()}.
+         * @internal
+         */
+        this._lastSeq = 0;
+        // The ring requires a positive integer capacity to be well-defined; a non-finite
+        // or sub-1 value would make the modular index arithmetic meaningless, so floor it
+        // to a sane minimum of 1 rather than crash on degenerate input.
+        this._capacity = Number.isFinite(maxRecords) && maxRecords >= 1 ? Math.floor(maxRecords) : 1;
+        this._now = now;
+    }
+    /**
+     * The retained records, oldest-first.
+     */
+    get records() {
+        return this._toOrderedArray();
+    }
+    /**
+     * The most recently assigned sequence number. A client can hold this value and
+     * pass it as `sinceSeq` to page only records logged afterward.
+     */
+    get lastSeq() {
+        return this._lastSeq;
+    }
+    /**
+     * Returns retained records, oldest-first, optionally filtered.
+     * @param options - {@link Logging.IGetRecordsOptions | Filtering and paging options}.
+     * @returns The matching records, oldest-first.
+     */
+    getRecords(options) {
+        let result = this._toOrderedArray();
+        if ((options === null || options === void 0 ? void 0 : options.minLevel) !== undefined) {
+            const minLevel = options.minLevel;
+            result = result.filter((r) => shouldLog(r.level, minLevel));
+        }
+        if ((options === null || options === void 0 ? void 0 : options.sinceSeq) !== undefined) {
+            const sinceSeq = options.sinceSeq;
+            result = result.filter((r) => r.seq > sinceSeq);
+        }
+        if ((options === null || options === void 0 ? void 0 : options.limit) !== undefined && result.length > options.limit) {
+            result = result.slice(result.length - options.limit);
+        }
+        return result;
+    }
+    /**
+     * Clears all retained records. Does NOT reset the sequence counter, so a client
+     * holding a `sinceSeq` cursor never re-sees a sequence number.
+     */
+    clear() {
+        this._buffer = [];
+        this._head = 0;
+        this._count = 0;
+    }
+    /**
+     * Materializes the ring into a plain oldest-first array.
+     * @internal
+     */
+    _toOrderedArray() {
+        const result = [];
+        for (let i = 0; i < this._count; i++) {
+            result.push(this._buffer[(this._head + i) % this._capacity]);
+        }
+        return result;
+    }
+    /**
+     * {@inheritDoc Logging.LoggerBase._logStructured}
+     * @internal
+     */
+    _logStructured(level, formatted, message, parameters) {
+        this._lastSeq += 1;
+        const record = {
+            seq: this._lastSeq,
+            timestamp: this._now(),
+            level,
+            message: formatted,
+            args: [message, ...parameters]
+        };
+        if (this._count < this._capacity) {
+            // Still filling: append to the next free slot (head stays 0 during this phase).
+            this._buffer.push(record);
+            this._count += 1;
+        }
+        else {
+            // Full: overwrite the oldest record in place and advance the head.
+            this._buffer[this._head] = record;
+            this._head = (this._head + 1) % this._capacity;
+        }
+    }
+    /**
+     * {@inheritDoc Logging.LoggerBase._log}
+     * @internal
+     */
+    _log(message, __level) {
+        return succeed(message);
+    }
+}
+//# sourceMappingURL=retainingLogger.js.map

package/dist/packlets/logging/retainingLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retainingLogger.js","sourceRoot":"","sources":["../../../src/packlets/logging/retainingLogger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAA4B,OAAO,EAAE,MAAM,SAAS,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAoB,SAAS,EAAE,MAAM,UAAU,CAAC;AAoDnE;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,eAAgB,SAAQ,UAAU;IAyC7C;;;;;;OAMG;IACH,YACE,WAA6B,QAAQ,EACrC,aAAqB,IAAI,EACzB,MAAoB,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;QAEpC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAvClB;;;;;WAKG;QACK,YAAO,GAAiB,EAAE,CAAC;QAEnC;;;WAGG;QACK,UAAK,GAAW,CAAC,CAAC;QAE1B;;;WAGG;QACK,WAAM,GAAW,CAAC,CAAC;QAE3B;;;;WAIG;QACK,aAAQ,GAAW,CAAC,CAAC;QAe3B,iFAAiF;QACjF,kFAAkF;QAClF,gEAAgE;QAChE,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7F,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,OAA4B;QAC5C,IAAI,MAAM,GAA8B,IAAI,CAAC,eAAe,EAAE,CAAC;QAC/D,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,MAAK,SAAS,EAAE,CAAC;YACpC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAClC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,MAAK,SAAS,EAAE,CAAC;YACpC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAClC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,QAAQ,CAAC,CAAC;QAClD,CAAC;QACD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,MAAK,SAAS,IAAI,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;YAClE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAED;;;OAGG;IACK,eAAe;QACrB,MAAM,MAAM,GAAiB,EAAE,CAAC;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACO,cAAc,CACtB,KAAsB,EACtB,SAAiB,EACjB,OAAgB,EAChB,UAA8B;QAE9B,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;QACnB,MAAM,MAAM,GAAe;YACzB,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,SAAS,EAAE,IAAI,CAAC,IAAI,EAAE;YACtB,KAAK;YACL,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC;SAC/B,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YACjC,gFAAgF;YAChF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC1B,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,mEAAmE;YACnE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;YAClC,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;QACjD,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,IAAI,CAAC,OAAe,EAAE,OAAwB;QACtD,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\nimport { MessageLogLevel, Success, succeed } from '../base';\nimport { LoggerBase, ReporterLogLevel, shouldLog } from './logger';\n\n/**\n * A retained log record. Preserves the level and an ordering cursor so consumers\n * can filter by severity and page incrementally.\n * @public\n */\nexport interface ILogRecord {\n  /**\n   * Monotonic 1-based sequence number, stable across ring eviction.\n   */\n  readonly seq: number;\n  /**\n   * Milliseconds since epoch when the record was logged (from the injected clock).\n   */\n  readonly timestamp: number;\n  /**\n   * The level the record was logged at.\n   */\n  readonly level: MessageLogLevel;\n  /**\n   * The formatted message (same formatting {@link Logging.LoggerBase._format | LoggerBase._format} produces).\n   */\n  readonly message: string;\n  /**\n   * The raw structured inputs `[message, ...parameters]` before formatting.\n   */\n  readonly args?: readonly unknown[];\n}\n\n/**\n * Options for {@link Logging.RetainingLogger.getRecords | RetainingLogger.getRecords}.\n * @public\n */\nexport interface IGetRecordsOptions {\n  /**\n   * If supplied, only records whose level would be emitted at this threshold\n   * (per {@link Logging.shouldLog | shouldLog}) are returned.\n   */\n  readonly minLevel?: ReporterLogLevel;\n  /**\n   * If supplied, only records with `seq > sinceSeq` are returned, enabling\n   * incremental paging from a previously-held cursor.\n   */\n  readonly sinceSeq?: number;\n  /**\n   * If supplied, returns at most this many records — the most recent N (tail),\n   * still ordered oldest-first.\n   */\n  readonly limit?: number;\n}\n\n/**\n * An {@link Logging.ILogger | ILogger} that retains structured log records in a bounded\n * most-recent-N ring, with a query API supporting min-severity filtering and\n * since-cursor incremental paging.\n *\n * @remarks\n * Records are captured via the {@link Logging.LoggerBase._logStructured | _logStructured} hook,\n * so the full structured form (`level` + formatted `message` + raw `args`) is retained.\n * The logger emits nowhere itself — pair it with a {@link Logging.MultiLogger | MultiLogger}\n * to also feed a {@link Logging.ConsoleLogger | ConsoleLogger} or other durable sink.\n *\n * @public\n */\nexport class RetainingLogger extends LoggerBase {\n  /**\n   * The fixed ring capacity — the maximum number of records retained before the\n   * oldest is overwritten. A positive integer (see the constructor normalization).\n   * @internal\n   */\n  private readonly _capacity: number;\n\n  /**\n   * Injected clock used to timestamp records.\n   * @internal\n   */\n  private readonly _now: () => number;\n\n  /**\n   * The backing store, used as a circular buffer. Grows lazily up to `_capacity`,\n   * after which records overwrite the oldest slot in place — eviction is O(1), with\n   * no `shift()` re-indexing regardless of capacity.\n   * @internal\n   */\n  private _buffer: ILogRecord[] = [];\n\n  /**\n   * Index of the oldest retained record within `_buffer` once the ring is full.\n   * @internal\n   */\n  private _head: number = 0;\n\n  /**\n   * The number of valid records currently retained (`<= _capacity`).\n   * @internal\n   */\n  private _count: number = 0;\n\n  /**\n   * The most recently assigned sequence number; monotonic, stable across eviction\n   * and {@link Logging.RetainingLogger.clear | clear()}.\n   * @internal\n   */\n  private _lastSeq: number = 0;\n\n  /**\n   * Creates a new retaining logger.\n   * @param logLevel - The level of logging to retain. Defaults to `'detail'` to capture\n   * broadly and filter at query time.\n   * @param maxRecords - The maximum number of records to retain. Defaults to `1000`.\n   * @param now - Injected clock returning milliseconds since epoch. Defaults to `Date.now`.\n   */\n  public constructor(\n    logLevel: ReporterLogLevel = 'detail',\n    maxRecords: number = 1000,\n    now: () => number = () => Date.now()\n  ) {\n    super(logLevel);\n    // The ring requires a positive integer capacity to be well-defined; a non-finite\n    // or sub-1 value would make the modular index arithmetic meaningless, so floor it\n    // to a sane minimum of 1 rather than crash on degenerate input.\n    this._capacity = Number.isFinite(maxRecords) && maxRecords >= 1 ? Math.floor(maxRecords) : 1;\n    this._now = now;\n  }\n\n  /**\n   * The retained records, oldest-first.\n   */\n  public get records(): ReadonlyArray<ILogRecord> {\n    return this._toOrderedArray();\n  }\n\n  /**\n   * The most recently assigned sequence number. A client can hold this value and\n   * pass it as `sinceSeq` to page only records logged afterward.\n   */\n  public get lastSeq(): number {\n    return this._lastSeq;\n  }\n\n  /**\n   * Returns retained records, oldest-first, optionally filtered.\n   * @param options - {@link Logging.IGetRecordsOptions | Filtering and paging options}.\n   * @returns The matching records, oldest-first.\n   */\n  public getRecords(options?: IGetRecordsOptions): ReadonlyArray<ILogRecord> {\n    let result: ReadonlyArray<ILogRecord> = this._toOrderedArray();\n    if (options?.minLevel !== undefined) {\n      const minLevel = options.minLevel;\n      result = result.filter((r) => shouldLog(r.level, minLevel));\n    }\n    if (options?.sinceSeq !== undefined) {\n      const sinceSeq = options.sinceSeq;\n      result = result.filter((r) => r.seq > sinceSeq);\n    }\n    if (options?.limit !== undefined && result.length > options.limit) {\n      result = result.slice(result.length - options.limit);\n    }\n    return result;\n  }\n\n  /**\n   * Clears all retained records. Does NOT reset the sequence counter, so a client\n   * holding a `sinceSeq` cursor never re-sees a sequence number.\n   */\n  public clear(): void {\n    this._buffer = [];\n    this._head = 0;\n    this._count = 0;\n  }\n\n  /**\n   * Materializes the ring into a plain oldest-first array.\n   * @internal\n   */\n  private _toOrderedArray(): ILogRecord[] {\n    const result: ILogRecord[] = [];\n    for (let i = 0; i < this._count; i++) {\n      result.push(this._buffer[(this._head + i) % this._capacity]);\n    }\n    return result;\n  }\n\n  /**\n   * {@inheritDoc Logging.LoggerBase._logStructured}\n   * @internal\n   */\n  protected _logStructured(\n    level: MessageLogLevel,\n    formatted: string,\n    message: unknown,\n    parameters: readonly unknown[]\n  ): void {\n    this._lastSeq += 1;\n    const record: ILogRecord = {\n      seq: this._lastSeq,\n      timestamp: this._now(),\n      level,\n      message: formatted,\n      args: [message, ...parameters]\n    };\n    if (this._count < this._capacity) {\n      // Still filling: append to the next free slot (head stays 0 during this phase).\n      this._buffer.push(record);\n      this._count += 1;\n    } else {\n      // Full: overwrite the oldest record in place and advance the head.\n      this._buffer[this._head] = record;\n      this._head = (this._head + 1) % this._capacity;\n    }\n  }\n\n  /**\n   * {@inheritDoc Logging.LoggerBase._log}\n   * @internal\n   */\n  protected _log(message: string, __level: MessageLogLevel): Success<string | undefined> {\n    return succeed(message);\n  }\n}\n"]}