@hyperjump/json-schema 1.16.3 → 1.16.5

package/README.md

@@ -7,7 +7,7 @@ A collection of modules for working with JSON Schemas.
   * Schemas can reference other schemas using a different dialect
   * Work directly with schemas on the filesystem or HTTP
 * OpenAPI
-  * Versions: 3.0, 3.1
+  * Versions: 3.0, 3.1, 3.2 
   * Validate an OpenAPI document
   * Validate values against a schema from an OpenAPI document
 * Create custom keywords, vocabularies, and dialects
@@ -132,22 +132,22 @@ system](https://github.com/hyperjump-io/browser/#uri-schemes) provided by
 
 **OpenAPI**
 
-The OpenAPI 3.0 and 3.1 meta-schemas are pre-loaded and the OpenAPI JSON Schema
+The OpenAPI 3.0 and 3.1 and 3.2 meta-schemas are pre-loaded and the OpenAPI JSON Schema
 dialects for each of those versions is supported. A document with a Content-Type
 of `application/openapi+json` (web) or a file extension of `openapi.json`
 (filesystem) is understood as an OpenAPI document.
 
 Use the pattern `@hyperjump/json-schema/*` to import the version you need. The
-available versions are `openapi-3-0` for 3.0 and `openapi-3-1` for 3.1.
+available versions are `openapi-3-0` for 3.0, `openapi-3-1` for 3.1, and `openapi-3-2` for 3.2.
 
 ```javascript
-import { validate } from "@hyperjump/json-schema/openapi-3-1";
+import { validate } from "@hyperjump/json-schema/openapi-3-2";
 
 
-// Validate an OpenAPI document
-const output = await validate("https://spec.openapis.org/oas/3.1/schema-base", openapi);
+// Validate an OpenAPI 3.2 document
+const output = await validate("https://spec.openapis.org/oas/3.2/schema-base", openapi);
 
-// Validate an instance against a schema in an OpenAPI document
+// Validate an instance against a schema in an OpenAPI 3.2 document
 const output = await validate("./example.openapi.json#/components/schemas/foo", 42);
 ```
 

package/annotations/index.d.ts

@@ -15,7 +15,7 @@ export type Annotator = (value: Json, options?: OutputFormat | ValidationOptions
 export const interpret: (compiledSchema: CompiledSchema, value: JsonNode, options?: OutputFormat | ValidationOptions) => JsonNode;
 
 export class ValidationError extends Error {
-  public output: Output;
+  public output: Output & { valid: false };
 
   public constructor(output: Output);
 }

package/lib/index.d.ts

@@ -56,7 +56,7 @@ export const setShouldValidateSchema: (isEnabled: boolean) => void;
 export const getShouldValidateSchema: () => boolean;
 
 export class InvalidSchemaError extends Error {
-  public output: Output;
+  public output: Output & { valid: false };
 
   public constructor(output: Output);
 }

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

@@ -180,18 +180,55 @@ type ExternalDocumentation = {
   url: string;
 };
 
-type Parameter = {
+export type Parameter = {
   name: string;
-  in: "query" | "header" | "path" | "cookie";
   description?: string;
   required?: boolean;
   deprecated?: boolean;
   allowEmptyValue?: boolean;
-  style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject";
+} & (
+  (
+    {
+      in: "path";
+      required: true;
+    } & (
+      ({ style?: "matrix" | "label" | "simple" } & SchemaParameter)
+      | ContentParameter
+    )
+  ) | (
+    {
+      in: "query";
+    } & (
+      ({ style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" } & SchemaParameter)
+      | ContentParameter
+    )
+  ) | (
+    {
+      in: "header";
+    } & (
+      ({ style?: "simple" } & SchemaParameter)
+      | ContentParameter
+    )
+  ) | (
+    {
+      in: "cookie";
+    } & (
+      ({ style?: "form" } & SchemaParameter)
+      | ContentParameter
+    )
+  )
+);
+
+type ContentParameter = {
+  schema?: never;
+  content: Record<string, MediaType | Reference>;
+};
+
+type SchemaParameter = {
   explode?: boolean;
   allowReserved?: boolean;
-  schema?: OasSchema31;
-  content?: Content;
+  schema: OasSchema32;
+  content?: never;
 } & Examples;
 
 type RequestBody = {
@@ -237,7 +274,7 @@ type Link = {
   parameters?: Record<string, string>;
   requestBody?: Json;
   description?: string;
-  body?: Server;
+  server?: Server;
 };
 
 type Header = {
@@ -259,25 +296,37 @@ type Tag = {
 type Reference = {
   $ref: string;
   summary?: string;
-  descriptions?: string;
+  description?: string;
 };
 
 type SecurityScheme = {
-  type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect";
+  type: "apiKey";
   description?: string;
-  name?: string;
-  in?: "query" | "header" | "cookie";
-  scheme?: string;
+  name: string;
+  in: "query" | "header" | "cookie";
+} | {
+  type: "http";
+  description?: string;
+  scheme: string;
   bearerFormat?: string;
-  flows?: OauthFlows;
-  openIdConnectUrl?: string;
+} | {
+  type: "mutualTLS";
+  description?: string;
+} | {
+  type: "oauth2";
+  description?: string;
+  flows: OauthFlows;
+} | {
+  type: "openIdConnect";
+  description?: string;
+  openIdConnectUrl: string;
 };
 
 type OauthFlows = {
-  implicit: Implicit;
-  Password: Password;
-  clientCredentials: ClientCredentials;
-  authorizationCode: AuthorizationCode;
+  implicit?: Implicit;
+  password?: Password;
+  clientCredentials?: ClientCredentials;
+  authorizationCode?: AuthorizationCode;
 };
 
 type Implicit = {

package/openapi-3-1/schema-draft-2019-09.js

@@ -23,7 +23,7 @@ export default {
     "dialect": { "const": "https://json-schema.org/draft/2019-09/schema" },
 
     "schema": {
-      "$dynamicanchor": "meta",
+      "$dynamicAnchor": "meta",
       "$ref": "https://spec.openapis.org/oas/3.1/dialect/base",
       "properties": {
         "$schema": { "$ref": "#/$defs/dialect" }

package/openapi-3-1/schema-draft-2020-12.js

@@ -23,7 +23,7 @@ export default {
     "dialect": { "const": "https://json-schema.org/draft/2020-12/schema" },
 
     "schema": {
-      "$dynamicanchor": "meta",
+      "$dynamicAnchor": "meta",
       "$ref": "https://spec.openapis.org/oas/3.1/dialect/base",
       "properties": {
         "$schema": { "$ref": "#/$defs/dialect" }

package/openapi-3-2/dialect/base.js

@@ -13,10 +13,10 @@ export default {
   "$dynamicAnchor": "meta",
 
   "title": "OpenAPI 3.2 Schema Object Dialect",
-  "description": "A JSON Schema dialect describing schemas found in OpenAPI v3.2 Descriptions",
+  "description": "A JSON Schema dialect describing schemas found in OpenAPI v3.2.x Descriptions",
 
   "allOf": [
     { "$ref": "https://json-schema.org/draft/2020-12/schema" },
-    { "$ref": "https://spec.openapis.org/oas/3.2/meta/base" }
+    { "$ref": "https://spec.openapis.org/oas/3.2/meta" }
   ]
 };

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

@@ -70,6 +70,7 @@ export type OasSchema32 = boolean | {
 type Discriminator = {
   propertyName: string;
   mappings?: Record<string, string>;
+  defaultMapping?: string;
 };
 
 type ExternalDocs = {
@@ -78,6 +79,7 @@ type ExternalDocs = {
 };
 
 type Xml = {
+  nodeType?: "element" | "attribute" | "text" | "cdata" | "none";
   name?: string;
   namespace?: string;
   prefix?: string;
@@ -85,7 +87,329 @@ type Xml = {
   wrapped?: boolean;
 };
 
-// TODO: Fill in this type when 3.2 is published
-export type OpenApi32 = unknown;
+export type OpenApi = {
+  openapi: string;
+  $self?: string;
+  info: Info;
+  jsonSchemaDialect?: string;
+  servers?: Server[];
+  paths?: Record<string, PathItem>;
+  webhooks?: Record<string, PathItem>;
+  components?: Components;
+  security?: SecurityRequirement[];
+  tags?: Tag[];
+  externalDocs?: ExternalDocs;
+};
+
+type Info = {
+  title: string;
+  summary?: string;
+  description?: string;
+  termsOfService?: string;
+  contact?: Contact;
+  license?: License;
+  version: string;
+};
+
+type Contact = {
+  name?: string;
+  url?: string;
+  email?: string;
+};
+
+type License = {
+  name: string;
+  identifier?: string;
+  url?: string;
+};
+
+type Server = {
+  url: string;
+  description?: string;
+  name?: string;
+  variables?: Record<string, ServerVariable>;
+};
+
+type ServerVariable = {
+  enum?: string[];
+  default: string;
+  description?: string;
+};
+
+type Components = {
+  schemas?: Record<string, OasSchema32>;
+  responses?: Record<string, Response | Reference>;
+  parameters?: Record<string, Parameter | Reference>;
+  examples?: Record<string, Example | Reference>;
+  requestBodies?: Record<string, RequestBody | Reference>;
+  headers?: Record<string, Header | Reference>;
+  securitySchemes?: Record<string, SecurityScheme | Reference>;
+  links?: Record<string, Link | Reference>;
+  callbacks?: Record<string, Callbacks | Reference>;
+  pathItems?: Record<string, PathItem>;
+  mediaTypes?: Record<string, MediaType | Reference>;
+};
+
+type PathItem = {
+  $ref?: string;
+  summary?: string;
+  description?: string;
+  get?: Operation;
+  put?: Operation;
+  post?: Operation;
+  delete?: Operation;
+  options?: Operation;
+  head?: Operation;
+  patch?: Operation;
+  trace?: Operation;
+  query?: Operation;
+  additionOperations?: Record<string, Operation>;
+  servers?: Server[];
+  parameters?: (Parameter | Reference)[];
+};
+
+type Operation = {
+  tags?: string[];
+  summary?: string;
+  description?: string;
+  externalDocs?: ExternalDocs;
+  operationId?: string;
+  parameters?: (Parameter | Reference)[];
+  requestBody?: RequestBody | Reference;
+  responses?: Responses;
+  callbacks?: Record<string, Callbacks | Reference>;
+  deprecated?: boolean;
+  security?: SecurityRequirement[];
+  servers?: Server[];
+};
+
+export type Parameter = {
+  name: string;
+  description?: string;
+  required?: boolean;
+  deprecated?: boolean;
+  allowEmptyValue?: boolean;
+} & Examples & (
+  (
+    {
+      in: "path";
+      required: true;
+    } & (
+      ({ style?: "matrix" | "label" | "simple" } & SchemaParameter)
+      | ContentParameter
+    )
+  ) | (
+    {
+      in: "query";
+    } & (
+      ({ style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" } & SchemaParameter)
+      | ContentParameter
+    )
+  ) | (
+    {
+      in: "header";
+    } & (
+      ({ style?: "simple" } & SchemaParameter)
+      | ContentParameter
+    )
+  ) | (
+    {
+      in: "cookie";
+    } & (
+      ({ style?: "cookie" } & SchemaParameter)
+      | ContentParameter
+    )
+  ) | (
+    { in: "querystring" } & ContentParameter
+  )
+);
+
+type ContentParameter = {
+  schema?: never;
+  content: Record<string, MediaType | Reference>;
+};
+
+type SchemaParameter = {
+  explode?: boolean;
+  allowReserved?: boolean;
+  schema: OasSchema32;
+  content?: never;
+};
+
+type RequestBody = {
+  description?: string;
+  content: Record<string, MediaType | Reference>;
+  required?: boolean;
+};
+
+type MediaType = {
+  schema?: OasSchema32;
+  itemSchema?: OasSchema32;
+} & Examples & ({
+  encoding?: Record<string, Encoding>;
+  prefixEncoding?: never;
+  itemEncoding?: never;
+} | {
+  encoding?: never;
+  prefixEncoding?: Encoding[];
+  itemEncoding?: Encoding;
+});
+
+type Encoding = {
+  contentType?: string;
+  headers?: Record<string, Header | Reference>;
+  style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";
+  explode?: boolean;
+  allowReserved?: boolean;
+} & ({
+  encoding?: Record<string, Encoding>;
+  prefixEncoding?: never;
+  itemEncoding?: never;
+} | {
+  encoding?: never;
+  prefixEncoding?: Encoding[];
+  itemEncoding?: Encoding;
+});
+
+type Responses = {
+  default?: Response | Reference;
+} & Record<string, Response | Reference>;
+
+type Response = {
+  summary?: string;
+  description?: string;
+  headers?: Record<string, Header | Reference>;
+  content?: Record<string, MediaType | Reference>;
+  links?: Record<string, Link | Reference>;
+};
+
+type Callbacks = Record<string, PathItem | Reference>;
+
+type Examples = {
+  example?: Json;
+  examples?: Record<string, Example | Reference>;
+};
+
+type Example = {
+  summary?: string;
+  description?: string;
+} & ({
+  value?: Json;
+  dataValue?: never;
+  serializedValue?: never;
+  externalValue?: never;
+} | {
+  value?: never;
+  dataValue?: Json;
+  serializedValue?: string;
+  externalValue?: string;
+});
+
+type Link = {
+  operationRef?: string;
+  operationId?: string;
+  parameters?: Record<string, string>;
+  requestBody?: Json;
+  description?: string;
+  server?: Server;
+};
+
+type Header = {
+  description?: string;
+  required?: boolean;
+  deprecated?: boolean;
+} & Examples & ({
+  style?: "simple";
+  explode?: boolean;
+  schema: OasSchema32;
+} | {
+  content: Record<string, MediaType | Reference>;
+});
+
+type Tag = {
+  name: string;
+  summary?: string;
+  description?: string;
+  externalDocs?: ExternalDocs;
+  parent?: string;
+  kind?: string;
+};
+
+type Reference = {
+  $ref: string;
+  summary?: string;
+  description?: string;
+};
+
+type SecurityScheme = {
+  type: "apiKey";
+  description?: string;
+  name: string;
+  in: "query" | "header" | "cookie";
+  deprecated?: boolean;
+} | {
+  type: "http";
+  description?: string;
+  scheme: string;
+  bearerFormat?: string;
+  deprecated?: boolean;
+} | {
+  type: "mutualTLS";
+  description?: string;
+  deprecated?: boolean;
+} | {
+  type: "oauth2";
+  description?: string;
+  flows: OauthFlows;
+  oauth2MetadataUrl?: string;
+  deprecated?: boolean;
+} | {
+  type: "openIdConnect";
+  description?: string;
+  openIdConnectUrl: string;
+  deprecated?: boolean;
+};
+
+type OauthFlows = {
+  implicit?: Implicit;
+  password?: Password;
+  clientCredentials?: ClientCredentials;
+  authorizationCode?: AuthorizationCode;
+  deviceAuthorization?: DeviceAuthorization;
+};
+
+type Implicit = {
+  authorizationUrl: string;
+  refreshUrl?: string;
+  scopes: Record<string, string>;
+};
+
+type Password = {
+  tokenUrl: string;
+  refreshUrl?: string;
+  scopes: Record<string, string>;
+};
+
+type ClientCredentials = {
+  tokenUrl: string;
+  refreshUrl?: string;
+  scopes: Record<string, string>;
+};
+
+type AuthorizationCode = {
+  authorizationUrl: string;
+  tokenUrl: string;
+  refreshUrl?: string;
+  scopes: Record<string, string>;
+};
+
+type DeviceAuthorization = {
+  deviceAuthorizationUrl: string;
+  tokenUrl: string;
+  refreshUrl?: string;
+  scopes: Record<string, string>;
+};
+
+type SecurityRequirement = Record<string, string[]>;
 
 export * from "../lib/index.js";

package/openapi-3-2/index.js

@@ -32,14 +32,12 @@ defineVocabulary("https://spec.openapis.org/oas/3.2/vocab/base", {
   "xml": "https://spec.openapis.org/oas/3.0/keyword/xml"
 });
 
-registerSchema(vocabularySchema, "https://spec.openapis.org/oas/3.2/meta/base");
-registerSchema(dialectSchema, "https://spec.openapis.org/oas/3.2/dialect/base");
+registerSchema(vocabularySchema, "https://spec.openapis.org/oas/3.2/meta");
+registerSchema(dialectSchema, "https://spec.openapis.org/oas/3.2/dialect");
 
 // Current Schemas
 registerSchema(schema, "https://spec.openapis.org/oas/3.2/schema");
-registerSchema(schema, "https://spec.openapis.org/oas/3.2/schema/latest");
 registerSchema(schemaBase, "https://spec.openapis.org/oas/3.2/schema-base");
-registerSchema(schemaBase, "https://spec.openapis.org/oas/3.2/schema-base/latest");
 
 // Alternative dialect schemas
 registerSchema(schemaDraft2020, "https://spec.openapis.org/oas/3.2/schema-draft-2020-12");

package/openapi-3-2/meta/base.js

@@ -3,21 +3,23 @@ export default {
   "$dynamicAnchor": "meta",
 
   "title": "OAS Base Vocabulary",
-  "description": "A JSON Schema Vocabulary used in the OpenAPI Schema Dialect",
+  "description": "A JSON Schema Vocabulary used in the OpenAPI JSON Schema Dialect",
 
   "type": ["object", "boolean"],
   "properties": {
-    "example": true,
     "discriminator": { "$ref": "#/$defs/discriminator" },
+    "example": { "deprecated": true },
     "externalDocs": { "$ref": "#/$defs/external-docs" },
     "xml": { "$ref": "#/$defs/xml" }
   },
+
   "$defs": {
     "extensible": {
       "patternProperties": {
         "^x-": true
       }
     },
+
     "discriminator": {
       "$ref": "#/$defs/extensible",
       "type": "object",
@@ -30,6 +32,9 @@ export default {
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "defaultMapping": {
+          "type": "string"
         }
       },
       "required": ["propertyName"],
@@ -54,21 +59,41 @@ export default {
       "$ref": "#/$defs/extensible",
       "type": "object",
       "properties": {
+        "nodeType": {
+          "type": "string",
+          "enum": [
+            "element",
+            "attribute",
+            "text",
+            "cdata",
+            "none"
+          ]
+        },
         "name": {
           "type": "string"
         },
         "namespace": {
           "type": "string",
-          "format": "uri"
+          "format": "iri"
         },
         "prefix": {
           "type": "string"
         },
         "attribute": {
-          "type": "boolean"
+          "type": "boolean",
+          "deprecated": true
         },
         "wrapped": {
-          "type": "boolean"
+          "type": "boolean",
+          "deprecated": true
+        }
+      },
+      "dependentSchemas": {
+        "nodeType": {
+          "properties": {
+            "attribute": false,
+            "wrapped": false
+          }
         }
       },
       "unevaluatedProperties": false

package/openapi-3-2/schema-base.js

@@ -20,11 +20,10 @@ export default {
   },
 
   "$defs": {
-    "dialect": { "const": "https://spec.openapis.org/oas/3.2/dialect/base" },
-
+    "dialect": { "const": "https://spec.openapis.org/oas/3.2/dialect" },
     "schema": {
       "$dynamicAnchor": "meta",
-      "$ref": "https://spec.openapis.org/oas/3.2/dialect/base",
+      "$ref": "https://spec.openapis.org/oas/3.2/dialect",
       "properties": {
         "$schema": { "$ref": "#/$defs/dialect" }
       }

package/openapi-3-2/schema-draft-04.js

@@ -12,7 +12,7 @@ export default {
     "https://spec.openapis.org/oas/3.2/vocab/base": false
   },
 
-  "description": "OpenAPI v3.2.x documents using draft-04 JSON Schemas",
+  "description": "The description of OpenAPI v3.2.x Documents using the draft-04 JSON Schema dialect",
 
   "$ref": "https://spec.openapis.org/oas/3.2/schema",
   "properties": {
@@ -24,7 +24,7 @@ export default {
 
     "schema": {
       "$dynamicAnchor": "meta",
-      "$ref": "https://spec.openapis.org/oas/3.2/dialect/base",
+      "$ref": "https://spec.openapis.org/oas/3.2/dialect",
       "properties": {
         "$schema": { "$ref": "#/$defs/dialect" }
       }