@fgv/ts-utils 3.0.1-alpha.2 → 3.0.1-alpha.4

package/dist/ts-utils.d.ts

@@ -1,12 +1,15 @@
 /**
  * Determines if an iterable collection of {@link Result | Result<T>} were all successful.
  * @param results - The collection of {@link Result | Result<T>} to be tested.
- * @returns Returns {@link Success} with `true` if all {@link Result | results} are successful.
- * If any are unsuccessful, returns {@link Failure} with a concatenated summary the error
+ * @param successValue - The value to be returned if results are successful.
+ * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @returns Returns {@link Success} with `successValue` if all {@link Result | results} are successful.
+ * If any are unsuccessful, returns {@link Failure} with a concatenated summary of the error
  * messages from all failed elements.
  * @public
  */
-export declare function allSucceed<T>(results: Iterable<Result<unknown>>, successValue: T): Result<T>;
+export declare function allSucceed<T>(results: Iterable<Result<unknown>>, successValue: T, aggregatedErrors?: string[]): Result<T>;
 
 /**
  * A helper function to create a {@link Converter | Converter} which converts `unknown` to an array of `<T>`.
@@ -1436,24 +1439,28 @@ declare type LogLevel = 'detail' | 'info' | 'warning' | 'error' | 'silent';
  * optionally ignoring certain error details.
  * @param results - The collection of {@link DetailedResult | DetailedResult<T, TD>} to be mapped.
  * @param ignore - An array of error detail values (of type `<TD>`) that should be ignored.
+ * @param aggregatedErrors  - Optional string array to which any non-ignorable error messages will be
+ * appended.  Each error is appended as an individual string.
  * @returns {@link Success} with an array containing all successful results if all results either
      * succeeded or returned error details listed in `ignore`.  If any results failed with details
      * that cannot be ignored, returns {@link Failure} with an concatenated summary of all non-ignorable
      * error messages.
      * @public
      */
- export declare function mapDetailedResults<T, TD>(results: Iterable<DetailedResult<T, TD>>, ignore: TD[]): Result<T[]>;
+ export declare function mapDetailedResults<T, TD>(results: Iterable<DetailedResult<T, TD>>, ignore: TD[], aggregatedErrors?: string[]): Result<T[]>;
 
  /**
   * Aggregates error messages from a collection of {@link Result | Result<T>}.
   * @param results - An iterable collection of {@link Result | Result<T>} for which
   * error messages are aggregated.
+  * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+  * appended.  Each error is appended as an individual string.
   * @returns An array of strings consisting of all error messages returned by
   * {@link Result | results} in the source collection. Ignores {@link Success}
   * results and returns an empty array if there were no errors.
   * @public
   */
- export declare function mapFailures<T>(results: Iterable<Result<T>>): string[];
+ export declare function mapFailures<T>(results: Iterable<Result<T>>, aggregatedErrors?: string[]): string[];
 
  /**
   * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties
@@ -1519,23 +1526,27 @@ declare type LogLevel = 'detail' | 'info' | 'warning' | 'error' | 'silent';
  /**
   * Aggregates successful result values from a collection of {@link Result | Result<T>}.
   * @param results - The collection of {@link Result | Result<T>} to be mapped.
+  * @param aggregatedErrors  - Optional string array to which any error messages will be
+  * appended.  Each error is appended as an individual string.
   * @returns  If all {@link Result | results} are successful, returns {@link Success} with an
   * array containing all returned values.  If any {@link Result | results} failed, returns
   * {@link Failure} with a concatenated summary of all error messages.
   * @public
   */
- export declare function mapResults<T>(results: Iterable<Result<T>>): Result<T[]>;
+ export declare function mapResults<T>(results: Iterable<Result<T>>, aggregatedErrors?: string[]): Result<T[]>;
 
  /**
   * Aggregates successful results from a a collection of {@link Result | Result<T>}.
   * @param results - An `Iterable` of {@link Result | Result<T>} from which success
   * results are to be aggregated.
+  * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+  * appended.  Each error is appended as an individual string.
   * @returns {@link Success} with an array of `<T>` if any results were successful. If
       * all {@link Result | results} failed, returns {@link Failure} with a concatenated
       * summary of all error messages.
       * @public
       */
-  export declare function mapSuccess<T>(results: Iterable<Result<T>>): Result<T[]>;
+  export declare function mapSuccess<T>(results: Iterable<Result<T>>, aggregatedErrors?: string[]): Result<T[]>;
 
   /**
    * Applies a factory method to convert a `ReadonlyMap<TK, TS>` into a `Record<TK, TD>`.
@@ -2087,10 +2098,12 @@ declare type LogLevel = 'detail' | 'info' | 'warning' | 'error' | 'silent';
         * each property.
         * @param options - An optional {@link PopulateObjectOptions | set of options} which
         * modify the behavior of this call.
+        * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+        * appended.  Each error is appended as an individual string.
         * {@label WITH_OPTIONS}
         * @public
         */
-       export declare function populateObject<T>(initializers: FieldInitializers<T>, options?: PopulateObjectOptions<T>): Result<T>;
+       export declare function populateObject<T>(initializers: FieldInitializers<T>, options?: PopulateObjectOptions<T>, aggregatedErrors?: string[]): Result<T>;
 
        /**
         * Populates an an object based on a prototype full of field initializers that return {@link Result | Result<T[key]>}.
@@ -2099,11 +2112,13 @@ declare type LogLevel = 'detail' | 'info' | 'warning' | 'error' | 'silent';
         * @param initializers - An object with the shape of the target but with initializer functions for
         * each property.
         * @param order - Optional order in which keys should be written.
+        * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+        * appended.  Each error is appended as an individual string.
         * @public
         * {@label WITH_ORDER}
         * @deprecated Pass {@link PopulateObjectOptions} instead.
         */
-       export declare function populateObject<T>(initializers: FieldInitializers<T>, order: (keyof T)[]): Result<T>;
+       export declare function populateObject<T>(initializers: FieldInitializers<T>, order: (keyof T)[] | undefined, aggregatedErrors?: string[]): Result<T>;
 
        /**
         * Options for the {@link (populateObject:1)} function.

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

@@ -1,5 +1,6 @@
 import * as Logging from './logger';
 export * from './brand';
+export * from './mapResults';
 export { Normalizer } from './normalize';
 export * from './result';
 export * from './utils';

package/lib/packlets/base/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,OAAO,MAAM,UAAU,CAAC;AAEpC,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,OAAO,MAAM,UAAU,CAAC;AAEpC,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/lib/packlets/base/index.js

@@ -51,6 +51,7 @@ exports.Logging = exports.Normalizer = void 0;
 const Logging = __importStar(require("./logger"));
 exports.Logging = Logging;
 __exportStar(require("./brand"), exports);
+__exportStar(require("./mapResults"), exports);
 var normalize_1 = require("./normalize");
 Object.defineProperty(exports, "Normalizer", { enumerable: true, get: function () { return normalize_1.Normalizer; } });
 __exportStar(require("./result"), exports);

package/lib/packlets/base/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/base/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kDAAoC;AAM3B,0BAAO;AAJhB,0CAAwB;AACxB,yCAAyC;AAAhC,uGAAA,UAAU,OAAA;AACnB,2CAAyB;AACzB,0CAAwB","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 * as Logging from './logger';\n\nexport * from './brand';\nexport { Normalizer } from './normalize';\nexport * from './result';\nexport * from './utils';\nexport { Logging };\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/base/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kDAAoC;AAO3B,0BAAO;AALhB,0CAAwB;AACxB,+CAA6B;AAC7B,yCAAyC;AAAhC,uGAAA,UAAU,OAAA;AACnB,2CAAyB;AACzB,0CAAwB","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 * as Logging from './logger';\n\nexport * from './brand';\nexport * from './mapResults';\nexport { Normalizer } from './normalize';\nexport * from './result';\nexport * from './utils';\nexport { Logging };\n"]}

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

@@ -0,0 +1,120 @@
+import { DetailedResult, Result } from './result';
+/**
+ * Aggregates successful result values from a collection of {@link Result | Result<T>}.
+ * @param results - The collection of {@link Result | Result<T>} to be mapped.
+ * @param aggregatedErrors  - Optional string array to which any error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @returns  If all {@link Result | results} are successful, returns {@link Success} with an
+ * array containing all returned values.  If any {@link Result | results} failed, returns
+ * {@link Failure} with a concatenated summary of all error messages.
+ * @public
+ */
+export declare function mapResults<T>(results: Iterable<Result<T>>, aggregatedErrors?: string[]): Result<T[]>;
+/**
+ * Aggregates successful results from a collection of {@link DetailedResult | DetailedResult<T, TD>},
+ * optionally ignoring certain error details.
+ * @param results - The collection of {@link DetailedResult | DetailedResult<T, TD>} to be mapped.
+ * @param ignore - An array of error detail values (of type `<TD>`) that should be ignored.
+ * @param aggregatedErrors  - Optional string array to which any non-ignorable error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @returns {@link Success} with an array containing all successful results if all results either
+ * succeeded or returned error details listed in `ignore`.  If any results failed with details
+ * that cannot be ignored, returns {@link Failure} with an concatenated summary of all non-ignorable
+ * error messages.
+ * @public
+ */
+export declare function mapDetailedResults<T, TD>(results: Iterable<DetailedResult<T, TD>>, ignore: TD[], aggregatedErrors?: string[]): Result<T[]>;
+/**
+ * Aggregates successful results from a a collection of {@link Result | Result<T>}.
+ * @param results - An `Iterable` of {@link Result | Result<T>} from which success
+ * results are to be aggregated.
+ * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @returns {@link Success} with an array of `<T>` if any results were successful. If
+ * all {@link Result | results} failed, returns {@link Failure} with a concatenated
+ * summary of all error messages.
+ * @public
+ */
+export declare function mapSuccess<T>(results: Iterable<Result<T>>, aggregatedErrors?: string[]): Result<T[]>;
+/**
+ * Aggregates error messages from a collection of {@link Result | Result<T>}.
+ * @param results - An iterable collection of {@link Result | Result<T>} for which
+ * error messages are aggregated.
+ * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @returns An array of strings consisting of all error messages returned by
+ * {@link Result | results} in the source collection. Ignores {@link Success}
+ * results and returns an empty array if there were no errors.
+ * @public
+ */
+export declare function mapFailures<T>(results: Iterable<Result<T>>, aggregatedErrors?: string[]): string[];
+/**
+ * Determines if an iterable collection of {@link Result | Result<T>} were all successful.
+ * @param results - The collection of {@link Result | Result<T>} to be tested.
+ * @param successValue - The value to be returned if results are successful.
+ * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @returns Returns {@link Success} with `successValue` if all {@link Result | results} are successful.
+ * If any are unsuccessful, returns {@link Failure} with a concatenated summary of the error
+ * messages from all failed elements.
+ * @public
+ */
+export declare function allSucceed<T>(results: Iterable<Result<unknown>>, successValue: T, aggregatedErrors?: string[]): Result<T>;
+/**
+ * String-keyed record of initialization functions to be passed to {@link (populateObject:1)}
+ * or {@link (populateObject:2)}.
+ * @public
+ */
+export type FieldInitializers<T> = {
+    [key in keyof T]: (state: Partial<T>) => Result<T[key]>;
+};
+/**
+ * Options for the {@link (populateObject:1)} function.
+ * @public
+ */
+export interface PopulateObjectOptions<T> {
+    /**
+     * If present, specifies the order in which property values should
+     * be evaluated.  Any keys not listed are evaluated after all listed
+     * keys in indeterminate order.  If 'order' is not present, keys
+     * are evaluated in indeterminate order.
+     */
+    order?: (keyof T)[];
+    /**
+     * Specify handling of `undefined` values.  By default, successful
+     * `undefined` results are written to the result object.  If this value
+     * is `true` then `undefined` results are suppressed for all properties.
+     * If this value is an array of property keys then `undefined` results
+     * are suppressed for those properties only.
+     */
+    suppressUndefined?: boolean | (keyof T)[];
+}
+/**
+ * Populates an an object based on a prototype full of field initializers that return {@link Result | Result<T[key]>}.
+ * Returns {@link Success} with the populated object if all initializers succeed, or {@link Failure} with a
+ * concatenated list of all error messages.
+ * @param initializers - An object with the shape of the target but with initializer functions for
+ * each property.
+ * @param options - An optional {@link PopulateObjectOptions | set of options} which
+ * modify the behavior of this call.
+ * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+ * appended.  Each error is appended as an individual string.
+ * {@label WITH_OPTIONS}
+ * @public
+ */
+export declare function populateObject<T>(initializers: FieldInitializers<T>, options?: PopulateObjectOptions<T>, aggregatedErrors?: string[]): Result<T>;
+/**
+ * Populates an an object based on a prototype full of field initializers that return {@link Result | Result<T[key]>}.
+ * Returns {@link Success} with the populated object if all initializers succeed, or {@link Failure} with a
+ * concatenated list of all error messages.
+ * @param initializers - An object with the shape of the target but with initializer functions for
+ * each property.
+ * @param order - Optional order in which keys should be written.
+ * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @public
+ * {@label WITH_ORDER}
+ * @deprecated Pass {@link PopulateObjectOptions} instead.
+ */
+export declare function populateObject<T>(initializers: FieldInitializers<T>, order: (keyof T)[] | undefined, aggregatedErrors?: string[]): Result<T>;
+//# sourceMappingURL=mapResults.d.ts.map

package/lib/packlets/base/mapResults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapResults.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/mapResults.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAiB,MAAM,UAAU,CAAC;AAEjE;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAiBpG;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,EAAE,EACtC,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EACxC,MAAM,EAAE,EAAE,EAAE,EACZ,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAC1B,MAAM,CAAC,CAAC,EAAE,CAAC,CAiBb;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAiBpG;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CASlG;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAC1B,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAClC,YAAY,EAAE,CAAC,EACf,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAC1B,MAAM,CAAC,CAAC,CAAC,CAgBX;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;KAAG,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CAAE,CAAC;AAE/F;;;GAGG;AAEH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAEpB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;CAC3C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,YAAY,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAClC,OAAO,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,EAClC,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAC1B,MAAM,CAAC,CAAC,CAAC,CAAC;AAEb;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,YAAY,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAClC,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,SAAS,EAC9B,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAC1B,MAAM,CAAC,CAAC,CAAC,CAAC"}

package/lib/packlets/base/mapResults.js

@@ -0,0 +1,208 @@
+"use strict";
+/*
+ * Copyright (c) 2020 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.populateObject = exports.allSucceed = exports.mapFailures = exports.mapSuccess = exports.mapDetailedResults = exports.mapResults = void 0;
+const result_1 = require("./result");
+/**
+ * Aggregates successful result values from a collection of {@link Result | Result<T>}.
+ * @param results - The collection of {@link Result | Result<T>} to be mapped.
+ * @param aggregatedErrors  - Optional string array to which any error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @returns  If all {@link Result | results} are successful, returns {@link Success} with an
+ * array containing all returned values.  If any {@link Result | results} failed, returns
+ * {@link Failure} with a concatenated summary of all error messages.
+ * @public
+ */
+function mapResults(results, aggregatedErrors) {
+    const errors = [];
+    const elements = [];
+    for (const result of results) {
+        if (result.isSuccess()) {
+            elements.push(result.value);
+        }
+        else {
+            errors.push(result.message);
+        }
+    }
+    if (errors.length > 0) {
+        aggregatedErrors === null || aggregatedErrors === void 0 ? void 0 : aggregatedErrors.push(...errors);
+        return (0, result_1.fail)(errors.join('\n'));
+    }
+    return (0, result_1.succeed)(elements);
+}
+exports.mapResults = mapResults;
+/**
+ * Aggregates successful results from a collection of {@link DetailedResult | DetailedResult<T, TD>},
+ * optionally ignoring certain error details.
+ * @param results - The collection of {@link DetailedResult | DetailedResult<T, TD>} to be mapped.
+ * @param ignore - An array of error detail values (of type `<TD>`) that should be ignored.
+ * @param aggregatedErrors  - Optional string array to which any non-ignorable error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @returns {@link Success} with an array containing all successful results if all results either
+ * succeeded or returned error details listed in `ignore`.  If any results failed with details
+ * that cannot be ignored, returns {@link Failure} with an concatenated summary of all non-ignorable
+ * error messages.
+ * @public
+ */
+function mapDetailedResults(results, ignore, aggregatedErrors) {
+    const errors = [];
+    const elements = [];
+    for (const result of results) {
+        if (result.isSuccess()) {
+            elements.push(result.value);
+        }
+        else if (!ignore.includes(result.detail)) {
+            errors.push(result.message);
+        }
+    }
+    if (errors.length > 0) {
+        aggregatedErrors === null || aggregatedErrors === void 0 ? void 0 : aggregatedErrors.push(...errors);
+        return (0, result_1.fail)(errors.join('\n'));
+    }
+    return (0, result_1.succeed)(elements);
+}
+exports.mapDetailedResults = mapDetailedResults;
+/**
+ * Aggregates successful results from a a collection of {@link Result | Result<T>}.
+ * @param results - An `Iterable` of {@link Result | Result<T>} from which success
+ * results are to be aggregated.
+ * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @returns {@link Success} with an array of `<T>` if any results were successful. If
+ * all {@link Result | results} failed, returns {@link Failure} with a concatenated
+ * summary of all error messages.
+ * @public
+ */
+function mapSuccess(results, aggregatedErrors) {
+    const errors = [];
+    const elements = [];
+    for (const result of results) {
+        if (result.isSuccess()) {
+            elements.push(result.value);
+        }
+        else {
+            errors.push(result.message);
+        }
+    }
+    if (elements.length === 0 && errors.length > 0) {
+        aggregatedErrors === null || aggregatedErrors === void 0 ? void 0 : aggregatedErrors.push(...errors);
+        return (0, result_1.fail)(errors.join('\n'));
+    }
+    return (0, result_1.succeed)(elements);
+}
+exports.mapSuccess = mapSuccess;
+/**
+ * Aggregates error messages from a collection of {@link Result | Result<T>}.
+ * @param results - An iterable collection of {@link Result | Result<T>} for which
+ * error messages are aggregated.
+ * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @returns An array of strings consisting of all error messages returned by
+ * {@link Result | results} in the source collection. Ignores {@link Success}
+ * results and returns an empty array if there were no errors.
+ * @public
+ */
+function mapFailures(results, aggregatedErrors) {
+    const errors = [];
+    for (const result of results) {
+        if (result.isFailure()) {
+            errors.push(result.message);
+            aggregatedErrors === null || aggregatedErrors === void 0 ? void 0 : aggregatedErrors.push(result.message);
+        }
+    }
+    return errors;
+}
+exports.mapFailures = mapFailures;
+/**
+ * Determines if an iterable collection of {@link Result | Result<T>} were all successful.
+ * @param results - The collection of {@link Result | Result<T>} to be tested.
+ * @param successValue - The value to be returned if results are successful.
+ * @param aggregatedErrors  - Optional string array to which any returned error messages will be
+ * appended.  Each error is appended as an individual string.
+ * @returns Returns {@link Success} with `successValue` if all {@link Result | results} are successful.
+ * If any are unsuccessful, returns {@link Failure} with a concatenated summary of the error
+ * messages from all failed elements.
+ * @public
+ */
+function allSucceed(results, successValue, aggregatedErrors) {
+    const errors = [];
+    if (results !== undefined) {
+        for (const result of results) {
+            if (result.isFailure()) {
+                errors.push(result.message);
+            }
+        }
+    }
+    if (errors.length > 0) {
+        aggregatedErrors === null || aggregatedErrors === void 0 ? void 0 : aggregatedErrors.push(...errors);
+        return (0, result_1.fail)(errors.join('\n'));
+    }
+    return (0, result_1.succeed)(successValue);
+}
+exports.allSucceed = allSucceed;
+function populateObject(initializers, optionsOrOrder, aggregatedErrors) {
+    var _a;
+    const options = optionsOrOrder
+        ? Array.isArray(optionsOrOrder)
+            ? { order: optionsOrOrder }
+            : optionsOrOrder
+        : {};
+    const state = {};
+    const errors = [];
+    const keys = Array.from((_a = options.order) !== null && _a !== void 0 ? _a : []);
+    const foundKeys = new Set(options.order);
+    // start with the supplied order then append anything else we find
+    for (const key in initializers) {
+        if (!foundKeys.has(key)) {
+            keys.push(key);
+            foundKeys.add(key);
+        }
+    }
+    for (const key of keys) {
+        if (initializers[key]) {
+            const result = initializers[key](state);
+            if (result.isSuccess()) {
+                if (result.value === undefined) {
+                    if (options.suppressUndefined === true ||
+                        (Array.isArray(options.suppressUndefined) && options.suppressUndefined.includes(key))) {
+                        continue;
+                    }
+                }
+                state[key] = result.value;
+            }
+            else {
+                errors.push(result.message);
+            }
+        }
+        else {
+            errors.push(`populateObject: Key ${String(key)} is present but has no initializer`);
+        }
+    }
+    if (errors.length > 0) {
+        aggregatedErrors === null || aggregatedErrors === void 0 ? void 0 : aggregatedErrors.push(...errors);
+        return (0, result_1.fail)(errors.join('\n'));
+    }
+    return (0, result_1.succeed)(state);
+}
+exports.populateObject = populateObject;
+//# sourceMappingURL=mapResults.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mapResults.js","sourceRoot":"","sources":["../../../src/packlets/base/mapResults.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,qCAAiE;AAEjE;;;;;;;;;GASG;AACH,SAAgB,UAAU,CAAI,OAA4B,EAAE,gBAA2B;IACrF,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,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;QAClC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAjBD,gCAiBC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,kBAAkB,CAChC,OAAwC,EACxC,MAAY,EACZ,gBAA2B;IAE3B,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,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;QAClC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AArBD,gDAqBC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CAAI,OAA4B,EAAE,gBAA2B;IACrF,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,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;QAClC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAjBD,gCAiBC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,WAAW,CAAI,OAA4B,EAAE,gBAA2B;IACtF,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,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AATD,kCASC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,OAAkC,EAClC,YAAe,EACf,gBAA2B;IAE3B,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,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;QAClC,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;AApBD,gCAoBC;AAsED,SAAgB,cAAc,CAC5B,YAAkC,EAClC,cAAuD,EACvD,gBAA2B;;IAE3B,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,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;QAClC,OAAO,IAAA,aAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,KAAU,CAAC,CAAC;AAC7B,CAAC;AAjDD,wCAiDC","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, 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>(results: Iterable<Result<T>>, aggregatedErrors?: string[]): 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?.push(...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?: string[]\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?.push(...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>(results: Iterable<Result<T>>, aggregatedErrors?: string[]): 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?.push(...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>(results: Iterable<Result<T>>, aggregatedErrors?: string[]): string[] {\n  const errors: string[] = [];\n  for (const result of results) {\n    if (result.isFailure()) {\n      errors.push(result.message);\n      aggregatedErrors?.push(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?: string[]\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?.push(...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?: string[]\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?: string[]\n): Result<T>;\nexport function populateObject<T>(\n  initializers: FieldInitializers<T>,\n  optionsOrOrder?: PopulateObjectOptions<T> | (keyof T)[],\n  aggregatedErrors?: string[]\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?.push(...errors);\n    return fail(errors.join('\\n'));\n  }\n  return succeed(state as T);\n}\n"]}

package/lib/packlets/base/normalize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"normalize.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/normalize.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAA6B,MAAM,UAAU,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnE;;;GAGG;AACH,qBAAa,UAAU;IACrB;;;;;OAKG;IACI,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IA4BvC;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM;IAaxD;;;;;;OAMG;IACI,gBAAgB,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE;IAQ7E,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;IAI7D;;;;OAIG;IACI,gBAAgB,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;CAwB/C"}
+{"version":3,"file":"normalize.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/normalize.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,MAAM,EAAiB,MAAM,UAAU,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnE;;;GAGG;AACH,qBAAa,UAAU;IACrB;;;;;OAKG;IACI,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IA4BvC;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM;IAaxD;;;;;;OAMG;IACI,gBAAgB,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE;IAQ7E,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;IAI7D;;;;OAIG;IACI,gBAAgB,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;CAwB/C"}

package/lib/packlets/base/normalize.js

@@ -22,6 +22,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Normalizer = void 0;
+const mapResults_1 = require("./mapResults");
 const result_1 = require("./result");
 /**
  * Normalizes an arbitrary JSON object
@@ -99,7 +100,7 @@ class Normalizer {
             .map((e) => [e[0], e[1].orThrow()]);
     }
     _normalizeArray(from) {
-        return (0, result_1.mapResults)(from.map((v) => this.normalize(v)));
+        return (0, mapResults_1.mapResults)(from.map((v) => this.normalize(v)));
     }
     /**
      * Normalizes the supplied literal value

package/lib/packlets/base/normalize.js.map

@@ -1 +1 @@
-{"version":3,"file":"normalize.js","sourceRoot":"","sources":["../../../src/packlets/base/normalize.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,qCAA6D;AAY7D;;;GAGG;AACH,MAAa,UAAU;IACrB;;;;;OAKG;IACI,SAAS,CAAI,IAAO;QACzB,QAAQ,OAAO,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,WAAW;gBACd,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;YACrC,KAAK,QAAQ;gBACX,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,YAAY,IAAI,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;oBACpE,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBACrC,CAAC;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC/B,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAyB,CAAC;gBAC5D,CAAC;qBAAM,IAAI,IAAI,YAAY,GAAG,EAAE,CAAC;oBAC/B,OAAO,IAAA,gBAAO,EAAC,IAAI,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAiB,CAAC,CAAC;gBACjF,CAAC;qBAAM,IAAI,IAAI,YAAY,GAAG,EAAE,CAAC;oBAC/B,OAAO,IAAA,gBAAO,EAAC,IAAI,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAiB,CAAC,CAAC;gBACjF,CAAC;gBACD,MAAM,GAAG,GAAmD,EAAE,CAAC;gBAC/D,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAyB,CAAC,CAAC,EAAE,CAAC;oBACjF,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnB,CAAC;gBACD,OAAO,IAAA,gBAAO,EAAC,GAAQ,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAA,aAAI,EAAC,kDAAkD,OAAO,IAAI,GAAG,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;OAOG;IACO,YAAY,CAAC,EAAW,EAAE,EAAW;QAC7C,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QACvB,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QACvB,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,CAAC;QACX,CAAC;QACD,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;QACD,sBAAsB;QACtB,OAAO,CAAC,CAAC;IACX,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CAAc,OAA2B;QAC9D,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;aACvB,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;aACjD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAmB,CAAC;aAC1D,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;aAC/B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACxC,CAAC;IAES,eAAe,CAAC,IAAe;QACvC,OAAO,IAAA,mBAAU,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAI,IAAO;QAChC,+CAA+C;QAC/C,QAAQ,OAAO,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ;gBACX,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,WAAW;gBACd,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC;QACzB,CAAC;QACD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,IAAI,YAAY,IAAI,EAAE,CAAC;YACzB,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;YAC3B,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,sBAAsB;QACtB,OAAO,IAAA,aAAI,EAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AAxGD,gCAwGC","sourcesContent":["/*\n * Copyright (c) 2021 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 { Result, fail, mapResults, succeed } from './result';\n\n/**\n * @internal\n */\nexport type Entry<T> = [string | number | symbol, T];\n\n/**\n * @internal\n */\nexport type ResultEntry<T> = [string | number | symbol, Result<T>];\n\n/**\n * Normalizes an arbitrary JSON object\n * @public\n */\nexport class Normalizer {\n  /**\n   * Normalizes the supplied value\n   *\n   * @param from - The value to be normalized\n   * @returns A normalized version of the value\n   */\n  public normalize<T>(from: T): Result<T> {\n    switch (typeof from) {\n      case 'string':\n      case 'bigint':\n      case 'boolean':\n      case 'number':\n      case 'symbol':\n      case 'undefined':\n        return this.normalizeLiteral(from);\n      case 'object':\n        if (from === null || from instanceof Date || from instanceof RegExp) {\n          return this.normalizeLiteral(from);\n        } else if (Array.isArray(from)) {\n          return this._normalizeArray(from) as unknown as Result<T>;\n        } else if (from instanceof Map) {\n          return succeed(new Map(this.normalizeEntries(from.entries())) as unknown as T);\n        } else if (from instanceof Set) {\n          return succeed(new Set(this.normalizeEntries(from.entries())) as unknown as T);\n        }\n        const obj: { [key in number | string | symbol]: unknown } = {};\n        for (const e of this.normalizeEntries(Object.entries(from as unknown as object))) {\n          obj[e[0]] = e[1];\n        }\n        return succeed(obj as T);\n    }\n    return fail(`normalize: Unexpected type - cannot normalize '${typeof from}'`);\n  }\n\n  /**\n   * Compares two property names from some object being normalized.\n   * @param k1 - First key to be compared.\n   * @param k2 - Second key to be compared.\n   * @returns `1` if `k1` is greater, `-1` if `k2` is greater and\n   * `0` if they are equal.\n   * @internal\n   */\n  protected _compareKeys(k1: unknown, k2: unknown): number {\n    const cs1 = String(k1);\n    const cs2 = String(k2);\n    if (cs1 > cs2) {\n      return 1;\n    }\n    if (cs2 > cs1) {\n      return -1;\n    }\n    /* c8 ignore next 2 */\n    return 0;\n  }\n\n  /**\n   * Normalizes an array of object property entries (e.g. as returned by `Object.entries()`).\n   * @remarks\n   * Converts property names (entry key) to string and then sorts as string.\n   * @param entries - The entries to be normalized.\n   * @returns A normalized sorted array of entries.\n   */\n  public normalizeEntries<T = unknown>(entries: Iterable<Entry<T>>): Entry<T>[] {\n    return Array.from(entries)\n      .sort((e1, e2) => this._compareKeys(e1[0], e2[0]))\n      .map((e) => [e[0], this.normalize(e[1])] as ResultEntry<T>)\n      .filter((e) => e[1].isSuccess())\n      .map((e) => [e[0], e[1].orThrow()]);\n  }\n\n  protected _normalizeArray(from: unknown[]): Result<unknown[]> {\n    return mapResults(from.map((v) => this.normalize(v)));\n  }\n\n  /**\n   * Normalizes the supplied literal value\n   * @param from - The literal value to be normalized.\n   * @returns A normalized value for the literal.\n   */\n  public normalizeLiteral<T>(from: T): Result<T> {\n    // TODO: Apply configurable normalization rules\n    switch (typeof from) {\n      case 'string':\n        return succeed(from);\n      case 'bigint':\n      case 'boolean':\n      case 'number':\n      case 'symbol':\n      case 'undefined':\n        return succeed(from);\n    }\n    if (from === null) {\n      return succeed(from);\n    }\n    if (from instanceof Date) {\n      return succeed(from);\n    }\n    if (from instanceof RegExp) {\n      return succeed(from);\n    }\n    /* c8 ignore next 2 */\n    return fail(`cannot normalize ${JSON.stringify(from)}`);\n  }\n}\n"]}
+{"version":3,"file":"normalize.js","sourceRoot":"","sources":["../../../src/packlets/base/normalize.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,6CAA0C;AAC1C,qCAAiD;AAYjD;;;GAGG;AACH,MAAa,UAAU;IACrB;;;;;OAKG;IACI,SAAS,CAAI,IAAO;QACzB,QAAQ,OAAO,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,WAAW;gBACd,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;YACrC,KAAK,QAAQ;gBACX,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,YAAY,IAAI,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;oBACpE,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBACrC,CAAC;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC/B,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAyB,CAAC;gBAC5D,CAAC;qBAAM,IAAI,IAAI,YAAY,GAAG,EAAE,CAAC;oBAC/B,OAAO,IAAA,gBAAO,EAAC,IAAI,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAiB,CAAC,CAAC;gBACjF,CAAC;qBAAM,IAAI,IAAI,YAAY,GAAG,EAAE,CAAC;oBAC/B,OAAO,IAAA,gBAAO,EAAC,IAAI,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAiB,CAAC,CAAC;gBACjF,CAAC;gBACD,MAAM,GAAG,GAAmD,EAAE,CAAC;gBAC/D,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAyB,CAAC,CAAC,EAAE,CAAC;oBACjF,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnB,CAAC;gBACD,OAAO,IAAA,gBAAO,EAAC,GAAQ,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAA,aAAI,EAAC,kDAAkD,OAAO,IAAI,GAAG,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;OAOG;IACO,YAAY,CAAC,EAAW,EAAE,EAAW;QAC7C,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QACvB,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QACvB,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,CAAC;QACX,CAAC;QACD,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;QACD,sBAAsB;QACtB,OAAO,CAAC,CAAC;IACX,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CAAc,OAA2B;QAC9D,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;aACvB,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;aACjD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAmB,CAAC;aAC1D,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;aAC/B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACxC,CAAC;IAES,eAAe,CAAC,IAAe;QACvC,OAAO,IAAA,uBAAU,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAI,IAAO;QAChC,+CAA+C;QAC/C,QAAQ,OAAO,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ;gBACX,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,WAAW;gBACd,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC;QACzB,CAAC;QACD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,IAAI,YAAY,IAAI,EAAE,CAAC;YACzB,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;YAC3B,OAAO,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,sBAAsB;QACtB,OAAO,IAAA,aAAI,EAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AAxGD,gCAwGC","sourcesContent":["/*\n * Copyright (c) 2021 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 { mapResults } from './mapResults';\nimport { Result, fail, succeed } from './result';\n\n/**\n * @internal\n */\nexport type Entry<T> = [string | number | symbol, T];\n\n/**\n * @internal\n */\nexport type ResultEntry<T> = [string | number | symbol, Result<T>];\n\n/**\n * Normalizes an arbitrary JSON object\n * @public\n */\nexport class Normalizer {\n  /**\n   * Normalizes the supplied value\n   *\n   * @param from - The value to be normalized\n   * @returns A normalized version of the value\n   */\n  public normalize<T>(from: T): Result<T> {\n    switch (typeof from) {\n      case 'string':\n      case 'bigint':\n      case 'boolean':\n      case 'number':\n      case 'symbol':\n      case 'undefined':\n        return this.normalizeLiteral(from);\n      case 'object':\n        if (from === null || from instanceof Date || from instanceof RegExp) {\n          return this.normalizeLiteral(from);\n        } else if (Array.isArray(from)) {\n          return this._normalizeArray(from) as unknown as Result<T>;\n        } else if (from instanceof Map) {\n          return succeed(new Map(this.normalizeEntries(from.entries())) as unknown as T);\n        } else if (from instanceof Set) {\n          return succeed(new Set(this.normalizeEntries(from.entries())) as unknown as T);\n        }\n        const obj: { [key in number | string | symbol]: unknown } = {};\n        for (const e of this.normalizeEntries(Object.entries(from as unknown as object))) {\n          obj[e[0]] = e[1];\n        }\n        return succeed(obj as T);\n    }\n    return fail(`normalize: Unexpected type - cannot normalize '${typeof from}'`);\n  }\n\n  /**\n   * Compares two property names from some object being normalized.\n   * @param k1 - First key to be compared.\n   * @param k2 - Second key to be compared.\n   * @returns `1` if `k1` is greater, `-1` if `k2` is greater and\n   * `0` if they are equal.\n   * @internal\n   */\n  protected _compareKeys(k1: unknown, k2: unknown): number {\n    const cs1 = String(k1);\n    const cs2 = String(k2);\n    if (cs1 > cs2) {\n      return 1;\n    }\n    if (cs2 > cs1) {\n      return -1;\n    }\n    /* c8 ignore next 2 */\n    return 0;\n  }\n\n  /**\n   * Normalizes an array of object property entries (e.g. as returned by `Object.entries()`).\n   * @remarks\n   * Converts property names (entry key) to string and then sorts as string.\n   * @param entries - The entries to be normalized.\n   * @returns A normalized sorted array of entries.\n   */\n  public normalizeEntries<T = unknown>(entries: Iterable<Entry<T>>): Entry<T>[] {\n    return Array.from(entries)\n      .sort((e1, e2) => this._compareKeys(e1[0], e2[0]))\n      .map((e) => [e[0], this.normalize(e[1])] as ResultEntry<T>)\n      .filter((e) => e[1].isSuccess())\n      .map((e) => [e[0], e[1].orThrow()]);\n  }\n\n  protected _normalizeArray(from: unknown[]): Result<unknown[]> {\n    return mapResults(from.map((v) => this.normalize(v)));\n  }\n\n  /**\n   * Normalizes the supplied literal value\n   * @param from - The literal value to be normalized.\n   * @returns A normalized value for the literal.\n   */\n  public normalizeLiteral<T>(from: T): Result<T> {\n    // TODO: Apply configurable normalization rules\n    switch (typeof from) {\n      case 'string':\n        return succeed(from);\n      case 'bigint':\n      case 'boolean':\n      case 'number':\n      case 'symbol':\n      case 'undefined':\n        return succeed(from);\n    }\n    if (from === null) {\n      return succeed(from);\n    }\n    if (from instanceof Date) {\n      return succeed(from);\n    }\n    if (from instanceof RegExp) {\n      return succeed(from);\n    }\n    /* c8 ignore next 2 */\n    return fail(`cannot normalize ${JSON.stringify(from)}`);\n  }\n}\n"]}

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

@@ -481,107 +481,4 @@ export declare function propagateWithDetail<T, TD>(result: Result<T>, detail: TD
  * @public
  */
 export declare function captureResult<T>(func: () => T): Result<T>;
-/**
- * Aggregates successful result values from a collection of {@link Result | Result<T>}.
- * @param results - The collection of {@link Result | Result<T>} to be mapped.
- * @returns  If all {@link Result | results} are successful, returns {@link Success} with an
- * array containing all returned values.  If any {@link Result | results} failed, returns
- * {@link Failure} with a concatenated summary of all error messages.
- * @public
- */
-export declare function mapResults<T>(results: Iterable<Result<T>>): Result<T[]>;
-/**
- * Aggregates successful results from a collection of {@link DetailedResult | DetailedResult<T, TD>},
- * optionally ignoring certain error details.
- * @param results - The collection of {@link DetailedResult | DetailedResult<T, TD>} to be mapped.
- * @param ignore - An array of error detail values (of type `<TD>`) that should be ignored.
- * @returns {@link Success} with an array containing all successful results if all results either
- * succeeded or returned error details listed in `ignore`.  If any results failed with details
- * that cannot be ignored, returns {@link Failure} with an concatenated summary of all non-ignorable
- * error messages.
- * @public
- */
-export declare function mapDetailedResults<T, TD>(results: Iterable<DetailedResult<T, TD>>, ignore: TD[]): Result<T[]>;
-/**
- * Aggregates successful results from a a collection of {@link Result | Result<T>}.
- * @param results - An `Iterable` of {@link Result | Result<T>} from which success
- * results are to be aggregated.
- * @returns {@link Success} with an array of `<T>` if any results were successful. If
- * all {@link Result | results} failed, returns {@link Failure} with a concatenated
- * summary of all error messages.
- * @public
- */
-export declare function mapSuccess<T>(results: Iterable<Result<T>>): Result<T[]>;
-/**
- * Aggregates error messages from a collection of {@link Result | Result<T>}.
- * @param results - An iterable collection of {@link Result | Result<T>} for which
- * error messages are aggregated.
- * @returns An array of strings consisting of all error messages returned by
- * {@link Result | results} in the source collection. Ignores {@link Success}
- * results and returns an empty array if there were no errors.
- * @public
- */
-export declare function mapFailures<T>(results: Iterable<Result<T>>): string[];
-/**
- * Determines if an iterable collection of {@link Result | Result<T>} were all successful.
- * @param results - The collection of {@link Result | Result<T>} to be tested.
- * @returns Returns {@link Success} with `true` if all {@link Result | results} are successful.
- * If any are unsuccessful, returns {@link Failure} with a concatenated summary the error
- * messages from all failed elements.
- * @public
- */
-export declare function allSucceed<T>(results: Iterable<Result<unknown>>, successValue: T): Result<T>;
-/**
- * String-keyed record of initialization functions to be passed to {@link (populateObject:1)}
- * or {@link (populateObject:2)}.
- * @public
- */
-export type FieldInitializers<T> = {
-    [key in keyof T]: (state: Partial<T>) => Result<T[key]>;
-};
-/**
- * Options for the {@link (populateObject:1)} function.
- * @public
- */
-export interface PopulateObjectOptions<T> {
-    /**
-     * If present, specifies the order in which property values should
-     * be evaluated.  Any keys not listed are evaluated after all listed
-     * keys in indeterminate order.  If 'order' is not present, keys
-     * are evaluated in indeterminate order.
-     */
-    order?: (keyof T)[];
-    /**
-     * Specify handling of `undefined` values.  By default, successful
-     * `undefined` results are written to the result object.  If this value
-     * is `true` then `undefined` results are suppressed for all properties.
-     * If this value is an array of property keys then `undefined` results
-     * are suppressed for those properties only.
-     */
-    suppressUndefined?: boolean | (keyof T)[];
-}
-/**
- * Populates an an object based on a prototype full of field initializers that return {@link Result | Result<T[key]>}.
- * Returns {@link Success} with the populated object if all initializers succeed, or {@link Failure} with a
- * concatenated list of all error messages.
- * @param initializers - An object with the shape of the target but with initializer functions for
- * each property.
- * @param options - An optional {@link PopulateObjectOptions | set of options} which
- * modify the behavior of this call.
- * {@label WITH_OPTIONS}
- * @public
- */
-export declare function populateObject<T>(initializers: FieldInitializers<T>, options?: PopulateObjectOptions<T>): Result<T>;
-/**
- * Populates an an object based on a prototype full of field initializers that return {@link Result | Result<T[key]>}.
- * Returns {@link Success} with the populated object if all initializers succeed, or {@link Failure} with a
- * concatenated list of all error messages.
- * @param initializers - An object with the shape of the target but with initializer functions for
- * each property.
- * @param order - Optional order in which keys should be written.
- * @public
- * {@label WITH_ORDER}
- * @deprecated Pass {@link PopulateObjectOptions} instead.
- */
-export declare function populateObject<T>(initializers: FieldInitializers<T>, order: (keyof T)[]): Result<T>;
 //# sourceMappingURL=result.d.ts.map

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

@@ -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;AAClE;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC;AACpE;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;AAEzE;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;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,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;CACvE;AAED;;;;GAIG;AACH,qBAAa,OAAO,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;IAC3C;;OAEG;IACH,SAAgB,OAAO,EAAE,IAAI,CAAQ;IACrC;;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,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;CAG7E;AAED;;;GAGG;AACH,qBAAa,OAAO,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;IAC3C;;OAEG;IACH,SAAgB,OAAO,EAAE,KAAK,CAAS;IAEvC;;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,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;;;;;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;CAGlF;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;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;;;;;;;;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;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAgBvE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,EAAE,EACtC,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EACxC,MAAM,EAAE,EAAE,EAAE,GACX,MAAM,CAAC,CAAC,EAAE,CAAC,CAgBb;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAgBvE;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,CAQrE;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAe5F;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;KAAG,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CAAE,CAAC;AAE/F;;;GAGG;AAEH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAEpB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;CAC3C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,YAAY,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAClC,OAAO,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,GACjC,MAAM,CAAC,CAAC,CAAC,CAAC;AAEb;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC"}
+{"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;AAClE;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC;AACpE;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;AAEzE;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;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,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;CACvE;AAED;;;;GAIG;AACH,qBAAa,OAAO,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;IAC3C;;OAEG;IACH,SAAgB,OAAO,EAAE,IAAI,CAAQ;IACrC;;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,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;CAG7E;AAED;;;GAGG;AACH,qBAAa,OAAO,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;IAC3C;;OAEG;IACH,SAAgB,OAAO,EAAE,KAAK,CAAS;IAEvC;;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,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;;;;;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;CAGlF;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;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;;;;;;;;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"}

package/lib/packlets/base/result.js

@@ -21,7 +21,7 @@
  * SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.populateObject = exports.allSucceed = exports.mapFailures = exports.mapSuccess = exports.mapDetailedResults = exports.mapResults = exports.captureResult = exports.propagateWithDetail = exports.failWithDetail = exports.succeedWithDetail = exports.DetailedFailure = exports.DetailedSuccess = exports.fail = exports.succeed = exports.Failure = exports.Success = void 0;
+exports.captureResult = exports.propagateWithDetail = exports.failWithDetail = exports.succeedWithDetail = exports.DetailedFailure = exports.DetailedSuccess = exports.fail = exports.succeed = exports.Failure = exports.Success = void 0;
 /**
  * Reports a successful {@link IResult | result} from some operation and the
  * corresponding value.
@@ -400,169 +400,4 @@ function captureResult(func) {
     }
 }
 exports.captureResult = captureResult;
-/**
- * Aggregates successful result values from a collection of {@link Result | Result<T>}.
- * @param results - The collection of {@link Result | Result<T>} to be mapped.
- * @returns  If all {@link Result | results} are successful, returns {@link Success} with an
- * array containing all returned values.  If any {@link Result | results} failed, returns
- * {@link Failure} with a concatenated summary of all error messages.
- * @public
- */
-function mapResults(results) {
-    const errors = [];
-    const elements = [];
-    for (const result of results) {
-        if (result.isSuccess()) {
-            elements.push(result.value);
-        }
-        else {
-            errors.push(result.message);
-        }
-    }
-    if (errors.length > 0) {
-        return fail(errors.join('\n'));
-    }
-    return succeed(elements);
-}
-exports.mapResults = mapResults;
-/**
- * Aggregates successful results from a collection of {@link DetailedResult | DetailedResult<T, TD>},
- * optionally ignoring certain error details.
- * @param results - The collection of {@link DetailedResult | DetailedResult<T, TD>} to be mapped.
- * @param ignore - An array of error detail values (of type `<TD>`) that should be ignored.
- * @returns {@link Success} with an array containing all successful results if all results either
- * succeeded or returned error details listed in `ignore`.  If any results failed with details
- * that cannot be ignored, returns {@link Failure} with an concatenated summary of all non-ignorable
- * error messages.
- * @public
- */
-function mapDetailedResults(results, ignore) {
-    const errors = [];
-    const elements = [];
-    for (const result of results) {
-        if (result.isSuccess()) {
-            elements.push(result.value);
-        }
-        else if (!ignore.includes(result.detail)) {
-            errors.push(result.message);
-        }
-    }
-    if (errors.length > 0) {
-        return fail(errors.join('\n'));
-    }
-    return succeed(elements);
-}
-exports.mapDetailedResults = mapDetailedResults;
-/**
- * Aggregates successful results from a a collection of {@link Result | Result<T>}.
- * @param results - An `Iterable` of {@link Result | Result<T>} from which success
- * results are to be aggregated.
- * @returns {@link Success} with an array of `<T>` if any results were successful. If
- * all {@link Result | results} failed, returns {@link Failure} with a concatenated
- * summary of all error messages.
- * @public
- */
-function mapSuccess(results) {
-    const errors = [];
-    const elements = [];
-    for (const result of results) {
-        if (result.isSuccess()) {
-            elements.push(result.value);
-        }
-        else {
-            errors.push(result.message);
-        }
-    }
-    if (elements.length === 0 && errors.length > 0) {
-        return fail(errors.join('\n'));
-    }
-    return succeed(elements);
-}
-exports.mapSuccess = mapSuccess;
-/**
- * Aggregates error messages from a collection of {@link Result | Result<T>}.
- * @param results - An iterable collection of {@link Result | Result<T>} for which
- * error messages are aggregated.
- * @returns An array of strings consisting of all error messages returned by
- * {@link Result | results} in the source collection. Ignores {@link Success}
- * results and returns an empty array if there were no errors.
- * @public
- */
-function mapFailures(results) {
-    const errors = [];
-    for (const result of results) {
-        if (result.isFailure()) {
-            errors.push(result.message);
-        }
-    }
-    return errors;
-}
-exports.mapFailures = mapFailures;
-/**
- * Determines if an iterable collection of {@link Result | Result<T>} were all successful.
- * @param results - The collection of {@link Result | Result<T>} to be tested.
- * @returns Returns {@link Success} with `true` if all {@link Result | results} are successful.
- * If any are unsuccessful, returns {@link Failure} with a concatenated summary the error
- * messages from all failed elements.
- * @public
- */
-function allSucceed(results, successValue) {
-    const errors = [];
-    if (results !== undefined) {
-        for (const result of results) {
-            if (result.isFailure()) {
-                errors.push(result.message);
-            }
-        }
-    }
-    if (errors.length > 0) {
-        return fail(errors.join('\n'));
-    }
-    return succeed(successValue);
-}
-exports.allSucceed = allSucceed;
-function populateObject(initializers, optionsOrOrder) {
-    var _a;
-    const options = optionsOrOrder
-        ? Array.isArray(optionsOrOrder)
-            ? { order: optionsOrOrder }
-            : optionsOrOrder
-        : {};
-    const state = {};
-    const errors = [];
-    const keys = Array.from((_a = options.order) !== null && _a !== void 0 ? _a : []);
-    const foundKeys = new Set(options.order);
-    // start with the supplied order then append anything else we find
-    for (const key in initializers) {
-        if (!foundKeys.has(key)) {
-            keys.push(key);
-            foundKeys.add(key);
-        }
-    }
-    for (const key of keys) {
-        if (initializers[key]) {
-            const result = initializers[key](state);
-            if (result.isSuccess()) {
-                if (result.value === undefined) {
-                    if (options.suppressUndefined === true ||
-                        (Array.isArray(options.suppressUndefined) && options.suppressUndefined.includes(key))) {
-                        continue;
-                    }
-                }
-                state[key] = result.value;
-            }
-            else {
-                errors.push(result.message);
-            }
-        }
-        else {
-            errors.push(`populateObject: Key ${String(key)} is present but has no initializer`);
-        }
-    }
-    if (errors.length > 0) {
-        return fail(errors.join('\n'));
-    }
-    return succeed(state);
-}
-exports.populateObject = populateObject;
 //# sourceMappingURL=result.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"result.js","sourceRoot":"","sources":["../../../src/packlets/base/result.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AA+KH;;;;GAIG;AACH,MAAa,OAAO;IAUlB;;;OAGG;IACH,YAAmB,KAAQ;QAb3B;;WAEG;QACa,YAAO,GAAS,IAAI,CAAC;QAWnC,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,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;CACF;AArGD,0BAqGC;AAED;;;GAGG;AACH,MAAa,OAAO;IAWlB;;;OAGG;IACH,YAAmB,OAAe;QAdlC;;WAEG;QACa,YAAO,GAAU,KAAK,CAAC;QAYrC,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,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;;;;;OAKG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAtHD,0BAsHC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CAAI,KAAQ;IACjC,OAAO,IAAI,OAAO,CAAI,KAAK,CAAC,CAAC;AAC/B,CAAC;AAFD,0BAEC;AAED;;;;GAIG;AACH,SAAgB,IAAI,CAAI,OAAe;IACrC,OAAO,IAAI,OAAO,CAAI,OAAO,CAAC,CAAC;AACjC,CAAC;AAFD,oBAEC;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;CACF;AA7DD,0CA6DC;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;CACF;AA3DD,0CA2DC;AAcD;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAAQ,KAAQ,EAAE,MAAW;IAC5D,OAAO,IAAI,eAAe,CAAQ,KAAK,EAAE,MAAM,CAAC,CAAC;AACnD,CAAC;AAFD,8CAEC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAQ,OAAe,EAAE,MAAU;IAC/D,OAAO,IAAI,eAAe,CAAQ,OAAO,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC;AAFD,wCAEC;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;AARD,kDAQC;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;AAND,sCAMC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CAAI,OAA4B;IACxD,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,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAhBD,gCAgBC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,kBAAkB,CAChC,OAAwC,EACxC,MAAY;IAEZ,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,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAnBD,gDAmBC;AAED;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAI,OAA4B;IACxD,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,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAhBD,gCAgBC;AAED;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAAI,OAA4B;IACzD,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;QAC9B,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AARD,kCAQC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CAAI,OAAkC,EAAE,YAAe;IAC/E,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,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC;AAC/B,CAAC;AAfD,gCAeC;AA6DD,SAAgB,cAAc,CAC5B,YAAkC,EAClC,cAAuD;;IAEvD,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,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,OAAO,CAAC,KAAU,CAAC,CAAC;AAC7B,CAAC;AA/CD,wCA+CC","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 * 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 * 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 * 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 * 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   * 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   * 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/**\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   * @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.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/**\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  /**\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.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   * 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/**\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/**\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\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 * @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>(results: Iterable<Result<T>>): 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    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 * @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): 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    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 * @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>(results: Iterable<Result<T>>): 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    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 * @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>(results: Iterable<Result<T>>): string[] {\n  const errors: string[] = [];\n  for (const result of results) {\n    if (result.isFailure()) {\n      errors.push(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 * @returns Returns {@link Success} with `true` if all {@link Result | results} are successful.\n * If any are unsuccessful, returns {@link Failure} with a concatenated summary the error\n * messages from all failed elements.\n * @public\n */\nexport function allSucceed<T>(results: Iterable<Result<unknown>>, successValue: T): 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    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 * {@label WITH_OPTIONS}\n * @public\n */\nexport function populateObject<T>(\n  initializers: FieldInitializers<T>,\n  options?: PopulateObjectOptions<T>\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 * @public\n * {@label WITH_ORDER}\n * @deprecated Pass {@link PopulateObjectOptions} instead.\n */\nexport function populateObject<T>(initializers: FieldInitializers<T>, order: (keyof T)[]): Result<T>;\nexport function populateObject<T>(\n  initializers: FieldInitializers<T>,\n  optionsOrOrder?: PopulateObjectOptions<T> | (keyof T)[]\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    return fail(errors.join('\\n'));\n  }\n  return succeed(state as T);\n}\n"]}
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../../../src/packlets/base/result.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AA+KH;;;;GAIG;AACH,MAAa,OAAO;IAUlB;;;OAGG;IACH,YAAmB,KAAQ;QAb3B;;WAEG;QACa,YAAO,GAAS,IAAI,CAAC;QAWnC,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,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;CACF;AArGD,0BAqGC;AAED;;;GAGG;AACH,MAAa,OAAO;IAWlB;;;OAGG;IACH,YAAmB,OAAe;QAdlC;;WAEG;QACa,YAAO,GAAU,KAAK,CAAC;QAYrC,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,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;;;;;OAKG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAtHD,0BAsHC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CAAI,KAAQ;IACjC,OAAO,IAAI,OAAO,CAAI,KAAK,CAAC,CAAC;AAC/B,CAAC;AAFD,0BAEC;AAED;;;;GAIG;AACH,SAAgB,IAAI,CAAI,OAAe;IACrC,OAAO,IAAI,OAAO,CAAI,OAAO,CAAC,CAAC;AACjC,CAAC;AAFD,oBAEC;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;CACF;AA7DD,0CA6DC;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;CACF;AA3DD,0CA2DC;AAcD;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAAQ,KAAQ,EAAE,MAAW;IAC5D,OAAO,IAAI,eAAe,CAAQ,KAAK,EAAE,MAAM,CAAC,CAAC;AACnD,CAAC;AAFD,8CAEC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAQ,OAAe,EAAE,MAAU;IAC/D,OAAO,IAAI,eAAe,CAAQ,OAAO,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC;AAFD,wCAEC;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;AARD,kDAQC;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;AAND,sCAMC","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 * 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 * 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 * 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 * 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   * 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   * 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/**\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   * @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.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/**\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  /**\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.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   * 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/**\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/**\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"]}

package/package.json

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