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

package/dist/lib/ref.d.ts

@@ -1,180 +0,0 @@
-import Pointer from "./pointer.js";
-import type { JSONParserError, MissingPointerError, ParserError, ResolverError } from "./util/errors.js";
-import type $Refs from "./refs.js";
-import type { ParserOptions } from "./options.js";
-import type { JSONSchema } from "./types";
-export type $RefError = JSONParserError | ResolverError | ParserError | MissingPointerError;
-/**
- * This class represents a single JSON reference and its resolved value.
- *
- * @class
- */
-declare class $Ref<S extends object = JSONSchema> {
-    /**
-     * The file path or URL of the referenced file.
-     * This path is relative to the path of the main JSON schema file.
-     *
-     * This path does NOT contain document fragments (JSON pointers). It always references an ENTIRE file.
-     * Use methods such as {@link $Ref#get}, {@link $Ref#resolve}, and {@link $Ref#exists} to get
-     * specific JSON pointers within the file.
-     *
-     * @type {string}
-     */
-    path: undefined | string;
-    /**
-     * The resolved value of the JSON reference.
-     * Can be any JSON type, not just objects. Unknown file types are represented as Buffers (byte arrays).
-     *
-     * @type {?*}
-     */
-    value: any;
-    /**
-     * The {@link $Refs} object that contains this {@link $Ref} object.
-     *
-     * @type {$Refs}
-     */
-    $refs: $Refs<S>;
-    /**
-     * Indicates the type of {@link $Ref#path} (e.g. "file", "http", etc.)
-     */
-    pathType: string | unknown;
-    /**
-     * List of all errors. Undefined if no errors.
-     */
-    errors: Array<$RefError>;
-    constructor($refs: $Refs<S>);
-    /**
-     * Pushes an error to errors array.
-     *
-     * @param err - The error to be pushed
-     * @returns
-     */
-    addError(err: $RefError): void;
-    /**
-     * Determines whether the given JSON reference exists within this {@link $Ref#value}.
-     *
-     * @param path - The full path being resolved, optionally with a JSON pointer in the hash
-     * @param options
-     * @returns
-     */
-    exists(path: string, options?: ParserOptions): boolean;
-    /**
-     * Resolves the given JSON reference within this {@link $Ref#value} and returns the resolved value.
-     *
-     * @param path - The full path being resolved, optionally with a JSON pointer in the hash
-     * @param options
-     * @returns - Returns the resolved value
-     */
-    get(path: string, options?: ParserOptions): any;
-    /**
-     * Resolves the given JSON reference within this {@link $Ref#value}.
-     *
-     * @param path - The full path being resolved, optionally with a JSON pointer in the hash
-     * @param options
-     * @param friendlyPath - The original user-specified path (used for error messages)
-     * @param pathFromRoot - The path of `obj` from the schema root
-     * @returns
-     */
-    resolve(path: string, options?: ParserOptions, friendlyPath?: string, pathFromRoot?: string): Pointer<S>;
-    /**
-     * Sets the value of a nested property within this {@link $Ref#value}.
-     * If the property, or any of its parents don't exist, they will be created.
-     *
-     * @param path - The full path of the property to set, optionally with a JSON pointer in the hash
-     * @param value - The value to assign
-     */
-    set(path: string, value: any): void;
-    /**
-     * Determines whether the given value is a JSON reference.
-     *
-     * @param value - The value to inspect
-     * @returns
-     */
-    static is$Ref(value: unknown): value is {
-        $ref: string;
-        length?: number;
-    };
-    /**
-     * Determines whether the given value is an external JSON reference.
-     *
-     * @param value - The value to inspect
-     * @returns
-     */
-    static isExternal$Ref(value: unknown): boolean;
-    /**
-     * Determines whether the given value is a JSON reference, and whether it is allowed by the options.
-     *
-     * @param value - The value to inspect
-     * @param options
-     * @returns
-     */
-    static isAllowed$Ref(value: unknown): true | undefined;
-    /**
-     * Determines whether the given value is a JSON reference that "extends" its resolved value.
-     * That is, it has extra properties (in addition to "$ref"), so rather than simply pointing to
-     * an existing value, this $ref actually creates a NEW value that is a shallow copy of the resolved
-     * value, plus the extra properties.
-     *
-     * @example: {
-       person: {
-         properties: {
-           firstName: { type: string }
-           lastName: { type: string }
-         }
-       }
-       employee: {
-         properties: {
-           $ref: #/person/properties
-           salary: { type: number }
-         }
-       }
-     }
-     *  In this example, "employee" is an extended $ref, since it extends "person" with an additional
-     *  property (salary).  The result is a NEW value that looks like this:
-     *
-     *  {
-     *    properties: {
-     *      firstName: { type: string }
-     *      lastName: { type: string }
-     *      salary: { type: number }
-     *    }
-     *  }
-     *
-     * @param value - The value to inspect
-     * @returns
-     */
-    static isExtended$Ref(value: unknown): boolean;
-    /**
-     * Returns the resolved value of a JSON Reference.
-     * If necessary, the resolved value is merged with the JSON Reference to create a new object
-     *
-     * @example: {
-    person: {
-      properties: {
-        firstName: { type: string }
-        lastName: { type: string }
-      }
-    }
-    employee: {
-      properties: {
-        $ref: #/person/properties
-        salary: { type: number }
-      }
-    }
-    } When "person" and "employee" are merged, you end up with the following object:
-     *
-     *  {
-     *    properties: {
-     *      firstName: { type: string }
-     *      lastName: { type: string }
-     *      salary: { type: number }
-     *    }
-     *  }
-     *
-     * @param $ref - The JSON reference object (the one with the "$ref" property)
-     * @param resolvedValue - The resolved value, which can be any type
-     * @returns - Returns the dereferenced value
-     */
-    static dereference<S extends object = JSONSchema>($ref: $Ref<S>, resolvedValue: S): S;
-}
-export default $Ref;

package/dist/lib/ref.js

@@ -1,226 +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 pointer_js_1 = __importDefault(require("./pointer.js"));
-const errors_js_1 = require("./util/errors.js");
-/**
- * This class represents a single JSON reference and its resolved value.
- *
- * @class
- */
-class $Ref {
-    constructor($refs) {
-        /**
-         * List of all errors. Undefined if no errors.
-         */
-        this.errors = [];
-        this.$refs = $refs;
-    }
-    /**
-     * Pushes an error to errors array.
-     *
-     * @param err - The error to be pushed
-     * @returns
-     */
-    addError(err) {
-        if (this.errors === undefined) {
-            this.errors = [];
-        }
-        const existingErrors = this.errors.map(({ footprint }) => footprint);
-        // the path has been almost certainly set at this point,
-        // but just in case something went wrong, normalizeError injects path if necessary
-        // moreover, certain errors might point at the same spot, so filter them out to reduce noise
-        if ("errors" in err && Array.isArray(err.errors)) {
-            this.errors.push(...err.errors.map(errors_js_1.normalizeError).filter(({ footprint }) => !existingErrors.includes(footprint)));
-        }
-        else if (!("footprint" in err) || !existingErrors.includes(err.footprint)) {
-            this.errors.push((0, errors_js_1.normalizeError)(err));
-        }
-    }
-    /**
-     * Determines whether the given JSON reference exists within this {@link $Ref#value}.
-     *
-     * @param path - The full path being resolved, optionally with a JSON pointer in the hash
-     * @param options
-     * @returns
-     */
-    exists(path, options) {
-        try {
-            this.resolve(path, options);
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-    /**
-     * Resolves the given JSON reference within this {@link $Ref#value} and returns the resolved value.
-     *
-     * @param path - The full path being resolved, optionally with a JSON pointer in the hash
-     * @param options
-     * @returns - Returns the resolved value
-     */
-    get(path, options) {
-        return this.resolve(path, options)?.value;
-    }
-    /**
-     * Resolves the given JSON reference within this {@link $Ref#value}.
-     *
-     * @param path - The full path being resolved, optionally with a JSON pointer in the hash
-     * @param options
-     * @param friendlyPath - The original user-specified path (used for error messages)
-     * @param pathFromRoot - The path of `obj` from the schema root
-     * @returns
-     */
-    resolve(path, options, friendlyPath, pathFromRoot) {
-        const pointer = new pointer_js_1.default(this, path, friendlyPath);
-        return pointer.resolve(this.value, options, pathFromRoot);
-    }
-    /**
-     * Sets the value of a nested property within this {@link $Ref#value}.
-     * If the property, or any of its parents don't exist, they will be created.
-     *
-     * @param path - The full path of the property to set, optionally with a JSON pointer in the hash
-     * @param value - The value to assign
-     */
-    set(path, value) {
-        const pointer = new pointer_js_1.default(this, path);
-        this.value = pointer.set(this.value, value);
-    }
-    /**
-     * Determines whether the given value is a JSON reference.
-     *
-     * @param value - The value to inspect
-     * @returns
-     */
-    static is$Ref(value) {
-        return (Boolean(value) &&
-            typeof value === "object" &&
-            value !== null &&
-            "$ref" in value &&
-            typeof value.$ref === "string" &&
-            value.$ref.length > 0);
-    }
-    /**
-     * Determines whether the given value is an external JSON reference.
-     *
-     * @param value - The value to inspect
-     * @returns
-     */
-    static isExternal$Ref(value) {
-        return $Ref.is$Ref(value) && value.$ref[0] !== "#";
-    }
-    /**
-     * Determines whether the given value is a JSON reference, and whether it is allowed by the options.
-     *
-     * @param value - The value to inspect
-     * @param options
-     * @returns
-     */
-    static isAllowed$Ref(value) {
-        if (this.is$Ref(value)) {
-            if (value.$ref.substring(0, 2) === "#/" || value.$ref === "#") {
-                // It's a JSON Pointer reference, which is always allowed
-                return true;
-            }
-            else if (value.$ref[0] !== "#") {
-                // It's an external reference, which is allowed by the options
-                return true;
-            }
-        }
-        return undefined;
-    }
-    /**
-     * Determines whether the given value is a JSON reference that "extends" its resolved value.
-     * That is, it has extra properties (in addition to "$ref"), so rather than simply pointing to
-     * an existing value, this $ref actually creates a NEW value that is a shallow copy of the resolved
-     * value, plus the extra properties.
-     *
-     * @example: {
-       person: {
-         properties: {
-           firstName: { type: string }
-           lastName: { type: string }
-         }
-       }
-       employee: {
-         properties: {
-           $ref: #/person/properties
-           salary: { type: number }
-         }
-       }
-     }
-     *  In this example, "employee" is an extended $ref, since it extends "person" with an additional
-     *  property (salary).  The result is a NEW value that looks like this:
-     *
-     *  {
-     *    properties: {
-     *      firstName: { type: string }
-     *      lastName: { type: string }
-     *      salary: { type: number }
-     *    }
-     *  }
-     *
-     * @param value - The value to inspect
-     * @returns
-     */
-    static isExtended$Ref(value) {
-        return $Ref.is$Ref(value) && Object.keys(value).length > 1;
-    }
-    /**
-     * Returns the resolved value of a JSON Reference.
-     * If necessary, the resolved value is merged with the JSON Reference to create a new object
-     *
-     * @example: {
-    person: {
-      properties: {
-        firstName: { type: string }
-        lastName: { type: string }
-      }
-    }
-    employee: {
-      properties: {
-        $ref: #/person/properties
-        salary: { type: number }
-      }
-    }
-    } When "person" and "employee" are merged, you end up with the following object:
-     *
-     *  {
-     *    properties: {
-     *      firstName: { type: string }
-     *      lastName: { type: string }
-     *      salary: { type: number }
-     *    }
-     *  }
-     *
-     * @param $ref - The JSON reference object (the one with the "$ref" property)
-     * @param resolvedValue - The resolved value, which can be any type
-     * @returns - Returns the dereferenced value
-     */
-    static dereference($ref, resolvedValue) {
-        if (resolvedValue && typeof resolvedValue === "object" && $Ref.isExtended$Ref($ref)) {
-            const merged = {};
-            for (const key of Object.keys($ref)) {
-                if (key !== "$ref") {
-                    // @ts-expect-error TS(7053): Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
-                    merged[key] = $ref[key];
-                }
-            }
-            for (const key of Object.keys(resolvedValue)) {
-                if (!(key in merged)) {
-                    // @ts-expect-error TS(7053): Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
-                    merged[key] = resolvedValue[key];
-                }
-            }
-            return merged;
-        }
-        else {
-            // Completely replace the original reference with the resolved value
-            return resolvedValue;
-        }
-    }
-}
-exports.default = $Ref;

package/dist/lib/refs.d.ts

@@ -1,127 +0,0 @@
-import $Ref from "./ref.js";
-import type { JSONSchema4Type, JSONSchema6Type, JSONSchema7Type } from "json-schema";
-import type { ParserOptions } from "./options.js";
-import type { JSONSchema } from "./types";
-interface $RefsMap<S extends object = JSONSchema> {
-    [url: string]: $Ref<S>;
-}
-/**
- * When you call the resolve method, the value that gets passed to the callback function (or Promise) is a $Refs object. This same object is accessible via the parser.$refs property of $RefParser objects.
- *
- * This object is a map of JSON References and their resolved values. It also has several convenient helper methods that make it easy for you to navigate and manipulate the JSON References.
- *
- * See https://apitools.dev/json-schema-ref-parser/docs/refs.html
- */
-export default class $Refs<S extends object = JSONSchema> {
-    /**
-     * This property is true if the schema contains any circular references. You may want to check this property before serializing the dereferenced schema as JSON, since JSON.stringify() does not support circular references by default.
-     *
-     * See https://apitools.dev/json-schema-ref-parser/docs/refs.html#circular
-     */
-    circular: boolean;
-    /**
-     * Returns the paths/URLs of all the files in your schema (including the main schema file).
-     *
-     * See https://apitools.dev/json-schema-ref-parser/docs/refs.html#pathstypes
-     *
-     * @param types (optional) Optionally only return certain types of paths ("file", "http", etc.)
-     */
-    paths(...types: (string | string[])[]): string[];
-    /**
-     * Returns a map of paths/URLs and their correspond values.
-     *
-     * See https://apitools.dev/json-schema-ref-parser/docs/refs.html#valuestypes
-     *
-     * @param types (optional) Optionally only return values from certain locations ("file", "http", etc.)
-     */
-    values(...types: (string | string[])[]): S;
-    /**
-     * Returns `true` if the given path exists in the schema; otherwise, returns `false`
-     *
-     * See https://apitools.dev/json-schema-ref-parser/docs/refs.html#existsref
-     *
-     * @param $ref The JSON Reference path, optionally with a JSON Pointer in the hash
-     */
-    /**
-     * Determines whether the given JSON reference exists.
-     *
-     * @param path - The path being resolved, optionally with a JSON pointer in the hash
-     * @param [options]
-     * @returns
-     */
-    exists(path: string, options: any): boolean;
-    /**
-     * Resolves the given JSON reference and returns the resolved value.
-     *
-     * @param path - The path being resolved, with a JSON pointer in the hash
-     * @param [options]
-     * @returns - Returns the resolved value
-     */
-    get(path: string, options?: ParserOptions): JSONSchema4Type | JSONSchema6Type | JSONSchema7Type;
-    /**
-     * Sets the value at the given path in the schema. If the property, or any of its parents, don't exist, they will be created.
-     *
-     * @param path The JSON Reference path, optionally with a JSON Pointer in the hash
-     * @param value The value to assign. Can be anything (object, string, number, etc.)
-     */
-    set(path: string, value: JSONSchema4Type | JSONSchema6Type | JSONSchema7Type): void;
-    /**
-     * Returns the specified {@link $Ref} object, or undefined.
-     *
-     * @param path - The path being resolved, optionally with a JSON pointer in the hash
-     * @returns
-     * @protected
-     */
-    _get$Ref(path: string): $Ref<S>;
-    /**
-     * Creates a new {@link $Ref} object and adds it to this {@link $Refs} object.
-     *
-     * @param path  - The file path or URL of the referenced file
-     */
-    _add(path: string): $Ref<S>;
-    /**
-     * Resolves the given JSON reference.
-     *
-     * @param path - The path being resolved, optionally with a JSON pointer in the hash
-     * @param pathFromRoot - The path of `obj` from the schema root
-     * @param [options]
-     * @returns
-     * @protected
-     */
-    _resolve(path: string, pathFromRoot: string, options?: ParserOptions): import("./pointer.js").default<S>;
-    /**
-     * A map of paths/urls to {@link $Ref} objects
-     *
-     * @type {object}
-     * @protected
-     */
-    _$refs: $RefsMap<S>;
-    /**
-     * The {@link $Ref} object that is the root of the JSON schema.
-     *
-     * @type {$Ref}
-     * @protected
-     */
-    _root$Ref: $Ref<S>;
-    constructor();
-    /**
-     * Returns the paths of all the files/URLs that are referenced by the JSON schema,
-     * including the schema itself.
-     *
-     * @param [types] - Only return paths of the given types ("file", "http", etc.)
-     * @returns
-     */
-    /**
-     * Returns the map of JSON references and their resolved values.
-     *
-     * @param [types] - Only return references of the given types ("file", "http", etc.)
-     * @returns
-     */
-    /**
-     * Returns a POJO (plain old JavaScript object) for serialization as JSON.
-     *
-     * @returns {object}
-     */
-    toJSON: (...types: (string | string[])[]) => S;
-}
-export {};