Merge pull request #1 from hey-api/feat/download-resolve

refactor: simplify the code to serve Hey API requirements

Author: mrlubos

.github/FUNDING.yml

@@ -1 +1,3 @@
-github: philsturgeon
+github:
+  - mrlubos
+  - hey-api

.github/workflows/CI-CD.yaml

@@ -44,14 +44,16 @@ jobs:
       - name: Run linter
         run: yarn lint
 
-      - name: Run Node tests
-        run: yarn test:node
+      # disabled after refactoring
+      # - name: Run Node tests
+      #   run: yarn test:node
 
-      - name: Send code coverage results to Coveralls
-        uses: coverallsapp/github-action@v2
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          parallel: true
+      # disabled after refactoring
+      # - name: Send code coverage results to Coveralls
+      #   uses: coverallsapp/github-action@v2
+      #   with:
+      #     github-token: ${{ secrets.GITHUB_TOKEN }}
+      #     parallel: true
 
   browser_tests:
     name: Browser Tests
@@ -76,28 +78,31 @@ jobs:
       - name: Install dependencies
         run: yarn install --frozen-lockfile
 
-      - name: Run tests
-        run: yarn test:browser
-
-      - name: Send code coverage results to Coveralls
-        uses: coverallsapp/github-action@v2
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          parallel: true
-
-  coverage:
-    name: Code Coverage
-    runs-on: ubuntu-latest
-    timeout-minutes: 5
-    needs:
-      - node_tests
-      - browser_tests
-    steps:
-      - name: Let Coveralls know that all tests have finished
-        uses: coverallsapp/github-action@v2
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          parallel-finished: true
+      # disabled after refactoring
+      # - name: Run tests
+      #   run: yarn test:browser
+
+      # disabled after refactoring
+      # - name: Send code coverage results to Coveralls
+      #   uses: coverallsapp/github-action@v2
+      #   with:
+      #     github-token: ${{ secrets.GITHUB_TOKEN }}
+      #     parallel: true
+
+  # disabled after refactoring
+  # coverage:
+  #   name: Code Coverage
+  #   runs-on: ubuntu-latest
+  #   timeout-minutes: 5
+  #   needs:
+  #     - node_tests
+  #     - browser_tests
+  #   steps:
+  #     - name: Let Coveralls know that all tests have finished
+  #       uses: coverallsapp/github-action@v2
+  #       with:
+  #         github-token: ${{ secrets.GITHUB_TOKEN }}
+  #         parallel-finished: true
 
   release:
     name: Release

.yarn/releases/yarn-4.2.2.cjs

@@ -1,3 +1,3 @@
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.2.2.cjs
+yarnPath: .yarn/releases/yarn-4.5.3.cjs

.yarn/releases/yarn-4.5.3.cjs

@@ -1,3 +1,5 @@
+> This is a modified fork to serve Hey API needs
+
 # JSON Schema $Ref Parser
 
 #### Parse, Resolve, and Dereference JSON Schema $ref pointers

.yarnrc.yml

@@ -1,10 +1,10 @@
 import $Ref from "./ref.js";
+import type { ParserOptions } from "./options.js";
 import Pointer from "./pointer.js";
 import * as url from "./util/url.js";
 import type $Refs from "./refs.js";
-import type $RefParser from "./index";
-import type { ParserOptions } from "./index";
-import type { JSONSchema } from "./index";
+import type { $RefParser } from "./index";
+import type { JSONSchema } from "./types/index.js";
 
 export interface InventoryEntry {
   $ref: any;
@@ -28,15 +28,15 @@ export interface InventoryEntry {
  * @param parser
  * @param options
  */
-function bundle<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
-  parser: $RefParser<S, O>,
-  options: O,
+function bundle(
+  parser: $RefParser,
+  options: ParserOptions,
 ) {
   // console.log('Bundling $ref pointers in %s', parser.$refs._root$Ref.path);
 
   // Build an inventory of all $ref pointers in the JSON Schema
   const inventory: InventoryEntry[] = [];
-  crawl<S, O>(parser, "schema", parser.$refs._root$Ref.path + "#", "#", 0, inventory, parser.$refs, options);
+  crawl<JSONSchema>(parser, "schema", parser.$refs._root$Ref.path + "#", "#", 0, inventory, parser.$refs, options);
 
   // Remap all $ref pointers
   remap(inventory);
@@ -54,15 +54,15 @@ function bundle<S extends object = JSONSchema, O extends ParserOptions<S> = Pars
  * @param $refs
  * @param options
  */
-function crawl<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
-  parent: object | $RefParser<S, O>,
+function crawl<S extends object = JSONSchema>(
+  parent: object | $RefParser,
   key: string | null,
   path: string,
   pathFromRoot: string,
   indirections: number,
   inventory: InventoryEntry[],
-  $refs: $Refs<S, O>,
-  options: O,
+  $refs: $Refs<S>,
+  options: ParserOptions,
 ) {
   const obj = key === null ? parent : parent[key as keyof typeof parent];
 
@@ -115,15 +115,15 @@ function crawl<S extends object = JSONSchema, O extends ParserOptions<S> = Parse
  * @param $refs
  * @param options
  */
-function inventory$Ref<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+function inventory$Ref<S extends object = JSONSchema>(
   $refParent: any,
   $refKey: string | null,
   path: string,
   pathFromRoot: string,
   indirections: number,
   inventory: InventoryEntry[],
-  $refs: $Refs<S, O>,
-  options: O,
+  $refs: $Refs<S>,
+  options: ParserOptions,
 ) {
   const $ref = $refKey === null ? $refParent : $refParent[$refKey];
   const $refPath = url.resolve(path, $ref.$ref);

README.md

@@ -5,7 +5,7 @@ import * as url from "./util/url.js";
 import type $Refs from "./refs.js";
 import type { DereferenceOptions, ParserOptions } from "./options.js";
 import type { JSONSchema } from "./types";
-import type $RefParser from "./index";
+import type { $RefParser } from "./index";
 import { TimeoutError } from "./util/errors";
 
 export default dereference;
@@ -17,13 +17,13 @@ export default dereference;
  * @param parser
  * @param options
  */
-function dereference<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
-  parser: $RefParser<S, O>,
-  options: O,
+function dereference(
+  parser: $RefParser,
+  options: ParserOptions,
 ) {
   const start = Date.now();
   // console.log('Dereferencing $ref pointers in %s', parser.$refs._root$Ref.path);
-  const dereferenced = crawl<S, O>(
+  const dereferenced = crawl<JSONSchema>(
     parser.schema,
     parser.$refs._root$Ref.path!,
     "#",
@@ -52,15 +52,15 @@ function dereference<S extends object = JSONSchema, O extends ParserOptions<S> =
  * @param startTime - The time when the dereferencing started
  * @returns
  */
-function crawl<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+function crawl<S extends object = JSONSchema>(
   obj: any,
   path: string,
   pathFromRoot: string,
   parents: Set<any>,
   processedObjects: Set<any>,
   dereferencedCache: any,
-  $refs: $Refs<S, O>,
-  options: O,
+  $refs: $Refs<S>,
+  options: ParserOptions,
   startTime: number,
 ) {
   let dereferenced;
@@ -82,7 +82,7 @@ function crawl<S extends object = JSONSchema, O extends ParserOptions<S> = Parse
       parents.add(obj);
       processedObjects.add(obj);
 
-      if ($Ref.isAllowed$Ref(obj, options)) {
+      if ($Ref.isAllowed$Ref(obj)) {
         dereferenced = dereference$Ref(
           obj,
           path,
@@ -108,7 +108,7 @@ function crawl<S extends object = JSONSchema, O extends ParserOptions<S> = Parse
           const value = obj[key];
           let circular = false;
 
-          if ($Ref.isAllowed$Ref(value, options)) {
+          if ($Ref.isAllowed$Ref(value)) {
             dereferenced = dereference$Ref(
               value,
               keyPath,
@@ -174,20 +174,18 @@ function crawl<S extends object = JSONSchema, O extends ParserOptions<S> = Parse
  * @param options
  * @returns
  */
-function dereference$Ref<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+function dereference$Ref<S extends object = JSONSchema>(
   $ref: any,
   path: string,
   pathFromRoot: string,
   parents: Set<any>,
   processedObjects: any,
   dereferencedCache: any,
-  $refs: $Refs<S, O>,
-  options: O,
+  $refs: $Refs<S>,
+  options: ParserOptions,
   startTime: number,
 ) {
-  const isExternalRef = $Ref.isExternal$Ref($ref);
-  const shouldResolveOnCwd = isExternalRef && options?.dereference?.externalReferenceResolution === "root";
-  const $refPath = url.resolve(shouldResolveOnCwd ? url.cwd() : path, $ref.$ref);
+  const $refPath = url.resolve(path, $ref.$ref);
 
   const cache = dereferencedCache.get($refPath);
   if (cache && !cache.circular) {