$(window).on("pageLoad", function () { const hub = document.querySelector("#ssr-main > div > div[class^='SuperHub']"); if (hub) hub.scrollTop = 0; }); if (document.querySelector("div[class^='PageNotFound'].rm-Container")) { document.documentElement.classList.add("err"); } try { initialProps = JSON.parse(document.getElementById("ssr-props").innerHTML); initialPropsData = initialProps.context.variables; glossaryPropsData = initialProps.context.terms; } catch (e) { initialPropsData = {}; initialProps = {}; } /* function selectProjectLabelInSearch(select = false) { const listItems = document.querySelectorAll(".rm-SearchModal aside ol li"); listItems?.forEach(li => { const label = li.querySelector('.Toggle-label'); const input = li.querySelector('input'); if (label?.innerText === projContentName && input) { if ((!input.checked && select) || (!select && input.checked)) { input.click(); } } }); } $(document).on("click", ".err .docsearch-bar input", (e) => { selectProjectLabelInSearch(true); document.querySelector(".err .docsearch-bar input")?.blur(); document.querySelector(".rm-SearchToggle")?.click(); }); */ function languageSelectorAnalytics(isDefault = true, isRef = true) { const classSelector = isRef ? ".rm-LanguageButton_active" : "section[aria-hidden='false'] button[class*='TutorialEditor-Nav-Tab_active']"; let lang = $(classSelector).text(); if (!lang?.trim()) return ""; lang += isDefault ? " (Default)" : " (Clicked)"; return isRef ? `api:reference language:${lang}` : `recipes:recipe language:${lang}`; } function updateLoggedInDetailsOverride(duration = 200) { const isLoggedIn = document.documentElement.classList.contains("userLoggedIn"); const replaceLink = (element, loggedIn = false) => { if (!element) return; element.href = loggedIn ? element.href.replace("?redirect_uri=/home", "?redirect_uri=" + window.location.pathname) : element.href.replace("?redirect=/home", "?redirect=" + window.location.pathname); }; 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 { email = JSON.parse(document.querySelector("#hub-me").dataset.json).user.email; } catch (e) { console.error("Error parsing user email", e.message); } } $(".td-user-icon").show(); $(".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); } } $(window).on("pageLoad", function () { updateLoggedInDetailsOverride(); if (window.reWriteTags) { window.reWriteTags(); } if (perfCookieEnabled()) { if (!isMultipleSlug()) { _satellite.track("page_view", { url: window.location.href, adobeDataLayer }); } setTimeout(() => { if (window.location.pathname.includes("/reference/")) { const selectorValue = languageSelectorAnalytics(); const trigger = isMultipleRefLangClicked(selectorValue); if (!trigger) { _satellite.track("click_interaction", { linkValue: selectorValue, adobeDataLayer }); } } if (window.location.pathname.includes("/recipes/")) { const selectorValue = languageSelectorAnalytics(true, false); const trigger = isMultipleRefLangClicked(selectorValue); if (!trigger) { _satellite.track("click_interaction", { linkValue: selectorValue, adobeDataLayer }); } } }, 5); } }); $(window).on("click", ".rm-LanguageButton", function () { const selectorValue = languageSelectorAnalytics(false); if (!isMultipleRefLangClicked(selectorValue)) { _satellite.track("click_interaction", { linkValue: selectorValue, adobeDataLayer }); } }); $(window).on("click", ".postman-run-button", function () { const selectorValue = `api:${document.querySelector("title").innerText}:run in postman`; _satellite.track("click_interaction", { linkValue: selectorValue, adobeDataLayer }); }); $(window).on("click", "a.rm-Header-link.rm-Header-bottom-link", function (e) { const selectorValue = `navigation:${e.target.textContent}`; _satellite.track("click_interaction", { linkValue: selectorValue, adobeDataLayer }); }); $(document).on("click", ".rm-LanguagePicker div[class*='LanguagePicker-MenuItem']", function () { setTimeout(() => { const selectorValue = languageSelectorAnalytics(false); if (!isMultipleRefLangClicked(selectorValue)) { _satellite.track("click_interaction", { linkValue: selectorValue, adobeDataLayer }); } }, 5); }); $(window).on("click", ".TutorialEditor-Nav button", function () { const selectorValue = languageSelectorAnalytics(false, false); if (!isMultipleRecipeLang(selectorValue)) { _satellite.track("click_interaction", { linkValue: selectorValue, adobeDataLayer }); } }); $(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 ""; _satellite.track("site_search", { "search term": searchTerm, "search type": "project search", url: window.location.href, adobeDataLayer, }); } }); 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(); })(); $(window).on("pageLoad", function () { if (window.location.hostname.includes("techdocs.akamai.com")) { setTimeout(updateSearchBar, 200); } }); /* * init:migration: Only execute for refactored projects */ if (!window.location.pathname.includes("home") && !window.location.pathname.includes("home-old")) { window.updateSearchBar = function () {}; function addErrors() { $(".rm-Sidebar-link > span").each(function () { const parentCode = $(this).children().first().text(); let iconClass = /^5[0-9]{2}$/.test(parentCode) ? "server-type" : null; iconClass = /^4[0-9]{2}$/.test(parentCode) ? "error-type" : iconClass; if (iconClass) { const icon = $(``); $(this).prepend(icon); } }); } function isExternal(link) { if (!link || link.startsWith("/") || link.startsWith("#")) return false; const isSameSiteLink = link.startsWith(location.origin); const isPdfLink = link.endsWith(".pdf") || link.includes(".pdf#"); if (isSameSiteLink && isPdfLink) return true; return !isSameSiteLink; } function isPrivateLink(href, privateProjects = []) { return privateProjects.some(p => href.includes(p)); } window.openNewTab = function () { const list = document.querySelectorAll("a[href]:not(.external-link)"); list.forEach(function (a) { const href = a.getAttribute("href"); if (isExternal(href) && !isPrivateLink(href, privateProjects)) { a.setAttribute("target", "_blank"); a.classList.add("external-link"); } }); }; const isReferenceSection = () => location.pathname.includes("/reference/"); const isChangelogSection = () => location.pathname.includes("/changelog"); const onlyAuthHelpTxt = [ "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" ]; const projectsForMutualAuth = ["iot-edge-message-stream", "iot-edge-connect-msg-store"]; const projectsToSkipForCodeComment = ["mpulse", ...onlyAuthHelpTxt]; const authLink = new Set([ "mpulse", "cloudtest", "identity-cloud", "netstorage-usage", "iot-edge-message-stream", "iot-edge-connect-msg-store", ]); function debounce(func, wait) { let timeout; return function executedFunction(...args) { clearTimeout(timeout); timeout = setTimeout(() => func.apply(this, args), wait); }; } async function getData(url, isText = false) { const fetchOptions = { method: "GET", cache: "default", headers: { Accept: "application/json" }, redirect: "follow" }; const response = await fetch(url, fetchOptions); return isText ? await response.text() : await response.json(); } async function getDataFromEKV(groupId, itemId) { const url = `https://techdocs.akamai.com/api/ew?groupId=${groupId}&itemId=${itemId}`; return await getData(url, true); } function commentCodeLine(commentText = "") { return `

${commentText}

`; } function injectCodeComment() { if (!isReferenceSection()) return; const projName = location.pathname.split("/", 2)[1]; if (projectsToSkipForCodeComment?.includes(projName)) 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 = projectsForMutualAuth?.includes(projName) ? "Use mutual auth or add JWT to this snippet" : "Add Authorization header to this snippet"; const commentLine = commentCodeLine(`${languageCommentSymbol} ${commentText}`); const codeLines = document.querySelectorAll(".CodeSnippet .CodeMirror-code > div"); for (let index = 0; index < codeLines.length; index++) { const codeElement = codeLines[index]; 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; } } } $(document).on("focus", ".CodeSnippet, .rm-ParamInput, .ServerVars-form .ServerVars-input", function () { injectCodeComment(); }); $(document).on("change", ".CodeMirror-code", function () { injectCodeComment(); }); $(document).on("blur", ".CodeSnippet, .rm-ParamInput, .ServerVars-form .ServerVars-input", function () { injectCodeComment(); }); $(document).on("click", ".rm-PlaygroundRequest div[class*='APIRequest-menu-item'], div[class*='LanguagePicker-MenuItem']", function () { setTimeout(injectCodeComment, 200); }); $(document).on("click", ".rm-LanguagePicker .rm-LanguageButton", function () { setTimeout(injectCodeComment, 200); }); $(window).on("resize", debounce(function () { if (isReferenceSection() && !$("div.auth-code-comment").length) { injectCodeComment(); } }, 250)); function 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 function postmanAuth() { if (!isReferenceSection()) return false; const postmanSessionItem = "akam_pm_info"; const apiTitle = document.querySelector(".rm-Sidebar-section .rm-Sidebar-heading + .rm-Sidebar-list .rm-Sidebar-link")?.innerText; if (!apiTitle) return false; let pmInfo = sessionStorage.getItem(postmanSessionItem); pmInfo = pmInfo ? JSON.parse(pmInfo) : null; if (!pmInfo) { pmInfo = await getData("https://techdocs.akamai.com/assets/postman.json"); sessionStorage.setItem(postmanSessionItem, JSON.stringify(pmInfo)); } const { collections, collectionBaseUrl } = pmInfo; if (!collections?.hasOwnProperty(apiTitle)) return false; const groupId = apiTitle.replace(/ /g, "_"); await new Promise(r => setTimeout(r, 350)); const itemId = document.querySelector("title")?.innerText ?.replace(/ /g, "_") .replace(/'/g, "") .replace(/\//g, ""); if (!itemId) return false; const ssKey = `${groupId}-${itemId}`; let eId = sessionStorage.getItem(ssKey); if (!eId) { const endpointId = await getDataFromEKV(groupId, itemId); if (!endpointId || endpointId.includes("Error")) { $("section.PostmanSection").remove(); return false; } eId = endpointId.replace(/"/g, ""); sessionStorage.setItem(ssKey, eId); } $("span.auth-section-info").parent().remove(); const partialUrl = collections[apiTitle][0]; const pmApiUrlToUse = `${collectionBaseUrl}/${partialUrl}${eId}`; 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(x => { if (x.textContent?.toLowerCase().includes("get started")) { docsUrl = x.href; target = "_self"; } }); } addPostmanButton(pmApiUrlToUse, docsUrl, target); return true; } async function authHelp() { if (!isReferenceSection()) return; const projName = location.pathname.split("/", 2)[1]; function credentialElementLink() { const isIncluded = authLink.has(projName) || onlyAuthHelpTxt.includes(projName); const target = isIncluded ? "_self" : "_blank"; let link = isIncluded ? `${projName}/reference/get-started` : "developer/docs/set-up-authentication-credentials"; let txt = onlyAuthHelpTxt.includes(projName) ? "authorization token" : "authentication credentials"; if (projName === "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 authHeaderText = onlyAuthHelpTxt.includes(projName) ? `Remember to get your ${credentialElementLink()} to run this code.` : `Remember to 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 (projName !== "linode-api") { if ($("span.auth-section-info").length === 0) { const authEleSection = `

Authentication

${infoEle}

`; $("#ReferencePlayground").children().eq(1).before(authEleSection); } } } if (!onlyAuthHelpTxt.includes(projName)) { $("section.InputGroup").hide(); } const hasPostman = await postmanAuth(); $("span.auth-section-info").show(); if (!hasPostman) { addAuthSection(); } if (!$("div.auth-code-comment").length) { injectCodeComment(); } } function readMore() { if (!isChangelogSection()) return; const hasTxt = document.querySelectorAll(".ch-release-note").length; if (hasTxt) return; document.querySelectorAll(".rm-Changelog article[class*='ChangelogPostExcerpt']").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.querySelectorAll("section.markdown-body")[0]?.append(span); }); } $(window).on("click", "a.rm-Header-bottom-link, a[class*='Pagination-link']", function () { if (this.getAttribute("href")?.includes("changelog")) readMore(); }); $(document).on("click", ".ch-release-note", function () { $(this).parent().siblings("h2").children("a").trigger("click"); }); function releaseNotesBackButton() { if (!isChangelogSection()) return; const backBtnDiv = document.querySelector(".rm-Changelog article.rm-Changelog-post > div"); if (!backBtnDiv) return; const projContentName = document.querySelector("meta[property='og:site_name']").content; const btnText = projContentName + " release notes"; const span = backBtnDiv.querySelectorAll("button span")[1]; if (span) { span.innerText = btnText; } else { const firstLink = backBtnDiv.querySelectorAll("a")[0]; const spanIcon = firstLink.querySelectorAll("span")[0].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"; } function openFirstResponse() { $(".rm-PlaygroundResponse div[class*='APIResponse-empty'] button:first-child").trigger("click"); } /* let isProgrammaticClick = false; $(window).on("click", ".docsearch-bar input.Input", function () { if (document.querySelector(".rm-SearchModal.show-modal")) return; shouldFilterByProject = true; isProgrammaticClick = true; $(this).trigger("blur"); $(".rm-Header-search .rm-SearchToggle").trigger("click"); setTimeout(() => { isProgrammaticClick = false; runWithRetries(document, { interval: 50, maxTries: 20 }); }, 0); }); $(window).on("click", ".rm-Header-search .rm-SearchToggle", function () { if (isProgrammaticClick) return; shouldFilterByProject = true; setTimeout(() => { runWithRetries(document, { interval: 50, maxTries: 20 }); }, 0); }); */ function collapsibleTableRows() { const tables = document.querySelectorAll("table"); if (!tables.length) return; const expandableRows = document.querySelectorAll("tr.expand"); if (expandableRows.length) return; $("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(""); rowChilds .prepend('') .wrapInner(''); tRow.firstElementChild.setAttribute("colspan", colLength); tRow.firstElementChild.style.fontWeight = "600"; } }); }); console.log("Collapsible table rows initialized"); } $(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(); }); /* const TARGET_LABEL = (() => { const meta = document.querySelector('meta[property="og:site_name"]'); return meta?.getAttribute("content")?.trim() || ""; })(); const norm = s => (s || "").replace(/\s+/g, " ").trim(); let shouldFilterByProject = false; function tryToggleOnce(root = document) { const filter = root.querySelector(".rm-SearchFilter, [class*='SearchProjectsFilter']"); if (!filter) return false; const spans = filter.querySelectorAll(".Toggle-label, .Toggle-label_md, [class*='Toggle-label']"); if (!spans.length) return false; let didSomething = false; for (const span of spans) { const labelEl = span.closest("label"); if (!labelEl) continue; const input = labelEl.querySelector('input[type="checkbox"]'); if (!input) continue; const isTarget = TARGET_LABEL && norm(span.textContent) === norm(TARGET_LABEL); if (shouldFilterByProject && isTarget) { if (!input.checked) { input.click(); input.dispatchEvent(new Event("change", { bubbles: true })); didSomething = true; } const listItem = labelEl.closest("li"); const list = listItem?.closest("ol"); if (list && listItem && list.firstElementChild !== listItem) { list.prepend(listItem); } continue; } if (!shouldFilterByProject && input.checked) { input.click(); input.dispatchEvent(new Event("change", { bubbles: true })); didSomething = true; } } return didSomething; } function runWithRetries(root, { interval = 75, maxTries = 30 } = {}) { let tries = 0; const id = setInterval(() => { tries++; const ok = tryToggleOnce(root); if (ok || tries >= maxTries) clearInterval(id); }, interval); } let lastModal = null; const mo = new MutationObserver(muts => { for (const m of muts) { for (const n of m.addedNodes) { if (!(n instanceof HTMLElement)) continue; const modal = n.matches?.(".rm-SearchModal, [class*='SearchModal']") ? n : n.querySelector?.(".rm-SearchModal, [class*='SearchModal']"); if (modal && modal !== lastModal) { lastModal = modal; setTimeout(() => runWithRetries(modal), 50); } } } }); mo.observe(document.body, { childList: true, subtree: true }); window.addEventListener("load", () => { shouldFilterByProject = true; setTimeout(() => runWithRetries(document), 200); }); function reorderAlphabetically(listItem, list) { const itemText = norm(listItem.find(".Toggle-label").text()); const siblings = list.children("li"); let inserted = false; siblings.each(function () { if (this === listItem[0]) return true; const siblingText = norm($(this).find(".Toggle-label").text()); const siblingInput = $(this).find("input.Toggle-input")[0]; if (siblingInput?.checked) return true; if (itemText.localeCompare(siblingText) < 0) { listItem.insertBefore($(this)); inserted = true; return false; } }); if (!inserted) { list.append(listItem); } } */ function waitForElement(selector) { return new Promise(resolve => { const existingElement = document.querySelector(selector); if (existingElement) { return resolve(existingElement); } const observer = new MutationObserver((mutations, obs) => { const element = document.querySelector(selector); if (element) { resolve(element); obs.disconnect(); } }); observer.observe(document.body, { childList: true, subtree: true, }); }); } function waitForAllElements(selector, callback, settleTime = 100) { let timer; const initialElements = document.querySelectorAll(selector); if (initialElements.length > 0) { callback(); return; } const observer = new MutationObserver((mutations, obs) => { const elements = document.querySelectorAll(selector); if (elements.length > 0) { clearTimeout(timer); timer = setTimeout(() => { obs.disconnect(); callback(); }, settleTime); } }); observer.observe(document.body, { childList: true, subtree: true }); } function retryUntilReady(checkAndApply, { interval = 100, maxTries = 30 } = {}) { let tries = 0; const id = setInterval(() => { tries++; const done = checkAndApply(); if (done || tries >= maxTries) clearInterval(id); }, interval); } function tryReadMore() { if (!isChangelogSection()) return true; const articles = document.querySelectorAll(".rm-Changelog article[class*='ChangelogPostExcerpt']"); if (!articles.length) return false; readMore(); return true; } function tryReleaseNotesBackButton() { if (!isChangelogSection()) return true; const backBtnDiv = document.querySelector(".rm-Changelog article.rm-Changelog-post > div"); if (!backBtnDiv) return false; releaseNotesBackButton(); return true; } $(window).on("pageLoad", async () => { console.log("pageLoad start"); setTimeout(() => { document .querySelectorAll(".rm-SearchToggle-placeholder") .forEach(x => (x.innerHTML = "Search this doc set")); updateLoggedInDetailsOverride(); openFirstResponse(); }, 100); if (isChangelogSection()) { waitForAllElements(".rm-Changelog article[class*='ChangelogPostExcerpt']", readMore, 150); waitForElement(".rm-Changelog article.rm-Changelog-post > div").then(releaseNotesBackButton); } if (isReferenceSection()) { await authHelp(); injectCodeComment(); } addErrors(); waitForAllElements("table", collapsibleTableRows, 100); console.log("pageLoad end"); }); $(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"); }); window.addEventListener("load", () => { openFirstResponse(); setTimeout(() => { console.log(!$("tr.expand").length); setTimeout(collapsibleTableRows, 1000); isChangelogSection() && readMore(); }, 1000); }); } // 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"); strongElement.classList.remove("beta"); strongElement.classList.remove("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); }); // ======================================== // SEARCH DEBUG + BEHAVIOR // ======================================== // GOALS // 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 // 5) Debug logging included // ======================================== (function () { 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("/").filter(Boolean)[0] || ""; const LOCAL_PROJECT_PREFIX = PROJECT_SLUG ? `/${PROJECT_SLUG}/` : ""; const PROJECT_LABEL = ( document.querySelector('meta[property="og:site_name"]')?.getAttribute("content") || window.projContentName || "").trim(); if (!PROJECT_LABEL || !PROJECT_SLUG) { console.warn("[SEARCH DEBUG] Missing PROJECT_LABEL or PROJECT_SLUG", { PROJECT_LABEL, PROJECT_SLUG }); return; } let pendingProjectScope = false; let appliedForCurrentOpen = false; let pollTimer = null; let activeModal = null; let isProgrammaticOpen = false; function dbg(label, data) { try { console.log(`[SEARCH DEBUG] ${label}`, data || ""); } catch (e) {} } function normalizeText(value) { return (value || "").replace(/\s+/g, " ").trim().toLowerCase(); } function clearPoll() { if (pollTimer) { clearInterval(pollTimer); pollTimer = null; dbg("clearPoll()"); } } 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: normalizeText(textEl.textContent), rawText: textEl.textContent }; }) .filter(Boolean); } function getCurrentProjectInput(modal) { const target = normalizeText(PROJECT_LABEL); const options = getSearchProjectInputs(modal); dbg("getCurrentProjectInput() options", options.map(o => ({ rawText: o.rawText, normalized: o.text, checked: o.input.checked }))); const match = options.find((option) => option.text === target); dbg("getCurrentProjectInput() match", match ? { rawText: match.rawText, normalized: match.text, checked: match.input.checked } : null); return match?.input || null; } function isCurrentProjectScoped(modal) { const input = getCurrentProjectInput(modal); return !!(input && input.checked); } function getHubMeData() { try { const el = document.querySelector("#hub-me"); if (!el?.dataset?.json) return null; return JSON.parse(el.dataset.json); } catch (e) { dbg("getHubMeData() parse failed", e); return null; } } function getCurrentProjectMeta() { const hubMe = getHubMeData(); const meta = hubMe?.search?.metaData || []; if (!Array.isArray(meta)) return null; const found = meta.find((p) => normalizeText(p.subdomain) === normalizeText(PROJECT_SLUG)) || meta.find((p) => normalizeText(p.name) === normalizeText(PROJECT_LABEL)); dbg("getCurrentProjectMeta()", found ? { name: found.name, subdomain: found.subdomain, modules: found.modules, nav_names: found.nav_names } : null); return found || null; } function getCurrentProjectNavState() { const nav = document.querySelector(PRIMARY_NAV_SELECTOR); if (!nav) { dbg("getCurrentProjectNavState() no nav found"); return null; } const links = [...nav.querySelectorAll("a.rm-Header-bottom-link")]; const state = { enabled: new Set(), disabled: new Set() }; links.forEach((link) => { const href = link.getAttribute("href") || ""; const isLocalProjectLink = href.startsWith(LOCAL_PROJECT_PREFIX); if (!isLocalProjectLink) return; const text = normalizeText(link.textContent); if (!text) return; const isDisabled = link.classList.contains("NavItem_muted2-OqeulnYimX") || !!link.querySelector('[aria-label="Section Disabled"]') || !!link.querySelector('[class*="DisabledSectionBadge"]'); if (isDisabled) { state.disabled.add(text); } else { state.enabled.add(text); } }); dbg("getCurrentProjectNavState()", { enabled: [...state.enabled], disabled: [...state.disabled] }); return state; } function isTabInvalidForCurrentProject(tabLabel) { const label = normalizeText(tabLabel); const meta = getCurrentProjectMeta(); const navState = getCurrentProjectNavState(); let blockedByMeta = false; let blockedByNav = false; if (meta) { const modules = meta.modules || {}; const navNames = meta.nav_names || {}; if (label === "guide" || label === "guides") { blockedByMeta = modules.docs === false || !String(navNames.docs || "").trim(); } else if (label === "recipes") { blockedByMeta = (modules.tutorials === false && modules.examples === false) || !String(navNames.recipes || "").trim(); } else if (label === "api" || label === "reference") { blockedByMeta = modules.reference === false || !String(navNames.reference || "").trim(); } else if (label === "release notes" || label === "changelog") { blockedByMeta = modules.changelog === false || !String(navNames.changelog || "").trim(); } else if (label === "discussions") { blockedByMeta = modules.discuss === false || !String(navNames.discuss || "").trim(); } else if (label === "pages") { blockedByMeta = modules.custompages === false; } } if (navState) { if (label === "guide" || label === "guides") { blockedByNav = navState.disabled.has("guide") || navState.disabled.has("guides"); } else if (label === "recipes") { blockedByNav = navState.disabled.has("recipes"); } else if (label === "api" || label === "reference") { blockedByNav = navState.disabled.has("api") || navState.disabled.has("reference"); } else if (label === "release notes" || label === "changelog") { blockedByNav = navState.disabled.has("release notes") || navState.disabled.has("changelog"); } else if (label === "discussions") { blockedByNav = navState.disabled.has("discussions"); } else if (label === "pages") { blockedByNav = navState.disabled.has("pages"); } } const blocked = blockedByMeta || blockedByNav; dbg("isTabInvalidForCurrentProject()", { tabLabel, blocked, blockedByMeta, blockedByNav }); return blocked; } function applyBlockedTabStyles(tab, blocked) { tab.removeAttribute("data-search-tab-blocked"); tab.removeAttribute("aria-disabled"); tab.style.opacity = ""; tab.style.cursor = ""; tab.style.pointerEvents = ""; tab.style.userSelect = ""; tab.tabIndex = 1; if (!blocked) return; tab.setAttribute("data-search-tab-blocked", "true"); tab.setAttribute("aria-disabled", "true"); tab.style.opacity = "0.45"; tab.style.cursor = "not-allowed"; tab.style.pointerEvents = "none"; tab.style.userSelect = "none"; tab.tabIndex = -1; } function setTabState(modal) { if (!modal) return; const tabs = modal.querySelectorAll('[role="tab"][aria-label], .Tabs-list [role="tab"]'); if (!tabs.length) { dbg("setTabState() no tabs found"); return; } const scoped = isCurrentProjectScoped(modal); dbg("setTabState()", { scoped, tabCount: tabs.length }); tabs.forEach((tab) => { const ariaLabel = tab.getAttribute("aria-label") || ""; const textLabel = tab.textContent || ""; const normalizedAria = normalizeText(ariaLabel); const normalizedText = normalizeText(textLabel); if (normalizedAria === "all" || normalizedText === "all") { applyBlockedTabStyles(tab, false); return; } if (!scoped) { applyBlockedTabStyles(tab, false); return; } const blocked = isTabInvalidForCurrentProject(ariaLabel) || isTabInvalidForCurrentProject(textLabel); dbg("tab state decision", { ariaLabel, textLabel, blocked }); applyBlockedTabStyles(tab, blocked); }); } function tryCheckProjectBox(modal) { if (!modal || !pendingProjectScope || appliedForCurrentOpen) { dbg("tryCheckProjectBox() skipped", { hasModal: !!modal, pendingProjectScope, appliedForCurrentOpen }); return false; } const matchedInput = getCurrentProjectInput(modal); if (!matchedInput) { dbg("tryCheckProjectBox() no matched input"); return false; } dbg("tryCheckProjectBox() before", { checked: matchedInput.checked, project: PROJECT_LABEL }); if (!matchedInput.checked) { matchedInput.click(); dbg("tryCheckProjectBox() clicked checkbox"); } appliedForCurrentOpen = true; pendingProjectScope = false; setTimeout(() => { setTabState(modal); }, 75); clearPoll(); return true; } function startProjectScopePolling(modal) { clearPoll(); let attempts = 0; const maxAttempts = 30; dbg("startProjectScopePolling()", { maxAttempts }); pollTimer = setInterval(() => { attempts += 1; dbg("poll tick", { attempts }); const worked = tryCheckProjectBox(modal); if (worked || attempts >= maxAttempts) { dbg("poll finished", { worked, attempts }); clearPoll(); setTimeout(() => setTabState(modal), 100); } }, 100); } function clearAllProjectFilters(modal) { if (!modal) return; const inputs = getSearchProjectInputs(modal) .map(option => option.input) .filter(Boolean); dbg("clearAllProjectFilters()", { checkedCount: inputs.filter(input => input.checked).length }); inputs.forEach((input) => { if (input.checked) { input.click(); } }); } function clearAllProjectFiltersWhenReady() { let attempts = 0; const maxAttempts = 20; dbg("clearAllProjectFiltersWhenReady() start"); const interval = setInterval(() => { attempts += 1; const modal = getModal(); dbg("clearAllProjectFiltersWhenReady() tick", { attempts, modalVisible: isModalVisible(modal) }); if (!isModalVisible(modal)) { if (attempts >= maxAttempts) clearInterval(interval); return; } const inputs = getSearchProjectInputs(modal); if (inputs.length) { clearAllProjectFilters(modal); setTimeout(() => setTabState(modal), 50); clearInterval(interval); dbg("clearAllProjectFiltersWhenReady() done"); return; } if (attempts >= maxAttempts) { clearInterval(interval); } }, 100); } function resetModalState() { dbg("resetModalState()"); appliedForCurrentOpen = false; pendingProjectScope = false; clearPoll(); activeModal = null; isProgrammaticOpen = false; } // Native header search button: SHOULD project-scope $(document).off("click.searchDebugHeader", HEADER_SEARCH_BUTTON_SELECTOR); $(document).on("click.searchDebugHeader", HEADER_SEARCH_BUTTON_SELECTOR, function (e) { dbg("HEADER SEARCH BUTTON click", { isProgrammaticOpen, target: e.target }); if (isProgrammaticOpen) { dbg("HEADER SEARCH BUTTON ignored because programmatic"); return; } pendingProjectScope = true; appliedForCurrentOpen = false; }); // Top/global search input: SHOULD open only, clear all project filters $(document).off("mousedown.searchDebugTop", TOP_SEARCH_INPUT_SELECTOR); $(document).on("mousedown.searchDebugTop", TOP_SEARCH_INPUT_SELECTOR, function (e) { dbg("TOP SEARCH mousedown", { selector: TOP_SEARCH_INPUT_SELECTOR, target: e.target }); e.preventDefault(); e.stopImmediatePropagation(); pendingProjectScope = false; appliedForCurrentOpen = false; if (typeof this.blur === "function") { this.blur(); } const btn = document.querySelector(HEADER_SEARCH_BUTTON_SELECTOR); dbg("TOP SEARCH forcing native button click", { foundButton: !!btn }); if (btn) { isProgrammaticOpen = true; btn.click(); setTimeout(() => { isProgrammaticOpen = false; dbg("TOP SEARCH cleared isProgrammaticOpen"); clearAllProjectFiltersWhenReady(); }, 0); } }); $(document).off("click.searchDebugTop", TOP_SEARCH_INPUT_SELECTOR); $(document).on("click.searchDebugTop", TOP_SEARCH_INPUT_SELECTOR, function (e) { dbg("TOP SEARCH click", { selector: TOP_SEARCH_INPUT_SELECTOR, target: e.target }); e.preventDefault(); e.stopImmediatePropagation(); }); // Checkbox changes $(document).off("change.searchDebugFilters", ".rm-SearchModal input[type='checkbox'], [class*='SearchModal'] input[type='checkbox']"); $(document).on("change.searchDebugFilters", ".rm-SearchModal input[type='checkbox'], [class*='SearchModal'] input[type='checkbox']", function () { const modal = getModal(); dbg("FILTER checkbox change", { checked: this.checked, value: this.value, labelText: $(this).closest("label").text().trim() }); if (!modal) return; setTimeout(() => { setTabState(modal); }, 50); }); // Hard block invalid tabs just in case $(document).off("click.searchDebugBlockedTabs", ".rm-SearchModal [role='tab'][data-search-tab-blocked='true'], [class*='SearchModal'] [role='tab'][data-search-tab-blocked='true']"); $(document).on("click.searchDebugBlockedTabs", ".rm-SearchModal [role='tab'][data-search-tab-blocked='true'], [class*='SearchModal'] [role='tab'][data-search-tab-blocked='true']", function (e) { dbg("BLOCKED TAB click prevented", { ariaLabel: this.getAttribute("aria-label"), text: this.textContent.trim() }); e.preventDefault(); e.stopImmediatePropagation(); return false; }); $(document).off("keydown.searchDebugBlockedTabs", ".rm-SearchModal [role='tab'][data-search-tab-blocked='true'], [class*='SearchModal'] [role='tab'][data-search-tab-blocked='true']"); $(document).on("keydown.searchDebugBlockedTabs", ".rm-SearchModal [role='tab'][data-search-tab-blocked='true'], [class*='SearchModal'] [role='tab'][data-search-tab-blocked='true']", function (e) { if (e.key !== "Enter" && e.key !== " ") return; dbg("BLOCKED TAB keydown prevented", { ariaLabel: this.getAttribute("aria-label"), text: this.textContent.trim(), key: e.key }); e.preventDefault(); e.stopImmediatePropagation(); return false; }); // Observer const observer = new MutationObserver(() => { const modal = getModal(); if (!isModalVisible(modal)) { resetModalState(); return; } if (modal !== activeModal) { activeModal = modal; appliedForCurrentOpen = false; dbg("new modal detected", modal); } if (pendingProjectScope && !appliedForCurrentOpen) { dbg("observer starting project scope polling"); startProjectScopePolling(modal); } else { setTimeout(() => { setTabState(modal); }, 100); } }); observer.observe(document.body, { childList: true, subtree: true }); dbg("initialized", { PROJECT_LABEL, PROJECT_SLUG, LOCAL_PROJECT_PREFIX }); })();

200Successfully retrieved the Prefetch Request settings.

400Invalid. Client error, such as invalid or malformed input.

404Not found. The security policy doesn't exist, doesn't carry application layer controls, or no rule with this ID is available for use in this policy.

500Internal server error. Something went wrong on our side. Try again in a few minutes or contact support if the error persists.