@gitbook/react-openapi 1.0.1 → 1.0.3

package/src/code-samples.ts

@@ -1,3 +1,13 @@
+import {
+    isFormData,
+    isPDF,
+    isFormUrlEncoded,
+    isText,
+    isXML,
+    isCSV,
+    isGraphQL,
+    isPlainObject,
+} from './contentTypeChecks';
 import { stringifyOpenAPI } from './stringifyOpenAPI';
 
 export interface CodeSampleInput {
@@ -30,14 +40,27 @@ export const codeSampleGenerators: CodeSampleGenerator[] = [
 
             lines.push(`--url '${url}'`);
 
-            if (headers) {
+            if (body) {
+                const bodyContent = BodyGenerators.getCurlBody(body, headers);
+
+                if (bodyContent) {
+                    body = bodyContent.body;
+                    headers = bodyContent.headers;
+                }
+            }
+
+            if (headers && Object.keys(headers).length > 0) {
                 Object.entries(headers).forEach(([key, value]) => {
                     lines.push(`--header '${key}: ${value}'`);
                 });
             }
 
-            if (body && Object.keys(body).length > 0) {
-                lines.push(`--data '${stringifyOpenAPI(body)}'`);
+            if (body) {
+                if (Array.isArray(body)) {
+                    lines.push(...body);
+                } else {
+                    lines.push(body);
+                }
             }
 
             return lines.map((line, index) => (index > 0 ? indent(line, 2) : line)).join(separator);
@@ -50,18 +73,29 @@ export const codeSampleGenerators: CodeSampleGenerator[] = [
         generate: ({ method, url, headers, body }) => {
             let code = '';
 
+            if (body) {
+                const 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('${url}', {
     method: '${method.toUpperCase()}',\n`;
 
-            if (headers) {
+            if (headers && Object.keys(headers).length > 0) {
                 code += indent(`headers: ${stringifyOpenAPI(headers, null, 2)},\n`, 4);
             }
 
             if (body) {
-                code += indent(`body: JSON.stringify(${stringifyOpenAPI(body, null, 2)}),\n`, 4);
+                code += indent(`body: ${body}\n`, 4);
             }
 
-            code += `});\n`;
+            code += `});\n\n`;
             code += `const data = await response.json();`;
 
             return code;
@@ -73,15 +107,34 @@ export const codeSampleGenerators: CodeSampleGenerator[] = [
         syntax: 'python',
         generate: ({ method, url, headers, body }) => {
             let code = 'import requests\n\n';
+
+            if (body) {
+                const 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.${method.toLowerCase()}(\n`;
             code += indent(`"${url}",\n`, 4);
-            if (headers) {
+
+            if (headers && Object.keys(headers).length > 0) {
                 code += indent(`headers=${stringifyOpenAPI(headers)},\n`, 4);
             }
+
             if (body) {
-                code += indent(`json=${stringifyOpenAPI(body)}\n`, 4);
+                if (body === 'files') {
+                    code += indent(`files=${body}\n`, 4);
+                } else {
+                    code += indent(`data=${stringifyOpenAPI(body)}\n`, 4);
+                }
             }
-            code += ')\n';
+
+            code += ')\n\n';
             code += `data = response.json()`;
             return code;
         },
@@ -99,6 +152,12 @@ export const codeSampleGenerators: CodeSampleGenerator[] = [
                 // handle unicode chars with a text encoder
                 const encoder = new TextEncoder();
 
+                const bodyString = BodyGenerators.getHTTPBody(body, headers);
+
+                if (bodyString) {
+                    body = bodyString;
+                }
+
                 headers = {
                     ...headers,
                     'Content-Length': encoder.encode(bodyContent).length.toString(),
@@ -117,7 +176,7 @@ export const codeSampleGenerators: CodeSampleGenerator[] = [
                       .join('\n') + '\n'
                 : '';
 
-            const bodyString = body ? `\n${stringifyOpenAPI(body, null, 2)}` : '';
+            const bodyString = body ? `\n${body}` : '';
 
             const httpRequest = `${method.toUpperCase()} ${decodeURI(path)} HTTP/1.1
 Host: ${host}
@@ -157,3 +216,165 @@ export function parseHostAndPath(url: string) {
         return { host, path };
     }
 }
+
+// Body Generators
+const BodyGenerators = {
+    getCurlBody(body: any, headers?: Record<string, string>) {
+        if (!body || !headers) return undefined;
+
+        // Copy headers to avoid mutating the original object
+        const headersCopy = { ...headers };
+        const contentType: string = headersCopy['Content-Type'] || '';
+
+        if (isFormData(contentType)) {
+            body = isPlainObject(body)
+                ? Object.entries(body).map(([key, value]) => `--form '${key}=${String(value)}'`)
+                : `--form 'file=@${body}'`;
+        } else if (isFormUrlEncoded(contentType)) {
+            body = isPlainObject(body)
+                ? `--data '${Object.entries(body)
+                      .map(([key, value]) => `${key}=${String(value)}`)
+                      .join('&')}'`
+                : String(body);
+        } else if (isText(contentType)) {
+            body = `--data '${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 $'${stringifyOpenAPI(body).replace(/"/g, '')}'`;
+        } else if (isGraphQL(contentType)) {
+            body = `--data '${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 '@${String(body)}'`;
+        } else {
+            body = `--data '${stringifyOpenAPI(body, null, 2)}'`;
+        }
+
+        return {
+            body,
+            headers: headersCopy,
+        };
+    },
+    getJavaScriptBody: (body: any, headers?: Record<string, string>) => {
+        if (!body || !headers) return;
+
+        let code = '';
+
+        // Copy headers to avoid mutating the original object
+        const headersCopy = { ...headers };
+        const contentType: string = 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(([key, value]) => {
+                    code += `formData.append("${key}", "${String(value)}");\n`;
+                });
+            } else if (typeof body === 'string') {
+                code += `formData.append("file", "${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(([key, value]) => {
+                    code += `params.append("${key}", "${String(value)}");\n`;
+                });
+            }
+            code += '\n';
+            body = 'params.toString()';
+        } else if (isGraphQL(contentType)) {
+            if (isPlainObject(body)) {
+                Object.entries(body).forEach(([key, value]) => {
+                    code += `const ${key} = \`\n${indent(String(value), 4)}\`;\n\n`;
+                });
+                body = `JSON.stringify({ ${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${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", "${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(${stringifyOpenAPI(body, null, 2)})`;
+        }
+
+        return { body, code, headers: headersCopy };
+    },
+    getPythonBody: (body: any, headers?: Record<string, string>) => {
+        if (!body || !headers) return;
+        let code = '';
+        const contentType: string = headers['Content-Type'] || '';
+
+        if (isFormData(contentType)) {
+            code += 'files = {\n';
+            if (isPlainObject(body)) {
+                Object.entries(body).forEach(([key, value]) => {
+                    code += indent(`"${key}": "${String(value)}",`, 4) + '\n';
+                });
+            }
+            code += '}\n\n';
+            body = 'files';
+        }
+
+        if (isPDF(contentType)) {
+            code += 'files = {\n';
+            code += indent(`"file": "${body}",`, 4) + '\n';
+            code += '}\n\n';
+            body = 'files';
+        }
+
+        return { body, code, headers };
+    },
+    getHTTPBody: (body: any, headers?: Record<string, string>) => {
+        if (!body || !headers) return undefined;
+
+        const contentType: string = headers['Content-Type'] || '';
+
+        const typeHandlers = {
+            pdf: () => `${stringifyOpenAPI(body, null, 2)}`,
+            formUrlEncoded: () => {
+                const encoded = isPlainObject(body)
+                    ? Object.entries(body)
+                          .map(([key, value]) => `${key}=${String(value)}`)
+                          .join('&')
+                    : String(body);
+                return `"${encoded}"`;
+            },
+            text: () => `"${String(body)}"`,
+            xmlOrCsv: () => `"${stringifyOpenAPI(body).replace(/"/g, '')}"`,
+            default: () => `${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/src/contentTypeChecks.ts

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

package/src/generateSchemaExample.ts

@@ -3,32 +3,40 @@ 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 function generateSchemaExample(
     schema: OpenAPIV3.SchemaObject,
-    options: {
-        onlyRequired?: boolean;
-    } = {},
+    options?: GenerateSchemaExampleOptions,
 ): JSONValue | undefined {
-    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',
+    return getExampleFromSchema(
+        schema,
+        {
+            emptyString: 'text',
+            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',
+            },
+            ...options,
         },
-    });
+        3, // Max depth for circular references
+    );
 }
 
 /**
@@ -36,9 +44,7 @@ export function generateSchemaExample(
  */
 export function generateMediaTypeExample(
     mediaType: OpenAPIV3.MediaTypeObject,
-    options: {
-        onlyRequired?: boolean;
-    } = {},
+    options?: GenerateSchemaExampleOptions,
 ): JSONValue | undefined {
     if (mediaType.example) {
         return mediaType.example;

package/src/json2xml.test.ts

@@ -0,0 +1,46 @@
+import { describe, expect, it } from 'bun:test';
+
+import { json2xml } from './json2xml';
+
+describe('getUrlFromServerState', () => {
+    it('transforms JSON to xml', () => {
+        const xml = json2xml({
+            foo: 'bar',
+        });
+
+        expect(xml).toBe('<?xml version="1.0"?>\n<foo>bar</foo>\n');
+    });
+
+    it('wraps array items', () => {
+        const xml = json2xml({
+            urls: {
+                url: ['https://example.com', 'https://example.com'],
+            },
+        });
+
+        expect(xml).toBe(
+            '<?xml version="1.0"?>\n<urls>\n\t<url>https://example.com</url>\n\t<url>https://example.com</url>\n</urls>\n',
+        );
+    });
+
+    it('indents correctly', () => {
+        const xml = json2xml({
+            id: 10,
+            name: 'doggie',
+            category: {
+                id: 1,
+                name: 'Dogs',
+            },
+            photoUrls: ['string'],
+            tags: [
+                {
+                    id: 0,
+                    name: 'string',
+                },
+            ],
+            status: 'available',
+        });
+
+        expect(xml).toMatchSnapshot();
+    });
+});

package/src/json2xml.ts

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

package/src/resolveOpenAPIOperation.test.ts

@@ -9,7 +9,7 @@ async function fetchFilesystem(url: string) {
     const filesystem = await parseOpenAPI({ value: text, rootURL: url });
     const transformedFs = await traverse(filesystem, async (node) => {
         if ('description' in node && typeof node.description === 'string' && node.description) {
-            node['x-description-html'] = node.description;
+            node['x-gitbook-description-html'] = node.description;
         }
         return node;
     });

package/src/stringifyOpenAPI.ts

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

package/src/types.ts

@@ -5,7 +5,18 @@ import type {
 } from '@gitbook/openapi-parser';
 
 export interface OpenAPIContextProps extends OpenAPIClientContext {
-    CodeBlock: React.ComponentType<{ code: string; syntax: string }>;
+    /**
+     * Render a code block.
+     */
+    renderCodeBlock: (props: { code: string; syntax: string }) => React.ReactNode;
+    /**
+     * Render the heading of the operation.
+     */
+    renderHeading: (props: { deprecated: boolean; title: string }) => React.ReactNode;
+    /**
+     * Render the document of the operation.
+     */
+    renderDocument: (props: { document: object }) => React.ReactNode;
 
     /** Spec url for the Scalar Api Client */
     specUrl: string;

package/src/util/server.test.ts

@@ -0,0 +1,58 @@
+import { describe, it, expect } from 'bun:test';
+import { interpolateServerURL, getDefaultServerURL } from './server';
+import { OpenAPIV3 } from '@gitbook/openapi-parser';
+
+describe('#interpolateServerURL', () => {
+    it('interpolates the server URL with the default values of the variables', () => {
+        const server: OpenAPIV3.ServerObject = {
+            url: 'https://{username}.example.com/{basePath}',
+            variables: {
+                username: { default: 'user' },
+                basePath: { default: 'v1' },
+            },
+        };
+        const result = interpolateServerURL(server);
+        expect(result).toBe('https://user.example.com/v1');
+    });
+
+    it('returns the URL with placeholders if no variables are provided', () => {
+        const server: OpenAPIV3.ServerObject = {
+            url: 'https://{username}.example.com/{basePath}',
+        };
+        const result = interpolateServerURL(server);
+        expect(result).toBe('https://{username}.example.com/{basePath}');
+    });
+
+    it('returns the URL with mixed placeholders and default values', () => {
+        const server: OpenAPIV3.ServerObject = {
+            url: 'https://{username}.example.com/{basePath}',
+            variables: {
+                basePath: { default: 'v1' },
+            },
+        };
+        const result = interpolateServerURL(server);
+        expect(result).toBe('https://{username}.example.com/v1');
+    });
+});
+
+describe('#getDefaultServerURL', () => {
+    it('returns the default server URL', () => {
+        const servers: OpenAPIV3.ServerObject[] = [
+            {
+                url: 'https://{username}.example.com/{basePath}',
+                variables: {
+                    username: { default: 'user' },
+                    basePath: { default: 'v1' },
+                },
+            },
+        ];
+        const result = getDefaultServerURL(servers);
+        expect(result).toBe('https://user.example.com/v1');
+    });
+
+    it('returns empty string if no servers are provided', () => {
+        const servers: OpenAPIV3.ServerObject[] = [];
+        const result = getDefaultServerURL(servers);
+        expect(result).toBe('');
+    });
+});

package/src/util/server.ts

@@ -0,0 +1,48 @@
+import { OpenAPIV3 } from '@gitbook/openapi-parser';
+
+/**
+ * Get the default URL for the server.
+ */
+export function getDefaultServerURL(servers: OpenAPIV3.ServerObject[]): string {
+    const server = servers[0];
+    if (!server) {
+        // Return empty string if no server is found to display nothing
+        return '';
+    }
+
+    return interpolateServerURL(server);
+}
+
+/**
+ * Interpolate the server URL with the default values of the variables.
+ */
+export function interpolateServerURL(server: OpenAPIV3.ServerObject) {
+    const parts = parseServerURL(server?.url ?? '');
+
+    return parts
+        .map((part) => {
+            if (part.kind === 'text') {
+                return part.text;
+            } else {
+                return server.variables?.[part.name]?.default ?? `{${part.name}}`;
+            }
+        })
+        .join('');
+}
+
+function parseServerURL(url: string) {
+    const parts = url.split(/{([^}]+)}/g);
+    const result: Array<{ kind: 'variable'; name: string } | { kind: 'text'; text: string }> = [];
+    for (let i = 0; i < parts.length; i++) {
+        const part = parts[i];
+        if (!part) {
+            continue;
+        }
+        if (i % 2 === 0) {
+            result.push({ kind: 'text', text: part });
+        } else {
+            result.push({ kind: 'variable', name: part });
+        }
+    }
+    return result;
+}