@hyperjump/json-schema 1.0.0 → 1.1.0

package/openapi-3-0/type.js

@@ -0,0 +1,16 @@
+import { getKeywordName } from "../lib/keywords.js";
+import * as Schema from "../lib/schema.js";
+import * as Instance from "../lib/instance.js";
+
+
+const id = "https://spec.openapis.org/oas/3.0/keyword/type";
+
+const compile = async (schema, ast, parentSchema) => {
+  const nullableKeyword = getKeywordName(schema.dialectId, "https://spec.openapis.org/oas/3.0/keyword/nullable");
+  const nullable = await Schema.step(nullableKeyword, parentSchema);
+  return Schema.value(nullable) === true ? ["null", Schema.value(schema)] : Schema.value(schema);
+};
+
+const interpret = (type, instance) => typeof type === "string" ? Instance.typeOf(instance, type) : type.some(Instance.typeOf(instance));
+
+export default { id, compile, interpret };

package/openapi-3-0/xml.js

@@ -0,0 +1,4 @@
+import metaData from "../lib/keywords/meta-data.js";
+
+
+export default { id: "https://spec.openapis.org/oas/3.0/keyword/xml", ...metaData };

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

@@ -0,0 +1,21 @@
+export default {
+  "$id": "https://spec.openapis.org/oas/3.1/dialect/base",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$vocabulary": {
+    "https://json-schema.org/draft/2020-12/vocab/core": true,
+    "https://json-schema.org/draft/2020-12/vocab/applicator": true,
+    "https://json-schema.org/draft/2020-12/vocab/unevaluated": true,
+    "https://json-schema.org/draft/2020-12/vocab/validation": true,
+    "https://json-schema.org/draft/2020-12/vocab/meta-data": true,
+    "https://json-schema.org/draft/2020-12/vocab/format-annotation": true,
+    "https://json-schema.org/draft/2020-12/vocab/content": true,
+    "https://spec.openapis.org/oas/3.1/vocab/base": false
+  },
+  "$dynamicAnchor": "meta",
+
+  "title": "OpenAPI 3.1 Schema Object Dialect",
+  "allOf": [
+    { "$ref": "https://json-schema.org/draft/2020-12/schema" },
+    { "$ref": "https://spec.openapis.org/oas/3.1/meta/base" }
+  ]
+};

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

@@ -0,0 +1,88 @@
+import type { Json } from "@hyperjump/json-pointer";
+import type { JsonSchemaType } from "../lib/common.js";
+
+
+export type OasSchema31 = boolean | {
+  $schema?: "https://json-schema.org/draft/2020-12/schema";
+  $id?: string;
+  $anchor?: string;
+  $ref?: string;
+  $dynamicRef?: string;
+  $dynamicAnchor?: string;
+  $vocabulary?: Record<string, boolean>;
+  $comment?: string;
+  $defs?: Record<string, OasSchema31>;
+  additionalItems?: OasSchema31;
+  unevaluatedItems?: OasSchema31;
+  prefixItems?: OasSchema31[];
+  items?: OasSchema31;
+  contains?: OasSchema31;
+  additionalProperties?: OasSchema31;
+  unevaluatedProperties?: OasSchema31;
+  properties?: Record<string, OasSchema31>;
+  patternProperties?: Record<string, OasSchema31>;
+  dependentSchemas?: Record<string, OasSchema31>;
+  propertyNames?: OasSchema31;
+  if?: OasSchema31;
+  then?: OasSchema31;
+  else?: OasSchema31;
+  allOf?: OasSchema31[];
+  anyOf?: OasSchema31[];
+  oneOf?: OasSchema31[];
+  not?: OasSchema31;
+  multipleOf?: number;
+  maximum?: number;
+  exclusiveMaximum?: number;
+  minimum?: number;
+  exclusiveMinimum?: number;
+  maxLength?: number;
+  minLength?: number;
+  pattern?: string;
+  maxItems?: number;
+  minItems?: number;
+  uniqueItems?: boolean;
+  maxContains?: number;
+  minContains?: number;
+  maxProperties?: number;
+  minProperties?: number;
+  required?: string[];
+  dependentRequired?: Record<string, string[]>;
+  const?: Json;
+  enum?: Json[];
+  type?: JsonSchemaType | JsonSchemaType[];
+  title?: string;
+  description?: string;
+  default?: Json;
+  deprecated?: boolean;
+  readOnly?: boolean;
+  writeOnly?: boolean;
+  examples?: Json[];
+  format?: "date-time" | "date" | "time" | "duration" | "email" | "idn-email" | "hostname" | "idn-hostname" | "ipv4" | "ipv6" | "uri" | "uri-reference" | "iri" | "iri-reference" | "uuid" | "uri-template" | "json-pointer" | "relative-json-pointer" | "regex";
+  contentMediaType?: string;
+  contentEncoding?: string;
+  contentSchema?: OasSchema31;
+  example: Json;
+  discriminator: Discriminator;
+  externalDocs: ExternalDocs;
+  xml: Xml;
+};
+
+type Discriminator = {
+  propertyName: string;
+  mappings: Record<string, string>;
+};
+
+type ExternalDocs = {
+  url: string;
+  description: string;
+};
+
+type Xml = {
+  name: string;
+  namespace: string;
+  prefix: string;
+  attribute: boolean;
+  wrapped: boolean;
+};
+
+export * from "../lib/index.js";

package/openapi-3-1/index.js

@@ -0,0 +1,48 @@
+import { addKeyword, defineVocabulary, loadDialect } from "../lib/keywords.js";
+import { addSchema } from "../lib/core.js";
+import "../lib/openapi.js";
+
+import dialectSchema from "./dialect/base.js";
+import vocabularySchema from "./meta/base.js";
+import schema20221007 from "./schema/2022-10-07.js";
+import schemaBase20221007 from "./schema-base/2022-10-07.js";
+
+import discriminator from "../openapi-3-0/discriminator.js";
+import example from "../openapi-3-0/example.js";
+import externalDocs from "../openapi-3-0/externalDocs.js";
+import xml from "../openapi-3-0/xml.js";
+
+
+addKeyword(discriminator);
+addKeyword(example);
+addKeyword(externalDocs);
+addKeyword(xml);
+
+defineVocabulary("https://spec.openapis.org/oas/3.1/vocab/base", {
+  "discriminator": "https://spec.openapis.org/oas/3.0/keyword/discriminator",
+  "example": "https://spec.openapis.org/oas/3.0/keyword/example",
+  "externalDocs": "https://spec.openapis.org/oas/3.0/keyword/externalDocs",
+  "xml": "https://spec.openapis.org/oas/3.0/keyword/xml"
+});
+
+loadDialect("https://spec.openapis.org/oas/3.1/schema-base", {
+  "https://json-schema.org/draft/2020-12/vocab/core": true,
+  "https://json-schema.org/draft/2020-12/vocab/applicator": true,
+  "https://json-schema.org/draft/2020-12/vocab/validation": true,
+  "https://json-schema.org/draft/2020-12/vocab/meta-data": true,
+  "https://json-schema.org/draft/2020-12/vocab/format-annotation": true,
+  "https://json-schema.org/draft/2020-12/vocab/content": true,
+  "https://json-schema.org/draft/2020-12/vocab/unevaluated": true,
+  "https://spec.openapis.org/oas/3.1/vocab/base": false
+}, true);
+
+addSchema(vocabularySchema);
+addSchema(dialectSchema);
+
+// Current Schemas
+addSchema(schema20221007, "https://spec.openapis.org/oas/3.1/schema");
+addSchema(schema20221007, "https://spec.openapis.org/oas/3.1/schema/latest");
+addSchema(schemaBase20221007, "https://spec.openapis.org/oas/3.1/schema-base");
+addSchema(schemaBase20221007, "https://spec.openapis.org/oas/3.1/schema-base/latest");
+
+export * from "../draft-2020-12/index.js";

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

@@ -0,0 +1,76 @@
+export default {
+  "$id": "https://spec.openapis.org/oas/3.1/meta/base",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$dynamicAnchor": "meta",
+  "title": "OAS Base vocabulary",
+
+  "type": ["object", "boolean"],
+  "properties": {
+    "example": true,
+    "discriminator": { "$ref": "#/$defs/discriminator" },
+    "externalDocs": { "$ref": "#/$defs/external-docs" },
+    "xml": { "$ref": "#/$defs/xml" }
+  },
+  "$defs": {
+    "extensible": {
+      "patternProperties": {
+        "^x-": true
+      }
+    },
+    "discriminator": {
+      "$ref": "#/$defs/extensible",
+      "type": "object",
+      "properties": {
+        "propertyName": {
+          "type": "string"
+        },
+        "mapping": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "required": ["propertyName"],
+      "unevaluatedProperties": false
+    },
+    "external-docs": {
+      "$ref": "#/$defs/extensible",
+      "type": "object",
+      "properties": {
+        "url": {
+          "type": "string",
+          "format": "uri-reference"
+        },
+        "description": {
+          "type": "string"
+        }
+      },
+      "required": ["url"],
+      "unevaluatedProperties": false
+    },
+    "xml": {
+      "$ref": "#/$defs/extensible",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "namespace": {
+          "type": "string",
+          "format": "uri"
+        },
+        "prefix": {
+          "type": "string"
+        },
+        "attribute": {
+          "type": "boolean"
+        },
+        "wrapped": {
+          "type": "boolean"
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  }
+};