@gitbook/react-openapi 1.4.2 → 1.5.1

package/dist/OpenAPISelect.jsx

@@ -1,44 +0,0 @@
-'use client';
-import clsx from 'clsx';
-import { useCallback } from 'react';
-import { Button, ListBox, ListBoxItem, Popover, Select, SelectValue, } from 'react-aria-components';
-import { useStore } from 'zustand';
-import { getOrCreateStoreByKey } from './getOrCreateStoreByKey';
-export function useSelectState(stateKey, initialKey) {
-    if (stateKey === void 0) { stateKey = 'select-state'; }
-    if (initialKey === void 0) { initialKey = 'default'; }
-    var store = useStore(getOrCreateStoreByKey(stateKey, initialKey));
-    return {
-        key: store.key,
-        setKey: useCallback(function (key) { return store.setKey(key); }, [store.setKey]),
-    };
-}
-export function OpenAPISelect(props) {
-    var _a;
-    var _b = props.icon, icon = _b === void 0 ? '▼' : _b, items = props.items, children = props.children, className = props.className, placement = props.placement, stateKey = props.stateKey, selectedKey = props.selectedKey, onSelectionChange = props.onSelectionChange;
-    var state = useSelectState(stateKey, (_a = items[0]) === null || _a === void 0 ? void 0 : _a.key);
-    var selected = items.find(function (item) { return item.key === state.key; }) || items[0];
-    return (<Select aria-label="OpenAPI Select" {...props} selectedKey={selectedKey || (selected === null || selected === void 0 ? void 0 : selected.key)} onSelectionChange={function (key) {
-            onSelectionChange === null || onSelectionChange === void 0 ? void 0 : onSelectionChange(key);
-            state.setKey(key);
-        }} className={clsx('openapi-select', className)}>
-            <Button>
-                <SelectValue />
-                {icon}
-            </Button>
-            <Popover placement={placement} className="openapi-select-popover">
-                <ListBox className="openapi-select-listbox" items={items}>
-                    {children}
-                </ListBox>
-            </Popover>
-        </Select>);
-}
-export function OpenAPISelectItem(props) {
-    return (<ListBoxItem {...props} className={function (_a) {
-            var isFocused = _a.isFocused, isSelected = _a.isSelected;
-            return clsx('openapi-select-item', {
-                'openapi-select-item-focused': isFocused,
-                'openapi-select-item-selected': isSelected,
-            });
-        }}/>);
-}

package/dist/OpenAPISpec.d.ts

@@ -1,6 +0,0 @@
-import type { OpenAPIClientContext } from './context';
-import type { OpenAPIOperationData, OpenAPIWebhookData } from './types';
-export declare function OpenAPISpec(props: {
-    data: OpenAPIOperationData | OpenAPIWebhookData;
-    context: OpenAPIClientContext;
-}): import("react").JSX.Element;

package/dist/OpenAPISpec.jsx

@@ -1,80 +0,0 @@
-import { OpenAPIRequestBody } from './OpenAPIRequestBody';
-import { OpenAPIResponses } from './OpenAPIResponses';
-import { OpenAPISchemaProperties } from './OpenAPISchemaServer';
-import { OpenAPISecurities } from './OpenAPISecurities';
-import { StaticSection } from './StaticSection';
-import { tString } from './translate';
-import { parameterToProperty } from './utils';
-export function OpenAPISpec(props) {
-    var _a;
-    var data = props.data, context = props.context;
-    var operation = data.operation;
-    var parameters = deduplicateParameters((_a = operation.parameters) !== null && _a !== void 0 ? _a : []);
-    var parameterGroups = groupParameters(parameters, context);
-    var securities = 'securities' in data ? data.securities : [];
-    return (<>
-            {securities.length > 0 ? (<OpenAPISecurities key="securities" securities={securities} context={context}/>) : null}
-
-            {parameterGroups.map(function (group) {
-            return (<StaticSection key={"parameter-".concat(group.key)} className="openapi-parameters" header={group.label}>
-                        <OpenAPISchemaProperties properties={group.parameters.map(parameterToProperty)} context={context}/>
-                    </StaticSection>);
-        })}
-
-            {operation.requestBody ? (<OpenAPIRequestBody key="body" requestBody={operation.requestBody} context={context} data={data}/>) : null}
-            {operation.responses ? (<OpenAPIResponses key="responses" responses={operation.responses} context={context}/>) : null}
-        </>);
-}
-function groupParameters(parameters, context) {
-    var sorted = ['path', 'query', 'header'];
-    var groups = [];
-    parameters
-        .filter(function (parameter) { return parameter.in; })
-        .forEach(function (parameter) {
-        var key = parameter.in;
-        var label = getParameterGroupName(parameter.in, context);
-        var group = groups.find(function (group) { return group.key === key; });
-        if (group) {
-            group.parameters.push(parameter);
-        }
-        else {
-            groups.push({
-                key: key,
-                label: label,
-                parameters: [parameter],
-            });
-        }
-    });
-    groups.sort(function (a, b) { return sorted.indexOf(a.key) - sorted.indexOf(b.key); });
-    return groups;
-}
-function getParameterGroupName(paramIn, context) {
-    switch (paramIn) {
-        case 'path':
-            return tString(context.translation, 'path_parameters');
-        case 'query':
-            return tString(context.translation, 'query_parameters');
-        case 'header':
-            return tString(context.translation, 'header_parameters');
-        default:
-            return paramIn;
-    }
-}
-/** Deduplicate parameters by name and in.
- * Some specs have both parameters define at path and operation level.
- * We only want to display one of them.
- * Parameters can have the wrong type (object instead of array) sometimes, we just return an empty array in that case.
- */
-function deduplicateParameters(parameters) {
-    var seen = new Set();
-    return Array.isArray(parameters)
-        ? parameters.filter(function (param) {
-            var key = "".concat(param.name, ":").concat(param.in);
-            if (seen.has(key)) {
-                return false;
-            }
-            seen.add(key);
-            return true;
-        })
-        : [];
-}

package/dist/OpenAPITabs.d.ts

@@ -1,26 +0,0 @@
-import { type Key, type TabsProps } from 'react-aria-components';
-export type TabItem = {
-    key: Key;
-    label: string;
-    body: React.ReactNode;
-    footer?: React.ReactNode;
-};
-/**
- * The OpenAPI Tabs wrapper component.
- */
-export declare function OpenAPITabs(props: React.PropsWithChildren<TabsProps & {
-    items: TabItem[];
-    stateKey?: string;
-}>): import("react").JSX.Element;
-/**
- * The OpenAPI Tabs list component.
- * This component should be used as a child of the OpenAPITabs component.
- * It renders the list of tabs.
- */
-export declare function OpenAPITabsList(): import("react").JSX.Element;
-/**
- * The OpenAPI Tabs panels component.
- * This component should be used as a child of the OpenAPITabs component.
- * It renders the content of the selected tab.
- */
-export declare function OpenAPITabsPanels(): import("react").JSX.Element | null;

package/dist/OpenAPITabs.jsx

@@ -1,109 +0,0 @@
-'use client';
-import { createContext, useContext, useEffect, useMemo, useRef, useState } from 'react';
-import { Tab, TabList, TabPanel, Tabs } from 'react-aria-components';
-import { useEventCallback } from 'usehooks-ts';
-import { getOrCreateStoreByKey } from './getOrCreateStoreByKey';
-var OpenAPITabsContext = createContext(null);
-function useOpenAPITabsContext() {
-    var context = useContext(OpenAPITabsContext);
-    if (!context) {
-        throw new Error('OpenAPITabsContext is missing');
-    }
-    return context;
-}
-/**
- * The OpenAPI Tabs wrapper component.
- */
-export function OpenAPITabs(props) {
-    var _a, _b;
-    var children = props.children, items = props.items, stateKey = props.stateKey;
-    var _c = useState(function () {
-        var _a, _b;
-        if (stateKey && typeof window !== 'undefined') {
-            var store = getOrCreateStoreByKey(stateKey);
-            var tabKey_1 = store.getState().key;
-            if (tabKey_1) {
-                return tabKey_1;
-            }
-        }
-        return (_b = (_a = items[0]) === null || _a === void 0 ? void 0 : _a.key) !== null && _b !== void 0 ? _b : null;
-    }), tabKey = _c[0], setTabKey = _c[1];
-    var selectTab = useEventCallback(function (key) {
-        if (!key || key === tabKey) {
-            return;
-        }
-        var tab = items.find(function (item) { return item.key === key; });
-        if (!tab) {
-            return;
-        }
-        setTabKey(key);
-    });
-    var selectedTab = (_b = (_a = items.find(function (item) { return item.key === tabKey; })) !== null && _a !== void 0 ? _a : items[0]) !== null && _b !== void 0 ? _b : null;
-    var cancelDeferRef = useRef(null);
-    useEffect(function () {
-        if (!stateKey) {
-            return undefined;
-        }
-        var store = getOrCreateStoreByKey(stateKey);
-        return store.subscribe(function (state) {
-            var _a;
-            (_a = cancelDeferRef.current) === null || _a === void 0 ? void 0 : _a.call(cancelDeferRef);
-            cancelDeferRef.current = defer(function () { return selectTab(state.key); });
-        });
-    }, [stateKey, selectTab]);
-    useEffect(function () {
-        return function () { var _a; return (_a = cancelDeferRef.current) === null || _a === void 0 ? void 0 : _a.call(cancelDeferRef); };
-    }, []);
-    var contextValue = useMemo(function () { return ({ items: items, selectedTab: selectedTab }); }, [items, selectedTab]);
-    return (<OpenAPITabsContext.Provider value={contextValue}>
-            <Tabs className="openapi-tabs" onSelectionChange={function (tabKey) {
-            selectTab(tabKey);
-            if (stateKey) {
-                var store = getOrCreateStoreByKey(stateKey);
-                store.setState({ key: tabKey });
-            }
-        }} selectedKey={tabKey}>
-                {children}
-            </Tabs>
-        </OpenAPITabsContext.Provider>);
-}
-var defer = function (fn) {
-    var id = setTimeout(fn, 0);
-    return function () { return clearTimeout(id); };
-};
-/**
- * The OpenAPI Tabs list component.
- * This component should be used as a child of the OpenAPITabs component.
- * It renders the list of tabs.
- */
-export function OpenAPITabsList() {
-    var items = useOpenAPITabsContext().items;
-    return (<TabList className="openapi-tabs-list">
-            {items.map(function (tab) { return (<Tab key={tab.key} id={tab.key} style={function (_a) {
-                var isFocusVisible = _a.isFocusVisible;
-                return ({
-                    outline: isFocusVisible
-                        ? '2px solid rgb(var(--primary-color-500)/0.4)'
-                        : 'none',
-                });
-            }} className="openapi-tabs-tab">
-                    {tab.label}
-                </Tab>); })}
-        </TabList>);
-}
-/**
- * The OpenAPI Tabs panels component.
- * This component should be used as a child of the OpenAPITabs component.
- * It renders the content of the selected tab.
- */
-export function OpenAPITabsPanels() {
-    var selectedTab = useOpenAPITabsContext().selectedTab;
-    if (!selectedTab) {
-        return null;
-    }
-    var key = selectedTab.key.toString();
-    return (<TabPanel id={key} className="openapi-tabs-panel">
-            <div className="openapi-panel-body">{selectedTab.body}</div>
-            {selectedTab.footer ? (<div className="openapi-panel-footer">{selectedTab.footer}</div>) : null}
-        </TabPanel>);
-}

package/dist/OpenAPIWebhook.d.ts

@@ -1,10 +0,0 @@
-import { type OpenAPIContextInput } from './context';
-import type { OpenAPIWebhookData } from './types';
-/**
- * Display an interactive OpenAPI webhook.
- */
-export declare function OpenAPIWebhook(props: {
-    className?: string;
-    data: OpenAPIWebhookData;
-    context: OpenAPIContextInput;
-}): import("react").JSX.Element;

package/dist/OpenAPIWebhook.jsx

@@ -1,23 +0,0 @@
-import clsx from 'clsx';
-import { OpenAPIWebhookExample } from './OpenAPIWebhookExample';
-import { OpenAPIColumnSpec } from './common/OpenAPIColumnSpec';
-import { OpenAPISummary } from './common/OpenAPISummary';
-import { resolveOpenAPIContext } from './context';
-/**
- * Display an interactive OpenAPI webhook.
- */
-export function OpenAPIWebhook(props) {
-    var className = props.className, data = props.data, contextInput = props.context;
-    var context = resolveOpenAPIContext(contextInput);
-    return (<div className={clsx('openapi-webhook', className)}>
-            <OpenAPISummary data={data} context={context}/>
-            <div className="openapi-columns">
-                <OpenAPIColumnSpec data={data} context={context}/>
-                <div className="openapi-column-preview">
-                    <div className="openapi-column-preview-body">
-                        <OpenAPIWebhookExample data={data} context={context}/>
-                    </div>
-                </div>
-            </div>
-        </div>);
-}

package/dist/OpenAPIWebhookExample.d.ts

@@ -1,6 +0,0 @@
-import { type OpenAPIContext } from './context';
-import type { OpenAPIWebhookData } from './types';
-export declare function OpenAPIWebhookExample(props: {
-    data: OpenAPIWebhookData;
-    context: OpenAPIContext;
-}): import("react").JSX.Element;

package/dist/OpenAPIWebhookExample.jsx

@@ -1,41 +0,0 @@
-import { OpenAPIEmptyExample } from './OpenAPIExample';
-import { OpenAPIMediaTypeContent } from './OpenAPIMediaType';
-import { getOpenAPIClientContext } from './context';
-import { getExamples } from './util/example';
-import { createStateKey } from './utils';
-export function OpenAPIWebhookExample(props) {
-    var data = props.data, context = props.context;
-    var operation = data.operation;
-    var items = (function () {
-        if (!operation.requestBody) {
-            return [];
-        }
-        return Object.entries(operation.requestBody.content).map(function (_a) {
-            var key = _a[0], value = _a[1];
-            var schema = value === null || value === void 0 ? void 0 : value.schema;
-            if (!schema) {
-                return {
-                    key: key,
-                    label: key,
-                    body: <OpenAPIEmptyExample context={context}/>,
-                };
-            }
-            return {
-                key: key,
-                label: key,
-                body: <></>,
-                examples: getExamples({
-                    mediaTypeObject: value,
-                    mediaType: key,
-                    context: context,
-                }),
-            };
-        });
-    })();
-    return (<div className="openapi-panel">
-            <h4 className="openapi-panel-heading">Payload</h4>
-            <div className="openapi-panel-body">
-                <OpenAPIMediaTypeContent selectIcon={context.icons.chevronDown} stateKey={createStateKey('request-body-media-type', context.blockKey)} items={items} context={getOpenAPIClientContext(context)}/>
-            </div>
-        </div>);
-}

package/dist/ScalarApiButton.d.ts

@@ -1,14 +0,0 @@
-import type { OpenAPIV3_1 } from '@gitbook/openapi-parser';
-import type { OpenAPIClientContext } from './context';
-import type { OpenAPIOperationData } from './types';
-/**
- * Button which launches the Scalar API Client
- */
-export declare function ScalarApiButton(props: {
-    method: OpenAPIV3_1.HttpMethods;
-    path: string;
-    securities: OpenAPIOperationData['securities'];
-    servers: OpenAPIOperationData['servers'];
-    specUrl: string;
-    context: OpenAPIClientContext;
-}): import("react").JSX.Element;

package/dist/ScalarApiButton.jsx

@@ -1,81 +0,0 @@
-'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 { ApiClientModalProvider, useApiClientModal } from '@scalar/api-client-react';
-import { Suspense, useEffect, useImperativeHandle, useMemo, useRef, useState } from 'react';
-import { createPortal } from 'react-dom';
-import { useOpenAPIOperationContext } from './OpenAPIOperationContext';
-import { useOpenAPIPrefillContext } from './OpenAPIPrefillContextProvider';
-import { t } from './translate';
-import { resolveTryItPrefillForOperation } from './util/tryit-prefill';
-/**
- * Button which launches the Scalar API Client
- */
-export function ScalarApiButton(props) {
-    var method = props.method, path = props.path, securities = props.securities, servers = props.servers, specUrl = props.specUrl, context = props.context;
-    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 () {
-            var _a, _b;
-            (_b = (_a = controllerRef.current) === null || _a === void 0 ? void 0 : _a.openClient) === null || _b === void 0 ? void 0 : _b.call(_a);
-            setIsOpen(true);
-        }}>
-                {t(context.translation, 'test_it')}
-                <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 10 12" fill="currentColor">
-                    <path stroke="currentColor" strokeWidth="1.5" d="M1 10.05V1.43c0-.2.2-.31.37-.22l7.26 4.08c.17.1.17.33.01.43l-7.26 4.54a.25.25 0 0 1-.38-.21Z"/>
-                </svg>
-            </button>
-
-            {isOpen &&
-            createPortal(<Suspense fallback={null}>
-                        <ScalarModal controllerRef={controllerRef} method={method} path={path} securities={securities} servers={servers} specUrl={specUrl}/>
-                    </Suspense>, document.body)}
-        </div>);
-}
-function ScalarModal(props) {
-    var method = props.method, path = props.path, securities = props.securities, servers = props.servers, specUrl = props.specUrl, controllerRef = props.controllerRef;
-    var getPrefillInputContextData = useOpenAPIPrefillContext();
-    var prefillInputContext = getPrefillInputContextData();
-    var prefillConfig = resolveTryItPrefillForOperation({
-        operation: { securities: securities, servers: servers },
-        prefillInputContext: prefillInputContext,
-    });
-    return (<ApiClientModalProvider configuration={__assign({ url: specUrl }, prefillConfig)} 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 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/StaticSection.d.ts

@@ -1,13 +0,0 @@
-import { type ComponentPropsWithoutRef } from 'react';
-export declare function Section(props: ComponentPropsWithoutRef<'div'>): import("react").JSX.Element;
-export declare function SectionHeader(props: ComponentPropsWithoutRef<'div'>): import("react").JSX.Element;
-export declare function SectionHeaderContent(props: ComponentPropsWithoutRef<'div'>): import("react").JSX.Element;
-export declare const SectionBody: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
-export declare function SectionFooter(props: ComponentPropsWithoutRef<'div'>): import("react").JSX.Element;
-export declare function SectionFooterContent(props: ComponentPropsWithoutRef<'div'>): import("react").JSX.Element;
-export declare function StaticSection(props: {
-    className: string;
-    header?: React.ReactNode;
-    children: React.ReactNode;
-    footer?: React.ReactNode;
-}): import("react").JSX.Element;

package/dist/StaticSection.jsx

@@ -1,32 +0,0 @@
-import clsx from 'clsx';
-import { forwardRef } from 'react';
-export function Section(props) {
-    return <div {...props} className={clsx('openapi-section', props.className)}/>;
-}
-export function SectionHeader(props) {
-    return (<div {...props} className={clsx('openapi-section-header', props.className ? "".concat(props.className, "-header") : undefined)}/>);
-}
-export function SectionHeaderContent(props) {
-    return (<div {...props} className={clsx('openapi-section-header-content', props.className && "".concat(props.className, "-header-content"))}/>);
-}
-export var SectionBody = forwardRef(function SectionBody(props, ref) {
-    return (<div ref={ref} {...props} className={clsx('openapi-section-body', props.className && "".concat(props.className, "-body"))}/>);
-});
-export function SectionFooter(props) {
-    return (<div {...props} className={clsx('openapi-section-footer', props.className && "".concat(props.className, "-footer"))}/>);
-}
-export function SectionFooterContent(props) {
-    return (<div {...props} className={clsx('openapi-section-footer-content', props.className && "".concat(props.className, "-footer-content"))}/>);
-}
-export function StaticSection(props) {
-    var className = props.className, header = props.header, children = props.children, footer = props.footer;
-    return (<Section className={className}>
-            {header ? (<SectionHeader className={className}>
-                    <SectionHeaderContent className={className}>{header}</SectionHeaderContent>
-                </SectionHeader>) : null}
-            <SectionBody className={className}>{children}</SectionBody>
-            {footer ? (<SectionFooter className={className}>
-                    <SectionFooterContent className={className}>{footer}</SectionFooterContent>
-                </SectionFooter>) : null}
-        </Section>);
-}

package/dist/code-samples.d.ts

@@ -1,17 +0,0 @@
-export interface CodeSampleInput {
-    method: string;
-    url: string;
-    headers?: Record<string, string>;
-    body?: any;
-}
-export interface CodeSampleGenerator {
-    id: string;
-    label: string;
-    syntax: string;
-    generate: (operation: CodeSampleInput) => string;
-}
-export declare const codeSampleGenerators: CodeSampleGenerator[];
-export declare function parseHostAndPath(url: string): {
-    host: string | undefined;
-    path: string;
-};