// --- Base Config --- window.projectSlug = window.location.pathname.split("/").find(Boolean) || ""; const TechDocsConfig = { debug: true, selectors: { superHub: "#ssr-main > div > div[class^='SuperHub']", pageNotFound: "div[class^='PageNotFound'].rm-Container", ssrProps: "#ssr-props", searchModal: ".rm-SearchModal, [class*='SearchModal']", primaryNav: 'nav[aria-label="Primary navigation"]', changelogPost: ".rm-Changelog article[class*='ChangelogPostExcerpt']", apiTitle: ".rm-Sidebar-section .rm-Sidebar-link:not([class*='Sidebar-link_hidden'])", aiSelectorsBtn: 'button, a.Menu-Item[role="button"], div.Menu-Item[role="button"]' }, projects: { onlyAuthHelp: [ "aura-secret-mgmt", "aura-lcdn-services", "aura-network-policy", "aura-lcdn-mapping", "aura-log-streaming", "aura-infrastructure", "aura-lcdn-deployment", "aura-lcdn-content-delivery", "aura-lcdn-content-control", "linode-api", "cloudtest", "msl5-harmonic" ], mutualAuth: ["iot-edge-message-stream", "iot-edge-connect-msg-store"], skipCodeComments: ["mpulse", "aura-secret-mgmt", "aura-lcdn-services", "aura-network-policy"], // Extracted dynamically if needed authLinks: ["mpulse", "cloudtest", "identity-cloud", "netstorage-usage", "iot-edge-message-stream", "iot-edge-connect-msg-store"], collapseTablesByDefault: ["terraform", "powershell", "quick-deploy-apps", "internal-poc-api"] }, trackedButtons: new Set(['Copy Page', 'Open in ChatGPT', 'Open in Claude', 'View as Markdown']) }; const Logger = { log: (msg, ...args) => console.log(`%c[TechDocs]`, 'color: #0174BC; font-weight: bold;', msg, ...args), error: (msg, ...args) => console.error(`%c[TechDocs]`, 'color: red; font-weight: bold;', msg, ...args), warn: (msg, ...args) => console.warn(`%c[TechDocs]`, 'color: #ff8b00; font-weight: bold;', msg, ...args), debug: TechDocsConfig.debug ? (msg, ...args) => console.log(`%c[TechDocs]`, 'color: #0174BC; font-weight: bold;', msg, ...args) : () => {} }; const Utils = { delay: (ms = 500) => new Promise(resolve => setTimeout(resolve, ms)), debounce(func, wait) { let timeout; return function (...args) { clearTimeout(timeout); timeout = setTimeout(() => func.apply(this, args), wait); }; }, async fetchData(url, isText = false) { try { const response = await fetch(url, { method: "GET", cache: "default", headers: { Accept: "application/json" }, redirect: "follow" }); Logger.debug(`Fetched data from ${url}`); return isText ? await response.text() : await response.json(); } catch (e) { Logger.error(`Fetch failure on ${url}`, e); return null; } }, isExternalLink(link) { if (!link || link.startsWith("/") || link.startsWith("#")) return false; const isSameSite = link.startsWith(window.location.origin); const isPdf = link.endsWith(".pdf") || link.includes(".pdf#"); return (isSameSite && isPdf) || !isSameSite; }, isPrivateLink(href, privateProjects = []) { return privateProjects.some(p => href.includes(p)); }, waitFor(selectors, { all = false, settleTime = 0, maxWait = 5000, root = document.body } = {}) { const selectorList = Array.isArray(selectors) ? selectors : [selectors]; // Helper to find elements based on the 'all' flag const findElements = () => { const results = selectorList.map(selector => { if (all) { const elements = [...document.querySelectorAll(selector)]; return elements.length ? elements : null; } return document.querySelector(selector); }); // Ensure every selector found at least one match if (results.every(Boolean)) { return selectorList.length > 1 ? results : results[0]; } return null; }; return new Promise(resolve => { let settleTimer; let failSafeTimer; const finish = (result) => { observer?.disconnect(); clearTimeout(failSafeTimer); clearTimeout(settleTimer); Logger.debug(`Element(s) found for selector(s): ${selectorList.join(", ")}`); resolve(result); }; // Check immediately const existing = findElements(); // If found immediately and no settle time is needed, resolve right away if (existing && !settleTime) { Logger.debug(`Element(s) found for selector(s): ${selectorList.join(", ")}`); return resolve(existing); } const observer = new MutationObserver(() => { const result = findElements(); if (!result) { // If element disappears during the settle period, reset the timer clearTimeout(settleTimer); return; } clearTimeout(settleTimer); if (settleTime) { settleTimer = setTimeout(() => finish(result), settleTime); } else { finish(result); } }); observer.observe(root, { childList: true, subtree: true }); // If it existed immediately but requires settleTime, kick off the first debounce timer if (existing && settleTime) { settleTimer = setTimeout(() => finish(existing), settleTime); } // Setup Fail-safe Timeout failSafeTimer = setTimeout(() => { observer.disconnect(); clearTimeout(settleTimer); Logger.warn(`Timed out waiting for selector(s) ${selectorList.join(", ")}`); resolve(null); }, maxWait); }); }, retryUntilReady(checkAndApply, { interval = 100, maxTries = 30 } = {}) { let tries = 0; const id = setInterval(() => { tries++; const done = checkAndApply(); if (done || tries >= maxTries) { Logger.debug(`Retry check completed for ${checkAndApply.name || "anonymous"}. Success: ${done}, Tries: ${tries}`); clearInterval(id); } }, interval); }, normalizeText(value) { return (value || "").replace(/\s+/g, " ").trim().toLowerCase(); }, isExactMatch(element, txt) { return element.innerText.trim() === txt; } }; const ContextManager = { init() { try { const element = document.getElementById("ssr-props"); if (element) { window.initialProps = JSON.parse(element.innerHTML); window.initialPropsData = window.initialProps.context?.variables || {}; window.glossaryPropsData = window.initialProps.context?.terms || {}; Logger.debug("initialProps parsed successfully."); } else { // see compatibility from #hub-me? window.initialProps = {}; window.initialPropsData = {}; window.glossaryPropsData = {}; } } catch (e) { Logger.error("initialProps parse failed — fallback defaults used.", e); window.initialProps = {}; window.initialPropsData = {}; window.glossaryPropsData = {}; } const meta = document.querySelector('meta[property="og:site_name"]'); window.projectLabel = (meta?.getAttribute("content") || window.projContentName || "").trim(); }, projectLabel() { const meta = document.querySelector('meta[property="og:site_name"]'); return (meta?.getAttribute("content") || window.projContentName || "").trim(); }, productSlug() { return window.location.pathname.split("/").find(Boolean) || ""; }, isHomePage() { const path = window.location.pathname; return path.includes("home") || path.includes("home-v6"); }, isSection(type) { return window.location.pathname.includes(`/${type}`); }, isReferenceSection() { return this.isSection("reference/"); }, isRecipesSection() { return this.isSection("recipes/"); }, isChangelogSection() { return this.isSection("changelog"); } }; const AnalyticsEngine = { init() { this.bindEvents(); }, trackPageView() { if (window._satellite?.track) { window._satellite.track("page_view", { url: window.location.href, adobeDataLayer: window.adobeDataLayer }); Logger.debug(`AA view: ${window.location.href}`); } }, trackInteraction(linkValue) { if (window._satellite?.track) { window._satellite.track("click_interaction", { linkValue, adobeDataLayer: window.adobeDataLayer }); Logger.debug(`AA click: ${linkValue}`); } }, trackSearchInteraction(searchTerm) { if (window._satellite?.track) { window._satellite.track("site_search", { "search term": searchTerm, "search type": "project search", url: window.location.href, adobeDataLayer: window.adobeDataLayer }); Logger.debug(`AA search: ${searchTerm}`); } }, getLanguageSelection(isDefault = true, isRef = true) { const referenceLanguageSelector = ".rm-LanguageButton_active"; const recipeLanguageSelector = "section[aria-hidden='false'] button[class*='TutorialEditor-Nav-Tab_active']"; const classSelector = isRef ? referenceLanguageSelector : recipeLanguageSelector; // using cash-dom $ which is globally available const langText = window.$(classSelector).text(); if (!langText?.trim()) return ""; const clickedText = isDefault ? '(Default)' : '(Clicked)'; const isSection = isRef ? "api:reference" : "recipes:recipe"; return `${isSection} language:${langText.trim()} ${clickedText}`; }, trackReferenceLanguageSelection() { if (ContextManager.isReferenceSection()) { const selectorValue = this.getLanguageSelection(); const trigger = typeof window.isMultipleRefLangClicked === "function" ? window.isMultipleRefLangClicked(selectorValue) : false; if (!trigger) { this.trackInteraction(selectorValue); } } }, trackRecipeLanguageSelection() { if (ContextManager.isRecipesSection()) { const selectorValue = this.getLanguageSelection(false, false); const trigger = typeof window.isMultipleRefLangClicked === "function" ? window.isMultipleRefLangClicked(selectorValue) : false; if (!trigger) { this.trackInteraction(selectorValue); } } }, triggerLytics() { if (!window.lyticsTagFunction || typeof window.lyticsTagFunction !== "function" || navigator.userAgent.includes("Sinequa")) return; const groups = window.OptanonActiveGroups; const hasRequiredConsent = groups?.includes("C0002") && groups?.includes("C0004"); if (!hasRequiredConsent) return; if (typeof window.setNewSlug === "function" && window.setNewSlug()) { window.lyticsTagFunction(); Logger.debug("AA Lytics."); } }, bindStaticClickTrackers() { // Track AI / Copy Interactions document.addEventListener('click', (event) => { const targetElement = event.target.closest(TechDocsConfig.selectors.aiSelectorsBtn); if (!targetElement) return; const elementText = (targetElement.textContent || '').trim(); if (TechDocsConfig.trackedButtons.has(elementText)) { this.trackInteraction(`ai:${elementText}`); } }, { capture: true }); }, bindEvents() { $(window).on("click", ".rm-LanguageButton", function () { const selectorValue = AnalyticsEngine.getLanguageSelection(false); const trigger = typeof window.isMultipleRefLangClicked === "function" ? window.isMultipleRefLangClicked(selectorValue) : false; if (!trigger) { AnalyticsEngine.trackInteraction(selectorValue); } }); $(window).on("click", ".postman-run-button", function () { AnalyticsEngine.trackInteraction(`api:${document.querySelector("title").innerText}:run in postman`); }); $(window).on("click", "a.rm-Header-link.rm-Header-bottom-link", function (e) { AnalyticsEngine.trackInteraction(`navigation:${e.target.textContent}`); }); $(document).on("click", ".rm-LanguagePicker div[class*='LanguagePicker-MenuItem']", function () { setTimeout(() => { const selectorValue = AnalyticsEngine.getLanguageSelection(false); const trigger = typeof window.isMultipleRefLangClicked === "function" ? window.isMultipleRefLangClicked(selectorValue) : false; if (!trigger) { AnalyticsEngine.trackInteraction(selectorValue); } }, 5); }); $(window).on("click", ".TutorialEditor-Nav button", function () { const selectorValue = AnalyticsEngine.getLanguageSelection(false, false); const trigger = typeof window.isMultipleRecipeLang === "function" ? window.isMultipleRecipeLang(selectorValue) : false; if (!trigger) { AnalyticsEngine.trackInteraction(selectorValue); } }); $(document).on("keyup", ".docsearch-wrapper input", function (e) { if (e.keyCode === 13) { const searchInputs = document.querySelectorAll(".docsearch-wrapper input"); let searchTerm = searchInputs[1]?.value; if (searchTerm == undefined || searchTerm === "") searchTerm = searchInputs[0]?.value; if (!searchTerm?.trim()) return ""; AnalyticsEngine.trackSearchInteraction(searchTerm.trim()); } }); } }; const AuthUserNavMenu = { init() { this.bindEvents(); }, updateLoggedInDetailsOverride(duration = 200) { const isLoggedIn = document.documentElement.classList.contains("userLoggedIn"); const initialPropsData = window.initialPropsData || {}; const productSlugName = ContextManager.productSlug(); const privateProjects = window.privateProjects || []; const replaceLink = (element, loggedIn = false) => { if (!element) return; try { const url = new URL(element.href, window.location.origin); const key = loggedIn ? "redirect_uri" : "redirect"; const path = window.location.pathname; if (url.searchParams.get(key) !== path) { url.searchParams.set(key, path); element.href = url.toString(); } } catch (e) { Logger.error("Failed to update redirect URL", e); } }; let ele; if (!privateProjects.includes(productSlugName)) { ele = document.querySelector("a.td-logout"); replaceLink(ele, true); ele = document.querySelector("div.td-logout a"); replaceLink(ele, true); } if (!isLoggedIn || !initialPropsData.user?.email) { setTimeout(() => { ele = document.querySelector(".td-login"); replaceLink(ele); ele = document.querySelector(".td-mobile-login"); replaceLink(ele); }, duration); } if (isLoggedIn) { setTimeout(() => { let email = initialPropsData?.user?.email; if (!email) { try { const hubMe = document.querySelector("#hub-me"); if (hubMe?.dataset.json) { email = JSON.parse(hubMe.dataset.json).user.email; } } catch (e) { Logger.error("Error parsing user email", e.message); } } $(".td-user-icon").show(); if (email) { $(".td-login .td-login-text").text(email).addClass("td-user"); $(".td-login").attr("data-tooltip", email); $(".td-mobile-login .td-login-text").text(email).addClass("td-user"); } $(".td-login").attr("href", ""); $(".td-mobile-login").attr("href", ""); }, duration); } }, bindEvents() { $(window).on("click", "a.td-contact", function () { $("a.td-contact .td-icon-nav-up").toggleClass("td-icon-down"); $(".td-contact-dropdown-content").toggle(); $(".td-login-dropdown-content").hide(); }); $(window).on("click", ".td-login", function (e) { if (!$(".td-login").attr("href")) { e.preventDefault(); } $(".td-login-dropdown-content").toggle(); $(".td-contact-dropdown-content").hide(); $(".td-contact .td-icon").removeClass("td-icon-down"); }); $(window).on("click", ".td-mobile-nav-icons .td-icon-menu", function () { $(".td-mobile").toggle(); $(".td-search-flyout").hide(); $(".td-mobile-nav-icons .icon-search1").removeClass("td-active"); $(".td-icon-menu").toggleClass("td-icon-hover"); }); $(window).on("click", ".err .td-mobile-nav-icons-1 .td-icon-menu", function () { $(".td-mobile").toggle(); $(".err .td-search-flyout-1").hide(); $(".err .td-mobile-nav-icons-1 .icon-search1").removeClass("td-active"); $(".td-icon-menu").toggleClass("td-icon-hover"); }); $(window).on("blur", ".td-contact-dropdown", function (e) { if (!e.relatedTarget) { $(".td-contact-dropdown-content").hide(); $(".td-contact .td-icon").removeClass("td-icon-down"); } }); $(window).on("blur", ".td-login", function (e) { if (!e.relatedTarget) { $(".td-login-dropdown-content").hide(); } }); $(window).on("click", ".td-mobile-nav-icons .icon-search1", function () { $(".td-search-flyout").toggle(); $(".td-mobile").hide(); $(".td-icon-menu").removeClass("td-icon-hover"); $(".td-mobile-nav-icons .icon-search1").toggleClass("td-active"); }); $(window).on("click", ".err .td-mobile-nav-icons-1 .icon-search1", function () { $(".err .td-search-flyout-1").toggle(); $(".td-mobile").hide(); $(".td-icon-menu").removeClass("td-icon-hover"); $(".err .td-mobile-nav-icons-1 .icon-search1").toggleClass("td-active"); }); } }; const ChangelogFeatures = { init() { this.bindEvents(); }, readMore() { if (!ContextManager.isChangelogSection()) return; const hasReadMore = document.querySelectorAll(".ch-release-note").length; if (hasReadMore) return; document.querySelectorAll(TechDocsConfig.selectors.changelogPost) .forEach(post => { const href = post.querySelectorAll("h2 a")[0]?.getAttribute("href"); if (!href) return; const span = document.createElement("span"); span.classList.add("ch-release-note"); span.innerText = "Read full release note"; post.querySelector("section.markdown-body")?.append(span); }); Logger.debug("'Read full release note' links added."); }, releaseNotesBackButton() { if (!ContextManager.isChangelogSection()) return; const backBtnDiv = document.querySelector(".rm-Changelog article.rm-Changelog-post > div"); if (!backBtnDiv) return; const btnText = ContextManager.projectLabel() + " release notes"; const span = backBtnDiv.querySelectorAll("button span")[1]; if (span) { span.innerText = btnText; } else { const firstLink = backBtnDiv.querySelector("a"); if (firstLink) { const spanIcon = firstLink.querySelector("span")?.outerHTML || ""; firstLink.innerHTML = spanIcon + `${btnText}`; firstLink.style.display = "flex"; } } const backToAllBtn = document.querySelector(".rm-Changelog a.to_all_notes"); if (!backToAllBtn) { const anchor = document.createElement("a"); anchor.className = "Button Button_sm Button Button_sm Button_text to_all_notes ChangelogPost_backVFYixWm1Jvy7 Button_primary"; anchor.type = "button"; anchor.href = "/release-notes/docs"; anchor.innerHTML = 'All release notes'; anchor.style.display = "flex"; backBtnDiv.appendChild(anchor); } const div = document.querySelector("article.rm-Changelog-post div[class*='ChangelogPage_back']"); if (div) div.style.display = "flex"; Logger.debug("Changelog back button updated."); }, bindEvents() { $(window).on("click", "a.rm-Header-bottom-link, a[class*='Pagination-link']", (e) => { if (e.currentTarget.getAttribute("href")?.includes("changelog")) this.readMore(); }); $(document).on("click", ".ch-release-note", function () { $(this).parent().siblings("h2").children("a").trigger("click"); }); } }; const AuthSectionUI = { init() { this.bindEvents(); }, commentCodeLine(commentText = "") { return `

${commentText}

`; }, injectCodeComment() { if (!ContextManager.isReferenceSection()) return; const productSlug = ContextManager.productSlug(); if (TechDocsConfig.projects.skipCodeComments?.includes(productSlug)) return; const codeHeaderExists = $(".CodeSnippet").text().includes("header"); const languageCommentSymbol = $(".rm-LanguageButton_active").text() === "Node" ? "//" : "#"; const authDiv = $("div.auth-code-comment"); if (authDiv.length) return; const commentText = TechDocsConfig.projects.mutualAuth?.includes(productSlug) ? "Use mutual auth or add JWT to this snippet" : "Add Authorization header to this snippet"; const commentLine = AuthSectionUI.commentCodeLine(`${languageCommentSymbol} ${commentText}`); const codeLines = document.querySelectorAll(".CodeSnippet .CodeMirror-code > div"); for (const codeElement of codeLines) { const txt = codeElement.textContent; const addElementBefore = txt.includes("options") || txt.includes("header") || txt.includes("sdk.") || txt.includes("sdk["); if (addElementBefore) { $(codeElement).before(commentLine); break; } if (!codeHeaderExists && txt.includes("url") && !txt.includes("curl")) { $(commentLine).insertAfter($(codeElement)); break; } } Logger.debug("Auth code comment injected."); }, addPostmanButton(pmApiUrl, docsUrl, target) { const infoEle = `To run this code or try it in Postman, set up your authentication credentials.`; const auth = `

Not familiar with Postman? Learn how to use collections.

`; const button = `

`; const ele = $(`

AUTHENTICATE & TRY IT

${infoEle}${auth}${button}

`); ele.insertAfter($("#ReferencePlayground > section:nth-child(1)")); }, async postmanAuth() { if (!ContextManager.isReferenceSection()) return false; const postmanSessionItem = "akam_pm_info"; const apiTitle = document.querySelector(TechDocsConfig.selectors.apiTitle)?.innerText; Logger.debug("API Title", apiTitle); if (!apiTitle) return false; let pmInfo = sessionStorage.getItem(postmanSessionItem); pmInfo = pmInfo ? JSON.parse(pmInfo) : null; if (!pmInfo) { pmInfo = await Utils.fetchData("/assets/postman.json"); if (pmInfo) { sessionStorage.setItem(postmanSessionItem, JSON.stringify(pmInfo)); } } if (!pmInfo) return false; Logger.debug("Postman Info fetched successfully."); const { collections, collectionBaseUrl } = pmInfo; if (!collections?.hasOwnProperty(apiTitle)) return false; const groupId = apiTitle.replaceAll(' ', "_"); await Utils.delay(350); // Ensure the DOM is fully loaded before proceeding const docsTitle = document.querySelector("title")?.innerText; const itemId = docsTitle ?.replaceAll(' ', "_") .replaceAll('\'', "") .replaceAll('/', ""); if (!itemId) { Logger.debug("Item ID not found."); return false; } const ssKey = `${groupId}-${itemId}`; let endpointIdInSession = sessionStorage.getItem(ssKey); if (!endpointIdInSession) { const endpointIdFromEW = await Utils.fetchData(`/api/ew?groupId=${groupId}&itemId=${itemId}`, true); if (!endpointIdFromEW || endpointIdFromEW.includes("Error")) { $("section.PostmanSection").remove(); Logger.debug(`Postman endpoint ID not found for ${itemId} received from EW: ${endpointIdFromEW}`); return false; } endpointIdInSession = endpointIdFromEW.replaceAll('"', ""); sessionStorage.setItem(ssKey, endpointIdInSession); } $("span.auth-section-info").parent().remove(); const partialUrl = collections[apiTitle][0]; const pmApiUrlToUse = `${collectionBaseUrl}/${partialUrl}${endpointIdInSession}`; let target = "_blank"; let docsUrl = "https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials"; if (!partialUrl.startsWith("akamai-apis/")) { document.querySelectorAll(".rm-Sidebar-section:first-child .rm-Sidebar-link").forEach(a => { if (a.textContent?.toLowerCase().includes("get started")) { docsUrl = a.href; target = "_self"; } }); } this.addPostmanButton(pmApiUrlToUse, docsUrl, target); Logger.debug("Postman button added successfully."); return true; }, async authHelp() { if (!ContextManager.isReferenceSection()) return; const productSlug = ContextManager.productSlug(); function credentialElementLink() { const isIncluded = TechDocsConfig.projects.authLinks?.includes(productSlug) || TechDocsConfig.projects.onlyAuthHelp?.includes(productSlug); const target = isIncluded ? "_self" : "_blank"; let link = isIncluded ? `${productSlug}/reference/get-started` : "developer/docs/set-up-authentication-credentials"; let txt = TechDocsConfig.projects.onlyAuthHelp?.includes(productSlug) ? "authorization token" : "authentication credentials"; if (productSlug === "mpulse") { const category = $(".rm-Sidebar-section .subnav-expanded .rm-Sidebar-link.active") .first() .parents(".rm-Sidebar-section") .children() .first() .text(); if (["Beacons"].includes(category)) { link = "mpulse/reference/beacons#getting-started"; txt = "API key"; } else { txt = "authentication token"; } } return `${txt}`; } function addAuthSection() { const isOnlyAuth = (TechDocsConfig.projects.onlyAuthHelp ?? []).includes(productSlug); const authHeaderText = `Remember to ${isOnlyAuth ? "get" : "add"} your ${credentialElementLink()} to run this code.`; const infoEle = `${authHeaderText}`; const header = $(".APIAuth [class*='APISectionHeader3LN'] [class*='APISectionHeader']"); if (header.length > 0) { if (header.text() === "Authorization") { header.text("Authentication"); if (!header.parent().next().hasClass("auth-section-info")) { header.parent().after(infoEle); } } } else if (productSlug !== "linode-api") { if ($("span.auth-section-info").length === 0) { const authEleSection = `

Authentication

${infoEle}

`; $("#ReferencePlayground").children().eq(1).before(authEleSection); } } Logger.debug("Auth section added successfully."); } if (!TechDocsConfig.projects.onlyAuthHelp?.includes(productSlug)) { $("section.InputGroup").hide(); } const hasPostman = await this.postmanAuth(); Logger.debug(`Postman auth check: ${hasPostman}`); $("span.auth-section-info").show(); if (!hasPostman) { addAuthSection(); } if (!$("div.auth-code-comment").length) { this.injectCodeComment(); } }, bindEvents() { $(document).on("focus", ".CodeSnippet, .rm-ParamInput, .ServerVars-form .ServerVars-input", () => this.injectCodeComment()); $(document).on("change", ".CodeMirror-code", () => this.injectCodeComment()); $(document).on("blur", ".CodeSnippet, .rm-ParamInput, .ServerVars-form .ServerVars-input", () => this.injectCodeComment()); $(document).on("click", ".rm-PlaygroundRequest div[class*='APIRequest-menu-item'], div[class*='LanguagePicker-MenuItem']", () => { setTimeout(() => this.injectCodeComment(), 250); }); $(document).on("click", ".rm-LanguagePicker .rm-LanguageButton", () => { setTimeout(() => this.injectCodeComment(), 250); }); $(window).on("resize", Utils.debounce(() => { if (ContextManager.isReferenceSection() && !$("div.auth-code-comment").length) { this.injectCodeComment(); } }, 300)); } }; const UIHelpers = { init() { this.bindEvents(); }, resetScroll() { const hub = document.querySelector(TechDocsConfig.selectors.superHub); if (hub) hub.scrollTop = 0; }, check404ErrorPage() { const is404 = !!document.querySelector(TechDocsConfig.selectors.pageNotFound); if (is404) { document.documentElement.classList.add("err"); Logger.debug("PageNotFound 'err' added to DOM."); } }, addSidebarErrorIndicators() { $(".rm-Sidebar-link > span").each(function () { const parentCode = $(this).children().first().text(); const statusGroup = /^(\d)\d{2}$/.exec(parentCode)?.[1]; let iconClass = null; if (statusGroup === "5") { iconClass = "server-type"; } if (statusGroup === "4") { iconClass = "error-type"; } if (iconClass && !$(this).find('.status-code').length) { const icon = $(``); $(this).prepend(icon); } }); }, openNewTab() { const list = document.querySelectorAll("a[href]:not(.external-link)"); const privateProjects = window.privateProjects || []; list.forEach(function (a) { const href = a.getAttribute("href"); if (Utils.isExternalLink(href) && !Utils.isPrivateLink(href, privateProjects)) { a.setAttribute("target", "_blank"); a.classList.add("external-link"); } }); }, collapsibleTableRows() { const tables = document.querySelectorAll("table"); if (!tables.length) return; const expandableRows = document.querySelectorAll("tr.expand"); if (expandableRows.length) return; const productSlug = ContextManager.productSlug(); const shouldCollapse = TechDocsConfig.projects.collapseTablesByDefault?.includes(productSlug); $("table").each(function () { const colLength = $(this).children().first().children().first().children().length; const tRows = $(this).children().find("tr"); tRows.each(function (j, tRow) { if (j === tRows.length - 1) return; const rowChilds = $(this).children(); let len = 0; rowChilds.length && rowChilds.each(function () { if ($(this).html() === "") len += 1; }); if (len === rowChilds.length - 1 && $(rowChilds[0]).html() !== "") { if ($(this).hasClass("expand")) return; $(this).addClass("expand"); rowChilds.first().siblings().remove().wrapInner(""); const initialTriangleClass = shouldCollapse ? "triangle-right" : "triangle-bottom"; rowChilds .prepend(``) .wrapInner(''); tRow.firstElementChild.setAttribute("colspan", colLength); tRow.firstElementChild.style.fontWeight = "600"; } }); // If configured to collapse by default, hide the child rows immediately if (shouldCollapse) { $(this) .find("tr.expand") .each(function () { $(this).nextUntil("tr.expand").hide(); }); } }); Logger.debug("Collapsible table rows initialized.", shouldCollapse); }, bindEvents() { $(document).on("click", ".clickable-triangle", function () { const triangleSpan = $(this).children().first(); triangleSpan.toggleClass("triangle-right"); triangleSpan.toggleClass("triangle-bottom"); $(this).parent().parent().nextUntil("tr.expand").toggle(); }); } }; // SEARCH DEBUG + BEHAVIOR // 1) Top/global search input opens modal and clears project filters // 2) Native header search button opens modal and auto-checks current project // 3) Invalid tabs remain visible, but are fully blocked when scoped to a project // 4) If current project is manually unchecked, tabs behave normally again const SearchBehavior = { init() { const HEADER_SEARCH_BUTTON_SELECTOR = ".rm-Header-search .rm-SearchToggle"; const TOP_SEARCH_INPUT_SELECTOR = ".docsearch-bar input, .docsearch-wrapper input"; const SEARCH_MODAL_SELECTOR = ".rm-SearchModal, [class*='SearchModal']"; const PRIMARY_NAV_SELECTOR = 'nav[aria-label="Primary navigation"]'; const PROJECT_SLUG = window.location.pathname.split("/").find(Boolean) || ""; const LOCAL_PROJECT_PREFIX = PROJECT_SLUG ? `/${PROJECT_SLUG}/` : ""; const PROJECT_LABEL = window.projectLabel || ""; if (!PROJECT_LABEL || !PROJECT_SLUG) { return; } let pendingProjectScope = false; let appliedForCurrentOpen = false; let pollTimer = null; let activeModal = null; let isProgrammaticOpen = false; function clearPoll() { if (pollTimer) { clearInterval(pollTimer); pollTimer = null; } } function getModal() { return document.querySelector(SEARCH_MODAL_SELECTOR); } function isModalVisible(modal) { return !!(modal && (modal.classList.contains("show-modal") || modal.offsetParent !== null)); } function getSearchProjectInputs(modal) { if (!modal) return []; return [...modal.querySelectorAll("label")] .map((label) => { const textEl = label.querySelector(".Toggle-label, .Toggle-label_md, [class*='Toggle-label']"); const input = label.querySelector('input[type="checkbox"]'); if (!textEl || !input) return null; return { label, input, text: Utils.normalizeText(textEl.textContent), rawText: textEl.textContent }; }) .filter(Boolean); } function getCurrentProjectInput(modal) { const target = Utils.normalizeText(PROJECT_LABEL); const options = getSearchProjectInputs(modal); const match = options.find((option) => option.text === target); return match?.input || null; } function tryCheckProjectBox(modal) { if (!modal || !pendingProjectScope || appliedForCurrentOpen) { return false; } const matchedInput = getCurrentProjectInput(modal); if (!matchedInput) { return false; } if (!matchedInput.checked) { matchedInput.click(); } appliedForCurrentOpen = true; pendingProjectScope = false; clearPoll(); return true; } function startProjectScopePolling(modal) { clearPoll(); let attempts = 0; const maxAttempts = 30; pollTimer = setInterval(() => { attempts += 1; const worked = tryCheckProjectBox(modal); if (worked || attempts >= maxAttempts) { clearPoll(); } }, 100); } function clearAllProjectFilters(modal) { if (!modal) return; const inputs = getSearchProjectInputs(modal) .map(option => option.input) .filter(Boolean); inputs.forEach((input) => { if (input.checked) { input.click(); } }); } function clearAllProjectFiltersWhenReady() { let attempts = 0; const maxAttempts = 20; const interval = setInterval(() => { attempts += 1; const modal = getModal(); if (!isModalVisible(modal)) { if (attempts >= maxAttempts) clearInterval(interval); return; } const inputs = getSearchProjectInputs(modal); if (inputs.length) { clearAllProjectFilters(modal); clearInterval(interval); return; } if (attempts >= maxAttempts) { clearInterval(interval); } }, 100); } function resetModalState() { appliedForCurrentOpen = false; pendingProjectScope = false; clearPoll(); activeModal = null; isProgrammaticOpen = false; } $(document).off("click.searchDebugHeader", HEADER_SEARCH_BUTTON_SELECTOR); $(document).on("click.searchDebugHeader", HEADER_SEARCH_BUTTON_SELECTOR, function (e) { if (isProgrammaticOpen) return; pendingProjectScope = true; appliedForCurrentOpen = false; }); $(document).off("mousedown.searchDebugTop", TOP_SEARCH_INPUT_SELECTOR); $(document).on("mousedown.searchDebugTop", TOP_SEARCH_INPUT_SELECTOR, function (e) { e.preventDefault(); e.stopImmediatePropagation(); pendingProjectScope = false; appliedForCurrentOpen = false; if (typeof this.blur === "function") { this.blur(); } const btn = document.querySelector(HEADER_SEARCH_BUTTON_SELECTOR); if (btn) { isProgrammaticOpen = true; btn.click(); setTimeout(() => { isProgrammaticOpen = false; clearAllProjectFiltersWhenReady(); }, 0); } }); $(document).off("click.searchDebugTop", TOP_SEARCH_INPUT_SELECTOR); $(document).on("click.searchDebugTop", TOP_SEARCH_INPUT_SELECTOR, function (e) { e.preventDefault(); e.stopImmediatePropagation(); }); const observer = new MutationObserver(() => { const modal = getModal(); if (!isModalVisible(modal)) { resetModalState(); return; } if (modal !== activeModal) { activeModal = modal; appliedForCurrentOpen = false; } if (pendingProjectScope && !appliedForCurrentOpen) { startProjectScopePolling(modal); } }); observer.observe(document.body, { childList: true, subtree: true }); } }; // -- Event execution on page load and SPA navigation $(window).on("pageLoad", UIHelpers.resetScroll); UIHelpers.check404ErrorPage(); ContextManager.init(); AuthUserNavMenu.init(); AnalyticsEngine.init(); if (!ContextManager.isHomePage()) { window.openNewTab = UIHelpers.openNewTab; AnalyticsEngine.bindStaticClickTrackers(); ChangelogFeatures.init(); AuthSectionUI.init(); UIHelpers.init(); // load Event window.addEventListener("load", () => { Logger.debug("load event."); setTimeout(() => { document.querySelectorAll(".rm-SearchToggle-placeholder")?.forEach(x => (x.innerHTML = "Search this doc set")); setTimeout(UIHelpers.collapsibleTableRows, 1000); }, 1000); if (ContextManager.isChangelogSection()) { Utils.waitFor(TechDocsConfig.selectors.changelogPost, { all: true, settleTime: 150 }) .then(ChangelogFeatures.readMore); } }); } // SPA navigation event $(window).on("pageLoad", async function () { Logger.debug("pageLoad event."); AuthUserNavMenu.updateLoggedInDetailsOverride(); // OneTrust compliance if (window.reWriteTags && typeof window.reWriteTags === "function") { window.reWriteTags(); } const isPerfCookieEnabled = typeof window.perfCookieEnabled === "function" ? window.perfCookieEnabled() : false; const isMultipleTrigger = typeof window.isMultipleSlug === "function" ? window.isMultipleSlug() : false; if (isPerfCookieEnabled && !isMultipleTrigger) AnalyticsEngine.trackPageView(); AnalyticsEngine.triggerLytics(); // Execute only for projects not home if (!ContextManager.isHomePage()) { setTimeout(() => { document .querySelectorAll(".rm-SearchToggle-placeholder") .forEach(x => (x.innerHTML = "Search this doc set")); AuthUserNavMenu.updateLoggedInDetailsOverride(); }, 100); if (ContextManager.isChangelogSection()) { Utils.waitFor(TechDocsConfig.selectors.changelogPost, { all: true, settleTime: 150 }) .then(ChangelogFeatures.readMore); Utils.waitFor(".rm-Changelog article.rm-Changelog-post > div") .then(ChangelogFeatures.releaseNotesBackButton); } if (ContextManager.isReferenceSection()) { Utils.waitFor([".rm-PlaygroundRequest", TechDocsConfig.selectors.apiTitle]) .then(async () => { await AuthSectionUI.authHelp(); }); Utils.waitFor(".rm-Playground .CodeSnippet .CodeMirror") .then(AuthSectionUI.injectCodeComment); } UIHelpers.addSidebarErrorIndicators(); Utils.waitFor("table", { all: true, settleTime: 100 }) .then(UIHelpers.collapsibleTableRows); if (isPerfCookieEnabled) { setTimeout(() => { AnalyticsEngine.trackReferenceLanguageSelection(); AnalyticsEngine.trackRecipeLanguageSelection(); }, 10); } } }); SearchBehavior.init(); function removeBetaAndPillClasses() { const tocBetas = [ "li.toc-children a", "span[class*='Sidebar-link-text'] span" ]; tocBetas.forEach(selector => { const elements = document.querySelectorAll(selector); elements.forEach(element => { element.querySelectorAll("span.beta").forEach(span => span.classList.remove("beta")); element.querySelectorAll("span.toc-beta").forEach(span => span.classList.remove("toc-beta")); element.querySelectorAll("span.pill").forEach(span => span.classList.remove("pill")); }); }); } document.addEventListener("DOMContentLoaded", function () { if (window.location.href.includes("reference")) { setTimeout(removeBetaAndPillClasses, 100); } const ob_beta = new MutationObserver(function () { if (window.location.href.includes("reference")) { setTimeout(removeBetaAndPillClasses, 100); } }); const config = { childList: true, subtree: true, characterData: true }; ob_beta.observe(document.body, config); }); // DOCHUB 4302 (function () { let currentUrl = location.href; function isExactMatchLocal(element, txt) { return element.innerText.trim() === txt; } function upgradeApiStatusLabelsLocal(isParameterOption = true) { if (window.location.href.includes("/docs/")) { return; } const selector = isParameterOption ? ".param-type" : ""; document.querySelectorAll(`#content.rm-Article ${selector} strong`).forEach((strongElement) => { strongElement.classList.remove("deprecated", "beta", "la"); if (isExactMatchLocal(strongElement, "Deprecated")) { strongElement.classList.add("deprecated"); } if (isExactMatchLocal(strongElement, "Beta")) { strongElement.classList.add("beta"); } if (isExactMatchLocal(strongElement, "Limited availability")) { strongElement.classList.add("la"); } }); } function waitForApiResponseSchemaAndRun() { const targetClass = "APIResponseSchemaPicker-items2bs6Pzrheef_"; const observer = new MutationObserver((mutations, obs) => { const el = document.querySelector(`[class*="${targetClass}"]`); if (el) { obs.disconnect(); setTimeout(upgradeApiStatusLabelsLocal, 200); } }); observer.observe(document.body, { childList: true, subtree: true, }); } function hookHistoryChanges() { const originalPush = history.pushState; const originalReplace = history.replaceState; const onChange = () => { if (location.href !== currentUrl) { currentUrl = location.href; console.log("[Router] URL changed to", currentUrl); waitForApiResponseSchemaAndRun(); } }; history.pushState = function () { originalPush.apply(this, arguments); onChange(); }; history.replaceState = function () { originalReplace.apply(this, arguments); onChange(); }; window.addEventListener("popstate", onChange); } const cancelUpgradeApiStatusLabels = () => { if (typeof window.upgradeApiStatusLabelsInSchema === "function") { window.upgradeApiStatusLabelsInSchema = function () {}; } else { setTimeout(cancelUpgradeApiStatusLabels, 10); } }; cancelUpgradeApiStatusLabels(); hookHistoryChanges(); waitForApiResponseSchemaAndRun(); })(); // Beta pills upgrade for refactored $(document).on("click", ".Button_slate_text.Button_md.rm-Header-bottom-link", function () { setTimeout(function () { const spans = document.querySelectorAll('span[class^="VersionBadge"]'); spans.forEach((span) => { console.log(span); if (span.textContent.trim() === "Beta") { span.classList.add("beta"); } }); }, 100); }); // README-532 do not create beta pills in text content function isExactMatch(element, txt) { return element.innerText.trim() === txt; } function upgradeApiStatusLabels(isParameterOption = true) { if (window.location.href.includes("/docs/")) { return; } const selector = isParameterOption ? ".param-type" : ""; document.querySelectorAll(`#content.rm-Article ${selector} strong`).forEach((strongElement) => { strongElement.classList.remove("deprecated", "beta", "la"); if (isExactMatch(strongElement, "Deprecated")) { strongElement.classList.add("deprecated"); } if (isExactMatch(strongElement, "Beta")) { strongElement.classList.add("beta"); } if (isExactMatch(strongElement, "Limited availability")) { strongElement.classList.add("la"); } }); } function upgradeApiStatusLabelsInSchema() { const buttons = document.querySelectorAll('[class*="APIResponseSchemaPicker-option"]'); buttons.forEach(function (button) { button.addEventListener("click", () => { setTimeout(upgradeApiStatusLabels, 5); }); }); } function upgradeApiStatusLabelsInNav() { function replaceNavStatus(labelType, element, text) { const remainingText = text.substring(labelType.length); const strongTag = document.createElement("strong"); strongTag.textContent = labelType.charAt(0).toUpperCase() + labelType.slice(1); strongTag.className = labelType; element.innerHTML = ""; element.appendChild(strongTag); element.appendChild(document.createTextNode(`${remainingText}`)); } const swaggerTitlesNav = document.querySelectorAll(".rm-Sidebar h3"); swaggerTitlesNav.forEach((title) => { const text = title.textContent.trim(); if (text.startsWith("Beta")) { replaceNavStatus("beta", title, text); } if (text.startsWith("Deprecated")) { replaceNavStatus("deprecated", title, text); } if (text.startsWith("Limited availability")) { replaceNavStatus("la", title, text); } }); } // README-468 Beta labels nested in clickable properties in schemas function schemaNestedStatusLabels() { document.querySelectorAll("button[class*='Param-expand']").forEach(button => { button.addEventListener("click", function () { setTimeout(() => { const container = this.parentElement.querySelector("[class*='Param-children']"); if (container && container.style.display !== "none" && getComputedStyle(container).display !== "none") { container.querySelectorAll("p strong").forEach(strongElement => { if (isExactMatch(strongElement, "Deprecated")) { strongElement.classList.add("deprecated"); } if (isExactMatch(strongElement, "Beta")) { strongElement.classList.add("beta"); } if (isExactMatch(strongElement, "Limited availability")) { strongElement.classList.add("la"); } }); } }, 200); }); }); } // README-408 Beta labels in guides function handleBetaInHeadings(heading, size, isApi = false) { if (!isApi && window.location.href.includes("/docs/")) { const headingTextDivs = document.querySelectorAll(heading); headingTextDivs.forEach(div => { const betaRegex = /$Beta$/i; const laRegex = /$Limited availability$/i; const deprecatedRegex = /$Deprecated$/i; if (betaRegex.test(div.innerHTML)) { div.innerHTML = div.innerHTML.replace( betaRegex, `(Beta)` ); } if (laRegex.test(div.innerHTML)) { div.innerHTML = div.innerHTML.replace( laRegex, `(Limited availability)` ); } if (deprecatedRegex.test(div.innerHTML)) { div.innerHTML = div.innerHTML.replace( deprecatedRegex, `(Deprecated)` ); } }); } } function applyBetaChanges() { const bodyBetas = [ "h1.heading .heading-text", "h2.heading .heading-text", "h3.heading .heading-text", ".col-xs-9 h1" ]; const tocBetas = [ "li.toc-children a", "span[class*='Sidebar-link-text'] span" ]; bodyBetas.forEach(selector => { handleBetaInHeadings(selector, "super-text"); }); tocBetas.forEach(selector => { handleBetaInHeadings(selector, "toc-beta"); }); } function applyAllBetaChanges() { applyBetaChanges(); upgradeApiStatusLabels(false); setTimeout(() => upgradeApiStatusLabels(true), 50); upgradeApiStatusLabelsInNav(); setTimeout(upgradeApiStatusLabelsInSchema, 200); setTimeout(schemaNestedStatusLabels, 100); } document.addEventListener("DOMContentLoaded", function () { applyAllBetaChanges(); let labelTimer = null; const config = { childList: true, subtree: true, characterData: true }; const observer = new MutationObserver(function () { observer.disconnect(); clearTimeout(labelTimer); labelTimer = setTimeout(() => { applyAllBetaChanges(); observer.observe(document.body, config); }, 50); }); observer.observe(document.body, config); }); $(window).on("pageLoad", function () { setTimeout(applyAllBetaChanges, 200); }); var coll = document.getElementsByClassName("collapsible1"); var i; for (i = 0; i < coll.length; i++) { coll[i].addEventListener("click", function() { this.classList.toggle("active"); var content1 = this.nextElementSibling; if (content1.style.display === "block") { content1.style.display = "none"; } else { content1.style.display = "block"; } }); }

Synopsis

Syntax

Description

Related Links