@hyperjump/json-schema 1.17.1 → 1.17.3

package/lib/experimental.d.ts

@@ -1,13 +1,13 @@
 import type { Browser, Document } from "@hyperjump/browser";
 import type { Json } from "@hyperjump/json-pointer";
-import type { Validator, Output, OutputUnit, OutputFormat, SchemaObject } from "./index.js";
+import type { Validator, Output, OutputUnit, OutputFormat, SchemaObject, ValidationOptions } from "./index.js";
 import type { JsonNode } from "./instance.js";
 
 
 // Compile/interpret
 export const compile: (schema: Browser<SchemaDocument>) => Promise<CompiledSchema>;
 export const interpret: (
-  (compiledSchema: CompiledSchema, value: JsonNode, outputFormat?: OutputFormat) => Output
+  (compiledSchema: CompiledSchema, value: JsonNode, outputFormat?: OutputFormat | ValidationOptions) => Output
 ) & (
   (compiledSchema: CompiledSchema) => Validator
 );
@@ -45,7 +45,6 @@ export const toSchema: (browser: Browser<SchemaDocument>, options?: ToSchemaOpti
 export type ToSchemaOptions = {
   contextDialectId?: string;
   includeDialect?: "auto" | "always" | "never";
-  selfIdentify?: boolean;
   contextUri?: string;
   includeEmbedded?: boolean;
 };
@@ -80,7 +79,7 @@ export type Keyword<A, Context extends ValidationContext = ValidationContext> =
   compile: (schema: Browser<SchemaDocument>, ast: AST, parentSchema: Browser<SchemaDocument>) => Promise<A>;
   interpret: (compiledKeywordValue: A, instance: JsonNode, context: Context) => boolean;
   simpleApplicator?: boolean;
-  annotation?: <B>(compiledKeywordValue: A, instance: JsonNode) => B | undefined;
+  annotation?: (compiledKeywordValue: A, instance: JsonNode) => unknown;
   plugin?: EvaluationPlugin<Context>;
 };
 

package/lib/index.d.ts

@@ -48,14 +48,14 @@ export type OutputUnit = {
 
 export const FLAG: "FLAG";
 
-export type OutputFormat = "FLAG" | "BASIC" | "DETAILED" | "VERBOSE";
+export type OutputFormat = "FLAG" | "BASIC" | "DETAILED";
 
 export const setMetaSchemaOutputFormat: (format: OutputFormat) => void;
 export const getMetaSchemaOutputFormat: () => OutputFormat;
 export const setShouldValidateSchema: (isEnabled: boolean) => void;
 export const getShouldValidateSchema: () => boolean;
-export const setShouldValidateFormat: (isEnabled: boolean) => void;
-export const getShouldValidateFormat: () => boolean;
+export const setShouldValidateFormat: (isEnabled: boolean | undefined) => void;
+export const getShouldValidateFormat: () => boolean | undefined;
 
 export class InvalidSchemaError extends Error {
   public output: Output & { valid: false };

package/lib/instance.d.ts

@@ -32,7 +32,7 @@ export type JsonNode = {
   children: JsonNode[];
   parent?: JsonNode;
   root: JsonNode;
-  annotations: Record<string, Record<string, unknown>>;
+  annotations: Record<string, unknown[]>;
 };
 
 type JsonNodeType = "object" | "array" | "string" | "number" | "boolean" | "null" | "property";

package/openapi-3-1/index.d.ts

@@ -141,7 +141,7 @@ type Components = {
   headers?: Record<string, Header | Reference>;
   securitySchemes?: Record<string, SecurityScheme | Reference>;
   links?: Record<string, Link | Reference>;
-  callbacks?: Record<string, Callbacks | Reference>;
+  callbacks?: Record<string, Callback | Reference>;
   pathItems?: Record<string, PathItem | Reference>;
 };
 
@@ -169,7 +169,7 @@ type Operation = {
   parameters?: (Parameter | Reference)[];
   requestBody?: RequestBody | Reference;
   responses?: Record<string, Response | Reference>;
-  callbacks?: Record<string, Callbacks | Reference>;
+  callbacks?: Record<string, Callback | Reference>;
   deprecated?: boolean;
   security?: SecurityRequirement[];
   servers?: Server[];
@@ -259,7 +259,7 @@ type Response = {
   links?: Record<string, Link | Reference>;
 };
 
-type Callbacks = Record<string, PathItem | Reference>;
+type Callback = Record<string, PathItem>;
 
 type Example = {
   summary?: string;

package/openapi-3-2/index.d.ts

@@ -69,7 +69,7 @@ export type OasSchema32 = boolean | {
 
 type Discriminator = {
   propertyName: string;
-  mappings?: Record<string, string>;
+  mapping?: Record<string, string>;
   defaultMapping?: string;
 };
 
@@ -145,7 +145,7 @@ type Components = {
   headers?: Record<string, Header | Reference>;
   securitySchemes?: Record<string, SecurityScheme | Reference>;
   links?: Record<string, Link | Reference>;
-  callbacks?: Record<string, Callbacks | Reference>;
+  callbacks?: Record<string, Callback | Reference>;
   pathItems?: Record<string, PathItem>;
   mediaTypes?: Record<string, MediaType | Reference>;
 };
@@ -163,7 +163,7 @@ type PathItem = {
   patch?: Operation;
   trace?: Operation;
   query?: Operation;
-  additionOperations?: Record<string, Operation>;
+  additionalOperations?: Record<string, Operation>;
   servers?: Server[];
   parameters?: (Parameter | Reference)[];
 };
@@ -177,7 +177,7 @@ type Operation = {
   parameters?: (Parameter | Reference)[];
   requestBody?: RequestBody | Reference;
   responses?: Responses;
-  callbacks?: Record<string, Callbacks | Reference>;
+  callbacks?: Record<string, Callback | Reference>;
   deprecated?: boolean;
   security?: SecurityRequirement[];
   servers?: Server[];
@@ -188,7 +188,6 @@ export type Parameter = {
   description?: string;
   required?: boolean;
   deprecated?: boolean;
-  allowEmptyValue?: boolean;
 } & Examples & (
   (
     {
@@ -201,6 +200,7 @@ export type Parameter = {
   ) | (
     {
       in: "query";
+      allowEmptyValue?: boolean;
     } & (
       ({ style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" } & SchemaParameter)
       | ContentParameter
@@ -283,7 +283,7 @@ type Response = {
   links?: Record<string, Link | Reference>;
 };
 
-type Callbacks = Record<string, PathItem | Reference>;
+type Callback = Record<string, PathItem>;
 
 type Examples = {
   example?: Json;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperjump/json-schema",
-  "version": "1.17.1",
+  "version": "1.17.3",
   "description": "A JSON Schema validator with support for custom keywords, vocabularies, and dialects",
   "type": "module",
   "main": "./v1/index.js",