@fgv/ts-utils 4.5.0-3 → 4.5.1

package/lib/packlets/base/result.js

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

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/utils.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAiB,MAAM,UAAU,CAAC;AAEjD;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,CAEhG;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAQ3F;AAED;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAO3F;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CAAC,CAAC,SAAS,MAAM,EAC1D,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAC7B,IAAI,EAAE,CAAC,EACP,YAAY,CAAC,EAAE,OAAO,GACrB,OAAO,GAAG,SAAS,CAErB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAChD,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAC7B,IAAI,EAAE,CAAC,GAEL,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,WAAW,GACX,WAAW,GACX,QAAQ,GACR,UAAU,GACV,SAAS,CAEZ;AAED;;;GAGG;AACH,KAAK,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,CAAC;AAEhG;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EAC5D,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,EACnB,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAarB;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EACpE,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,EAC/B,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,CAEjC;AAED;;;;;;;GAOG;AACH,wBAAgB,gCAAgC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EACjF,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,EAC/B,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAErB;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EAC5D,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,EACxB,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAaxB;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EACpE,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,EACpC,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,CAEpC;AAED;;;;;;;GAOG;AACH,wBAAgB,gCAAgC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EACjF,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,EACpC,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAExB"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/packlets/base/utils.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAiB,MAAM,UAAU,CAAC;AAEjD;;;;;;;GAOG;AAEH,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,CAEhG;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAQ3F;AAED;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAO3F;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CAAC,CAAC,SAAS,MAAM,EAC1D,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAC7B,IAAI,EAAE,CAAC,EACP,YAAY,CAAC,EAAE,OAAO,GACrB,OAAO,GAAG,SAAS,CAErB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAChD,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAC7B,IAAI,EAAE,CAAC,GAEL,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,WAAW,GACX,WAAW,GACX,QAAQ,GACR,UAAU,GACV,SAAS,CAEZ;AAED;;;GAGG;AACH,KAAK,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,CAAC;AAEhG;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EAC5D,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,EACnB,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAarB;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EACpE,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,EAC/B,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,CAEjC;AAED;;;;;;;GAOG;AACH,wBAAgB,gCAAgC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EACjF,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,EAC/B,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAErB;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EAC5D,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,EACxB,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAaxB;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EACpE,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,EACpC,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,CAEpC;AAED;;;;;;;GAOG;AACH,wBAAgB,gCAAgC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EACjF,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,EACpC,OAAO,EAAE,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACrC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAExB"}

package/lib/packlets/base/utils.js

@@ -41,6 +41,7 @@ const result_1 = require("./result");
  * @returns Returns `true` if the key is present, `false` otherwise.
  * @public
  */
+// eslint-disable-next-line @typescript-eslint/ban-types
 function isKeyOf(key, item) {
     return item.hasOwnProperty(key);
 }

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

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/packlets/base/utils.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;AAYH,0BAEC;AAUD,oBAQC;AAWD,oBAOC;AAaD,kEAMC;AAaD,8CAeC;AAgBD,kCAgBC;AAUD,kDAKC;AAUD,4EAKC;AAUD,kCAgBC;AAUD,kDAKC;AAUD,4EAKC;AArND,qCAAiD;AAEjD;;;;;;;GAOG;AACH,SAAgB,OAAO,CAAmB,GAA6B,EAAE,IAAO;IAC9E,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,IAAI,CAAsC,IAAO,EAAE,OAAY;IAC7E,MAAM,IAAI,GAAwB,EAAE,CAAC;IACrC,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YAChB,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,IAAkB,CAAC;AAC5B,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,IAAI,CAAsC,IAAO,EAAE,OAAY;IAC7E,MAAM,IAAI,GAAwB,EAAE,CAAC;IACrC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAiB,CAAC,CAAC,EAAE,CAAC;QAChG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAgC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,OAAO,IAAkB,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,2BAA2B,CACzC,GAA6B,EAC7B,IAAO,EACP,YAAsB;IAEtB,OAAO,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AACvD,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,iBAAiB,CAC/B,GAA6B,EAC7B,IAAO;IAYP,OAAO,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3D,CAAC;AAQD;;;;;;;GAOG;AACH,SAAgB,WAAW,CACzB,GAAmB,EACnB,OAAsC;IAEtC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1C,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC3B,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,aAAI,EAAC,GAAG,GAAG,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,GAAG,CAAC,CAAC;AACtB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,GAA+B,EAC/B,OAAsC;IAEtC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,gBAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,gCAAgC,CAC9C,GAA+B,EAC/B,OAAsC;IAEtC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,gBAAO,EAAC,IAAI,GAAG,EAAU,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AACpF,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,WAAW,CACzB,GAAwB,EACxB,OAAsC;IAEtC,MAAM,MAAM,GAAmB,EAAoB,CAAC;IACpD,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3C,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC3B,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,aAAI,EAAC,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,MAAM,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,GAAoC,EACpC,OAAsC;IAEtC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,gBAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,gCAAgC,CAC9C,GAAoC,EACpC,OAAsC;IAEtC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,gBAAO,EAAC,EAAoB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AACvF,CAAC","sourcesContent":["/*\r\n * Copyright (c) 2020 Erik Fortune\r\n *\r\n * Permission is hereby granted, free of charge, to any person obtaining a copy\r\n * of this software and associated documentation files (the \"Software\"), to deal\r\n * in the Software without restriction, including without limitation the rights\r\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\n * copies of the Software, and to permit persons to whom the Software is\r\n * furnished to do so, subject to the following conditions:\r\n *\r\n * The above copyright notice and this permission notice shall be included in all\r\n * copies or substantial portions of the Software.\r\n *\r\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\n * SOFTWARE.\r\n */\r\n\r\nimport { Result, fail, succeed } from './result';\r\n\r\n/**\r\n * Helper type-guard function to report whether a specified key is present in\r\n * a supplied object.\r\n * @param key - The key to be tested.\r\n * @param item - The object to be tested.\r\n * @returns Returns `true` if the key is present, `false` otherwise.\r\n * @public\r\n */\r\nexport function isKeyOf<T extends object>(key: string | number | symbol, item: T): key is keyof T {\r\n  return item.hasOwnProperty(key);\r\n}\r\n\r\n/**\r\n * Simple implicit pick function, which picks a set of properties from a supplied\r\n * object.  Ignores picked properties that do not exist regardless of type signature.\r\n * @param from - The object from which keys are to be picked.\r\n * @param include - The keys of the properties to be picked from `from`.\r\n * @returns A new object containing the requested properties from `from`, where present.\r\n * @public\r\n */\r\nexport function pick<T extends object, K extends keyof T>(from: T, include: K[]): Pick<T, K> {\r\n  const rtrn: Partial<Pick<T, K>> = {};\r\n  for (const key of include) {\r\n    if (key in from) {\r\n      rtrn[key] = from[key];\r\n    }\r\n  }\r\n  return rtrn as Pick<T, K>;\r\n}\r\n\r\n/**\r\n * Simple implicit omit function, which picks all of the properties from a supplied\r\n * object except those specified for exclusion.\r\n * @param from - The object from which keys are to be picked.\r\n * @param exclude - The keys of the properties to be excluded from the returned object.\r\n * @returns A new object containing all of the properties from `from` that were not\r\n * explicitly excluded.\r\n * @public\r\n */\r\nexport function omit<T extends object, K extends keyof T>(from: T, exclude: K[]): Omit<T, K> {\r\n  const rtrn: Partial<Omit<T, K>> = {};\r\n  for (const entry of Object.entries(from).filter((e) => !exclude.includes(e[0] as keyof T as K))) {\r\n    rtrn[entry[0] as unknown as keyof Omit<T, K>] = entry[1];\r\n  }\r\n\r\n  return rtrn as Omit<T, K>;\r\n}\r\n\r\n/**\r\n * Gets the value of a property specified by key from an arbitrary object,\r\n * or a default value if the property does not exist.\r\n * @param key - The key specifying the property to be retrieved.\r\n * @param item - The object from which the property is to be retrieved.\r\n * @param defaultValue - An optional default value to be returned if the property\r\n * is not present (default `undefined`).\r\n * @returns The value of the requested property, or the default value if the\r\n * requested property does not exist.\r\n * @public\r\n */\r\nexport function getValueOfPropertyOrDefault<T extends object>(\r\n  key: string | number | symbol,\r\n  item: T,\r\n  defaultValue?: unknown\r\n): unknown | undefined {\r\n  return isKeyOf(key, item) ? item[key] : defaultValue;\r\n}\r\n\r\n/**\r\n * Gets the type of a property specified by key from an arbitrary object.\r\n * @param key - The key specifying the property to be tested.\r\n * @param item - The object from which the property is to be tested.\r\n * @returns The type of the requested property, or `undefined` if the\r\n * property does not exist.\r\n * @example\r\n * Returns `'undefined'` (a string) if the property exists but has the value\r\n * undefined but `undefined` (the literal) if the property does not exist.\r\n * @public\r\n */\r\nexport function getTypeOfProperty<T extends object>(\r\n  key: string | number | symbol,\r\n  item: T\r\n):\r\n  | 'string'\r\n  | 'number'\r\n  | 'bigint'\r\n  | 'boolean'\r\n  | 'symbol'\r\n  | 'undefined'\r\n  | 'undefined'\r\n  | 'object'\r\n  | 'function'\r\n  | undefined {\r\n  return isKeyOf(key, item) ? typeof item[key] : undefined;\r\n}\r\n\r\n/**\r\n * Type for factory methods which convert a key-value pair to a new unique value.\r\n * @public\r\n */\r\ntype KeyedThingFactory<TS, TD, TK extends string = string> = (key: TK, thing: TS) => Result<TD>;\r\n\r\n/**\r\n * Applies a factory method to convert a `Record<TK, TS>` into a `Map<TK, TD>`.\r\n * @param src - The `Record` to be converted.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting map on success, or {@link Failure} with a\r\n * message if an error occurs.\r\n * @public\r\n */\r\nexport function recordToMap<TS, TD, TK extends string = string>(\r\n  src: Record<TK, TS>,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Map<TK, TD>> {\r\n  const map = new Map<TK, TD>();\r\n  for (const key in src) {\r\n    if (src[key] !== undefined) {\r\n      const itemResult = factory(key, src[key]);\r\n      if (itemResult.isSuccess()) {\r\n        map.set(key, itemResult.value);\r\n      } else {\r\n        return fail(`${key}: ${itemResult.message}`);\r\n      }\r\n    }\r\n  }\r\n  return succeed(map);\r\n}\r\n\r\n/**\r\n * Applies a factory method to convert an optional `Record<TK, TS>` into a `Map<TK, TD>`, or `undefined`.\r\n * @param src - The `Record` to be converted, or undefined.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting map if conversion succeeds, or {@link Success} with `undefined`\r\n * if `src` is `undefined`. Returns {@link Failure} with a message if an error occurs.\r\n * @public\r\n */\r\nexport function optionalRecordToMap<TS, TD, TK extends string = string>(\r\n  src: Record<TK, TS> | undefined,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Map<TK, TD> | undefined> {\r\n  return src === undefined ? succeed(undefined) : recordToMap(src, factory);\r\n}\r\n\r\n/**\r\n * Applies a factory method to convert an optional `Record<TK, TS>` into a `Map<TK, TD>`\r\n * @param src - The `Record` to be converted, or `undefined`.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting map (empty if `src` is `undefined`) if conversion succeeds.\r\n * Returns {@link Failure} with a message if an error occurs.\r\n * @public\r\n */\r\nexport function optionalRecordToPossiblyEmptyMap<TS, TD, TK extends string = string>(\r\n  src: Record<TK, TS> | undefined,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Map<TK, TD>> {\r\n  return src === undefined ? succeed(new Map<TK, TD>()) : recordToMap(src, factory);\r\n}\r\n\r\n/**\r\n * Applies a factory method to convert a `ReadonlyMap<TK, TS>` into a `Record<TK, TD>`.\r\n * @param src - The `Map` object to be converted.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting `Record<TK, TD>` if conversion succeeds, or\r\n * {@link Failure} with an error message if an error occurs.\r\n * @public\r\n */\r\nexport function mapToRecord<TS, TD, TK extends string = string>(\r\n  src: ReadonlyMap<TK, TS>,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Record<TK, TD>> {\r\n  const record: Record<TK, TD> = {} as Record<TK, TD>;\r\n  for (const kvp of src) {\r\n    if (kvp[1] !== undefined) {\r\n      const itemResult = factory(kvp[0], kvp[1]);\r\n      if (itemResult.isSuccess()) {\r\n        record[kvp[0]] = itemResult.value;\r\n      } else {\r\n        return fail(`${kvp[0]}: ${itemResult.message}`);\r\n      }\r\n    }\r\n  }\r\n  return succeed(record);\r\n}\r\n\r\n/**\r\n * Applies a factory method to convert an optional `ReadonlyMap<string, TS>` into a `Record<string, TD>` or `undefined`.\r\n * @param src - The `Map` object to be converted, or `undefined`.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting record if conversion succeeds, or {@link Success} with `undefined` if\r\n * `src` is `undefined`. Returns {@link Failure} with a message if an error occurs.\r\n * @public\r\n */\r\nexport function optionalMapToRecord<TS, TD, TK extends string = string>(\r\n  src: ReadonlyMap<TK, TS> | undefined,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Record<TK, TD> | undefined> {\r\n  return src === undefined ? succeed(undefined) : mapToRecord(src, factory);\r\n}\r\n\r\n/**\r\n * Applies a factory method to convert an optional `ReadonlyMap<string, TS>` into a `Record<string, TD>`\r\n * @param src - The `ReadonlyMap` object to be converted, or `undefined`.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting record (empty if `src` is `undefined`) if conversion succeeds.\r\n * Returns {@link Failure} with a message if an error occurs.\r\n * @public\r\n */\r\nexport function optionalMapToPossiblyEmptyRecord<TS, TD, TK extends string = string>(\r\n  src: ReadonlyMap<TK, TS> | undefined,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Record<TK, TD>> {\r\n  return src === undefined ? succeed({} as Record<TK, TD>) : mapToRecord(src, factory);\r\n}\r\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/packlets/base/utils.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;AAaH,0BAEC;AAUD,oBAQC;AAWD,oBAOC;AAaD,kEAMC;AAaD,8CAeC;AAgBD,kCAgBC;AAUD,kDAKC;AAUD,4EAKC;AAUD,kCAgBC;AAUD,kDAKC;AAUD,4EAKC;AAtND,qCAAiD;AAEjD;;;;;;;GAOG;AACH,wDAAwD;AACxD,SAAgB,OAAO,CAAmB,GAA6B,EAAE,IAAO;IAC9E,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,IAAI,CAAsC,IAAO,EAAE,OAAY;IAC7E,MAAM,IAAI,GAAwB,EAAE,CAAC;IACrC,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YAChB,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,IAAkB,CAAC;AAC5B,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,IAAI,CAAsC,IAAO,EAAE,OAAY;IAC7E,MAAM,IAAI,GAAwB,EAAE,CAAC;IACrC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAiB,CAAC,CAAC,EAAE,CAAC;QAChG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAgC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,OAAO,IAAkB,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,2BAA2B,CACzC,GAA6B,EAC7B,IAAO,EACP,YAAsB;IAEtB,OAAO,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AACvD,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,iBAAiB,CAC/B,GAA6B,EAC7B,IAAO;IAYP,OAAO,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3D,CAAC;AAQD;;;;;;;GAOG;AACH,SAAgB,WAAW,CACzB,GAAmB,EACnB,OAAsC;IAEtC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1C,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC3B,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,aAAI,EAAC,GAAG,GAAG,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,GAAG,CAAC,CAAC;AACtB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,GAA+B,EAC/B,OAAsC;IAEtC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,gBAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,gCAAgC,CAC9C,GAA+B,EAC/B,OAAsC;IAEtC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,gBAAO,EAAC,IAAI,GAAG,EAAU,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AACpF,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,WAAW,CACzB,GAAwB,EACxB,OAAsC;IAEtC,MAAM,MAAM,GAAmB,EAAoB,CAAC;IACpD,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3C,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC3B,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,aAAI,EAAC,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAA,gBAAO,EAAC,MAAM,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,GAAoC,EACpC,OAAsC;IAEtC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,gBAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,gCAAgC,CAC9C,GAAoC,EACpC,OAAsC;IAEtC,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,gBAAO,EAAC,EAAoB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AACvF,CAAC","sourcesContent":["/*\r\n * Copyright (c) 2020 Erik Fortune\r\n *\r\n * Permission is hereby granted, free of charge, to any person obtaining a copy\r\n * of this software and associated documentation files (the \"Software\"), to deal\r\n * in the Software without restriction, including without limitation the rights\r\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\n * copies of the Software, and to permit persons to whom the Software is\r\n * furnished to do so, subject to the following conditions:\r\n *\r\n * The above copyright notice and this permission notice shall be included in all\r\n * copies or substantial portions of the Software.\r\n *\r\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\n * SOFTWARE.\r\n */\r\n\r\nimport { Result, fail, succeed } from './result';\r\n\r\n/**\r\n * Helper type-guard function to report whether a specified key is present in\r\n * a supplied object.\r\n * @param key - The key to be tested.\r\n * @param item - The object to be tested.\r\n * @returns Returns `true` if the key is present, `false` otherwise.\r\n * @public\r\n */\r\n// eslint-disable-next-line @typescript-eslint/ban-types\r\nexport function isKeyOf<T extends object>(key: string | number | symbol, item: T): key is keyof T {\r\n  return item.hasOwnProperty(key);\r\n}\r\n\r\n/**\r\n * Simple implicit pick function, which picks a set of properties from a supplied\r\n * object.  Ignores picked properties that do not exist regardless of type signature.\r\n * @param from - The object from which keys are to be picked.\r\n * @param include - The keys of the properties to be picked from `from`.\r\n * @returns A new object containing the requested properties from `from`, where present.\r\n * @public\r\n */\r\nexport function pick<T extends object, K extends keyof T>(from: T, include: K[]): Pick<T, K> {\r\n  const rtrn: Partial<Pick<T, K>> = {};\r\n  for (const key of include) {\r\n    if (key in from) {\r\n      rtrn[key] = from[key];\r\n    }\r\n  }\r\n  return rtrn as Pick<T, K>;\r\n}\r\n\r\n/**\r\n * Simple implicit omit function, which picks all of the properties from a supplied\r\n * object except those specified for exclusion.\r\n * @param from - The object from which keys are to be picked.\r\n * @param exclude - The keys of the properties to be excluded from the returned object.\r\n * @returns A new object containing all of the properties from `from` that were not\r\n * explicitly excluded.\r\n * @public\r\n */\r\nexport function omit<T extends object, K extends keyof T>(from: T, exclude: K[]): Omit<T, K> {\r\n  const rtrn: Partial<Omit<T, K>> = {};\r\n  for (const entry of Object.entries(from).filter((e) => !exclude.includes(e[0] as keyof T as K))) {\r\n    rtrn[entry[0] as unknown as keyof Omit<T, K>] = entry[1];\r\n  }\r\n\r\n  return rtrn as Omit<T, K>;\r\n}\r\n\r\n/**\r\n * Gets the value of a property specified by key from an arbitrary object,\r\n * or a default value if the property does not exist.\r\n * @param key - The key specifying the property to be retrieved.\r\n * @param item - The object from which the property is to be retrieved.\r\n * @param defaultValue - An optional default value to be returned if the property\r\n * is not present (default `undefined`).\r\n * @returns The value of the requested property, or the default value if the\r\n * requested property does not exist.\r\n * @public\r\n */\r\nexport function getValueOfPropertyOrDefault<T extends object>(\r\n  key: string | number | symbol,\r\n  item: T,\r\n  defaultValue?: unknown\r\n): unknown | undefined {\r\n  return isKeyOf(key, item) ? item[key] : defaultValue;\r\n}\r\n\r\n/**\r\n * Gets the type of a property specified by key from an arbitrary object.\r\n * @param key - The key specifying the property to be tested.\r\n * @param item - The object from which the property is to be tested.\r\n * @returns The type of the requested property, or `undefined` if the\r\n * property does not exist.\r\n * @example\r\n * Returns `'undefined'` (a string) if the property exists but has the value\r\n * undefined but `undefined` (the literal) if the property does not exist.\r\n * @public\r\n */\r\nexport function getTypeOfProperty<T extends object>(\r\n  key: string | number | symbol,\r\n  item: T\r\n):\r\n  | 'string'\r\n  | 'number'\r\n  | 'bigint'\r\n  | 'boolean'\r\n  | 'symbol'\r\n  | 'undefined'\r\n  | 'undefined'\r\n  | 'object'\r\n  | 'function'\r\n  | undefined {\r\n  return isKeyOf(key, item) ? typeof item[key] : undefined;\r\n}\r\n\r\n/**\r\n * Type for factory methods which convert a key-value pair to a new unique value.\r\n * @public\r\n */\r\ntype KeyedThingFactory<TS, TD, TK extends string = string> = (key: TK, thing: TS) => Result<TD>;\r\n\r\n/**\r\n * Applies a factory method to convert a `Record<TK, TS>` into a `Map<TK, TD>`.\r\n * @param src - The `Record` to be converted.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting map on success, or {@link Failure} with a\r\n * message if an error occurs.\r\n * @public\r\n */\r\nexport function recordToMap<TS, TD, TK extends string = string>(\r\n  src: Record<TK, TS>,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Map<TK, TD>> {\r\n  const map = new Map<TK, TD>();\r\n  for (const key in src) {\r\n    if (src[key] !== undefined) {\r\n      const itemResult = factory(key, src[key]);\r\n      if (itemResult.isSuccess()) {\r\n        map.set(key, itemResult.value);\r\n      } else {\r\n        return fail(`${key}: ${itemResult.message}`);\r\n      }\r\n    }\r\n  }\r\n  return succeed(map);\r\n}\r\n\r\n/**\r\n * Applies a factory method to convert an optional `Record<TK, TS>` into a `Map<TK, TD>`, or `undefined`.\r\n * @param src - The `Record` to be converted, or undefined.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting map if conversion succeeds, or {@link Success} with `undefined`\r\n * if `src` is `undefined`. Returns {@link Failure} with a message if an error occurs.\r\n * @public\r\n */\r\nexport function optionalRecordToMap<TS, TD, TK extends string = string>(\r\n  src: Record<TK, TS> | undefined,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Map<TK, TD> | undefined> {\r\n  return src === undefined ? succeed(undefined) : recordToMap(src, factory);\r\n}\r\n\r\n/**\r\n * Applies a factory method to convert an optional `Record<TK, TS>` into a `Map<TK, TD>`\r\n * @param src - The `Record` to be converted, or `undefined`.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting map (empty if `src` is `undefined`) if conversion succeeds.\r\n * Returns {@link Failure} with a message if an error occurs.\r\n * @public\r\n */\r\nexport function optionalRecordToPossiblyEmptyMap<TS, TD, TK extends string = string>(\r\n  src: Record<TK, TS> | undefined,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Map<TK, TD>> {\r\n  return src === undefined ? succeed(new Map<TK, TD>()) : recordToMap(src, factory);\r\n}\r\n\r\n/**\r\n * Applies a factory method to convert a `ReadonlyMap<TK, TS>` into a `Record<TK, TD>`.\r\n * @param src - The `Map` object to be converted.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting `Record<TK, TD>` if conversion succeeds, or\r\n * {@link Failure} with an error message if an error occurs.\r\n * @public\r\n */\r\nexport function mapToRecord<TS, TD, TK extends string = string>(\r\n  src: ReadonlyMap<TK, TS>,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Record<TK, TD>> {\r\n  const record: Record<TK, TD> = {} as Record<TK, TD>;\r\n  for (const kvp of src) {\r\n    if (kvp[1] !== undefined) {\r\n      const itemResult = factory(kvp[0], kvp[1]);\r\n      if (itemResult.isSuccess()) {\r\n        record[kvp[0]] = itemResult.value;\r\n      } else {\r\n        return fail(`${kvp[0]}: ${itemResult.message}`);\r\n      }\r\n    }\r\n  }\r\n  return succeed(record);\r\n}\r\n\r\n/**\r\n * Applies a factory method to convert an optional `ReadonlyMap<string, TS>` into a `Record<string, TD>` or `undefined`.\r\n * @param src - The `Map` object to be converted, or `undefined`.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting record if conversion succeeds, or {@link Success} with `undefined` if\r\n * `src` is `undefined`. Returns {@link Failure} with a message if an error occurs.\r\n * @public\r\n */\r\nexport function optionalMapToRecord<TS, TD, TK extends string = string>(\r\n  src: ReadonlyMap<TK, TS> | undefined,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Record<TK, TD> | undefined> {\r\n  return src === undefined ? succeed(undefined) : mapToRecord(src, factory);\r\n}\r\n\r\n/**\r\n * Applies a factory method to convert an optional `ReadonlyMap<string, TS>` into a `Record<string, TD>`\r\n * @param src - The `ReadonlyMap` object to be converted, or `undefined`.\r\n * @param factory - The factory method used to convert elements.\r\n * @returns {@link Success} with the resulting record (empty if `src` is `undefined`) if conversion succeeds.\r\n * Returns {@link Failure} with a message if an error occurs.\r\n * @public\r\n */\r\nexport function optionalMapToPossiblyEmptyRecord<TS, TD, TK extends string = string>(\r\n  src: ReadonlyMap<TK, TS> | undefined,\r\n  factory: KeyedThingFactory<TS, TD, TK>\r\n): Result<Record<TK, TD>> {\r\n  return src === undefined ? succeed({} as Record<TK, TD>) : mapToRecord(src, factory);\r\n}\r\n"]}

package/lib/packlets/collections/collector.d.ts

@@ -69,7 +69,7 @@ export declare class Collector<TITEM extends ICollectible<any, any>> implements
     /**
      * {@inheritdoc Collections.ResultMap.entries}
      */
-    entries(): MapIterator<KeyValueEntry<CollectibleKey<TITEM>, TITEM>>;
+    entries(): IterableIterator<KeyValueEntry<CollectibleKey<TITEM>, TITEM>>;
     /**
      * {@inheritdoc Collections.ResultMap.forEach}
      */

package/lib/packlets/collections/collector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collector.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/collector.ts"],"names":[],"mappings":"AAsBA,OAAO,EAEL,cAAc,EAEd,MAAM,EAIP,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,0BAA0B,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAEpG;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,GAAG,eAAe,CAAC;AAE5E;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAEjC,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CACpC,SAAQ,kBAAkB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACxD;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B,CAE1C,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC;IAEpC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,qBAAa,SAAS,CAEpB,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CACpC,YAAW,kBAAkB,CAAC,KAAK,CAAC;IAEpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoC;IAC3D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;;OAIG;gBACgB,MAAM,CAAC,EAAE,2BAA2B,CAAC,KAAK,CAAC;IAQ9D;;;;;;OAMG;WACW,eAAe,CAE3B,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EACpC,MAAM,CAAC,EAAE,2BAA2B,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAIxE;;;;;;;OAOG;IACI,GAAG,CAAC,IAAI,EAAE,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAkBrE;;OAEG;IACI,OAAO,IAAI,WAAW,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IAI1E;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,kBAAkB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,EAAE,OAAO,GAAG,IAAI;IAM/F;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAKpF;;OAEG;IACI,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;IAO1C;;;;;;;;OAQG;IACI,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAE1E;;;;;;;;;OASG;IACI,QAAQ,CACb,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,EAC1B,OAAO,EAAE,0BAA0B,CAAC,KAAK,CAAC,GACzC,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IA6B/C;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,OAAO;IAI/C;;OAEG;IACI,IAAI,IAAI,gBAAgB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAItD;;OAEG;IACI,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC;IAIxC;;OAEG;IACI,UAAU,IAAI,kBAAkB,CAAC,KAAK,CAAC;IAI9C;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IAIzF,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,SAAS,IAAI,KAAK;CAGhF"}
+{"version":3,"file":"collector.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/collector.ts"],"names":[],"mappings":"AAsBA,OAAO,EAEL,cAAc,EAEd,MAAM,EAIP,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,0BAA0B,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAEpG;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,GAAG,eAAe,CAAC;AAE5E;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAEjC,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CACpC,SAAQ,kBAAkB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACxD;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B,CAE1C,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC;IAEpC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,qBAAa,SAAS,CAEpB,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CACpC,YAAW,kBAAkB,CAAC,KAAK,CAAC;IAEpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoC;IAC3D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;;OAIG;gBACgB,MAAM,CAAC,EAAE,2BAA2B,CAAC,KAAK,CAAC;IAQ9D;;;;;;OAMG;WACW,eAAe,CAE3B,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EACpC,MAAM,CAAC,EAAE,2BAA2B,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAIxE;;;;;;;OAOG;IACI,GAAG,CAAC,IAAI,EAAE,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAkBrE;;OAEG;IACI,OAAO,IAAI,gBAAgB,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IAI/E;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,kBAAkB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,EAAE,OAAO,GAAG,IAAI;IAM/F;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAKpF;;OAEG;IACI,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;IAO1C;;;;;;;;OAQG;IACI,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAE1E;;;;;;;;;OASG;IACI,QAAQ,CACb,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,EAC1B,OAAO,EAAE,0BAA0B,CAAC,KAAK,CAAC,GACzC,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IA6B/C;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,OAAO;IAI/C;;OAEG;IACI,IAAI,IAAI,gBAAgB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAItD;;OAEG;IACI,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC;IAIxC;;OAEG;IACI,UAAU,IAAI,kBAAkB,CAAC,KAAK,CAAC;IAI9C;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IAIzF,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,SAAS,IAAI,KAAK;CAGhF"}

package/lib/packlets/collections/collector.js.map

@@ -1 +1 @@
-{"version":3,"file":"collector.js","sourceRoot":"","sources":["../../../src/packlets/collections/collector.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAQiB;AAuCjB;;;;;;;;GAQG;AACH,MAAa,SAAS;IAQpB;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,YAAmB,MAA2C;;QAC5D,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAgC,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,IAAI,IAAI,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,mCAAI,EAAE,EAAE,CAAC;YACvC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,eAAe,CAG3B,MAA2C;QAC3C,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACI,GAAG,CAAC,IAAW;QACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtB,OAAO,IAAA,wBAAiB,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC3C,CAAC;aAAM,IAAI,QAAQ,EAAE,CAAC;YACpB,OAAO,IAAA,qBAAc,EAAC,GAAG,IAAI,CAAC,GAAG,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;YAC5B,OAAO,IAAA,qBAAc,EAAC,GAAG,IAAI,CAAC,GAAG,KAAK,WAAW,CAAC,OAAO,EAAE,EAAE,eAAe,CAAC,CAAC;QAChF,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC/C,OAAO,IAAA,qBAAc,EAAC,GAAG,IAAI,CAAC,GAAG,qCAAqC,IAAI,CAAC,KAAK,EAAE,EAAE,eAAe,CAAC,CAAC;QACvG,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzB,OAAO,IAAA,wBAAiB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,QAA0D,EAAE,GAAa;QACtF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YACjD,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAA0B;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAA,wBAAiB,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAA,qBAAc,EAAC,GAAG,GAAG,aAAa,EAAE,WAAW,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAa;QACxB,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC/C,OAAO,IAAA,WAAI,EAAC,GAAG,KAAK,iBAAiB,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACvC,CAAC;IA4BM,QAAQ,CACb,SAAwC,EACxC,OAA2C;QAE3C,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;QACjE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,IAAA,wBAAiB,EAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;YACzC,CAAC,CAAC,OAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC3C,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC;QACvB,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;YAC3B,OAAO,IAAA,qBAAc,EAAC,GAAG,GAAG,KAAK,UAAU,CAAC,OAAO,EAAE,EAAE,eAAe,CAAC,CAAC;QAC1E,CAAC;QACD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC;QAE9B,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;YACrB,OAAO,IAAA,qBAAc,EAAC,GAAG,GAAG,mCAAmC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;QACvF,CAAC;QAED,OAAO,UAAU,CAAC,iBAAiB,CAAwB,eAAe,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YAC7F,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAA0B;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,IAAI;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACxC,CAAC;IAES,OAAO,CAAC,SAAwC;QACxD,OAAO,OAAO,SAAS,KAAK,QAAQ,CAAC;IACvC,CAAC;CACF;AAlMD,8BAkMC","sourcesContent":["/*\n * Copyright (c) 2025 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 {\n  captureResult,\n  DetailedResult,\n  failWithDetail,\n  Result,\n  fail,\n  succeed,\n  succeedWithDetail\n} from '../base';\nimport { CollectibleFactoryCallback, CollectibleKey, ICollectible } from './collectible';\nimport { KeyValueEntry } from './common';\nimport { IReadOnlyResultMap, ResultMapForEachCb, ResultMapResultDetail } from './readonlyResultMap';\n\n/**\n * Additional success or failure details for mutating collector calls.\n * @public\n */\nexport type CollectorResultDetail = ResultMapResultDetail | 'invalid-index';\n\n/**\n * A read-only interface exposing only the non-mutating methods of a {@link Collections.Collector | ICollector}.\n * @public\n */\nexport interface IReadOnlyCollector<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  TITEM extends ICollectible<any, any>\n> extends IReadOnlyResultMap<CollectibleKey<TITEM>, TITEM> {\n  /**\n   * Gets the item at a specified index.\n   * @param index - The index of the item to retrieve.\n   * @returns Returns {@link Success | Success} with the item if it exists, or {@link Failure | Failure}\n   * with an error if the index is out of range.\n   */\n  getAt(index: number): Result<TITEM>;\n}\n\n/**\n * Parameters for constructing a {@link Collections.Collector | ICollector}.\n * @public\n */\nexport interface ICollectorConstructorParams<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  TITEM extends ICollectible<any, any>\n> {\n  items?: TITEM[];\n}\n\n/**\n * A {@link Collections.Collector | Collector} that is a specialized collection\n * which contains items of type {@link Collections.ICollectible | ICollectible},\n * which have a unique key and a write-once index.\n *\n * Items are assigned an index sequentially as they are added to the collection.\n * Once added, items are immutable - they cannot be removed or replaced.\n * @public\n */\nexport class Collector<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  TITEM extends ICollectible<any, any>\n> implements IReadOnlyCollector<TITEM>\n{\n  private readonly _byKey: Map<CollectibleKey<TITEM>, TITEM>;\n  private readonly _byIndex: TITEM[];\n\n  /**\n   * {@inheritdoc Collections.ResultMap.size}\n   */\n  public get size(): number {\n    return this._byIndex.length;\n  }\n\n  /**\n   * Constructs a new {@link Collections.Collector | Collector}.\n   * @param params - Optional {@link Collections.ICollectorConstructorParams | initialization parameters} used\n   * to construct the collector.\n   */\n  public constructor(params?: ICollectorConstructorParams<TITEM>) {\n    this._byKey = new Map<CollectibleKey<TITEM>, TITEM>();\n    this._byIndex = [];\n    for (const item of params?.items ?? []) {\n      this.add(item).orThrow();\n    }\n  }\n\n  /**\n   * Creates a new {@link Collections.Collector | Collector} instance.\n   * @param params - Optional {@link Collections.ICollectorConstructorParams | initialization parameters} used\n   * to create the collector.\n   * @returns Returns {@link Success | Success} with the new collector if it was created successfully,\n   * or {@link Failure | Failure} with an error if the collector could not be created.\n   */\n  public static createCollector<\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    TITEM extends ICollectible<any, any>\n  >(params?: ICollectorConstructorParams<TITEM>): Result<Collector<TITEM>> {\n    return captureResult(() => new Collector(params));\n  }\n\n  /**\n   * Adds an item to the collection, failing if a different item with the same key already exists. Note\n   * that adding an object that is already in the collection again will succeed without updating the collection.\n   * @param item - The item to add.\n   * @returns Returns {@link DetailedSuccess | Success} with the item and detail `added` if it was added\n   * or detail `exists` if the item was already in the map.  Returns {@link DetailedFailure | Failure} with\n   * an error message and appropriate detail if the item could not be added.\n   */\n  public add(item: TITEM): DetailedResult<TITEM, CollectorResultDetail> {\n    const existing = this._byKey.get(item.key);\n    if (existing === item) {\n      return succeedWithDetail(item, 'exists');\n    } else if (existing) {\n      return failWithDetail(`${item.key}: already exists`, 'exists');\n    }\n    const indexResult = item.setIndex(this._byIndex.length);\n    if (indexResult.isFailure()) {\n      return failWithDetail(`${item.key}: ${indexResult.message}`, 'invalid-index');\n    } else if (item.index !== this._byIndex.length) {\n      return failWithDetail(`${item.key}: index mismatch - built item has ${item.index}`, 'invalid-index');\n    }\n    this._byKey.set(item.key, item);\n    this._byIndex.push(item);\n    return succeedWithDetail(item, 'added');\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.entries}\n   */\n  public entries(): MapIterator<KeyValueEntry<CollectibleKey<TITEM>, TITEM>> {\n    return this._byKey.entries();\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.forEach}\n   */\n  public forEach(callback: ResultMapForEachCb<CollectibleKey<TITEM>, TITEM>, arg?: unknown): void {\n    for (const [key, value] of this._byKey.entries()) {\n      callback(value, key, this, arg);\n    }\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.get}\n   */\n  public get(key: CollectibleKey<TITEM>): DetailedResult<TITEM, ResultMapResultDetail> {\n    const item = this._byKey.get(key);\n    return item ? succeedWithDetail(item, 'exists') : failWithDetail(`${key}: not found`, 'not-found');\n  }\n\n  /**\n   * {@inheritdoc Collections.IReadOnlyCollector.getAt}\n   */\n  public getAt(index: number): Result<TITEM> {\n    if (index < 0 || index >= this._byIndex.length) {\n      return fail(`${index}: out of range.`);\n    }\n    return succeed(this._byIndex[index]);\n  }\n\n  /**\n   * Gets an existing item with a key matching that of a supplied item, or adds the supplied\n   * item to the collector if no item with that key exists.\n   * @param item - The item to get or add.\n   * @returns Returns {@link DetailedSuccess | Success} with the item stored in the collector -\n   * detail `exists` indicates that an existing item return and detail `added` indicates that the\n   * item was added. Returns {@link DetailedFailure | Failure} with an error and appropriate\n   * detail if the item could not be added.\n   */\n  public getOrAdd(item: TITEM): DetailedResult<TITEM, CollectorResultDetail>;\n\n  /**\n   * Gets an existing item with a key matching the supplied key, or adds a new item to the collector\n   * using a factory callback if no item with that key exists.\n   * @param key - The key of the item to add.\n   * @param callback - The factory callback to create the item.\n   * @returns Returns {@link DetailedSuccess | Success} with the item stored in the collector -\n   * detail `exists` indicates that an existing item return and detail `added` indicates that the\n   * item was added. Returns {@link DetailedFailure | Failure} with an error and appropriate\n   * detail if the item could not be added.\n   */\n  public getOrAdd(\n    key: CollectibleKey<TITEM>,\n    factory: CollectibleFactoryCallback<TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail>;\n\n  public getOrAdd(\n    keyOrItem: CollectibleKey<TITEM> | TITEM,\n    factory?: CollectibleFactoryCallback<TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail> {\n    const key = !this._isItem(keyOrItem) ? keyOrItem : keyOrItem.key;\n    const existing = this._byKey.get(key);\n    if (existing) {\n      return succeedWithDetail(existing, 'exists');\n    }\n\n    const itemResult = !this._isItem(keyOrItem)\n      ? factory!(keyOrItem, this._byIndex.length)\n      : succeed(keyOrItem);\n    if (itemResult.isFailure()) {\n      return failWithDetail(`${key}: ${itemResult.message}`, 'invalid-value');\n    }\n    const item = itemResult.value;\n\n    if (item.key !== key) {\n      return failWithDetail(`${key}: key mismatch - built item has ${key}`, 'invalid-key');\n    }\n\n    return itemResult.withFailureDetail<CollectorResultDetail>('invalid-index').onSuccess((item) => {\n      return this.add(item);\n    });\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.has}\n   */\n  public has(key: CollectibleKey<TITEM>): boolean {\n    return this._byKey.has(key);\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.keys}\n   */\n  public keys(): IterableIterator<CollectibleKey<TITEM>> {\n    return this._byKey.keys();\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.values}\n   */\n  public values(): IterableIterator<TITEM> {\n    return this._byKey.values();\n  }\n\n  /**\n   * Gets a read-only version of this collector.\n   */\n  public toReadOnly(): IReadOnlyCollector<TITEM> {\n    return this;\n  }\n\n  /**\n   * Gets an iterator over the map entries.\n   * @returns An iterator over the map entries.\n   */\n  public [Symbol.iterator](): IterableIterator<KeyValueEntry<CollectibleKey<TITEM>, TITEM>> {\n    return this._byKey[Symbol.iterator]();\n  }\n\n  protected _isItem(keyOrItem: CollectibleKey<TITEM> | TITEM): keyOrItem is TITEM {\n    return typeof keyOrItem !== 'string';\n  }\n}\n"]}
+{"version":3,"file":"collector.js","sourceRoot":"","sources":["../../../src/packlets/collections/collector.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAQiB;AAuCjB;;;;;;;;GAQG;AACH,MAAa,SAAS;IAQpB;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,YAAmB,MAA2C;;QAC5D,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAgC,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,IAAI,IAAI,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,mCAAI,EAAE,EAAE,CAAC;YACvC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,eAAe,CAG3B,MAA2C;QAC3C,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACI,GAAG,CAAC,IAAW;QACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtB,OAAO,IAAA,wBAAiB,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC3C,CAAC;aAAM,IAAI,QAAQ,EAAE,CAAC;YACpB,OAAO,IAAA,qBAAc,EAAC,GAAG,IAAI,CAAC,GAAG,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;YAC5B,OAAO,IAAA,qBAAc,EAAC,GAAG,IAAI,CAAC,GAAG,KAAK,WAAW,CAAC,OAAO,EAAE,EAAE,eAAe,CAAC,CAAC;QAChF,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC/C,OAAO,IAAA,qBAAc,EAAC,GAAG,IAAI,CAAC,GAAG,qCAAqC,IAAI,CAAC,KAAK,EAAE,EAAE,eAAe,CAAC,CAAC;QACvG,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzB,OAAO,IAAA,wBAAiB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,QAA0D,EAAE,GAAa;QACtF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YACjD,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAA0B;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAA,wBAAiB,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAA,qBAAc,EAAC,GAAG,GAAG,aAAa,EAAE,WAAW,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAa;QACxB,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC/C,OAAO,IAAA,WAAI,EAAC,GAAG,KAAK,iBAAiB,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACvC,CAAC;IA4BM,QAAQ,CACb,SAAwC,EACxC,OAA2C;QAE3C,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;QACjE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,IAAA,wBAAiB,EAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;YACzC,CAAC,CAAC,OAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC3C,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC;QACvB,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;YAC3B,OAAO,IAAA,qBAAc,EAAC,GAAG,GAAG,KAAK,UAAU,CAAC,OAAO,EAAE,EAAE,eAAe,CAAC,CAAC;QAC1E,CAAC;QACD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC;QAE9B,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;YACrB,OAAO,IAAA,qBAAc,EAAC,GAAG,GAAG,mCAAmC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;QACvF,CAAC;QAED,OAAO,UAAU,CAAC,iBAAiB,CAAwB,eAAe,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YAC7F,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAA0B;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,IAAI;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACxC,CAAC;IAES,OAAO,CAAC,SAAwC;QACxD,OAAO,OAAO,SAAS,KAAK,QAAQ,CAAC;IACvC,CAAC;CACF;AAlMD,8BAkMC","sourcesContent":["/*\n * Copyright (c) 2025 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 {\n  captureResult,\n  DetailedResult,\n  failWithDetail,\n  Result,\n  fail,\n  succeed,\n  succeedWithDetail\n} from '../base';\nimport { CollectibleFactoryCallback, CollectibleKey, ICollectible } from './collectible';\nimport { KeyValueEntry } from './common';\nimport { IReadOnlyResultMap, ResultMapForEachCb, ResultMapResultDetail } from './readonlyResultMap';\n\n/**\n * Additional success or failure details for mutating collector calls.\n * @public\n */\nexport type CollectorResultDetail = ResultMapResultDetail | 'invalid-index';\n\n/**\n * A read-only interface exposing only the non-mutating methods of a {@link Collections.Collector | ICollector}.\n * @public\n */\nexport interface IReadOnlyCollector<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  TITEM extends ICollectible<any, any>\n> extends IReadOnlyResultMap<CollectibleKey<TITEM>, TITEM> {\n  /**\n   * Gets the item at a specified index.\n   * @param index - The index of the item to retrieve.\n   * @returns Returns {@link Success | Success} with the item if it exists, or {@link Failure | Failure}\n   * with an error if the index is out of range.\n   */\n  getAt(index: number): Result<TITEM>;\n}\n\n/**\n * Parameters for constructing a {@link Collections.Collector | ICollector}.\n * @public\n */\nexport interface ICollectorConstructorParams<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  TITEM extends ICollectible<any, any>\n> {\n  items?: TITEM[];\n}\n\n/**\n * A {@link Collections.Collector | Collector} that is a specialized collection\n * which contains items of type {@link Collections.ICollectible | ICollectible},\n * which have a unique key and a write-once index.\n *\n * Items are assigned an index sequentially as they are added to the collection.\n * Once added, items are immutable - they cannot be removed or replaced.\n * @public\n */\nexport class Collector<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  TITEM extends ICollectible<any, any>\n> implements IReadOnlyCollector<TITEM>\n{\n  private readonly _byKey: Map<CollectibleKey<TITEM>, TITEM>;\n  private readonly _byIndex: TITEM[];\n\n  /**\n   * {@inheritdoc Collections.ResultMap.size}\n   */\n  public get size(): number {\n    return this._byIndex.length;\n  }\n\n  /**\n   * Constructs a new {@link Collections.Collector | Collector}.\n   * @param params - Optional {@link Collections.ICollectorConstructorParams | initialization parameters} used\n   * to construct the collector.\n   */\n  public constructor(params?: ICollectorConstructorParams<TITEM>) {\n    this._byKey = new Map<CollectibleKey<TITEM>, TITEM>();\n    this._byIndex = [];\n    for (const item of params?.items ?? []) {\n      this.add(item).orThrow();\n    }\n  }\n\n  /**\n   * Creates a new {@link Collections.Collector | Collector} instance.\n   * @param params - Optional {@link Collections.ICollectorConstructorParams | initialization parameters} used\n   * to create the collector.\n   * @returns Returns {@link Success | Success} with the new collector if it was created successfully,\n   * or {@link Failure | Failure} with an error if the collector could not be created.\n   */\n  public static createCollector<\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    TITEM extends ICollectible<any, any>\n  >(params?: ICollectorConstructorParams<TITEM>): Result<Collector<TITEM>> {\n    return captureResult(() => new Collector(params));\n  }\n\n  /**\n   * Adds an item to the collection, failing if a different item with the same key already exists. Note\n   * that adding an object that is already in the collection again will succeed without updating the collection.\n   * @param item - The item to add.\n   * @returns Returns {@link DetailedSuccess | Success} with the item and detail `added` if it was added\n   * or detail `exists` if the item was already in the map.  Returns {@link DetailedFailure | Failure} with\n   * an error message and appropriate detail if the item could not be added.\n   */\n  public add(item: TITEM): DetailedResult<TITEM, CollectorResultDetail> {\n    const existing = this._byKey.get(item.key);\n    if (existing === item) {\n      return succeedWithDetail(item, 'exists');\n    } else if (existing) {\n      return failWithDetail(`${item.key}: already exists`, 'exists');\n    }\n    const indexResult = item.setIndex(this._byIndex.length);\n    if (indexResult.isFailure()) {\n      return failWithDetail(`${item.key}: ${indexResult.message}`, 'invalid-index');\n    } else if (item.index !== this._byIndex.length) {\n      return failWithDetail(`${item.key}: index mismatch - built item has ${item.index}`, 'invalid-index');\n    }\n    this._byKey.set(item.key, item);\n    this._byIndex.push(item);\n    return succeedWithDetail(item, 'added');\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.entries}\n   */\n  public entries(): IterableIterator<KeyValueEntry<CollectibleKey<TITEM>, TITEM>> {\n    return this._byKey.entries();\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.forEach}\n   */\n  public forEach(callback: ResultMapForEachCb<CollectibleKey<TITEM>, TITEM>, arg?: unknown): void {\n    for (const [key, value] of this._byKey.entries()) {\n      callback(value, key, this, arg);\n    }\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.get}\n   */\n  public get(key: CollectibleKey<TITEM>): DetailedResult<TITEM, ResultMapResultDetail> {\n    const item = this._byKey.get(key);\n    return item ? succeedWithDetail(item, 'exists') : failWithDetail(`${key}: not found`, 'not-found');\n  }\n\n  /**\n   * {@inheritdoc Collections.IReadOnlyCollector.getAt}\n   */\n  public getAt(index: number): Result<TITEM> {\n    if (index < 0 || index >= this._byIndex.length) {\n      return fail(`${index}: out of range.`);\n    }\n    return succeed(this._byIndex[index]);\n  }\n\n  /**\n   * Gets an existing item with a key matching that of a supplied item, or adds the supplied\n   * item to the collector if no item with that key exists.\n   * @param item - The item to get or add.\n   * @returns Returns {@link DetailedSuccess | Success} with the item stored in the collector -\n   * detail `exists` indicates that an existing item return and detail `added` indicates that the\n   * item was added. Returns {@link DetailedFailure | Failure} with an error and appropriate\n   * detail if the item could not be added.\n   */\n  public getOrAdd(item: TITEM): DetailedResult<TITEM, CollectorResultDetail>;\n\n  /**\n   * Gets an existing item with a key matching the supplied key, or adds a new item to the collector\n   * using a factory callback if no item with that key exists.\n   * @param key - The key of the item to add.\n   * @param callback - The factory callback to create the item.\n   * @returns Returns {@link DetailedSuccess | Success} with the item stored in the collector -\n   * detail `exists` indicates that an existing item return and detail `added` indicates that the\n   * item was added. Returns {@link DetailedFailure | Failure} with an error and appropriate\n   * detail if the item could not be added.\n   */\n  public getOrAdd(\n    key: CollectibleKey<TITEM>,\n    factory: CollectibleFactoryCallback<TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail>;\n\n  public getOrAdd(\n    keyOrItem: CollectibleKey<TITEM> | TITEM,\n    factory?: CollectibleFactoryCallback<TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail> {\n    const key = !this._isItem(keyOrItem) ? keyOrItem : keyOrItem.key;\n    const existing = this._byKey.get(key);\n    if (existing) {\n      return succeedWithDetail(existing, 'exists');\n    }\n\n    const itemResult = !this._isItem(keyOrItem)\n      ? factory!(keyOrItem, this._byIndex.length)\n      : succeed(keyOrItem);\n    if (itemResult.isFailure()) {\n      return failWithDetail(`${key}: ${itemResult.message}`, 'invalid-value');\n    }\n    const item = itemResult.value;\n\n    if (item.key !== key) {\n      return failWithDetail(`${key}: key mismatch - built item has ${key}`, 'invalid-key');\n    }\n\n    return itemResult.withFailureDetail<CollectorResultDetail>('invalid-index').onSuccess((item) => {\n      return this.add(item);\n    });\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.has}\n   */\n  public has(key: CollectibleKey<TITEM>): boolean {\n    return this._byKey.has(key);\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.keys}\n   */\n  public keys(): IterableIterator<CollectibleKey<TITEM>> {\n    return this._byKey.keys();\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.values}\n   */\n  public values(): IterableIterator<TITEM> {\n    return this._byKey.values();\n  }\n\n  /**\n   * Gets a read-only version of this collector.\n   */\n  public toReadOnly(): IReadOnlyCollector<TITEM> {\n    return this;\n  }\n\n  /**\n   * Gets an iterator over the map entries.\n   * @returns An iterator over the map entries.\n   */\n  public [Symbol.iterator](): IterableIterator<KeyValueEntry<CollectibleKey<TITEM>, TITEM>> {\n    return this._byKey[Symbol.iterator]();\n  }\n\n  protected _isItem(keyOrItem: CollectibleKey<TITEM> | TITEM): keyOrItem is TITEM {\n    return typeof keyOrItem !== 'string';\n  }\n}\n"]}