@redocly/theme 0.67.0-next.3 → 0.67.0-next.5

package/lib/components/TableOfContent/TableOfContent.js

@@ -65,7 +65,7 @@ function TableOfContent(props) {
                 const href = '#' + heading.id;
                 return (React.createElement(TableOfContentMenuItem, { key: href + idx, href: href, $depth: heading.depth - leastDepth + 1 || 0, className: activeHeading === heading.id ? 'active' : '', dangerouslySetInnerHTML: { __html: heading.value || '' }, "data-testid": `toc-${heading.value}`, onClick: (e) => {
                         e.preventDefault();
-                        telemetry.sendTocItemClickedMessage();
+                        telemetry.sendTocItemClickedMessage([(0, utils_1.getBaseDataAttributes)('tocItem', 'toc')]);
                         handleHeadingClick(heading.id);
                     } }));
             }))));

package/lib/components/UserMenu/LoginButton.js

@@ -7,12 +7,13 @@ exports.LoginButton = LoginButton;
 const react_1 = __importDefault(require("react"));
 const hooks_1 = require("../../core/hooks");
 const Button_1 = require("../../components/Button/Button");
+const utils_1 = require("../../core/utils");
 function LoginButton({ href, className, variant = 'primary', size = 'medium', label, labelTranslationKey = 'userMenu.login', 'data-component-name': componentName = 'UserMenu/LoginButton', }) {
     const { useTranslate, useTelemetry } = (0, hooks_1.useThemeHooks)();
     const { translate } = useTranslate();
     const telemetry = useTelemetry();
     const buttonLabel = label || translate(labelTranslationKey, 'Login');
     return (react_1.default.createElement("span", { "data-component-name": componentName, className: className },
-        react_1.default.createElement(Button_1.Button, { "data-translation-key": label ? undefined : labelTranslationKey, to: href, languageInsensitive: true, onClick: () => telemetry.sendLoginButtonClickedMessage(), "data-testid": "login-btn", extraClass: className, variant: variant, size: size }, buttonLabel)));
+        react_1.default.createElement(Button_1.Button, { "data-translation-key": label ? undefined : labelTranslationKey, to: href, languageInsensitive: true, onClick: () => telemetry.sendLoginClickedMessage([(0, utils_1.getBaseDataAttributes)('login', 'button')]), "data-testid": "login-btn", extraClass: className, variant: variant, size: size }, buttonLabel)));
 }
 //# sourceMappingURL=LoginButton.js.map

package/lib/components/UserMenu/LogoutMenuItem.js

@@ -8,13 +8,14 @@ const react_1 = __importDefault(require("react"));
 const hooks_1 = require("../../core/hooks");
 const LogoutIcon_1 = require("../../icons/LogoutIcon/LogoutIcon");
 const DropdownMenuItem_1 = require("../../components/Dropdown/DropdownMenuItem");
+const utils_1 = require("../../core/utils");
 function LogoutMenuItem({ iconOnly, className }) {
     const { useTranslate, useTelemetry, useUserMenu } = (0, hooks_1.useThemeHooks)();
     const { handleLogout } = useUserMenu();
     const telemetry = useTelemetry();
     const { translate } = useTranslate();
     const handleClick = () => {
-        telemetry.sendLogoutMenuItemClickedMessage();
+        telemetry.sendLogoutClickedMessage([(0, utils_1.getBaseDataAttributes)('logoutItem', 'userMenu')]);
         handleLogout();
     };
     return (react_1.default.createElement(DropdownMenuItem_1.DropdownMenuItem, { className: className, dangerous: true, "data-component-name": "UserMenu/LogoutMenuItem", onAction: handleClick, "data-translation-key": "userMenu.logout", prefix: react_1.default.createElement(LogoutIcon_1.LogoutIcon, null), style: { width: iconOnly ? 'fit-content' : '100%' } }, iconOnly ? null : translate('userMenu.logout', 'Log out')));

package/lib/core/hooks/search/use-search-dialog.js

@@ -10,6 +10,7 @@ const hotkeys_js_1 = __importDefault(require("hotkeys-js"));
 const use_theme_hooks_1 = require("../use-theme-hooks");
 const use_theme_config_1 = require("../use-theme-config");
 const contexts_1 = require("../../contexts");
+const utils_1 = require("../../utils");
 function useSearchDialog() {
     var _a;
     var _b;
@@ -25,7 +26,9 @@ function useSearchDialog() {
         if (hotKeys) {
             (0, hotkeys_js_1.default)(hotKeys, (ev) => {
                 setIsOpen(true);
-                telemetry.sendSearchOpenedMessage([{ object: 'search', method: 'shortcut' }]);
+                telemetry.sendSearchOpenedMessage([
+                    Object.assign(Object.assign({}, (0, utils_1.getBaseDataAttributes)('searchDialogId', 'search')), { method: 'shortcut' }),
+                ]);
                 ev.preventDefault();
             });
             return () => hotkeys_js_1.default.unbind(hotKeys);
@@ -33,7 +36,9 @@ function useSearchDialog() {
         // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [hotKeys]);
     const onOpen = (0, react_1.useCallback)(function () {
-        telemetry.sendSearchOpenedMessage([{ object: 'search', method: 'click' }]);
+        telemetry.sendSearchOpenedMessage([
+            Object.assign(Object.assign({}, (0, utils_1.getBaseDataAttributes)('searchDialogId', 'search')), { method: 'click' }),
+        ]);
         setIsOpen(true);
         // eslint-disable-next-line react-hooks/exhaustive-deps
     }, []);

package/lib/core/hooks/use-banner-telemetry.js

@@ -14,6 +14,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useBannerTelemetry = useBannerTelemetry;
 const react_1 = require("react");
 const use_theme_hooks_1 = require("./use-theme-hooks");
+const get_base_data_attributes_1 = require("../utils/telemetry/get-base-data-attributes");
 const noop = () => { };
 const noopLink = (_href) => { };
 function useBannerTelemetry(displayBanner) {
@@ -27,17 +28,7 @@ function useBannerTelemetry(displayBanner) {
                 sendBannerLinkClickedMessage: noopLink,
             };
         }
-        const bannerUri = 'urn:redocly:realm:ui:banner:banner-id';
-        const payload = {
-            id: 'banner-id',
-            object: 'banner',
-            uri: bannerUri,
-            trackingId: displayBanner.trackingId,
-            hash: displayBanner.hash,
-            color: displayBanner.color,
-            target: displayBanner.target,
-            dismissible: displayBanner.dismissible,
-        };
+        const payload = Object.assign(Object.assign({}, (0, get_base_data_attributes_1.getBaseDataAttributes)('bannerId', 'banner')), { trackingId: displayBanner.trackingId, hash: displayBanner.hash, color: displayBanner.color, target: displayBanner.target, dismissible: displayBanner.dismissible });
         return {
             sendBannerViewedMessage: () => {
                 telemetry.sendBannerViewedMessage([payload]);

package/lib/core/hooks/use-color-switcher.js

@@ -7,6 +7,7 @@ const use_theme_config_1 = require("./use-theme-config");
 const use_theme_hooks_1 = require("./use-theme-hooks");
 const use_store_1 = require("./use-store");
 const constants_1 = require("../constants");
+const utils_1 = require("../utils");
 const COLOR_MODE_KEY = 'colorSchema';
 const colorModeStore = (0, use_store_1.createStore)({
     storageKey: COLOR_MODE_KEY,
@@ -36,7 +37,7 @@ const useColorSwitcher = () => {
             root.classList.remove('notransition');
         });
         telemetry.sendColorModeSwitchedMessage([
-            { object: 'color_mode', from: activeColorMode, to: newMode },
+            ...(0, utils_1.generateBeforeAfterContext)('colorMode', 'button', { mode: activeColorMode }, { mode: newMode }),
         ]);
         setActiveColorMode(newMode);
     };

package/lib/core/hooks/use-page-actions.js

@@ -24,13 +24,7 @@ const clipboard_service_1 = require("../utils/clipboard-service");
 const dom_1 = require("../utils/dom");
 const mcp_1 = require("../utils/mcp");
 const urls_1 = require("../utils/urls");
-function createPageActionResource(pageSlug, pageUrl) {
-    return {
-        id: pageSlug,
-        object: 'page',
-        uri: pageUrl,
-    };
-}
+const get_base_data_attributes_1 = require("../utils/telemetry/get-base-data-attributes");
 const DEFAULT_ENABLED_ACTIONS = [
     'copy',
     'view',
@@ -55,19 +49,17 @@ function usePageActions(pageSlug, mcpUrl, actions) {
             ? { serverName: mcpConfig.serverName, url: mcpUrl || '' }
             : { serverName: mcpConfig.serverName, url: mcpConfig.serverUrl || '' };
         const isDocsMcp = !requiresMcpUrl;
-        const origin = dom_1.IS_BROWSER ? window.location.origin : '';
-        const pageUrl = `${origin}${pageSlug}`;
         return createMCPAction({
             clientType,
             mcpConfig: config,
             translate,
             onClickCallback: isDocsMcp
-                ? () => telemetry.sendPageActionsButtonClickedMessage([
-                    Object.assign(Object.assign({}, createPageActionResource(pageSlug, pageUrl)), { action_type: `docs-mcp-${clientType}` }),
+                ? () => telemetry.sendPageActionsClickedMessage([
+                    Object.assign(Object.assign({}, (0, get_base_data_attributes_1.getBaseDataAttributes)('pageActions', 'button')), { actionType: `docs-mcp-${clientType}` }),
                 ])
                 : undefined,
         });
-    }, [mcpUrl, mcpConfig, translate, telemetry, pageSlug]);
+    }, [mcpUrl, mcpConfig, translate, telemetry]);
     const result = (0, react_1.useMemo)(() => {
         var _a, _b;
         var _c;
@@ -83,7 +75,6 @@ function usePageActions(pageSlug, mcpUrl, actions) {
             ? window.location.origin
             : ((_c = globalThis['SSR_HOSTNAME']) !== null && _c !== void 0 ? _c : '');
         const pathname = (0, urls_1.addTrailingSlash)(pageSlug);
-        const pageUrl = (0, urls_1.combineUrls)(origin, pathname);
         const isRoot = (0, urls_1.withoutPathPrefix)(pathname) === '/';
         const mdPageUrl = isRoot
             ? (0, urls_1.combineUrls)(origin, pathname, 'index.html.md')
@@ -106,8 +97,8 @@ function usePageActions(pageSlug, mcpUrl, actions) {
                         }
                         const text = yield result.text();
                         clipboard_service_1.ClipboardService.copyCustom(text);
-                        telemetry.sendPageActionsButtonClickedMessage([
-                            Object.assign(Object.assign({}, createPageActionResource(pageSlug, pageUrl)), { action_type: 'copy' }),
+                        telemetry.sendPageActionsClickedMessage([
+                            Object.assign(Object.assign({}, (0, get_base_data_attributes_1.getBaseDataAttributes)('pageActions', 'button')), { actionType: 'copy' }),
                         ]);
                     }
                     catch (error) {
@@ -122,8 +113,8 @@ function usePageActions(pageSlug, mcpUrl, actions) {
                 iconComponent: MarkdownFullIcon_1.MarkdownFullIcon,
                 link: mdPageUrl,
                 onClick: () => {
-                    telemetry.sendPageActionsButtonClickedMessage([
-                        Object.assign(Object.assign({}, createPageActionResource(pageSlug, pageUrl)), { action_type: 'view' }),
+                    telemetry.sendPageActionsClickedMessage([
+                        Object.assign(Object.assign({}, (0, get_base_data_attributes_1.getBaseDataAttributes)('pageActions', 'button')), { actionType: 'view' }),
                     ]);
                 },
             }),
@@ -136,8 +127,8 @@ function usePageActions(pageSlug, mcpUrl, actions) {
                     iconComponent: ChatGptIcon_1.ChatGptIcon,
                     link,
                     onClick: () => {
-                        telemetry.sendPageActionsButtonClickedMessage([
-                            Object.assign(Object.assign({}, createPageActionResource(pageSlug, pageUrl)), { action_type: 'chatgpt' }),
+                        telemetry.sendPageActionsClickedMessage([
+                            Object.assign(Object.assign({}, (0, get_base_data_attributes_1.getBaseDataAttributes)('pageActions', 'button')), { actionType: 'chatgpt' }),
                         ]);
                         window.location.href = link;
                     },
@@ -152,8 +143,8 @@ function usePageActions(pageSlug, mcpUrl, actions) {
                     iconComponent: ClaudeIcon_1.ClaudeIcon,
                     link,
                     onClick: () => {
-                        telemetry.sendPageActionsButtonClickedMessage([
-                            Object.assign(Object.assign({}, createPageActionResource(pageSlug, pageUrl)), { action_type: 'claude' }),
+                        telemetry.sendPageActionsClickedMessage([
+                            Object.assign(Object.assign({}, (0, get_base_data_attributes_1.getBaseDataAttributes)('pageActions', 'button')), { actionType: 'claude' }),
                         ]);
                         window.location.href = link;
                     },

package/lib/core/hooks/use-product-picker.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useProductPicker = useProductPicker;
+const react_1 = require("react");
 const react_router_dom_1 = require("react-router-dom");
 const utils_1 = require("../../components/Product/utils");
 const use_theme_hooks_1 = require("./use-theme-hooks");
@@ -12,20 +13,29 @@ function useProductPicker() {
     const telemetry = useTelemetry();
     const navigate = (0, react_router_dom_1.useNavigate)();
     const loadAndNavigate = useLoadAndNavigate();
+    // An open dropdown can fire a menu item's onAction from an earlier render, so `product.link`
+    // may be stale (e.g. after a locale switch); resolve the live product via a ref.
+    const productsRef = (0, react_1.useRef)(products);
+    productsRef.current = products;
     function setProduct(product) {
+        var _a;
         if (!product)
             return;
-        telemetry.sendProductPickedMessage([{ object: 'product', product: product.slug }]);
+        // match on `name` (locale-stable; link/slug are re-localized)
+        const freshProduct = (_a = productsRef.current.find((p) => p.name === product.name)) !== null && _a !== void 0 ? _a : product;
+        telemetry.sendProductPickerChangedMessage([
+            ...(0, utils_2.generateBeforeAfterContext)('productPicker', 'dropdown', { product: (currentProduct === null || currentProduct === void 0 ? void 0 : currentProduct.slug) || '' }, { product: freshProduct.slug }),
+        ]);
         if (typeof document === 'undefined')
             return;
-        if (product.name) {
+        if (freshProduct.name) {
             const root = document.documentElement;
             Array.from(root.classList)
                 .filter((c) => c.startsWith('product-'))
                 .forEach((c) => root.classList.remove(c));
-            root.classList.add((0, utils_1.getProductClassName)(product.name));
+            root.classList.add((0, utils_1.getProductClassName)(freshProduct.name));
         }
-        loadAndNavigate({ navigate, to: (0, utils_2.withPathPrefix)(product.link) });
+        loadAndNavigate({ navigate, to: (0, utils_2.withPathPrefix)(freshProduct.link) });
     }
     return {
         currentProduct,

package/lib/core/hooks/use-telemetry-fallback.d.ts

@@ -1,48 +1,59 @@
 export declare const useTelemetryFallback: () => {
     send: () => void;
-    sendPageViewedMessage: () => void;
-    sendPageActionsButtonClickedMessage: () => void;
     sendErrorMessage: () => void;
     sendClientErrorMessage: () => void;
+    sendCatalogEntitiesFilterCheckboxToggledMessage: () => void;
+    sendCatalogEntitiesCopyDataSchemaClickedMessage: () => void;
+    sendCatalogEntitiesViewModeChangedMessage: () => void;
+    sendCatalogEntitiesRelatedEntitiesListSearchQueryMessage: () => void;
+    sendCatalogEntitiesRelatedEntitiesListSearchResultClickMessage: () => void;
+    sendCatalogEntitiesListSearchQueryMessage: () => void;
+    sendCatalogEntitiesListSearchResultClickedMessage: () => void;
+    sendRedirectMessage: () => void;
+    sendCustomMessage: () => void;
+    sendSearchAIQueryMessage: () => void;
+    sendSearchAiOpenedMessage: () => void;
+    sendSearchAIFeedbackMessage: () => void;
+    sendLoginClickedMessage: () => void;
+    sendLoginProviderClickedMessage: () => void;
+    sendLogoutClickedMessage: () => void;
+    sendBannerViewedMessage: () => void;
+    sendBannerLinkClickedMessage: () => void;
+    sendBannerDismissedMessage: () => void;
     sendBreadcrumbClickedMessage: () => void;
-    sendColorModeSwitchedMessage: () => void;
-    sendSidebarItemClickedMessage: () => void;
-    sendSidebarItemExpandedMessage: () => void;
-    sendSidebarItemCollapsedMessage: () => void;
-    sendChangeLayoutButtonClickedMessage: () => void;
-    sendEditPageLinkClickedMessage: () => void;
-    sendCodeSnippetReportedMessage: () => void;
-    sendNavbarMenuItemClickedMessage: () => void;
-    sendLoginButtonClickedMessage: () => void;
-    sendLoginProviderButtonClickedMessage: () => void;
-    sendLogoutMenuItemClickedMessage: () => void;
-    sendLogoClickedMessage: () => void;
-    sendTocItemClickedMessage: () => void;
+    sendCatalogActionsClickedMessage: () => void;
     sendCatalogFilterChangedMessage: () => void;
     sendCatalogItemClickedMessage: () => void;
     sendScorecardLinkClickedMessage: () => void;
-    sendBackToCatalogButtonClickedMessage: () => void;
-    sendSidebarDrilldownBackButtonClickedMessage: () => void;
+    sendFilterCheckboxToggledMessage: () => void;
+    sendFeedbackMessage: () => void;
     sendFooterItemClickedMessage: () => void;
-    sendCatalogActionsButtonClickedMessage: () => void;
-    sendMobileMenuButtonCloseClickedMessage: () => void;
-    sendMobileMenuButtonOpenClickedMessage: () => void;
-    sendSearchInputResetButtonClickedMessage: () => void;
-    sendSearchRecentRemoveButtonClickedMessage: () => void;
+    sendNavbarMenuItemClickedMessage: () => void;
+    sendColorModeSwitchedMessage: () => void;
+    sendLanguagePickerChangedMessage: () => void;
+    sendProductPickerChangedMessage: () => void;
+    sendLogoClickedMessage: () => void;
+    sendCodeSnippetReportedMessage: () => void;
+    sendMobileMenuClosedMessage: () => void;
+    sendMobileMenuOpenedMessage: () => void;
+    sendPageViewedMessage: () => void;
+    sendPageTimeMessage: () => void;
+    sendPageActionsClickedMessage: () => void;
+    sendPageEditClickedMessage: () => void;
+    sendSidebarDrilldownBackClickedMessage: () => void;
+    sendSidebarItemClickedMessage: () => void;
+    sendSidebarExpandedMessage: () => void;
+    sendSidebarCollapsedMessage: () => void;
+    sendChangeLayoutClickedMessage: () => void;
+    sendRequestApiAccessClickedMessage: () => void;
+    sendVersionPickerChangedMessage: () => void;
+    sendSearchInputResetClickedMessage: () => void;
+    sendSearchResultClickedMessage: () => void;
+    sendSearchRecentRemoveClickedMessage: () => void;
     sendSearchRecentClickedMessage: () => void;
-    sendRequestApiAccessButtonClickedMessage: () => void;
-    sendVersionPickerSelectionChangeMessage: () => void;
-    sendProductPickedMessage: () => void;
-    sendFilterCheckboxToggledMessage: () => void;
-    sendLanguagePickerLocaleChangedMessage: () => void;
     sendSearchOpenedMessage: () => void;
     sendSearchQueryMessage: () => void;
-    sendSearchAiOpenedMessage: () => void;
-    sendSearchAIQueryMessage: () => void;
-    sendSearchAIFeedbackMessage: () => void;
-    sendFeedbackMessage: () => void;
-    sendSearchResultClickedMessage: () => void;
-    sendRedirectMessage: () => void;
+    sendTocItemClickedMessage: () => void;
     sendOpenapiDocsMessage: () => void;
     sendCopyCodeSnippetClickedMessage: () => void;
     sendViewedMessage: () => void;
@@ -65,10 +76,7 @@ export declare const useTelemetryFallback: () => {
     sendAsyncapiDocsReferencedInClickedMessage: () => void;
     sendGraphqlDocsViewedMessage: () => void;
     sendGraphqlDocsPerformanceMetricsMessage: () => void;
+    sendGraphqlDocsDownloadDefinitionClickedMessage: () => void;
     sendGraphqlDocsReferencedInLinkClickedMessage: () => void;
     sendGraphqlDocsRequiredScopesModalOpenedMessage: () => void;
-    sendGraphqlDocsDownloadDefinitionClickedMessage: () => void;
-    sendBannerViewedMessage: () => void;
-    sendBannerLinkClickedMessage: () => void;
-    sendBannerDismissedMessage: () => void;
 };

package/lib/core/hooks/use-telemetry-fallback.js

@@ -1,53 +1,64 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useTelemetryFallback = void 0;
-// eslint-disable-next-line no-warning-comments
-// TODO we need to create some common way to do this.
+// Fallback no-op telemetry used by `useThemeHooks` when no ThemeDataContext
+// provider supplies real hooks.
 const useTelemetryFallback = () => ({
     send: () => { },
-    sendPageViewedMessage: () => { },
-    sendPageActionsButtonClickedMessage: () => { },
     sendErrorMessage: () => { },
     sendClientErrorMessage: () => { },
+    sendCatalogEntitiesFilterCheckboxToggledMessage: () => { },
+    sendCatalogEntitiesCopyDataSchemaClickedMessage: () => { },
+    sendCatalogEntitiesViewModeChangedMessage: () => { },
+    sendCatalogEntitiesRelatedEntitiesListSearchQueryMessage: () => { },
+    sendCatalogEntitiesRelatedEntitiesListSearchResultClickMessage: () => { },
+    sendCatalogEntitiesListSearchQueryMessage: () => { },
+    sendCatalogEntitiesListSearchResultClickedMessage: () => { },
+    sendRedirectMessage: () => { },
+    sendCustomMessage: () => { },
+    sendSearchAIQueryMessage: () => { },
+    sendSearchAiOpenedMessage: () => { },
+    sendSearchAIFeedbackMessage: () => { },
+    sendLoginClickedMessage: () => { },
+    sendLoginProviderClickedMessage: () => { },
+    sendLogoutClickedMessage: () => { },
+    sendBannerViewedMessage: () => { },
+    sendBannerLinkClickedMessage: () => { },
+    sendBannerDismissedMessage: () => { },
     sendBreadcrumbClickedMessage: () => { },
-    sendColorModeSwitchedMessage: () => { },
-    sendSidebarItemClickedMessage: () => { },
-    sendSidebarItemExpandedMessage: () => { },
-    sendSidebarItemCollapsedMessage: () => { },
-    sendChangeLayoutButtonClickedMessage: () => { },
-    sendEditPageLinkClickedMessage: () => { },
-    sendCodeSnippetReportedMessage: () => { },
-    sendNavbarMenuItemClickedMessage: () => { },
-    sendLoginButtonClickedMessage: () => { },
-    sendLoginProviderButtonClickedMessage: () => { },
-    sendLogoutMenuItemClickedMessage: () => { },
-    sendLogoClickedMessage: () => { },
-    sendTocItemClickedMessage: () => { },
+    sendCatalogActionsClickedMessage: () => { },
     sendCatalogFilterChangedMessage: () => { },
     sendCatalogItemClickedMessage: () => { },
     sendScorecardLinkClickedMessage: () => { },
-    sendBackToCatalogButtonClickedMessage: () => { },
-    sendSidebarDrilldownBackButtonClickedMessage: () => { },
+    sendFilterCheckboxToggledMessage: () => { },
+    sendFeedbackMessage: () => { },
     sendFooterItemClickedMessage: () => { },
-    sendCatalogActionsButtonClickedMessage: () => { },
-    sendMobileMenuButtonCloseClickedMessage: () => { },
-    sendMobileMenuButtonOpenClickedMessage: () => { },
-    sendSearchInputResetButtonClickedMessage: () => { },
-    sendSearchRecentRemoveButtonClickedMessage: () => { },
+    sendNavbarMenuItemClickedMessage: () => { },
+    sendColorModeSwitchedMessage: () => { },
+    sendLanguagePickerChangedMessage: () => { },
+    sendProductPickerChangedMessage: () => { },
+    sendLogoClickedMessage: () => { },
+    sendCodeSnippetReportedMessage: () => { },
+    sendMobileMenuClosedMessage: () => { },
+    sendMobileMenuOpenedMessage: () => { },
+    sendPageViewedMessage: () => { },
+    sendPageTimeMessage: () => { },
+    sendPageActionsClickedMessage: () => { },
+    sendPageEditClickedMessage: () => { },
+    sendSidebarDrilldownBackClickedMessage: () => { },
+    sendSidebarItemClickedMessage: () => { },
+    sendSidebarExpandedMessage: () => { },
+    sendSidebarCollapsedMessage: () => { },
+    sendChangeLayoutClickedMessage: () => { },
+    sendRequestApiAccessClickedMessage: () => { },
+    sendVersionPickerChangedMessage: () => { },
+    sendSearchInputResetClickedMessage: () => { },
+    sendSearchResultClickedMessage: () => { },
+    sendSearchRecentRemoveClickedMessage: () => { },
     sendSearchRecentClickedMessage: () => { },
-    sendRequestApiAccessButtonClickedMessage: () => { },
-    sendVersionPickerSelectionChangeMessage: () => { },
-    sendProductPickedMessage: () => { },
-    sendFilterCheckboxToggledMessage: () => { },
-    sendLanguagePickerLocaleChangedMessage: () => { },
     sendSearchOpenedMessage: () => { },
     sendSearchQueryMessage: () => { },
-    sendSearchAiOpenedMessage: () => { },
-    sendSearchAIQueryMessage: () => { },
-    sendSearchAIFeedbackMessage: () => { },
-    sendFeedbackMessage: () => { },
-    sendSearchResultClickedMessage: () => { },
-    sendRedirectMessage: () => { },
+    sendTocItemClickedMessage: () => { },
     sendOpenapiDocsMessage: () => { },
     sendCopyCodeSnippetClickedMessage: () => { },
     sendViewedMessage: () => { },
@@ -70,12 +81,9 @@ const useTelemetryFallback = () => ({
     sendAsyncapiDocsReferencedInClickedMessage: () => { },
     sendGraphqlDocsViewedMessage: () => { },
     sendGraphqlDocsPerformanceMetricsMessage: () => { },
+    sendGraphqlDocsDownloadDefinitionClickedMessage: () => { },
     sendGraphqlDocsReferencedInLinkClickedMessage: () => { },
     sendGraphqlDocsRequiredScopesModalOpenedMessage: () => { },
-    sendGraphqlDocsDownloadDefinitionClickedMessage: () => { },
-    sendBannerViewedMessage: () => { },
-    sendBannerLinkClickedMessage: () => { },
-    sendBannerDismissedMessage: () => { },
 });
 exports.useTelemetryFallback = useTelemetryFallback;
 //# sourceMappingURL=use-telemetry-fallback.js.map

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

@@ -124,5 +124,6 @@ export declare enum ToolCallName {
     GetEndpoints = "get-endpoints",
     GetEndpointInfo = "get-endpoint-info",
     GetSecuritySchemes = "get-security-schemes",
-    GetFullApiDescription = "get-full-api-description"
+    GetFullApiDescription = "get-full-api-description",
+    Execute = "execute"
 }

package/lib/core/types/search.js

@@ -14,5 +14,6 @@ var ToolCallName;
     ToolCallName["GetEndpointInfo"] = "get-endpoint-info";
     ToolCallName["GetSecuritySchemes"] = "get-security-schemes";
     ToolCallName["GetFullApiDescription"] = "get-full-api-description";
+    ToolCallName["Execute"] = "execute";
 })(ToolCallName || (exports.ToolCallName = ToolCallName = {}));
 //# sourceMappingURL=search.js.map

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

@@ -46,3 +46,5 @@ export * from './content-segments';
 export * from './custom-catalog-options-casing';
 export * from './get-auto-dismiss-duration';
 export * from './tooltip-placement';
+export * from './telemetry/get-base-data-attributes';
+export * from './telemetry/generate-before-after-context';

package/lib/core/utils/index.js

@@ -62,4 +62,6 @@ __exportStar(require("./content-segments"), exports);
 __exportStar(require("./custom-catalog-options-casing"), exports);
 __exportStar(require("./get-auto-dismiss-duration"), exports);
 __exportStar(require("./tooltip-placement"), exports);
+__exportStar(require("./telemetry/get-base-data-attributes"), exports);
+__exportStar(require("./telemetry/generate-before-after-context"), exports);
 //# sourceMappingURL=index.js.map

package/lib/core/utils/telemetry/generate-before-after-context.d.ts

@@ -0,0 +1,37 @@
+import type { AsyncApiRealmUI } from '@redocly/realm-asyncapi-sdk';
+type UITelemetryClient = AsyncApiRealmUI.Telemetry;
+type UITelemetryClientMethods = {
+    [K in keyof UITelemetryClient]: UITelemetryClient[K] extends (...args: any) => any ? UITelemetryClient[K] : never;
+};
+type UITelemetryClientMethodKeys = {
+    [K in keyof UITelemetryClientMethods]: Parameters<UITelemetryClientMethods[K]>[0] extends readonly [any, any, ...any[]] ? K : never;
+}[keyof UITelemetryClientMethods];
+type EventSchemaProps<T extends UITelemetryClientMethodKeys> = Parameters<UITelemetryClientMethods[T]>[0];
+type EventAfterContext<T extends UITelemetryClientMethodKeys> = EventSchemaProps<T>[0];
+type EventBeforeContext<T extends UITelemetryClientMethodKeys> = EventSchemaProps<T>[1];
+/**
+ * Builds a typed `[after, before]` tuple for Realm UI telemetry events whose AsyncAPI
+ * contract lists the updated state first, then the prior state (per CloudEvents styleguide).
+ *
+ * Each slice merges {@link getBaseDataAttributes} (`id`, `object`, `uri`) with the
+ * corresponding partial payload and sets `context` to `'after'` or `'before'`.
+ *
+ * @template T - Telemetry client method key whose `data` tuple is
+ *   `[after, before, ...]` (for example `'sendLanguagePickerChangedMessage'`).
+ * @param id - Stable resource identifier passed to {@link getBaseDataAttributes}
+ *   and included on both payloads.
+ * @param object - Resource kind passed to {@link getBaseDataAttributes}
+ *   and included on both payloads (for example `'dropdown'` or `'button'`).
+ * @param before - Event-specific fields for the prior state, excluding `id`, `object`,
+ *   `uri`, and `context` (filled by this helper).
+ * @param after - Event-specific fields for the updated state, excluding `id`, `object`,
+ *   `uri`, and `context` (filled by this helper).
+ * @returns A two-tuple in send order: the fully merged after payload, then the fully
+ *   merged before payload. Spread into the matching `send*Message` call.
+ */
+export declare function generateBeforeAfterContext<T extends UITelemetryClientMethodKeys>(id: EventAfterContext<T>['id'], object: EventAfterContext<T>['object'], before: Omit<EventBeforeContext<T>, 'id' | 'object' | 'uri' | 'context'>, after: Omit<EventAfterContext<T>, 'id' | 'object' | 'uri' | 'context'>): [EventAfterContext<T> & {
+    context: 'after';
+}, EventBeforeContext<T> & {
+    context: 'before';
+}];
+export {};

package/lib/core/utils/telemetry/generate-before-after-context.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateBeforeAfterContext = generateBeforeAfterContext;
+const get_base_data_attributes_1 = require("./get-base-data-attributes");
+/**
+ * Builds a typed `[after, before]` tuple for Realm UI telemetry events whose AsyncAPI
+ * contract lists the updated state first, then the prior state (per CloudEvents styleguide).
+ *
+ * Each slice merges {@link getBaseDataAttributes} (`id`, `object`, `uri`) with the
+ * corresponding partial payload and sets `context` to `'after'` or `'before'`.
+ *
+ * @template T - Telemetry client method key whose `data` tuple is
+ *   `[after, before, ...]` (for example `'sendLanguagePickerChangedMessage'`).
+ * @param id - Stable resource identifier passed to {@link getBaseDataAttributes}
+ *   and included on both payloads.
+ * @param object - Resource kind passed to {@link getBaseDataAttributes}
+ *   and included on both payloads (for example `'dropdown'` or `'button'`).
+ * @param before - Event-specific fields for the prior state, excluding `id`, `object`,
+ *   `uri`, and `context` (filled by this helper).
+ * @param after - Event-specific fields for the updated state, excluding `id`, `object`,
+ *   `uri`, and `context` (filled by this helper).
+ * @returns A two-tuple in send order: the fully merged after payload, then the fully
+ *   merged before payload. Spread into the matching `send*Message` call.
+ */
+function generateBeforeAfterContext(id, object, before, after) {
+    const baseAttributes = (0, get_base_data_attributes_1.getBaseDataAttributes)(id, object);
+    return [
+        Object.assign(Object.assign(Object.assign({}, baseAttributes), { context: 'after' }), after),
+        Object.assign(Object.assign(Object.assign({}, baseAttributes), { context: 'before' }), before),
+    ];
+}
+//# sourceMappingURL=generate-before-after-context.js.map

package/lib/core/utils/telemetry/generate-resource-urn.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Generates a resource URN for Realm UI telemetry.
+ * @param object - The object type.
+ * @param id - The resource ID.
+ * @returns The resource URN.
+ */
+export declare function generateResourceUrn<K, T, U>(object: K, id: T): U;

package/lib/core/utils/telemetry/generate-resource-urn.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateResourceUrn = generateResourceUrn;
+/**
+ * Generates a resource URN for Realm UI telemetry.
+ * @param object - The object type.
+ * @param id - The resource ID.
+ * @returns The resource URN.
+ */
+function generateResourceUrn(object, id) {
+    return `urn:redocly:realm:ui:${object}:${id}`;
+}
+//# sourceMappingURL=generate-resource-urn.js.map

package/lib/core/utils/telemetry/get-base-data-attributes.d.ts

@@ -0,0 +1,14 @@
+export type BaseDataAttributes<T, K, U> = {
+    /** Resource identifier (e.g. UI key, or page URL when tracking navigation). */
+    id: T;
+    /** Object kind used for telemetry categorization (e.g. `'button'`, `'page'`). */
+    object: K;
+    /** Resolved URI: the optional `url` when provided, otherwise a Realm UI resource URN. */
+    uri: U;
+};
+/**
+ * Builds the base fields for Realm UI telemetry payloads: `id`, `object`, and `uri`.
+ * When `url` is omitted, {@link generateResourceUrn} derives `uri` as
+ * `urn:redocly:realm:ui:{object}:{id}`.
+ */
+export declare function getBaseDataAttributes<T, K, U>(id: T, object: K, url?: U): BaseDataAttributes<T, K, U>;

package/lib/core/utils/telemetry/get-base-data-attributes.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBaseDataAttributes = getBaseDataAttributes;
+const generate_resource_urn_1 = require("./generate-resource-urn");
+/**
+ * Builds the base fields for Realm UI telemetry payloads: `id`, `object`, and `uri`.
+ * When `url` is omitted, {@link generateResourceUrn} derives `uri` as
+ * `urn:redocly:realm:ui:{object}:{id}`.
+ */
+function getBaseDataAttributes(id, object, url) {
+    return {
+        id,
+        object,
+        uri: url !== null && url !== void 0 ? url : (0, generate_resource_urn_1.generateResourceUrn)(object, id),
+    };
+}
+//# sourceMappingURL=get-base-data-attributes.js.map