@fgv/ts-utils 5.1.0-4 → 5.1.0-40

package/dist/packlets/conversion/basicConverters.js

@@ -19,9 +19,10 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-import { fail, isKeyOf, succeed } from '../base';
+import { allMessageLogLevels, fail, isKeyOf, succeed } from '../base';
 import { Base as ValidationBase } from '../validation';
 import { BaseConverter } from './baseConverter';
+import { allOnError } from './converter';
 import { ObjectConverter } from './objectConverter';
 import { StringConverter } from './stringConverter';
 /**
@@ -47,6 +48,16 @@ export function enumeratedValue(values) {
         return index >= 0 ? succeed(v[index]) : fail(`Invalid enumerated value ${JSON.stringify(from)}`);
     });
 }
+/**
+ * A ready-made {@link Converter | Converter} for {@link MessageLogLevel} values.
+ * @public
+ */
+export const messageLogLevel = enumeratedValue(allMessageLogLevels);
+/**
+ * A ready-made {@link Converter | Converter} for {@link Conversion.OnError | OnError} values.
+ * @public
+ */
+export const onError = enumeratedValue(allOnError);
 /**
  * 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.
@@ -546,6 +557,9 @@ export function strictObject(properties, opt) {
  *
  * If the source is not an object, the discriminator property is missing, or the discriminator has
  * a value not present in the converters, conversion fails and returns {@link Failure | Failure} with more information.
+ *
+ * The `self` reference of the outer converter is threaded through to per-arm converter invocations,
+ * enabling recursive discriminated-union parsers where arms recurse via `self`.
  * @param discriminatorProp - Name of the property used to discriminate types.
  * @param converters - {@link Converters.DiscriminatedObjectConverters | String-keyed record of converters and validators}
  * to invoke, where each key corresponds to a value of the discriminator property.
@@ -553,7 +567,7 @@ export function strictObject(properties, opt) {
  * @public
  */
 export function discriminatedObject(discriminatorProp, converters) {
-    return new BaseConverter((from) => {
+    return new BaseConverter((from, self, context) => {
         if (typeof from !== 'object' || Array.isArray(from) || from === null) {
             return fail(`Not a discriminated object: "${JSON.stringify(from)}"`);
         }
@@ -561,11 +575,16 @@ export function discriminatedObject(discriminatorProp, converters) {
             return fail(`Discriminator property ${discriminatorProp} not present in "${JSON.stringify(from)}"`);
         }
         const discriminatorValue = from[discriminatorProp];
-        const converter = converters[discriminatorValue];
-        if (converter === undefined) {
+        const arm = converters[discriminatorValue];
+        if (arm === undefined) {
             return fail(`No converter for discriminator ${discriminatorProp}="${discriminatorValue}"`);
         }
-        return converter.convert(from);
+        // Thread the outer self and context through to the arm so that recursive
+        // discriminated-union parsers can reach the outer dispatcher via self.
+        if (isValidator(arm)) {
+            return arm.convert(from, context);
+        }
+        return arm.convert(from, context, self);
     });
 }
 //# sourceMappingURL=basicConverters.js.map

package/dist/packlets/conversion/basicConverters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basicConverters.js","sourceRoot":"","sources":["../../../src/packlets/conversion/basicConverters.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAoC,mBAAmB,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACxG,OAAO,EAAmC,IAAI,IAAI,cAAc,EAAE,MAAM,eAAe,CAAC;AACxF,OAAO,EAAE,aAAa,EAAiB,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAsB,UAAU,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAmB,eAAe,EAA0B,MAAM,mBAAmB,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AASpD;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GAAoB,IAAI,eAAe,EAAE,CAAC;AAE7D;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAAI,MAAwB;IACzD,OAAO,IAAI,aAAa,CACtB,CAAC,IAAa,EAAE,MAAsC,EAAE,OAA0B,EAAa,EAAE;QAC/F,MAAM,CAAC,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,MAAM,CAAC;QAC5B,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC;QACnC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnG,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAGxB,eAAe,CAAkB,mBAAmB,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAA+C,eAAe,CAAU,UAAU,CAAC,CAAC;AAExG;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,qBAAqB,CACnC,GAA0C,EAC1C,OAAgB;IAEhB,OAAO,IAAI,aAAa,CACtB,CAAC,IAAa,EAAE,MAAuC,EAAE,SAA6B,EAAE,EAAE;QACxF,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;YACvB,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAU,CAAC,EAAE,CAAC;gBACjC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CACT,OAAO;YACL,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE;YACvC,CAAC,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,wBAAwB,CAChE,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAkB,KAAQ;IAC/C,OAAO,IAAI,aAAa,CACtB,CAAC,IAAa,EAAE,MAAwB,EAAE,SAAmB,EAAa,EAAE;QAC1E,OAAO,IAAI,KAAK,KAAK;YACnB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;YAChB,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC/E,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,kDAAkD;AAClD,MAAM,CAAC,MAAM,KAAK,GAAG,OAAO,CAAC;AAE7B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAA+B,IAAI,aAAa,CAAkB,CAAC,IAAa,EAAE,EAAE;IACrG,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAW,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAClE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAAgC,IAAI,aAAa,CAAmB,CAAC,IAAa,EAAE,EAAE;IAC1G,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC,IAAe,CAAC,CAAC;IAClC,CAAC;SAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpC,QAAQ,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAC3B,KAAK,MAAM;gBACT,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;YACvB,KAAK,OAAO;gBACV,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAgC,gBAAgB,CAAC;AAErE;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAA2C,MAAM,CAAC,QAAQ,EAAE,CAAC;AAExF;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,SAAiB,EACjB,UAA8B,UAAU;IAExC,OAAO,IAAI,aAAa,CACtB,CAAC,IAAa,EAAE,MAAmC,EAAE,OAAgB,EAAE,EAAE;QACvE,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACvB,IAAI,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,SAAS,CAAC,CAAC;YACvD,IAAI,OAAO,KAAK,KAAK,EAAE,CAAC;gBACtB,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACvD,CAAC;YACD,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACzB,oBAAyD;IAEzD,OAAO,UAAU,IAAI,oBAAoB,CAAC;AAC5C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CACvB,oBAAyD;IAEzD,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACvC,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IACD,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;QAClF,OAAO,oBAAoB,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACzB,oBAAyD;IAEzD,IAAI,WAAW,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACtC,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IACD,OAAO,IAAI,cAAc,CAAC,gBAAgB,CAAQ;QAChD,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAwB,EAAE;YAC/D,MAAM,MAAM,GAAG,oBAAoB,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAC3D,OAAO,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1D,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAkB,OAA6B;IACpE,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,GAAG,CACjB,WAAmB,EACnB,KAAkC;IAElC,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAAyB,EAAE,OAAY,EAAE,EAAE;QAClF,IAAI,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;YACzB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,WAAW,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAA2C,MAAM,CAAC,QAAQ,EAAE,CAAC;AAExF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAA4C,gBAAgB,CAAC,QAAQ,EAAE,CAAC;AAEpG;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,KAAK,CACnB,UAAsD,EACtD,UAAmB,cAAc;IAEjC,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE;QAC/D,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAChD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACrD,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,IAAI,OAAO,KAAK,aAAa,EAAE,CAAC;oBAC9B,OAAO,MAAM,CAAC;gBAChB,CAAC;gBACD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,6BAA6B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,OAAO,CACrB,SAA8C,EAC9C,UAAmB,aAAa;IAEhC,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAA0B,EAAE,OAAY,EAAE,EAAE;QACnF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,SAAS,GAAQ,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAChD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACrD,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC;iBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,KAAK,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1G,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAiC,OAAO,CAAC,MAAM,CAAC,CAAC;AAEzE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAiC,OAAO,CAAC,MAAM,CAAC,CAAC;AA6EzE;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CACtB,SAA8C,EAC9C,SAA4D,MAAM;IAElE,MAAM,OAAO,GACX,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,iBAAG,OAAO,EAAE,MAAM,IAAK,MAAM,CAAE,CAAC;IACpF,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAAoC,EAAE,OAAY,EAAE,EAAE;;QAC7F,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACrE,OAAO,IAAI,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,cAAc,GAAG,MAAA,MAAA,OAAO,CAAC,YAAY,0CAAE,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,mCAAI,OAAO,CAAC,GAAG,CAAC,CAAC;gBAEnF,cAAc;qBACX,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACtB,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAY,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;wBAC1E,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;wBACzB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;oBACvB,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;qBACD,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBACrB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACrB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvB,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzG,CAAC,CAAC,CAAC;AACL,CAAC;AAwDD;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CACnB,SAA8C,EAC9C,SAA4D,MAAM;IAElE,MAAM,OAAO,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,iBAAG,OAAO,EAAE,MAAM,IAAK,MAAM,CAAE,CAAC;IAClG,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAAiC,EAAE,OAAY,EAAE,EAAE;;QAC1F,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACrE,OAAO,IAAI,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,GAAG,EAAS,CAAC;QAC7B,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,cAAc,GAAG,MAAA,MAAA,OAAO,CAAC,YAAY,0CAAE,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,mCAAI,OAAO,CAAC,GAAG,CAAC,CAAC;gBAEnF,cAAc;qBACX,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACtB,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAY,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;wBAC1E,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;wBACzB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;oBACvB,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;qBACD,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBACrB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACrB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvB,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtG,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAC1B,SAAuC,EACvC,WAAoB;IAEpB,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAAwB,EAAE,SAAc,EAAE,EAAE;QACnF,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACpB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,OAAO,CACrB,KAAa,EACb,SAA8C;IAE9C,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;QACjF,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,OAAO,IAAI,CAAC,GAAG,KAAK,+CAA+C,CAAC,CAAC;QACvE,CAAC;aAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,2CAA2C,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,GAAG,KAAK,8CAA8C,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;QACxF,CAAC;QACD,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAa,EACb,SAA8C;IAE9C,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAAoC,EAAE,OAAY,EAAE,EAAE;QAC7F,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,OAAO,IAAI,CAAC,GAAG,KAAK,+CAA+C,CAAC,CAAC;QACvE,CAAC;aAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,2CAA2C,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,KAAK,CACnB,IAAY,EACZ,SAA8C;IAE9C,OAAO,IAAI,aAAa,CAAC,CAAC,IAAa,EAAE,MAAwB,EAAE,OAAY,EAAE,EAAE;QACjF,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACtE,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;gBACxB,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBAClE,OAAO,IAAI,CAAC,SAAS,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;gBAC3C,CAAC,CAAC,CAAC;YACL,CAAC;YACD,OAAO,IAAI,CAAC,SAAS,IAAI,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,IAAI,CAAC,yBAAyB,IAAI,qBAAqB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAY,EACZ,SAA8C;IAE9C,OAAO,IAAI,aAAa,CACtB,CAAC,IAAa,EAAE,MAAoC,EAAE,OAAY,EAAE,EAAE;QACpE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACtE,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;gBACxB,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;oBAC1E,OAAO,IAAI,CAAC,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;gBACrC,CAAC,CAAC,CAAC;gBAEH,yDAAyD;gBACzD,oDAAoD;gBACpD,YAAY;gBACZ,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;oBACnD,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;YACD,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,IAAI,CAAC,yBAAyB,IAAI,qBAAqB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC,EACD,SAAS,EACT,EAAE,UAAU,EAAE,IAAI,EAAE,CACrB,CAAC;AACJ,CAAC;AAqDD;;;;GAIG;AACH,MAAM,UAAU,MAAM,CACpB,UAAkC,EAClC,OAAiD;IAEjD,OAAO,IAAI,eAAe,CAAC,UAAU,EAAE,OAAoC,CAAC,CAAC;AAC/E,CAAC;AAuDD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,UAAkC,EAClC,GAAmD;IAEnD,sBAAsB;IACtB,MAAM,OAAO,GACX,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC,iCAAM,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC,KAAE,MAAM,EAAE,IAAI,GAAE,CAAC;IACvG,OAAO,IAAI,eAAe,CAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;AACzD,CAAC;AAYD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,mBAAmB,CACjC,iBAAyB,EACzB,UAAgD;IAEhD,OAAO,IAAI,aAAa,CAAQ,CAAC,IAAa,EAAE,IAAsB,EAAE,OAAY,EAAE,EAAE;QACtF,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACrE,OAAO,IAAI,CAAC,gCAAgC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAClE,OAAO,IAAI,CAAC,0BAA0B,iBAAiB,oBAAoB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtG,CAAC;QAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,iBAAiB,CAAO,CAAC;QACzD,MAAM,GAAG,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAC3C,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,kCAAkC,iBAAiB,KAAK,kBAAkB,GAAG,CAAC,CAAC;QAC7F,CAAC;QACD,yEAAyE;QACzE,uEAAuE;QACvE,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YACrB,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, MessageLogLevel, Result, allMessageLogLevels, fail, isKeyOf, succeed } from '../base';\nimport { TypeGuardWithContext, Validator, Base as ValidationBase } from '../validation';\nimport { BaseConverter, ConverterFunc } from './baseConverter';\nimport { Converter, OnError, allOnError } from './converter';\nimport { FieldConverters, ObjectConverter, ObjectConverterOptions } from './objectConverter';\nimport { StringConverter } from './stringConverter';\n\n/**\n * Action to take on conversion failures (deprecated - use Conversion.OnError)\n * @public\n * @deprecated use Conversion.OnError.\n */\nexport { OnError };\n\n/**\n * A converter to convert unknown to string. Values of type\n * string succeed.  Anything else fails.\n * @public\n */\nexport const string: StringConverter = new StringConverter();\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of supplied\n * enumerated values. Anything else fails.\n *\n * @remarks\n * Allowed enumerated values can also be supplied as context at conversion time.\n * @param values - Array of allowed values.\n * @returns A new {@link Converter | Converter} returning `<T>`.\n * @public\n */\nexport function enumeratedValue<T>(values: ReadonlyArray<T>): Converter<T, ReadonlyArray<T>> {\n  return new BaseConverter(\n    (from: unknown, __self: Converter<T, ReadonlyArray<T>>, context?: ReadonlyArray<T>): Result<T> => {\n      const v = context ?? values;\n      const index = v.indexOf(from as T);\n      return index >= 0 ? succeed(v[index]) : fail(`Invalid enumerated value ${JSON.stringify(from)}`);\n    }\n  );\n}\n\n/**\n * A ready-made {@link Converter | Converter} for {@link MessageLogLevel} values.\n * @public\n */\nexport const messageLogLevel: Converter<\n  MessageLogLevel,\n  ReadonlyArray<MessageLogLevel>\n> = enumeratedValue<MessageLogLevel>(allMessageLogLevels);\n\n/**\n * A ready-made {@link Converter | Converter} for {@link Conversion.OnError | OnError} values.\n * @public\n */\nexport const onError: Converter<OnError, ReadonlyArray<OnError>> = enumeratedValue<OnError>(allOnError);\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of supplied enumerated\n * values, mapping any of multiple supplied values to the enumeration.\n * @remarks\n * Enables mapping of multiple input values to a consistent internal representation (so e.g. `'y'`, `'yes'`,\n * `'true'`, `1` and `true` can all map to boolean `true`)\n * @param map - An array of tuples describing the mapping. The first element of each tuple is the result\n * value, the second is the set of values that map to the result.  Tuples are evaluated in the order\n * supplied and are not checked for duplicates.\n * @param message - An optional error message.\n * @returns A {@link Converter | Converter} which applies the mapping and yields `<T>` on success.\n * @public\n */\nexport function mappedEnumeratedValue<T, TC = unknown>(\n  map: ReadonlyArray<[T, ReadonlyArray<TC>]>,\n  message?: string\n): Converter<T, ReadonlyArray<TC>> {\n  return new BaseConverter(\n    (from: unknown, __self: Converter<T, ReadonlyArray<TC>>, __context?: ReadonlyArray<TC>) => {\n      for (const item of map) {\n        if (item[1].includes(from as TC)) {\n          return succeed(item[0]);\n        }\n      }\n      return fail(\n        message\n          ? `${JSON.stringify(from)}: ${message}`\n          : `Cannot map '${JSON.stringify(from)}' to a supported value`\n      );\n    }\n  );\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts `unknown` to some supplied literal value. Succeeds with\n * the supplied value if an identity comparison succeeds, fails otherwise.\n * @param value - The value to be compared.\n * @returns A {@link Converter | Converter} which returns the supplied value on success.\n * @public\n */\nexport function literal<T, TC = unknown>(value: T): Converter<T, TC> {\n  return new BaseConverter<T, TC>(\n    (from: unknown, __self: Converter<T, TC>, __context?: unknown): Result<T> => {\n      return from === value\n        ? succeed(value)\n        : fail(`${JSON.stringify(from)}: does not match ${JSON.stringify(value)}`);\n    }\n  );\n}\n\n/**\n * Deprecated alias for @see literal\n * @param value - The value to be compared.\n * @deprecated Use {@link Converters.literal} instead.\n * @internal\n */\n// eslint-disable-next-line @rushstack/typedef-var\nexport const value = literal;\n\n/**\n * A {@link Converter | Converter} which converts `unknown` to a `number`.\n * @remarks\n * Numbers and strings with a numeric format succeed. Anything else fails.\n * @public\n */\nexport const number: Converter<number, unknown> = new BaseConverter<number, unknown>((from: unknown) => {\n  if (typeof from !== 'number') {\n    const num: number = typeof from === 'string' ? Number(from) : NaN;\n    return isNaN(num) ? fail(`Not a number: ${JSON.stringify(from)}`) : succeed(num);\n  }\n  return succeed(from);\n});\n\nconst booleanConverter: Converter<boolean, unknown> = new BaseConverter<boolean, unknown>((from: unknown) => {\n  if (typeof from === 'boolean') {\n    return succeed(from as boolean);\n  } else if (typeof from === 'string') {\n    switch (from.toLowerCase()) {\n      case 'true':\n        return succeed(true);\n      case 'false':\n        return succeed(false);\n    }\n  }\n  return fail(`Not a boolean: ${JSON.stringify(from)}`);\n});\n\n/**\n * A {@link Converter | Converter} which converts `unknown` to `boolean`.\n * @remarks\n * Boolean values or the case-insensitive strings `'true'` and `'false'` succeed.\n * Anything else fails.\n * @public\n */\nexport const boolean: Converter<boolean, unknown> = booleanConverter;\n\n/**\n * A {@link Converter | Converter} which converts an optional `string` value. Values of type\n * `string` are returned.  Anything else returns {@link Success | Success} with value `undefined`.\n * @public\n */\nexport const optionalString: Converter<string | undefined, unknown> = string.optional();\n\n/**\n * Helper function to create a {@link Converter | Converter} which converts any `string` into an\n * array of `string`, by separating at a supplied delimiter.\n * @remarks\n * Delimiter may also be supplied as context at conversion time.\n * @param delimiter - The delimiter at which to split.\n * @returns A new {@link Converter | Converter} returning `string[]`.\n * @public\n */\nexport function delimitedString(\n  delimiter: string,\n  options: 'filtered' | 'all' = 'filtered'\n): Converter<string[], string> {\n  return new BaseConverter<string[], string>(\n    (from: unknown, __self: Converter<string[], string>, context?: string) => {\n      const result = string.convert(from);\n      if (result.isSuccess()) {\n        let strings = result.value.split(context ?? delimiter);\n        if (options !== 'all') {\n          strings = strings.filter((s) => s.trim().length > 0);\n        }\n        return succeed(strings);\n      }\n      return fail(result.message);\n    }\n  );\n}\n\n/**\n * Determines if a supplied {@link Conversion.Converter | Converter} or {@link Validation.Validator | Validator} is\n * a {@link Validation.Validator | Validator}.\n * @param converterOrValidator - The {@link Conversion.Converter | Converter} or {@link Validation.Validator | Validator} to be tested.\n * @returns `true` if `converterOrValidator` is a {@link Validation.Validator | Validator}, `false` otherwise.\n * @public\n */\nexport function isValidator<T, TC>(\n  converterOrValidator: Converter<T, TC> | Validator<T, TC>\n): converterOrValidator is Validator<T, TC> {\n  return 'validate' in converterOrValidator;\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} from any {@link Validation.Validator}\n * @param converterOrValidator - the {@link Validation.Validator} to be wrapped or {@link Converter | Converter}\n * to be used directly.\n * @returns A {@link Converter | Converter} which uses the supplied validator.\n * @public\n */\nexport function validated<T, TC = unknown>(\n  converterOrValidator: Validator<T, TC> | Converter<T, TC>\n): Converter<T, TC> {\n  if (!isValidator(converterOrValidator)) {\n    return converterOrValidator;\n  }\n  return new BaseConverter((from: unknown, __self?: Converter<T, TC>, context?: TC) => {\n    return converterOrValidator.validate(from, context);\n  });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator | Validator} from any {@link Conversion.Converter | Converter}\n * or {@link Validation.Validator | Validator}.\n * @param converterOrValidator - the {@link Conversion.Converter | Converter} to be wrappped or {@link Validation.Validator | Validator} to be used directly.\n * @returns A {@link Validation.Validator | Validator} which uses the supplied converter or validator.\n * @public\n */\nexport function asValidator<T, TC = unknown>(\n  converterOrValidator: Converter<T, TC> | Validator<T, TC>\n): Validator<T, TC> {\n  if (isValidator(converterOrValidator)) {\n    return converterOrValidator;\n  }\n  return new ValidationBase.GenericValidator<T, TC>({\n    validator: (from: unknown, context?: TC): boolean | Failure<T> => {\n      const result = converterOrValidator.convert(from, context);\n      return result.isSuccess() ? true : fail(result.message);\n    }\n  });\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} from a supplied {@link Conversion.ConverterFunc | ConverterFunc}.\n * @param convert - the function to be wrapped\n * @returns A {@link Converter | Converter} which uses the supplied function.\n * @public\n */\nexport function generic<T, TC = unknown>(convert: ConverterFunc<T, TC>): Converter<T, TC> {\n  return new BaseConverter(convert);\n}\n\n/**\n * Helper function to create a {@link Converter | Converter} from a supplied type guard function.\n * @param description - a description of the thing to be validated for use in error messages\n * @param guard - a {@link Validation.TypeGuardWithContext} which performs the validation.\n * @returns A new {@link Converter | Converter} which validates the values using the supplied type guard\n * and returns them in place.\n * @public\n */\nexport function isA<T, TC = unknown>(\n  description: string,\n  guard: TypeGuardWithContext<T, TC>\n): Converter<T, TC> {\n  return new BaseConverter((from: unknown, __self?: Converter<T, TC>, context?: TC) => {\n    if (guard(from, context)) {\n      return succeed(from);\n    }\n    return fail(`invalid ${description} (${JSON.stringify(from)})`);\n  });\n}\n\n/**\n * A {@link Converter | Converter} which converts an optional `number` value.\n * @remarks\n * Values of type `number` or numeric strings are converted and returned.\n * Anything else returns {@link Success | Success} with value `undefined`.\n * @public\n */\nexport const optionalNumber: Converter<number | undefined, unknown> = number.optional();\n\n/**\n * A {@link Converter | Converter} to convert an optional `boolean` value.\n * @remarks\n * Values of type `boolean` or strings that match (case-insensitive) `'true'`\n * or `'false'` are converted and returned.  Anything else returns {@link Success | Success}\n * with value `undefined`.\n * @public\n */\nexport const optionalBoolean: Converter<boolean | undefined, unknown> = booleanConverter.optional();\n\n/**\n * A helper function to create a {@link Converter | Converter} for polymorphic values.\n * Returns a converter which invokes the wrapped converters in sequence, returning the\n * first successful result.  Returns an error if none of the supplied converters can\n * convert the value.\n * @remarks\n * If `onError` is `ignoreErrors` (default), then errors from any of the\n * converters are ignored provided that some converter succeeds.  If\n * onError is `failOnError`, then an error from any converter fails the entire\n * conversion.\n *\n * @param converters - An ordered list of {@link Converter | converters} or {@link Validator | validators}\n * to be considered.\n * @param onError - Specifies treatment of unconvertible elements.\n * @returns A new {@link Converter | Converter} which yields a value from the union of the types returned\n * by the wrapped converters.\n * @public\n */\nexport function oneOf<T, TC = unknown>(\n  converters: Array<Converter<T, TC> | Validator<T, TC>>,\n  onError: OnError = 'ignoreErrors'\n): Converter<T, TC> {\n  return new BaseConverter((from: unknown, __self, context?: TC) => {\n    const errors: string[] = [];\n    for (const converter of converters) {\n      const result = converter.convert(from, context);\n      if (result.isSuccess() && result.value !== undefined) {\n        return result;\n      }\n\n      if (result.isFailure()) {\n        if (onError === 'failOnError') {\n          return result;\n        }\n        errors.push(result.message);\n      }\n    }\n    return fail(`No matching converter for ${JSON.stringify(from)}: ${errors.join('\\n')}`);\n  });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts `unknown` to an array of `<T>`.\n * @remarks\n * If `onError` is `'failOnError'` (default), then the entire conversion fails if any element cannot\n * be converted.  If `onError` is `'ignoreErrors'`, then failing elements are silently ignored.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used to convert each\n * item in the array.\n * @param onError - Specifies treatment of unconvertible elements.\n * @returns A {@link Converter | Converter} which returns an array of `<T>`.\n * @public\n */\nexport function arrayOf<T, TC = unknown>(\n  converter: Converter<T, TC> | Validator<T, TC>,\n  onError: OnError = 'failOnError'\n): Converter<T[], TC> {\n  return new BaseConverter((from: unknown, __self: Converter<T[], TC>, context?: TC) => {\n    if (!Array.isArray(from)) {\n      return fail(`Not an array: ${JSON.stringify(from)}`);\n    }\n\n    const successes: T[] = [];\n    const errors: string[] = [];\n    for (const item of from) {\n      const result = converter.convert(item, context);\n      if (result.isSuccess() && result.value !== undefined) {\n        successes.push(result.value);\n      } else if (result.isFailure()) {\n        errors.push(result.message);\n      }\n    }\n\n    return errors.length === 0 || onError === 'ignoreErrors' ? succeed(successes) : fail(errors.join('\\n'));\n  });\n}\n\n/**\n * {@link Converter | Converter} to convert an `unknown` to an array of `string`.\n * @remarks\n * Returns {@link Success | Success} with the the supplied value if it as an array\n * of strings, returns {@link Failure | Failure} with an error message otherwise.\n * @public\n */\nexport const stringArray: Converter<string[], unknown> = arrayOf(string);\n\n/**\n * {@link Converter | Converter} to convert an `unknown` to an array of `number`.\n * @remarks\n * Returns {@link Success | Success} with the the supplied value if it as an array\n * of numbers, returns {@link Failure | Failure} with an error message otherwise.\n * @public\n */\nexport const numberArray: Converter<number[], unknown> = arrayOf(number);\n\n/**\n * Options for {@link recordOf} and\n * {@link mapOf}\n * helper functions.\n * @public\n */\n\nexport interface KeyedConverterOptions<T extends string = string, TC = unknown> {\n  /**\n   * if `onError` is `'fail'` (default), then the entire conversion fails if any key or element\n   * cannot be converted.  If `onError` is `'ignore'`, failing elements are silently ignored.\n   */\n  onError?: 'fail' | 'ignore';\n  /**\n   * If present, `keyConverter` is used to convert the source object property names to\n   * keys in the resulting map or record.\n   * @remarks\n   * Can be used to coerce key names to supported values and/or strong types.\n   */\n  keyConverter?: Converter<T, TC> | Validator<T, TC>;\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed\n * properties using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to\n * produce a `Record<string, T>`.\n * @remarks\n * The resulting converter fails conversion if any element cannot be converted.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for each\n * item in the source object.\n * @returns A {@link Converter | Converter} which returns `Record<string, T>`.\n * {@label WITH_DEFAULT}\n * @public\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n  converter: Converter<T, TC> | Validator<T, TC>\n): Converter<Record<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Record<string, T>` and optionally specified handling of elements that cannot be converted.\n * @remarks\n * if `onError` is `'fail'` (default), then the entire conversion fails if any key or element\n * cannot be converted.  If `onError` is `'ignore'`, failing elements are silently ignored.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} for each item in\n * the source object.\n * @returns A {@link Converter | Converter} which returns `Record<string, T>`.\n * {@label WITH_ON_ERROR}\n * @public\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n  converter: Converter<T, TC> | Validator<T, TC>,\n  onError: 'fail' | 'ignore'\n): Converter<Record<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} or which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Record<TK, T>`.\n * @remarks\n * If present, the supplied {@link Converters.KeyedConverterOptions | options} can provide a strongly-typed\n * converter for keys and/or control the handling of elements that fail conversion.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for each item in the source object.\n * @param options - Optional {@link Converters.KeyedConverterOptions | KeyedConverterOptions<TK, TC>} which\n * supplies a key converter and/or error-handling options.\n * @returns A {@link Converter | Converter} which returns `Record<TK, T>`.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n  converter: Converter<T, TC> | Validator<T, TC>,\n  options: KeyedConverterOptions<TK, TC>\n): Converter<Record<TK, T>, TC>;\n\n/**\n * Concrete implementation of {@link Converters.(recordOf:1) | Converters.recordOf(Converter<T, TC>)},\n * {@link Converters.(recordOf:2) | Converters.recordOf(Converter<T, TC>, 'fail' or 'ignore')}, and\n * {@link Converters.recordOf | Converters.recordOf(Converter<T, TC>, KeyedConverterOptions)}.\n * @internal\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n  converter: Converter<T, TC> | Validator<T, TC>,\n  option: 'fail' | 'ignore' | KeyedConverterOptions<TK, TC> = 'fail'\n): Converter<Record<TK, T>, TC> {\n  const options: KeyedConverterOptions<TK, TC> =\n    typeof option === 'string' ? { onError: option } : { onError: 'fail', ...option };\n  return new BaseConverter((from: unknown, __self: Converter<Record<TK, T>, TC>, context?: TC) => {\n    if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n      return fail(`Not a string-keyed object: ${JSON.stringify(from)}`);\n    }\n\n    const record: Record<string, T> = {};\n    const errors: string[] = [];\n\n    for (const key in from) {\n      if (isKeyOf(key, from)) {\n        const writeKeyResult = options.keyConverter?.convert(key, context) ?? succeed(key);\n\n        writeKeyResult\n          .onSuccess((writeKey) => {\n            return converter.convert(from[key] as unknown, context).onSuccess((value) => {\n              record[writeKey] = value;\n              return succeed(true);\n            });\n          })\n          .onFailure((message) => {\n            errors.push(message);\n            return fail(message);\n          });\n      }\n    }\n\n    return errors.length === 0 || options.onError === 'ignore' ? succeed(record) : fail(errors.join('\\n'));\n  });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Map<string, T>`.\n * @remarks\n * The resulting converter fails conversion if any element cannot be converted.\n * @param converter - {@link Converter | Converter} | {@link Validator | Validator} used for each item in\n * the source object.\n * @returns A {@link Converter | Converter} which returns `Map<string, T>`.\n * {@label WITH_DEFAULT}\n * @public\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n  converter: Converter<T, TC> | Validator<T, TC>\n): Converter<Map<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce a\n * `Map<string, T>` and specified handling of elements that cannot be converted.\n * @remarks\n * if `onError` is `'fail'` (default), then the entire conversion fails if any key or element\n * cannot be converted.  If `onError` is `'ignore'`, failing elements are silently ignored.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for\n * each item in the source object.\n * @returns A {@link Converter | Converter} which returns `Map<string, T>`.\n * {@label WITH_ON_ERROR}\n * @public\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n  converter: Converter<T, TC> | Validator<T, TC>,\n  onError: 'fail' | 'ignore'\n): Converter<Map<TK, T>, TC>;\n\n/**\n * A helper function to create a {@link Converter | Converter} which converts the `string`-keyed properties\n * using a supplied {@link Converter | Converter<T, TC>} or {@link Validator | Validator<T>} to produce\n * a `Map<TK,T>`.\n * @remarks\n * If present, the supplied {@link Converters.KeyedConverterOptions | options} can provide a strongly-typed\n * converter for keys and/or control the handling of elements that fail conversion.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used for each item\n * in the source object.\n * @param options - Optional {@link Converters.KeyedConverterOptions | KeyedConverterOptions<TK, TC>} which\n * supplies a key converter and/or error-handling options.\n * @returns A {@link Converter | Converter} which returns `Map<TK,T>`.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n  converter: Converter<T, TC> | Validator<T, TC>,\n  options: KeyedConverterOptions<TK, TC>\n): Converter<Map<TK, T>, TC>;\n\n/**\n * Concrete implementation of {@link Converters.(mapOf:1) | Converters.mapOf(Converter<T, TC>)},\n * {@link Converters.(mapOf:2) | Converters.mapOf(Converter<T, TC>, 'fail' or 'ignore')}, and\n * {@link Converters.mapOf | Converters.mapOf(Converter<T, TC>, KeyedConverterOptions)}.\n * @internal\n */\nexport function mapOf<T, TC = unknown, TK extends string = string>(\n  converter: Converter<T, TC> | Validator<T, TC>,\n  option: 'fail' | 'ignore' | KeyedConverterOptions<TK, TC> = 'fail'\n): Converter<Map<TK, T>, TC> {\n  const options = typeof option === 'string' ? { onError: option } : { onError: 'fail', ...option };\n  return new BaseConverter((from: unknown, __self: Converter<Map<TK, T>, TC>, context?: TC) => {\n    if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n      return fail(`Not a string-keyed object: ${JSON.stringify(from)}`);\n    }\n\n    const map = new Map<TK, T>();\n    const errors: string[] = [];\n\n    for (const key in from) {\n      if (isKeyOf(key, from)) {\n        const writeKeyResult = options.keyConverter?.convert(key, context) ?? succeed(key);\n\n        writeKeyResult\n          .onSuccess((writeKey) => {\n            return converter.convert(from[key] as unknown, context).onSuccess((value) => {\n              map.set(writeKey, value);\n              return succeed(true);\n            });\n          })\n          .onFailure((message) => {\n            errors.push(message);\n            return fail(message);\n          });\n      }\n    }\n\n    return errors.length === 0 || options.onError === 'ignore' ? succeed(map) : fail(errors.join('\\n'));\n  });\n}\n\n/**\n * Helper function to create  a {@link Converter | Converter} which validates that a supplied value is\n * of a type validated by a supplied validator function and returns it.\n * @remarks\n * If `validator` succeeds, this {@link Converter | Converter} returns {@link Success | Success} with the supplied\n * value of `from` coerced to type `<T>`.  Returns a {@link Failure | Failure} with additional\n * information otherwise.\n * @param validator - A validator function to determine if the converted value is valid.\n * @param description - A description of the validated type for use in error messages.\n * @returns A new {@link Converter | Converter<T, TC>} which applies the supplied validation.\n * @public\n */\nexport function validateWith<T, TC = unknown>(\n  validator: (from: unknown) => from is T,\n  description?: string\n): Converter<T, TC> {\n  return new BaseConverter((from: unknown, __self: Converter<T, TC>, __context?: TC) => {\n    if (validator(from)) {\n      return succeed(from);\n    }\n    return fail(`${JSON.stringify(from)}: invalid ${description ?? 'value'}`);\n  });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and converts an element from an array.\n * @remarks\n * The returned {@link Converter | Converter} returns {@link Success | Success} with the converted value if the element exists\n * in the supplied array and can be converted. Returns {@link Failure | Failure} with an error message otherwise.\n * @param index - The index of the element to be extracted.\n * @param converter - A {@link Converter | Converter} or {@link Validator | Validator} for the extracted element.\n * @returns A {@link Converter | Converter<T, TC>} which extracts the specified element from an array.\n * @public\n */\nexport function element<T, TC = unknown>(\n  index: number,\n  converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T, TC> {\n  return new BaseConverter((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n    if (index < 0) {\n      return fail(`${index}: cannot convert for a negative element index`);\n    } else if (!Array.isArray(from)) {\n      return fail('element converter: source is not an array');\n    } else if (index >= from.length) {\n      return fail(`${index}: element converter index out of range (0..${from.length - 1})`);\n    }\n    return converter.convert(from[index], context);\n  });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and converts an optional element from an array.\n * @remarks\n * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value if the element exists\n * in the supplied array and can be converted. Returns {@link Success | Success} with value `undefined` if the parameter\n * is an array but the index is out of range. Returns {@link Failure | Failure} with a message if the supplied parameter\n * is not an array, if the requested index is negative, or if the element cannot be converted.\n * @param index - The index of the element to be extracted.\n * @param converter - A {@link Converter | Converter} or {@link Validator | Validator} used for the extracted element.\n * @returns A {@link Converter | Converter<T, TC>} which extracts the specified element from an array.\n * @public\n */\nexport function optionalElement<T, TC = unknown>(\n  index: number,\n  converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T | undefined, TC> {\n  return new BaseConverter((from: unknown, __self: Converter<T | undefined, TC>, context?: TC) => {\n    if (index < 0) {\n      return fail(`${index}: cannot convert for a negative element index`);\n    } else if (!Array.isArray(from)) {\n      return fail('element converter: source is not an array');\n    } else if (index >= from.length) {\n      return succeed(undefined);\n    }\n    return converter.convert(from[index], context);\n  });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and convert a property specified\n * by name from an object.\n * @remarks\n * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value of the corresponding\n * object property if the field exists and can be converted. Returns {@link Failure | Failure} with an error message\n * otherwise.\n * @param name - The name of the field to be extracted.\n * @param converter - {@link Converter | Converter}  or {@link Validator | Validator} to use for the extracted\n * field.\n * @public\n */\nexport function field<T, TC = unknown>(\n  name: string,\n  converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T, TC> {\n  return new BaseConverter((from: unknown, __self: Converter<T, TC>, context?: TC) => {\n    if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n      if (isKeyOf(name, from)) {\n        return converter.convert(from[name], context).onFailure((message) => {\n          return fail(`Field ${name}: ${message}`);\n        });\n      }\n      return fail(`Field ${name} not found in: ${JSON.stringify(from)}`);\n    }\n    return fail(`Cannot convert field \"${name}\" from non-object ${JSON.stringify(from)}`);\n  });\n}\n\n/**\n * A helper function to create a {@link Converter | Converter} which extracts and convert a property specified\n * by name from an object.\n * @remarks\n * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value of\n * the corresponding object property if the field exists and can be converted. Returns {@link Success | Success}\n * with `undefined` if the supplied parameter is an object but the named field is not present.\n * Returns {@link Failure | Failure} with an error message otherwise.\n * @param name - The name of the field to be extracted.\n * @param converter - {@link Converter | Converter} or {@link Validator | Validator} to use for the extracted field.\n * @public\n */\nexport function optionalField<T, TC = unknown>(\n  name: string,\n  converter: Converter<T, TC> | Validator<T, TC>\n): Converter<T | undefined, TC> {\n  return new BaseConverter(\n    (from: unknown, __self: Converter<T | undefined, TC>, context?: TC) => {\n      if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n        if (isKeyOf(name, from)) {\n          const result = converter.convert(from[name], context).onFailure((message) => {\n            return fail(`${name}: ${message}`);\n          });\n\n          // if conversion was successful or input was undefined we\n          // succeed with 'undefined', but we propagate actual\n          // failures.\n          if (result.isSuccess() || from[name] !== undefined) {\n            return result;\n          }\n        }\n        return succeed(undefined);\n      }\n      return fail(`Cannot convert field \"${name}\" from non-object ${JSON.stringify(from)}`);\n    },\n    undefined,\n    { isOptional: true }\n  );\n}\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} which converts an object\n * without changing shape, given a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and an optional\n * {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>} to further refine conversion behavior.\n * @remarks\n * By default, if all of the requested fields exist and can be converted, returns {@link Success | Success}\n * with a new object that contains the converted values under the original key names.  If any required properties\n * do not exist or cannot be converted, the entire conversion fails, returning {@link Failure | Failure} with additional\n * error information.\n *\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n * @param properties - An {@link Conversion.FieldConverters | FieldConverters<T, TC>} defining the shape of the\n * source object and {@link Converter | converters} to be applied to each properties.\n * @param options - An {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>} containing options\n * for the object converter.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function object<T, TC = unknown>(\n  properties: FieldConverters<T, TC>,\n  options?: ObjectConverterOptions<T>\n): ObjectConverter<T, TC>;\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} which converts an object\n * without changing shape, given a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and a set of\n * optional properties.\n * @remarks\n * By default, if all of the requested fields exist and can be converted, returns {@link Success | Success}\n * with a new object that contains the converted values under the original key names.  If any required properties\n * do not exist or cannot be converted, the entire conversion fails, returning {@link Failure | Failure} with additional\n * error information.\n *\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n * @param properties - An {@link Conversion.FieldConverters | FieldConverters<T, TC>} defining the shape of the\n * source object and {@link Converter | converters} to be applied to each properties.\n * @param optional - An array of `(keyof T)` listing the keys to be considered optional.\n * {@label WITH_KEYS}\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * @public\n * @deprecated Use {@link Converters.(object:1) | Converters.object(fields, options)} instead.\n */\n\nexport function object<T, TC = unknown>(\n  properties: FieldConverters<T, TC>,\n  optional: (keyof T)[]\n): ObjectConverter<T, TC>;\n\n/**\n * Concrete implementation of {@link Converters.(object:1) | Converters.object(fields, options)}\n * and {@link Converters.(object:2) | Converters.objects(fields, optionalKeys)}.\n * @internal\n */\nexport function object<T, TC>(\n  properties: FieldConverters<T, TC>,\n  options?: (keyof T)[] | ObjectConverterOptions<T>\n): ObjectConverter<T, TC> {\n  return new ObjectConverter(properties, options as ObjectConverterOptions<T>);\n}\n\n/**\n * Options for the {@link strictObject} helper function.\n * @public\n */\nexport type StrictObjectConverterOptions<T> = Omit<ObjectConverterOptions<T>, 'strict'>;\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter} which converts an object\n * without changing shape, a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and an optional\n * {@link Converters.StrictObjectConverterOptions | StrictObjectConverterOptions<T>} to further refine\n * conversion behavior.\n *\n * @remarks\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n *\n * The conversion fails if any unexpected fields are encountered.\n *\n * @param properties - An object containing defining the shape and converters to be applied.\n * @param options - An optional @see StrictObjectConverterOptions<T> containing options for the object converter.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * {@label WITH_OPTIONS}\n * @public\n */\nexport function strictObject<T, TC = unknown>(\n  properties: FieldConverters<T, TC>,\n  options?: StrictObjectConverterOptions<T>\n): ObjectConverter<T, TC>;\n\n/**\n * Helper function to create a {@link Conversion.ObjectConverter | ObjectConverter} which converts an object\n * without changing shape, a {@link Conversion.FieldConverters | FieldConverters<T, TC>} and an optional\n * {@link Converters.StrictObjectConverterOptions | StrictObjectConverterOptions<T>} to further refine\n * conversion behavior.\n *\n * @remarks\n * Fields that succeed but convert to undefined are omitted from the result object but do not\n * fail the conversion.\n *\n * The conversion fails if any unexpected fields are encountered.\n *\n * @param properties - An object containing defining the shape and converters to be applied.\n * @param optional - An array of `keyof T` containing keys to be considered optional.\n * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} which applies the specified conversions.\n * {@label WITH_KEYS}\n * @deprecated Use {@link Converters.strictObject | Converters.strictObject(options)} instead.\n * @public\n */\nexport function strictObject<T, TC = unknown>(\n  properties: FieldConverters<T, TC>,\n  optional: (keyof T)[]\n): ObjectConverter<T, TC>;\n\n/**\n * Concrete implementation for {@link Converters.strictObject | Converters.strictObject(fields, options)}\n * and {@link Converters.strictObject | Converters.strictObject(fields, optional)}.\n * @internal\n */\nexport function strictObject<T, TC = unknown>(\n  properties: FieldConverters<T, TC>,\n  opt?: (keyof T)[] | StrictObjectConverterOptions<T>\n): ObjectConverter<T, TC> {\n  /* c8 ignore next 2 */\n  const options: ObjectConverterOptions<T> =\n    opt && Array.isArray(opt) ? { strict: true, optionalFields: opt } : { ...(opt ?? {}), strict: true };\n  return new ObjectConverter<T, TC>(properties, options);\n}\n\n/**\n * A string-keyed `Record<string, Converter>` which maps specific {@link Converter | converters} or\n * {@link Validator | Validators} to the value of a discriminator property.\n * @public\n */\nexport type DiscriminatedObjectConverters<T, TD extends string = string, TC = unknown> = Record<\n  TD,\n  Converter<T, TC> | Validator<T, TC>\n>;\n\n/**\n * Helper to create a {@link Converter | Converter} which converts a discriminated object without changing shape.\n * @remarks\n * Takes the name of the discriminator property and a\n * {@link Converters.DiscriminatedObjectConverters | string-keyed Record of converters and validators}. During conversion,\n * the resulting {@link Converter | Converter} invokes the converter from `converters` that corresponds to the value of\n * the discriminator property in the source object.\n *\n * If the source is not an object, the discriminator property is missing, or the discriminator has\n * a value not present in the converters, conversion fails and returns {@link Failure | Failure} with more information.\n *\n * The `self` reference of the outer converter is threaded through to per-arm converter invocations,\n * enabling recursive discriminated-union parsers where arms recurse via `self`.\n * @param discriminatorProp - Name of the property used to discriminate types.\n * @param converters - {@link Converters.DiscriminatedObjectConverters | String-keyed record of converters and validators}\n * to invoke, where each key corresponds to a value of the discriminator property.\n * @returns A {@link Converter | Converter} which converts the corresponding discriminated object.\n * @public\n */\nexport function discriminatedObject<T, TD extends string = string, TC = unknown>(\n  discriminatorProp: string,\n  converters: DiscriminatedObjectConverters<T, TD>\n): Converter<T, TC> {\n  return new BaseConverter<T, TC>((from: unknown, self: Converter<T, TC>, context?: TC) => {\n    if (typeof from !== 'object' || Array.isArray(from) || from === null) {\n      return fail(`Not a discriminated object: \"${JSON.stringify(from)}\"`);\n    }\n    if (!isKeyOf(discriminatorProp, from) || !from[discriminatorProp]) {\n      return fail(`Discriminator property ${discriminatorProp} not present in \"${JSON.stringify(from)}\"`);\n    }\n\n    const discriminatorValue = from[discriminatorProp] as TD;\n    const arm = converters[discriminatorValue];\n    if (arm === undefined) {\n      return fail(`No converter for discriminator ${discriminatorProp}=\"${discriminatorValue}\"`);\n    }\n    // Thread the outer self and context through to the arm so that recursive\n    // discriminated-union parsers can reach the outer dispatcher via self.\n    if (isValidator(arm)) {\n      return arm.convert(from, context);\n    }\n    return arm.convert(from, context, self);\n  });\n}\n"]}

package/dist/packlets/conversion/converter.js

@@ -1,2 +1,12 @@
-export {};
+// Untyped (literal-tuple-inferred) source of truth for allOnError, kept separate from the widened
+// public export below so the exhaustiveness check actually inspects the literal values instead of
+// being widened away to {@link Conversion.OnError | OnError} before the check runs.
+const onErrorValues = ['failOnError', 'ignoreErrors'];
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const _onErrorExhaustivenessCheck = true;
+/**
+ * Exhaustive list of all {@link Conversion.OnError | OnError} values.
+ * @public
+ */
+export const allOnError = onErrorValues;
 //# sourceMappingURL=converter.js.map

package/dist/packlets/conversion/converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"converter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/converter.ts"],"names":[],"mappings":"AA6BA,kGAAkG;AAClG,kGAAkG;AAClG,oFAAoF;AACpF,MAAM,aAAa,GAAG,CAAC,aAAa,EAAE,cAAc,CAAU,CAAC;AAc/D,6DAA6D;AAC7D,MAAM,2BAA2B,GAAgC,IAAI,CAAC;AAEtE;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAuB,aAAa,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 */\nimport { Brand, Result, Success } from '../base';\n\n/**\n * Action to take on conversion failures.\n * @public\n */\nexport type OnError = 'failOnError' | 'ignoreErrors';\n\n// Untyped (literal-tuple-inferred) source of truth for allOnError, kept separate from the widened\n// public export below so the exhaustiveness check actually inspects the literal values instead of\n// being widened away to {@link Conversion.OnError | OnError} before the check runs.\nconst onErrorValues = ['failOnError', 'ignoreErrors'] as const;\n\n/**\n * Compile-time exhaustiveness guard ensuring {@link onErrorValues} exactly matches every member of\n * {@link Conversion.OnError | OnError}. Adding or removing a union member without updating the array fails the build.\n * Deliberately not exported - this exists only to force the compiler to evaluate the check below.\n */\ntype _OnErrorExhaustivenessCheck = [\n  Exclude<OnError, (typeof onErrorValues)[number]>,\n  Exclude<(typeof onErrorValues)[number], OnError>\n] extends [never, never]\n  ? true\n  : never;\n\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nconst _onErrorExhaustivenessCheck: _OnErrorExhaustivenessCheck = true;\n\n/**\n * Exhaustive list of all {@link Conversion.OnError | OnError} values.\n * @public\n */\nexport const allOnError: readonly OnError[] = onErrorValues;\n\n/**\n * Converter traits.\n * @public\n */\n\nexport interface ConverterTraits {\n  readonly isOptional: boolean;\n  readonly brand?: string;\n}\n\n/**\n * Formats an incoming error message and value that failed validation.\n * @param val - The value that failed validation.\n * @param message - The default error message, if any.\n * @param context - Optional validation context.\n * @returns The formatted error message.\n * @public\n */\nexport type ConversionErrorFormatter<TC = unknown> = (val: unknown, message?: string, context?: TC) => string;\n\n/**\n * Options for {@link Converter.withConstraint}.\n * @public\n */\n\nexport interface ConstraintOptions {\n  /**\n   * Optional description for error messages when constraint\n   * function returns false.\n   */\n  readonly description: string;\n}\n\n/**\n * Generic converter to convert unknown to a templated type `<T>`, using\n * intrinsic rules or as modified by an optional conversion context\n * of optional templated type `<TC>` (default `undefined`).\n * @public\n */\n\nexport interface Converter<T, TC = unknown> extends ConverterTraits {\n  /**\n   *\n   * Indicates whether this element is explicitly optional.\n   */\n  readonly isOptional: boolean;\n\n  /**\n   * Returns the brand for a branded type.\n   */\n  readonly brand?: string;\n\n  /**\n   * Converts from `unknown` to `<T>`.  For objects and arrays, is guaranteed\n   * to return a new entity, with any unrecognized properties removed.\n   * @param from - The `unknown` to be converted\n   * @param context - An optional conversion context of type `<TC>` to be used in\n   * the conversion.\n   * @param selfOverride - An optional override for the `self` reference passed to the\n   * converter function, enabling outer converters (e.g. discriminated-object) to thread\n   * themselves through to per-arm converters for recursive parsing.\n   * @returns A {@link Result} with a {@link Success} and a value on success or an\n   * {@link Failure} with a a message on failure.\n   */\n  convert(from: unknown, context?: TC, selfOverride?: Converter<T, TC>): Result<T>;\n\n  /**\n   * Converts from `unknown` to `<T>` or `undefined`, as appropriate.\n   *\n   * @remarks\n   * If `onError` is `failOnError`, the converter succeeds for\n   * `undefined` or any convertible value, but reports an error\n   * if it encounters a value that cannot be converted.\n   *\n   * If `onError` is `ignoreErrors` (default) then values that\n   * cannot be converted result in a successful return of `undefined`.\n   * @param from - The `unknown` to be converted\n   * @param context - An optional conversion context of type `<TC>` to be used in\n   * the conversion.\n   * @param onError - Specifies handling of values that cannot be converted (default `ignoreErrors`).\n   * @returns A {@link Result} with a {@link Success} and a value on success or an\n   * {@link Failure} with a a message on failure.\n   */\n  convertOptional(from: unknown, context?: TC, onError?: OnError): Result<T | undefined>;\n\n  /**\n   * Creates a {@link Converter} for an optional value.\n   *\n   * @remarks\n   * If `onError` is `failOnError`, the resulting converter will accept `undefined`\n   * or a convertible value, but report an error if it encounters a value that cannot be\n   * converted.\n   *\n   * If `onError` is `ignoreErrors` (default) then values that cannot be converted will\n   * result in a successful return of `undefined`.\n   *\n   * @param onError - Specifies handling of values that cannot be converted (default `ignoreErrors`).\n   * @returns A new {@link Converter} returning `<T|undefined>`.\n   * */\n  optional(onError?: OnError): Converter<T | undefined, TC>;\n\n  /**\n   * Creates a {@link Converter} which applies a (possibly) mapping conversion to\n   * the converted value of this {@link Converter}.\n   * @param mapper - A function which maps from the the result type `<T>` of this\n   * converter to a new result type `<T2>`.\n   * @returns A new {@link Converter} returning `<T2>`.\n   */\n  map<T2>(mapper: (from: T, context?: TC) => Result<T2>): Converter<T2, TC>;\n\n  /**\n   * Creates a {@link Converter} which applies an additional supplied\n   * converter to the result of this converter.\n   *\n   * @param mapConverter - The {@link Converter} to be applied to the\n   * converted result from this {@link Converter}.\n   * @returns A new {@link Converter} returning `<T2>`.\n   */\n  mapConvert<T2>(mapConverter: Converter<T2, unknown>): Converter<T2, TC>;\n\n  /**\n   * Creates a {@link Converter} which maps the individual items of a collection\n   * resulting from this {@link Converter} using the supplied map function.\n   *\n   * @remarks\n   * Fails if `from` is not an array.\n   *\n   * @param mapper - The map function to be applied to each element of the\n   * result of this {@link Converter}.\n   * @returns A new {@link Converter} returning `<TI[]>`.\n   */\n  mapItems<TI>(mapper: (from: unknown, context?: TC) => Result<TI>): Converter<TI[], TC>;\n\n  /**\n   * Creates a {@link Converter} which maps the individual items of a collection\n   * resulting from this {@link Converter} using the supplied {@link Converter}.\n   *\n   * @remarks\n   * Fails if `from` is not an array.\n   *\n   * @param mapConverter - The {@link Converter} to be applied to each element of the\n   * result of this {@link Converter}.\n   * @returns A new {@link Converter} returning `<TI[]>`.\n   */\n  mapConvertItems<TI>(mapConverter: Converter<TI, unknown>): Converter<TI[], TC>;\n\n  /**\n   * Creates a {@link Converter | Converter} which applies a supplied action after\n   * conversion.  The supplied action is always called regardless of success or failure\n   * of the base conversion and is allowed to mutate the return type.\n   * @param action - The action to be applied.\n   */\n  withAction<T2>(action: (result: Result<T>, context?: TC) => Result<T2>): Converter<T2, TC>;\n\n  /**\n   * Creates a {@link Converter} which applies a supplied type guard to the conversion\n   * result.\n   * @param guard - The type guard function to apply.\n   * @param message - Optional message to be reported if the type guard fails.\n   * @returns A new {@link Converter} returning `<TI>`.\n   */\n  withTypeGuard<TI>(guard: (from: unknown, context?: TC) => from is TI, message?: string): Converter<TI, TC>;\n\n  /**\n   * Creates a {@link Converter} which applies a supplied type guard to each member of\n   * the conversion result from this converter.\n   *\n   * @remarks\n   * Fails if the conversion result is not an array or if any member fails the\n   * type guard.\n   * @param guard - The type guard function to apply to each element.\n   * @param message - Optional message to be reported if the type guard fails.\n   * @returns A new {@link Converter} returning `<TI>`.\n   */\n  withItemTypeGuard<TI>(\n    guard: (from: unknown, context?: TC) => from is TI,\n    message?: string\n  ): Converter<TI[], TC>;\n\n  /**\n   * Creates a {@link Converter} which applies an optional constraint to the result\n   * of this conversion.  If this {@link Converter} (the base converter) succeeds, the new\n   * converter calls a supplied constraint evaluation function with the conversion, which\n   * fails the entire conversion if the constraint function returns either `false` or\n   * {@link Failure | Failure<T>}.\n   *\n   * @param constraint - Constraint evaluation function.\n   * @param options - {@link Conversion.ConstraintOptions | Options} for constraint evaluation.\n   * @returns A new {@link Converter} returning `<T>`.\n   */\n  withConstraint(\n    constraint: (val: T, context?: TC) => boolean | Result<T>,\n    options?: ConstraintOptions\n  ): Converter<T, TC>;\n\n  /**\n   * Creates a new {@link Converter} which is derived from this one but which returns an\n   * error message formatted by the supplied formatter if the conversion fails.\n   * @param formatter - The formatter to be applied.\n   * @returns A new {@link Converter} returning `<T>`.\n   */\n  withFormattedError(formatter: ConversionErrorFormatter<TC>): Converter<T, TC>;\n\n  /**\n   * returns a converter which adds a brand to the type to prevent mismatched usage\n   * of simple types.\n   * @param brand - The brand to be applied to the result value.\n   * @returns A {@link Converter} returning `Brand<T, B>`.\n   */\n  withBrand<B extends string>(brand: B): Converter<Brand<T, B>, TC>;\n\n  /**\n   * Returns a Converter which always succeeds with a default value rather than failing.\n   */\n  withDefault<TD = T>(dflt: TD): DefaultingConverter<T, TD, TC>;\n\n  /**\n   * Chains this converter with another of the same type, to be attempted if this\n   * converter fails.\n   * @param other -\n   */\n  or(other: Converter<T, TC>): Converter<T, TC>;\n}\n\n/**\n * @public\n */\n\nexport interface DefaultingConverter<T, TD = T, TC = unknown> extends Converter<T | TD, TC> {\n  /**\n   * Default value to use if the conversion fails.\n   */\n  readonly defaultValue: TD;\n\n  /**\n   * Convert the supplied `unknown` to `Success<T>` or to the `Success` with the default value\n   * if conversion is not possible.\n   * @param from - the value to be converted.\n   * @param ctx - optional context for the conversion.\n   */\n  convert(from: unknown, ctx?: TC): Success<T | TD>;\n}\n"]}

package/dist/packlets/conversion/converters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"converters.js","sourceRoot":"","sources":["../../../src/packlets/conversion/converters.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC","sourcesContent":["/*\n * Copyright (c) 2026 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\nexport * from './basicConverters';\nexport * from './advancedConverters';\n"]}

package/dist/packlets/conversion/defaultingConverter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultingConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/defaultingConverter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAA0B,OAAO,EAAE,MAAM,SAAS,CAAC;AAG1D;;;;GAIG;AACH,MAAM,OAAO,0BAA0B;IAQrC;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,YAAmB,SAA2B,EAAE,YAAgB;QAC9D,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,IAAa,EAAE,GAAoB;QAChD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,eAAe,CACpB,IAAa,EACb,OAAwB,EACxB,OAAsD;QAEtD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC1E,IAAI,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC;YAC1B,OAAO,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,OAAsD;QACpE,6EAA6E;QAC7E,sBAAsB;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACI,GAAG,CAAK,MAAoC;QACjD,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACI,UAAU,CAAK,YAAoC;QACxD,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACI,QAAQ,CAAK,MAAqC;QACvD,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACI,eAAe,CAAK,YAAoC;QAC7D,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IAC1G,CAAC;IAED;;OAEG;IACI,UAAU,CAAK,MAA8C;QAClE,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC/F,CAAC;IAED;;OAEG;IACI,aAAa,CAClB,KAAoC,EACpC,OAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACjG,CAAC;IAED;;OAEG;IACI,iBAAiB,CACtB,KAAoC,EACpC,OAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACI,cAAc,CACnB,UAAqD,EACrD,OAAuC;QAEvC,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACvG,CAAC;IAED;;OAEG;IACI,SAAS,CAAmB,KAAQ;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,SAAuC;QAC/D,wEAAwE;QACxE,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAU,IAAS;QACnC,OAAO,IAAI,0BAA0B,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACI,EAAE,CAAC,WAA6B;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,aAAa,CAAS,SAAqB;QACjD,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACpE,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Brand, Result, Success, succeed } from '../base';\nimport { ConstraintOptions, ConversionErrorFormatter, Converter, DefaultingConverter } from './converter';\n\n/**\n * Generic {@link Conversion.DefaultingConverter | DefaultingConverter}, which wraps another converter\n * to substitute a supplied default value for any errors returned by the inner converter.\n * @public\n */\nexport class GenericDefaultingConverter<T, TD = T, TC = unknown> implements DefaultingConverter<T, TD, TC> {\n  private _converter: Converter<T, TC>;\n\n  /**\n   * {@inheritDoc Conversion.DefaultingConverter.defaultValue}\n   */\n  public defaultValue: TD;\n\n  /**\n   * {@inheritDoc Converter.isOptional}\n   */\n  public get isOptional(): boolean {\n    return this._converter.isOptional;\n  }\n\n  /**\n   * {@inheritDoc Converter.isOptional}\n   */\n  public get brand(): string | undefined {\n    return this._converter.brand;\n  }\n\n  /**\n   * Constructs a new {@link Conversion.GenericDefaultingConverter | generic defaulting converter}.\n   * @param converter - inner {@link Converter | Converter} used for the base conversion.\n   * @param defaultValue - default value to be supplied if the inner conversion fails.\n   */\n  public constructor(converter: Converter<T, TC>, defaultValue: TD) {\n    this.defaultValue = defaultValue;\n    this._converter = converter;\n  }\n\n  /**\n   * {@inheritDoc Converter.convert}\n   */\n  public convert(from: unknown, ctx?: TC | undefined): Success<T | TD> {\n    return this._applyDefault(this._converter.convert(from, ctx));\n  }\n\n  /**\n   * {@inheritDoc Converter.convertOptional}\n   */\n  public convertOptional(\n    from: unknown,\n    context?: TC | undefined,\n    onError?: ('failOnError' | 'ignoreErrors') | undefined\n  ): Result<T | TD | undefined> {\n    const converted = this._converter.convertOptional(from, context, onError);\n    if (converted.isFailure()) {\n      return succeed(this.defaultValue);\n    }\n    return converted;\n  }\n\n  /**\n   * {@inheritDoc Converter.optional}\n   */\n  public optional(onError?: ('failOnError' | 'ignoreErrors') | undefined): Converter<T | TD | undefined, TC> {\n    // need to let the inner converter do its optional thing first or our default\n    // steps on everything\n    return this._converter.optional(onError).withAction((result) => this._applyDefault(result));\n  }\n\n  /**\n   * {@inheritDoc Converter.map}\n   */\n  public map<T2>(mapper: (from: T | TD) => Result<T2>): Converter<T2, TC> {\n    return this._converter.withAction((result) => this._applyDefault(result)).map(mapper);\n  }\n\n  /**\n   * {@inheritDoc Converter.mapConvert}\n   */\n  public mapConvert<T2>(mapConverter: Converter<T2, unknown>): Converter<T2, TC> {\n    return this._converter.withAction((result) => this._applyDefault(result)).mapConvert(mapConverter);\n  }\n\n  /**\n   * {@inheritDoc Converter.mapItems}\n   */\n  public mapItems<TI>(mapper: (from: unknown) => Result<TI>): Converter<TI[], TC> {\n    return this._converter.withAction((result) => this._applyDefault(result)).mapItems(mapper);\n  }\n\n  /**\n   * {@inheritDoc Converter.mapConvertItems}\n   */\n  public mapConvertItems<TI>(mapConverter: Converter<TI, unknown>): Converter<TI[], TC> {\n    return this._converter.withAction((result) => this._applyDefault(result)).mapConvertItems(mapConverter);\n  }\n\n  /**\n   * {@inheritDoc Converter.withAction}\n   */\n  public withAction<T2>(action: (result: Result<T | TD>) => Result<T2>): Converter<T2, TC> {\n    return this._converter.withAction((result) => this._applyDefault(result)).withAction(action);\n  }\n\n  /**\n   * {@inheritDoc Converter.withTypeGuard}\n   */\n  public withTypeGuard<TI>(\n    guard: (from: unknown) => from is TI,\n    message?: string | undefined\n  ): Converter<TI, TC> {\n    return this._converter.withAction((result) => this._applyDefault(result)).withTypeGuard(guard);\n  }\n\n  /**\n   * {@inheritDoc Converter.withItemTypeGuard}\n   */\n  public withItemTypeGuard<TI>(\n    guard: (from: unknown) => from is TI,\n    message?: string | undefined\n  ): Converter<TI[], TC> {\n    return this._converter.withAction((result) => this._applyDefault(result)).withItemTypeGuard(guard);\n  }\n\n  /**\n   * {@inheritDoc Converter.withConstraint}\n   */\n  public withConstraint(\n    constraint: (val: T | TD) => boolean | Result<T | TD>,\n    options?: ConstraintOptions | undefined\n  ): Converter<T | TD, TC> {\n    return this._converter.withAction((result) => this._applyDefault(result)).withConstraint(constraint);\n  }\n\n  /**\n   * {@inheritDoc Converter.withBrand}\n   */\n  public withBrand<B extends string>(brand: B): Converter<Brand<T | TD, B>, TC> {\n    return this._converter.withAction((result) => this._applyDefault(result)).withBrand(brand);\n  }\n\n  /**\n   * {@inheritDoc Converter.withFormattedError}\n   */\n  public withFormattedError(formatter: ConversionErrorFormatter<TC>): Converter<T | TD, TC> {\n    // formatter should never actually be invoked for a defaulting converter\n    return this._converter.withAction((result) => this._applyDefault(result)).withFormattedError(formatter);\n  }\n\n  /**\n   * Returns a Converter which always succeeds with the supplied default value rather\n   * than failing.\n   *\n   * Note that the supplied default value *overrides* the default value of this\n   * {@link Conversion.DefaultingConverter | DefaultingConverter}.\n   */\n  public withDefault<TD2 = T>(dflt: TD2): DefaultingConverter<T, TD2, TC> {\n    return new GenericDefaultingConverter(this._converter, dflt);\n  }\n\n  /**\n   * {@inheritDoc Converter.or}\n   */\n  public or(__converter: Converter<T, TC>): DefaultingConverter<T, TD, TC> {\n    return this;\n  }\n\n  private _applyDefault<T2 = T>(converted: Result<T2>): Success<T2 | TD> {\n    return converted.success ? converted : succeed(this.defaultValue);\n  }\n}\n"]}

package/dist/packlets/conversion/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/conversion/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAE3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,CAAC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Converters from './converters';\n\nexport * from './baseConverter';\nexport * from './converter';\nexport * from './defaultingConverter';\nexport * from './objectConverter';\nexport * from './stringConverter';\nexport { Converters };\n"]}

package/dist/packlets/conversion/objectConverter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objectConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/objectConverter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,IAAI,EAAE,OAAO,EAAU,OAAO,EAAE,MAAM,SAAS,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAsCpD;;;;;;;;;GASG;AACH,MAAM,OAAO,eAAiC,SAAQ,aAAoB;IA+BxE;;;OAGG;IACH,YAAmB,MAA8B,EAAE,GAA6C;QAC9F,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;QAE7F,KAAK,CAAC,CAAC,IAAa,EAAE,MAAM,EAAE,OAAY,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAEzG,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,IAAa,EAAE,OAAY;QAC/C,MAAM,OAAO,mCAAmC,IAAI,CAAC,OAAO,KAAE,QAAQ,EAAE,SAAS,GAAE,CAAC;QACpF,OAAO,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;OAMG;IACI,eAAe,CAAC,IAAa,EAAE,OAAY;QAChD,MAAM,OAAO,mCAAmC,IAAI,CAAC,OAAO,KAAE,QAAQ,EAAE,UAAU,GAAE,CAAC;QACrF,OAAO,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,CAAwB,CAAC;IAC9F,CAAC;IA+BD;;;;;OAKG;IACI,OAAO,CAAC,GAA6C;QAC1D,MAAM,OAAO,GACX,GAAG,KAAK,SAAS;YACf,CAAC,iCAAM,IAAI,CAAC,OAAO,KAAE,QAAQ,EAAE,SAAS,IACxC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;YACpB,CAAC,iCAAM,IAAI,CAAC,OAAO,KAAE,cAAc,EAAE,CAAC,GAAG,GAAG,CAAC,IAC7C,CAAC,CAAE,GAA0C,CAAC;QAClD,OAAO,IAAI,eAAe,CAAiB,IAAI,CAAC,MAAyC,EAAE,OAAO,CAAC,CAAC,KAAK,CACvG,IAAI,CAAC,OAAO,EAAE,CACf,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,qBAAkC;;QAClD,kDAAkD;QAClD,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,mCAAI,EAAE,CAAC;QACrD,MAAM,QAAQ,GAAG,CAAC,GAAG,UAAU,EAAE,GAAG,qBAAqB,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACb,MAAM,OAAO,mCAA6C,IAAI,CAAC,OAAO,KAAE,QAAQ,EAAE,UAAU,GAAE,CAAC;QAC/F,OAAO,IAAI,eAAe,CACxB,IAAI,CAAC,MAA0C,EAC/C,OAAO,CACR,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1B,CAAC;IAEO,MAAM,CAAC,QAAQ,CACrB,IAAa,EACb,OAAuB,EACvB,MAA8B,EAC9B,OAAkC;QAElC,+CAA+C;;QAE/C,MAAM,SAAS,GAAG,EAAkC,CAAC;QACrD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChB,MAAM,UAAU,GACd,OAAO,CAAC,QAAQ,KAAK,SAAS;oBAC9B,CAAC,OAAO,CAAC,QAAQ,KAAK,UAAU;wBAC9B,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,KAAK,IAAI,IAAI,CAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,QAAQ,CAAC,GAAG,CAAC,MAAK,IAAI,CAAC,CAAC,CAAC;gBACzF,MAAM,MAAM,GAAG,UAAU;oBACvB,CAAC,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;oBACxD,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBACnD,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBACrD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;gBAChC,CAAC;qBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;oBAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACvB,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,EAAE,CAAC;wBACrF,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,wCAAwC,CAAC,CAAC;oBAC9D,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC;YACxB,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;YACpB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrG,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { fail, isKeyOf, Result, succeed } from '../base';\nimport { Validator } from '../validation';\nimport { BaseConverter } from './baseConverter';\nimport { Converter } from './converter';\nimport { field, optionalField } from './converters';\n\n/**\n * Options for an {@link Conversion.ObjectConverter | ObjectConverter}.\n * @public\n */\n\nexport interface ObjectConverterOptions<T> {\n  /**\n   * If present, lists optional fields. Missing non-optional fields cause an error.\n   */\n  optionalFields?: (keyof T)[];\n  /**\n   * If true, unrecognized fields yield an error.  If false or undefined (default),\n   * unrecognized fields are ignored.\n   */\n  strict?: boolean;\n  /**\n   * Optional description to be included in error messages.\n   */\n  description?: string;\n\n  /**\n   * Optional modifier to apply to the converter.\n   */\n  modifier?: 'partial' | 'required';\n}\n\n/**\n * Per-property converters or validators for each of the properties in type T.\n * @remarks\n * Used to construct a {@link Conversion.ObjectConverter | ObjectConverter}\n * @public\n */\nexport type FieldConverters<T, TC = unknown> = {\n  [key in keyof T]: Converter<T[key], TC | unknown> | Validator<T[key], TC>;\n};\n\n/**\n * A {@link Converter | Converter} which converts an object of type `<T>` without changing shape, given\n * a {@link Conversion.FieldConverters | FieldConverters<T>} for the fields in the object.\n * @remarks\n * By default, if all of the required fields exist and can be converted, returns a new object with\n * the converted values under the original key names.  If any required fields do not exist or cannot\n * be converted, the entire conversion fails. See {@link Conversion.ObjectConverterOptions | ObjectConverterOptions}\n * for other conversion options.\n * @public\n */\nexport class ObjectConverter<T, TC = unknown> extends BaseConverter<T, TC> {\n  /**\n   * Fields converted by this {@link Conversion.ObjectConverter | ObjectConverter}.\n   */\n  public readonly fields: FieldConverters<T, TC>;\n  /**\n   * Options used to initialize this {@link Conversion.ObjectConverter | ObjectConverter}.\n   */\n  public readonly options: ObjectConverterOptions<T>;\n\n  /**\n   * Constructs a new {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} using options\n   * supplied in a {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>}.\n   * @param fields - A {@link Conversion.FieldConverters | FieldConverters<T>} containing\n   * a {@link Converter} for each field\n   * @param options - An optional @see ObjectConverterOptions to configure the conversion\n   * {@label WITH_OPTIONS}\n   */\n  public constructor(fields: FieldConverters<T, TC>, options?: ObjectConverterOptions<T>);\n\n  /**\n   * Constructs a new {@link Conversion.ObjectConverter | ObjectConverter<T, TC>} with optional\n   * properties specified as an array of `keyof T`.\n   * @param fields - A {@link Conversion.FieldConverters | FieldConverters<T>} containing\n   * a {@link Converter} for each field.\n   * @param optional - An array of `keyof T` listing fields that are not required.\n   * {@label WITH_KEYS}\n   * @deprecated Use {@link Conversion.Converter.optional | .optional()} on the individual\n   * fields, or pass {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>} to the constructor.\n   */\n  public constructor(fields: FieldConverters<T, TC>, optional?: (keyof T)[]);\n  /**\n   * Concrete implementation of {@link Converters.(ObjectConverter:constructor)}\n   * @internal\n   */\n  public constructor(fields: FieldConverters<T, TC>, opt?: ObjectConverterOptions<T> | (keyof T)[]) {\n    const options = Array.isArray(opt) ? { optionalFields: opt } : opt ?? { optionalFields: [] };\n\n    super((from: unknown, __self, context?: TC) => ObjectConverter._convert(from, context, fields, options));\n\n    this.fields = fields;\n    this.options = options;\n  }\n\n  /**\n   * Converts the supplied object using the {@link Conversion.ObjectConverter | ObjectConverter}\n   * with all fields optional.\n   * @param from - The object to be converted.\n   * @param context - An optional context object passed to the field converters.\n   * @returns A {@link Result} containing the converted object or an error message.\n   */\n  public convertPartial(from: unknown, context?: TC): Result<Partial<T>> {\n    const options: ObjectConverterOptions<T> = { ...this.options, modifier: 'partial' };\n    return ObjectConverter._convert(from, context, this.fields, options);\n  }\n\n  /**\n   * Converts the supplied object using the {@link Conversion.ObjectConverter | ObjectConverter}\n   * with all fields required.\n   * @param from - The object to be converted.\n   * @param context - An optional context object passed to the field converters.\n   * @returns A {@link Result} containing the converted object or an error message.\n   */\n  public convertRequired(from: unknown, context?: TC): Result<Required<T>> {\n    const options: ObjectConverterOptions<T> = { ...this.options, modifier: 'required' };\n    return ObjectConverter._convert(from, context, this.fields, options) as Result<Required<T>>;\n  }\n\n  /**\n   * Creates a new {@link Conversion.ObjectConverter | ObjectConverter} derived from this one but with\n   * all properties optional.\n   * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} with the additional optional source properties.\n   * {@label WITHOUT_OPTIONS}\n   */\n  public partial(): ObjectConverter<Partial<T>, TC>;\n\n  /**\n   * Creates a new {@link Conversion.ObjectConverter | ObjectConverter} derived from this one but with\n   * new optional properties as specified by a supplied {@link Conversion.ObjectConverterOptions | ObjectConverterOptions<T>}.\n   * @param options - The {@link Conversion.ObjectConverterOptions | options} to be applied to the new\n   * converter.\n   * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} with the additional optional source properties.\n   * {@label WITH_OPTIONS}\n   * @deprecated Pass just the keys to be made optional.\n   */\n  public partial(options: ObjectConverterOptions<T>): ObjectConverter<Partial<T>, TC>;\n\n  /**\n   * Creates a new {@link Conversion.ObjectConverter | ObjectConverter} derived from this one but with\n   * new optional properties as specified by a supplied array of `keyof T`.\n   * @param optional - The keys of the source object properties to be made optional.\n   * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} with the additional optional source\n   * properties.\n   * {@label WITH_KEYS}\n   */\n  public partial(optional: (keyof T)[]): ObjectConverter<Partial<T>, TC>;\n\n  /**\n   * Concrete implementation of\n   * {@link Conversion.ObjectConverter.(partial:1) | ObjectConverter.partial(ObjectConverterOptions)} and\n   * {@link Conversion.ObjectConverter.(partial:2) | ObjectConverter.partial((keyof T))[]}.\n   * @internal\n   */\n  public partial(opt?: ObjectConverterOptions<T> | (keyof T)[]): ObjectConverter<Partial<T>, TC> {\n    const options: ObjectConverterOptions<Partial<T>> =\n      opt === undefined\n        ? { ...this.options, modifier: 'partial' }\n        : Array.isArray(opt)\n        ? { ...this.options, optionalFields: [...opt] }\n        : (opt as ObjectConverterOptions<Partial<T>>);\n    return new ObjectConverter<Partial<T>, TC>(this.fields as FieldConverters<Partial<T>, TC>, options)._with(\n      this._traits()\n    );\n  }\n\n  /**\n   * Creates a new {@link Conversion.ObjectConverter | ObjectConverter} derived from this one but with\n   * new optional properties as specified by a supplied array of `keyof T`.\n   * @param addOptionalProperties - The keys to be made optional.\n   * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} with the additional optional source\n   * properties.\n   */\n  public addPartial(addOptionalProperties: (keyof T)[]): ObjectConverter<Partial<T>, TC> {\n    /* c8 ignore next 1 - coverage having a bad day */\n    const myOptional = this.options.optionalFields ?? [];\n    const optional = [...myOptional, ...addOptionalProperties];\n    return this.partial(optional)._with(this._traits());\n  }\n\n  /**\n   * Creates a new {@link Conversion.ObjectConverter | ObjectConverter} derived from this one but with\n   * all properties required.\n   * @returns A new {@link Conversion.ObjectConverter | ObjectConverter} with the additional required source properties.\n   */\n  public required(): ObjectConverter<Required<T>, TC> {\n    const options: ObjectConverterOptions<Required<T>> = { ...this.options, modifier: 'required' };\n    return new ObjectConverter<Required<T>, TC>(\n      this.fields as FieldConverters<Required<T>, TC>,\n      options\n    )._with(this._traits());\n  }\n\n  private static _convert<T, TC>(\n    from: unknown,\n    context: TC | undefined,\n    fields: FieldConverters<T, TC>,\n    options: ObjectConverterOptions<T>\n  ): Result<T> {\n    // eslint bug thinks key is used before defined\n\n    const converted = {} as { [key in keyof T]: T[key] };\n    const errors: string[] = [];\n    for (const key in fields) {\n      if (fields[key]) {\n        const isOptional =\n          options.modifier === 'partial' ||\n          (options.modifier !== 'required' &&\n            (fields[key].isOptional === true || options.optionalFields?.includes(key) === true));\n        const result = isOptional\n          ? optionalField(key, fields[key]).convert(from, context)\n          : field(key, fields[key]).convert(from, context);\n        if (result.isSuccess() && result.value !== undefined) {\n          converted[key] = result.value;\n        } else if (result.isFailure()) {\n          errors.push(result.message);\n        }\n      }\n    }\n\n    if (options.strict === true) {\n      if (typeof from === 'object' && !Array.isArray(from)) {\n        for (const key in from) {\n          if (from.hasOwnProperty(key) && (!isKeyOf(key, fields) || fields[key] === undefined)) {\n            errors.push(`${key}: unexpected property in source object`);\n          }\n        }\n      } else {\n        errors.push('source is not an object');\n      }\n    }\n    return errors.length === 0\n      ? succeed(converted)\n      : fail(options.description ? `${options.description}: ${errors.join('\\n')}` : errors.join('\\n'));\n  }\n}\n"]}

package/dist/packlets/conversion/stringConverter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/stringConverter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAU,IAAI,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAiBhD;;;;;GAKG;AACH,MAAM,OAAO,eAAyD,SAAQ,aAAoB;IAChG;;;;;OAKG;IACH,YACE,cAAmB,EACnB,MAAwB,EACxB,YAAgF,eAAe,CAAC,QAAQ;QAExG,KAAK,CAAC,SAAS,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACO,MAAM,CAAC,QAAQ,CAAmB,IAAa;QACvD,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;OAEG;IACO,MAAM,CAAC,KAAK,CACpB,OAA+B,EAC/B,SAAiC,EACjC,MAAwB;QAExB,OAAO,IAAI,eAAe,CAAQ,SAAS,EAAE,SAAS,EAAE,CAAC,IAAa,EAAE,EAAE;YACxE,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACpC,CAAC;IA8CD;;;;;;OAMG;IACI,QAAQ,CACb,KAA0C,EAC1C,OAAqC;QAErC,MAAM,OAAO,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAC;QACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,KAAK,IAAI;oBACnB,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,sBAAsB,KAAK,GAAG,CAAC,CAAC;YACvF,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,KAAK,YAAY,MAAM,EAAE,CAAC;YACnC,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;oBACrB,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,sBAAsB,KAAK,GAAG,CAAC,CAAC;YACvF,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,KAAK,YAAY,GAAG,EAAE,CAAC;YAChC,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;oBACpB,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,qBAAqB,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;oBACzB,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,oBAAoB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC/F,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Result, fail, succeed } from '../base';\nimport { BaseConverter } from './baseConverter';\nimport { Converter, ConverterTraits } from './converter';\n\n/**\n * Options for {@link Conversion.StringConverter | StringConverter}\n * matching method\n * @public\n */\n\nexport interface StringMatchOptions {\n  /**\n   * An optional message to be displayed if a non-matching string\n   * is encountered.\n   */\n  message?: string;\n}\n\n/**\n * The {@link Conversion.StringConverter | StringConverter} class extends\n * {@link Conversion.BaseConverter | BaseConverter} to provide string-specific\n * helper methods.\n * @public\n */\nexport class StringConverter<T extends string = string, TC = unknown> extends BaseConverter<T, TC> {\n  /**\n   * Construct a new {@link Conversion.StringConverter | StringConverter}.\n   * @param defaultContext - Optional context used by the conversion.\n   * @param traits - Optional traits to be applied to the conversion.\n   * @param converter - Optional conversion function to be used for the conversion.\n   */\n  public constructor(\n    defaultContext?: TC,\n    traits?: ConverterTraits,\n    converter: (from: unknown, self: Converter<T, TC>, context?: TC) => Result<T> = StringConverter._convert\n  ) {\n    super(converter, defaultContext, traits);\n  }\n\n  /**\n   * @internal\n   */\n  protected static _convert<T extends string>(from: unknown): Result<T> {\n    return typeof from === 'string' ? succeed(from as T) : fail(`Not a string: ${JSON.stringify(from)}`);\n  }\n\n  /**\n   * @internal\n   */\n  protected static _wrap<T extends string, TC>(\n    wrapped: StringConverter<T, TC>,\n    converter: (from: T) => Result<T>,\n    traits?: ConverterTraits\n  ): StringConverter<T, TC> {\n    return new StringConverter<T, TC>(undefined, undefined, (from: unknown) => {\n      return wrapped.convert(from).onSuccess(converter);\n    })._with(wrapped._traits(traits));\n  }\n\n  /**\n   * Returns a {@link Conversion.StringConverter | StringConverter} which constrains the result to match\n   * a supplied string.\n   * @param match - The string to be matched\n   * @param options - Optional {@link Conversion.StringMatchOptions} for this conversion.\n   * @returns {@link Success} with a matching string or {@link Failure} with an informative\n   * error if the string does not match.\n   * {@label WITH_STRING}\n   */\n  public matching(match: string, options?: Partial<StringMatchOptions>): StringConverter<T, TC>;\n\n  /**\n   * Returns a {@link Conversion.StringConverter | StringConverter} which constrains the result to match\n   * one of a supplied array of strings.\n   * @param match - The array of allowed strings.\n   * @param options - Optional {@link Conversion.StringMatchOptions} for this conversion.\n   * @returns {@link Success} with a matching string or {@link Failure} with an informative\n   * error if the string does not match.\n   * {@label WITH_ARRAY}\n   */\n  public matching(match: string[], options?: Partial<StringMatchOptions>): StringConverter<T, TC>;\n\n  /**\n   * Returns a {@link Conversion.StringConverter | StringConverter} which constrains the result to match\n   * one of a supplied `Set` of strings.\n   * @param match - The `Set` of allowed strings.\n   * @param options - Optional {@link Conversion.StringMatchOptions} for this conversion.\n   * @returns {@link Success} with a matching string or {@link Failure} with an informative\n   * error if the string does not match.\n   * {@label WITH_SET}\n   */\n  public matching(match: Set<T>, options?: Partial<StringMatchOptions>): StringConverter<T, TC>;\n\n  /**\n   * Returns a {@link Conversion.StringConverter | StringConverter} which constrains the result to match\n   * a supplied regular expression.\n   * @param match - The regular expression to be used as a constraint.\n   * @param options - Optional {@link Conversion.StringMatchOptions} for this conversion\n   * @returns {@link Success} with a matching string or {@link Failure} with an informative\n   * error if the string does not match.\n   * {@label WITH_REGEXP}\n   */\n  public matching(match: RegExp, options?: Partial<StringMatchOptions>): StringConverter<T, TC>;\n\n  /**\n   * Concrete implementation of {@link Conversion.StringConverter.matching#string | StringConverter.matching(string)},\n   * {@link Conversion.StringConverter.matching#array | StringConverter.matching(string[])},\n   * {@link Conversion.StringConverter.matching#set | StringConverter.matching(Set<string>)}, and\n   * {@link Conversion.StringConverter.matching#regexp | StringConverter.matching(RegExp)}.\n   * @internal\n   */\n  public matching(\n    match: string | string[] | Set<T> | RegExp,\n    options?: Partial<StringMatchOptions>\n  ): StringConverter<T, TC> {\n    const message = options?.message;\n    if (typeof match === 'string') {\n      return StringConverter._wrap<T, TC>(this, (from: T) => {\n        return match === from\n          ? succeed(from as T)\n          : fail(message ? `\"${from}\": ${message}` : `\"${from}\": does not match \"${match}\"`);\n      });\n    } else if (match instanceof RegExp) {\n      return StringConverter._wrap<T, TC>(this, (from: T) => {\n        return match.test(from)\n          ? succeed(from as T)\n          : fail(message ? `\"${from}\": ${message}` : `\"${from}\": does not match \"${match}\"`);\n      });\n    } else if (match instanceof Set) {\n      return StringConverter._wrap<T, TC>(this, (from: T) => {\n        return match.has(from)\n          ? succeed(from as T)\n          : fail(message ? `\"${from}\": ${message}` : `\"${from}\": not found in set`);\n      });\n    } else {\n      return StringConverter._wrap<T, TC>(this, (from: T) => {\n        return match.includes(from)\n          ? succeed(from as T)\n          : fail(message ? `\"${from}\": ${message}` : `\"${from}\": not found in [${match.join(',')}]`);\n      });\n    }\n  }\n}\n"]}

package/dist/packlets/hash/crcNormalizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crcNormalizer.js","sourceRoot":"","sources":["../../../src/packlets/hash/crcNormalizer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,SAAS,UAAU,CAAC,KAAa;IAC/B,wEAAwE;IACxE,0EAA0E;IAC1E,MAAM,iBAAiB,GAAG,OAAO,WAAW,KAAK,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;IACvF,IAAI,iBAAiB,EAAE,CAAC;QACtB,OAAO,IAAI,iBAAiB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IACD,mDAAmD;IACnD,+BAA+B;IAC/B,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,IAAI,SAAS,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,SAAS,IAAI,MAAM,IAAI,SAAS,IAAI,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YACvE,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACrC,IAAI,IAAI,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;gBACrC,SAAS,GAAG,CAAC,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC;gBACrE,CAAC,EAAE,CAAC;YACN,CAAC;QACH,CAAC;QACD,IAAI,SAAS,GAAG,IAAI,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxB,CAAC;aAAM,IAAI,SAAS,GAAG,KAAK,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC;YACpC,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;QACxC,CAAC;aAAM,IAAI,SAAS,GAAG,OAAO,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC;YACrC,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC;YACrC,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;YAC9C,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IACD,8BAA8B;IAC9B,OAAO,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,GAAW,UAAU,CAAC;AAEtC,MAAM,UAAU,GAAa,EAAE,CAAC;AAEhC,SAAS,KAAK,CAAC,KAAiB,EAAE,MAAc,UAAU;IACxD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,eAAe,EAAE,CAAC;IACpB,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACtC,sCAAsC;QACtC,GAAG,GAAG,UAAU,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAU,EAAE;IACrC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,UAAU,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,SAAS,eAAe;IACtB,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3B,sCAAsC;gBACtC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACV,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,UAAU,CAAC;gBAC7B,CAAC;qBAAM,CAAC;oBACN,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACd,CAAC;YACH,CAAC;YACD,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,eAAgB,SAAQ,iBAAiB;IACpD;QACE,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,KAAe;QACrC,OAAO,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;aACtC,QAAQ,CAAC,EAAE,CAAC;aACZ,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACtB,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { HashingNormalizer } from './hashingNormalizer';\n\nfunction encodeUtf8(input: string): Uint8Array {\n  // Prefer built-in TextEncoder when available (browsers and modern Node)\n  // @ts-ignore - global TextEncoder may be unavailable in some environments\n  const GlobalTextEncoder = typeof TextEncoder !== 'undefined' ? TextEncoder : undefined;\n  if (GlobalTextEncoder) {\n    return new GlobalTextEncoder().encode(input);\n  }\n  // Very small manual UTF-8 encoder as a last resort\n  /* eslint-disable no-bitwise */\n  const bytes: number[] = [];\n  for (let i = 0; i < input.length; i++) {\n    let codePoint = input.charCodeAt(i);\n    if (codePoint >= 0xd800 && codePoint <= 0xdbff && i + 1 < input.length) {\n      const next = input.charCodeAt(i + 1);\n      if (next >= 0xdc00 && next <= 0xdfff) {\n        codePoint = ((codePoint - 0xd800) << 10) + (next - 0xdc00) + 0x10000;\n        i++;\n      }\n    }\n    if (codePoint < 0x80) {\n      bytes.push(codePoint);\n    } else if (codePoint < 0x800) {\n      bytes.push(0xc0 | (codePoint >> 6));\n      bytes.push(0x80 | (codePoint & 0x3f));\n    } else if (codePoint < 0x10000) {\n      bytes.push(0xe0 | (codePoint >> 12));\n      bytes.push(0x80 | ((codePoint >> 6) & 0x3f));\n      bytes.push(0x80 | (codePoint & 0x3f));\n    } else {\n      bytes.push(0xf0 | (codePoint >> 18));\n      bytes.push(0x80 | ((codePoint >> 12) & 0x3f));\n      bytes.push(0x80 | ((codePoint >> 6) & 0x3f));\n      bytes.push(0x80 | (codePoint & 0x3f));\n    }\n  }\n  /* eslint-enable no-bitwise */\n  return new Uint8Array(bytes);\n}\n\nconst POLYNOMIAL: number = 0xedb88320;\n\nconst crc32Table: number[] = [];\n\nfunction crc32(bytes: Uint8Array, crc: number = 0xffffffff): number {\n  if (crc32Table.length === 0) {\n    buildCrc32Table();\n  }\n  for (let i = 0; i < bytes.length; ++i) {\n    // eslint-disable-next-line no-bitwise\n    crc = crc32Table[(crc ^ bytes[i]) & 0xff] ^ (crc >>> 8);\n  }\n  return (crc ^ -1) >>> 0;\n}\n\nconst toUInt32 = (n: number): number => {\n  if (n >= 0) {\n    return n;\n  }\n  return 0xffffffff - n * -1 + 1;\n};\n\nfunction buildCrc32Table(): void {\n  if (crc32Table.length === 0) {\n    for (let n = 0; n < 256; n++) {\n      let r = n;\n      for (let i = 0; i < 8; i++) {\n        // eslint-disable-next-line no-bitwise\n        if (r & 1) {\n          r = (r >>> 1) ^ POLYNOMIAL;\n        } else {\n          r = r >>> 1;\n        }\n      }\n      crc32Table.push(toUInt32(r));\n    }\n  }\n}\n\n/**\n * A {@link Hash.HashingNormalizer | hashing normalizer} which computes object\n * hash using the CRC32 algorithm.\n * @public\n */\nexport class Crc32Normalizer extends HashingNormalizer {\n  public constructor() {\n    super(Crc32Normalizer.crc32Hash);\n  }\n\n  public static crc32Hash(parts: string[]): string {\n    return crc32(encodeUtf8(parts.join('|')))\n      .toString(16)\n      .padStart(8, '0');\n  }\n}\n"]}

package/dist/packlets/hash/hashingNormalizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hashingNormalizer.js","sourceRoot":"","sources":["../../../src/packlets/hash/hashingNormalizer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,UAAU,EAAU,aAAa,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAQvF;;;GAGG;AACH,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAG/C,YAAmB,IAAkB;QACnC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAEM,WAAW,CAAC,IAAa;QAC9B,QAAQ,OAAO,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,WAAW;gBACd,OAAO,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;oBAC1D,OAAO,aAAa,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;YACL,KAAK,QAAQ;gBACX,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,YAAY,IAAI,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;oBACpE,OAAO,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;wBAC1D,OAAO,aAAa,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC9C,CAAC,CAAC,CAAC;gBACL,CAAC;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC/B,OAAO,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;wBACtE,OAAO,aAAa,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1D,CAAC,CAAC,CAAC;gBACL,CAAC;qBAAM,IAAI,IAAI,YAAY,GAAG,IAAI,IAAI,YAAY,GAAG,EAAE,CAAC;oBACtD,MAAM,IAAI,GAAG,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;oBACjD,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC5E,CAAC;gBACD,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACxF,CAAC;QACD,OAAO,IAAI,CAAC,+CAA+C,OAAO,IAAI,GAAG,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;OAKG;IACO,yBAAyB,CACjC,IAAoF;QAEpF,QAAQ,OAAO,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ;gBACX,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;YACvB,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,WAAW;gBACd,OAAO,OAAO,CAAC,GAAG,OAAO,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,IAAI,YAAY,IAAI,EAAE,CAAC;YACzB,OAAO,OAAO,CAAC,WAAW,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;YAC3B,OAAO,OAAO,CAAC,aAAa,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACpD,CAAC;QACD,sBAAsB;QACtB,OAAO,IAAI,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Normalizer, Result, captureResult, fail, mapResults, succeed } from '../base';\n\n/**\n * Function to compute a hash from a pre-normalized array of strings.\n * @public\n */\nexport type HashFunction = (parts: string[]) => string;\n\n/**\n * Normalizes an arbitrary JSON object\n * @public\n */\nexport class HashingNormalizer extends Normalizer {\n  private _hash: HashFunction;\n\n  public constructor(hash: HashFunction) {\n    super();\n    this._hash = hash;\n  }\n\n  public computeHash(from: unknown): Result<string> {\n    switch (typeof from) {\n      case 'string':\n      case 'bigint':\n      case 'boolean':\n      case 'number':\n      case 'symbol':\n      case 'undefined':\n        return this._normalizeLiteralToString(from).onSuccess((v) => {\n          return captureResult(() => this._hash([v]));\n        });\n      case 'object':\n        if (from === null || from instanceof Date || from instanceof RegExp) {\n          return this._normalizeLiteralToString(from).onSuccess((v) => {\n            return captureResult(() => this._hash([v]));\n          });\n        } else if (Array.isArray(from)) {\n          return mapResults(from.map((e) => this.computeHash(e))).onSuccess((a) => {\n            return captureResult(() => this._hash(['array', ...a]));\n          });\n        } else if (from instanceof Map || from instanceof Set) {\n          const type = from instanceof Map ? 'map' : 'set';\n          return this.computeHash([type, ...this.normalizeEntries(from.entries())]);\n        }\n        return this.computeHash(['object', ...this.normalizeEntries(Object.entries(from))]);\n    }\n    return fail(`computeHash: Unexpected type - cannot hash '${typeof from}'`);\n  }\n\n  /**\n   * Constructs a normalized string representation of some literal value.\n   * @param from - The literal value to be normalized.\n   * @returns A normalized string representation of the literal.\n   * @internal\n   */\n  protected _normalizeLiteralToString(\n    from: string | number | bigint | boolean | symbol | undefined | Date | RegExp | null\n  ): Result<string> {\n    switch (typeof from) {\n      case 'string':\n        return succeed(from);\n      case 'bigint':\n      case 'boolean':\n      case 'number':\n      case 'symbol':\n      case 'undefined':\n        return succeed(`${typeof from}:[[[${String(from)}]]]`);\n    }\n    if (from === null) {\n      return succeed('object:[[[null]]');\n    }\n    if (from instanceof Date) {\n      return succeed(`Date:[[[${String(from.valueOf())}]]]`);\n    }\n    if (from instanceof RegExp) {\n      return succeed(`RegExp:[[[${from.toString()}]]]`);\n    }\n    /* c8 ignore next 2 */\n    return fail(`cannot normalize ${JSON.stringify(from)}`);\n  }\n}\n"]}

package/dist/packlets/hash/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/hash/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,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\nexport * from './crcNormalizer';\nexport * from './hashingNormalizer';\n"]}

package/dist/packlets/logging/bootLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootLogger.js","sourceRoot":"","sources":["../../../src/packlets/logging/bootLogger.ts"],"names":[],"mappings":"AAsBA,OAAO,EAA0B,cAAc,EAAE,cAAc,EAAoB,MAAM,UAAU,CAAC;AAYpG;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,OAAO,UAAU;IAKrB;;;;OAIG;IACH,YAAmB,QAA2B;QATtC,YAAO,GAAoB,EAAE,CAAC;QAE9B,aAAQ,GAAY,KAAK,CAAC;QAQhC,IAAI,CAAC,SAAS,GAAG,IAAI,cAAc,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAe;QAC1B,0BAA0B;QAC1B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,CAAC;QAED,mDAAmD;QACnD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,GAAG,CACR,KAAsB,EACtB,OAAiB,EACjB,GAAG,UAAqB;QAExB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,OAAe,EAAE,MAAe;QACrD,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,OAAe,EAAE,MAAe;QACpD,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF","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 */\nimport { MessageLogLevel, Success } from '../base';\nimport { IDetailLogger, ILogger, InMemoryLogger, isDetailLogger, ReporterLogLevel } from './logger';\n\n/**\n * A recorded log entry capturing the raw arguments before formatting.\n * @internal\n */\ninterface IBootLogEntry {\n  readonly level: MessageLogLevel;\n  readonly message: unknown;\n  readonly parameters: unknown[];\n}\n\n/**\n * A logger that buffers log entries during startup, then replays them\n * to a real logger once it becomes available.\n *\n * @remarks\n * During application bootstrap, the real logger (e.g. one backed by\n * toast notifications) may not be available yet. `BootLogger` solves\n * this by:\n * 1. Buffering all log calls in memory during the boot phase.\n * 2. When {@link BootLogger.ready | ready()} is called with the real\n *    logger, replaying all buffered entries and then forwarding all\n *    subsequent calls directly.\n *\n * @example\n * ```typescript\n * // Create early, before the real logger exists\n * const bootLogger = new BootLogger('detail');\n * bootLogger.info('Starting up...');\n *\n * // Later, when the real logger is available\n * bootLogger.ready(realLogger);\n * // 'Starting up...' is replayed to realLogger\n * // All future calls go directly to realLogger\n * ```\n *\n * @public\n */\nexport class BootLogger implements IDetailLogger {\n  private _buffer: IBootLogEntry[] = [];\n  private _delegate: ILogger;\n  private _isReady: boolean = false;\n\n  /**\n   * Creates a new boot logger.\n   * @param logLevel - The log level for the initial in-memory buffer phase.\n   * Defaults to 'detail' to capture everything during boot.\n   */\n  public constructor(logLevel?: ReporterLogLevel) {\n    this._delegate = new InMemoryLogger(logLevel ?? 'detail');\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.logLevel}\n   */\n  public get logLevel(): ReporterLogLevel {\n    return this._delegate.logLevel;\n  }\n\n  /**\n   * Whether the boot logger has been connected to a real logger.\n   */\n  public get isReady(): boolean {\n    return this._isReady;\n  }\n\n  /**\n   * Connects this boot logger to a real logger.\n   * All buffered entries are replayed to the new logger in order,\n   * and all subsequent calls are forwarded directly.\n   * @param logger - The real logger to forward to.\n   */\n  public ready(logger: ILogger): void {\n    // Replay buffered entries\n    for (const entry of this._buffer) {\n      logger.log(entry.level, entry.message, ...entry.parameters);\n    }\n\n    // Switch to the real logger and discard the buffer\n    this._delegate = logger;\n    this._buffer = [];\n    this._isReady = true;\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.log}\n   */\n  public log(\n    level: MessageLogLevel,\n    message?: unknown,\n    ...parameters: unknown[]\n  ): Success<string | undefined> {\n    if (!this._isReady) {\n      this._buffer.push({ level, message, parameters });\n    }\n    return this._delegate.log(level, message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.detail}\n   */\n  public detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('detail', message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.info}\n   */\n  public info(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('info', message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.warn}\n   */\n  public warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('warning', message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.error}\n   */\n  public error(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.log('error', message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.IDetailLogger.errorWithDetail}\n   */\n  public errorWithDetail(message: string, detail: unknown): Success<string | undefined> {\n    if (isDetailLogger(this._delegate)) {\n      return this._delegate.errorWithDetail(message, detail);\n    }\n    this.log('detail', detail);\n    return this.log('error', message);\n  }\n\n  /**\n   * {@inheritDoc Logging.IDetailLogger.warnWithDetail}\n   */\n  public warnWithDetail(message: string, detail: unknown): Success<string | undefined> {\n    if (isDetailLogger(this._delegate)) {\n      return this._delegate.warnWithDetail(message, detail);\n    }\n    this.log('detail', detail);\n    return this.log('warning', message);\n  }\n}\n"]}

package/dist/packlets/logging/index.js

@@ -22,4 +22,6 @@
 export * from './bootLogger';
 export * from './logger';
 export * from './logReporter';
+export * from './multiLogger';
+export * from './retainingLogger';
 //# sourceMappingURL=index.js.map

package/dist/packlets/logging/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/logging/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,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\nexport * from './bootLogger';\nexport * from './logger';\nexport * from './logReporter';\nexport * from './multiLogger';\nexport * from './retainingLogger';\n"]}

package/dist/packlets/logging/logReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logReporter.js","sourceRoot":"","sources":["../../../src/packlets/logging/logReporter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAGL,cAAc,EAEd,UAAU,EACV,iBAAiB,EAClB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,aAAa,EAAqE,MAAM,SAAS,CAAC;AAwB3G;;;;GAIG;AACH,MAAM,OAAO,WAAW;IAmBtB;;;OAGG;IACH,YAAmB,MAAwC;;QACzD,sBAAsB;QACtB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,MAAA,MAAM,CAAC,MAAM,mCAAI,IAAI,UAAU,EAAE,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,MAAA,MAAM,CAAC,cAAc,mCAAI,WAAW,CAAC,eAAe,CAAC;QAC5E,IAAI,CAAC,iBAAiB,GAAG,MAAA,MAAM,CAAC,gBAAgB,mCAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,MAAgB;QAC1C,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,IAAI,UAAU,EAAE,CAAC;QACpC,OAAO,aAAa,CAAC,GAAG,EAAE,CAAC,IAAI,WAAW,CAAU,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACvD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACrD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAiB,EAAE,GAAG,UAAqB;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,OAAe,EAAE,MAAe;QACrD,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,OAAe,EAAE,MAAe;QACpD,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACrD,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,GAAG,CACR,KAAsB,EACtB,OAAiB,EACjB,GAAG,UAAqB;QAExB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,KAAsB,EAAE,KAAQ,EAAE,MAAW,EAAE,OAA4B;QAC9F,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC3D,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;QAC7E,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,KAAsB,EAAE,OAAe,EAAE,MAAW;QACvE,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1D,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CAAK,cAAyC;QACrE,OAAO,IAAI,WAAW,CAAS;YAC7B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,cAAc;YACd,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;SACzC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAA4B,KAAQ,EAAE,MAAW;QAC5E,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;CACF","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 */\nimport {\n  IDetailLogger,\n  ILogger,\n  isDetailLogger,\n  ReporterLogLevel,\n  NoOpLogger,\n  stringifyLogValue\n} from './logger';\nimport { captureResult, ErrorFormatter, IResultReporter, MessageLogLevel, Result, Success } from '../base';\n\n/**\n * A function that formats a value for logging.\n * @public\n */\nexport type LogValueFormatter<T, TD = unknown> = (value: T, detail?: TD) => string;\n\n/**\n * A function that formats a message for logging.\n * @public\n */\nexport type LogMessageFormatter<TD = unknown> = (message: string, detail?: TD) => string;\n\n/**\n * Parameters for creating a {@link Logging.LogReporter | LogReporter}.\n * @public\n */\nexport interface ILogReporterCreateParams<T, TD = unknown> {\n  logger?: ILogger;\n  valueFormatter?: LogValueFormatter<T, TD>;\n  messageFormatter?: LogMessageFormatter<TD>;\n}\n\n/**\n * Abstract base class which wraps an existing {@link Logging.ILogger | ILogger} to implement\n * both {@link Logging.ILogger | ILogger} and {@link IResultReporter | IResultReporter}.\n * @public\n */\nexport class LogReporter<T, TD = unknown> implements IDetailLogger, IResultReporter<T, TD> {\n  /**\n   * Base logger used to by this reporter.\n   * @public\n   */\n  public readonly logger: ILogger;\n\n  /**\n   * The formatter to use for values.\n   * @internal\n   */\n  protected readonly _valueFormatter: LogValueFormatter<T, TD>;\n\n  /**\n   * The formatter to use for messages.\n   * @internal\n   */\n  protected readonly _messageFormatter: LogMessageFormatter<TD>;\n\n  /**\n   * Creates a new {@link Logging.LogReporter | LogReporter}.\n   * @param params - The parameters for creating the {@link Logging.LogReporter | LogReporter}.\n   */\n  public constructor(params?: ILogReporterCreateParams<T, TD>) {\n    /* c8 ignore next 1 */\n    params = params ?? {};\n    this.logger = params.logger ?? new NoOpLogger();\n    this._valueFormatter = params.valueFormatter ?? LogReporter.tryFormatObject;\n    this._messageFormatter = params.messageFormatter ?? ((message, __detail) => message);\n  }\n\n  /**\n   * Creates a default {@link Logging.LogReporter | LogReporter} with a {@link Logging.NoOpLogger | NoOpLogger} with the\n   * supplied parameters, returning both the logger and reporter.\n   * @param logger - Optional logger to use; defaults to a new {@link Logging.NoOpLogger | NoOpLogger} if not provided.\n   * @returns\n   */\n  public static createDefault(logger?: ILogger): Result<LogReporter<unknown>> {\n    logger = logger ?? new NoOpLogger();\n    return captureResult(() => new LogReporter<unknown>({ logger }));\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.logLevel}\n   */\n  public get logLevel(): ReporterLogLevel {\n    return this.logger.logLevel;\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.detail}\n   */\n  public detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.logger.detail(message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.info}\n   */\n  public info(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.logger.info(message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.warn}\n   */\n  public warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.logger.warn(message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.error}\n   */\n  public error(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {\n    return this.logger.error(message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc Logging.IDetailLogger.errorWithDetail}\n   */\n  public errorWithDetail(message: string, detail: unknown): Success<string | undefined> {\n    if (isDetailLogger(this.logger)) {\n      return this.logger.errorWithDetail(message, detail);\n    }\n    this.logger.detail(detail);\n    return this.logger.error(message);\n  }\n\n  /**\n   * {@inheritDoc Logging.IDetailLogger.warnWithDetail}\n   */\n  public warnWithDetail(message: string, detail: unknown): Success<string | undefined> {\n    if (isDetailLogger(this.logger)) {\n      return this.logger.warnWithDetail(message, detail);\n    }\n    this.logger.detail(detail);\n    return this.logger.warn(message);\n  }\n\n  /**\n   * {@inheritDoc Logging.ILogger.log}\n   */\n  public log(\n    level: MessageLogLevel,\n    message?: unknown,\n    ...parameters: unknown[]\n  ): Success<string | undefined> {\n    return this.logger.log(level, message, ...parameters);\n  }\n\n  /**\n   * {@inheritDoc IResultReporter.reportSuccess}\n   */\n  public reportSuccess(level: MessageLogLevel, value: T, detail?: TD, message?: ErrorFormatter<TD>): void {\n    const formattedValue = this._valueFormatter(value, detail);\n    const formatted = message ? message(formattedValue, detail) : formattedValue;\n    this.log(level, formatted);\n  }\n\n  /**\n   * {@inheritDoc IResultReporter.reportFailure}\n   */\n  public reportFailure(level: MessageLogLevel, message: string, detail?: TD): void {\n    const formatted = this._messageFormatter(message, detail);\n    this.log(level, formatted);\n  }\n\n  /**\n   * Creates a new {@link Logging.LogReporter | LogReporter} with the same logger but a different value formatter.\n   * @param valueFormatter - The value formatter to use.\n   * @returns A new {@link Logging.LogReporter | LogReporter} with the same logger but a different value formatter.\n   */\n  public withValueFormatter<TN>(valueFormatter: LogValueFormatter<TN, TD>): LogReporter<TN, TD> {\n    return new LogReporter<TN, TD>({\n      logger: this.logger,\n      valueFormatter,\n      messageFormatter: this._messageFormatter\n    });\n  }\n\n  /**\n   * Generic method to try to format an object for logging.\n   * @param value - The value to format.\n   * @param detail - The detail to format.\n   * @returns\n   */\n  public static tryFormatObject<T = unknown, TD = unknown>(value: T, detail?: TD): string {\n    return stringifyLogValue(value);\n  }\n}\n"]}

package/dist/packlets/logging/logger.js

@@ -20,6 +20,8 @@
  * SOFTWARE.
  */
 import { captureResult, succeed } from '../base';
+import { allReporterLogLevels, isDetailLogger, reporterLogLevel } from '../logging-interface';
+export { isDetailLogger, allReporterLogLevels, reporterLogLevel };
 /**
  * Compares two log levels.
  * @param message - The first log level.
@@ -69,16 +71,6 @@ export function stringifyLogValue(value, maxLength) {
     }
     return str;
 }
-/**
- * Type guard that checks whether a logger implements {@link IDetailLogger}.
- * @param logger - The logger to check.
- * @returns `true` if the logger implements `IDetailLogger`.
- * @public
- */
-export function isDetailLogger(logger) {
-    return (typeof logger.errorWithDetail === 'function' &&
-        typeof logger.warnWithDetail === 'function');
-}
 /**
  * Abstract base class which implements {@link Logging.IDetailLogger | IDetailLogger}.
  * @public
@@ -86,55 +78,81 @@ export function isDetailLogger(logger) {
 export class LoggerBase {
     constructor(logLevel) {
         /**
-         * {@inheritDoc Logging.ILogger.logLevel}
+         * The level of logging to be used.
          */
         this.logLevel = 'info';
         this.logLevel = logLevel !== null && logLevel !== void 0 ? logLevel : 'info';
     }
     /**
-     * {@inheritDoc Logging.ILogger.detail}
+     * Logs a detail message.
+     * @param message - The message to log.
+     * @param parameters - The parameters to log.
+     * @returns `Success` with the logged message if the level is enabled, or
+     * `Success` with `undefined` if the message is suppressed.
      */
     detail(message, ...parameters) {
         return this.log('detail', message, ...parameters);
     }
     /**
-     * {@inheritDoc Logging.ILogger.info}
+     * Logs an info message.
+     * @param message - The message to log.
+     * @param parameters - The parameters to log.
+     * @returns `Success` with the logged message if the level is enabled, or
+     * `Success` with `undefined` if the message is suppressed.
      */
     info(message, ...parameters) {
         return this.log('info', message, ...parameters);
     }
     /**
-     * {@inheritDoc Logging.ILogger.warn}
+     * Logs a warning message.
+     * @param message - The message to log.
+     * @param parameters - The parameters to log.
+     * @returns `Success` with the logged message if the level is enabled, or
+     * `Success` with `undefined` if the message is suppressed.
      */
     warn(message, ...parameters) {
         return this.log('warning', message, ...parameters);
     }
     /**
-     * {@inheritDoc Logging.ILogger.error}
+     * Logs an error message.
+     * @param message - The message to log.
+     * @param parameters - The parameters to log.
+     * @returns `Success` with the logged message if the level is enabled, or
+     * `Success` with `undefined` if the message is suppressed.
      */
     error(message, ...parameters) {
         return this.log('error', message, ...parameters);
     }
     /**
-     * {@inheritDoc Logging.IDetailLogger.errorWithDetail}
+     * Logs a short error summary at `error` level, then emits `detail` at `detail` level.
+     * @param message - Short human-readable summary.
+     * @param detail - Full detail (e.g. raw converter error) logged at `detail` level.
      */
     errorWithDetail(message, detail) {
         this.detail(detail);
         return this.error(message);
     }
     /**
-     * {@inheritDoc Logging.IDetailLogger.warnWithDetail}
+     * Logs a short warning summary at `warning` level, then emits `detail` at `detail` level.
+     * @param message - Short human-readable summary.
+     * @param detail - Full detail logged at `detail` level.
      */
     warnWithDetail(message, detail) {
         this.detail(detail);
         return this.warn(message);
     }
     /**
-     * {@inheritDoc Logging.ILogger.log}
+     * Logs a message at the given level.
+     * @param level - The level of the message.
+     * @param message - The message to log.
+     * @param parameters - The parameters to log.
+     * @returns `Success` with the logged message if the level is enabled, or
+     * `Success` with `undefined` if the message is suppressed.
      */
     log(level, message, ...parameters) {
         if (shouldLog(level, this.logLevel)) {
             const formatted = this._format(message, ...parameters);
+            this._logStructured(level, formatted, message, parameters);
             return this._log(formatted, level);
         }
         return this._suppressLog(level, message, ...parameters);
@@ -153,6 +171,21 @@ export class LoggerBase {
         const joined = strings.join('');
         return joined;
     }
+    /**
+     * Inner hook called for logged messages alongside {@link Logging.LoggerBase._log | _log},
+     * exposing the structured `(level, formatted, message, parameters)` form before it is
+     * collapsed to the formatted string. The default implementation is a no-op; subclasses
+     * that need to retain structured records (e.g. {@link Logging.RetainingLogger | RetainingLogger})
+     * override this. Fired only in the `shouldLog` branch, so suppressed messages never reach it.
+     * @param __level - The {@link MessageLogLevel | level} of the message.
+     * @param __formatted - The formatted message (same string passed to `_log`).
+     * @param __message - The raw message argument before formatting.
+     * @param __parameters - The raw parameter arguments before formatting.
+     * @public
+     */
+    _logStructured(__level, __formatted, __message, __parameters) {
+        /* no-op; subclasses that retain structured records override this */
+    }
     /**
      * Inner method called for suppressed log messages.
      * @public