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

package/{lib → src}/util/url.ts

@@ -1,20 +1,19 @@
-import convertPathToPosix from "./convert-path-to-posix";
-import path, { win32 } from "path";
+import path, { join, win32 } from 'node:path';
+
+import convertPathToPosix from './convert-path-to-posix';
+import { isWindows } from './is-windows';
 
 const forwardSlashPattern = /\//g;
 const protocolPattern = /^(\w{2,}):\/\//i;
 
-import { join } from "path";
-import { isWindows } from "./is-windows";
-
 // RegExp patterns to URL-encode special characters in local filesystem paths
 const urlEncodePatterns = [
-  [/\?/g, "%3F"],
-  [/#/g, "%23"],
+  [/\?/g, '%3F'],
+  [/#/g, '%23'],
 ] as [RegExp, string][];
 
 // RegExp patterns to URL-decode special characters for local filesystem paths
-const urlDecodePatterns = [/%23/g, "#", /%24/g, "$", /%26/g, "&", /%2C/g, ",", /%40/g, "@"];
+const urlDecodePatterns = [/%23/g, '#', /%24/g, '$', /%26/g, '&', /%2C/g, ',', /%40/g, '@'];
 
 /**
  * Returns resolved target URL relative to a base URL in a manner similar to that of a Web browser resolving an anchor tag HREF.
@@ -22,12 +21,12 @@ const urlDecodePatterns = [/%23/g, "#", /%24/g, "$", /%26/g, "&", /%2C/g, ",", /
  * @returns
  */
 export function resolve(from: string, to: string) {
-  const fromUrl = new URL(convertPathToPosix(from), "resolve://");
+  const fromUrl = new URL(convertPathToPosix(from), 'resolve://');
   const resolvedUrl = new URL(convertPathToPosix(to), fromUrl);
-  const endSpaces = to.match(/(\s*)$/)?.[1] || "";
-  if (resolvedUrl.protocol === "resolve:") {
+  const endSpaces = to.match(/(\s*)$/)?.[1] || '';
+  if (resolvedUrl.protocol === 'resolve:') {
     // `from` is a relative URL.
-    const { pathname, search, hash } = resolvedUrl;
+    const { hash, pathname, search } = resolvedUrl;
     return pathname + search + hash + endSpaces;
   }
   return resolvedUrl.toString() + endSpaces;
@@ -39,17 +38,17 @@ export function resolve(from: string, to: string) {
  * @returns
  */
 export function cwd() {
-  if (typeof window !== "undefined") {
+  if (typeof window !== 'undefined') {
     return location.href;
   }
 
   const path = process.cwd();
 
   const lastChar = path.slice(-1);
-  if (lastChar === "/" || lastChar === "\\") {
+  if (lastChar === '/' || lastChar === '\\') {
     return path;
   } else {
-    return path + "/";
+    return path + '/';
   }
 }
 
@@ -60,9 +59,9 @@ export function cwd() {
  * @returns
  */
 export function getProtocol(path: string | undefined) {
-  const match = protocolPattern.exec(path || "");
+  const match = protocolPattern.exec(path || '');
   if (match) {
-    return match[1].toLowerCase();
+    return match[1]!.toLowerCase();
   }
   return undefined;
 }
@@ -75,11 +74,11 @@ export function getProtocol(path: string | undefined) {
  * @returns
  */
 export function getExtension(path: any) {
-  const lastDot = path.lastIndexOf(".");
+  const lastDot = path.lastIndexOf('.');
   if (lastDot > -1) {
     return stripQuery(path.substr(lastDot).toLowerCase());
   }
-  return "";
+  return '';
 }
 
 /**
@@ -89,7 +88,7 @@ export function getExtension(path: any) {
  * @returns
  */
 export function stripQuery(path: any) {
-  const queryIndex = path.indexOf("?");
+  const queryIndex = path.indexOf('?');
   if (queryIndex > -1) {
     path = path.substr(0, queryIndex);
   }
@@ -105,13 +104,13 @@ export function stripQuery(path: any) {
  */
 export function getHash(path: undefined | string) {
   if (!path) {
-    return "#";
+    return '#';
   }
-  const hashIndex = path.indexOf("#");
+  const hashIndex = path.indexOf('#');
   if (hashIndex > -1) {
     return path.substring(hashIndex);
   }
-  return "#";
+  return '#';
 }
 
 /**
@@ -122,9 +121,9 @@ export function getHash(path: undefined | string) {
  */
 export function stripHash(path?: string | undefined) {
   if (!path) {
-    return "";
+    return '';
   }
-  const hashIndex = path.indexOf("#");
+  const hashIndex = path.indexOf('#');
   if (hashIndex > -1) {
     path = path.substring(0, hashIndex);
   }
@@ -140,14 +139,14 @@ export function stripHash(path?: string | undefined) {
  */
 export function isFileSystemPath(path: string | undefined) {
   // @ts-ignore
-  if (typeof window !== "undefined" || (typeof process !== "undefined" && process.browser)) {
+  if (typeof window !== 'undefined' || (typeof process !== 'undefined' && process.browser)) {
     // We're running in a browser, so assume that all paths are URLs.
     // This way, even relative paths will be treated as URLs rather than as filesystem paths
     return false;
   }
 
   const protocol = getProtocol(path);
-  return protocol === undefined || protocol === "file";
+  return protocol === undefined || protocol === 'file';
 }
 
 /**
@@ -177,12 +176,12 @@ export function fromFileSystemPath(path: string) {
     const hasProjectDir = upperPath.includes(posixUpper);
     const hasProjectUri = upperPath.includes(posixUpper);
     const isAbsolutePath =
-      win32?.isAbsolute(path) ||
-      path.startsWith("http://") ||
-      path.startsWith("https://") ||
-      path.startsWith("file://");
+      win32.isAbsolute(path) ||
+      path.startsWith('http://') ||
+      path.startsWith('https://') ||
+      path.startsWith('file://');
 
-    if (!(hasProjectDir || hasProjectUri || isAbsolutePath) && !projectDir.startsWith("http")) {
+    if (!(hasProjectDir || hasProjectUri || isAbsolutePath) && !projectDir.startsWith('http')) {
       path = join(projectDir, path);
     }
     path = convertPathToPosix(path);
@@ -212,41 +211,41 @@ export function toFileSystemPath(path: string | undefined, keepFileProtocol?: bo
   // This includes characters such as "#" and "?", which have special meaning in URLs,
   // but are just normal characters in a filesystem path.
   for (let i = 0; i < urlDecodePatterns.length; i += 2) {
-    path = path.replace(urlDecodePatterns[i], urlDecodePatterns[i + 1] as string);
+    path = path.replace(urlDecodePatterns[i]!, urlDecodePatterns[i + 1] as string);
   }
 
   // Step 3: If it's a "file://" URL, then format it consistently
   // or convert it to a local filesystem path
-  let isFileUrl = path.substr(0, 7).toLowerCase() === "file://";
+  let isFileUrl = path.substr(0, 7).toLowerCase() === 'file://';
   if (isFileUrl) {
     // Strip-off the protocol, and the initial "/", if there is one
-    path = path[7] === "/" ? path.substr(8) : path.substr(7);
+    path = path[7] === '/' ? path.substr(8) : path.substr(7);
 
     // insert a colon (":") after the drive letter on Windows
-    if (isWindows() && path[1] === "/") {
-      path = path[0] + ":" + path.substr(1);
+    if (isWindows() && path[1] === '/') {
+      path = path[0] + ':' + path.substr(1);
     }
 
     if (keepFileProtocol) {
       // Return the consistently-formatted "file://" URL
-      path = "file:///" + path;
+      path = 'file:///' + path;
     } else {
       // Convert the "file://" URL to a local filesystem path.
       // On Windows, it will start with something like "C:/".
       // On Posix, it will start with "/"
       isFileUrl = false;
-      path = isWindows() ? path : "/" + path;
+      path = isWindows() ? path : '/' + path;
     }
   }
 
   // Step 4: Normalize Windows paths (unless it's a "file://" URL)
   if (isWindows() && !isFileUrl) {
     // Replace forward slashes with backslashes
-    path = path.replace(forwardSlashPattern, "\\");
+    path = path.replace(forwardSlashPattern, '\\');
 
     // Capitalize the drive letter
-    if (path.substr(1, 2) === ":\\") {
-      path = path[0].toUpperCase() + path.substr(1);
+    if (path.substr(1, 2) === ':\\') {
+      path = path[0]!.toUpperCase() + path.substr(1);
     }
   }
 

package/dist/lib/__tests__/bundle.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/lib/__tests__/bundle.test.js

@@ -1,50 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const vitest_1 = require("vitest");
-const __1 = require("..");
-(0, vitest_1.describe)("bundle", () => {
-    (0, vitest_1.it)("handles circular reference with description", async () => {
-        const refParser = new __1.$RefParser();
-        const pathOrUrlOrSchema = path_1.default.resolve("lib", "__tests__", "spec", "circular-ref-with-description.json");
-        const schema = await refParser.bundle({ pathOrUrlOrSchema });
-        (0, vitest_1.expect)(schema).toEqual({
-            schemas: {
-                Bar: {
-                    $ref: '#/schemas/Foo',
-                    description: 'ok',
-                },
-                Foo: {
-                    $ref: '#/schemas/Bar',
-                },
-            },
-        });
-    });
-    (0, vitest_1.it)("bundles multiple references to the same file correctly", async () => {
-        const refParser = new __1.$RefParser();
-        const pathOrUrlOrSchema = path_1.default.resolve("lib", "__tests__", "spec", "multiple-refs.json");
-        const schema = (await refParser.bundle({ pathOrUrlOrSchema }));
-        // Both parameters should now be $ref to the same internal definition
-        const firstParam = schema.paths["/test1/{pathId}"].get.parameters[0];
-        const secondParam = schema.paths["/test2/{pathId}"].get.parameters[0];
-        // The $ref should match the output structure in file_context_0
-        (0, vitest_1.expect)(firstParam.$ref).toBe("#/components/parameters/path-parameter_pathId");
-        (0, vitest_1.expect)(secondParam.$ref).toBe("#/components/parameters/path-parameter_pathId");
-        // The referenced parameter should exist and match the expected structure
-        (0, vitest_1.expect)(schema.components).toBeDefined();
-        (0, vitest_1.expect)(schema.components.parameters).toBeDefined();
-        (0, vitest_1.expect)(schema.components.parameters["path-parameter_pathId"]).toEqual({
-            name: "pathId",
-            in: "path",
-            required: true,
-            schema: {
-                type: "string",
-                format: "uuid",
-                description: "Unique identifier for the path",
-            },
-        });
-    });
-});

package/dist/lib/__tests__/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/lib/__tests__/index.test.js

@@ -1,43 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_path_1 = __importDefault(require("node:path"));
-const vitest_1 = require("vitest");
-const index_1 = require("../index");
-(0, vitest_1.describe)("getResolvedInput", () => {
-    (0, vitest_1.it)("handles url", async () => {
-        const pathOrUrlOrSchema = "https://foo.com";
-        const resolvedInput = await (0, index_1.getResolvedInput)({ pathOrUrlOrSchema });
-        (0, vitest_1.expect)(resolvedInput.type).toBe("url");
-        (0, vitest_1.expect)(resolvedInput.schema).toBeUndefined();
-        (0, vitest_1.expect)(resolvedInput.path).toBe("https://foo.com/");
-    });
-    (0, vitest_1.it)("handles file", async () => {
-        const pathOrUrlOrSchema = "./path/to/openapi.json";
-        const resolvedInput = await (0, index_1.getResolvedInput)({ pathOrUrlOrSchema });
-        (0, vitest_1.expect)(resolvedInput.type).toBe("file");
-        (0, vitest_1.expect)(resolvedInput.schema).toBeUndefined();
-        (0, vitest_1.expect)(node_path_1.default.normalize(resolvedInput.path).toLowerCase()).toBe(node_path_1.default.normalize(node_path_1.default.resolve("./path/to/openapi.json")).toLowerCase());
-    });
-    (0, vitest_1.it)("handles raw spec", async () => {
-        const pathOrUrlOrSchema = {
-            info: {
-                version: "1.0.0",
-            },
-            openapi: "3.1.0",
-            paths: {},
-        };
-        const resolvedInput = await (0, index_1.getResolvedInput)({ pathOrUrlOrSchema });
-        (0, vitest_1.expect)(resolvedInput.type).toBe("json");
-        (0, vitest_1.expect)(resolvedInput.schema).toEqual({
-            info: {
-                version: "1.0.0",
-            },
-            openapi: "3.1.0",
-            paths: {},
-        });
-        (0, vitest_1.expect)(resolvedInput.path).toBe("");
-    });
-});

package/dist/lib/__tests__/pointer.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/lib/__tests__/pointer.test.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const vitest_1 = require("vitest");
-const __1 = require("..");
-const path_1 = __importDefault(require("path"));
-(0, vitest_1.describe)("pointer", () => {
-    (0, vitest_1.it)("inlines internal JSON Pointer refs under #/paths/ for OpenAPI bundling", async () => {
-        const refParser = new __1.$RefParser();
-        const pathOrUrlOrSchema = path_1.default.resolve("lib", "__tests__", "spec", "openapi-paths-ref.json");
-        const schema = (await refParser.bundle({ pathOrUrlOrSchema }));
-        // The GET endpoint should have its schema defined inline
-        const getSchema = schema.paths["/foo"].get.responses["200"].content["application/json"].schema;
-        (0, vitest_1.expect)(getSchema.$ref).toBeUndefined();
-        (0, vitest_1.expect)(getSchema.type).toBe("object");
-        (0, vitest_1.expect)(getSchema.properties.bar.type).toBe("string");
-        // The POST endpoint should have its schema inlined (copied) instead of a $ref
-        const postSchema = schema.paths["/foo"].post.responses["200"].content["application/json"].schema;
-        (0, vitest_1.expect)(postSchema.$ref).toBe("#/paths/~1foo/get/responses/200/content/application~1json/schema");
-        (0, vitest_1.expect)(postSchema.type).toBeUndefined();
-        (0, vitest_1.expect)(postSchema.properties?.bar?.type).toBeUndefined();
-        // Both schemas should be identical objects
-        (0, vitest_1.expect)(postSchema).not.toBe(getSchema);
-    });
-});

package/dist/lib/bundle.d.ts

@@ -1,26 +0,0 @@
-import type { ParserOptions } from "./options.js";
-import type { $RefParser } from "./index";
-export interface InventoryEntry {
-    $ref: any;
-    circular: any;
-    depth: any;
-    extended: any;
-    external: any;
-    file: any;
-    hash: any;
-    indirections: any;
-    key: any;
-    parent: any;
-    pathFromRoot: any;
-    value: any;
-    originalContainerType?: "schemas" | "parameters" | "requestBodies" | "responses" | "headers";
-}
-/**
- * Bundles all external JSON references into the main JSON schema, thus resulting in a schema that
- * only has *internal* references, not any *external* references.
- * This method mutates the JSON schema object, adding new references and re-mapping existing ones.
- *
- * @param parser
- * @param options
- */
-export declare const bundle: (parser: $RefParser, options: ParserOptions) => void;