@gitbook/react-openapi 1.0.5 → 1.1.1

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @gitbook/react-openapi
 
+## 1.1.1
+
+### Patch Changes
+
+-   f574858: Fix OpenAPI example display error
+
+## 1.1.0
+
+### Minor Changes
+
+-   bb3ca9c: Implement OpenAPI models blocks
+
+### Patch Changes
+
+-   0278a14: Upgrade Scalar dependencies
+-   3173d8e: Remove top level circular refs in alternatives
+-   Updated dependencies [0278a14]
+-   Updated dependencies [bb3ca9c]
+-   Updated dependencies [052e07a]
+    -   @gitbook/openapi-parser@2.1.0
+
 ## 1.0.5
 
 ### Patch Changes

package/dist/OpenAPIDisclosure.d.ts

@@ -1,13 +1,9 @@
-import type React from 'react';
 import type { OpenAPIClientContext } from './types';
-interface Props {
-    context: OpenAPIClientContext;
-    children: React.ReactNode;
-    label?: string;
-}
 /**
  * Display an interactive OpenAPI disclosure.
- * The label is optional and defaults to "child attributes".
  */
-export declare function OpenAPIDisclosure({ context, children, label }: Props): React.JSX.Element;
-export {};
+export declare function OpenAPIDisclosure(props: {
+    context: OpenAPIClientContext;
+    children: React.ReactNode;
+    label: string;
+}): React.JSX.Element;

package/dist/OpenAPIDisclosure.jsx

@@ -1,33 +1,30 @@
 'use client';
-import { useRef } from 'react';
-import { mergeProps, useButton, useDisclosure, useFocusRing } from 'react-aria';
-import { useDisclosureState } from 'react-stately';
+import { useState } from 'react';
+import { Button, Disclosure, DisclosurePanel, Heading } from 'react-aria-components';
 /**
  * Display an interactive OpenAPI disclosure.
- * The label is optional and defaults to "child attributes".
  */
-export function OpenAPIDisclosure(_a) {
-    var context = _a.context, children = _a.children, label = _a.label;
-    var state = useDisclosureState({});
-    var panelRef = useRef(null);
-    var triggerRef = useRef(null);
-    var _b = useDisclosure({}, state, panelRef), triggerProps = _b.buttonProps, panelProps = _b.panelProps;
-    var buttonProps = useButton(triggerProps, triggerRef).buttonProps;
-    var _c = useFocusRing(), isFocusVisible = _c.isFocusVisible, focusProps = _c.focusProps;
-    return (<div className="openapi-disclosure">
-            <button ref={triggerRef} {...mergeProps(buttonProps, focusProps)} slot="trigger" className="openapi-disclosure-trigger" style={{
-            outline: isFocusVisible
-                ? '2px solid rgb(var(--primary-color-500) / 0.4)'
-                : 'none',
+export function OpenAPIDisclosure(props) {
+    var context = props.context, children = props.children, label = props.label;
+    var _a = useState(false), isExpanded = _a[0], setIsExpanded = _a[1];
+    return (<Disclosure className="openapi-disclosure" isExpanded={isExpanded} onExpandedChange={setIsExpanded}>
+            <Heading>
+                <Button slot="trigger" className="openapi-disclosure-trigger" style={function (_a) {
+            var isFocusVisible = _a.isFocusVisible;
+            return ({
+                outline: isFocusVisible
+                    ? '2px solid rgb(var(--primary-color-500) / 0.4)'
+                    : 'none',
+            });
         }}>
-                {context.icons.plus}
-                <span>
-                    {"".concat(state.isExpanded ? 'Hide' : 'Show', " ").concat(label ? label : 'child attributes')}
-                </span>
-            </button>
-
-            {state.isExpanded && (<div ref={panelRef} {...panelProps} className="openapi-disclosure-panel">
-                    {children}
-                </div>)}
-        </div>);
+                    {context.icons.plus}
+                    <span>
+                        {isExpanded ? 'Hide' : 'Show'} {label}
+                    </span>
+                </Button>
+            </Heading>
+            <DisclosurePanel className="openapi-disclosure-panel">
+                {isExpanded ? children : null}
+            </DisclosurePanel>
+        </Disclosure>);
 }

package/dist/OpenAPIDisclosureGroup.d.ts

@@ -8,7 +8,7 @@ type TDisclosureGroup = {
     label: string | React.ReactNode;
     tabs?: {
         id: string;
-        label: string | React.ReactNode;
+        label?: string | React.ReactNode;
         body?: React.ReactNode;
     }[];
 };

package/dist/OpenAPIDisclosureGroup.jsx

@@ -25,7 +25,7 @@ export function OpenAPIDisclosureGroup(props) {
         </DisclosureGroupStateContext.Provider>);
 }
 function DisclosureItem(props) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f;
     var icon = props.icon, group = props.group;
     var defaultId = useId();
     var id = group.id || defaultId;
@@ -42,11 +42,11 @@ function DisclosureItem(props) {
     var panelRef = useRef(null);
     var triggerRef = useRef(null);
     var isDisabled = (groupState === null || groupState === void 0 ? void 0 : groupState.isDisabled) || !((_a = group.tabs) === null || _a === void 0 ? void 0 : _a.length) || false;
-    var _f = useDisclosure(__assign(__assign({}, props), { isExpanded: isExpanded, isDisabled: isDisabled }), state, panelRef), triggerProps = _f.buttonProps, panelProps = _f.panelProps;
+    var _g = useDisclosure(__assign(__assign({}, props), { isExpanded: isExpanded, isDisabled: isDisabled }), state, panelRef), triggerProps = _g.buttonProps, panelProps = _g.panelProps;
     var buttonProps = useButton(triggerProps, triggerRef).buttonProps;
-    var _g = useFocusRing(), isFocusVisible = _g.isFocusVisible, focusProps = _g.focusProps;
+    var _h = useFocusRing(), isFocusVisible = _h.isFocusVisible, focusProps = _h.focusProps;
     var defaultTab = ((_c = (_b = group.tabs) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.id) || '';
-    var _h = useState(defaultTab), selectedTabKey = _h[0], setSelectedTabKey = _h[1];
+    var _j = useState(defaultTab), selectedTabKey = _j[0], setSelectedTabKey = _j[1];
     var selectedTab = (_d = group.tabs) === null || _d === void 0 ? void 0 : _d.find(function (tab) { return tab.id === selectedTabKey; });
     return (<div className="openapi-disclosure-group" aria-expanded={state.isExpanded}>
             <div className="openapi-disclosure-group-header">
@@ -71,7 +71,7 @@ function DisclosureItem(props) {
                                 {group.tabs.map(function (tab) { return (<option key={tab.id} value={tab.id}>
                                         {tab.label}
                                     </option>); })}
-                            </select>) : group.tabs[0] ? (<span>{group.tabs[0].label}</span>) : null}
+                            </select>) : ((_f = group.tabs[0]) === null || _f === void 0 ? void 0 : _f.label) ? (<span>{group.tabs[0].label}</span>) : null}
                     </div>) : null}
             </div>
 

package/dist/OpenAPIPath.jsx

@@ -6,14 +6,18 @@ export function OpenAPIPath(props) {
     var data = props.data, context = props.context;
     var method = data.method, path = data.path;
     var specUrl = context.specUrl;
+    var hideTryItPanel = data['x-hideTryItPanel'] || data.operation['x-hideTryItPanel'];
     return (<div className="openapi-path">
             <div className={"openapi-method openapi-method-".concat(method)}>{method}</div>
             <div className="openapi-path-title" data-deprecated={data.operation.deprecated}>
                 <p>{formatPath(path)}</p>
             </div>
-            {data['x-hideTryItPanel'] || data.operation['x-hideTryItPanel'] ? null : (<ScalarApiButton method={method} path={path} specUrl={specUrl}/>)}
+            {!hideTryItPanel && validateHttpMethod(method) && (<ScalarApiButton method={method} path={path} specUrl={specUrl}/>)}
         </div>);
 }
+function validateHttpMethod(method) {
+    return ['get', 'post', 'put', 'delete', 'patch', 'head', 'options', 'trace'].includes(method);
+}
 // Format the path to highlight placeholders
 function formatPath(path) {
     // Matches placeholders like {id}, {userId}, etc.

package/dist/OpenAPISchema.d.ts

@@ -1,20 +1,11 @@
 import type { OpenAPIV3 } from '@gitbook/openapi-parser';
 import type { OpenAPIClientContext } from './types';
 type CircularRefsIds = Map<OpenAPIV3.SchemaObject, string>;
-export interface OpenAPISchemaPropertyEntry {
+interface OpenAPISchemaPropertyEntry {
     propertyName?: string | undefined;
     required?: boolean | undefined;
     schema: OpenAPIV3.SchemaObject;
 }
-/**
- * Render a property of an OpenAPI schema.
- */
-export declare function OpenAPISchemaProperty(props: OpenAPISchemaPropertyEntry & {
-    /** Set of objects already observed as parents */
-    circularRefs?: CircularRefsIds;
-    context: OpenAPIClientContext;
-    className?: string;
-}): import("react").JSX.Element;
 /**
  * Render a set of properties of an OpenAPI schema.
  */
@@ -23,7 +14,7 @@ export declare function OpenAPISchemaProperties(props: {
     properties: OpenAPISchemaPropertyEntry[];
     circularRefs?: CircularRefsIds;
     context: OpenAPIClientContext;
-}): import("react").JSX.Element | null;
+}): import("react").JSX.Element;
 /**
  * Render a root schema (such as the request body or response body).
  */
@@ -31,22 +22,8 @@ export declare function OpenAPIRootSchema(props: {
     schema: OpenAPIV3.SchemaObject;
     context: OpenAPIClientContext;
 }): import("react").JSX.Element;
-/**
- * Render the enum value for a schema.
- */
-export declare function OpenAPISchemaEnum(props: {
-    enumValues: any[];
-}): import("react").JSX.Element;
-export declare function OpenAPISchemaPresentation(props: OpenAPISchemaPropertyEntry): import("react").JSX.Element;
-type OpenAPISchemaAlternatives = [
-    OpenAPIV3.SchemaObject[],
-    OpenAPIV3.DiscriminatorObject | undefined
-];
 /**
  * Get the alternatives to display for a schema.
  */
-export declare function getSchemaAlternatives(schema: OpenAPIV3.SchemaObject, ancestors?: Set<OpenAPIV3.SchemaObject>): null | OpenAPISchemaAlternatives;
-export declare function getSchemaTitle(schema: OpenAPIV3.SchemaObject, 
-/** If the title is inferred in a oneOf with discriminator, we can use it to optimize the title */
-discriminator?: OpenAPIV3.DiscriminatorObject): string;
+export declare function getSchemaAlternatives(schema: OpenAPIV3.SchemaObject, ancestors?: Set<OpenAPIV3.SchemaObject>): OpenAPIV3.SchemaObject[] | null;
 export {};

package/dist/OpenAPISchema.jsx

@@ -1,57 +1,43 @@
-import clsx from 'clsx';
 import { useId } from 'react';
-import { InteractiveSection } from './InteractiveSection';
+import clsx from 'clsx';
 import { Markdown } from './Markdown';
 import { OpenAPIDisclosure } from './OpenAPIDisclosure';
 import { OpenAPISchemaName } from './OpenAPISchemaName';
-import { stringifyOpenAPI } from './stringifyOpenAPI';
-import { checkIsReference, resolveDescription } from './utils';
+import { checkIsReference, resolveDescription, resolveFirstExample } from './utils';
 /**
  * Render a property of an OpenAPI schema.
  */
-export function OpenAPISchemaProperty(props) {
-    var _a;
-    var schema = props.schema, _b = props.circularRefs, parentCircularRefs = _b === void 0 ? new Map() : _b, context = props.context, className = props.className;
+function OpenAPISchemaProperty(props) {
+    var property = props.property, _a = props.circularRefs, parentCircularRefs = _a === void 0 ? new Map() : _a, context = props.context, className = props.className;
+    var schema = property.schema;
     var id = useId();
-    var parentCircularRef = parentCircularRefs.get(schema);
-    var circularRefs = new Map(parentCircularRefs).set(schema, id);
-    // Avoid recursing infinitely, and instead render a link to the parent schema
-    var properties = parentCircularRef ? null : getSchemaProperties(schema);
-    var alternatives = parentCircularRef
-        ? null
-        : getSchemaAlternatives(schema, new Set(circularRefs.keys()));
-    if ((_a = alternatives === null || alternatives === void 0 ? void 0 : alternatives[0]) === null || _a === void 0 ? void 0 : _a.length) {
-        return (<OpenAPISchemaAlternativesItem {...props} circularRefs={circularRefs} context={context} alternatives={alternatives} parentCircularRef={parentCircularRef}/>);
-    }
-    if ((properties && properties.length > 0) || schema.type === 'object') {
-        return (<InteractiveSection id={id} className={clsx('openapi-schema', className)}>
-                <OpenAPISchemaPresentation {...props}/>
-                {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)}>
-            <OpenAPISchemaPresentation {...props}/>
-            {(properties && properties.length > 0) ||
-            (schema.enum && schema.enum.length > 0) ||
-            parentCircularRef ? (<>
-                    {(properties === null || properties === void 0 ? void 0 : properties.length) ? (<OpenAPISchemaProperties properties={properties} circularRefs={circularRefs} context={context}/>) : null}
-                    {parentCircularRef ? (<OpenAPISchemaCircularRef id={parentCircularRef} schema={schema}/>) : null}
-                </>) : null}
-        </InteractiveSection>);
+    return (<div id={id} className={clsx('openapi-schema', className)}>
+            <OpenAPISchemaPresentation property={property}/>
+            {(function () {
+            var parentCircularRef = parentCircularRefs.get(schema);
+            // Avoid recursing infinitely, and instead render a link to the parent schema
+            if (parentCircularRef) {
+                return <OpenAPISchemaCircularRef id={parentCircularRef} schema={schema}/>;
+            }
+            var circularRefs = parentCircularRefs.set(schema, id);
+            var properties = getSchemaProperties(schema);
+            var alternatives = getSchemaAlternatives(schema, new Set(circularRefs.keys()));
+            return (<>
+                        {alternatives === null || alternatives === void 0 ? void 0 : alternatives.map(function (schema, index) { return (<OpenAPISchemaAlternative key={index} schema={schema} circularRefs={circularRefs} context={context}/>); })}
+                        {(properties === null || properties === void 0 ? void 0 : properties.length) ? (<OpenAPIDisclosure context={context} label={getDisclosureLabel(schema)}>
+                                <OpenAPISchemaProperties properties={properties} circularRefs={circularRefs} context={context}/>
+                            </OpenAPIDisclosure>) : null}
+                    </>);
+        })()}
+        </div>);
 }
 /**
  * Render a set of properties of an OpenAPI schema.
  */
 export function OpenAPISchemaProperties(props) {
     var id = props.id, properties = props.properties, circularRefs = props.circularRefs, context = props.context;
-    if (!properties.length) {
-        return null;
-    }
     return (<div id={id} className="openapi-schema-properties">
-            {properties.map(function (property, index) { return (<OpenAPISchemaProperty key={index} circularRefs={circularRefs} {...property} context={context}/>); })}
+            {properties.map(function (property, index) { return (<OpenAPISchemaProperty key={index} circularRefs={circularRefs} property={property} context={context}/>); })}
         </div>);
 }
 /**
@@ -59,12 +45,11 @@ export function OpenAPISchemaProperties(props) {
  */
 export function OpenAPIRootSchema(props) {
     var schema = props.schema, context = props.context;
-    // Avoid recursing infinitely, and instead render a link to the parent schema
     var properties = getSchemaProperties(schema);
-    if (properties && properties.length > 0) {
+    if (properties === null || properties === void 0 ? void 0 : properties.length) {
         return <OpenAPISchemaProperties properties={properties} context={context}/>;
     }
-    return (<OpenAPISchemaProperty schema={schema} context={context} className="openapi-schema-root"/>);
+    return (<OpenAPISchemaProperty className="openapi-schema-root" property={{ schema: schema }} context={context}/>);
 }
 /**
  * Render a tab for an alternative schema.
@@ -72,36 +57,16 @@ export function OpenAPIRootSchema(props) {
  * for primitives, it renders the schema itself.
  */
 function OpenAPISchemaAlternative(props) {
-    var _a;
     var schema = props.schema, circularRefs = props.circularRefs, context = props.context;
-    var id = useId();
-    var subProperties = getSchemaProperties(schema);
     var description = resolveDescription(schema);
-    var alternatives = getSchemaAlternatives(schema, new Set(circularRefs === null || circularRefs === void 0 ? void 0 : circularRefs.keys()));
-    if (((_a = alternatives === null || alternatives === void 0 ? void 0 : alternatives[0]) === null || _a === void 0 ? void 0 : _a.length) && !(subProperties === null || subProperties === void 0 ? void 0 : subProperties.length)) {
-        return (<>
-                {description ? (<Markdown source={description} className="openapi-schema-description"/>) : null}
-                <OpenAPIDisclosure context={context} label={getDisclosureLabel(schema)}>
-                    <OpenAPISchemaAlternativesItem schema={schema} circularRefs={circularRefs} context={context} alternatives={alternatives}/>
-                </OpenAPIDisclosure>
-            </>);
-    }
+    var properties = getSchemaProperties(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}/>
+                {(properties === null || properties === void 0 ? void 0 : properties.length) ? (<OpenAPISchemaProperties properties={properties} circularRefs={circularRefs} context={context}/>) : (<OpenAPISchemaProperty property={{ schema: schema }} circularRefs={circularRefs} context={context}/>)}
             </OpenAPIDisclosure>
         </>);
 }
-function OpenAPISchemaAlternativesItem(props) {
-    var id = useId();
-    var schema = props.schema, circularRefs = props.circularRefs, context = props.context, alternatives = props.alternatives, parentCircularRef = props.parentCircularRef;
-    return (<InteractiveSection id={id} className={clsx('openapi-schema')}>
-            <OpenAPISchemaPresentation {...props}/>
-            {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>);
-}
 /**
  * Render a circular reference to a schema.
  */
@@ -115,7 +80,7 @@ function OpenAPISchemaCircularRef(props) {
 /**
  * Render the enum value for a schema.
  */
-export function OpenAPISchemaEnum(props) {
+function OpenAPISchemaEnum(props) {
     var enumValues = props.enumValues;
     return (<div className="openapi-schema-enum">
             <span>
@@ -127,29 +92,24 @@ export function OpenAPISchemaEnum(props) {
             </span>
         </div>);
 }
-export function OpenAPISchemaPresentation(props) {
-    var schema = props.schema, propertyName = props.propertyName, required = props.required;
-    var shouldDisplayExample = function (schema) {
-        return ((typeof schema.example === 'string' && !!schema.example) ||
-            typeof schema.example === 'number' ||
-            typeof schema.example === 'boolean' ||
-            (Array.isArray(schema.example) && schema.example.length > 0) ||
-            (typeof schema.example === 'object' &&
-                schema.example !== null &&
-                Object.keys(schema.example).length > 0));
-    };
+/**
+ * Render the top row of a schema. e.g: name, type, and required status.
+ */
+function OpenAPISchemaPresentation(props) {
+    var _a = props.property, schema = _a.schema, propertyName = _a.propertyName, required = _a.required;
     var description = resolveDescription(schema);
+    var example = resolveFirstExample(schema);
     return (<div className="openapi-schema-presentation">
             <OpenAPISchemaName schema={schema} type={getSchemaTitle(schema)} propertyName={propertyName} required={required}/>
-            {schema['x-deprecated-sunset'] ? (<div className="openapi-deprecated-sunset openapi-schema-description openapi-markdown">
+            {typeof schema['x-deprecated-sunset'] === 'string' ? (<div className="openapi-deprecated-sunset openapi-schema-description openapi-markdown">
                     Sunset date:{' '}
                     <span className="openapi-deprecated-sunset-date">
                         {schema['x-deprecated-sunset']}
                     </span>
                 </div>) : null}
             {description ? (<Markdown source={description} className="openapi-schema-description"/>) : null}
-            {shouldDisplayExample(schema) ? (<div className="openapi-schema-example">
-                    Example: <code>{formatExample(schema.example)}</code>
+            {typeof example === 'string' ? (<div className="openapi-schema-example">
+                    Example: <code>{example}</code>
                 </div>) : null}
             {schema.pattern ? (<div className="openapi-schema-pattern">
                     Pattern: <code>{schema.pattern}</code>
@@ -162,28 +122,30 @@ export function OpenAPISchemaPresentation(props) {
  */
 function getSchemaProperties(schema) {
     // check array AND schema.items as this is sometimes null despite what the type indicates
-    if (schema.type === 'array' && !!schema.items) {
+    if (schema.type === 'array' && schema.items && !checkIsReference(schema.items)) {
         var items = schema.items;
         var itemProperties = getSchemaProperties(items);
         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) {
+        if ((items.type === 'string' ||
+            items.type === 'number' ||
+            items.type === 'boolean' ||
+            items.type === 'integer') &&
+            !items.enum) {
             return null;
         }
-        return [
-            {
-                propertyName: 'items',
-                schema: items,
-            },
-        ];
+        return [{ propertyName: 'items', schema: items }];
     }
     if (schema.type === 'object' || schema.properties) {
         var result_1 = [];
         if (schema.properties) {
             Object.entries(schema.properties).forEach(function (_a) {
                 var propertyName = _a[0], propertySchema = _a[1];
+                if (checkIsReference(propertySchema)) {
+                    return;
+                }
                 result_1.push({
                     propertyName: propertyName,
                     required: Array.isArray(schema.required)
@@ -193,11 +155,10 @@ function getSchemaProperties(schema) {
                 });
             });
         }
-        if (schema.additionalProperties) {
-            var additionalProperties = schema.additionalProperties;
+        if (schema.additionalProperties && !checkIsReference(schema.additionalProperties)) {
             result_1.push({
                 propertyName: 'Other properties',
-                schema: additionalProperties === true ? {} : additionalProperties,
+                schema: schema.additionalProperties === true ? {} : schema.additionalProperties,
             });
         }
         return result_1;
@@ -209,43 +170,42 @@ function getSchemaProperties(schema) {
  */
 export function getSchemaAlternatives(schema, ancestors) {
     if (ancestors === void 0) { ancestors = new Set(); }
-    var downAncestors = new Set(ancestors).add(schema);
-    if (schema.anyOf) {
-        return [flattenAlternatives('anyOf', schema.anyOf, downAncestors), schema.discriminator];
-    }
-    if (schema.oneOf) {
-        return [flattenAlternatives('oneOf', schema.oneOf, downAncestors), schema.discriminator];
-    }
-    if (schema.allOf) {
-        return [flattenAlternatives('allOf', schema.allOf, downAncestors), schema.discriminator];
+    var alternatives = (function () {
+        if (schema.anyOf) {
+            return ['anyOf', schema.anyOf];
+        }
+        if (schema.oneOf) {
+            return ['oneOf', schema.oneOf];
+        }
+        if (schema.allOf) {
+            return ['allOf', schema.allOf];
+        }
+        return null;
+    })();
+    if (!alternatives) {
+        return null;
     }
-    return null;
+    var type = alternatives[0], schemas = alternatives[1];
+    return flattenAlternatives(type, schemas, new Set(ancestors).add(schema));
 }
-function flattenAlternatives(alternativeType, alternatives, ancestors) {
-    return alternatives.reduce(function (acc, alternative) {
-        var _a;
-        if (!!alternative[alternativeType] && !ancestors.has(alternative)) {
-            acc.push.apply(acc, (((_a = getSchemaAlternatives(alternative, ancestors)) === null || _a === void 0 ? void 0 : _a[0]) || []));
+function flattenAlternatives(alternativeType, schemasOrRefs, ancestors) {
+    return schemasOrRefs.reduce(function (acc, schemaOrRef) {
+        if (checkIsReference(schemaOrRef)) {
+            return acc;
         }
-        else {
-            acc.push(alternative);
+        if (schemaOrRef[alternativeType] && !ancestors.has(schemaOrRef)) {
+            var schemas = getSchemaAlternatives(schemaOrRef, ancestors);
+            if (schemas) {
+                acc.push.apply(acc, schemas);
+            }
+            return acc;
         }
+        acc.push(schemaOrRef);
         return acc;
     }, []);
 }
-export function getSchemaTitle(schema, 
-/** If the title is inferred in a oneOf with discriminator, we can use it to optimize the title */
-discriminator) {
+function getSchemaTitle(schema) {
     var _a;
-    // Try using the discriminator
-    if ((discriminator === null || discriminator === void 0 ? void 0 : discriminator.propertyName) && schema.properties) {
-        var discriminatorProperty = schema.properties[discriminator.propertyName];
-        if (discriminatorProperty && !checkIsReference(discriminatorProperty)) {
-            if (discriminatorProperty.enum) {
-                return discriminatorProperty.enum.map(function (value) { return value.toString(); }).join(' | ');
-            }
-        }
-    }
     // Otherwise try to infer a nice title
     var type = 'any';
     if (schema.enum) {
@@ -286,20 +246,9 @@ function getDisclosureLabel(schema) {
         }
         // Fallback to "child attributes" for enums and objects
         if (schema.items.enum || schema.items.type === 'object') {
-            return;
+            return 'child attributes';
         }
         return (_b = (_a = schema.items.title) !== null && _a !== void 0 ? _a : schema.title) !== null && _b !== void 0 ? _b : getSchemaTitle(schema.items);
     }
-    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 stringifyOpenAPI(example);
+    return schema.title || 'child attributes';
 }

package/dist/ScalarApiButton.d.ts

@@ -1,8 +1,9 @@
+import type { OpenAPIV3_1 } from '@gitbook/openapi-parser';
 /**
  * Button which launches the Scalar API Client
  */
-export declare function ScalarApiButton({ method, path, specUrl, }: {
-    method: string;
+export declare function ScalarApiButton(props: {
+    method: OpenAPIV3_1.HttpMethods;
     path: string;
     specUrl: string;
 }): import("react").JSX.Element;

package/dist/ScalarApiButton.jsx

@@ -1,15 +1,14 @@
 'use client';
 import { ApiClientModalProvider, useApiClientModal } from '@scalar/api-client-react';
-import { useEffect, useImperativeHandle, useRef, useState } from 'react';
+import { useEffect, useImperativeHandle, useMemo, useRef, useState } from 'react';
 import { createPortal } from 'react-dom';
-import { useEventCallback } from 'usehooks-ts';
 import { useOpenAPIOperationContext } from './OpenAPIOperationContext';
 /**
  * Button which launches the Scalar API Client
  */
-export function ScalarApiButton(_a) {
-    var method = _a.method, path = _a.path, specUrl = _a.specUrl;
-    var _b = useState(false), isOpen = _b[0], setIsOpen = _b[1];
+export function ScalarApiButton(props) {
+    var method = props.method, path = props.path, specUrl = props.specUrl;
+    var _a = useState(false), isOpen = _a[0], setIsOpen = _a[1];
     var controllerRef = useRef(null);
     return (<div className="scalar scalar-activate">
             <button className="scalar-activate-button button" onClick={function () {
@@ -28,24 +27,29 @@ export function ScalarApiButton(_a) {
         </div>);
 }
 function ScalarModal(props) {
-    return (<ApiClientModalProvider configuration={{ spec: { url: props.specUrl } }} initialRequest={{ path: props.path, method: props.method }}>
-            <ScalarModalController method={props.method} path={props.path} controllerRef={props.controllerRef}/>
+    var method = props.method, path = props.path, specUrl = props.specUrl, controllerRef = props.controllerRef;
+    return (<ApiClientModalProvider configuration={{ spec: { url: specUrl } }} initialRequest={{ method: method, path: path }}>
+            <ScalarModalController method={method} path={path} controllerRef={controllerRef}/>
         </ApiClientModalProvider>);
 }
 function ScalarModalController(props) {
+    var method = props.method, path = props.path, controllerRef = props.controllerRef;
     var client = useApiClientModal();
-    var openClient = client === null || client === void 0 ? void 0 : client.open;
-    useImperativeHandle(props.controllerRef, function () { return ({ openClient: openClient ? function () { return openClient(); } : undefined }); }, [openClient]);
-    // Open the client when the component is mounted.
-    var onOpenClient = useOpenAPIOperationContext().onOpenClient;
-    var trackOpening = useEventCallback(function () {
-        onOpenClient({ method: props.method, path: props.path });
-    });
-    useEffect(function () {
-        if (openClient) {
-            openClient();
-            trackOpening();
+    var openScalarClient = client === null || client === void 0 ? void 0 : client.open;
+    var trackClientOpening = useOpenAPIOperationContext().onOpenClient;
+    var openClient = useMemo(function () {
+        if (openScalarClient) {
+            return function () {
+                openScalarClient({ method: method, path: path, _source: 'gitbook' });
+                trackClientOpening({ method: method, path: path });
+            };
         }
+        return null;
+    }, [openScalarClient, method, path, trackClientOpening]);
+    useImperativeHandle(controllerRef, function () { return ({ openClient: openClient ? function () { return openClient(); } : undefined }); }, [openClient]);
+    // Open at mount
+    useEffect(function () {
+        openClient === null || openClient === void 0 ? void 0 : openClient();
     }, [openClient]);
     return null;
 }

package/dist/dereference.d.ts

@@ -0,0 +1,5 @@
+import { type Filesystem, type OpenAPIV3xDocument } from '@gitbook/openapi-parser';
+/**
+ * Memoized version of `dereferenceSchema`.
+ */
+export declare function dereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3xDocument>;