api 4.5.0 → 5.0.0-beta.1

package/dist/core/prepareParams.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+import type { Operation } from 'oas';
+/**
+ * With potentially supplied body and/or metadata we need to run through them against a given API
+ * operation to see what's what and prepare any available parameters to be used in an API request
+ * with `@readme/oas-to-har`.
+ *
+ * @param operation
+ * @param body
+ * @param metadata
+ */
+export default function prepareParams(operation: Operation, body?: unknown, metadata?: Record<string, unknown>): Promise<{
+    body?: any;
+    cookie?: Record<string, string | number | boolean>;
+    files?: Record<string, Buffer>;
+    formData?: any;
+    header?: Record<string, string | number | boolean>;
+    path?: Record<string, string | number | boolean>;
+    query?: Record<string, string | number | boolean>;
+    server?: {
+        selected: number;
+        variables: Record<string, string | number>;
+    };
+}>;

package/dist/core/prepareParams.js

@@ -0,0 +1,351 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var lodash_merge_1 = __importDefault(require("lodash.merge"));
+var promises_1 = __importDefault(require("fs/promises"));
+var path_1 = __importDefault(require("path"));
+var stream_1 = __importDefault(require("stream"));
+var get_stream_1 = __importDefault(require("get-stream"));
+var sync_1 = __importDefault(require("datauri/sync"));
+var parser_1 = __importDefault(require("datauri/parser"));
+var getJSONSchemaDefaults_1 = __importDefault(require("./getJSONSchemaDefaults"));
+/**
+ * Extract all available parameters from an operations Parameter Object into a digestable array
+ * that we can use to apply to the request.
+ *
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameterObject}
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameterObject}
+ * @param parameters
+ */
+function digestParameters(parameters) {
+    return parameters.reduce(function (prev, param) {
+        var _a;
+        if ('$ref' in param || 'allOf' in param || 'anyOf' in param || 'oneOf' in param) {
+            throw new Error("The OpenAPI document for this operation wasn't dereferenced before processing.");
+        }
+        else if (param.name in prev) {
+            throw new Error("The operation you are using has the same parameter, ".concat(param.name, ", spread across multiple entry points. We unfortunately can't handle this right now."));
+        }
+        return Object.assign(prev, (_a = {}, _a[param.name] = param, _a));
+    }, {});
+}
+// https://github.com/you-dont-need/You-Dont-Need-Lodash-Underscore#_isempty
+function isEmpty(obj) {
+    return [Object, Array].includes((obj || {}).constructor) && !Object.entries(obj || {}).length;
+}
+function isObject(thing) {
+    if (thing instanceof stream_1["default"].Readable) {
+        return false;
+    }
+    return typeof thing === 'object' && thing !== null && !Array.isArray(thing);
+}
+function isPrimitive(obj) {
+    return typeof obj === null || typeof obj === 'number' || typeof obj === 'string';
+}
+function merge(src, target) {
+    if (Array.isArray(target)) {
+        // @todo we need to add support for merging array defaults with array body/metadata arguments
+        return target;
+    }
+    else if (!isObject(target)) {
+        return target;
+    }
+    return (0, lodash_merge_1["default"])(src, target);
+}
+/**
+ * Ingest a file path or readable stream into a common object that we can later use to process it
+ * into a parameters object for making an API request.
+ *
+ * @param paramName
+ * @param file
+ */
+function processFile(paramName, file) {
+    if (typeof file === 'string') {
+        // In order to support relative pathed files, we need to attempt to resolve them.
+        var resolvedFile_1 = path_1["default"].resolve(file);
+        return promises_1["default"]
+            .stat(resolvedFile_1)
+            .then(function () { return (0, sync_1["default"])(resolvedFile_1); })
+            .then(function (fileMetadata) {
+            var payloadFilename = encodeURIComponent(path_1["default"].basename(resolvedFile_1));
+            return {
+                paramName: paramName,
+                base64: fileMetadata.content.replace(';base64', ";name=".concat(payloadFilename, ";base64")),
+                filename: payloadFilename,
+                buffer: fileMetadata.buffer
+            };
+        })["catch"](function (err) {
+            if (err.code === 'ENOENT') {
+                // It's less than ideal for us to handle files that don't exist like this but because
+                // `file` is a string it might actually be the full text contents of the file and not
+                // actually a path.
+                //
+                // We also can't really regex to see if `file` *looks*` like a path because one should be
+                // able to pass in a relative `owlbert.png` (instead of `./owlbert.png`) and though that
+                // doesn't *look* like a path, it is one that should still work.
+                return undefined;
+            }
+            throw err;
+        });
+    }
+    else if (file instanceof stream_1["default"].Readable) {
+        return get_stream_1["default"].buffer(file).then(function (buffer) {
+            var filePath = file.path;
+            var parser = new parser_1["default"]();
+            var base64 = parser.format(filePath, buffer).content;
+            var payloadFilename = encodeURIComponent(path_1["default"].basename(filePath));
+            return {
+                paramName: paramName,
+                base64: base64.replace(';base64', ";name=".concat(payloadFilename, ";base64")),
+                filename: payloadFilename,
+                buffer: buffer
+            };
+        });
+    }
+    return Promise.reject(new TypeError(paramName
+        ? "The data supplied for the `".concat(paramName, "` request body parameter is not a file handler that we support.")
+        : "The data supplied for the request body payload is not a file handler that we support."));
+}
+/**
+ * With potentially supplied body and/or metadata we need to run through them against a given API
+ * operation to see what's what and prepare any available parameters to be used in an API request
+ * with `@readme/oas-to-har`.
+ *
+ * @param operation
+ * @param body
+ * @param metadata
+ */
+function prepareParams(operation, body, metadata) {
+    var _a, _b, _c, _d;
+    return __awaiter(this, void 0, void 0, function () {
+        var metadataIntersected, digestedParameters, hasDigestedParams, jsonSchema, jsonSchemaDefaults, params, intersection, payloadJsonSchema, conversions_1;
+        return __generator(this, function (_e) {
+            switch (_e.label) {
+                case 0:
+                    metadataIntersected = false;
+                    digestedParameters = digestParameters(operation.getParameters());
+                    hasDigestedParams = !!Object.keys(digestedParameters).length;
+                    jsonSchema = operation.getParametersAsJsonSchema();
+                    if (!jsonSchema && (body !== undefined || metadata !== undefined)) {
+                        throw new Error("You supplied metadata and/or body data for this operation but it doesn't have any documented parameters or request payloads. If you think this is an error please contact support for the API you're using.");
+                    }
+                    jsonSchemaDefaults = jsonSchema ? (0, getJSONSchemaDefaults_1["default"])(jsonSchema) : {};
+                    params = jsonSchemaDefaults;
+                    // If a body argument was supplied we need to do a bit of work to see if it's actually a body
+                    // argument or metadata because the library lets you supply either a body, metadata, or body with
+                    // metadata.
+                    if (typeof body !== 'undefined') {
+                        if (Array.isArray(body) || isPrimitive(body)) {
+                            // If the body param is an array or a primitive then we know it's absolutely a body because
+                            // metadata can only ever be undefined or an object.
+                            params.body = merge(params.body, body);
+                        }
+                        else if (typeof metadata === 'undefined') {
+                            // No metadata was explicitly provided so we need to analyze the body to determine if it's a
+                            // body or should be actually be treated as metadata.
+                            if (!hasDigestedParams) {
+                                // If no parameters were able to be digested it's because this operation has none so then
+                                // we just have to assume that what the user supplied was for a body and not metadata. This
+                                // might lead to unwanted false positives if the API definition isn't accurate but short of
+                                // throwing an error (one that the user would have no control over resolving anyways) there
+                                // isn't anything we can do about it.
+                                params.body = merge(params.body, body);
+                            }
+                            else {
+                                intersection = Object.keys(body).filter(function (value) { return Object.keys(digestedParameters).includes(value); }).length;
+                                if (intersection && intersection / Object.keys(body).length > 0.25) {
+                                    /* eslint-disable no-param-reassign */
+                                    // If more than 25% of the body intersects with the parameters that we've got on hand,
+                                    // then we should treat it as a metadata object and organize into parameters.
+                                    metadataIntersected = true;
+                                    metadata = merge(params.body, body);
+                                    body = undefined;
+                                    /* eslint-enable no-param-reassign */
+                                }
+                                else {
+                                    // For all other cases, we should just treat the supplied body as a body.
+                                    params.body = merge(params.body, body);
+                                }
+                            }
+                        }
+                        else {
+                            // Body and metadata were both supplied.
+                            params.body = merge(params.body, body);
+                        }
+                    }
+                    if (!!operation.hasRequestBody()) return [3 /*break*/, 1];
+                    // If this operation doesn't have any documented request body then we shouldn't be sending
+                    // anything.
+                    delete params.body;
+                    return [3 /*break*/, 3];
+                case 1:
+                    if (!('body' in params))
+                        params.body = {};
+                    payloadJsonSchema = jsonSchema.find(function (js) { return js.type === 'body'; });
+                    if (!payloadJsonSchema) return [3 /*break*/, 3];
+                    if (!params.files)
+                        params.files = {};
+                    conversions_1 = [];
+                    // @todo add support for `type: array`, `oneOf` and `anyOf`
+                    if ((_a = payloadJsonSchema.schema) === null || _a === void 0 ? void 0 : _a.properties) {
+                        Object.entries((_b = payloadJsonSchema.schema) === null || _b === void 0 ? void 0 : _b.properties)
+                            .filter(function (_a) {
+                            var schema = _a[1];
+                            return (schema === null || schema === void 0 ? void 0 : schema.format) === 'binary';
+                        })
+                            .filter(function (_a) {
+                            var prop = _a[0];
+                            return Object.keys(params.body).includes(prop);
+                        })
+                            .forEach(function (_a) {
+                            var prop = _a[0];
+                            conversions_1.push(processFile(prop, params.body[prop]));
+                        });
+                    }
+                    else if (((_c = payloadJsonSchema.schema) === null || _c === void 0 ? void 0 : _c.type) === 'string') {
+                        if (((_d = payloadJsonSchema.schema) === null || _d === void 0 ? void 0 : _d.format) === 'binary') {
+                            conversions_1.push(processFile(undefined, params.body));
+                        }
+                    }
+                    return [4 /*yield*/, Promise.all(conversions_1)
+                            .then(function (fileMetadata) { return fileMetadata.filter(Boolean); })
+                            .then(function (fm) {
+                            fm.forEach(function (fileMetadata) {
+                                if (!fileMetadata) {
+                                    // If we don't have any metadata here it's because the file we have is likely
+                                    // the full string content of the file so since we don't have any filenames to
+                                    // work with we shouldn't do any additional handling to the `body` or `files`
+                                    // parameters.
+                                    return;
+                                }
+                                if (fileMetadata.paramName) {
+                                    params.body[fileMetadata.paramName] = fileMetadata.base64;
+                                }
+                                else {
+                                    params.body = fileMetadata.base64;
+                                }
+                                params.files[fileMetadata.filename] = fileMetadata.buffer;
+                            });
+                        })];
+                case 2:
+                    _e.sent();
+                    _e.label = 3;
+                case 3:
+                    // Form data should be placed within `formData` instead of `body` for it to properly get picked
+                    // up by `fetch-har`.
+                    if (operation.isFormUrlEncoded()) {
+                        params.formData = merge(params.formData, params.body);
+                        delete params.body;
+                    }
+                    // Only spend time trying to organize metadata into parameters if we were able to digest
+                    // parameters out of the operation schema. If we couldn't digest anything, but metadata was
+                    // supplied then we wouldn't know how to send it in the request!
+                    if (hasDigestedParams) {
+                        if (!('cookie' in params))
+                            params.cookie = {};
+                        if (!('header' in params))
+                            params.header = {};
+                        if (!('path' in params))
+                            params.path = {};
+                        if (!('query' in params))
+                            params.query = {};
+                        Object.entries(digestedParameters).forEach(function (_a) {
+                            var paramName = _a[0], param = _a[1];
+                            var value;
+                            if (typeof metadata === 'object' && !isEmpty(metadata) && paramName in metadata) {
+                                value = metadata[paramName];
+                            }
+                            if (value === undefined) {
+                                return;
+                            }
+                            /* eslint-disable no-param-reassign */
+                            switch (param["in"]) {
+                                case 'path':
+                                    params.path[paramName] = value;
+                                    delete metadata[paramName];
+                                    break;
+                                case 'query':
+                                    params.query[paramName] = value;
+                                    delete metadata[paramName];
+                                    break;
+                                case 'header':
+                                    params.header[paramName] = value;
+                                    delete metadata[paramName];
+                                    break;
+                                case 'cookie':
+                                    params.cookie[paramName] = value;
+                                    delete metadata[paramName];
+                                    break;
+                                default: // no-op
+                            }
+                            /* eslint-enable no-param-reassign */
+                            // Because a user might have sent just a metadata object, we want to make sure that we filter
+                            // out anything that they sent that is a parameter from also being sent as part of a form
+                            // data payload for `x-www-form-urlencoded` requests.
+                            if (metadataIntersected && operation.isFormUrlEncoded()) {
+                                if (paramName in params.formData) {
+                                    delete params.formData[paramName];
+                                }
+                            }
+                        });
+                        // If there's any leftover metadata that hasn't been moved into form data for this request we
+                        // need to move it or else it'll get tossed.
+                        if (!isEmpty(metadata)) {
+                            if (operation.isFormUrlEncoded()) {
+                                params.formData = merge(params.formData, metadata);
+                            }
+                            else {
+                                // Any other remaining unused metadata will be unused because we don't know where to place
+                                // it in the request.
+                            }
+                        }
+                    }
+                    ['body', 'cookie', 'files', 'formData', 'header', 'path', 'query'].forEach(function (type) {
+                        if (type in params && isEmpty(params[type])) {
+                            delete params[type];
+                        }
+                    });
+                    return [2 /*return*/, params];
+            }
+        });
+    });
+}
+exports["default"] = prepareParams;

package/dist/core/prepareServer.d.ts

@@ -0,0 +1,13 @@
+import type Oas from 'oas';
+/**
+ * With an SDK server config and an instance of OAS we should extract and prepare the server and
+ * any server variables to be supplied to `@readme/oas-to-har`.
+ *
+ * @param spec
+ * @param url
+ * @param variables
+ */
+export default function prepareServer(spec: Oas, url: string, variables?: Record<string, string | number>): false | {
+    selected: number;
+    variables: Record<string, string | number>;
+};

package/dist/core/prepareServer.js

@@ -0,0 +1,50 @@
+"use strict";
+exports.__esModule = true;
+function stripTrailingSlash(url) {
+    if (url[url.length - 1] === '/') {
+        return url.slice(0, -1);
+    }
+    return url;
+}
+/**
+ * With an SDK server config and an instance of OAS we should extract and prepare the server and
+ * any server variables to be supplied to `@readme/oas-to-har`.
+ *
+ * @param spec
+ * @param url
+ * @param variables
+ */
+function prepareServer(spec, url, variables) {
+    if (variables === void 0) { variables = {}; }
+    var serverIdx;
+    var sanitizedUrl = stripTrailingSlash(url);
+    (spec.api.servers || []).forEach(function (server, i) {
+        if (server.url === sanitizedUrl) {
+            serverIdx = i;
+        }
+    });
+    // If we were able to find the passed in server in the OAS servers, we should use that! If we
+    // couldn't and server variables were passed in we should try our best to handle that, otherwise
+    // we should ignore the passed in server and use whever the default from the OAS is.
+    if (serverIdx) {
+        return {
+            selected: serverIdx,
+            variables: variables
+        };
+    }
+    else if (Object.keys(variables).length) {
+        // @todo we should run `oas.replaceUrl(url)` and pass that unto `@readme/oas-to-har`
+    }
+    else {
+        var server = spec.splitVariables(url);
+        if (server) {
+            return {
+                selected: server.selected,
+                variables: server.variables
+            };
+        }
+        // @todo we should pass `url` directly into `@readme/oas-to-har` as the base URL
+    }
+    return false;
+}
+exports["default"] = prepareServer;

package/dist/fetcher.d.ts

@@ -0,0 +1,53 @@
+import type { OASDocument } from 'oas/@types/rmoas.types';
+import 'isomorphic-fetch';
+export default class Fetcher {
+    uri: string | OASDocument;
+    /**
+     * @example @petstore/v1.0#n6kvf10vakpemvplx
+     * @example @petstore#n6kvf10vakpemvplx
+     */
+    static registryUUIDRegex: RegExp;
+    constructor(uri: string | OASDocument);
+    static isAPIRegistryUUID(uri: string): boolean;
+    static getProjectPrefixFromRegistryUUID(uri: string): string;
+    load(): Promise<(Omit<Omit<import("openapi-types").OpenAPIV3.Document<{}>, "paths" | "components">, "paths" | "components" | "info" | "servers" | "webhooks" | "jsonSchemaDialect"> & {
+        info: import("openapi-types").OpenAPIV3_1.InfoObject;
+        jsonSchemaDialect?: string;
+        servers?: import("openapi-types").OpenAPIV3_1.ServerObject[];
+    } & Pick<{
+        paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
+        webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
+        components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
+    }, "paths"> & Omit<Partial<{
+        paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
+        webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
+        components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
+    }>, "paths"> & Record<string, unknown>) | (Omit<Omit<import("openapi-types").OpenAPIV3.Document<{}>, "paths" | "components">, "paths" | "components" | "info" | "servers" | "webhooks" | "jsonSchemaDialect"> & {
+        info: import("openapi-types").OpenAPIV3_1.InfoObject;
+        jsonSchemaDialect?: string;
+        servers?: import("openapi-types").OpenAPIV3_1.ServerObject[];
+    } & Pick<{
+        paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
+        webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
+        components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
+    }, "webhooks"> & Omit<Partial<{
+        paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
+        webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
+        components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
+    }>, "webhooks"> & Record<string, unknown>) | (Omit<Omit<import("openapi-types").OpenAPIV3.Document<{}>, "paths" | "components">, "paths" | "components" | "info" | "servers" | "webhooks" | "jsonSchemaDialect"> & {
+        info: import("openapi-types").OpenAPIV3_1.InfoObject;
+        jsonSchemaDialect?: string;
+        servers?: import("openapi-types").OpenAPIV3_1.ServerObject[];
+    } & Pick<{
+        paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
+        webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
+        components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
+    }, "components"> & Omit<Partial<{
+        paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
+        webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
+        components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
+    }>, "components"> & Record<string, unknown>) | (import("openapi-types").OpenAPIV3.Document<{}> & Record<string, unknown>)>;
+    static getURL(url: string): Promise<any>;
+    static getFile(uri: string): Promise<any>;
+    static validate(json: any): Promise<import("openapi-types").OpenAPI.Document<{}>>;
+}

package/dist/fetcher.js

@@ -0,0 +1,149 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+require("isomorphic-fetch");
+var openapi_parser_1 = __importDefault(require("@readme/openapi-parser"));
+var js_yaml_1 = __importDefault(require("js-yaml"));
+var fs_1 = __importDefault(require("fs"));
+var path_1 = __importDefault(require("path"));
+var Fetcher = /** @class */ (function () {
+    function Fetcher(uri) {
+        if (typeof uri === 'string') {
+            // Resolve OpenAPI definition shorthand accessors from within the ReadMe API Registry.
+            this.uri = Fetcher.isAPIRegistryUUID(uri)
+                ? uri.replace(Fetcher.registryUUIDRegex, 'https://dash.readme.com/api/v1/api-registry/$4')
+                : uri;
+        }
+        else {
+            this.uri = uri;
+        }
+    }
+    Fetcher.isAPIRegistryUUID = function (uri) {
+        return Fetcher.registryUUIDRegex.test(uri);
+    };
+    Fetcher.getProjectPrefixFromRegistryUUID = function (uri) {
+        var matches = uri.match(Fetcher.registryUUIDRegex);
+        if (!matches) {
+            return undefined;
+        }
+        return matches.groups.project;
+    };
+    Fetcher.prototype.load = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                if (typeof this.uri !== 'string') {
+                    throw new TypeError("Something disastrous occurred and a non-string URI was supplied to the Fetcher library. This shouldn't have happened!");
+                }
+                return [2 /*return*/, Promise.resolve(this.uri)
+                        .then(function (uri) {
+                        var url;
+                        try {
+                            url = new URL(uri);
+                        }
+                        catch (err) {
+                            // If that try fails for whatever reason than the URI that we have isn't a real URL and
+                            // we can safely attempt to look for it on the filesystem.
+                            return Fetcher.getFile(uri);
+                        }
+                        return Fetcher.getURL(url.href);
+                    })
+                        .then(function (res) { return Fetcher.validate(res); })
+                        .then(function (res) { return res; })];
+            });
+        });
+    };
+    Fetcher.getURL = function (url) {
+        // @todo maybe include our user-agent here to identify our request
+        return fetch(url).then(function (res) {
+            if (!res.ok) {
+                throw new Error("Unable to retrieve URL (".concat(url, "). Reason: ").concat(res.statusText));
+            }
+            if (res.headers.get('content-type') === 'application/yaml' || /\.(yaml|yml)/.test(url)) {
+                return res.text().then(function (text) {
+                    return js_yaml_1["default"].load(text);
+                });
+            }
+            return res.json();
+        });
+    };
+    Fetcher.getFile = function (uri) {
+        // Support relative paths by resolving them against the cwd.
+        var file = path_1["default"].resolve(process.cwd(), uri);
+        if (!fs_1["default"].existsSync(file)) {
+            throw new Error("Sorry, we were unable to load an API definition from ".concat(file, ". Please either supply a URL or a path on your filesystem."));
+        }
+        return Promise.resolve(fs_1["default"].readFileSync(file, 'utf8')).then(function (res) {
+            if (/\.(yaml|yml)/.test(file)) {
+                return js_yaml_1["default"].load(res);
+            }
+            return JSON.parse(res);
+        });
+    };
+    Fetcher.validate = function (json) {
+        if (json.swagger) {
+            throw new Error('Sorry, this module only supports OpenAPI definitions.');
+        }
+        // The `validate` method handles dereferencing for us.
+        return openapi_parser_1["default"].validate(json, {
+            dereference: {
+                /**
+                 * If circular `$refs` are ignored they'll remain in the API definition as `$ref: String`.
+                 * This allows us to not only do easy circular reference detection but also stringify and
+                 * save dereferenced API definitions back into the cache directory.
+                 */
+                circular: 'ignore'
+            }
+        })["catch"](function (err) {
+            if (/is not a valid openapi definition/i.test(err.message)) {
+                throw new Error("Sorry, that doesn't look like a valid OpenAPI definition.");
+            }
+            throw err;
+        });
+    };
+    /**
+     * @example @petstore/v1.0#n6kvf10vakpemvplx
+     * @example @petstore#n6kvf10vakpemvplx
+     */
+    // eslint-disable-next-line unicorn/no-unsafe-regex
+    Fetcher.registryUUIDRegex = /^@(?<project>[a-zA-Z0-9-_]+)(\/?(?<version>.+))?#(?<uuid>[a-z0-9]+)$/;
+    return Fetcher;
+}());
+exports["default"] = Fetcher;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import type { OASDocument } from 'oas/@types/rmoas.types';
+interface SDKOptions {
+    cacheDir?: string;
+}
+declare const _default: (uri: string | OASDocument, opts?: SDKOptions) => any;
+export = _default;