@gitbook/react-openapi 1.0.2 → 1.0.3

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @gitbook/react-openapi
 
+## 1.0.3
+
+### Patch Changes
+
+-   dc2dbc5: Update OpenAPI code examples to support multiple content-type
+-   f1d1d2f: Return empty string if no server provided
+-   05e1d8c: Hide x-gitbook-\* symbols in OpenAPI blocks
+-   b4a12d6: Fix circularRef in schema + examples OpenAPI
+-   9f0de74: Fix ID not set when there is no operation summary
+-   da55fac: Render GitBook blocks in OpenAPI operation description
+-   Updated dependencies [c808bb1]
+-   Updated dependencies [e24206e]
+-   Updated dependencies [a054554]
+-   Updated dependencies [da55fac]
+    -   @gitbook/openapi-parser@2.0.0
+
 ## 1.0.2
 
 ### Patch Changes

package/dist/OpenAPICodeSample.jsx

@@ -12,11 +12,11 @@ var __assign = (this && this.__assign) || function () {
 import { codeSampleGenerators } from './code-samples';
 import { generateMediaTypeExample, generateSchemaExample } from './generateSchemaExample';
 import { InteractiveSection } from './InteractiveSection';
-import { getServersURL } from './OpenAPIServerURL';
 import { createStateKey } from './utils';
 import { stringifyOpenAPI } from './stringifyOpenAPI';
 import { OpenAPITabs, OpenAPITabsList, OpenAPITabsPanels } from './OpenAPITabs';
 import { checkIsReference } from './utils';
+import { getDefaultServerURL } from './util/server';
 /**
  * Display code samples to execute the operation.
  * It supports the Redocly custom syntax as well (https://redocly.com/docs/api-reference-docs/specification-extensions/x-code-samples/)
@@ -52,15 +52,11 @@ export function OpenAPICodeSample(props) {
         : undefined;
     var requestBodyContent = requestBodyContentEntries === null || requestBodyContentEntries === void 0 ? void 0 : requestBodyContentEntries[0];
     var input = {
-        url: getServersURL(data.servers) +
+        url: getDefaultServerURL(data.servers) +
             data.path +
             (searchParams.size ? "?".concat(searchParams.toString()) : ''),
         method: data.method,
-        body: requestBodyContent
-            ? generateMediaTypeExample(requestBodyContent[1], {
-                omitEmptyAndOptionalProperties: true,
-            })
-            : undefined,
+        body: requestBodyContent ? generateMediaTypeExample(requestBodyContent[1]) : undefined,
         headers: __assign(__assign(__assign({}, getSecurityHeaders(data.securities)), headersObject), (requestBodyContent
             ? {
                 'Content-Type': requestBodyContent[0],
@@ -70,7 +66,10 @@ export function OpenAPICodeSample(props) {
     var autoCodeSamples = codeSampleGenerators.map(function (generator) { return ({
         key: "default-".concat(generator.id),
         label: generator.label,
-        body: <context.CodeBlock code={generator.generate(input)} syntax={generator.syntax}/>,
+        body: context.renderCodeBlock({
+            code: generator.generate(input),
+            syntax: generator.syntax,
+        }),
     }); });
     // Use custom samples if defined
     var customCodeSamples = null;
@@ -86,7 +85,10 @@ export function OpenAPICodeSample(props) {
                 .map(function (sample) { return ({
                 key: "redocly-".concat(sample.lang),
                 label: sample.label,
-                body: <context.CodeBlock code={sample.source} syntax={sample.lang}/>,
+                body: context.renderCodeBlock({
+                    code: sample.source,
+                    syntax: sample.lang,
+                }),
             }); });
         }
     });

package/dist/OpenAPIOperation.jsx

@@ -17,9 +17,8 @@ export function OpenAPIOperation(props) {
         icons: context.icons,
         blockKey: context.blockKey,
     };
-    var description = resolveDescription(operation);
     return (<div className={clsx('openapi-operation', className)}>
-            <div className="openapi-summary">
+            <div className="openapi-summary" id={operation.summary ? undefined : context.id}>
                 {operation.summary
             ? context.renderHeading({
                 deprecated: (_a = operation.deprecated) !== null && _a !== void 0 ? _a : false,
@@ -37,9 +36,7 @@ export function OpenAPIOperation(props) {
                             </span>
                             {"."}
                         </div>) : null}
-                    {description ? (<div className="openapi-intro">
-                            <Markdown className="openapi-description" source={description}/>
-                        </div>) : null}
+                    <OpenAPIOperationDescription operation={operation} context={context}/>
                     <OpenAPIPath data={data} context={context}/>
                     <OpenAPISpec data={data} context={clientContext}/>
                 </div>
@@ -52,3 +49,20 @@ export function OpenAPIOperation(props) {
             </div>
         </div>);
 }
+function OpenAPIOperationDescription(props) {
+    var operation = props.operation;
+    if (operation['x-gitbook-description-document']) {
+        return (<div className="openapi-intro">
+                {props.context.renderDocument({
+                document: operation['x-gitbook-description-document'],
+            })}
+            </div>);
+    }
+    var description = resolveDescription(operation);
+    if (!description) {
+        return null;
+    }
+    return (<div className="openapi-intro">
+            <Markdown className="openapi-description" source={description}/>
+        </div>);
+}

package/dist/OpenAPIResponseExample.jsx

@@ -3,6 +3,7 @@ import { checkIsReference, createStateKey, resolveDescription } from './utils';
 import { OpenAPITabs, OpenAPITabsList, OpenAPITabsPanels } from './OpenAPITabs';
 import { InteractiveSection } from './InteractiveSection';
 import { json2xml } from './json2xml';
+import { stringifyOpenAPI } from './stringifyOpenAPI';
 /**
  * Display an example of the response content.
  */
@@ -128,7 +129,7 @@ function OpenAPIExample(props) {
     if (code === null) {
         return <OpenAPIEmptyResponseExample />;
     }
-    return <context.CodeBlock code={code} syntax={syntax}/>;
+    return context.renderCodeBlock({ code: code, syntax: syntax });
 }
 function stringifyExample(args) {
     var example = args.example, xml = args.xml;
@@ -141,7 +142,7 @@ function stringifyExample(args) {
     if (xml) {
         return json2xml(example.value);
     }
-    return JSON.stringify(example.value, null, 2);
+    return stringifyOpenAPI(example.value, null, 2);
 }
 /**
  * Get the syntax from a media type.

package/dist/OpenAPISchema.jsx

@@ -29,18 +29,20 @@ export function OpenAPISchemaProperty(props) {
     var alternatives = parentCircularRef
         ? null
         : getSchemaAlternatives(schema, new Set(circularRefs.keys()));
-    if ((properties && properties.length > 0) || schema.type === 'object') {
+    if ((_a = alternatives === null || alternatives === void 0 ? void 0 : alternatives[0]) === null || _a === void 0 ? void 0 : _a.length) {
         return (<InteractiveSection id={id} className={clsx('openapi-schema', className)}>
                 <OpenAPISchemaPresentation {...props}/>
-                {properties && properties.length > 0 ? (<OpenAPIDisclosure context={context}>
-                        <OpenAPISchemaProperties properties={properties} circularRefs={circularRefs} context={context}/>
-                    </OpenAPIDisclosure>) : null}
+                {alternatives[0].map(function (alternative, index) { return (<OpenAPISchemaAlternative key={"alternative-".concat(index)} schema={alternative} circularRefs={circularRefs} context={context}/>); })}
+                {parentCircularRef ? (<OpenAPISchemaCircularRef id={parentCircularRef} schema={schema}/>) : null}
             </InteractiveSection>);
     }
-    if ((_a = alternatives === null || alternatives === void 0 ? void 0 : alternatives[0]) === null || _a === void 0 ? void 0 : _a.length) {
+    if ((properties && properties.length > 0) || schema.type === 'object') {
         return (<InteractiveSection id={id} className={clsx('openapi-schema', className)}>
                 <OpenAPISchemaPresentation {...props}/>
-                {alternatives[0].map(function (alternative, index) { return (<OpenAPISchemaAlternative key={"alternative-".concat(index)} schema={alternative} circularRefs={circularRefs} context={context}/>); })}
+                {properties && properties.length > 0 ? (<OpenAPIDisclosure context={context} label={getDisclosureLabel(schema)}>
+                        <OpenAPISchemaProperties properties={properties} circularRefs={circularRefs} context={context}/>
+                    </OpenAPIDisclosure>) : null}
+                {parentCircularRef ? (<OpenAPISchemaCircularRef id={parentCircularRef} schema={schema}/>) : null}
             </InteractiveSection>);
     }
     return (<InteractiveSection id={id} className={clsx('openapi-schema', className)}>
@@ -86,9 +88,13 @@ function OpenAPISchemaAlternative(props) {
     var schema = props.schema, circularRefs = props.circularRefs, context = props.context;
     var id = useId();
     var subProperties = getSchemaProperties(schema);
-    return (<OpenAPIDisclosure context={context}>
-            <OpenAPISchemaProperties id={id} properties={subProperties !== null && subProperties !== void 0 ? subProperties : [{ schema: schema }]} circularRefs={subProperties ? new Map(circularRefs).set(schema, id) : circularRefs} context={context}/>
-        </OpenAPIDisclosure>);
+    var description = resolveDescription(schema);
+    return (<>
+            {description ? (<Markdown source={description} className="openapi-schema-description"/>) : null}
+            <OpenAPIDisclosure context={context} label={getDisclosureLabel(schema)}>
+                <OpenAPISchemaProperties id={id} properties={subProperties !== null && subProperties !== void 0 ? subProperties : [{ schema: schema }]} circularRefs={subProperties ? new Map(circularRefs).set(schema, id) : circularRefs} context={context}/>
+            </OpenAPIDisclosure>
+        </>);
 }
 /**
  * Render a circular reference to a schema.
@@ -118,7 +124,7 @@ export function OpenAPISchemaEnum(props) {
 export function OpenAPISchemaPresentation(props) {
     var schema = props.schema, propertyName = props.propertyName, required = props.required;
     var shouldDisplayExample = function (schema) {
-        return (typeof schema.example === 'string' ||
+        return ((typeof schema.example === 'string' && !!schema.example) ||
             typeof schema.example === 'number' ||
             typeof schema.example === 'boolean' ||
             (Array.isArray(schema.example) && schema.example.length > 0) ||
@@ -128,7 +134,7 @@ export function OpenAPISchemaPresentation(props) {
     };
     var description = resolveDescription(schema);
     return (<div className="openapi-schema-presentation">
-            <OpenAPISchemaName type={getSchemaTitle(schema)} propertyName={propertyName} required={required} deprecated={schema.deprecated}/>
+            <OpenAPISchemaName schema={schema} type={getSchemaTitle(schema)} propertyName={propertyName} required={required}/>
             {schema['x-deprecated-sunset'] ? (<div className="openapi-deprecated-sunset openapi-schema-description openapi-markdown">
                     Sunset date:{' '}
                     <span className="openapi-deprecated-sunset-date">
@@ -137,12 +143,7 @@ export function OpenAPISchemaPresentation(props) {
                 </div>) : null}
             {description ? (<Markdown source={description} className="openapi-schema-description"/>) : null}
             {shouldDisplayExample(schema) ? (<div className="openapi-schema-example">
-                    Example:{' '}
-                    <code>
-                        {typeof schema.example === 'string'
-                ? schema.example
-                : stringifyOpenAPI(schema.example)}
-                    </code>
+                    Example: <code>{formatExample(schema.example)}</code>
                 </div>) : null}
             {schema.pattern ? (<div className="openapi-schema-pattern">
                     Pattern: <code>{schema.pattern}</code>
@@ -154,17 +155,6 @@ export function OpenAPISchemaPresentation(props) {
  * Get the sub-properties of a schema.
  */
 function getSchemaProperties(schema) {
-    if (schema.allOf) {
-        return schema.allOf.reduce(function (acc, subSchema) {
-            var _a;
-            var properties = (_a = getSchemaProperties(subSchema)) !== null && _a !== void 0 ? _a : [
-                {
-                    schema: subSchema,
-                },
-            ];
-            return __spreadArray(__spreadArray([], acc, true), properties, true);
-        }, []);
-    }
     // check array AND schema.items as this is sometimes null despite what the type indicates
     if (schema.type === 'array' && !!schema.items) {
         var items = schema.items;
@@ -172,6 +162,10 @@ function getSchemaProperties(schema) {
         if (itemProperties) {
             return itemProperties;
         }
+        // If the items are a primitive type, we don't need to display them
+        if (['string', 'number', 'boolean', 'integer'].includes(items.type) && !items.enum) {
+            return null;
+        }
         return [
             {
                 propertyName: 'items',
@@ -217,8 +211,7 @@ export function getSchemaAlternatives(schema, ancestors) {
         return [flattenAlternatives('oneOf', schema.oneOf, downAncestors), schema.discriminator];
     }
     if (schema.allOf) {
-        // allOf is managed in `getSchemaProperties`
-        return null;
+        return [flattenAlternatives('allOf', schema.allOf, downAncestors), schema.discriminator];
     }
     return null;
 }
@@ -235,10 +228,6 @@ export function getSchemaTitle(schema,
 /** If the title is inferred in a oneOf with discriminator, we can use it to optimize the title */
 discriminator) {
     var _a;
-    if (schema.title) {
-        // If the schema has a title, use it
-        return schema.title;
-    }
     // Try using the discriminator
     if ((discriminator === null || discriminator === void 0 ? void 0 : discriminator.propertyName) && schema.properties) {
         var discriminatorProperty = schema.properties[discriminator.propertyName];
@@ -278,17 +267,30 @@ discriminator) {
     else if ('not' in schema) {
         type = 'not';
     }
-    if (schema.minimum || schema.minLength) {
-        type += " \u00B7 min: ".concat(schema.minimum || schema.minLength);
-    }
-    if (schema.maximum || schema.maxLength) {
-        type += " \u00B7 max: ".concat(schema.maximum || schema.maxLength);
-    }
-    if (schema.default) {
-        type += " \u00B7 default: ".concat(schema.default);
+    return type;
+}
+function getDisclosureLabel(schema) {
+    var _a, _b;
+    if (schema.type === 'array' && !!schema.items) {
+        if (schema.items.oneOf) {
+            return 'available items';
+        }
+        // Fallback to "child attributes" for enums and objects
+        if (schema.items.enum || schema.items.type === 'object') {
+            return;
+        }
+        return (_b = (_a = schema.items.title) !== null && _a !== void 0 ? _a : schema.title) !== null && _b !== void 0 ? _b : getSchemaTitle(schema.items);
     }
-    if (schema.nullable) {
-        type = "".concat(type, " | nullable");
+    return schema.title;
+}
+function formatExample(example) {
+    if (typeof example === 'string') {
+        return example
+            .replace(/\n/g, ' ') // Replace newlines with spaces
+            .replace(/\s+/g, ' ') // Collapse multiple spaces/newlines into a single space
+            .replace(/([\{\}:,])\s+/g, '$1 ') // Ensure a space after {, }, :, and ,
+            .replace(/\s+([\{\}:,])/g, ' $1') // Ensure a space before {, }, :, and ,
+            .trim();
     }
-    return type;
+    return stringifyOpenAPI(example);
 }

package/dist/OpenAPISchemaName.d.ts

@@ -1,8 +1,9 @@
+import { OpenAPIV3 } from '@gitbook/openapi-parser';
 interface OpenAPISchemaNameProps {
+    schema?: OpenAPIV3.SchemaObject;
     propertyName?: string | JSX.Element;
     required?: boolean;
     type?: string;
-    deprecated?: boolean;
 }
 /**
  * Display the schema name row.

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/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]);