@redocly/theme 0.58.0-next.6 → 0.58.0-next.8

package/lib/core/openapi/index.d.ts

@@ -1,5 +1,5 @@
 export type { UserClaims } from '../types/user-claims';
-export type { SearchDocument, SearchItemData, OperationParameter } from '../types/search';
+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';

package/lib/core/types/index.d.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/lib/core/types/index.js

@@ -32,4 +32,5 @@ __exportStar(require("./open-api-server"), exports);
 __exportStar(require("./marker"), exports);
 __exportStar(require("./code-walkthrough"), exports);
 __exportStar(require("./page-actions"), exports);
+__exportStar(require("./open-api-info"), exports);
 //# sourceMappingURL=index.js.map

package/lib/core/types/open-api-info.d.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/lib/core/types/open-api-info.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=open-api-info.js.map

package/lib/core/types/search.d.ts

@@ -13,7 +13,7 @@ export type OperationParameter = {
     example: string | undefined;
     enum: string[] | undefined;
 };
-export type SearchDocument = {
+export type SearchHit = {
     id: string;
     url: string;
     title: string | string[];
@@ -24,7 +24,6 @@ export type SearchDocument = {
     deprecated?: boolean;
     security?: string[];
     parameters?: OperationParameter[];
-    metadata?: Record<string, any>;
     version?: string;
     versionFolderId?: string;
     isDefaultVersion?: boolean;
@@ -48,7 +47,7 @@ export type ParameterHighlight = {
     path: string[];
 };
 export type SearchItemData = {
-    document: SearchDocument;
+    document: SearchHit;
     highlight: Record<string, string> & {
         parameters?: ParameterHighlight[];
         path?: string[];

package/lib/ext/useConfigureReplay.d.ts

@@ -1,5 +1,5 @@
 import type { ConfigureRequestValues, ConfigureServerRequestValues } from '../ext/configure';
-import type { UserClaims, OpenAPIServer } from '../core/types';
+import type { UserClaims, OpenAPIServer, OpenAPIInfo } from '../core/types';
 type ContextProps = {
     operation: {
         name: string;
@@ -8,6 +8,7 @@ type ContextProps = {
         href: string;
         method: string;
     };
+    info: OpenAPIInfo;
     servers: OpenAPIServer[];
     userClaims: UserClaims;
 };

package/lib/markdoc/components/Tabs/Tabs.d.ts

@@ -16,7 +16,8 @@ type TabsProps = {
     className?: string;
     size: TabsSize;
     forceReady?: boolean;
+    initialTab?: string;
 };
-export declare function Tabs({ children, className, size, forceReady }: TabsProps): JSX.Element;
+export declare function Tabs({ children, className, size, forceReady, initialTab: propInitialTab, }: TabsProps): JSX.Element;
 export declare const TabContent: import("styled-components").StyledComponent<"div", any, {}, never>;
 export {};

package/lib/markdoc/components/Tabs/Tabs.js

@@ -34,7 +34,7 @@ var TabsSize;
     TabsSize["SMALL"] = "small";
     TabsSize["MEDIUM"] = "medium";
 })(TabsSize || (exports.TabsSize = TabsSize = {}));
-function Tabs({ children, className, size, forceReady = false }) {
+function Tabs({ children, className, size, forceReady = false, initialTab: propInitialTab, }) {
     var _a, _b;
     const [childrenArray, setChildrenArray] = (0, react_1.useState)(react_1.default.Children.toArray(children));
     (0, react_1.useEffect)(() => {
@@ -42,7 +42,8 @@ function Tabs({ children, className, size, forceReady = false }) {
     }, [children]);
     const tabsContainerRef = (0, react_1.useRef)(null);
     const [isAnimating, setIsAnimating] = (0, react_1.useState)(false);
-    const initialTab = (_b = (_a = childrenArray[0]) === null || _a === void 0 ? void 0 : _a.props.label) !== null && _b !== void 0 ? _b : '';
+    const defaultInitialTab = (_b = (_a = childrenArray[0]) === null || _a === void 0 ? void 0 : _a.props.label) !== null && _b !== void 0 ? _b : '';
+    const initialTab = propInitialTab !== null && propInitialTab !== void 0 ? propInitialTab : defaultInitialTab;
     const { activeTab, setTabRef, onTabClick, handleKeyboard, getTabId, visibleTabs, overflowTabs, ready, allTabsHidden, } = (0, hooks_1.useTabs)({
         initialTab,
         totalTabs: childrenArray.length,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/theme",
-  "version": "0.58.0-next.6",
+  "version": "0.58.0-next.8",
   "description": "Shared UI components lib",
   "keywords": [
     "theme",
@@ -87,8 +87,8 @@
     "openapi-sampler": "1.6.1",
     "react-calendar": "5.1.0",
     "react-date-picker": "11.0.0",
-    "@redocly/config": "0.34.0",
-    "@redocly/realm-asyncapi-sdk": "0.4.0-next.2"
+    "@redocly/config": "0.35.0",
+    "@redocly/realm-asyncapi-sdk": "0.4.0-next.3"
   },
   "scripts": {
     "watch": "tsc -p tsconfig.build.json && (concurrently \"tsc -w -p tsconfig.build.json\" \"tsc-alias -w -p tsconfig.build.json\")",

package/src/core/openapi/index.ts

@@ -5,7 +5,7 @@
 // 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 { SearchDocument, SearchItemData, OperationParameter } from '../types/search';
+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';

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/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/search.ts

@@ -15,7 +15,8 @@ export type OperationParameter = {
   enum: string[] | undefined;
 };
 
-export type SearchDocument = {
+// TODO: review SearchHit type as it might contain properties that are not in the search results
+export type SearchHit = {
   id: string;
   url: string;
   title: string | string[];
@@ -26,7 +27,6 @@ export type SearchDocument = {
   deprecated?: boolean;
   security?: string[];
   parameters?: OperationParameter[];
-  metadata?: Record<string, any>;
   version?: string;
   versionFolderId?: string;
   isDefaultVersion?: boolean;
@@ -47,7 +47,7 @@ export type ParameterHighlight = {
 };
 
 export type SearchItemData = {
-  document: SearchDocument;
+  document: SearchHit;
   highlight: Record<string, string> & { parameters?: ParameterHighlight[]; path?: string[] };
 };
 

package/src/ext/useConfigureReplay.ts

@@ -4,7 +4,7 @@ import type {
   ConfigureRequestValues,
   ConfigureServerRequestValues,
 } from '@redocly/theme/ext/configure';
-import type { UserClaims, OpenAPIServer } from '@redocly/theme/core/types';
+import type { UserClaims, OpenAPIServer, OpenAPIInfo } from '@redocly/theme/core/types';
 
 type ContextProps = {
   operation: {
@@ -14,6 +14,7 @@ type ContextProps = {
     href: string;
     method: string;
   };
+  info: OpenAPIInfo;
   servers: OpenAPIServer[];
   userClaims: UserClaims;
 };

package/src/markdoc/components/Tabs/Tabs.tsx

@@ -24,9 +24,16 @@ type TabsProps = {
   className?: string;
   size: TabsSize;
   forceReady?: boolean;
+  initialTab?: string;
 };
 
-export function Tabs({ children, className, size, forceReady = false }: TabsProps): JSX.Element {
+export function Tabs({
+  children,
+  className,
+  size,
+  forceReady = false,
+  initialTab: propInitialTab,
+}: TabsProps): JSX.Element {
   const [childrenArray, setChildrenArray] = useState<React.ReactElement<TabItemProps>[]>(
     React.Children.toArray(children) as React.ReactElement<TabItemProps>[],
   );
@@ -36,7 +43,8 @@ export function Tabs({ children, className, size, forceReady = false }: TabsProp
   }, [children]);
   const tabsContainerRef = useRef<HTMLUListElement>(null);
   const [isAnimating, setIsAnimating] = useState<boolean>(false);
-  const initialTab = childrenArray[0]?.props.label ?? '';
+  const defaultInitialTab = childrenArray[0]?.props.label ?? '';
+  const initialTab = propInitialTab ?? defaultInitialTab;
   const {
     activeTab,
     setTabRef,