@redocly/theme 0.58.0-next.1 → 0.58.0-next.10

package/src/components/CodeBlock/CodeBlockDropdown.tsx

@@ -1,24 +1,23 @@
 import React, { type JSX } from 'react';
-import styled from 'styled-components';
 
-import type { CodeBlockDropdownItems } from '@redocly/theme/components/CodeBlock/CodeBlock';
+import type { CodeBlockItems } from '@redocly/theme/components/CodeBlock/CodeBlock';
 
 import { Dropdown } from '@redocly/theme/components/Dropdown/Dropdown';
 import { DropdownMenu } from '@redocly/theme/components/Dropdown/DropdownMenu';
 import { DropdownMenuItem } from '@redocly/theme/components/Dropdown/DropdownMenuItem';
 import { Button } from '@redocly/theme/components/Button/Button';
-import { ChevronSortIcon } from '@redocly/theme/icons/ChevronSortIcon/ChevronSortIcon';
 import { NoneIcon } from '@redocly/theme/icons/NoneIcon/NoneIcon';
 import { getFileIconByLanguage } from '@redocly/theme/core/utils';
 
-export function CodeBlockDropdown({ items, onChange, value }: CodeBlockDropdownItems): JSX.Element {
-  const activeItem = items.find((item) => item.name === value) || items[0];
+export function CodeBlockDropdown({ items, onChange, value }: CodeBlockItems): JSX.Element {
+  const activeItem = items.find((item) => item.id === value) || items[0];
   const icon = activeItem?.lang ? getFileIconByLanguage(activeItem?.lang) : null;
   return (
-    <StyledDropdown
+    <Dropdown
+      withArrow
       alignment="end"
       trigger={
-        <Button icon={<ChevronSortIcon />} iconPosition="right" variant="text" size="small">
+        <Button iconPosition="right" variant="ghost" size="small">
           {icon}
           {activeItem.name}
         </Button>
@@ -27,11 +26,12 @@ export function CodeBlockDropdown({ items, onChange, value }: CodeBlockDropdownI
       <DropdownMenu>
         {items.map((item) => {
           const icon = getFileIconByLanguage(item.lang || '');
+          const isActive = item.id === value;
           return (
             <DropdownMenuItem
-              key={item.lang}
-              onAction={() => onChange(item.name)}
-              active={item.name === activeItem.name}
+              key={item.id}
+              onAction={() => onChange(item.id)}
+              active={isActive}
               prefix={item.lang ? icon : <NoneIcon size="var(--icon-size)" />}
             >
               {item.name}
@@ -39,15 +39,6 @@ export function CodeBlockDropdown({ items, onChange, value }: CodeBlockDropdownI
           );
         })}
       </DropdownMenu>
-    </StyledDropdown>
+    </Dropdown>
   );
 }
-
-const StyledDropdown = styled(Dropdown)`
-  margin-left: auto;
-  --icon-size: 18px;
-  --button-color: var(--text-color-secondary);
-  button.button-size-small {
-    --button-icon-size: 18px;
-  }
-`;

package/src/components/CodeBlock/CodeBlockTabs.tsx

@@ -2,7 +2,7 @@ import React, { useEffect, useRef } from 'react';
 import styled, { css } from 'styled-components';
 
 import type { JSX } from 'react';
-import type { CodeBlockTabItems } from '@redocly/theme/components/CodeBlock/CodeBlock';
+import type { CodeBlockItems } from '@redocly/theme/components/CodeBlock/CodeBlock';
 
 import { useCodeBlockTabsControls } from '@redocly/theme/core/hooks';
 import { Button } from '@redocly/theme/components/Button/Button';
@@ -11,7 +11,7 @@ import { ChevronRightIcon } from '@redocly/theme/icons/ChevronRightIcon/ChevronR
 import { getFileIconByExt, getFileIconByLanguage } from '@redocly/theme/core/utils/get-file-icon';
 
 export type CodeBlockTabsProps = {
-  tabs: CodeBlockTabItems;
+  tabs: CodeBlockItems;
 };
 
 export function CodeBlockTabs({ tabs }: CodeBlockTabsProps): JSX.Element {
@@ -24,7 +24,7 @@ export function CodeBlockTabs({ tabs }: CodeBlockTabsProps): JSX.Element {
   });
 
   useEffect(() => {
-    const activeTab = tabRefs.current.find((tab) => tab?.dataset.name === tabs.value);
+    const activeTab = tabRefs.current.find((tab) => tab?.dataset.id === tabs.value);
 
     if (activeTab) {
       activeTab.scrollIntoView({ block: 'nearest', inline: 'center' });
@@ -35,23 +35,23 @@ export function CodeBlockTabs({ tabs }: CodeBlockTabsProps): JSX.Element {
     <CodeBlockTabsWrapper ref={containerRef} data-component-name="CodeBlock/CodeBlockTabs">
       <ShadowWrapper>
         <Tabs>
-          {tabs.items.map(({ name, lang }, i) => {
+          {tabs.items.map((item, i) => {
+            const { name, lang, id } = item;
             const ext = name.match(/\.([^.]+)$/)?.[1];
             const fileIcon = lang
               ? getFileIconByLanguage(lang)
               : ext
                 ? getFileIconByExt(ext)
                 : null;
-
             return (
               <Tab
                 ref={(el: HTMLButtonElement | null) => {
                   tabRefs.current[i] = el as HTMLButtonElement;
                 }}
                 data-name={name}
-                active={name === tabs.value}
-                key={name + i}
-                onClick={() => tabs.onChange(name)}
+                active={id === tabs.value}
+                key={id}
+                onClick={() => tabs.onChange(id)}
               >
                 {fileIcon}
                 {name}

package/src/components/Search/SearchDialog.tsx

@@ -306,13 +306,16 @@ export function SearchDialog({ onClose, className }: SearchDialogProps): JSX.Ele
                     aria-selected="true"
                   >
                     <AiStarsIcon
+                      style={{ flexShrink: 0 }}
                       color="var(--search-ai-icon-color)"
                       size="36px"
                       background="var(--search-ai-icon-bg-color)"
                       margin="0 var(--spacing-md) 0 0"
                       borderRadius="var(--border-radius-lg)"
                     />
-                    <Typography fontWeight="var(--font-weight-semibold)">{query}</Typography>
+                    <QueryWrapper>
+                      <Typography fontWeight="var(--font-weight-semibold)">{query}</Typography>
+                    </QueryWrapper>
                     <Typography>- {translate('search.ai.label', 'Ask AI assistant')}</Typography>
                     <ReturnKeyIcon color="var(--search-item-text-color)" />
                   </SearchWithAI>
@@ -484,10 +487,10 @@ const SearchDialogWrapper = styled.div`
   border-radius: 0;
 
   @media screen and (max-width: ${breakpoints.small}) {
-    min-height: -webkit-fill-available !important;
-    min-height: 100dvh !important;
-    height: auto !important;
-    width: 100vw !important;
+    min-height: -webkit-fill-available;
+    min-height: 100dvh;
+    height: 100dvh;
+    width: 100vw;
   }
 
   @media screen and (min-width: ${breakpoints.small}) {
@@ -539,6 +542,8 @@ const SearchDialogBodyMainView = styled.div`
 
 const SearchDialogBodyFilterView = styled.div`
   overflow: scroll;
+  max-width: var(--search-filter-width);
+  width: 100%;
 `;
 
 const SearchDialogFooter = styled.footer`
@@ -673,3 +678,7 @@ const SearchWithAI = styled.div`
     margin-right: var(--spacing-xs);
   }
 `;
+
+const QueryWrapper = styled.div`
+  word-break: break-word;
+`;

package/src/components/Search/SearchFilter.tsx

@@ -66,7 +66,8 @@ export function SearchFilter({
 }
 
 const SearchFilterWrapper = styled.div`
-  width: var(--search-filter-width);
+  width: 100%;
+  max-width: var(--search-filter-width);
   display: flex;
   flex-direction: column;
   padding: var(--search-filter-padding);

package/src/components/Tooltip/Tooltip.tsx

@@ -98,14 +98,12 @@ export function TooltipComponent({
   }, [isOpened, placement, updateTooltipPosition]);
 
   useEffect(() => {
-    if (isControlled && !disabled) {
-      if (isOpen) {
-        handleOpen();
-      } else {
-        handleClose();
-      }
+    if (isOpen && !disabled) {
+      handleOpen();
+    } else {
+      handleClose();
     }
-  }, [isOpen, isControlled, handleOpen, handleClose, disabled]);
+  }, [isOpen, handleOpen, handleClose, disabled]);
 
   const controllers = !isControlled &&
     !disabled && {
@@ -268,7 +266,7 @@ const TooltipBody = styled.span<
   display: inline-block;
 
   padding: var(--tooltip-padding);
-  max-width: var(--tooltip-max-width);
+  max-width: ${({ width }) => width || 'var(--tooltip-max-width)'};
   white-space: normal;
   word-break: normal;
   overflow-wrap: break-word;

package/src/components/Tooltip/TooltipWrapper.tsx

@@ -26,7 +26,7 @@ export function TooltipWrapper({
   showOnHover = true,
   disabled = false,
 }: TooltipWrapperProps): JSX.Element {
-  const tooltip = useControl();
+  const tooltip = useControl(false);
 
   const handleMouseEnter = (): void => {
     if (showOnHover && !disabled) {

package/src/core/constants/catalog.ts

@@ -2,33 +2,15 @@ import type { EntityRelationType } from '../types/catalog';
 
 export const CATALOG_TAG_MAX_LENGTH = 15;
 
-export const ENTITY_RELATION_TYPES = [
-  'partOf',
-  'hasParts',
-  'creates',
-  'createdBy',
-  'owns',
-  'ownedBy',
-  'implements',
-  'implementedBy',
-  'dependsOn',
-  'dependencyOf',
-  'uses',
-  'usedBy',
-  'produces',
-  'consumes',
-  'linksTo',
-  'supersedes',
-  'supersededBy',
-  'compatibleWith',
-  'extends',
-  'extendedBy',
-  'relatesTo',
-  'hasMember',
-  'memberOf',
-  'triggers',
-  'triggeredBy',
-] as const;
+export const PREDEFINED_ENTITY_TYPES = [
+  'service',
+  'domain',
+  'team',
+  'user',
+  'api-description',
+  'data-schema',
+  'api-operation',
+];
 
 export const reverseRelationMap: Record<EntityRelationType, EntityRelationType> = {
   partOf: 'hasParts',
@@ -56,6 +38,8 @@ export const reverseRelationMap: Record<EntityRelationType, EntityRelationType>
   memberOf: 'hasMember',
   triggers: 'triggeredBy',
   triggeredBy: 'triggers',
+  returns: 'returnedBy',
+  returnedBy: 'returns',
 } as const;
 
 export const relationTypeMap: Record<EntityRelationType, string> = {
@@ -84,6 +68,8 @@ export const relationTypeMap: Record<EntityRelationType, string> = {
   memberOf: 'Member of',
   triggers: 'Triggers',
   triggeredBy: 'Triggered by',
+  returns: 'Returns',
+  returnedBy: 'Returned by',
 };
 
 export enum GraphHandleType {

package/src/core/contexts/CodeSnippetContext.tsx

@@ -1,31 +1,67 @@
-import { createContext, useContext, useState } from 'react';
+import React, { createContext, useContext, useCallback, useMemo } from 'react';
 
-export type CodeSnippetContextType = {
-  activeSnippetName: string;
-  setActiveSnippetName: (name: string) => void;
-};
+import { useLocalState } from '../hooks/use-local-state';
 
 export const CODE_GROUP_SNIPPET_NAME_KEY = 'redocly:codeGroupSnippetName';
 
+type CodeSnippetContextType = {
+  activeSnippets: Record<string, string>;
+  setActiveSnippet: (groupId: string, snippetId: string) => void;
+};
+
 export const CodeSnippetContext = createContext<CodeSnippetContextType | null>(null);
 
-export function useActiveCodeSnippetName(
-  mode: 'tabs' | 'dropdown',
-): [string, (name: string) => void] {
+export function CodeSnippetProvider({ children }: { children: React.ReactNode }) {
+  const [activeSnippets, setActiveSnippets] = useLocalState<Record<string, string>>(
+    CODE_GROUP_SNIPPET_NAME_KEY,
+    {},
+  );
+
+  const setActiveSnippet = useCallback(
+    (groupId: string, snippetId: string) => {
+      setActiveSnippets({ ...activeSnippets, [groupId]: snippetId });
+    },
+    [activeSnippets, setActiveSnippets],
+  );
+
+  const contextValue = { activeSnippets, setActiveSnippet };
+
+  return <CodeSnippetContext.Provider value={contextValue}>{children}</CodeSnippetContext.Provider>;
+}
+
+export const useCodeSnippetContext = (): CodeSnippetContextType => {
   const context = useContext(CodeSnippetContext);
+
   if (!context) {
     throw new Error('useCodeSnippetContext must be used within a CodeSnippetContext');
   }
 
-  const [activeSnippetName, setActiveSnippetName] = useState(
-    mode === 'tabs' ? '' : context.activeSnippetName,
+  return context;
+};
+
+export const useActiveCodeSnippetId = (
+  groupId?: string,
+  availableSnippets?: { id: string }[],
+): [string, (id: string) => void] => {
+  const { activeSnippets, setActiveSnippet } = useCodeSnippetContext();
+
+  const storedSnippetId = groupId ? activeSnippets[groupId] || '' : '';
+
+  const activeId = useMemo(() => {
+    if (!availableSnippets?.length) return storedSnippetId;
+
+    const found = storedSnippetId && availableSnippets.find((s) => s.id === storedSnippetId);
+    return found ? storedSnippetId : availableSnippets[0]?.id || '';
+  }, [storedSnippetId, availableSnippets]);
+
+  const setActiveSnippetId = useCallback(
+    (id: string) => {
+      if (groupId) {
+        setActiveSnippet(groupId, id);
+      }
+    },
+    [groupId, setActiveSnippet],
   );
 
-  if (mode === 'tabs') {
-    // use non-synced state for tabs mode
-    return [activeSnippetName, setActiveSnippetName];
-  } else {
-    // use global synced state for dropdown mode
-    return [context.activeSnippetName, context.setActiveSnippetName];
-  }
-}
+  return [activeId, setActiveSnippetId];
+};

package/src/core/hooks/catalog/useCatalogTableViewRow.ts

@@ -21,7 +21,7 @@ export function useCatalogTableViewRow({
     }
 
     return Object.values(entitiesCatalogConfig.catalogs ?? {}).find((catalog) => {
-      return catalog.includes?.some((include) => include.type === entityType);
+      return catalog?.includes?.some((include) => include.type === entityType);
     });
   };
 

package/src/core/hooks/use-active-section-id.ts

@@ -25,6 +25,12 @@ export function useActiveSectionId(
           setItemId('');
           return;
         }
+
+        if (window.scrollY <= 0) {
+          setItemId(sections[0].getAttribute('data-section-id') || '');
+          return;
+        }
+
         for (let i = 0; i < sections.length; i++) {
           const section = sections[i];
           const rect = section.getBoundingClientRect();

package/src/core/hooks/use-codeblock-tabs-controls.ts

@@ -1,9 +1,9 @@
 import { useEffect, useState, useCallback, useMemo } from 'react';
 
-import type { CodeBlockTabItems } from '../../components/CodeBlock/CodeBlock';
+import type { CodeBlockItems } from '../../components/CodeBlock/CodeBlock';
 
 type CodeBlockTabsProps = {
-  tabs: CodeBlockTabItems;
+  tabs: CodeBlockItems;
   containerRef: React.RefObject<HTMLDivElement | null>;
   tabRefs: React.RefObject<HTMLButtonElement[]>;
 };

package/src/core/hooks/use-control.ts

@@ -1,4 +1,6 @@
-import { useState, useCallback } from 'react';
+import { useState, useCallback, useRef } from 'react';
+
+const DEFAULT_CONTROL_OPEN_DELAY = 300;
 
 export type UseControlReturnType = {
   isOpened: boolean;
@@ -8,9 +10,25 @@ export type UseControlReturnType = {
 
 export const useControl = (initialVal = false): UseControlReturnType => {
   const [isOpened, setIsOpened] = useState<boolean>(initialVal);
+  const timeoutRef = useRef<ReturnType<typeof setTimeout> | null>(null);
+
+  const clearOpenTimer = useCallback(() => {
+    if (timeoutRef.current) {
+      clearTimeout(timeoutRef.current);
+    }
+  }, []);
+
+  const handleOpen = useCallback(() => {
+    clearOpenTimer();
+    timeoutRef.current = setTimeout(() => {
+      setIsOpened(true);
+    }, DEFAULT_CONTROL_OPEN_DELAY);
+  }, [clearOpenTimer]);
 
-  const handleOpen = useCallback(() => setIsOpened(true), []);
-  const handleClose = useCallback(() => setIsOpened(false), []);
+  const handleClose = useCallback(() => {
+    clearOpenTimer();
+    setIsOpened(false);
+  }, [clearOpenTimer]);
 
   return {
     isOpened,

package/src/core/hooks/use-local-state.ts

@@ -1,30 +1,39 @@
-import { useState, useEffect } from 'react';
+import { useState, useEffect, useCallback } from 'react';
+
+import { isBrowser } from '../utils/js-utils';
+
+function getStoredValue<T>(key: string, fallback: T): T {
+  if (!isBrowser()) return fallback;
 
-function getInitialValue<T>(key: string, initialValue: T): T {
-  if (typeof window === 'undefined') {
-    return initialValue;
-  }
   try {
     const savedValue = localStorage.getItem(key);
-    if (savedValue) {
-      return JSON.parse(savedValue) as T;
-    }
-  } catch (error) {
-    console.error(`Error reading from localStorage for key "${key}":`, error);
+    return savedValue ? (JSON.parse(savedValue) as T) : fallback;
+  } catch {
+    return fallback;
   }
-  return initialValue;
 }
 
 export function useLocalState<T>(key: string, initialValue: T): [T, (value: T) => void] {
-  const [value, setValue] = useState<T>(() => getInitialValue(key, initialValue));
+  const [value, setValue] = useState<T>(initialValue);
 
+  // Load stored value from localStorage after component mounts
+  // This ensures SSR compatibility: server and client both start with initialValue,
+  // then client loads the actual stored value without hydration mismatch
   useEffect(() => {
-    try {
-      localStorage.setItem(key, JSON.stringify(value));
-    } catch (error) {
-      console.error(`Error writing to localStorage for key "${key}":`, error);
-    }
-  }, [key, value]);
+    if (!isBrowser()) return;
+    setValue(getStoredValue(key, initialValue));
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [key]);
+
+  const handleSetValue = useCallback(
+    (newValue: T) => {
+      setValue(newValue);
+      if (isBrowser()) {
+        localStorage.setItem(key, JSON.stringify(newValue));
+      }
+    },
+    [key],
+  );
 
-  return [value, setValue] as const;
+  return [value, handleSetValue] as const;
 }

package/src/core/hooks/use-telemetry-fallback.ts

@@ -58,4 +58,9 @@ export const useTelemetryFallback = () => ({
   sendAsyncapiDocsMessageClickedMessage: () => {},
   sendAsyncapiDocsServerModalOpenedMessage: () => {},
   sendAsyncapiDocsDownloadDefinitionClickedMessage: () => {},
+  sendGraphqlDocsViewedMessage: () => {},
+  sendGraphqlDocsPerformanceMetricsMessage: () => {},
+  sendGraphqlDocsReferencedInLinkClickedMessage: () => {},
+  sendGraphqlDocsRequiredScopesModalOpenedMessage: () => {},
+  sendGraphqlDocsDownloadDefinitionClickedMessage: () => {},
 });

package/src/core/openapi/index.ts

@@ -4,6 +4,10 @@
 // This selective import approach will help with tree shaking and reduce
 // the overall bundle size by avoiding importing the entire theme package
 // when only specific functionality is needed.
+export type { UserClaims } from '../types/user-claims';
+export type { OperationParameter, ParameterHighlight } from '../types/search';
+export type { TFunction, TOptions } from '../types/l10n';
+export type { SelectOption, SelectProps } from '../types/select';
 export { IS_BROWSER } from '../utils/dom';
 export {
   addLeadingSlash,
@@ -18,15 +22,15 @@ export { useMount } from '../hooks/use-mount';
 export { GlobalStyle } from '../styles/global';
 export { breakpoints } from '../utils/media-css';
 export { isPrimitive } from '../utils/args-typecheck';
-export type { UserClaims } from '../types/user-claims';
+export { ClipboardService } from '../utils/clipboard-service';
+export { getUserAgent } from '../utils/get-user-agent';
 export { useFocusTrap } from '../hooks/use-focus-trap';
-export type { TFunction, TOptions } from '../types/l10n';
 export { useThemeHooks } from '../hooks/use-theme-hooks';
 export { useOutsideClick } from '../hooks/use-outside-click';
-export type { SelectOption, SelectProps } from '../types/select';
 export { useActiveSectionId } from '../hooks/use-active-section-id';
 export { useModalScrollLock } from '../hooks/use-modal-scroll-lock';
+export { useSearchDialog } from '../hooks/search/use-search-dialog';
+export { useDialogHotKeys } from '../hooks/use-dialog-hotkeys';
 export { SecurityVariablesEnvSuffix } from '../constants/environments';
 export { isUndefined, isString, isNotNull, isObject } from '../utils/type-guards';
 export { ThemeDataContext, type ThemeDataTransferObject } from '../contexts/ThemeDataContext';
-export { ENTITY_RELATION_TYPES } from '../constants/catalog';

package/src/core/styles/global.ts

@@ -780,6 +780,25 @@ const apiReferenceDocs = css`
   --fab-icon-color: var(--navbar-text-color); // @presenter Color
 
   // @tokens End
+
+  /**
+    * @tokens OpenAPI Schema Catalog Link
+   */
+
+  --schema-catalog-link-margin-bottom: var(--spacing-lg);
+  --schema-catalog-link-padding: 2px;
+  --schema-catalog-link-border-radius: var(--border-radius-md);
+  --schema-catalog-link-background-color: var(--layer-color);
+  --schema-catalog-link-color: var(--color-purple-7);
+
+  --schema-catalog-link-share-icon-color: var(--color-purple-7);
+  --schema-catalog-link-share-icon-background-color: var(--color-purple-1);
+  --schema-catalog-link-share-icon-border-radius: var(--border-radius-md);
+  --schema-catalog-link-share-icon-wrapper-size: var(--spacing-xl);
+
+  --schema-catalog-link-text-color: var(--text-color-primary);
+
+  // @tokens End
 `;
 
 const badges = css`

package/src/core/types/catalog.ts

@@ -1,10 +1,9 @@
 import { InfiniteData, UseInfiniteQueryResult } from '@tanstack/react-query';
 import { CatalogEntityConfig, LayoutVariant } from '@redocly/config';
+import { ENTITY_RELATION_TYPES } from '@redocly/config';
 
 import type { CatalogFilterConfig } from '@redocly/theme/config';
 
-import { ENTITY_RELATION_TYPES } from '../constants/catalog';
-
 export type SortOption = 'title' | '-title' | 'type' | '-type';
 
 export type UseCatalogResponse = {

package/src/core/types/hooks.ts

@@ -17,6 +17,7 @@ import type {
   FilteredCatalog,
   UseCatalogSortResponse,
   UseCatalogSearchResponse,
+  CatalogViewMode,
 } from './catalog';
 import type { UserMenuData } from './user-menu';
 import type { ItemState } from './sidebar';
@@ -139,7 +140,11 @@ export type ThemeHooks = {
         nextPage?: ResolvedNavItemWithLink;
       }
     | undefined;
-  useCatalog: (config?: CatalogEntityConfig, entitiesCounterInitial?: number) => UseCatalogResponse;
+  useCatalog: (
+    config?: CatalogEntityConfig,
+    entitiesCounterInitial?: number,
+    initialViewMode?: CatalogViewMode,
+  ) => UseCatalogResponse;
   useCatalogSort: () => UseCatalogSortResponse;
   useCatalogSearch: () => UseCatalogSearchResponse;
   useFetchCatalogEntities: (

package/src/core/types/index.ts

@@ -16,3 +16,4 @@ export * from './open-api-server';
 export * from './marker';
 export * from './code-walkthrough';
 export * from './page-actions';
+export * from './open-api-info';

package/src/core/types/l10n.ts

@@ -280,6 +280,9 @@ export type TranslationKey =
   | 'openapi.requiredScopes'
   | 'openapi.unsupportedLanguage'
   | 'openapi.failedToGenerateCodeSample'
+  | 'openapi.schemaCatalogLink.title'
+  | 'openapi.schemaCatalogLink.copyButtonTooltip'
+  | 'openapi.schemaCatalogLink.copiedTooltip'
   | 'asyncapi.download.description.title'
   | 'asyncapi.info.title'
   | 'graphql.queries'

package/src/core/types/open-api-info.ts

@@ -0,0 +1,34 @@
+export type OpenAPIInfo = {
+  title: string;
+  version: string;
+  description?: string;
+  summary?: string;
+  termsOfService?: string;
+  contact?: {
+    name?: string;
+    url?: string;
+    email?: string;
+  };
+  license?: {
+    name: string;
+    url?: string;
+    identifier?: string;
+  };
+  externalDocs?: {
+    description?: string;
+    url: string;
+  };
+  'x-logo'?: {
+    url?: string;
+    backgroundColor?: string;
+    altText?: string;
+    href?: string;
+  };
+  'x-metadata'?: {
+    apiId?: string;
+    [key: string]: unknown;
+  };
+  'x-seo'?: {
+    title?: string;
+  };
+};

package/src/core/types/open-api-server.ts

@@ -1,6 +1,7 @@
 export type OpenAPIServer = {
   url: string;
   description?: string;
+  name?: string;
   variables?: Record<
     string,
     {