@gitbook/react-openapi 1.4.3 → 1.5.2

package/dist/utils.js

@@ -1,224 +1,163 @@
-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;
+import { stringifyOpenAPI } from "./stringifyOpenAPI.js";
+import { tString } from "./translate.js";
+
+//#region src/utils.ts
+function checkIsReference(input) {
+	return typeof input === "object" && !!input && "$ref" in input;
 }
-export function createStateKey(key, scope) {
-    return scope ? "".concat(scope, "_").concat(key) : key;
+function createStateKey(key, scope) {
+	return scope ? `${scope}_${key}` : key;
 }
 /**
- * Check if an object has a description. Either at the root level or in items.
- */
+* 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;
+	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;
+* Resolve the description of an object.
+*/
+function resolveDescription(object) {
+	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() : void 0;
+	if ("items" in object && typeof object.items === "object" && hasDescription(object.items)) return resolveDescription(object.items);
 }
 /**
- * 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,
-    };
+* Extract descriptions from an object.
+*/
+function extractDescriptions(object) {
+	return {
+		description: object.description,
+		"x-gitbook-description-html": "x-gitbook-description-html" in object ? object["x-gitbook-description-html"] : void 0
+	};
 }
 /**
- * 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 first example from an object.
+*/
+function resolveFirstExample(object) {
+	if ("examples" in object && typeof object.examples === "object" && object.examples) {
+		const firstKey = Object.keys(object.examples)[0];
+		if (firstKey && object.examples[firstKey]) return formatExample(object.examples[firstKey]);
+	}
+	if (shouldDisplayExample(object)) return formatExample(object.example);
+	if (object.items && typeof object.items === "object") return formatExample(object.items.example);
 }
 /**
- * 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);
+* Resolve the schema of a parameter.
+* Extract the description, example and deprecated from parameter.
+*/
+function resolveParameterSchema(parameter) {
+	const schema = checkIsReference(parameter.schema) ? void 0 : parameter.schema;
+	return {
+		...extractDescriptions(parameter),
+		example: resolveFirstExample(parameter),
+		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,
-    };
+* Transform a parameter object to a property object.
+*/
+function parameterToProperty(parameter) {
+	if (checkIsReference(parameter)) return {
+		propertyName: parameter.$ref ?? "Unknown ref",
+		schema: {},
+		required: void 0
+	};
+	return {
+		propertyName: parameter.name,
+		schema: resolveParameterSchema(parameter),
+		required: parameter.required
+	};
 }
 /**
- * Format the example of a schema.
- */
+* 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);
+	if (typeof example === "string") return example.replace(/\n/g, " ").replace(/\s+/g, " ").replace(/([\{\}:,])\s+/g, "$1 ").replace(/\s+([\{\}:,])/g, " $1").trim();
+	return stringifyOpenAPI(example);
 }
 /**
- * Check if an example should be displayed.
- */
+* 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));
+	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 the class name for a status code.
+* 1xx: informational
+* 2xx: success
+* 3xx: redirect
+* 4xx, 5xx: error
+*/
+function getStatusCodeClassName(statusCode) {
+	switch (getStatusCodeCategory(statusCode)) {
+		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 '';
-    }
+* 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
+*/
+function getStatusCodeDefaultLabel(statusCode, context) {
+	switch (getStatusCodeCategory(statusCode)) {
+		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;
+	const code = typeof statusCode === "string" ? Number.parseInt(statusCode, 10) : statusCode;
+	if (Number.isNaN(code) || code < 100 || code >= 600) return "unknown";
+	return Math.floor(code / 100);
 }
-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;
+function getSchemaTitle(schema) {
+	let type = "any";
+	if (schema.enum || schema["x-enumDescriptions"] || schema["x-gitbook-enum"]) type = `${schema.type} · enum`;
+	else if (schema.type === "array" && !!schema.items) type = `${getSchemaTitle(schema.items)}[]`;
+	else if (Array.isArray(schema.type)) type = schema.type.join(" | ");
+	else if (schema.type || schema.properties) {
+		type = schema.type ?? "object";
+		if (schema.format) type += ` · ${schema.format}`;
+		if (type === "object" && schema.title) type += ` · ${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;
 }
+/**
+* Extract security information for an operation based on its security requirements and the spec security schemes.
+*/
+function extractOperationSecurityInfo(args) {
+	const { securityRequirement, securities } = args;
+	const securitiesMap = new Map(securities);
+	if (!securityRequirement || securityRequirement.length === 0) return securities.map(([key, security]) => ({
+		key,
+		label: key,
+		schemes: [security]
+	}));
+	return securityRequirement.map((requirement, idx) => {
+		const schemeKeys = Object.keys(requirement);
+		return {
+			key: `security-${idx}`,
+			label: schemeKeys.join(" & "),
+			schemes: schemeKeys.map((schemeKey) => securitiesMap.get(schemeKey)).filter((s) => s !== void 0)
+		};
+	});
+}
+
+//#endregion
+export { checkIsReference, createStateKey, extractOperationSecurityInfo, getSchemaTitle, getStatusCodeClassName, getStatusCodeDefaultLabel, parameterToProperty, resolveDescription, resolveFirstExample };

package/package.json

@@ -4,23 +4,22 @@
     "exports": {
         ".": {
             "types": "./dist/index.d.ts",
-            "development": "./src/index.ts",
             "default": "./dist/index.js"
         }
     },
-    "version": "1.4.3",
+    "version": "1.5.2",
     "sideEffects": false,
     "dependencies": {
-        "@gitbook/expr": "workspace:*",
-        "@gitbook/openapi-parser": "workspace:*",
+        "@gitbook/expr": "1.2.3",
+        "@gitbook/openapi-parser": "3.0.4",
         "@scalar/api-client-react": "^1.3.16",
         "@scalar/oas-utils": "^0.2.130",
         "@scalar/types": "^0.1.9",
-        "clsx": "^2.1.1",
+        "classnames": "^2.5.1",
         "flatted": "^3.2.9",
         "json-xml-parse": "^1.3.0",
-        "react-aria-components": "^1.6.0",
-        "react-aria": "^3.37.0",
+        "react-aria-components": "^1.13.0",
+        "react-aria": "^3.44.0",
         "usehooks-ts": "^3.1.0",
         "zustand": "^5.0.3",
         "js-yaml": "^4.1.0"
@@ -28,17 +27,25 @@
     "devDependencies": {
         "@types/js-yaml": "^4.0.9",
         "bun-types": "^1.1.20",
+        "react": "^19.0.0",
+        "react-dom": "^19.0.0",
+        "tsdown": "^0.15.6",
         "typescript": "^5.5.3"
     },
     "peerDependencies": {
-        "react": "*"
+        "react": "*",
+        "react-dom": "*"
     },
     "scripts": {
-        "build": "rm -rf ./dist && tsc --project tsconfig.build.json",
+        "build": "tsdown",
         "typecheck": "tsc --noEmit",
         "unit": "bun test",
-        "dev": "bun run build -- --watch",
+        "dev": "bun run build -- --watch ./src",
         "clean": "rm -rf ./dist"
     },
-    "files": ["dist", "src", "README.md", "CHANGELOG.md"]
+    "files": ["dist", "README.md", "CHANGELOG.md"],
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    }
 }

package/dist/InteractiveSection.d.ts

@@ -1,33 +0,0 @@
-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 declare 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;
-}): import("react").JSX.Element;
-export {};

package/dist/InteractiveSection.jsx

@@ -1,61 +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';
-/**
- * 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) {
-    var _a, _b;
-    var id = props.id, className = props.className, _c = props.toggeable, toggeable = _c === void 0 ? false : _c, _d = props.defaultOpened, defaultOpened = _d === void 0 ? true : _d, _e = props.tabs, tabs = _e === void 0 ? [] : _e, _f = props.defaultTab, defaultTab = _f === void 0 ? (_a = tabs[0]) === null || _a === void 0 ? void 0 : _a.key : _f, header = props.header, overlay = props.overlay, _g = props.toggleIcon, toggleIcon = _g === void 0 ? '▶' : _g, selectIcon = props.selectIcon, _h = props.stateKey, stateKey = _h === void 0 ? 'interactive-section' : _h;
-    var state = useDisclosureState({
-        defaultExpanded: defaultOpened,
-    });
-    var panelRef = useRef(null);
-    var triggerRef = useRef(null);
-    var _j = useDisclosure({}, state, panelRef), triggerProps = _j.buttonProps, panelProps = _j.panelProps;
-    var buttonProps = useButton(triggerProps, triggerRef).buttonProps;
-    var _k = useFocusRing(), isFocusVisible = _k.isFocusVisible, focusProps = _k.focusProps;
-    var store = useSelectState(stateKey, defaultTab);
-    var selectedTab = (_b = tabs.find(function (tab) { return tab.key === store.key; })) !== null && _b !== void 0 ? _b : tabs[0];
-    return (<Section id={id} className={clsx('openapi-section', toggeable ? 'openapi-section-toggeable' : null, className, toggeable ? "".concat(className, "-").concat(state.isExpanded ? 'opened' : 'closed') : null)}>
-            {header ? (<SectionHeader onClick={function () {
-                if (toggeable) {
-                    state.toggle();
-                }
-            }} className={className}>
-                    <SectionHeaderContent className={className}>
-                        {(selectedTab === null || selectedTab === void 0 ? void 0 : selectedTab.body) && toggeable ? (<button {...mergeProps(buttonProps, focusProps)} ref={triggerRef} className={clsx('openapi-section-toggle', "".concat(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', "".concat(className, "-header-controls"))} onClick={function (event) {
-                event.stopPropagation();
-            }}>
-                        {tabs.length > 0 ? (<OpenAPISelect stateKey={stateKey} items={tabs} onSelectionChange={function () {
-                    state.expand();
-                }} icon={selectIcon} placement="bottom end">
-                                {tabs.map(function (tab) { return (<OpenAPISelectItem key={tab.key} id={tab.key} value={tab}>
-                                        {tab.label}
-                                    </OpenAPISelectItem>); })}
-                            </OpenAPISelect>) : null}
-                    </div>
-                </SectionHeader>) : null}
-            {(!toggeable || state.isExpanded) && (selectedTab === null || selectedTab === void 0 ? void 0 : selectedTab.body) ? (<SectionBody ref={panelRef} {...panelProps} className={className}>
-                    {selectedTab === null || selectedTab === void 0 ? void 0 : selectedTab.body}
-                </SectionBody>) : null}
-            {overlay ? (<div className={clsx('openapi-section-overlay', "".concat(className, "-overlay"))}>
-                    {overlay}
-                </div>) : null}
-        </Section>);
-}

package/dist/Markdown.d.ts

@@ -1,4 +0,0 @@
-export declare function Markdown(props: {
-    source: string;
-    className?: string;
-}): import("react").JSX.Element;

package/dist/Markdown.jsx

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

package/dist/OpenAPICodeSample.d.ts

@@ -1,19 +0,0 @@
-import type { OpenAPIV3 } from '@gitbook/openapi-parser';
-import { type OpenAPIContext } from './context';
-import type { OpenAPIOperationData } from './types';
-/**
- * Display code samples to execute the operation.
- * It supports the Redocly custom syntax as well (https://redocly.com/docs/api-reference-docs/specification-extensions/x-code-samples/)
- */
-export declare function OpenAPICodeSample(props: {
-    data: OpenAPIOperationData;
-    context: OpenAPIContext;
-}): import("react").JSX.Element | null;
-export interface MediaTypeRenderer {
-    mediaType: string;
-    element: React.ReactNode;
-    examples: Array<{
-        example: OpenAPIV3.ExampleObject;
-        element: React.ReactNode;
-    }>;
-}