@hey-api/json-schema-ref-parser 1.0.3 → 1.0.4

package/dist/lib/index.d.ts

@@ -37,8 +37,9 @@ export declare class $RefParser {
      *
      * @param pathOrUrlOrSchema A JSON Schema object, or the file path or URL of a JSON Schema file.
      */
-    bundle({ arrayBuffer, pathOrUrlOrSchema, resolvedInput, }: {
+    bundle({ arrayBuffer, fetch, pathOrUrlOrSchema, resolvedInput, }: {
         arrayBuffer?: ArrayBuffer;
+        fetch?: RequestInit;
         pathOrUrlOrSchema: JSONSchema | string | unknown;
         resolvedInput?: ResolvedInput;
     }): Promise<JSONSchema>;
@@ -51,7 +52,8 @@ export declare class $RefParser {
      *
      * @param pathOrUrlOrSchema A JSON Schema object, or the file path or URL of a JSON Schema file.
      */
-    dereference({ pathOrUrlOrSchema, }: {
+    dereference({ fetch, pathOrUrlOrSchema, }: {
+        fetch?: RequestInit;
         pathOrUrlOrSchema: JSONSchema | string | unknown;
     }): Promise<JSONSchema>;
     /**
@@ -62,8 +64,9 @@ export declare class $RefParser {
      * @param pathOrUrlOrSchema A JSON Schema object, or the file path or URL of a JSON Schema file.
      * @returns - The returned promise resolves with the parsed JSON schema object.
      */
-    parse({ arrayBuffer, pathOrUrlOrSchema, resolvedInput: _resolvedInput, }: {
+    parse({ arrayBuffer, fetch, pathOrUrlOrSchema, resolvedInput: _resolvedInput, }: {
         arrayBuffer?: ArrayBuffer;
+        fetch?: RequestInit;
         pathOrUrlOrSchema: JSONSchema | string | unknown;
         resolvedInput?: ResolvedInput;
     }): Promise<{

package/dist/lib/index.js

@@ -118,8 +118,13 @@ class $RefParser {
      *
      * @param pathOrUrlOrSchema A JSON Schema object, or the file path or URL of a JSON Schema file.
      */
-    async bundle({ arrayBuffer, pathOrUrlOrSchema, resolvedInput, }) {
-        await this.parse({ arrayBuffer, pathOrUrlOrSchema, resolvedInput });
+    async bundle({ arrayBuffer, fetch, pathOrUrlOrSchema, resolvedInput, }) {
+        await this.parse({
+            arrayBuffer,
+            fetch,
+            pathOrUrlOrSchema,
+            resolvedInput,
+        });
         await (0, resolve_external_js_1.resolveExternal)(this, this.options);
         const errors = errors_js_1.JSONParserErrorGroup.getParserErrors(this);
         if (errors.length > 0) {
@@ -141,8 +146,11 @@ class $RefParser {
      *
      * @param pathOrUrlOrSchema A JSON Schema object, or the file path or URL of a JSON Schema file.
      */
-    async dereference({ pathOrUrlOrSchema, }) {
-        await this.parse({ pathOrUrlOrSchema });
+    async dereference({ fetch, pathOrUrlOrSchema, }) {
+        await this.parse({
+            fetch,
+            pathOrUrlOrSchema,
+        });
         await (0, resolve_external_js_1.resolveExternal)(this, this.options);
         const errors = errors_js_1.JSONParserErrorGroup.getParserErrors(this);
         if (errors.length > 0) {
@@ -163,7 +171,7 @@ class $RefParser {
      * @param pathOrUrlOrSchema A JSON Schema object, or the file path or URL of a JSON Schema file.
      * @returns - The returned promise resolves with the parsed JSON schema object.
      */
-    async parse({ arrayBuffer, pathOrUrlOrSchema, resolvedInput: _resolvedInput, }) {
+    async parse({ arrayBuffer, fetch, pathOrUrlOrSchema, resolvedInput: _resolvedInput, }) {
         const resolvedInput = _resolvedInput || (0, exports.getResolvedInput)({ pathOrUrlOrSchema });
         const { path, type } = resolvedInput;
         let { schema } = resolvedInput;
@@ -184,7 +192,11 @@ class $RefParser {
             $refAdded.pathType = type;
             try {
                 const resolver = type === 'file' ? file_js_1.fileResolver : url_js_1.urlResolver;
-                await resolver.handler(file, arrayBuffer);
+                await resolver.handler({
+                    arrayBuffer,
+                    fetch,
+                    file,
+                });
                 const parseResult = await (0, parse_js_1.parseFile)(file, this.options);
                 $refAdded.value = parseResult.result;
                 schema = parseResult.result;

package/dist/lib/resolve-external.js

@@ -131,7 +131,7 @@ async function resolve$Ref($ref, path, $refs, options) {
         let promises = [];
         if (resolvedInput.type !== 'json') {
             const resolver = resolvedInput.type === 'file' ? file_js_1.fileResolver : url_js_1.urlResolver;
-            await resolver.handler(file);
+            await resolver.handler({ file });
             const parseResult = await (0, parse_js_1.parseFile)(file, options);
             $refAdded.value = parseResult.result;
             promises = crawl(parseResult.result, `${withoutHash}#`, $refs, options, new Set(), true);

package/dist/lib/resolvers/file.d.ts

@@ -1,4 +1,6 @@
 import type { FileInfo } from "../types/index.js";
 export declare const fileResolver: {
-    handler: (file: FileInfo) => Promise<void>;
+    handler: ({ file, }: {
+        file: FileInfo;
+    }) => Promise<void>;
 };

package/dist/lib/resolvers/file.js

@@ -42,7 +42,7 @@ const ono_1 = require("@jsdevtools/ono");
 const url = __importStar(require("../util/url.js"));
 const errors_js_1 = require("../util/errors.js");
 exports.fileResolver = {
-    handler: async (file) => {
+    handler: async ({ file, }) => {
         let path;
         try {
             path = url.toFileSystemPath(file.url);

package/dist/lib/resolvers/url.d.ts

@@ -1,13 +1,17 @@
 import type { FileInfo } from "../types/index.js";
-export declare const sendRequest: ({ init, redirects, timeout, url, }: {
-    init?: RequestInit;
+export declare const sendRequest: ({ fetchOptions, redirects, timeout, url, }: {
+    fetchOptions?: RequestInit;
     redirects?: string[];
     timeout?: number;
     url: URL | string;
 }) => Promise<{
-    init?: RequestInit;
+    fetchOptions?: RequestInit;
     response: Response;
 }>;
 export declare const urlResolver: {
-    handler: (file: FileInfo, arrayBuffer?: ArrayBuffer) => Promise<void>;
+    handler: ({ arrayBuffer, fetch: _fetch, file, }: {
+        arrayBuffer?: ArrayBuffer;
+        fetch?: RequestInit;
+        file: FileInfo;
+    }) => Promise<void>;
 };

package/dist/lib/resolvers/url.js

@@ -4,7 +4,7 @@ exports.urlResolver = exports.sendRequest = void 0;
 const ono_1 = require("@jsdevtools/ono");
 const url_js_1 = require("../util/url.js");
 const errors_js_1 = require("../util/errors.js");
-const sendRequest = async ({ init, redirects = [], timeout = 60000, url, }) => {
+const sendRequest = async ({ fetchOptions, redirects = [], timeout = 60000, url, }) => {
     url = new URL(url);
     redirects.push(url.href);
     const controller = new AbortController();
@@ -13,7 +13,7 @@ const sendRequest = async ({ init, redirects = [], timeout = 60000, url, }) => {
     }, timeout);
     const response = await fetch(url, {
         signal: controller.signal,
-        ...init,
+        ...fetchOptions,
     });
     clearTimeout(timeoutId);
     if (response.status >= 300 && response.status <= 399) {
@@ -24,29 +24,30 @@ const sendRequest = async ({ init, redirects = [], timeout = 60000, url, }) => {
             throw (0, ono_1.ono)({ status: response.status }, `HTTP ${response.status} redirect with no location header`);
         }
         return (0, exports.sendRequest)({
-            init,
+            fetchOptions,
             redirects,
             timeout,
             url: (0, url_js_1.resolve)(url.href, response.headers.location),
         });
     }
-    return { init, response };
+    return { fetchOptions, response };
 };
 exports.sendRequest = sendRequest;
 exports.urlResolver = {
-    handler: async (file, arrayBuffer) => {
+    handler: async ({ arrayBuffer, fetch: _fetch, file, }) => {
         let data = arrayBuffer;
         if (!data) {
             try {
-                const { init, response } = await (0, exports.sendRequest)({
-                    init: {
+                const { fetchOptions, response } = await (0, exports.sendRequest)({
+                    fetchOptions: {
                         method: 'GET',
+                        ..._fetch,
                     },
                     url: file.url,
                 });
                 if (response.status >= 400) {
                     // gracefully handle HEAD method not allowed
-                    if (response.status !== 405 || init?.method !== 'HEAD') {
+                    if (response.status !== 405 || fetchOptions?.method !== 'HEAD') {
                         throw (0, ono_1.ono)({ status: response.status }, `HTTP ERROR ${response.status}`);
                     }
                     data = response.body ? await response.arrayBuffer() : new ArrayBuffer(0);

package/lib/index.ts

@@ -94,14 +94,21 @@ export class $RefParser {
    */
   public async bundle({
     arrayBuffer,
+    fetch,
     pathOrUrlOrSchema,
     resolvedInput,
   }: {
     arrayBuffer?: ArrayBuffer;
+    fetch?: RequestInit;
     pathOrUrlOrSchema: JSONSchema | string | unknown;
     resolvedInput?: ResolvedInput;
   }): Promise<JSONSchema> {
-    await this.parse({ arrayBuffer, pathOrUrlOrSchema, resolvedInput });
+    await this.parse({
+      arrayBuffer,
+      fetch,
+      pathOrUrlOrSchema,
+      resolvedInput,
+    });
     await resolveExternal(this, this.options);
     const errors = JSONParserErrorGroup.getParserErrors(this);
     if (errors.length > 0) {
@@ -125,11 +132,16 @@ export class $RefParser {
    * @param pathOrUrlOrSchema A JSON Schema object, or the file path or URL of a JSON Schema file.
    */
   public async dereference({
+    fetch,
     pathOrUrlOrSchema,
   }: {
+    fetch?: RequestInit;
     pathOrUrlOrSchema: JSONSchema | string | unknown;
   }): Promise<JSONSchema> {
-    await this.parse({ pathOrUrlOrSchema });
+    await this.parse({
+      fetch,
+      pathOrUrlOrSchema,
+    });
     await resolveExternal(this, this.options);
     const errors = JSONParserErrorGroup.getParserErrors(this);
     if (errors.length > 0) {
@@ -153,10 +165,12 @@ export class $RefParser {
    */
   public async parse({
     arrayBuffer,
+    fetch,
     pathOrUrlOrSchema,
     resolvedInput: _resolvedInput,
   }: {
     arrayBuffer?: ArrayBuffer;
+    fetch?: RequestInit;
     pathOrUrlOrSchema: JSONSchema | string | unknown;
     resolvedInput?: ResolvedInput;
   }): Promise<{ schema: JSONSchema }> {
@@ -182,7 +196,11 @@ export class $RefParser {
       $refAdded.pathType = type;
       try {
         const resolver = type === 'file' ? fileResolver : urlResolver;
-        await resolver.handler(file, arrayBuffer);
+        await resolver.handler({
+          arrayBuffer,
+          fetch,
+          file,
+        });
         const parseResult = await parseFile(file, this.options);
         $refAdded.value = parseResult.result;
         schema = parseResult.result;

package/lib/resolve-external.ts

@@ -124,7 +124,7 @@ async function resolve$Ref<S extends object = JSONSchema>(
 
     if (resolvedInput.type !== 'json') {
       const resolver = resolvedInput.type === 'file' ? fileResolver : urlResolver;
-      await resolver.handler(file);
+      await resolver.handler({ file });
       const parseResult = await parseFile(file, options);
       $refAdded.value = parseResult.result;
       promises = crawl(parseResult.result, `${withoutHash}#`, $refs, options, new Set(), true);

package/lib/resolvers/file.ts

@@ -5,7 +5,11 @@ import { ResolverError } from "../util/errors.js";
 import type { FileInfo } from "../types/index.js";
 
 export const fileResolver = {
-  handler: async (file: FileInfo): Promise<void> => {
+  handler: async ({
+    file,
+  }: {
+    file: FileInfo;
+  }): Promise<void> => {
     let path: string | undefined;
 
     try {

package/lib/resolvers/url.ts

@@ -4,17 +4,17 @@ import { ResolverError } from "../util/errors.js";
 import type { FileInfo } from "../types/index.js";
 
 export const sendRequest = async ({
-  init,
+  fetchOptions,
   redirects = [],
   timeout = 60_000,
   url,
 }: {
-  init?: RequestInit;
+  fetchOptions?: RequestInit;
   redirects?: string[];
   timeout?: number;
   url: URL | string;
 }): Promise<{
-  init?: RequestInit;
+  fetchOptions?: RequestInit;
   response: Response;
 }> => {
   url = new URL(url);
@@ -26,7 +26,7 @@ export const sendRequest = async ({
   }, timeout);
   const response = await fetch(url, {
     signal: controller.signal,
-    ...init,
+    ...fetchOptions,
   });
   clearTimeout(timeoutId);
 
@@ -45,32 +45,41 @@ export const sendRequest = async ({
     }
 
     return sendRequest({
-      init,
+      fetchOptions,
       redirects,
       timeout,
       url: resolve(url.href, response.headers.location as string),
     });
   }
 
-  return { init, response };
+  return { fetchOptions, response };
 }
 
 export const urlResolver = {
-  handler: async (file: FileInfo, arrayBuffer?: ArrayBuffer): Promise<void> => {
+  handler: async ({
+    arrayBuffer,
+    fetch: _fetch,
+    file,
+  }: {
+    arrayBuffer?: ArrayBuffer;
+    fetch?: RequestInit;
+    file: FileInfo;
+  }): Promise<void> => {
     let data = arrayBuffer;
 
     if (!data) {
       try {
-        const { init, response } = await sendRequest({
-          init: {
+        const { fetchOptions, response } = await sendRequest({
+          fetchOptions: {
             method: 'GET',
+            ..._fetch,
           },
           url: file.url,
         });
 
         if (response.status >= 400) {
           // gracefully handle HEAD method not allowed
-          if (response.status !== 405 || init?.method !== 'HEAD') {
+          if (response.status !== 405 || fetchOptions?.method !== 'HEAD') {
             throw ono({ status: response.status }, `HTTP ERROR ${response.status}`);
           }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hey-api/json-schema-ref-parser",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
   "homepage": "https://heyapi.dev/",
   "repository": {