@fgv/ts-utils 5.1.0-3 → 5.1.0-31

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

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/validator.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,EAAE,IAAI,CACjC,IAAI,EAAE,OAAO,EACb,OAAO,CAAC,EAAE,EAAE,EACZ,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,KACpB,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE1B;;;GAGG;AAEH,MAAM,WAAW,gBAAgB,CAAC,EAAE;IAClC,cAAc,CAAC,EAAE,EAAE,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,MAAM,wBAAwB,CAAC,EAAE,GAAG,OAAO,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,MAAM,CAAC;AAE9G;;;;GAIG;AAEH,MAAM,WAAW,SAAS,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO;IACxC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAEjD;;;;;;;;OAQG;IACH,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAEhD;;;;;;;OAOG;IACH,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAErE;;;;OAIG;IACH,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC;IAE9C;;;OAGG;IACH,QAAQ,IAAI,SAAS,CAAC,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAErF;;;;OAIG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAElE;;;;;;OAMG;IACH,kBAAkB,CAAC,SAAS,EAAE,wBAAwB,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CAC/C"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../../src/packlets/validation/validator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG","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 } from '../base';\nimport { ConstraintTrait, ValidatorTraits } from './traits';\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> = (\n  from: unknown,\n  context?: TC,\n  self?: Validator<T, TC>\n) => boolean | Failure<T>;\n\n/**\n * Options that apply to any {@link Validation.Validator | Validator}.\n * @public\n */\n\nexport interface ValidatorOptions<TC> {\n  defaultContext?: TC;\n}\n\n/**\n * A {@link Validation.Constraint | Constraint<T>} function returns\n * `true` if the supplied value meets the constraint. Can return\n * {@link Failure} with an error message or simply return `false`\n * for a default message.\n * @public\n */\nexport type Constraint<T> = (val: T) => boolean | Failure<T>;\n\n/**\n * Formats an incoming error message and value that failed validation.\n * @param val - The value that failed validation.\n * @param message - The default error message, if any.\n * @param context - Optional validation context.\n * @returns The formatted error message.\n * @public\n */\nexport type ValidationErrorFormatter<TC = unknown> = (val: unknown, message?: string, context?: TC) => string;\n\n/**\n * In-place validation that a supplied unknown matches some\n * required characteristics (type, values, etc).\n * @public\n */\n\nexport interface Validator<T, TC = unknown> {\n  /**\n   * {@link Validation.ValidatorTraits | Traits} describing this validation.\n   */\n  readonly traits: ValidatorTraits;\n\n  /**\n   * Indicates whether this element is explicitly optional.\n   */\n  readonly isOptional: boolean;\n\n  /**\n   * The brand for a branded type.\n   */\n  readonly brand: string | undefined;\n\n  /**\n   * Tests to see if a supplied `unknown` value matches this validation.  All\n   * validate calls are guaranteed to return the entity passed in on Success.\n   * @param from - The `unknown` value to be tested.\n   * @param context - Optional validation context.\n   * @returns {@link Success} with the typed, validated value,\n   * or {@link Failure} with an error message if validation fails.\n   */\n  validate(from: unknown, context?: TC): Result<T>;\n\n  /**\n   * Tests to see if a supplied 'unknown' value matches this validation.  In\n   * contrast to {@link Validator.validate | validate}, makes no guarantees\n   * about the identity of the returned value.\n   * @param from - The `unknown` value to be tested.\n   * @param context - Optional validation context.\n   * @returns {@link Success} with the typed, conversion value,\n   * or {@link Failure} with an error message if conversion fails.\n   */\n  convert(from: unknown, context?: TC): Result<T>;\n\n  /**\n   * Tests to see if a supplied `unknown` value matches this\n   * validation.  Accepts `undefined`.\n   * @param from - The `unknown` value to be tested.\n   * @param context - Optional validation context.\n   * @returns {@link Success} with the typed, validated value,\n   * or {@link Failure} with an error message if validation fails.\n   */\n  validateOptional(from: unknown, context?: TC): Result<T | undefined>;\n\n  /**\n   * Non-throwing type guard\n   * @param from - The value to be tested.\n   * @param context - Optional validation context.\n   */\n  guard(from: unknown, context?: TC): from is T;\n\n  /**\n   * Creates an {@link Validation.Validator | in-place validator}\n   * which is derived from this one but which also matches `undefined`.\n   */\n  optional(): Validator<T | undefined, TC>;\n\n  /**\n   * Creates an {@link Validation.Validator | in-place validator}\n   * which is derived from this one but which applies additional constraints.\n   * @param constraint - the constraint to be applied\n   * @param trait - As optional {@link Validation.ConstraintTrait | ConstraintTrait}\n   * to be applied to the resulting {@link Validation.Validator | Validator}.\n   * @returns A new {@link Validation.Validator | Validator}.\n   */\n  withConstraint(constraint: Constraint<T>, trait?: ConstraintTrait): Validator<T, TC>;\n\n  /**\n   * Creates a new {@link Validation.Validator | in-place validator} which\n   * is derived from this one but which matches a branded result.\n   * @param brand - The brand to be applied.\n   */\n  withBrand<B extends string>(brand: B): Validator<Brand<T, B>, TC>;\n\n  /**\n   * Creates a new {@link Validation.Validator | in-place validator} which\n   * is derived from this one but which returns an error message supplied\n   * by the provided formatter if an error occurs.\n   * @param formatter - The error message formatter to be applied.\n   * @returns A new {@link Validation.Validator | Validator}.\n   */\n  withFormattedError(formatter: ValidationErrorFormatter<TC>): Validator<T, TC>;\n\n  /**\n   * Chains this validator with another of the same type, to be attempted if this\n   * validator fails.\n   * @param other - The other {@link Validation.Validator | Validator} to be attempted\n   * if this one fails.\n   */\n  or(other: Validator<T, TC>): Validator<T, TC>;\n}\n"]}

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

@@ -1,4 +1,5 @@
 import { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';
+import { Validator } from './validator';
 import { Failure } from '../base';
 /**
  * @internal
@@ -24,6 +25,6 @@ export declare abstract class ValidatorBase<T, TC = unknown> extends GenericVali
      * with an error message if `from` is invalid.
      * @internal
      */
-    protected abstract _validate(from: unknown, context?: TC, self?: import('./validator').Validator<T, TC>): boolean | Failure<T>;
+    protected abstract _validate(from: unknown, context?: TC, self?: Validator<T, TC>): boolean | Failure<T>;
 }
 //# sourceMappingURL=validatorBase.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validatorBase.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/validatorBase.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,gBAAgB,EAAE,iCAAiC,EAAE,MAAM,oBAAoB,CAAC;AACzF,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,8BAA8B,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,CACtD,iCAAiC,CAAC,CAAC,EAAE,EAAE,CAAC,EACxC,WAAW,CACZ,CAAC;AAEF;;;GAGG;AACH,8BAAsB,aAAa,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC;IAClF;;;;OAIG;IACH,SAAS,aAAa,MAAM,EAAE,OAAO,CAAC,8BAA8B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAO5E;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;CACzG"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"validatorBase.js","sourceRoot":"","sources":["../../../src/packlets/validation/validatorBase.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,yDAAyF;AAazF;;;GAGG;AACH,MAAsB,aAA+B,SAAQ,mCAAuB;IAClF;;;;OAIG;IACH,YAAsB,MAAsD;QAC1E,KAAK,iBACH,SAAS,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,IACpE,MAAM,EACT,CAAC;IACL,CAAC;CAYF;AAvBD,sCAuBC","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 { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\nimport { Validator } from './validator';\n\nimport { Failure } from '../base';\n\n/**\n * @internal\n */\nexport type ValidatorBaseConstructorParams<T, TC> = Omit<\n  GenericValidatorConstructorParams<T, TC>,\n  'validator'\n>;\n\n/**\n * Abstract base helper class for specific validator implementations\n * @internal\n */\nexport abstract class ValidatorBase<T, TC = unknown> extends GenericValidator<T, TC> {\n  /**\n   * Inner constructor\n   * @param params - Initialization params.\n   * @internal\n   */\n  protected constructor(params: Partial<ValidatorBaseConstructorParams<T, TC>>) {\n    super({\n      validator: (from, context, self) => this._validate(from, context, self),\n      ...params\n    });\n  }\n\n  /**\n   * Abstract validation method to me implemented by derived classes.\n   * @param from - Value to be converted.\n   * @param context - Optional validation context.\n   * @param self - Optional self-reference for recursive validation.\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 abstract _validate(from: unknown, context?: TC, self?: Validator<T, TC>): boolean | Failure<T>;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../../src/packlets/validation/validators.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AA6CH,wBAKC;AAUD,0BAKC;AAgCD,4BAoDC;AAOD,0CAeC;AAOD,0BAUC;AAUD,kCASC;AAWD,sBAKC;AAWD,kBAMC;AAWD,0BAEC;AA3PD,kCAAoE;AACpE,mCAA0E;AAC1E,+CAA4F;AAC5F,qCAA8F;AAC9F,2CAAsF;AAEtF,uCAA6C;AAE7C,yDAAsD;AACtD,qCAA2C;AAC3C,mCAA0E;AAC1E,qCAA2C;AAG3C;;;GAGG;AACU,QAAA,MAAM,GAAsB,IAAI,wBAAe,EAAE,CAAC;AAE/D;;;GAGG;AACU,QAAA,MAAM,GAAsB,IAAI,wBAAe,EAAE,CAAC;AAE/D;;;GAGG;AACU,QAAA,OAAO,GAAuB,IAAI,0BAAgB,EAAE,CAAC;AAElE;;;;;;;;;;GAUG;AACH,SAAgB,MAAM,CACpB,MAA8B,EAC9B,MAAgE;IAEhE,OAAO,IAAI,wBAAe,iBAAG,MAAM,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC5D,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,OAAO,CACrB,eAAiC,EACjC,MAAwE;IAExE,OAAO,IAAI,sBAAc,iBAAG,eAAe,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AACpE,CAAC;AAoBD;;;;;;;;;;;GAWG;AACH,SAAgB,QAAQ,CACtB,SAA2B,EAC3B,OAA2C;IAE3C,MAAM,IAAI,mBAAwC,OAAO,EAAE,MAAM,IAAK,OAAO,CAAE,CAAC;IAEhF,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CACT,IAAa,EACb,OAAY,EACZ,IAAmC,EACD,EAAE;YACpC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrE,OAAO,IAAA,WAAI,EAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACpE,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,wBAAiB,EAAE,CAAC;YAEvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,IAAI,IAAA,cAAO,EAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;oBACvB,2CAA2C;oBAC3C,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;wBACtB,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;wBAC3D,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC;4BAC3B,IAAI,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gCAC9B,SAAS;4BACX,CAAC;4BACD,MAAM,CAAC,UAAU,CAAC,QAAQ,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;4BACxD,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC;gCAC5B,OAAO,IAAA,WAAI,EAAC,SAAS,CAAC,OAAO,CAAC,CAAC;4BACjC,CAAC;wBACH,CAAC;oBACH,CAAC;oBAED,iBAAiB;oBACjB,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAY,EAAE,OAAO,CAAC,CAAC;oBACtE,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;wBAC7B,IAAI,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;4BAC9B,SAAS;wBACX,CAAC;wBACD,MAAM,CAAC,UAAU,CAAC,aAAa,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC;wBAC/D,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC;4BAC5B,OAAO,IAAA,WAAI,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC;wBACnC,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAED,yCAAyC;YACzC,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7D,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAmB,MAAwB;IACxE,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CACT,IAAa,EACb,OAA0B,EAC1B,IAAqC,EACf,EAAE;YACxB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,CAAC,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,MAAM,CAAC;gBAC5B,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC;gBACnC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,6BAA6B,IAAI,mBAAmB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACvG,CAAC;YACD,OAAO,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACtE,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CACrB,KAAQ;IAER,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAiB,EAAE,IAAmB,EAAwB,EAAE;YACzF,OAAO,IAAI,KAAK,KAAK;gBACnB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,IAAA,WAAI,EAAC,oBAAoB,MAAM,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9F,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,WAAW,CAMzB,MAA4E;IAE5E,OAAO,IAAI,kCAAoB,CAAgC,MAAM,CAAC,CAAC;AACzE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,KAAK,CACnB,UAAmC,EACnC,MAAmE;IAEnE,OAAO,IAAI,sBAAc,iCAAa,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,KAAE,UAAU,IAAG,CAAC;AACtE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,GAAG,CACjB,WAAmB,EACnB,KAAkC,EAClC,MAAkF;IAElF,OAAO,IAAI,8BAAkB,iBAAG,WAAW,EAAE,KAAK,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC3E,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,OAAO,CAAkB,SAA+B;IACtE,OAAO,IAAI,mCAAgB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;AAC7C,CAAC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail, isKeyOf, MessageAggregator } from '../base';\nimport { ArrayValidator, ArrayValidatorConstructorParams } from './array';\nimport { CompositeIdValidator, CompositeIdValidatorConstructorParams } from './compositeId';\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 { OneOfValidator, OneOfValidatorConstructorParams } from './oneOf';\nimport { StringValidator } from './string';\nimport { Validator, ValidatorFunc } from './validator';\n\n/**\n * A {@link Validation.Classes.StringValidator | StringValidator} which validates a string in place.\n * @public\n */\nexport const string: Validator<string> = new StringValidator();\n\n/**\n * A {@link Validation.Classes.NumberValidator | NumberValidator} which validates a number in place.\n * @public\n */\nexport const number: Validator<number> = new NumberValidator();\n\n/**\n * A {@link Validation.Classes.BooleanValidator | BooleanValidator} which validates a boolean in place.\n * @public\n */\nexport const boolean: Validator<boolean> = new BooleanValidator();\n\n/**\n * Helper function to create a {@link Validation.Classes.ObjectValidator | ObjectValidator} which validates\n * an object in place.\n * @param fields - A {@link Validation.Classes.FieldValidators | field validator definition}\n * describing the validations to be applied.\n * @param params - Optional {@link Validation.Classes.ObjectValidatorConstructorParams | parameters}\n * to refine the behavior of the resulting {@link Validation.Validator | validator}.\n * @returns A new {@link Validation.Validator | Validator} which validates the desired\n * object in place.\n * @public\n */\nexport function object<T, TC = unknown>(\n  fields: FieldValidators<T, TC>,\n  params?: Omit<ObjectValidatorConstructorParams<T, TC>, 'fields'>\n): ObjectValidator<T, TC> {\n  return new ObjectValidator({ fields, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Classes.ArrayValidator | ArrayValidator} which\n * validates an array in place.\n * @param validateElement - A {@link Validation.Validator | validator} which validates each element.\n * @returns A new {@link Validation.Classes.ArrayValidator | ArrayValidator } which validates the desired\n * array in place.\n * @public\n */\nexport function arrayOf<T, TC>(\n  validateElement: Validator<T, TC>,\n  params?: Omit<ArrayValidatorConstructorParams<T, TC>, 'validateElement'>\n): ArrayValidator<T, TC> {\n  return new ArrayValidator({ validateElement, ...(params ?? {}) });\n}\n\n/**\n * Options for {@link Validators.recordOf} helper function.\n * @public\n */\nexport interface IRecordOfValidatorOptions<TK extends string = string, TC = unknown> {\n  /**\n   * If `onError` is `'fail'` (default), then the entire validation fails if any key or element\n   * cannot be validated. If `onError` is `'ignore'`, failing elements are silently ignored.\n   */\n  onError?: 'fail' | 'ignore';\n  /**\n   * If present, `keyValidator` is used to validate the source object property names.\n   * @remarks\n   * Can be used to validate key names to supported values and/or strong types.\n   */\n  keyValidator?: Validator<TK, TC>;\n}\n\n/**\n * A helper function to create a {@link Validation.Validator | Validator} which validates the `string`-keyed properties\n * using a supplied {@link Validation.Validator | Validator<T, TC>} to produce a `Record<TK, T>`.\n * @remarks\n * If present, the supplied {@link Validators.IRecordOfValidatorOptions | options} can provide a strongly-typed\n * validator for keys and/or control the handling of elements that fail validation.\n * @param validator - {@link Validation.Validator | Validator} used for each item in the source object.\n * @param options - Optional {@link Validators.IRecordOfValidatorOptions | IRecordOfValidatorOptions<TK, TC>} which\n * supplies a key validator and/or error-handling options.\n * @returns A {@link Validation.Validator | Validator} which validates `Record<TK, T>`.\n * @public\n */\nexport function recordOf<T, TC = unknown, TK extends string = string>(\n  validator: Validator<T, TC>,\n  options?: IRecordOfValidatorOptions<TK, TC>\n): Validator<Record<TK, T>, TC> {\n  const opts: IRecordOfValidatorOptions<TK, TC> = { onError: 'fail', ...options };\n\n  return new GenericValidator({\n    validator: (\n      from: unknown,\n      context?: TC,\n      self?: Validator<Record<TK, T>, TC>\n    ): boolean | Failure<Record<TK, T>> => {\n      if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n        return fail(`Not a string-keyed object: ${JSON.stringify(from)}`);\n      }\n\n      const errors = new MessageAggregator();\n\n      for (const key in from) {\n        if (isKeyOf(key, from)) {\n          // Validate key if keyValidator is provided\n          if (opts.keyValidator) {\n            const keyResult = opts.keyValidator.validate(key, context);\n            if (!keyResult.isSuccess()) {\n              if (opts.onError === 'ignore') {\n                continue;\n              }\n              errors.addMessage(`Key \"${key}\": ${keyResult.message}`);\n              if (opts.onError === 'fail') {\n                return fail(keyResult.message);\n              }\n            }\n          }\n\n          // Validate value\n          const valueResult = validator.validate(from[key] as unknown, context);\n          if (!valueResult.isSuccess()) {\n            if (opts.onError === 'ignore') {\n              continue;\n            }\n            errors.addMessage(`Property \"${key}\": ${valueResult.message}`);\n            if (opts.onError === 'fail') {\n              return fail(valueResult.message);\n            }\n          }\n        }\n      }\n\n      /* c8 ignore next 1 - defense in depth */\n      return errors.hasMessages ? fail(errors.toString()) : true;\n    }\n  });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator} which validates an enumerated\n * value in place.\n * @public\n */\nexport function enumeratedValue<T extends string>(values: ReadonlyArray<T>): Validator<T, ReadonlyArray<T>> {\n  return new GenericValidator({\n    validator: (\n      from: unknown,\n      context?: ReadonlyArray<T>,\n      self?: Validator<T, ReadonlyArray<T>>\n    ): 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, context?: unknown, self?: Validator<T>): 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/** Helper function to create a {@link Validation.Validator | Validator} which validates a\n * strongly-typed composite ID.\n * @param params - {@link Validation.Classes.CompositeIdValidatorConstructorParams | params}\n * used to construct the validator.\n * @returns A new {@link Validation.Validator | Validator} which validates the desired\n * composite ID in place.\n * @public\n */\nexport function compositeId<\n  T extends string = string,\n  TCOLLECTIONID extends string = string,\n  TITEMID extends string = string,\n  TC = unknown\n>(\n  params: CompositeIdValidatorConstructorParams<T, TCOLLECTIONID, TITEMID, TC>\n): CompositeIdValidator<T, TCOLLECTIONID, TITEMID, TC> {\n  return new CompositeIdValidator<T, TCOLLECTIONID, TITEMID, TC>(params);\n}\n\n/**\n * Helper function to create a {@link Validation.Validator | Validator} which validates one\n * of several possible validated values.\n * @param validators - the {@link Validation.Validator | validators} to be considered.\n * @param params - Optional {@link Validation.Classes.OneOfValidatorConstructorParams | params} used to construct the validator.\n * @returns A new {@link Validator | Validator} which validates values that match any of\n * the supplied validators.\n * @public\n */\nexport function oneOf<T, TC = unknown>(\n  validators: Array<Validator<T, TC>>,\n  params?: Omit<OneOfValidatorConstructorParams<T, TC>, 'validators'>\n): OneOfValidator<T, TC> {\n  return new OneOfValidator<T, TC>({ ...(params ?? {}), validators });\n}\n\n/**\n * Helper function to create a {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator} which\n * validates a value or object in place.\n * @param description - a description of the thing to be validated for use in error messages\n * @param guard - a {@link Validation.TypeGuardWithContext} which performs the validation.\n * @returns A new {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator } which validates\n * the values using the supplied type guard.\n * @public\n */\nexport function isA<T, TC = unknown>(\n  description: string,\n  guard: TypeGuardWithContext<T, TC>,\n  params?: Omit<TypeGuardValidatorConstructorParams<T, TC>, 'description' | 'guard'>\n): TypeGuardValidator<T, TC> {\n  return new TypeGuardValidator({ description, guard, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator | Validator} using a\n * supplied {@link Validation.ValidatorFunc | validator function}.\n * @param validator - A {@link Validation.ValidatorFunc | validator function} that a\n * supplied unknown value matches some condition.\n * @returns A new {@link Validation.Validator | Validator} which validates the desired\n * value using the supplied function.\n * @public\n */\nexport function generic<T, TC = unknown>(validator: ValidatorFunc<T, TC>): Validator<T, TC> {\n  return new GenericValidator({ validator });\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-utils",
-  "version": "5.1.0-3",
+  "version": "5.1.0-31",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "module": "dist/index.js",
@@ -47,13 +47,15 @@
     "typescript": "5.9.3",
     "eslint-plugin-n": "^17.23.1",
     "jest-snapshot": "~29.7.0",
-    "@rushstack/heft": "1.2.6",
-    "@rushstack/heft-node-rig": "2.11.26",
+    "@rushstack/heft": "1.2.7",
+    "@rushstack/heft-node-rig": "2.11.27",
     "@rushstack/eslint-config": "4.6.4",
     "@types/heft-jest": "1.0.6",
     "@rushstack/heft-jest-plugin": "1.2.6",
     "eslint-plugin-tsdoc": "~0.5.2",
-    "@fgv/heft-dual-rig": "5.1.0-3"
+    "typedoc": "~0.28.16",
+    "@fgv/heft-dual-rig": "5.1.0-31",
+    "@fgv/typedoc-compact-theme": "5.1.0-31"
   },
   "repository": {
     "type": "git",

package/dist/test/helpers/jest/helpers/fsHelpers.js

@@ -1,139 +0,0 @@
-/*
- * 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.
- */
-import fs from 'fs';
-import * as path from 'path';
-/**
- * @public
- */
-export class ReadWriteSpies {
-    constructor(read, write) {
-        this.read = read;
-        this.write = write;
-    }
-    clear() {
-        this.read.mockClear();
-        this.write.mockClear();
-    }
-    restore() {
-        this.read.mockRestore();
-        this.write.mockRestore();
-    }
-}
-/**
- * @public
- */
-export class MockFileSystem {
-    constructor(configs, options) {
-        this._extraWrites = [];
-        this._config = new Map();
-        this._data = new Map();
-        this._options = options;
-        this._realReadFileSync = fs.readFileSync;
-        for (const config of configs) {
-            const fullPath = path.resolve(config.path);
-            this._config.set(fullPath, config);
-            if (config.backingFile) {
-                this.readMockFileSync(fullPath);
-            }
-            else if (config.payload) {
-                this._data.set(fullPath, config.payload);
-            }
-        }
-    }
-    readMockFileSync(wanted) {
-        var _a;
-        const fullPathWanted = path.resolve(wanted);
-        if (!this._data.has(fullPathWanted)) {
-            const config = this._config.get(fullPathWanted);
-            if ((config === null || config === void 0 ? void 0 : config.backingFile) === undefined) {
-                if (((_a = this._options) === null || _a === void 0 ? void 0 : _a.mockWriteOnly) !== true) {
-                    throw new Error(`Mock file not found: ${wanted}`);
-                }
-                const body = this._realReadFileSync(fullPathWanted).toString();
-                this._data.set(fullPathWanted, body);
-            }
-            else {
-                const fullBackingPath = path.resolve(config.backingFile);
-                const body = this._realReadFileSync(fullBackingPath).toString();
-                this._data.set(fullPathWanted, body);
-            }
-        }
-        const payload = this._data.get(fullPathWanted);
-        // not actually reproducible right now
-        /* c8 ignore next 3 */
-        if (payload === undefined) {
-            throw new Error(`Mock file ${wanted} payload is undefined.`);
-        }
-        return payload;
-    }
-    writeMockFileSync(wanted, body) {
-        var _a;
-        const fullPathWanted = path.resolve(wanted);
-        const config = this._config.get(fullPathWanted);
-        if (config === undefined) {
-            if (((_a = this._options) === null || _a === void 0 ? void 0 : _a.allowUnknownMockWrite) !== true) {
-                throw new Error(`Mock path not found: ${wanted}`);
-            }
-            this._extraWrites.push(fullPathWanted);
-        }
-        else if (config.writable !== true) {
-            throw new Error(`Mock permission denied: ${wanted}`);
-        }
-        this._data.set(fullPathWanted, body);
-    }
-    getExtraFilesWritten() {
-        return Array.from(this._extraWrites);
-    }
-    tryGetPayload(want) {
-        return this._data.get(path.resolve(want));
-    }
-    reset() {
-        const writable = Array.from(this._config.values()).filter((c) => c.writable === true);
-        for (const config of writable) {
-            this._data.delete(path.resolve(config.path));
-            if (config.backingFile) {
-                this.readMockFileSync(path.resolve(config.path));
-            }
-            else if (config.payload) {
-                this._data.set(path.resolve(config.path), config.payload);
-            }
-        }
-        for (const path of this._extraWrites) {
-            this._data.delete(path);
-        }
-        this._extraWrites.splice(0, this._extraWrites.length);
-    }
-    startSpies() {
-        return new ReadWriteSpies(jest.spyOn(fs, 'readFileSync').mockImplementation((wanted) => {
-            if (typeof wanted !== 'string') {
-                throw new Error('readFileSync mock supports only string parameters');
-            }
-            return this.readMockFileSync(wanted);
-        }), jest.spyOn(fs, 'writeFileSync').mockImplementation((wanted, payload) => {
-            if (typeof wanted !== 'string' || typeof payload !== 'string') {
-                throw new Error('writeFileSync mock supports only string parameters');
-            }
-            return this.writeMockFileSync(wanted, payload);
-        }));
-    }
-}
-//# sourceMappingURL=fsHelpers.js.map

package/dist/test/helpers/jest/helpers/index.js

@@ -1,2 +0,0 @@
-export * from './fsHelpers';
-//# sourceMappingURL=index.js.map

package/dist/test/helpers/jest/index.js

@@ -1,17 +0,0 @@
-import matchers from './matchers';
-import './types';
-export { MockFileSystem } from './helpers';
-function isJestGlobal(g) {
-    return g.hasOwnProperty('expect');
-}
-/* c8 ignore else */
-if (isJestGlobal(global)) {
-    global.expect.extend(matchers);
-}
-else {
-    console.error([
-        "Unable to find Jest's global expect",
-        'Please check that you have added ts-utils-jest correctly to your jest configuration.'
-    ].join('\n'));
-}
-//# sourceMappingURL=index.js.map

package/dist/test/helpers/jest/matchers/index.js

@@ -1,14 +0,0 @@
-import ToFail from './toFail';
-import ToFailTest from './toFailTest';
-import ToFailTestAndMatchSnapshot from './toFailTestAndMatchSnapshot';
-import ToFailTestWith from './toFailTestWith';
-import ToFailWith from './toFailWith';
-import ToFailWithDetail from './toFailWithDetail';
-import ToSucceed from './toSucceed';
-import ToSucceedAndMatchInlineSnapshot from './toSucceedAndMatchInlineSnapshot';
-import ToSucceedAndMatchSnapshot from './toSucceedAndMatchSnapshot';
-import ToSucceedAndSatisfy from './toSucceedAndSatisfy';
-import ToSucceedWith from './toSucceedWith';
-import toSucceedWithDetail from './toSucceedWithDetail';
-export default Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, ToFail), ToFailTest), ToFailTestAndMatchSnapshot), ToFailTestWith), ToFailWith), ToFailWithDetail), ToSucceed), ToSucceedAndMatchInlineSnapshot), ToSucceedAndMatchSnapshot), ToSucceedAndSatisfy), ToSucceedWith), toSucceedWithDetail);
-//# sourceMappingURL=index.js.map

package/dist/test/helpers/jest/matchers/toFail/index.js

@@ -1,23 +0,0 @@
-import { printExpectedResult, printReceivedResult } from '../../utils/matcherHelpers';
-import { matcherName, predicate } from './predicate';
-import { matcherHint } from 'jest-matcher-utils';
-function passMessage(received) {
-    return () => [
-        matcherHint(`.not.${matcherName}`),
-        printExpectedResult('failure', false),
-        printReceivedResult(received)
-    ].join('\n');
-}
-function failMessage(received) {
-    return () => [matcherHint(`${matcherName}`), printExpectedResult('failure', true), printReceivedResult(received)].join('\n');
-}
-export default {
-    toFail: function (received) {
-        const pass = predicate(received);
-        if (pass) {
-            return { pass: true, message: passMessage(received) };
-        }
-        return { pass: false, message: failMessage(received) };
-    }
-};
-//# sourceMappingURL=index.js.map

package/dist/test/helpers/jest/matchers/toFail/predicate.js

@@ -1,5 +0,0 @@
-export const matcherName = 'toFail';
-export function predicate(received) {
-    return received.isFailure();
-}
-//# sourceMappingURL=predicate.js.map

package/dist/test/helpers/jest/matchers/toFailTest/index.js

@@ -1,28 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import { matcherName, predicate } from './predicate';
-import { matcherHint } from 'jest-matcher-utils';
-import { printExpectedResult } from '../../utils/matcherHelpers';
-function passMessage() {
-    return () => [
-        matcherHint(`.not.${matcherName}`, 'callback'),
-        printExpectedResult('failure', false),
-        '  Received: Test failed'
-    ].join('\n');
-}
-function failMessage() {
-    return () => [
-        matcherHint(`${matcherName}`, 'callback'),
-        printExpectedResult('failure', true),
-        '  Received: Test passed'
-    ].join('\n');
-}
-export default {
-    toFailTest: function (cb) {
-        const pass = predicate(cb);
-        if (pass) {
-            return { pass: true, message: passMessage() };
-        }
-        return { pass: false, message: failMessage() };
-    }
-};
-//# sourceMappingURL=index.js.map

package/dist/test/helpers/jest/matchers/toFailTest/predicate.js

@@ -1,8 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import { captureResult } from '../../ts-utils';
-export const matcherName = 'toFailTest';
-export function predicate(cb) {
-    const cbResult = captureResult(() => cb());
-    return cbResult.isFailure();
-}
-//# sourceMappingURL=predicate.js.map

package/dist/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/index.js

@@ -1,24 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import { matcherName, predicate } from './predicate';
-import { matcherHint } from 'jest-matcher-utils';
-import { toMatchSnapshot } from 'jest-snapshot';
-export default {
-    toFailTestAndMatchSnapshot: function (cb) {
-        const context = this;
-        const cbResult = predicate(cb);
-        if (cbResult.isFailure()) {
-            return {
-                pass: false,
-                message: () => {
-                    return [
-                        matcherHint(`${matcherName}`, 'callback'),
-                        '  Expected: Callback to fail with an error that matches snapshot',
-                        '  Received: Callback succeeded'
-                    ].join('\n');
-                }
-            };
-        }
-        return toMatchSnapshot.call(context, cbResult.value, 'toFailTestAndMatchSnapshot');
-    }
-};
-//# sourceMappingURL=index.js.map

package/dist/test/helpers/jest/matchers/toFailTestAndMatchSnapshot/predicate.js

@@ -1,11 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import { captureResult, fail, succeed } from '../../ts-utils';
-export const matcherName = 'toFailTestAndMatchSnapshot';
-export function predicate(cb) {
-    const cbResult = captureResult(() => cb());
-    if (cbResult.isFailure()) {
-        return succeed(cbResult.message);
-    }
-    return fail('Callback did not fail');
-}
-//# sourceMappingURL=predicate.js.map

package/dist/test/helpers/jest/matchers/toFailTestWith/index.js

@@ -1,29 +0,0 @@
-import { matcherName, predicate } from './predicate';
-import { matcherHint } from 'jest-matcher-utils';
-import { printExpectedResult } from '../../utils/matcherHelpers';
-function passMessage(cbResult, expected) {
-    return () => [
-        matcherHint(`.not.${matcherName}`, 'callback', 'expectedMessage'),
-        printExpectedResult('failure', false, expected),
-        `  Received: Callback failed with:\n>>>>\n${cbResult.value}\n<<<<`
-    ].join('\n');
-}
-function failMessage(cbResult, expected) {
-    return () => [
-        matcherHint(`${matcherName}`, 'callback', 'expectedMessage'),
-        printExpectedResult('failure', true, expected),
-        cbResult.message === ''
-            ? '  Received: Callback succeeded'
-            : `  Received: Callback failed with:\n>>>>\n${cbResult.message}\n<<<<`
-    ].join('\n');
-}
-export default {
-    toFailTestWith: function (cb, expected) {
-        const cbResult = predicate(cb, expected);
-        if (cbResult.isSuccess()) {
-            return { pass: true, message: passMessage(cbResult, expected) };
-        }
-        return { pass: false, message: failMessage(cbResult, expected) };
-    }
-};
-//# sourceMappingURL=index.js.map

package/dist/test/helpers/jest/matchers/toFailTestWith/predicate.js

@@ -1,26 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import { equals } from '@jest/expect-utils';
-import { stringify } from 'jest-matcher-utils';
-import { captureResult, fail, succeed } from '../../ts-utils';
-export const matcherName = 'toFailTestWith';
-export function predicate(cb, expected) {
-    const cbResult = captureResult(() => cb());
-    if (cbResult.isFailure()) {
-        let success = false;
-        if (expected instanceof RegExp) {
-            success = cbResult.message.match(expected) !== null;
-        }
-        else if (typeof expected === 'string') {
-            success = cbResult.message === expected;
-        }
-        else if (Array.isArray(expected)) {
-            success = equals(cbResult.message.split('\n'), expected);
-        }
-        else {
-            return fail(`Unsupported expected value "${stringify(expected)}" for toFailTestWith`);
-        }
-        return success ? succeed(cbResult.message) : fail(cbResult.message);
-    }
-    return fail('');
-}
-//# sourceMappingURL=predicate.js.map

package/dist/test/helpers/jest/matchers/toFailWith/index.js

@@ -1,27 +0,0 @@
-import { printExpectedResult, printReceivedResult } from '../../utils/matcherHelpers';
-import { matcherName, predicate } from './predicate';
-import { matcherHint } from 'jest-matcher-utils';
-function passMessage(received, expected) {
-    return () => [
-        matcherHint(`.not.${matcherName}`),
-        printExpectedResult('failure', false, expected),
-        printReceivedResult(received)
-    ].join('\n');
-}
-function failMessage(received, expected) {
-    return () => [
-        matcherHint(`${matcherName}`),
-        printExpectedResult('failure', true, expected),
-        printReceivedResult(received)
-    ].join('\n');
-}
-export default {
-    toFailWith: function (received, expected) {
-        const pass = predicate(received, expected);
-        if (pass) {
-            return { pass: true, message: passMessage(received, expected) };
-        }
-        return { pass: false, message: failMessage(received, expected) };
-    }
-};
-//# sourceMappingURL=index.js.map

package/dist/test/helpers/jest/matchers/toFailWith/predicate.js

@@ -1,16 +0,0 @@
-export const matcherName = 'toFailWith';
-export function predicate(received, expected) {
-    if (received.isFailure()) {
-        if (expected === undefined) {
-            return received.message === undefined;
-        }
-        else if (expected instanceof RegExp) {
-            return received.message.match(expected) !== null;
-        }
-        else {
-            return received.message === expected;
-        }
-    }
-    return false;
-}
-//# sourceMappingURL=predicate.js.map

package/dist/test/helpers/jest/matchers/toFailWithDetail/index.js

@@ -1,27 +0,0 @@
-import { printExpectedDetailedResult, printReceivedDetailedResult } from '../../utils/matcherHelpers';
-import { matcherName, predicate } from './predicate';
-import { matcherHint } from 'jest-matcher-utils';
-function passMessage(received, expectedMessage, expectedDetail) {
-    return () => [
-        matcherHint(`.not.${matcherName}`),
-        printExpectedDetailedResult('failure', false, expectedMessage, expectedDetail),
-        printReceivedDetailedResult(received)
-    ].join('\n');
-}
-function failMessage(received, expectedMessage, expectedDetail) {
-    return () => [
-        matcherHint(`${matcherName}`),
-        printExpectedDetailedResult('failure', true, expectedMessage, expectedDetail),
-        printReceivedDetailedResult(received)
-    ].join('\n');
-}
-export default {
-    toFailWithDetail: function (received, expectedMessage, expectedDetail) {
-        const pass = predicate(received, expectedMessage, expectedDetail);
-        if (pass) {
-            return { pass: true, message: passMessage(received, expectedMessage, expectedDetail) };
-        }
-        return { pass: false, message: failMessage(received, expectedMessage, expectedDetail) };
-    }
-};
-//# sourceMappingURL=index.js.map

package/dist/test/helpers/jest/matchers/toFailWithDetail/predicate.js

@@ -1,22 +0,0 @@
-import { equals } from '@jest/expect-utils';
-export const matcherName = 'toFailWith';
-export function predicate(received, expectedResult, expectedDetail) {
-    if (received.isFailure()) {
-        if (expectedResult === undefined) {
-            if (received.message !== undefined) {
-                return false;
-            }
-        }
-        else if (expectedResult instanceof RegExp) {
-            if (received.message.match(expectedResult) === null) {
-                return false;
-            }
-        }
-        else if (received.message !== expectedResult) {
-            return false;
-        }
-        return equals(received.detail, expectedDetail);
-    }
-    return false;
-}
-//# sourceMappingURL=predicate.js.map

package/dist/test/helpers/jest/matchers/toSucceed/index.js

@@ -1,23 +0,0 @@
-import { printExpectedResult, printReceivedResult } from '../../utils/matcherHelpers';
-import { matcherName, predicate } from './predicate';
-import { matcherHint } from 'jest-matcher-utils';
-function passMessage(received) {
-    return () => [
-        matcherHint(`.not.${matcherName}`),
-        printExpectedResult('success', false),
-        printReceivedResult(received)
-    ].join('\n');
-}
-function failMessage(received) {
-    return () => [matcherHint(`${matcherName}`), printExpectedResult('success', true), printReceivedResult(received)].join('\n');
-}
-export default {
-    toSucceed: function (received) {
-        const pass = predicate(received);
-        if (pass) {
-            return { pass: true, message: passMessage(received) };
-        }
-        return { pass: false, message: failMessage(received) };
-    }
-};
-//# sourceMappingURL=index.js.map

package/dist/test/helpers/jest/matchers/toSucceed/predicate.js

@@ -1,5 +0,0 @@
-export const matcherName = 'toSucceed';
-export function predicate(received) {
-    return received.isSuccess();
-}
-//# sourceMappingURL=predicate.js.map

package/dist/test/helpers/jest/matchers/toSucceedAndMatchInlineSnapshot/index.js

@@ -1,24 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import { matcherHint } from 'jest-matcher-utils';
-import { toMatchInlineSnapshot } from 'jest-snapshot';
-import { printReceivedResult } from '../../utils/matcherHelpers';
-const matcherName = 'toSucceedAndMatchInlineSnapshot';
-export default {
-    toSucceedAndMatchInlineSnapshot: function (received, snapshot) {
-        const context = this;
-        if (received.isFailure()) {
-            return {
-                pass: false,
-                message: () => {
-                    return [
-                        matcherHint(`${matcherName}`, 'callback'),
-                        'Expected:\n  Callback to succeed with a result that matches the snapshot',
-                        printReceivedResult(received)
-                    ].join('\n');
-                }
-            };
-        }
-        return toMatchInlineSnapshot.call(context, received.value, {}, snapshot);
-    }
-};
-//# sourceMappingURL=index.js.map