@amritk/generate-examples 0.6.3 → 0.7.0

package/dist/generators/schema-validation.js

@@ -16,23 +16,47 @@ const FILTER_KEYWORDS = /* @__PURE__ */ new Set([
   "maxProperties",
   "contains"
 ]);
-const SKIP_RECURSE = /* @__PURE__ */ new Set(["enum", "const", "examples", "default", "$ref", "required", "$defs", "definitions"]);
+const SCHEMA_MAPS = /* @__PURE__ */ new Set([
+  "properties",
+  "patternProperties",
+  "$defs",
+  "definitions",
+  "dependentSchemas",
+  "dependencies"
+]);
+const SKIP_RECURSE = /* @__PURE__ */ new Set([
+  // The data keywords, matching `@amritk/helpers`' `DATA_KEYWORDS` —
+  // `example` is OpenAPI 3.0's singular spelling and belongs with `examples`.
+  "enum",
+  "const",
+  "examples",
+  "example",
+  "default",
+  // Plus this walker's own additions, which are not data but are equally not
+  // applied here.
+  "$ref",
+  "required",
+  "$defs",
+  "definitions"
+]);
 const filterAnswers = /* @__PURE__ */ new WeakMap();
 const needsValidationFilter = (schema) => {
-  const walk = (node) => {
+  const walk = (node, inSchemaMap = false) => {
     if (Array.isArray(node))
-      return node.some(walk);
+      return node.some((item) => walk(item, inSchemaMap));
     if (node === null || typeof node !== "object")
       return false;
     const obj = node;
-    for (const key of Object.keys(obj)) {
-      if (FILTER_KEYWORDS.has(key))
-        return true;
+    if (!inSchemaMap) {
+      for (const key of Object.keys(obj)) {
+        if (FILTER_KEYWORDS.has(key))
+          return true;
+      }
     }
-    for (const [key, value] of Object.entries(obj)) {
-      if (SKIP_RECURSE.has(key))
+    for (const key of Object.keys(obj)) {
+      if (!inSchemaMap && SKIP_RECURSE.has(key))
         continue;
-      if (walk(value))
+      if (walk(obj[key], !inSchemaMap && SCHEMA_MAPS.has(key)))
         return true;
     }
     return false;
@@ -138,6 +162,7 @@ const spliceDefs = (schema, rootSchema) => {
 };
 const WARNING_SCHEMA_LIMIT = 240;
 const reportedGuardFailures = /* @__PURE__ */ new Set();
+const MAX_REPORTED_GUARD_FAILURES = 1e3;
 const describeSchema = (schema) => {
   const serialized = (() => {
     try {
@@ -155,6 +180,8 @@ const warnUndecidableSchema = (schema, reason) => {
 ${described}`;
   if (reportedGuardFailures.has(key))
     return;
+  if (reportedGuardFailures.size >= MAX_REPORTED_GUARD_FAILURES)
+    reportedGuardFailures.clear();
   reportedGuardFailures.add(key);
   console.warn(`Warning: cannot validate generated values against ${described} \u2014 ${message}. Every candidate value is accepted for this subschema, so constraints only the validator enforces (\`oneOf\`, \`not\`, \`pattern\`, \`if\`/\`then\`, \u2026) go unchecked there and the emitted example may not satisfy its own schema. Generation continues regardless; the usual causes are a \`$ref\` pointing outside this fragment and a \`pattern\` the ReDoS screen rejects.`);
 };
@@ -166,6 +193,39 @@ const tryGuard = (schema, checkFormats) => {
     return void 0;
   }
 };
+const everyPatternCompiles = (node) => {
+  if (node === null || typeof node !== "object")
+    return true;
+  if (Array.isArray(node))
+    return node.every(everyPatternCompiles);
+  const compiles = (source) => {
+    try {
+      new RegExp(source);
+      return true;
+    } catch {
+      return false;
+    }
+  };
+  for (const [key, value] of Object.entries(node)) {
+    if (key === "pattern" && typeof value === "string" && !compiles(value))
+      return false;
+    if (key === "patternProperties" && value !== null && typeof value === "object") {
+      if (!Object.keys(value).every(compiles))
+        return false;
+    }
+    if (!everyPatternCompiles(value))
+      return false;
+  }
+  return true;
+};
+const canBuildGuard = (schema, rootSchema) => {
+  const resolved = withResolvableDefs(schema, rootSchema);
+  if (!everyPatternCompiles(resolved)) {
+    warnUndecidableSchema(resolved, "the schema carries a `pattern` that is not a valid regular expression");
+    return false;
+  }
+  return tryGuard(resolved, false) !== void 0;
+};
 const makeInstanceCheck = (schema, rootSchema, options) => {
   const resolved = withResolvableDefs(schema, rootSchema);
   const guard = tryGuard(resolved, options?.checkFormats === true);
@@ -181,6 +241,7 @@ const makeInstanceCheck = (schema, rootSchema, options) => {
   };
 };
 export {
+  canBuildGuard,
   makeInstanceCheck,
   needsValidationFilter,
   withResolvableDefs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amritk/generate-examples",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "description": "Generate fast-check arbitraries and example values from JSON Schemas.",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -55,8 +55,8 @@
   },
   "dependencies": {
     "json-schema-typed": "^8.0.1",
-    "@amritk/helpers": "^0.15.3",
-    "@amritk/runtime-validators": "^0.10.1"
+    "@amritk/helpers": "^0.16.0",
+    "@amritk/runtime-validators": "^0.12.0"
   },
   "devDependencies": {
     "ajv": "^8.17.1"