@fgv/ts-utils 4.5.0-2 → 4.5.0

package/lib/packlets/conversion/objectConverter.js

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

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

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

package/lib/packlets/hash/crcNormalizer.js

@@ -69,7 +69,7 @@ class Crc32Normalizer extends hashingNormalizer_1.HashingNormalizer {
         super(Crc32Normalizer.crc32Hash);
     }
     static crc32Hash(parts) {
-        return crc32(textEncoder.encode(parts.join('|'))).toString(16);
+        return String(crc32(textEncoder.encode(parts.join('|'))));
     }
 }
 exports.Crc32Normalizer = Crc32Normalizer;

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

@@ -1 +1 @@
-{"version":3,"file":"crcNormalizer.js","sourceRoot":"","sources":["../../../src/packlets/hash/crcNormalizer.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,2DAAwD;AAExD,MAAM,WAAW,GAAgB,IAAI,WAAW,EAAE,CAAC;AAEnD,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,MAAa,eAAgB,SAAQ,qCAAiB;IACpD;QACE,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,KAAe;QACrC,OAAO,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AARD,0CAQC","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\nconst textEncoder: TextEncoder = new TextEncoder();\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(textEncoder.encode(parts.join('|'))).toString(16);\n  }\n}\n"]}
+{"version":3,"file":"crcNormalizer.js","sourceRoot":"","sources":["../../../src/packlets/hash/crcNormalizer.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,2DAAwD;AAExD,MAAM,WAAW,GAAgB,IAAI,WAAW,EAAE,CAAC;AAEnD,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,MAAa,eAAgB,SAAQ,qCAAiB;IACpD;QACE,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,KAAe;QACrC,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5D,CAAC;CACF;AARD,0CAQC","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\nconst textEncoder: TextEncoder = new TextEncoder();\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 String(crc32(textEncoder.encode(parts.join('|'))));\n  }\n}\n"]}

package/lib/packlets/validation/validators.d.ts

@@ -40,6 +40,36 @@ export declare function object<T, TC = unknown>(fields: FieldValidators<T, TC>,
  * @public
  */
 export declare function arrayOf<T, TC>(validateElement: Validator<T, TC>, params?: Omit<ArrayValidatorConstructorParams<T, TC>, 'validateElement'>): ArrayValidator<T, TC>;
+/**
+ * Options for {@link Validators.recordOf} helper function.
+ * @public
+ */
+export interface IRecordOfValidatorOptions<TK extends string = string, TC = unknown> {
+    /**
+     * If `onError` is `'fail'` (default), then the entire validation fails if any key or element
+     * cannot be validated. If `onError` is `'ignore'`, failing elements are silently ignored.
+     */
+    onError?: 'fail' | 'ignore';
+    /**
+     * If present, `keyValidator` is used to validate the source object property names.
+     * @remarks
+     * Can be used to validate key names to supported values and/or strong types.
+     */
+    keyValidator?: Validator<TK, TC>;
+}
+/**
+ * A helper function to create a {@link Validation.Validator | Validator} which validates the `string`-keyed properties
+ * using a supplied {@link Validation.Validator | Validator<T, TC>} to produce a `Record<TK, T>`.
+ * @remarks
+ * If present, the supplied {@link Validators.IRecordOfValidatorOptions | options} can provide a strongly-typed
+ * validator for keys and/or control the handling of elements that fail validation.
+ * @param validator - {@link Validation.Validator | Validator} used for each item in the source object.
+ * @param options - Optional {@link Validators.IRecordOfValidatorOptions | IRecordOfValidatorOptions<TK, TC>} which
+ * supplies a key validator and/or error-handling options.
+ * @returns A {@link Validation.Validator | Validator} which validates `Record<TK, T>`.
+ * @public
+ */
+export declare function recordOf<T, TC = unknown, TK extends string = string>(validator: Validator<T, TC>, options?: IRecordOfValidatorOptions<TK, TC>): Validator<Record<TK, T>, TC>;
 /**
  * Helper function to create a {@link Validation.Validator} which validates an enumerated
  * value in place.

package/lib/packlets/validation/validators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/validators.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,cAAc,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AAC9F,OAAO,EAAE,kBAAkB,EAAE,mCAAmC,EAAE,MAAM,aAAa,CAAC;AAGtF,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAG/D,OAAO,EAAE,cAAc,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAE1E,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,SAAS,CAAC,MAAM,CAAyB,CAAC;AAE/D;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,SAAS,CAAC,MAAM,CAAyB,CAAC;AAE/D;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,OAAO,CAA0B,CAAC;AAElE;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EACpC,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,EAC9B,MAAM,CAAC,EAAE,IAAI,CAAC,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,GAC/D,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAExB;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,EAAE,EAC3B,eAAe,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EACjC,MAAM,CAAC,EAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,iBAAiB,CAAC,GACvE,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAEvB;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAWhF;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,EACrF,KAAK,EAAE,CAAC,GACP,SAAS,CAAC,CAAC,CAAC,CAQd;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EACnC,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EACnC,MAAM,CAAC,EAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,YAAY,CAAC,GAClE,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAEvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EACjC,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,oBAAoB,CAAC,CAAC,EAAE,EAAE,CAAC,EAClC,MAAM,CAAC,EAAE,IAAI,CAAC,mCAAmC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,GACjF,kBAAkB,CAAC,CAAC,EAAE,EAAE,CAAC,CAE3B;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAE1F"}
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/validators.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,cAAc,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AAC9F,OAAO,EAAE,kBAAkB,EAAE,mCAAmC,EAAE,MAAM,aAAa,CAAC;AAGtF,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAG/D,OAAO,EAAE,cAAc,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAE1E,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,SAAS,CAAC,MAAM,CAAyB,CAAC;AAE/D;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,SAAS,CAAC,MAAM,CAAyB,CAAC;AAE/D;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,OAAO,CAA0B,CAAC;AAElE;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EACpC,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,EAC9B,MAAM,CAAC,EAAE,IAAI,CAAC,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,GAC/D,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAExB;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,EAAE,EAC3B,eAAe,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EACjC,MAAM,CAAC,EAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,iBAAiB,CAAC,GACvE,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAEvB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO;IACjF;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC5B;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;CAClC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE,SAAS,MAAM,GAAG,MAAM,EAClE,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAC3B,OAAO,CAAC,EAAE,yBAAyB,CAAC,EAAE,EAAE,EAAE,CAAC,GAC1C,SAAS,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CA4C9B;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAWhF;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,EACrF,KAAK,EAAE,CAAC,GACP,SAAS,CAAC,CAAC,CAAC,CAQd;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EACnC,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EACnC,MAAM,CAAC,EAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,YAAY,CAAC,GAClE,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAEvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EACjC,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,oBAAoB,CAAC,CAAC,EAAE,EAAE,CAAC,EAClC,MAAM,CAAC,EAAE,IAAI,CAAC,mCAAmC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,GACjF,kBAAkB,CAAC,CAAC,EAAE,EAAE,CAAC,CAE3B;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAE1F"}

package/lib/packlets/validation/validators.js

@@ -24,6 +24,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.boolean = exports.number = exports.string = void 0;
 exports.object = object;
 exports.arrayOf = arrayOf;
+exports.recordOf = recordOf;
 exports.enumeratedValue = enumeratedValue;
 exports.literal = literal;
 exports.oneOf = oneOf;
@@ -78,6 +79,58 @@ function object(fields, params) {
 function arrayOf(validateElement, params) {
     return new array_1.ArrayValidator(Object.assign({ validateElement }, (params !== null && params !== void 0 ? params : {})));
 }
+/**
+ * A helper function to create a {@link Validation.Validator | Validator} which validates the `string`-keyed properties
+ * using a supplied {@link Validation.Validator | Validator<T, TC>} to produce a `Record<TK, T>`.
+ * @remarks
+ * If present, the supplied {@link Validators.IRecordOfValidatorOptions | options} can provide a strongly-typed
+ * validator for keys and/or control the handling of elements that fail validation.
+ * @param validator - {@link Validation.Validator | Validator} used for each item in the source object.
+ * @param options - Optional {@link Validators.IRecordOfValidatorOptions | IRecordOfValidatorOptions<TK, TC>} which
+ * supplies a key validator and/or error-handling options.
+ * @returns A {@link Validation.Validator | Validator} which validates `Record<TK, T>`.
+ * @public
+ */
+function recordOf(validator, options) {
+    const opts = Object.assign({ onError: 'fail' }, options);
+    return new genericValidator_1.GenericValidator({
+        validator: (from, context) => {
+            if (typeof from !== 'object' || from === null || Array.isArray(from)) {
+                return (0, base_1.fail)(`Not a string-keyed object: ${JSON.stringify(from)}`);
+            }
+            const errors = new base_1.MessageAggregator();
+            for (const key in from) {
+                if ((0, base_1.isKeyOf)(key, from)) {
+                    // Validate key if keyValidator is provided
+                    if (opts.keyValidator) {
+                        const keyResult = opts.keyValidator.validate(key, context);
+                        if (!keyResult.isSuccess()) {
+                            if (opts.onError === 'ignore') {
+                                continue;
+                            }
+                            errors.addMessage(`Key "${key}": ${keyResult.message}`);
+                            if (opts.onError === 'fail') {
+                                return (0, base_1.fail)(keyResult.message);
+                            }
+                        }
+                    }
+                    // Validate value
+                    const valueResult = validator.validate(from[key], context);
+                    if (!valueResult.isSuccess()) {
+                        if (opts.onError === 'ignore') {
+                            continue;
+                        }
+                        errors.addMessage(`Property "${key}": ${valueResult.message}`);
+                        if (opts.onError === 'fail') {
+                            return (0, base_1.fail)(valueResult.message);
+                        }
+                    }
+                }
+            }
+            return errors.hasMessages ? (0, base_1.fail)(errors.toString()) : true;
+        }
+    });
+}
 /**
  * Helper function to create a {@link Validation.Validator} which validates an enumerated
  * value in place.

package/lib/packlets/validation/validators.js.map

@@ -1 +1 @@
-{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../../src/packlets/validation/validators.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AA4CH,wBAKC;AAUD,0BAKC;AAOD,0CAWC;AAOD,0BAUC;AAWD,sBAKC;AAWD,kBAMC;AAWD,0BAEC;AA/ID,kCAAwC;AACxC,mCAA0E;AAC1E,qCAA8F;AAC9F,2CAAsF;AAEtF,uCAA6C;AAE7C,yDAAsD;AACtD,qCAA2C;AAC3C,mCAA0E;AAC1E,qCAA2C;AAG3C;;;GAGG;AACU,QAAA,MAAM,GAAsB,IAAI,wBAAe,EAAE,CAAC;AAE/D;;;GAGG;AACU,QAAA,MAAM,GAAsB,IAAI,wBAAe,EAAE,CAAC;AAE/D;;;GAGG;AACU,QAAA,OAAO,GAAuB,IAAI,0BAAgB,EAAE,CAAC;AAElE;;;;;;;;;;GAUG;AACH,SAAgB,MAAM,CACpB,MAA8B,EAC9B,MAAgE;IAEhE,OAAO,IAAI,wBAAe,iBAAG,MAAM,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC5D,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,OAAO,CACrB,eAAiC,EACjC,MAAwE;IAExE,OAAO,IAAI,sBAAc,iBAAG,eAAe,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAmB,MAAW;IAC3D,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAa,EAAwB,EAAE;YAChE,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,CAAC,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,MAAM,CAAC;gBAC5B,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC;gBACnC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,6BAA6B,IAAI,mBAAmB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACvG,CAAC;YACD,OAAO,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACtE,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CACrB,KAAQ;IAER,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CAAC,IAAa,EAAwB,EAAE;YACjD,OAAO,IAAI,KAAK,KAAK;gBACnB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,IAAA,WAAI,EAAC,oBAAoB,MAAM,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9F,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,KAAK,CACnB,UAAmC,EACnC,MAAmE;IAEnE,OAAO,IAAI,sBAAc,iCAAa,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,KAAE,UAAU,IAAG,CAAC;AACtE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,GAAG,CACjB,WAAmB,EACnB,KAAkC,EAClC,MAAkF;IAElF,OAAO,IAAI,8BAAkB,iBAAG,WAAW,EAAE,KAAK,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC3E,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,OAAO,CAAkB,SAA+B;IACtE,OAAO,IAAI,mCAAgB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;AAC7C,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 { Failure, fail } from '../base';\nimport { ArrayValidator, ArrayValidatorConstructorParams } from './array';\nimport { FieldValidators, ObjectValidator, ObjectValidatorConstructorParams } from './object';\nimport { TypeGuardValidator, TypeGuardValidatorConstructorParams } from './typeGuard';\n\nimport { BooleanValidator } from './boolean';\nimport { TypeGuardWithContext, ValidatorFunc } from './common';\nimport { GenericValidator } from './genericValidator';\nimport { NumberValidator } from './number';\nimport { OneOfValidator, OneOfValidatorConstructorParams } from './oneOf';\nimport { StringValidator } from './string';\nimport { Validator } from './validator';\n\n/**\n * A {@link Validation.Classes.StringValidator | StringValidator} which validates a string in place.\n * @public\n */\nexport const string: Validator<string> = new StringValidator();\n\n/**\n * A {@link Validation.Classes.NumberValidator | NumberValidator} which validates a number in place.\n * @public\n */\nexport const number: Validator<number> = new NumberValidator();\n\n/**\n * A {@link Validation.Classes.BooleanValidator | BooleanValidator} which validates a boolean in place.\n * @public\n */\nexport const boolean: Validator<boolean> = new BooleanValidator();\n\n/**\n * Helper function to create a {@link Validation.Classes.ObjectValidator | ObjectValidator} which validates\n * an object in place.\n * @param fields - A {@link Validation.Classes.FieldValidators | field validator definition}\n * describing the validations to be applied.\n * @param params - Optional {@link Validation.Classes.ObjectValidatorConstructorParams | parameters}\n * to refine the behavior of the resulting {@link Validation.Validator | validator}.\n * @returns A new {@link Validation.Validator | Validator} which validates the desired\n * object in place.\n * @public\n */\nexport function object<T, TC = unknown>(\n  fields: FieldValidators<T, TC>,\n  params?: Omit<ObjectValidatorConstructorParams<T, TC>, 'fields'>\n): ObjectValidator<T, TC> {\n  return new ObjectValidator({ fields, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Classes.ArrayValidator | ArrayValidator} which\n * validates an array in place.\n * @param validateElement - A {@link Validation.Validator | validator} which validates each element.\n * @returns A new {@link Validation.Classes.ArrayValidator | ArrayValidator } which validates the desired\n * array in place.\n * @public\n */\nexport function arrayOf<T, TC>(\n  validateElement: Validator<T, TC>,\n  params?: Omit<ArrayValidatorConstructorParams<T, TC>, 'validateElement'>\n): ArrayValidator<T, TC> {\n  return new ArrayValidator({ validateElement, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator} which validates an enumerated\n * value in place.\n * @public\n */\nexport function enumeratedValue<T extends string>(values: T[]): Validator<T, T[]> {\n  return new GenericValidator({\n    validator: (from: unknown, context?: T[]): boolean | Failure<T> => {\n      if (typeof from === 'string') {\n        const v = context ?? values;\n        const index = v.indexOf(from as T);\n        return index >= 0 ? true : fail(`Invalid enumerated value \"${from}\"  - expected: (${v.join(', ')})`);\n      }\n      return fail(`Not a string: \"${JSON.stringify(from, undefined, 2)}`);\n    }\n  });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator} which validates a literal value.\n * @param value - the literal value to be validated\n * @public\n */\nexport function literal<T extends string | number | boolean | symbol | null | undefined>(\n  value: T\n): Validator<T> {\n  return new GenericValidator({\n    validator: (from: unknown): boolean | Failure<T> => {\n      return from === value\n        ? true\n        : fail(`Expected literal ${String(value)}, found \"${JSON.stringify(from, undefined, 2)}`);\n    }\n  });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator | Validator} which validates one\n * of several possible validated values.\n * @param validators - the {@link Validation.Validator | validators} to be considered.\n * @param params - Optional {@link Validation.Classes.OneOfValidatorConstructorParams | params} used to construct the validator.\n * @returns A new {@link Validator | Validator} which validates values that match any of\n * the supplied validators.\n * @public\n */\nexport function oneOf<T, TC = unknown>(\n  validators: Array<Validator<T, TC>>,\n  params?: Omit<OneOfValidatorConstructorParams<T, TC>, 'validators'>\n): OneOfValidator<T, TC> {\n  return new OneOfValidator<T, TC>({ ...(params ?? {}), validators });\n}\n\n/**\n * Helper function to create a {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator} which\n * validates a value or object in place.\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 Validation.Classes.TypeGuardValidator | TypeGuardValidator } which validates\n * the values using the supplied type guard.\n * @public\n */\nexport function isA<T, TC = unknown>(\n  description: string,\n  guard: TypeGuardWithContext<T, TC>,\n  params?: Omit<TypeGuardValidatorConstructorParams<T, TC>, 'description' | 'guard'>\n): TypeGuardValidator<T, TC> {\n  return new TypeGuardValidator({ description, guard, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator | Validator} using a\n * supplied {@link Validation.ValidatorFunc | validator function}.\n * @param validator - A {@link Validation.ValidatorFunc | validator function} that a\n * supplied unknown value matches some condition.\n * @returns A new {@link Validation.Validator | Validator} which validates the desired\n * value using the supplied function.\n * @public\n */\nexport function generic<T, TC = unknown>(validator: ValidatorFunc<T, TC>): Validator<T, TC> {\n  return new GenericValidator({ validator });\n}\n"]}
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../../src/packlets/validation/validators.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AA4CH,wBAKC;AAUD,0BAKC;AAgCD,4BA+CC;AAOD,0CAWC;AAOD,0BAUC;AAWD,sBAKC;AAWD,kBAMC;AAWD,0BAEC;AA9ND,kCAAoE;AACpE,mCAA0E;AAC1E,qCAA8F;AAC9F,2CAAsF;AAEtF,uCAA6C;AAE7C,yDAAsD;AACtD,qCAA2C;AAC3C,mCAA0E;AAC1E,qCAA2C;AAG3C;;;GAGG;AACU,QAAA,MAAM,GAAsB,IAAI,wBAAe,EAAE,CAAC;AAE/D;;;GAGG;AACU,QAAA,MAAM,GAAsB,IAAI,wBAAe,EAAE,CAAC;AAE/D;;;GAGG;AACU,QAAA,OAAO,GAAuB,IAAI,0BAAgB,EAAE,CAAC;AAElE;;;;;;;;;;GAUG;AACH,SAAgB,MAAM,CACpB,MAA8B,EAC9B,MAAgE;IAEhE,OAAO,IAAI,wBAAe,iBAAG,MAAM,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC5D,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,OAAO,CACrB,eAAiC,EACjC,MAAwE;IAExE,OAAO,IAAI,sBAAc,iBAAG,eAAe,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AACpE,CAAC;AAoBD;;;;;;;;;;;GAWG;AACH,SAAgB,QAAQ,CACtB,SAA2B,EAC3B,OAA2C;IAE3C,MAAM,IAAI,mBAAwC,OAAO,EAAE,MAAM,IAAK,OAAO,CAAE,CAAC;IAEhF,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAoC,EAAE;YAC3E,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrE,OAAO,IAAA,WAAI,EAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACpE,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,wBAAiB,EAAE,CAAC;YAEvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,IAAI,IAAA,cAAO,EAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;oBACvB,2CAA2C;oBAC3C,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;wBACtB,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;wBAC3D,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC;4BAC3B,IAAI,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gCAC9B,SAAS;4BACX,CAAC;4BACD,MAAM,CAAC,UAAU,CAAC,QAAQ,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;4BACxD,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC;gCAC5B,OAAO,IAAA,WAAI,EAAC,SAAS,CAAC,OAAO,CAAC,CAAC;4BACjC,CAAC;wBACH,CAAC;oBACH,CAAC;oBAED,iBAAiB;oBACjB,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAY,EAAE,OAAO,CAAC,CAAC;oBACtE,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;wBAC7B,IAAI,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;4BAC9B,SAAS;wBACX,CAAC;wBACD,MAAM,CAAC,UAAU,CAAC,aAAa,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC;wBAC/D,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC;4BAC5B,OAAO,IAAA,WAAI,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC;wBACnC,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAED,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7D,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAmB,MAAW;IAC3D,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAa,EAAwB,EAAE;YAChE,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,CAAC,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,MAAM,CAAC;gBAC5B,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC;gBACnC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,6BAA6B,IAAI,mBAAmB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACvG,CAAC;YACD,OAAO,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACtE,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CACrB,KAAQ;IAER,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CAAC,IAAa,EAAwB,EAAE;YACjD,OAAO,IAAI,KAAK,KAAK;gBACnB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,IAAA,WAAI,EAAC,oBAAoB,MAAM,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9F,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,KAAK,CACnB,UAAmC,EACnC,MAAmE;IAEnE,OAAO,IAAI,sBAAc,iCAAa,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,KAAE,UAAU,IAAG,CAAC;AACtE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,GAAG,CACjB,WAAmB,EACnB,KAAkC,EAClC,MAAkF;IAElF,OAAO,IAAI,8BAAkB,iBAAG,WAAW,EAAE,KAAK,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC3E,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,OAAO,CAAkB,SAA+B;IACtE,OAAO,IAAI,mCAAgB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;AAC7C,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 { Failure, fail, isKeyOf, MessageAggregator } from '../base';\nimport { ArrayValidator, ArrayValidatorConstructorParams } from './array';\nimport { FieldValidators, ObjectValidator, ObjectValidatorConstructorParams } from './object';\nimport { TypeGuardValidator, TypeGuardValidatorConstructorParams } from './typeGuard';\n\nimport { BooleanValidator } from './boolean';\nimport { TypeGuardWithContext, ValidatorFunc } from './common';\nimport { GenericValidator } from './genericValidator';\nimport { NumberValidator } from './number';\nimport { OneOfValidator, OneOfValidatorConstructorParams } from './oneOf';\nimport { StringValidator } from './string';\nimport { Validator } from './validator';\n\n/**\n * A {@link Validation.Classes.StringValidator | StringValidator} which validates a string in place.\n * @public\n */\nexport const string: Validator<string> = new StringValidator();\n\n/**\n * A {@link Validation.Classes.NumberValidator | NumberValidator} which validates a number in place.\n * @public\n */\nexport const number: Validator<number> = new NumberValidator();\n\n/**\n * A {@link Validation.Classes.BooleanValidator | BooleanValidator} which validates a boolean in place.\n * @public\n */\nexport const boolean: Validator<boolean> = new BooleanValidator();\n\n/**\n * Helper function to create a {@link Validation.Classes.ObjectValidator | ObjectValidator} which validates\n * an object in place.\n * @param fields - A {@link Validation.Classes.FieldValidators | field validator definition}\n * describing the validations to be applied.\n * @param params - Optional {@link Validation.Classes.ObjectValidatorConstructorParams | parameters}\n * to refine the behavior of the resulting {@link Validation.Validator | validator}.\n * @returns A new {@link Validation.Validator | Validator} which validates the desired\n * object in place.\n * @public\n */\nexport function object<T, TC = unknown>(\n  fields: FieldValidators<T, TC>,\n  params?: Omit<ObjectValidatorConstructorParams<T, TC>, 'fields'>\n): ObjectValidator<T, TC> {\n  return new ObjectValidator({ fields, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Classes.ArrayValidator | ArrayValidator} which\n * validates an array in place.\n * @param validateElement - A {@link Validation.Validator | validator} which validates each element.\n * @returns A new {@link Validation.Classes.ArrayValidator | ArrayValidator } which validates the desired\n * array in place.\n * @public\n */\nexport function arrayOf<T, TC>(\n  validateElement: Validator<T, TC>,\n  params?: Omit<ArrayValidatorConstructorParams<T, TC>, 'validateElement'>\n): ArrayValidator<T, TC> {\n  return new ArrayValidator({ validateElement, ...(params ?? {}) });\n}\n\n/**\n * Options for {@link Validators.recordOf} helper function.\n * @public\n */\nexport interface IRecordOfValidatorOptions<TK extends string = string, TC = unknown> {\n  /**\n   * If `onError` is `'fail'` (default), then the entire validation fails if any key or element\n   * cannot be validated. If `onError` is `'ignore'`, failing elements are silently ignored.\n   */\n  onError?: 'fail' | 'ignore';\n  /**\n   * If present, `keyValidator` is used to validate the source object property names.\n   * @remarks\n   * Can be used to validate key names to supported values and/or strong types.\n   */\n  keyValidator?: Validator<TK, TC>;\n}\n\n/**\n * A helper function to create a {@link Validation.Validator | Validator} which validates the `string`-keyed properties\n * using a supplied {@link Validation.Validator | Validator<T, TC>} to produce a `Record<TK, T>`.\n * @remarks\n * If present, the supplied {@link Validators.IRecordOfValidatorOptions | options} can provide a strongly-typed\n * validator for keys and/or control the handling of elements that fail validation.\n * @param validator - {@link Validation.Validator | Validator} used for each item in the source object.\n * @param options - Optional {@link Validators.IRecordOfValidatorOptions | IRecordOfValidatorOptions<TK, TC>} which\n * supplies a key validator and/or error-handling options.\n * @returns A {@link Validation.Validator | Validator} which validates `Record<TK, T>`.\n * @public\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n  validator: Validator<T, TC>,\n  options?: IRecordOfValidatorOptions<TK, TC>\n): Validator<Record<TK, T>, TC> {\n  const opts: IRecordOfValidatorOptions<TK, TC> = { onError: 'fail', ...options };\n\n  return new GenericValidator({\n    validator: (from: unknown, context?: TC): boolean | Failure<Record<TK, T>> => {\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 errors = new MessageAggregator();\n\n      for (const key in from) {\n        if (isKeyOf(key, from)) {\n          // Validate key if keyValidator is provided\n          if (opts.keyValidator) {\n            const keyResult = opts.keyValidator.validate(key, context);\n            if (!keyResult.isSuccess()) {\n              if (opts.onError === 'ignore') {\n                continue;\n              }\n              errors.addMessage(`Key \"${key}\": ${keyResult.message}`);\n              if (opts.onError === 'fail') {\n                return fail(keyResult.message);\n              }\n            }\n          }\n\n          // Validate value\n          const valueResult = validator.validate(from[key] as unknown, context);\n          if (!valueResult.isSuccess()) {\n            if (opts.onError === 'ignore') {\n              continue;\n            }\n            errors.addMessage(`Property \"${key}\": ${valueResult.message}`);\n            if (opts.onError === 'fail') {\n              return fail(valueResult.message);\n            }\n          }\n        }\n      }\n\n      return errors.hasMessages ? fail(errors.toString()) : true;\n    }\n  });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator} which validates an enumerated\n * value in place.\n * @public\n */\nexport function enumeratedValue<T extends string>(values: T[]): Validator<T, T[]> {\n  return new GenericValidator({\n    validator: (from: unknown, context?: T[]): boolean | Failure<T> => {\n      if (typeof from === 'string') {\n        const v = context ?? values;\n        const index = v.indexOf(from as T);\n        return index >= 0 ? true : fail(`Invalid enumerated value \"${from}\"  - expected: (${v.join(', ')})`);\n      }\n      return fail(`Not a string: \"${JSON.stringify(from, undefined, 2)}`);\n    }\n  });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator} which validates a literal value.\n * @param value - the literal value to be validated\n * @public\n */\nexport function literal<T extends string | number | boolean | symbol | null | undefined>(\n  value: T\n): Validator<T> {\n  return new GenericValidator({\n    validator: (from: unknown): boolean | Failure<T> => {\n      return from === value\n        ? true\n        : fail(`Expected literal ${String(value)}, found \"${JSON.stringify(from, undefined, 2)}`);\n    }\n  });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator | Validator} which validates one\n * of several possible validated values.\n * @param validators - the {@link Validation.Validator | validators} to be considered.\n * @param params - Optional {@link Validation.Classes.OneOfValidatorConstructorParams | params} used to construct the validator.\n * @returns A new {@link Validator | Validator} which validates values that match any of\n * the supplied validators.\n * @public\n */\nexport function oneOf<T, TC = unknown>(\n  validators: Array<Validator<T, TC>>,\n  params?: Omit<OneOfValidatorConstructorParams<T, TC>, 'validators'>\n): OneOfValidator<T, TC> {\n  return new OneOfValidator<T, TC>({ ...(params ?? {}), validators });\n}\n\n/**\n * Helper function to create a {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator} which\n * validates a value or object in place.\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 Validation.Classes.TypeGuardValidator | TypeGuardValidator } which validates\n * the values using the supplied type guard.\n * @public\n */\nexport function isA<T, TC = unknown>(\n  description: string,\n  guard: TypeGuardWithContext<T, TC>,\n  params?: Omit<TypeGuardValidatorConstructorParams<T, TC>, 'description' | 'guard'>\n): TypeGuardValidator<T, TC> {\n  return new TypeGuardValidator({ description, guard, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator | Validator} using a\n * supplied {@link Validation.ValidatorFunc | validator function}.\n * @param validator - A {@link Validation.ValidatorFunc | validator function} that a\n * supplied unknown value matches some condition.\n * @returns A new {@link Validation.Validator | Validator} which validates the desired\n * value using the supplied function.\n * @public\n */\nexport function generic<T, TC = unknown>(validator: ValidatorFunc<T, TC>): Validator<T, TC> {\n  return new GenericValidator({ validator });\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-utils",
-  "version": "4.5.0-2",
+  "version": "4.5.0",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "types": "dist/ts-utils.d.ts",
@@ -29,32 +29,32 @@
   "homepage": "https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils#readme",
   "devDependencies": {
     "@jest/expect-utils": "^29.7.0",
-    "@microsoft/api-documenter": "^7.26.17",
-    "@microsoft/api-extractor": "^7.52.1",
+    "@microsoft/api-documenter": "^7.26.5",
+    "@microsoft/api-extractor": "^7.49.1",
     "@types/jest": "^29.5.14",
     "@types/luxon": "^3.4.2",
     "@types/mustache": "^4.2.5",
-    "@types/node": "^22.13.11",
-    "@typescript-eslint/eslint-plugin": "^8.27.0",
-    "@typescript-eslint/parser": "^8.27.0",
+    "@types/node": "^20.14.9",
+    "@typescript-eslint/eslint-plugin": "^7.14.1",
+    "@typescript-eslint/parser": "^7.14.1",
     "eslint": "^8.57.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^7.2.1",
+    "eslint-plugin-promise": "^6.2.0",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
     "jest-matcher-utils": "^29.7.0",
-    "rimraf": "^6.0.1",
-    "ts-jest": "^29.2.6",
+    "rimraf": "^5.0.7",
+    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.8.2",
-    "eslint-plugin-n": "^17.16.2",
+    "typescript": "^5.7.3",
+    "eslint-plugin-n": "^16.6.2",
     "jest-snapshot": "~29.7.0",
-    "@rushstack/heft": "~0.71.0",
-    "@rushstack/heft-node-rig": "~2.8.2",
-    "@rushstack/eslint-config": "~4.3.0",
+    "@rushstack/heft": "~0.68.13",
+    "@rushstack/heft-node-rig": "~2.6.49",
+    "@rushstack/eslint-config": "~3.7.0",
     "@types/heft-jest": "1.0.6",
-    "@rushstack/heft-jest-plugin": "~0.15.2",
+    "@rushstack/heft-jest-plugin": "~0.14.3",
     "eslint-plugin-tsdoc": "~0.4.0"
   }
 }

package/lib/packlets/file-tree/directoryItem.d.ts

@@ -1,47 +0,0 @@
-import { Result } from '../base';
-import { FileTreeItem, IFileTreeAccessors, IFileTreeDirectoryItem } from './fileTreeAccessors';
-/**
- * Class representing a directory in a file tree.
- * @public
- */
-export declare class DirectoryItem implements IFileTreeDirectoryItem {
-    /**
-     * {@inheritdoc FileTree.IFileTreeDirectoryItem."type"}
-     */
-    readonly type: 'directory';
-    /**
-     * {@inheritdoc FileTree.IFileTreeDirectoryItem.absolutePath}
-     */
-    readonly absolutePath: string;
-    /**
-     * {@inheritdoc FileTree.IFileTreeDirectoryItem.name}
-     */
-    get name(): string;
-    /**
-     * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.
-     * @public
-     */
-    protected readonly _hal: IFileTreeAccessors;
-    /**
-     * Protected constructor for derived classes.
-     * @param path - Relative path of the directory.
-     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
-     * file system operations.
-     * @public
-     */
-    protected constructor(path: string, hal: IFileTreeAccessors);
-    /**
-     * Creates a new DirectoryItem instance.
-     * @param path - Relative path of the directory.
-     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
-     * file system operations.
-     * @returns A {@link Result | result} containing the new DirectoryItem instance if successful,
-     * or a failure if an error occurs.
-     */
-    static create(path: string, hal: IFileTreeAccessors): Result<DirectoryItem>;
-    /**
-     * {@inheritdoc FileTree.IFileTreeDirectoryItem.getChildren}
-     */
-    getChildren(): Result<ReadonlyArray<FileTreeItem>>;
-}
-//# sourceMappingURL=directoryItem.d.ts.map

package/lib/packlets/file-tree/directoryItem.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"directoryItem.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/directoryItem.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAiB,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAE/F;;;GAGG;AACH,qBAAa,aAAc,YAAW,sBAAsB;IAC1D;;OAEG;IACH,SAAgB,IAAI,EAAE,WAAW,CAAe;IAEhD;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAE5C;;;;;;OAMG;IACH,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB;IAK3D;;;;;;;OAOG;WACW,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,GAAG,MAAM,CAAC,aAAa,CAAC;IAIlF;;OAEG;IACI,WAAW,IAAI,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;CAG1D"}

package/lib/packlets/file-tree/directoryItem.js

@@ -1,71 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DirectoryItem = void 0;
-const base_1 = require("../base");
-/**
- * Class representing a directory in a file tree.
- * @public
- */
-class DirectoryItem {
-    /**
-     * {@inheritdoc FileTree.IFileTreeDirectoryItem.name}
-     */
-    get name() {
-        return this._hal.getBaseName(this.absolutePath);
-    }
-    /**
-     * Protected constructor for derived classes.
-     * @param path - Relative path of the directory.
-     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
-     * file system operations.
-     * @public
-     */
-    constructor(path, hal) {
-        /**
-         * {@inheritdoc FileTree.IFileTreeDirectoryItem."type"}
-         */
-        this.type = 'directory';
-        this._hal = hal;
-        this.absolutePath = hal.resolveAbsolutePath(path);
-    }
-    /**
-     * Creates a new DirectoryItem instance.
-     * @param path - Relative path of the directory.
-     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
-     * file system operations.
-     * @returns A {@link Result | result} containing the new DirectoryItem instance if successful,
-     * or a failure if an error occurs.
-     */
-    static create(path, hal) {
-        return (0, base_1.captureResult)(() => new DirectoryItem(path, hal));
-    }
-    /**
-     * {@inheritdoc FileTree.IFileTreeDirectoryItem.getChildren}
-     */
-    getChildren() {
-        return this._hal.getChildren(this.absolutePath);
-    }
-}
-exports.DirectoryItem = DirectoryItem;
-//# sourceMappingURL=directoryItem.js.map

package/lib/packlets/file-tree/directoryItem.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"directoryItem.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/directoryItem.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgD;AAGhD;;;GAGG;AACH,MAAa,aAAa;IAWxB;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAQD;;;;;;OAMG;IACH,YAAsB,IAAY,EAAE,GAAuB;QA9B3D;;WAEG;QACa,SAAI,GAAgB,WAAW,CAAC;QA4B9C,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,GAAuB;QACxD,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;CACF;AAtDD,sCAsDC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Result, captureResult } from '../base';\nimport { FileTreeItem, IFileTreeAccessors, IFileTreeDirectoryItem } from './fileTreeAccessors';\n\n/**\n * Class representing a directory in a file tree.\n * @public\n */\nexport class DirectoryItem implements IFileTreeDirectoryItem {\n  /**\n   * {@inheritdoc FileTree.IFileTreeDirectoryItem.\"type\"}\n   */\n  public readonly type: 'directory' = 'directory';\n\n  /**\n   * {@inheritdoc FileTree.IFileTreeDirectoryItem.absolutePath}\n   */\n  public readonly absolutePath: string;\n\n  /**\n   * {@inheritdoc FileTree.IFileTreeDirectoryItem.name}\n   */\n  public get name(): string {\n    return this._hal.getBaseName(this.absolutePath);\n  }\n\n  /**\n   * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.\n   * @public\n   */\n  protected readonly _hal: IFileTreeAccessors;\n\n  /**\n   * Protected constructor for derived classes.\n   * @param path - Relative path of the directory.\n   * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n   * file system operations.\n   * @public\n   */\n  protected constructor(path: string, hal: IFileTreeAccessors) {\n    this._hal = hal;\n    this.absolutePath = hal.resolveAbsolutePath(path);\n  }\n\n  /**\n   * Creates a new DirectoryItem instance.\n   * @param path - Relative path of the directory.\n   * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n   * file system operations.\n   * @returns A {@link Result | result} containing the new DirectoryItem instance if successful,\n   * or a failure if an error occurs.\n   */\n  public static create(path: string, hal: IFileTreeAccessors): Result<DirectoryItem> {\n    return captureResult(() => new DirectoryItem(path, hal));\n  }\n\n  /**\n   * {@inheritdoc FileTree.IFileTreeDirectoryItem.getChildren}\n   */\n  public getChildren(): Result<ReadonlyArray<FileTreeItem>> {\n    return this._hal.getChildren(this.absolutePath);\n  }\n}\n"]}

package/lib/packlets/file-tree/fileItem.d.ts

@@ -1,64 +0,0 @@
-import { Result } from '../base';
-import { Converter } from '../conversion';
-import { Validator } from '../validation';
-import { IFileTreeAccessors, IFileTreeFileItem } from './fileTreeAccessors';
-/**
- * Class representing a file in a file tree.
- * @public
- */
-export declare class FileItem implements IFileTreeFileItem {
-    /**
-     * {@inheritdoc FileTree.IFileTreeFileItem."type"}
-     */
-    readonly type: 'file';
-    /**
-     * {@inheritdoc FileTree.IFileTreeFileItem.absolutePath}
-     */
-    readonly absolutePath: string;
-    /**
-     * {@inheritdoc FileTree.IFileTreeFileItem.name}
-     */
-    get name(): string;
-    /**
-     * {@inheritdoc FileTree.IFileTreeFileItem.baseName}
-     */
-    get baseName(): string;
-    /**
-     * {@inheritdoc FileTree.IFileTreeFileItem.extension}
-     */
-    get extension(): string;
-    /**
-     * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.
-     * @public
-     */
-    protected readonly _hal: IFileTreeAccessors;
-    /**
-     * Protected constructor for derived classes.
-     * @param path - Relative path of the file.
-     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
-     * file system operations.
-     * @public
-     */
-    protected constructor(path: string, hal: IFileTreeAccessors);
-    /**
-     * Creates a new {@link FileTree.FileItem | FileItem} instance.
-     * @param path - Relative path of the file.
-     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
-     * file system operations.
-     * @public
-     */
-    static create(path: string, hal: IFileTreeAccessors): Result<FileItem>;
-    /**
-     * {@inheritdoc FileTree.IFileTreeFileItem.(getContents:1)}
-     */
-    getContents(): Result<unknown>;
-    /**
-     * {@inheritdoc FileTree.IFileTreeFileItem.(getContents:2)}
-     */
-    getContents<T>(converter: Validator<T> | Converter<T>): Result<T>;
-    /**
-     * {@inheritdoc FileTree.IFileTreeFileItem.getRawContents}
-     */
-    getRawContents(): Result<string>;
-}
-//# sourceMappingURL=fileItem.d.ts.map

package/lib/packlets/file-tree/fileItem.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fileItem.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileItem.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,MAAM,EAAW,MAAM,SAAS,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE5E;;;GAGG;AACH,qBAAa,QAAS,YAAW,iBAAiB;IAChD;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAU;IAEtC;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAE5C;;;;;;OAMG;IACH,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB;IAK3D;;;;;;OAMG;WACW,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,GAAG,MAAM,CAAC,QAAQ,CAAC;IAI7E;;OAEG;IACI,WAAW,IAAI,MAAM,CAAC,OAAO,CAAC;IACrC;;OAEG;IACI,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAaxE;;OAEG;IACI,cAAc,IAAI,MAAM,CAAC,MAAM,CAAC;CAGxC"}