ata-validator 1.33.2 → 1.34.0

package/compat.d.ts

@@ -36,14 +36,25 @@ declare class Ata {
 }
 
 declare namespace Ata {
-  interface ErrorObject {
+  /** The same class under the name ajv 8 exports it by: `import { Ajv } from 'ata-validator/compat'`. */
+  const Ajv: typeof Ata;
+  type Ajv = Ata;
+  // Generic the way the reference's ErrorObject is, so code that names
+  // `ErrorObject<string, Record<string, any>, unknown>` compiles against this
+  // entry unchanged, and an error from here passes where one from the
+  // reference is expected.
+  interface ErrorObject<K extends string = string, P = Record<string, any>, S = unknown> {
     instancePath: string;
     schemaPath: string;
-    keyword: string;
-    params: Record<string, unknown>;
+    keyword: K;
+    params: P;
     message: string;
     /** Present when `verbose: true`. */
-    parentSchema?: unknown;
+    schema?: S;
+    /** Present when `verbose: true`. */
+    parentSchema?: Record<string, any>;
+    /** Present when `verbose: true`. */
+    data?: unknown;
     /** Present on errors produced under `propertyNames`. */
     propertyName?: string;
     [extra: string]: unknown;

package/compat.js

@@ -432,3 +432,4 @@ Ata.attachDataFrames = function attachDataFrames(errors, text) {
 module.exports = Ata;
 module.exports.default = Ata;
 module.exports.Ata = Ata;
+module.exports.Ajv = Ata;

package/compat.mjs

@@ -1,3 +1,5 @@
 import Ata from './compat.js';
-export { Ata };
+// `Ajv` as well, so the named import ajv 8 documents,
+// `import { Ajv } from 'ajv'`, changes only in the module name.
+export { Ata, Ata as Ajv };
 export default Ata;

package/index.d.ts

@@ -564,7 +564,22 @@ export interface ValidatorConstructor {
 /** Compile a schema into a reusable validator. */
 export const Validator: ValidatorConstructor;
 
-/** One-shot validate: creates a Validator, validates data, returns result. */
+/**
+ * One-shot validate: validates data against a schema or an existing
+ * {@link Validator} and returns the result. A schema written with
+ * {@link defineSchema} (or as a `const` literal) types `data` from the schema
+ * itself. The last form takes the type as an argument for a schema TypeScript
+ * cannot see into, such as one read from a file; that type is an assertion,
+ * not something the schema is checked against.
+ */
+export function validate<T>(
+  validator: Validator<T>,
+  data: unknown
+): ValidationResult<T>;
+export function validate<const S extends JSONSchema>(
+  schema: S,
+  data: unknown
+): ValidationResult<Infer<S>>;
 export function validate<T = unknown>(
   schema: object | string,
   data: unknown

package/index.js

@@ -2523,13 +2523,16 @@ class Validator {
   }
 }
 
+// One-shot validate. It goes through a Validator like every other entry
+// point, so the result has one shape everywhere: `data` on success, errors
+// with a code, a keyword and an instancePath. From the first native binding
+// until 1.33.3 it handed the schema straight to the native engine whenever
+// the addon was loaded, which is every default install on a supported
+// platform, and returned that engine's raw result: numeric codes, `path`
+// instead of `instancePath`, no keyword, and no `data`. The compile cache keeps
+// a schema passed again from compiling again.
 function validate(schema, data) {
-  if (native) {
-    const schemaStr =
-      typeof schema === "string" ? schema : JSON.stringify(schema);
-    return native.validate(schemaStr, data);
-  }
-  // JS fallback: compile and validate
+  if (schema instanceof Validator) return schema.validate(data);
   const v = new Validator(typeof schema === "string" ? JSON.parse(schema) : schema);
   return v.validate(data);
 }

package/lib/compat-errors.js

@@ -369,8 +369,25 @@ function createShaper({ Validator, rootId, rootDoc, schemas, options, allErrors,
     return group.length;
   }
 
+  // A `type` error the way the reference words it. ata folds `nullable: true`
+  // into the type union before compiling, so its own error names the union:
+  // `must be integer, null`. The reference names the type as written, adding
+  // `null` only when the written type is already a list, and joins a list
+  // with a bare comma: `must be integer`, `must be string,number,null`. The
+  // node is read from the schema as the caller passed it.
+  function asReferenceType(e) {
+    if (e.keyword !== 'type' || typeof e.message !== 'string' || !e.message.startsWith('must be ')) return e;
+    const ptr = pointerOf(e.schemaPath || '');
+    if (!ptr.endsWith('/type')) return e;
+    const node = walkPointer(rootDoc, ptr.slice(0, -'/type'.length));
+    let t = node && typeof node === 'object' && node.type !== undefined ? node.type : e.params && e.params.type;
+    if (t === undefined) return e;
+    if (node && node.nullable === true && Array.isArray(t) && !t.includes('null')) t = [...t, 'null'];
+    return { ...e, params: { ...e.params, type: t }, message: 'must be ' + (Array.isArray(t) ? t.join(',') : t) };
+  }
+
   return function shapeErrors(errors, data) {
-    const shaped = shape(errors, data, '').map(asReferenceKeyword);
+    const shaped = shape(errors, data, '').map(asReferenceKeyword).map(asReferenceType);
     if (allErrors) return shaped;
     const n = groupEnd(shaped);
     return shaped.slice(0, n);

package/lib/version.js

@@ -7,4 +7,4 @@
 //
 // Kept in lockstep with package.json by `tests/test_version_sync.js`.
 
-module.exports = '1.33.2';
+module.exports = '1.34.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ata-validator",
-  "version": "1.33.2",
+  "version": "1.34.0",
   "description": "JSON Schema validation that compiles for speed and still runs where code generation is blocked. Compiled and interpreted engines answer identically at 100% of the official suite. TypeScript inference, Standard Schema V1, and a build step that emits dependency-free modules.",
   "main": "index.js",
   "module": "index.mjs",
@@ -51,7 +51,7 @@
     "release:check": "node scripts/regen-safe-regex-source.js && node tests/test_pack_purity.js && node scripts/check-doc-coverage.js && node tests/test_error_codes_lock.js && node tests/test_safe_regex_source_sync.js && node tests/test_version_sync.js",
     "build": "cmake-js build --target ata",
     "rebuild": "cmake-js rebuild --target ata",
-    "test": "node test.js && node tests/test_removed_aot_methods.js && node tests/test_no_native.js && node tests/test_no_eval.js && node tests/test_property_dependencies.js && node tests/test_v1_dialect.js && node tests/test_buffer_path_parity.js && node tests/test_buffer_gate.js && node tests/test_scanner_differential.js && node tests/test_validate_json_scanner_cost.js && node tests/test_buffer_reject_cost.js && node tests/test_nan_verdict.js && node tests/test_remove_additional_nested.js && node tests/test_exclusive_bounds.js && node tests/test_engine_differential.js && node tests/test_error_shape_differential.js && node tests/test_output_format.js && node tests/test_retry_message.js && node tests/test_describe_schema.js && node tests/test_aot_parse.js && node tests/test_draft7_semantics.js && node tests/test_metaschema_ref.js && node tests/test_pure_js_unsupported.js && node tests/test_native_load_order.js && node tests/test_pack_purity.js && node tests/test_make_native_package.js && node tests/test_browser_nofs.js && node tests/test_browser_imports_guard.js && node tests/test_version_sync.js && node tests/test_native_loaded.js && node tests/test_safe_regex_source_sync.js && node tests/test_t_builder.js && node tests/test_async_refine.js && node tests/test_safe_regex.js && node tests/test_safe_regex_integration.js && node tests/test_aot_build.js && node tests/test_aot_differential.js && node tests/test_aot_cli_build.js && node tests/test_aot_cli_smoke.js && node tests/test_bundle_standalone.js && node tests/test_standalone_anyof.js && node tests/test_standalone_formats.js && node tests/test_aot_format_mode.js && node tests/test_aot_additional_props_errors.js && node tests/test_id_anchor_refs.js && node tests/test_engine_routing.js && node tests/test_engine_option.js && node tests/test_compile_cache_order.js && node tests/test_engine_diagnostic.js && node tests/test_format_engine_parity.js && node tests/test_error_accumulator_collision.js && node tests/test_uri_helper_parity.js && node tests/test_uri_fast_path.js && node tests/test_extend_verdict.js && node tests/test_ipv4_regex.js && node tests/test_ipv6_fast_path.js && node tests/test_nested_recursion_decline.js && node tests/test_generator_error_content.js && node tests/test_inherited_key_presence.js && node tests/test_proto_accessor.js && node tests/test_hybrid_tier.js && node tests/test_first_rejection_builds_one.js && node tests/test_container_local.js && node tests/test_fixed_pattern_inline.js && node tests/test_plan_source.js && node tests/test_fused_remove_additional.js && node tests/test_runtime_parse.js && node tests/test_formats_single_pass.js && node tests/test_email_format_cost.js && node tests/test_format_single_error.js && node tests/test_defs_pointer_alias.js && node tests/test_cross_doc_root_ref.js && node tests/test_codegen_entrypoint_agreement.js && node tests/test_hybrid_agreement.js && node tests/test_codegen_edge_shapes.js && node tests/test_deferred_def_scope.js && node tests/test_node_scoped_ctx_flags.js && node tests/test_fast_slot_exhaustion.js && node tests/test_ajv_errors.js && node tests/test_custom_keywords.js && node tests/test_strict_schema.js && node tests/test_aot_external_checks.js && node tests/test_ajv_parity.js && node tests/test_user_format_error_path.js && node tests/test_unevaluated_error_path.js && node tests/test_unevaluated_error_shape.js && node tests/test_pattern_properties_errors.js && node tests/test_additional_properties_scaling.js && node tests/test_additional_props_combined_cost.js && node tests/test_no_input_mutation.js && node tests/test_typed_validator_runner.js && node tests/test_define_schema.js && node tests/test_error_codes_lock.js && node tests/test_error_code_lookup.js && node tests/test_error_order.js && node tests/test_error_order_ordinal.js && node tests/test_rejection_shape.js && node tests/test_lazy_normalization.js && node tests/test_value_equality.js && node tests/test_vocabulary.js && node tests/test_schema_scan.js && node tests/test_lazy_errors.js && node tests/test_single_pass_errors.js && node tests/test_lazy_json_errors.js && node tests/test_lazy_instance.js && node tests/test_cyclic_input.js && node tests/test_native_error_codes.js && node tests/test_verdict_preprocess.js && node tests/test_defaults_own_keys.js && node tests/test_plan_compiler.js && node tests/test_nullable.js && node tests/test_validate_and_parse.js && node tests/test_validate_data.js && node tests/test_enrich_error.js && node tests/test_enrich_received.js && node tests/test_rich_errors_optout.js && node tests/test_error_messages.js && node tests/test_source_positions.js && node tests/fuzz_positions.js && node tests/test_malformed_json_termination.js && node tests/test_data_positions.js && node tests/test_targeted_positions.js && node tests/test_position_map_cost.js && node tests/test_targeted_positions_cost.js && node tests/test_aot_staleness.js && node tests/test_file_positions.js && node tests/test_aot_positions_cost.js && node tests/test_schema_hash.js && node tests/test_render_shared.js && node tests/test_renderers.js && node tests/test_additive_fields.js && node tests/test_diagnostic_source.js && node tests/test_diagnose.js && node tests/test_correlate.js && node tests/test_diagnostics_score.js && node tests/test_runtime_error_dx.js && node tests/test_aot_error_dx.js && node tests/test_abort_early.js && node tests/test_branch_collapse.js && node tests/test_suggestions.js && node tests/test_cli_validate.js && node tests/test_cli_version.js && node benchmark/bench_aot_size.mjs",
+    "test": "node test.js && node tests/test_removed_aot_methods.js && node tests/test_no_native.js && node tests/test_no_eval.js && node tests/test_property_dependencies.js && node tests/test_v1_dialect.js && node tests/test_buffer_path_parity.js && node tests/test_buffer_gate.js && node tests/test_scanner_differential.js && node tests/test_validate_json_scanner_cost.js && node tests/test_buffer_reject_cost.js && node tests/test_nan_verdict.js && node tests/test_remove_additional_nested.js && node tests/test_exclusive_bounds.js && node tests/test_engine_differential.js && node tests/test_error_shape_differential.js && node tests/test_output_format.js && node tests/test_retry_message.js && node tests/test_describe_schema.js && node tests/test_aot_parse.js && node tests/test_draft7_semantics.js && node tests/test_metaschema_ref.js && node tests/test_pure_js_unsupported.js && node tests/test_native_load_order.js && node tests/test_pack_purity.js && node tests/test_make_native_package.js && node tests/test_browser_nofs.js && node tests/test_browser_imports_guard.js && node tests/test_version_sync.js && node tests/test_native_loaded.js && node tests/test_safe_regex_source_sync.js && node tests/test_t_builder.js && node tests/test_async_refine.js && node tests/test_safe_regex.js && node tests/test_safe_regex_integration.js && node tests/test_aot_build.js && node tests/test_aot_differential.js && node tests/test_aot_cli_build.js && node tests/test_aot_cli_smoke.js && node tests/test_bundle_standalone.js && node tests/test_standalone_anyof.js && node tests/test_standalone_formats.js && node tests/test_aot_format_mode.js && node tests/test_aot_additional_props_errors.js && node tests/test_id_anchor_refs.js && node tests/test_engine_routing.js && node tests/test_engine_option.js && node tests/test_compile_cache_order.js && node tests/test_engine_diagnostic.js && node tests/test_format_engine_parity.js && node tests/test_error_accumulator_collision.js && node tests/test_uri_helper_parity.js && node tests/test_uri_fast_path.js && node tests/test_extend_verdict.js && node tests/test_ipv4_regex.js && node tests/test_ipv6_fast_path.js && node tests/test_nested_recursion_decline.js && node tests/test_generator_error_content.js && node tests/test_inherited_key_presence.js && node tests/test_proto_accessor.js && node tests/test_hybrid_tier.js && node tests/test_first_rejection_builds_one.js && node tests/test_container_local.js && node tests/test_one_shot_validate.js && node tests/test_fixed_pattern_inline.js && node tests/test_plan_source.js && node tests/test_fused_remove_additional.js && node tests/test_runtime_parse.js && node tests/test_formats_single_pass.js && node tests/test_email_format_cost.js && node tests/test_format_single_error.js && node tests/test_defs_pointer_alias.js && node tests/test_cross_doc_root_ref.js && node tests/test_codegen_entrypoint_agreement.js && node tests/test_hybrid_agreement.js && node tests/test_codegen_edge_shapes.js && node tests/test_deferred_def_scope.js && node tests/test_node_scoped_ctx_flags.js && node tests/test_fast_slot_exhaustion.js && node tests/test_ajv_errors.js && node tests/test_custom_keywords.js && node tests/test_strict_schema.js && node tests/test_aot_external_checks.js && node tests/test_ajv_parity.js && node tests/test_user_format_error_path.js && node tests/test_unevaluated_error_path.js && node tests/test_unevaluated_error_shape.js && node tests/test_pattern_properties_errors.js && node tests/test_additional_properties_scaling.js && node tests/test_additional_props_combined_cost.js && node tests/test_no_input_mutation.js && node tests/test_typed_validator_runner.js && node tests/test_define_schema.js && node tests/test_error_codes_lock.js && node tests/test_error_code_lookup.js && node tests/test_error_order.js && node tests/test_error_order_ordinal.js && node tests/test_rejection_shape.js && node tests/test_lazy_normalization.js && node tests/test_value_equality.js && node tests/test_vocabulary.js && node tests/test_schema_scan.js && node tests/test_lazy_errors.js && node tests/test_single_pass_errors.js && node tests/test_lazy_json_errors.js && node tests/test_lazy_instance.js && node tests/test_cyclic_input.js && node tests/test_native_error_codes.js && node tests/test_verdict_preprocess.js && node tests/test_defaults_own_keys.js && node tests/test_plan_compiler.js && node tests/test_nullable.js && node tests/test_validate_and_parse.js && node tests/test_validate_data.js && node tests/test_enrich_error.js && node tests/test_enrich_received.js && node tests/test_rich_errors_optout.js && node tests/test_error_messages.js && node tests/test_source_positions.js && node tests/fuzz_positions.js && node tests/test_malformed_json_termination.js && node tests/test_data_positions.js && node tests/test_targeted_positions.js && node tests/test_position_map_cost.js && node tests/test_targeted_positions_cost.js && node tests/test_aot_staleness.js && node tests/test_file_positions.js && node tests/test_aot_positions_cost.js && node tests/test_schema_hash.js && node tests/test_render_shared.js && node tests/test_renderers.js && node tests/test_additive_fields.js && node tests/test_diagnostic_source.js && node tests/test_diagnose.js && node tests/test_correlate.js && node tests/test_diagnostics_score.js && node tests/test_runtime_error_dx.js && node tests/test_aot_error_dx.js && node tests/test_abort_early.js && node tests/test_branch_collapse.js && node tests/test_suggestions.js && node tests/test_cli_validate.js && node tests/test_cli_version.js && node benchmark/bench_aot_size.mjs",
     "bench:size": "node benchmark/bench_aot_size.mjs",
     "test:suite": "node tests/run_suite.js && node tests/run_suite.js draft7 && node tests/run_suite.js v1",
     "test:compat": "node tests/test_compat.js",
@@ -121,13 +121,13 @@
     "LICENSE"
   ],
   "optionalDependencies": {
-    "@ata-validator/native-darwin-arm64": "1.33.2",
-    "@ata-validator/native-darwin-x64": "1.33.2",
-    "@ata-validator/native-linux-arm64-gnu": "1.33.2",
-    "@ata-validator/native-linux-arm64-musl": "1.33.2",
-    "@ata-validator/native-linux-x64-gnu": "1.33.2",
-    "@ata-validator/native-linux-x64-musl": "1.33.2",
-    "@ata-validator/native-win32-x64": "1.33.2"
+    "@ata-validator/native-darwin-arm64": "1.34.0",
+    "@ata-validator/native-darwin-x64": "1.34.0",
+    "@ata-validator/native-linux-arm64-gnu": "1.34.0",
+    "@ata-validator/native-linux-arm64-musl": "1.34.0",
+    "@ata-validator/native-linux-x64-gnu": "1.34.0",
+    "@ata-validator/native-linux-x64-musl": "1.34.0",
+    "@ata-validator/native-win32-x64": "1.34.0"
   },
   "peerDependencies": {
     "yaml": "^2.0.0"