@gitbook/react-openapi 0.7.1 → 1.0.0

package/dist/fetchOpenAPIOperation.js

@@ -1,124 +1,195 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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 = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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 (g && (g = 0, op[0] && (_ = 0)), _) 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 __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 import { toJSON, fromJSON } from 'flatted';
-import YAML from 'yaml';
-import swagger2openapi from 'swagger2openapi';
-import { resolveOpenAPIPath } from './resolveOpenAPIPath';
+import { OpenAPIParseError, dereference, } from '@gitbook/openapi-parser';
+import { noReference } from './utils';
 export { toJSON, fromJSON };
 /**
  * Resolve an OpenAPI operation in a file and compile it to a more usable format.
  */
-export async function fetchOpenAPIOperation(input, rawFetcher) {
-    const fetcher = cacheFetcher(rawFetcher);
-    let operation = await resolveOpenAPIPath(input.url, ['paths', input.path, input.method], fetcher);
-    if (!operation) {
-        return null;
-    }
-    const specData = await fetcher.fetch(input.url);
-    // Resolve common parameters
-    const commonParameters = await resolveOpenAPIPath(input.url, ['paths', input.path, 'parameters'], fetcher);
-    if (commonParameters) {
-        operation = {
-            ...operation,
-            parameters: [...commonParameters, ...(operation.parameters ?? [])],
-        };
-    }
-    // Resolve servers
-    const servers = await resolveOpenAPIPath(input.url, ['servers'], fetcher);
-    // Resolve securities
-    const securities = [];
-    for (const security of operation.security ?? []) {
-        const securityKey = Object.keys(security)[0];
-        const securityScheme = await resolveOpenAPIPath(input.url, ['components', 'securitySchemes', securityKey], fetcher);
-        if (securityScheme) {
-            securities.push([securityKey, securityScheme]);
-        }
+export function fetchOpenAPIOperation(input, fetcher) {
+    return __awaiter(this, void 0, void 0, function () {
+        var filesystem, schema, operation, commonParameters, servers, security, securities, _i, security_1, entry, securityKey, securityScheme;
+        var _a, _b, _c, _d, _e, _f;
+        return __generator(this, function (_g) {
+            switch (_g.label) {
+                case 0: return [4 /*yield*/, fetcher.fetch(input.url)];
+                case 1:
+                    filesystem = _g.sent();
+                    return [4 /*yield*/, memoDereferenceFilesystem(filesystem, input.url)];
+                case 2:
+                    schema = _g.sent();
+                    operation = getOperationByPathAndMethod(schema, input.path, input.method);
+                    if (!operation) {
+                        return [2 /*return*/, null];
+                    }
+                    commonParameters = getPathObjectParameter(schema, input.path);
+                    if (commonParameters) {
+                        operation = __assign(__assign({}, operation), { parameters: __spreadArray(__spreadArray([], commonParameters, true), ((_a = operation.parameters) !== null && _a !== void 0 ? _a : []), true) });
+                    }
+                    servers = 'servers' in schema ? ((_b = schema.servers) !== null && _b !== void 0 ? _b : []) : [];
+                    security = flattenSecurities((_d = (_c = operation.security) !== null && _c !== void 0 ? _c : schema.security) !== null && _d !== void 0 ? _d : []);
+                    securities = [];
+                    for (_i = 0, security_1 = security; _i < security_1.length; _i++) {
+                        entry = security_1[_i];
+                        securityKey = Object.keys(entry)[0];
+                        if (securityKey) {
+                            securityScheme = (_f = (_e = schema.components) === null || _e === void 0 ? void 0 : _e.securitySchemes) === null || _f === void 0 ? void 0 : _f[securityKey];
+                            if (securityScheme) {
+                                securities.push([securityKey, noReference(securityScheme)]);
+                            }
+                        }
+                    }
+                    return [2 /*return*/, {
+                            servers: servers,
+                            operation: operation,
+                            method: input.method,
+                            path: input.path,
+                            securities: securities,
+                            'x-codeSamples': typeof schema['x-codeSamples'] === 'boolean' ? schema['x-codeSamples'] : undefined,
+                            'x-hideTryItPanel': typeof schema['x-hideTryItPanel'] === 'boolean'
+                                ? schema['x-hideTryItPanel']
+                                : undefined,
+                        }];
+            }
+        });
+    });
+}
+var dereferenceCache = new WeakMap();
+/**
+ * Memoized version of `dereferenceSchema`.
+ */
+function memoDereferenceFilesystem(filesystem, url) {
+    if (dereferenceCache.has(filesystem)) {
+        return dereferenceCache.get(filesystem);
     }
-    return {
-        servers: servers ?? [],
-        operation,
-        method: input.method,
-        path: input.path,
-        securities,
-        'x-codeSamples': typeof specData['x-codeSamples'] === 'boolean' ? specData['x-codeSamples'] : undefined,
-        'x-hideTryItPanel': typeof specData['x-hideTryItPanel'] === 'boolean'
-            ? specData['x-hideTryItPanel']
-            : undefined,
-    };
+    var promise = dereferenceFilesystem(filesystem, url);
+    dereferenceCache.set(filesystem, promise);
+    return promise;
 }
-function cacheFetcher(fetcher) {
-    const cache = new Map();
-    return {
-        async fetch(url) {
-            if (cache.has(url)) {
-                return cache.get(url);
+/**
+ * Dereference an OpenAPI schema.
+ */
+function dereferenceFilesystem(filesystem, url) {
+    return __awaiter(this, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, dereference(filesystem)];
+                case 1:
+                    result = _a.sent();
+                    if (!result.schema) {
+                        throw new OpenAPIParseError('Failed to dereference OpenAPI document', url, 'failed-dereference');
+                    }
+                    return [2 /*return*/, result.schema];
             }
-            const promise = fetcher.fetch(url);
-            cache.set(url, promise);
-            return promise;
-        },
-        parseMarkdown: fetcher.parseMarkdown,
-    };
+        });
+    });
 }
 /**
- * Parse a raw string into an OpenAPI document.
- * It will also convert Swagger 2.0 to OpenAPI 3.0.
- * It can throw an `OpenAPIFetchError` if the document is invalid.
+ * Get a path object from its path.
  */
-export async function parseOpenAPIV3(url, text) {
-    // Parse the JSON or YAML
-    let data;
-    // Try with JSON
-    try {
-        data = JSON.parse(text);
+function getPathObject(schema, path) {
+    var _a;
+    if ((_a = schema.paths) === null || _a === void 0 ? void 0 : _a[path]) {
+        return schema.paths[path];
     }
-    catch (jsonError) {
-        try {
-            // Try with YAML
-            data = YAML.parse(text);
-        }
-        catch (yamlError) {
-            if (yamlError instanceof Error && yamlError.name.startsWith('YAML')) {
-                throw new OpenAPIFetchError('Failed to parse YAML: ' + yamlError.message, url);
-            }
-            else {
-                throw yamlError;
-            }
-        }
+    return null;
+}
+/**
+ * Resolve parameters from a path in an OpenAPI schema.
+ */
+function getPathObjectParameter(schema, path) {
+    var pathObject = getPathObject(schema, path);
+    if (pathObject === null || pathObject === void 0 ? void 0 : pathObject.parameters) {
+        return pathObject.parameters.map(noReference);
     }
-    // Convert Swagger 2.0 to OpenAPI 3.0
-    // @ts-ignore
-    if (data && data.swagger) {
-        try {
-            // Convert Swagger 2.0 to OpenAPI 3.0
-            // @ts-ignore
-            const result = (await swagger2openapi.convertObj(data, {
-                resolve: false,
-                resolveInternal: false,
-                laxDefaults: true,
-                laxurls: true,
-                lint: false,
-                prevalidate: false,
-                anchors: true,
-                patch: true,
-            }));
-            data = result.openapi;
-        }
-        catch (error) {
-            if (error.name === 'S2OError') {
-                throw new OpenAPIFetchError('Failed to convert Swagger 2.0 to OpenAPI 3.0: ' + error.message, url);
-            }
-            else {
-                throw error;
-            }
-        }
+    return null;
+}
+/**
+ * Get an operation by its path and method.
+ */
+function getOperationByPathAndMethod(schema, path, method) {
+    // Types are buffy for OpenAPIV3_1.OperationObject, so we use v3
+    var pathObject = getPathObject(schema, path);
+    if (!pathObject) {
+        return null;
     }
-    // @ts-ignore
-    return data;
+    var normalizedMethod = method.toLowerCase();
+    if (!pathObject[normalizedMethod]) {
+        return null;
+    }
+    return pathObject[normalizedMethod];
 }
-export class OpenAPIFetchError extends Error {
-    url;
-    name = 'OpenAPIFetchError';
-    constructor(message, url) {
-        super(message);
-        this.url = url;
+/**
+ * Flatten security objects in case they are nested.
+ * @example [{bearerAuth:[], basicAuth:[]}] => [{ bearerAuth: [] }, { basicAuth: [] }]
+ */
+function flattenSecurities(security) {
+    if (!Array.isArray(security) || security.length === 0) {
+        return [];
     }
+    return security.flatMap(function (securityObject) {
+        return Object.entries(securityObject).map(function (_a) {
+            var _b;
+            var authType = _a[0], config = _a[1];
+            return (_b = {},
+                _b[authType] = config,
+                _b);
+        });
+    });
 }

package/dist/generateSchemaExample.d.ts

@@ -1,4 +1,4 @@
-import { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3 } from '@gitbook/openapi-parser';
 type JSONValue = string | number | boolean | null | JSONValue[] | {
     [key: string]: JSONValue;
 };
@@ -7,7 +7,7 @@ type JSONValue = string | number | boolean | null | JSONValue[] | {
  */
 export declare function generateSchemaExample(schema: OpenAPIV3.SchemaObject, options?: {
     onlyRequired?: boolean;
-}, ancestors?: Set<OpenAPIV3.SchemaObject>): JSONValue | undefined;
+}): JSONValue | undefined;
 /**
  * Generate an example for a media type.
  */

package/dist/generateSchemaExample.js

@@ -1,115 +1,43 @@
 import { noReference } from './utils';
+import { getExampleFromSchema } from '@scalar/oas-utils/spec-getters';
 /**
  * Generate a JSON example from a schema
  */
-export function generateSchemaExample(schema, options = {}, ancestors = new Set()) {
-    const { onlyRequired = false } = options;
-    if (ancestors.has(schema)) {
-        return undefined;
-    }
-    if (typeof schema.example !== 'undefined') {
-        return schema.example;
-    }
-    if (schema.enum && schema.enum.length > 0) {
-        return schema.enum[0];
-    }
-    if (schema.type === 'string') {
-        if (schema.default) {
-            return schema.default;
-        }
-        if (schema.format === 'date-time') {
-            return new Date().toISOString();
-        }
-        if (schema.format === 'date') {
-            return new Date().toISOString().split('T')[0];
-        }
-        if (schema.format === 'email') {
-            return 'name@gmail.com';
-        }
-        if (schema.format === 'hostname') {
-            return 'example.com';
-        }
-        if (schema.format === 'ipv4') {
-            return '0.0.0.0';
-        }
-        if (schema.format === 'ipv6') {
-            return '2001:0db8:85a3:0000:0000:8a2e:0370:7334';
-        }
-        if (schema.format === 'uri') {
-            return 'https://example.com';
-        }
-        if (schema.format === 'uuid') {
-            return '123e4567-e89b-12d3-a456-426614174000';
-        }
-        if (schema.format === 'binary') {
-            return 'binary';
-        }
-        if (schema.format === 'byte') {
-            return 'Ynl0ZXM=';
-        }
-        if (schema.format === 'password') {
-            return 'password';
-        }
-        return 'text';
-    }
-    if (schema.type === 'number' || schema.type === 'integer') {
-        return schema.default || 0;
-    }
-    if (schema.type === 'boolean') {
-        return schema.default || false;
-    }
-    if (schema.type === 'array') {
-        if (schema.items) {
-            const exampleValue = generateSchemaExample(noReference(schema.items), options, new Set(ancestors).add(schema));
-            if (exampleValue !== undefined) {
-                return [exampleValue];
-            }
-            return [];
-        }
-        return [];
-    }
-    if (schema.properties) {
-        const example = {};
-        const props = onlyRequired ? (schema.required ?? []) : Object.keys(schema.properties);
-        for (const key of props) {
-            const property = noReference(schema.properties[key]);
-            if (property && (onlyRequired || !property.deprecated)) {
-                const exampleValue = generateSchemaExample(noReference(property), options, new Set(ancestors).add(schema));
-                if (exampleValue !== undefined) {
-                    example[key] = exampleValue;
-                }
-            }
-        }
-        return example;
-    }
-    if (schema.oneOf && schema.oneOf.length > 0) {
-        return generateSchemaExample(noReference(schema.oneOf[0]), options, new Set(ancestors).add(schema));
-    }
-    if (schema.anyOf && schema.anyOf.length > 0) {
-        return generateSchemaExample(noReference(schema.anyOf[0]), options, new Set(ancestors).add(schema));
-    }
-    if (schema.allOf && schema.allOf.length > 0) {
-        return schema.allOf.reduce((acc, curr) => {
-            const example = generateSchemaExample(noReference(curr), options, new Set(ancestors).add(schema));
-            if (typeof example === 'object' && !Array.isArray(example) && example !== null) {
-                return { ...acc, ...example };
-            }
-            return acc;
-        }, {});
-    }
-    return undefined;
+export function generateSchemaExample(schema, options) {
+    if (options === void 0) { options = {}; }
+    return getExampleFromSchema(schema, {
+        emptyString: 'text',
+        omitEmptyAndOptionalProperties: options.onlyRequired,
+        variables: {
+            'date-time': new Date().toISOString(),
+            date: new Date().toISOString().split('T')[0],
+            email: 'name@gmail.com',
+            hostname: 'example.com',
+            ipv4: '0.0.0.0',
+            ipv6: '2001:0db8:85a3:0000:0000:8a2e:0370:7334',
+            uri: 'https://example.com',
+            uuid: '123e4567-e89b-12d3-a456-426614174000',
+            binary: 'binary',
+            byte: 'Ynl0ZXM=',
+            password: 'password',
+        },
+    });
 }
 /**
  * Generate an example for a media type.
  */
-export function generateMediaTypeExample(mediaType, options = {}) {
+export function generateMediaTypeExample(mediaType, options) {
+    if (options === void 0) { options = {}; }
     if (mediaType.example) {
         return mediaType.example;
     }
     if (mediaType.examples) {
-        const example = mediaType.examples[Object.keys(mediaType.examples)[0]];
-        if (example) {
-            return noReference(example).value;
+        var key = Object.keys(mediaType.examples)[0];
+        if (key) {
+            var example = mediaType.examples[key];
+            if (example) {
+                return noReference(example).value;
+            }
         }
     }
     if (mediaType.schema) {

package/dist/index.d.ts

@@ -1,3 +1,4 @@
-export * from './fetchOpenAPIOperation';
+export * from './resolveOpenAPIOperation';
 export * from './OpenAPIOperation';
-export type { OpenAPIFetcher } from './types';
+export * from './OpenAPIOperationContext';
+export type { OpenAPIOperationData } from './types';

package/dist/index.js

@@ -1,2 +1,3 @@
-export * from './fetchOpenAPIOperation';
+export * from './resolveOpenAPIOperation';
 export * from './OpenAPIOperation';
+export * from './OpenAPIOperationContext';

package/dist/resolveOpenAPIOperation.d.ts

@@ -0,0 +1,11 @@
+import { toJSON, fromJSON } from 'flatted';
+import { type OpenAPIV3xDocument, type Filesystem } from '@gitbook/openapi-parser';
+import { OpenAPIOperationData } from './types';
+export { toJSON, fromJSON };
+/**
+ * Resolve an OpenAPI operation in a file and compile it to a more usable format.
+ */
+export declare function resolveOpenAPIOperation(filesystem: Filesystem<OpenAPIV3xDocument>, operationDescriptor: {
+    path: string;
+    method: string;
+}): Promise<OpenAPIOperationData | null>;