Package Exports

json-ref-lite
json-ref-lite/index.coffee

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (json-ref-lite) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Extremely light weight module to resolve jsonschema '$ref' references

This is a zero-dependency module. I found similar modules but for some reason they had 10++ dependencies.

Usage

reflite = require('json-ref-lite')();

json = {
  foo: {
    id: 'foobar',
    value: 'bar'
  },
  example: {
    '$ref': 'foobar'
  }
};

console.dir(reflite.resolve(json));

Outputs:

{ 
  foo: { id: 'foobar', value: 'bar' },
  example: { value: 'bar' } 
}

Why?

Because dont-repeat-yourself (DRY)! It is extremely useful to use '$ref' keys in json.

Features

supports resolving json references to 'id'-fields ( "$ref": "foobar" )
supports resolving internal jsonpointers ( "$ref": "#/foo/value" )
supports resolving local files ( "$ref": "/some/path/test.json" )
supports resolving remote json(schema) files ( "$ref": "http://foo.com/person.json" )
supports resolving remote jsonpointers: ( "$ref": "http://foo.com/person.json#/address/street" )

Example: id fields

json = {
  foo: {
    id: 'foobar',
    value: 'bar'
  },
  example: {
    '$ref': 'foobar'
  }
};

outputs:

{ 
  foo: { id: 'foobar', value: 'bar' },
  example: { value: 'bar' } 
}

Example: jsonpointers

{
  foo: {
    value: 'bar',
    foo: 'flop'
  },
  example: {
    ids: {
      '$ref': '#/foo/foo'
    }
  }
}

outputs:

{
  foo: {
    value: 'bar',
    foo: 'flop'
  },
  example: {
    ids: 'flop' 
  }
}

NOTE: escaping slashes in keys is supported. "#/model/foo['\\/bar']/flop" will try to reference model.foo['/bar'].flop from itself

Example: remote schemas

{
  foo: {
    "$ref": "http://json-schema.org/address"
  }
  bar: {
    "$ref": "http://json-schema.org/address#/street/number"
  }
}

outputs: replaces value of foo with jsonresult from given url, also supports jsonpointers to remote source

NOTE: please install like so for remote support: 'npm install json-ref-lite sync-request'

Example: local files

{
  foo: {
    "$ref": "./test.json"
  }
}

outputs: replaces value of foo with contents of file test.json (use './' for current directory).