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

package/dist/lib/parse.js

@@ -1,87 +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;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseFile = void 0;
-exports.newFile = newFile;
-const ono_1 = require("@jsdevtools/ono");
-const url_js_1 = require("./util/url.js");
-const plugins = __importStar(require("./util/plugins.js"));
-const errors_js_1 = require("./util/errors.js");
-/**
- * Prepares the file object so we can populate it with data and other values
- * when it's read and parsed. This "file object" will be passed to all
- * resolvers and parsers.
- */
-function newFile(path) {
-    let url = path;
-    // Remove the URL fragment, if any
-    const hashIndex = url.indexOf("#");
-    let hash = "";
-    if (hashIndex > -1) {
-        hash = url.substring(hashIndex);
-        url = url.substring(0, hashIndex);
-    }
-    return {
-        extension: (0, url_js_1.getExtension)(url),
-        hash,
-        url,
-    };
-}
-/**
- * Parses the given file's contents, using the configured parser plugins.
- */
-const parseFile = async (file, options) => {
-    try {
-        // If none of the parsers are a match for this file, try all of them. This
-        // handles situations where the file is a supported type, just with an
-        // unknown extension.
-        const parsers = [options.parse.json, options.parse.yaml, options.parse.text, options.parse.binary];
-        const filtered = parsers.filter((plugin) => plugin.canHandle(file));
-        return await plugins.run(filtered.length ? filtered : parsers, file);
-    }
-    catch (error) {
-        if (error && error.message && error.message.startsWith("Error parsing")) {
-            throw error;
-        }
-        if (!error || !("error" in error)) {
-            throw ono_1.ono.syntax(`Unable to parse ${file.url}`);
-        }
-        if (error.error instanceof errors_js_1.ParserError) {
-            throw error.error;
-        }
-        throw new errors_js_1.ParserError(error.error.message, file.url);
-    }
-};
-exports.parseFile = parseFile;

package/dist/lib/parsers/binary.d.ts

@@ -1,2 +0,0 @@
-import type { Plugin } from "../types/index.js";
-export declare const binaryParser: Plugin;

package/dist/lib/parsers/binary.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.binaryParser = void 0;
-const BINARY_REGEXP = /\.(jpeg|jpg|gif|png|bmp|ico)$/i;
-exports.binaryParser = {
-    canHandle: (file) => Buffer.isBuffer(file.data) && BINARY_REGEXP.test(file.url),
-    handler: (file) => Buffer.isBuffer(file.data)
-        ? file.data
-        // This will reject if data is anything other than a string or typed array
-        : Buffer.from(file.data),
-    name: 'binary',
-};

package/dist/lib/parsers/json.d.ts

@@ -1,2 +0,0 @@
-import type { Plugin } from "../types/index.js";
-export declare const jsonParser: Plugin;

package/dist/lib/parsers/json.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonParser = void 0;
-const errors_js_1 = require("../util/errors.js");
-exports.jsonParser = {
-    canHandle: (file) => file.extension === '.json',
-    async handler(file) {
-        let data = file.data;
-        if (Buffer.isBuffer(data)) {
-            data = data.toString();
-        }
-        if (typeof data !== "string") {
-            // data is already a JavaScript value (object, array, number, null, NaN, etc.)
-            return data;
-        }
-        if (!data.trim().length) {
-            // this mirrors the YAML behavior
-            return;
-        }
-        try {
-            return JSON.parse(data);
-            // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        }
-        catch (error) {
-            try {
-                // find the first curly brace
-                const firstCurlyBrace = data.indexOf("{");
-                // remove any characters before the first curly brace
-                data = data.slice(firstCurlyBrace);
-                return JSON.parse(data);
-            }
-            catch (error) {
-                throw new errors_js_1.ParserError(error.message, file.url);
-            }
-        }
-    },
-    name: 'json',
-};

package/dist/lib/parsers/text.d.ts

@@ -1,2 +0,0 @@
-import type { Plugin } from "../types/index.js";
-export declare const textParser: Plugin;

package/dist/lib/parsers/text.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.textParser = void 0;
-const errors_js_1 = require("../util/errors.js");
-const TEXT_REGEXP = /\.(txt|htm|html|md|xml|js|min|map|css|scss|less|svg)$/i;
-exports.textParser = {
-    canHandle: (file) => (typeof file.data === "string" || Buffer.isBuffer(file.data)) && TEXT_REGEXP.test(file.url),
-    handler(file) {
-        if (typeof file.data === "string") {
-            return file.data;
-        }
-        if (!Buffer.isBuffer(file.data)) {
-            throw new errors_js_1.ParserError("data is not text", file.url);
-        }
-        return file.data.toString('utf-8');
-    },
-    name: 'text',
-};

package/dist/lib/parsers/yaml.d.ts

@@ -1,2 +0,0 @@
-import type { Plugin } from "../types/index.js";
-export declare const yamlParser: Plugin;

package/dist/lib/parsers/yaml.js

@@ -1,28 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.yamlParser = void 0;
-const errors_js_1 = require("../util/errors.js");
-const js_yaml_1 = __importDefault(require("js-yaml"));
-const js_yaml_2 = require("js-yaml");
-exports.yamlParser = {
-    // JSON is valid YAML
-    canHandle: (file) => [".yaml", ".yml", ".json"].includes(file.extension),
-    handler: async (file) => {
-        const data = Buffer.isBuffer(file.data) ? file.data.toString() : file.data;
-        if (typeof data !== "string") {
-            // data is already a JavaScript value (object, array, number, null, NaN, etc.)
-            return data;
-        }
-        try {
-            const yamlSchema = js_yaml_1.default.load(data, { schema: js_yaml_2.JSON_SCHEMA });
-            return yamlSchema;
-        }
-        catch (error) {
-            throw new errors_js_1.ParserError(error?.message || "Parser Error", file.url);
-        }
-    },
-    name: 'yaml',
-};

package/dist/lib/pointer.d.ts

@@ -1,88 +0,0 @@
-import type { ParserOptions } from "./options.js";
-import $Ref from "./ref.js";
-import type { JSONSchema } from "./types";
-/**
- * This class represents a single JSON pointer and its resolved value.
- *
- * @param $ref
- * @param path
- * @param [friendlyPath] - The original user-specified path (used for error messages)
- * @class
- */
-declare class Pointer<S extends object = JSONSchema> {
-    /**
-     * The {@link $Ref} object that contains this {@link Pointer} object.
-     */
-    $ref: $Ref<S>;
-    /**
-     * The file path or URL, containing the JSON pointer in the hash.
-     * This path is relative to the path of the main JSON schema file.
-     */
-    path: string;
-    /**
-     * The original path or URL, used for error messages.
-     */
-    originalPath: string;
-    /**
-     * The value of the JSON pointer.
-     * Can be any JSON type, not just objects. Unknown file types are represented as Buffers (byte arrays).
-     */
-    value: any;
-    /**
-     * Indicates whether the pointer references itself.
-     */
-    circular: boolean;
-    /**
-     * The number of indirect references that were traversed to resolve the value.
-     * Resolving a single pointer may require resolving multiple $Refs.
-     */
-    indirections: number;
-    constructor($ref: $Ref<S>, path: string, friendlyPath?: string);
-    /**
-     * Resolves the value of a nested property within the given object.
-     *
-     * @param obj - The object that will be crawled
-     * @param options
-     * @param pathFromRoot - the path of place that initiated resolving
-     *
-     * @returns
-     * Returns a JSON pointer whose {@link Pointer#value} is the resolved value.
-     * If resolving this value required resolving other JSON references, then
-     * the {@link Pointer#$ref} and {@link Pointer#path} will reflect the resolution path
-     * of the resolved value.
-     */
-    resolve(obj: S, options?: ParserOptions, pathFromRoot?: string): this;
-    /**
-     * Sets the value of a nested property within the given object.
-     *
-     * @param obj - The object that will be crawled
-     * @param value - the value to assign
-     * @param options
-     *
-     * @returns
-     * Returns the modified object, or an entirely new object if the entire object is overwritten.
-     */
-    set(obj: S, value: any, options?: ParserOptions): any;
-    /**
-     * Parses a JSON pointer (or a path containing a JSON pointer in the hash)
-     * and returns an array of the pointer's tokens.
-     * (e.g. "schema.json#/definitions/person/name" => ["definitions", "person", "name"])
-     *
-     * The pointer is parsed according to RFC 6901
-     * {@link https://tools.ietf.org/html/rfc6901#section-3}
-     *
-     * @param path
-     * @param [originalPath]
-     * @returns
-     */
-    static parse(path: string, originalPath?: string): string[];
-    /**
-     * Creates a JSON pointer path, by joining one or more tokens to a base path.
-     *
-     * @param base - The base path (e.g. "schema.json#/definitions/person")
-     * @param tokens - The token(s) to append (e.g. ["name", "first"])
-     * @returns
-     */
-    static join(base: string, tokens: string | string[]): string;
-}
-export default Pointer;

package/dist/lib/pointer.js

@@ -1,297 +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 });
-const ref_js_1 = __importDefault(require("./ref.js"));
-const url = __importStar(require("./util/url.js"));
-const errors_js_1 = require("./util/errors.js");
-const slashes = /\//g;
-const tildes = /~/g;
-const escapedSlash = /~1/g;
-const escapedTilde = /~0/g;
-const safeDecodeURIComponent = (encodedURIComponent) => {
-    try {
-        return decodeURIComponent(encodedURIComponent);
-    }
-    catch {
-        return encodedURIComponent;
-    }
-};
-/**
- * This class represents a single JSON pointer and its resolved value.
- *
- * @param $ref
- * @param path
- * @param [friendlyPath] - The original user-specified path (used for error messages)
- * @class
- */
-class Pointer {
-    constructor($ref, path, friendlyPath) {
-        this.$ref = $ref;
-        this.path = path;
-        this.originalPath = friendlyPath || path;
-        this.value = undefined;
-        this.circular = false;
-        this.indirections = 0;
-    }
-    /**
-     * Resolves the value of a nested property within the given object.
-     *
-     * @param obj - The object that will be crawled
-     * @param options
-     * @param pathFromRoot - the path of place that initiated resolving
-     *
-     * @returns
-     * Returns a JSON pointer whose {@link Pointer#value} is the resolved value.
-     * If resolving this value required resolving other JSON references, then
-     * the {@link Pointer#$ref} and {@link Pointer#path} will reflect the resolution path
-     * of the resolved value.
-     */
-    resolve(obj, options, pathFromRoot) {
-        const tokens = Pointer.parse(this.path, this.originalPath);
-        // Crawl the object, one token at a time
-        this.value = unwrapOrThrow(obj);
-        const errors = [];
-        for (let i = 0; i < tokens.length; i++) {
-            if (resolveIf$Ref(this, options, pathFromRoot)) {
-                // The $ref path has changed, so append the remaining tokens to the path
-                this.path = Pointer.join(this.path, tokens.slice(i));
-            }
-            if (typeof this.value === "object" && this.value !== null && !isRootPath(pathFromRoot) && "$ref" in this.value) {
-                return this;
-            }
-            const token = tokens[i];
-            if (this.value[token] === undefined || (this.value[token] === null && i === tokens.length - 1)) {
-                // one final case is if the entry itself includes slashes, and was parsed out as a token - we can join the remaining tokens and try again
-                let didFindSubstringSlashMatch = false;
-                for (let j = tokens.length - 1; j > i; j--) {
-                    const joinedToken = tokens.slice(i, j + 1).join("/");
-                    if (this.value[joinedToken] !== undefined) {
-                        this.value = this.value[joinedToken];
-                        i = j;
-                        didFindSubstringSlashMatch = true;
-                        break;
-                    }
-                }
-                if (didFindSubstringSlashMatch) {
-                    continue;
-                }
-                this.value = null;
-                errors.push(new errors_js_1.MissingPointerError(token, decodeURI(this.originalPath)));
-            }
-            else {
-                this.value = this.value[token];
-            }
-        }
-        if (errors.length > 0) {
-            throw errors.length === 1 ? errors[0] : new AggregateError(errors, "Multiple missing pointer errors");
-        }
-        // Resolve the final value
-        if (!this.value || (this.value.$ref && url.resolve(this.path, this.value.$ref) !== pathFromRoot)) {
-            resolveIf$Ref(this, options, pathFromRoot);
-        }
-        return this;
-    }
-    /**
-     * Sets the value of a nested property within the given object.
-     *
-     * @param obj - The object that will be crawled
-     * @param value - the value to assign
-     * @param options
-     *
-     * @returns
-     * Returns the modified object, or an entirely new object if the entire object is overwritten.
-     */
-    set(obj, value, options) {
-        const tokens = Pointer.parse(this.path);
-        let token;
-        if (tokens.length === 0) {
-            // There are no tokens, replace the entire object with the new value
-            this.value = value;
-            return value;
-        }
-        // Crawl the object, one token at a time
-        this.value = unwrapOrThrow(obj);
-        for (let i = 0; i < tokens.length - 1; i++) {
-            resolveIf$Ref(this, options);
-            token = tokens[i];
-            if (this.value && this.value[token] !== undefined) {
-                // The token exists
-                this.value = this.value[token];
-            }
-            else {
-                // The token doesn't exist, so create it
-                this.value = setValue(this, token, {});
-            }
-        }
-        // Set the value of the final token
-        resolveIf$Ref(this, options);
-        token = tokens[tokens.length - 1];
-        setValue(this, token, value);
-        // Return the updated object
-        return obj;
-    }
-    /**
-     * Parses a JSON pointer (or a path containing a JSON pointer in the hash)
-     * and returns an array of the pointer's tokens.
-     * (e.g. "schema.json#/definitions/person/name" => ["definitions", "person", "name"])
-     *
-     * The pointer is parsed according to RFC 6901
-     * {@link https://tools.ietf.org/html/rfc6901#section-3}
-     *
-     * @param path
-     * @param [originalPath]
-     * @returns
-     */
-    static parse(path, originalPath) {
-        // Get the JSON pointer from the path's hash
-        const pointer = url.getHash(path).substring(1);
-        // If there's no pointer, then there are no tokens,
-        // so return an empty array
-        if (!pointer) {
-            return [];
-        }
-        // Split into an array
-        const split = pointer.split("/");
-        // Decode each part, according to RFC 6901
-        for (let i = 0; i < split.length; i++) {
-            split[i] = safeDecodeURIComponent(split[i].replace(escapedSlash, "/").replace(escapedTilde, "~"));
-        }
-        if (split[0] !== "") {
-            throw new errors_js_1.InvalidPointerError(pointer, originalPath === undefined ? path : originalPath);
-        }
-        return split.slice(1);
-    }
-    /**
-     * Creates a JSON pointer path, by joining one or more tokens to a base path.
-     *
-     * @param base - The base path (e.g. "schema.json#/definitions/person")
-     * @param tokens - The token(s) to append (e.g. ["name", "first"])
-     * @returns
-     */
-    static join(base, tokens) {
-        // Ensure that the base path contains a hash
-        if (base.indexOf("#") === -1) {
-            base += "#";
-        }
-        // Append each token to the base path
-        tokens = Array.isArray(tokens) ? tokens : [tokens];
-        for (let i = 0; i < tokens.length; i++) {
-            const token = tokens[i];
-            // Encode the token, according to RFC 6901
-            base += "/" + encodeURIComponent(token.replace(tildes, "~0").replace(slashes, "~1"));
-        }
-        return base;
-    }
-}
-/**
- * If the given pointer's {@link Pointer#value} is a JSON reference,
- * then the reference is resolved and {@link Pointer#value} is replaced with the resolved value.
- * In addition, {@link Pointer#path} and {@link Pointer#$ref} are updated to reflect the
- * resolution path of the new value.
- *
- * @param pointer
- * @param options
- * @param [pathFromRoot] - the path of place that initiated resolving
- * @returns - Returns `true` if the resolution path changed
- */
-function resolveIf$Ref(pointer, options, pathFromRoot) {
-    // Is the value a JSON reference? (and allowed?)
-    if (ref_js_1.default.isAllowed$Ref(pointer.value)) {
-        const $refPath = url.resolve(pointer.path, pointer.value.$ref);
-        if ($refPath === pointer.path && !isRootPath(pathFromRoot)) {
-            // The value is a reference to itself, so there's nothing to do.
-            pointer.circular = true;
-        }
-        else {
-            const resolved = pointer.$ref.$refs._resolve($refPath, pointer.path, options);
-            if (resolved === null) {
-                return false;
-            }
-            pointer.indirections += resolved.indirections + 1;
-            if (ref_js_1.default.isExtended$Ref(pointer.value)) {
-                // This JSON reference "extends" the resolved value, rather than simply pointing to it.
-                // So the resolved path does NOT change.  Just the value does.
-                pointer.value = ref_js_1.default.dereference(pointer.value, resolved.value);
-                return false;
-            }
-            else {
-                // Resolve the reference
-                pointer.$ref = resolved.$ref;
-                pointer.path = resolved.path;
-                pointer.value = resolved.value;
-            }
-            return true;
-        }
-    }
-    return undefined;
-}
-exports.default = Pointer;
-/**
- * Sets the specified token value of the {@link Pointer#value}.
- *
- * The token is evaluated according to RFC 6901.
- * {@link https://tools.ietf.org/html/rfc6901#section-4}
- *
- * @param pointer - The JSON Pointer whose value will be modified
- * @param token - A JSON Pointer token that indicates how to modify `obj`
- * @param value - The value to assign
- * @returns - Returns the assigned value
- */
-function setValue(pointer, token, value) {
-    if (pointer.value && typeof pointer.value === "object") {
-        if (token === "-" && Array.isArray(pointer.value)) {
-            pointer.value.push(value);
-        }
-        else {
-            pointer.value[token] = value;
-        }
-    }
-    else {
-        throw new errors_js_1.JSONParserError(`Error assigning $ref pointer "${pointer.path}". \nCannot set "${token}" of a non-object.`);
-    }
-    return value;
-}
-function unwrapOrThrow(value) {
-    if ((0, errors_js_1.isHandledError)(value)) {
-        throw value;
-    }
-    return value;
-}
-function isRootPath(pathFromRoot) {
-    return typeof pathFromRoot == "string" && Pointer.parse(pathFromRoot).length == 0;
-}