feat: switch to json-schema-ref-parser

.gitignore

@@ -6,3 +6,5 @@
 
 # misc
 .idea
+
+coverage/

README.md

@@ -9,17 +9,16 @@ yarn add @stoplight/json-ref-readers
 
 ## Usage
 
-The library exports two functions: `resolveHttp` and `resolveFile`. Both take `uri.URI` and resolve to a string containing requested resource.
-
 ```ts
-import { Resolver } from '@stoplight/json-ref-resolver';
-import { resolveFile, resolveHttp } from '@stoplight/json-ref-readers';
+import $RefParser from '@apidevtools/json-schema-ref-parser';
+import { jsonParser, yamlParser } from '@stoplight/json-ref-readers';
+
+const parser = new $RefParser();
 
-const httpAndFileResolver = new Resolver({
-  resolvers: {
-    https: { resolve: resolveHttp },
-    http: { resolve: resolveHttp },
-    file: { resolve: resolveFile },
+parser.dereference(filePath, {
+  parse: {
+    json: jsonParser,
+    yaml: yamlParser,
   },
 });
 ```

package.json

@@ -27,21 +27,27 @@
     "test.prod": "yarn lint && yarn test --coverage --no-cache",
     "test.update": "yarn test --updateSnapshot"
   },
+  "peerDependencies": {
+    "@apidevtools/json-schema-ref-parser": ">=9.0.2"
+  },
   "dependencies": {
+    "@stoplight/json": "^3.7.1",
+    "@stoplight/path": "^1.3.1",
+    "@stoplight/yaml": "^3.8.1",
     "node-fetch": "^2.6.0"
   },
   "devDependencies": {
+    "@apidevtools/json-schema-ref-parser": "https://github.com/stoplightio/json-schema-ref-parser#03462047af4e62e889038f5e4ce53c552fbefaee",
     "@stoplight/scripts": "^7.0.3",
+    "@stoplight/types": "^11.6.0",
     "@types/jest": "^24.0.18",
     "@types/nock": "^11.1.0",
     "@types/node-fetch": "^2.5.2",
-    "@types/urijs": "^1.19.4",
     "jest": "^24.9.0",
     "nock": "^11.7.0",
     "ts-jest": "^24.1.0",
     "tslint": "^5.20.0",
     "tslint-config-stoplight": "^1.3.0",
-    "typescript": "^3.6.3",
-    "urijs": "^1.19.2"
+    "typescript": "^3.8.3"
   }
 }

src/index.ts

@@ -1,2 +1,2 @@
-export { createResolveHttp, resolveHttp, NetworkError, OpenError } from './http';
-export { resolveFile } from './file';
+export * from './parsers';
+export * from './resolvers';

src/parsers/__tests__/json.spec.ts

@@ -0,0 +1,87 @@
+import { readFile } from 'fs';
+import $RefParser = require('@apidevtools/json-schema-ref-parser');
+import { jsonParser } from '../index';
+import { resolveFile } from '../../resolvers';
+
+jest.mock('fs');
+
+describe('JSON Parser', () => {
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('works', async () => {
+    ((readFile as unknown) as jest.Mock).mockImplementation((_path, _opts, cb) => cb(null, '{"foo":true}'));
+
+    const parser = new $RefParser();
+    const deref = parser.dereference({ $ref: './baz.json' }, {
+      resolve: {
+        file: resolveFile,
+      },
+      parse: {
+        json: jsonParser,
+        yaml: false,
+      }
+    });
+
+    return expect(deref).resolves.toStrictEqual({ foo: true });
+  });
+
+  it('retains the order of keys', async () => {
+    ((readFile as unknown) as jest.Mock).mockImplementation((_path, _opts, cb) => cb(null, '{"foo":true,"0": false}'));
+
+    const parser = new $RefParser();
+    const deref = await parser.dereference({ $ref: './baz.json' }, {
+      resolve: {
+        file: resolveFile,
+      },
+      parse: {
+        json: jsonParser,
+        yaml: false,
+      }
+    });
+
+    expect(Object.keys(deref)).toEqual(['foo', '0'])
+  });
+
+  it('handles failures', async () => {
+    ((readFile as unknown) as jest.Mock).mockImplementation((_path, _opts, cb) => cb(null, '{bar zx;cxz"":true}'));
+
+    const parser = new $RefParser();
+    const deref = parser.dereference({ $ref: './baz.json' }, {
+      resolve: {
+        file: resolveFile,
+      },
+      parse: {
+        json: jsonParser,
+        yaml: false,
+      }
+    });
+
+    return expect(deref).rejects.toThrow($RefParser.ParserError);
+  });
+
+  it('integrates with continueOnError',  () => {
+    ((readFile as unknown) as jest.Mock).mockImplementation((_path, _opts, cb) => cb(null, '{"foo": true,}'));
+
+    const parser = new $RefParser();
+    const deref = parser.dereference({ $ref: './baz.json' }, {
+      resolve: {
+        file: resolveFile,
+      },
+      parse: {
+        json: jsonParser,
+        yaml: false,
+      },
+      continueOnError: true,
+    });
+
+    return Promise.all([
+      expect(deref).rejects.toThrow($RefParser.JSONParserErrorGroup),
+      expect(deref).rejects.toHaveProperty('errors', [
+        expect.objectContaining({ name: 'ParserError', message: 'PropertyNameExpected' }),
+        expect.objectContaining({ name: 'ParserError', message: 'ValueExpected' }),
+      ]),
+    ]);
+  })
+});

src/parsers/__tests__/yaml.spec.ts

@@ -0,0 +1,83 @@
+import { readFile } from 'fs';
+import $RefParser = require('@apidevtools/json-schema-ref-parser');
+import { yamlParser } from '../index';
+import { resolveFile } from '../../resolvers';
+
+jest.mock('fs');
+
+describe('YAML Parser', () => {
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('works', async () => {
+    ((readFile as unknown) as jest.Mock).mockImplementation((_path, _opts, cb) => cb(null, '{"foo":true}'));
+
+    const parser = new $RefParser();
+    const deref = parser.dereference({ $ref: './baz.yaml' }, {
+      resolve: {
+        file: resolveFile,
+      },
+      parse: {
+        yaml: yamlParser,
+      }
+    });
+
+    return expect(deref).resolves.toStrictEqual({ foo: true });
+  });
+
+  it('retains the order of keys', async () => {
+    ((readFile as unknown) as jest.Mock).mockImplementation((_path, _opts, cb) => cb(null, '{"foo":true,"0": false}'));
+
+    const parser = new $RefParser();
+    const deref = await parser.dereference({ $ref: './baz.yaml' }, {
+      resolve: {
+        file: resolveFile,
+      },
+      parse: {
+        yaml: yamlParser,
+      }
+    });
+
+    expect(Object.keys(deref)).toEqual(['foo', '0'])
+  });
+
+  it('handles failures', async () => {
+    ((readFile as unknown) as jest.Mock).mockImplementation((_path, _opts, cb) => cb(null, 'foo:\n d\na'));
+
+    const parser = new $RefParser();
+    const deref = parser.dereference({ $ref: './baz.yaml' }, {
+      resolve: {
+        file: resolveFile,
+      },
+      parse: {
+        yaml: yamlParser,
+      }
+    });
+
+    return expect(deref).rejects.toThrow($RefParser.ParserError);
+  });
+
+  it('integrates with continueOnError',  () => {
+    ((readFile as unknown) as jest.Mock).mockImplementation((_path, _opts, cb) => cb(null, 'foo:\n d\na'));
+
+    const parser = new $RefParser();
+    const deref = parser.dereference({ $ref: './baz.yaml' }, {
+      resolve: {
+        file: resolveFile,
+      },
+      parse: {
+        yaml: yamlParser,
+      },
+      continueOnError: true,
+    });
+
+    return Promise.all([
+      expect(deref).rejects.toThrow($RefParser.JSONParserErrorGroup),
+      expect(deref).rejects.toHaveProperty('errors', [
+        expect.objectContaining({ name: 'ParserError', message: 'can not read a block mapping entry; a multiline key may not be an implicit key' }),
+        expect.objectContaining({ name: 'ParserError', message: 'can not read an implicit mapping pair; a colon is missed' }),
+      ]),
+    ]);
+  })
+});