Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/christianmurphy/json-schema-keyref
Validate key references from JSON Schema
https://github.com/christianmurphy/json-schema-keyref
json-schema key-value typescript
Last synced: 5 days ago
JSON representation
Validate key references from JSON Schema
- Host: GitHub
- URL: https://github.com/christianmurphy/json-schema-keyref
- Owner: ChristianMurphy
- License: mit
- Created: 2016-07-21T01:27:06.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T14:02:06.000Z (10 days ago)
- Last Synced: 2024-10-27T15:49:31.478Z (9 days ago)
- Topics: json-schema, key-value, typescript
- Language: TypeScript
- Homepage: https://christianmurphy.github.io/json-schema-keyref
- Size: 3.27 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSON Schema KeyRef
[](https://www.npmjs.com/package/json-schema-keyref)
[](https://github.com/ChristianMurphy/json-schema-keyref/actions/workflows/CI.yml)
## About
This is an extension to the standard JSON Schema. It allows for validating the
references to remote values, actually have the value that is being referenced.
See [Example](#example) for a sample use case.
## Installation
Install from npm
```sh
npm install --save json-schema-keyref
```
## Usage
```js
const fs = require("fs");
const jsonSchemaKeyref = require("json-schema-keyref");
const document = JSON.parse(fs.readSync("document.json"));
const schema = JSON.parse(fs.readSync("schema.json"));
// Validate document against standard JSON schema using tv4 or another library
const result = jsonSchemaKeyref.validate(document, schema);
console.log(result); //=> {"errors": [], "isValid": true}
```
## Example
Below is a User and Transaction database. Where users have an `id` and `name`.
And transactions are `from` one user `id`, `to` another user `id`, with an
`amount`.
Using key reference validator, transaction 2 would be flagged because user 3
does not exist in the data.
Data:
```json
{
"users": [
{
"id": 1,
"name": "user 1"
},
{
"id": 2,
"name": "user 2"
}
],
"transactions": [
{
"from": 1,
"to": 2,
"amount": 1.0
},
{
"from": 3,
"to": 1,
"amount": 99.99
}
]
}
```
Schema:
```json
{
"key": {
"to": "$.users[*].id",
"from": "$.users[*].id"
},
"keyref": {
"to": "$.transactions[*].to",
"from": "$.transactions[*].from"
},
"title": "Employee and Transaction Database",
"type": "object",
"properties": {
"users": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": ["id", "name"]
},
"transactions": {
"type": "object",
"properties": {
"to": {
"type": "integer"
},
"from": {
"type": "integer"
},
"amount": {
"type": "number"
}
}
}
},
"required": ["users", "transactions"]
}
```