@fgv/ts-utils 4.2.2 → 4.4.0

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

@@ -1,7 +1,7 @@
 import { ArrayValidator, ArrayValidatorConstructorParams } from './array';
 import { FieldValidators, ObjectValidator, ObjectValidatorConstructorParams } from './object';
 import { TypeGuardValidator, TypeGuardValidatorConstructorParams } from './typeGuard';
-import { TypeGuardWithContext } from './common';
+import { TypeGuardWithContext, ValidatorFunc } from './common';
 import { OneOfValidator, OneOfValidatorConstructorParams } from './oneOf';
 import { Validator } from './validator';
 /**
@@ -71,5 +71,15 @@ export declare function oneOf<T, TC = unknown>(validators: Array<Validator<T, TC
  * the values using the supplied type guard.
  * @public
  */
-export declare function isA<T, TC>(description: string, guard: TypeGuardWithContext<T, TC>, params?: Omit<TypeGuardValidatorConstructorParams<T, TC>, 'description' | 'guard'>): TypeGuardValidator<T, TC>;
+export declare function isA<T, TC = unknown>(description: string, guard: TypeGuardWithContext<T, TC>, params?: Omit<TypeGuardValidatorConstructorParams<T, TC>, 'description' | 'guard'>): TypeGuardValidator<T, TC>;
+/**
+ * Helper function to create a {@link Validation.Validator | Validator} using a
+ * supplied {@link Validation.ValidatorFunc | validator function}.
+ * @param validator - A {@link Validation.ValidatorFunc | validator function} that a
+ * supplied unknown value matches some condition.
+ * @returns A new {@link Validation.Validator | Validator} which validates the desired
+ * value using the supplied function.
+ * @public
+ */
+export declare function generic<T, TC = unknown>(validator: ValidatorFunc<T, TC>): Validator<T, TC>;
 //# sourceMappingURL=validators.d.ts.map

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

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

package/lib/packlets/validation/validators.js

@@ -28,6 +28,7 @@ exports.enumeratedValue = enumeratedValue;
 exports.literal = literal;
 exports.oneOf = oneOf;
 exports.isA = isA;
+exports.generic = generic;
 const base_1 = require("../base");
 const array_1 = require("./array");
 const object_1 = require("./object");
@@ -132,4 +133,16 @@ function oneOf(validators, params) {
 function isA(description, guard, params) {
     return new typeGuard_1.TypeGuardValidator(Object.assign({ description, guard }, (params !== null && params !== void 0 ? params : {})));
 }
+/**
+ * Helper function to create a {@link Validation.Validator | Validator} using a
+ * supplied {@link Validation.ValidatorFunc | validator function}.
+ * @param validator - A {@link Validation.ValidatorFunc | validator function} that a
+ * supplied unknown value matches some condition.
+ * @returns A new {@link Validation.Validator | Validator} which validates the desired
+ * value using the supplied function.
+ * @public
+ */
+function generic(validator) {
+    return new genericValidator_1.GenericValidator({ validator });
+}
 //# sourceMappingURL=validators.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../../src/packlets/validation/validators.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AA4CH,wBAKC;AAUD,0BAKC;AAOD,0CAWC;AAOD,0BAUC;AAWD,sBAKC;AAWD,kBAMC;AAlID,kCAAwC;AACxC,mCAA0E;AAC1E,qCAA8F;AAC9F,2CAAsF;AAEtF,uCAA6C;AAE7C,yDAAsD;AACtD,qCAA2C;AAC3C,mCAA0E;AAC1E,qCAA2C;AAG3C;;;GAGG;AACU,QAAA,MAAM,GAAsB,IAAI,wBAAe,EAAE,CAAC;AAE/D;;;GAGG;AACU,QAAA,MAAM,GAAsB,IAAI,wBAAe,EAAE,CAAC;AAE/D;;;GAGG;AACU,QAAA,OAAO,GAAuB,IAAI,0BAAgB,EAAE,CAAC;AAElE;;;;;;;;;;GAUG;AACH,SAAgB,MAAM,CACpB,MAA8B,EAC9B,MAAgE;IAEhE,OAAO,IAAI,wBAAe,iBAAG,MAAM,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC5D,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,OAAO,CACrB,eAAiC,EACjC,MAAwE;IAExE,OAAO,IAAI,sBAAc,iBAAG,eAAe,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAmB,MAAW;IAC3D,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAa,EAAwB,EAAE;YAChE,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,CAAC,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,MAAM,CAAC;gBAC5B,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC;gBACnC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,6BAA6B,IAAI,mBAAmB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACvG,CAAC;YACD,OAAO,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACtE,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CACrB,KAAQ;IAER,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CAAC,IAAa,EAAwB,EAAE;YACjD,OAAO,IAAI,KAAK,KAAK;gBACnB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,IAAA,WAAI,EAAC,oBAAoB,MAAM,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9F,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,KAAK,CACnB,UAAmC,EACnC,MAAmE;IAEnE,OAAO,IAAI,sBAAc,iCAAa,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,KAAE,UAAU,IAAG,CAAC;AACtE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,GAAG,CACjB,WAAmB,EACnB,KAAkC,EAClC,MAAkF;IAElF,OAAO,IAAI,8BAAkB,iBAAG,WAAW,EAAE,KAAK,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC3E,CAAC","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 { OneOfValidator, OneOfValidatorConstructorParams } from './oneOf';\nimport { StringValidator } from './string';\nimport { Validator } from './validator';\n\n/**\n * A {@link Validation.Classes.StringValidator | StringValidator} which validates a string in place.\n * @public\n */\nexport const string: Validator<string> = new StringValidator();\n\n/**\n * A {@link Validation.Classes.NumberValidator | NumberValidator} which validates a number in place.\n * @public\n */\nexport const number: Validator<number> = new NumberValidator();\n\n/**\n * A {@link Validation.Classes.BooleanValidator | BooleanValidator} which validates a boolean in place.\n * @public\n */\nexport const boolean: Validator<boolean> = new BooleanValidator();\n\n/**\n * Helper function to create a {@link Validation.Classes.ObjectValidator | ObjectValidator} which validates\n * an object in place.\n * @param fields - A {@link Validation.Classes.FieldValidators | field validator definition}\n * describing the validations to be applied.\n * @param params - Optional {@link Validation.Classes.ObjectValidatorConstructorParams | parameters}\n * to refine the behavior of the resulting {@link Validation.Validator | validator}.\n * @returns A new {@link Validation.Validator | Validator} which validates the desired\n * object in place.\n * @public\n */\nexport function object<T, TC = unknown>(\n  fields: FieldValidators<T, TC>,\n  params?: Omit<ObjectValidatorConstructorParams<T, TC>, 'fields'>\n): ObjectValidator<T, TC> {\n  return new ObjectValidator({ fields, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Classes.ArrayValidator | ArrayValidator} which\n * validates an array in place.\n * @param validateElement - A {@link Validation.Validator | validator} which validates each element.\n * @returns A new {@link Validation.Classes.ArrayValidator | ArrayValidator } which validates the desired\n * array in place.\n * @public\n */\nexport function arrayOf<T, TC>(\n  validateElement: Validator<T, TC>,\n  params?: Omit<ArrayValidatorConstructorParams<T, TC>, 'validateElement'>\n): ArrayValidator<T, TC> {\n  return new ArrayValidator({ validateElement, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator} which validates an enumerated\n * value in place.\n * @public\n */\nexport function enumeratedValue<T extends string>(values: T[]): Validator<T, T[]> {\n  return new GenericValidator({\n    validator: (from: unknown, context?: T[]): boolean | Failure<T> => {\n      if (typeof from === 'string') {\n        const v = context ?? values;\n        const index = v.indexOf(from as T);\n        return index >= 0 ? true : fail(`Invalid enumerated value \"${from}\"  - expected: (${v.join(', ')})`);\n      }\n      return fail(`Not a string: \"${JSON.stringify(from, undefined, 2)}`);\n    }\n  });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator} which validates a literal value.\n * @param value - the literal value to be validated\n * @public\n */\nexport function literal<T extends string | number | boolean | symbol | null | undefined>(\n  value: T\n): Validator<T> {\n  return new GenericValidator({\n    validator: (from: unknown): boolean | Failure<T> => {\n      return from === value\n        ? true\n        : fail(`Expected literal ${String(value)}, found \"${JSON.stringify(from, undefined, 2)}`);\n    }\n  });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator | Validator} which validates one\n * of several possible validated values.\n * @param validators - the {@link Validation.Validator | validators} to be considered.\n * @param params - Optional {@link Validation.Classes.OneOfValidatorConstructorParams | params} used to construct the validator.\n * @returns A new {@link Validator | Validator} which validates values that match any of\n * the supplied validators.\n * @public\n */\nexport function oneOf<T, TC = unknown>(\n  validators: Array<Validator<T, TC>>,\n  params?: Omit<OneOfValidatorConstructorParams<T, TC>, 'validators'>\n): OneOfValidator<T, TC> {\n  return new OneOfValidator<T, TC>({ ...(params ?? {}), validators });\n}\n\n/**\n * Helper function to create a {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator} which\n * validates a value or object in place.\n * @param description - a description of the thing to be validated for use in error messages\n * @param guard - a {@link Validation.TypeGuardWithContext} which performs the validation.\n * @returns A new {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator } which validates\n * the values using the supplied type guard.\n * @public\n */\nexport function isA<T, TC>(\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;;;AA4CH,wBAKC;AAUD,0BAKC;AAOD,0CAWC;AAOD,0BAUC;AAWD,sBAKC;AAWD,kBAMC;AAWD,0BAEC;AA/ID,kCAAwC;AACxC,mCAA0E;AAC1E,qCAA8F;AAC9F,2CAAsF;AAEtF,uCAA6C;AAE7C,yDAAsD;AACtD,qCAA2C;AAC3C,mCAA0E;AAC1E,qCAA2C;AAG3C;;;GAGG;AACU,QAAA,MAAM,GAAsB,IAAI,wBAAe,EAAE,CAAC;AAE/D;;;GAGG;AACU,QAAA,MAAM,GAAsB,IAAI,wBAAe,EAAE,CAAC;AAE/D;;;GAGG;AACU,QAAA,OAAO,GAAuB,IAAI,0BAAgB,EAAE,CAAC;AAElE;;;;;;;;;;GAUG;AACH,SAAgB,MAAM,CACpB,MAA8B,EAC9B,MAAgE;IAEhE,OAAO,IAAI,wBAAe,iBAAG,MAAM,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC5D,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,OAAO,CACrB,eAAiC,EACjC,MAAwE;IAExE,OAAO,IAAI,sBAAc,iBAAG,eAAe,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAmB,MAAW;IAC3D,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAa,EAAwB,EAAE;YAChE,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,CAAC,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,MAAM,CAAC;gBAC5B,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC;gBACnC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,6BAA6B,IAAI,mBAAmB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACvG,CAAC;YACD,OAAO,IAAA,WAAI,EAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACtE,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CACrB,KAAQ;IAER,OAAO,IAAI,mCAAgB,CAAC;QAC1B,SAAS,EAAE,CAAC,IAAa,EAAwB,EAAE;YACjD,OAAO,IAAI,KAAK,KAAK;gBACnB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,IAAA,WAAI,EAAC,oBAAoB,MAAM,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9F,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,KAAK,CACnB,UAAmC,EACnC,MAAmE;IAEnE,OAAO,IAAI,sBAAc,iCAAa,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,KAAE,UAAU,IAAG,CAAC;AACtE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,GAAG,CACjB,WAAmB,EACnB,KAAkC,EAClC,MAAkF;IAElF,OAAO,IAAI,8BAAkB,iBAAG,WAAW,EAAE,KAAK,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC3E,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,OAAO,CAAkB,SAA+B;IACtE,OAAO,IAAI,mCAAgB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;AAC7C,CAAC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail } from '../base';\nimport { ArrayValidator, ArrayValidatorConstructorParams } from './array';\nimport { FieldValidators, ObjectValidator, ObjectValidatorConstructorParams } from './object';\nimport { TypeGuardValidator, TypeGuardValidatorConstructorParams } from './typeGuard';\n\nimport { BooleanValidator } from './boolean';\nimport { TypeGuardWithContext, ValidatorFunc } from './common';\nimport { GenericValidator } from './genericValidator';\nimport { NumberValidator } from './number';\nimport { OneOfValidator, OneOfValidatorConstructorParams } from './oneOf';\nimport { StringValidator } from './string';\nimport { Validator } from './validator';\n\n/**\n * A {@link Validation.Classes.StringValidator | StringValidator} which validates a string in place.\n * @public\n */\nexport const string: Validator<string> = new StringValidator();\n\n/**\n * A {@link Validation.Classes.NumberValidator | NumberValidator} which validates a number in place.\n * @public\n */\nexport const number: Validator<number> = new NumberValidator();\n\n/**\n * A {@link Validation.Classes.BooleanValidator | BooleanValidator} which validates a boolean in place.\n * @public\n */\nexport const boolean: Validator<boolean> = new BooleanValidator();\n\n/**\n * Helper function to create a {@link Validation.Classes.ObjectValidator | ObjectValidator} which validates\n * an object in place.\n * @param fields - A {@link Validation.Classes.FieldValidators | field validator definition}\n * describing the validations to be applied.\n * @param params - Optional {@link Validation.Classes.ObjectValidatorConstructorParams | parameters}\n * to refine the behavior of the resulting {@link Validation.Validator | validator}.\n * @returns A new {@link Validation.Validator | Validator} which validates the desired\n * object in place.\n * @public\n */\nexport function object<T, TC = unknown>(\n  fields: FieldValidators<T, TC>,\n  params?: Omit<ObjectValidatorConstructorParams<T, TC>, 'fields'>\n): ObjectValidator<T, TC> {\n  return new ObjectValidator({ fields, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Classes.ArrayValidator | ArrayValidator} which\n * validates an array in place.\n * @param validateElement - A {@link Validation.Validator | validator} which validates each element.\n * @returns A new {@link Validation.Classes.ArrayValidator | ArrayValidator } which validates the desired\n * array in place.\n * @public\n */\nexport function arrayOf<T, TC>(\n  validateElement: Validator<T, TC>,\n  params?: Omit<ArrayValidatorConstructorParams<T, TC>, 'validateElement'>\n): ArrayValidator<T, TC> {\n  return new ArrayValidator({ validateElement, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator} which validates an enumerated\n * value in place.\n * @public\n */\nexport function enumeratedValue<T extends string>(values: T[]): Validator<T, T[]> {\n  return new GenericValidator({\n    validator: (from: unknown, context?: T[]): boolean | Failure<T> => {\n      if (typeof from === 'string') {\n        const v = context ?? values;\n        const index = v.indexOf(from as T);\n        return index >= 0 ? true : fail(`Invalid enumerated value \"${from}\"  - expected: (${v.join(', ')})`);\n      }\n      return fail(`Not a string: \"${JSON.stringify(from, undefined, 2)}`);\n    }\n  });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator} which validates a literal value.\n * @param value - the literal value to be validated\n * @public\n */\nexport function literal<T extends string | number | boolean | symbol | null | undefined>(\n  value: T\n): Validator<T> {\n  return new GenericValidator({\n    validator: (from: unknown): boolean | Failure<T> => {\n      return from === value\n        ? true\n        : fail(`Expected literal ${String(value)}, found \"${JSON.stringify(from, undefined, 2)}`);\n    }\n  });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator | Validator} which validates one\n * of several possible validated values.\n * @param validators - the {@link Validation.Validator | validators} to be considered.\n * @param params - Optional {@link Validation.Classes.OneOfValidatorConstructorParams | params} used to construct the validator.\n * @returns A new {@link Validator | Validator} which validates values that match any of\n * the supplied validators.\n * @public\n */\nexport function oneOf<T, TC = unknown>(\n  validators: Array<Validator<T, TC>>,\n  params?: Omit<OneOfValidatorConstructorParams<T, TC>, 'validators'>\n): OneOfValidator<T, TC> {\n  return new OneOfValidator<T, TC>({ ...(params ?? {}), validators });\n}\n\n/**\n * Helper function to create a {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator} which\n * validates a value or object in place.\n * @param description - a description of the thing to be validated for use in error messages\n * @param guard - a {@link Validation.TypeGuardWithContext} which performs the validation.\n * @returns A new {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator } which validates\n * the values using the supplied type guard.\n * @public\n */\nexport function isA<T, TC = unknown>(\n  description: string,\n  guard: TypeGuardWithContext<T, TC>,\n  params?: Omit<TypeGuardValidatorConstructorParams<T, TC>, 'description' | 'guard'>\n): TypeGuardValidator<T, TC> {\n  return new TypeGuardValidator({ description, guard, ...(params ?? {}) });\n}\n\n/**\n * Helper function to create a {@link Validation.Validator | Validator} using a\n * supplied {@link Validation.ValidatorFunc | validator function}.\n * @param validator - A {@link Validation.ValidatorFunc | validator function} that a\n * supplied unknown value matches some condition.\n * @returns A new {@link Validation.Validator | Validator} which validates the desired\n * value using the supplied function.\n * @public\n */\nexport function generic<T, TC = unknown>(validator: ValidatorFunc<T, TC>): Validator<T, TC> {\n  return new GenericValidator({ validator });\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-utils",
-  "version": "4.2.2",
+  "version": "4.4.0",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "types": "dist/ts-utils.d.ts",

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

@@ -1 +0,0 @@
-{"version":3,"file":"resultMapValidator.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/resultMapValidator.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,cAAc,EAAqC,MAAM,SAAS,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,2BAA2B,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO;IACnF;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAEhD;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAEzC;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC,CAAC;IAE5D;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO;IACvF,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACvB,UAAU,EAAE,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;CACxC;AAED;;;;GAIG;AACH,qBAAa,kBAAkB,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CACtE,YAAW,2BAA2B,CAAC,EAAE,EAAE,EAAE,CAAC;IAE9C,SAAgB,UAAU,EAAE,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACvD,IAAW,GAAG,IAAI,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAE3C;IAED,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAElC;;;OAGG;gBACgB,MAAM,EAAE,+BAA+B,CAAC,EAAE,EAAE,EAAE,CAAC;IAKlE;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAMlF;;OAEG;IACI,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAMrE;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAMlE;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAEvF;;OAEG;IACI,QAAQ,CACb,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,qBAAqB,CAAC,EAAE,EAAE,EAAE,CAAC,GACrC,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAwB5C;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAMlF;;OAEG;IACI,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAMrF;;OAEG;IACI,UAAU,IAAI,2BAA2B,CAAC,EAAE,EAAE,EAAE,CAAC;IAIxD;;;;;;OAMG;IACH,SAAS,CAAC,wBAAwB,CAAC,EAAE,SAAS,MAAM,EAAE,EAAE,EACtD,KAAK,EAAE,EAAE,GAAG,qBAAqB,CAAC,EAAE,EAAE,EAAE,CAAC,GACxC,KAAK,IAAI,qBAAqB,CAAC,EAAE,EAAE,EAAE,CAAC;CAG1C"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"resultMapValidator.js","sourceRoot":"","sources":["../../../src/packlets/collections/resultMapValidator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAA4E;AAwC5E;;;;GAIG;AACH,MAAa,kBAAkB;IAI7B,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAID;;;OAGG;IACH,YAAmB,MAA+C;QAChE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW,EAAE,KAAc;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;YACxE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,GAAW;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACtD,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACtD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAcM,QAAQ,CACb,GAAW,EACX,cAAuD;QAEvD,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,cAAc,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;gBACjF,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;gBACtD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE;oBACrC,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC;yBAC5B,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;yBAC/D,SAAS,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAA,wBAAiB,EAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;oBAEpE,OAAO,KAAK,CAAC,OAAO;wBAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;wBAC/B,CAAC,CAAC,IAAA,qBAAc,EAA4B,KAAK,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;gBAChF,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAS,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW,EAAE,KAAc;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;YACxE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,GAAW,EAAE,KAAc;QACvC,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;YACxE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACO,wBAAwB,CAChC,KAAyC;QAEzC,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;IACrC,CAAC;CACF;AA7HD,gDA6HC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { DetailedResult, failWithDetail, succeedWithDetail } from '../base';\nimport { IReadOnlyResultMap, ResultMapResultDetail } from './readonlyResultMap';\nimport { ResultMap, ResultMapValueFactory } from './resultMap';\nimport { KeyValueValidators } from './utils';\n\n/**\n * A read-only interface exposing non-mutating methods of a {@link Collections.ResultMapValidator | ResultMapValidator}.\n * @public\n */\nexport interface IReadOnlyResultMapValidator<TK extends string = string, TV = unknown> {\n  /**\n   * {@inheritdoc Collections.ResultMapValidator.validators}\n   */\n  readonly validators: KeyValueValidators<TK, TV>;\n\n  /**\n   * {@inheritdoc Collections.ResultMapValidator.map}\n   */\n  readonly map: IReadOnlyResultMap<TK, TV>;\n\n  /**\n   * {@inheritdoc Collections.ResultMap.get}\n   */\n  get(key: string): DetailedResult<TV, ResultMapResultDetail>;\n\n  /**\n   * {@inheritdoc Collections.ResultMap.has}\n   */\n  has(key: string): boolean;\n}\n\n/**\n * Parameters for constructing a {@link Collections.ResultMapValidator | ResultMapValidator}.\n * @public\n */\nexport interface IResultMapValidatorCreateParams<TK extends string = string, TV = unknown> {\n  map: ResultMap<TK, TV>;\n  validators: KeyValueValidators<TK, TV>;\n}\n\n/**\n * A {@link Collections.ResultMap | ResultMap} wrapper which validates weakly-typed keys\n * before calling the wrapped result map.\n * @public\n */\nexport class ResultMapValidator<TK extends string = string, TV = unknown>\n  implements IReadOnlyResultMapValidator<TK, TV>\n{\n  public readonly validators: KeyValueValidators<TK, TV>;\n  public get map(): IReadOnlyResultMap<TK, TV> {\n    return this._map;\n  }\n\n  protected _map: ResultMap<TK, TV>;\n\n  /**\n   * Constructs a new {@link Collections.ValidatingResultMap | ValidatingResultMap}.\n   * @param params - Required parameters for constructing the map.\n   */\n  public constructor(params: IResultMapValidatorCreateParams<TK, TV>) {\n    this._map = params.map;\n    this.validators = params.validators;\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.add}\n   */\n  public add(key: string, value: unknown): DetailedResult<TV, ResultMapResultDetail> {\n    return this.validators.validateEntry([key, value]).onSuccess(([vk, vv]) => {\n      return this._map.add(vk, vv);\n    });\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.delete}\n   */\n  public delete(key: string): DetailedResult<TV, ResultMapResultDetail> {\n    return this.validators.validateKey(key).onSuccess((k) => {\n      return this._map.delete(k);\n    });\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.get}\n   */\n  public get(key: string): DetailedResult<TV, ResultMapResultDetail> {\n    return this.validators.validateKey(key).onSuccess((k) => {\n      return this._map.get(k);\n    });\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.(getOrAdd:1)}\n   */\n  public getOrAdd(key: string, value: unknown): DetailedResult<TV, ResultMapResultDetail>;\n\n  /**\n   * {@inheritdoc Collections.ResultMap.(getOrAdd:2)}\n   */\n  public getOrAdd(\n    key: string,\n    factory: ResultMapValueFactory<TK, TV>\n  ): DetailedResult<TV, ResultMapResultDetail>;\n  public getOrAdd(\n    key: string,\n    valueOrFactory: unknown | ResultMapValueFactory<TK, TV>\n  ): DetailedResult<TV, ResultMapResultDetail> {\n    if (!this._isResultMapValueFactory(valueOrFactory)) {\n      return this.validators.validateEntry([key, valueOrFactory]).onSuccess(([vk, vv]) => {\n        return this._map.getOrAdd(vk, vv);\n      });\n    } else {\n      return this.validators.validateKey(key).onSuccess((k) => {\n        return this._map.get(k).onFailure(() => {\n          const value = valueOrFactory(k)\n            .onSuccess((value) => this.validators.validateEntry([k, value]))\n            .onSuccess(([__key, value]) => succeedWithDetail(value, 'added'));\n\n          return value.success\n            ? this._map.add(k, value.value)\n            : failWithDetail<TV, ResultMapResultDetail>(value.message, 'invalid-value');\n        });\n      });\n    }\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.has}\n   */\n  public has(key: string): boolean {\n    return this._map.has(key as TK);\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.set}\n   */\n  public set(key: string, value: unknown): DetailedResult<TV, ResultMapResultDetail> {\n    return this.validators.validateEntry([key, value]).onSuccess(([vk, vv]) => {\n      return this._map.set(vk, vv);\n    });\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.update}\n   */\n  public update(key: string, value: unknown): DetailedResult<TV, ResultMapResultDetail> {\n    return this.validators.validateEntry([key, value]).onSuccess(([vk, vv]) => {\n      return this._map.update(vk, vv);\n    });\n  }\n\n  /**\n   * Gets a read-only version of this validator.\n   */\n  public toReadOnly(): IReadOnlyResultMapValidator<TK, TV> {\n    return this;\n  }\n\n  /**\n   * Determines if a value is a {@link Collections.ResultMapValueFactory | ResultMapValueFactory}.\n   * @param value - The value to check.\n   * @returns `true` if the value is a {@link Collections.ResultMapValueFactory | ResultMapValueFactory},\n   * `false` otherwise.\n   * @public\n   */\n  protected _isResultMapValueFactory<TK extends string, TV>(\n    value: TV | ResultMapValueFactory<TK, TV>\n  ): value is ResultMapValueFactory<TK, TV> {\n    return typeof value === 'function';\n  }\n}\n"]}

package/lib/packlets/collections/validatingResultMap.d.ts

@@ -1,73 +0,0 @@
-import { DetailedResult, Result } from '../base';
-import { KeyValueEntry } from './common';
-import { IReadOnlyResultMap, ResultMapResultDetail } from './readonlyResultMap';
-import { ResultMap, ResultMapValueFactory } from './resultMap';
-import { IReadOnlyResultMapValidator, ResultMapValidator } from './resultMapValidator';
-import { KeyValueValidators } from './utils';
-/**
- * A read-only interface exposing non-mutating methods of a {@link Collections.ValidatingResultMap | ValidatingResultMap}.
- * @public
- */
-export interface IReadOnlyValidatingResultMap<TK extends string = string, TV = unknown> extends IReadOnlyResultMap<TK, TV> {
-    /**
-     * {@inheritdoc Collections.ValidatingResultMap.validate}
-     */
-    readonly validate: IReadOnlyResultMapValidator<TK, TV>;
-}
-/**
- * Parameters for constructing a {@link Collections.ResultMap | ResultMap}.
- * @public
- */
-export interface IValidatingResultMapConstructorParams<TK extends string = string, TV = unknown> {
-    entries?: Iterable<KeyValueEntry<string, unknown>>;
-    validators: KeyValueValidators<TK, TV>;
-}
-/**
- * A {@link Collections.ResultMap | ResultMap} with a {@link Collections.ResultMapValidator | validator}
- * property that enables validated use of the underlying map with weakly-typed keys and values.
- * @public
- */
-export declare class ValidatingResultMap<TK extends string = string, TV = unknown> extends ResultMap<TK, TV> implements IReadOnlyValidatingResultMap<TK, TV> {
-    /**
-     * A {@link Collections.ResultMapValidator | ResultMapValidator} which validates keys and values
-     * before inserting them into this collection.
-     */
-    readonly validate: ResultMapValidator<TK, TV>;
-    /**
-     * Constructs a new {@link Collections.ValidatingResultMap | ValidatingResultMap}.
-     * @param params - Required parameters for constructing the map.
-     */
-    constructor(params: IValidatingResultMapConstructorParams<TK, TV>);
-    /**
-     * Creates a new {@link Collections.ValidatingResultMap | ValidatingResultMap} instance.
-     * @param params - Required parameters for constructing the map.
-     * @returns `Success` with the new map if successful, `Failure` otherwise.
-     * @public
-     */
-    static createValidating<TK extends string = string, TV = unknown>(params: IValidatingResultMapConstructorParams<TK, TV>): Result<ValidatingResultMap<TK, TV>>;
-    /**
-     * {@inheritdoc Collections.ResultMap.add}
-     */
-    add(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail>;
-    /**
-     * {@inheritdoc Collections.ResultMap.(getOrAdd:1)}
-     */
-    getOrAdd(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail>;
-    /**
-     * {@inheritdoc Collections.ResultMap.(getOrAdd:2)}
-     */
-    getOrAdd(key: TK, factory: ResultMapValueFactory<TK, TV>): DetailedResult<TV, ResultMapResultDetail>;
-    /**
-     * {@inheritdoc Collections.ResultMap.set}
-     */
-    set(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail>;
-    /**
-     * {@inheritdoc Collections.ResultMap.update}
-     */
-    update(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail>;
-    /**
-     * Gets a read-only version of this map.
-     */
-    toReadOnly(): IReadOnlyValidatingResultMap<TK, TV>;
-}
-//# sourceMappingURL=validatingResultMap.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"validatingResultMap.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/validatingResultMap.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,cAAc,EAAkB,MAAM,EAAW,MAAM,SAAS,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,4BAA4B,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CACpF,SAAQ,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,2BAA2B,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;CACxD;AAED;;;GAGG;AACH,MAAM,WAAW,qCAAqC,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO;IAC7F,OAAO,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACnD,UAAU,EAAE,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;CACxC;AAED;;;;GAIG;AACH,qBAAa,mBAAmB,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CACvE,SAAQ,SAAS,CAAC,EAAE,EAAE,EAAE,CACxB,YAAW,4BAA4B,CAAC,EAAE,EAAE,EAAE,CAAC;IAE/C;;;OAGG;IACH,SAAgB,QAAQ,EAAE,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAErD;;;OAGG;gBACgB,MAAM,EAAE,qCAAqC,CAAC,EAAE,EAAE,EAAE,CAAC;IAMxE;;;;;OAKG;WACW,gBAAgB,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,EACrE,MAAM,EAAE,qCAAqC,CAAC,EAAE,EAAE,EAAE,CAAC,GACpD,MAAM,CAAC,mBAAmB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAItC;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAMzE;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAC9E;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,qBAAqB,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAqB3G;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAMzE;;OAEG;IACI,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAM5E;;OAEG;IACI,UAAU,IAAI,4BAA4B,CAAC,EAAE,EAAE,EAAE,CAAC;CAG1D"}

package/lib/packlets/collections/validatingResultMap.js

@@ -1,102 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidatingResultMap = void 0;
-const base_1 = require("../base");
-const resultMap_1 = require("./resultMap");
-const resultMapValidator_1 = require("./resultMapValidator");
-/**
- * A {@link Collections.ResultMap | ResultMap} with a {@link Collections.ResultMapValidator | validator}
- * property that enables validated use of the underlying map with weakly-typed keys and values.
- * @public
- */
-class ValidatingResultMap extends resultMap_1.ResultMap {
-    /**
-     * Constructs a new {@link Collections.ValidatingResultMap | ValidatingResultMap}.
-     * @param params - Required parameters for constructing the map.
-     */
-    constructor(params) {
-        var _a;
-        const entries = params.validators.validateEntries([...((_a = params.entries) !== null && _a !== void 0 ? _a : [])]).orThrow();
-        super({ entries });
-        this.validate = new resultMapValidator_1.ResultMapValidator({ map: this, validators: params.validators });
-    }
-    /**
-     * Creates a new {@link Collections.ValidatingResultMap | ValidatingResultMap} instance.
-     * @param params - Required parameters for constructing the map.
-     * @returns `Success` with the new map if successful, `Failure` otherwise.
-     * @public
-     */
-    static createValidating(params) {
-        return (0, base_1.captureResult)(() => new ValidatingResultMap(params));
-    }
-    /**
-     * {@inheritdoc Collections.ResultMap.add}
-     */
-    add(key, value) {
-        return this.validate.validators.validateEntry([key, value]).onSuccess((entry) => {
-            return super.add(entry[0], entry[1]);
-        });
-    }
-    getOrAdd(key, valueOrFactory) {
-        if (!this._isResultMapValueFactory(valueOrFactory)) {
-            return this.validate.validators.validateEntry([key, valueOrFactory]).onSuccess((entry) => {
-                return super.getOrAdd(entry[0], entry[1]);
-            });
-        }
-        else {
-            return super.get(key).onFailure(() => {
-                const value = valueOrFactory(key)
-                    .onSuccess((value) => this.validate.validators.validateEntry([key, value]))
-                    .onSuccess(([key, value]) => (0, base_1.succeed)(value));
-                return value.success
-                    ? super.add(key, value.value)
-                    : (0, base_1.failWithDetail)(value.message, 'invalid-value');
-            });
-        }
-    }
-    /**
-     * {@inheritdoc Collections.ResultMap.set}
-     */
-    set(key, value) {
-        return this.validate.validators.validateEntry([key, value]).onSuccess((entry) => {
-            return super.set(entry[0], entry[1]);
-        });
-    }
-    /**
-     * {@inheritdoc Collections.ResultMap.update}
-     */
-    update(key, value) {
-        return this.validate.validators.validateEntry([key, value]).onSuccess((entry) => {
-            return super.update(entry[0], entry[1]);
-        });
-    }
-    /**
-     * Gets a read-only version of this map.
-     */
-    toReadOnly() {
-        return this;
-    }
-}
-exports.ValidatingResultMap = ValidatingResultMap;
-//# sourceMappingURL=validatingResultMap.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"validatingResultMap.js","sourceRoot":"","sources":["../../../src/packlets/collections/validatingResultMap.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAyF;AAGzF,2CAA+D;AAC/D,6DAAuF;AAwBvF;;;;GAIG;AACH,MAAa,mBACX,SAAQ,qBAAiB;IASzB;;;OAGG;IACH,YAAmB,MAAqD;;QACtE,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACzF,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,uCAAkB,CAAS,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAC5B,MAAqD;QAErD,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAO,EAAE,KAAS;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9E,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAUM,QAAQ,CACb,GAAO,EACP,cAAkD;QAElD,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,cAAc,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBACvF,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE;gBACnC,MAAM,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC;qBAC9B,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;qBAC1E,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC,CAAC,CAAC;gBAC/C,OAAO,KAAK,CAAC,OAAO;oBAClB,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC;oBAC7B,CAAC,CAAC,IAAA,qBAAc,EAA4B,KAAK,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAO,EAAE,KAAS;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9E,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,GAAO,EAAE,KAAS;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9E,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA7FD,kDA6FC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { captureResult, DetailedResult, failWithDetail, Result, succeed } from '../base';\nimport { KeyValueEntry } from './common';\nimport { IReadOnlyResultMap, ResultMapResultDetail } from './readonlyResultMap';\nimport { ResultMap, ResultMapValueFactory } from './resultMap';\nimport { IReadOnlyResultMapValidator, ResultMapValidator } from './resultMapValidator';\nimport { KeyValueValidators } from './utils';\n\n/**\n * A read-only interface exposing non-mutating methods of a {@link Collections.ValidatingResultMap | ValidatingResultMap}.\n * @public\n */\nexport interface IReadOnlyValidatingResultMap<TK extends string = string, TV = unknown>\n  extends IReadOnlyResultMap<TK, TV> {\n  /**\n   * {@inheritdoc Collections.ValidatingResultMap.validate}\n   */\n  readonly validate: IReadOnlyResultMapValidator<TK, TV>;\n}\n\n/**\n * Parameters for constructing a {@link Collections.ResultMap | ResultMap}.\n * @public\n */\nexport interface IValidatingResultMapConstructorParams<TK extends string = string, TV = unknown> {\n  entries?: Iterable<KeyValueEntry<string, unknown>>;\n  validators: KeyValueValidators<TK, TV>;\n}\n\n/**\n * A {@link Collections.ResultMap | ResultMap} with a {@link Collections.ResultMapValidator | validator}\n * property that enables validated use of the underlying map with weakly-typed keys and values.\n * @public\n */\nexport class ValidatingResultMap<TK extends string = string, TV = unknown>\n  extends ResultMap<TK, TV>\n  implements IReadOnlyValidatingResultMap<TK, TV>\n{\n  /**\n   * A {@link Collections.ResultMapValidator | ResultMapValidator} which validates keys and values\n   * before inserting them into this collection.\n   */\n  public readonly validate: ResultMapValidator<TK, TV>;\n\n  /**\n   * Constructs a new {@link Collections.ValidatingResultMap | ValidatingResultMap}.\n   * @param params - Required parameters for constructing the map.\n   */\n  public constructor(params: IValidatingResultMapConstructorParams<TK, TV>) {\n    const entries = params.validators.validateEntries([...(params.entries ?? [])]).orThrow();\n    super({ entries });\n    this.validate = new ResultMapValidator<TK, TV>({ map: this, validators: params.validators });\n  }\n\n  /**\n   * Creates a new {@link Collections.ValidatingResultMap | ValidatingResultMap} instance.\n   * @param params - Required parameters for constructing the map.\n   * @returns `Success` with the new map if successful, `Failure` otherwise.\n   * @public\n   */\n  public static createValidating<TK extends string = string, TV = unknown>(\n    params: IValidatingResultMapConstructorParams<TK, TV>\n  ): Result<ValidatingResultMap<TK, TV>> {\n    return captureResult(() => new ValidatingResultMap(params));\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.add}\n   */\n  public add(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail> {\n    return this.validate.validators.validateEntry([key, value]).onSuccess((entry) => {\n      return super.add(entry[0], entry[1]);\n    });\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.(getOrAdd:1)}\n   */\n  public getOrAdd(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail>;\n  /**\n   * {@inheritdoc Collections.ResultMap.(getOrAdd:2)}\n   */\n  public getOrAdd(key: TK, factory: ResultMapValueFactory<TK, TV>): DetailedResult<TV, ResultMapResultDetail>;\n  public getOrAdd(\n    key: TK,\n    valueOrFactory: TV | ResultMapValueFactory<TK, TV>\n  ): DetailedResult<TV, ResultMapResultDetail> {\n    if (!this._isResultMapValueFactory(valueOrFactory)) {\n      return this.validate.validators.validateEntry([key, valueOrFactory]).onSuccess((entry) => {\n        return super.getOrAdd(entry[0], entry[1]);\n      });\n    } else {\n      return super.get(key).onFailure(() => {\n        const value = valueOrFactory(key)\n          .onSuccess((value) => this.validate.validators.validateEntry([key, value]))\n          .onSuccess(([key, value]) => succeed(value));\n        return value.success\n          ? super.add(key, value.value)\n          : failWithDetail<TV, ResultMapResultDetail>(value.message, 'invalid-value');\n      });\n    }\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.set}\n   */\n  public set(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail> {\n    return this.validate.validators.validateEntry([key, value]).onSuccess((entry) => {\n      return super.set(entry[0], entry[1]);\n    });\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.update}\n   */\n  public update(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail> {\n    return this.validate.validators.validateEntry([key, value]).onSuccess((entry) => {\n      return super.update(entry[0], entry[1]);\n    });\n  }\n\n  /**\n   * Gets a read-only version of this map.\n   */\n  public toReadOnly(): IReadOnlyValidatingResultMap<TK, TV> {\n    return this;\n  }\n}\n"]}