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

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

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../../src/packlets/validation/validators.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAW,IAAI,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,cAAc,EAAmC,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAyC,MAAM,eAAe,CAAC;AAC5F,OAAO,EAAmB,eAAe,EAAoC,MAAM,UAAU,CAAC;AAC9F,OAAO,EAAE,kBAAkB,EAAuC,MAAM,aAAa,CAAC;AAEtF,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAE7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAmC,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAsB,IAAI,eAAe,EAAE,CAAC;AAE/D;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAsB,IAAI,eAAe,EAAE,CAAC;AAE/D;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAAuB,IAAI,gBAAgB,EAAE,CAAC;AAElE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,MAAM,CACpB,MAA8B,EAC9B,MAAgE;IAEhE,OAAO,IAAI,eAAe,iBAAG,MAAM,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC5D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,OAAO,CACrB,eAAiC,EACjC,MAAwE;IAExE,OAAO,IAAI,cAAc,iBAAG,eAAe,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AACpE,CAAC;AAoBD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,QAAQ,CACtB,SAA2B,EAC3B,OAA2C;IAE3C,MAAM,IAAI,mBAAwC,OAAO,EAAE,MAAM,IAAK,OAAO,CAAE,CAAC;IAEhF,OAAO,IAAI,gBAAgB,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,IAAI,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACpE,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,iBAAiB,EAAE,CAAC;YAEvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,IAAI,OAAO,CAAC,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,IAAI,CAAC,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,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;wBACnC,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAED,yCAAyC;YACzC,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7D,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAmB,MAAwB;IACxE,OAAO,IAAI,gBAAgB,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,IAAI,CAAC,6BAA6B,IAAI,mBAAmB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACvG,CAAC;YACD,OAAO,IAAI,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACtE,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CACrB,KAAQ;IAER,OAAO,IAAI,gBAAgB,CAAC;QAC1B,SAAS,EAAE,CAAC,IAAa,EAAE,OAAiB,EAAE,IAAmB,EAAwB,EAAE;YACzF,OAAO,IAAI,KAAK,KAAK;gBACnB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,IAAI,CAAC,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,MAAM,UAAU,WAAW,CAMzB,MAA4E;IAE5E,OAAO,IAAI,oBAAoB,CAAgC,MAAM,CAAC,CAAC;AACzE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,KAAK,CACnB,UAAmC,EACnC,MAAmE;IAEnE,OAAO,IAAI,cAAc,iCAAa,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,KAAE,UAAU,IAAG,CAAC;AACtE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,GAAG,CACjB,WAAmB,EACnB,KAAkC,EAClC,MAAkF;IAElF,OAAO,IAAI,kBAAkB,iBAAG,WAAW,EAAE,KAAK,IAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,EAAG,CAAC;AAC3E,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CAAkB,SAA+B;IACtE,OAAO,IAAI,gBAAgB,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"]}