@fgv/ts-utils 4.6.0 → 5.0.0-10

package/lib/packlets/base/result.js

@@ -23,9 +23,14 @@
 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.useOrInitialize = useOrInitialize;
 exports.succeedWithDetail = succeedWithDetail;
+exports.succeedsWithDetail = succeedsWithDetail;
 exports.failWithDetail = failWithDetail;
+exports.failsWithDetail = failsWithDetail;
 exports.propagateWithDetail = propagateWithDetail;
 exports.captureResult = captureResult;
 /**
@@ -67,9 +72,6 @@ class Success {
     isFailure() {
         return false;
     }
-    /**
-     * {@inheritdoc IResult.orThrow}
-     */
     orThrow(__logger) {
         return this._value;
     }
@@ -79,7 +81,7 @@ class Success {
     }
     /**
      * {@inheritdoc IResult.getValueOrThrow}
-     * @deprecated Use {@link Success.orThrow | orThrow} instead.
+     * @deprecated Use {@link Success.(orThrow:1) | orThrow(logger)} or {@link Success.(orThrow:2) | orThrow(formatter)} instead.
      */
     getValueOrThrow(__logger) {
         return this._value;
@@ -96,7 +98,7 @@ class Success {
      * {@inheritdoc IResult.onSuccess}
      */
     onSuccess(cb) {
-        return cb(this.value);
+        return cb(this._value);
     }
     /**
      * {@inheritdoc IResult.onFailure}
@@ -114,20 +116,29 @@ class Success {
      * {@inheritdoc IResult.withFailureDetail}
      */
     withFailureDetail(__detail) {
-        return succeedWithDetail(this.value);
+        return succeedWithDetail(this._value);
     }
     /**
      * {@inheritdoc IResult.withDetail}
      */
     withDetail(detail, successDetail) {
-        return succeedWithDetail(this.value, successDetail !== null && successDetail !== void 0 ? successDetail : detail);
+        return succeedWithDetail(this._value, successDetail !== null && successDetail !== void 0 ? successDetail : detail);
     }
     /**
      * {@inheritdoc IResult.aggregateError}
      */
-    aggregateError(errors) {
+    aggregateError(__errors) {
         return this;
     }
+    /**
+     * Creates a {@link Success | Success<T>} with the supplied value.
+     * @param value - The value to be returned.
+     * @returns The resulting {@link Success | Success<T>} with the supplied value.
+     * @public
+     */
+    static with(value) {
+        return new Success(value);
+    }
 }
 exports.Success = Success;
 /**
@@ -168,12 +179,14 @@ class Failure {
     isFailure() {
         return true;
     }
-    /**
-     * {@inheritdoc IResult.orThrow}
-     */
-    orThrow(logger) {
-        if (logger !== undefined) {
-            logger.error(this._message);
+    orThrow(logOrFormat) {
+        if (logOrFormat !== undefined) {
+            if (typeof logOrFormat === 'function') {
+                throw new Error(logOrFormat(this._message));
+            }
+            else {
+                logOrFormat.error(this._message);
+            }
         }
         throw new Error(this._message);
     }
@@ -182,7 +195,7 @@ class Failure {
     }
     /**
      * {@inheritdoc IResult.getValueOrThrow}
-     * @deprecated Use {@link Failure.orThrow | orThrow} instead.
+     * @deprecated Use {@link Failure.(orThrow:1) | orThrow(logger)} or {@link Failure.(orThrow:2) | orThrow(formatter)} instead.
      */
     getValueOrThrow(logger) {
         if (logger !== undefined) {
@@ -201,37 +214,37 @@ class Failure {
      * {@inheritdoc IResult.onSuccess}
      */
     onSuccess(__) {
-        return new Failure(this.message);
+        return new Failure(this._message);
     }
     /**
      * {@inheritdoc IResult.onFailure}
      */
     onFailure(cb) {
-        return cb(this.message);
+        return cb(this._message);
     }
     /**
      * {@inheritdoc IResult.withErrorFormat}
      */
     withErrorFormat(cb) {
-        return fail(cb(this.message));
+        return fail(cb(this._message));
     }
     /**
      * {@inheritdoc IResult.withFailureDetail}
      */
     withFailureDetail(detail) {
-        return failWithDetail(this.message, detail);
+        return failWithDetail(this._message, detail);
     }
     /**
      * {@inheritdoc IResult.withDetail}
      */
     withDetail(detail, __successDetail) {
-        return failWithDetail(this.message, detail);
+        return failWithDetail(this._message, detail);
     }
     /**
      * {@inheritdoc IResult.aggregateError}
      */
     aggregateError(errors) {
-        errors.addMessage(this.message);
+        errors.addMessage(this._message);
         return this;
     }
     /**
@@ -241,29 +254,68 @@ class Failure {
      * @returns A string representing this object.
      */
     toString() {
-        return this.message;
+        return this._message;
+    }
+    /**
+     * Creates a {@link Failure | Failure<T>} with the supplied error message.
+     * @param message - The error message to be returned.
+     * @returns The resulting {@link Failure | Failure<T>} with the supplied error message.
+     */
+    static with(message) {
+        return new Failure(message);
     }
 }
 exports.Failure = Failure;
 /**
  * Returns {@link Success | Success<T>} with the supplied result value.
  * @param value - The successful result value to be returned
+ * @remarks
+ * A `succeeds` alias was added in release 5.0 for
+ * naming consistency with {@link fails | fails}, which was added
+ * to avoid conflicts with test frameworks and libraries.
  * @public
  */
 function succeed(value) {
     return new Success(value);
 }
+/**
+ * {@inheritdoc succeed}
+ * @public
+ */
+function succeeds(value) {
+    return new Success(value);
+}
 /**
  * Returns {@link Failure | Failure<T>} with the supplied error message.
  * @param message - Error message to be returned.
+ * @remarks
+ * A `fails` alias was added in release 5.0 due to
+ * issues with the name `fail` being used test frameworks and libraries.
  * @public
  */
 function fail(message) {
     return new Failure(message);
 }
 /**
- * A {@link DetailedSuccess} extends {@link Success} to report optional success details in
- * addition to the error message.
+ * {@inheritdoc fail}
+ * @public
+ */
+function fails(message) {
+    return new Failure(message);
+}
+/**
+ * Uses a value or calls a supplied initializer if the supplied value is undefined.
+ * @param value - the value
+ * @param initializer - a function that initializes the value if it is undefined
+ * @returns `Success` with the value if it is defined, or the result of calling the initializer function.
+ * @public
+ */
+function useOrInitialize(value, initializer) {
+    return value !== undefined ? succeed(value) : initializer();
+}
+/**
+ * A {@link DetailedSuccess | DetailedSuccess} extends {@link Success | Success} to report optional success
+ * details in addition to the error message.
  * @public
  */
 class DetailedSuccess extends Success {
@@ -305,7 +357,7 @@ class DetailedSuccess extends Success {
      * @returns The {@link DetailedResult | DetailedResult<T, TD>} returned by the success callback.
      */
     onSuccess(cb) {
-        return cb(this.value, this._detail);
+        return cb(this._value, this._detail);
     }
     /**
      * Propagates this {@link DetailedSuccess}.
@@ -324,11 +376,24 @@ 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);
+    }
+    /**
+     * Returns this {@link DetailedSuccess} as a {@link Result}.
+     */
+    get asResult() {
+        return this;
+    }
 }
 exports.DetailedSuccess = DetailedSuccess;
 /**
- * A {@link DetailedFailure} extends {@link Failure} to report optional failure details in
- * addition to the error message.
+ * A {@link DetailedFailure | DetailedFailure<T, TD>} extends {@link Failure | Failure<T>} to report optional
+ * failure details in addition to the error message.
  * @public
  */
 class DetailedFailure extends Failure {
@@ -370,7 +435,7 @@ class DetailedFailure extends Failure {
      * the error message and detail from this one.
      */
     onSuccess(__cb) {
-        return new DetailedFailure(this.message, this._detail);
+        return new DetailedFailure(this._message, this._detail);
     }
     /**
      * Invokes the supplied {@link DetailedFailureContinuation | failure callback} and propagates
@@ -379,13 +444,42 @@ class DetailedFailure extends Failure {
      * @returns The {@link DetailedResult | DetailedResult<T, TD>} returned by the failure callback.
      */
     onFailure(cb) {
-        return cb(this.message, this._detail);
+        return cb(this._message, this._detail);
     }
     /**
      * {@inheritdoc IResult.withErrorFormat}
      */
     withErrorFormat(cb) {
-        return failWithDetail(cb(this.message, this._detail), this._detail);
+        return failWithDetail(cb(this._message, this._detail), this._detail);
+    }
+    orThrow(logOrFormat) {
+        if (logOrFormat !== undefined) {
+            if (typeof logOrFormat === 'function') {
+                throw new Error(logOrFormat(this._message, this._detail));
+            }
+            else {
+                logOrFormat.error(this._message, this._detail);
+            }
+        }
+        throw new Error(this._message);
+    }
+    /**
+     * Returns this {@link DetailedFailure} as a {@link Result}.
+     */
+    get asResult() {
+        return this;
+    }
+    /**
+     * Creates a {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied error message
+     * and optional detail.
+     * @param message - The error message to be returned.
+     * @param detail - The error detail to be returned.
+     * @returns The resulting {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied
+     * error message and detail.
+     * @public
+     */
+    static with(message, detail) {
+        return new DetailedFailure(message, detail);
     }
 }
 exports.DetailedFailure = DetailedFailure;
@@ -396,22 +490,43 @@ exports.DetailedFailure = DetailedFailure;
  * @param detail - An optional detail of type `<TD>` to be returned.
  * @returns A {@link DetailedSuccess | DetailedSuccess<T, TD>} with the supplied value
  * and detail, if supplied.
+ * @remarks
+ * The `succeedsWithDetail` alias was added in release 5.0 for
+ * naming consistency with {@link fails | fails}, which was added to avoid conflicts
+ * with test frameworks and libraries.
  * @public
  */
 function succeedWithDetail(value, detail) {
     return new DetailedSuccess(value, detail);
 }
+/**
+ * {@inheritdoc succeedWithDetail}
+ * @public
+ */
+function succeedsWithDetail(value, detail) {
+    return new DetailedSuccess(value, detail);
+}
 /**
  * Returns {@link DetailedFailure | DetailedFailure<T, TD>} with a supplied error message and detail.
  * @param message - The error message to be returned.
  * @param detail - The event detail to be returned.
  * @returns An {@link DetailedFailure | DetailedFailure<T, TD>} with the supplied error
  * message and detail.
+ * @remarks
+ * The `failsWithDetail` alias was added in release 5.0 for naming consistency
+ * with {@link fails | fails}, which was added to avoid conflicts with test frameworks and libraries.
  * @public
  */
 function failWithDetail(message, detail) {
     return new DetailedFailure(message, detail);
 }
+/**
+ * {@inheritdoc failWithDetail}
+ * @public
+ */
+function failsWithDetail(message, detail) {
+    return new DetailedFailure(message, detail);
+}
 /**
  * Propagates a {@link Success} or {@link Failure} {@link Result}, adding supplied
  * event details as appropriate.

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"collectible.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/collectible.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAgC,MAAM,SAAS,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,aAAa,EAAc,MAAM,eAAe,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,YAAY,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM;IACxF,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IACnB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,YAAY,IAAI,KAAK,SAAS,YAAY,CAAC,MAAM,IAAI,CAAC,GAC3F,IAAI,GACJ,KAAK,CAAC;AAEV;;;GAGG;AAEH,MAAM,MAAM,gBAAgB,CAAC,KAAK,SAAS,YAAY,IAAI,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,MAAM,MAAM,CAAC,GACpG,MAAM,GACN,KAAK,CAAC;AAEV;;;;GAIG;AAEH,MAAM,MAAM,kBAAkB,CAAC,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,IAAI,IAAI,CAC3E,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,EAC1B,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,IAAI,KACP,MAAM,CAAC,KAAK,CAAC,CAAC;AAEnB;;;GAGG;AAEH,MAAM,MAAM,0BAA0B,CAAC,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAC7E,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,EAC1B,KAAK,EAAE,MAAM,KACV,MAAM,CAAC,KAAK,CAAC,CAAC;AAEnB;;;;GAIG;AACH,MAAM,WAAW,sCAAsC,CACrD,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,MAAM,SAAS,MAAM,GAAG,MAAM;IAE9B,GAAG,EAAE,IAAI,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,0CAA0C,CACzD,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,MAAM,SAAS,MAAM,GAAG,MAAM;IAE9B,GAAG,EAAE,IAAI,CAAC;IACV,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAC5G;AAED;;;GAGG;AACH,MAAM,MAAM,6BAA6B,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,IAClG,sCAAsC,CAAC,IAAI,EAAE,MAAM,CAAC,GACpD,0CAA0C,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAE7D;;;;GAIG;AACH,qBAAa,WAAW,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,CACnF,YAAW,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,SAAgB,GAAG,EAAE,IAAI,CAAC;IAE1B;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE7F;;;;;OAKG;gBACgB,MAAM,EAAE,sCAAsC,CAAC,IAAI,EAAE,MAAM,CAAC;IAE/E;;;;;OAKG;gBACgB,MAAM,EAAE,0CAA0C,CAAC,IAAI,EAAE,MAAM,CAAC;IAEnF;;;;OAIG;gBACgB,MAAM,EAAE,6BAA6B,CAAC,IAAI,EAAE,MAAM,CAAC;IAgBtE;;;;;OAKG;WACW,iBAAiB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,EAC1F,MAAM,EAAE,sCAAsC,CAAC,IAAI,EAAE,MAAM,CAAC,GAC3D,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAEpC;;;;;;OAMG;WACW,iBAAiB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,EAC1F,MAAM,EAAE,0CAA0C,CAAC,IAAI,EAAE,MAAM,CAAC,GAC/D,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAEpC;;;;;;OAMG;WACW,iBAAiB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,EAC1F,MAAM,EAAE,6BAA6B,CAAC,IAAI,EAAE,MAAM,CAAC,GAClD,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAQpC;;OAEG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;CAwB/C"}
+{"version":3,"file":"collectible.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/collectible.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAgC,MAAM,SAAS,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,aAAa,EAAc,MAAM,eAAe,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,YAAY,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM;IACxF,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IACnB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,YAAY,IAAI,KAAK,SAAS,YAAY,CAAC,MAAM,IAAI,CAAC,GAC3F,IAAI,GACJ,KAAK,CAAC;AAEV;;;GAGG;AAEH,MAAM,MAAM,gBAAgB,CAAC,KAAK,SAAS,YAAY,IAAI,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,MAAM,MAAM,CAAC,GACpG,MAAM,GACN,KAAK,CAAC;AAEV;;;;GAIG;AAEH,MAAM,MAAM,kBAAkB,CAAC,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,IAAI,IAAI,CAC3E,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,EAC1B,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,IAAI,KACP,MAAM,CAAC,KAAK,CAAC,CAAC;AAEnB;;;GAGG;AAEH,MAAM,MAAM,0BAA0B,CAAC,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAC7E,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,EAC1B,KAAK,EAAE,MAAM,KACV,MAAM,CAAC,KAAK,CAAC,CAAC;AAEnB;;;;GAIG;AACH,MAAM,WAAW,sCAAsC,CACrD,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,MAAM,SAAS,MAAM,GAAG,MAAM;IAE9B,GAAG,EAAE,IAAI,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,0CAA0C,CACzD,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,MAAM,SAAS,MAAM,GAAG,MAAM;IAE9B,GAAG,EAAE,IAAI,CAAC;IACV,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAC5G;AAED;;;GAGG;AACH,MAAM,MAAM,6BAA6B,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,IAClG,sCAAsC,CAAC,IAAI,EAAE,MAAM,CAAC,GACpD,0CAA0C,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAE7D;;;;GAIG;AACH,qBAAa,WAAW,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,CACnF,YAAW,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,SAAgB,GAAG,EAAE,IAAI,CAAC;IAE1B;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE7F;;;;;OAKG;gBACgB,MAAM,EAAE,sCAAsC,CAAC,IAAI,EAAE,MAAM,CAAC;IAE/E;;;;;OAKG;gBACgB,MAAM,EAAE,0CAA0C,CAAC,IAAI,EAAE,MAAM,CAAC;IAEnF;;;;OAIG;gBACgB,MAAM,EAAE,6BAA6B,CAAC,IAAI,EAAE,MAAM,CAAC;IAiBtE;;;;;OAKG;WACW,iBAAiB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,EAC1F,MAAM,EAAE,sCAAsC,CAAC,IAAI,EAAE,MAAM,CAAC,GAC3D,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAEpC;;;;;;OAMG;WACW,iBAAiB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,EAC1F,MAAM,EAAE,0CAA0C,CAAC,IAAI,EAAE,MAAM,CAAC,GAC/D,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAEpC;;;;;;OAMG;WACW,iBAAiB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,EAC1F,MAAM,EAAE,6BAA6B,CAAC,IAAI,EAAE,MAAM,CAAC,GAClD,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAQpC;;OAEG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;CAyB/C"}

package/lib/packlets/collections/collectible.js

@@ -48,6 +48,7 @@ class Collectible {
             }
         }
         else {
+            /* c8 ignore next 3 - coverage is having a bad day */
             this._index = params.index;
         }
     }
@@ -61,6 +62,7 @@ class Collectible {
         let converted;
         if (this._indexConverter) {
             const { value, message } = this._indexConverter.convert(index);
+            /* c8 ignore next 3 - there's a test for this but coverage is having a bad day */
             if (message) {
                 return (0, base_1.fail)(message);
             }

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

@@ -1 +1 @@
-{"version":3,"file":"collectible.js","sourceRoot":"","sources":["../../../src/packlets/collections/collectible.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAA+D;AAC/D,8CAAqE;AAuFrE;;;;GAIG;AACH,MAAa,WAAW;IAQtB;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IA2BD,YAAmB,MAAmD;QACpE,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QACtB,IAAI,gBAAgB,IAAI,MAAM,EAAE,CAAC;YAC/B,IAAI,CAAC,eAAe;gBAClB,OAAO,MAAM,CAAC,cAAc,KAAK,UAAU;oBACzC,CAAC,CAAC,uBAAU,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;oBAC3C,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC;YAC5B,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC/B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;YACrE,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC7B,CAAC;IACH,CAAC;IAkCM,MAAM,CAAC,iBAAiB,CAC7B,MAAmD;QAEnD,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,KAAa;QAC3B,IAAI,SAA6B,CAAC;QAClC,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC/D,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YACD,SAAS,GAAG,KAAK,CAAC;QACpB,CAAC;QAED,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO,IAAA,WAAI,EAAC,SAAS,IAAI,CAAC,KAAK,0CAA0C,KAAK,EAAE,CAAC,CAAC;QACpF,CAAC;QAED,6CAA6C;QAC7C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,IAAA,WAAI,EAAC,SAAS,KAAK,4DAA4D,CAAC,CAAC;QAC1F,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,OAAO,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;CACF;AAxHD,kCAwHC","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 { Result, captureResult, fail, succeed } from '../base';\nimport { Converter, ConverterFunc, Converters } from '../conversion';\nimport { Validator } from '../validation';\n\n/**\n * An item that can be collected by some {@link ConvertingCollector | Collector}.\n * @public\n */\nexport interface ICollectible<TKEY extends string = string, TINDEX extends number = number> {\n  readonly key: TKEY;\n  readonly index: TINDEX | undefined;\n  setIndex(index: number): Result<TINDEX>;\n}\n\n/**\n * Infer the key type from an {@link Collections.ICollectible | ICollectible} type.\n * @public\n */\nexport type CollectibleKey<TITEM extends ICollectible> = TITEM extends ICollectible<infer TKEY>\n  ? TKEY\n  : never;\n\n/**\n * Infer the index type from an {@link Collections.ICollectible | ICollectible} type.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type CollectibleIndex<TITEM extends ICollectible> = TITEM extends ICollectible<any, infer TINDEX>\n  ? TINDEX\n  : never;\n\n/**\n * Factory function for creating a new {@link Collections.ICollectible | ICollectible} instance given a key, an index and a source representation\n * of the item to be added.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type CollectibleFactory<TITEM extends ICollectible<any, any>, TSRC> = (\n  key: CollectibleKey<TITEM>,\n  index: number,\n  item: TSRC\n) => Result<TITEM>;\n\n/**\n * Factory function for creating a new {@link Collections.ICollectible | ICollectible} instance given a key and an index.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type CollectibleFactoryCallback<TITEM extends ICollectible<any, any>> = (\n  key: CollectibleKey<TITEM>,\n  index: number\n) => Result<TITEM>;\n\n/**\n * Parameters for constructing a new {@link Collections.ICollectible | ICollectible} instance with\n * a defined, strongly-typed index.\n * @public\n */\nexport interface ICollectibleConstructorParamsWithIndex<\n  TKEY extends string = string,\n  TINDEX extends number = number\n> {\n  key: TKEY;\n  index: TINDEX;\n}\n\n/**\n * Parameters for constructing a new {@link Collections.ICollectible | ICollectible} instance with an\n * index converter.\n * @public\n */\nexport interface ICollectibleConstructorParamsWithConverter<\n  TKEY extends string = string,\n  TINDEX extends number = number\n> {\n  key: TKEY;\n  index?: number;\n  indexConverter: Validator<TINDEX, unknown> | Converter<TINDEX, unknown> | ConverterFunc<TINDEX, undefined>;\n}\n\n/**\n * Parameters for constructing a new {@link Collections.ICollectible | ICollectible} instance.\n * @public\n */\nexport type ICollectibleConstructorParams<TKEY extends string = string, TINDEX extends number = number> =\n  | ICollectibleConstructorParamsWithIndex<TKEY, TINDEX>\n  | ICollectibleConstructorParamsWithConverter<TKEY, TINDEX>;\n\n/**\n * Simple implementation of {@link Collections.ICollectible | ICollectible} which does not allow the index to be\n * changed once set.\n * @public\n */\nexport class Collectible<TKEY extends string = string, TINDEX extends number = number>\n  implements ICollectible<TKEY, TINDEX>\n{\n  /**\n   * {@link Collections.ICollectible.key}\n   */\n  public readonly key: TKEY;\n\n  /**\n   * {@link Collections.ICollectible.index}\n   */\n  public get index(): TINDEX | undefined {\n    return this._index;\n  }\n\n  protected _index: TINDEX | undefined;\n  protected readonly _indexConverter?: Validator<TINDEX, unknown> | Converter<TINDEX, unknown>;\n\n  /**\n   * Constructs a new {@link Collections.Collectible | Collectible} instance\n   * with a defined, strongly-typed index.\n   * @param params - {@link Collections.ICollectibleConstructorParamsWithIndex | Parameters} for constructing\n   * the collectible.\n   */\n  public constructor(params: ICollectibleConstructorParamsWithIndex<TKEY, TINDEX>);\n\n  /**\n   * Constructs a new {@link Collections.Collectible | Collectible} instance with\n   * an undefined index and an index converter to validate te index when it is set.\n   * @param params - {@link Collections.ICollectibleConstructorParamsWithConverter | Parameters} for constructing\n   * the collectible.\n   */\n  public constructor(params: ICollectibleConstructorParamsWithConverter<TKEY, TINDEX>);\n\n  /**\n   * Constructs a new {@link Collections.Collectible | Collectible} instance.\n   * @param params - {@link Collections.ICollectibleConstructorParams | Parameters} for constructing\n   * the collectible.\n   */\n  public constructor(params: ICollectibleConstructorParams<TKEY, TINDEX>);\n  public constructor(params: ICollectibleConstructorParams<TKEY, TINDEX>) {\n    this.key = params.key;\n    if ('indexConverter' in params) {\n      this._indexConverter =\n        typeof params.indexConverter === 'function'\n          ? Converters.generic(params.indexConverter)\n          : params.indexConverter;\n      if (params.index !== undefined) {\n        this._index = this._indexConverter.convert(params.index).orThrow();\n      }\n    } else {\n      this._index = params.index;\n    }\n  }\n\n  /**\n   * Creates a new {@link Collections.Collectible | Collectible} instance with a defined, strongly-typed index.\n   * @param params - {@link Collections.ICollectibleConstructorParamsWithIndex | Parameters} for constructing\n   * the collectible.\n   * @returns {@link Success} with the new collectible if successful, {@link Failure} otherwise.\n   */\n  public static createCollectible<TKEY extends string = string, TINDEX extends number = number>(\n    params: ICollectibleConstructorParamsWithIndex<TKEY, TINDEX>\n  ): Result<Collectible<TKEY, TINDEX>>;\n\n  /**\n   * Creates a new {@link Collections.Collectible | Collectible} instance with an undefined index and an index\n   * converter to validate the index when it is set.\n   * @param params - {@link Collections.ICollectibleConstructorParamsWithConverter | Parameters} for constructing\n   * the collectible.\n   * @returns {@link Success} with the new collectible if successful, {@link Failure} otherwise.\n   */\n  public static createCollectible<TKEY extends string = string, TINDEX extends number = number>(\n    params: ICollectibleConstructorParamsWithConverter<TKEY, TINDEX>\n  ): Result<Collectible<TKEY, TINDEX>>;\n\n  /**\n   * Creates a new {@link Collections.Collectible | Collectible} instance.\n   * @param params - {@link Collections.ICollectibleConstructorParams | Parameters} for constructing\n   * the collectible.\n   * @returns {@link Success} with the new collectible if successful, {@link Failure} otherwise\n   * @public\n   */\n  public static createCollectible<TKEY extends string = string, TINDEX extends number = number>(\n    params: ICollectibleConstructorParams<TKEY, TINDEX>\n  ): Result<Collectible<TKEY, TINDEX>>;\n\n  public static createCollectible<TKEY extends string = string, TINDEX extends number = number>(\n    params: ICollectibleConstructorParams<TKEY, TINDEX>\n  ): Result<Collectible<TKEY, TINDEX>> {\n    return captureResult(() => new Collectible(params));\n  }\n\n  /**\n   * {@link Collections.ICollectible.setIndex}\n   */\n  public setIndex(index: number): Result<TINDEX> {\n    let converted: TINDEX | undefined;\n    if (this._indexConverter) {\n      const { value, message } = this._indexConverter.convert(index);\n      if (message) {\n        return fail(message);\n      }\n      converted = value;\n    }\n\n    if (index === this.index) {\n      return succeed(this.index);\n    } else if (this._index !== undefined) {\n      return fail(`index ${this.index} is immutable and cannot be changed to ${index}`);\n    }\n\n    /* c8 ignore next 3 - should be impossible */\n    if (converted === undefined) {\n      return fail(`index ${index} cannot be set on a Collectible without an index converter`);\n    }\n\n    this._index = converted;\n    return succeed(converted);\n  }\n}\n"]}
+{"version":3,"file":"collectible.js","sourceRoot":"","sources":["../../../src/packlets/collections/collectible.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAA+D;AAC/D,8CAAqE;AAuFrE;;;;GAIG;AACH,MAAa,WAAW;IAQtB;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IA2BD,YAAmB,MAAmD;QACpE,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QACtB,IAAI,gBAAgB,IAAI,MAAM,EAAE,CAAC;YAC/B,IAAI,CAAC,eAAe;gBAClB,OAAO,MAAM,CAAC,cAAc,KAAK,UAAU;oBACzC,CAAC,CAAC,uBAAU,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;oBAC3C,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC;YAC5B,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC/B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;YACrE,CAAC;QACH,CAAC;aAAM,CAAC;YACR,qDAAqD;YACnD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC7B,CAAC;IACH,CAAC;IAkCM,MAAM,CAAC,iBAAiB,CAC7B,MAAmD;QAEnD,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,KAAa;QAC3B,IAAI,SAA6B,CAAC;QAClC,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC/D,iFAAiF;YACjF,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YACD,SAAS,GAAG,KAAK,CAAC;QACpB,CAAC;QAED,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO,IAAA,WAAI,EAAC,SAAS,IAAI,CAAC,KAAK,0CAA0C,KAAK,EAAE,CAAC,CAAC;QACpF,CAAC;QAED,6CAA6C;QAC7C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,IAAA,WAAI,EAAC,SAAS,KAAK,4DAA4D,CAAC,CAAC;QAC1F,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,OAAO,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;CACF;AA1HD,kCA0HC","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 { Result, captureResult, fail, succeed } from '../base';\nimport { Converter, ConverterFunc, Converters } from '../conversion';\nimport { Validator } from '../validation';\n\n/**\n * An item that can be collected by some {@link ConvertingCollector | Collector}.\n * @public\n */\nexport interface ICollectible<TKEY extends string = string, TINDEX extends number = number> {\n  readonly key: TKEY;\n  readonly index: TINDEX | undefined;\n  setIndex(index: number): Result<TINDEX>;\n}\n\n/**\n * Infer the key type from an {@link Collections.ICollectible | ICollectible} type.\n * @public\n */\nexport type CollectibleKey<TITEM extends ICollectible> = TITEM extends ICollectible<infer TKEY>\n  ? TKEY\n  : never;\n\n/**\n * Infer the index type from an {@link Collections.ICollectible | ICollectible} type.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type CollectibleIndex<TITEM extends ICollectible> = TITEM extends ICollectible<any, infer TINDEX>\n  ? TINDEX\n  : never;\n\n/**\n * Factory function for creating a new {@link Collections.ICollectible | ICollectible} instance given a key, an index and a source representation\n * of the item to be added.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type CollectibleFactory<TITEM extends ICollectible<any, any>, TSRC> = (\n  key: CollectibleKey<TITEM>,\n  index: number,\n  item: TSRC\n) => Result<TITEM>;\n\n/**\n * Factory function for creating a new {@link Collections.ICollectible | ICollectible} instance given a key and an index.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type CollectibleFactoryCallback<TITEM extends ICollectible<any, any>> = (\n  key: CollectibleKey<TITEM>,\n  index: number\n) => Result<TITEM>;\n\n/**\n * Parameters for constructing a new {@link Collections.ICollectible | ICollectible} instance with\n * a defined, strongly-typed index.\n * @public\n */\nexport interface ICollectibleConstructorParamsWithIndex<\n  TKEY extends string = string,\n  TINDEX extends number = number\n> {\n  key: TKEY;\n  index: TINDEX;\n}\n\n/**\n * Parameters for constructing a new {@link Collections.ICollectible | ICollectible} instance with an\n * index converter.\n * @public\n */\nexport interface ICollectibleConstructorParamsWithConverter<\n  TKEY extends string = string,\n  TINDEX extends number = number\n> {\n  key: TKEY;\n  index?: number;\n  indexConverter: Validator<TINDEX, unknown> | Converter<TINDEX, unknown> | ConverterFunc<TINDEX, undefined>;\n}\n\n/**\n * Parameters for constructing a new {@link Collections.ICollectible | ICollectible} instance.\n * @public\n */\nexport type ICollectibleConstructorParams<TKEY extends string = string, TINDEX extends number = number> =\n  | ICollectibleConstructorParamsWithIndex<TKEY, TINDEX>\n  | ICollectibleConstructorParamsWithConverter<TKEY, TINDEX>;\n\n/**\n * Simple implementation of {@link Collections.ICollectible | ICollectible} which does not allow the index to be\n * changed once set.\n * @public\n */\nexport class Collectible<TKEY extends string = string, TINDEX extends number = number>\n  implements ICollectible<TKEY, TINDEX>\n{\n  /**\n   * {@link Collections.ICollectible.key}\n   */\n  public readonly key: TKEY;\n\n  /**\n   * {@link Collections.ICollectible.index}\n   */\n  public get index(): TINDEX | undefined {\n    return this._index;\n  }\n\n  protected _index: TINDEX | undefined;\n  protected readonly _indexConverter?: Validator<TINDEX, unknown> | Converter<TINDEX, unknown>;\n\n  /**\n   * Constructs a new {@link Collections.Collectible | Collectible} instance\n   * with a defined, strongly-typed index.\n   * @param params - {@link Collections.ICollectibleConstructorParamsWithIndex | Parameters} for constructing\n   * the collectible.\n   */\n  public constructor(params: ICollectibleConstructorParamsWithIndex<TKEY, TINDEX>);\n\n  /**\n   * Constructs a new {@link Collections.Collectible | Collectible} instance with\n   * an undefined index and an index converter to validate te index when it is set.\n   * @param params - {@link Collections.ICollectibleConstructorParamsWithConverter | Parameters} for constructing\n   * the collectible.\n   */\n  public constructor(params: ICollectibleConstructorParamsWithConverter<TKEY, TINDEX>);\n\n  /**\n   * Constructs a new {@link Collections.Collectible | Collectible} instance.\n   * @param params - {@link Collections.ICollectibleConstructorParams | Parameters} for constructing\n   * the collectible.\n   */\n  public constructor(params: ICollectibleConstructorParams<TKEY, TINDEX>);\n  public constructor(params: ICollectibleConstructorParams<TKEY, TINDEX>) {\n    this.key = params.key;\n    if ('indexConverter' in params) {\n      this._indexConverter =\n        typeof params.indexConverter === 'function'\n          ? Converters.generic(params.indexConverter)\n          : params.indexConverter;\n      if (params.index !== undefined) {\n        this._index = this._indexConverter.convert(params.index).orThrow();\n      }\n    } else {\n    /* c8 ignore next 3 - coverage is having a bad day */\n      this._index = params.index;\n    }\n  }\n\n  /**\n   * Creates a new {@link Collections.Collectible | Collectible} instance with a defined, strongly-typed index.\n   * @param params - {@link Collections.ICollectibleConstructorParamsWithIndex | Parameters} for constructing\n   * the collectible.\n   * @returns {@link Success} with the new collectible if successful, {@link Failure} otherwise.\n   */\n  public static createCollectible<TKEY extends string = string, TINDEX extends number = number>(\n    params: ICollectibleConstructorParamsWithIndex<TKEY, TINDEX>\n  ): Result<Collectible<TKEY, TINDEX>>;\n\n  /**\n   * Creates a new {@link Collections.Collectible | Collectible} instance with an undefined index and an index\n   * converter to validate the index when it is set.\n   * @param params - {@link Collections.ICollectibleConstructorParamsWithConverter | Parameters} for constructing\n   * the collectible.\n   * @returns {@link Success} with the new collectible if successful, {@link Failure} otherwise.\n   */\n  public static createCollectible<TKEY extends string = string, TINDEX extends number = number>(\n    params: ICollectibleConstructorParamsWithConverter<TKEY, TINDEX>\n  ): Result<Collectible<TKEY, TINDEX>>;\n\n  /**\n   * Creates a new {@link Collections.Collectible | Collectible} instance.\n   * @param params - {@link Collections.ICollectibleConstructorParams | Parameters} for constructing\n   * the collectible.\n   * @returns {@link Success} with the new collectible if successful, {@link Failure} otherwise\n   * @public\n   */\n  public static createCollectible<TKEY extends string = string, TINDEX extends number = number>(\n    params: ICollectibleConstructorParams<TKEY, TINDEX>\n  ): Result<Collectible<TKEY, TINDEX>>;\n\n  public static createCollectible<TKEY extends string = string, TINDEX extends number = number>(\n    params: ICollectibleConstructorParams<TKEY, TINDEX>\n  ): Result<Collectible<TKEY, TINDEX>> {\n    return captureResult(() => new Collectible(params));\n  }\n\n  /**\n   * {@link Collections.ICollectible.setIndex}\n   */\n  public setIndex(index: number): Result<TINDEX> {\n    let converted: TINDEX | undefined;\n    if (this._indexConverter) {\n      const { value, message } = this._indexConverter.convert(index);\n      /* c8 ignore next 3 - there's a test for this but coverage is having a bad day */\n      if (message) {\n        return fail(message);\n      }\n      converted = value;\n    }\n\n    if (index === this.index) {\n      return succeed(this.index);\n    } else if (this._index !== undefined) {\n      return fail(`index ${this.index} is immutable and cannot be changed to ${index}`);\n    }\n\n    /* c8 ignore next 3 - should be impossible */\n    if (converted === undefined) {\n      return fail(`index ${index} cannot be set on a Collectible without an index converter`);\n    }\n\n    this._index = converted;\n    return succeed(converted);\n  }\n}\n"]}

package/lib/packlets/conversion/converters.d.ts

@@ -25,7 +25,7 @@ export declare const string: StringConverter;
  * @returns A new {@link Converter | Converter} returning `<T>`.
  * @public
  */
-export declare function enumeratedValue<T>(values: T[]): Converter<T, T[]>;
+export declare function enumeratedValue<T>(values: ReadonlyArray<T>): Converter<T, ReadonlyArray<T>>;
 /**
  * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of supplied enumerated
  * values, mapping any of multiple supplied values to the enumeration.
@@ -39,7 +39,7 @@ export declare function enumeratedValue<T>(values: T[]): Converter<T, T[]>;
  * @returns A {@link Converter | Converter} which applies the mapping and yields `<T>` on success.
  * @public
  */
-export declare function mappedEnumeratedValue<T, TC = unknown>(map: [T, unknown[]][], message?: string): Converter<T, TC>;
+export declare function mappedEnumeratedValue<T, TC = unknown>(map: ReadonlyArray<[T, ReadonlyArray<TC>]>, message?: string): Converter<T, ReadonlyArray<TC>>;
 /**
  * Helper function to create a {@link Converter | Converter} which converts `unknown` to some supplied literal value. Succeeds with
  * the supplied value if an identity comparison succeeds, fails otherwise.