{"id":20330067,"url":"https://github.com/json-schema-tools/reference-resolver","last_synced_at":"2025-04-11T21:03:04.033Z","repository":{"id":37797681,"uuid":"282066031","full_name":"json-schema-tools/reference-resolver","owner":"json-schema-tools","description":"takes $ref strings and a root object, returns the resolved value of the reference","archived":false,"fork":false,"pushed_at":"2024-08-26T16:05:57.000Z","size":1536,"stargazers_count":6,"open_issues_count":12,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T21:02:55.478Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://json-schema-tools.github.io/reference-resolver/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/json-schema-tools.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"belfordz","open_collective":"zachary-belford"}},"created_at":"2020-07-23T22:08:35.000Z","updated_at":"2025-03-10T12:24:01.000Z","dependencies_parsed_at":"2024-12-22T11:06:49.005Z","dependency_job_id":"114780fc-21a5-4fe8-8e0d-8b2de4a18931","html_url":"https://github.com/json-schema-tools/reference-resolver","commit_stats":{"total_commits":116,"total_committers":6,"mean_commits":"19.333333333333332","dds":0.5603448275862069,"last_synced_commit":"ec64513e3f00b15c23f0004f786f339914af83da"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/json-schema-tools%2Freference-resolver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/json-schema-tools%2Freference-resolver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/json-schema-tools%2Freference-resolver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/json-schema-tools%2Freference-resolver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/json-schema-tools","download_url":"https://codeload.github.com/json-schema-tools/reference-resolver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248480437,"owners_count":21110937,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T20:14:49.975Z","updated_at":"2025-04-11T21:03:03.889Z","avatar_url":"https://github.com/json-schema-tools.png","language":"TypeScript","funding_links":["https://github.com/sponsors/belfordz","https://opencollective.com/zachary-belford"],"categories":[],"sub_categories":[],"readme":"# JSON Schema Reference Resolver\n\n\u003ccenter\u003e\n  \u003cspan\u003e\n    \u003cimg alt=\"CircleCI branch\" src=\"https://img.shields.io/circleci/project/github/json-schema-tools/reference-resolver/master.svg\"\u003e\n    \u003cimg src=\"https://codecov.io/gh/json-schema-tools/reference-resolver/branch/master/graph/badge.svg\" /\u003e\n    \u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/dt/@json-schema-tools/reference-resolver.svg\" /\u003e\n    \u003cimg alt=\"GitHub release\" src=\"https://img.shields.io/github/release/json-schema-tools/reference-resolver.svg\" /\u003e\n    \u003cimg alt=\"GitHub commits since latest release\" src=\"https://img.shields.io/github/commits-since/json-schema-tools/reference-resolver/latest.svg\" /\u003e\n  \u003c/span\u003e\n\u003c/center\u003e\n\nTakes a $ref string and a root object, and returns the referenced value.\n\nWorks in browser \u0026 in node (file system refs ignored in browser).\n\nEasily add support for your own protocols.\n\n## Getting Started\n\n`npm install @json-schema-tools/reference-resolver`\n\n```typescript\nimport refRes from \"@json-schema-tools/reference-resolver\";\n\nrefRes.resolve(\"#/properties/foo\", { properties: { foo: true } }); // returns true\nrefRes.resolve(\"https://foo.com/\"); // returns what ever json foo.com returns\nrefRef.resolve(\"../my-object.json\"); // you get teh idea\n```\n\n## Adding custom protocol handlers\n\n```typescript\nimport referenceResolver from \"@json-schema-tools/reference-resolver\";\nimport JSONSchema from \"@json-schema-tools/meta-schema\";\n\nreferenceResolver.protocolHandlerMap.ipfs = (uri) =\u003e {\n   const pretendItsFetchedFromIpfs = {\n     title: \"foo\",\n     type: \"string\",\n   } as JSONSchema;\n   return Promise.resolve(fetchedFromIpfs);\n};\n\nreferenceResolver.protocolHandlerMap[\"customprotocol\"] = (uri) =\u003e {\n   return Promise.resolve({\n     type: \"string\",\n     title: uri.replace(\"customprotocol://\", \"\"),\n   });\n};\n\nreferenceResolver.resolve(\"ipfs://80088008800880088008\");\nreferenceResolver.resolve(\"customprotocol://foobar\");\n```\n\n\n### Contributing\n\nHow to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING.md](BUILDING.md) and [RELEASING.md](RELEASING.md) respectively. Commits in this repository follow the [CONVENTIONAL_COMMITS.md](CONVENTIONAL_COMMITS.md) specification.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjson-schema-tools%2Freference-resolver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjson-schema-tools%2Freference-resolver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjson-schema-tools%2Freference-resolver/lists"}