npm - @fgv/ts-utils - Versions diffs - 4.5.0-0 → 4.5.0-2 - Mend

@fgv/ts-utils 4.5.0-0 → 4.5.0-2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/dist/ts-utils.d.ts +85 -15
package/lib/packlets/base/mapResults.js +1 -1
package/lib/packlets/base/mapResults.js.map +1 -1
package/lib/packlets/base/result.d.ts +78 -15
package/lib/packlets/base/result.d.ts.map +1 -1
package/lib/packlets/base/result.js +101 -19
package/lib/packlets/base/result.js.map +1 -1
package/lib/packlets/conversion/objectConverter.d.ts +3 -0
package/lib/packlets/conversion/objectConverter.d.ts.map +1 -1
package/lib/packlets/conversion/objectConverter.js +42 -43
package/lib/packlets/conversion/objectConverter.js.map +1 -1
package/package.json +1 -1

package/dist/ts-utils.d.ts CHANGED Viewed

@@ -1029,26 +1029,26 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
           declare function delimitedString(delimiter: string, options?: 'filtered' | 'all'): Converter<string[], string>;
           /**
-           * A {@link DetailedFailure} extends {@link Failure} to report optional failure details in
-           * addition to the error message.
+           * A {@link DetailedFailure | DetailedFailure<T, TD>} extends {@link Failure | Failure<T>} to report optional
+           * failure details in addition to the error message.
            * @public
            */
           export declare class DetailedFailure<T, TD> extends Failure<T> {
               /**
                * @internal
                */
-              protected _detail: TD;
+              protected _detail?: TD;
               /**
                * Constructs a new {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied
                * message and detail.
                * @param message - The message to be returned.
                * @param detail - The error detail to be returned.
                */
-              constructor(message: string, detail: TD);
+              constructor(message: string, detail?: TD);
               /**
                * The error detail associated with this {@link DetailedFailure}.
                */
-              get detail(): TD;
+              get detail(): TD | undefined;
               /**
                * Reports that this {@link DetailedFailure} is a failure.
                * @remarks
@@ -1080,16 +1080,27 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                * {@inheritdoc IResult.withErrorFormat}
                */
               withErrorFormat(cb: ErrorFormatter<TD>): DetailedResult<T, TD>;
+              /**
+               * Creates a {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied error message
+               * and optional detail.
+               * @param message - The error message to be returned.
+               * @param detail - The error detail to be returned.
+               * @returns The resulting {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied
+               * error message and detail.
+               * @public
+               */
+              static with<T, TD>(message: string, detail?: TD): DetailedFailure<T, TD>;
           }
           /**
-           * Callback to be called when a {@link DetailedResult} encounters a failure.
+           * Callback to be called when a {@link DetailedResult | DetailedResult} encounters a failure.
            * @remarks
-           * A failure callback can change {@link Failure} to {@link Success} (e.g. by returning a default value)
+           * A failure callback can change {@link DetailedFailure | DetailedFailure<T, TD>} to
+           * {@link DetailedSuccess | DetailedSuccess<T, TD>} (e.g. by returning a default value)
            * or it can change or embellish the error message, but it cannot change the success return type.
            * @public
            */
-          export declare type DetailedFailureContinuation<T, TD> = (message: string, detail: TD) => DetailedResult<T, TD>;
+          export declare type DetailedFailureContinuation<T, TD> = (message: string, detail?: TD) => DetailedResult<T, TD>;
           /**
            * Type inference to determine the result type `T` of a {@link DetailedResult | DetailedResult<T, TD>}.
@@ -1098,8 +1109,8 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
           export declare type DetailedResult<T, TD> = DetailedSuccess<T, TD> | DetailedFailure<T, TD>;
           /**
-           * A {@link DetailedSuccess} extends {@link Success} to report optional success details in
-           * addition to the error message.
+           * A {@link DetailedSuccess | DetailedSuccess} extends {@link Success | Success} to report optional success
+           * details in addition to the error message.
            * @public
            */
           export declare class DetailedSuccess<T, TD> extends Success<T> {
@@ -1151,10 +1162,15 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                * {@inheritdoc Success.withErrorFormat}
                */
               withErrorFormat(cb: ErrorFormatter): DetailedResult<T, TD>;
+              /**
+               * Creates a {@link DetailedSuccess | DetailedSuccess<T, TD>} with the supplied value and
+               * optional detail.
+               */
+              static with<T, TD>(value: T, detail?: TD): DetailedSuccess<T, TD>;
           }
           /**
-           * Callback to be called when a {@link DetailedResult} encounters success.
+           * Callback to be called when a {@link DetailedResult | DetailedResult} encounters success.
            * @remarks
            * A success callback can return a different result type than it receives, allowing
            * success results to chain through intermediate result types.
@@ -1279,11 +1295,26 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
           /**
            * Returns {@link Failure | Failure<T>} with the supplied error message.
            * @param message - Error message to be returned.
+           * @remarks
+           * A `fails` alias was added in release 5.0 due to
+           * issues with the name `fail` being used test frameworks and libraries.
            * @public
            */
           declare function fail_2<T>(message: string): Failure<T>;
           export { fail_2 as fail }
+          /**
+           * {@inheritdoc fail}
+           * @public
+           */
+          export declare function fails<T>(message: string): Failure<T>;
+          /**
+           * {@inheritdoc failWithDetail}
+           * @public
+           */
+          export declare function failsWithDetail<T, TD>(message: string, detail?: TD): DetailedFailure<T, TD>;
           /**
            * Reports a failed {@link IResult | result} from some operation, with an error message.
            * @public
@@ -1300,7 +1331,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
               /**
                * @internal
                */
-              private readonly _message;
+              protected readonly _message: string;
               /**
                * Constructs a {@link Failure} with the supplied message.
                * @param message - Error message to be reported.
@@ -1371,6 +1402,12 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                * @returns A string representing this object.
                */
               toString(): string;
+              /**
+               * Creates a {@link Failure | Failure<T>} with the supplied error message.
+               * @param message - The error message to be returned.
+               * @returns The resulting {@link Failure | Failure<T>} with the supplied error message.
+               */
+              static with<T>(message: string): Failure<T>;
           }
           /**
@@ -1386,9 +1423,12 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
            * @param detail - The event detail to be returned.
            * @returns An {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied error
            * message and detail.
+           * @remarks
+           * The `failsWithDetail` alias was added in release 5.0 for naming consistency
+           * with {@link fails | fails}, which was added to avoid conflicts with test frameworks and libraries.
            * @public
            */
-          export declare function failWithDetail<T, TD>(message: string, detail: TD): DetailedFailure<T, TD>;
+          export declare function failWithDetail<T, TD>(message: string, detail?: TD): DetailedFailure<T, TD>;
           /**
            * A helper function to create a {@link Converter | Converter} which extracts and convert a property specified
@@ -3181,6 +3221,8 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                                         * a {@link Converter} for each field.
                                         * @param optional - An array of `keyof T` listing fields that are not required.
                                         * {@label WITH_KEYS}
+                                        * @deprecated Use {@link Conversion.Converter.optional | .optional()} on the individual
+                                        * fields, or pass {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>} to the constructor.
                                         */
                                        constructor(fields: FieldConverters<T, TC>, optional?: (keyof T)[]);
                                        /**
@@ -3209,6 +3251,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                                         * properties.
                                         */
                                        addPartial(addOptionalProperties: (keyof T)[]): ObjectConverter<Partial<T>, TC>;
+                                       private static _convert;
                                    }
                                    /**
@@ -4082,10 +4125,26 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                                                /**
                                                 * Returns {@link Success | Success<T>} with the supplied result value.
                                                 * @param value - The successful result value to be returned
+                                                * @remarks
+                                                * A `succeeds` alias was added in release 5.0 for
+                                                * naming consistency with {@link fails | fails}, which was added
+                                                * to avoid conflicts with test frameworks and libraries.
                                                 * @public
                                                 */
                                                export declare function succeed<T>(value: T): Success<T>;
+                                               /**
+                                                * {@inheritdoc succeed}
+                                                * @public
+                                                */
+                                               export declare function succeeds<T>(value: T): Success<T>;
+                                               /**
+                                                * {@inheritdoc succeedWithDetail}
+                                                * @public
+                                                */
+                                               export declare function succeedsWithDetail<T, TD>(value: T, detail?: TD): DetailedSuccess<T, TD>;
                                                /**
                                                 * Returns {@link DetailedSuccess | DetailedSuccess<T, TD>} with a supplied value and optional
                                                 * detail.
@@ -4093,6 +4152,10 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                                                 * @param detail - An optional detail of type `<TD>` to be returned.
                                                 * @returns A {@link DetailedSuccess | DetailedSuccess<T, TD>} with the supplied value
                                                 * and detail, if supplied.
+                                                * @remarks
+                                                * The `succeedsWithDetail` alias was added in release 5.0 for
+                                                * naming consistency with {@link fails | fails}, which was added to avoid conflicts
+                                                * with test frameworks and libraries.
                                                 * @public
                                                 */
                                                export declare function succeedWithDetail<T, TD>(value: T, detail?: TD): DetailedSuccess<T, TD>;
@@ -4114,7 +4177,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                                                    /**
                                                     * @internal
                                                     */
-                                                   private readonly _value;
+                                                   protected readonly _value: T;
                                                    /**
                                                     * Constructs a {@link Success} with the supplied value.
                                                     * @param value - The value to be returned.
@@ -4177,7 +4240,14 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                                                    /**
                                                     * {@inheritdoc IResult.aggregateError}
                                                     */
-                                                   aggregateError(errors: IMessageAggregator): this;
+                                                   aggregateError(__errors: IMessageAggregator): this;
+                                                   /**
+                                                    * Creates a {@link Success | Success<T>} with the supplied value.
+                                                    * @param value - The value to be returned.
+                                                    * @returns The resulting {@link Success | Success<T>} with the supplied value.
+                                                    * @public
+                                                    */
+                                                   static with<T>(value: T): Success<T>;
                                                }
                                                /**

package/lib/packlets/base/mapResults.js CHANGED Viewed

@@ -75,7 +75,7 @@ function mapDetailedResults(results, ignore, aggregatedErrors) {
         if (result.isSuccess()) {
             elements.push(result.value);
         }
-        else if (!ignore.includes(result.detail)) {
+        else if (result.detail && !ignore.includes(result.detail)) {
             errors.push(result.message);
         }
     }

package/lib/packlets/base/mapResults.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"mapResults.js","sourceRoot":"","sources":["../../../src/packlets/base/mapResults.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;AAcH,gCAoBC;AAeD,gDAqBC;AAaD,gCAoBC;AAaD,kCAYC;AAaD,gCAoBC;AAuED,wCAiDC;AAvRD,qCAAqF;AAErF;;;;;;;;;GASG;AACH,SAAgB,UAAU,CACxB,OAA4B,EAC5B,gBAAqC;IAErC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAQ,EAAE,CAAC;IAEzB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,kBAAkB,CAChC,OAAwC,EACxC,MAAY,EACZ,gBAAqC;IAErC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAQ,EAAE,CAAC;IAEzB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;aAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,OAA4B,EAC5B,gBAAqC;IAErC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAQ,EAAE,CAAC;IAEzB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/C,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,WAAW,CACzB,OAA4B,EAC5B,gBAAqC;IAErC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC5B,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,OAAkC,EAClC,YAAe,EACf,gBAAqC;IAErC,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,YAAY,CAAC,CAAC;AAC/B,CAAC;AAuED,SAAgB,cAAc,CAC5B,YAAkC,EAClC,cAAuD,EACvD,gBAAqC;;IAErC,MAAM,OAAO,GAA6B,cAAc;QACtD,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC;YAC7B,CAAC,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE;YAC3B,CAAC,CAAC,cAAc;QAClB,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,KAAK,GAAG,EAAkC,CAAC;IACjD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,IAAI,GAAgB,KAAK,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC;IAC1D,MAAM,SAAS,GAAG,IAAI,GAAG,CAAU,OAAO,CAAC,KAAK,CAAC,CAAC;IAElD,kEAAkE;IAClE,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;QAC/B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACf,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;YACxC,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBAC/B,IACE,OAAO,CAAC,iBAAiB,KAAK,IAAI;wBAClC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EACrF,CAAC;wBACD,SAAS;oBACX,CAAC;gBACH,CAAC;gBACD,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,uBAAuB,MAAM,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,KAAU,CAAC,CAAC;AAC7B,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\nimport { DetailedResult, IMessageAggregator, Result, fail, succeed } from './result';\n\n/\n Aggregates successful result values from a collection of {@link Result \| Result<T>}.\n * @param results - The collection of {@link Result \| Result<T>} to be mapped.\n * @param aggregatedErrors - Optional string array to which any error messages will be\n * appended. Each error is appended as an individual string.\n * @returns If all {@link Result \| results} are successful, returns {@link Success} with an\n * array containing all returned values. If any {@link Result \| results} failed, returns\n * {@link Failure} with a concatenated summary of all error messages.\n * @public\n /\nexport function mapResults<T>(\n results: Iterable<Result<T>>,\n aggregatedErrors?: IMessageAggregator\n): Result<T[]> {\n const errors: string[] = [];\n const elements: T[] = [];\n\n for (const result of results) {\n if (result.isSuccess()) {\n elements.push(result.value);\n } else {\n errors.push(result.message);\n }\n }\n\n if (errors.length > 0) {\n aggregatedErrors?.addMessages(errors);\n return fail(errors.join('\\n'));\n }\n return succeed(elements);\n}\n\n/\n Aggregates successful results from a collection of {@link DetailedResult \| DetailedResult<T, TD>},\n * optionally ignoring certain error details.\n * @param results - The collection of {@link DetailedResult \| DetailedResult<T, TD>} to be mapped.\n * @param ignore - An array of error detail values (of type `<TD>`) that should be ignored.\n * @param aggregatedErrors - Optional string array to which any non-ignorable error messages will be\n * appended. Each error is appended as an individual string.\n * @returns {@link Success} with an array containing all successful results if all results either\n * succeeded or returned error details listed in `ignore`. If any results failed with details\n * that cannot be ignored, returns {@link Failure} with an concatenated summary of all non-ignorable\n * error messages.\n * @public\n /\nexport function mapDetailedResults<T, TD>(\n results: Iterable<DetailedResult<T, TD>>,\n ignore: TD[],\n aggregatedErrors?: IMessageAggregator\n): Result<T[]> {\n const errors: string[] = [];\n const elements: T[] = [];\n\n for (const result of results) {\n if (result.isSuccess()) {\n elements.push(result.value);\n } else if (!ignore.includes(result.detail)) {\n errors.push(result.message);\n }\n }\n\n if (errors.length > 0) {\n aggregatedErrors?.addMessages(errors);\n return fail(errors.join('\\n'));\n }\n return succeed(elements);\n}\n\n/\n Aggregates successful results from a a collection of {@link Result \| Result<T>}.\n * @param results - An `Iterable` of {@link Result \| Result<T>} from which success\n * results are to be aggregated.\n * @param aggregatedErrors - Optional string array to which any returned error messages will be\n * appended. Each error is appended as an individual string.\n * @returns {@link Success} with an array of `<T>` if any results were successful. If\n * all {@link Result \| results} failed, returns {@link Failure} with a concatenated\n * summary of all error messages.\n * @public\n /\nexport function mapSuccess<T>(\n results: Iterable<Result<T>>,\n aggregatedErrors?: IMessageAggregator\n): Result<T[]> {\n const errors: string[] = [];\n const elements: T[] = [];\n\n for (const result of results) {\n if (result.isSuccess()) {\n elements.push(result.value);\n } else {\n errors.push(result.message);\n }\n }\n\n if (elements.length === 0 && errors.length > 0) {\n aggregatedErrors?.addMessages(errors);\n return fail(errors.join('\\n'));\n }\n return succeed(elements);\n}\n\n/\n Aggregates error messages from a collection of {@link Result \| Result<T>}.\n * @param results - An iterable collection of {@link Result \| Result<T>} for which\n * error messages are aggregated.\n * @param aggregatedErrors - Optional string array to which any returned error messages will be\n * appended. Each error is appended as an individual string.\n * @returns An array of strings consisting of all error messages returned by\n * {@link Result \| results} in the source collection. Ignores {@link Success}\n * results and returns an empty array if there were no errors.\n * @public\n /\nexport function mapFailures<T>(\n results: Iterable<Result<T>>,\n aggregatedErrors?: IMessageAggregator\n): string[] {\n const errors: string[] = [];\n for (const result of results) {\n if (result.isFailure()) {\n errors.push(result.message);\n aggregatedErrors?.addMessage(result.message);\n }\n }\n return errors;\n}\n\n/\n Determines if an iterable collection of {@link Result \| Result<T>} were all successful.\n * @param results - The collection of {@link Result \| Result<T>} to be tested.\n * @param successValue - The value to be returned if results are successful.\n * @param aggregatedErrors - Optional string array to which any returned error messages will be\n * appended. Each error is appended as an individual string.\n * @returns Returns {@link Success} with `successValue` if all {@link Result \| results} are successful.\n * If any are unsuccessful, returns {@link Failure} with a concatenated summary of the error\n * messages from all failed elements.\n * @public\n /\nexport function allSucceed<T>(\n results: Iterable<Result<unknown>>,\n successValue: T,\n aggregatedErrors?: IMessageAggregator\n): Result<T> {\n const errors: string[] = [];\n\n if (results !== undefined) {\n for (const result of results) {\n if (result.isFailure()) {\n errors.push(result.message);\n }\n }\n }\n\n if (errors.length > 0) {\n aggregatedErrors?.addMessages(errors);\n return fail(errors.join('\\n'));\n }\n return succeed(successValue);\n}\n\n/\n String-keyed record of initialization functions to be passed to {@link (populateObject:1)}\n * or {@link (populateObject:2)}.\n * @public\n /\nexport type FieldInitializers<T> = { [key in keyof T]: (state: Partial<T>) => Result<T[key]> };\n\n/\n Options for the {@link (populateObject:1)} function.\n * @public\n /\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface PopulateObjectOptions<T> {\n /\n If present, specifies the order in which property values should\n * be evaluated. Any keys not listed are evaluated after all listed\n * keys in indeterminate order. If 'order' is not present, keys\n * are evaluated in indeterminate order.\n /\n order?: (keyof T)[];\n\n /\n Specify handling of `undefined` values. By default, successful\n * `undefined` results are written to the result object. If this value\n * is `true` then `undefined` results are suppressed for all properties.\n * If this value is an array of property keys then `undefined` results\n * are suppressed for those properties only.\n /\n suppressUndefined?: boolean \| (keyof T)[];\n}\n\n/\n Populates an an object based on a prototype full of field initializers that return {@link Result \| Result<T[key]>}.\n * Returns {@link Success} with the populated object if all initializers succeed, or {@link Failure} with a\n * concatenated list of all error messages.\n * @param initializers - An object with the shape of the target but with initializer functions for\n * each property.\n * @param options - An optional {@link PopulateObjectOptions \| set of options} which\n * modify the behavior of this call.\n * @param aggregatedErrors - Optional string array to which any returned error messages will be\n * appended. Each error is appended as an individual string.\n * {@label WITH_OPTIONS}\n * @public\n /\nexport function populateObject<T>(\n initializers: FieldInitializers<T>,\n options?: PopulateObjectOptions<T>,\n aggregatedErrors?: IMessageAggregator\n): Result<T>;\n\n/\n Populates an an object based on a prototype full of field initializers that return {@link Result \| Result<T[key]>}.\n * Returns {@link Success} with the populated object if all initializers succeed, or {@link Failure} with a\n * concatenated list of all error messages.\n * @param initializers - An object with the shape of the target but with initializer functions for\n * each property.\n * @param order - Optional order in which keys should be written.\n * @param aggregatedErrors - Optional string array to which any returned error messages will be\n * appended. Each error is appended as an individual string.\n * @public\n * {@label WITH_ORDER}\n * @deprecated Pass {@link PopulateObjectOptions} instead.\n */\nexport function populateObject<T>(\n initializers: FieldInitializers<T>,\n order: (keyof T)[] \| undefined,\n aggregatedErrors?: IMessageAggregator\n): Result<T>;\n\nexport function populateObject<T>(\n initializers: FieldInitializers<T>,\n optionsOrOrder?: PopulateObjectOptions<T> \| (keyof T)[],\n aggregatedErrors?: IMessageAggregator\n): Result<T> {\n const options: PopulateObjectOptions<T> = optionsOrOrder\n ? Array.isArray(optionsOrOrder)\n ? { order: optionsOrOrder }\n : optionsOrOrder\n : {};\n const state = {} as { [key in keyof T]: T[key] };\n const errors: string[] = [];\n const keys: (keyof T)[] = Array.from(options.order ?? []);\n const foundKeys = new Set<keyof T>(options.order);\n\n // start with the supplied order then append anything else we find\n for (const key in initializers) {\n if (!foundKeys.has(key)) {\n keys.push(key);\n foundKeys.add(key);\n }\n }\n\n for (const key of keys) {\n if (initializers[key]) {\n const result = initializers[key](state);\n if (result.isSuccess()) {\n if (result.value === undefined) {\n if (\n options.suppressUndefined === true \|\|\n (Array.isArray(options.suppressUndefined) && options.suppressUndefined.includes(key))\n ) {\n continue;\n }\n }\n state[key] = result.value;\n } else {\n errors.push(result.message);\n }\n } else {\n errors.push(`populateObject: Key ${String(key)} is present but has no initializer`);\n }\n }\n\n if (errors.length > 0) {\n aggregatedErrors?.addMessages(errors);\n return fail(errors.join('\\n'));\n }\n return succeed(state as T);\n}\n"]}
1	+ {"version":3,"file":"mapResults.js","sourceRoot":"","sources":["../../../src/packlets/base/mapResults.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;AAcH,gCAoBC;AAeD,gDAqBC;AAaD,gCAoBC;AAaD,kCAYC;AAaD,gCAoBC;AAuED,wCAiDC;AAvRD,qCAAqF;AAErF;;;;;;;;;GASG;AACH,SAAgB,UAAU,CACxB,OAA4B,EAC5B,gBAAqC;IAErC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAQ,EAAE,CAAC;IAEzB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,kBAAkB,CAChC,OAAwC,EACxC,MAAY,EACZ,gBAAqC;IAErC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAQ,EAAE,CAAC;IAEzB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5D,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,OAA4B,EAC5B,gBAAqC;IAErC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAQ,EAAE,CAAC;IAEzB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/C,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,WAAW,CACzB,OAA4B,EAC5B,gBAAqC;IAErC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC5B,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,OAAkC,EAClC,YAAe,EACf,gBAAqC;IAErC,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,YAAY,CAAC,CAAC;AAC/B,CAAC;AAuED,SAAgB,cAAc,CAC5B,YAAkC,EAClC,cAAuD,EACvD,gBAAqC;;IAErC,MAAM,OAAO,GAA6B,cAAc;QACtD,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC;YAC7B,CAAC,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE;YAC3B,CAAC,CAAC,cAAc;QAClB,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,KAAK,GAAG,EAAkC,CAAC;IACjD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,IAAI,GAAgB,KAAK,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC;IAC1D,MAAM,SAAS,GAAG,IAAI,GAAG,CAAU,OAAO,CAAC,KAAK,CAAC,CAAC;IAElD,kEAAkE;IAClE,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;QAC/B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACf,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;YACxC,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBAC/B,IACE,OAAO,CAAC,iBAAiB,KAAK,IAAI;wBAClC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EACrF,CAAC;wBACD,SAAS;oBACX,CAAC;gBACH,CAAC;gBACD,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,uBAAuB,MAAM,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,KAAU,CAAC,CAAC;AAC7B,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\nimport { DetailedResult, IMessageAggregator, Result, fail, succeed } from './result';\n\n/\n Aggregates successful result values from a collection of {@link Result \| Result<T>}.\n * @param results - The collection of {@link Result \| Result<T>} to be mapped.\n * @param aggregatedErrors - Optional string array to which any error messages will be\n * appended. Each error is appended as an individual string.\n * @returns If all {@link Result \| results} are successful, returns {@link Success} with an\n * array containing all returned values. If any {@link Result \| results} failed, returns\n * {@link Failure} with a concatenated summary of all error messages.\n * @public\n /\nexport function mapResults<T>(\n results: Iterable<Result<T>>,\n aggregatedErrors?: IMessageAggregator\n): Result<T[]> {\n const errors: string[] = [];\n const elements: T[] = [];\n\n for (const result of results) {\n if (result.isSuccess()) {\n elements.push(result.value);\n } else {\n errors.push(result.message);\n }\n }\n\n if (errors.length > 0) {\n aggregatedErrors?.addMessages(errors);\n return fail(errors.join('\\n'));\n }\n return succeed(elements);\n}\n\n/\n Aggregates successful results from a collection of {@link DetailedResult \| DetailedResult<T, TD>},\n * optionally ignoring certain error details.\n * @param results - The collection of {@link DetailedResult \| DetailedResult<T, TD>} to be mapped.\n * @param ignore - An array of error detail values (of type `<TD>`) that should be ignored.\n * @param aggregatedErrors - Optional string array to which any non-ignorable error messages will be\n * appended. Each error is appended as an individual string.\n * @returns {@link Success} with an array containing all successful results if all results either\n * succeeded or returned error details listed in `ignore`. If any results failed with details\n * that cannot be ignored, returns {@link Failure} with an concatenated summary of all non-ignorable\n * error messages.\n * @public\n /\nexport function mapDetailedResults<T, TD>(\n results: Iterable<DetailedResult<T, TD>>,\n ignore: TD[],\n aggregatedErrors?: IMessageAggregator\n): Result<T[]> {\n const errors: string[] = [];\n const elements: T[] = [];\n\n for (const result of results) {\n if (result.isSuccess()) {\n elements.push(result.value);\n } else if (result.detail && !ignore.includes(result.detail)) {\n errors.push(result.message);\n }\n }\n\n if (errors.length > 0) {\n aggregatedErrors?.addMessages(errors);\n return fail(errors.join('\\n'));\n }\n return succeed(elements);\n}\n\n/\n Aggregates successful results from a a collection of {@link Result \| Result<T>}.\n * @param results - An `Iterable` of {@link Result \| Result<T>} from which success\n * results are to be aggregated.\n * @param aggregatedErrors - Optional string array to which any returned error messages will be\n * appended. Each error is appended as an individual string.\n * @returns {@link Success} with an array of `<T>` if any results were successful. If\n * all {@link Result \| results} failed, returns {@link Failure} with a concatenated\n * summary of all error messages.\n * @public\n /\nexport function mapSuccess<T>(\n results: Iterable<Result<T>>,\n aggregatedErrors?: IMessageAggregator\n): Result<T[]> {\n const errors: string[] = [];\n const elements: T[] = [];\n\n for (const result of results) {\n if (result.isSuccess()) {\n elements.push(result.value);\n } else {\n errors.push(result.message);\n }\n }\n\n if (elements.length === 0 && errors.length > 0) {\n aggregatedErrors?.addMessages(errors);\n return fail(errors.join('\\n'));\n }\n return succeed(elements);\n}\n\n/\n Aggregates error messages from a collection of {@link Result \| Result<T>}.\n * @param results - An iterable collection of {@link Result \| Result<T>} for which\n * error messages are aggregated.\n * @param aggregatedErrors - Optional string array to which any returned error messages will be\n * appended. Each error is appended as an individual string.\n * @returns An array of strings consisting of all error messages returned by\n * {@link Result \| results} in the source collection. Ignores {@link Success}\n * results and returns an empty array if there were no errors.\n * @public\n /\nexport function mapFailures<T>(\n results: Iterable<Result<T>>,\n aggregatedErrors?: IMessageAggregator\n): string[] {\n const errors: string[] = [];\n for (const result of results) {\n if (result.isFailure()) {\n errors.push(result.message);\n aggregatedErrors?.addMessage(result.message);\n }\n }\n return errors;\n}\n\n/\n Determines if an iterable collection of {@link Result \| Result<T>} were all successful.\n * @param results - The collection of {@link Result \| Result<T>} to be tested.\n * @param successValue - The value to be returned if results are successful.\n * @param aggregatedErrors - Optional string array to which any returned error messages will be\n * appended. Each error is appended as an individual string.\n * @returns Returns {@link Success} with `successValue` if all {@link Result \| results} are successful.\n * If any are unsuccessful, returns {@link Failure} with a concatenated summary of the error\n * messages from all failed elements.\n * @public\n /\nexport function allSucceed<T>(\n results: Iterable<Result<unknown>>,\n successValue: T,\n aggregatedErrors?: IMessageAggregator\n): Result<T> {\n const errors: string[] = [];\n\n if (results !== undefined) {\n for (const result of results) {\n if (result.isFailure()) {\n errors.push(result.message);\n }\n }\n }\n\n if (errors.length > 0) {\n aggregatedErrors?.addMessages(errors);\n return fail(errors.join('\\n'));\n }\n return succeed(successValue);\n}\n\n/\n String-keyed record of initialization functions to be passed to {@link (populateObject:1)}\n * or {@link (populateObject:2)}.\n * @public\n /\nexport type FieldInitializers<T> = { [key in keyof T]: (state: Partial<T>) => Result<T[key]> };\n\n/\n Options for the {@link (populateObject:1)} function.\n * @public\n /\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface PopulateObjectOptions<T> {\n /\n If present, specifies the order in which property values should\n * be evaluated. Any keys not listed are evaluated after all listed\n * keys in indeterminate order. If 'order' is not present, keys\n * are evaluated in indeterminate order.\n /\n order?: (keyof T)[];\n\n /\n Specify handling of `undefined` values. By default, successful\n * `undefined` results are written to the result object. If this value\n * is `true` then `undefined` results are suppressed for all properties.\n * If this value is an array of property keys then `undefined` results\n * are suppressed for those properties only.\n /\n suppressUndefined?: boolean \| (keyof T)[];\n}\n\n/\n Populates an an object based on a prototype full of field initializers that return {@link Result \| Result<T[key]>}.\n * Returns {@link Success} with the populated object if all initializers succeed, or {@link Failure} with a\n * concatenated list of all error messages.\n * @param initializers - An object with the shape of the target but with initializer functions for\n * each property.\n * @param options - An optional {@link PopulateObjectOptions \| set of options} which\n * modify the behavior of this call.\n * @param aggregatedErrors - Optional string array to which any returned error messages will be\n * appended. Each error is appended as an individual string.\n * {@label WITH_OPTIONS}\n * @public\n /\nexport function populateObject<T>(\n initializers: FieldInitializers<T>,\n options?: PopulateObjectOptions<T>,\n aggregatedErrors?: IMessageAggregator\n): Result<T>;\n\n/\n Populates an an object based on a prototype full of field initializers that return {@link Result \| Result<T[key]>}.\n * Returns {@link Success} with the populated object if all initializers succeed, or {@link Failure} with a\n * concatenated list of all error messages.\n * @param initializers - An object with the shape of the target but with initializer functions for\n * each property.\n * @param order - Optional order in which keys should be written.\n * @param aggregatedErrors - Optional string array to which any returned error messages will be\n * appended. Each error is appended as an individual string.\n * @public\n * {@label WITH_ORDER}\n * @deprecated Pass {@link PopulateObjectOptions} instead.\n */\nexport function populateObject<T>(\n initializers: FieldInitializers<T>,\n order: (keyof T)[] \| undefined,\n aggregatedErrors?: IMessageAggregator\n): Result<T>;\n\nexport function populateObject<T>(\n initializers: FieldInitializers<T>,\n optionsOrOrder?: PopulateObjectOptions<T> \| (keyof T)[],\n aggregatedErrors?: IMessageAggregator\n): Result<T> {\n const options: PopulateObjectOptions<T> = optionsOrOrder\n ? Array.isArray(optionsOrOrder)\n ? { order: optionsOrOrder }\n : optionsOrOrder\n : {};\n const state = {} as { [key in keyof T]: T[key] };\n const errors: string[] = [];\n const keys: (keyof T)[] = Array.from(options.order ?? []);\n const foundKeys = new Set<keyof T>(options.order);\n\n // start with the supplied order then append anything else we find\n for (const key in initializers) {\n if (!foundKeys.has(key)) {\n keys.push(key);\n foundKeys.add(key);\n }\n }\n\n for (const key of keys) {\n if (initializers[key]) {\n const result = initializers[key](state);\n if (result.isSuccess()) {\n if (result.value === undefined) {\n if (\n options.suppressUndefined === true \|\|\n (Array.isArray(options.suppressUndefined) && options.suppressUndefined.includes(key))\n ) {\n continue;\n }\n }\n state[key] = result.value;\n } else {\n errors.push(result.message);\n }\n } else {\n errors.push(`populateObject: Key ${String(key)} is present but has no initializer`);\n }\n }\n\n if (errors.length > 0) {\n aggregatedErrors?.addMessages(errors);\n return fail(errors.join('\\n'));\n }\n return succeed(state as T);\n}\n"]}

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

@@ -245,7 +245,7 @@ export declare class Success<T> implements IResult<T> {
     /**
      * @internal
      */
-    private readonly _value;
+    protected readonly _value: T;
     /**
      * Constructs a {@link Success} with the supplied value.
      * @param value - The value to be returned.
@@ -308,7 +308,14 @@ export declare class Success<T> implements IResult<T> {
     /**
      * {@inheritdoc IResult.aggregateError}
      */
-    aggregateError(errors: IMessageAggregator): this;
+    aggregateError(__errors: IMessageAggregator): this;
+    /**
+     * Creates a {@link Success | Success<T>} with the supplied value.
+     * @param value - The value to be returned.
+     * @returns The resulting {@link Success | Success<T>} with the supplied value.
+     * @public
+     */
+    static with<T>(value: T): Success<T>;
 }
 /**
  * Reports a failed {@link IResult | result} from some operation, with an error message.
@@ -326,7 +333,7 @@ export declare class Failure<T> implements IResult<T> {
     /**
      * @internal
      */
-    private readonly _message;
+    protected readonly _message: string;
     /**
      * Constructs a {@link Failure} with the supplied message.
      * @param message - Error message to be reported.
@@ -397,21 +404,44 @@ export declare class Failure<T> implements IResult<T> {
      * @returns A string representing this object.
      */
     toString(): string;
+    /**
+     * Creates a {@link Failure | Failure<T>} with the supplied error message.
+     * @param message - The error message to be returned.
+     * @returns The resulting {@link Failure | Failure<T>} with the supplied error message.
+     */
+    static with<T>(message: string): Failure<T>;
 }
 /**
  * Returns {@link Success | Success<T>} with the supplied result value.
  * @param value - The successful result value to be returned
+ * @remarks
+ * A `succeeds` alias was added in release 5.0 for
+ * naming consistency with {@link fails | fails}, which was added
+ * to avoid conflicts with test frameworks and libraries.
  * @public
  */
 export declare function succeed<T>(value: T): Success<T>;
+/**
+ * {@inheritdoc succeed}
+ * @public
+ */
+export declare function succeeds<T>(value: T): Success<T>;
 /**
  * Returns {@link Failure | Failure<T>} with the supplied error message.
  * @param message - Error message to be returned.
+ * @remarks
+ * A `fails` alias was added in release 5.0 due to
+ * issues with the name `fail` being used test frameworks and libraries.
  * @public
  */
 export declare function fail<T>(message: string): Failure<T>;
 /**
- * Callback to be called when a {@link DetailedResult} encounters success.
+ * {@inheritdoc fail}
+ * @public
+ */
+export declare function fails<T>(message: string): Failure<T>;
+/**
+ * Callback to be called when a {@link DetailedResult | DetailedResult} encounters success.
  * @remarks
  * A success callback can return a different result type than it receives, allowing
  * success results to chain through intermediate result types.
@@ -419,16 +449,17 @@ export declare function fail<T>(message: string): Failure<T>;
  */
 export type DetailedSuccessContinuation<T, TD, TN> = (value: T, detail?: TD) => DetailedResult<TN, TD>;
 /**
- * Callback to be called when a {@link DetailedResult} encounters a failure.
+ * Callback to be called when a {@link DetailedResult | DetailedResult} encounters a failure.
  * @remarks
- * A failure callback can change {@link Failure} to {@link Success} (e.g. by returning a default value)
+ * A failure callback can change {@link DetailedFailure | DetailedFailure<T, TD>} to
+ * {@link DetailedSuccess | DetailedSuccess<T, TD>} (e.g. by returning a default value)
  * or it can change or embellish the error message, but it cannot change the success return type.
  * @public
  */
-export type DetailedFailureContinuation<T, TD> = (message: string, detail: TD) => DetailedResult<T, TD>;
+export type DetailedFailureContinuation<T, TD> = (message: string, detail?: TD) => DetailedResult<T, TD>;
 /**
- * A {@link DetailedSuccess} extends {@link Success} to report optional success details in
- * addition to the error message.
+ * A {@link DetailedSuccess | DetailedSuccess} extends {@link Success | Success} to report optional success
+ * details in addition to the error message.
  * @public
  */
 export declare class DetailedSuccess<T, TD> extends Success<T> {
@@ -480,28 +511,33 @@ export declare class DetailedSuccess<T, TD> extends Success<T> {
      * {@inheritdoc Success.withErrorFormat}
      */
     withErrorFormat(cb: ErrorFormatter): DetailedResult<T, TD>;
+    /**
+     * Creates a {@link DetailedSuccess | DetailedSuccess<T, TD>} with the supplied value and
+     * optional detail.
+     */
+    static with<T, TD>(value: T, detail?: TD): DetailedSuccess<T, TD>;
 }
 /**
- * A {@link DetailedFailure} extends {@link Failure} to report optional failure details in
- * addition to the error message.
+ * A {@link DetailedFailure | DetailedFailure<T, TD>} extends {@link Failure | Failure<T>} to report optional
+ * failure details in addition to the error message.
  * @public
  */
 export declare class DetailedFailure<T, TD> extends Failure<T> {
     /**
      * @internal
      */
-    protected _detail: TD;
+    protected _detail?: TD;
     /**
      * Constructs a new {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied
      * message and detail.
      * @param message - The message to be returned.
      * @param detail - The error detail to be returned.
      */
-    constructor(message: string, detail: TD);
+    constructor(message: string, detail?: TD);
     /**
      * The error detail associated with this {@link DetailedFailure}.
      */
-    get detail(): TD;
+    get detail(): TD | undefined;
     /**
      * Reports that this {@link DetailedFailure} is a failure.
      * @remarks
@@ -533,6 +569,16 @@ export declare class DetailedFailure<T, TD> extends Failure<T> {
      * {@inheritdoc IResult.withErrorFormat}
      */
     withErrorFormat(cb: ErrorFormatter<TD>): DetailedResult<T, TD>;
+    /**
+     * Creates a {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied error message
+     * and optional detail.
+     * @param message - The error message to be returned.
+     * @param detail - The error detail to be returned.
+     * @returns The resulting {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied
+     * error message and detail.
+     * @public
+     */
+    static with<T, TD>(message: string, detail?: TD): DetailedFailure<T, TD>;
 }
 /**
  * Type inference to determine the result type `T` of a {@link DetailedResult | DetailedResult<T, TD>}.
@@ -551,18 +597,35 @@ export type ResultDetailType<T> = T extends DetailedResult<unknown, infer TD> ?
  * @param detail - An optional detail of type `<TD>` to be returned.
  * @returns A {@link DetailedSuccess | DetailedSuccess<T, TD>} with the supplied value
  * and detail, if supplied.
+ * @remarks
+ * The `succeedsWithDetail` alias was added in release 5.0 for
+ * naming consistency with {@link fails | fails}, which was added to avoid conflicts
+ * with test frameworks and libraries.
  * @public
  */
 export declare function succeedWithDetail<T, TD>(value: T, detail?: TD): DetailedSuccess<T, TD>;
+/**
+ * {@inheritdoc succeedWithDetail}
+ * @public
+ */
+export declare function succeedsWithDetail<T, TD>(value: T, detail?: TD): DetailedSuccess<T, TD>;
 /**
  * Returns {@link DetailedFailure | DetailedFailure<T, TD>} with a supplied error message and detail.
  * @param message - The error message to be returned.
  * @param detail - The event detail to be returned.
  * @returns An {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied error
  * message and detail.
+ * @remarks
+ * The `failsWithDetail` alias was added in release 5.0 for naming consistency
+ * with {@link fails | fails}, which was added to avoid conflicts with test frameworks and libraries.
+ * @public
+ */
+export declare function failWithDetail<T, TD>(message: string, detail?: TD): DetailedFailure<T, TD>;
+/**
+ * {@inheritdoc failWithDetail}
  * @public
  */
-export declare function failWithDetail<T, TD>(message: string, detail: TD): DetailedFailure<T, TD>;
+export declare function failsWithDetail<T, TD>(message: string, detail?: TD): DetailedFailure<T, TD>;
 /**
  * Propagates a {@link Success} or {@link Failure} {@link Result}, adding supplied
  * event details as appropriate.

package/lib/packlets/base/result.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/result.ts"],"names":[],"mappings":"AAuBA;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAChD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC,CAAC;AAElE;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,EAAE,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,KAAK,MAAM,CAAC;AAEpF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAEzC;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI,CAAC;IAElD;;;;;;OAMG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACtC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;;OAGG;IACH,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAEhC;;;OAGG;IACH,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAEhC;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,CAAC,CAAC;IAE3C;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE3C;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,CAAC,CAAC;IAEnC;;;;;;;OAOG;IACH,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC;IAEtB;;;;;;OAMG;IACH,SAAS,IAAI,CAAC,GAAG,SAAS,CAAC;IAE3B;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;IAE1D;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAEjD;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAE/C;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEzD;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEtE;;;;;OAKG;IACH,cAAc,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAClD;AAED;;;;GAIG;AACH,qBAAa,OAAO,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;IAC3C;;OAEG;IACH,SAAgB,OAAO,EAAE,IAAI,CAAQ;IAErC;;OAEG;IACH,SAAgB,OAAO,EAAE,SAAS,CAAa;IAE/C;;OAEG;IACH,~~OAAO~~,CAAC,QAAQ,CAAC,MAAM,~~CAAI~~;~~IAE3B~~;;;OAGG;gBACgB,KAAK,EAAE,CAAC;IAI3B;;OAEG;IACH,IAAW,KAAK,IAAI,CAAC,CAEpB;IAED;;OAEG;IACI,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;IAItC;;OAEG;IACI,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;IAItC;;OAEG;IACI,OAAO,CAAC,QAAQ,CAAC,EAAE,aAAa,GAAG,CAAC;IAI3C;;OAEG;IACI,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC;IAC5B;;OAEG;IACI,SAAS,IAAI,CAAC,GAAG,SAAS;IAKjC;;;OAGG;IACI,eAAe,CAAC,QAAQ,CAAC,EAAE,aAAa,GAAG,CAAC;IAInD;;;OAGG;IACI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAIjD;;OAEG;IACI,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC;IAIhE;;OAEG;IACI,SAAS,CAAC,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAIvD;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC;IAIvD;;OAEG;IACI,iBAAiB,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAIjE;;OAEG;IACI,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAI5E;;OAEG;IACI,cAAc,CAAC,~~MAAM~~,EAAE,kBAAkB,GAAG,IAAI;~~CAGxD~~;AAED;;;GAGG;AACH,qBAAa,OAAO,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;IAC3C;;OAEG;IACH,SAAgB,OAAO,EAAE,KAAK,CAAS;IACvC;;OAEG;IACH,SAAgB,KAAK,EAAE,SAAS,CAAa;IAE7C;;OAEG;IACH,~~OAAO~~,CAAC,QAAQ,CAAC,QAAQ,~~CAAS~~;~~IAElC~~;;;OAGG;gBACgB,OAAO,EAAE,MAAM;IAIlC;;OAEG;IACH,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED;;OAEG;IACI,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;IAItC;;OAEG;IACI,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;IAItC;;OAEG;IACI,OAAO,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,KAAK;IAO7C;;OAEG;IACI,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC;IAC5B;;OAEG;IACI,SAAS,IAAI,CAAC,GAAG,SAAS;IAKjC;;;OAGG;IACI,eAAe,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,KAAK;IAOrD;;;OAGG;IACI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAIjD;;OAEG;IACI,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC;IAIhE;;OAEG;IACI,SAAS,CAAC,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAIvD;;OAEG;IACI,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC;IAIrD;;OAEG;IACI,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAI/D;;OAEG;IACI,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,eAAe,CAAC,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAI9E;;OAEG;IACI,cAAc,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAKvD;;;;;OAKG;IACI,QAAQ,IAAI,MAAM;~~CAG1B~~;AAED~~;;;;GAIG~~;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAE/C;AAED~~;;;;GAIG~~;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAEnD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,KAAK,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;AAEvG~~;;;;;;GAMG~~;AACH,MAAM,MAAM,2BAA2B,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,KAAK,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;~~AAExG~~;;;;GAIG;AACH,qBAAa,eAAe,CAAC,CAAC,EAAE,EAAE,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IACpD;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;IAEvB;;;;;;OAMG;gBACgB,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE;IAKxC;;;OAGG;IACH,IAAW,MAAM,IAAI,EAAE,GAAG,SAAS,CAElC;IAED;;;;;;;OAOG;IACI,SAAS,IAAI,IAAI,IAAI,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC;IAIlD;;;;;;;OAOG;IACI,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,2BAA2B,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC;IAIxF;;;;;;;OAOG;IACI,SAAS,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAIjF;;OAEG;IACI,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;~~CAGlE~~;AAED;;;;GAIG;AACH,qBAAa,eAAe,CAAC,CAAC,EAAE,EAAE,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IACpD;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC;~~IAEtB~~;;;;;OAKG;gBACgB,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;~~IAK9C~~;;OAEG;IACH,IAAW,MAAM,IAAI,EAAE,~~CAEtB~~;IAED;;;;;;;OAOG;IACI,SAAS,IAAI,IAAI,IAAI,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC;IAIlD;;;;;;;;;OASG;IACI,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,2BAA2B,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC;IAI1F;;;;;OAKG;IACI,SAAS,CAAC,EAAE,EAAE,2BAA2B,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAI/E;;OAEG;IACI,eAAe,CAAC,EAAE,EAAE,cAAc,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;~~CAGtE~~;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,EAAE,IAAI,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAEpF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;AAE3F~~;;;;;;;;GAQG~~;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAEtF;AAED~~;;;;;;;GAOG~~;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,~~CAEzF~~;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,EAAE,EACvC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EACjB,MAAM,EAAE,EAAE,EACV,aAAa,CAAC,EAAE,EAAE,GACjB,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAIvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAMzD"}
1	+ {"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/result.ts"],"names":[],"mappings":"AAuBA;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAChD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC,CAAC;AAElE;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,EAAE,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,KAAK,MAAM,CAAC;AAEpF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAEzC;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI,CAAC;IAElD;;;;;;OAMG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACtC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;;OAGG;IACH,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAEhC;;;OAGG;IACH,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAEhC;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,CAAC,CAAC;IAE3C;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE3C;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,CAAC,CAAC;IAEnC;;;;;;;OAOG;IACH,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC;IAEtB;;;;;;OAMG;IACH,SAAS,IAAI,CAAC,GAAG,SAAS,CAAC;IAE3B;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;IAE1D;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAEjD;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAE/C;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEzD;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEtE;;;;;OAKG;IACH,cAAc,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAClD;AAED;;;;GAIG;AACH,qBAAa,OAAO,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;IAC3C;;OAEG;IACH,SAAgB,OAAO,EAAE,IAAI,CAAQ;IAErC;;OAEG;IACH,SAAgB,OAAO,EAAE,SAAS,CAAa;IAE/C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAE7B;;;OAGG;gBACgB,KAAK,EAAE,CAAC;IAI3B;;OAEG;IACH,IAAW,KAAK,IAAI,CAAC,CAEpB;IAED;;OAEG;IACI,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;IAItC;;OAEG;IACI,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;IAItC;;OAEG;IACI,OAAO,CAAC,QAAQ,CAAC,EAAE,aAAa,GAAG,CAAC;IAI3C;;OAEG;IACI,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC;IAC5B;;OAEG;IACI,SAAS,IAAI,CAAC,GAAG,SAAS;IAKjC;;;OAGG;IACI,eAAe,CAAC,QAAQ,CAAC,EAAE,aAAa,GAAG,CAAC;IAInD;;;OAGG;IACI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAIjD;;OAEG;IACI,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC;IAIhE;;OAEG;IACI,SAAS,CAAC,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAIvD;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC;IAIvD;;OAEG;IACI,iBAAiB,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAIjE;;OAEG;IACI,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAI5E;;OAEG;IACI,cAAc,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI;IAIzD;;;;;OAKG;WACW,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAG5C;AAED;;;GAGG;AACH,qBAAa,OAAO,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;IAC3C;;OAEG;IACH,SAAgB,OAAO,EAAE,KAAK,CAAS;IACvC;;OAEG;IACH,SAAgB,KAAK,EAAE,SAAS,CAAa;IAE7C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAEpC;;;OAGG;gBACgB,OAAO,EAAE,MAAM;IAIlC;;OAEG;IACH,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED;;OAEG;IACI,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;IAItC;;OAEG;IACI,SAAS,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;IAItC;;OAEG;IACI,OAAO,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,KAAK;IAO7C;;OAEG;IACI,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC;IAC5B;;OAEG;IACI,SAAS,IAAI,CAAC,GAAG,SAAS;IAKjC;;;OAGG;IACI,eAAe,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,KAAK;IAOrD;;;OAGG;IACI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAIjD;;OAEG;IACI,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC;IAIhE;;OAEG;IACI,SAAS,CAAC,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAIvD;;OAEG;IACI,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC;IAIrD;;OAEG;IACI,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAI/D;;OAEG;IACI,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,eAAe,CAAC,EAAE,EAAE,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAI9E;;OAEG;IACI,cAAc,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAKvD;;;;;OAKG;IACI,QAAQ,IAAI,MAAM;IAIzB;;;;OAIG;WACW,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;CAGnD;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAE/C;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAEhD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAEnD;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAEpD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,KAAK,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;AAEvG;;;;;;;GAOG;AACH,MAAM,MAAM,2BAA2B,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,KAAK,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAEzG;;;;GAIG;AACH,qBAAa,eAAe,CAAC,CAAC,EAAE,EAAE,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IACpD;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;IAEvB;;;;;;OAMG;gBACgB,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE;IAKxC;;;OAGG;IACH,IAAW,MAAM,IAAI,EAAE,GAAG,SAAS,CAElC;IAED;;;;;;;OAOG;IACI,SAAS,IAAI,IAAI,IAAI,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC;IAIlD;;;;;;;OAOG;IACI,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,2BAA2B,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC;IAIxF;;;;;;;OAOG;IACI,SAAS,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAIjF;;OAEG;IACI,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAIjE;;;OAGG;WACW,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC;CAGzE;AAED;;;;GAIG;AACH,qBAAa,eAAe,CAAC,CAAC,EAAE,EAAE,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IACpD;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;IAEvB;;;;;OAKG;gBACgB,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE;IAK/C;;OAEG;IACH,IAAW,MAAM,IAAI,EAAE,GAAG,SAAS,CAElC;IAED;;;;;;;OAOG;IACI,SAAS,IAAI,IAAI,IAAI,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC;IAIlD;;;;;;;;;OASG;IACI,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,2BAA2B,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC;IAI1F;;;;;OAKG;IACI,SAAS,CAAC,EAAE,EAAE,2BAA2B,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAI/E;;OAEG;IACI,eAAe,CAAC,EAAE,EAAE,cAAc,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC;IAIrE;;;;;;;;OAQG;WACW,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC;CAGhF;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,EAAE,IAAI,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAEpF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;AAE3F;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAEtF;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAEvF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAE1F;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAE3F;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,EAAE,EACvC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EACjB,MAAM,EAAE,EAAE,EACV,aAAa,CAAC,EAAE,EAAE,GACjB,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAIvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAMzD"}

package/lib/packlets/base/result.js CHANGED Viewed

@@ -23,9 +23,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DetailedFailure = exports.DetailedSuccess = exports.Failure = exports.Success = void 0;
 exports.succeed = succeed;
+exports.succeeds = succeeds;
 exports.fail = fail;
+exports.fails = fails;
 exports.succeedWithDetail = succeedWithDetail;
+exports.succeedsWithDetail = succeedsWithDetail;
 exports.failWithDetail = failWithDetail;
+exports.failsWithDetail = failsWithDetail;
 exports.propagateWithDetail = propagateWithDetail;
 exports.captureResult = captureResult;
 /**
@@ -96,7 +100,7 @@ class Success {
      * {@inheritdoc IResult.onSuccess}
      */
     onSuccess(cb) {
-        return cb(this.value);
+        return cb(this._value);
     }
     /**
      * {@inheritdoc IResult.onFailure}
@@ -114,20 +118,29 @@ class Success {
      * {@inheritdoc IResult.withFailureDetail}
      */
     withFailureDetail(__detail) {
-        return succeedWithDetail(this.value);
+        return succeedWithDetail(this._value);
     }
     /**
      * {@inheritdoc IResult.withDetail}
      */
     withDetail(detail, successDetail) {
-        return succeedWithDetail(this.value, successDetail !== null && successDetail !== void 0 ? successDetail : detail);
+        return succeedWithDetail(this._value, successDetail !== null && successDetail !== void 0 ? successDetail : detail);
     }
     /**
      * {@inheritdoc IResult.aggregateError}
      */
-    aggregateError(errors) {
+    aggregateError(__errors) {
         return this;
     }
+    /**
+     * Creates a {@link Success | Success<T>} with the supplied value.
+     * @param value - The value to be returned.
+     * @returns The resulting {@link Success | Success<T>} with the supplied value.
+     * @public
+     */
+    static with(value) {
+        return new Success(value);
+    }
 }
 exports.Success = Success;
 /**
@@ -201,37 +214,37 @@ class Failure {
      * {@inheritdoc IResult.onSuccess}
      */
     onSuccess(__) {
-        return new Failure(this.message);
+        return new Failure(this._message);
     }
     /**
      * {@inheritdoc IResult.onFailure}
      */
     onFailure(cb) {
-        return cb(this.message);
+        return cb(this._message);
     }
     /**
      * {@inheritdoc IResult.withErrorFormat}
      */
     withErrorFormat(cb) {
-        return fail(cb(this.message));
+        return fail(cb(this._message));
     }
     /**
      * {@inheritdoc IResult.withFailureDetail}
      */
     withFailureDetail(detail) {
-        return failWithDetail(this.message, detail);
+        return failWithDetail(this._message, detail);
     }
     /**
      * {@inheritdoc IResult.withDetail}
      */
     withDetail(detail, __successDetail) {
-        return failWithDetail(this.message, detail);
+        return failWithDetail(this._message, detail);
     }
     /**
      * {@inheritdoc IResult.aggregateError}
      */
     aggregateError(errors) {
-        errors.addMessage(this.message);
+        errors.addMessage(this._message);
         return this;
     }
     /**
@@ -241,29 +254,58 @@ class Failure {
      * @returns A string representing this object.
      */
     toString() {
-        return this.message;
+        return this._message;
+    }
+    /**
+     * Creates a {@link Failure | Failure<T>} with the supplied error message.
+     * @param message - The error message to be returned.
+     * @returns The resulting {@link Failure | Failure<T>} with the supplied error message.
+     */
+    static with(message) {
+        return new Failure(message);
     }
 }
 exports.Failure = Failure;
 /**
  * Returns {@link Success | Success<T>} with the supplied result value.
  * @param value - The successful result value to be returned
+ * @remarks
+ * A `succeeds` alias was added in release 5.0 for
+ * naming consistency with {@link fails | fails}, which was added
+ * to avoid conflicts with test frameworks and libraries.
  * @public
  */
 function succeed(value) {
     return new Success(value);
 }
+/**
+ * {@inheritdoc succeed}
+ * @public
+ */
+function succeeds(value) {
+    return new Success(value);
+}
 /**
  * Returns {@link Failure | Failure<T>} with the supplied error message.
  * @param message - Error message to be returned.
+ * @remarks
+ * A `fails` alias was added in release 5.0 due to
+ * issues with the name `fail` being used test frameworks and libraries.
  * @public
  */
 function fail(message) {
     return new Failure(message);
 }
 /**
- * A {@link DetailedSuccess} extends {@link Success} to report optional success details in
- * addition to the error message.
+ * {@inheritdoc fail}
+ * @public
+ */
+function fails(message) {
+    return new Failure(message);
+}
+/**
+ * A {@link DetailedSuccess | DetailedSuccess} extends {@link Success | Success} to report optional success
+ * details in addition to the error message.
  * @public
  */
 class DetailedSuccess extends Success {
@@ -305,7 +347,7 @@ class DetailedSuccess extends Success {
      * @returns The {@link DetailedResult | DetailedResult<T, TD>} returned by the success callback.
      */
     onSuccess(cb) {
-        return cb(this.value, this._detail);
+        return cb(this._value, this._detail);
     }
     /**
      * Propagates this {@link DetailedSuccess}.
@@ -324,11 +366,18 @@ class DetailedSuccess extends Success {
     withErrorFormat(cb) {
         return this;
     }
+    /**
+     * Creates a {@link DetailedSuccess | DetailedSuccess<T, TD>} with the supplied value and
+     * optional detail.
+     */
+    static with(value, detail) {
+        return new DetailedSuccess(value, detail);
+    }
 }
 exports.DetailedSuccess = DetailedSuccess;
 /**
- * A {@link DetailedFailure} extends {@link Failure} to report optional failure details in
- * addition to the error message.
+ * A {@link DetailedFailure | DetailedFailure<T, TD>} extends {@link Failure | Failure<T>} to report optional
+ * failure details in addition to the error message.
  * @public
  */
 class DetailedFailure extends Failure {
@@ -370,7 +419,7 @@ class DetailedFailure extends Failure {
      * the error message and detail from this one.
      */
     onSuccess(__cb) {
-        return new DetailedFailure(this.message, this._detail);
+        return new DetailedFailure(this._message, this._detail);
     }
     /**
      * Invokes the supplied {@link DetailedFailureContinuation | failure callback} and propagates
@@ -379,13 +428,25 @@ class DetailedFailure extends Failure {
      * @returns The {@link DetailedResult | DetailedResult<T, TD>} returned by the failure callback.
      */
     onFailure(cb) {
-        return cb(this.message, this._detail);
+        return cb(this._message, this._detail);
     }
     /**
      * {@inheritdoc IResult.withErrorFormat}
      */
     withErrorFormat(cb) {
-        return failWithDetail(cb(this.message, this._detail), this._detail);
+        return failWithDetail(cb(this._message, this._detail), this._detail);
+    }
+    /**
+     * Creates a {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied error message
+     * and optional detail.
+     * @param message - The error message to be returned.
+     * @param detail - The error detail to be returned.
+     * @returns The resulting {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied
+     * error message and detail.
+     * @public
+     */
+    static with(message, detail) {
+        return new DetailedFailure(message, detail);
     }
 }
 exports.DetailedFailure = DetailedFailure;
@@ -396,22 +457,43 @@ exports.DetailedFailure = DetailedFailure;
  * @param detail - An optional detail of type `<TD>` to be returned.
  * @returns A {@link DetailedSuccess | DetailedSuccess<T, TD>} with the supplied value
  * and detail, if supplied.
+ * @remarks
+ * The `succeedsWithDetail` alias was added in release 5.0 for
+ * naming consistency with {@link fails | fails}, which was added to avoid conflicts
+ * with test frameworks and libraries.
  * @public
  */
 function succeedWithDetail(value, detail) {
     return new DetailedSuccess(value, detail);
 }
+/**
+ * {@inheritdoc succeedWithDetail}
+ * @public
+ */
+function succeedsWithDetail(value, detail) {
+    return new DetailedSuccess(value, detail);
+}
 /**
  * Returns {@link DetailedFailure | DetailedFailure<T, TD>} with a supplied error message and detail.
  * @param message - The error message to be returned.
  * @param detail - The event detail to be returned.
  * @returns An {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied error
  * message and detail.
+ * @remarks
+ * The `failsWithDetail` alias was added in release 5.0 for naming consistency
+ * with {@link fails | fails}, which was added to avoid conflicts with test frameworks and libraries.
  * @public
  */
 function failWithDetail(message, detail) {
     return new DetailedFailure(message, detail);
 }
+/**
+ * {@inheritdoc failWithDetail}
+ * @public
+ */
+function failsWithDetail(message, detail) {
+    return new DetailedFailure(message, detail);
+}
 /**
  * Propagates a {@link Success} or {@link Failure} {@link Result}, adding supplied
  * event details as appropriate.

package/lib/packlets/base/result.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"result.js","sourceRoot":"","sources":["../../../src/packlets/base/result.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAwhBH,0BAEC;AAOD,oBAEC;AA6LD,8CAEC;AAUD,wCAEC;AAaD,kDAQC;AAWD,sCAMC;AAhhBD;;;;GAIG;AACH,MAAa,OAAO;IAgBlB;;;OAGG;IACH,YAAmB,KAAQ;QAnB3B;;WAEG;QACa,YAAO,GAAS,IAAI,CAAC;QAErC;;WAEG;QACa,YAAO,GAAc,SAAS,CAAC;QAY7C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,SAAS;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,SAAS;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,QAAwB;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAUM,SAAS,CAAC,IAAQ;;QACvB,OAAO,MAAA,IAAI,CAAC,MAAM,mCAAI,IAAI,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,QAAwB;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,IAAQ;;QAC/B,OAAO,MAAA,IAAI,CAAC,MAAM,mCAAI,IAAI,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,SAAS,CAAK,EAA8B;QACjD,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,EAA0B;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,IAAoB;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAK,QAAY;QACvC,OAAO,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,UAAU,CAAK,MAAU,EAAE,aAAkB;QAClD,OAAO,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,MAA0B;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAzHD,0BAyHC;AAED;;;GAGG;AACH,MAAa,OAAO;IAelB;;;OAGG;IACH,YAAmB,OAAe;QAlBlC;;WAEG;QACa,YAAO,GAAU,KAAK,CAAC;QACvC;;WAEG;QACa,UAAK,GAAc,SAAS,CAAC;QAY3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,SAAS;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,SAAS;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,MAAsB;QACnC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAUM,SAAS,CAAC,IAAQ;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,MAAsB;QAC3C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,IAAQ;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,SAAS,CAAK,EAA8B;QACjD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,EAA0B;QACzC,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,EAAkB;QACvC,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAK,MAAU;QACrC,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,UAAU,CAAK,MAAU,EAAE,eAAoB;QACpD,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,MAA0B;QAC9C,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAzID,0BAyIC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CAAI,KAAQ;IACjC,OAAO,IAAI,OAAO,CAAI,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED;;;;GAIG;AACH,SAAgB,IAAI,CAAI,OAAe;IACrC,OAAO,IAAI,OAAO,CAAI,OAAO,CAAC,CAAC;AACjC,CAAC;AAoBD;;;;GAIG;AACH,MAAa,eAAuB,SAAQ,OAAU;IAMpD;;;;;;OAMG;IACH,YAAmB,KAAQ,EAAE,MAAW;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;;;OAOG;IACI,SAAS;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CAAK,EAA0C;QAC7D,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CAAC,IAAwC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,EAAkB;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AApED,0CAoEC;AAED;;;;GAIG;AACH,MAAa,eAAuB,SAAQ,OAAU;IAMpD;;;;;OAKG;IACH,YAAmB,OAAe,EAAE,MAAU;QAC5C,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;;;OAOG;IACI,SAAS;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACI,SAAS,CAAK,IAA4C;QAC/D,OAAO,IAAI,eAAe,CAAS,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,EAAsC;QACrD,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,EAAsB;QAC3C,OAAO,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AAlED,0CAkEC;AAcD;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAAQ,KAAQ,EAAE,MAAW;IAC5D,OAAO,IAAI,eAAe,CAAQ,KAAK,EAAE,MAAM,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAQ,OAAe,EAAE,MAAU;IAC/D,OAAO,IAAI,eAAe,CAAQ,OAAO,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,mBAAmB,CACjC,MAAiB,EACjB,MAAU,EACV,aAAkB;IAElB,OAAO,MAAM,CAAC,SAAS,EAAE;QACvB,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,MAAM,CAAC;QAC1D,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,aAAa,CAAI,IAAa;IAC5C,IAAI,CAAC;QACH,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,IAAI,CAAE,GAAa,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;AACH,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\n/ eslint-disable no-use-before-define /\n/\n Represents the {@link IResult \| result} of some operation or sequence of operations.\n * @remarks\n * {@link Success \| Success<T>} and {@link Failure \| Failure<T>} share the common\n * contract {@link IResult}, enabling commingled discriminated usage.\n * @public\n /\nexport type Result<T> = Success<T> \| Failure<T>;\n/\n Continuation callback to be called in the event that an\n * {@link Result} is successful.\n * @public\n /\nexport type SuccessContinuation<T, TN> = (value: T) => Result<TN>;\n\n/\n Continuation callback to be called in the event that an\n * {@link Result} fails.\n * @public\n /\nexport type FailureContinuation<T> = (message: string) => Result<T>;\n\n/\n Type inference to determine the result type of an {@link Result}.\n * @beta\n /\nexport type ResultValueType<T> = T extends Result<infer TV> ? TV : never;\n\n/\n Formats an error message.\n * @param message - The error message to be formatted.\n * @param detail - An optional detail to be included in the formatted message.\n * @public\n /\nexport type ErrorFormatter<TD = unknown> = (message: string, detail?: TD) => string;\n\n/\n Simple logger interface used by {@link IResult.orThrow}.\n * @public\n /\nexport interface IResultLogger {\n /\n Log an error message.\n * @param message - The message to be logged.\n /\n error(message: string): void;\n}\n\n/\n Simple error aggregator to simplify collecting all errors in\n * a flow.\n * @public\n /\nexport interface IMessageAggregator {\n /\n Indicates whether any messages have been aggregated.\n /\n readonly hasMessages: boolean;\n\n /\n The number of messages aggregated.\n /\n readonly numMessages: number;\n\n /\n The aggregated messages.\n /\n readonly messages: ReadonlyArray<string>;\n\n /\n Adds a message to the aggregator, if defined.\n * @param message - The message to add - pass `undefined`\n * or the empty string to continue without adding a message.\n /\n addMessage(message: string \| undefined): this;\n\n /\n Adds multiple messages to the aggregator.\n * @param messages - the messages to add.\n /\n addMessages(messages: string[] \| undefined): this;\n\n /\n Returns all messages as a single string joined\n * using the optionally-supplied `separator`, or\n * newline if no separator is specified.\n * @param separator - The optional separator used\n * to join strings.\n /\n toString(separator?: string): string;\n}\n\n/\n Represents the result of some operation of sequence of operations.\n * @remarks\n * This common contract enables commingled discriminated usage of {@link Success \| Success<T>}\n * and {@link Failure \| Failure<T>}.\n * @public\n /\nexport interface IResult<T> {\n /\n Indicates whether the operation was successful.\n /\n readonly success: boolean;\n\n /\n Value returned by a successful operation, undefined\n * for a failed operation.\n /\n readonly value: T \| undefined;\n\n /\n Error message returned by a failed operation, undefined\n * for a successful operation.\n /\n readonly message: string \| undefined;\n\n /\n Indicates whether this operation was successful. Functions\n * as a type guard for {@link Success \| Success<T>}.\n /\n isSuccess(): this is Success<T>;\n\n /\n Indicates whether this operation failed. Functions\n * as a type guard for {@link Failure \| Failure<T>}.\n /\n isFailure(): this is Failure<T>;\n\n /\n Gets the value associated with a successful {@link IResult \| result},\n * or throws the error message if the corresponding operation failed.\n \n Note that `getValueOrThrow` is being superseded by `orThrow` and\n * will eventually be deprecated. Please use orDefault instead.\n \n @param logger - An optional {@link IResultLogger \| logger} to which the\n * error will also be reported.\n * @returns The return value, if the operation was successful.\n * @throws The error message if the operation failed.\n * @deprecated Use {@link IResult.orThrow \| orThrow} instead.\n /\n getValueOrThrow(logger?: IResultLogger): T;\n\n /\n Gets the value associated with a successful {@link IResult \| result},\n * or a default value if the corresponding operation failed.\n * @param dflt - The value to be returned if the operation failed (default is\n * `undefined`).\n \n Note that `getValueOrDefault` is being superseded by `orDefault` and\n * will eventually be deprecated. Please use orDefault instead.\n \n @returns The return value, if the operation was successful. Returns\n * the supplied default value or `undefined` if no default is supplied.\n * @deprecated Use {@link IResult.(orDefault:1) \| orDefault(T)} or {@link IResult.(orDefault:2) \| orDefault()} instead.\n /\n getValueOrDefault(dflt?: T): T \| undefined;\n\n /\n Gets the value associated with a successful {@link IResult \| result},\n * or throws the error message if the corresponding operation failed.\n * @param logger - An optional {@link IResultLogger \| logger} to which the\n * error will also be reported.\n * @returns The return value, if the operation was successful.\n * @throws The error message if the operation failed.\n /\n orThrow(logger?: IResultLogger): T;\n\n /\n Gets the value associated with a successful {@link IResult \| result},\n * or a default value if the corresponding operation failed.\n * @param dflt - The value to be returned if the operation failed.\n * @returns The return value, if the operation was successful. Returns\n * the supplied default if an error occurred.\n * {@label SUPPLIED}\n /\n orDefault(dflt: T): T;\n\n /\n Gets the value associated with a successful {@link IResult \| result},\n * or a default value if the corresponding operation failed.\n * @returns The return value, if the operation was successful, or\n * `undefined` if an error occurs.\n * {@label MISSING}\n /\n orDefault(): T \| undefined;\n\n /\n Calls a supplied {@link SuccessContinuation \| success continuation} if\n * the operation was a success.\n * @remarks\n * The {@link SuccessContinuation \| success continuation} might return a\n * different result type than {@link IResult} on which it is invoked. This\n * enables chaining of operations with heterogenous return types.\n \n @param cb - The {@link SuccessContinuation \| success continuation} to\n * be called in the event of success.\n * @returns If this operation was successful, returns the value returned\n * by the {@link SuccessContinuation \| success continuation}. If this result\n * failed, propagates the error message from this failure.\n /\n onSuccess<TN>(cb: SuccessContinuation<T, TN>): Result<TN>;\n\n /\n Calls a supplied {@link FailureContinuation \| failed continuation} if\n * the operation failed.\n * @param cb - The {@link FailureContinuation \| failure continuation} to\n * be called in the event of failure.\n * @returns If this operation failed, returns the value returned by the\n * {@link FailureContinuation \| failure continuation}. If this result\n * was successful, propagates the result value from the successful event.\n /\n onFailure(cb: FailureContinuation<T>): Result<T>;\n\n /\n Calls a supplied {@link ErrorFormatter \| error formatter} if\n * the operation failed.\n * @param cb - The {@link ErrorFormatter \| error formatter} to\n * be called in the event of failure.\n * @returns If this operation failed, returns the returns {@link Failure \| Failure}\n * with the message returned by the formatter. If this result\n * was successful, propagates the result value from the successful event.\n /\n withErrorFormat(cb: ErrorFormatter): Result<T>;\n\n /\n Converts a {@link IResult \| IResult<T>} to a {@link DetailedResult \| DetailedResult<T, TD>},\n * adding a supplied detail if the operation failed.\n * @param detail - The detail to be added if this operation failed.\n * @returns A new {@link DetailedResult \| DetailedResult<T, TD>} with either\n * the success result or the error message from this {@link IResult}, with\n * the supplied detail (if this event failed) or detail `undefined` (if\n * this result succeeded).\n /\n withFailureDetail<TD>(detail: TD): DetailedResult<T, TD>;\n\n /\n Converts a {@link IResult \| IResult<T>} to a {@link DetailedResult \| DetailedResult<T, TD>},\n * adding supplied details.\n * @param detail - The default detail to be added to the new {@link DetailedResult}.\n * @param successDetail - An optional detail to be added if this result was successful.\n * @returns A new {@link DetailedResult \| DetailedResult<T, TD>} with either\n * the success result or the error message from this {@link IResult} and the\n * appropriate added detail.\n /\n withDetail<TD>(detail: TD, successDetail?: TD): DetailedResult<T, TD>;\n\n /\n Propagates interior result, appending any error message to the\n * supplied errors array.\n * @param errors - {@link IMessageAggregator \| Error aggregator} in which\n * errors will be aggregated.\n /\n aggregateError(errors: IMessageAggregator): this;\n}\n\n/\n Reports a successful {@link IResult \| result} from some operation and the\n * corresponding value.\n * @public\n /\nexport class Success<T> implements IResult<T> {\n /\n {@inheritdoc IResult.success}\n /\n public readonly success: true = true;\n\n /\n For a successful operation, the error message is always `undefined`.\n /\n public readonly message: undefined = undefined;\n\n /\n @internal\n /\n private readonly _value: T;\n\n /\n Constructs a {@link Success} with the supplied value.\n * @param value - The value to be returned.\n /\n public constructor(value: T) {\n this._value = value;\n }\n\n /\n The result value returned by the successful operation.\n /\n public get value(): T {\n return this._value;\n }\n\n /\n {@inheritdoc IResult.isSuccess}\n /\n public isSuccess(): this is Success<T> {\n return true;\n }\n\n /\n {@inheritdoc IResult.isFailure}\n /\n public isFailure(): this is Failure<T> {\n return false;\n }\n\n /\n {@inheritdoc IResult.orThrow}\n /\n public orThrow(__logger?: IResultLogger): T {\n return this._value;\n }\n\n /\n {@inheritdoc IResult.(orDefault:1)}\n /\n public orDefault(dflt: T): T;\n /\n {@inheritdoc IResult.(orDefault:2)}\n /\n public orDefault(): T \| undefined;\n public orDefault(dflt?: T): T \| undefined {\n return this._value ?? dflt;\n }\n\n /\n {@inheritdoc IResult.getValueOrThrow}\n * @deprecated Use {@link Success.orThrow \| orThrow} instead.\n /\n public getValueOrThrow(__logger?: IResultLogger): T {\n return this._value;\n }\n\n /\n {@inheritdoc IResult.getValueOrDefault}\n * @deprecated Use {@link Success.(orDefault:1) \| orDefault(T)} or {@link Success.(orDefault:2) \| orDefault()} instead.\n /\n public getValueOrDefault(dflt?: T): T \| undefined {\n return this._value ?? dflt;\n }\n\n /\n {@inheritdoc IResult.onSuccess}\n /\n public onSuccess<TN>(cb: SuccessContinuation<T, TN>): Result<TN> {\n return cb(this.value);\n }\n\n /\n {@inheritdoc IResult.onFailure}\n /\n public onFailure(__: FailureContinuation<T>): Result<T> {\n return this;\n }\n\n /\n {@inheritdoc IResult.withErrorFormat}\n /\n public withErrorFormat(__cb: ErrorFormatter): Result<T> {\n return this;\n }\n\n /\n {@inheritdoc IResult.withFailureDetail}\n /\n public withFailureDetail<TD>(__detail: TD): DetailedResult<T, TD> {\n return succeedWithDetail(this.value);\n }\n\n /\n {@inheritdoc IResult.withDetail}\n /\n public withDetail<TD>(detail: TD, successDetail?: TD): DetailedResult<T, TD> {\n return succeedWithDetail(this.value, successDetail ?? detail);\n }\n\n /\n {@inheritdoc IResult.aggregateError}\n /\n public aggregateError(errors: IMessageAggregator): this {\n return this;\n }\n}\n\n/\n Reports a failed {@link IResult \| result} from some operation, with an error message.\n * @public\n /\nexport class Failure<T> implements IResult<T> {\n /\n {@inheritdoc IResult.success}\n /\n public readonly success: false = false;\n /\n Failed operation always returns undefined for value.\n /\n public readonly value: undefined = undefined;\n\n /\n @internal\n /\n private readonly _message: string;\n\n /\n Constructs a {@link Failure} with the supplied message.\n * @param message - Error message to be reported.\n /\n public constructor(message: string) {\n this._message = message;\n }\n\n /\n Gets the error message associated with this error.\n /\n public get message(): string {\n return this._message;\n }\n\n /\n {@inheritdoc IResult.isSuccess}\n /\n public isSuccess(): this is Success<T> {\n return false;\n }\n\n /\n {@inheritdoc IResult.isFailure}\n /\n public isFailure(): this is Failure<T> {\n return true;\n }\n\n /\n {@inheritdoc IResult.orThrow}\n /\n public orThrow(logger?: IResultLogger): never {\n if (logger !== undefined) {\n logger.error(this._message);\n }\n throw new Error(this._message);\n }\n\n /\n {@inheritdoc IResult.(orDefault:1)}\n /\n public orDefault(dflt: T): T;\n /\n {@inheritdoc IResult.(orDefault:2)}\n /\n public orDefault(): T \| undefined;\n public orDefault(dflt?: T): T \| undefined {\n return dflt;\n }\n\n /\n {@inheritdoc IResult.getValueOrThrow}\n * @deprecated Use {@link Failure.orThrow \| orThrow} instead.\n /\n public getValueOrThrow(logger?: IResultLogger): never {\n if (logger !== undefined) {\n logger.error(this._message);\n }\n throw new Error(this._message);\n }\n\n /\n {@inheritdoc IResult.getValueOrDefault}\n * @deprecated Use {@link Failure.(orDefault:1) \| orDefault(T)} or {@link Failure.(orDefault:2) \| orDefault()} instead.\n /\n public getValueOrDefault(dflt?: T): T \| undefined {\n return dflt;\n }\n\n /\n {@inheritdoc IResult.onSuccess}\n /\n public onSuccess<TN>(__: SuccessContinuation<T, TN>): Result<TN> {\n return new Failure(this.message);\n }\n\n /\n {@inheritdoc IResult.onFailure}\n /\n public onFailure(cb: FailureContinuation<T>): Result<T> {\n return cb(this.message);\n }\n\n /\n {@inheritdoc IResult.withErrorFormat}\n /\n public withErrorFormat(cb: ErrorFormatter): Result<T> {\n return fail(cb(this.message));\n }\n\n /\n {@inheritdoc IResult.withFailureDetail}\n /\n public withFailureDetail<TD>(detail: TD): DetailedResult<T, TD> {\n return failWithDetail(this.message, detail);\n }\n\n /\n {@inheritdoc IResult.withDetail}\n /\n public withDetail<TD>(detail: TD, __successDetail?: TD): DetailedResult<T, TD> {\n return failWithDetail(this.message, detail);\n }\n\n /\n {@inheritdoc IResult.aggregateError}\n /\n public aggregateError(errors: IMessageAggregator): this {\n errors.addMessage(this.message);\n return this;\n }\n\n /\n Get a 'friendly' string representation of this object.\n * @remarks\n * The string representation of a {@link Failure} value is the error message.\n * @returns A string representing this object.\n /\n public toString(): string {\n return this.message;\n }\n}\n\n/\n Returns {@link Success \| Success<T>} with the supplied result value.\n * @param value - The successful result value to be returned\n * @public\n /\nexport function succeed<T>(value: T): Success<T> {\n return new Success<T>(value);\n}\n\n/\n Returns {@link Failure \| Failure<T>} with the supplied error message.\n * @param message - Error message to be returned.\n * @public\n /\nexport function fail<T>(message: string): Failure<T> {\n return new Failure<T>(message);\n}\n\n/\n Callback to be called when a {@link DetailedResult} encounters success.\n * @remarks\n * A success callback can return a different result type than it receives, allowing\n * success results to chain through intermediate result types.\n * @public\n /\nexport type DetailedSuccessContinuation<T, TD, TN> = (value: T, detail?: TD) => DetailedResult<TN, TD>;\n\n/\n Callback to be called when a {@link DetailedResult} encounters a failure.\n * @remarks\n * A failure callback can change {@link Failure} to {@link Success} (e.g. by returning a default value)\n * or it can change or embellish the error message, but it cannot change the success return type.\n * @public\n /\nexport type DetailedFailureContinuation<T, TD> = (message: string, detail: TD) => DetailedResult<T, TD>;\n\n/\n A {@link DetailedSuccess} extends {@link Success} to report optional success details in\n * addition to the error message.\n * @public\n /\nexport class DetailedSuccess<T, TD> extends Success<T> {\n /\n @internal\n /\n protected _detail?: TD;\n\n /\n Constructs a new {@link DetailedSuccess \| DetailedSuccess<T, TD>} with the supplied\n * value and detail.\n * @param value - The value to be returned.\n * @param detail - An optional successful detail to be returned. If omitted, detail\n * will be `undefined`.\n /\n public constructor(value: T, detail?: TD) {\n super(value);\n this._detail = detail;\n }\n\n /\n The success detail associated with this {@link DetailedSuccess}, or `undefined` if\n * no detail was supplied.\n /\n public get detail(): TD \| undefined {\n return this._detail;\n }\n\n /\n Reports that this {@link DetailedSuccess} is a success.\n * @remarks\n * Always true for {@link DetailedSuccess} but can be used as type guard\n * to discriminate {@link DetailedSuccess} from {@link DetailedFailure} in\n * a {@link DetailedResult}.\n * @returns `true`\n /\n public isSuccess(): this is DetailedSuccess<T, TD> {\n return true;\n }\n\n /\n Invokes the supplied {@link DetailedSuccessContinuation \| success callback} and propagates\n * its returned {@link DetailedResult \| DetailedResult<TN, TD>}.\n * @remarks\n * The success callback mutates the return type from `<T>` to `<TN>`.\n * @param cb - The {@link DetailedSuccessContinuation \| success callback} to be invoked.\n * @returns The {@link DetailedResult \| DetailedResult<T, TD>} returned by the success callback.\n /\n public onSuccess<TN>(cb: DetailedSuccessContinuation<T, TD, TN>): DetailedResult<TN, TD> {\n return cb(this.value, this._detail);\n }\n\n /\n Propagates this {@link DetailedSuccess}.\n * @remarks\n * Failure does not mutate return type so we can return this event directly.\n * @param _cb - {@link DetailedFailureContinuation \| Failure callback} to be called\n * on a {@link DetailedResult} in case of failure (ignored).\n * @returns `this`\n /\n public onFailure(__cb: DetailedFailureContinuation<T, TD>): DetailedResult<T, TD> {\n return this;\n }\n\n /\n {@inheritdoc Success.withErrorFormat}\n /\n public withErrorFormat(cb: ErrorFormatter): DetailedResult<T, TD> {\n return this;\n }\n}\n\n/\n A {@link DetailedFailure} extends {@link Failure} to report optional failure details in\n * addition to the error message.\n * @public\n /\nexport class DetailedFailure<T, TD> extends Failure<T> {\n /\n @internal\n /\n protected _detail: TD;\n\n /\n Constructs a new {@link DetailedFailure \| DetailedFailure<T, TD>} with the supplied\n * message and detail.\n * @param message - The message to be returned.\n * @param detail - The error detail to be returned.\n /\n public constructor(message: string, detail: TD) {\n super(message);\n this._detail = detail;\n }\n\n /\n The error detail associated with this {@link DetailedFailure}.\n /\n public get detail(): TD {\n return this._detail;\n }\n\n /\n Reports that this {@link DetailedFailure} is a failure.\n * @remarks\n * Always true for {@link DetailedFailure} but can be used as type guard\n * to discriminate {@link DetailedSuccess} from {@link DetailedFailure} in\n * a {@link DetailedResult}.\n * @returns `true`\n /\n public isFailure(): this is DetailedFailure<T, TD> {\n return true;\n }\n\n /\n Propagates the error message and detail from this result.\n * @remarks\n * Mutates the success type as the success callback would have, but does not\n * call the success callback.\n * @param _cb - {@link DetailedSuccessContinuation \| Success callback} to be called\n * on a {@link DetailedResult} in case of success (ignored).\n * @returns A new {@link DetailedFailure \| DetailedFailure<TN, TD>} which contains\n * the error message and detail from this one.\n /\n public onSuccess<TN>(__cb: DetailedSuccessContinuation<T, TD, TN>): DetailedResult<TN, TD> {\n return new DetailedFailure<TN, TD>(this.message, this._detail);\n }\n\n /\n Invokes the supplied {@link DetailedFailureContinuation \| failure callback} and propagates\n * its returned {@link DetailedResult \| DetailedResult<T, TD>}.\n * @param cb - The {@link DetailedFailureContinuation \| failure callback} to be invoked.\n * @returns The {@link DetailedResult \| DetailedResult<T, TD>} returned by the failure callback.\n /\n public onFailure(cb: DetailedFailureContinuation<T, TD>): DetailedResult<T, TD> {\n return cb(this.message, this._detail);\n }\n\n /\n {@inheritdoc IResult.withErrorFormat}\n /\n public withErrorFormat(cb: ErrorFormatter<TD>): DetailedResult<T, TD> {\n return failWithDetail(cb(this.message, this._detail), this._detail);\n }\n}\n\n/\n Type inference to determine the result type `T` of a {@link DetailedResult \| DetailedResult<T, TD>}.\n * @beta\n /\nexport type DetailedResult<T, TD> = DetailedSuccess<T, TD> \| DetailedFailure<T, TD>;\n\n/\n Type inference to determine the detail type `TD` of a {@link DetailedResult \| DetailedResult<T, TD>}.\n * @beta\n /\nexport type ResultDetailType<T> = T extends DetailedResult<unknown, infer TD> ? TD : never;\n\n/\n Returns {@link DetailedSuccess \| DetailedSuccess<T, TD>} with a supplied value and optional\n * detail.\n * @param value - The value of type `<T>` to be returned.\n * @param detail - An optional detail of type `<TD>` to be returned.\n * @returns A {@link DetailedSuccess \| DetailedSuccess<T, TD>} with the supplied value\n * and detail, if supplied.\n * @public\n /\nexport function succeedWithDetail<T, TD>(value: T, detail?: TD): DetailedSuccess<T, TD> {\n return new DetailedSuccess<T, TD>(value, detail);\n}\n\n/\n Returns {@link DetailedFailure \| DetailedFailure<T, TD>} with a supplied error message and detail.\n * @param message - The error message to be returned.\n * @param detail - The event detail to be returned.\n * @returns An {@link DetailedFailure \| DetailedFailure<T, TD>} with the supplied error\n * message and detail.\n * @public\n /\nexport function failWithDetail<T, TD>(message: string, detail: TD): DetailedFailure<T, TD> {\n return new DetailedFailure<T, TD>(message, detail);\n}\n\n/\n Propagates a {@link Success} or {@link Failure} {@link Result}, adding supplied\n * event details as appropriate.\n * @param result - The {@link Result} to be propagated.\n * @param detail - The event detail (type `<TD>`) to be added to the {@link Result \| result}.\n * @param successDetail - An optional distinct event detail to be added to {@link Success} results. If `successDetail`\n * is omitted or `undefined`, then `detail` will be applied to {@link Success} results.\n * @returns A new {@link DetailedResult \| DetailedResult<T, TD>} with the success value or error\n * message from the original `result` but with the specified detail added.\n * @public\n /\nexport function propagateWithDetail<T, TD>(\n result: Result<T>,\n detail: TD,\n successDetail?: TD\n): DetailedResult<T, TD> {\n return result.isSuccess()\n ? succeedWithDetail(result.value, successDetail ?? detail)\n : failWithDetail(result.message, detail);\n}\n\n/\n Wraps a function which might throw to convert exception results\n * to {@link Failure}.\n * @param func - The function to be captured.\n * @returns Returns {@link Success} with a value of type `<T>` on\n * success , or {@link Failure} with the thrown error message if\n * `func` throws an `Error`.\n * @public\n */\nexport function captureResult<T>(func: () => T): Result<T> {\n try {\n return succeed(func());\n } catch (err) {\n return fail((err as Error).message);\n }\n}\n"]}
1	+ {"version":3,"file":"result.js","sourceRoot":"","sources":["../../../src/packlets/base/result.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AA+iBH,0BAEC;AAMD,4BAEC;AAUD,oBAEC;AAMD,sBAEC;AAuND,8CAEC;AAMD,gDAEC;AAaD,wCAEC;AAMD,0CAEC;AAaD,kDAQC;AAWD,sCAMC;AAvmBD;;;;GAIG;AACH,MAAa,OAAO;IAgBlB;;;OAGG;IACH,YAAmB,KAAQ;QAnB3B;;WAEG;QACa,YAAO,GAAS,IAAI,CAAC;QAErC;;WAEG;QACa,YAAO,GAAc,SAAS,CAAC;QAY7C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,SAAS;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,SAAS;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,QAAwB;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAUM,SAAS,CAAC,IAAQ;;QACvB,OAAO,MAAA,IAAI,CAAC,MAAM,mCAAI,IAAI,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,QAAwB;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,IAAQ;;QAC/B,OAAO,MAAA,IAAI,CAAC,MAAM,mCAAI,IAAI,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,SAAS,CAAK,EAA8B;QACjD,OAAO,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,EAA0B;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,IAAoB;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAK,QAAY;QACvC,OAAO,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,UAAU,CAAK,MAAU,EAAE,aAAkB;QAClD,OAAO,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,QAA4B;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,IAAI,CAAI,KAAQ;QAC5B,OAAO,IAAI,OAAO,CAAI,KAAK,CAAC,CAAC;IAC/B,CAAC;CACF;AAnID,0BAmIC;AAED;;;GAGG;AACH,MAAa,OAAO;IAelB;;;OAGG;IACH,YAAmB,OAAe;QAlBlC;;WAEG;QACa,YAAO,GAAU,KAAK,CAAC;QACvC;;WAEG;QACa,UAAK,GAAc,SAAS,CAAC;QAY3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,SAAS;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,SAAS;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,MAAsB;QACnC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAUM,SAAS,CAAC,IAAQ;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,MAAsB;QAC3C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,IAAQ;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,SAAS,CAAK,EAA8B;QACjD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,EAA0B;QACzC,OAAO,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,EAAkB;QACvC,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAK,MAAU;QACrC,OAAO,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,UAAU,CAAK,MAAU,EAAE,eAAoB;QACpD,OAAO,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,MAA0B;QAC9C,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAI,CAAI,OAAe;QACnC,OAAO,IAAI,OAAO,CAAI,OAAO,CAAC,CAAC;IACjC,CAAC;CACF;AAlJD,0BAkJC;AAED;;;;;;;;GAQG;AACH,SAAgB,OAAO,CAAI,KAAQ;IACjC,OAAO,IAAI,OAAO,CAAI,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED;;;GAGG;AACH,SAAgB,QAAQ,CAAI,KAAQ;IAClC,OAAO,IAAI,OAAO,CAAI,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,IAAI,CAAI,OAAe;IACrC,OAAO,IAAI,OAAO,CAAI,OAAO,CAAC,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAI,OAAe;IACtC,OAAO,IAAI,OAAO,CAAI,OAAO,CAAC,CAAC;AACjC,CAAC;AAqBD;;;;GAIG;AACH,MAAa,eAAuB,SAAQ,OAAU;IAMpD;;;;;;OAMG;IACH,YAAmB,KAAQ,EAAE,MAAW;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;;;OAOG;IACI,SAAS;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CAAK,EAA0C;QAC7D,OAAO,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CAAC,IAAwC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,EAAkB;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,IAAI,CAAQ,KAAQ,EAAE,MAAW;QAC7C,OAAO,IAAI,eAAe,CAAQ,KAAK,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;CACF;AA5ED,0CA4EC;AAED;;;;GAIG;AACH,MAAa,eAAuB,SAAQ,OAAU;IAMpD;;;;;OAKG;IACH,YAAmB,OAAe,EAAE,MAAW;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;;;OAOG;IACI,SAAS;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACI,SAAS,CAAK,IAA4C;QAC/D,OAAO,IAAI,eAAe,CAAS,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,EAAsC;QACrD,OAAO,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,EAAsB;QAC3C,OAAO,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,IAAI,CAAQ,OAAe,EAAE,MAAW;QACpD,OAAO,IAAI,eAAe,CAAQ,OAAO,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;CACF;AA/ED,0CA+EC;AAcD;;;;;;;;;;;;GAYG;AACH,SAAgB,iBAAiB,CAAQ,KAAQ,EAAE,MAAW;IAC5D,OAAO,IAAI,eAAe,CAAQ,KAAK,EAAE,MAAM,CAAC,CAAC;AACnD,CAAC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAAQ,KAAQ,EAAE,MAAW;IAC7D,OAAO,IAAI,eAAe,CAAQ,KAAK,EAAE,MAAM,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,cAAc,CAAQ,OAAe,EAAE,MAAW;IAChE,OAAO,IAAI,eAAe,CAAQ,OAAO,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC;AAED;;;GAGG;AACH,SAAgB,eAAe,CAAQ,OAAe,EAAE,MAAW;IACjE,OAAO,IAAI,eAAe,CAAQ,OAAO,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,mBAAmB,CACjC,MAAiB,EACjB,MAAU,EACV,aAAkB;IAElB,OAAO,MAAM,CAAC,SAAS,EAAE;QACvB,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,MAAM,CAAC;QAC1D,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,aAAa,CAAI,IAAa;IAC5C,IAAI,CAAC;QACH,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,IAAI,CAAE,GAAa,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;AACH,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\n/ eslint-disable no-use-before-define /\n/\n Represents the {@link IResult \| result} of some operation or sequence of operations.\n * @remarks\n * {@link Success \| Success<T>} and {@link Failure \| Failure<T>} share the common\n * contract {@link IResult}, enabling commingled discriminated usage.\n * @public\n /\nexport type Result<T> = Success<T> \| Failure<T>;\n/\n Continuation callback to be called in the event that an\n * {@link Result} is successful.\n * @public\n /\nexport type SuccessContinuation<T, TN> = (value: T) => Result<TN>;\n\n/\n Continuation callback to be called in the event that an\n * {@link Result} fails.\n * @public\n /\nexport type FailureContinuation<T> = (message: string) => Result<T>;\n\n/\n Type inference to determine the result type of an {@link Result}.\n * @beta\n /\nexport type ResultValueType<T> = T extends Result<infer TV> ? TV : never;\n\n/\n Formats an error message.\n * @param message - The error message to be formatted.\n * @param detail - An optional detail to be included in the formatted message.\n * @public\n /\nexport type ErrorFormatter<TD = unknown> = (message: string, detail?: TD) => string;\n\n/\n Simple logger interface used by {@link IResult.orThrow}.\n * @public\n /\nexport interface IResultLogger {\n /\n Log an error message.\n * @param message - The message to be logged.\n /\n error(message: string): void;\n}\n\n/\n Simple error aggregator to simplify collecting all errors in\n * a flow.\n * @public\n /\nexport interface IMessageAggregator {\n /\n Indicates whether any messages have been aggregated.\n /\n readonly hasMessages: boolean;\n\n /\n The number of messages aggregated.\n /\n readonly numMessages: number;\n\n /\n The aggregated messages.\n /\n readonly messages: ReadonlyArray<string>;\n\n /\n Adds a message to the aggregator, if defined.\n * @param message - The message to add - pass `undefined`\n * or the empty string to continue without adding a message.\n /\n addMessage(message: string \| undefined): this;\n\n /\n Adds multiple messages to the aggregator.\n * @param messages - the messages to add.\n /\n addMessages(messages: string[] \| undefined): this;\n\n /\n Returns all messages as a single string joined\n * using the optionally-supplied `separator`, or\n * newline if no separator is specified.\n * @param separator - The optional separator used\n * to join strings.\n /\n toString(separator?: string): string;\n}\n\n/\n Represents the result of some operation of sequence of operations.\n * @remarks\n * This common contract enables commingled discriminated usage of {@link Success \| Success<T>}\n * and {@link Failure \| Failure<T>}.\n * @public\n /\nexport interface IResult<T> {\n /\n Indicates whether the operation was successful.\n /\n readonly success: boolean;\n\n /\n Value returned by a successful operation, undefined\n * for a failed operation.\n /\n readonly value: T \| undefined;\n\n /\n Error message returned by a failed operation, undefined\n * for a successful operation.\n /\n readonly message: string \| undefined;\n\n /\n Indicates whether this operation was successful. Functions\n * as a type guard for {@link Success \| Success<T>}.\n /\n isSuccess(): this is Success<T>;\n\n /\n Indicates whether this operation failed. Functions\n * as a type guard for {@link Failure \| Failure<T>}.\n /\n isFailure(): this is Failure<T>;\n\n /\n Gets the value associated with a successful {@link IResult \| result},\n * or throws the error message if the corresponding operation failed.\n \n Note that `getValueOrThrow` is being superseded by `orThrow` and\n * will eventually be deprecated. Please use orDefault instead.\n \n @param logger - An optional {@link IResultLogger \| logger} to which the\n * error will also be reported.\n * @returns The return value, if the operation was successful.\n * @throws The error message if the operation failed.\n * @deprecated Use {@link IResult.orThrow \| orThrow} instead.\n /\n getValueOrThrow(logger?: IResultLogger): T;\n\n /\n Gets the value associated with a successful {@link IResult \| result},\n * or a default value if the corresponding operation failed.\n * @param dflt - The value to be returned if the operation failed (default is\n * `undefined`).\n \n Note that `getValueOrDefault` is being superseded by `orDefault` and\n * will eventually be deprecated. Please use orDefault instead.\n \n @returns The return value, if the operation was successful. Returns\n * the supplied default value or `undefined` if no default is supplied.\n * @deprecated Use {@link IResult.(orDefault:1) \| orDefault(T)} or {@link IResult.(orDefault:2) \| orDefault()} instead.\n /\n getValueOrDefault(dflt?: T): T \| undefined;\n\n /\n Gets the value associated with a successful {@link IResult \| result},\n * or throws the error message if the corresponding operation failed.\n * @param logger - An optional {@link IResultLogger \| logger} to which the\n * error will also be reported.\n * @returns The return value, if the operation was successful.\n * @throws The error message if the operation failed.\n /\n orThrow(logger?: IResultLogger): T;\n\n /\n Gets the value associated with a successful {@link IResult \| result},\n * or a default value if the corresponding operation failed.\n * @param dflt - The value to be returned if the operation failed.\n * @returns The return value, if the operation was successful. Returns\n * the supplied default if an error occurred.\n * {@label SUPPLIED}\n /\n orDefault(dflt: T): T;\n\n /\n Gets the value associated with a successful {@link IResult \| result},\n * or a default value if the corresponding operation failed.\n * @returns The return value, if the operation was successful, or\n * `undefined` if an error occurs.\n * {@label MISSING}\n /\n orDefault(): T \| undefined;\n\n /\n Calls a supplied {@link SuccessContinuation \| success continuation} if\n * the operation was a success.\n * @remarks\n * The {@link SuccessContinuation \| success continuation} might return a\n * different result type than {@link IResult} on which it is invoked. This\n * enables chaining of operations with heterogenous return types.\n \n @param cb - The {@link SuccessContinuation \| success continuation} to\n * be called in the event of success.\n * @returns If this operation was successful, returns the value returned\n * by the {@link SuccessContinuation \| success continuation}. If this result\n * failed, propagates the error message from this failure.\n /\n onSuccess<TN>(cb: SuccessContinuation<T, TN>): Result<TN>;\n\n /\n Calls a supplied {@link FailureContinuation \| failed continuation} if\n * the operation failed.\n * @param cb - The {@link FailureContinuation \| failure continuation} to\n * be called in the event of failure.\n * @returns If this operation failed, returns the value returned by the\n * {@link FailureContinuation \| failure continuation}. If this result\n * was successful, propagates the result value from the successful event.\n /\n onFailure(cb: FailureContinuation<T>): Result<T>;\n\n /\n Calls a supplied {@link ErrorFormatter \| error formatter} if\n * the operation failed.\n * @param cb - The {@link ErrorFormatter \| error formatter} to\n * be called in the event of failure.\n * @returns If this operation failed, returns the returns {@link Failure \| Failure}\n * with the message returned by the formatter. If this result\n * was successful, propagates the result value from the successful event.\n /\n withErrorFormat(cb: ErrorFormatter): Result<T>;\n\n /\n Converts a {@link IResult \| IResult<T>} to a {@link DetailedResult \| DetailedResult<T, TD>},\n * adding a supplied detail if the operation failed.\n * @param detail - The detail to be added if this operation failed.\n * @returns A new {@link DetailedResult \| DetailedResult<T, TD>} with either\n * the success result or the error message from this {@link IResult}, with\n * the supplied detail (if this event failed) or detail `undefined` (if\n * this result succeeded).\n /\n withFailureDetail<TD>(detail: TD): DetailedResult<T, TD>;\n\n /\n Converts a {@link IResult \| IResult<T>} to a {@link DetailedResult \| DetailedResult<T, TD>},\n * adding supplied details.\n * @param detail - The default detail to be added to the new {@link DetailedResult}.\n * @param successDetail - An optional detail to be added if this result was successful.\n * @returns A new {@link DetailedResult \| DetailedResult<T, TD>} with either\n * the success result or the error message from this {@link IResult} and the\n * appropriate added detail.\n /\n withDetail<TD>(detail: TD, successDetail?: TD): DetailedResult<T, TD>;\n\n /\n Propagates interior result, appending any error message to the\n * supplied errors array.\n * @param errors - {@link IMessageAggregator \| Error aggregator} in which\n * errors will be aggregated.\n /\n aggregateError(errors: IMessageAggregator): this;\n}\n\n/\n Reports a successful {@link IResult \| result} from some operation and the\n * corresponding value.\n * @public\n /\nexport class Success<T> implements IResult<T> {\n /\n {@inheritdoc IResult.success}\n /\n public readonly success: true = true;\n\n /\n For a successful operation, the error message is always `undefined`.\n /\n public readonly message: undefined = undefined;\n\n /\n @internal\n /\n protected readonly _value: T;\n\n /\n Constructs a {@link Success} with the supplied value.\n * @param value - The value to be returned.\n /\n public constructor(value: T) {\n this._value = value;\n }\n\n /\n The result value returned by the successful operation.\n /\n public get value(): T {\n return this._value;\n }\n\n /\n {@inheritdoc IResult.isSuccess}\n /\n public isSuccess(): this is Success<T> {\n return true;\n }\n\n /\n {@inheritdoc IResult.isFailure}\n /\n public isFailure(): this is Failure<T> {\n return false;\n }\n\n /\n {@inheritdoc IResult.orThrow}\n /\n public orThrow(__logger?: IResultLogger): T {\n return this._value;\n }\n\n /\n {@inheritdoc IResult.(orDefault:1)}\n /\n public orDefault(dflt: T): T;\n /\n {@inheritdoc IResult.(orDefault:2)}\n /\n public orDefault(): T \| undefined;\n public orDefault(dflt?: T): T \| undefined {\n return this._value ?? dflt;\n }\n\n /\n {@inheritdoc IResult.getValueOrThrow}\n * @deprecated Use {@link Success.orThrow \| orThrow} instead.\n /\n public getValueOrThrow(__logger?: IResultLogger): T {\n return this._value;\n }\n\n /\n {@inheritdoc IResult.getValueOrDefault}\n * @deprecated Use {@link Success.(orDefault:1) \| orDefault(T)} or {@link Success.(orDefault:2) \| orDefault()} instead.\n /\n public getValueOrDefault(dflt?: T): T \| undefined {\n return this._value ?? dflt;\n }\n\n /\n {@inheritdoc IResult.onSuccess}\n /\n public onSuccess<TN>(cb: SuccessContinuation<T, TN>): Result<TN> {\n return cb(this._value);\n }\n\n /\n {@inheritdoc IResult.onFailure}\n /\n public onFailure(__: FailureContinuation<T>): Result<T> {\n return this;\n }\n\n /\n {@inheritdoc IResult.withErrorFormat}\n /\n public withErrorFormat(__cb: ErrorFormatter): Result<T> {\n return this;\n }\n\n /\n {@inheritdoc IResult.withFailureDetail}\n /\n public withFailureDetail<TD>(__detail: TD): DetailedResult<T, TD> {\n return succeedWithDetail(this._value);\n }\n\n /\n {@inheritdoc IResult.withDetail}\n /\n public withDetail<TD>(detail: TD, successDetail?: TD): DetailedResult<T, TD> {\n return succeedWithDetail(this._value, successDetail ?? detail);\n }\n\n /\n {@inheritdoc IResult.aggregateError}\n /\n public aggregateError(__errors: IMessageAggregator): this {\n return this;\n }\n\n /\n Creates a {@link Success \| Success<T>} with the supplied value.\n * @param value - The value to be returned.\n * @returns The resulting {@link Success \| Success<T>} with the supplied value.\n * @public\n /\n public static with<T>(value: T): Success<T> {\n return new Success<T>(value);\n }\n}\n\n/\n Reports a failed {@link IResult \| result} from some operation, with an error message.\n * @public\n /\nexport class Failure<T> implements IResult<T> {\n /\n {@inheritdoc IResult.success}\n /\n public readonly success: false = false;\n /\n Failed operation always returns undefined for value.\n /\n public readonly value: undefined = undefined;\n\n /\n @internal\n /\n protected readonly _message: string;\n\n /\n Constructs a {@link Failure} with the supplied message.\n * @param message - Error message to be reported.\n /\n public constructor(message: string) {\n this._message = message;\n }\n\n /\n Gets the error message associated with this error.\n /\n public get message(): string {\n return this._message;\n }\n\n /\n {@inheritdoc IResult.isSuccess}\n /\n public isSuccess(): this is Success<T> {\n return false;\n }\n\n /\n {@inheritdoc IResult.isFailure}\n /\n public isFailure(): this is Failure<T> {\n return true;\n }\n\n /\n {@inheritdoc IResult.orThrow}\n /\n public orThrow(logger?: IResultLogger): never {\n if (logger !== undefined) {\n logger.error(this._message);\n }\n throw new Error(this._message);\n }\n\n /\n {@inheritdoc IResult.(orDefault:1)}\n /\n public orDefault(dflt: T): T;\n /\n {@inheritdoc IResult.(orDefault:2)}\n /\n public orDefault(): T \| undefined;\n public orDefault(dflt?: T): T \| undefined {\n return dflt;\n }\n\n /\n {@inheritdoc IResult.getValueOrThrow}\n * @deprecated Use {@link Failure.orThrow \| orThrow} instead.\n /\n public getValueOrThrow(logger?: IResultLogger): never {\n if (logger !== undefined) {\n logger.error(this._message);\n }\n throw new Error(this._message);\n }\n\n /\n {@inheritdoc IResult.getValueOrDefault}\n * @deprecated Use {@link Failure.(orDefault:1) \| orDefault(T)} or {@link Failure.(orDefault:2) \| orDefault()} instead.\n /\n public getValueOrDefault(dflt?: T): T \| undefined {\n return dflt;\n }\n\n /\n {@inheritdoc IResult.onSuccess}\n /\n public onSuccess<TN>(__: SuccessContinuation<T, TN>): Result<TN> {\n return new Failure(this._message);\n }\n\n /\n {@inheritdoc IResult.onFailure}\n /\n public onFailure(cb: FailureContinuation<T>): Result<T> {\n return cb(this._message);\n }\n\n /\n {@inheritdoc IResult.withErrorFormat}\n /\n public withErrorFormat(cb: ErrorFormatter): Result<T> {\n return fail(cb(this._message));\n }\n\n /\n {@inheritdoc IResult.withFailureDetail}\n /\n public withFailureDetail<TD>(detail: TD): DetailedResult<T, TD> {\n return failWithDetail(this._message, detail);\n }\n\n /\n {@inheritdoc IResult.withDetail}\n /\n public withDetail<TD>(detail: TD, __successDetail?: TD): DetailedResult<T, TD> {\n return failWithDetail(this._message, detail);\n }\n\n /\n {@inheritdoc IResult.aggregateError}\n /\n public aggregateError(errors: IMessageAggregator): this {\n errors.addMessage(this._message);\n return this;\n }\n\n /\n Get a 'friendly' string representation of this object.\n * @remarks\n * The string representation of a {@link Failure} value is the error message.\n * @returns A string representing this object.\n /\n public toString(): string {\n return this._message;\n }\n\n /\n Creates a {@link Failure \| Failure<T>} with the supplied error message.\n * @param message - The error message to be returned.\n * @returns The resulting {@link Failure \| Failure<T>} with the supplied error message.\n /\n public static with<T>(message: string): Failure<T> {\n return new Failure<T>(message);\n }\n}\n\n/\n Returns {@link Success \| Success<T>} with the supplied result value.\n * @param value - The successful result value to be returned\n * @remarks\n * A `succeeds` alias was added in release 5.0 for\n * naming consistency with {@link fails \| fails}, which was added\n * to avoid conflicts with test frameworks and libraries.\n * @public\n /\nexport function succeed<T>(value: T): Success<T> {\n return new Success<T>(value);\n}\n\n/\n {@inheritdoc succeed}\n * @public\n /\nexport function succeeds<T>(value: T): Success<T> {\n return new Success<T>(value);\n}\n\n/\n Returns {@link Failure \| Failure<T>} with the supplied error message.\n * @param message - Error message to be returned.\n * @remarks\n * A `fails` alias was added in release 5.0 due to\n * issues with the name `fail` being used test frameworks and libraries.\n * @public\n /\nexport function fail<T>(message: string): Failure<T> {\n return new Failure<T>(message);\n}\n\n/\n {@inheritdoc fail}\n * @public\n /\nexport function fails<T>(message: string): Failure<T> {\n return new Failure<T>(message);\n}\n\n/\n Callback to be called when a {@link DetailedResult \| DetailedResult} encounters success.\n * @remarks\n * A success callback can return a different result type than it receives, allowing\n * success results to chain through intermediate result types.\n * @public\n /\nexport type DetailedSuccessContinuation<T, TD, TN> = (value: T, detail?: TD) => DetailedResult<TN, TD>;\n\n/\n Callback to be called when a {@link DetailedResult \| DetailedResult} encounters a failure.\n * @remarks\n * A failure callback can change {@link DetailedFailure \| DetailedFailure<T, TD>} to\n * {@link DetailedSuccess \| DetailedSuccess<T, TD>} (e.g. by returning a default value)\n * or it can change or embellish the error message, but it cannot change the success return type.\n * @public\n /\nexport type DetailedFailureContinuation<T, TD> = (message: string, detail?: TD) => DetailedResult<T, TD>;\n\n/\n A {@link DetailedSuccess \| DetailedSuccess} extends {@link Success \| Success} to report optional success\n * details in addition to the error message.\n * @public\n /\nexport class DetailedSuccess<T, TD> extends Success<T> {\n /\n @internal\n /\n protected _detail?: TD;\n\n /\n Constructs a new {@link DetailedSuccess \| DetailedSuccess<T, TD>} with the supplied\n * value and detail.\n * @param value - The value to be returned.\n * @param detail - An optional successful detail to be returned. If omitted, detail\n * will be `undefined`.\n /\n public constructor(value: T, detail?: TD) {\n super(value);\n this._detail = detail;\n }\n\n /\n The success detail associated with this {@link DetailedSuccess}, or `undefined` if\n * no detail was supplied.\n /\n public get detail(): TD \| undefined {\n return this._detail;\n }\n\n /\n Reports that this {@link DetailedSuccess} is a success.\n * @remarks\n * Always true for {@link DetailedSuccess} but can be used as type guard\n * to discriminate {@link DetailedSuccess} from {@link DetailedFailure} in\n * a {@link DetailedResult}.\n * @returns `true`\n /\n public isSuccess(): this is DetailedSuccess<T, TD> {\n return true;\n }\n\n /\n Invokes the supplied {@link DetailedSuccessContinuation \| success callback} and propagates\n * its returned {@link DetailedResult \| DetailedResult<TN, TD>}.\n * @remarks\n * The success callback mutates the return type from `<T>` to `<TN>`.\n * @param cb - The {@link DetailedSuccessContinuation \| success callback} to be invoked.\n * @returns The {@link DetailedResult \| DetailedResult<T, TD>} returned by the success callback.\n /\n public onSuccess<TN>(cb: DetailedSuccessContinuation<T, TD, TN>): DetailedResult<TN, TD> {\n return cb(this._value, this._detail);\n }\n\n /\n Propagates this {@link DetailedSuccess}.\n * @remarks\n * Failure does not mutate return type so we can return this event directly.\n * @param _cb - {@link DetailedFailureContinuation \| Failure callback} to be called\n * on a {@link DetailedResult} in case of failure (ignored).\n * @returns `this`\n /\n public onFailure(__cb: DetailedFailureContinuation<T, TD>): DetailedResult<T, TD> {\n return this;\n }\n\n /\n {@inheritdoc Success.withErrorFormat}\n /\n public withErrorFormat(cb: ErrorFormatter): DetailedResult<T, TD> {\n return this;\n }\n\n /\n Creates a {@link DetailedSuccess \| DetailedSuccess<T, TD>} with the supplied value and\n * optional detail.\n /\n public static with<T, TD>(value: T, detail?: TD): DetailedSuccess<T, TD> {\n return new DetailedSuccess<T, TD>(value, detail);\n }\n}\n\n/\n A {@link DetailedFailure \| DetailedFailure<T, TD>} extends {@link Failure \| Failure<T>} to report optional\n * failure details in addition to the error message.\n * @public\n /\nexport class DetailedFailure<T, TD> extends Failure<T> {\n /\n @internal\n /\n protected _detail?: TD;\n\n /\n Constructs a new {@link DetailedFailure \| DetailedFailure<T, TD>} with the supplied\n * message and detail.\n * @param message - The message to be returned.\n * @param detail - The error detail to be returned.\n /\n public constructor(message: string, detail?: TD) {\n super(message);\n this._detail = detail;\n }\n\n /\n The error detail associated with this {@link DetailedFailure}.\n /\n public get detail(): TD \| undefined {\n return this._detail;\n }\n\n /\n Reports that this {@link DetailedFailure} is a failure.\n * @remarks\n * Always true for {@link DetailedFailure} but can be used as type guard\n * to discriminate {@link DetailedSuccess} from {@link DetailedFailure} in\n * a {@link DetailedResult}.\n * @returns `true`\n /\n public isFailure(): this is DetailedFailure<T, TD> {\n return true;\n }\n\n /\n Propagates the error message and detail from this result.\n * @remarks\n * Mutates the success type as the success callback would have, but does not\n * call the success callback.\n * @param _cb - {@link DetailedSuccessContinuation \| Success callback} to be called\n * on a {@link DetailedResult} in case of success (ignored).\n * @returns A new {@link DetailedFailure \| DetailedFailure<TN, TD>} which contains\n * the error message and detail from this one.\n /\n public onSuccess<TN>(__cb: DetailedSuccessContinuation<T, TD, TN>): DetailedResult<TN, TD> {\n return new DetailedFailure<TN, TD>(this._message, this._detail);\n }\n\n /\n Invokes the supplied {@link DetailedFailureContinuation \| failure callback} and propagates\n * its returned {@link DetailedResult \| DetailedResult<T, TD>}.\n * @param cb - The {@link DetailedFailureContinuation \| failure callback} to be invoked.\n * @returns The {@link DetailedResult \| DetailedResult<T, TD>} returned by the failure callback.\n /\n public onFailure(cb: DetailedFailureContinuation<T, TD>): DetailedResult<T, TD> {\n return cb(this._message, this._detail);\n }\n\n /\n {@inheritdoc IResult.withErrorFormat}\n /\n public withErrorFormat(cb: ErrorFormatter<TD>): DetailedResult<T, TD> {\n return failWithDetail(cb(this._message, this._detail), this._detail);\n }\n\n /\n Creates a {@link DetailedFailure \| DetailedFailure<T, TD>} with the supplied error message\n * and optional detail.\n * @param message - The error message to be returned.\n * @param detail - The error detail to be returned.\n * @returns The resulting {@link DetailedFailure \| DetailedFailure<T, TD>} with the supplied\n * error message and detail.\n * @public\n /\n public static with<T, TD>(message: string, detail?: TD): DetailedFailure<T, TD> {\n return new DetailedFailure<T, TD>(message, detail);\n }\n}\n\n/\n Type inference to determine the result type `T` of a {@link DetailedResult \| DetailedResult<T, TD>}.\n * @beta\n /\nexport type DetailedResult<T, TD> = DetailedSuccess<T, TD> \| DetailedFailure<T, TD>;\n\n/\n Type inference to determine the detail type `TD` of a {@link DetailedResult \| DetailedResult<T, TD>}.\n * @beta\n /\nexport type ResultDetailType<T> = T extends DetailedResult<unknown, infer TD> ? TD : never;\n\n/\n Returns {@link DetailedSuccess \| DetailedSuccess<T, TD>} with a supplied value and optional\n * detail.\n * @param value - The value of type `<T>` to be returned.\n * @param detail - An optional detail of type `<TD>` to be returned.\n * @returns A {@link DetailedSuccess \| DetailedSuccess<T, TD>} with the supplied value\n * and detail, if supplied.\n * @remarks\n * The `succeedsWithDetail` alias was added in release 5.0 for\n * naming consistency with {@link fails \| fails}, which was added to avoid conflicts\n * with test frameworks and libraries.\n * @public\n /\nexport function succeedWithDetail<T, TD>(value: T, detail?: TD): DetailedSuccess<T, TD> {\n return new DetailedSuccess<T, TD>(value, detail);\n}\n\n/\n {@inheritdoc succeedWithDetail}\n * @public\n /\nexport function succeedsWithDetail<T, TD>(value: T, detail?: TD): DetailedSuccess<T, TD> {\n return new DetailedSuccess<T, TD>(value, detail);\n}\n\n/\n Returns {@link DetailedFailure \| DetailedFailure<T, TD>} with a supplied error message and detail.\n * @param message - The error message to be returned.\n * @param detail - The event detail to be returned.\n * @returns An {@link DetailedFailure \| DetailedFailure<T, TD>} with the supplied error\n * message and detail.\n * @remarks\n * The `failsWithDetail` alias was added in release 5.0 for naming consistency\n * with {@link fails \| fails}, which was added to avoid conflicts with test frameworks and libraries.\n * @public\n /\nexport function failWithDetail<T, TD>(message: string, detail?: TD): DetailedFailure<T, TD> {\n return new DetailedFailure<T, TD>(message, detail);\n}\n\n/\n {@inheritdoc failWithDetail}\n * @public\n /\nexport function failsWithDetail<T, TD>(message: string, detail?: TD): DetailedFailure<T, TD> {\n return new DetailedFailure<T, TD>(message, detail);\n}\n\n/\n Propagates a {@link Success} or {@link Failure} {@link Result}, adding supplied\n * event details as appropriate.\n * @param result - The {@link Result} to be propagated.\n * @param detail - The event detail (type `<TD>`) to be added to the {@link Result \| result}.\n * @param successDetail - An optional distinct event detail to be added to {@link Success} results. If `successDetail`\n * is omitted or `undefined`, then `detail` will be applied to {@link Success} results.\n * @returns A new {@link DetailedResult \| DetailedResult<T, TD>} with the success value or error\n * message from the original `result` but with the specified detail added.\n * @public\n /\nexport function propagateWithDetail<T, TD>(\n result: Result<T>,\n detail: TD,\n successDetail?: TD\n): DetailedResult<T, TD> {\n return result.isSuccess()\n ? succeedWithDetail(result.value, successDetail ?? detail)\n : failWithDetail(result.message, detail);\n}\n\n/\n Wraps a function which might throw to convert exception results\n * to {@link Failure}.\n * @param func - The function to be captured.\n * @returns Returns {@link Success} with a value of type `<T>` on\n * success , or {@link Failure} with the thrown error message if\n * `func` throws an `Error`.\n * @public\n */\nexport function captureResult<T>(func: () => T): Result<T> {\n try {\n return succeed(func());\n } catch (err) {\n return fail((err as Error).message);\n }\n}\n"]}

package/lib/packlets/conversion/objectConverter.d.ts CHANGED Viewed

@@ -64,6 +64,8 @@ export declare class ObjectConverter<T, TC = unknown> extends BaseConverter<T, T
      * a {@link Converter} for each field.
      * @param optional - An array of `keyof T` listing fields that are not required.
      * {@label WITH_KEYS}
+     * @deprecated Use {@link Conversion.Converter.optional | .optional()} on the individual
+     * fields, or pass {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>} to the constructor.
      */
     constructor(fields: FieldConverters<T, TC>, optional?: (keyof T)[]);
     /**
@@ -92,5 +94,6 @@ export declare class ObjectConverter<T, TC = unknown> extends BaseConverter<T, T
      * properties.
      */
     addPartial(addOptionalProperties: (keyof T)[]): ObjectConverter<Partial<T>, TC>;
+    private static _convert;
 }
 //# sourceMappingURL=objectConverter.d.ts.map

package/lib/packlets/conversion/objectConverter.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"objectConverter.d.ts","sourceRoot":"","sources":["../../../src/packlets/conversion/objectConverter.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;GAGG;AAEH,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,IAAI;KAC5C,GAAG,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;CAC1E,CAAC;AAEF;;;;;;;;;GASG;AACH,qBAAa,eAAe,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC;IACxE;;OAEG;IACH,SAAgB,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC/C;;OAEG;IACH,SAAgB,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAEnD;;;;;;;OAOG;gBACgB,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC;IAEtF~~;;;;;;;OAOG~~;gBACgB,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE;~~IAmDzE~~;;;;;;;OAOG;IACI,OAAO,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAEnF;;;;;;;OAOG;IACI,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAcvE;;;;;;OAMG;IACI,UAAU,CAAC,qBAAqB,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;~~CAKvF~~"}
1	+ {"version":3,"file":"objectConverter.d.ts","sourceRoot":"","sources":["../../../src/packlets/conversion/objectConverter.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;GAGG;AAEH,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,IAAI;KAC5C,GAAG,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;CAC1E,CAAC;AAEF;;;;;;;;;GASG;AACH,qBAAa,eAAe,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC;IACxE;;OAEG;IACH,SAAgB,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC/C;;OAEG;IACH,SAAgB,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAEnD;;;;;;;OAOG;gBACgB,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC;IAEtF;;;;;;;;;OASG;gBACgB,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE;IAczE;;;;;;;OAOG;IACI,OAAO,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAEnF;;;;;;;OAOG;IACI,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAcvE;;;;;;OAMG;IACI,UAAU,CAAC,qBAAqB,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAMtF,OAAO,CAAC,MAAM,CAAC,QAAQ;CAuCxB"}

package/lib/packlets/conversion/objectConverter.js CHANGED Viewed

@@ -41,49 +41,10 @@ class ObjectConverter extends baseConverter_1.BaseConverter {
      * @internal
      */
     constructor(fields, opt) {
-        super((from, __self, context) => {
-            var _a, _b;
-            // eslint bug thinks key is used before defined
-            // eslint-disable-next-line no-use-before-define
-            const converted = {};
-            const errors = [];
-            for (const key in fields) {
-                if (fields[key]) {
-                    const isOptional = (_b = (fields[key].isOptional || ((_a = this.options.optionalFields) === null || _a === void 0 ? void 0 : _a.includes(key)))) !== null && _b !== void 0 ? _b : false;
-                    const result = isOptional
-                        ? (0, converters_1.optionalField)(key, fields[key]).convert(from, context)
-                        : (0, converters_1.field)(key, fields[key]).convert(from, context);
-                    if (result.isSuccess() && result.value !== undefined) {
-                        converted[key] = result.value;
-                    }
-                    else if (result.isFailure()) {
-                        errors.push(result.message);
-                    }
-                }
-            }
-            if (this.options.strict === true) {
-                if (typeof from === 'object' && !Array.isArray(from)) {
-                    for (const key in from) {
-                        if (from.hasOwnProperty(key) && (!(0, base_1.isKeyOf)(key, fields) || fields[key] === undefined)) {
-                            errors.push(`${key}: unexpected property in source object`);
-                        }
-                    }
-                }
-                else {
-                    errors.push('source is not an object');
-                }
-            }
-            return errors.length === 0
-                ? (0, base_1.succeed)(converted)
-                : (0, base_1.fail)(this.options.description ? `${this.options.description}: ${errors.join('\n')}` : errors.join('\n'));
-        });
+        const options = Array.isArray(opt) ? { optionalFields: opt } : opt !== null && opt !== void 0 ? opt : { optionalFields: [] };
+        super((from, __self, context) => ObjectConverter._convert(from, context, fields, options));
         this.fields = fields;
-        if (Array.isArray(opt)) {
-            this.options = { optionalFields: opt };
-        }
-        else {
-            this.options = opt !== null && opt !== void 0 ? opt : {};
-        }
+        this.options = options;
     }
     /**
      * Concrete implementation of
@@ -103,7 +64,45 @@ class ObjectConverter extends baseConverter_1.BaseConverter {
      */
     addPartial(addOptionalProperties) {
         var _a;
-        return this.partial([...((_a = this.options.optionalFields) !== null && _a !== void 0 ? _a : []), ...addOptionalProperties])._with(this._traits());
+        /* c8 ignore next 1 - coverage having a bad day */
+        const myOptional = (_a = this.options.optionalFields) !== null && _a !== void 0 ? _a : [];
+        return this.partial([...myOptional, ...addOptionalProperties])._with(this._traits());
+    }
+    static _convert(from, context, fields, options) {
+        var _a, _b;
+        // eslint bug thinks key is used before defined
+        // eslint-disable-next-line no-use-before-define
+        const converted = {};
+        const errors = [];
+        for (const key in fields) {
+            if (fields[key]) {
+                const isOptional = (_b = (fields[key].isOptional || ((_a = options.optionalFields) === null || _a === void 0 ? void 0 : _a.includes(key)))) !== null && _b !== void 0 ? _b : false;
+                const result = isOptional
+                    ? (0, converters_1.optionalField)(key, fields[key]).convert(from, context)
+                    : (0, converters_1.field)(key, fields[key]).convert(from, context);
+                if (result.isSuccess() && result.value !== undefined) {
+                    converted[key] = result.value;
+                }
+                else if (result.isFailure()) {
+                    errors.push(result.message);
+                }
+            }
+        }
+        if (options.strict === true) {
+            if (typeof from === 'object' && !Array.isArray(from)) {
+                for (const key in from) {
+                    if (from.hasOwnProperty(key) && (!(0, base_1.isKeyOf)(key, fields) || fields[key] === undefined)) {
+                        errors.push(`${key}: unexpected property in source object`);
+                    }
+                }
+            }
+            else {
+                errors.push('source is not an object');
+            }
+        }
+        return errors.length === 0
+            ? (0, base_1.succeed)(converted)
+            : (0, base_1.fail)(options.description ? `${options.description}: ${errors.join('\n')}` : errors.join('\n'));
     }
 }
 exports.ObjectConverter = ObjectConverter;

package/lib/packlets/conversion/objectConverter.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"objectConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/objectConverter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAiD;AAEjD,mDAAgD;AAEhD,6CAAoD;AAiCpD;;;;;;;;;GASG;AACH,MAAa,eAAiC,SAAQ,6BAAoB;IA6BxE;;;OAGG;IACH,YAAmB,MAA8B,EAAE,GAA6C;QAC9F,KAAK,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE;;YAC5C,+CAA+C;YAC/C,gDAAgD;YAChD,MAAM,SAAS,GAAG,EAAkC,CAAC;YACrD,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;gBACzB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;oBAChB,MAAM,UAAU,GAAG,MAAA,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,KAAI,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,0CAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAC,mCAAI,KAAK,CAAC;oBACnG,MAAM,MAAM,GAAG,UAAU;wBACvB,CAAC,CAAC,IAAA,0BAAa,EAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;wBACxD,CAAC,CAAC,IAAA,kBAAK,EAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;oBACnD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;wBACrD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;oBAChC,CAAC;yBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;wBAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBAC9B,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;gBACjC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACrD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;wBACvB,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAA,cAAO,EAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,EAAE,CAAC;4BACrF,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,wCAAwC,CAAC,CAAC;wBAC9D,CAAC;oBACH,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC;gBACxB,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC;gBACpB,CAAC,CAAC,IAAA,WAAI,EACF,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CACnG,CAAC;QACR,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,OAAO,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAqBD;;;;;OAKG;IACI,OAAO,CAAC,GAA6C;QAC1D,OAAO,IAAI,eAAe,CACxB,IAAI,CAAC,MAAyC,EAC9C,GAAyC,CAC1C,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,qBAAkC;;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,mCAAI,EAAE,CAAC,EAAE,GAAG,qBAAqB,CAAC,CAAC,CAAC,KAAK,CAC3F,IAAI,CAAC,OAAO,EAAE,CACf,CAAC;IACJ,CAAC;CACF;AA3HD,0CA2HC","sourcesContent":["/\n Copyright (c) 2023 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\nimport { fail, isKeyOf, succeed } from '../base';\nimport { Validator } from '../validation';\nimport { BaseConverter } from './baseConverter';\nimport { Converter } from './converter';\nimport { field, optionalField } from './converters';\n\n/\n Options for an {@link Conversion.ObjectConverter \| ObjectConverter}.\n * @public\n /\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectConverterOptions<T> {\n /\n If present, lists optional fields. Missing non-optional fields cause an error.\n /\n optionalFields?: (keyof T)[];\n /\n If true, unrecognized fields yield an error. If false or undefined (default),\n * unrecognized fields are ignored.\n /\n strict?: boolean;\n /\n Optional description to be included in error messages.\n /\n description?: string;\n}\n\n/\n Per-property converters or validators for each of the properties in type T.\n * @remarks\n * Used to construct a {@link Conversion.ObjectConverter \| ObjectConverter}\n * @public\n /\nexport type FieldConverters<T, TC = unknown> = {\n [key in keyof T]: Converter<T[key], TC \| unknown> \| Validator<T[key], TC>;\n};\n\n/\n A {@link Converter} which converts an object of type `<T>` without changing shape, given\n * a {@link Conversion.FieldConverters \| FieldConverters<T>} for the fields in the object.\n * @remarks\n * By default, if all of the required fields exist and can be converted, returns a new object with\n * the converted values under the original key names. If any required fields do not exist or cannot\n * be converted, the entire conversion fails. See {@link Conversion.ObjectConverterOptions \| ObjectConverterOptions}\n * for other conversion options.\n * @public\n /\nexport class ObjectConverter<T, TC = unknown> extends BaseConverter<T, TC> {\n /\n Fields converted by this {@link Conversion.ObjectConverter \| ObjectConverter}.\n /\n public readonly fields: FieldConverters<T, TC>;\n /\n Options used to initialize this {@link Conversion.ObjectConverter \| ObjectConverter}.\n /\n public readonly options: ObjectConverterOptions<T>;\n\n /\n Constructs a new {@link Conversion.ObjectConverter \| ObjectConverter<T, TC>} using options\n * supplied in a {@link Conversion.ObjectConverterOptions \| ObjectConverterOptions<T>}.\n * @param fields - A {@link Conversion.FieldConverters \| FieldConverters<T>} containing\n * a {@link Converter} for each field\n * @param options - An optional @see ObjectConverterOptions to configure the conversion\n * {@label WITH_OPTIONS}\n /\n public constructor(fields: FieldConverters<T, TC>, options?: ObjectConverterOptions<T>);\n\n /\n Constructs a new {@link Conversion.ObjectConverter \| ObjectConverter<T, TC>} with optional\n * properties specified as an array of `keyof T`.\n * @param fields - A {@link Conversion.FieldConverters \| FieldConverters<T>} containing\n * a {@link Converter} for each field.\n * @param optional - An array of `keyof T` listing fields that are not required.\n * {@label WITH_KEYS}\n /\n public constructor(fields: FieldConverters<T, TC>, optional?: (keyof T)[]);\n /\n Concrete implementation of {@link Converters.(ObjectConverter:constructor)}\n * @internal\n /\n public constructor(fields: FieldConverters<T, TC>, opt?: ObjectConverterOptions<T> \| (keyof T)[]) {\n super((from: unknown, __self, context?: TC) => {\n // eslint bug thinks key is used before defined\n // eslint-disable-next-line no-use-before-define\n const converted = {} as { [key in keyof T]: T[key] };\n const errors: string[] = [];\n for (const key in fields) {\n if (fields[key]) {\n const isOptional = (fields[key].isOptional \|\| this.options.optionalFields?.includes(key)) ?? false;\n const result = isOptional\n ? optionalField(key, fields[key]).convert(from, context)\n : field(key, fields[key]).convert(from, context);\n if (result.isSuccess() && result.value !== undefined) {\n converted[key] = result.value;\n } else if (result.isFailure()) {\n errors.push(result.message);\n }\n }\n }\n\n if (this.options.strict === true) {\n if (typeof from === 'object' && !Array.isArray(from)) {\n for (const key in from) {\n if (from.hasOwnProperty(key) && (!isKeyOf(key, fields) \|\| fields[key] === undefined)) {\n errors.push(`${key}: unexpected property in source object`);\n }\n }\n } else {\n errors.push('source is not an object');\n }\n }\n return errors.length === 0\n ? succeed(converted)\n : fail(\n this.options.description ? `${this.options.description}: ${errors.join('\\n')}` : errors.join('\\n')\n );\n });\n\n this.fields = fields;\n if (Array.isArray(opt)) {\n this.options = { optionalFields: opt };\n } else {\n this.options = opt ?? {};\n }\n }\n\n /\n Creates a new {@link Conversion.ObjectConverter \| ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied {@link Conversion.ObjectConverterOptions \| ObjectConverterOptions<T>}.\n * @param options - The {@link Conversion.ObjectConverterOptions \| options} to be applied to the new\n * converter.\n * @returns A new {@link Conversion.ObjectConverter \| ObjectConverter} with the additional optional source properties.\n * {@label WITH_OPTIONS}\n /\n public partial(options: ObjectConverterOptions<T>): ObjectConverter<Partial<T>, TC>;\n\n /\n Creates a new {@link Conversion.ObjectConverter \| ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied array of `keyof T`.\n * @param optional - The keys of the source object properties to be made optional.\n * @returns A new {@link Conversion.ObjectConverter \| ObjectConverter} with the additional optional source\n * properties.\n * {@label WITH_KEYS}\n /\n public partial(optional?: (keyof T)[]): ObjectConverter<Partial<T>, TC>;\n /\n Concrete implementation of\n * {@link Conversion.ObjectConverter.(partial:1) \| ObjectConverter.partial(ObjectConverterOptions)} and\n * {@link Conversion.ObjectConverter.(partial:2) \| ObjectConverter.partial((keyof T))[]}.\n * @internal\n /\n public partial(opt?: ObjectConverterOptions<T> \| (keyof T)[]): ObjectConverter<Partial<T>, TC> {\n return new ObjectConverter<Partial<T>, TC>(\n this.fields as FieldConverters<Partial<T>, TC>,\n opt as ObjectConverterOptions<Partial<T>>\n )._with(this._traits());\n }\n\n /\n Creates a new {@link Conversion.ObjectConverter \| ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied array of `keyof T`.\n * @param addOptionalProperties - The keys to be made optional.\n * @returns A new {@link Conversion.ObjectConverter \| ObjectConverter} with the additional optional source\n * properties.\n */\n public addPartial(addOptionalProperties: (keyof T)[]): ObjectConverter<Partial<T>, TC> {\n return this.partial([...(this.options.optionalFields ?? []), ...addOptionalProperties])._with(\n this._traits()\n );\n }\n}\n"]}
1	+ {"version":3,"file":"objectConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/objectConverter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAyD;AAEzD,mDAAgD;AAEhD,6CAAoD;AAiCpD;;;;;;;;;GASG;AACH,MAAa,eAAiC,SAAQ,6BAAoB;IA+BxE;;;OAGG;IACH,YAAmB,MAA8B,EAAE,GAA6C;QAC9F,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;QAE7F,KAAK,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAEzG,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAqBD;;;;;OAKG;IACI,OAAO,CAAC,GAA6C;QAC1D,OAAO,IAAI,eAAe,CACxB,IAAI,CAAC,MAAyC,EAC9C,GAAyC,CAC1C,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,qBAAkC;;QAClD,kDAAkD;QAClD,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,mCAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,UAAU,EAAE,GAAG,qBAAqB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAEO,MAAM,CAAC,QAAQ,CACrB,IAAa,EACb,OAAuB,EACvB,MAA8B,EAC9B,OAAkC;;QAElC,+CAA+C;QAC/C,gDAAgD;QAChD,MAAM,SAAS,GAAG,EAAkC,CAAC;QACrD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChB,MAAM,UAAU,GAAG,MAAA,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,KAAI,MAAA,OAAO,CAAC,cAAc,0CAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAC,mCAAI,KAAK,CAAC;gBAC9F,MAAM,MAAM,GAAG,UAAU;oBACvB,CAAC,CAAC,IAAA,0BAAa,EAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;oBACxD,CAAC,CAAC,IAAA,kBAAK,EAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBACnD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBACrD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;gBAChC,CAAC;qBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;oBAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACvB,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAA,cAAO,EAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,EAAE,CAAC;wBACrF,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,wCAAwC,CAAC,CAAC;oBAC9D,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC;YACxB,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC;YACpB,CAAC,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrG,CAAC;CACF;AAhID,0CAgIC","sourcesContent":["/\n Copyright (c) 2023 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\nimport { fail, isKeyOf, Result, succeed } from '../base';\nimport { Validator } from '../validation';\nimport { BaseConverter } from './baseConverter';\nimport { Converter } from './converter';\nimport { field, optionalField } from './converters';\n\n/\n Options for an {@link Conversion.ObjectConverter \| ObjectConverter}.\n * @public\n /\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectConverterOptions<T> {\n /\n If present, lists optional fields. Missing non-optional fields cause an error.\n /\n optionalFields?: (keyof T)[];\n /\n If true, unrecognized fields yield an error. If false or undefined (default),\n * unrecognized fields are ignored.\n /\n strict?: boolean;\n /\n Optional description to be included in error messages.\n /\n description?: string;\n}\n\n/\n Per-property converters or validators for each of the properties in type T.\n * @remarks\n * Used to construct a {@link Conversion.ObjectConverter \| ObjectConverter}\n * @public\n /\nexport type FieldConverters<T, TC = unknown> = {\n [key in keyof T]: Converter<T[key], TC \| unknown> \| Validator<T[key], TC>;\n};\n\n/\n A {@link Converter} which converts an object of type `<T>` without changing shape, given\n * a {@link Conversion.FieldConverters \| FieldConverters<T>} for the fields in the object.\n * @remarks\n * By default, if all of the required fields exist and can be converted, returns a new object with\n * the converted values under the original key names. If any required fields do not exist or cannot\n * be converted, the entire conversion fails. See {@link Conversion.ObjectConverterOptions \| ObjectConverterOptions}\n * for other conversion options.\n * @public\n /\nexport class ObjectConverter<T, TC = unknown> extends BaseConverter<T, TC> {\n /\n Fields converted by this {@link Conversion.ObjectConverter \| ObjectConverter}.\n /\n public readonly fields: FieldConverters<T, TC>;\n /\n Options used to initialize this {@link Conversion.ObjectConverter \| ObjectConverter}.\n /\n public readonly options: ObjectConverterOptions<T>;\n\n /\n Constructs a new {@link Conversion.ObjectConverter \| ObjectConverter<T, TC>} using options\n * supplied in a {@link Conversion.ObjectConverterOptions \| ObjectConverterOptions<T>}.\n * @param fields - A {@link Conversion.FieldConverters \| FieldConverters<T>} containing\n * a {@link Converter} for each field\n * @param options - An optional @see ObjectConverterOptions to configure the conversion\n * {@label WITH_OPTIONS}\n /\n public constructor(fields: FieldConverters<T, TC>, options?: ObjectConverterOptions<T>);\n\n /\n Constructs a new {@link Conversion.ObjectConverter \| ObjectConverter<T, TC>} with optional\n * properties specified as an array of `keyof T`.\n * @param fields - A {@link Conversion.FieldConverters \| FieldConverters<T>} containing\n * a {@link Converter} for each field.\n * @param optional - An array of `keyof T` listing fields that are not required.\n * {@label WITH_KEYS}\n * @deprecated Use {@link Conversion.Converter.optional \| .optional()} on the individual\n * fields, or pass {@link Conversion.ObjectConverterOptions \| ObjectConverterOptions<T>} to the constructor.\n /\n public constructor(fields: FieldConverters<T, TC>, optional?: (keyof T)[]);\n /\n Concrete implementation of {@link Converters.(ObjectConverter:constructor)}\n * @internal\n /\n public constructor(fields: FieldConverters<T, TC>, opt?: ObjectConverterOptions<T> \| (keyof T)[]) {\n const options = Array.isArray(opt) ? { optionalFields: opt } : opt ?? { optionalFields: [] };\n\n super((from: unknown, __self, context?: TC) => ObjectConverter._convert(from, context, fields, options));\n\n this.fields = fields;\n this.options = options;\n }\n\n /\n Creates a new {@link Conversion.ObjectConverter \| ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied {@link Conversion.ObjectConverterOptions \| ObjectConverterOptions<T>}.\n * @param options - The {@link Conversion.ObjectConverterOptions \| options} to be applied to the new\n * converter.\n * @returns A new {@link Conversion.ObjectConverter \| ObjectConverter} with the additional optional source properties.\n * {@label WITH_OPTIONS}\n /\n public partial(options: ObjectConverterOptions<T>): ObjectConverter<Partial<T>, TC>;\n\n /\n Creates a new {@link Conversion.ObjectConverter \| ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied array of `keyof T`.\n * @param optional - The keys of the source object properties to be made optional.\n * @returns A new {@link Conversion.ObjectConverter \| ObjectConverter} with the additional optional source\n * properties.\n * {@label WITH_KEYS}\n /\n public partial(optional?: (keyof T)[]): ObjectConverter<Partial<T>, TC>;\n /\n Concrete implementation of\n * {@link Conversion.ObjectConverter.(partial:1) \| ObjectConverter.partial(ObjectConverterOptions)} and\n * {@link Conversion.ObjectConverter.(partial:2) \| ObjectConverter.partial((keyof T))[]}.\n * @internal\n /\n public partial(opt?: ObjectConverterOptions<T> \| (keyof T)[]): ObjectConverter<Partial<T>, TC> {\n return new ObjectConverter<Partial<T>, TC>(\n this.fields as FieldConverters<Partial<T>, TC>,\n opt as ObjectConverterOptions<Partial<T>>\n )._with(this._traits());\n }\n\n /\n Creates a new {@link Conversion.ObjectConverter \| ObjectConverter} derived from this one but with\n * new optional properties as specified by a supplied array of `keyof T`.\n * @param addOptionalProperties - The keys to be made optional.\n * @returns A new {@link Conversion.ObjectConverter \| ObjectConverter} with the additional optional source\n * properties.\n /\n public addPartial(addOptionalProperties: (keyof T)[]): ObjectConverter<Partial<T>, TC> {\n / c8 ignore next 1 - coverage having a bad day */\n const myOptional = this.options.optionalFields ?? [];\n return this.partial([...myOptional, ...addOptionalProperties])._with(this._traits());\n }\n\n private static _convert<T, TC>(\n from: unknown,\n context: TC \| undefined,\n fields: FieldConverters<T, TC>,\n options: ObjectConverterOptions<T>\n ): Result<T> {\n // eslint bug thinks key is used before defined\n // eslint-disable-next-line no-use-before-define\n const converted = {} as { [key in keyof T]: T[key] };\n const errors: string[] = [];\n for (const key in fields) {\n if (fields[key]) {\n const isOptional = (fields[key].isOptional \|\| options.optionalFields?.includes(key)) ?? false;\n const result = isOptional\n ? optionalField(key, fields[key]).convert(from, context)\n : field(key, fields[key]).convert(from, context);\n if (result.isSuccess() && result.value !== undefined) {\n converted[key] = result.value;\n } else if (result.isFailure()) {\n errors.push(result.message);\n }\n }\n }\n\n if (options.strict === true) {\n if (typeof from === 'object' && !Array.isArray(from)) {\n for (const key in from) {\n if (from.hasOwnProperty(key) && (!isKeyOf(key, fields) \|\| fields[key] === undefined)) {\n errors.push(`${key}: unexpected property in source object`);\n }\n }\n } else {\n errors.push('source is not an object');\n }\n }\n return errors.length === 0\n ? succeed(converted)\n : fail(options.description ? `${options.description}: ${errors.join('\\n')}` : errors.join('\\n'));\n }\n}\n"]}

package/package.json CHANGED Viewed

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