@apidevtools/json-schema-ref-parser 11.7.2 → 11.8.2

package/cjs/refs.js

@@ -0,0 +1,214 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, /**
+ * This class is a map of JSON references and their resolved values.
+ */ "default", {
+    enumerable: true,
+    get: function() {
+        return $Refs;
+    }
+});
+var _ono = require("@jsdevtools/ono");
+var _refJs = /*#__PURE__*/ _interopRequireDefault(require("./ref.js"));
+var _urlJs = /*#__PURE__*/ _interopRequireWildcard(require("./util/url.js"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interopRequireWildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {};
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+var isWindows = /^win/.test(globalThis.process ? globalThis.process.platform : undefined);
+var getPathFromOs = function(filePath) {
+    return isWindows ? filePath.replace(/\\/g, "/") : filePath;
+};
+function $Refs() {
+    /**
+   * Indicates whether the schema contains any circular references.
+   *
+   * @type {boolean}
+   */ this.circular = false;
+    /**
+   * A map of paths/urls to {@link $Ref} objects
+   *
+   * @type {object}
+   * @protected
+   */ this._$refs = {};
+    /**
+   * The {@link $Ref} object that is the root of the JSON schema.
+   *
+   * @type {$Ref}
+   * @protected
+   */ this._root$Ref = null;
+}
+/**
+ * Returns the paths of all the files/URLs that are referenced by the JSON schema,
+ * including the schema itself.
+ *
+ * @param {...string|string[]} [types] - Only return paths of the given types ("file", "http", etc.)
+ * @returns {string[]}
+ */ $Refs.prototype.paths = function(types) {
+    var paths = getPaths(this._$refs, arguments);
+    return paths.map(function(path) {
+        return getPathFromOs(path.decoded);
+    });
+};
+/**
+ * Returns the map of JSON references and their resolved values.
+ *
+ * @param {...string|string[]} [types] - Only return references of the given types ("file", "http", etc.)
+ * @returns {object}
+ */ $Refs.prototype.values = function(types) {
+    var $refs = this._$refs;
+    var paths = getPaths($refs, arguments);
+    return paths.reduce(function(obj, path) {
+        obj[getPathFromOs(path.decoded)] = $refs[path.encoded].value;
+        return obj;
+    }, {});
+};
+/**
+ * Returns a POJO (plain old JavaScript object) for serialization as JSON.
+ *
+ * @returns {object}
+ */ $Refs.prototype.toJSON = $Refs.prototype.values;
+/**
+ * Determines whether the given JSON reference exists.
+ *
+ * @param {string} path - The path being resolved, optionally with a JSON pointer in the hash
+ * @param {$RefParserOptions} [options]
+ * @returns {boolean}
+ */ $Refs.prototype.exists = function(path, options) {
+    try {
+        this._resolve(path, "", options);
+        return true;
+    } catch (e) {
+        return false;
+    }
+};
+/**
+ * Resolves the given JSON reference and returns the resolved value.
+ *
+ * @param {string} path - The path being resolved, with a JSON pointer in the hash
+ * @param {$RefParserOptions} [options]
+ * @returns {*} - Returns the resolved value
+ */ $Refs.prototype.get = function(path, options) {
+    return this._resolve(path, "", options).value;
+};
+/**
+ * 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 {string} path - The path of the property to set, optionally with a JSON pointer in the hash
+ * @param {*} value - The value to assign
+ */ $Refs.prototype.set = function(path, value) {
+    var absPath = _urlJs.resolve(this._root$Ref.path, path);
+    var withoutHash = _urlJs.stripHash(absPath);
+    var $ref = this._$refs[withoutHash];
+    if (!$ref) {
+        throw (0, _ono.ono)('Error resolving $ref pointer "'.concat(path, '". \n"').concat(withoutHash, '" not found.'));
+    }
+    $ref.set(absPath, value);
+};
+/**
+ * Creates a new {@link $Ref} object and adds it to this {@link $Refs} object.
+ *
+ * @param {string} path  - The file path or URL of the referenced file
+ */ $Refs.prototype._add = function(path) {
+    var withoutHash = _urlJs.stripHash(path);
+    var $ref = new _refJs.default();
+    $ref.path = withoutHash;
+    $ref.$refs = this;
+    this._$refs[withoutHash] = $ref;
+    this._root$Ref = this._root$Ref || $ref;
+    return $ref;
+};
+/**
+ * Resolves the given JSON reference.
+ *
+ * @param {string} path - The path being resolved, optionally with a JSON pointer in the hash
+ * @param {string} pathFromRoot - The path of `obj` from the schema root
+ * @param {$RefParserOptions} [options]
+ * @returns {Pointer}
+ * @protected
+ */ $Refs.prototype._resolve = function(path, pathFromRoot, options) {
+    var absPath = _urlJs.resolve(this._root$Ref.path, path);
+    var withoutHash = _urlJs.stripHash(absPath);
+    var $ref = this._$refs[withoutHash];
+    if (!$ref) {
+        throw (0, _ono.ono)('Error resolving $ref pointer "'.concat(path, '". \n"').concat(withoutHash, '" not found.'));
+    }
+    return $ref.resolve(absPath, options, path, pathFromRoot);
+};
+/**
+ * Returns the specified {@link $Ref} object, or undefined.
+ *
+ * @param {string} path - The path being resolved, optionally with a JSON pointer in the hash
+ * @returns {$Ref|undefined}
+ * @protected
+ */ $Refs.prototype._get$Ref = function(path) {
+    path = _urlJs.resolve(this._root$Ref.path, path);
+    var withoutHash = _urlJs.stripHash(path);
+    return this._$refs[withoutHash];
+};
+/**
+ * Returns the encoded and decoded paths keys of the given object.
+ *
+ * @param {object} $refs - The object whose keys are URL-encoded paths
+ * @param {...string|string[]} [types] - Only return paths of the given types ("file", "http", etc.)
+ * @returns {object[]}
+ */ function getPaths($refs, types) {
+    var paths = Object.keys($refs);
+    // Filter the paths by type
+    types = Array.isArray(types[0]) ? types[0] : Array.prototype.slice.call(types);
+    if (types.length > 0 && types[0]) {
+        paths = paths.filter(function(key) {
+            return types.indexOf($refs[key].pathType) !== -1;
+        });
+    }
+    // Decode local filesystem paths
+    return paths.map(function(path) {
+        return {
+            encoded: path,
+            decoded: $refs[path].pathType === "file" ? _urlJs.toFileSystemPath(path, true) : path
+        };
+    });
+}

package/cjs/resolve-external.js

@@ -0,0 +1,333 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+var _refJs = /*#__PURE__*/ _interopRequireDefault(require("./ref.js"));
+var _pointerJs = /*#__PURE__*/ _interopRequireDefault(require("./pointer.js"));
+var _parseJs = /*#__PURE__*/ _interopRequireDefault(require("./parse.js"));
+var _urlJs = /*#__PURE__*/ _interopRequireWildcard(require("./util/url.js"));
+var _errorsJs = require("./util/errors.js");
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _asyncToGenerator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interopRequireWildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {};
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+var __generator = (void 0) && (void 0).__generator || function(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+};
+var _default = resolveExternal;
+/**
+ * Crawls the JSON schema, finds all external JSON references, and resolves their values.
+ * This method does not mutate the JSON schema. The resolved values are added to {@link $RefParser#$refs}.
+ *
+ * NOTE: We only care about EXTERNAL references here. INTERNAL references are only relevant when dereferencing.
+ *
+ * @param {$RefParser} parser
+ * @param {$RefParserOptions} options
+ *
+ * @returns {Promise}
+ * The promise resolves once all JSON references in the schema have been resolved,
+ * including nested references that are contained in externally-referenced files.
+ */ function resolveExternal(parser, options) {
+    if (!options.resolve.external) {
+        // Nothing to resolve, so exit early
+        return Promise.resolve();
+    }
+    try {
+        // console.log('Resolving $ref pointers in %s', parser.$refs._root$Ref.path);
+        var promises = crawl(parser.schema, parser.$refs._root$Ref.path + "#", parser.$refs, options);
+        return Promise.all(promises);
+    } catch (e) {
+        return Promise.reject(e);
+    }
+}
+/**
+ * Recursively crawls the given value, and resolves any external JSON references.
+ *
+ * @param {*} obj - The value to crawl. If it's not an object or array, it will be ignored.
+ * @param {string} path - The full path of `obj`, possibly with a JSON Pointer in the hash
+ * @param {$Refs} $refs
+ * @param {$RefParserOptions} options
+ * @param {Set} seen - Internal.
+ *
+ * @returns {Promise[]}
+ * Returns an array of promises. There will be one promise for each JSON reference in `obj`.
+ * If `obj` does not contain any JSON references, then the array will be empty.
+ * If any of the JSON references point to files that contain additional JSON references,
+ * then the corresponding promise will internally reference an array of promises.
+ */ function crawl(obj, path, $refs, options, seen) {
+    seen = seen || new Set();
+    var promises = [];
+    if (obj && typeof obj === "object" && !ArrayBuffer.isView(obj) && !seen.has(obj)) {
+        seen.add(obj); // Track previously seen objects to avoid infinite recursion
+        if (_refJs.default.isExternal$Ref(obj)) {
+            promises.push(resolve$Ref(obj, path, $refs, options));
+        } else {
+            var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+            try {
+                for(var _iterator = Object.keys(obj)[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+                    var key = _step.value;
+                    var keyPath = _pointerJs.default.join(path, key);
+                    var value = obj[key];
+                    if (_refJs.default.isExternal$Ref(value)) {
+                        promises.push(resolve$Ref(value, keyPath, $refs, options));
+                    } else {
+                        promises = promises.concat(crawl(value, keyPath, $refs, options, seen));
+                    }
+                }
+            } catch (err) {
+                _didIteratorError = true;
+                _iteratorError = err;
+            } finally{
+                try {
+                    if (!_iteratorNormalCompletion && _iterator.return != null) {
+                        _iterator.return();
+                    }
+                } finally{
+                    if (_didIteratorError) {
+                        throw _iteratorError;
+                    }
+                }
+            }
+        }
+    }
+    return promises;
+}
+function resolve$Ref($ref, path, $refs, options) {
+    return _resolve$Ref.apply(this, arguments);
+}
+function _resolve$Ref() {
+    _resolve$Ref = /**
+ * Resolves the given JSON Reference, and then crawls the resulting value.
+ *
+ * @param {{$ref: string}} $ref - The JSON Reference to resolve
+ * @param {string} path - The full path of `$ref`, possibly with a JSON Pointer in the hash
+ * @param {$Refs} $refs
+ * @param {$RefParserOptions} options
+ *
+ * @returns {Promise}
+ * The promise resolves once all JSON references in the object have been resolved,
+ * including nested references that are contained in externally-referenced files.
+ */ _asyncToGenerator(function($ref, path, $refs, options) {
+        var resolvedPath, withoutHash, result, promises, err;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    resolvedPath = _urlJs.resolve(path, $ref.$ref);
+                    withoutHash = _urlJs.stripHash(resolvedPath);
+                    // Do we already have this $ref?
+                    $ref = $refs._$refs[withoutHash];
+                    if ($ref) {
+                        // We've already parsed this $ref, so use the existing value
+                        return [
+                            2,
+                            Promise.resolve($ref.value)
+                        ];
+                    }
+                    _state.label = 1;
+                case 1:
+                    _state.trys.push([
+                        1,
+                        3,
+                        ,
+                        4
+                    ]);
+                    return [
+                        4,
+                        (0, _parseJs.default)(resolvedPath, $refs, options)
+                    ];
+                case 2:
+                    result = _state.sent();
+                    promises = crawl(result, withoutHash + "#", $refs, options);
+                    return [
+                        2,
+                        Promise.all(promises)
+                    ];
+                case 3:
+                    err = _state.sent();
+                    if (!options.continueOnError || !(0, _errorsJs.isHandledError)(err)) {
+                        throw err;
+                    }
+                    if ($refs._$refs[withoutHash]) {
+                        err.source = decodeURI(_urlJs.stripHash(path));
+                        err.path = _urlJs.safePointerToPath(_urlJs.getHash(path));
+                    }
+                    return [
+                        2,
+                        []
+                    ];
+                case 4:
+                    return [
+                        2
+                    ];
+            }
+        });
+    });
+    return _resolve$Ref.apply(this, arguments);
+}

package/cjs/resolvers/file.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+var _fs = /*#__PURE__*/ _interopRequireDefault(require("fs"));
+var _ono = require("@jsdevtools/ono");
+var _urlJs = /*#__PURE__*/ _interopRequireWildcard(require("../util/url.js"));
+var _errorsJs = require("../util/errors.js");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interopRequireWildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {};
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+var _default = {
+    /**
+   * The order that this resolver will run, in relation to other resolvers.
+   *
+   * @type {number}
+   */ order: 100,
+    /**
+   * Determines whether this resolver can read a given file reference.
+   * Resolvers that return true will be tried, in order, until one successfully resolves the file.
+   * Resolvers that return false will not be given a chance to resolve the file.
+   *
+   * @param {object} file           - An object containing information about the referenced file
+   * @param {string} file.url       - The full URL of the referenced file
+   * @param {string} file.extension - The lowercased file extension (e.g. ".txt", ".html", etc.)
+   * @returns {boolean}
+   */ canRead: function canRead(file) {
+        return _urlJs.isFileSystemPath(file.url);
+    },
+    /**
+   * Reads the given file and returns its raw contents as a Buffer.
+   *
+   * @param {object} file           - An object containing information about the referenced file
+   * @param {string} file.url       - The full URL of the referenced file
+   * @param {string} file.extension - The lowercased file extension (e.g. ".txt", ".html", etc.)
+   * @returns {Promise<Buffer>}
+   */ read: function read(file) {
+        return new Promise(function(resolve, reject) {
+            var path;
+            try {
+                path = _urlJs.toFileSystemPath(file.url);
+            } catch (err) {
+                reject(new _errorsJs.ResolverError(_ono.ono.uri(err, "Malformed URI: ".concat(file.url)), file.url));
+            }
+            // console.log('Opening file: %s', path);
+            try {
+                _fs.default.readFile(path, function(err, data) {
+                    if (err) {
+                        reject(new _errorsJs.ResolverError((0, _ono.ono)(err, 'Error opening file "'.concat(path, '"')), path));
+                    } else {
+                        resolve(data);
+                    }
+                });
+            } catch (err1) {
+                reject(new _errorsJs.ResolverError((0, _ono.ono)(err1, 'Error opening file "'.concat(path, '"')), path));
+            }
+        });
+    }
+};