@gitbook/react-openapi 1.1.9 → 1.2.0

package/src/OpenAPIResponseExample.tsx

@@ -1,19 +1,20 @@
 import type { OpenAPIV3 } from '@gitbook/openapi-parser';
 import { Markdown } from './Markdown';
-import { OpenAPITabs, OpenAPITabsList, OpenAPITabsPanels } from './OpenAPITabs';
-import { StaticSection } from './StaticSection';
-import { generateSchemaExample } from './generateSchemaExample';
-import { json2xml } from './json2xml';
-import { stringifyOpenAPI } from './stringifyOpenAPI';
-import type { OpenAPIContextProps, OpenAPIOperationData } from './types';
-import { checkIsReference, createStateKey, resolveDescription } from './utils';
+import { OpenAPIEmptyExample, OpenAPIExample } from './OpenAPIExample';
+import { OpenAPIMediaTypeContent } from './OpenAPIMediaType';
+import { OpenAPIResponseExampleContent } from './OpenAPIResponseExampleContent';
+import { type OpenAPIContext, getOpenAPIClientContext } from './context';
+import type { OpenAPIOperationData, OpenAPIWebhookData } from './types';
+import { getExampleFromReference, getExamples } from './util/example';
+import { createStateKey, getStatusCodeDefaultLabel } from './utils';
+import { checkIsReference, resolveDescription } from './utils';
 
 /**
  * Display an example of the response content.
  */
 export function OpenAPIResponseExample(props: {
-    data: OpenAPIOperationData;
-    context: OpenAPIContextProps;
+    data: OpenAPIOperationData | OpenAPIWebhookData;
+    context: OpenAPIContext;
 }) {
     const { data, context } = props;
 
@@ -42,36 +43,41 @@ export function OpenAPIResponseExample(props: {
 
     const tabs = responses.map(([key, responseObject]) => {
         const description = resolveDescription(responseObject);
+        const label = description ? (
+            <Markdown source={description} />
+        ) : (
+            getStatusCodeDefaultLabel(key, context)
+        );
 
         if (checkIsReference(responseObject)) {
             return {
                 key: key,
-                label: key,
+                label,
+                statusCode: key,
                 body: (
                     <OpenAPIExample
-                        example={getExampleFromReference(responseObject)}
+                        example={getExampleFromReference(responseObject, context)}
                         context={context}
                         syntax="json"
                     />
                 ),
-                footer: description ? <Markdown source={description} /> : undefined,
             };
         }
 
         if (!responseObject.content || Object.keys(responseObject.content).length === 0) {
             return {
                 key: key,
-                label: key,
-                body: <OpenAPIEmptyResponseExample />,
-                footer: description ? <Markdown source={description} /> : undefined,
+                label,
+                statusCode: key,
+                body: <OpenAPIEmptyExample context={context} />,
             };
         }
 
         return {
             key: key,
-            label: key,
+            label,
+            statusCode: key,
             body: <OpenAPIResponse context={context} content={responseObject.content} />,
-            footer: description ? <Markdown source={description} /> : undefined,
         };
     });
 
@@ -80,16 +86,16 @@ export function OpenAPIResponseExample(props: {
     }
 
     return (
-        <OpenAPITabs stateKey={createStateKey('response-example')} items={tabs}>
-            <StaticSection header={<OpenAPITabsList />} className="openapi-response-example">
-                <OpenAPITabsPanels />
-            </StaticSection>
-        </OpenAPITabs>
+        <OpenAPIResponseExampleContent
+            selectIcon={context.icons.chevronDown}
+            blockKey={context.blockKey}
+            items={tabs}
+        />
     );
 }
 
 function OpenAPIResponse(props: {
-    context: OpenAPIContextProps;
+    context: OpenAPIContext;
     content: {
         [media: string]: OpenAPIV3.MediaTypeObject;
     };
@@ -103,206 +109,26 @@ function OpenAPIResponse(props: {
         throw new Error('One media type is required');
     }
 
-    if (entries.length === 1) {
-        const [mediaType, mediaTypeObject] = firstEntry;
-        return (
-            <OpenAPIResponseMediaType
-                context={context}
-                mediaType={mediaType}
-                mediaTypeObject={mediaTypeObject}
-            />
-        );
-    }
-
     const tabs = entries.map((entry) => {
         const [mediaType, mediaTypeObject] = entry;
         return {
             key: mediaType,
             label: mediaType,
-            body: (
-                <OpenAPIResponseMediaType
-                    context={context}
-                    mediaType={mediaType}
-                    mediaTypeObject={mediaTypeObject}
-                />
-            ),
-        };
-    });
-
-    return (
-        <OpenAPITabs stateKey={createStateKey('response-media-types')} items={tabs}>
-            <StaticSection header={<OpenAPITabsList />} className="openapi-response-media-types">
-                <OpenAPITabsPanels />
-            </StaticSection>
-        </OpenAPITabs>
-    );
-}
-
-function OpenAPIResponseMediaType(props: {
-    mediaTypeObject: OpenAPIV3.MediaTypeObject;
-    mediaType: string;
-    context: OpenAPIContextProps;
-}) {
-    const { mediaTypeObject, mediaType } = props;
-    const examples = getExamplesFromMediaTypeObject({ mediaTypeObject, mediaType });
-    const syntax = getSyntaxFromMediaType(mediaType);
-    const firstExample = examples[0];
-
-    if (!firstExample) {
-        return <OpenAPIEmptyResponseExample />;
-    }
-
-    if (examples.length === 1) {
-        return (
-            <OpenAPIExample
-                example={firstExample.example}
-                context={props.context}
-                syntax={syntax}
-            />
-        );
-    }
-
-    const tabs = examples.map((example) => {
-        return {
-            key: example.key,
-            label: example.example.summary || example.key,
-            body: (
-                <OpenAPIExample example={example.example} context={props.context} syntax={syntax} />
-            ),
+            body: <></>,
+            examples: getExamples({
+                mediaTypeObject,
+                mediaType,
+                context,
+            }),
         };
     });
 
     return (
-        <OpenAPITabs stateKey={createStateKey('response-media-type-examples')} items={tabs}>
-            <StaticSection
-                header={<OpenAPITabsList />}
-                className="openapi-response-media-type-examples"
-            >
-                <OpenAPITabsPanels />
-            </StaticSection>
-        </OpenAPITabs>
+        <OpenAPIMediaTypeContent
+            selectIcon={context.icons.chevronDown}
+            stateKey={createStateKey('response-media-types', context.blockKey)}
+            items={tabs}
+            context={getOpenAPIClientContext(context)}
+        />
     );
 }
-
-/**
- * Display an example.
- */
-function OpenAPIExample(props: {
-    example: OpenAPIV3.ExampleObject;
-    context: OpenAPIContextProps;
-    syntax: string;
-}) {
-    const { example, context, syntax } = props;
-    const code = stringifyExample({ example, xml: syntax === 'xml' });
-
-    if (code === null) {
-        return <OpenAPIEmptyResponseExample />;
-    }
-
-    return context.renderCodeBlock({ code, syntax });
-}
-
-function stringifyExample(args: { example: OpenAPIV3.ExampleObject; xml: boolean }): string | null {
-    const { example, xml } = args;
-
-    if (!example.value) {
-        return null;
-    }
-
-    if (typeof example.value === 'string') {
-        return example.value;
-    }
-
-    if (xml) {
-        return json2xml(example.value);
-    }
-
-    return stringifyOpenAPI(example.value, null, 2);
-}
-
-/**
- * Get the syntax from a media type.
- */
-function getSyntaxFromMediaType(mediaType: string): string {
-    if (mediaType.includes('json')) {
-        return 'json';
-    }
-
-    if (mediaType === 'application/xml') {
-        return 'xml';
-    }
-
-    return 'text';
-}
-
-/**
- * Get examples from a media type object.
- */
-function getExamplesFromMediaTypeObject(args: {
-    mediaType: string;
-    mediaTypeObject: OpenAPIV3.MediaTypeObject;
-}): { key: string; example: OpenAPIV3.ExampleObject }[] {
-    const { mediaTypeObject, mediaType } = args;
-    if (mediaTypeObject.examples) {
-        return Object.entries(mediaTypeObject.examples).map(([key, example]) => {
-            return {
-                key,
-                example: checkIsReference(example) ? getExampleFromReference(example) : example,
-            };
-        });
-    }
-
-    if (mediaTypeObject.example) {
-        return [{ key: 'default', example: { value: mediaTypeObject.example } }];
-    }
-
-    if (mediaTypeObject.schema) {
-        if (mediaType === 'application/xml') {
-            // @TODO normally we should use the name of the schema but we don't have it
-            // fix it when we got the reference name
-            const root = mediaTypeObject.schema.xml?.name ?? 'object';
-            return [
-                {
-                    key: 'default',
-                    example: {
-                        value: {
-                            [root]: generateSchemaExample(mediaTypeObject.schema, {
-                                xml: mediaType === 'application/xml',
-                                mode: 'read',
-                            }),
-                        },
-                    },
-                },
-            ];
-        }
-        return [
-            {
-                key: 'default',
-                example: {
-                    value: generateSchemaExample(mediaTypeObject.schema, {
-                        mode: 'read',
-                    }),
-                },
-            },
-        ];
-    }
-    return [];
-}
-
-/**
- * Empty response example.
- */
-function OpenAPIEmptyResponseExample() {
-    return (
-        <pre className="openapi-response-example-empty">
-            <p>No body</p>
-        </pre>
-    );
-}
-
-/**
- * Generate an example from a reference object.
- */
-function getExampleFromReference(ref: OpenAPIV3.ReferenceObject): OpenAPIV3.ExampleObject {
-    return { summary: 'Unresolved reference', value: { $ref: ref.$ref } };
-}

package/src/OpenAPIResponseExampleContent.tsx

@@ -0,0 +1,123 @@
+'use client';
+
+import clsx from 'clsx';
+import type { Key } from 'react-aria';
+import { OpenAPISelect, OpenAPISelectItem, useSelectState } from './OpenAPISelect';
+import { StaticSection } from './StaticSection';
+import { createStateKey, getStatusCodeClassName } from './utils';
+
+type OpenAPIResponseExampleItem = OpenAPISelectItem & {
+    statusCode: string;
+    body: React.ReactNode;
+};
+
+/**
+ * Get the state of the response examples select.
+ */
+export function useResponseExamplesState(
+    blockKey: string | undefined,
+    initialKey: Key = 'default'
+) {
+    return useSelectState(getResponseExampleStateKey(blockKey), initialKey);
+}
+
+export function OpenAPIResponseExampleContent(props: {
+    items: OpenAPIResponseExampleItem[];
+    blockKey?: string;
+    selectIcon?: React.ReactNode;
+}) {
+    const { blockKey, items, selectIcon } = props;
+
+    return (
+        <StaticSection
+            header={
+                <OpenAPIResponseExampleHeader
+                    selectIcon={selectIcon}
+                    blockKey={blockKey}
+                    items={items}
+                />
+            }
+            className="openapi-response-examples"
+        >
+            <OpenAPIResponseExampleBody blockKey={blockKey} items={items} />
+        </StaticSection>
+    );
+}
+
+function OpenAPIResponseExampleHeader(props: {
+    items: OpenAPIResponseExampleItem[];
+    blockKey?: string;
+    selectIcon?: React.ReactNode;
+}) {
+    const { items, blockKey, selectIcon } = props;
+
+    if (items.length === 1) {
+        const item = items[0];
+
+        if (!item) {
+            return null;
+        }
+
+        return (
+            <span className="openapi-response-examples-statuscode-title">
+                <span
+                    className={clsx(
+                        'openapi-statuscode',
+                        `openapi-statuscode-${getStatusCodeClassName(item.statusCode)}`,
+                        'openapi-response-examples-statuscode'
+                    )}
+                >
+                    {item.statusCode}
+                </span>
+                <span>{item.label}</span>
+            </span>
+        );
+    }
+
+    return (
+        <OpenAPISelect
+            items={items}
+            icon={selectIcon}
+            stateKey={getResponseExampleStateKey(blockKey)}
+            placement="bottom start"
+        >
+            {items.map((item) => (
+                <OpenAPISelectItem key={item.key} id={item.key} value={item}>
+                    <span
+                        className={clsx(
+                            'openapi-statuscode',
+                            `openapi-statuscode-${getStatusCodeClassName(item.statusCode)}`,
+                            'openapi-response-examples-statuscode'
+                        )}
+                    >
+                        {item.statusCode}
+                    </span>
+                    <span>{item.label}</span>
+                </OpenAPISelectItem>
+            ))}
+        </OpenAPISelect>
+    );
+}
+
+function OpenAPIResponseExampleBody(props: {
+    items: OpenAPIResponseExampleItem[];
+    blockKey?: string;
+}) {
+    const { blockKey, items } = props;
+    const state = useResponseExamplesState(blockKey, items[0]?.key);
+
+    const selectedItem = items.find((item) => item.key === state.key) ?? items[0];
+
+    if (!selectedItem) {
+        return null;
+    }
+
+    return <div className="openapi-response-examples-panel">{selectedItem.body}</div>;
+}
+
+/**
+ * Return the state key for the response examples.
+ */
+function getResponseExampleStateKey(blockKey: string | undefined) {
+    return createStateKey('openapi-responses', blockKey);
+}

package/src/OpenAPIResponses.tsx

@@ -1,9 +1,15 @@
+'use client';
+
 import type { OpenAPIV3, OpenAPIV3_1 } from '@gitbook/openapi-parser';
+import clsx from 'clsx';
 import { Markdown } from './Markdown';
 import { OpenAPIDisclosureGroup } from './OpenAPIDisclosureGroup';
 import { OpenAPIResponse } from './OpenAPIResponse';
+import { useResponseExamplesState } from './OpenAPIResponseExampleContent';
 import { StaticSection } from './StaticSection';
-import type { OpenAPIClientContext } from './types';
+import type { OpenAPIClientContext } from './context';
+import { t } from './translate';
+import { createStateKey, getStatusCodeClassName, getStatusCodeDefaultLabel } from './utils';
 
 /**
  * Display an interactive response body.
@@ -14,70 +20,85 @@ export function OpenAPIResponses(props: {
 }) {
     const { responses, context } = props;
 
-    return (
-        <StaticSection header="Responses" className="openapi-responses">
-            <OpenAPIDisclosureGroup
-                allowsMultipleExpanded
-                icon={context.icons.chevronRight}
-                groups={Object.entries(responses).map(
-                    ([statusCode, response]: [string, OpenAPIV3.ResponseObject]) => {
-                        const tabs = (() => {
-                            // If there is no content, but there are headers, we need to show the headers
-                            if (
-                                (!response.content || !Object.keys(response.content).length) &&
-                                response.headers &&
-                                Object.keys(response.headers).length
-                            ) {
-                                return [
-                                    {
-                                        id: 'default',
-                                        body: (
-                                            <OpenAPIResponse
-                                                response={response}
-                                                mediaType={{}}
-                                                context={context}
-                                            />
-                                        ),
-                                    },
-                                ];
-                            }
+    const groups = Object.entries(responses).map(
+        ([statusCode, response]: [string, OpenAPIV3.ResponseObject]) => {
+            const tabs = (() => {
+                // If there is no content, but there are headers, we need to show the headers
+                if (
+                    (!response.content || !Object.keys(response.content).length) &&
+                    response.headers &&
+                    Object.keys(response.headers).length
+                ) {
+                    return [
+                        {
+                            key: 'default',
+                            label: '',
+                            body: (
+                                <OpenAPIResponse
+                                    response={response}
+                                    mediaType={{}}
+                                    context={context}
+                                />
+                            ),
+                        },
+                    ];
+                }
 
-                            return Object.entries(response.content ?? {}).map(
-                                ([contentType, mediaType]) => ({
-                                    id: contentType,
-                                    label: contentType,
-                                    body: (
-                                        <OpenAPIResponse
-                                            response={response}
-                                            mediaType={mediaType}
-                                            context={context}
-                                        />
-                                    ),
-                                })
-                            );
-                        })();
+                return Object.entries(response.content ?? {}).map(([contentType, mediaType]) => ({
+                    key: contentType,
+                    label: contentType,
+                    body: (
+                        <OpenAPIResponse
+                            response={response}
+                            mediaType={mediaType}
+                            context={context}
+                        />
+                    ),
+                }));
+            })();
 
-                        const description = response.description;
+            const description = response.description;
 
-                        return {
-                            id: statusCode,
-                            label: (
-                                <div className="openapi-response-tab-content">
-                                    <span className="openapi-response-statuscode">
-                                        {statusCode}
-                                    </span>
-                                    {description ? (
-                                        <Markdown
-                                            source={description}
-                                            className="openapi-response-description"
-                                        />
-                                    ) : null}
-                                </div>
-                            ),
-                            tabs,
-                        };
-                    }
-                )}
+            return {
+                key: statusCode,
+                label: (
+                    <div className="openapi-response-tab-content">
+                        <span
+                            className={clsx(
+                                'openapi-statuscode',
+                                `openapi-statuscode-${getStatusCodeClassName(statusCode)}`
+                            )}
+                        >
+                            {statusCode}
+                        </span>
+                        {description ? (
+                            <Markdown
+                                source={description}
+                                className="openapi-response-description"
+                            />
+                        ) : (
+                            getStatusCodeDefaultLabel(statusCode, context)
+                        )}
+                    </div>
+                ),
+                tabs,
+            };
+        }
+    );
+
+    const state = useResponseExamplesState(context.blockKey, groups[0]?.key);
+
+    return (
+        <StaticSection header={t(context.translation, 'responses')} className="openapi-responses">
+            <OpenAPIDisclosureGroup
+                icon={context.icons.chevronRight}
+                expandedKeys={state.key ? new Set([state.key]) : new Set()}
+                onExpandedChange={(keys) => {
+                    const key = keys.values().next().value ?? null;
+                    state.setKey(key);
+                }}
+                groups={groups}
+                selectStateKey={createStateKey('response-media-types', context.blockKey)}
             />
         </StaticSection>
     );