@fgv/ts-utils 5.0.1-1 → 5.0.1-2

package/dist/ts-utils.d.ts

@@ -1114,7 +1114,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
               /**
                * {@inheritdoc IResult.report}
                */
-              report(reporter?: IResultReporter<T, TD>, options?: IResultReportOptions<TD>): this;
+              report(reporter?: IResultReporter<T, unknown>, options?: IResultReportOptions<unknown>): DetailedFailure<T, TD>;
               orThrow(logOrFormat?: IResultLogger<TD> | ErrorFormatter<TD>): never;
               orThrow(cb: ErrorFormatter): never;
               /**
@@ -1206,7 +1206,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
               /**
                * {@inheritdoc IResult.report}
                */
-              report(reporter?: IResultReporter<T, TD>, options?: IResultReportOptions<TD>): this;
+              report(reporter?: IResultReporter<T, unknown>, options?: IResultReportOptions<unknown>): DetailedSuccess<T, TD>;
               /**
                * Creates a {@link DetailedSuccess | DetailedSuccess<T, TD>} with the supplied value and
                * optional detail.
@@ -1406,7 +1406,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
               /**
                * {@inheritdoc IResult.report}
                */
-              report(reporter?: IResultReporter<T>, options?: IResultReportOptions): this;
+              report(reporter?: IResultReporter<T>, options?: IResultReportOptions<unknown>): Failure<T>;
               /**
                * Get a 'friendly' string representation of this object.
                * @remarks
@@ -1967,6 +1967,16 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
               toString(separator?: string): string;
           }
 
+          /**
+           * Details for reporting a message.
+           * @public
+           */
+          export declare interface IMessageReportDetail<TD = unknown> {
+              level?: MessageLogLevel;
+              message?: ErrorFormatter<TD>;
+              detail?: TD;
+          }
+
           /**
            * Infers the type that will be returned by an instantiated converter.  Works
            * for complex as well as simple types.
@@ -2345,7 +2355,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                * @param reporter - The {@link IResultReporter | reporter} to which the result will be reported.
                * @param options - The {@link IResultReportOptions | options} for reporting the result.
                */
-              report(reporter?: IResultReporter<T>, options?: IResultReportOptions): this;
+              report(reporter?: IResultReporter<T>, options?: IResultReportOptions<unknown>): Result<T>;
           }
 
           /**
@@ -2382,7 +2392,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
            * @public
            */
           export declare interface IResultReporter<T, TD = unknown> {
-              reportSuccess(level: MessageLogLevel, value: T, detail?: TD): void;
+              reportSuccess(level: MessageLogLevel, value: T, detail?: TD, message?: ErrorFormatter<TD>): void;
               reportFailure(level: MessageLogLevel, message: string, detail?: TD): void;
           }
 
@@ -2394,15 +2404,11 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
               /**
                * The level of reporting to be used for failure results.  Default is 'error'.
                */
-              failure?: MessageLogLevel;
+              failure?: MessageLogLevel | IMessageReportDetail<TD>;
               /**
                * The level of reporting to be used for success results.  Default is 'quiet'.
                */
-              success?: MessageLogLevel;
-              /**
-               * The error formatter to be used for reporting an error result.
-               */
-              message?: ErrorFormatter<TD>;
+              success?: MessageLogLevel | IMessageReportDetail<TD>;
           }
 
           /**
@@ -2681,10 +2687,10 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
            */
           declare class LogReporter<T, TD = unknown> implements ILogger, IResultReporter<T, TD> {
               /**
-               * The logger to wrap.
-               * @internal
+               * Base logger used to by this reporter.
+               * @public
                */
-              protected readonly _logger: ILogger;
+              readonly logger: ILogger;
               /**
                * The formatter to use for values.
                * @internal
@@ -2727,11 +2733,17 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
               /**
                * {@inheritDoc IResultReporter.reportSuccess}
                */
-              reportSuccess(level: MessageLogLevel, value: T, detail?: TD): void;
+              reportSuccess(level: MessageLogLevel, value: T, detail?: TD, message?: ErrorFormatter<TD>): void;
               /**
                * {@inheritDoc IResultReporter.reportFailure}
                */
               reportFailure(level: MessageLogLevel, message: string, detail?: TD): void;
+              /**
+               * Creates a new {@link Logging.LogReporter | LogReporter} with the same logger but a different value formatter.
+               * @param valueFormatter - The value formatter to use.
+               * @returns A new {@link Logging.LogReporter | LogReporter} with the same logger but a different value formatter.
+               */
+              withValueFormatter<TN>(valueFormatter: LogValueFormatter<TN, TD>): LogReporter<TN, TD>;
               /**
                * Generic method to try to format an object for logging.
                * @param value - The value to format.
@@ -4232,7 +4244,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                                  /**
                                   * {@inheritdoc IResult.report}
                                   */
-                                 report(reporter?: IResultReporter<T>, options?: IResultReportOptions): this;
+                                 report(reporter?: IResultReporter<T>, options?: IResultReportOptions<unknown>): Success<T>;
                                  /**
                                   * Creates a {@link Success | Success<T>} with the supplied value.
                                   * @param value - The value to be returned.

package/lib/packlets/base/result.d.ts

@@ -58,6 +58,15 @@ export interface IResultLogger<TD = unknown> {
  * @public
  */
 export type MessageLogLevel = 'quiet' | 'detail' | 'info' | 'warning' | 'error';
+/**
+ * Details for reporting a message.
+ * @public
+ */
+export interface IMessageReportDetail<TD = unknown> {
+    level?: MessageLogLevel;
+    message?: ErrorFormatter<TD>;
+    detail?: TD;
+}
 /**
  * Options for reporting a result.
  * @public
@@ -66,22 +75,18 @@ export interface IResultReportOptions<TD = unknown> {
     /**
      * The level of reporting to be used for failure results.  Default is 'error'.
      */
-    failure?: MessageLogLevel;
+    failure?: MessageLogLevel | IMessageReportDetail<TD>;
     /**
      * The level of reporting to be used for success results.  Default is 'quiet'.
      */
-    success?: MessageLogLevel;
-    /**
-     * The error formatter to be used for reporting an error result.
-     */
-    message?: ErrorFormatter<TD>;
+    success?: MessageLogLevel | IMessageReportDetail<TD>;
 }
 /**
  * Interface for reporting a result.
  * @public
  */
 export interface IResultReporter<T, TD = unknown> {
-    reportSuccess(level: MessageLogLevel, value: T, detail?: TD): void;
+    reportSuccess(level: MessageLogLevel, value: T, detail?: TD, message?: ErrorFormatter<TD>): void;
     reportFailure(level: MessageLogLevel, message: string, detail?: TD): void;
 }
 /**
@@ -286,7 +291,7 @@ export interface IResult<T> {
      * @param reporter - The {@link IResultReporter | reporter} to which the result will be reported.
      * @param options - The {@link IResultReportOptions | options} for reporting the result.
      */
-    report(reporter?: IResultReporter<T>, options?: IResultReportOptions): this;
+    report(reporter?: IResultReporter<T>, options?: IResultReportOptions<unknown>): Result<T>;
 }
 /**
  * Reports a successful {@link IResult | result} from some operation and the
@@ -376,7 +381,7 @@ export declare class Success<T> implements IResult<T> {
     /**
      * {@inheritdoc IResult.report}
      */
-    report(reporter?: IResultReporter<T>, options?: IResultReportOptions): this;
+    report(reporter?: IResultReporter<T>, options?: IResultReportOptions<unknown>): Success<T>;
     /**
      * Creates a {@link Success | Success<T>} with the supplied value.
      * @param value - The value to be returned.
@@ -472,7 +477,7 @@ export declare class Failure<T> implements IResult<T> {
     /**
      * {@inheritdoc IResult.report}
      */
-    report(reporter?: IResultReporter<T>, options?: IResultReportOptions): this;
+    report(reporter?: IResultReporter<T>, options?: IResultReportOptions<unknown>): Failure<T>;
     /**
      * Get a 'friendly' string representation of this object.
      * @remarks
@@ -598,7 +603,7 @@ export declare class DetailedSuccess<T, TD> extends Success<T> {
     /**
      * {@inheritdoc IResult.report}
      */
-    report(reporter?: IResultReporter<T, TD>, options?: IResultReportOptions<TD>): this;
+    report(reporter?: IResultReporter<T, unknown>, options?: IResultReportOptions<unknown>): DetailedSuccess<T, TD>;
     /**
      * Creates a {@link DetailedSuccess | DetailedSuccess<T, TD>} with the supplied value and
      * optional detail.
@@ -668,7 +673,7 @@ export declare class DetailedFailure<T, TD> extends Failure<T> {
     /**
      * {@inheritdoc IResult.report}
      */
-    report(reporter?: IResultReporter<T, TD>, options?: IResultReportOptions<TD>): this;
+    report(reporter?: IResultReporter<T, unknown>, options?: IResultReportOptions<unknown>): DetailedFailure<T, TD>;
     orThrow(logOrFormat?: IResultLogger<TD> | ErrorFormatter<TD>): never;
     orThrow(cb: ErrorFormatter): never;
     /**

package/lib/packlets/base/result.js

@@ -145,8 +145,9 @@ class Success {
      */
     report(reporter, options) {
         var _a;
-        const level = (_a = options === null || options === void 0 ? void 0 : options.success) !== null && _a !== void 0 ? _a : 'quiet';
-        reporter === null || reporter === void 0 ? void 0 : reporter.reportSuccess(level, this._value);
+        const successOptions = typeof (options === null || options === void 0 ? void 0 : options.success) === 'object' ? options.success : { level: options === null || options === void 0 ? void 0 : options.success };
+        const level = (_a = successOptions.level) !== null && _a !== void 0 ? _a : 'quiet';
+        reporter === null || reporter === void 0 ? void 0 : reporter.reportSuccess(level, this._value, undefined, successOptions.message);
         return this;
     }
     /**
@@ -272,8 +273,9 @@ class Failure {
      */
     report(reporter, options) {
         var _a, _b, _c;
-        const level = (_a = options === null || options === void 0 ? void 0 : options.failure) !== null && _a !== void 0 ? _a : 'error';
-        const message = (_c = (_b = options === null || options === void 0 ? void 0 : options.message) === null || _b === void 0 ? void 0 : _b.call(options, this._message)) !== null && _c !== void 0 ? _c : this._message;
+        const failureOptions = typeof (options === null || options === void 0 ? void 0 : options.failure) === 'object' ? options.failure : { level: options === null || options === void 0 ? void 0 : options.failure };
+        const level = (_a = failureOptions.level) !== null && _a !== void 0 ? _a : 'error';
+        const message = (_c = (_b = failureOptions.message) === null || _b === void 0 ? void 0 : _b.call(failureOptions, this._message)) !== null && _c !== void 0 ? _c : this._message;
         reporter === null || reporter === void 0 ? void 0 : reporter.reportFailure(level, message);
         return this;
     }
@@ -411,8 +413,11 @@ class DetailedSuccess extends Success {
      */
     report(reporter, options) {
         var _a;
-        const level = (_a = options === null || options === void 0 ? void 0 : options.success) !== null && _a !== void 0 ? _a : 'quiet';
-        reporter === null || reporter === void 0 ? void 0 : reporter.reportSuccess(level, this._value, this._detail);
+        const successOptions = typeof (options === null || options === void 0 ? void 0 : options.success) === 'object' ? options.success : { level: options === null || options === void 0 ? void 0 : options.success };
+        const level = (_a = successOptions.level) !== null && _a !== void 0 ? _a : 'quiet';
+        // Cast reporter to preserve detail type when calling reportSuccess
+        const detailedReporter = reporter;
+        detailedReporter === null || detailedReporter === void 0 ? void 0 : detailedReporter.reportSuccess(level, this._value, this._detail, successOptions.message);
         return this;
     }
     /**
@@ -503,10 +508,15 @@ class DetailedFailure extends Failure {
      * {@inheritdoc IResult.report}
      */
     report(reporter, options) {
-        var _a, _b, _c;
-        const level = (_a = options === null || options === void 0 ? void 0 : options.failure) !== null && _a !== void 0 ? _a : 'error';
-        const message = (_c = (_b = options === null || options === void 0 ? void 0 : options.message) === null || _b === void 0 ? void 0 : _b.call(options, this._message, this._detail)) !== null && _c !== void 0 ? _c : this._message;
-        reporter === null || reporter === void 0 ? void 0 : reporter.reportFailure(level, message, this._detail);
+        var _a, _b;
+        const failureOptions = typeof (options === null || options === void 0 ? void 0 : options.failure) === 'object' ? options.failure : { level: options === null || options === void 0 ? void 0 : options.failure };
+        const level = (_a = failureOptions.level) !== null && _a !== void 0 ? _a : 'error';
+        // Cast formatter to handle detail type properly
+        const formatter = failureOptions.message;
+        const message = (_b = formatter === null || formatter === void 0 ? void 0 : formatter(this._message, this._detail)) !== null && _b !== void 0 ? _b : this._message;
+        // Cast reporter to preserve detail type when calling reportFailure
+        const detailedReporter = reporter;
+        detailedReporter === null || detailedReporter === void 0 ? void 0 : detailedReporter.reportFailure(level, message, this._detail);
         return this;
     }
     orThrow(logOrFormat) {

package/lib/packlets/logging/logReporter.d.ts

@@ -1,5 +1,5 @@
 import { ILogger, ReporterLogLevel } from './logger';
-import { IResultReporter, MessageLogLevel, Success } from '../base';
+import { ErrorFormatter, IResultReporter, MessageLogLevel, Success } from '../base';
 /**
  * A function that formats a value for logging.
  * @public
@@ -26,10 +26,10 @@ export interface ILogReporterCreateParams<T, TD = unknown> {
  */
 export declare class LogReporter<T, TD = unknown> implements ILogger, IResultReporter<T, TD> {
     /**
-     * The logger to wrap.
-     * @internal
+     * Base logger used to by this reporter.
+     * @public
      */
-    protected readonly _logger: ILogger;
+    readonly logger: ILogger;
     /**
      * The formatter to use for values.
      * @internal
@@ -72,11 +72,17 @@ export declare class LogReporter<T, TD = unknown> implements ILogger, IResultRep
     /**
      * {@inheritDoc IResultReporter.reportSuccess}
      */
-    reportSuccess(level: MessageLogLevel, value: T, detail?: TD): void;
+    reportSuccess(level: MessageLogLevel, value: T, detail?: TD, message?: ErrorFormatter<TD>): void;
     /**
      * {@inheritDoc IResultReporter.reportFailure}
      */
     reportFailure(level: MessageLogLevel, message: string, detail?: TD): void;
+    /**
+     * Creates a new {@link Logging.LogReporter | LogReporter} with the same logger but a different value formatter.
+     * @param valueFormatter - The value formatter to use.
+     * @returns A new {@link Logging.LogReporter | LogReporter} with the same logger but a different value formatter.
+     */
+    withValueFormatter<TN>(valueFormatter: LogValueFormatter<TN, TD>): LogReporter<TN, TD>;
     /**
      * Generic method to try to format an object for logging.
      * @param value - The value to format.

package/lib/packlets/logging/logReporter.js

@@ -37,7 +37,7 @@ class LogReporter {
         var _a, _b, _c;
         /* c8 ignore next 1 */
         params = params !== null && params !== void 0 ? params : {};
-        this._logger = (_a = params.logger) !== null && _a !== void 0 ? _a : new logger_1.NoOpLogger();
+        this.logger = (_a = params.logger) !== null && _a !== void 0 ? _a : new logger_1.NoOpLogger();
         this._valueFormatter = (_b = params.valueFormatter) !== null && _b !== void 0 ? _b : LogReporter.tryFormatObject;
         this._messageFormatter = (_c = params.messageFormatter) !== null && _c !== void 0 ? _c : ((message, __detail) => message);
     }
@@ -45,43 +45,44 @@ class LogReporter {
      * {@inheritDoc Logging.ILogger.logLevel}
      */
     get logLevel() {
-        return this._logger.logLevel;
+        return this.logger.logLevel;
     }
     /**
      * {@inheritDoc Logging.ILogger.detail}
      */
     detail(message, ...parameters) {
-        return this._logger.detail(message, ...parameters);
+        return this.logger.detail(message, ...parameters);
     }
     /**
      * {@inheritDoc Logging.ILogger.info}
      */
     info(message, ...parameters) {
-        return this._logger.info(message, ...parameters);
+        return this.logger.info(message, ...parameters);
     }
     /**
      * {@inheritDoc Logging.ILogger.warn}
      */
     warn(message, ...parameters) {
-        return this._logger.warn(message, ...parameters);
+        return this.logger.warn(message, ...parameters);
     }
     /**
      * {@inheritDoc Logging.ILogger.error}
      */
     error(message, ...parameters) {
-        return this._logger.error(message, ...parameters);
+        return this.logger.error(message, ...parameters);
     }
     /**
      * {@inheritDoc Logging.ILogger.log}
      */
     log(level, message, ...parameters) {
-        return this._logger.log(level, message, ...parameters);
+        return this.logger.log(level, message, ...parameters);
     }
     /**
      * {@inheritDoc IResultReporter.reportSuccess}
      */
-    reportSuccess(level, value, detail) {
-        const formatted = this._valueFormatter(value, detail);
+    reportSuccess(level, value, detail, message) {
+        const formattedValue = this._valueFormatter(value, detail);
+        const formatted = message ? message(formattedValue, detail) : formattedValue;
         this.log(level, formatted);
     }
     /**
@@ -91,6 +92,18 @@ class LogReporter {
         const formatted = this._messageFormatter(message, detail);
         this.log(level, formatted);
     }
+    /**
+     * Creates a new {@link Logging.LogReporter | LogReporter} with the same logger but a different value formatter.
+     * @param valueFormatter - The value formatter to use.
+     * @returns A new {@link Logging.LogReporter | LogReporter} with the same logger but a different value formatter.
+     */
+    withValueFormatter(valueFormatter) {
+        return new LogReporter({
+            logger: this.logger,
+            valueFormatter,
+            messageFormatter: this._messageFormatter
+        });
+    }
     /**
      * Generic method to try to format an object for logging.
      * @param value - The value to format.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-utils",
-  "version": "5.0.1-1",
+  "version": "5.0.1-2",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "types": "dist/ts-utils.d.ts",