JSON Schema Reference Resolver

Takes a $ref string and a root object, and returns the referenced value.

Works in browser & in node (file system refs ignored in browser).

Easily add support for your own protocols.

Getting Started

npm install @json-schema-tools/reference-resolver

1import refRes from "@json-schema-tools/reference-resolver";
2
3refRes.resolve("#/properties/foo", { properties: { foo: true } }); // returns true
4refRes.resolve("https://foo.com/"); // returns what ever json foo.com returns
5refRef.resolve("../my-object.json"); // you get teh idea

Adding custom protocol handlers

1import referenceResolver from "@json-schema-tools/reference-resolver";
2import JSONSchema from "@json-schema-tools/meta-schema";
3
4referenceResolver.protocolHandlerMap.ipfs = (uri) => {
5   const pretendItsFetchedFromIpfs = {
6     title: "foo",
7     type: "string",
8   } as JSONSchema;
9   return Promise.resolve(fetchedFromIpfs);
10};
11
12referenceResolver.protocolHandlerMap["customprotocol"] = (uri) => {
13   return Promise.resolve({
14     type: "string",
15     title: uri.replace("customprotocol://", ""),
16   });
17};
18
19referenceResolver.resolve("ipfs://80088008800880088008");
20referenceResolver.resolve("customprotocol://foobar");

Contributing

How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.