@fgv/ts-utils 2.1.0 → 2.1.1-alpha.0

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,kCAAiD;AACjD,2CAAuD;AACvD,6CAAoD;AA+BpD;;;;;;;;;GASG;AACH,MAAa,eAAiC,SAAQ,yBAAoB;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;gBACxB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;oBACf,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;wBACpD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;qBAC/B;yBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;wBAC7B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;qBAC7B;iBACF;aACF;YAED,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE;gBAChC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBACpD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;wBACtB,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;4BACpF,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,wCAAwC,CAAC,CAAC;yBAC7D;qBACF;iBACF;qBAAM;oBACL,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;iBACxC;aACF;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;YACtB,IAAI,CAAC,OAAO,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC;SACxC;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC;SAC1B;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 { BaseConverter, 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 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> = { [key in keyof T]: Converter<T[key], TC> };\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>;\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>} 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>} 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"]}
+{"version":3,"file":"objectConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/objectConverter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAiD;AACjD,2CAAuD;AACvD,6CAAoD;AA+BpD;;;;;;;;;GASG;AACH,MAAa,eAAiC,SAAQ,yBAAoB;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 { BaseConverter, 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 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> = { [key in keyof T]: Converter<T[key], TC> };\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>;\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>} 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>} 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/conversion/stringConverter.js.map

@@ -1 +1 @@
-{"version":3,"file":"stringConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/stringConverter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgD;AAChD,2CAAwE;AAiBxE;;;;;GAKG;AACH,MAAa,eAAyD,SAAQ,yBAAoB;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,IAAA,cAAO,EAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,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;YAC7B,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,KAAK,IAAI;oBACnB,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,sBAAsB,KAAK,GAAG,CAAC,CAAC;YACvF,CAAC,CAAC,CAAC;SACJ;aAAM,IAAI,KAAK,YAAY,MAAM,EAAE;YAClC,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;oBACrB,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,sBAAsB,KAAK,GAAG,CAAC,CAAC;YACvF,CAAC,CAAC,CAAC;SACJ;aAAM,IAAI,KAAK,YAAY,GAAG,EAAE;YAC/B,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;oBACpB,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,qBAAqB,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;oBACzB,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,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;SACJ;IACH,CAAC;CACF;AArHD,0CAqHC","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, Converter, ConverterTraits } from './converter';\n\n/**\n * Options for {@link Conversion.StringConverter | StringConverter}\n * matching method\n * @public\n */\n\n// eslint-disable-next-line @typescript-eslint/naming-convention\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"]}
+{"version":3,"file":"stringConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/stringConverter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgD;AAChD,2CAAwE;AAiBxE;;;;;GAKG;AACH,MAAa,eAAyD,SAAQ,yBAAoB;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,IAAA,cAAO,EAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,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,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,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,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,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,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,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,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,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;AArHD,0CAqHC","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, Converter, ConverterTraits } from './converter';\n\n/**\n * Options for {@link Conversion.StringConverter | StringConverter}\n * matching method\n * @public\n */\n\n// eslint-disable-next-line @typescript-eslint/naming-convention\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/lib/packlets/validation/array.js.map

@@ -1 +1 @@
-{"version":3,"file":"array.js","sourceRoot":"","sources":["../../../src/packlets/validation/array.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AAExC,mDAAgF;AAYhF;;;;GAIG;AACH,MAAa,cAAgC,SAAQ,6BAAsB;IASzE;;;;OAIG;IACH,YAAmB,MAA8C;;QAC/D,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACO,SAAS,CAAI,IAAa,EAAE,OAAY;QAChD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE;gBACvB,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAC7D,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE;oBACvB,OAAO,IAAA,WAAI,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC;iBAC7B;aACF;YACD,OAAO,IAAI,CAAC;SACb;QACD,OAAO,IAAA,WAAI,EAAI,IAAI,IAAI,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF;AAzCD,wCAyCC","sourcesContent":["/*\n * Copyright (c) 2022 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 { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.ArrayValidator | ArrayValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ArrayValidatorConstructorParams<T, TC = unknown>\n  extends ValidatorBaseConstructorParams<T[], TC> {\n  validateElement: Validator<T, TC>;\n}\n\n/**\n * An in-place {@link Validator | Validator} for arrays of validated\n * values or objects.\n * @public\n */\nexport class ArrayValidator<T, TC = unknown> extends ValidatorBase<T[], TC> {\n  /**\n   * {@link Validation.ValidatorOptions | Options} which apply to this\n   * validator.\n   */\n  public readonly options: ValidatorOptions<TC>;\n\n  protected readonly _validateElement: Validator<T, TC>;\n\n  /**\n   * Constructs a new {@link Validation.Classes.ArrayValidator | ArrayValidator}.\n   * @param params - Optional {@link Validation.Classes.ArrayValidatorConstructorParams | init params} for the\n   * new {@link Validation.Classes.ArrayValidator | ArrayValidator}.\n   */\n  public constructor(params: ArrayValidatorConstructorParams<T, TC>) {\n    super(params);\n    this._validateElement = params.validateElement;\n    this.options = params.options ?? {};\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `array`\n   * and that every element of the array can be validated by the supplied array\n   * validator.\n   * @param from - The `unknown` value to be tested.\n   * @param context - Optional validation context will be propagated to element validator.\n   * @returns Returns `true` if `from` is an `array` of valid elements, or\n   * {@link Failure} with an error message if not.\n   */\n  protected _validate<T>(from: unknown, context?: TC): boolean | Failure<T> {\n    if (Array.isArray(from)) {\n      for (const elem of from) {\n        const result = this._validateElement.validate(elem, context);\n        if (!result.isSuccess()) {\n          return fail(result.message);\n        }\n      }\n      return true;\n    }\n    return fail<T>(`\"${from}\": not an array`);\n  }\n}\n"]}
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../../../src/packlets/validation/array.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AAExC,mDAAgF;AAYhF;;;;GAIG;AACH,MAAa,cAAgC,SAAQ,6BAAsB;IASzE;;;;OAIG;IACH,YAAmB,MAA8C;;QAC/D,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACO,SAAS,CAAI,IAAa,EAAE,OAAY;QAChD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;gBACxB,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAC7D,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;oBACxB,OAAO,IAAA,WAAI,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAA,WAAI,EAAI,IAAI,IAAI,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF;AAzCD,wCAyCC","sourcesContent":["/*\n * Copyright (c) 2022 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 { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.ArrayValidator | ArrayValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ArrayValidatorConstructorParams<T, TC = unknown>\n  extends ValidatorBaseConstructorParams<T[], TC> {\n  validateElement: Validator<T, TC>;\n}\n\n/**\n * An in-place {@link Validator | Validator} for arrays of validated\n * values or objects.\n * @public\n */\nexport class ArrayValidator<T, TC = unknown> extends ValidatorBase<T[], TC> {\n  /**\n   * {@link Validation.ValidatorOptions | Options} which apply to this\n   * validator.\n   */\n  public readonly options: ValidatorOptions<TC>;\n\n  protected readonly _validateElement: Validator<T, TC>;\n\n  /**\n   * Constructs a new {@link Validation.Classes.ArrayValidator | ArrayValidator}.\n   * @param params - Optional {@link Validation.Classes.ArrayValidatorConstructorParams | init params} for the\n   * new {@link Validation.Classes.ArrayValidator | ArrayValidator}.\n   */\n  public constructor(params: ArrayValidatorConstructorParams<T, TC>) {\n    super(params);\n    this._validateElement = params.validateElement;\n    this.options = params.options ?? {};\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `array`\n   * and that every element of the array can be validated by the supplied array\n   * validator.\n   * @param from - The `unknown` value to be tested.\n   * @param context - Optional validation context will be propagated to element validator.\n   * @returns Returns `true` if `from` is an `array` of valid elements, or\n   * {@link Failure} with an error message if not.\n   */\n  protected _validate<T>(from: unknown, context?: TC): boolean | Failure<T> {\n    if (Array.isArray(from)) {\n      for (const elem of from) {\n        const result = this._validateElement.validate(elem, context);\n        if (!result.isSuccess()) {\n          return fail(result.message);\n        }\n      }\n      return true;\n    }\n    return fail<T>(`\"${from}\": not an array`);\n  }\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"boolean.js","sourceRoot":"","sources":["../../../src/packlets/validation/boolean.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAQzF;;;GAGG;AACH,MAAa,gBAA+B,SAAQ,mCAA6B;IAC/E;;;;OAIG;IACH,YAAmB,MAA8C;QAC/D,oBAAoB;QACpB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,KAAK,iBACH,SAAS,EAAE,gBAAgB,CAAC,eAAe,IACxC,MAAM,EACT,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,IAAa;QACzC,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE;YAC7B,OAAO,IAAI,CAAC;SACb;QACD,OAAO,IAAA,WAAI,EAAC,IAAI,IAAI,kBAAkB,CAAC,CAAC;IAC1C,CAAC;CACF;AA3BD,4CA2BC","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 { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n * @public\n */\nexport type BooleanValidatorConstructorParams<TC = unknown> = GenericValidatorConstructorParams<boolean, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `boolean` values.\n * @public\n */\nexport class BooleanValidator<TC = unknown> extends GenericValidator<boolean, TC> {\n  /**\n   * Constructs a new {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n   * @param params - Optional {@link Validation.Classes.BooleanValidatorConstructorParams | init params} for the\n   * new {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n   */\n  public constructor(params?: BooleanValidatorConstructorParams<TC>) {\n    /* c8 ignore next */\n    params = params ?? {};\n    super({\n      validator: BooleanValidator.validateBoolean,\n      ...params\n    });\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `boolean`.\n   * @param from - The `unknown` value to be tested.\n   * @returns Returns `true` if `from` is a `boolean`, or {@link Failure} with an error\n   * message if not.\n   */\n  public static validateBoolean(from: unknown): boolean | Failure<boolean> {\n    if (typeof from === 'boolean') {\n      return true;\n    }\n    return fail(`\"${from}\": not a boolean`);\n  }\n}\n"]}
+{"version":3,"file":"boolean.js","sourceRoot":"","sources":["../../../src/packlets/validation/boolean.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAQzF;;;GAGG;AACH,MAAa,gBAA+B,SAAQ,mCAA6B;IAC/E;;;;OAIG;IACH,YAAmB,MAA8C;QAC/D,oBAAoB;QACpB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,KAAK,iBACH,SAAS,EAAE,gBAAgB,CAAC,eAAe,IACxC,MAAM,EACT,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,IAAa;QACzC,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,IAAI,IAAI,kBAAkB,CAAC,CAAC;IAC1C,CAAC;CACF;AA3BD,4CA2BC","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 { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n * @public\n */\nexport type BooleanValidatorConstructorParams<TC = unknown> = GenericValidatorConstructorParams<boolean, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `boolean` values.\n * @public\n */\nexport class BooleanValidator<TC = unknown> extends GenericValidator<boolean, TC> {\n  /**\n   * Constructs a new {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n   * @param params - Optional {@link Validation.Classes.BooleanValidatorConstructorParams | init params} for the\n   * new {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n   */\n  public constructor(params?: BooleanValidatorConstructorParams<TC>) {\n    /* c8 ignore next */\n    params = params ?? {};\n    super({\n      validator: BooleanValidator.validateBoolean,\n      ...params\n    });\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `boolean`.\n   * @param from - The `unknown` value to be tested.\n   * @returns Returns `true` if `from` is a `boolean`, or {@link Failure} with an error\n   * message if not.\n   */\n  public static validateBoolean(from: unknown): boolean | Failure<boolean> {\n    if (typeof from === 'boolean') {\n      return true;\n    }\n    return fail(`\"${from}\": not a boolean`);\n  }\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"field.js","sourceRoot":"","sources":["../../../src/packlets/validation/field.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAiD;AAEjD,mDAAgD;AAWhD;;;;GAIG;AACH,MAAa,cAAkC,SAAQ,6BAAoB;IAczE;;;;;;;OAOG;IACH,YACE,SAAiB,EACjB,cAAgC,EAChC,OAAmC;QAEnC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,oBAAoB;QACpB,IAAI,CAAC,aAAa,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE;YACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,KAAK,IAAI,CAAC;YAEtD,IAAI,IAAA,cAAO,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE;gBACjC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE;oBACnD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc;yBAC/B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;yBACvC,SAAS,CAAC,CAAC,OAAe,EAAE,EAAE;wBAC7B,OAAO,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC,CAAC;oBAC/C,CAAC,CAAC,CAAC;oBAEL,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;iBACvC;aACF;YAED,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,IAAI,IAAI,CAAC,SAAS,0BAA0B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACnG;QACD,0CAA0C;QAC1C,OAAO,IAAA,WAAI,EAAC,0BAA0B,IAAI,CAAC,SAAS,sBAAsB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrG,CAAC;CACF;AA1DD,wCA0DC","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, fail, isKeyOf } from '../base';\nimport { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase } from './validatorBase';\n\n/**\n * Parameters used to construct a {@link Validation.FieldValidator | FieldValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface FieldValidatorOptions<TC> extends ValidatorOptions<TC> {\n  optional?: boolean;\n}\n\n/**\n * An in-place {@link Validation.Validator | Validator} for properties\n * an an object.\n * @public\n */\nexport class FieldValidator<T, TC = undefined> extends ValidatorBase<T, TC> {\n  /**\n   * The name of the property that this validator should validate.\n   */\n  public readonly fieldName: string;\n  /**\n   * The {@link Validation.Validator | Validator} to be applied against the named property.\n   */\n  public readonly fieldValidator: Validator<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _fieldOptions: FieldValidatorOptions<TC>;\n\n  /**\n   * Constructs a new {@link Validation.FieldValidator | FieldValidator.}.\n   * @param fieldName - The name of the property that this validator should validate.\n   * @param fieldValidator - The {@link Validation.Validator | Validator} to be applied\n   * against the named property.\n   * @param options - Additional {@link Validation.FieldValidatorOptions | options} to be\n   * applied to this validation.\n   */\n  public constructor(\n    fieldName: string,\n    fieldValidator: Validator<T, TC>,\n    options?: FieldValidatorOptions<TC>\n  ) {\n    super({ options });\n    this.fieldName = fieldName;\n    this.fieldValidator = fieldValidator;\n    /* c8 ignore next */\n    this._fieldOptions = options ?? {};\n  }\n\n  /**\n   * {@inheritdoc Validation.ValidatorBase._validate}\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n      const optional = this._fieldOptions.optional === true;\n\n      if (isKeyOf(this.fieldName, from)) {\n        if (!optional || from[this.fieldName] !== undefined) {\n          const result = this.fieldValidator\n            .validate(from[this.fieldName], context)\n            .onFailure((message: string) => {\n              return fail(`${this.fieldName}: ${message}`);\n            });\n\n          return result.success ? true : result;\n        }\n      }\n\n      return optional ? true : fail(`\"${this.fieldName}\": Field not found in \"${JSON.stringify(from)}`);\n    }\n    /* c8 ignore next 2 -- defense in depth */\n    return fail(`Cannot validate field '${this.fieldName}' from non-object \"${JSON.stringify(from)}\"`);\n  }\n}\n"]}
+{"version":3,"file":"field.js","sourceRoot":"","sources":["../../../src/packlets/validation/field.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAiD;AAEjD,mDAAgD;AAWhD;;;;GAIG;AACH,MAAa,cAAkC,SAAQ,6BAAoB;IAczE;;;;;;;OAOG;IACH,YACE,SAAiB,EACjB,cAAgC,EAChC,OAAmC;QAEnC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,oBAAoB;QACpB,IAAI,CAAC,aAAa,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACtE,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,KAAK,IAAI,CAAC;YAEtD,IAAI,IAAA,cAAO,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE,CAAC;oBACpD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc;yBAC/B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;yBACvC,SAAS,CAAC,CAAC,OAAe,EAAE,EAAE;wBAC7B,OAAO,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC,CAAC;oBAC/C,CAAC,CAAC,CAAC;oBAEL,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;gBACxC,CAAC;YACH,CAAC;YAED,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,IAAI,IAAI,CAAC,SAAS,0BAA0B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpG,CAAC;QACD,0CAA0C;QAC1C,OAAO,IAAA,WAAI,EAAC,0BAA0B,IAAI,CAAC,SAAS,sBAAsB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrG,CAAC;CACF;AA1DD,wCA0DC","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, fail, isKeyOf } from '../base';\nimport { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase } from './validatorBase';\n\n/**\n * Parameters used to construct a {@link Validation.FieldValidator | FieldValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface FieldValidatorOptions<TC> extends ValidatorOptions<TC> {\n  optional?: boolean;\n}\n\n/**\n * An in-place {@link Validation.Validator | Validator} for properties\n * an an object.\n * @public\n */\nexport class FieldValidator<T, TC = undefined> extends ValidatorBase<T, TC> {\n  /**\n   * The name of the property that this validator should validate.\n   */\n  public readonly fieldName: string;\n  /**\n   * The {@link Validation.Validator | Validator} to be applied against the named property.\n   */\n  public readonly fieldValidator: Validator<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _fieldOptions: FieldValidatorOptions<TC>;\n\n  /**\n   * Constructs a new {@link Validation.FieldValidator | FieldValidator.}.\n   * @param fieldName - The name of the property that this validator should validate.\n   * @param fieldValidator - The {@link Validation.Validator | Validator} to be applied\n   * against the named property.\n   * @param options - Additional {@link Validation.FieldValidatorOptions | options} to be\n   * applied to this validation.\n   */\n  public constructor(\n    fieldName: string,\n    fieldValidator: Validator<T, TC>,\n    options?: FieldValidatorOptions<TC>\n  ) {\n    super({ options });\n    this.fieldName = fieldName;\n    this.fieldValidator = fieldValidator;\n    /* c8 ignore next */\n    this._fieldOptions = options ?? {};\n  }\n\n  /**\n   * {@inheritdoc Validation.ValidatorBase._validate}\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n      const optional = this._fieldOptions.optional === true;\n\n      if (isKeyOf(this.fieldName, from)) {\n        if (!optional || from[this.fieldName] !== undefined) {\n          const result = this.fieldValidator\n            .validate(from[this.fieldName], context)\n            .onFailure((message: string) => {\n              return fail(`${this.fieldName}: ${message}`);\n            });\n\n          return result.success ? true : result;\n        }\n      }\n\n      return optional ? true : fail(`\"${this.fieldName}\": Field not found in \"${JSON.stringify(from)}`);\n    }\n    /* c8 ignore next 2 -- defense in depth */\n    return fail(`Cannot validate field '${this.fieldName}' from non-object \"${JSON.stringify(from)}\"`);\n  }\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"genericValidator.js","sourceRoot":"","sources":["../../../src/packlets/validation/genericValidator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgE;AAChE,qCAA4D;AAsB5D;;;GAGG;AACH,MAAa,gBAAgB;IAe3B;;;;OAIG;IACH,YAAmB,MAAyD;;QAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACnD;QACD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,IAAa,EAAE,OAAY;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7D,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE;YAC/B,OAAO,MAAM,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAI,eAAe,CAAC,CAAC;SAC/D;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAa,EAAE,OAAY;QACjD,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAa,EAAE,OAAY;QACtC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,OAAO,IAAI,gBAAgB,CAAC;YAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7E,CAAC;YACD,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,UAAyB,EAAE,KAAuB;QACtE,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;QACtC,OAAO,IAAI,gBAAgB,CAAC;YAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAwB,EAAE;gBAC/D,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE;oBAC1D,MAAM,gBAAgB,GAAG,UAAU,CAAC,IAAS,CAAC,CAAC;oBAC/C,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE;wBACzC,OAAO,gBAAgB;4BACrB,CAAC,CAAC,IAAI;4BACN,CAAC,CAAC,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;qBACjF;oBACD,OAAO,gBAAgB,CAAC;iBACzB;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,EAAE,EAAE,WAAW,EAAE,CAAC,KAAK,CAAC,EAAE;SACjC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,SAAS,CAAmB,KAAQ;QACzC,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,CAAC,KAAK,WAAW,KAAK,IAAI,CAAC,CAAC;SACnF;QAED,OAAO,IAAI,gBAAgB,CAAkB;YAC3C,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAmC,CAAC;YACzF,CAAC;YACD,MAAM,EAAE,EAAE,KAAK,EAAE;SAClB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACO,QAAQ,CAAC,eAAoB;QACrC,OAAO,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;IACzD,CAAC;CACF;AA/HD,4CA+HC","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 { Brand, Failure, Result, fail, succeed } from '../base';\nimport { ConstraintTrait, ValidatorTraits } from './traits';\nimport { Constraint, Validator, ValidatorOptions } from './validator';\n\n/**\n * Type for a validation function, which validates that a supplied `unknown`\n * value is a valid value of type `<T>`, possibly as influenced by\n * an optionally-supplied validation context of type `<TC>`.\n * @public\n */\nexport type ValidatorFunc<T, TC> = (from: unknown, context?: TC) => boolean | Failure<T>;\n\n/**\n * Options used to initialize a {@link Validation.Base.GenericValidator | GenericValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface GenericValidatorConstructorParams<T, TC> {\n  options?: ValidatorOptions<TC>;\n  traits?: Partial<ValidatorTraits>;\n  validator?: ValidatorFunc<T, TC>;\n}\n\n/**\n * Generic base implementation for an in-place {@link Validation.Validator | Validator}.\n * @public\n */\nexport class GenericValidator<T, TC = undefined> implements Validator<T, TC> {\n  /**\n   * {@inheritdoc Validation.Validator.traits}\n   */\n  public readonly traits: ValidatorTraits;\n\n  /**\n   * @internal\n   */\n  protected readonly _validator: ValidatorFunc<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _options: ValidatorOptions<TC>;\n\n  /**\n   * Constructs a new {@link Validation.Base.GenericValidator | GenericValidator<T>}.\n   * @param params - The {@link Validation.Base.GenericValidatorConstructorParams | constructor params}\n   * used to configure validation.\n   */\n  public constructor(params: Partial<GenericValidatorConstructorParams<T, TC>>) {\n    if (!params.validator) {\n      throw new Error('No validator function supplied');\n    }\n    this._validator = params.validator;\n    this._options = params.options ?? {};\n    this.traits = new ValidatorTraits(params.traits);\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.isOptional}\n   */\n  public get isOptional(): boolean {\n    return this.traits.isOptional;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.brand}\n   */\n  public get brand(): string | undefined {\n    return this.traits.brand;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.validate}\n   */\n  public validate(from: unknown, context?: TC): Result<T> {\n    const result = this._validator(from, this._context(context));\n    if (typeof result === 'boolean') {\n      return result ? succeed(from as T) : fail<T>('Invalid value');\n    }\n    return result;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.validateOptional}\n   */\n  public validateOptional(from: unknown, context?: TC): Result<T | undefined> {\n    return from === undefined ? succeed(undefined) : this.validate(from, context);\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.guard}\n   */\n  public guard(from: unknown, context?: TC): from is T {\n    return this._validator(from, this._context(context)) === true;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.optional}\n   */\n  public optional(): Validator<T | undefined, TC> {\n    return new GenericValidator({\n      validator: (from: unknown, context?: TC) => {\n        return from === undefined || this._validator(from, this._context(context));\n      },\n      traits: { isOptional: true }\n    });\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.withConstraint}\n   */\n  public withConstraint(constraint: Constraint<T>, trait?: ConstraintTrait): Validator<T, TC> {\n    trait = trait ?? { type: 'function' };\n    return new GenericValidator({\n      validator: (from: unknown, context?: TC): boolean | Failure<T> => {\n        if (this._validator(from, this._context(context)) === true) {\n          const constraintResult = constraint(from as T);\n          if (typeof constraintResult === 'boolean') {\n            return constraintResult\n              ? true\n              : fail(`Invalid value \"${JSON.stringify(from)}\":  does not meet constraint.`);\n          }\n          return constraintResult;\n        }\n        return false;\n      },\n      traits: { constraints: [trait] }\n    });\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.brand}\n   */\n  public withBrand<B extends string>(brand: B): Validator<Brand<T, B>, TC> {\n    if (this.brand) {\n      throw new Error(`Cannot replace existing brand \"${this.brand}\" with \"${brand}\".`);\n    }\n\n    return new GenericValidator<Brand<T, B>, TC>({\n      validator: (from: unknown, context?: TC) => {\n        return this._validator(from, this._context(context)) as boolean | Failure<Brand<T, B>>;\n      },\n      traits: { brand }\n    });\n  }\n\n  /**\n   * Gets a default or explicit context.\n   * @param explicitContext - Optional explicit context.\n   * @returns The appropriate context to use.\n   * @internal\n   */\n  protected _context(explicitContext?: TC): TC | undefined {\n    return explicitContext ?? this._options.defaultContext;\n  }\n}\n"]}
+{"version":3,"file":"genericValidator.js","sourceRoot":"","sources":["../../../src/packlets/validation/genericValidator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgE;AAChE,qCAA4D;AAsB5D;;;GAGG;AACH,MAAa,gBAAgB;IAe3B;;;;OAIG;IACH,YAAmB,MAAyD;;QAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,IAAa,EAAE,OAAY;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7D,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,MAAM,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAI,eAAe,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAa,EAAE,OAAY;QACjD,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAa,EAAE,OAAY;QACtC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,OAAO,IAAI,gBAAgB,CAAC;YAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7E,CAAC;YACD,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,UAAyB,EAAE,KAAuB;QACtE,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;QACtC,OAAO,IAAI,gBAAgB,CAAC;YAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAwB,EAAE;gBAC/D,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;oBAC3D,MAAM,gBAAgB,GAAG,UAAU,CAAC,IAAS,CAAC,CAAC;oBAC/C,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE,CAAC;wBAC1C,OAAO,gBAAgB;4BACrB,CAAC,CAAC,IAAI;4BACN,CAAC,CAAC,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;oBAClF,CAAC;oBACD,OAAO,gBAAgB,CAAC;gBAC1B,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,EAAE,EAAE,WAAW,EAAE,CAAC,KAAK,CAAC,EAAE;SACjC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,SAAS,CAAmB,KAAQ;QACzC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,CAAC,KAAK,WAAW,KAAK,IAAI,CAAC,CAAC;QACpF,CAAC;QAED,OAAO,IAAI,gBAAgB,CAAkB;YAC3C,SAAS,EAAE,CAAC,IAAa,EAAE,OAAY,EAAE,EAAE;gBACzC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAmC,CAAC;YACzF,CAAC;YACD,MAAM,EAAE,EAAE,KAAK,EAAE;SAClB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACO,QAAQ,CAAC,eAAoB;QACrC,OAAO,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;IACzD,CAAC;CACF;AA/HD,4CA+HC","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 { Brand, Failure, Result, fail, succeed } from '../base';\nimport { ConstraintTrait, ValidatorTraits } from './traits';\nimport { Constraint, Validator, ValidatorOptions } from './validator';\n\n/**\n * Type for a validation function, which validates that a supplied `unknown`\n * value is a valid value of type `<T>`, possibly as influenced by\n * an optionally-supplied validation context of type `<TC>`.\n * @public\n */\nexport type ValidatorFunc<T, TC> = (from: unknown, context?: TC) => boolean | Failure<T>;\n\n/**\n * Options used to initialize a {@link Validation.Base.GenericValidator | GenericValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface GenericValidatorConstructorParams<T, TC> {\n  options?: ValidatorOptions<TC>;\n  traits?: Partial<ValidatorTraits>;\n  validator?: ValidatorFunc<T, TC>;\n}\n\n/**\n * Generic base implementation for an in-place {@link Validation.Validator | Validator}.\n * @public\n */\nexport class GenericValidator<T, TC = undefined> implements Validator<T, TC> {\n  /**\n   * {@inheritdoc Validation.Validator.traits}\n   */\n  public readonly traits: ValidatorTraits;\n\n  /**\n   * @internal\n   */\n  protected readonly _validator: ValidatorFunc<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _options: ValidatorOptions<TC>;\n\n  /**\n   * Constructs a new {@link Validation.Base.GenericValidator | GenericValidator<T>}.\n   * @param params - The {@link Validation.Base.GenericValidatorConstructorParams | constructor params}\n   * used to configure validation.\n   */\n  public constructor(params: Partial<GenericValidatorConstructorParams<T, TC>>) {\n    if (!params.validator) {\n      throw new Error('No validator function supplied');\n    }\n    this._validator = params.validator;\n    this._options = params.options ?? {};\n    this.traits = new ValidatorTraits(params.traits);\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.isOptional}\n   */\n  public get isOptional(): boolean {\n    return this.traits.isOptional;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.brand}\n   */\n  public get brand(): string | undefined {\n    return this.traits.brand;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.validate}\n   */\n  public validate(from: unknown, context?: TC): Result<T> {\n    const result = this._validator(from, this._context(context));\n    if (typeof result === 'boolean') {\n      return result ? succeed(from as T) : fail<T>('Invalid value');\n    }\n    return result;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.validateOptional}\n   */\n  public validateOptional(from: unknown, context?: TC): Result<T | undefined> {\n    return from === undefined ? succeed(undefined) : this.validate(from, context);\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.guard}\n   */\n  public guard(from: unknown, context?: TC): from is T {\n    return this._validator(from, this._context(context)) === true;\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.optional}\n   */\n  public optional(): Validator<T | undefined, TC> {\n    return new GenericValidator({\n      validator: (from: unknown, context?: TC) => {\n        return from === undefined || this._validator(from, this._context(context));\n      },\n      traits: { isOptional: true }\n    });\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.withConstraint}\n   */\n  public withConstraint(constraint: Constraint<T>, trait?: ConstraintTrait): Validator<T, TC> {\n    trait = trait ?? { type: 'function' };\n    return new GenericValidator({\n      validator: (from: unknown, context?: TC): boolean | Failure<T> => {\n        if (this._validator(from, this._context(context)) === true) {\n          const constraintResult = constraint(from as T);\n          if (typeof constraintResult === 'boolean') {\n            return constraintResult\n              ? true\n              : fail(`Invalid value \"${JSON.stringify(from)}\":  does not meet constraint.`);\n          }\n          return constraintResult;\n        }\n        return false;\n      },\n      traits: { constraints: [trait] }\n    });\n  }\n\n  /**\n   * {@inheritdoc Validation.Validator.brand}\n   */\n  public withBrand<B extends string>(brand: B): Validator<Brand<T, B>, TC> {\n    if (this.brand) {\n      throw new Error(`Cannot replace existing brand \"${this.brand}\" with \"${brand}\".`);\n    }\n\n    return new GenericValidator<Brand<T, B>, TC>({\n      validator: (from: unknown, context?: TC) => {\n        return this._validator(from, this._context(context)) as boolean | Failure<Brand<T, B>>;\n      },\n      traits: { brand }\n    });\n  }\n\n  /**\n   * Gets a default or explicit context.\n   * @param explicitContext - Optional explicit context.\n   * @returns The appropriate context to use.\n   * @internal\n   */\n  protected _context(explicitContext?: TC): TC | undefined {\n    return explicitContext ?? this._options.defaultContext;\n  }\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"number.js","sourceRoot":"","sources":["../../../src/packlets/validation/number.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAWzF;;;GAGG;AACH,MAAa,eAAyD,SAAQ,mCAAuB;IACnG;;;;OAIG;IACH,YAAmB,MAAgD;QACjE,KAAK,iBACH,SAAS,EAAE,eAAe,CAAC,cAAc,IACtC,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EACjB,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAmB,IAAa;QAC1D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,IAAI,CAAC;SACb;QACD,OAAO,IAAA,WAAI,EAAI,IAAI,IAAI,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF;AAzBD,0CAyBC","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 { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.NumberValidator | NumberValidator}.\n * @public\n */\nexport type NumberValidatorConstructorParams<\n  T extends number = number,\n  TC = unknown\n> = GenericValidatorConstructorParams<T, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `number` values.\n * @public\n */\nexport class NumberValidator<T extends number = number, TC = unknown> extends GenericValidator<T, TC> {\n  /**\n   * Constructs a new {@link Validation.Classes.NumberValidator | NumberValidator}.\n   * @param params - Optional {@link Validation.Classes.NumberValidatorConstructorParams | init params} for the\n   * new {@link Validation.Classes.NumberValidator | NumberValidator}.\n   */\n  public constructor(params?: NumberValidatorConstructorParams<T, TC>) {\n    super({\n      validator: NumberValidator.validateNumber,\n      ...(params ?? {})\n    });\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `number`.\n   * @param from - The `unknown` value to be tested.\n   * @returns Returns `true` if `from` is a `number`, or {@link Failure} with an error\n   * message if not.\n   */\n  public static validateNumber<T extends number>(from: unknown): boolean | Failure<T> {\n    if (typeof from === 'number') {\n      return true;\n    }\n    return fail<T>(`\"${from}\": not a number`);\n  }\n}\n"]}
+{"version":3,"file":"number.js","sourceRoot":"","sources":["../../../src/packlets/validation/number.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAWzF;;;GAGG;AACH,MAAa,eAAyD,SAAQ,mCAAuB;IACnG;;;;OAIG;IACH,YAAmB,MAAgD;QACjE,KAAK,iBACH,SAAS,EAAE,eAAe,CAAC,cAAc,IACtC,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EACjB,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAmB,IAAa;QAC1D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAA,WAAI,EAAI,IAAI,IAAI,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF;AAzBD,0CAyBC","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 { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.NumberValidator | NumberValidator}.\n * @public\n */\nexport type NumberValidatorConstructorParams<\n  T extends number = number,\n  TC = unknown\n> = GenericValidatorConstructorParams<T, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `number` values.\n * @public\n */\nexport class NumberValidator<T extends number = number, TC = unknown> extends GenericValidator<T, TC> {\n  /**\n   * Constructs a new {@link Validation.Classes.NumberValidator | NumberValidator}.\n   * @param params - Optional {@link Validation.Classes.NumberValidatorConstructorParams | init params} for the\n   * new {@link Validation.Classes.NumberValidator | NumberValidator}.\n   */\n  public constructor(params?: NumberValidatorConstructorParams<T, TC>) {\n    super({\n      validator: NumberValidator.validateNumber,\n      ...(params ?? {})\n    });\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `number`.\n   * @param from - The `unknown` value to be tested.\n   * @returns Returns `true` if `from` is a `number`, or {@link Failure} with an error\n   * message if not.\n   */\n  public static validateNumber<T extends number>(from: unknown): boolean | Failure<T> {\n    if (typeof from === 'number') {\n      return true;\n    }\n    return fail<T>(`\"${from}\": not a number`);\n  }\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../src/packlets/validation/object.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AAExC,mDAAgF;AAEhF,mCAAyC;AA4CzC;;;;;;;GAOG;AACH,MAAa,eAAiC,SAAQ,6BAAoB;IAoBxE;;;;;;OAMG;IACH,YAAmB,MAA+C;;QAChE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;QACpC,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACtF,IAAI,CAAC,cAAc;YACjB,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACO,MAAM,CAAC,kBAAkB,CACjC,MAA8B,EAC9B,OAAuC;;QAEvC,MAAM,QAAQ,GAAoC,EAAE,CAAC;QACrD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;gBACf,oBAAoB;gBACpB,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,KAAI,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,0CAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAC;gBAClF,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,sBAAc,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;aACpE;SACF;QACD,OAAO,QAAkC,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACI,OAAO,CAAC,OAAuC;QACpD,oBAAoB;QACpB,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACxB,OAAO,IAAI,eAAe,CAAiB;YACzC,MAAM,EAAE,IAAI,CAAC,MAAyC;YACtD,OAAO,kCACF,IAAI,CAAC,OAAO,GACZ,OAAO,CACX;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,iBAA8B;;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,cAAc,EAAE,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,mCAAI,EAAE,CAAC,EAAE,GAAG,iBAAiB,CAAC;SAC/E,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACpE,OAAO,IAAA,WAAI,EAAC,yBAAyB,CAAC,CAAC;SACxC;QAED,+CAA+C;QAC/C,gDAAgD;QAChD,MAAM,SAAS,GAAG,EAAkC,CAAC;QACrD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACvC,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE;gBAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAClE,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;oBAChD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;iBAC/B;qBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;oBAC7B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;iBAC7B;aACF;SACF;QAED,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,cAAe,CAAC,GAAG,CAAC,CAAY,CAAC,CAAC,CAAC;YACzF,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,sCAAsC,CAAC,CAAC,CAAC;SACrF;QACD,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,CAAC;CACF;AAjID,0CAiIC","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 { Failure, fail } from '../base';\nimport { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';\n\nimport { FieldValidator } from './field';\n\n/**\n * Per-property {@link Validation.Validator | validators} for each of the properties in `<T>`.\n * @public\n */\nexport type FieldValidators<T, TC = unknown> = { [key in keyof T]: Validator<T[key], TC> };\n\n/**\n * Options for an {@link Validation.Classes.ObjectValidator | ObjectValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectValidatorOptions<T, TC> extends ValidatorOptions<TC> {\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\n/**\n * Options for the {@link Validation.Classes.ObjectValidator | ObjectValidator} constructor.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectValidatorConstructorParams<T, TC> extends ValidatorBaseConstructorParams<T, TC> {\n  /**\n   * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a\n   * {@link Validation.Validator | Validator} for each of the expected properties\n   * of a result object.\n   */\n  fields: FieldValidators<T>;\n  /**\n   * Optional additional {@link Validation.Classes.ObjectValidatorOptions | ValidatorOptions} to\n   * configure validation.\n   */\n  options?: ObjectValidatorOptions<T, TC>;\n}\n\n/**\n * In-place {@link Validation.Validator | Validator} for an object of type `<T>`.\n * @remarks\n * By default, succeeds if all of the required fields exist and are validate, and fails if\n * any required fields do not exist or are invalid.  See {@link Validation.Classes.ObjectValidatorOptions}\n * for other validation options.\n * @public\n */\nexport class ObjectValidator<T, TC = unknown> extends ValidatorBase<T, TC> {\n  /**\n   * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a\n   * {@link Validation.Validator | Validator} for each of the expected properties\n   */\n  public readonly fields: FieldValidators<T>;\n  /**\n   * {@link Validation.Classes.ObjectValidatorOptions | Options} which apply to this\n   * validator.\n   */\n  public readonly options: ObjectValidatorOptions<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _innerValidators: FieldValidators<T>;\n  /**\n   * @internal\n   */\n  protected readonly _allowedFields?: Set<keyof T>;\n\n  /**\n   * Constructs a new {@link Validation.Classes.ObjectValidator | ObjectValidator<T>}.\n   * @param fields - A {@link Validation.Classes.FieldValidators | FieldValidators<T>} containing\n   * a {@link Validation.Validator | Validator} for each field.\n   * @param options - An optional {@link Validation.Classes.ObjectValidatorOptions} to configure\n   * validation.\n   */\n  public constructor(params: ObjectValidatorConstructorParams<T, TC>) {\n    super(params);\n\n    this.fields = params.fields;\n    this.options = params.options ?? {};\n    this._innerValidators = ObjectValidator._resolveValidators(this.fields, this.options);\n    this._allowedFields =\n      this.options.strict === true ? new Set(Object.keys(this.fields) as (keyof T)[]) : undefined;\n  }\n\n  /**\n   * Creates the actual {@link Validation.Classes.FieldValidators | FieldValidators<T>} to be\n   * used by this converter by applying any options or traits defined in the options\n   * to the field converters passed to the constructor.\n   * @param fields - The base {@link Validation.Classes.FieldValidators | FieldValidators<T>} passed\n   * in to the constructor.\n   * @param options - The {@link Validation.Classes.ObjectValidatorOptions | object validator options}\n   * passed in to the constructor.\n   * @returns A new {@link Validation.Classes.FieldValidators | FieldValidators} with the fully-configured\n   * individual {@link Validation.Validator | field validators} to be applied.\n   * @internal\n   */\n  protected static _resolveValidators<T, TC>(\n    fields: FieldValidators<T, TC>,\n    options?: ObjectValidatorOptions<T, TC>\n  ): FieldValidators<T, TC> {\n    const resolved: Partial<FieldValidators<T, TC>> = {};\n    for (const key in fields) {\n      if (fields[key]) {\n        /* c8 ignore next */\n        const optional = fields[key].isOptional || options?.optionalFields?.includes(key);\n        resolved[key] = new FieldValidator(key, fields[key], { optional });\n      }\n    }\n    return resolved as FieldValidators<T, TC>;\n  }\n\n  /**\n   * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} derived from this one but with\n   * new optional properties as specified by a supplied\n   * {@link Validation.Classes.ObjectValidatorOptions | ObjectValidatorOptions<T>}.\n   * @param options - The {@link Validation.Classes.ObjectValidatorOptions | options} to be applied to the new\n   * {@link Validation.Classes.ObjectValidator | validator}.\n   * @returns A new {@link Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional\n   * source properties.\n   */\n  public partial(options?: ObjectValidatorOptions<T, TC>): ObjectValidator<Partial<T>, TC> {\n    /* c8 ignore next */\n    options = options ?? {};\n    return new ObjectValidator<Partial<T>, TC>({\n      fields: this.fields as FieldValidators<Partial<T>, TC>,\n      options: {\n        ...this.options,\n        ...options\n      },\n      traits: this.traits\n    });\n  }\n\n  /**\n   * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} 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 Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional\n   * source properties.\n   */\n  public addPartial(addOptionalFields: (keyof T)[]): ObjectValidator<Partial<T>, TC> {\n    return this.partial({\n      optionalFields: [...(this.options.optionalFields ?? []), ...addOptionalFields]\n    });\n  }\n\n  /**\n   * {@inheritdoc Validation.ValidatorBase._validate}\n   * @internal\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n      return fail('source is not an object');\n    }\n\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 this._innerValidators) {\n      if (this._innerValidators[key]) {\n        const result = this._innerValidators[key].validate(from, context);\n        if (result.success && 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._allowedFields) {\n      const invalid = Object.keys(from).filter((k) => !this._allowedFields!.has(k as keyof T));\n      invalid.forEach((key) => errors.push(`${key}: unexpected field in source object.`));\n    }\n    return errors.length === 0 ? true : fail(errors.join('\\n'));\n  }\n}\n"]}
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../src/packlets/validation/object.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AAExC,mDAAgF;AAEhF,mCAAyC;AA4CzC;;;;;;;GAOG;AACH,MAAa,eAAiC,SAAQ,6BAAoB;IAoBxE;;;;;;OAMG;IACH,YAAmB,MAA+C;;QAChE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;QACpC,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACtF,IAAI,CAAC,cAAc;YACjB,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACO,MAAM,CAAC,kBAAkB,CACjC,MAA8B,EAC9B,OAAuC;;QAEvC,MAAM,QAAQ,GAAoC,EAAE,CAAC;QACrD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChB,oBAAoB;gBACpB,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,KAAI,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,0CAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAC;gBAClF,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,sBAAc,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;QACD,OAAO,QAAkC,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACI,OAAO,CAAC,OAAuC;QACpD,oBAAoB;QACpB,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACxB,OAAO,IAAI,eAAe,CAAiB;YACzC,MAAM,EAAE,IAAI,CAAC,MAAyC;YACtD,OAAO,kCACF,IAAI,CAAC,OAAO,GACZ,OAAO,CACX;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,iBAA8B;;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,cAAc,EAAE,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,mCAAI,EAAE,CAAC,EAAE,GAAG,iBAAiB,CAAC;SAC/E,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACrE,OAAO,IAAA,WAAI,EAAC,yBAAyB,CAAC,CAAC;QACzC,CAAC;QAED,+CAA+C;QAC/C,gDAAgD;QAChD,MAAM,SAAS,GAAG,EAAkC,CAAC;QACrD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxC,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAClE,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBACjD,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,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,cAAe,CAAC,GAAG,CAAC,CAAY,CAAC,CAAC,CAAC;YACzF,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,sCAAsC,CAAC,CAAC,CAAC;QACtF,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,CAAC;CACF;AAjID,0CAiIC","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 { Failure, fail } from '../base';\nimport { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';\n\nimport { FieldValidator } from './field';\n\n/**\n * Per-property {@link Validation.Validator | validators} for each of the properties in `<T>`.\n * @public\n */\nexport type FieldValidators<T, TC = unknown> = { [key in keyof T]: Validator<T[key], TC> };\n\n/**\n * Options for an {@link Validation.Classes.ObjectValidator | ObjectValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectValidatorOptions<T, TC> extends ValidatorOptions<TC> {\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\n/**\n * Options for the {@link Validation.Classes.ObjectValidator | ObjectValidator} constructor.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectValidatorConstructorParams<T, TC> extends ValidatorBaseConstructorParams<T, TC> {\n  /**\n   * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a\n   * {@link Validation.Validator | Validator} for each of the expected properties\n   * of a result object.\n   */\n  fields: FieldValidators<T>;\n  /**\n   * Optional additional {@link Validation.Classes.ObjectValidatorOptions | ValidatorOptions} to\n   * configure validation.\n   */\n  options?: ObjectValidatorOptions<T, TC>;\n}\n\n/**\n * In-place {@link Validation.Validator | Validator} for an object of type `<T>`.\n * @remarks\n * By default, succeeds if all of the required fields exist and are validate, and fails if\n * any required fields do not exist or are invalid.  See {@link Validation.Classes.ObjectValidatorOptions}\n * for other validation options.\n * @public\n */\nexport class ObjectValidator<T, TC = unknown> extends ValidatorBase<T, TC> {\n  /**\n   * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a\n   * {@link Validation.Validator | Validator} for each of the expected properties\n   */\n  public readonly fields: FieldValidators<T>;\n  /**\n   * {@link Validation.Classes.ObjectValidatorOptions | Options} which apply to this\n   * validator.\n   */\n  public readonly options: ObjectValidatorOptions<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _innerValidators: FieldValidators<T>;\n  /**\n   * @internal\n   */\n  protected readonly _allowedFields?: Set<keyof T>;\n\n  /**\n   * Constructs a new {@link Validation.Classes.ObjectValidator | ObjectValidator<T>}.\n   * @param fields - A {@link Validation.Classes.FieldValidators | FieldValidators<T>} containing\n   * a {@link Validation.Validator | Validator} for each field.\n   * @param options - An optional {@link Validation.Classes.ObjectValidatorOptions} to configure\n   * validation.\n   */\n  public constructor(params: ObjectValidatorConstructorParams<T, TC>) {\n    super(params);\n\n    this.fields = params.fields;\n    this.options = params.options ?? {};\n    this._innerValidators = ObjectValidator._resolveValidators(this.fields, this.options);\n    this._allowedFields =\n      this.options.strict === true ? new Set(Object.keys(this.fields) as (keyof T)[]) : undefined;\n  }\n\n  /**\n   * Creates the actual {@link Validation.Classes.FieldValidators | FieldValidators<T>} to be\n   * used by this converter by applying any options or traits defined in the options\n   * to the field converters passed to the constructor.\n   * @param fields - The base {@link Validation.Classes.FieldValidators | FieldValidators<T>} passed\n   * in to the constructor.\n   * @param options - The {@link Validation.Classes.ObjectValidatorOptions | object validator options}\n   * passed in to the constructor.\n   * @returns A new {@link Validation.Classes.FieldValidators | FieldValidators} with the fully-configured\n   * individual {@link Validation.Validator | field validators} to be applied.\n   * @internal\n   */\n  protected static _resolveValidators<T, TC>(\n    fields: FieldValidators<T, TC>,\n    options?: ObjectValidatorOptions<T, TC>\n  ): FieldValidators<T, TC> {\n    const resolved: Partial<FieldValidators<T, TC>> = {};\n    for (const key in fields) {\n      if (fields[key]) {\n        /* c8 ignore next */\n        const optional = fields[key].isOptional || options?.optionalFields?.includes(key);\n        resolved[key] = new FieldValidator(key, fields[key], { optional });\n      }\n    }\n    return resolved as FieldValidators<T, TC>;\n  }\n\n  /**\n   * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} derived from this one but with\n   * new optional properties as specified by a supplied\n   * {@link Validation.Classes.ObjectValidatorOptions | ObjectValidatorOptions<T>}.\n   * @param options - The {@link Validation.Classes.ObjectValidatorOptions | options} to be applied to the new\n   * {@link Validation.Classes.ObjectValidator | validator}.\n   * @returns A new {@link Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional\n   * source properties.\n   */\n  public partial(options?: ObjectValidatorOptions<T, TC>): ObjectValidator<Partial<T>, TC> {\n    /* c8 ignore next */\n    options = options ?? {};\n    return new ObjectValidator<Partial<T>, TC>({\n      fields: this.fields as FieldValidators<Partial<T>, TC>,\n      options: {\n        ...this.options,\n        ...options\n      },\n      traits: this.traits\n    });\n  }\n\n  /**\n   * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} 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 Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional\n   * source properties.\n   */\n  public addPartial(addOptionalFields: (keyof T)[]): ObjectValidator<Partial<T>, TC> {\n    return this.partial({\n      optionalFields: [...(this.options.optionalFields ?? []), ...addOptionalFields]\n    });\n  }\n\n  /**\n   * {@inheritdoc Validation.ValidatorBase._validate}\n   * @internal\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n      return fail('source is not an object');\n    }\n\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 this._innerValidators) {\n      if (this._innerValidators[key]) {\n        const result = this._innerValidators[key].validate(from, context);\n        if (result.success && 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._allowedFields) {\n      const invalid = Object.keys(from).filter((k) => !this._allowedFields!.has(k as keyof T));\n      invalid.forEach((key) => errors.push(`${key}: unexpected field in source object.`));\n    }\n    return errors.length === 0 ? true : fail(errors.join('\\n'));\n  }\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../src/packlets/validation/string.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAWzF;;;GAGG;AACH,MAAa,eAAyD,SAAQ,mCAAuB;IACnG;;;;OAIG;IACH,YAAmB,MAAgD;QACjE,KAAK,iBACH,SAAS,EAAE,eAAe,CAAC,cAAc,IACtC,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EACjB,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAmB,IAAa;QAC1D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,IAAI,CAAC;SACb;QACD,OAAO,IAAA,WAAI,EAAI,IAAI,IAAI,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF;AAzBD,0CAyBC","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 { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.StringValidator | StringValidator}.\n * @public\n */\nexport type StringValidatorConstructorParams<\n  T extends string = string,\n  TC = unknown\n> = GenericValidatorConstructorParams<T, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `string` values.\n * @public\n */\nexport class StringValidator<T extends string = string, TC = unknown> extends GenericValidator<T, TC> {\n  /**\n   * Constructs a new {@link Validation.Classes.StringValidator | StringValidator}.\n   * @param params - Optional {@link Validation.Classes.StringValidatorConstructorParams | init params}\n   * for the new {@link Validation.Classes.StringValidator | StringValidator}.\n   */\n  public constructor(params?: StringValidatorConstructorParams<T, TC>) {\n    super({\n      validator: StringValidator.validateString,\n      ...(params ?? {})\n    });\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `string`.\n   * @param from - The `unknown` value to be tested.\n   * @returns Returns `true` if `from` is a `string`, or {@link Failure} with an error\n   * message if not.\n   */\n  public static validateString<T extends string>(from: unknown): boolean | Failure<T> {\n    if (typeof from === 'string') {\n      return true;\n    }\n    return fail<T>(`\"${from}\": not a string`);\n  }\n}\n"]}
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../src/packlets/validation/string.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAWzF;;;GAGG;AACH,MAAa,eAAyD,SAAQ,mCAAuB;IACnG;;;;OAIG;IACH,YAAmB,MAAgD;QACjE,KAAK,iBACH,SAAS,EAAE,eAAe,CAAC,cAAc,IACtC,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EACjB,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAmB,IAAa;QAC1D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAA,WAAI,EAAI,IAAI,IAAI,iBAAiB,CAAC,CAAC;IAC5C,CAAC;CACF;AAzBD,0CAyBC","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 { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.StringValidator | StringValidator}.\n * @public\n */\nexport type StringValidatorConstructorParams<\n  T extends string = string,\n  TC = unknown\n> = GenericValidatorConstructorParams<T, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `string` values.\n * @public\n */\nexport class StringValidator<T extends string = string, TC = unknown> extends GenericValidator<T, TC> {\n  /**\n   * Constructs a new {@link Validation.Classes.StringValidator | StringValidator}.\n   * @param params - Optional {@link Validation.Classes.StringValidatorConstructorParams | init params}\n   * for the new {@link Validation.Classes.StringValidator | StringValidator}.\n   */\n  public constructor(params?: StringValidatorConstructorParams<T, TC>) {\n    super({\n      validator: StringValidator.validateString,\n      ...(params ?? {})\n    });\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `string`.\n   * @param from - The `unknown` value to be tested.\n   * @returns Returns `true` if `from` is a `string`, or {@link Failure} with an error\n   * message if not.\n   */\n  public static validateString<T extends string>(from: unknown): boolean | Failure<T> {\n    if (typeof from === 'string') {\n      return true;\n    }\n    return fail<T>(`\"${from}\": not a string`);\n  }\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"typeGuard.js","sourceRoot":"","sources":["../../../src/packlets/validation/typeGuard.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,mDAAgF;AAgBhF;;;;GAIG;AACH,MAAa,kBAAoC,SAAQ,6BAAoB;IAU3E;;;;OAIG;IACH,YAAmB,MAAkD;;QACnE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE;YAC9B,OAAO,IAAI,CAAC;SACb;QACD,OAAO,IAAA,WAAI,EAAC,WAAW,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvE,CAAC;CACF;AArCD,gDAqCC","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 { Failure, fail } from '../base';\nimport { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';\n\nimport { TypeGuardWithContext } from './common';\nimport { ValidatorOptions } from './validator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.TypeGuardValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface TypeGuardValidatorConstructorParams<T, TC = unknown>\n  extends ValidatorBaseConstructorParams<T, TC> {\n  guard: TypeGuardWithContext<T, TC>;\n  description: string;\n}\n\n/**\n * An in-place {@link Validation.Validator | Validator} that can be instantiated using a type guard\n * function.\n * @public\n */\nexport class TypeGuardValidator<T, TC = unknown> extends ValidatorBase<T, TC> {\n  /**\n   * {@link Validation.ValidatorOptions | Options} which apply to this\n   * validator.\n   */\n  public readonly options: ValidatorOptions<TC>;\n  public readonly description: string;\n\n  protected readonly _guard: TypeGuardWithContext<T, TC>;\n\n  /**\n   * Constructs a new {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator}.\n   * @param params - Optional {@link Validation.Classes.TypeGuardValidatorConstructorParams | init params} for the\n   * new {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator}.\n   */\n  public constructor(params: TypeGuardValidatorConstructorParams<T, TC>) {\n    super(params);\n    this.description = params.description;\n    this._guard = params.guard;\n    this.options = params.options ?? {};\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value matches the supplied\n   * type guard, returning a `Failure<T>` containing more information about a failure.\n   * @param from - Value to be converted.\n   * @param context - Optional validation context.\n   * @returns `true` if `from` is valid, {@link Failure | Failure<T>}\n   * with an error message if `from` is invalid.\n   * @internal\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (this._guard(from, context)) {\n      return true;\n    }\n    return fail(`invalid ${this.description} (${JSON.stringify(from)})`);\n  }\n}\n"]}
+{"version":3,"file":"typeGuard.js","sourceRoot":"","sources":["../../../src/packlets/validation/typeGuard.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,mDAAgF;AAgBhF;;;;GAIG;AACH,MAAa,kBAAoC,SAAQ,6BAAoB;IAU3E;;;;OAIG;IACH,YAAmB,MAAkD;;QACnE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAA,WAAI,EAAC,WAAW,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvE,CAAC;CACF;AArCD,gDAqCC","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 { Failure, fail } from '../base';\nimport { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';\n\nimport { TypeGuardWithContext } from './common';\nimport { ValidatorOptions } from './validator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.TypeGuardValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface TypeGuardValidatorConstructorParams<T, TC = unknown>\n  extends ValidatorBaseConstructorParams<T, TC> {\n  guard: TypeGuardWithContext<T, TC>;\n  description: string;\n}\n\n/**\n * An in-place {@link Validation.Validator | Validator} that can be instantiated using a type guard\n * function.\n * @public\n */\nexport class TypeGuardValidator<T, TC = unknown> extends ValidatorBase<T, TC> {\n  /**\n   * {@link Validation.ValidatorOptions | Options} which apply to this\n   * validator.\n   */\n  public readonly options: ValidatorOptions<TC>;\n  public readonly description: string;\n\n  protected readonly _guard: TypeGuardWithContext<T, TC>;\n\n  /**\n   * Constructs a new {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator}.\n   * @param params - Optional {@link Validation.Classes.TypeGuardValidatorConstructorParams | init params} for the\n   * new {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator}.\n   */\n  public constructor(params: TypeGuardValidatorConstructorParams<T, TC>) {\n    super(params);\n    this.description = params.description;\n    this._guard = params.guard;\n    this.options = params.options ?? {};\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value matches the supplied\n   * type guard, returning a `Failure<T>` containing more information about a failure.\n   * @param from - Value to be converted.\n   * @param context - Optional validation context.\n   * @returns `true` if `from` is valid, {@link Failure | Failure<T>}\n   * with an error message if `from` is invalid.\n   * @internal\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (this._guard(from, context)) {\n      return true;\n    }\n    return fail(`invalid ${this.description} (${JSON.stringify(from)})`);\n  }\n}\n"]}

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;;;AAEH,kCAAwC;AACxC,mCAA0E;AAC1E,qCAA8F;AAC9F,2CAAsF;AAEtF,uCAA6C;AAE7C,yDAAsD;AACtD,qCAA2C;AAC3C,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;AALD,wBAKC;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;AALD,0BAKC;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;gBAC5B,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;aACtG;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;AAXD,0CAWC;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;AAVD,0BAUC;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;AAND,kBAMC","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 } from './common';\nimport { GenericValidator } from './genericValidator';\nimport { NumberValidator } from './number';\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.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>(\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"]}
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../../src/packlets/validation/validators.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,mCAA0E;AAC1E,qCAA8F;AAC9F,2CAAsF;AAEtF,uCAA6C;AAE7C,yDAAsD;AACtD,qCAA2C;AAC3C,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;AALD,wBAKC;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;AALD,0BAKC;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;AAXD,0CAWC;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;AAVD,0BAUC;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;AAND,kBAMC","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 } from './common';\nimport { GenericValidator } from './genericValidator';\nimport { NumberValidator } from './number';\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.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>(\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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-utils",
-  "version": "2.1.0",
+  "version": "2.1.1-alpha.0",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "types": "dist/ts-utils.d.ts",
@@ -16,6 +16,7 @@
     "lint": "eslint src --ext .ts",
     "fixlint": "eslint src --ext .ts --fix"
   },
+  "sideEffects": false,
   "keywords": [
     "typescript",
     "json"
@@ -28,18 +29,17 @@
   "homepage": "https://github.com/ErikFortune/fgv#readme",
   "devDependencies": {
     "@jest/expect-utils": "^29.7.0",
-    "@microsoft/api-documenter": "^7.23.10",
-    "@microsoft/api-extractor": "^7.38.1",
-    "@types/jest": "^29.5.7",
-    "@types/luxon": "^3.3.3",
-    "@types/mustache": "^4.2.4",
-    "@types/node": "^20.8.9",
-    "@types/papaparse": "^5.3.10",
-    "@typescript-eslint/eslint-plugin": "^6.9.1",
-    "@typescript-eslint/parser": "^6.9.1",
-    "eslint": "^8.52.0",
+    "@microsoft/api-documenter": "^7.23.17",
+    "@microsoft/api-extractor": "^7.39.1",
+    "@types/jest": "^29.5.11",
+    "@types/luxon": "^3.4.1",
+    "@types/mustache": "^4.2.5",
+    "@types/node": "^20.11.5",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
+    "eslint": "^8.56.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.7.0",
@@ -47,20 +47,19 @@
     "jest-matcher-utils": "^29.7.0",
     "rimraf": "^5.0.5",
     "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.2.2",
-    "eslint-plugin-n": "^16.2.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3",
+    "eslint-plugin-n": "^16.6.2",
     "jest-snapshot": "~29.7.0",
-    "@rushstack/heft": "~0.63.0",
-    "@rushstack/heft-node-rig": "~2.3.8",
-    "@rushstack/eslint-config": "~3.4.1",
-    "@types/heft-jest": "1.0.5",
-    "@rushstack/heft-jest-plugin": "~0.10.2",
+    "@rushstack/heft": "~0.64.0",
+    "@rushstack/heft-node-rig": "~2.4.0",
+    "@rushstack/eslint-config": "~3.6.0",
+    "@types/heft-jest": "1.0.6",
+    "@rushstack/heft-jest-plugin": "~0.11.0",
     "eslint-plugin-tsdoc": "~0.2.17"
   },
   "dependencies": {
-    "luxon": "^3.4.3",
-    "mustache": "^4.2.0",
-    "papaparse": "^5.4.1"
+    "luxon": "^3.4.4",
+    "mustache": "^4.2.0"
   }
 }

package/lib/packlets/csv/csvHelpers.d.ts

@@ -1,17 +0,0 @@
-import { Result } from '../base';
-/**
- * Options for {@link Csv.readCsvFileSync}
- * @beta
- */
-export interface CsvOptions {
-    delimiter?: string;
-}
-/**
- * Reads a CSV file from a supplied path.
- * @param srcPath - Source path from which the file is read.
- * @param options - optional parameters to control the processing
- * @returns The contents of the file.
- * @beta
- */
-export declare function readCsvFileSync(srcPath: string, options?: CsvOptions): Result<unknown>;
-//# sourceMappingURL=csvHelpers.d.ts.map

package/lib/packlets/csv/csvHelpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"csvHelpers.d.ts","sourceRoot":"","sources":["../../../src/packlets/csv/csvHelpers.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,MAAM,EAAiB,MAAM,SAAS,CAAC;AAEhD;;;GAGG;AAEH,MAAM,WAAW,UAAU;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CActF"}

package/lib/packlets/csv/csvHelpers.js

@@ -1,69 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2020 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readCsvFileSync = void 0;
-const fs = __importStar(require("fs"));
-const papaparse_1 = require("papaparse");
-const path = __importStar(require("path"));
-const base_1 = require("../base");
-/**
- * Reads a CSV file from a supplied path.
- * @param srcPath - Source path from which the file is read.
- * @param options - optional parameters to control the processing
- * @returns The contents of the file.
- * @beta
- */
-function readCsvFileSync(srcPath, options) {
-    return (0, base_1.captureResult)(() => {
-        const fullPath = path.resolve(srcPath);
-        const body = fs.readFileSync(fullPath, 'utf8').toString();
-        options = options !== null && options !== void 0 ? options : {};
-        // eslint-disable-next-line
-        return (0, papaparse_1.parse)(body, Object.assign({ transform: (s) => s.trim(), header: false, dynamicTyping: false, skipEmptyLines: 'greedy' }, options)).data.slice(1);
-    });
-}
-exports.readCsvFileSync = readCsvFileSync;
-//# sourceMappingURL=csvHelpers.js.map

package/lib/packlets/csv/csvHelpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"csvHelpers.js","sourceRoot":"","sources":["../../../src/packlets/csv/csvHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,yCAAkC;AAClC,2CAA6B;AAC7B,kCAAgD;AAWhD;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,OAAe,EAAE,OAAoB;IACnE,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC1D,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACxB,2BAA2B;QAC3B,OAAO,IAAA,iBAAK,EAAC,IAAI,kBACf,SAAS,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAClC,MAAM,EAAE,KAAK,EACb,aAAa,EAAE,KAAK,EACpB,cAAc,EAAE,QAAQ,IACrB,OAAO,EACV,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC,CAAC,CAAC;AACL,CAAC;AAdD,0CAcC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as fs from 'fs';\nimport { parse } from 'papaparse';\nimport * as path from 'path';\nimport { Result, captureResult } from '../base';\n\n/**\n * Options for {@link Csv.readCsvFileSync}\n * @beta\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface CsvOptions {\n  delimiter?: string;\n}\n\n/**\n * Reads a CSV file from a supplied path.\n * @param srcPath - Source path from which the file is read.\n * @param options - optional parameters to control the processing\n * @returns The contents of the file.\n * @beta\n */\nexport function readCsvFileSync(srcPath: string, options?: CsvOptions): Result<unknown> {\n  return captureResult(() => {\n    const fullPath = path.resolve(srcPath);\n    const body = fs.readFileSync(fullPath, 'utf8').toString();\n    options = options ?? {};\n    // eslint-disable-next-line\n    return parse(body, {\n      transform: (s: string) => s.trim(),\n      header: false,\n      dynamicTyping: false,\n      skipEmptyLines: 'greedy',\n      ...options\n    }).data.slice(1);\n  });\n}\n"]}

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

@@ -1,2 +0,0 @@
-export * from './csvHelpers';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/csv/index.ts"],"names":[],"mappings":"AAsBA,cAAc,cAAc,CAAC"}