@amritk/generate-validators 0.16.0 → 0.17.0

package/dist/generators/folds-to-constant.js

@@ -1,4 +1,5 @@
 import { isSchemaObject } from "@amritk/helpers/schema-guards";
+import { enforcesFormat, NO_FORMATS } from "./enforced-keywords.js";
 const ANNOTATION_KEYWORDS = /* @__PURE__ */ new Set([
   "$anchor",
   "$comment",
@@ -25,14 +26,17 @@ const ANNOTATION_KEYWORDS = /* @__PURE__ */ new Set([
   "writeOnly",
   "xml"
 ]);
-const foldsToConstant = (schema) => {
+const foldsToConstant = (schema, formats = NO_FORMATS) => {
   if (schema === true)
     return true;
   if (schema === false)
     return false;
   if (!isSchemaObject(schema))
     return void 0;
-  return Object.keys(schema).every((key) => ANNOTATION_KEYWORDS.has(key)) ? true : void 0;
+  const record = schema;
+  if (enforcesFormat(record, formats))
+    return void 0;
+  return Object.keys(record).every((key) => ANNOTATION_KEYWORDS.has(key)) ? true : void 0;
 };
 export {
   foldsToConstant

package/dist/generators/generate-files.d.ts

@@ -24,6 +24,13 @@ type GenerateValidatorFileOptions = {
      * {@link UnknownKeysStrategy} for the trade-off between the two.
      */
     readonly unknownKeys?: UnknownKeysStrategy;
+    /**
+     * The `format` names this build enforces. Empty (the default) leaves `format`
+     * an annotation, as 2020-12 reads it; a name here makes the generated
+     * `validateX` and `isX` both check it, against a `formats.ts` emitted
+     * alongside.
+     */
+    readonly formats?: ReadonlySet<string>;
 };
 /**
  * Generates a complete TypeScript validator file from a JSON Schema.

package/dist/generators/generate-files.js

@@ -1,6 +1,8 @@
 import { generateTypeDefinition } from "@amritk/helpers/generate-type-definition";
 import { DEFAULT_UNKNOWN_KEYS } from "@amritk/helpers/unknown-keys-strategy";
 import { collectValidatorImports } from "./collect-validator-imports.js";
+import { formatCheckName } from "./emit-format-checks.js";
+import { NO_FORMATS } from "./enforced-keywords.js";
 import { generateBooleanGuard, generateValidatorFunction } from "./generate-validator-function.js";
 const escapeForWordMatch = (name) => name.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 const generateValidatorFile = (schema, typeName, options) => {
@@ -10,8 +12,9 @@ const generateValidatorFile = (schema, typeName, options) => {
     ...options?.rootSchema !== void 0 ? { rootSchema: options.rootSchema } : {}
   });
   const unknownKeys = options?.unknownKeys ?? DEFAULT_UNKNOWN_KEYS;
-  const validatorFunction = generateValidatorFunction(schema, typeName, typeSuffix, options?.rootSchema, unknownKeys);
-  const booleanGuard = generateBooleanGuard(schema, typeName, typeSuffix, unknownKeys);
+  const formats = options?.formats ?? NO_FORMATS;
+  const validatorFunction = generateValidatorFunction(schema, typeName, typeSuffix, options?.rootSchema, unknownKeys, formats);
+  const booleanGuard = generateBooleanGuard(schema, typeName, typeSuffix, unknownKeys, formats);
   const body = validatorFunction + booleanGuard;
   const emitted = typeDefinition + body;
   const mentions = (name) => new RegExp(`\\b${escapeForWordMatch(name)}\\b`).test(emitted);
@@ -30,6 +33,11 @@ const generateValidatorFile = (schema, typeName, options) => {
   const runtimeHelpers = ["valuesEqual", "allUnique", "escapePointer", "everyItem"].filter((name) => body.includes(`${name}(`));
   if (runtimeHelpers.length > 0) {
     result += `import { ${runtimeHelpers.join(", ")} } from './validation-result.js'
+`;
+  }
+  const formatChecks = [...formats].map(formatCheckName).filter((name) => body.includes(`${name}(`)).sort();
+  if (formatChecks.length > 0) {
+    result += `import { ${formatChecks.join(", ")} } from './formats.js'
 `;
   }
   for (const imp of refImports) {

package/dist/generators/generate-validator-function.d.ts

@@ -16,7 +16,7 @@ import type { JSONSchema } from 'json-schema-typed/draft-2020-12';
  * `unknownKeys` picks how a closed object's no-extras test counts keys — see
  * {@link UnknownKeysStrategy}.
  */
-export declare const generateBooleanGuard: (schema: JSONSchema, typeName: string, _suffix?: string, unknownKeys?: UnknownKeysStrategy) => string;
+export declare const generateBooleanGuard: (schema: JSONSchema, typeName: string, _suffix?: string, unknownKeys?: UnknownKeysStrategy, formats?: ReadonlySet<string>) => string;
 /**
  * Generates a TypeScript validator function from a JSON Schema.
  *
@@ -39,4 +39,4 @@ export declare const generateBooleanGuard: (schema: JSONSchema, typeName: string
  * // }
  * ```
  */
-export declare const generateValidatorFunction: (schema: JSONSchema, typeName: string, suffix?: string, rootSchema?: Record<string, unknown>, unknownKeys?: UnknownKeysStrategy) => string;
+export declare const generateValidatorFunction: (schema: JSONSchema, typeName: string, suffix?: string, rootSchema?: Record<string, unknown>, unknownKeys?: UnknownKeysStrategy, formats?: ReadonlySet<string>) => string;