Socket
Socket
Sign inDemoInstall

json-schema-ref-parser

Package Overview
Dependencies
7
Maintainers
1
Versions
91
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 7.1.4 to 8.0.0

index.d.ts

62

CHANGELOG.md

@@ -1,2 +0,3 @@

# Change Log
Change Log
====================================================================================================
All notable changes will be documented in this file.

@@ -6,4 +7,17 @@ JSON Schema $Ref Parser adheres to [Semantic Versioning](http://semver.org/).

## [v7.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v7.1.0) (2019-06-21)
[v8.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v8.0.0) (2020-03-13)
----------------------------------------------------------------------------------------------------
- Moved JSON Schema $Ref Parser to the [@APIDevTools scope](https://www.npmjs.com/org/apidevtools) on NPM
- The "json-schema-ref-parser" NPM package is now just a wrapper around the scoped "@apidevtools/json-schema-ref-parser" package
[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v7.1.4...v8.0.0)
[v7.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v7.1.0) (2019-06-21)
----------------------------------------------------------------------------------------------------
- Merged [PR #124](https://github.com/APIDevTools/json-schema-ref-parser/pull/124/), which provides more context to [custom resolvers](https://apitools.dev/json-schema-ref-parser/docs/plugins/resolvers.html).

@@ -14,4 +28,6 @@

## [v7.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v7.0.0) (2019-06-11)
[v7.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v7.0.0) (2019-06-11)
----------------------------------------------------------------------------------------------------
- Dropped support for Node 6

@@ -26,4 +42,6 @@

## [v6.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v6.0.0) (2018-10-04)
[v6.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v6.0.0) (2018-10-04)
----------------------------------------------------------------------------------------------------
- Dropped support for [Bower](https://www.npmjs.com/package/bower), since it has been deprecated

@@ -36,4 +54,6 @@

## [v5.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v5.1.0) (2018-07-11)
[v5.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v5.1.0) (2018-07-11)
----------------------------------------------------------------------------------------------------
- Improved the logic of the [`bundle()` method](https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#bundleschema-options-callback) to produce shorter reference paths when possible. This is not a breaking change, since both the old reference paths and the new reference paths are valid. The new ones are just shorter. Big thanks to [@hipstersmoothie](https://github.com/hipstersmoothie) for [PR #68](https://github.com/APIDevTools/json-schema-ref-parser/pull/68), which helped a lot with this.

@@ -44,4 +64,6 @@

## [v5.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v5.0.0) (2018-03-18)
[v5.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v5.0.0) (2018-03-18)
----------------------------------------------------------------------------------------------------
This release contains two bug fixes related to file paths. They are _technically_ breaking changes — hence the major version bump — but they're both edge cases that probably won't affect most users.

@@ -56,4 +78,6 @@

## [v4.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v4.1.0) (2018-01-17)
[v4.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v4.1.0) (2018-01-17)
----------------------------------------------------------------------------------------------------
- Updated dependencies

@@ -66,4 +90,6 @@

## [v4.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v4.0.0) (2017-10-13)
[v4.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v4.0.0) (2017-10-13)
----------------------------------------------------------------------------------------------------
#### Breaking Changes

@@ -82,4 +108,6 @@

## [v3.3.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v3.3.0) (2017-08-09)
[v3.3.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v3.3.0) (2017-08-09)
----------------------------------------------------------------------------------------------------
- Updated dependencies

@@ -94,4 +122,6 @@

## [v3.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v3.0.0) (2016-04-03)
[v3.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v3.0.0) (2016-04-03)
----------------------------------------------------------------------------------------------------
#### Plug-ins !!!

@@ -112,4 +142,6 @@ That's the major new feature in this version. Originally requested in [PR #8](https://github.com/APIDevTools/json-schema-ref-parser/pull/8), and refined a few times over the past few months, the plug-in API is now finalized and ready to use. You can now define your own [resolvers](https://github.com/APIDevTools/json-schema-ref-parser/blob/v3.0.0/docs/plugins/resolvers.md) and [parsers](https://github.com/APIDevTools/json-schema-ref-parser/blob/v3.0.0/docs/plugins/parsers.md).

## [v2.2.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v2.2.0) (2016-01-03)
[v2.2.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v2.2.0) (2016-01-03)
----------------------------------------------------------------------------------------------------
This version includes a **complete rewrite** of the [`bundle` method](https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#bundleschema-options-callback) method, mostly to fix [this bug](https://github.com/APIDevTools/swagger-parser/issues/16), but also to address a few [edge-cases](https://github.com/APIDevTools/json-schema-ref-parser/commit/ca9b322879519e4bcb2dcf6e63f08ac254b90868) that weren't handled before. As a side-effect of this rewrite, there was also some pretty significant refactoring and code-cleanup done throughout the codebase.

@@ -122,4 +154,6 @@

## [v2.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v2.1.0) (2015-12-31)
[v2.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v2.1.0) (2015-12-31)
----------------------------------------------------------------------------------------------------
JSON Schema $Ref Parser now automatically follows HTTP redirects. This is especially great for servers that automatically "ugrade" your connection from HTTP to HTTPS via a 301 redirect. Now that won't break your code.

@@ -132,4 +166,6 @@

## [v2.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v2.0.0) (2015-12-31)
[v2.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v2.0.0) (2015-12-31)
----------------------------------------------------------------------------------------------------
Bumping the major version number because [this change](https://github.com/APIDevTools/json-schema-ref-parser/pull/5) technically breaks backward-compatibility — although I doubt it will actually affect many people. Basically, if you're using JSON Schema $Ref Parser to download files from a CORS-enabled server that requires authentication, then you'll need to set the `http.withCredentials` option to `true`.

@@ -136,0 +172,0 @@

{
"name": "json-schema-ref-parser",
"version": "7.1.4",
"version": "8.0.0",
"description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",

@@ -31,46 +31,14 @@ "keywords": [

"license": "MIT",
"main": "lib/index.js",
"typings": "lib/index.d.ts",
"browser": {
"fs": false
},
"main": "index.js",
"typings": "index.d.ts",
"files": [
"lib"
"index.js",
"index.d.ts"
],
"scripts": {
"lint": "eslint lib test/fixtures test/specs",
"test": "npm run test:node && npm run test:browser && npm run test:typescript && npm run lint",
"test:node": "mocha",
"test:browser": "karma start --single-run",
"test:typescript": "tsc --noEmit --strict --lib esnext test/specs/typescript-definition.spec.ts",
"coverage": "npm run coverage:node && npm run coverage:browser",
"coverage:node": "nyc --reporter=text --reporter=lcov --report-dir coverage/node node_modules/mocha/bin/mocha",
"coverage:browser": "npm run test:browser -- --coverage",
"upgrade": "npm-check -u && npm audit fix",
"bump": "bump --tag --push --all",
"release": "npm run upgrade && npm test && npm run bump"
"engines": {
"node": ">=10"
},
"devDependencies": {
"@babel/polyfill": "^7.7.0",
"@types/json-schema": "^7.0.4",
"@types/node": "^13.1.2",
"chai": "^4.2.0",
"coveralls": "^3.0.9",
"eslint": "^6.8.0",
"eslint-config-modular": "^7.0.1",
"host-environment": "^1.1.4",
"karma": "^4.4.1",
"karma-cli": "^2.0.0",
"karma-config": "^1.5.7",
"mocha": "^6.2.2",
"npm-check": "^5.9.0",
"nyc": "^15.0.0",
"typescript": "^3.7.4",
"version-bump-prompt": "^5.0.7"
},
"dependencies": {
"call-me-maybe": "^1.0.1",
"js-yaml": "^3.13.1",
"ono": "^6.0.0"
"@apidevtools/json-schema-ref-parser": "8.0.0"
}
}

@@ -5,11 +5,12 @@ JSON Schema $Ref Parser

[![Build Status](https://api.travis-ci.com/APIDevTools/json-schema-ref-parser.svg?branch=master)](https://travis-ci.com/APIDevTools/json-schema-ref-parser)
[![Build Status](https://github.com/APIDevTools/json-schema-ref-parser/workflows/CI-CD/badge.svg?branch=master)](https://github.com/APIDevTools/json-schema-ref-parser/blob/master/.github/workflows/CI-CD.yaml)
[![Coverage Status](https://coveralls.io/repos/github/APIDevTools/json-schema-ref-parser/badge.svg?branch=master)](https://coveralls.io/github/APIDevTools/json-schema-ref-parser)
[![npm](https://img.shields.io/npm/v/json-schema-ref-parser.svg)](https://www.npmjs.com/package/json-schema-ref-parser)
[![npm](https://img.shields.io/npm/v/@apidevtools/json-schema-ref-parser.svg)](https://www.npmjs.com/package/@apidevtools/json-schema-ref-parser)
[![Dependencies](https://david-dm.org/APIDevTools/json-schema-ref-parser.svg)](https://david-dm.org/APIDevTools/json-schema-ref-parser)
[![License](https://img.shields.io/npm/l/json-schema-ref-parser.svg)](LICENSE)
[![License](https://img.shields.io/npm/l/@apidevtools/json-schema-ref-parser.svg)](LICENSE)
[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/APIDevTools/json-schema-ref-parser)
[![OS and Browser Compatibility](https://apitools.dev/img/badges/ci-badges-with-ie.svg)](https://travis-ci.com/APIDevTools/json-schema-ref-parser)
[![OS and Browser Compatibility](https://apitools.dev/img/badges/ci-badges-with-ie.svg)](https://github.com/APIDevTools/json-schema-ref-parser/blob/master/.github/workflows/CI-CD.yaml)

@@ -55,3 +56,3 @@

- Maintains object reference equality — `$ref` pointers to the same value always resolve to the same object instance
- [Tested](https://travis-ci.com/APIDevTools/json-schema-ref-parser) in Node and all major web browsers on Windows, Mac, and Linux
- Tested in Node and all major web browsers on Windows, Mac, and Linux

@@ -96,3 +97,3 @@

```bash
npm install json-schema-ref-parser
npm install @apidevtools/json-schema-ref-parser
```

@@ -104,6 +105,6 @@

--------------------------
When using Json-Schema-Ref-Parser in Node.js apps, you'll probably want to use **CommonJS** syntax:
When using JSON Schema $Ref Parser in Node.js apps, you'll probably want to use **CommonJS** syntax:
```javascript
const $RefParser = require("json-schema-ref-parser");
const $RefParser = require("@apidevtools/json-schema-ref-parser");
```

@@ -114,3 +115,3 @@

```javascript
import $RefParser from "json-schema-ref-parser";
import $RefParser from "@apidevtools/json-schema-ref-parser";
```

@@ -122,5 +123,5 @@

--------------------------
Json-Schema-Ref-Parser supports recent versions of every major web browser. Older browsers may require [Babel](https://babeljs.io/) and/or [polyfills](https://babeljs.io/docs/en/next/babel-polyfill).
JSON Schema $Ref Parser supports recent versions of every major web browser. Older browsers may require [Babel](https://babeljs.io/) and/or [polyfills](https://babeljs.io/docs/en/next/babel-polyfill).
To use Json-Schema-Ref-Parser in a browser, you'll need to use a bundling tool such as [Webpack](https://webpack.js.org/), [Rollup](https://rollupjs.org/), [Parcel](https://parceljs.org/), or [Browserify](http://browserify.org/). Some bundlers may require a bit of configuration, such as setting `browser: true` in [rollup-plugin-resolve](https://github.com/rollup/rollup-plugin-node-resolve).
To use JSON Schema $Ref Parser in a browser, you'll need to use a bundling tool such as [Webpack](https://webpack.js.org/), [Rollup](https://rollupjs.org/), [Parcel](https://parceljs.org/), or [Browserify](http://browserify.org/). Some bundlers may require a bit of configuration, such as setting `browser: true` in [rollup-plugin-resolve](https://github.com/rollup/rollup-plugin-node-resolve).

@@ -134,2 +135,3 @@

Contributing

@@ -148,9 +150,7 @@ --------------------------

3. __Run the build script__<br>
`npm run build`
4. __Run the tests__<br>
3. __Run the tests__<br>
`npm test`
License

@@ -160,2 +160,6 @@ --------------------------

This package is [Treeware](http://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/APIDevTools/json-schema-ref-parser) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
Big Thanks To

@@ -162,0 +166,0 @@ --------------------------

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc