@hyperjump/json-schema 1.5.2 → 1.6.1

package/README.md

@@ -18,8 +18,8 @@ A collection of modules for working with JSON Schemas.
 * Provides utilities for working with annotations
 
 ## Install
-Includes support for node.js (ES Modules, TypeScript) and browsers (works with
-CSP
+Includes support for node.js/bun.js (ES Modules, TypeScript) and browsers (works
+with CSP
 [`unsafe-eval`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src#unsafe_eval_expressions)).
 
 ### Node.js
@@ -42,6 +42,16 @@ configuration.
   ]
 ```
 
+### TypeScript
+This package uses the package.json "exports" field. [TypeScript understands
+"exports"](https://devblogs.microsoft.com/typescript/announcing-typescript-4-5-beta/#packagejson-exports-imports-and-self-referencing),
+but you need to change a couple settings in your `tsconfig.json` for it to work.
+
+```jsonc
+    "module": "Node16", // or "NodeNext"
+    "moduleResolution": "Node16", // or "NodeNext"
+```
+
 ### Versioning
 The API for this library is divided into two categories: Stable and
 Experimental. The Stable API strictly follows semantic versioning, but the
@@ -98,20 +108,30 @@ const output2 = isString(42);
 
 **Fetching schemas**
 
-You can fetch schemas from the web or from the file system, but when fetching
-from the file system, there are limitations for security reasons. If your schema
-has an identifier with an http(s) scheme (**https**://example.com), it's not
-allowed to reference schemas with a file scheme
-(**file**:///path/to/my/schemas).
+Schemas that are available on the web can be loaded automatically without
+needing to load them manually.
 
 ```javascript
 const output = await validate("http://example.com/schemas/string", "foo");
 ```
 
+When running on the server, you can also load schemas directly from the
+filesystem using `file:` URIs. When fetching from the file system, there are
+limitations for security reasons. If your schema has an identifier with an
+http(s) scheme (**https**://example.com), it's not allowed to reference schemas
+with a file scheme (**file**:///path/to/my/schemas).
+
 ```javascript
 const output = await validate(`file://${__dirname}/string.schema.json`, "foo");
 ```
 
+If the schema URI is relative, the base URI in the browser is the browser
+location and the base URI on the server is the current working directory.
+
+```javascript
+const output = await validate(`./string.schema.json`, "foo");
+```
+
 **Media type plugins**
 
 There is a plugin system for adding support for different media types. By
@@ -174,11 +194,11 @@ Schema, such as `@hyperjump/json-schema/draft-2020-12`.
 
     Load a schema manually rather than fetching it from the filesystem or over
     the network.
-* **validate**: (schemaURI: string, instance: any, outputFormat: OutputFormat = FLAG) => Promise<OutputUnit>
+* **validate**: (schemaURI: string, instance: any, outputFormat: OutputFormat = * FLAG) => Promise\<OutputUnit>
 
     Validate an instance against a schema. This function is curried to allow
     compiling the schema once and applying it to multiple instances.
-* **validate**: (schemaURI: string) => Promise<(instance: any, outputFormat: OutputFormat = FLAG) => OutputUnit>
+* **validate**: (schemaURI: string) => Promise\<(instance: any, outputFormat: OutputFormat = FLAG) => OutputUnit>
 
     Compiling a schema to a validation function.
 * **FLAG**: "FLAG"
@@ -293,7 +313,7 @@ const bundledSchema = await bundle("https://example.com/main"); // {
 ### API
 These are available from the `@hyperjump/json-schema/bundle` export.
 
-* **bundle**: (uri: string, options: Options) => Promise<SchemaObject>
+* **bundle**: (uri: string, options: Options) => Promise\<SchemaObject>
 
     Create a bundled schema starting with the given schema. External schemas
     will be fetched from the filesystem, the network, or internally as needed.
@@ -513,7 +533,7 @@ These are available from the `@hyperjump/json-schema/experimental` export.
 
         A URI that uniquely identifies the keyword. It should use a domain you
         own to avoid conflict with keywords defined by others.
-    * compile: (schema: SchemaDocument, ast: AST, parentSchema: SchemaDocument) => Promise<A>
+    * compile: (schema: SchemaDocument, ast: AST, parentSchema: SchemaDocument) * => Promise\<A>
 
         This function takes the keyword value, does whatever preprocessing it
         can on it without an instance, and returns the result. The returned
@@ -531,7 +551,7 @@ These are available from the `@hyperjump/json-schema/experimental` export.
 
         If the keyword is an applicator, it will need to implements this
         function for `unevaluatedProperties` to work as expected.
-    * collectEvaluatedItems?: (compiledKeywordValue: A, instance: JsonDocument, ast: AST, dynamicAnchors: Anchors) => Set<number> | false
+    * collectEvaluatedItems?: (compiledKeywordValue: A, instance: JsonDocument, * ast: AST, dynamicAnchors: Anchors) => Set\<number> | false
 
         If the keyword is an applicator, it will need to implements this
         function for `unevaluatedItems` to work as expected.
@@ -547,7 +567,7 @@ set of functions for working with SchemaDocuments.
 * **Schema.add**: (schema: object, retrievalUri?: string, dialectId?: string) => string
 
     Load a schema. Returns the identifier for the schema.
-* **Schema.get**: (url: string, contextDoc?: SchemaDocument) => Promise<SchemaDocument>
+* **Schema.get**: (url: string, contextDoc?: SchemaDocument) => Promise\<SchemaDocument>
 
     Fetch a schema. Schemas can come from an HTTP request, a file, or a schema
     that was added with `Schema.add`.
@@ -560,22 +580,22 @@ set of functions for working with SchemaDocuments.
 * **Schema.typeOf**: (doc: SchemaDocument, type: string) => boolean
 
     Determines if the JSON type of the given doc matches the given type.
-* **Schema.has**: (key: string, doc: SchemaDocument) => Promise<SchemaDocument>
+* **Schema.has**: (key: string, doc: SchemaDocument) => Promise\<SchemaDocument>
 
     Similar to `key in schema`.
-* **Schema.step**: (key: string, doc: SchemaDocument) => Promise<SchemaDocument>
+* **Schema.step**: (key: string, doc: SchemaDocument) => Promise\<SchemaDocument>
 
     Similar to `schema[key]`, but returns an SchemaDocument.
-* **Schema.iter**: (doc: SchemaDocument) => AsyncGenerator<SchemaDocument>
+* **Schema.iter**: (doc: SchemaDocument) => AsyncGenerator\<SchemaDocument>
 
     Iterate over the items in the array that the SchemaDocument represents
-* **Schema.entries**: (doc: SchemaDocument) => AsyncGenerator<[string, SchemaDocument]>
+* **Schema.entries**: (doc: SchemaDocument) => AsyncGenerator\<[string, SchemaDocument]>
 
     Similar to `Object.entries`, but yields SchemaDocuments for values.
-* **Schema.values**: (doc: SchemaDocument) => AsyncGenerator<SchemaDocument>
+* **Schema.values**: (doc: SchemaDocument) => AsyncGenerator\<SchemaDocument>
 
     Similar to `Object.values`, but yields SchemaDocuments for values.
-* **Schema.keys**: (doc: SchemaDocument) => Generator<string>
+* **Schema.keys**: (doc: SchemaDocument) => Generator\<string>
 
     Similar to `Object.keys`.
 * **Schema.length**: (doc: SchemaDocument) => number
@@ -627,16 +647,16 @@ set of functions for working with InstanceDocuments.
 * **Instance.step**: (key: string, doc: InstanceDocument) => InstanceDocument
 
     Similar to `schema[key]`, but returns a InstanceDocument.
-* **Instance.iter**: (doc: InstanceDocument) => Generator<InstanceDocument>
+* **Instance.iter**: (doc: InstanceDocument) => Generator\<InstanceDocument>
 
     Iterate over the items in the array that the SchemaDocument represents.
-* **Instance.entries**: (doc: InstanceDocument) => Generator<[string, InstanceDocument]>
+* **Instance.entries**: (doc: InstanceDocument) => Generator\<[string, InstanceDocument]>
 
     Similar to `Object.entries`, but yields InstanceDocuments for values.
-* **Instance.values**: (doc: InstanceDocument) => Generator<InstanceDocument>
+* **Instance.values**: (doc: InstanceDocument) => Generator\<InstanceDocument>
 
     Similar to `Object.values`, but yields InstanceDocuments for values.
-* **Instance.keys**: (doc: InstanceDocument) => Generator<string>
+* **Instance.keys**: (doc: InstanceDocument) => Generator\<string>
 
     Similar to `Object.keys`.
 * **Instance.length**: (doc: InstanceDocument) => number
@@ -723,7 +743,7 @@ for (const deprecated of AnnotatedInstance.annotatedWith(instance, "deprecated",
 These are available from the `@hyperjump/json-schema/annotations/experimental`
 export.
 
-* **annotate**: (schemaUri: string, instance: any, outputFormat: OutputFormat = FLAG) => Promise<AnnotatedInstance>
+* **annotate**: (schemaUri: string, instance: any, outputFormat: OutputFormat = * FLAG) => Promise\<AnnotatedInstance>
 
     Annotate an instance using the given schema. The function is curried to
     allow compiling the schema once and applying it to multiple instances. This
@@ -757,7 +777,7 @@ following functions are available in addition to the functions available in the
 ### API
 These are available from the `@hyperjump/json-schema/experimental` export.
 
-* **compile**: (schema: SchemaDocument) => Promise<CompiledSchema>
+* **compile**: (schemaUri: string) => Promise\<CompiledSchema>
 
     Return a compiled schema. This is useful if you're creating tooling for
     something other than validation.

package/lib/context-uri.browser.js

@@ -0,0 +1 @@
+export const contextUri = () => document.location.toString();

package/lib/context-uri.js

@@ -0,0 +1,4 @@
+import { cwd } from "node:process";
+
+
+export const contextUri = () => `file://${cwd()}/`;

package/lib/core.d.ts

@@ -20,7 +20,7 @@ export const addSchema: typeof add;
 
 export type Validator = (value: unknown, outputFormat?: OutputFormat) => OutputUnit;
 
-export type OutputFormat = "FLAG" | "BASIC" | "DETAILED" | "VERBOSE" | string;
+export type OutputFormat = "FLAG" | "BASIC" | "DETAILED" | "VERBOSE";
 
 export type OutputUnit = {
   keyword: string;

package/lib/fetch.js

@@ -1,15 +1,15 @@
-import fs from "fs/promises";
+import { createReadStream } from "node:fs";
+import { Readable } from "node:stream";
+import { fileURLToPath } from "node:url";
 import { fetch, Response } from "undici";
-import Url from "url";
 import * as MediaTypes from "./media-types.js";
 
 
-export default async (url, options) => {
+export default (url, options) => {
   if (url.startsWith("file://")) {
-    const filePath = Url.fileURLToPath(url);
-    const fd = await fs.open(filePath);
-    const stream = fd.createReadStream();
-    const response = new Response(stream, {
+    const filePath = fileURLToPath(url);
+    const stream = createReadStream(filePath);
+    const response = new Response(Readable.toWeb(stream), {
       headers: { "Content-Type": MediaTypes.getContentType(filePath) }
     });
     Object.defineProperty(response, "url", { value: url });

package/lib/instance.js

@@ -1,4 +1,4 @@
-import { append as pointerAppend } from "@hyperjump/json-pointer";
+import { append as pointerAppend, get as pointerGet } from "@hyperjump/json-pointer";
 import { toAbsoluteIri } from "@hyperjump/uri";
 import curry from "just-curry-it";
 import { jsonTypeOf } from "./common.js";
@@ -18,7 +18,12 @@ export const get = (url, instance = nil) => {
     throw Error(`No JSON document found at '${url.split("#")[0]}'`);
   }
 
-  return { ...instance, pointer: url.substr(1) };
+  const pointer = url.substr(1);
+  return {
+    ...instance,
+    pointer: pointer,
+    value: pointerGet(pointer, instance.instance)
+  };
 };
 
 export const uri = (doc) => `${doc.id || ""}#${encodeURI(doc.pointer)}`;

package/lib/keywords/additionalProperties.js

@@ -1,4 +1,4 @@
-import { concat, join, empty, map, filter, every, pipe, tap } from "@hyperjump/pact";
+import { concat, join, empty, map, filter, every, pipe } from "@hyperjump/pact";
 import * as Schema from "../schema.js";
 import * as Instance from "../instance.js";
 import { getKeywordName } from "../keywords.js";

package/lib/schema.js

@@ -1,6 +1,7 @@
 import { nil as nilPointer, append as pointerAppend, get as pointerGet } from "@hyperjump/json-pointer";
 import { toAbsoluteIri } from "@hyperjump/uri";
 import { jsonTypeOf, resolveUri, uriFragment, pathRelative, jsonStringify } from "./common.js";
+import { contextUri } from "./context-uri.js";
 import fetch from "./fetch.js";
 import { hasDialect, loadDialect, getKeywordName } from "./keywords.js";
 import { parseResponse, acceptableMediaTypes } from "./media-types.js";
@@ -11,13 +12,14 @@ import * as Reference from "./reference.js";
 const schemaStore = {};
 const schemaStoreAlias = {};
 
-const defaultDialectId = "https://json-schema.org/validation";
-
 export const add = (schema, retrievalUri = undefined, contextDialectId = undefined) => {
   schema = JSON.parse(JSON.stringify(schema));
 
   // Dialect / JSON Schema Version
-  const dialectId = toAbsoluteIri(schema.$schema || contextDialectId || defaultDialectId);
+  if ((typeof schema !== "object" || !("$schema" in schema)) && !contextDialectId) {
+    throw Error("Unable to determine a dialect for the schema. The dialect can be declared in a number of ways, but the recommended way is to use the '$schema' keyword in your schema.");
+  }
+  const dialectId = toAbsoluteIri(schema.$schema || contextDialectId);
   delete schema.$schema;
 
   if (!hasDialect(dialectId)) {
@@ -159,7 +161,7 @@ const nil = {
 };
 
 export const get = async (url, contextDoc = nil) => {
-  const resolvedUrl = resolveUri(url, contextDoc.id);
+  const resolvedUrl = resolveUri(url, contextDoc.id || contextUri());
   const id = toAbsoluteIri(resolvedUrl);
   const fragment = uriFragment(resolvedUrl);
 
@@ -173,9 +175,11 @@ export const get = async (url, contextDoc = nil) => {
     const [schema, contextDialectId] = await parseResponse(response);
 
     // Try to determine the dialect from the meta-schema if it isn't already known
-    const dialectId = toAbsoluteIri(schema.$schema || contextDialectId || defaultDialectId);
-    if (!hasDialect(dialectId) && !hasStoredSchema(dialectId)) {
-      await get(dialectId);
+    if (schema.$schema || contextDialectId) {
+      const dialectId = toAbsoluteIri(schema.$schema || contextDialectId);
+      if (!hasDialect(dialectId) && !hasStoredSchema(dialectId)) {
+        await get(dialectId);
+      }
     }
 
     add(schema, id, contextDialectId);
@@ -272,7 +276,7 @@ export const toSchema = (schemaDoc, options = {}) => {
     dynamicAnchors[pointer] = anchor;
   }
 
-  const schema = JSON.parse(jsonStringify(schemaDoc.schema, (key, value, pointer) => {
+  const schema = JSON.parse(jsonStringify(schemaDoc.schema, (_key, value, pointer) => {
     if (Reference.isReference(value)) {
       const refValue = Reference.value(value);
       if (fullOptions.includeEmbedded || !(idToken in refValue)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperjump/json-schema",
-  "version": "1.5.2",
+  "version": "1.6.1",
   "description": "A JSON Schema validator with support for custom keywords, vocabularies, and dialects",
   "type": "module",
   "main": "./stable/index.js",
@@ -21,20 +21,24 @@
     "./bundle": "./bundle/index.js"
   },
   "browser": {
-    "./lib/fetch.js": "./lib/fetch.browser.js"
+    "./lib/fetch.js": "./lib/fetch.browser.js",
+    "./lib/context-uri.js": "./lib/context-uri.browser.js"
   },
   "scripts": {
     "clean": "xargs -a .gitignore rm -rf",
-    "lint": "eslint lib stable draft-* openapi-*",
+    "lint": "eslint lib stable draft-* openapi-* bundle annotations",
     "test": "mocha 'lib/**/*.spec.ts' 'stable/**/*.spec.ts' 'draft-*/**/*.spec.ts' 'openapi-*/**/*.spec.ts' 'bundle/**/*.spec.ts' 'annotations/**/*.spec.ts'"
   },
   "repository": "github:hyperjump-io/json-schema",
   "keywords": [
     "JSON Schema",
+    "json-schema",
+    "jsonschema",
     "JSON",
     "Schema",
     "2020-12",
     "2019-09",
+    "draft-07",
     "draft-06",
     "draft-04",
     "vocabulary",
@@ -49,6 +53,7 @@
   "devDependencies": {
     "@types/chai": "*",
     "@types/mocha": "*",
+    "@types/node": "^20.6.2",
     "@typescript-eslint/eslint-plugin": "*",
     "@typescript-eslint/parser": "*",
     "chai": "*",

package/stable/index.js

@@ -97,7 +97,8 @@ defineVocabulary("https://json-schema.org/vocab/unevaluated", {
   "unevaluatedProperties": "https://json-schema.org/keyword/unevaluatedProperties"
 });
 
-loadDialect("https://json-schema.org/validation", {
+const dialectId = "https://json-schema.org/validation";
+loadDialect(dialectId, {
   "https://json-schema.org/vocab/core": true,
   "https://json-schema.org/vocab/applicator": true,
   "https://json-schema.org/vocab/validation": true,
@@ -107,14 +108,14 @@ loadDialect("https://json-schema.org/validation", {
   "https://json-schema.org/vocab/unevaluated": true
 });
 
-addSchema(metaSchema);
-addSchema(coreMetaSchema);
-addSchema(applicatorMetaSchema);
-addSchema(validationMetaSchema);
-addSchema(metaDataMetaSchema);
-addSchema(formatAnnotationMetaSchema);
-addSchema(formatAssertionMetaSchema);
-addSchema(contentMetaSchema);
-addSchema(unevaluatedMetaSchema);
+addSchema(metaSchema, dialectId);
+addSchema(coreMetaSchema, "https://json-schema.org/meta/core");
+addSchema(applicatorMetaSchema, "https://json-schema.org/meta/applicator");
+addSchema(validationMetaSchema, "https://json-schema.org/meta/validation");
+addSchema(metaDataMetaSchema, "https://json-schema.org/meta/meta-data");
+addSchema(formatAnnotationMetaSchema, "https://json-schema.org/meta/format-annotation");
+addSchema(formatAssertionMetaSchema, "https://json-schema.org/meta/format-assertion");
+addSchema(contentMetaSchema, "https://json-schema.org/meta/content");
+addSchema(unevaluatedMetaSchema, "https://json-schema.org/meta/unevaluated");
 
 export * from "../lib/index.js";

package/stable/meta/applicator.js

@@ -1,5 +1,5 @@
 export default {
-  "$id": "https://json-schema.org/meta/applicator",
+  "$schema": "https://json-schema.org/validation",
   "title": "Applicator vocabulary meta-schema",
 
   "$dynamicAnchor": "meta",

package/stable/meta/content.js

@@ -1,5 +1,5 @@
 export default {
-  "$id": "https://json-schema.org/meta/content",
+  "$schema": "https://json-schema.org/validation",
   "title": "Content vocabulary meta-schema",
 
   "$dynamicAnchor": "meta",

package/stable/meta/core.js

@@ -1,5 +1,5 @@
 export default {
-  "$id": "https://json-schema.org/meta/core",
+  "$schema": "https://json-schema.org/validation",
   "title": "Core vocabulary meta-schema",
 
   "$dynamicAnchor": "meta",

package/stable/meta/format-annotation.js

@@ -1,5 +1,5 @@
 export default {
-  "$id": "https://json-schema.org/meta/format-annotation",
+  "$schema": "https://json-schema.org/validation",
   "title": "Format vocabulary meta-schema for annotation results",
 
   "$dynamicAnchor": "meta",

package/stable/meta/format-assertion.js

@@ -1,5 +1,5 @@
 export default {
-  "$id": "https://json-schema.org/meta/format-assertion",
+  "$schema": "https://json-schema.org/validation",
   "title": "Format vocabulary meta-schema for assertion results",
 
   "$dynamicAnchor": "meta",

package/stable/meta/meta-data.js

@@ -1,5 +1,5 @@
 export default {
-  "$id": "https://json-schema.org/meta/meta-data",
+  "$schema": "https://json-schema.org/validation",
   "title": "Meta-data vocabulary meta-schema",
 
   "$dynamicAnchor": "meta",

package/stable/meta/unevaluated.js

@@ -1,5 +1,5 @@
 export default {
-  "$id": "https://json-schema.org/meta/unevaluated",
+  "$schema": "https://json-schema.org/validation",
   "title": "Unevaluated applicator vocabulary meta-schema",
 
   "$dynamicAnchor": "meta",

package/stable/meta/validation.js

@@ -1,5 +1,5 @@
 export default {
-  "$id": "https://json-schema.org/meta/validation",
+  "$schema": "https://json-schema.org/validation",
   "title": "Validation vocabulary meta-schema",
 
   "$dynamicAnchor": "meta",

package/stable/validation.js

@@ -1,5 +1,5 @@
 export default {
-  "$id": "https://json-schema.org/validation",
+  "$schema": "https://json-schema.org/validation",
   "$vocabulary": {
     "https://json-schema.org/vocab/core": true,
     "https://json-schema.org/vocab/applicator": true,