@gitbook/react-openapi 1.0.0 → 1.0.2

package/dist/OpenAPISchema.jsx

@@ -11,7 +11,7 @@ import clsx from 'clsx';
 import { useId } from 'react';
 import { InteractiveSection } from './InteractiveSection';
 import { Markdown } from './Markdown';
-import { checkIsReference, noReference, resolveDescription } from './utils';
+import { checkIsReference, resolveDescription } from './utils';
 import { stringifyOpenAPI } from './stringifyOpenAPI';
 import { OpenAPISchemaName } from './OpenAPISchemaName';
 import { OpenAPIDisclosure } from './OpenAPIDisclosure';
@@ -29,18 +29,18 @@ export function OpenAPISchemaProperty(props) {
     var alternatives = parentCircularRef
         ? null
         : getSchemaAlternatives(schema, new Set(circularRefs.keys()));
-    if ((properties && !!properties.length) || schema.type === 'object') {
+    if ((properties && properties.length > 0) || schema.type === 'object') {
         return (<InteractiveSection id={id} className={clsx('openapi-schema', className)}>
                 <OpenAPISchemaPresentation {...props}/>
-                <OpenAPIDisclosure context={context}>
-                    {properties && properties.length > 0 ? (<OpenAPISchemaProperties properties={properties} circularRefs={circularRefs} context={context}/>) : null}
-                </OpenAPIDisclosure>
+                {properties && properties.length > 0 ? (<OpenAPIDisclosure context={context}>
+                        <OpenAPISchemaProperties properties={properties} circularRefs={circularRefs} context={context}/>
+                    </OpenAPIDisclosure>) : null}
             </InteractiveSection>);
     }
     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}/>
-                {alternatives[0].map(function (alternative, index) { return (<OpenAPISchemaAlternative key={index} schema={alternative} circularRefs={circularRefs} context={context}/>); })}
+                {alternatives[0].map(function (alternative, index) { return (<OpenAPISchemaAlternative key={"alternative-".concat(index)} schema={alternative} circularRefs={circularRefs} context={context}/>); })}
             </InteractiveSection>);
     }
     return (<InteractiveSection id={id} className={clsx('openapi-schema', className)}>
@@ -157,9 +157,9 @@ function getSchemaProperties(schema) {
     if (schema.allOf) {
         return schema.allOf.reduce(function (acc, subSchema) {
             var _a;
-            var properties = (_a = getSchemaProperties(noReference(subSchema))) !== null && _a !== void 0 ? _a : [
+            var properties = (_a = getSchemaProperties(subSchema)) !== null && _a !== void 0 ? _a : [
                 {
-                    schema: noReference(subSchema),
+                    schema: subSchema,
                 },
             ];
             return __spreadArray(__spreadArray([], acc, true), properties, true);
@@ -167,7 +167,7 @@ function getSchemaProperties(schema) {
     }
     // check array AND schema.items as this is sometimes null despite what the type indicates
     if (schema.type === 'array' && !!schema.items) {
-        var items = noReference(schema.items);
+        var items = schema.items;
         var itemProperties = getSchemaProperties(items);
         if (itemProperties) {
             return itemProperties;
@@ -183,11 +183,7 @@ function getSchemaProperties(schema) {
         var result_1 = [];
         if (schema.properties) {
             Object.entries(schema.properties).forEach(function (_a) {
-                var propertyName = _a[0], rawPropertySchema = _a[1];
-                var isReference = checkIsReference(rawPropertySchema);
-                var propertySchema = isReference
-                    ? { propertyName: propertyName }
-                    : rawPropertySchema;
+                var propertyName = _a[0], propertySchema = _a[1];
                 result_1.push({
                     propertyName: propertyName,
                     required: Array.isArray(schema.required)
@@ -198,7 +194,7 @@ function getSchemaProperties(schema) {
             });
         }
         if (schema.additionalProperties) {
-            var additionalProperties = noReference(schema.additionalProperties);
+            var additionalProperties = schema.additionalProperties;
             result_1.push({
                 propertyName: 'Other properties',
                 schema: additionalProperties === true ? {} : additionalProperties,
@@ -215,16 +211,10 @@ 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.map(noReference), downAncestors),
-            noReference(schema.discriminator),
-        ];
+        return [flattenAlternatives('anyOf', schema.anyOf, downAncestors), schema.discriminator];
     }
     if (schema.oneOf) {
-        return [
-            flattenAlternatives('oneOf', schema.oneOf.map(noReference), downAncestors),
-            noReference(schema.discriminator),
-        ];
+        return [flattenAlternatives('oneOf', schema.oneOf, downAncestors), schema.discriminator];
     }
     if (schema.allOf) {
         // allOf is managed in `getSchemaProperties`
@@ -251,8 +241,8 @@ discriminator) {
     }
     // Try using the discriminator
     if ((discriminator === null || discriminator === void 0 ? void 0 : discriminator.propertyName) && schema.properties) {
-        var discriminatorProperty = noReference(schema.properties[discriminator.propertyName]);
-        if (discriminatorProperty) {
+        var discriminatorProperty = schema.properties[discriminator.propertyName];
+        if (discriminatorProperty && !checkIsReference(discriminatorProperty)) {
             if (discriminatorProperty.enum) {
                 return discriminatorProperty.enum.map(function (value) { return value.toString(); }).join(' | ');
             }
@@ -261,11 +251,11 @@ discriminator) {
     // Otherwise try to infer a nice title
     var type = 'any';
     if (schema.enum) {
-        type = 'enum';
+        type = "".concat(schema.type, " \u00B7 enum");
         // check array AND schema.items as this is sometimes null despite what the type indicates
     }
     else if (schema.type === 'array' && !!schema.items) {
-        type = "".concat(getSchemaTitle(noReference(schema.items)), "[]");
+        type = "".concat(getSchemaTitle(schema.items), "[]");
     }
     else if (Array.isArray(schema.type)) {
         type = schema.type.join(' | ');
@@ -273,7 +263,7 @@ discriminator) {
     else if (schema.type || schema.properties) {
         type = (_a = schema.type) !== null && _a !== void 0 ? _a : 'object';
         if (schema.format) {
-            type += " ".concat(schema.format);
+            type += " \u00B7 ".concat(schema.format);
         }
     }
     else if ('anyOf' in schema) {
@@ -288,8 +278,17 @@ 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);
+    }
     if (schema.nullable) {
-        type = "nullable ".concat(type);
+        type = "".concat(type, " | nullable");
     }
     return type;
 }

package/dist/OpenAPISpec.jsx

@@ -1,21 +1,10 @@
 'use client';
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 import { InteractiveSection } from './InteractiveSection';
 import { OpenAPIRequestBody } from './OpenAPIRequestBody';
 import { OpenAPIResponses } from './OpenAPIResponses';
 import { OpenAPISchemaProperties } from './OpenAPISchema';
 import { OpenAPISecurities } from './OpenAPISecurities';
-import { noReference, resolveDescription } from './utils';
+import { parameterToProperty } from './utils';
 /**
  * Client component to render the spec for the request and response.
  *
@@ -33,25 +22,12 @@ export function OpenAPISpec(props) {
 
             {parameterGroups.map(function (group) {
             return (<InteractiveSection key={group.key} className="openapi-parameters" header={group.label}>
-                        <OpenAPISchemaProperties properties={group.parameters.map(function (parameter) {
-                    var _a;
-                    var description = resolveDescription(parameter);
-                    return {
-                        propertyName: parameter.name,
-                        schema: __assign({ 
-                            // Description of the parameter is defined at the parameter level
-                            // we use display it if the schema doesn't override it
-                            description: description, example: parameter.example, 
-                            // Deprecated can be defined at the parameter level
-                            deprecated: parameter.deprecated }, ((_a = noReference(parameter.schema)) !== null && _a !== void 0 ? _a : {})),
-                        required: parameter.required,
-                    };
-                })} context={context}/>
+                        <OpenAPISchemaProperties properties={group.parameters.map(parameterToProperty)} context={context}/>
                     </InteractiveSection>);
         })}
 
-            {operation.requestBody ? (<OpenAPIRequestBody requestBody={noReference(operation.requestBody)} context={context}/>) : null}
-            {operation.responses ? (<OpenAPIResponses responses={noReference(operation.responses)} context={context}/>) : null}
+            {operation.requestBody ? (<OpenAPIRequestBody requestBody={operation.requestBody} context={context}/>) : null}
+            {operation.responses ? (<OpenAPIResponses responses={operation.responses} context={context}/>) : null}
         </>);
 }
 function groupParameters(parameters) {

package/dist/OpenAPITabs.d.ts

@@ -10,6 +10,7 @@ export type Tab = {
  */
 export declare function OpenAPITabs(props: React.PropsWithChildren<TabsProps & {
     items: Tab[];
+    stateKey?: string;
 }>): import("react").JSX.Element;
 /**
  * The OpenAPI Tabs list component.

package/dist/OpenAPITabs.jsx

@@ -1,7 +1,9 @@
 'use client';
-import { createContext, useContext, useMemo, useState } from 'react';
+import { createContext, useContext, useEffect, useMemo, useState } from 'react';
 import { Tab, TabList, TabPanel, Tabs } from 'react-aria-components';
 import { Markdown } from './Markdown';
+import { useSyncedTabsGlobalState } from './useSyncedTabsGlobalState';
+import { useIntersectionObserver } from 'usehooks-ts';
 var OpenAPITabsContext = createContext(null);
 function useOpenAPITabsContext() {
     var context = useContext(OpenAPITabsContext);
@@ -14,17 +16,52 @@ function useOpenAPITabsContext() {
  * The OpenAPI Tabs wrapper component.
  */
 export function OpenAPITabs(props) {
-    var children = props.children, items = props.items;
-    var _a = useState(function () {
-        var firstItem = items[0];
-        if (!firstItem) {
-            throw new Error('OpenAPITabs: at least one tab is required');
+    var children = props.children, items = props.items, stateKey = props.stateKey;
+    var isVisible = stateKey
+        ? useIntersectionObserver({
+            threshold: 0.1,
+            rootMargin: '200px',
+        })
+        : true;
+    var defaultTab = items[0];
+    var _a = useSyncedTabsGlobalState(), syncedTabs = _a[0], setSyncedTabs = _a[1];
+    var _b = useState(function () {
+        var _a, _b, _c;
+        if (isVisible && stateKey && syncedTabs && syncedTabs.has(stateKey)) {
+            var tabFromState = syncedTabs.get(stateKey);
+            return (_a = tabFromState === null || tabFromState === void 0 ? void 0 : tabFromState.key) !== null && _a !== void 0 ? _a : (_b = items[0]) === null || _b === void 0 ? void 0 : _b.key;
         }
-        return firstItem.key;
-    }), selectedKey = _a[0], setSelectedKey = _a[1];
-    var contextValue = { items: items, selectedKey: selectedKey, setSelectedKey: setSelectedKey };
+        return (_c = items[0]) === null || _c === void 0 ? void 0 : _c.key;
+    }), selectedTabKey = _b[0], setSelectedTabKey = _b[1];
+    var _c = useState(defaultTab), selectedTab = _c[0], setSelectedTab = _c[1];
+    var handleSelectionChange = function (key) {
+        setSelectedTabKey(key);
+        if (stateKey) {
+            var tab_1 = items.find(function (item) { return item.key === key; });
+            if (!tab_1) {
+                return;
+            }
+            setSyncedTabs(function (state) {
+                var newState = new Map(state);
+                newState.set(stateKey, tab_1);
+                return newState;
+            });
+        }
+    };
+    useEffect(function () {
+        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;
+            }
+            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);
+            }
+        }
+    }, [isVisible, stateKey, syncedTabs, selectedTabKey]);
+    var contextValue = useMemo(function () { return ({ items: items, selectedTab: selectedTab }); }, [items, selectedTab]);
     return (<OpenAPITabsContext.Provider value={contextValue}>
-            <Tabs className="openapi-tabs" onSelectionChange={setSelectedKey} selectedKey={selectedKey}>
+            <Tabs className="openapi-tabs" onSelectionChange={handleSelectionChange} selectedKey={selectedTab === null || selectedTab === void 0 ? void 0 : selectedTab.key}>
                 {children}
             </Tabs>
         </OpenAPITabsContext.Provider>);
@@ -55,13 +92,12 @@ export function OpenAPITabsList() {
  * It renders the content of the selected tab.
  */
 export function OpenAPITabsPanels() {
-    var _a = useOpenAPITabsContext(), selectedKey = _a.selectedKey, items = _a.items;
-    var tab = useMemo(function () { return items.find(function (tab) { return tab.key === selectedKey; }); }, [items, selectedKey]);
-    if (!tab) {
+    var selectedTab = useOpenAPITabsContext().selectedTab;
+    if (!selectedTab) {
         return null;
     }
-    return (<TabPanel key={"TabPanel-".concat(tab.key)} id={tab.key.toString()} className="openapi-tabs-panel">
-            {tab.body}
-            {tab.description ? (<Markdown source={tab.description} className="openapi-tabs-footer"/>) : null}
+    return (<TabPanel key={"TabPanel-".concat(selectedTab.key)} id={selectedTab.key.toString()} className="openapi-tabs-panel">
+            {selectedTab.body}
+            {selectedTab.description ? (<Markdown source={selectedTab.description} className="openapi-tabs-footer"/>) : null}
         </TabPanel>);
 }

package/dist/generateSchemaExample.d.ts

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

package/dist/generateSchemaExample.js

@@ -1,14 +1,20 @@
-import { noReference } from './utils';
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 import { getExampleFromSchema } from '@scalar/oas-utils/spec-getters';
 /**
  * Generate a JSON example from a schema
  */
 export function generateSchemaExample(schema, options) {
-    if (options === void 0) { options = {}; }
-    return getExampleFromSchema(schema, {
-        emptyString: 'text',
-        omitEmptyAndOptionalProperties: options.onlyRequired,
-        variables: {
+    return getExampleFromSchema(schema, __assign({ emptyString: 'text', variables: {
             'date-time': new Date().toISOString(),
             date: new Date().toISOString().split('T')[0],
             email: 'name@gmail.com',
@@ -20,14 +26,12 @@ export function generateSchemaExample(schema, options) {
             binary: 'binary',
             byte: 'Ynl0ZXM=',
             password: 'password',
-        },
-    });
+        } }, options));
 }
 /**
  * Generate an example for a media type.
  */
 export function generateMediaTypeExample(mediaType, options) {
-    if (options === void 0) { options = {}; }
     if (mediaType.example) {
         return mediaType.example;
     }
@@ -36,12 +40,12 @@ export function generateMediaTypeExample(mediaType, options) {
         if (key) {
             var example = mediaType.examples[key];
             if (example) {
-                return noReference(example).value;
+                return example.value;
             }
         }
     }
     if (mediaType.schema) {
-        return generateSchemaExample(noReference(mediaType.schema), options);
+        return generateSchemaExample(mediaType.schema, options);
     }
     return undefined;
 }

package/dist/json2xml.d.ts

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

package/dist/json2xml.js

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

package/dist/resolveOpenAPIOperation.js

@@ -56,7 +56,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 import { toJSON, fromJSON } from 'flatted';
 import { dereference, } from '@gitbook/openapi-parser';
-import { noReference } from './utils';
+import { checkIsReference } from './utils';
 export { toJSON, fromJSON };
 /**
  * Resolve an OpenAPI operation in a file and compile it to a more usable format.
@@ -88,8 +88,8 @@ export function resolveOpenAPIOperation(filesystem, operationDescriptor) {
                         securityKey = Object.keys(entry)[0];
                         if (securityKey) {
                             securityScheme = (_f = (_e = schema.components) === null || _e === void 0 ? void 0 : _e.securitySchemes) === null || _f === void 0 ? void 0 : _f[securityKey];
-                            if (securityScheme) {
-                                securities.push([securityKey, noReference(securityScheme)]);
+                            if (securityScheme && !checkIsReference(securityScheme)) {
+                                securities.push([securityKey, securityScheme]);
                             }
                         }
                     }
@@ -155,7 +155,7 @@ function getPathObject(schema, path) {
 function getPathObjectParameter(schema, path) {
     var pathObject = getPathObject(schema, path);
     if (pathObject === null || pathObject === void 0 ? void 0 : pathObject.parameters) {
-        return pathObject.parameters.map(noReference);
+        return pathObject.parameters;
     }
     return null;
 }