@gitbook/react-openapi 1.4.2 → 1.5.1

package/dist/util/server.js

@@ -1,44 +0,0 @@
-/**
- * Get the default URL for the server.
- */
-export function getDefaultServerURL(servers) {
-    var server = servers[0];
-    if (!server) {
-        // Return empty string if no server is found to display nothing
-        return '';
-    }
-    return interpolateServerURL(server);
-}
-/**
- * Interpolate the server URL with the default values of the variables.
- */
-export function interpolateServerURL(server) {
-    var _a;
-    var parts = parseServerURL((_a = server === null || server === void 0 ? void 0 : server.url) !== null && _a !== void 0 ? _a : '');
-    return parts
-        .map(function (part) {
-        var _a, _b, _c;
-        if (part.kind === 'text') {
-            return part.text;
-        }
-        return (_c = (_b = (_a = server.variables) === null || _a === void 0 ? void 0 : _a[part.name]) === null || _b === void 0 ? void 0 : _b.default) !== null && _c !== void 0 ? _c : "{".concat(part.name, "}");
-    })
-        .join('');
-}
-function parseServerURL(url) {
-    var parts = url.split(/{([^}]+)}/g);
-    var result = [];
-    for (var i = 0; i < parts.length; i++) {
-        var part = parts[i];
-        if (!part) {
-            continue;
-        }
-        if (i % 2 === 0) {
-            result.push({ kind: 'text', text: part });
-        }
-        else {
-            result.push({ kind: 'variable', name: part });
-        }
-    }
-    return result;
-}

package/dist/util/tryit-prefill.d.ts

@@ -1,20 +0,0 @@
-import type { ApiClientConfiguration } from '@scalar/types';
-import type { PrefillInputContextData } from '../OpenAPIPrefillContextProvider';
-import type { OpenAPIOperationData } from '../types';
-export interface TryItPrefillConfiguration {
-    authentication?: ApiClientConfiguration['authentication'];
-    servers?: ApiClientConfiguration['servers'];
-}
-/**
- * Resolve the Scalar API client prefill configuration for a given OpenAPI operation.
- */
-export declare function resolveTryItPrefillForOperation(args: {
-    /**
-     * The parsed OpenAPI operation.
-     */
-    operation: Pick<OpenAPIOperationData, 'securities' | 'servers'>;
-    /**
-     * Prefill input context data.
-     */
-    prefillInputContext: PrefillInputContextData | null;
-}): TryItPrefillConfiguration;

package/dist/util/tryit-prefill.js

@@ -1,129 +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);
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-import { ExpressionRuntime, parseTemplate } from '@gitbook/expr';
-/**
- * Resolve the Scalar API client prefill configuration for a given OpenAPI operation.
- */
-export function resolveTryItPrefillForOperation(args) {
-    var _a = args.operation, securities = _a.securities, servers = _a.servers, prefillInputContext = args.prefillInputContext;
-    if (!prefillInputContext) {
-        return {};
-    }
-    var runtime = new ExpressionRuntime();
-    var resolveTryItPrefillExpression = function (expr) {
-        var parts = parseTemplate(expr);
-        if (!parts.length) {
-            return undefined;
-        }
-        return runtime.evaluateTemplate(expr, prefillInputContext);
-    };
-    var prefillAuth = securities
-        ? resolveTryItPrefillAuthForOperationSecurities({
-            securities: securities,
-            resolveTryItPrefillExpression: resolveTryItPrefillExpression,
-        })
-        : undefined;
-    var prefillServers = servers
-        ? resolveTryItPrefillServersForOperationServers({ servers: servers, resolveTryItPrefillExpression: resolveTryItPrefillExpression })
-        : [];
-    return __assign(__assign({}, (prefillAuth ? { authentication: prefillAuth } : {})), (prefillServers ? { servers: prefillServers } : {}));
-}
-/**
- * Resolve prefill authentication configuration for the security schemes defined for an operation.
- */
-function resolveTryItPrefillAuthForOperationSecurities(args) {
-    var _a, _b;
-    var securities = args.securities, resolveTryItPrefillExpression = args.resolveTryItPrefillExpression;
-    var prefillAuthConfig = {};
-    for (var _i = 0, _c = Object.values(securities); _i < _c.length; _i++) {
-        var _d = _c[_i], schemeName = _d[0], security = _d[1];
-        var tryitPrefillAuthValue = security['x-gitbook-prefill']
-            ? resolveTryItPrefillExpression(security['x-gitbook-prefill'])
-            : undefined;
-        if (!tryitPrefillAuthValue) {
-            continue;
-        }
-        switch (security.type) {
-            case 'http': {
-                if ((_a = security.scheme) === null || _a === void 0 ? void 0 : _a.includes('bearer')) {
-                    prefillAuthConfig[schemeName] = { token: tryitPrefillAuthValue };
-                }
-                else if (((_b = security.scheme) === null || _b === void 0 ? void 0 : _b.includes('basic')) &&
-                    tryitPrefillAuthValue.includes(':')) {
-                    var _e = tryitPrefillAuthValue.split(':', 2), username = _e[0], password = _e[1];
-                    prefillAuthConfig[schemeName] = { username: username, password: password };
-                }
-                break;
-            }
-            case 'apiKey': {
-                prefillAuthConfig[schemeName] = {
-                    name: security.name,
-                    in: security.in,
-                    value: tryitPrefillAuthValue,
-                };
-                break;
-            }
-            case 'oauth2':
-            case 'openIdConnect': {
-                break;
-            }
-        }
-    }
-    return Object.keys(prefillAuthConfig).length > 0
-        ? { securitySchemes: prefillAuthConfig }
-        : undefined;
-}
-/**
- * Resolve prefill server configuration for the servers defined for an operation.
- */
-function resolveTryItPrefillServersForOperationServers(args) {
-    var servers = args.servers, resolveTryItPrefillExpression = args.resolveTryItPrefillExpression;
-    var resolvedServers = [];
-    for (var _i = 0, servers_1 = servers; _i < servers_1.length; _i++) {
-        var server = servers_1[_i];
-        // Url-level prefill
-        var tryItPrefillServerUrlExpr = server['x-gitbook-prefill'];
-        var tryItPrefillServerUrlValue = tryItPrefillServerUrlExpr
-            ? resolveTryItPrefillExpression(tryItPrefillServerUrlExpr)
-            : undefined;
-        var variables = server.variables
-            ? __assign({}, server.variables) : {};
-        // Variable-level prefill
-        if (server.variables) {
-            for (var _a = 0, _b = Object.entries(server.variables); _a < _b.length; _a++) {
-                var _c = _b[_a], varName = _c[0], variable = _c[1];
-                var tryItPrefillVarExpr = variable["x-gitbook-prefill"], variableProps = __rest(variable, ['x-gitbook-prefill']);
-                var tryItPrefillVarValue = tryItPrefillVarExpr
-                    ? resolveTryItPrefillExpression(tryItPrefillVarExpr)
-                    : undefined;
-                variables[varName] = __assign(__assign({}, variableProps), (tryItPrefillVarValue ? { default: String(tryItPrefillVarValue) } : {}));
-            }
-        }
-        var hasServerVariables = Object.keys(variables).length > 0;
-        if (server.url && (tryItPrefillServerUrlValue || hasServerVariables)) {
-            var resolvedServer = __assign(__assign({ url: tryItPrefillServerUrlValue !== null && tryItPrefillServerUrlValue !== void 0 ? tryItPrefillServerUrlValue : server.url }, (server.description ? { description: server.description } : {})), (hasServerVariables ? { variables: variables } : {}));
-            resolvedServers.push(resolvedServer);
-        }
-    }
-    return resolvedServers.length > 0 ? resolvedServers : undefined;
-}

package/dist/utils.d.ts

@@ -1,50 +0,0 @@
-import type { AnyObject, OpenAPIV3, OpenAPIV3_1 } from '@gitbook/openapi-parser';
-import type { OpenAPIUniversalContext } from './context';
-export declare function checkIsReference(input: unknown): input is OpenAPIV3.ReferenceObject;
-export declare function createStateKey(key: string, scope?: string): string;
-/**
- * Resolve the description of an object.
- */
-export declare function resolveDescription(object: OpenAPIV3.SchemaObject | AnyObject): string | undefined;
-/**
- * Extract descriptions from an object.
- */
-export declare function extractDescriptions(object: AnyObject): {
-    description: any;
-    'x-gitbook-description-html': any;
-};
-/**
- * Resolve the first example from an object.
- */
-export declare function resolveFirstExample(object: AnyObject): string | undefined;
-/**
- * Resolve the schema of a parameter.
- * Extract the description, example and deprecated from parameter.
- */
-export declare function resolveParameterSchema(parameter: OpenAPIV3.ParameterBaseObject): OpenAPIV3.SchemaObject;
-/**
- * Transform a parameter object to a property object.
- */
-export declare function parameterToProperty(parameter: OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject): {
-    propertyName: string | undefined;
-    schema: OpenAPIV3.SchemaObject;
-    required: boolean | undefined;
-};
-/**
- * Get the class name for a status code.
- * 1xx: informational
- * 2xx: success
- * 3xx: redirect
- * 4xx, 5xx: error
- */
-export declare function getStatusCodeClassName(statusCode: number | string): string;
-/**
- * Get a default label for a status code.
- * This is used when there is no label provided in the OpenAPI spec.
- * 1xx: Information
- * 2xx: Success
- * 3xx: Redirect
- * 4xx, 5xx: Error
- */
-export declare function getStatusCodeDefaultLabel(statusCode: number | string, context: OpenAPIUniversalContext): string;
-export declare function getSchemaTitle(schema: OpenAPIV3.SchemaObject): string;

package/dist/utils.js

@@ -1,224 +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 { stringifyOpenAPI } from './stringifyOpenAPI';
-import { tString } from './translate';
-export function checkIsReference(input) {
-    return typeof input === 'object' && !!input && '$ref' in input;
-}
-export function createStateKey(key, scope) {
-    return scope ? "".concat(scope, "_").concat(key) : key;
-}
-/**
- * Check if an object has a description. Either at the root level or in items.
- */
-function hasDescription(object) {
-    return 'description' in object || 'x-gitbook-description-html' in object;
-}
-/**
- * Resolve the description of an object.
- */
-export function resolveDescription(object) {
-    // Resolve description from the object first
-    if (hasDescription(object)) {
-        return 'x-gitbook-description-html' in object &&
-            typeof object['x-gitbook-description-html'] === 'string'
-            ? object['x-gitbook-description-html'].trim()
-            : typeof object.description === 'string'
-                ? object.description.trim()
-                : undefined;
-    }
-    // If the object has no description, try to resolve it from the items
-    if ('items' in object && typeof object.items === 'object' && hasDescription(object.items)) {
-        return resolveDescription(object.items);
-    }
-    return undefined;
-}
-/**
- * Extract descriptions from an object.
- */
-export function extractDescriptions(object) {
-    return {
-        description: object.description,
-        'x-gitbook-description-html': 'x-gitbook-description-html' in object
-            ? object['x-gitbook-description-html']
-            : undefined,
-    };
-}
-/**
- * Resolve the first example from an object.
- */
-export function resolveFirstExample(object) {
-    if ('examples' in object && typeof object.examples === 'object' && object.examples) {
-        var keys = Object.keys(object.examples);
-        var firstKey = keys[0];
-        if (firstKey && object.examples[firstKey]) {
-            return formatExample(object.examples[firstKey]);
-        }
-    }
-    // Resolve top level example first
-    if (shouldDisplayExample(object)) {
-        return formatExample(object.example);
-    }
-    // Resolve example from items if it exists
-    if (object.items && typeof object.items === 'object') {
-        return formatExample(object.items.example);
-    }
-    return undefined;
-}
-/**
- * Resolve the schema of a parameter.
- * Extract the description, example and deprecated from parameter.
- */
-export function resolveParameterSchema(parameter) {
-    var schema = checkIsReference(parameter.schema) ? undefined : parameter.schema;
-    return __assign(__assign(__assign({}, extractDescriptions(parameter)), { example: resolveFirstExample(parameter), 
-        // Deprecated can be defined at the parameter level
-        deprecated: parameter.deprecated }), schema);
-}
-/**
- * Transform a parameter object to a property object.
- */
-export function parameterToProperty(parameter) {
-    var _a;
-    if (checkIsReference(parameter)) {
-        return {
-            propertyName: (_a = parameter.$ref) !== null && _a !== void 0 ? _a : 'Unknown ref',
-            schema: {},
-            required: undefined,
-        };
-    }
-    return {
-        propertyName: parameter.name,
-        schema: resolveParameterSchema(parameter),
-        required: parameter.required,
-    };
-}
-/**
- * Format the example of a schema.
- */
-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);
-}
-/**
- * Check if an example should be displayed.
- */
-function shouldDisplayExample(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));
-}
-/**
- * Get the class name for a status code.
- * 1xx: informational
- * 2xx: success
- * 3xx: redirect
- * 4xx, 5xx: error
- */
-export function getStatusCodeClassName(statusCode) {
-    var category = getStatusCodeCategory(statusCode);
-    switch (category) {
-        case 1:
-            return 'informational';
-        case 2:
-            return 'success';
-        case 3:
-            return 'redirect';
-        case 4:
-        case 5:
-            return 'error';
-        default:
-            return 'unknown';
-    }
-}
-/**
- * Get a default label for a status code.
- * This is used when there is no label provided in the OpenAPI spec.
- * 1xx: Information
- * 2xx: Success
- * 3xx: Redirect
- * 4xx, 5xx: Error
- */
-export function getStatusCodeDefaultLabel(statusCode, context) {
-    var category = getStatusCodeCategory(statusCode);
-    switch (category) {
-        case 1:
-            return tString(context.translation, 'information');
-        case 2:
-            return tString(context.translation, 'success');
-        case 3:
-            return tString(context.translation, 'redirect');
-        case 4:
-        case 5:
-            return tString(context.translation, 'error');
-        default:
-            return '';
-    }
-}
-function getStatusCodeCategory(statusCode) {
-    var code = typeof statusCode === 'string' ? Number.parseInt(statusCode, 10) : statusCode;
-    if (Number.isNaN(code) || code < 100 || code >= 600) {
-        return 'unknown';
-    }
-    // Determine the category of the status code based on the first digit
-    var category = Math.floor(code / 100);
-    return category;
-}
-export function getSchemaTitle(schema) {
-    var _a;
-    // Otherwise try to infer a nice title
-    var type = 'any';
-    if (schema.enum || schema['x-enumDescriptions'] || schema['x-gitbook-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(schema.items), "[]");
-    }
-    else if (Array.isArray(schema.type)) {
-        type = schema.type.join(' | ');
-    }
-    else if (schema.type || schema.properties) {
-        type = (_a = schema.type) !== null && _a !== void 0 ? _a : 'object';
-        if (schema.format) {
-            type += " \u00B7 ".concat(schema.format);
-        }
-        // Only add the title if it's an object (no need for the title of a string, number, etc.)
-        if (type === 'object' && schema.title) {
-            type += " \u00B7 ".concat(schema.title.replaceAll(' ', ''));
-        }
-    }
-    if ('anyOf' in schema) {
-        type = 'any of';
-    }
-    else if ('oneOf' in schema) {
-        type = 'one of';
-    }
-    else if ('allOf' in schema) {
-        type = 'all of';
-    }
-    else if ('not' in schema) {
-        type = 'not';
-    }
-    return type;
-}

package/src/InteractiveSection.tsx

@@ -1,147 +0,0 @@
-'use client';
-
-import clsx from 'clsx';
-import { useRef } from 'react';
-import { mergeProps, useButton, useDisclosure, useFocusRing } from 'react-aria';
-import { useDisclosureState } from 'react-stately';
-import { OpenAPISelect, OpenAPISelectItem, useSelectState } from './OpenAPISelect';
-import { Section, SectionBody, SectionHeader, SectionHeaderContent } from './StaticSection';
-
-interface InteractiveSectionTab {
-    key: string;
-    label: string;
-    body: React.ReactNode;
-}
-
-/**
- * To optimize rendering, most of the components are server-components,
- * and the interactiveness is mainly handled by a few key components like this one.
- */
-export function InteractiveSection(props: {
-    id?: string;
-    /** Class name to be set on the section, sub-elements will use it as prefix */
-    className: string;
-    /** If true, the content can be toggeable */
-    toggeable?: boolean;
-    /** Default state of the toggle */
-    defaultOpened?: boolean;
-    /** Icon to display for the toggle */
-    toggleIcon?: React.ReactNode;
-    /** Tabs of content to display */
-    tabs?: Array<InteractiveSectionTab>;
-    /** Default tab to have opened */
-    defaultTab?: string;
-    /** Content of the header */
-    header?: React.ReactNode;
-    /** Children to display within the container */
-    overlay?: React.ReactNode;
-    /** State key to use with a store */
-    stateKey?: string;
-    /** Icon for the tabs select */
-    selectIcon?: React.ReactNode;
-}) {
-    const {
-        id,
-        className,
-        toggeable = false,
-        defaultOpened = true,
-        tabs = [],
-        defaultTab = tabs[0]?.key,
-        header,
-        overlay,
-        toggleIcon = '▶',
-        selectIcon,
-        stateKey = 'interactive-section',
-    } = props;
-    const state = useDisclosureState({
-        defaultExpanded: defaultOpened,
-    });
-    const panelRef = useRef<HTMLDivElement | null>(null);
-    const triggerRef = useRef<HTMLButtonElement | null>(null);
-    const { buttonProps: triggerProps, panelProps } = useDisclosure({}, state, panelRef);
-    const { buttonProps } = useButton(triggerProps, triggerRef);
-    const { isFocusVisible, focusProps } = useFocusRing();
-    const store = useSelectState(stateKey, defaultTab);
-
-    const selectedTab: InteractiveSectionTab | undefined =
-        tabs.find((tab) => tab.key === store.key) ?? tabs[0];
-
-    return (
-        <Section
-            id={id}
-            className={clsx(
-                'openapi-section',
-                toggeable ? 'openapi-section-toggeable' : null,
-                className,
-                toggeable ? `${className}-${state.isExpanded ? 'opened' : 'closed'}` : null
-            )}
-        >
-            {header ? (
-                <SectionHeader
-                    onClick={() => {
-                        if (toggeable) {
-                            state.toggle();
-                        }
-                    }}
-                    className={className}
-                >
-                    <SectionHeaderContent className={className}>
-                        {selectedTab?.body && toggeable ? (
-                            <button
-                                {...mergeProps(buttonProps, focusProps)}
-                                ref={triggerRef}
-                                className={clsx('openapi-section-toggle', `${className}-toggle`)}
-                                style={{
-                                    outline: isFocusVisible
-                                        ? '2px solid rgb(var(--primary-color-500) / 0.4)'
-                                        : 'none',
-                                }}
-                            >
-                                {toggleIcon}
-                            </button>
-                        ) : null}
-                        {header}
-                    </SectionHeaderContent>
-                    {/* biome-ignore lint/a11y/useKeyWithClickEvents: we prevent default here */}
-                    <div
-                        className={clsx(
-                            'openapi-section-header-controls',
-                            `${className}-header-controls`
-                        )}
-                        onClick={(event) => {
-                            event.stopPropagation();
-                        }}
-                    >
-                        {tabs.length > 0 ? (
-                            <OpenAPISelect
-                                stateKey={stateKey}
-                                items={tabs}
-                                onSelectionChange={() => {
-                                    state.expand();
-                                }}
-                                icon={selectIcon}
-                                placement="bottom end"
-                            >
-                                {tabs.map((tab) => (
-                                    <OpenAPISelectItem key={tab.key} id={tab.key} value={tab}>
-                                        {tab.label}
-                                    </OpenAPISelectItem>
-                                ))}
-                            </OpenAPISelect>
-                        ) : null}
-                    </div>
-                </SectionHeader>
-            ) : null}
-            {(!toggeable || state.isExpanded) && selectedTab?.body ? (
-                <SectionBody ref={panelRef} {...panelProps} className={className}>
-                    {selectedTab?.body}
-                </SectionBody>
-            ) : null}
-            {overlay ? (
-                <div className={clsx('openapi-section-overlay', `${className}-overlay`)}>
-                    {overlay}
-                </div>
-            ) : null}
-        </Section>
-    );
-}

package/src/Markdown.tsx

@@ -1,12 +0,0 @@
-import clsx from 'clsx';
-
-export function Markdown(props: { source: string; className?: string }) {
-    const { source, className } = props;
-
-    return (
-        <div
-            className={clsx('openapi-markdown', className)}
-            dangerouslySetInnerHTML={{ __html: source }}
-        />
-    );
-}