@gitbook/react-openapi 1.0.1 → 1.0.3

package/dist/OpenAPISchemaName.jsx

@@ -3,13 +3,34 @@
  * It includes the property name, type, required and deprecated status.
  */
 export function OpenAPISchemaName(props) {
-    var type = props.type, propertyName = props.propertyName, required = props.required, deprecated = props.deprecated;
+    var schema = props.schema, type = props.type, propertyName = props.propertyName, required = props.required;
+    var additionalItems = schema && getAdditionalItems(schema);
     return (<div className="openapi-schema-name">
-            {propertyName ? (<span data-deprecated={deprecated} className="openapi-schema-propertyname">
+            {propertyName ? (<span data-deprecated={schema === null || schema === void 0 ? void 0 : schema.deprecated} className="openapi-schema-propertyname">
                     {propertyName}
                 </span>) : null}
-            {type ? <span className="openapi-schema-type">{type}</span> : null}
+            <span>
+                {type ? <span className="openapi-schema-type">{type}</span> : null}
+                {additionalItems ? (<span className="openapi-schema-type">{additionalItems}</span>) : null}
+            </span>
             {required ? <span className="openapi-schema-required">required</span> : null}
-            {deprecated ? <span className="openapi-deprecated">Deprecated</span> : null}
+            {(schema === null || schema === void 0 ? void 0 : schema.deprecated) ? <span className="openapi-deprecated">Deprecated</span> : null}
         </div>);
 }
+function getAdditionalItems(schema) {
+    var additionalItems = '';
+    if (schema.minimum || schema.minLength) {
+        additionalItems += " \u00B7 min: ".concat(schema.minimum || schema.minLength);
+    }
+    if (schema.maximum || schema.maxLength) {
+        additionalItems += " \u00B7 max: ".concat(schema.maximum || schema.maxLength);
+    }
+    // If the schema has a default value, we display it
+    if (typeof schema.default !== 'undefined') {
+        additionalItems += " \u00B7 default: ".concat(schema.default);
+    }
+    if (schema.nullable) {
+        additionalItems = " | nullable";
+    }
+    return additionalItems;
+}

package/dist/OpenAPISpec.jsx

@@ -1,21 +1,10 @@
 'use client';
-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);
-};
 import { InteractiveSection } from './InteractiveSection';
 import { OpenAPIRequestBody } from './OpenAPIRequestBody';
 import { OpenAPIResponses } from './OpenAPIResponses';
 import { OpenAPISchemaProperties } from './OpenAPISchema';
 import { OpenAPISecurities } from './OpenAPISecurities';
-import { resolveDescription } from './utils';
+import { parameterToProperty } from './utils';
 /**
  * Client component to render the spec for the request and response.
  *
@@ -33,20 +22,7 @@ export function OpenAPISpec(props) {
 
             {parameterGroups.map(function (group) {
             return (<InteractiveSection key={group.key} className="openapi-parameters" header={group.label}>
-                        <OpenAPISchemaProperties properties={group.parameters.map(function (parameter) {
-                    var _a;
-                    var description = resolveDescription(parameter);
-                    return {
-                        propertyName: parameter.name,
-                        schema: __assign({ 
-                            // Description of the parameter is defined at the parameter level
-                            // we use display it if the schema doesn't override it
-                            description: description, example: parameter.example, 
-                            // Deprecated can be defined at the parameter level
-                            deprecated: parameter.deprecated }, ((_a = parameter.schema) !== null && _a !== void 0 ? _a : {})),
-                        required: parameter.required,
-                    };
-                })} context={context}/>
+                        <OpenAPISchemaProperties properties={group.parameters.map(parameterToProperty)} context={context}/>
                     </InteractiveSection>);
         })}
 

package/dist/OpenAPITabs.jsx

@@ -52,10 +52,14 @@ 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]);

package/dist/code-samples.js

@@ -9,6 +9,7 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+import { isFormData, isPDF, isFormUrlEncoded, isText, isXML, isCSV, isGraphQL, isPlainObject, } 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,14 +55,23 @@ 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 += "});\n\n";
             code += "const data = await response.json();";
             return code;
         },
@@ -61,15 +83,29 @@ 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 += ')\n\n';
             code += "data = response.json()";
             return code;
         },
@@ -86,6 +122,10 @@ 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')) {
@@ -99,7 +139,7 @@ export var codeSampleGenerators = [
                 })
                     .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;
         },
@@ -132,3 +172,185 @@ export function parseHostAndPath(url) {
         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 += indent("\"".concat(key, "\": \"").concat(String(value), "\","), 4) + '\n';
+                });
+            }
+            code += '}\n\n';
+            body = 'files';
+        }
+        if (isPDF(contentType)) {
+            code += 'files = {\n';
+            code += 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.d.ts

@@ -1,17 +1,16 @@
 import type { OpenAPIV3 } from '@gitbook/openapi-parser';
+import { getExampleFromSchema } from '@scalar/oas-utils/spec-getters';
 type JSONValue = string | number | boolean | null | JSONValue[] | {
     [key: string]: JSONValue;
 };
+type ScalarGetExampleFromSchemaOptions = NonNullable<Parameters<typeof getExampleFromSchema>[1]>;
+type GenerateSchemaExampleOptions = Pick<ScalarGetExampleFromSchemaOptions, 'xml' | 'omitEmptyAndOptionalProperties' | 'mode'>;
 /**
  * Generate a JSON example from a schema
  */
-export declare function generateSchemaExample(schema: OpenAPIV3.SchemaObject, options?: {
-    onlyRequired?: boolean;
-}): JSONValue | undefined;
+export declare function generateSchemaExample(schema: OpenAPIV3.SchemaObject, options?: GenerateSchemaExampleOptions): JSONValue | undefined;
 /**
  * Generate an example for a media type.
  */
-export declare function generateMediaTypeExample(mediaType: OpenAPIV3.MediaTypeObject, options?: {
-    onlyRequired?: boolean;
-}): JSONValue | undefined;
+export declare function generateMediaTypeExample(mediaType: OpenAPIV3.MediaTypeObject, options?: GenerateSchemaExampleOptions): JSONValue | undefined;
 export {};

package/dist/generateSchemaExample.js

@@ -1,13 +1,20 @@
+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);
+};
 import { getExampleFromSchema } from '@scalar/oas-utils/spec-getters';
 /**
  * Generate a JSON example from a schema
  */
 export function generateSchemaExample(schema, options) {
-    if (options === void 0) { options = {}; }
-    return getExampleFromSchema(schema, {
-        emptyString: 'text',
-        omitEmptyAndOptionalProperties: options.onlyRequired,
-        variables: {
+    return getExampleFromSchema(schema, __assign({ emptyString: 'text', variables: {
             'date-time': new Date().toISOString(),
             date: new Date().toISOString().split('T')[0],
             email: 'name@gmail.com',
@@ -19,14 +26,12 @@ export function generateSchemaExample(schema, options) {
             binary: 'binary',
             byte: 'Ynl0ZXM=',
             password: 'password',
-        },
-    });
+        } }, options), 3);
 }
 /**
  * Generate an example for a media type.
  */
 export function generateMediaTypeExample(mediaType, options) {
-    if (options === void 0) { options = {}; }
     if (mediaType.example) {
         return mediaType.example;
     }

package/dist/json2xml.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This function converts an object to XML.
+ */
+export declare function json2xml(data: Record<string, any>): string;

package/dist/json2xml.js

@@ -0,0 +1,7 @@
+import { jsXml } from 'json-xml-parse';
+/**
+ * This function converts an object to XML.
+ */
+export function json2xml(data) {
+    return jsXml.toXmlString(data, { beautify: true });
+}

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);
 }