@hyperjump/json-schema 1.17.2 → 1.17.4

package/annotations/test-utils.js

@@ -30,7 +30,7 @@ export const isCompatible = (compatibility, versionUnderTest) => {
         }
         break;
       default:
-        throw Error(`Unsupported contraint operator: ${operator}`);
+        throw Error(`Unsupported constraint operator: ${operator}`);
     }
   }
 

package/draft-04/dependencies.js

@@ -20,17 +20,21 @@ const interpret = (dependencies, instance, context) => {
     return true;
   }
 
-  return dependencies.every(([propertyName, dependency]) => {
+  let isValid = true;
+  for (const [propertyName, dependency] of dependencies) {
     if (!Instance.has(propertyName, instance)) {
-      return true;
+      continue;
     }
 
     if (Array.isArray(dependency)) {
-      return dependency.every((key) => Instance.has(key, instance));
+      isValid &&= dependency.every((key) => Instance.has(key, instance));
     } else {
-      return Validation.interpret(dependency, instance, context);
+      const isSchemaValid = Validation.interpret(dependency, instance, context);
+      isValid &&= isSchemaValid;
     }
-  });
+  }
+
+  return isValid;
 };
 
 export default { id, compile, interpret };

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,7 +48,7 @@ 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;

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-0/index.d.ts

@@ -39,17 +39,17 @@ export type OasSchema30 = {
   xml?: Xml;
 };
 
-type Discriminator = {
+export type Discriminator = {
   propertyName: string;
   mappings?: Record<string, string>;
 };
 
-type ExternalDocs = {
+export type ExternalDocs = {
   url: string;
   description?: string;
 };
 
-type Xml = {
+export type Xml = {
   name?: string;
   namespace?: string;
   prefix?: string;
@@ -68,11 +68,11 @@ export type OpenApi30 = {
   components?: Components;
 };
 
-type Reference = {
+export type Reference = {
   $ref: "string";
 };
 
-type Info = {
+export type Info = {
   title: string;
   description?: string;
   termsOfService?: string;
@@ -81,30 +81,30 @@ type Info = {
   version: string;
 };
 
-type Contact = {
+export type Contact = {
   name?: string;
   url?: string;
   email?: string;
 };
 
-type License = {
+export type License = {
   name: string;
   url?: string;
 };
 
-type Server = {
+export type Server = {
   url: string;
   description?: string;
   variables?: Record<string, ServerVariable>;
 };
 
-type ServerVariable = {
+export type ServerVariable = {
   enum?: string[];
   default: string;
   description?: string;
 };
 
-type Components = {
+export type Components = {
   schemas?: Record<string, OasSchema30>;
   responses?: Record<string, Response | Reference>;
   parameters?: Record<string, Parameter | Reference>;
@@ -116,28 +116,28 @@ type Components = {
   callbacks: Record<string, Callback | Reference>;
 };
 
-type Response = {
+export type Response = {
   description: string;
   headers?: Record<string, Header | Reference>;
   content?: Record<string, MediaType>;
   links?: Record<string, Link | Reference>;
 };
 
-type MediaType = {
+export type MediaType = {
   schema?: OasSchema30;
   example?: unknown;
   examples?: Record<string, Example | Reference>;
   encoding?: Record<string, Encoding>;
 };
 
-type Example = {
+export type Example = {
   summary?: string;
   description?: string;
   value?: unknown;
   externalValue?: string;
 };
 
-type Header = {
+export type Header = {
   description?: string;
   required?: boolean;
   deprecated?: boolean;
@@ -151,9 +151,9 @@ type Header = {
   examples: Record<string, Example | Reference>;
 };
 
-type Paths = Record<string, PathItem>;
+export type Paths = Record<string, PathItem>;
 
-type PathItem = {
+export type PathItem = {
   $ref?: string;
   summary?: string;
   description?: string;
@@ -169,7 +169,7 @@ type PathItem = {
   trace?: Operation;
 };
 
-type Operation = {
+export type Operation = {
   tags?: string[];
   summary?: string;
   description?: string;
@@ -184,17 +184,17 @@ type Operation = {
   servers?: Server[];
 };
 
-type Responses = Record<string, Response | Reference>;
+export type Responses = Record<string, Response | Reference>;
 
-type SecurityRequirement = Record<string, string[]>;
+export type SecurityRequirement = Record<string, string[]>;
 
-type Tag = {
+export type Tag = {
   name: string;
   description?: string;
   externalDocs?: ExternalDocs;
 };
 
-type Parameter = {
+export type Parameter = {
   name: string;
   in: string;
   description?: string;
@@ -210,73 +210,73 @@ type Parameter = {
   examples?: Record<string, Example | Reference>;
 };
 
-type RequestBody = {
+export type RequestBody = {
   description?: string;
   content: Record<string, MediaType>;
   required?: boolean;
 };
 
-type SecurityScheme = APIKeySecurityScheme | HTTPSecurityScheme | OAuth2SecurityScheme | OpenIdConnectSecurityScheme;
+export type SecurityScheme = APIKeySecurityScheme | HTTPSecurityScheme | OAuth2SecurityScheme | OpenIdConnectSecurityScheme;
 
-type APIKeySecurityScheme = {
+export type APIKeySecurityScheme = {
   type: "apiKey";
   name: string;
   in: "header" | "query" | "cookie";
   description?: string;
 };
 
-type HTTPSecurityScheme = {
+export type HTTPSecurityScheme = {
   scheme: string;
   bearerFormat?: string;
   description?: string;
   type: "http";
 };
 
-type OAuth2SecurityScheme = {
+export type OAuth2SecurityScheme = {
   type: "oauth2";
   flows: OAuthFlows;
   description?: string;
 };
 
-type OpenIdConnectSecurityScheme = {
+export type OpenIdConnectSecurityScheme = {
   type: "openIdConnect";
   openIdConnectUrl: string;
   description?: string;
 };
 
-type OAuthFlows = {
+export type OAuthFlows = {
   implicit?: ImplicitOAuthFlow;
   password?: PasswordOAuthFlow;
   clientCredentials?: ClientCredentialsFlow;
   authorizationCode?: AuthorizationCodeOAuthFlow;
 };
 
-type ImplicitOAuthFlow = {
+export type ImplicitOAuthFlow = {
   authorizationUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type PasswordOAuthFlow = {
+export type PasswordOAuthFlow = {
   tokenUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type ClientCredentialsFlow = {
+export type ClientCredentialsFlow = {
   tokenUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type AuthorizationCodeOAuthFlow = {
+export type AuthorizationCodeOAuthFlow = {
   authorizationUrl: string;
   tokenUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type Link = {
+export type Link = {
   operationId?: string;
   operationRef?: string;
   parameters?: Record<string, unknown>;
@@ -285,9 +285,9 @@ type Link = {
   server?: Server;
 };
 
-type Callback = Record<string, PathItem>;
+export type Callback = Record<string, PathItem>;
 
-type Encoding = {
+export type Encoding = {
   contentType?: string;
   headers?: Record<string, Header | Reference>;
   style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";

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

@@ -67,17 +67,17 @@ export type OasSchema31 = boolean | {
   xml?: Xml;
 };
 
-type Discriminator = {
+export type Discriminator = {
   propertyName: string;
   mappings?: Record<string, string>;
 };
 
-type ExternalDocs = {
+export type ExternalDocs = {
   url: string;
   description?: string;
 };
 
-type Xml = {
+export type Xml = {
   name?: string;
   namespace?: string;
   prefix?: string;
@@ -98,7 +98,7 @@ export type OpenApi = {
   components?: Components;
 };
 
-type Info = {
+export type Info = {
   title: string;
   summary?: string;
   description?: string;
@@ -108,31 +108,31 @@ type Info = {
   version: string;
 };
 
-type Contact = {
+export type Contact = {
   name?: string;
   url?: string;
   email?: string;
 };
 
-type License = {
+export type License = {
   name: string;
   url?: string;
   identifier?: string;
 };
 
-type Server = {
+export type Server = {
   url: string;
   description?: string;
   variables?: Record<string, ServerVariable>;
 };
 
-type ServerVariable = {
+export type ServerVariable = {
   enum?: string[];
   default: string;
   description?: string;
 };
 
-type Components = {
+export type Components = {
   schemas?: Record<string, OasSchema31>;
   responses?: Record<string, Response | Reference>;
   parameters?: Record<string, Parameter | Reference>;
@@ -141,11 +141,11 @@ 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>;
 };
 
-type PathItem = {
+export type PathItem = {
   summary?: string;
   description?: string;
   servers?: Server[];
@@ -160,7 +160,7 @@ type PathItem = {
   trace?: Operation;
 };
 
-type Operation = {
+export type Operation = {
   tags?: string[];
   summary?: string;
   description?: string;
@@ -169,13 +169,13 @@ 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[];
 };
 
-type ExternalDocumentation = {
+export type ExternalDocumentation = {
   description?: string;
   url: string;
 };
@@ -219,32 +219,32 @@ export type Parameter = {
   )
 );
 
-type ContentParameter = {
+export type ContentParameter = {
   schema?: never;
   content: Record<string, MediaType | Reference>;
 };
 
-type SchemaParameter = {
+export type SchemaParameter = {
   explode?: boolean;
   allowReserved?: boolean;
   schema: OasSchema32;
   content?: never;
 } & Examples;
 
-type RequestBody = {
+export type RequestBody = {
   description?: string;
   content: Content;
   required?: boolean;
 };
 
-type Content = Record<string, MediaType>;
+export type Content = Record<string, MediaType>;
 
-type MediaType = {
+export type MediaType = {
   schema?: OasSchema31;
   encoding?: Record<string, Encoding>;
 } & Examples;
 
-type Encoding = {
+export type Encoding = {
   contentType?: string;
   headers?: Record<string, Header | Reference>;
   style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";
@@ -252,23 +252,23 @@ type Encoding = {
   allowReserved?: boolean;
 };
 
-type Response = {
+export type Response = {
   description: string;
   headers?: Record<string, Header | Reference>;
   content?: Content;
   links?: Record<string, Link | Reference>;
 };
 
-type Callbacks = Record<string, PathItem | Reference>;
+export type Callback = Record<string, PathItem>;
 
-type Example = {
+export type Example = {
   summary?: string;
   description?: string;
   value?: Json;
   externalValue?: string;
 };
 
-type Link = {
+export type Link = {
   operationRef?: string;
   operationId?: string;
   parameters?: Record<string, string>;
@@ -277,7 +277,7 @@ type Link = {
   server?: Server;
 };
 
-type Header = {
+export type Header = {
   description?: string;
   required?: boolean;
   deprecated?: boolean;
@@ -287,19 +287,19 @@ type Header = {
   content?: Content;
 };
 
-type Tag = {
+export type Tag = {
   name: string;
   description?: string;
   externalDocs?: ExternalDocumentation;
 };
 
-type Reference = {
+export type Reference = {
   $ref: string;
   summary?: string;
   description?: string;
 };
 
-type SecurityScheme = {
+export type SecurityScheme = {
   type: "apiKey";
   description?: string;
   name: string;
@@ -322,41 +322,41 @@ type SecurityScheme = {
   openIdConnectUrl: string;
 };
 
-type OauthFlows = {
+export type OauthFlows = {
   implicit?: Implicit;
   password?: Password;
   clientCredentials?: ClientCredentials;
   authorizationCode?: AuthorizationCode;
 };
 
-type Implicit = {
+export type Implicit = {
   authorizationUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type Password = {
+export type Password = {
   tokenUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type ClientCredentials = {
+export type ClientCredentials = {
   tokenUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type AuthorizationCode = {
+export type AuthorizationCode = {
   authorizationUrl: string;
   tokenUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type SecurityRequirement = Record<string, string[]>;
+export type SecurityRequirement = Record<string, string[]>;
 
-type Examples = {
+export type Examples = {
   example?: Json;
   examples?: Record<string, Example | Reference>;
 };

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

@@ -67,18 +67,18 @@ export type OasSchema32 = boolean | {
   xml?: Xml;
 };
 
-type Discriminator = {
+export type Discriminator = {
   propertyName: string;
-  mappings?: Record<string, string>;
+  mapping?: Record<string, string>;
   defaultMapping?: string;
 };
 
-type ExternalDocs = {
+export type ExternalDocs = {
   url: string;
   description?: string;
 };
 
-type Xml = {
+export type Xml = {
   nodeType?: "element" | "attribute" | "text" | "cdata" | "none";
   name?: string;
   namespace?: string;
@@ -101,7 +101,7 @@ export type OpenApi = {
   externalDocs?: ExternalDocs;
 };
 
-type Info = {
+export type Info = {
   title: string;
   summary?: string;
   description?: string;
@@ -111,32 +111,32 @@ type Info = {
   version: string;
 };
 
-type Contact = {
+export type Contact = {
   name?: string;
   url?: string;
   email?: string;
 };
 
-type License = {
+export type License = {
   name: string;
   identifier?: string;
   url?: string;
 };
 
-type Server = {
+export type Server = {
   url: string;
   description?: string;
   name?: string;
   variables?: Record<string, ServerVariable>;
 };
 
-type ServerVariable = {
+export type ServerVariable = {
   enum?: string[];
   default: string;
   description?: string;
 };
 
-type Components = {
+export type Components = {
   schemas?: Record<string, OasSchema32>;
   responses?: Record<string, Response | Reference>;
   parameters?: Record<string, Parameter | Reference>;
@@ -145,12 +145,12 @@ 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>;
 };
 
-type PathItem = {
+export type PathItem = {
   $ref?: string;
   summary?: string;
   description?: string;
@@ -163,12 +163,12 @@ type PathItem = {
   patch?: Operation;
   trace?: Operation;
   query?: Operation;
-  additionOperations?: Record<string, Operation>;
+  additionalOperations?: Record<string, Operation>;
   servers?: Server[];
   parameters?: (Parameter | Reference)[];
 };
 
-type Operation = {
+export type Operation = {
   tags?: string[];
   summary?: string;
   description?: string;
@@ -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
@@ -224,25 +224,25 @@ export type Parameter = {
   )
 );
 
-type ContentParameter = {
+export type ContentParameter = {
   schema?: never;
   content: Record<string, MediaType | Reference>;
 };
 
-type SchemaParameter = {
+export type SchemaParameter = {
   explode?: boolean;
   allowReserved?: boolean;
   schema: OasSchema32;
   content?: never;
 };
 
-type RequestBody = {
+export type RequestBody = {
   description?: string;
   content: Record<string, MediaType | Reference>;
   required?: boolean;
 };
 
-type MediaType = {
+export type MediaType = {
   schema?: OasSchema32;
   itemSchema?: OasSchema32;
 } & Examples & ({
@@ -255,7 +255,7 @@ type MediaType = {
   itemEncoding?: Encoding;
 });
 
-type Encoding = {
+export type Encoding = {
   contentType?: string;
   headers?: Record<string, Header | Reference>;
   style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";
@@ -271,11 +271,11 @@ type Encoding = {
   itemEncoding?: Encoding;
 });
 
-type Responses = {
+export type Responses = {
   default?: Response | Reference;
 } & Record<string, Response | Reference>;
 
-type Response = {
+export type Response = {
   summary?: string;
   description?: string;
   headers?: Record<string, Header | Reference>;
@@ -283,14 +283,14 @@ type Response = {
   links?: Record<string, Link | Reference>;
 };
 
-type Callbacks = Record<string, PathItem | Reference>;
+export type Callback = Record<string, PathItem>;
 
-type Examples = {
+export type Examples = {
   example?: Json;
   examples?: Record<string, Example | Reference>;
 };
 
-type Example = {
+export type Example = {
   summary?: string;
   description?: string;
 } & ({
@@ -305,7 +305,7 @@ type Example = {
   externalValue?: string;
 });
 
-type Link = {
+export type Link = {
   operationRef?: string;
   operationId?: string;
   parameters?: Record<string, string>;
@@ -314,7 +314,7 @@ type Link = {
   server?: Server;
 };
 
-type Header = {
+export type Header = {
   description?: string;
   required?: boolean;
   deprecated?: boolean;
@@ -326,7 +326,7 @@ type Header = {
   content: Record<string, MediaType | Reference>;
 });
 
-type Tag = {
+export type Tag = {
   name: string;
   summary?: string;
   description?: string;
@@ -335,13 +335,13 @@ type Tag = {
   kind?: string;
 };
 
-type Reference = {
+export type Reference = {
   $ref: string;
   summary?: string;
   description?: string;
 };
 
-type SecurityScheme = {
+export type SecurityScheme = {
   type: "apiKey";
   description?: string;
   name: string;
@@ -370,7 +370,7 @@ type SecurityScheme = {
   deprecated?: boolean;
 };
 
-type OauthFlows = {
+export type OauthFlows = {
   implicit?: Implicit;
   password?: Password;
   clientCredentials?: ClientCredentials;
@@ -378,38 +378,38 @@ type OauthFlows = {
   deviceAuthorization?: DeviceAuthorization;
 };
 
-type Implicit = {
+export type Implicit = {
   authorizationUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type Password = {
+export type Password = {
   tokenUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type ClientCredentials = {
+export type ClientCredentials = {
   tokenUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type AuthorizationCode = {
+export type AuthorizationCode = {
   authorizationUrl: string;
   tokenUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type DeviceAuthorization = {
+export type DeviceAuthorization = {
   deviceAuthorizationUrl: string;
   tokenUrl: string;
   refreshUrl?: string;
   scopes: Record<string, string>;
 };
 
-type SecurityRequirement = Record<string, string[]>;
+export type SecurityRequirement = Record<string, string[]>;
 
 export * from "../lib/index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperjump/json-schema",
-  "version": "1.17.2",
+  "version": "1.17.4",
   "description": "A JSON Schema validator with support for custom keywords, vocabularies, and dialects",
   "type": "module",
   "main": "./v1/index.js",
@@ -25,7 +25,7 @@
   "scripts": {
     "clean": "xargs -a .gitignore rm -rf",
     "lint": "eslint lib v1 draft-* openapi-* bundle annotations",
-    "test": "vitest --watch=false",
+    "test": "vitest run",
     "check-types": "tsc --noEmit"
   },
   "repository": {