@hey-api/json-schema-ref-parser 1.2.3 → 1.3.0

package/README.md

@@ -1,15 +1,7 @@
-> This is a modified fork to serve Hey API needs
-
 # JSON Schema $Ref Parser
 
 #### Parse, Resolve, and Dereference JSON Schema $ref pointers
 
-<!-- [![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/actions)
-[![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/@apidevtools/json-schema-ref-parser.svg)](https://www.npmjs.com/package/@apidevtools/json-schema-ref-parser)
-[![License](https://img.shields.io/npm/l/@apidevtools/json-schema-ref-parser.svg)](LICENSE) -->
-
 ## Installation
 
 Install using [npm](https://docs.npmjs.com/about-npm/):
@@ -66,33 +58,19 @@ JavaScript objects.
   instance
 - Compatible with Node LTS and beyond, and all major web browsers on Windows, Mac, and Linux
 
-## Example
-
-```javascript
-import { $RefParser } from "@hey-api/json-schema-ref-parser";
-
-try {
-  const parser = new $RefParser();
-  await parser.dereference({ pathOrUrlOrSchema: mySchema });
-  console.log(parser.schema.definitions.person.properties.firstName);
-} catch (err) {
-  console.error(err);
-}
-```
-
 ### New in this fork (@hey-api)
 
 - **Multiple inputs with `bundleMany`**: Merge and bundle several OpenAPI/JSON Schema inputs (files, URLs, or raw objects) into a single schema. Components are prefixed to avoid name collisions, paths are namespaced on conflict, and `$ref`s are rewritten accordingly.
 
 ```javascript
-import { $RefParser } from "@hey-api/json-schema-ref-parser";
+import { $RefParser } from '@hey-api/json-schema-ref-parser';
 
 const parser = new $RefParser();
 const merged = await parser.bundleMany({
   pathOrUrlOrSchemas: [
-    "./specs/a.yaml",
-    "https://example.com/b.yaml",
-    { openapi: "3.1.0", info: { title: "Inline" }, paths: {} },
+    './specs/a.yaml',
+    'https://example.com/b.yaml',
+    { openapi: '3.1.0', info: { title: 'Inline' }, paths: {} },
   ],
 });
 
@@ -103,11 +81,11 @@ const merged = await parser.bundleMany({
 
 ```javascript
 const parser = new $RefParser();
-parser.options.dereference.excludedPathMatcher = (p) => p.includes("/example/");
+parser.options.dereference.excludedPathMatcher = (p) => p.includes('/example/');
 parser.options.dereference.onDereference = (p, v) => {
   // inspect p / v as needed
 };
-await parser.dereference({ pathOrUrlOrSchema: "./openapi.yaml" });
+await parser.dereference({ pathOrUrlOrSchema: './openapi.yaml' });
 ```
 
 - **Smart input resolution**: You can pass a file path, URL, or raw schema object. If a raw schema includes `$id`, it is used as the base URL for resolving relative `$ref`s.
@@ -115,64 +93,11 @@ await parser.dereference({ pathOrUrlOrSchema: "./openapi.yaml" });
 ```javascript
 await new $RefParser().bundle({
   pathOrUrlOrSchema: {
-    $id: "https://api.example.com/openapi.json",
-    openapi: "3.1.0",
+    $id: 'https://api.example.com/openapi.json',
+    openapi: '3.1.0',
     paths: {
-      "/ping": { get: { responses: { 200: { description: "ok" } } } },
+      '/ping': { get: { responses: { 200: { description: 'ok' } } } },
     },
   },
 });
 ```
-
-## Polyfills
-
-If you are using Node.js < 18, you'll need a polyfill for `fetch`,
-like [node-fetch](https://github.com/node-fetch/node-fetch):
-
-```javascript
-import fetch from "node-fetch";
-
-globalThis.fetch = fetch;
-```
-
-## Browser support
-
-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).
-
-#### Webpack 5
-
-Webpack 5 has dropped the default export of node core modules in favour of polyfills, you'll need to set them up
-yourself ( after npm-installing them )
-Edit your `webpack.config.js` :
-
-```js
-config.resolve.fallback = {
-  path: require.resolve("path-browserify"),
-  fs: require.resolve("browserify-fs"),
-};
-
-config.plugins.push(
-  new webpack.ProvidePlugin({
-    Buffer: ["buffer", "Buffer"],
-  }),
-);
-```
-
-#### Building/Testing
-
-To build/test the project locally on your computer:
-
-1. **Clone this repo**<br>
-   `git clone https://github.com/APIDevTools/json-schema-ref-parser.git`
-
-2. **Install dependencies**<br>
-   `yarn install`
-
-3. **Run the tests**<br>
-   `yarn test`