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

package/dist/lib/util/errors.js

@@ -1,112 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidPointerError = exports.TimeoutError = exports.MissingPointerError = exports.UnmatchedResolverError = exports.ResolverError = exports.UnmatchedParserError = exports.ParserError = exports.JSONParserErrorGroup = exports.JSONParserError = void 0;
-exports.isHandledError = isHandledError;
-exports.normalizeError = normalizeError;
-const ono_1 = require("@jsdevtools/ono");
-const url_js_1 = require("./url.js");
-class JSONParserError extends Error {
-    constructor(message, source) {
-        super();
-        this.code = "EUNKNOWN";
-        this.name = "JSONParserError";
-        this.message = message;
-        this.source = source;
-        this.path = null;
-        ono_1.Ono.extend(this);
-    }
-    get footprint() {
-        return `${this.path}+${this.source}+${this.code}+${this.message}`;
-    }
-}
-exports.JSONParserError = JSONParserError;
-class JSONParserErrorGroup extends Error {
-    constructor(parser) {
-        super();
-        this.files = parser;
-        this.name = "JSONParserErrorGroup";
-        this.message = `${this.errors.length} error${this.errors.length > 1 ? "s" : ""} occurred while reading '${(0, url_js_1.toFileSystemPath)(parser.$refs._root$Ref.path)}'`;
-        ono_1.Ono.extend(this);
-    }
-    static getParserErrors(parser) {
-        const errors = [];
-        for (const $ref of Object.values(parser.$refs._$refs)) {
-            if ($ref.errors) {
-                errors.push(...$ref.errors);
-            }
-        }
-        return errors;
-    }
-    get errors() {
-        return JSONParserErrorGroup.getParserErrors(this.files);
-    }
-}
-exports.JSONParserErrorGroup = JSONParserErrorGroup;
-class ParserError extends JSONParserError {
-    constructor(message, source) {
-        super(`Error parsing ${source}: ${message}`, source);
-        this.code = "EPARSER";
-        this.name = "ParserError";
-    }
-}
-exports.ParserError = ParserError;
-class UnmatchedParserError extends JSONParserError {
-    constructor(source) {
-        super(`Could not find parser for "${source}"`, source);
-        this.code = "EUNMATCHEDPARSER";
-        this.name = "UnmatchedParserError";
-    }
-}
-exports.UnmatchedParserError = UnmatchedParserError;
-class ResolverError extends JSONParserError {
-    constructor(ex, source) {
-        super(ex.message || `Error reading file "${source}"`, source);
-        this.code = "ERESOLVER";
-        this.name = "ResolverError";
-        if ("code" in ex) {
-            this.ioErrorCode = String(ex.code);
-        }
-    }
-}
-exports.ResolverError = ResolverError;
-class UnmatchedResolverError extends JSONParserError {
-    constructor(source) {
-        super(`Could not find resolver for "${source}"`, source);
-        this.code = "EUNMATCHEDRESOLVER";
-        this.name = "UnmatchedResolverError";
-    }
-}
-exports.UnmatchedResolverError = UnmatchedResolverError;
-class MissingPointerError extends JSONParserError {
-    constructor(token, path) {
-        super(`Missing $ref pointer "${(0, url_js_1.getHash)(path)}". Token "${token}" does not exist.`, (0, url_js_1.stripHash)(path));
-        this.code = "EMISSINGPOINTER";
-        this.name = "MissingPointerError";
-    }
-}
-exports.MissingPointerError = MissingPointerError;
-class TimeoutError extends JSONParserError {
-    constructor(timeout) {
-        super(`Dereferencing timeout reached: ${timeout}ms`);
-        this.code = "ETIMEOUT";
-        this.name = "TimeoutError";
-    }
-}
-exports.TimeoutError = TimeoutError;
-class InvalidPointerError extends JSONParserError {
-    constructor(pointer, path) {
-        super(`Invalid $ref pointer "${pointer}". Pointers must begin with "#/"`, (0, url_js_1.stripHash)(path));
-        this.code = "EUNMATCHEDRESOLVER";
-        this.name = "InvalidPointerError";
-    }
-}
-exports.InvalidPointerError = InvalidPointerError;
-function isHandledError(err) {
-    return err instanceof JSONParserError || err instanceof JSONParserErrorGroup;
-}
-function normalizeError(err) {
-    if (err.path === null) {
-        err.path = [];
-    }
-    return err;
-}

package/dist/lib/util/is-windows.d.ts

@@ -1 +0,0 @@
-export declare const isWindows: () => boolean;

package/dist/lib/util/is-windows.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWindows = void 0;
-const isWindowsConst = /^win/.test(globalThis.process ? globalThis.process.platform : "");
-const isWindows = () => isWindowsConst;
-exports.isWindows = isWindows;

package/dist/lib/util/plugins.d.ts

@@ -1,16 +0,0 @@
-import type { FileInfo, JSONSchema } from "../types/index.js";
-import type { Plugin } from "../types/index.js";
-export interface PluginResult {
-    error?: any;
-    plugin: Pick<Plugin, 'handler'>;
-    result?: string | Buffer | JSONSchema;
-}
-/**
- * Runs the specified method of the given plugins, in order, until one of them returns a successful result.
- * Each method can return a synchronous value, a Promise, or call an error-first callback.
- * If the promise resolves successfully, or the callback is called without an error, then the result
- * is immediately returned and no further plugins are called.
- * If the promise rejects, or the callback is called with an error, then the next plugin is called.
- * If ALL plugins fail, then the last error is thrown.
- */
-export declare function run(plugins: Pick<Plugin, 'handler'>[], file: FileInfo): Promise<PluginResult>;

package/dist/lib/util/plugins.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = run;
-/**
- * Runs the specified method of the given plugins, in order, until one of them returns a successful result.
- * Each method can return a synchronous value, a Promise, or call an error-first callback.
- * If the promise resolves successfully, or the callback is called without an error, then the result
- * is immediately returned and no further plugins are called.
- * If the promise rejects, or the callback is called with an error, then the next plugin is called.
- * If ALL plugins fail, then the last error is thrown.
- */
-async function run(plugins, file) {
-    let index = 0;
-    let lastError;
-    let plugin;
-    return new Promise((resolve, reject) => {
-        const runNextPlugin = async () => {
-            plugin = plugins[index++];
-            if (!plugin) {
-                // there are no more functions, re-throw the last error
-                return reject(lastError);
-            }
-            try {
-                const result = await plugin.handler(file);
-                if (result !== undefined) {
-                    return resolve({
-                        plugin,
-                        result,
-                    });
-                }
-                if (index === plugins.length) {
-                    throw new Error("No promise has been returned.");
-                }
-            }
-            catch (e) {
-                lastError = {
-                    plugin,
-                    error: e,
-                };
-                runNextPlugin();
-            }
-        };
-        runNextPlugin();
-    });
-}

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

@@ -1,79 +0,0 @@
-/**
- * Returns resolved target URL relative to a base URL in a manner similar to that of a Web browser resolving an anchor tag HREF.
- *
- * @returns
- */
-export declare function resolve(from: string, to: string): string;
-/**
- * Returns the current working directory (in Node) or the current page URL (in browsers).
- *
- * @returns
- */
-export declare function cwd(): string;
-/**
- * Returns the protocol of the given URL, or `undefined` if it has no protocol.
- *
- * @param path
- * @returns
- */
-export declare function getProtocol(path: string | undefined): string | undefined;
-/**
- * Returns the lowercased file extension of the given URL,
- * or an empty string if it has no extension.
- *
- * @param path
- * @returns
- */
-export declare function getExtension(path: any): any;
-/**
- * Removes the query, if any, from the given path.
- *
- * @param path
- * @returns
- */
-export declare function stripQuery(path: any): any;
-/**
- * Returns the hash (URL fragment), of the given path.
- * If there is no hash, then the root hash ("#") is returned.
- *
- * @param path
- * @returns
- */
-export declare function getHash(path: undefined | string): string;
-/**
- * Removes the hash (URL fragment), if any, from the given path.
- *
- * @param path
- * @returns
- */
-export declare function stripHash(path?: string | undefined): string;
-/**
- * Determines whether the given path is a filesystem path.
- * This includes "file://" URLs.
- *
- * @param path
- * @returns
- */
-export declare function isFileSystemPath(path: string | undefined): boolean;
-/**
- * Converts a filesystem path to a properly-encoded URL.
- *
- * This is intended to handle situations where JSON Schema $Ref Parser is called
- * with a filesystem path that contains characters which are not allowed in URLs.
- *
- * @example
- * The following filesystem paths would be converted to the following URLs:
- *
- *    <"!@#$%^&*+=?'>.json              ==>   %3C%22!@%23$%25%5E&*+=%3F\'%3E.json
- *    C:\\My Documents\\File (1).json   ==>   C:/My%20Documents/File%20(1).json
- *    file://Project #42/file.json      ==>   file://Project%20%2342/file.json
- *
- * @param path
- * @returns
- */
-export declare function fromFileSystemPath(path: string): string;
-/**
- * Converts a URL to a local filesystem path.
- */
-export declare function toFileSystemPath(path: string | undefined, keepFileProtocol?: boolean): string;
-export declare function relative(from: string, to: string): string;

package/dist/lib/util/url.js

@@ -1,285 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolve = resolve;
-exports.cwd = cwd;
-exports.getProtocol = getProtocol;
-exports.getExtension = getExtension;
-exports.stripQuery = stripQuery;
-exports.getHash = getHash;
-exports.stripHash = stripHash;
-exports.isFileSystemPath = isFileSystemPath;
-exports.fromFileSystemPath = fromFileSystemPath;
-exports.toFileSystemPath = toFileSystemPath;
-exports.relative = relative;
-const convert_path_to_posix_1 = __importDefault(require("./convert-path-to-posix"));
-const path_1 = __importStar(require("path"));
-const forwardSlashPattern = /\//g;
-const protocolPattern = /^(\w{2,}):\/\//i;
-const path_2 = require("path");
-const is_windows_1 = require("./is-windows");
-// RegExp patterns to URL-encode special characters in local filesystem paths
-const urlEncodePatterns = [
-    [/\?/g, "%3F"],
-    [/#/g, "%23"],
-];
-// RegExp patterns to URL-decode special characters for local filesystem paths
-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.
- *
- * @returns
- */
-function resolve(from, to) {
-    const fromUrl = new URL((0, convert_path_to_posix_1.default)(from), "resolve://");
-    const resolvedUrl = new URL((0, convert_path_to_posix_1.default)(to), fromUrl);
-    const endSpaces = to.match(/(\s*)$/)?.[1] || "";
-    if (resolvedUrl.protocol === "resolve:") {
-        // `from` is a relative URL.
-        const { pathname, search, hash } = resolvedUrl;
-        return pathname + search + hash + endSpaces;
-    }
-    return resolvedUrl.toString() + endSpaces;
-}
-/**
- * Returns the current working directory (in Node) or the current page URL (in browsers).
- *
- * @returns
- */
-function cwd() {
-    if (typeof window !== "undefined") {
-        return location.href;
-    }
-    const path = process.cwd();
-    const lastChar = path.slice(-1);
-    if (lastChar === "/" || lastChar === "\\") {
-        return path;
-    }
-    else {
-        return path + "/";
-    }
-}
-/**
- * Returns the protocol of the given URL, or `undefined` if it has no protocol.
- *
- * @param path
- * @returns
- */
-function getProtocol(path) {
-    const match = protocolPattern.exec(path || "");
-    if (match) {
-        return match[1].toLowerCase();
-    }
-    return undefined;
-}
-/**
- * Returns the lowercased file extension of the given URL,
- * or an empty string if it has no extension.
- *
- * @param path
- * @returns
- */
-function getExtension(path) {
-    const lastDot = path.lastIndexOf(".");
-    if (lastDot > -1) {
-        return stripQuery(path.substr(lastDot).toLowerCase());
-    }
-    return "";
-}
-/**
- * Removes the query, if any, from the given path.
- *
- * @param path
- * @returns
- */
-function stripQuery(path) {
-    const queryIndex = path.indexOf("?");
-    if (queryIndex > -1) {
-        path = path.substr(0, queryIndex);
-    }
-    return path;
-}
-/**
- * Returns the hash (URL fragment), of the given path.
- * If there is no hash, then the root hash ("#") is returned.
- *
- * @param path
- * @returns
- */
-function getHash(path) {
-    if (!path) {
-        return "#";
-    }
-    const hashIndex = path.indexOf("#");
-    if (hashIndex > -1) {
-        return path.substring(hashIndex);
-    }
-    return "#";
-}
-/**
- * Removes the hash (URL fragment), if any, from the given path.
- *
- * @param path
- * @returns
- */
-function stripHash(path) {
-    if (!path) {
-        return "";
-    }
-    const hashIndex = path.indexOf("#");
-    if (hashIndex > -1) {
-        path = path.substring(0, hashIndex);
-    }
-    return path;
-}
-/**
- * Determines whether the given path is a filesystem path.
- * This includes "file://" URLs.
- *
- * @param path
- * @returns
- */
-function isFileSystemPath(path) {
-    // @ts-ignore
-    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";
-}
-/**
- * Converts a filesystem path to a properly-encoded URL.
- *
- * This is intended to handle situations where JSON Schema $Ref Parser is called
- * with a filesystem path that contains characters which are not allowed in URLs.
- *
- * @example
- * The following filesystem paths would be converted to the following URLs:
- *
- *    <"!@#$%^&*+=?'>.json              ==>   %3C%22!@%23$%25%5E&*+=%3F\'%3E.json
- *    C:\\My Documents\\File (1).json   ==>   C:/My%20Documents/File%20(1).json
- *    file://Project #42/file.json      ==>   file://Project%20%2342/file.json
- *
- * @param path
- * @returns
- */
-function fromFileSystemPath(path) {
-    // Step 1: On Windows, replace backslashes with forward slashes,
-    // rather than encoding them as "%5C"
-    if ((0, is_windows_1.isWindows)()) {
-        const projectDir = cwd();
-        const upperPath = path.toUpperCase();
-        const projectDirPosixPath = (0, convert_path_to_posix_1.default)(projectDir);
-        const posixUpper = projectDirPosixPath.toUpperCase();
-        const hasProjectDir = upperPath.includes(posixUpper);
-        const hasProjectUri = upperPath.includes(posixUpper);
-        const isAbsolutePath = path_1.win32?.isAbsolute(path) ||
-            path.startsWith("http://") ||
-            path.startsWith("https://") ||
-            path.startsWith("file://");
-        if (!(hasProjectDir || hasProjectUri || isAbsolutePath) && !projectDir.startsWith("http")) {
-            path = (0, path_2.join)(projectDir, path);
-        }
-        path = (0, convert_path_to_posix_1.default)(path);
-    }
-    // Step 2: `encodeURI` will take care of MOST characters
-    path = encodeURI(path);
-    // Step 3: Manually encode characters that are not encoded by `encodeURI`.
-    // This includes characters such as "#" and "?", which have special meaning in URLs,
-    // but are just normal characters in a filesystem path.
-    for (const pattern of urlEncodePatterns) {
-        path = path.replace(pattern[0], pattern[1]);
-    }
-    return path;
-}
-/**
- * Converts a URL to a local filesystem path.
- */
-function toFileSystemPath(path, keepFileProtocol) {
-    // Step 1: `decodeURI` will decode characters such as Cyrillic characters, spaces, etc.
-    path = decodeURI(path);
-    // Step 2: Manually decode characters that are not decoded by `decodeURI`.
-    // 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]);
-    }
-    // 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://";
-    if (isFileUrl) {
-        // Strip-off the protocol, and the initial "/", if there is one
-        path = path[7] === "/" ? path.substr(8) : path.substr(7);
-        // insert a colon (":") after the drive letter on Windows
-        if ((0, is_windows_1.isWindows)() && path[1] === "/") {
-            path = path[0] + ":" + path.substr(1);
-        }
-        if (keepFileProtocol) {
-            // Return the consistently-formatted "file://" URL
-            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 = (0, is_windows_1.isWindows)() ? path : "/" + path;
-        }
-    }
-    // Step 4: Normalize Windows paths (unless it's a "file://" URL)
-    if ((0, is_windows_1.isWindows)() && !isFileUrl) {
-        // Replace forward slashes with backslashes
-        path = path.replace(forwardSlashPattern, "\\");
-        // Capitalize the drive letter
-        if (path.substr(1, 2) === ":\\") {
-            path = path[0].toUpperCase() + path.substr(1);
-        }
-    }
-    return path;
-}
-function relative(from, to) {
-    if (!isFileSystemPath(from) || !isFileSystemPath(to)) {
-        return resolve(from, to);
-    }
-    const fromDir = path_1.default.dirname(stripHash(from));
-    const toPath = stripHash(to);
-    const result = path_1.default.relative(fromDir, toPath);
-    return result + getHash(to);
-}

package/dist/vite.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vite").UserConfig;
-export default _default;

package/dist/vite.config.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const config_1 = require("vitest/config");
-const isBrowser = process.env.BROWSER === "true";
-exports.default = (0, config_1.defineConfig)({
-    test: {
-        coverage: { reporter: ["lcov", "html", "text"] },
-        dir: "test",
-        environment: isBrowser ? "jsdom" : "node",
-        exclude: ["**/__IGNORED__/**"],
-        globals: true,
-        globalSetup: isBrowser ? ["./test/fixtures/server.ts"] : undefined,
-        include: ['./lib/**/*.test.ts'],
-        passWithNoTests: true,
-        reporters: ["verbose"],
-        testTimeout: 5000,
-        watch: false,
-    },
-});

package/lib/__tests__/bundle.test.ts

@@ -1,52 +0,0 @@
-import path from "path";
-
-import { describe, expect, it } from "vitest";
-
-import { $RefParser } from "..";
-
-describe("bundle", () => {
-  it("handles circular reference with description", async () => {
-    const refParser = new $RefParser();
-    const pathOrUrlOrSchema = path.resolve("lib", "__tests__", "spec", "circular-ref-with-description.json");
-    const schema = await refParser.bundle({ pathOrUrlOrSchema });
-    expect(schema).toEqual({
-      schemas: {
-        Bar: {
-          $ref: '#/schemas/Foo',
-          description: 'ok',
-        },
-        Foo: {
-          $ref: '#/schemas/Bar',
-        },
-      },
-    });
-  });
-
-  it("bundles multiple references to the same file correctly", async () => {
-    const refParser = new $RefParser();
-    const pathOrUrlOrSchema = path.resolve("lib", "__tests__", "spec", "multiple-refs.json");
-    const schema = (await refParser.bundle({ pathOrUrlOrSchema })) as any;
-
-    // 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
-    expect(firstParam.$ref).toBe("#/components/parameters/path-parameter_pathId");
-    expect(secondParam.$ref).toBe("#/components/parameters/path-parameter_pathId");
-
-    // The referenced parameter should exist and match the expected structure
-    expect(schema.components).toBeDefined();
-    expect(schema.components.parameters).toBeDefined();
-    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/lib/__tests__/index.test.ts

@@ -1,45 +0,0 @@
-import path from "node:path";
-
-import { describe, expect, it } from "vitest";
-
-import { getResolvedInput } from "../index";
-
-describe("getResolvedInput", () => {
-  it("handles url", async () => {
-    const pathOrUrlOrSchema = "https://foo.com";
-    const resolvedInput = await getResolvedInput({ pathOrUrlOrSchema });
-    expect(resolvedInput.type).toBe("url");
-    expect(resolvedInput.schema).toBeUndefined();
-    expect(resolvedInput.path).toBe("https://foo.com/");
-  });
-
-  it("handles file", async () => {
-    const pathOrUrlOrSchema = "./path/to/openapi.json";
-    const resolvedInput = await getResolvedInput({ pathOrUrlOrSchema });
-    expect(resolvedInput.type).toBe("file");
-    expect(resolvedInput.schema).toBeUndefined();
-    expect(path.normalize(resolvedInput.path).toLowerCase()).toBe(
-      path.normalize(path.resolve("./path/to/openapi.json")).toLowerCase(),
-    );
-  });
-
-  it("handles raw spec", async () => {
-    const pathOrUrlOrSchema = {
-      info: {
-        version: "1.0.0",
-      },
-      openapi: "3.1.0",
-      paths: {},
-    };
-    const resolvedInput = await getResolvedInput({ pathOrUrlOrSchema });
-    expect(resolvedInput.type).toBe("json");
-    expect(resolvedInput.schema).toEqual({
-      info: {
-        version: "1.0.0",
-      },
-      openapi: "3.1.0",
-      paths: {},
-    });
-    expect(resolvedInput.path).toBe("");
-  });
-});