@gitbook/react-openapi 1.0.2 → 1.0.4

package/dist/OpenAPISecurities.jsx

@@ -35,12 +35,12 @@ function getLabelForType(security) {
             if (security.scheme === 'basic') {
                 return <OpenAPISchemaName propertyName="Authorization" type="string" required/>;
             }
-            if (security.scheme == 'bearer') {
+            if (security.scheme === 'bearer') {
                 var description = resolveDescription(security);
                 return (<>
                         <OpenAPISchemaName propertyName="Authorization" type="string" required/>
                         {/** Show a default description if none is provided */}
-                        {!description ? (<Markdown source={"Bearer authentication header of the form Bearer ".concat("&lt;token&gt;", ".")} className="openapi-securities-description"/>) : null}
+                        {!description ? (<Markdown source={"Bearer authentication header of the form Bearer ".concat('&lt;token&gt;', ".")} className="openapi-securities-description"/>) : null}
                     </>);
             }
             return <OpenAPISchemaName propertyName="HTTP" required/>;

package/dist/OpenAPITabs.d.ts

@@ -1,5 +1,5 @@
-import { Key, TabsProps } from 'react-aria-components';
-export type Tab = {
+import { type Key, type TabsProps } from 'react-aria-components';
+export type TabItem = {
     key: Key;
     label: string;
     body: React.ReactNode;
@@ -9,7 +9,7 @@ export type Tab = {
  * The OpenAPI Tabs wrapper component.
  */
 export declare function OpenAPITabs(props: React.PropsWithChildren<TabsProps & {
-    items: Tab[];
+    items: TabItem[];
     stateKey?: string;
 }>): import("react").JSX.Element;
 /**

package/dist/OpenAPITabs.jsx

@@ -1,9 +1,9 @@
 'use client';
 import { createContext, useContext, useEffect, useMemo, useState } from 'react';
 import { Tab, TabList, TabPanel, Tabs } from 'react-aria-components';
+import { useIntersectionObserver } from 'usehooks-ts';
 import { Markdown } from './Markdown';
 import { useSyncedTabsGlobalState } from './useSyncedTabsGlobalState';
-import { useIntersectionObserver } from 'usehooks-ts';
 var OpenAPITabsContext = createContext(null);
 function useOpenAPITabsContext() {
     var context = useContext(OpenAPITabsContext);
@@ -17,23 +17,22 @@ function useOpenAPITabsContext() {
  */
 export function OpenAPITabs(props) {
     var children = props.children, items = props.items, stateKey = props.stateKey;
-    var isVisible = stateKey
-        ? useIntersectionObserver({
-            threshold: 0.1,
-            rootMargin: '200px',
-        })
-        : true;
+    var _a = useIntersectionObserver({
+        threshold: 0.1,
+        rootMargin: '200px',
+    }), ref = _a[0], isIntersectionVisible = _a[1];
+    var isVisible = stateKey ? isIntersectionVisible : true;
     var defaultTab = items[0];
-    var _a = useSyncedTabsGlobalState(), syncedTabs = _a[0], setSyncedTabs = _a[1];
-    var _b = useState(function () {
+    var _b = useSyncedTabsGlobalState(), syncedTabs = _b[0], setSyncedTabs = _b[1];
+    var _c = useState(function () {
         var _a, _b, _c;
         if (isVisible && stateKey && syncedTabs && syncedTabs.has(stateKey)) {
             var tabFromState = syncedTabs.get(stateKey);
             return (_a = tabFromState === null || tabFromState === void 0 ? void 0 : tabFromState.key) !== null && _a !== void 0 ? _a : (_b = items[0]) === null || _b === void 0 ? void 0 : _b.key;
         }
         return (_c = items[0]) === null || _c === void 0 ? void 0 : _c.key;
-    }), selectedTabKey = _b[0], setSelectedTabKey = _b[1];
-    var _c = useState(defaultTab), selectedTab = _c[0], setSelectedTab = _c[1];
+    }), selectedTabKey = _c[0], setSelectedTabKey = _c[1];
+    var _d = useState(defaultTab), selectedTab = _d[0], setSelectedTab = _d[1];
     var handleSelectionChange = function (key) {
         setSelectedTabKey(key);
         if (stateKey) {
@@ -52,16 +51,20 @@ export function OpenAPITabs(props) {
         if (isVisible && stateKey && syncedTabs && syncedTabs.has(stateKey)) {
             var tabFromState_1 = syncedTabs.get(stateKey);
             if (!items.some(function (item) { return item.key === (tabFromState_1 === null || tabFromState_1 === void 0 ? void 0 : tabFromState_1.key); })) {
-                return;
+                return setSelectedTab(defaultTab);
             }
             if (tabFromState_1 && (tabFromState_1 === null || tabFromState_1 === void 0 ? void 0 : tabFromState_1.key) !== (selectedTab === null || selectedTab === void 0 ? void 0 : selectedTab.key)) {
-                setSelectedTab(tabFromState_1);
+                var tabFromItems = items.find(function (item) { return item.key === tabFromState_1.key; });
+                if (!tabFromItems) {
+                    return;
+                }
+                setSelectedTab(tabFromItems);
             }
         }
     }, [isVisible, stateKey, syncedTabs, selectedTabKey]);
     var contextValue = useMemo(function () { return ({ items: items, selectedTab: selectedTab }); }, [items, selectedTab]);
     return (<OpenAPITabsContext.Provider value={contextValue}>
-            <Tabs className="openapi-tabs" onSelectionChange={handleSelectionChange} selectedKey={selectedTab === null || selectedTab === void 0 ? void 0 : selectedTab.key}>
+            <Tabs ref={ref} className="openapi-tabs" onSelectionChange={handleSelectionChange} selectedKey={selectedTab === null || selectedTab === void 0 ? void 0 : selectedTab.key}>
                 {children}
             </Tabs>
         </OpenAPITabsContext.Provider>);

package/dist/ScalarApiButton.jsx

@@ -2,8 +2,8 @@
 import { ApiClientModalProvider, useApiClientModal } from '@scalar/api-client-react';
 import { useEffect, useImperativeHandle, useRef, useState } from 'react';
 import { createPortal } from 'react-dom';
-import { useOpenAPIOperationContext } from './OpenAPIOperationContext';
 import { useEventCallback } from 'usehooks-ts';
+import { useOpenAPIOperationContext } from './OpenAPIOperationContext';
 /**
  * Button which launches the Scalar API Client
  */

package/dist/code-samples.js

@@ -9,6 +9,7 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+import { isCSV, isFormData, isFormUrlEncoded, isGraphQL, isPDF, isPlainObject, isText, isXML, } from './contentTypeChecks';
 import { stringifyOpenAPI } from './stringifyOpenAPI';
 export var codeSampleGenerators = [
     {
@@ -23,14 +24,26 @@ export var codeSampleGenerators = [
                 lines.push("--request ".concat(method.toUpperCase()));
             }
             lines.push("--url '".concat(url, "'"));
-            if (headers) {
+            if (body) {
+                var bodyContent = BodyGenerators.getCurlBody(body, headers);
+                if (bodyContent) {
+                    body = bodyContent.body;
+                    headers = bodyContent.headers;
+                }
+            }
+            if (headers && Object.keys(headers).length > 0) {
                 Object.entries(headers).forEach(function (_a) {
                     var key = _a[0], value = _a[1];
                     lines.push("--header '".concat(key, ": ").concat(value, "'"));
                 });
             }
-            if (body && Object.keys(body).length > 0) {
-                lines.push("--data '".concat(stringifyOpenAPI(body), "'"));
+            if (body) {
+                if (Array.isArray(body)) {
+                    lines.push.apply(lines, body);
+                }
+                else {
+                    lines.push(body);
+                }
             }
             return lines.map(function (line, index) { return (index > 0 ? indent(line, 2) : line); }).join(separator);
         },
@@ -42,15 +55,24 @@ export var codeSampleGenerators = [
         generate: function (_a) {
             var method = _a.method, url = _a.url, headers = _a.headers, body = _a.body;
             var code = '';
+            if (body) {
+                var lines = BodyGenerators.getJavaScriptBody(body, headers);
+                if (lines) {
+                    // add the generated code to the top
+                    code += lines.code;
+                    body = lines.body;
+                    headers = lines.headers;
+                }
+            }
             code += "const response = await fetch('".concat(url, "', {\n    method: '").concat(method.toUpperCase(), "',\n");
-            if (headers) {
+            if (headers && Object.keys(headers).length > 0) {
                 code += indent("headers: ".concat(stringifyOpenAPI(headers, null, 2), ",\n"), 4);
             }
             if (body) {
-                code += indent("body: JSON.stringify(".concat(stringifyOpenAPI(body, null, 2), "),\n"), 4);
+                code += indent("body: ".concat(body, "\n"), 4);
             }
-            code += "});\n";
-            code += "const data = await response.json();";
+            code += '});\n\n';
+            code += 'const data = await response.json();';
             return code;
         },
     },
@@ -61,16 +83,30 @@ export var codeSampleGenerators = [
         generate: function (_a) {
             var method = _a.method, url = _a.url, headers = _a.headers, body = _a.body;
             var code = 'import requests\n\n';
+            if (body) {
+                var lines = BodyGenerators.getPythonBody(body, headers);
+                // add the generated code to the top
+                if (lines) {
+                    code += lines.code;
+                    body = lines.body;
+                    headers = lines.headers;
+                }
+            }
             code += "response = requests.".concat(method.toLowerCase(), "(\n");
             code += indent("\"".concat(url, "\",\n"), 4);
-            if (headers) {
+            if (headers && Object.keys(headers).length > 0) {
                 code += indent("headers=".concat(stringifyOpenAPI(headers), ",\n"), 4);
             }
             if (body) {
-                code += indent("json=".concat(stringifyOpenAPI(body), "\n"), 4);
+                if (body === 'files') {
+                    code += indent("files=".concat(body, "\n"), 4);
+                }
+                else {
+                    code += indent("data=".concat(stringifyOpenAPI(body), "\n"), 4);
+                }
             }
-            code += ')\n';
-            code += "data = response.json()";
+            code += ')\n\n';
+            code += 'data = response.json()';
             return code;
         },
     },
@@ -86,20 +122,24 @@ export var codeSampleGenerators = [
                 var bodyContent = body ? stringifyOpenAPI(body) : '';
                 // handle unicode chars with a text encoder
                 var encoder = new TextEncoder();
+                var bodyString_1 = BodyGenerators.getHTTPBody(body, headers);
+                if (bodyString_1) {
+                    body = bodyString_1;
+                }
                 headers = __assign(__assign({}, headers), { 'Content-Length': encoder.encode(bodyContent).length.toString() });
             }
             if (!headers.hasOwnProperty('Accept')) {
                 headers.Accept = '*/*';
             }
             var headerString = headers
-                ? Object.entries(headers)
+                ? "".concat(Object.entries(headers)
                     .map(function (_a) {
                     var key = _a[0], value = _a[1];
-                    return key.toLowerCase() !== 'host' ? "".concat(key, ": ").concat(value) : "";
+                    return key.toLowerCase() !== 'host' ? "".concat(key, ": ").concat(value) : '';
                 })
-                    .join('\n') + '\n'
+                    .join('\n'), "\n")
                 : '';
-            var bodyString = body ? "\n".concat(stringifyOpenAPI(body, null, 2)) : '';
+            var bodyString = body ? "\n".concat(body) : '';
             var httpRequest = "".concat(method.toUpperCase(), " ").concat(decodeURI(path), " HTTP/1.1\nHost: ").concat(host, "\n").concat(headerString).concat(bodyString);
             return httpRequest;
         },
@@ -118,7 +158,7 @@ export function parseHostAndPath(url) {
         var path = urlObj.pathname || '/';
         return { host: urlObj.host, path: path };
     }
-    catch (e) {
+    catch (_e) {
         // If the URL was invalid do our best to parse the URL.
         // Check for the protocol part and pull it off to grab the host
         var splitted = url.split('//');
@@ -128,7 +168,189 @@ export function parseHostAndPath(url) {
         // pull off the host (mutates)
         var host = parts.shift();
         // add a leading slash and join the paths again
-        var path = '/' + parts.join('/');
+        var path = "/".concat(parts.join('/'));
         return { host: host, path: path };
     }
 }
+// Body Generators
+var BodyGenerators = {
+    getCurlBody: function (body, headers) {
+        if (!body || !headers)
+            return undefined;
+        // Copy headers to avoid mutating the original object
+        var headersCopy = __assign({}, headers);
+        var contentType = headersCopy['Content-Type'] || '';
+        if (isFormData(contentType)) {
+            body = isPlainObject(body)
+                ? Object.entries(body).map(function (_a) {
+                    var key = _a[0], value = _a[1];
+                    return "--form '".concat(key, "=").concat(String(value), "'");
+                })
+                : "--form 'file=@".concat(body, "'");
+        }
+        else if (isFormUrlEncoded(contentType)) {
+            body = isPlainObject(body)
+                ? "--data '".concat(Object.entries(body)
+                    .map(function (_a) {
+                    var key = _a[0], value = _a[1];
+                    return "".concat(key, "=").concat(String(value));
+                })
+                    .join('&'), "'")
+                : String(body);
+        }
+        else if (isText(contentType)) {
+            body = "--data '".concat(String(body).replace(/"/g, ''), "'");
+        }
+        else if (isXML(contentType) || isCSV(contentType)) {
+            // We use --data-binary to avoid cURL converting newlines to \r\n
+            body = "--data-binary $'".concat(stringifyOpenAPI(body).replace(/"/g, ''), "'");
+        }
+        else if (isGraphQL(contentType)) {
+            body = "--data '".concat(stringifyOpenAPI(body), "'");
+            // Set Content-Type to application/json for GraphQL, recommended by GraphQL spec
+            headersCopy['Content-Type'] = 'application/json';
+        }
+        else if (isPDF(contentType)) {
+            // We use --data-binary to avoid cURL converting newlines to \r\n
+            body = "--data-binary '@".concat(String(body), "'");
+        }
+        else {
+            body = "--data '".concat(stringifyOpenAPI(body, null, 2), "'");
+        }
+        return {
+            body: body,
+            headers: headersCopy,
+        };
+    },
+    getJavaScriptBody: function (body, headers) {
+        if (!body || !headers)
+            return;
+        var code = '';
+        // Copy headers to avoid mutating the original object
+        var headersCopy = __assign({}, headers);
+        var contentType = headersCopy['Content-Type'] || '';
+        // Use FormData for file uploads
+        if (isFormData(contentType)) {
+            code += 'const formData = new FormData();\n\n';
+            if (isPlainObject(body)) {
+                Object.entries(body).forEach(function (_a) {
+                    var key = _a[0], value = _a[1];
+                    code += "formData.append(\"".concat(key, "\", \"").concat(String(value), "\");\n");
+                });
+            }
+            else if (typeof body === 'string') {
+                code += "formData.append(\"file\", \"".concat(body, "\");\n");
+            }
+            code += '\n';
+            body = 'formData';
+        }
+        else if (isFormUrlEncoded(contentType)) {
+            // Use URLSearchParams for form-urlencoded data
+            code += 'const params = new URLSearchParams();\n\n';
+            if (isPlainObject(body)) {
+                Object.entries(body).forEach(function (_a) {
+                    var key = _a[0], value = _a[1];
+                    code += "params.append(\"".concat(key, "\", \"").concat(String(value), "\");\n");
+                });
+            }
+            code += '\n';
+            body = 'params.toString()';
+        }
+        else if (isGraphQL(contentType)) {
+            if (isPlainObject(body)) {
+                Object.entries(body).forEach(function (_a) {
+                    var key = _a[0], value = _a[1];
+                    code += "const ".concat(key, " = `\n").concat(indent(String(value), 4), "`;\n\n");
+                });
+                body = "JSON.stringify({ ".concat(Object.keys(body).join(', '), " })");
+                // Set Content-Type to application/json for GraphQL, recommended by GraphQL spec
+                headersCopy['Content-Type'] = 'application/json';
+            }
+            else {
+                code += "const query = `\n".concat(indent(String(body), 4), "`;\n\n");
+                body = 'JSON.stringify(query)';
+            }
+        }
+        else if (isCSV(contentType)) {
+            code += 'const csv = `\n';
+            code += indent(String(body), 4);
+            code += '`;\n\n';
+            body = 'csv';
+        }
+        else if (isPDF(contentType)) {
+            // Use FormData to upload PDF files
+            code += 'const formData = new FormData();\n\n';
+            code += "formData.append(\"file\", \"".concat(body, "\");\n\n");
+            body = 'formData';
+        }
+        else if (isXML(contentType)) {
+            code += 'const xml = `\n';
+            code += indent(String(body), 4);
+            code += '`;\n\n';
+            body = 'xml';
+        }
+        else if (isText(contentType)) {
+            body = stringifyOpenAPI(body, null, 2);
+        }
+        else {
+            body = "JSON.stringify(".concat(stringifyOpenAPI(body, null, 2), ")");
+        }
+        return { body: body, code: code, headers: headersCopy };
+    },
+    getPythonBody: function (body, headers) {
+        if (!body || !headers)
+            return;
+        var code = '';
+        var contentType = headers['Content-Type'] || '';
+        if (isFormData(contentType)) {
+            code += 'files = {\n';
+            if (isPlainObject(body)) {
+                Object.entries(body).forEach(function (_a) {
+                    var key = _a[0], value = _a[1];
+                    code += "".concat(indent("\"".concat(key, "\": \"").concat(String(value), "\","), 4), "\n");
+                });
+            }
+            code += '}\n\n';
+            body = 'files';
+        }
+        if (isPDF(contentType)) {
+            code += 'files = {\n';
+            code += "".concat(indent("\"file\": \"".concat(body, "\","), 4), "\n");
+            code += '}\n\n';
+            body = 'files';
+        }
+        return { body: body, code: code, headers: headers };
+    },
+    getHTTPBody: function (body, headers) {
+        if (!body || !headers)
+            return undefined;
+        var contentType = headers['Content-Type'] || '';
+        var typeHandlers = {
+            pdf: function () { return "".concat(stringifyOpenAPI(body, null, 2)); },
+            formUrlEncoded: function () {
+                var encoded = isPlainObject(body)
+                    ? Object.entries(body)
+                        .map(function (_a) {
+                        var key = _a[0], value = _a[1];
+                        return "".concat(key, "=").concat(String(value));
+                    })
+                        .join('&')
+                    : String(body);
+                return "\"".concat(encoded, "\"");
+            },
+            text: function () { return "\"".concat(String(body), "\""); },
+            xmlOrCsv: function () { return "\"".concat(stringifyOpenAPI(body).replace(/"/g, ''), "\""); },
+            default: function () { return "".concat(stringifyOpenAPI(body, null, 2)); },
+        };
+        if (isPDF(contentType))
+            return typeHandlers.pdf();
+        if (isFormUrlEncoded(contentType))
+            return typeHandlers.formUrlEncoded();
+        if (isText(contentType))
+            return typeHandlers.text();
+        if (isXML(contentType) || isCSV(contentType)) {
+            return typeHandlers.xmlOrCsv();
+        }
+        return typeHandlers.default();
+    },
+};

package/dist/contentTypeChecks.d.ts

@@ -0,0 +1,9 @@
+export declare function isJSON(contentType?: string): boolean;
+export declare function isXML(contentType?: string): boolean;
+export declare function isGraphQL(contentType?: string): boolean;
+export declare function isCSV(contentType?: string): boolean;
+export declare function isPDF(contentType?: string): boolean;
+export declare function isText(contentType?: string): boolean;
+export declare function isFormUrlEncoded(contentType?: string): boolean;
+export declare function isFormData(contentType?: string): boolean;
+export declare function isPlainObject(value: unknown): boolean;

package/dist/contentTypeChecks.js

@@ -0,0 +1,27 @@
+export function isJSON(contentType) {
+    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/json')) || false;
+}
+export function isXML(contentType) {
+    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/xml')) || false;
+}
+export function isGraphQL(contentType) {
+    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/graphql')) || false;
+}
+export function isCSV(contentType) {
+    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('text/csv')) || false;
+}
+export function isPDF(contentType) {
+    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/pdf')) || false;
+}
+export function isText(contentType) {
+    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('text/plain')) || false;
+}
+export function isFormUrlEncoded(contentType) {
+    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/x-www-form-urlencoded')) || false;
+}
+export function isFormData(contentType) {
+    return !!contentType && contentType.toLowerCase().includes('multipart/form-data');
+}
+export function isPlainObject(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}

package/dist/generateSchemaExample.js

@@ -26,7 +26,8 @@ export function generateSchemaExample(schema, options) {
             binary: 'binary',
             byte: 'Ynl0ZXM=',
             password: 'password',
-        } }, options));
+        } }, options), 3 // Max depth for circular references
+    );
 }
 /**
  * Generate an example for a media type.

package/dist/resolveOpenAPIOperation.d.ts

@@ -1,6 +1,6 @@
-import { toJSON, fromJSON } from 'flatted';
-import { type OpenAPIV3xDocument, type Filesystem } from '@gitbook/openapi-parser';
-import { OpenAPIOperationData } from './types';
+import { fromJSON, toJSON } from 'flatted';
+import { type Filesystem, type OpenAPIV3xDocument } from '@gitbook/openapi-parser';
+import type { OpenAPIOperationData } from './types';
 export { toJSON, fromJSON };
 /**
  * Resolve an OpenAPI operation in a file and compile it to a more usable format.

package/dist/resolveOpenAPIOperation.js

@@ -54,7 +54,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     }
     return to.concat(ar || Array.prototype.slice.call(from));
 };
-import { toJSON, fromJSON } from 'flatted';
+import { fromJSON, toJSON } from 'flatted';
 import { dereference, } from '@gitbook/openapi-parser';
 import { checkIsReference } from './utils';
 export { toJSON, fromJSON };

package/dist/stringifyOpenAPI.d.ts

@@ -1,4 +1,4 @@
 /**
  * Stringify an OpenAPI object. Same API as JSON.stringify.
  */
-export declare function stringifyOpenAPI(body: unknown, transformer?: null, indent?: number): string;
+export declare function stringifyOpenAPI(body: unknown, _?: null, indent?: number): string;

package/dist/stringifyOpenAPI.js

@@ -1,6 +1,12 @@
 /**
  * Stringify an OpenAPI object. Same API as JSON.stringify.
  */
-export function stringifyOpenAPI(body, transformer, indent) {
-    return JSON.stringify(body, transformer, indent);
+export function stringifyOpenAPI(body, _, indent) {
+    return JSON.stringify(body, function (key, value) {
+        // Ignore internal keys
+        if (key.startsWith('x-gitbook-')) {
+            return undefined;
+        }
+        return value;
+    }, indent);
 }