@amazon/vinyl-validation 1.2.0 → 2.0.4

package/dist/index.js

@@ -19,15 +19,6 @@ var __spreadValues = (a, b) => {
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 
-// src/validation/validators.ts
-import {
-  stringifyForPrint as stringifyForPrint2,
-  substitute as substitute12
-} from "@amazon/vinyl-util";
-
-// src/validation/ArraySchema.ts
-import { substitute as substitute4 } from "@amazon/vinyl-util";
-
 // src/validation/andValidators.ts
 import { substitute as substitute2 } from "@amazon/vinyl-util";
 
@@ -51,9 +42,10 @@ function createValidationExpectationMessage(expectationMessage, input, path, inp
     path: path.join(".")
   });
 }
-function createValidator(expectationMessage, isValid, inputStringify = (input) => stringifyForPrint(input, 500)) {
+function createValidator(expectationMessage, isValid, inputStringify = (input) => stringifyForPrint(input, 500), jsonSchema) {
   return {
     description: expectationMessage,
+    jsonSchema,
     isValid(input) {
       return isValid(input);
     },
@@ -89,9 +81,10 @@ function createValidator(expectationMessage, isValid, inputStringify = (input) =
     }
   };
 }
-function createDeepValidator(description, validate) {
+function createDeepValidator(description, validate, jsonSchema) {
   return {
     description,
+    jsonSchema,
     isValid(input) {
       return validate(input, { all: false }, []).length === 0;
     },
@@ -108,6 +101,39 @@ function createDeepValidator(description, validate) {
   };
 }
 
+// src/validation/JsonSchema.ts
+import { ownKeys } from "@amazon/vinyl-util";
+function mergeJsonSchema(...fragments) {
+  var _a;
+  const merged = {};
+  for (const fragment of fragments) {
+    if (fragment == null) continue;
+    for (const key of ownKeys(fragment)) {
+      if (fragment[key] === void 0) continue;
+      if (key === "properties") {
+        merged.properties = __spreadValues(__spreadValues({}, merged.properties), fragment.properties);
+      } else if (key === "required") {
+        merged.required = [
+          .../* @__PURE__ */ new Set([
+            ...(_a = merged.required) != null ? _a : [],
+            ...fragment.required
+          ])
+        ];
+      } else {
+        merged[key] = fragment[key];
+      }
+    }
+  }
+  return merged;
+}
+function toJsonSchema(source) {
+  const provider = source;
+  if (typeof provider.toJsonSchema === "function") {
+    return provider.toJsonSchema();
+  }
+  return __spreadValues({}, source.jsonSchema);
+}
+
 // src/validation/andValidators.ts
 var locale = {
   /**
@@ -134,10 +160,14 @@ function andValidators(...validators) {
         if (errors.length) return errors;
       }
       return [];
-    }
+    },
+    mergeJsonSchema(...validators.map((v) => v.jsonSchema))
   );
 }
 
+// src/validation/ArraySchema.ts
+import { substitute as substitute4 } from "@amazon/vinyl-util";
+
 // src/validation/orValidators.ts
 import { substitute as substitute3 } from "@amazon/vinyl-util";
 var locale2 = {
@@ -150,36 +180,46 @@ var locale2 = {
    */
   separator: " | "
 };
+function unionJsonSchema(validators) {
+  const branches = validators.map((v) => v.jsonSchema).filter((fragment) => fragment != null);
+  if (branches.length === 0) return void 0;
+  if (branches.length === 1) return branches[0];
+  return { anyOf: branches };
+}
 function orValidators(...validators) {
   const description = substitute3(locale2.template, {
     value: validators.map((v) => v.description).join(locale2.separator)
   });
-  return createDeepValidator(description, (input, options, path) => {
-    let longestErrors = [];
-    let longestPath = 0;
-    for (const validator of validators) {
-      const errors = validator.validate(input, options, path);
-      if (!errors.length) return errors;
-      const pathLength = errors.reduce(
-        (max, m) => Math.max(m.path.length, max),
-        0
-      );
-      if (pathLength >= longestPath) {
-        longestErrors = errors;
-        longestPath = pathLength;
+  return createDeepValidator(
+    description,
+    (input, options, path) => {
+      let longestErrors = [];
+      let longestPath = 0;
+      for (const validator of validators) {
+        const errors = validator.validate(input, options, path);
+        if (!errors.length) return errors;
+        const pathLength = errors.reduce(
+          (max, m) => Math.max(m.path.length, max),
+          0
+        );
+        if (pathLength >= longestPath) {
+          longestErrors = errors;
+          longestPath = pathLength;
+        }
       }
-    }
-    return longestPath > path.length ? longestErrors : [
-      {
-        message: createValidationExpectationMessage(
-          description,
-          input,
+      return longestPath > path.length ? longestErrors : [
+        {
+          message: createValidationExpectationMessage(
+            description,
+            input,
+            path
+          ),
           path
-        ),
-        path
-      }
-    ];
-  });
+        }
+      ];
+    },
+    unionJsonSchema(validators)
+  );
 }
 
 // src/validation/SchemaBase.ts
@@ -195,6 +235,7 @@ var SchemaBase = class {
     __publicField(this, "__type", /* @__PURE__ */ invariant());
     __publicField(this, "validator");
     __publicField(this, "_options", requiredValidationOptions);
+    __publicField(this, "_jsonSchemaDescription");
     __publicField(this, "assert", (input, origin, path) => {
       this.validator.assert(input, origin, path);
     });
@@ -208,6 +249,39 @@ var SchemaBase = class {
   get description() {
     return this.validator.description;
   }
+  /**
+   * The composed JSON Schema fragment for this schema, including any {@link describe} description.
+   * Composes through chaining the same way {@link description} does; serialize a complete
+   * definition with {@link toJsonSchema}.
+   */
+  get jsonSchema() {
+    const base = this.validator.jsonSchema;
+    if (this._jsonSchemaDescription == null) return base;
+    return mergeJsonSchema(base, {
+      description: this._jsonSchemaDescription
+    });
+  }
+  /**
+   * Attaches a human-readable description to this schema, akin to zod's `describe`.
+   * The description is metadata only; it does not affect validation, and surfaces in the output
+   * of {@link toJsonSchema}.
+   *
+   * @param description The description to attach.
+   * @return A clone of this schema carrying the description.
+   */
+  describe(description) {
+    const cloned = this.clone();
+    cloned._jsonSchemaDescription = description;
+    return cloned;
+  }
+  /**
+   * Serializes this schema to a JSON Schema definition, suitable for describing the shape to an
+   * LLM or other consumer. Works similarly to zod-to-json-schema.
+   */
+  toJsonSchema() {
+    var _a;
+    return (_a = this.jsonSchema) != null ? _a : {};
+  }
   /**
    * Clones this schema, transforming all validators with the given mutator.
    *
@@ -222,6 +296,7 @@ var SchemaBase = class {
       this.operation
     ) : this.self(transform(this.currentValidator));
     cloned._options = this._options;
+    cloned._jsonSchemaDescription = this._jsonSchemaDescription;
     return cloned;
   }
   self(current, previous, operation) {
@@ -271,15 +346,30 @@ var valueValidators = {
   },
   /**
    * Creates a validator that asserts that the input is nullish.
+   * JSON Schema has no representation for `undefined`, so only `null` is expressed.
    */
   nullish() {
-    return createValidator(locale3.nullish, (input) => input == null);
+    return createValidator(
+      locale3.nullish,
+      (input) => input == null,
+      void 0,
+      {
+        type: "null"
+      }
+    );
   },
   /**
    * Creates a validator that asserts that the input is strictly null.
    */
   null() {
-    return createValidator(locale3.null, (input) => input === null);
+    return createValidator(
+      locale3.null,
+      (input) => input === null,
+      void 0,
+      {
+        type: "null"
+      }
+    );
   },
   /**
    * Creates a validator that asserts that the input is strictly undefined.
@@ -354,7 +444,9 @@ var arrayValidators = {
   isArray() {
     return createValidator(
       locale4.array,
-      (input) => Array.isArray(input)
+      (input) => Array.isArray(input),
+      void 0,
+      { type: "array" }
     );
   },
   /**
@@ -381,7 +473,8 @@ var arrayValidators = {
           if (!options.all && errors.length) return errors;
         }
         return errors;
-      }
+      },
+      { type: "array", items: toJsonSchema(elementValidator) }
     );
   },
   /**
@@ -419,6 +512,13 @@ var arrayValidators = {
           if (!options.all && errors.length) return errors;
         }
         return errors;
+      },
+      {
+        type: "array",
+        items: validators.map((v) => toJsonSchema(v)),
+        minItems: validators.length,
+        maxItems: validators.length,
+        additionalItems: false
       }
     );
   },
@@ -430,7 +530,8 @@ var arrayValidators = {
     return createValidator(
       substitute4(locale4.minLength, { value: min }),
       (input) => input.length >= min,
-      (input) => substitute4(locale4.actualLength, { value: input.length })
+      (input) => substitute4(locale4.actualLength, { value: input.length }),
+      { minItems: min }
     );
   },
   /**
@@ -442,7 +543,8 @@ var arrayValidators = {
     return createValidator(
       substitute4(locale4.maxLength, { value: max }),
       (input) => input.length <= max,
-      (input) => substitute4(locale4.actualLength, { value: input.length })
+      (input) => substitute4(locale4.actualLength, { value: input.length }),
+      { maxItems: max }
     );
   }
 };
@@ -512,12 +614,22 @@ import { substitute as substitute5 } from "@amazon/vinyl-util";
 var locale5 = {
   template: "type {value}"
 };
+var jsonSchemaTypeByTypeof = {
+  string: "string",
+  number: "number",
+  boolean: "boolean",
+  object: "object"
+};
 function typeOfValidator(expected) {
+  const jsonType = jsonSchemaTypeByTypeof[expected];
+  const jsonSchema = jsonType == null ? void 0 : { type: jsonType };
   return createValidator(
     substitute5(locale5.template, { value: expected }),
     (input) => {
       return input != null && typeof input === expected;
-    }
+    },
+    void 0,
+    jsonSchema
   );
 }
 var typeOfValidatorCache = {};
@@ -586,88 +698,9 @@ var _FunctionSchema = class _FunctionSchema extends ValueSchema {
 __publicField(_FunctionSchema, "_base", null);
 var FunctionSchema = _FunctionSchema;
 
-// src/validation/SetSchema.ts
+// src/validation/NumberSchema.ts
 import { substitute as substitute7 } from "@amazon/vinyl-util";
 var locale7 = {
-  set: "Set",
-  withElements: "Set<{value}>"
-};
-var setValidators = {
-  /**
-   * Creates a validator that asserts that the input is a set.
-   */
-  isSet() {
-    return createValidator(
-      locale7.set,
-      (input) => input instanceof Set
-    );
-  },
-  /**
-   * Creates a validator that asserts that every element passes the given validator.
-   *
-   * @param elementValidator
-   */
-  withElements(elementValidator) {
-    return createDeepValidator(
-      substitute7(locale7.withElements, {
-        value: elementValidator.description
-      }),
-      (input, options, path) => {
-        const errors = [];
-        let i = 0;
-        for (const element of input) {
-          errors.push(
-            ...elementValidator.validate(
-              element,
-              options,
-              path.concat(i.toString())
-            )
-          );
-          if (!options.all && errors.length) return errors;
-          i++;
-        }
-        return errors;
-      }
-    );
-  }
-};
-var _SetSchema = class _SetSchema extends ValueSchema {
-  /**
-   * The base SetSchema instance validating that the input is a Set.
-   */
-  static get base() {
-    if (this._base == null)
-      this._base = new _SetSchema(setValidators.isSet());
-    return this._base;
-  }
-  /**
-   * Creates a validator that asserts that every element passes the given validator.
-   *
-   * @param elementValidator
-   */
-  withElements(elementValidator) {
-    return this.chain(setValidators.withElements(elementValidator));
-  }
-  /**
-   * Casts to a readonly set.
-   * This is a shallow cast, elements of the array will not be changed.
-   */
-  readonly() {
-    return this;
-  }
-  /**
-   * Casts the parameter type.
-   */
-  cast() {
-    return this;
-  }
-};
-__publicField(_SetSchema, "_base", null);
-var SetSchema = _SetSchema;
-
-// src/validation/NumberSchema.ts
-import { substitute as substitute8 } from "@amazon/vinyl-util";
-var locale8 = {
   gte: "at least {value}",
   gt: "greater than {value}",
   lte: "at most {value}",
@@ -685,8 +718,10 @@ var numberValidators = {
    */
   gte(min) {
     return createValidator(
-      substitute8(locale8.gte, { value: min }),
-      (input) => input >= min
+      substitute7(locale7.gte, { value: min }),
+      (input) => input >= min,
+      void 0,
+      { minimum: min }
     );
   },
   /**
@@ -697,8 +732,10 @@ var numberValidators = {
    */
   gt(min) {
     return createValidator(
-      substitute8(locale8.gt, { value: min }),
-      (input) => input > min
+      substitute7(locale7.gt, { value: min }),
+      (input) => input > min,
+      void 0,
+      { exclusiveMinimum: min }
     );
   },
   /**
@@ -709,8 +746,10 @@ var numberValidators = {
    */
   lte(max) {
     return createValidator(
-      substitute8(locale8.lte, { value: max }),
-      (input) => input <= max
+      substitute7(locale7.lte, { value: max }),
+      (input) => input <= max,
+      void 0,
+      { maximum: max }
     );
   },
   /**
@@ -721,8 +760,10 @@ var numberValidators = {
    */
   lt(max) {
     return createValidator(
-      substitute8(locale8.lt, { value: max }),
-      (input) => input < max
+      substitute7(locale7.lt, { value: max }),
+      (input) => input < max,
+      void 0,
+      { exclusiveMaximum: max }
     );
   },
   /**
@@ -734,23 +775,27 @@ var numberValidators = {
    */
   within(min, max) {
     return createValidator(
-      substitute8(locale8.within, { min, max }),
-      (input) => input >= min && input <= max
+      substitute7(locale7.within, { min, max }),
+      (input) => input >= min && input <= max,
+      void 0,
+      { minimum: min, maximum: max }
     );
   },
   /**
    * Creates a validator that asserts that the input number is finite.
    */
   finite() {
-    return createValidator(locale8.finite, (input) => Number.isFinite(input));
+    return createValidator(locale7.finite, (input) => Number.isFinite(input));
   },
   /**
    * Creates a validator that asserts that the input number is a safe integer.
    */
   safeInteger() {
     return createValidator(
-      locale8.safeInteger,
-      (input) => Number.isSafeInteger(input)
+      locale7.safeInteger,
+      (input) => Number.isSafeInteger(input),
+      void 0,
+      { type: "integer" }
     );
   }
 };
@@ -826,7 +871,7 @@ __publicField(_NumberSchema, "_base", null);
 var NumberSchema = _NumberSchema;
 
 // src/validation/ObjectSchema.ts
-import { merge, ownKeys, substitute as substitute9 } from "@amazon/vinyl-util";
+import { merge, ownKeys as ownKeys2, substitute as substitute8 } from "@amazon/vinyl-util";
 
 // src/validation/ValidatorWithPartial.ts
 function isValidatorWithPartial(validator) {
@@ -840,7 +885,7 @@ function maybeToPartial(validator) {
 }
 
 // src/validation/ObjectSchema.ts
-var locale9 = {
+var locale8 = {
   extend: "{\n{body}\n}",
   prop: "{key}: {value}",
   propSeparator: ",\n",
@@ -856,19 +901,27 @@ var objectValidators = {
    */
   properties(propertyValidators) {
     const propertiesDescriptions = [];
-    const keys = ownKeys(propertyValidators);
+    const keys = ownKeys2(propertyValidators);
+    const jsonProperties = {};
+    const requiredKeys = [];
     for (const key of keys) {
       const validator2 = propertyValidators[key];
       propertiesDescriptions.push(
-        substitute9(locale9.prop, {
+        substitute8(locale8.prop, {
           key: String(key) + (validator2.options.optional ? "?" : ""),
           value: validator2.description
         })
       );
+      jsonProperties[String(key)] = toJsonSchema(validator2);
+      if (!validator2.options.optional) requiredKeys.push(String(key));
     }
-    const description = substitute9(locale9.extend, {
-      body: propertiesDescriptions.join(locale9.propSeparator).split("\n").map((line) => locale9.indent + line).join("\n")
+    const description = substitute8(locale8.extend, {
+      body: propertiesDescriptions.join(locale8.propSeparator).split("\n").map((line) => locale8.indent + line).join("\n")
     });
+    const jsonSchema = __spreadValues({
+      type: "object",
+      properties: jsonProperties
+    }, requiredKeys.length ? { required: requiredKeys } : {});
     const validator = createDeepValidator(
       description,
       (input, options, path) => {
@@ -887,7 +940,7 @@ var objectValidators = {
           } else {
             if (!validator2.options.optional) {
               errors.push({
-                message: substitute9(locale9.required, { key }),
+                message: substitute8(locale8.required, { key }),
                 path: path.concat(String(key))
               });
             }
@@ -895,7 +948,8 @@ var objectValidators = {
           if (!options.all && errors.length) return errors;
         }
         return errors;
-      }
+      },
+      jsonSchema
     );
     return merge(validator, {
       partial() {
@@ -962,11 +1016,11 @@ __publicField(_ObjectSchema, "_base", null);
 var ObjectSchema = _ObjectSchema;
 
 // src/validation/RecordSchema.ts
-import { ownKeys as ownKeys2, substitute as substitute11 } from "@amazon/vinyl-util";
+import { ownKeys as ownKeys3, substitute as substitute10 } from "@amazon/vinyl-util";
 
 // src/validation/StringSchema.ts
-import { substitute as substitute10 } from "@amazon/vinyl-util";
-var locale10 = {
+import { substitute as substitute9 } from "@amazon/vinyl-util";
+var locale9 = {
   notEmpty: "not empty",
   minLength: "at least {value} characters",
   maxLength: "at most {value} characters",
@@ -978,7 +1032,12 @@ var stringValidators = {
    * Creates a validator that asserts that the input is not empty.
    */
   notEmpty() {
-    return createValidator(locale10.notEmpty, (input) => input !== "");
+    return createValidator(
+      locale9.notEmpty,
+      (input) => input !== "",
+      void 0,
+      { minLength: 1 }
+    );
   },
   /**
    * Creates a validator that asserts that the input string has at least the given minimum
@@ -988,8 +1047,10 @@ var stringValidators = {
    */
   minLength(min) {
     return createValidator(
-      substitute10(locale10.minLength, { value: min }),
-      (input) => input.length >= min
+      substitute9(locale9.minLength, { value: min }),
+      (input) => input.length >= min,
+      void 0,
+      { minLength: min }
     );
   },
   /**
@@ -1000,8 +1061,10 @@ var stringValidators = {
    */
   maxLength(max) {
     return createValidator(
-      substitute10(locale10.maxLength, { value: max }),
-      (input) => input.length <= max
+      substitute9(locale9.maxLength, { value: max }),
+      (input) => input.length <= max,
+      void 0,
+      { maxLength: max }
     );
   },
   /**
@@ -1010,7 +1073,7 @@ var stringValidators = {
    */
   noWhitespace() {
     return createValidator(
-      locale10.noWhitespace,
+      locale9.noWhitespace,
       (input) => input.search(/\s/g) === -1
     );
   },
@@ -1020,10 +1083,12 @@ var stringValidators = {
    */
   matches(regex) {
     return createValidator(
-      substitute10(locale10.matches, { value: regex.toString() }),
+      substitute9(locale9.matches, { value: regex.toString() }),
       (input) => {
         return regex.test(input);
-      }
+      },
+      void 0,
+      { pattern: regex.source }
     );
   }
 };
@@ -1079,7 +1144,7 @@ __publicField(_StringSchema, "_base", null);
 var StringSchema = _StringSchema;
 
 // src/validation/RecordSchema.ts
-var locale11 = {
+var locale10 = {
   record: "{ [key: {key}]: {value} }"
 };
 var recordValidators = {
@@ -1096,13 +1161,13 @@ var recordValidators = {
    */
   record(keyValidator, valueValidator) {
     return createDeepValidator(
-      substitute11(locale11.record, {
+      substitute10(locale10.record, {
         key: keyValidator.description,
         value: valueValidator.description
       }),
       (input, options, path) => {
         const errors = [];
-        for (const key of ownKeys2(input)) {
+        for (const key of ownKeys3(input)) {
           const keyStr = String(key);
           errors.push(
             ...keyValidator.validate(
@@ -1123,6 +1188,10 @@ var recordValidators = {
           if (!options.all && errors.length) return errors;
         }
         return errors;
+      },
+      {
+        type: "object",
+        additionalProperties: toJsonSchema(valueValidator)
       }
     );
   }
@@ -1180,7 +1249,97 @@ var _RecordSchema = class _RecordSchema extends ValueSchema {
 __publicField(_RecordSchema, "_base", null);
 var RecordSchema = _RecordSchema;
 
+// src/validation/SetSchema.ts
+import { substitute as substitute11 } from "@amazon/vinyl-util";
+var locale11 = {
+  set: "Set",
+  withElements: "Set<{value}>"
+};
+var setValidators = {
+  /**
+   * Creates a validator that asserts that the input is a set.
+   */
+  isSet() {
+    return createValidator(
+      locale11.set,
+      (input) => input instanceof Set,
+      void 0,
+      { type: "array", uniqueItems: true }
+    );
+  },
+  /**
+   * Creates a validator that asserts that every element passes the given validator.
+   *
+   * @param elementValidator
+   */
+  withElements(elementValidator) {
+    return createDeepValidator(
+      substitute11(locale11.withElements, {
+        value: elementValidator.description
+      }),
+      (input, options, path) => {
+        const errors = [];
+        let i = 0;
+        for (const element of input) {
+          errors.push(
+            ...elementValidator.validate(
+              element,
+              options,
+              path.concat(i.toString())
+            )
+          );
+          if (!options.all && errors.length) return errors;
+          i++;
+        }
+        return errors;
+      },
+      {
+        type: "array",
+        uniqueItems: true,
+        items: toJsonSchema(elementValidator)
+      }
+    );
+  }
+};
+var _SetSchema = class _SetSchema extends ValueSchema {
+  /**
+   * The base SetSchema instance validating that the input is a Set.
+   */
+  static get base() {
+    if (this._base == null)
+      this._base = new _SetSchema(setValidators.isSet());
+    return this._base;
+  }
+  /**
+   * Creates a validator that asserts that every element passes the given validator.
+   *
+   * @param elementValidator
+   */
+  withElements(elementValidator) {
+    return this.chain(setValidators.withElements(elementValidator));
+  }
+  /**
+   * Casts to a readonly set.
+   * This is a shallow cast, elements of the array will not be changed.
+   */
+  readonly() {
+    return this;
+  }
+  /**
+   * Casts the parameter type.
+   */
+  cast() {
+    return this;
+  }
+};
+__publicField(_SetSchema, "_base", null);
+var SetSchema = _SetSchema;
+
 // src/validation/validators.ts
+import {
+  stringifyForPrint as stringifyForPrint2,
+  substitute as substitute12
+} from "@amazon/vinyl-util";
 var locale12 = {
   isOneOf: "one of: {value}",
   instanceOf: "instance of {value}",
@@ -1213,7 +1372,9 @@ function isOneOf(...possibleValues) {
       substitute12(locale12.isOneOf, {
         value: possibleValues.join(locale12.oneOfSeparator)
       }),
-      (input) => possibleValues.includes(input)
+      (input) => possibleValues.includes(input),
+      void 0,
+      { enum: [...possibleValues] }
     )
   );
 }
@@ -1287,6 +1448,7 @@ export {
   isValidatorWithPartial,
   maybeToDeepPartial,
   maybeToPartial,
+  mergeJsonSchema,
   nullish,
   number,
   numberValidators,
@@ -1301,6 +1463,7 @@ export {
   string,
   stringValidators,
   symbol,
+  toJsonSchema,
   tuple,
   typeOfValidators,
   valueValidators