@gitbook/react-openapi 1.4.3 → 1.5.1

package/dist/OpenAPIResponse.jsx

@@ -1,57 +0,0 @@
-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 { OpenAPIDisclosure } from './OpenAPIDisclosure';
-import { OpenAPISchemaPresentation } from './OpenAPISchema';
-import { OpenAPISchemaProperties } from './OpenAPISchemaServer';
-import { tString } from './translate';
-import { parameterToProperty, resolveDescription } from './utils';
-/**
- * Display an interactive response body.
- */
-export function OpenAPIResponse(props) {
-    var _a, _b;
-    var response = props.response, context = props.context, mediaType = props.mediaType;
-    var headers = Object.entries((_a = response.headers) !== null && _a !== void 0 ? _a : {}).map(function (_a) {
-        var name = _a[0], header = _a[1];
-        return [name, header !== null && header !== void 0 ? header : {}];
-    });
-    var content = Object.entries((_b = mediaType === null || mediaType === void 0 ? void 0 : mediaType.schema) !== null && _b !== void 0 ? _b : {});
-    var description = resolveDescription(response);
-    if (content.length === 0 && !description && headers.length === 0) {
-        return null;
-    }
-    return (<div className="openapi-response-body">
-            {headers.length > 0 ? (<OpenAPIDisclosure header={<OpenAPISchemaPresentation context={context} property={{
-                    propertyName: tString(context.translation, 'headers'),
-                    schema: {
-                        type: 'object',
-                    },
-                    required: null,
-                }}/>} icon={context.icons.plus} label={function (isExpanded) {
-                return tString(context.translation, isExpanded ? 'hide' : 'show', tString(context.translation, headers.length === 1 ? 'header' : 'headers'));
-            }}>
-                    <OpenAPISchemaProperties properties={headers.map(function (_a) {
-                var name = _a[0], header = _a[1];
-                return parameterToProperty(__assign({ name: name }, header));
-            })} context={context}/>
-                </OpenAPIDisclosure>) : null}
-            {(mediaType === null || mediaType === void 0 ? void 0 : mediaType.schema) && (<div className="openapi-responsebody">
-                    <OpenAPISchemaProperties id={"response-".concat(context.blockKey)} properties={[
-                {
-                    schema: mediaType.schema,
-                    propertyName: tString(context.translation, 'response'),
-                    required: null,
-                },
-            ]} context={context}/>
-                </div>)}
-        </div>);
-}

package/dist/OpenAPIResponseExample.d.ts

@@ -1,9 +0,0 @@
-import { type OpenAPIContext } from './context';
-import type { OpenAPIOperationData, OpenAPIWebhookData } from './types';
-/**
- * Display an example of the response content.
- */
-export declare function OpenAPIResponseExample(props: {
-    data: OpenAPIOperationData | OpenAPIWebhookData;
-    context: OpenAPIContext;
-}): import("react").JSX.Element | null;

package/dist/OpenAPIResponseExample.jsx

@@ -1,105 +0,0 @@
-import { Markdown } from './Markdown';
-import { OpenAPIEmptyExample, OpenAPIExample } from './OpenAPIExample';
-import { OpenAPIMediaTypeContent } from './OpenAPIMediaType';
-import { OpenAPIResponseExampleContent } from './OpenAPIResponseExampleContent';
-import { getOpenAPIClientContext } from './context';
-import { getExampleFromReference, getExamples } from './util/example';
-import { createStateKey, getStatusCodeDefaultLabel, resolveDescription } from './utils';
-import { checkIsReference } from './utils';
-/**
- * Display an example of the response content.
- */
-export function OpenAPIResponseExample(props) {
-    var data = props.data, context = props.context;
-    // if there are no responses defined for the operation
-    if (!data.operation.responses) {
-        return null;
-    }
-    var responses = Object.entries(data.operation.responses);
-    // Sort response to get 200, and 2xx first
-    responses.sort(function (_a, _b) {
-        var a = _a[0];
-        var b = _b[0];
-        if (a === 'default') {
-            return 1;
-        }
-        if (b === 'default') {
-            return -1;
-        }
-        if (a === '200') {
-            return -1;
-        }
-        if (b === '200') {
-            return 1;
-        }
-        return Number(a) - Number(b);
-    });
-    var tabs = responses
-        .filter(function (_a) {
-        var _ = _a[0], responseObject = _a[1];
-        return responseObject &&
-            typeof responseObject === 'object' &&
-            // Make sure the response is not hidden
-            !responseObject['x-hideSample'];
-    })
-        .map(function (_a) {
-        var key = _a[0], responseObject = _a[1];
-        var description = resolveDescription(responseObject);
-        var label = description ? (<Markdown key={"response-description-".concat(key)} source={description}/>) : (getStatusCodeDefaultLabel(key, context));
-        if (checkIsReference(responseObject)) {
-            return {
-                key: key,
-                label: label,
-                statusCode: key,
-                body: (<OpenAPIExample example={getExampleFromReference(responseObject, context)} context={context} syntax="json"/>),
-            };
-        }
-        if (!responseObject.content || Object.keys(responseObject.content).length === 0) {
-            return {
-                key: key,
-                label: label,
-                statusCode: key,
-                body: <OpenAPIEmptyExample context={context}/>,
-            };
-        }
-        return {
-            key: key,
-            label: label,
-            statusCode: key,
-            body: <OpenAPIResponse context={context} content={responseObject.content}/>,
-        };
-    });
-    if (tabs.length === 0) {
-        return null;
-    }
-    return (<OpenAPIResponseExampleContent selectIcon={context.icons.chevronDown} blockKey={context.blockKey} items={tabs}/>);
-}
-function OpenAPIResponse(props) {
-    var context = props.context, content = props.content;
-    var entries = Object.entries(content);
-    var firstEntry = entries[0];
-    if (!firstEntry) {
-        throw new Error('One media type is required');
-    }
-    var tabs = entries.map(function (entry) {
-        var mediaType = entry[0], mediaTypeObject = entry[1];
-        if (!mediaTypeObject) {
-            return {
-                key: mediaType,
-                label: mediaType,
-                body: <OpenAPIEmptyExample context={context}/>,
-            };
-        }
-        return {
-            key: mediaType,
-            label: mediaType,
-            body: <></>,
-            examples: getExamples({
-                mediaTypeObject: mediaTypeObject,
-                mediaType: mediaType,
-                context: context,
-            }),
-        };
-    });
-    return (<OpenAPIMediaTypeContent selectIcon={context.icons.chevronDown} stateKey={createStateKey('response-media-types', context.blockKey)} items={tabs} context={getOpenAPIClientContext(context)}/>);
-}

package/dist/OpenAPIResponseExampleContent.d.ts

@@ -1,22 +0,0 @@
-import type { Key } from 'react-aria';
-import { OpenAPISelectItem } from './OpenAPISelect';
-type OpenAPIResponseExampleItem = OpenAPISelectItem & {
-    statusCode: string;
-    body: React.ReactNode;
-};
-/**
- * Get the state of the response examples select.
- */
-export declare function useResponseExamplesState(blockKey: string | undefined, initialKey?: Key): {
-    key: (string | number) | null;
-    setKey: (key: Key | null) => void;
-};
-export declare function OpenAPIResponseExampleContent(props: {
-    items: OpenAPIResponseExampleItem[];
-    blockKey?: string;
-    selectIcon?: React.ReactNode;
-}): import("react").JSX.Element;
-declare function OpenAPIResponseExampleItem(props: {
-    item: OpenAPIResponseExampleItem;
-}): import("react").JSX.Element;
-export {};

package/dist/OpenAPIResponseExampleContent.jsx

@@ -1,60 +0,0 @@
-'use client';
-import clsx from 'clsx';
-import { OpenAPISelect, OpenAPISelectItem, useSelectState } from './OpenAPISelect';
-import { StaticSection } from './StaticSection';
-import { createStateKey, getStatusCodeClassName } from './utils';
-/**
- * Get the state of the response examples select.
- */
-export function useResponseExamplesState(blockKey, initialKey) {
-    if (initialKey === void 0) { initialKey = 'default'; }
-    return useSelectState(getResponseExampleStateKey(blockKey), initialKey);
-}
-export function OpenAPIResponseExampleContent(props) {
-    var blockKey = props.blockKey, items = props.items, selectIcon = props.selectIcon;
-    return (<StaticSection header={<OpenAPIResponseExampleHeader selectIcon={selectIcon} blockKey={blockKey} items={items}/>} className="openapi-response-examples">
-            <OpenAPIResponseExampleBody blockKey={blockKey} items={items}/>
-        </StaticSection>);
-}
-function OpenAPIResponseExampleHeader(props) {
-    var items = props.items, blockKey = props.blockKey, selectIcon = props.selectIcon;
-    if (items.length === 1) {
-        var item = items[0];
-        if (!item) {
-            return null;
-        }
-        return (<span className="openapi-response-examples-statuscode-title">
-                <OpenAPIResponseExampleItem item={item}/>
-            </span>);
-    }
-    return (<OpenAPISelect items={items} icon={selectIcon} stateKey={getResponseExampleStateKey(blockKey)} placement="bottom start">
-            {items.map(function (item) { return (<OpenAPISelectItem key={item.key} id={item.key} value={item}>
-                    <OpenAPIResponseExampleItem item={item}/>
-                </OpenAPISelectItem>); })}
-        </OpenAPISelect>);
-}
-function OpenAPIResponseExampleItem(props) {
-    var item = props.item;
-    return (<>
-            <span className={clsx('openapi-statuscode', "openapi-statuscode-".concat(getStatusCodeClassName(item.statusCode)), 'openapi-response-examples-statuscode')}>
-                {item.statusCode}
-            </span>
-            <span className="openapi-response-examples-statuscode-label">{item.label}</span>
-        </>);
-}
-function OpenAPIResponseExampleBody(props) {
-    var _a, _b;
-    var blockKey = props.blockKey, items = props.items;
-    var state = useResponseExamplesState(blockKey, (_a = items[0]) === null || _a === void 0 ? void 0 : _a.key);
-    var selectedItem = (_b = items.find(function (item) { return item.key === state.key; })) !== null && _b !== void 0 ? _b : 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) {
-    return createStateKey('openapi-responses', blockKey);
-}

package/dist/OpenAPIResponses.d.ts

@@ -1,9 +0,0 @@
-import type { OpenAPIV3, OpenAPIV3_1 } from '@gitbook/openapi-parser';
-import type { OpenAPIClientContext } from './context';
-/**
- * Display an interactive response body.
- */
-export declare function OpenAPIResponses(props: {
-    responses: OpenAPIV3.ResponsesObject | OpenAPIV3_1.ResponsesObject;
-    context: OpenAPIClientContext;
-}): import("react").JSX.Element;

package/dist/OpenAPIResponses.jsx

@@ -1,77 +0,0 @@
-'use client';
-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 { t } from './translate';
-import { createStateKey, getStatusCodeClassName, getStatusCodeDefaultLabel, resolveDescription, } from './utils';
-/**
- * Display an interactive response body.
- */
-export function OpenAPIResponses(props) {
-    var _a;
-    var responses = props.responses, context = props.context;
-    var groups = Object.entries(responses)
-        .filter(function (_a) {
-        var _ = _a[0], response = _a[1];
-        return response && typeof response === 'object';
-    })
-        .map(function (_a) {
-        var statusCode = _a[0], response = _a[1];
-        var tabs = (function () {
-            var _a;
-            // 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}/>),
-                    },
-                ];
-            }
-            if (!response.content) {
-                return [
-                    {
-                        key: 'default',
-                        label: '',
-                        body: (<pre className="openapi-example-empty">
-                                    <p>{t(context.translation, 'no_content')}</p>
-                                </pre>),
-                    },
-                ];
-            }
-            return Object.entries((_a = response.content) !== null && _a !== void 0 ? _a : {}).map(function (_a) {
-                var contentType = _a[0], mediaType = _a[1];
-                return ({
-                    key: contentType,
-                    label: contentType,
-                    body: (<OpenAPIResponse response={response} mediaType={mediaType} context={context}/>),
-                });
-            });
-        })();
-        var description = resolveDescription(response);
-        return {
-            key: statusCode,
-            label: (<div className="openapi-response-tab-content">
-                        <span className={clsx('openapi-statuscode', "openapi-statuscode-".concat(getStatusCodeClassName(statusCode)))}>
-                            {statusCode}
-                        </span>
-                        {description ? (<Markdown source={description} className="openapi-response-description"/>) : (getStatusCodeDefaultLabel(statusCode, context))}
-                    </div>),
-            tabs: tabs,
-        };
-    });
-    var state = useResponseExamplesState(context.blockKey, (_a = groups[0]) === null || _a === void 0 ? void 0 : _a.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={function (keys) {
-            var _a;
-            var key = (_a = keys.values().next().value) !== null && _a !== void 0 ? _a : null;
-            state.setKey(key);
-        }} groups={groups} selectIcon={context.icons.chevronDown} selectStateKey={createStateKey('response-media-types', context.blockKey)}/>
-        </StaticSection>);
-}

package/dist/OpenAPISchema.d.ts

@@ -1,27 +0,0 @@
-import type { OpenAPIV3 } from '@gitbook/openapi-parser';
-import type { OpenAPIClientContext } from './context';
-export interface OpenAPISchemaPropertyEntry {
-    propertyName?: string;
-    required?: boolean | null;
-    schema: OpenAPIV3.SchemaObject;
-}
-export declare function OpenAPISchemaPropertiesFromServer(props: {
-    id?: string;
-    properties: string;
-    context: OpenAPIClientContext;
-}): import("react").JSX.Element;
-export declare function OpenAPIRootSchemaFromServer(props: {
-    schema: string;
-    context: OpenAPIClientContext;
-}): import("react").JSX.Element;
-/**
- * Render the top row of a schema. e.g: name, type, and required status.
- */
-export declare function OpenAPISchemaPresentation(props: {
-    property: OpenAPISchemaPropertyEntry;
-    context: OpenAPIClientContext;
-}): import("react").JSX.Element;
-/**
- * Get the alternatives to display for a schema.
- */
-export declare function getSchemaAlternatives(schema: OpenAPIV3.SchemaObject, ancestors?: Set<OpenAPIV3.SchemaObject>): OpenAPIV3.SchemaObject[] | null;