diff --git a/gatsby-config.js b/gatsby-config.js index 166faf087..efad469bf 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -192,6 +192,7 @@ module.exports = { .queries, // for testing add dryRun as true, // dryRun: true, + continueOnFailure: !process.env.ALGOLIA_ADMIN_KEY, }, }, { diff --git a/gatsby-node.js b/gatsby-node.js index 3cb3567e4..98a9cf3a9 100644 --- a/gatsby-node.js +++ b/gatsby-node.js @@ -3,14 +3,123 @@ const { DOC_NAV_PAGE_ID, NOT_FOUND_PAGE_ID, VERSION_DROPDOWN, + SITE_URL, + LLMS_SECTIONS, } = require('./src/configs/doc-configs'); const { getDocLinkFromEdge } = require('./src/utils/gatsby-utils.js'); -exports.onPostBuild = () => { +/* ── Build-time Markdown generation ─────────────────────────────────────── + * For every asciidoc node, convert the already-generated HTML to clean + * Markdown using cheerio (DOM pre-processing) + turndown (HTML→MD). + * The result is stored as `fields.markdownBody` on each node and exposed + * in GraphQL so CopyPageDropdown can use it instead of scraping the DOM. + */ +exports.onCreateNode = ({ node, actions }) => { + if (node.internal.type !== 'Asciidoc') return; + + const { createNodeField } = actions; + const TurndownService = require('turndown'); + const cheerio = require('cheerio'); + + const html = node.html || ''; + const title = node.document?.title || node.pageAttributes?.title || ''; + + /* Load HTML into cheerio for pre-processing */ + const $ = cheerio.load(html, { decodeEntities: false }); + + /* Remove anchor icon links that Asciidoctor injects next to headings */ + $('a.anchor').remove(); + + /* Remove the embedded TOC — it adds noise to Markdown */ + $('#toc').remove(); + + /* Convert admonition tables to readable text blocks */ + $('.admonitionblock').each((_, el) => { + const type = $(el).attr('class').match(/\b(note|tip|warning|caution|important)\b/i)?.[1]?.toUpperCase() || 'NOTE'; + const content = $(el).find('td.content').text().trim(); + $(el).replaceWith(`

${type}: ${content}

`); + }); + + /* Get the cleaned HTML */ + const cleanedHtml = $('body').html() || ''; + + /* Configure turndown */ + const td = new TurndownService({ + headingStyle: 'atx', + bulletListMarker: '-', + codeBlockStyle: 'fenced', + fence: '```', + }); + + /* GFM table plugin — renders tables as proper Markdown pipe tables */ + const { tables } = require('turndown-plugin-gfm'); + td.use(tables); + + const markdownBody = td.turndown(cleanedHtml); + + createNodeField({ + node, + name: 'markdownBody', + value: markdownBody, + }); +}; + +exports.onPostBuild = async ({ graphql, reporter }) => { fsExtra.copyFileSync( `${__dirname}/robots.txt`, `${__dirname}/public/robots.txt`, ); + + try { + const result = await graphql(` + query { + allAsciidoc { + edges { + node { + document { title } + pageAttributes { pageid } + } + } + } + } + `); + + if (result.errors) { + reporter.warn(`llms.txt generation: GraphQL errors — ${JSON.stringify(result.errors)}`); + return; + } + + const pageMap = {}; + result.data.allAsciidoc.edges.forEach(({ node }) => { + const pageid = node.pageAttributes?.pageid; + const title = node.document?.title; + if (pageid && title) pageMap[pageid] = title; + }); + + const lines = [ + '# ThoughtSpot Developer Documentation', + '', + '> Developer documentation for ThoughtSpot Embedded — tools, APIs, and SDKs for embedding ThoughtSpot analytics into your applications.', + '', + ]; + + for (const section of LLMS_SECTIONS) { + lines.push(`## ${section.label}`); + for (const pageId of section.pageIds) { + const title = pageMap[pageId]; + if (title) lines.push(`- [${title}](${SITE_URL}/${pageId})`); + } + lines.push(''); + } + + fsExtra.writeFileSync( + `${__dirname}/public/llms.txt`, + lines.join('\n'), + ); + reporter.info(`llms.txt generated with ${Object.keys(pageMap).length} pages`); + } catch (err) { + reporter.warn(`llms.txt generation failed: ${err.message}`); + } }; exports.createPages = async function ({ actions, graphql }) { const { data } = await graphql(` @@ -39,12 +148,23 @@ exports.createPages = async function ({ actions, graphql }) { `); const namePageIdMap = {}; + // Collect per-category nav HTMLs keyed by category name (pageid minus 'nav-' prefix) + const navMap = {}; + const NAV_PARTIAL_PREFIX = 'nav-'; + data.allAsciidoc.edges.forEach((e) => { const { sourceInstanceName: sourceName, relativePath: relPath, } = e.node.parent; const pageId = e.node.pageAttributes.pageid; + + // Collect nav-* files into the navMap (not content pages) + if (pageId && pageId.startsWith(NAV_PARTIAL_PREFIX)) { + navMap[pageId.slice(NAV_PARTIAL_PREFIX.length)] = e.node.html; + return; + } + if (sourceName === 'tutorials') { const relPathSplit = relPath.split('/'); const pageIdSplit = pageId.split('__'); @@ -66,13 +186,16 @@ exports.createPages = async function ({ actions, graphql }) { data.allAsciidoc.edges.forEach((edge) => { const { pageid: pageId } = edge.node.pageAttributes; + // Skip nav partial files — they are sidebar data, not content pages + if (pageId && pageId.startsWith(NAV_PARTIAL_PREFIX)) return; + const docPath = getDocLinkFromEdge(edge); actions.createPage({ path: docPath, component: require.resolve( './src/components/DevDocTemplate/index.tsx', ), - context: { pageId, navId: DOC_NAV_PAGE_ID, namePageIdMap }, + context: { pageId, navId: DOC_NAV_PAGE_ID, navMap, namePageIdMap }, }); if (pageId === 'introduction') { @@ -81,7 +204,7 @@ exports.createPages = async function ({ actions, graphql }) { component: require.resolve( './src/components/DevDocTemplate/index.tsx', ), - context: { pageId, navId: DOC_NAV_PAGE_ID, namePageIdMap }, + context: { pageId, navId: DOC_NAV_PAGE_ID, navMap, namePageIdMap }, }); } }); diff --git a/modules/ROOT/pages/ai-integration-options.adoc b/modules/ROOT/pages/ai-integration-options.adoc index 5e67530b7..ec760fd73 100644 --- a/modules/ROOT/pages/ai-integration-options.adoc +++ b/modules/ROOT/pages/ai-integration-options.adoc @@ -1,4 +1,4 @@ -= ThoughtSpot AI analytics integration += AI analytics integration :toc: true :toclevels: 3 diff --git a/modules/ROOT/pages/api-changelog.adoc b/modules/ROOT/pages/api-changelog.adoc index 22cb4c719..1a1338efd 100644 --- a/modules/ROOT/pages/api-changelog.adoc +++ b/modules/ROOT/pages/api-changelog.adoc @@ -8,6 +8,102 @@ This changelog lists only the changes introduced in the Visual Embed SDK. For information about new features and enhancements available for embedded analytics, see xref:whats-new.adoc[What's New]. +== Version 1.48.x, May 2026 +[width="100%" cols="1,4"] +|==== +|[tag greenBackground]#NEW FEATURE# a| +[discrete] +===== Liveboard embedding + +The SDK includes the following new features and enhancements in Liveboard embedding. + +Continuous Liveboard layout in PDF downloads [beta betaBackground]^Beta^:: + + +When set to `true`, the `isContinuousLiveboardPDFEnabled` enables the Liveboard tab to render on a single page that matches the exact UI layout you see in ThoughtSpot. This update addresses the issue where visualizations for PDF downloads were split across multiple A4 pages regardless of how they appear on screen. This feature is in beta and can be enabled by setting `isContinuousLiveboardPDFEnabled` to `true`. + +New events and action IDs;; + +* `EmbedEvent.DownloadLiveboardAsContinuousPDF` + +Emits when the download action is triggered. +* `HostEvent.DownloadLiveboardAsContinuousPDF` + +Programmatically triggers the download action to export the PDF with a continuous Liveboard layout. +* `Action.DownloadLiveboardAsContinuousPDF` + +Action ID to control the visibility of download action that exports continuous PDFs. + +Liveboard download actions:: + +The following action IDs are introduced in the SDK for the download buttons at the Liveboard level: + +* `Action.DownloadLiveboard` + +* `Action.DownloadLiveboardAsXlsx` + +* `Action.DownloadLiveboardAsCsv` + +Test email for Liveboard scheduled jobs:: + +The SDK introduces the `isSendNowLiveboardSchedulingEnabled` to enable the **Send now** option for the Liveboard scheduled jobs. This option allows Liveboard users to send a test email notification to either themselves or the intended recipients of the Liveboard scheduled alerts. + +New events and action IDs;; + +* `EmbedEvent.SendTestScheduleEmail` + +Emits when *Send now* button is clicked. +* `HostEvent.SendTestScheduleEmail` + +Programmatically triggers the Send now action to send a test email notification for a Liveboard scheduled job. +* `Action.SendTestScheduleEmail` + +Action ID to disable, show, or hide the **Send now** button on the Liveboard schedule page. + +|[tag greenBackground]#NEW FEATURE# a| + +[discrete] +===== Spotter embedding + +The SDK introduces the following action IDs to control the visibility of specific UI components in chat panel of the embedded Spotter interface: + +* `Action.SpotterChatConnectorResources` + +For the connector resources section in the Spotter chat interface. +* `Action.SpotterChatConnectors` + +For the connectors panel section in the Spotter chat interface. +* `Action.SpotterChatModeSwitcher` + +For the mode switcher in the Spotter chat interface. + +|[tag greenBackground]#NEW FEATURE# a| + +[discrete] +===== Event handling +Note the following changes: + +EmbedEvent:: + +* `EmbedEvent.Subscribed` + +The SDK introduces the `EmbedEvent.Subscribed` to emit an event when a HostEvent listener is registered. You can use this event to safely dispatch host events during the initial load without race conditions. +* `EmbedEvent.Error` + +The `EmbedEvent.Error` now fires on HostEvent payload validation failures. +* `EmbedEvent.ChangePersonalizedView` + +Emits when a user selects a different Personalized View or resets to default. + +HostEvent:: +* `HostEvent.GetExportRequestForCurrentPinboard` [.version-badge.breaking]#Breaking# + +The response payload of the `GetExportRequestForCurrentPinboard` passthrough +host event has been updated to include a `type` discriminator field, making it +consistent with the shape of other host event responses. It now returns `{ data: { v2Content }, type }` instead of `{ v2Content }` directly. This enhancement introduces a breaking change for any code that reads `result.v2Content` directly. Update your integration workflows to use `result.data.v2Content`. + +* `HostEvent.SelectPersonalizedView` + +Triggers the selection of a specific Personalized View and resets the default view on a Liveboard. + +⚠️Deprecated events and action IDs️:: +The following events are deprecated and replaced with new event IDs. + +* `EmbedEvent.UpdatePersonalisedView`. Use `EmbedEvent.UpdatePersonalizedView`. +* `EmbedEvent.SavePersonalisedView`. Use `EmbedEvent.SavePersonalizedView`. +* `EmbedEvent.DeletePersonalisedView`. Use `EmbedEvent.DeletePersonalizedView`. +* `HostEvent.ResetLiveboardPersonalisedView`. Use `HostEvent.ResetLiveboardPersonalizedView`. +* `Action.PersonalisedViewsDropdown`. Use `Action.PersonalizedViewsDropdown`. +* `Action.OrganiseFavourites`. Use `Action.OrganizeFavorites`. + + +|==== + + == Version 1.47.x, April 2026 [width="100%" cols="1,4"] |==== @@ -147,7 +243,7 @@ Is emitted when a saved chat is deleted. * `EmbedEvent.SpotterConversationSelected` + Is emitted when a saved chat is selected in the chat history sidebar. -|[tag greenBackground]#NEW FEATURE# | `enableLinkOverridesV2` + +|[tag greenBackground]#NEW FEATURE# | `enableLinkOverridesV2` + Use this configuration setting to override ThoughtSpot URLs on hover or when opening in a new tab. This is recommended over the earlier `linkOverride` flag for a better user experience. @@ -619,7 +715,7 @@ For more information about Spotter customization, see xref:embed-spotter.adoc#Sp |[tag greenBackground]#NEW FEATURE# a| -Configurations attributes:: +Configuration attributes:: * `hideIrrelevantChipsInLiveboardTabs` + Hides filter chips on a Liveboard when set to `true`. diff --git a/modules/ROOT/pages/common/nav-embedding.adoc b/modules/ROOT/pages/common/nav-embedding.adoc new file mode 100644 index 000000000..5632e6cbd --- /dev/null +++ b/modules/ROOT/pages/common/nav-embedding.adoc @@ -0,0 +1,177 @@ + +:page-pageid: nav-embedding +:page-description: Embedding navigation + +[navSection] + +[.sidebar-title] +Embed ThoughtSpot in a web app + +* link:{{navprefix}}/getting-started[Embed with Visual Embed SDK] +* link:{{navprefix}}/tsembed[Quickstart guide] +* link:{{navprefix}}/embed-ai-search-analytics[Embed AI Search and Analytics] +** link:{{navprefix}}/embed-spotter[Embed Spotter experience] +** link:{{navprefix}}/embed-spotter-agent[Embed Spotter Agent] +* link:{{navprefix}}/embed-liveboard[Embed Analytics] +** link:{{navprefix}}/embed-liveboard[Embed a Liveboard] +** link:{{navprefix}}/embed-a-viz[Embed a visualization] +* link:{{navprefix}}/full-embed[Embed full application] +** link:{{navprefix}}/full-app-customize[Customize your embed] +** link:{{navprefix}}/customize-nav-controls[Customize navigation panels] +** link:{{navprefix}}/set-default-page[Customize default page and navigation path] +** link:{{navprefix}}/customize-homepage-experience[Customize home page experience] +* Embed token-based Search +** link:{{navprefix}}/search-embed[Embed Search] +** link:{{navprefix}}/embed-searchbar[Embed search bar] +* link:{{navprefix}}/react-app-embed[Embed with React components] + +[.sidebar-title] +Embed ThoughtSpot in a mobile app + +* link:{{navprefix}}/mobile-embed[Overview] +* link:{{navprefix}}/embed-ts-mobile-react-native[React Native SDK] +* link:{{navprefix}}/embed-ts-flutter[Flutter embed SDK] +* link:{{navprefix}}/embed-ts-swift[Swift Embed SDK] +* link:{{navprefix}}/embed-ts-android[Android Embed SDK] + +[.sidebar-title] +Embed without SDK + +** link:{{navprefix}}/embed-without-sdk[Embed without SDK] +** link:{{navprefix}}/custom-viz-rest-api[Create a custom visualization] + +[.sidebar-title] +Customize and integrate + +* link:{{navprefix}}/style-customization[Customize UI layout and styles] +** link:{{navprefix}}/customize-style[Customize basic styles] +** link:{{navprefix}}/custom-css[CSS customization framework] +** link:{{navprefix}}/theme-builder-doc[Theme builder] +** link:{{navprefix}}/customize-icons[Customize icons] +** link:{{navprefix}}/customize-text[Customize text strings] +** link:{{navprefix}}/css-variables-reference[CSS variables reference] + +* link:{{navprefix}}/filters-overview[Filters types and application layers] +** link:{{navprefix}}/runtime-overrides[Runtime overrides] +** link:{{navprefix}}/runtime-filters[Runtime filters] +** link:{{navprefix}}/runtime-params[Runtime Parameters] +* link:{{navprefix}}/action-config[Customize menus] +** link:{{navprefix}}/actions[Action IDs in the SDK] +* link:{{navprefix}}/events-app-integration[Events and app interactions] +** link:{{navprefix}}/embed-events[Using embed events] +** link:{{navprefix}}/host-events[Using host events] +** link:{{navprefix}}/context-aware-event-routing[Context-based execution of host events] +** link:{{navprefix}}/hostEventsV2-migration[Migrating from Host Event v1 to Host Events v2 framework] +** link:{{navprefix}}/handling-embed-errors[Handling embed errors] +** link:{{navprefix}}/api-search-intercept[API intercept and data fetch requests] + +* link:{{navprefix}}/custom-action-intro[Custom actions] +** link:{{navprefix}}/customize-actions[Custom actions through the UI] +*** link:{{navprefix}}/custom-action-url[URL actions] +*** link:{{navprefix}}/custom-action-callback[Callback actions] +*** link:{{navprefix}}/edit-custom-action[Set the position of a custom action] +*** link:{{navprefix}}/add-action-viz[Add a local action to a visualization] +*** link:{{navprefix}}/add-action-worksheet[Add a local action to a model] +** link:{{navprefix}}/code-based-custom-action[Code based custom actions] +** link:{{navprefix}}/custom-action-payload[Callback response payload] + +* link:{{navprefix}}/customize-links[Customize links] +* link:{{navprefix}}/set-locale[Customize locale] +* link:{{navprefix}}/custom-domain-config[Custom domain configuration] +* link:{{navprefix}}/customize-emails[Customize onboarding settings] +* link:{{navprefix}}/customize-email-apis[Customize email template] +* link:{{navprefix}}/in-app-navigation[Create dynamic menus and navigation] +* link:{{navprefix}}/best-practices[Performance optimization] +** link:{{navprefix}}/best-practices[Best practices] +** link:{{navprefix}}/prerender[Prerender components] +** link:{{navprefix}}/lazy-load-fullHeight[Full height and lazy loading options] +** link:{{navprefix}}/prefetch[Prefetch static resources] +* link:{{navprefix}}/troubleshoot-errors[Troubleshoot errors] + +[.sidebar-title] +Authentication and data security + +* link:{{navprefix}}/embed-auth[Authentication] +** link:{{navprefix}}/trusted-auth[Trusted authentication] +*** link:{{navprefix}}/trusted-auth-secret-key[Secret key management] +*** link:{{navprefix}}/trusted-auth-sdk[Front-end trusted authentication integration] +*** link:{{navprefix}}/trusted-auth-token-request-service[Token request service] +*** link:{{navprefix}}/trusted-auth-troubleshoot[Troubleshoot trusted authentication] +** link:{{navprefix}}/saml-sso[SAML SSO authentication] +** link:{{navprefix}}/oidc-auth[OpenID Connect authentication] +** link:{{navprefix}}/just-in-time-provisioning[Just-in-time provisioning] +* link:{{navprefix}}/security-settings[Security settings] + +* link:{{navprefix}}/embed-object-access[Authorization] +** link:{{navprefix}}/access-control-sharing[Access control and sharing] +** link:{{navprefix}}/privileges-and-roles[Privileges and Roles] +** link:{{navprefix}}/data-security[Data security] +*** link:{{navprefix}}/rls-rules[RLS Rules] +*** link:{{navprefix}}/abac-via-rls-variables[ABAC via RLS with variables] +*** link:{{navprefix}}/jwt-abac-migration-guide[ABAC JWT migration guide] +**** link:{{navprefix}}/jwt-filter-parameters-rules-migration-guide[JWT ABAC with filter rules -> ABAC via RLS] +**** link:{{navprefix}}/jwt-abac-beta-migration-guide[JWT ABAC beta implementation -> ABAC via RLS] +*** link:{{navprefix}}/abac-user-parameters[ABAC via JWT with filter rules and parameters] +* link:{{navprefix}}/selective-user-access[User access] +* link:{{navprefix}}/troubleshoot-errors[Troubleshoot errors] + +[.sidebar-title] +Embedding tutorials + +* link:{{navprefix}}/tutorials/tutorials-overview[Embedding tutorials] +* link:{{navprefix}}/tutorials/tse-fundamentals/intro[Embedding Fundamentals] +** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-01[01 - Overview] +** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-02[02 - Set up for course] +** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-03[03 - Security setup] +** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-04[04 - Start coding] +** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-05[05 - Embed Search] +** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-06[06 - Embed Natural Language Search] +** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-07[07 - Embed Liveboard] +** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-08[08 - Embed Visualization] +** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-09[09 - Embed full application] +** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-10[10 - Style embedded app] +** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-11[11 - Course summary] +** link:{{navprefix}}/tutorials/style-customization/tutorial[Style customization] +* link:{{navprefix}}/tutorials/react-components/intro[React components] +** link:{{navprefix}}/tutorials/react-components/lesson-01[01 - Initialize Visual Embed SDK] +** link:{{navprefix}}/tutorials/react-components/lesson-02[02 - ThoughtSpot component pages] +** link:{{navprefix}}/tutorials/react-components/lesson-03[03 - Menus and navigation elements] +** link:{{navprefix}}/tutorials/react-components/lesson-04[04 - Event handling] + + +[.sidebar-title] +Reference guides and changelog + +* +++Visual Embed Playground+++ +* link:{{navprefix}}/VisualEmbedSdk[Visual Embed SDK Reference] +include::generated/typedoc/CustomSideNav.adoc[] +** Custom styles +*** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomStyles[CustomStyles]# +*** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomisationsInterface[CustomisationsInterface]# +*** [.typedoc-Interface]#link:{{navprefix}}/Interface_customCssInterface[customCssInterface]# +*** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomCssVariables[customCssVariables]# +** Runtime filters +*** [.typedoc-Interface]#link:{{navprefix}}/Interface_RuntimeFilter[RuntimeFilter]# +*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_RuntimeFilterOp[RuntimeFilterOp]# +** Others +*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_Action[Action]# +*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_ContextMenuTriggerOptions[ContextMenuTriggerOptions]# +*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_DataSourceVisualMode[DataSourceVisualMode]# +*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_Page[Page]# +*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_PrefetchFeatures[PrefetchFeatures]# +*** [.typedoc-Function]#link:{{navprefix}}/Function_executeTML[executeTML]# +*** [.typedoc-Function]#link:{{navprefix}}/Function_exportTML[exportTML]# +* link:{{navprefix}}/embed-sdk-changelog[Changelog] +** link:{{navprefix}}/embed-sdk-changelog[Visual Embed SDK] +** link:{{navprefix}}/mobile-sdk-changelog[Mobile Embed SDK] + +[.sidebar-title] +Additional resources + +* link:{{navprefix}}/embed-ts[About ThoughtSpot embedding] +* link:{{navprefix}}/get-started-tse[Embed licenses] +* link:{{navprefix}}/license-feature-matrix[Feature matrix] +* link:{{navprefix}}/faqs[FAQs] +* link:{{navprefix}}/code-samples[Code samples] +* link:https://codesandbox.io/s/big-tse-react-demo-i4g9xi[React CodeSandbox, window=_blank] +* link:https://codesandbox.io/s/graphqlcookieembed-wf4fk9?file=/src/App.js:418-426[GraphQL CodeSandbox, window=_blank] diff --git a/modules/ROOT/pages/common/nav-mcp-server.adoc b/modules/ROOT/pages/common/nav-mcp-server.adoc new file mode 100644 index 000000000..d40f131d7 --- /dev/null +++ b/modules/ROOT/pages/common/nav-mcp-server.adoc @@ -0,0 +1,32 @@ + +:page-pageid: nav-mcp-server +:page-description: MCP Server navigation + +[navSection] + +[.sidebar-title] +ThoughtSpot MCP server + +* link:{{navprefix}}/mcp-integration[Overview] +** link:{{navprefix}}/mcp-server-spotter3[MCP Server with Spotter 3] +** link:{{navprefix}}/mcp-server-legacy[Legacy MCP Server architecture and tools] +* link:{{navprefix}}/connect-mcp-server-to-clients[Connecting MCP Server to MCP clients] +* link:{{navprefix}}/custom-chatbot-integration-mcp[Integrating MCP Server in a custom app] + +[.sidebar-title] +MCP tools reference + +* link:{{navprefix}}/mcp-tool-reference[Overview] +* link:{{navprefix}}/mcp-tool-reference-spotter3[MCP tool reference (Spotter 3)] +* link:{{navprefix}}/mcp-tool-reference-spotter3[MCP tool reference (legacy version)] + +[.sidebar-title] +Related SDK components + +* [.typedoc-Function]#link:{{navprefix}}/Function_startAutoMCPFrameRenderer[startAutoMCPFrameRenderer]# +* [.typedoc-Interface]#link:{{navprefix}}/Interface_AutoMCPFrameRendererViewConfig[AutoMCPFrameRendererViewConfig]# + +[.sidebar-title] +MCP Server release notes + +* link:{{navprefix}}/mcp-server-changelog[MCP Server changelog] diff --git a/modules/ROOT/pages/common/nav-rest-api.adoc b/modules/ROOT/pages/common/nav-rest-api.adoc new file mode 100644 index 000000000..a9fec3165 --- /dev/null +++ b/modules/ROOT/pages/common/nav-rest-api.adoc @@ -0,0 +1,96 @@ + +:page-pageid: nav-rest-api +:page-description: REST API navigation + +[navSection] + +[.sidebar-title] +REST APIs + +* link:{{navprefix}}/rest-apis[Overview] +* link:{{navprefix}}/rest-apiv2-getstarted[Get started] +* link:{{navprefix}}/api-authv2[REST API v2.0 authentication] +* link:{{navprefix}}/rest-v2-changelog[REST API v2 changelog] +* link:{{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction[REST API v2 Playground] +* link:{{navprefix}}/rest-apiv2-reference[REST API v2.0 Reference] +** link:{{navprefix}}/api-user-management[Users and group privileges] +** link:{{navprefix}}/rbac[Role-based access control] +** link:{{navprefix}}/rest-apiv2-search[Search API endpoints] +*** link:{{navprefix}}/rest-apiv2-users-search[Search users] +*** link:{{navprefix}}/rest-apiv2-groups-search[Search groups] +*** link:{{navprefix}}/rest-apiv2-metadata-search[Search metadata] +** link:{{navprefix}}/fetch-data-and-report-apis[Data and Report APIs] +** link:{{navprefix}}/spotter-api[Spotter APIs] +*** link:{{navprefix}}/spotter-agent-apis[AI APIs (Spotter Agent and Spotter 3)] +*** link:{{navprefix}}/spotter-apis-classic[AI APIs (Spotter Classic) ^BETA^] +*** link:{{navprefix}}/spotter-coaching-apis[Spotter coaching APIs ^BETA^] +** link:{{navprefix}}/audit-logs[Audit logs] +** link:{{navprefix}}/tml[TML] +** link:{{navprefix}}/collections[Collections ^BETA^] +** link:{{navprefix}}/connections[Connections] +** link:{{navprefix}}/connection-config[Connection configuration] +** link:{{navprefix}}/runtime-sort[Runtime sorting] + + +[.sidebar-title] +REST API SDK + +* link:{{navprefix}}/rest-api-sdk[Overview] +* link:{{navprefix}}/rest-api-sdk-typescript[TypeScript SDK] +* link:{{navprefix}}/rest-api-sdk-java[Java SDK] +* link:{{navprefix}}/rest-apiv2-js[REST API v2.0 in JavaScript] + +[.sidebar-title] +Webhooks + +* link:{{navprefix}}/webhooks[Overview] +* link:{{navprefix}}/webhooks-comm-channel[Configure and monitor webhook communication channels] +* link:{{navprefix}}/webhooks-s3-integration[Deliver Liveboard reports to AWS S3 Storage] +* link:{{navprefix}}/webhooks-lb-schedule[Deliver Liveboard reports to external application] +* link:{{navprefix}}/webhooks-lb-payload[Webhook response payload] +* link:{{navprefix}}/webhooks-kpi[Webhook for KPI alerts] + +[.sidebar-title] +REST API Tutorials + +* link:{{navprefix}}/tutorials/rest-api/intro[REST API Tutorials] +* link:{{navprefix}}/tutorials/rest-api/lesson-01[01 - REST API overview] +* link:{{navprefix}}/tutorials/rest-api/lesson-02[02 - Simple Python implementation] +* link:{{navprefix}}/tutorials/rest-api/lesson-03[03 - Complex REST API workflows] + +[.sidebar-title] +REST API v1 (DEPRECATED) + +* link:{{navprefix}}/rest-api-getstarted[Get started] +* link:{{navprefix}}/api-auth-session[REST API v1 authentication] +* link:{{navprefix}}/catalog-and-audit[Catalog and audit content] +* link:{{navprefix}}/rest-api-pagination[Paginate API response] +* link:{{navprefix}}/rest-api-reference[REST API v1 Reference] +** link:{{navprefix}}/orgs-api[Orgs API] +** link:{{navprefix}}/user-api[User API] +** link:{{navprefix}}/group-api[Group API] +** link:{{navprefix}}/role-api[Role API] +** link:{{navprefix}}/session-api[Session API] +** link:{{navprefix}}/connections-api[Data connection API] +** link:{{navprefix}}/metadata-api[Metadata API] +** link:{{navprefix}}/admin-api[Admin API] +** link:{{navprefix}}/tml-api[TML API] +** link:{{navprefix}}/dependent-objects-api[Dependent objects API] +** link:{{navprefix}}/search-data-api[Search data API] +** link:{{navprefix}}/liveboard-data-api[Liveboard data API] +** link:{{navprefix}}/liveboard-export-api[Liveboard export API] +** link:{{navprefix}}/security-api[Security API] +** link:{{navprefix}}/logs-api[Audit logs API] +** link:{{navprefix}}/materialization-api[Materialization API] +** link:{{navprefix}}/database-api[Database API] +** link:{{navprefix}}/rest-v1-changelog[REST API v1 changelog] +** link:{{navprefix}}/v1v2-comparison[REST v1 and v2.0 comparison] + + +//** link:{{navprefix}}/graphql-guide[GraphQL API ^Beta^] + + + + + + diff --git a/modules/ROOT/pages/common/nav-spottercode.adoc b/modules/ROOT/pages/common/nav-spottercode.adoc new file mode 100644 index 000000000..b60c85c31 --- /dev/null +++ b/modules/ROOT/pages/common/nav-spottercode.adoc @@ -0,0 +1,12 @@ + +:page-pageid: nav-spottercode +:page-description: SpotterCode navigation + +[navSection] + +[.sidebar-title] +SpotterCode agent + +* link:{{navprefix}}/SpotterCode[SpotterCode for IDEs] +* link:{{navprefix}}/integrate-SpotterCode[Integrating SpotterCode] +* link:{{navprefix}}/spottercode-prompting-guide[SpotterCode prompting guide] diff --git a/modules/ROOT/pages/common/nav-tutorials.adoc b/modules/ROOT/pages/common/nav-tutorials.adoc new file mode 100644 index 000000000..b7933f53d --- /dev/null +++ b/modules/ROOT/pages/common/nav-tutorials.adoc @@ -0,0 +1,29 @@ + +:page-pageid: nav-tutorials +:page-description: Tutorials navigation + +[navSection] + +* link:{{navprefix}}/tutorials/tutorials-overview[Tutorials] +** link:{{navprefix}}/tutorials/tse-fundamentals/intro[Embedding Fundamentals] +*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-01[01 - Overview] +*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-02[02 - Set up for course] +*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-03[03 - Security setup] +*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-04[04 - Start coding] +*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-05[05 - Embed Search] +*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-06[06 - Embed Natural Language Search] +*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-07[07 - Embed Liveboard] +*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-08[08 - Embed Visualization] +*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-09[09 - Embed full application] +*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-10[10 - Style embedded app] +*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-11[11 - Course summary] +** link:{{navprefix}}/tutorials/style-customization/tutorial[Style customization] +** link:{{navprefix}}/tutorials/react-components/intro[React components] +*** link:{{navprefix}}/tutorials/react-components/lesson-01[01 - Initialize Visual Embed SDK] +*** link:{{navprefix}}/tutorials/react-components/lesson-02[02 - ThoughtSpot component pages] +*** link:{{navprefix}}/tutorials/react-components/lesson-03[03 - Menus and navigation elements] +*** link:{{navprefix}}/tutorials/react-components/lesson-04[04 - Event handling] + +*** link:{{navprefix}}/tutorials/rest-api/lesson-04[04 - Event handling] +** Spotter +*** link:{{navprefix}}/tutorials/spotter/integrate-into-chatbot[Integrate Spotter into your Chatbot] diff --git a/modules/ROOT/pages/common/nav.adoc b/modules/ROOT/pages/common/nav.adoc index 06771c138..9b6a374fa 100644 --- a/modules/ROOT/pages/common/nav.adoc +++ b/modules/ROOT/pages/common/nav.adoc @@ -4,249 +4,81 @@ [navSection] -* link:{{navprefix}}/ask-docs[AskDocs ^Beta^] - -* link:{{navprefix}}/whats-new[What's New] -** link:{{navprefix}}/whats-new[New features] - -*** link:{{navprefix}}/fixed-issues[Fixed issues] -*** link:{{navprefix}}/known-issues[Known Issues] - -** link:{{navprefix}}/embed-sdk-changelog[SDK changelog] -*** link:{{navprefix}}/embed-sdk-changelog[Visual Embed changelog] -*** link:{{navprefix}}/mobile-sdk-changelog[Mobile Embed SDK changelog] -** link:{{navprefix}}/rest-v2-changelog[REST API changelog] -*** link:{{navprefix}}/rest-v2-changelog[REST API v2 changelog] -*** link:{{navprefix}}/rest-v1-changelog[REST API v1 changelog] +[.sidebar-title] +Release notes and changelogs + +* link:{{navprefix}}/whats-new[What's new] +* Changelog +** link:{{navprefix}}/embed-sdk-changelog[Visual Embed SDK changelog] +** link:{{navprefix}}/mobile-sdk-changelog[Mobile Embed SDK changelog] +** link:{{navprefix}}/rest-v2-changelog[REST API v2 changelog] ** link:{{navprefix}}/mcp-server-changelog[MCP Server changelog] -** link:{{navprefix}}/deprecated-features[Deprecation announcements] - -* Live Playgrounds -** +++Visual Embed Playground+++ -** link:{{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction[REST API v2 Playground] -** link:{{navprefix}}/graphql-play-ground[GraphQL Playground] -** +++REST API v1 Playground+++ -** link:{{navprefix}}/theme-builder[Theme Builder] -** link:{{navprefix}}/spotdev-portal[How to use] -*** link:{{navprefix}}/dev-playground[Visual Embed Playground] -*** link:{{navprefix}}/graphql-playground[GraphQL Playground] -*** link:{{navprefix}}/rest-playground[REST API Playground] - -* link:{{navprefix}}/tutorials/tutorials-overview[Tutorials] -** link:{{navprefix}}/tutorials/tse-fundamentals/intro[Embedding Fundamentals] -*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-01[01 - Overview] -*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-02[02 - Set up for course] -*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-03[03 - Security setup] -*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-04[04 - Start coding] -*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-05[05 - Embed Search] -*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-06[06 - Embed Natural Language Search] -*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-07[07 - Embed Liveboard] -*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-08[08 - Embed Visualization] -*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-09[09 - Embed full application] -*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-10[10 - Style embedded app] -*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-11[11 - Course summary] -** link:{{navprefix}}/tutorials/style-customization/tutorial[Style customization] -** link:{{navprefix}}/tutorials/react-components/intro[React components] -*** link:{{navprefix}}/tutorials/react-components/lesson-01[01 - Initialize Visual Embed SDK] -*** link:{{navprefix}}/tutorials/react-components/lesson-02[02 - ThoughtSpot component pages] -*** link:{{navprefix}}/tutorials/react-components/lesson-03[03 - Menus and navigation elements] -*** link:{{navprefix}}/tutorials/react-components/lesson-04[04 - Event handling] -** link:{{navprefix}}/tutorials/rest-api/intro[REST API] -*** link:{{navprefix}}/tutorials/rest-api/lesson-01[01 - REST API overview] -*** link:{{navprefix}}/tutorials/rest-api/lesson-02[02 - Simple Python implementation] -*** link:{{navprefix}}/tutorials/rest-api/lesson-03[03 - Complex REST API workflows] -*** link:{{navprefix}}/tutorials/rest-api/lesson-04[04 - Event handling] -** Spotter -*** link:{{navprefix}}/tutorials/spotter/integrate-into-chatbot[Integrate Spotter into your Chatbot] - -* link:{{navprefix}}/getting-started[Embed ThoughtSpot] -** link:{{navprefix}}/getting-started[Quickstart Guide] -** link:{{navprefix}}/tsembed[Embed ThoughtSpot in Web app] -*** Embed analytics -**** link:{{navprefix}}/embed-liveboard[Embed a Liveboard] -**** link:{{navprefix}}/embed-a-viz[Embed a visualization] -*** link:{{navprefix}}/embed-ai-search-analytics[Embed AI Search and Analytics] -**** link:{{navprefix}}/embed-spotter[Embed Spotter experience] -**** link:{{navprefix}}/embed-spotter-agent[Embed Spotter Agent] -*** link:{{navprefix}}/full-embed[Embed full application] -**** link:{{navprefix}}/full-app-customize[Customize your embed] -**** link:{{navprefix}}/customize-nav-controls[Customize navigation panels] -**** link:{{navprefix}}/set-default-page[Customize default page and navigation path] -**** link:{{navprefix}}/customize-homepage-experience[Customize home page experience] +* link:{{navprefix}}/deprecated-features[Deprecation announcements] -*** Embed token-based Search -**** link:{{navprefix}}/search-embed[Embed Search] -**** link:{{navprefix}}/embed-searchbar[Embed search bar] -*** link:{{navprefix}}/react-app-embed[Embed with React components] -** link:{{navprefix}}/mobile-embed[Embed ThoughtSpot in a mobile app] -*** link:{{navprefix}}/embed-ts-mobile-react-native[React Native SDK] -*** link:{{navprefix}}/embed-ts-flutter[Flutter embed SDK] -*** link:{{navprefix}}/embed-ts-swift[Swift Embed SDK] -*** link:{{navprefix}}/embed-ts-android[Android Embed SDK] +[.sidebar-title] +Live Playgrounds -** Customize and integrate -*** link:{{navprefix}}/style-customization[Customize UI layout and styles] -**** link:{{navprefix}}/customize-style[Customize basic styles] -**** link:{{navprefix}}/custom-css[CSS customization framework] -***** link:{{navprefix}}/css-variables-reference[CSS variables reference] -***** link:{{navprefix}}/customize-icons[Customize icons] -***** link:{{navprefix}}/customize-text[Customize text strings] -***** link:{{navprefix}}/theme-builder-doc[Theme builder] +* +++Visual Embed Playground+++ +** link:{{navprefix}}/dev-playground[How to use] -*** link:{{navprefix}}/filters-overview[Filters overview] -**** link:{{navprefix}}/runtime-overrides[Runtime overrides] -**** link:{{navprefix}}/runtime-filters[Runtime filters] -**** link:{{navprefix}}/runtime-params[Runtime Parameters] +* link:{{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction[REST API v2 Playground] +** link:{{navprefix}}/rest-playground[How to use] +//** link:{{navprefix}}/graphql-play-ground[GraphQL Playground] +//** +++REST API v1 Playground+++ +* link:{{navprefix}}/theme-builder[Theme Builder] +** link:{{navprefix}}/theme-builder-doc[How to use] -*** link:{{navprefix}}/action-config[Customize menus] -**** link:{{navprefix}}/actions[Action IDs in the SDK] -*** link:{{navprefix}}/events-app-integration[Events and app interactions] -**** link:{{navprefix}}/embed-events[Using embed events] -**** link:{{navprefix}}/host-events[Using host events] -**** link:{{navprefix}}/context-aware-event-routing[Context-based execution of host events] -**** link:{{navprefix}}/hostEventsV2-migration[Migrating from Host Event v1 to Host Events v2 framework] -**** link:{{navprefix}}/api-search-intercept[API intercept and data fetch requests] -*** link:{{navprefix}}/custom-action-intro[Custom actions] -**** link:{{navprefix}}/customize-actions[Custom actions through the UI] -***** link:{{navprefix}}/custom-action-url[URL actions] -***** link:{{navprefix}}/custom-action-callback[Callback actions] -***** link:{{navprefix}}/edit-custom-action[Set the position of a custom action] -***** link:{{navprefix}}/add-action-viz[Add a local action to a visualization] -***** link:{{navprefix}}/add-action-worksheet[Add a local action to a model] -**** link:{{navprefix}}/code-based-custom-action[Code based custom actions] -**** link:{{navprefix}}/custom-action-payload[Callback response payload] -*** link:{{navprefix}}/customize-links[Customize links] -*** link:{{navprefix}}/set-locale[Customize locale] -*** link:{{navprefix}}/custom-domain-config[Custom domain configuration] -*** link:{{navprefix}}/customize-emails[Customize onboarding settings] -*** link:{{navprefix}}/customize-email-apis[Customize email template] -*** link:{{navprefix}}/in-app-navigation[Create dynamic menus and navigation] -** link:{{navprefix}}/security-settings[Security settings] -** link:{{navprefix}}/embed-auth[Authentication] -*** link:{{navprefix}}/trusted-auth[Trusted authentication] -**** link:{{navprefix}}/trusted-auth-secret-key[Secret key management] -**** link:{{navprefix}}/trusted-auth-sdk[Front-end trusted authentication integration] -**** link:{{navprefix}}/trusted-auth-token-request-service[Token request service] -**** link:{{navprefix}}/trusted-auth-troubleshoot[Troubleshoot trusted authentication] -*** link:{{navprefix}}/saml-sso[SAML SSO authentication] -*** link:{{navprefix}}/oidc-auth[OpenID Connect authentication] -*** link:{{navprefix}}/just-in-time-provisioning[Just-in-time provisioning] -** link:{{navprefix}}/embed-object-access[Authorization] -*** link:{{navprefix}}/access-control-sharing[Access control and sharing] -*** link:{{navprefix}}/privileges-and-roles[Privileges and Roles] -*** link:{{navprefix}}/data-security[Data security] -**** link:{{navprefix}}/rls-rules[RLS Rules] -**** link:{{navprefix}}/abac-via-rls-variables[ABAC via RLS with variables] -**** link:{{navprefix}}/jwt-abac-migration-guide[ABAC JWT migration guide] -***** link:{{navprefix}}/jwt-filter-parameters-rules-migration-guide[JWT ABAC with filter rules -> ABAC via RLS] -***** link:{{navprefix}}/jwt-abac-beta-migration-guide[JWT ABAC beta implementation -> ABAC via RLS] -**** link:{{navprefix}}/abac-user-parameters[ABAC via JWT with filter rules and parameters] -*** link:{{navprefix}}/selective-user-access[User access] -** link:{{navprefix}}/best-practices[Performance optimization] -*** link:{{navprefix}}/best-practices[Best practices] -*** link:{{navprefix}}/prerender[Prerender components] -*** link:{{navprefix}}/lazy-load-fullHeight[Full height and lazy loading options] -*** link:{{navprefix}}/prefetch[Prefetch static resources] -** link:{{navprefix}}/VisualEmbedSdk[Visual Embed SDK Reference] -include::generated/typedoc/CustomSideNav.adoc[] -*** Custom styles -**** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomStyles[CustomStyles]# -**** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomisationsInterface[CustomisationsInterface]# -**** [.typedoc-Interface]#link:{{navprefix}}/Interface_customCssInterface[customCssInterface]# -**** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomCssVariables[customCssVariables]# -*** Runtime filters -**** [.typedoc-Interface]#link:{{navprefix}}/Interface_RuntimeFilter[RuntimeFilter]# -**** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_RuntimeFilterOp[RuntimeFilterOp]# -*** Others -**** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_Action[Action]# -**** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_ContextMenuTriggerOptions[ContextMenuTriggerOptions]# -**** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_DataSourceVisualMode[DataSourceVisualMode]# -**** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_Page[Page]# -**** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_PrefetchFeatures[PrefetchFeatures]# -**** [.typedoc-Function]#link:{{navprefix}}/Function_executeTML[executeTML]# -**** [.typedoc-Function]#link:{{navprefix}}/Function_exportTML[exportTML]# -** Other embedding methods -*** link:{{navprefix}}/embed-without-sdk[Embed without SDK] -*** link:{{navprefix}}/custom-viz-rest-api[Create a custom visualization] -** link:{{navprefix}}/troubleshoot-errors[Troubleshoot errors] +//*** link:{{navprefix}}/graphql-playground[GraphQL Playground] -* link:{{navprefix}}/rest-apis[REST API] -** link:{{navprefix}}/rest-apis[Overview] -** link:{{navprefix}}/api-user-management[Users and group privileges] -** link:{{navprefix}}/rbac[Role-based access control] -** link:{{navprefix}}/spotter-api[Spotter APIs ^BETA^] -** link:{{navprefix}}/audit-logs[Audit logs] -** link:{{navprefix}}/tml[TML] -** link:{{navprefix}}/collections[Collections ^BETA^] -** link:{{navprefix}}/connections[Connections] -*** link:{{navprefix}}/connection-config[Connection configuration] -** link:{{navprefix}}/rest-apiv2-getstarted[REST API v2.0] -*** link:{{navprefix}}/rest-apiv2-getstarted[Get started] -*** link:{{navprefix}}/api-authv2[REST API v2.0 authentication] -*** link:{{navprefix}}/rest-apiv2-js[REST API v2.0 in JavaScript] -*** link:{{navprefix}}/rest-apiv2-search[REST API v2.0 Search endpoints] -**** link:{{navprefix}}/rest-apiv2-users-search[Search users] -**** link:{{navprefix}}/rest-apiv2-groups-search[Search groups] -**** link:{{navprefix}}/rest-apiv2-metadata-search[Search metadata] -*** link:{{navprefix}}/fetch-data-and-report-apis[Data and Report APIs] -*** link:{{navprefix}}/rest-api-sdk[REST API v2.0 SDKs] -**** link:{{navprefix}}/rest-api-sdk-typescript[TypeScript SDK] -**** link:{{navprefix}}/rest-api-sdk-java[Java SDK] -** link:{{navprefix}}/rest-apiv2-reference[REST API v2.0 Reference] -** link:{{navprefix}}/rest-api-getstarted[REST API v1] -*** link:{{navprefix}}/rest-api-getstarted[Get started] -*** link:{{navprefix}}/api-auth-session[REST API v1 authentication] -*** link:{{navprefix}}/catalog-and-audit[Catalog and audit content] -*** link:{{navprefix}}/rest-api-pagination[Paginate API response] -** link:{{navprefix}}/rest-api-reference[REST API v1 Reference] -*** link:{{navprefix}}/orgs-api[Orgs API] -*** link:{{navprefix}}/user-api[User API] -*** link:{{navprefix}}/group-api[Group API] -*** link:{{navprefix}}/role-api[Role API] -*** link:{{navprefix}}/session-api[Session API] -*** link:{{navprefix}}/connections-api[Data connection API] -*** link:{{navprefix}}/metadata-api[Metadata API] -*** link:{{navprefix}}/admin-api[Admin API] -*** link:{{navprefix}}/tml-api[TML API] -*** link:{{navprefix}}/dependent-objects-api[Dependent objects API] -*** link:{{navprefix}}/search-data-api[Search data API] -*** link:{{navprefix}}/liveboard-data-api[Liveboard data API] -*** link:{{navprefix}}/liveboard-export-api[Liveboard export API] -*** link:{{navprefix}}/security-api[Security API] -*** link:{{navprefix}}/logs-api[Audit logs API] -*** link:{{navprefix}}/materialization-api[Materialization API] -*** link:{{navprefix}}/database-api[Database API] -** link:{{navprefix}}/runtime-sort[Runtime sorting] -** link:{{navprefix}}/v1v2-comparison[REST v1 and v2.0 comparison] -** link:{{navprefix}}/graphql-guide[GraphQL API ^Beta^] -** link:{{navprefix}}/webhooks[Webhooks] -*** link:{{navprefix}}/webhooks-comm-channel[Configure and monitor webhook communication channels] -*** link:{{navprefix}}/webhooks-s3-integration[Deliver Liveboard reports to AWS S3 Storage] -*** link:{{navprefix}}/webhooks-lb-schedule[Deliver Liveboard reports to external application] -*** link:{{navprefix}}/webhooks-lb-payload[Webhook response payload] -*** link:{{navprefix}}/webhooks-kpi[Webhook for KPI alerts] +[.sidebar-title] +Get started +* link:{{navprefix}}/getting-started[Embed ThoughtSpot] * link:{{navprefix}}/SpotterCode[SpotterCode for IDEs] -** link:{{navprefix}}/integrate-SpotterCode[Integrating SpotterCode] -** link:{{navprefix}}/spottercode-prompting-guide[SpotterCode prompting guide] - -* MCP Servers and tools -** link:{{navprefix}}/ai-analytics-integration[ThoughtSpot AI analytics integration] -** link:{{navprefix}}/mcp-integration[ThoughtSpot MCP server] -*** link:{{navprefix}}/mcp-server-spotter3[MCP Server with Spotter 3] -*** link:{{navprefix}}/mcp-server-legacy[Legacy MCP Server architecture and tools] -** link:{{navprefix}}/connect-mcp-server-to-clients[Connecting MCP Server to MCP clients] -** link:{{navprefix}}/custom-chatbot-integration-mcp[Integrating MCP Server in a custom app] -** link:{{navprefix}}/mcp-tool-reference[MCP tool reference] -*** link:{{navprefix}}/mcp-tool-reference-spotter3[MCP tool reference (Spotter 3)] -*** link:{{navprefix}}/mcp-tool-reference-spotter3[MCP tool reference (legacy version)] -** Related SDK components -*** [.typedoc-Function]#link:{{navprefix}}/Function_startAutoMCPFrameRenderer[startAutoMCPFrameRenderer]# -*** [.typedoc-Interface]#link:{{navprefix}}/Interface_AutoMCPFrameRendererViewConfig[AutoMCPFrameRendererViewConfig]# - - +* link:{{navprefix}}/rest-apis[REST APIs] +* link:{{navprefix}}/ai-analytics-integration[AI analytics integration] +* link:{{navprefix}}/mcp-integration[MCP Server integration] +//** link:{{navprefix}}/tutorials/tutorials-overview[Tutorials] +* link:{{navprefix}}/VisualEmbedSdk[SDK and API reference] +** link:{{navprefix}}/VisualEmbedSdk[Visual Embed SDK] +** link:{{navprefix}}/rest-apiv2-reference[REST API] +** link:{{navprefix}}/mcp-tool-reference[MCP tools] + + +[.sidebar-title] +Build and deploy + +* link:{{navprefix}}/development-and-deployment[Development and deployment] +** link:{{navprefix}}/thoughtspot-objects[ThoughtSpot objects] +** link:{{navprefix}}/variables[Variables] +** link:{{navprefix}}/parameterize-metadata[Parameterize metadata] + +* link:{{navprefix}}/deploy-with-tml-apis[Deploy with TML APIs] +** link:{{navprefix}}/git-provider-integration[Git provider integration] +** link:{{navprefix}}/modify-tml[TML modification] +* link:{{navprefix}}/publish-data-overview[Publish content to Orgs] +** link:{{navprefix}}/publish-to-orgs[Publish objects to Orgs] +* link:{{navprefix}}/git-integration[Deploy with GitHub APIs (legacy)] +** link:{{navprefix}}/git-configuration[Configure GitHub integration] +** link:{{navprefix}}/git-api[GitHub REST APIs] +** link:{{navprefix}}/guid-mapping[GUID mapping] + +[.sidebar-title] +Multi-tenancy + +* link:{{navprefix}}/multi-tenancy[Overview] +* link:{{navprefix}}/orgs[Multi-tenancy with Orgs] +** link:{{navprefix}}/orgs-api-op[Org administration] +** link:{{navprefix}}/multitenancy-within-an-org[Multi-tenancy within an Org] +** link:{{navprefix}}/single-tenant-data-models[Single-tenant data models with Orgs] +* link:{{navprefix}}/tse-cluster[Cluster maintenance and upgrade] + +[.sidebar-title] +Integration guides + +** link:{{navprefix}}/external-tool-script-integration[Third-party tools and custom scripts] * link:{{navprefix}}/development-and-deployment[Deployment and integration] ** link:{{navprefix}}/development-and-deployment[Development and deployment] @@ -276,23 +108,17 @@ include::generated/typedoc/CustomSideNav.adoc[] ** link:{{navprefix}}/pendo-integration[Pendo integration with embed] ** link:{{navprefix}}/sf-integration[Integration with Salesforce] ** link:{{navprefix}}/vercel-integration[Vercel integration] -* Additional references -** link:{{navprefix}}/embed-ts[About ThoughtSpot embedding] -** link:{{navprefix}}/get-started-tse[Embed licenses] -** link:{{navprefix}}/license-feature-matrix[Feature matrix] -** link:{{navprefix}}/faqs[FAQs] -** link:{{navprefix}}/code-samples[Code samples] -** link:https://codesandbox.io/s/big-tse-react-demo-i4g9xi[React CodeSandbox, window=_blank] -** link:https://codesandbox.io/s/graphqlcookieembed-wf4fk9?file=/src/App.js:418-426[GraphQL CodeSandbox, window=_blank] - -* Resources -** link:https://developers.thoughtspot.com[ThoughtSpot Developers, window=_blank] -** link:https://community.thoughtspot.com/customers/s/[Community, window=_blank] -** link:https://developers.thoughtspot.com/guides[Tutorials, window=_blank] -** link:https://developers.thoughtspot.com/codespot[CodeSpot, window=_blank] -** link:https://training.thoughtspot.com/page/developer[Training resources, window=_blank] -** link:https://docs.thoughtspot.com[Product Documentation, window=_blank] -** link:{{navprefix}}/abac-user-parameters-beta[ABAC via tokens (pre-10.4.0.cl) (Deprecated)] +[.sidebar-title] +Additional resources +* link:{{navprefix}}/faqs[FAQs] +* link:https://codesandbox.io/s/big-tse-react-demo-i4g9xi[React CodeSandbox, window=_blank] +//** link:https://codesandbox.io/s/graphqlcookieembed-wf4fk9?file=/src/App.js:418-426[GraphQL CodeSandbox, window=_blank] +* link:https://community.thoughtspot.com/customers/s/[Community, window=_blank] +* link:https://training.thoughtspot.com/page/developer[Training resources, window=_blank] +* link:https://docs.thoughtspot.com[Product Documentation, window=_blank] +* link:https://developers.thoughtspot.com[ThoughtSpot Developers, window=_blank] +* Deprecated feature docs +** link:{{navprefix}}/abac-user-parameters-beta[ABAC via tokens (pre-10.4.0.cl) (Deprecated)] diff --git a/modules/ROOT/pages/customize-homepage-full-embed.adoc b/modules/ROOT/pages/customize-homepage-full-embed.adoc index 20f9de70e..954cb8da5 100644 --- a/modules/ROOT/pages/customize-homepage-full-embed.adoc +++ b/modules/ROOT/pages/customize-homepage-full-embed.adoc @@ -8,11 +8,10 @@ Developers can customize the home page experience in full application embedding to show either the classic layout or the new modular home page. -[div announcementBlock] --- [IMPORTANT] +==== The classic (V1) experience and V2 experience modes will be deprecated in an upcoming release in 2026. Therefore, ThoughtSpot recommends upgrading the UI experience of your full application embedding to the V3 experience. --- +==== == Home page layout diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index f9ad3bb86..17daad593 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -293,28 +293,39 @@ curl -X POST \ For *PDF* downloads, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. -===== Sample API payload for XLSX downloads +You can now also download continuous pdfs which matches the full length of your Liveboard, without breaking them into multiple A4 pages. + +* `page_size = CONTINUOUS` [beta betaBackground]^Beta^ Unlike the A4 format, which introduces forced page breaks between visualizations, this continuous flow maintains your exact design and intended layout. ++ +When `page_size = CONTINUOUS`, the `include_filter_page` option works to show/hide the filter section in the PDF page (in a continuous PDF, there is no separate filter page, but the filters are included on the same page at the top). +* `zoom_level` [beta betaBackground]^Beta^ offers various download size options to suit the viewer's screen dimensions, thereby enhancing legibility. This can be set only when `page_size = CONTINUOUS`. Valid values are integers in the range of 45 and 175. + +To enable this on your ThoughtSpot instance, contact ThoughtSpot Support. + +===== Sample API payload for PDF downloads [source,cURL] ---- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/report/liveboard' \ - -H 'Authorization: Bearer {access-token}'\ - -H 'Content-Type: application/json' \ +curl -X POST 'https://{ThoughtSpot-Host}/api/rest/2.0/report/liveboard' \ +--header 'Authorization: Bearer {access-token}' \ +--header 'Content-Type: application/json' \ --data-raw '{ -"metadata_identifier": "416052fd-ad22-4d48-be0a-e43b53109957", -"file_format": "PDF", -"visualization_identifiers": [ -"254c6e30-680c-41ea-aa4d-bb059f745462" -], -"pdf_options": { -"include_cover_page": true, -"include_custom_logo": true, -"include_filter_page": true, -"include_page_number": true, -"page_orientation": "LANDSCAPE", -"page_footer_text": "Sample footer text" -} + "metadata_identifier": "416052fd-ad22-4d48-be0a-e43b53109957", + "file_format": "PDF", + "visualization_identifiers": [ + "254c6e30-680c-41ea-aa4d-bb059f745462" + ], + "pdf_options": { + "page_size": "CONTINUOUS", + "zoom_level": 105, + "include_cover_page": true, + "include_custom_logo": true, + "include_filter_page": true, + "include_page_number": true, + "page_orientation": "PORTRAIT", + "truncate_table": false, + "page_footer_text": "Sample footer text" + } }' ---- diff --git a/modules/ROOT/pages/deprecated-features.adoc b/modules/ROOT/pages/deprecated-features.adoc index 4c977b11e..06089a22d 100644 --- a/modules/ROOT/pages/deprecated-features.adoc +++ b/modules/ROOT/pages/deprecated-features.adoc @@ -14,6 +14,8 @@ As ThoughtSpot applications evolve, some existing features will be deprecated an [options='header'] |===== |Feature|Impacted interface and release versions|Deprecation date |End of Support / removal from the product +a|xref:deprecated-features.adoc#hostEventv1[HostEvent v1 framework] +|ThoughtSpot Cloud 26.10.0.cl and later | October 2026 | March 2027 a|xref:deprecated-features.adoc#v1-v2-exp-fullApp-embed[V1 and V2 UI experience in full application embedding]|ThoughtSpot Cloud 26.8.0.cl and later | February 2026 | August 2026 a|xref:deprecated-features.adoc#PNGFlowDeprecation[Select PNG export options] a|ThoughtSpot Cloud 26.4.0.cl and later | April 2026 | August 2026 a|xref:deprecated-features.adoc#variableApis[Variable APIs] a|ThoughtSpot Cloud 26.4.0.cl and later | April 2026 | October 2026 @@ -85,6 +87,18 @@ a|xref:deprecated-features.adoc#_deprecated_parameter_in_rest_api_v2_0_authentic |||| |===== +[#hostEventv1] +== HostEvent v1 framework in Visual Embed SDK +The HostEvent v1 framework will be deprecated in the ThoughtSpot Cloud 26.10.0.cl release version. The default behavior of host events and application workflows with the HostEvent v1 framework will be replaced with the HostEvent v2 framework. + +Impact on your instance:: +Embedding applications with integrations and workflows that use HostEvent objects to trigger actions will benefit from enhanced event handling, routing behavior, and payload validation. If your embedded interface includes multi-layered interactions, event routing will be context-aware and deterministic. +Embedding applications with integrations and workflows that use HostEvent objects to trigger actions will experience improved event handling, routing behavior, and payload validation. If your embedded interface includes multi-layered interactions, event routing will be context-aware and deterministic. For more information, see xref:events-context-aware-routing.adoc[Context-based execution of host events]. + +Recommended actions:: +If you are using the HostEvent v1 framework in your embed, ThoughtSpot recommends migrating to the HostEvent v2 framework in your development environment and evaluating the event behavior and impact on custom workflows and integrations. + +For migration and feature rollout guidelines, refer to the xref:hosteventsv2-migration.adoc[HostEvent v2 migration guide]. + [#v1-v2-exp-fullApp-embed] == V1 and V2 navigation and home page experience in full app embed Starting with ThoughtSpot 26.8.0.cl, the V3 navigation and home page experience will be set as the default UI experience in full application embedding. The V1 and V2 navigation and home page experience will be deprecated and will no longer be supported. diff --git a/modules/ROOT/pages/embed-event-error-best-practices.adoc b/modules/ROOT/pages/embed-event-error-best-practices.adoc new file mode 100644 index 000000000..e9bdc49f0 --- /dev/null +++ b/modules/ROOT/pages/embed-event-error-best-practices.adoc @@ -0,0 +1,433 @@ += Handling embed errors +:toc: true +:toclevels: 2 + +:page-title: Handling embed errors +:page-pageid: handling-embed-errors +:page-description: This document lists the best practices for handling error events. + +The ThoughtSpot Visual Embed SDK provides a layered approach to error +handling. `EmbedEvent.Error` is a real-time outbound event emitted from the embedded ThoughtSpot iframe to the host application, signaling that something has gone wrong, either inside the SDK itself, inside the embedded app (the iframe), or as a result of an invalid HostEvent payload sent by the host. + +Unlike most embed events, which are cached and can be replayed on late subscribers, `EmbedEvent.Error` is not cached or replayed. Every emission is independent, and a handler must be registered before an error occurs to receive it. + +`EmbedEvent.Error` fires on a per-embed-component basis. Any handler must be registered before `render()` is called. + +== Trigger sources +Embed errors surface through distinct channels for the following failure categories: + +* xref:embed-event-error-best-practices.adoc#_sdk_or_configuration_validation[SDK or configuration validation] +* xref:embed-event-error-best-practices.adoc#_hostevent_validation[HostEvent validation errors] +* xref:embed-event-error-best-practices.adoc#_runtime_filter_or_cross_filter_errors[Runtime filter validation errors] +* xref:embed-event-error-best-practices.adoc#_network_events[Network events] + +=== SDK or configuration validation + +When SDK or configuration errors occur, the internal `handleError(error)` method in the embed component: + +1. Sets `isError = true` and permanently blocks future `renderIFrame` calls on this instance. +2. Calls `executeCallbacks(EmbedEvent.Error, { error })`. +3. Logs via `logger.error(error)`. + +[cols="2,3", options="header"] +|=== +| Condition | Error message emitted + +| `init()` was not called before `render()` +| `"Looks like render was called before calling init..."` + +| Both `hiddenActions` and `visibleActions` passed +| `"You cannot have both hidden actions and visible actions"` + +| Both `hiddenTabs` and `visibleTabs` passed +| `"You cannot have both hidden Tabs and visible Tabs"` + +| `trigger()` called before `render()` +| `"Please call render before triggering events"` + +| `trigger()` called with undefined event type +| `"Host event type is undefined"` + +| Auth failure during `renderIFrame` +| The caught auth/login error object +|=== + +=== HostEvent validation + +When the host sends a HostEvent with an invalid payload or a context mismatch, the event bridge validates it against the HostEvent schema. On failure, `dispatchValidationError()` is triggered to emit `EmbedEvent.Error` with code `embedErrorCodes.HOST_EVENT_VALIDATION`. + +[source,json] +---- +{ + "type": "ValidationError", + "code": "HOST_EVENT_VALIDATION", + "message": "" +} +---- + +[IMPORTANT] +==== +If `shouldBypassPayloadValidation: true`, validation failures are silently logged as console warnings and never reach your `EmbedEvent.Error` handler. +==== + +=== Runtime filter or cross-filter errors +Filter operations can fail inside the iframe with typed errors: + +[cols="2,3", options="header"] +|=== +| `eventErrorType` | Typical message pattern + +| `SingleValueFilter` +| `"Filter {name}: Cannot pass multiple filtering elements to this single value filter."` + +| `NonExistFilter` +| `"UpdateFilters could not update the filter on {name} as it is not an existing filter..."` + +| `InvalidDateValue` +| `"UpdateFilters could not update the filter on {name} as invalid date value provided."` + +| `InvalidOperator` +| `"UpdateFilters could not update the filter on {name} as invalid operator value provided."` + +| `WrongVizId` +| `"UpdateCrossFilters could not update the filter as invalid VizId value provided."` + +| `NotAWorksheet` +| `"UpdateCrossFilters could not update the filter as VizId does not consist any worksheet."` + +| `NoFilterableColumnPresent` +| `"Could not apply CrossFilter..."` + +| `filterExistsOrNoAttributeColumn` +| `"UpdateCrossFilters could not update the filter as column is not an attribute..."` + +| `InvalidColumnId` +| `"Invalid ColumnId provided"` + +| `Fullscreen` +| `"Failed to enable fullscreen, This may be happening because there was no user interaction..."` + +| `NoActivePersonalisedViewsError` +| `"No Personalized Liveboard view is selected."` + +| `PersonalisedViewNotFound` +| `"No Personalised View found matching the provided viewId or viewName."` +|=== + +=== Network events + +A global `window.offline` listener emits `EmbedEvent.Error` with a different payload shape: + +[source,json] +---- +{ + "offlineWarning": "Network not Detected. Embed is offline. Please reconnect and refresh" +} +---- + +== Error types + +The `EmbedEvent.Error` is fired when the following types of errors occur: + +[cols="2,3", options="header"] +|=== +|Error type| Description +|`API` a| API call failure error. This error event occurs when an API request is blocked. +Example: +[source,JavaScript] +---- +SearchEmbed.on(EmbedEvent.Error, (error) => { + console.log(error); + // { type: "Error", data: { errorType: "API", error: { message: '...', error: '...' } } } +}); +---- +|`FULLSCREEN` a| Error in presenting a Liveboard or visualization in full-screen mode. + +[source,JavaScript] +---- +LiveboardEmbed.on(EmbedEvent.Error, (error) => { + console.log(error); + // { type: "Error", data: { errorType: "FULLSCREEN", error: { + // message: "Fullscreen mode is not available", + // } }} +}) +---- +|`SINGLE_VALUE_FILTER` a| Error in updating filter values. This error occurs when a single-value filter is applied to a Liveboard and the user tries to update this filter with multiple values. + +[source,JavaScript] +---- +LiveboardEmbed.on(EmbedEvent.Error, (error) => { + console.log(error); + // { type: "Error", data: { errorType: "SINGLE_VALUE_FILTER", error: { + // message: "Filter {filter_name}: Cannot pass multiple filtering elements to this single value filter.", + // } }} +}) +---- +|`NON_EXIST_FILTER` a| Error in applying filter due to a non-existent filter. + +[source,JavaScript] +---- +LiveboardEmbed.on(EmbedEvent.Error, (error) => { + console.log(error); + // { type: "Error", data: { errorType: "NON_EXIST_FILTER", error: { + // message: "UpdateFilters could not update the filter on {filter_name} as it is not an existing filter in the Liveboard. Please edit the Liveboard and add {filter_name} as a filter chip in order to update it programmatically.", + // } }} +}) +---- +|`INVALID_DATE_VALUE` a| Error due to an invalid date value in a filter. For example, if the column name is `Commit Date` and a correct date value is not specified, the `INVALID_DATE_VALUE` error event is fired. + +[source,JavaScript] +---- +LiveboardEmbed.on(EmbedEvent.Error, (error) => { + console.log(error); + // { type: "Error", data: { errorType: "INVALID_DATE_VALUE", error: { + // message: "UpdateFilters could not update the filter on {filter_name} as invalid date value provided.", + // } }} +}) +---- +|`INVALID_OPERATOR` a|Error due to an invalid operator in filter properties. For example, if you try to apply filters on the `Revenue` column with the operator as `LT` and specify multiple values, it may result in an error. + +[source,JavaScript] +---- +LiveboardEmbed.on(EmbedEvent.Error, (error) => { + console.log(error); + // { type: "Error", data: { errorType: "INVALID_OPERATOR", error: { + // message: "UpdateFilters could not update the filter on {filter_name} as invalid operator value provided.", + // } }} +}) +---- +|=== + +== Payload shapes + +[source,typescript] +---- +// SDK / auth error +{ error: string | Record } + +// HostEvent validation error +{ type: string; code: string; message: string } + +// Filter / runtime error (from embedded app) +// — matches one of the eventErrorType patterns above + +// Network offline +{ offlineWarning: string } +---- + +== How to subscribe + +[source,typescript] +---- +import { LiveboardEmbed, EmbedEvent } from '@thoughtspot/visual-embed-sdk'; + +const embed = new LiveboardEmbed('#container', { + liveboardId: 'your-liveboard-id', +}); + +// Register BEFORE render() — errors can fire during initialization +embed.on(EmbedEvent.Error, (payload) => { + + // SDK/auth error + if (payload?.error) { + console.error('[SDK Error]', payload.error); + return; + } + + // HostEvent validation error (your payload is malformed) + if (payload?.code === 'HOST_EVENT_VALIDATION') { + console.error('[HostEvent validation failed]', payload.message); + return; + } + + // runtime filter/action error from the iframe + console.warn('[Embed runtime error]', payload); + + // network offline + if (payload?.offlineWarning) { + showOfflineBanner(payload.offlineWarning); + return; + } +}); + +embed.render(); +---- + + + +//// +=== Recovery after an error + +Once `handleError` fires, the embed instance sets `isError = true` and all future +`renderIFrame` calls are silently skipped. To recover, you must destroy the existing +instance and create a new one: + +[source,typescript] +---- +embed.on(EmbedEvent.Error, async (payload) => { + logError(payload); + + if (isRecoverable(payload)) { + embed.destroy(); // removes window listeners and DOM node + + const freshEmbed = new LiveboardEmbed('#container', viewConfig); + freshEmbed.on(EmbedEvent.Error, errorHandler); + await freshEmbed.render(); + } +}); +---- +//// + +== Handling errors +The following example shows the sample code for handling errors. + +[source,typescript] +---- +import { HostEvent } from '@thoughtspot/visual-embed-sdk'; + +try { + const result = await embed.trigger(HostEvent.UpdateRuntimeFilters, [ + { columnName: 'Region', operator: 'EQ', values: ['West'] }, + ]); + + // Timeout is a resolve, not a reject — check explicitly + if (result instanceof Error) { + console.error('HostEvent timed out:', result.message); + return; + } + + console.log('HostEvent succeeded:', result); + +} catch (err) { + // Rejection = iframe returned an explicit error in the response + console.error('HostEvent rejected by iframe:', err); +} +---- + +=== Error handling guidelines + +[cols="2,4", options="header"] +|===== +| Error category | Detection and recovery + +| SDK init config error + +a|**Detection mechanism**: `EmbedEvent.Error` + + +**Payload/data**: `{ error: string }` + +**Recovery action**: Fix configuration. Recreate and render embed. + +| Auth failure (SDK layer) +a| +**Detection mechanism**: `AuthStatus.FAILURE` on init emitter + +**Payload/data**: `AuthFailureType` + +**Recovery action**: Check `getAuthToken` and credentials. Use `suppressErrorAlerts` for custom UI. + +| Auth failure (iframe layer) + +a| +**Detection mechanism**: `EmbedEvent.AuthFailure` + + +**Recovery action**: Show login prompt. Recreate and render embed. + +| Session expired + +a|**Detection mechanism**: `EmbedEvent.AuthExpire` + +**Recovery action**: Refresh token. Use `autoLogin: true` for a transparent refresh. + +| Idle session timeout + +a|**Detection mechanism**: `EmbedEvent.IdleSessionTimeout` and `AuthStatus.FAILURE(IDLE_SESSION_TIMEOUT)` + +**Recovery action**: Use `autoLogin: true`. Prompt re-authentication. + +|Third-party cookies blocked + +a|**Detection mechanism**: `EmbedEvent.NoCookieAccess` and `AuthStatus.FAILURE(NO_COOKIE_ACCESS)` + +**Recovery action**: Switch to `TrustedAuthTokenCookieless`. Use `ignoreNoCookieAccess: true` to suppress alert. + +| User logout +a|**Detection mechanism**: `EmbedEvent.AuthLogout` and `AuthStatus.LOGOUT` + +**Recovery action**: Redirect to login or clear state + +| Duplicate token +a|**Detection mechanism**: `AuthStatus.FAILURE(SDK)` and `alert()` (suppressible) + +**Payload/data**: `DUPLICATE_TOKEN_ERR` string + +**Recovery action**: Always return a fresh token from `getAuthToken`. + +| Invalid token +a|**Detection mechanism**: `AuthStatus.FAILURE(SDK)` and `logger.error` + +**Payload/data**: `INVALID_TOKEN_ERROR` string + +**Recovery action**: Verify token generation on the server. + +| Network offline +a| **Detection mechanism**: `EmbedEvent.Error` + +**Payload/data**: `{ offlineWarning: string }` + +**Recovery action**: Show offline UI. Reconnect and reload. + +| HostEvent validation error +a|**Detection mechanism**: `EmbedEvent.Error` + +**Payload/data**: `{ type, code: "HOST_EVENT_VALIDATION", message }` + +**Recovery action**: Fix the `HostEvent` payload; enable `useHostEventsV2: true` in development + +| HostEvent timeout (30 seconds) +a|**Detection mechanism**: `trigger()` resolves with `Error` + +**Payload/data**: `Error("Trigger timed-out...")` + +**Recovery action**: Check if iframe is still mounted. Call `reload()` if needed + +| HostEvent iframe rejection +a|**Detection mechanism**: `trigger()` rejects + +**Payload/data**: Error from iframe + +**Recovery action**: Inspect the rejection payload; see HostEvent validation error above + +| Filter errors at runtime +a|**Detection mechanism**: `EmbedEvent.Error` + +**Payload/data**: `eventErrorType` message string + +**Recovery action**: Fix filter parameters. Validate against current Liveboard/answer filters. +|===== + +== Best practices + +* Always register an event listener for `EmbedEvent.Error` on your embed instance to capture and handle errors emitted by the embedded ThoughtSpot application. Register `EmbedEvent.Error` before calling `render()`. +* Inspect and categorize error payloads. The error event provides a payload with fields such as errorType, message, and code. Do not assume that `payload.error` always exists in `EmbedEvent.Error`. Offline errors use `offlineWarning`; validation errors use `code`. +* Do not destroy the embed on errors. First, inspect the errors to determine if you need to display host fallback pages. Not all events are fatal. ThoughtSpot handles some failures internally, so only take action if necessary based on the specific error and event type. +* Provide contextual and user-friendly error messages based on the errorType and error details. Avoid exposing raw error objects or stack traces to your application users. +* Enable `useHostEventsV2: true` in development/staging to surface `HostEvent` payload errors early. +* Log errors for diagnostics. +* Simulate different error scenarios during development. For example, network failures and invalid filters to ensure the error handling logic works as expected. +* Do not set `shouldBypassPayloadValidation: true` in production environments. Validation errors become invisible console warnings. +* Do not call `trigger()` before `render()`; calling it before `render()` returns `null`. + +== Try it out in the Visual Embed Playground +Try out the embed events in the +++ Visual Embed Playground +++ and preview changes. + +[.widthAuto] +[.bordered] +image::./images/embed-event-playground.png[Try Embed events in Playground] + +== Additional resources + +* To identify and log errors, use the error types and error codes. For more information, see xref:EmbedErrorDetailsEvent.adoc[EmbedErrorDetailsEvent] and xref:EmbedErrorCodes.adoc[EmbedErrorCodes]. +* For information about the supported event objects and examples, see xref:EmbedEvent.adoc[EmbedEvent]. + + diff --git a/modules/ROOT/pages/embed-pinboard.adoc b/modules/ROOT/pages/embed-pinboard.adoc index eaae64319..d8a246b78 100644 --- a/modules/ROOT/pages/embed-pinboard.adoc +++ b/modules/ROOT/pages/embed-pinboard.adoc @@ -6,7 +6,7 @@ :page-pageid: embed-liveboard :page-description: You can use the LiveboardEmbed SDK library to embed a ThoughtSpot Liveboard in your app and use it for live insights -This page explains how to embed a ThoughtSpot Liveboard in your Web page, portal, or application. +This page explains how to embed a ThoughtSpot Liveboard in your web page, portal, or application. A ThoughtSpot Liveboard is an interactive dashboard that presents a collection of visualizations pinned by a user. @@ -64,7 +64,7 @@ For more information about the Liveboard embed object, classes, methods, interfa == Customize Liveboard view -The `LiveboardEmbed` component includes the `xref:LiveboardViewConfig.adoc[LiveboardViewConfig]` object. This object provides various attributes and properties to customize the xref:css-customization.adoc[look and feel of the Liveboard page], xref:embed-actions.adoc[control the visibility of menu actions] and features, and xref:embed-events.adoc[manage interactions between the host and embedded app]. +The `LiveboardEmbed` component includes the `xref:LiveboardViewConfig.adoc[LiveboardViewConfig]` object. This object provides various attributes and properties to xref:css-customization.adoc[customize the look and feel of the Liveboard page], xref:embed-actions.adoc[control the visibility of menu actions] and features, and xref:embed-events.adoc[manage interactions between the host and embedded app]. The most common customization is controlling the visibility of menu items in the embedded view by configuring the `disabledActions`, `hiddenActions`, and `visibleActions` properties with an array of xref:Action.adoc[Action] IDs. For information about the other frequently used properties, see xref:embed-pinboard.adoc#common-customizations[common customization options]. @@ -94,16 +94,16 @@ liveboardEmbed.render(); ---- == Verify the embedded object -. Load the embedded object in your app. If the embedding is successful, you will see a Liveboard page with visualizations. +. Load the embedded object in your app. If the embedding is successful, you see a Liveboard page with visualizations. + [.bordered] image::./images/embed-lb.png[Liveboard embed] -. Explore the charts and tables, and verify if objects render and show the desired data. +. Explore the charts and tables, and verify that objects render and show the desired data. [#common-customizations] == Common customization options -The *xref:LiveboardViewConfig.adoc[LiveboardViewConfig]* object includes several properties and attributes that allow fine-grained control of the embedded experience. You can specify settings that enable or disable a specific feature, control visible or disabled menu elements and actions, set tabs and layout preferences, manage filters, hide header, and more. +The *xref:LiveboardViewConfig.adoc[LiveboardViewConfig]* object includes several properties and attributes that allow fine-grained control of the embedded experience. You can specify settings that enable or disable a specific feature, control visible or disabled menu elements and actions, set tabs and layout preferences, manage filters, hide header, and more. === Show/hide large UI elements Parameters such as `hideLiveboardHeader`, `hideTabPanel`, `isLiveboardHeaderSticky`, `showLiveboardTitle`, and `showLiveboardDescription` control various aspects of the standard embedded Liveboard experience. Note the phrasing of the property name and the description in the documentation to understand whether `true` enables or disables the particular feature. @@ -113,9 +113,9 @@ Parameters such as `hideLiveboardHeader`, `hideTabPanel`, `isLiveboardHeaderStic [.widthAuto] image::./images/liveboard_view_config_callouts_2.png[LiveboardViewConfig parameters] -The `hideLiveboardHeader` property removes the entire header area above the Liveboard, including filters and the overall Liveboard menu, which is a common pattern for "read-only" use cases or rebuilding your own menus and buttons using xref:embed-events.adoc[HostEvents]. +The `hideLiveboardHeader` property removes the entire header area above the Liveboard, including filters and the overall Liveboard menu, which is a common pattern for "read-only" use cases or for rebuilding your own menus and buttons using xref:embed-events.adoc[HostEvents]. -The following constructor will disable the __sticky header__, while showing the Liveboard title, which would be hidden by default: +The following constructor disables the __sticky header__ and shows the Liveboard title, which is hidden by default: [source,JavaScript] ---- @@ -132,7 +132,7 @@ const liveboardEmbed = new LiveboardEmbed(document.getElementById('ts-embed'), { [NOTE] ==== -When `fullHeight` is set to `true`, the SDK ignores the `isLiveboardHeaderSticky:true` setting, and the Liveboard header will not be sticky. +When `fullHeight` is set to `true`, the SDK ignores the `isLiveboardHeaderSticky:true` setting, and the Liveboard header is not sticky. ==== === Customize Liveboard tabs @@ -157,9 +157,9 @@ The `activeTabId` property is available only in the `LiveboardEmbed` package and ==== === Reduce visible tabs and visualizations -`visibleVizs` and `visibleTabs` allow for limiting the experience for certain users from a Liveboard with many more elements. +`visibleVizs` and `visibleTabs` allow you to limit the experience for certain users on a Liveboard with many more elements. -For example, a template Liveboard with many different KPIs could be reduced down to a smaller set by giving a user an interface to select the particular visualizations to show, storing their selections, and using that saved set of visualization GUIDs as the array for `visibleVizs` on page load (there is an equivalent xref:embed-events.adoc[HostEvent] called `SetVisibleVizs` to make an update after the Liveboard has loaded). +For example, a template Liveboard with many different KPIs could be reduced to a smaller set by giving a user an interface to select the particular visualizations to show, storing their selections, and using that saved set of visualization GUIDs as the array for `visibleVizs` on page load (there is an equivalent xref:embed-events.adoc[HostEvent] called `SetVisibleVizs` to make an update after the Liveboard has loaded). [#noteTiles] === Add Note tiles @@ -170,8 +170,8 @@ You can add a link:https://docs.thoughtspot.com/cloud/latest/liveboard-notes[Liv * If you are adding links and images from an external site, or embedding multimedia or a web page in an iFrame, make sure the URLs are added to CORS and CSP allowlists. For more information, see xref:security-settings.adoc[Security settings]. === Redefine Liveboard breakpoint widths -When turned on, the `enable2ColumnLayout` allows for customising the Liveboard breakpoint width for embedded users. -The current 12 column layout changes to 2 columns per row at 1024px, and to 1 column per row layout at 630px in the new Liveboard experience. Once enabled, these breakpoints would apply to all Liveboards in the ThoughtSpot instance, and cannot be set only for individual Liveboards. +When enabled, the `enable2ColumnLayout` allows customizing the Liveboard breakpoint width for embedded users. +The current 12 column layout changes to 2 columns per row at 1024px, and to 1 column per row layout at 630px in the new Liveboard experience. Once enabled, these breakpoints apply to all Liveboards in the ThoughtSpot instance, and cannot be set only for individual Liveboards. These breakpoint widths are customisable for the embedded customers. Contact ThoughtSpot support for assistance with customisation. @@ -216,7 +216,7 @@ You can also pin a visualization to a Liveboard tab using the **Pin** action on === Customize filters -To view specific data across the tables and charts on an embedded Liveboard, users can use Liveboard filter options. By default, Liveboard filters cannot be applied at load. You can either embed a Liveboard that already includes filters or use the xref:runtime-filters.adoc[runtime filters] feature in the Visual Embed SDK to apply filters during load time. +To view specific data across the tables and charts on an embedded Liveboard, users can use Liveboard filter options. By default, Liveboard filters cannot be applied at load. You can either embed a Liveboard that already includes filters or use the xref:runtime-filters.adoc[runtime filters] feature in the Visual Embed SDK to apply filters at load time. ==== Customizing filter visibility To hide filters in an embedded Liveboard, you can use the following options: @@ -249,7 +249,102 @@ Use the following host events in the Visual Embed SDK to update filters: * link:https://developers.thoughtspot.com/docs/Enumeration_HostEvent#_updateruntimefilters[`HostEvent.UpdateRuntimeFilters`] to update runtime filters * link:https://developers.thoughtspot.com/docs/Enumeration_HostEvent#_updatecrossfilter[`HostEvent.UpdateCrossFilter`] -For more information and examples, see xref:filters_overview.adoc#_updating_filters_using_host_events[Updating filters] and xref:filters_overview.adoc#_updating_date_filters[Updating date filters]. +For more information and examples, see xref:filters_overview.adoc[Filter types and application layers]. + +== Liveboard download options + +Embedding application users can download Liveboards in the PDF, XLSX, and CSV formats. If the `isContinuousLiveboardPDFEnabled` is set to `true`, users can download the PDF with a continuous layout as seen in the UI, with each tab on a single page. When this parameter is set to `false`, users can download the Liveboard PDF in the A4 format with a paginated view. + +[NOTE] +==== +Starting with the 26.5.0.cl and Visual Embed SDK version 1.48.x, the new multi-format download experience is available on embedded Liveboards and can be enabled using the `isContinuousLiveboardPDFEnabled` and `isLiveboardXLSXCSVDownloadEnabled` parameters. The `Download` action in the Liveboard's more options menu is controlled by `Action.DownloadLiveboard` instead of `Action.Download` and `Action.DownloadAsPdf`. +==== + +=== Download actions and behavior + +[width=100%, cols="2,2,4"] +[options='header'] +|===== +| Download actions +| SDK parameter +| Action ID for show/hide control +| **Download** menu action +| Enabled by default. +a| Use the `Action.DownloadLiveboard` to show, hide, or disable the Download action in the menu. +| Continuous PDF +|`isContinuousLiveboardPDFEnabled` + +Enables or disables the continuous PDF option in Liveboard downloads +a| Use the `Action.DownloadLiveboardAsContinuousPDF` action ID to show or hide the **PDF (Continuous)** option in the **Download** modal. + +| XLSX download +| `isLiveboardXLSXCSVDownloadEnabled` + +Enables the XLSX and CSV download options in the Download modal. +a|`Action.DownloadLiveboardAsXlsx` - action ID to show or hide the XLSX option in the **Download** modal. + +| CSV download +a| `isLiveboardXLSXCSVDownloadEnabled` + +Enables the XLSX and CSV download options in the Download modal. +a|`Action.DownloadLiveboardAsCsv` - action ID to show, hide, or disable the CSV option in the **Download** modal. +|===== + +=== Example + +The following example enables the **PDF (Continuous)**, **XLSX**, and **CSV** options in the Liveboard **Download** modal. + +[source,javascript] +---- +const embed = new LiveboardEmbed('#tsEmbed', { + isContinuousLiveboardPDFEnabled: true, + isLiveboardXLSXCSVDownloadEnabled: true, +}); +---- + +To hide or disable the download options, specify the following action IDs: + +[source,javascript] +---- +const embed = new LiveboardEmbed('#tsEmbed', { + //... + hiddenActions: [ + Action.DownloadLiveboard, // Hides the Download parent action from the more options menu + Action.DownloadLiveboardAsContinuousPDF, // Hides the Continuous PDF download option from the Download modal + Action.DownloadLiveboardAsCsv, // Hides the CSV download option from the Download modal + Action.DownloadLiveboardAsXlsx // Hides the XLSX download option from the Download modal + ], + // Use either `hiddenActions` or visibleActions, not both, to avoid errors + //visibleActions: [ + //Action.DownloadLiveboard, // Shows the Download parent action in the more options menu + //Action.DownloadLiveboardAsContinuousPDF, // Shows the Continuous PDF download option + //Action.DownloadLiveboardAsCsv, // Shows the CSV download option + //Action.DownloadLiveboardAsXlsx // Shows the XLSX download option + //] +}); +---- + +[source,javascript] +---- +const embed = new LiveboardEmbed('#tsEmbed', { + //... + disabledActions: [ + Action.DownloadLiveboard,// Disables the Download parent action in the more options menu + Action.DownloadLiveboardAsContinuousPDF, // Disables the Continuous PDF download option in the Download modal + Action.DownloadLiveboardAsCsv, // Disables the CSV download option in the Download modal + Action.DownloadLiveboardAsXlsx, // Disables the XLSX download option in the Download modal) + ], +}); +---- + +=== HostEvent workflow for the download actions +Use the HostEvent IDs to trigger download actions on an embedded Liveboard. + +* `HostEvent.DownloadLiveboardAsContinuousPDF` + +To open the **Download** modal with the continuous PDF download option selected. +* `HostEvent.DownloadAsPdf` + +To trigger the standard PDF (A4) download action. +* `HostEvent.DownloadAsXlsx` + +To open the **Download** modal with the XLSX option selected when the `isLiveboardXLSXCSVDownloadEnabled` is enabled in the embed view. +* `HostEvent.DownloadAsCsv` + +To open the **Download** modal with the CSV option selected when `isLiveboardXLSXCSVDownloadEnabled` parameter is enabled in the embed view. //// @@ -350,9 +445,9 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { === Liveboard grouping and styling [earlyAccess eaBackground]#Early Access# You can now create a visual group of Answers and note tiles together in the Liveboard. You can select multiple Answers and notes in the Liveboard editor. You can also style parts of the Liveboard, groups and Answers with the new styling panel. To enable this feature, set `isLiveboardMasterpiecesEnabled` to `true`. -It is important to note the following changes which happen in the Liveboard UI and layout when this feature is active. +Note the following changes that occur in the Liveboard UI and layout when this feature is enabled. -* All tiles on the Liveboard will now have a default border and an increased border-radius, resulting in more pronounced curved corners. This is part of the broader visualization tile customization options done to enhance the visual appearance of charts and tables. +* All tiles on the Liveboard will now have a default border and an increased border-radius, resulting in more pronounced curved corners. This is part of the broader visualization tile customization options to enhance the visual appearance of charts and tables. * For Note tiles, the default scrollbar is now hidden for long content. Users must scroll within the tile area itself, and if the tile is not sized appropriately for its content, it may appear clipped due to the new container styles. This change emphasizes the importance of properly sizing Note tiles to avoid content being visually cut off. * If a Liveboard is saved with Groups in the ThoughtSpot interface, but the embedding code does not have the grouping and styling feature enabled, the Liveboard will fail to load and throw an error. + diff --git a/modules/ROOT/pages/filters_overview.adoc b/modules/ROOT/pages/filters_overview.adoc index d77f3b1a5..0d78adf4b 100644 --- a/modules/ROOT/pages/filters_overview.adoc +++ b/modules/ROOT/pages/filters_overview.adoc @@ -1,4 +1,4 @@ -= Filters overview += Filter types and application layers :toc: true :toclevels: 2 @@ -6,9 +6,9 @@ :page-pageid: filters-overview :page-description: ThoughtSpot has several layers of filters which have an order of precedence and different events -ThoughtSpot Embedded provides a robust filtering framework for Liveboards, Answers, visualizations, and other ThoughtSpot objects with multiple filter types and layered application logic. Filters can be configured using the Visual Embed SDK events and parameters when embedding, applied at runtime, or via UI-driven workflows. +ThoughtSpot Embedded provides a robust filtering framework for Liveboards, Answers, visualizations, and other ThoughtSpot objects with multiple filter types and layered application logic. Filters can be configured using Visual Embed SDK events and parameters at embed time, applied at runtime, or set through UI-driven workflows. -== Filter types and application layers +== Overview The behavior of each filter type and the mechanism for setting filters can differ widely. There are different types of filters, which can be applied in the following order: @@ -19,11 +19,11 @@ RLS rules can also be used, along with custom variables and the JSON Web Token ( 2. **Data Model filters** + Models can have parameters, formulas, and filters. + -Embedding application users cannot affect the formulas or filters, which are always applied, but Parameters used in a formula can be set by other methods. + +Embedding application users cannot affect the formulas or filters, which are always applied, but parameters used in a formula can be set by other methods. + If the user can edit the parameter, use the runtime parameters layer to programmatically set its value. 3. xref:runtime-filters.adoc[Runtime filters] and xref:runtime-parameters.adoc[Runtime Parameters] + -You can define xref:runtime-filters.adoc[runtime filters] and xref:runtime-parameters.adoc[runtime parameters] within the browser for a given object at load time. Filters and parameters can be set using the Visual Embed SDK, REST API, or URL query parameters and updated via host events in the Visual Embed SDK. +You can define xref:runtime-filters.adoc[runtime filters] and xref:runtime-parameters.adoc[runtime parameters] in the browser for a given object at load time. Filters and parameters can be set using the Visual Embed SDK, REST API, or URL query parameters and updated via host events in the Visual Embed SDK. + [NOTE] ==== @@ -39,24 +39,24 @@ Cross filters are ad-hoc filters based on user selection. These filters are used Cross filters are supported only on attribute columns. 6. link:https://docs.thoughtspot.com/cloud/latest/filters[Search query filters, window=_blank] + -Set via the search query string in Answers and visualizations, not visible as UI filter components on a Liveboard, but can be viewed in **Explore** or *Edit* modes. + +Set via the search query string in Answers and visualizations, not visible as UI filter components on a Liveboard, but can be viewed in *Explore* or *Edit* modes. + The lowest layer of filters is defined in the search query for a given Answer or visualization on a Liveboard. + The link:https://docs.thoughtspot.com/cloud/latest/filters[filter terms, window=_blank] are saved as part of the `search_query` of the object, visible in TML. == Filter attributes When specifying a column for filtering, you must use the exact column name as defined in the model. Filters can be applied to string, number, boolean, Date, Datetime, and time data types. -For the `DATE` and `DATE_TIME` data types, some filter types may require the date and time values to be specified in the Epoch time format. +For the `DATE` and `DATE_TIME` data types, some filter types may require the date and time values to be specified in epoch time format. All operations result in a `WHERE` clause being applied to the queries generated by ThoughtSpot, or no query being issued if the logic is always false. A data filter object in ThoughtSpot typically includes the following attributes: -`column`, `columnName`, or `columnId`:: +`column`, `columnName`, **or** `columnId`:: The name of the column to filter on. For example, `item type` or `product`. The column value must match the actual column name in the ThoughtSpot model. If the model uses column aliases, use the base column name, not the alias. This attribute is defined as `col1`, `col2`, `col3` in the object URLs and REST API requests, as `columnName` in the `runtimeFilters` array in the Visual Embed SDK. The filter object for host events in the SDK allows `column` or `columnName`. + If there are multiple columns with the same name, you can use the `WORKSHEET_NAME::COLUMN_NAME` format; for example, `"(Sample) Retail - Apparel::city"`. -`oper` or `operator`:: +`operator`, `oper`, or `op`:: The supported operators include: + [width="80%" cols="1,2,2"] @@ -116,12 +116,12 @@ The supported operators include: | between non-inclusive | 2 -|`IN` -|is included in this list of values -|multiple -|`NOT_IN` -|is not included in this list of values -|multiple +| `IN` +| is included in this list of values +| multiple +| `NOT_IN` +| is not included in this list of values +| multiple |=== values:: @@ -174,20 +174,22 @@ Any data restrictions resulting from filter rules will be seen in the visible fi == Applying filters before and after load -* xref:runtime-filters.adoc[Runtime filters] can be applied at load via Visual Embed SDK, REST API, or URL parameters. -* Liveboard filters cannot be applied at load. However, they can be updated using `HostEvent.UpdateFilters` in the SDK. -* Search query filters can be applied at load by specifying them in the initial search query when embedding an Answer or Spotter session. For example, in Spotter embed, you can use the `searchQuery` property to set a pre-defined search (including filters) at load. -+ -When you view an Answer or visualization in *Edit* mode, the filter UI for search query filters appears above the chart or table. These filters are not shown on a Liveboard. If a Liveboard filter is applied to the same column as a search query filter, the Liveboard filter will override the search query filter values. +xref:runtime-filters.adoc[Runtime filters] can be applied at load via Visual Embed SDK, REST API, or URL parameters. + +Liveboard filters cannot be applied at load. However, they can be updated using `HostEvent.UpdateFilters` in the SDK. + +Search query filters can be applied at load by specifying them in the initial search query when embedding an Answer or Spotter session. For example, in Spotter embed, you can use the `searchQuery` property to set a pre-defined search (including filters) at load. + +When you view an Answer or visualization in *Edit* mode, the filter UI for search query filters appears above the chart or table. These filters are not shown on a Liveboard. If a Liveboard filter is applied on the same column as a search query filter, the Liveboard filter overrides the search query filter values. === Cross filters Liveboard users can apply filters across all visualizations based on the current selection using the *Filter* menu option from the contextual menu. For more information, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-filters-cross[Liveboard cross filter, window=_blank]. -If the column already has a Liveboard filter and the user applies cross filters, the cross filter replaces the values in the currently applied Liveboard filter. If there is no Liveboard filter applied to a column and the user applies a cross filter, a new filter chip with cross filter values is displayed in the header area. This filter chip is removed when the cross filter is cleared. +If the column already has a Liveboard filter and the user applies cross filters, the cross filter replaces the values in the currently applied Liveboard filter. If there is no Liveboard filter applied on a column and the user applies a cross filter, a new filter chip with cross filter values is displayed in the header area. This filter chip is removed when the cross filter is cleared. Whenever any user action affects a cross filter, a link:https://developers.thoughtspot.com/docs/Enumeration_EmbedEvent#_crossfilterchanged[EmbedEvent.CrossFilterChanged] fires, which can then be used to trigger a specific action. -== Updating filters using host events +== Updating filters using host events in Visual Embed SDK There is no programmatic way to adjust the filter values before loading the Liveboard, but there are events that can adjust the values after the Liveboard is rendered. === OpenFilter event @@ -195,12 +197,12 @@ If you have hidden the Liveboard header, you can trigger the action of opening a [source,JavaScript] ---- -LiveboardEmbed.trigger(HostEvent.OpenFilter, +liveboardEmbed.trigger(HostEvent.OpenFilter, { columnId: ''}) ---- === UpdateFilters event -The link:https://developers.thoughtspot.com/docs/Enumeration_HostEvent#_updatefilters[HostEvent.UpdateFilters] directly updates the values of the target of an existing filter that's currently applied on a Liveboard: +The link:https://developers.thoughtspot.com/docs/Enumeration_HostEvent#_updatefilters[HostEvent.UpdateFilters] directly updates the values of an existing filter currently applied on a Liveboard: [source,JavaScript] ---- @@ -248,10 +250,10 @@ liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, { }); ---- -== Updating date filters +=== Updating date filters via host events To update date filters in an embedded Liveboard, visualization, or saved answer, use `HostEvent.UpdateFilters`. -When updating filters using `HostEvent.UpdateFilters`, you must include the date filter `type` along with the time period to apply a rolling or fixed time windows. +When updating filters using `HostEvent.UpdateFilters`, you must include the date filter `type` along with the time period to apply rolling or fixed time windows. [NOTE] ==== @@ -261,12 +263,13 @@ When updating filters using `HostEvent.UpdateFilters`, you must include the date The following table lists the supported filter types and examples for each type: -[width="100%" cols="3,5,8"] +[width="100%" cols="3,8"] [options='header'] |===== -|Type| Description | Example +|Type| Description + +| `YESTERDAY` a| -| `YESTERDAY` | Specify the `type` as `YESTERDAY`. a| [source,JavaScript] ---- liveboardEmbed.trigger(HostEvent.UpdateFilters, { @@ -278,7 +281,7 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { } }); ---- -| `TODAY` | Specify the `type` as `TODAY`. a| +| `TODAY` a| [source,JavaScript] ---- liveboardEmbed.trigger(HostEvent.UpdateFilters, { @@ -290,7 +293,7 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { } }); ---- -| `TOMORROW` | Specify the `type` as `TOMORROW`. a| +| `TOMORROW` a| [source,JavaScript] ---- @@ -304,7 +307,9 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { }); ---- -|`EXACT_DATE` | Allows filtering column data to show details for the exact date, before or after the date. For example, to filter data for dates greater than `2023/07/31`, specify `2023/07/31` as value, with the filter operator as `GT`. a| [source,JavaScript] +|`EXACT_DATE` a| Allows filtering column data to show details for the exact date, before or after the date. For example, to filter data for dates greater than `2023/07/31`, specify `2023/07/31` as value, with the filter operator as `GT`. + +[source,JavaScript] ---- liveboardEmbed.trigger(HostEvent.UpdateFilters, { filter: { @@ -315,7 +320,8 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { } }); ---- -|`EXACT_DATE_RANGE` |Specify the start date and end date in the `values` array. Ensure that the start date is lower than the end date. For example, `"2023-01-31","2023-03-31"`. a| +|`EXACT_DATE_RANGE` +a|Specify the start date and end date in the `values` array. Ensure that the start date is lower than the end date. For example, `"2023-01-31","2023-03-31"`. [source,JavaScript] ---- @@ -329,9 +335,9 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { }); ---- -|`LAST_N_PERIOD` |Specify the period. You must include the `datePeriod` attribute based on the time period specified in the filter object. Valid values for `datePeriod` are `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, and `YEAR`. For example, to filter column data by last 2 weeks, set `datePeriod` to `WEEK` and `values` to `2`. +|`LAST_N_PERIOD` a|Specify the period. You must include the `datePeriod` attribute based on the time period specified in the filter object. Valid values for `datePeriod` are `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, and `YEAR`. For example, to filter column data by last 2 weeks, set `datePeriod` to `WEEK` and `values` to `2`. -a|[source,JavaScript] +[source,JavaScript] ---- liveboardEmbed.trigger(HostEvent.UpdateFilters, { filter: { @@ -345,9 +351,9 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { }); ---- -|`NEXT_N_PERIOD` | Specify the period. You must include the `datePeriod` attribute based on the time period specified in the filter object. Valid values for `datePeriod` are `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, and `YEAR`. For example, to filter column data by next 2 months, set `datePeriod` to `MONTH` and `values` to `2`. +|`NEXT_N_PERIOD` a| Specify the period. You must include the `datePeriod` attribute based on the time period specified in the filter object. Valid values for `datePeriod` are `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, and `YEAR`. For example, to filter column data by next 2 months, set `datePeriod` to `MONTH` and `values` to `2`. -a|[source,JavaScript] +[source,JavaScript] ---- liveboardEmbed.trigger(HostEvent.UpdateFilters, { filter: { @@ -361,9 +367,9 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { }); ---- -| `THIS_PERIOD` | Specify the period. You must include the `datePeriod` attribute based on the time period specified in the filter object. Valid values for `datePeriod` are `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, and `YEAR`. +| `THIS_PERIOD` a| Specify the period. You must include the `datePeriod` attribute based on the time period specified in the filter object. Valid values for `datePeriod` are `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, and `YEAR`. -a|[source,JavaScript] +[source,JavaScript] ---- liveboardEmbed.trigger(HostEvent.UpdateFilters, { filter: { @@ -376,9 +382,9 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { }); ---- -| `PERIOD_TO_DATE` |Specify the period. You must include the `datePeriod` attribute based on the time period specified in the filter object. Valid values for `datePeriod` are `WEEK`, `MONTH`, `QUARTER`, and `YEAR`. +| `PERIOD_TO_DATE` a|Specify the period. You must include the `datePeriod` attribute based on the time period specified in the filter object. Valid values for `datePeriod` are `WEEK`, `MONTH`, `QUARTER`, and `YEAR`. -a|[source,JavaScript] +[source,JavaScript] ---- liveboardEmbed.trigger(HostEvent.UpdateFilters, { filter: { @@ -390,8 +396,9 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { } }); ---- -|`YEAR_ONLY` |Specify the year. For example, 2023. -a|[source,JavaScript] +|`YEAR_ONLY` a|Specify the year. For example, 2023. + +[source,JavaScript] ---- liveboardEmbed.trigger(HostEvent.UpdateFilters, { filter: { @@ -403,8 +410,9 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { }); ---- -| `MONTH_YEAR` |Specify the month and year in the `values` array. For example, `"July","2023"`. -a|[source,JavaScript] +| `MONTH_YEAR` a|Specify the month and year in the `values` array. For example, `"July","2023"`. + +[source,JavaScript] ---- liveboardEmbed.trigger(HostEvent.UpdateFilters, { filter: { @@ -416,9 +424,9 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { }); ---- -|`QUARTER_YEAR` | Specify the quarter and year in the `values` array. For example, `"Q1","2023"`. +|`QUARTER_YEAR` a| Specify the quarter and year in the `values` array. For example, `"Q1","2023"`. -a|[source,JavaScript] +[source,JavaScript] ---- liveboardEmbed.trigger(HostEvent.UpdateFilters, { filter: { @@ -431,6 +439,433 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, { ---- |===== +[#_override_filters] +== Overriding filters during Liveboard export via REST API + +The `override_filters` parameter on the Liveboard report API +(`POST /api/rest/2.0/report/liveboard`) lets you programmatically override filters when exporting a Liveboard report. Filters specified here override any existing filters that are applied on the same columns in the Liveboard. + +The `override_filters` value is a JSON array of filter objects, with each object targeting one column. + +[source,json] +---- +"override_filters": [ + { ... }, + { ... } +] +---- + +[IMPORTANT] +==== +* The `override_filters` accepts a JSON array directly, not an object that wraps the array. +* Specifying two or more filter objects that target the same date column returns the error, `more than one filter objects are not allowed for date type column `. However, columns with other data type do not have this restriction. Multiple filter objects on the same non-date column are merged. +==== + +=== Filter object fields + +Each filter object in the JSON array has the following top-level fields: + +[cols="1,4", options="header"] +|=== +|Field| Description +|`column_name` a| Name of the column to filter. The `column_name` field accepts the display name of the column as it appears in the Liveboard's underlying data source. Matching is case-insensitive, so `"Order Date"`, `"ORDER DATE"`, and `"order date"` are all equivalent. ++ +If there are multiple columns with the same name, you can use the `WORKSHEET_NAME::COLUMN_NAME` format; for example, `"Sales Metrics::Order Date"`. + +NOTE: Column names must be used as qualifiers. Column GUIDs are not supported in the +`override_filters` object. + +|`generic_filter` | Attribute or measure filter for columns with data type other than `date` or `datetime`. The `date_filter` and `generic_filter` attributes are mutually exclusive. + +|`date_filter` a| Date filter definition for the columns with `date` or `datetime` data type. For information about the supported attributes, see xref:#_date_filter_parameters[Date filter parameters]. + +|`negate` +|__Boolean__. When `true`, inverts the filter match condition. Instead of returning rows that match the filter condition, it returns rows that do not match it. +|=== + +=== Date filter parameters +For `date_filter` objects, use the following table attributes as needed: + +[cols="1,4", options="header"] +|=== +|Field| Description +|`type` a| +__String__. Valid values for fixed date filters include: + +* `EXACT_DATE` - A specific calendar date, or an inequality relative to a date. +* `EXACT_DATE_RANGE` - A date range between two bounds (inclusive). + +`date_range.low_epoch`, `date_range.high_epoch`, `op: BW_INC` only. +* `MONTH_YEAR` - A specific month in a specific year. +* `QUARTER_YEAR` - A specific quarter in a specific year. +* `YEAR_ONLY` - An entire calendar year. + +Valid values for rolling date filters include: + + +* `YESTERDAY` - For previous calendar day. +* `TODAY` - The current calendar day. +* `TOMORROW` - The next calendar day. +* `THIS_PERIOD` - The current period (for example, this quarter). +* `NEXT_PERIOD` - The next single period (for example, next month). +* `LAST_N_PERIOD` - The last _N_ complete periods. +* `NEXT_N_PERIOD` - The next _N_ complete periods. +* `PERIOD_TO_DATE` - From the start of the current period to now (for example, month-to-date). + +The following types are not supported: + +* `EXACT_TIME` +* `EXACT_DATE_TIME` +* `NOW` +* `MONTH_ONLY` +* `WEEKDAY_ONLY` +* `QUARTER_ONLY` +* `N_PERIOD_AGO` +* `PERIOD_ONLY` + + +|`datePeriod` a| + +For rolling date filters such as `LAST_N_PERIOD`, `NEXT_N_PERIOD`, `LAST_PERIOD`, `NEXT_PERIOD`, `THIS_PERIOD`, and `PERIOD_TO_DATE`, the `datePeriod` attribute is required. The `datePeriod` specifies the period. + +Valid values for `datePeriod` include: + +* `DAY` - Calendar day +* `WEEK` - Calendar week +* `MONTH` - Calendar month +* `QUARTER` - Calendar quarter +* `YEAR` - Calendar year +* `HOUR` - Hour (`dateTime` columns only) +* `MINUTE` - Minute (`datetime` columns only) +* `SECOND` - Second (`datetime` columns only) + ++ +[NOTE] +==== +`HOUR`, `MINUTE`, and `SECOND` are valid only for columns that contain a time +component. Use them only for the columns with DATE_TIME or TIME data type. +==== + +|`include_current_period` a| +For `LAST_N_PERIOD` and `NEXT_N_PERIOD`, you can set the optional attribute `include_current_period` to include current day, week, month, quarter, year as specified in the `datePeriod` property. For example, if the current day is May 7, and you specify `LAST_N_PERIOD` with `datePeriod: MONTH` and `number: 3`, the `include_current_period: true` setting will include data for March, April, and May. + + +|`op` a| +Comparison operator. Valid values depend on `type`. + +* Use `EQ` for `YESTERDAY`, `TODAY`, `TOMORROW`, `PERIOD_TO_DATE`, `QUARTER_YEAR`, `MONTH_YEAR`, `YEAR_ONLY`. +* The `LAST_PERIOD`, `NEXT_PERIOD`, `THIS_PERIOD`, `LAST_N_PERIOD`, `NEXT_N_PERIOD` and `EXACT_DATE` filter types support `EQ`, `LE`, `LT`, `GE`, and `GT`. +* For `EXACT_DATE_RANGE`, use `BW_INC` only. + +|`number` a| +Period count. Required when `type` is `LAST_N_PERIOD` or `NEXT_N_PERIOD`. +Must be ≥ 0. + +|`epoch` a| +Required when `type` is `EXACT_DATE`. + +|`low_epoch` and `high_epoch` a| +Required for the `EXACT_DATE_RANGE` filter type. `low_epoch` must be lower than `high_epoch`. + +|`year_name` a| +Four-digit year as a string (for example, `"2024"`). Required for `YEAR_ONLY`, +`QUARTER_YEAR`, and `MONTH_YEAR`. + +|`quarter_name` a| +Quarter identifier. Required for `QUARTER_YEAR`. Valid values are `Q1`, `Q2`, `Q3`, and `Q4`. + +|`month_name` a| +Name of the month in uppercase. Required for `MONTH_YEAR`. +|=== + +=== Examples + +==== Generic filter example + +[source,JSON] +---- +"override_filters":[ + { + "column_name":"Item type", + "generic_filter":{ + "op":"EQ", + "values":[ + "Jackets", + "Bags" + ] + }, + "negate":false + }, + { + "column_name":"Region", + "generic_filter":{ + "op":"IN", + "values":[ + "west", + "midwest" + ] + }, + "negate":false + } + ] +---- + + +==== Combining date and attribute filters + +[source,json] +---- +"override_filters": [ + { + "column_name": "Order Date", + "date_filter": { + "type": "LAST_N_PERIOD", + "datePeriod": "MONTH", + "number": 3, + "op": "EQ" + } + }, + { + "column_name": "Region", + "generic_filter": { + "op": "IN", + "values": ["West", "East"] + } + } +] +---- + + +==== Negated filter example + +[source,json] +---- +"override_filters":[ + { + "column_name": "Order Date", + "negate": true, + "date_filter": { + "type": "QUARTER_YEAR", + "op": "EQ", + "quarter_name": "Q1", + "year_name": "2026" + } +}] +---- + +==== Datetime data type example + +[source,JSON] +---- +"override_filters":[ + { + "column_name":"Commit Date", + "date_filter":{ + "datePeriod":"HOUR", + "number":3, + "type":"LAST_N_PERIOD", + "op":"EQ" + } + } +] +---- + +==== Date filter examples +Refer to the following table for examples of JSON object for date filters: + +[width="100%" cols="3,8"] +[options='header'] +|===== +|Date filter type | Example + +| `YESTERDAY` a| + +[source,json] +---- +"override_filters":[ + { + "column_name":"Order Date", + "date_filter":{ + "type":"YESTERDAY", + "op":"EQ" + } + } +] +---- + +| `TODAY` a| +[source,json] +---- +"override_filters":[ + { + "column_name":"Order Date", + "date_filter":{ + "type":"TODAY", + "op":"EQ" + } + } +] +---- +| `TOMORROW` a| + +[source,json] +---- +"override_filters":[ + { + "column_name":"Order Date", + "date_filter":{ + "type":"TOMORROW", + "op":"EQ" + } + } +] +---- + +|`EXACT_DATE` +a| +[source,json] +---- +"override_filters":[ + { + "column_name": "Order Date", + "date_filter": { + "type": "EXACT_DATE", + "op": "EQ", + "epoch": 1710460800 + } +}] +---- + +|`EXACT_DATE_RANGE` +a| +[source,json] +---- +"override_filters":[ +{ + "column_name": "Order Date", + "date_filter": { + "type": "EXACT_DATE_RANGE", + "op": "BW_INC", + "date_range": { + "low_epoch": 1704067200, + "high_epoch": 1735689599 + } + } +}] +---- + +|`LAST_N_PERIOD` + +a| +[source,json] +---- +"override_filters":[ + { + "column_name": "Order Date", + "date_filter": { + "type": "LAST_N_PERIOD", + "datePeriod": "MONTH", + "number": 3, + "op": "EQ", + "include_current_period": true + } +}] +---- + +|`NEXT_N_PERIOD` + +a|[source,json] +---- +"override_filters":[ + { + "column_name": "Order Date", + "date_filter": { + "type": "NEXT_N_PERIOD", + "datePeriod": "MONTH", + "number": 3, + "op": "EQ", + "include_current_period": true + } +}] +---- + +| `THIS_PERIOD` + +a| +[source,json] +---- +"override_filters":[ + { + "column_name": "Order Date", + "date_filter": { + "type": "THIS_PERIOD", + "datePeriod": "QUARTER", + "op": "EQ" + } +}] +---- + +| `PERIOD_TO_DATE` +a| [source,json] +---- +"override_filters":[ + { + "column_name": "Order Date", + "date_filter": { + "type": "PERIOD_TO_DATE", + "datePeriod": "MONTH", + "op": "EQ" + } +}] +---- + +|`YEAR_ONLY` +a|[source,json] +---- +"override_filters":[ +{ + "column_name": "Order Date", + "date_filter": { + "type": "YEAR_ONLY", + "op": "EQ", + "year_name": "2024" + } +}] +---- + +| `MONTH_YEAR` a| +[source,json] +---- +"override_filters":[ +{ + "column_name": "Order Date", + "date_filter": { + "type": "MONTH_YEAR", + "op": "EQ", + "month_name": "MARCH", + "year_name": "2026" + } +}] +---- + +| `QUARTER_YEAR` + +a| +[source,json] +---- +"override_filters":[ +{ + "column_name": "Order Date", + "date_filter": { + "type": "QUARTER_YEAR", + "op": "EQ", + "quarter_name": "Q1", + "year_name": "2024" + } +}] +---- +|| +|===== + + == Updating runtime filters For information about runtime filters update, see xref:runtime-filters.adoc#_adjust_runtime_filters_using_sdk_events[Runtime filters documentation]. @@ -454,18 +889,35 @@ liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [{ ---- liveboardEmbed.trigger(HostEvent.UpdateFilters, { filters: [{ - column: "state", // columnName is also a valid parameter. + column: "state", oper: "EQ", values: [] // set an empty array to clear filters }] }); ---- -Setting empty values via `HostEvent.UpdateFilters` removes only the filter values; it does not remove or hide the filter chips from the Liveboard. +[NOTE] +==== +* Setting empty values via `HostEvent.UpdateFilters` removes only the filter values; it does not remove or hide the filter chips from the Liveboard. +* Clearing date filters by passing an empty values array is not supported. +==== + +== Additional resources + +Refer to the following documentation for more information: + +* xref:runtime-filters.adoc[Runtime filters] +* xref:events-hostEvents.adoc[HostEvents in Visual Embed SDK] + +== Additional resources + +Refer to the following documentation for more information: +* xref:runtime-filters.adoc[Runtime filters] +* xref:events-hostEvents.adoc[HostEvents in Visual Embed SDK] //// === Events There is no specific event to update `search_query filters` in the `SearchEmbed` component or the Liveboard edit mode. -You can set your app to listen to link:https://developers.thoughtspot.com/docs/Enumeration_EmbedEvent#_querychanged[EmbedEvent.QueryChanged] and trigger the link:https://developers.thoughtspot.com/docs/Enumeration_HostEvent#_gettml[HostEvent.GetTML] event to get a new TML generated for the `search_query` string after an update. +You can set your app to listen to link:https://developers.thoughtspot.com/docs/Enumeration_EmbedEvent#_querychanged[EmbedEvent.QueryChanged] and trigger the link:https://developers.thoughtspot.com/docs/Enumeration_HostEvent#_gettml[HostEvent.GetTML] event to get a new TML generated for the `search_query` string after an update. \ No newline at end of file diff --git a/modules/ROOT/pages/full-app-customize.adoc b/modules/ROOT/pages/full-app-customize.adoc index 07366a97a..44d9e2530 100644 --- a/modules/ROOT/pages/full-app-customize.adoc +++ b/modules/ROOT/pages/full-app-customize.adoc @@ -8,11 +8,10 @@ The Visual Embed SDK provides several controls to customize the embedded view, including setting the default landing page, navigation style, visibility of modules and menu items, and more. -[div announcementBlock] --- [IMPORTANT] +==== The classic (V1) experience and V2 experience modes will be deprecated in an upcoming release in 2026. Therefore, ThoughtSpot recommends upgrading the UI experience of your full application embedding to the V3 experience. --- +==== == UI experience modes ThoughtSpot application supports the following UI experience modes: diff --git a/modules/ROOT/pages/home.adoc b/modules/ROOT/pages/home.adoc index 82813c543..6e1d31b51 100644 --- a/modules/ROOT/pages/home.adoc +++ b/modules/ROOT/pages/home.adoc @@ -10,9 +10,10 @@

ThoughtSpot Embedded Documentation

-

Learn how to use developer tools, APIs, and SDK to embed ThoughtSpot content in your app!

+

Learn how to use developer tools, APIs, and SDKs to embed ThoughtSpot content in your app.

+

AI analytics with Spotter | Search | Try it out

@@ -39,40 +42,42 @@
-
Embed charts and tables
-

Embed ThoughtSpot visualizations in your application to empower your users with insights that are easy to read and modify.

+
Liveboards and charts
+

Embed a visualization or a Liveboard with multiple visualizations and insights that your users can explore, analyze, and act on.

-
-
-
Embed Liveboards
-

Embed Liveboards with visualizations and insights that your users can view, explore, analyze, and act on.

-
-
+
+ + ++++ - - ++++
-
Embed ThoughtSpot app
-

Embed the full ThoughtSpot experience in your application, including search, charts and tables, automated insights, and Liveboards.

+
Embed ThoughtSpot in a mobile app
+

Embed ThoughtSpot in your mobile app to deliver interactive analytics and search-driven insights.

@@ -80,7 +85,7 @@
Customize embedded view
-

Show or hide menu actions, trigger and handle events, add custom buttons, and trigger callback to your host app.

+

Show or hide menu actions, manage app interactions, add custom buttons and callback actions.

@@ -93,19 +98,68 @@
Customize UI
-

Apply custom styles and themes to the embedded ThoughtSpot UI elements to match the look and feel of your app.

+

Apply custom styles and themes to the embedded ThoughtSpot UI elements.

+
+++++ + + + +[.non-link] +++++ +
+
Integrate tools and workflows
+
+
+
+
REST APIs
+

Use REST APIs to programmatically integrate with and manage ThoughtSpot content, including handling request and response workflows.

+
+
+
+
+
+
SpotterCode in IDEs
+

Integrate SpotterCode in your IDE to accelerate embedding application development and generate deployment-ready code.

+
+
+
+
+
+
MCP Server
+

Integrate ThoughtSpot analytics into any AI-native application and custom chatbot using ThoughtSpot MCP Server.

+
+

+ Learn more +

+
+
+ + +
+
++++ + + +//// ++++
@@ -145,5 +199,6 @@
++++ +//// diff --git a/modules/ROOT/pages/mcp-server-changelog.adoc b/modules/ROOT/pages/mcp-server-changelog.adoc index 78186247f..ce53f8fe9 100644 --- a/modules/ROOT/pages/mcp-server-changelog.adoc +++ b/modules/ROOT/pages/mcp-server-changelog.adoc @@ -40,7 +40,7 @@ a| [discrete] ==== Support for Spotter 3 -ThoughtSpot MCP Server now supports Spotter 3, enabling advanced analytics, forecasting, multi-step reasoning, and deep research. The new MCP tools support real-time streaming, session-based conversations, and richer interactions. + +ThoughtSpot MCP Server now supports Spotter 3, enabling advanced analytics, forecasting, multi-step reasoning, and deep research. The new MCP tools support real-time streaming, session-based conversations, richer interactions, and direct embedding of visualizations in MCP-aware apps. + For more information, see xref:mcp-server-spotter3.adoc[MCP Server with Spotter 3]. --- @@ -51,8 +51,8 @@ MCP Server URLs now support date-based versioning, defined using the `?api-versi [NOTE] ==== -* If the API version is set to a specific date, the server returns the latest version released on or before that date. -* If your integration has custom workflows that rely on MCP tools, pin it to a tested version using the `?api-version={YYYY-MM-DD}` parameter. +* The MCP Server URLs without the API version always point to the latest version and may introduce new tools. Pin your integration to a tested version using the `?api-version={YYYY-MM-DD}` parameter. For example, `?api-version=2026-05-01`. +* If the API version is set to a future date, the server returns the latest API version released before the date specified in the URL. ==== --- @@ -74,7 +74,7 @@ To update your integration to use Spotter 3 features and the new MCP tools: == April 2026 *API version string:* `?api-version=2026-04-30` or an earlier date string + -*Upgrade notes*: Supports the legacy MCP tools and URLs only. Upgrade your integrations to version 2026-04-30 or later. +*Upgrade recommendation*: Supports the legacy MCP tools and URLs only. Upgrade your integrations to version 2026-04-30 or later. [.cl-table, cols="1,4", frame=none, grid=none] |==== diff --git a/modules/ROOT/pages/mcp-tool-reference-guide.adoc b/modules/ROOT/pages/mcp-tool-reference-guide.adoc index 90f34f4f4..c9fb5b1dc 100644 --- a/modules/ROOT/pages/mcp-tool-reference-guide.adoc +++ b/modules/ROOT/pages/mcp-tool-reference-guide.adoc @@ -16,6 +16,3 @@ ThoughtSpot MCP Server provides specialized tools that enable the AI agent in yo * To view the MCP Server code, see the link:https://github.com/thoughtspot/mcp-server[MCP Server GitHub repository, window=_blank]. * For a chat client example, see link:https://github.com/thoughtspot/developer-examples/tree/main/mcp/python-react-agent-simple-ui[Python Agent with Simple React UI]. * See xref:mcp-connect-custom-chatbot.adoc[Integrating MCP Server in a custom application or chatbot] - - - diff --git a/modules/ROOT/pages/mcp-tool-reference-spotter3.adoc b/modules/ROOT/pages/mcp-tool-reference-spotter3.adoc index 976af140e..997c9905b 100644 --- a/modules/ROOT/pages/mcp-tool-reference-spotter3.adoc +++ b/modules/ROOT/pages/mcp-tool-reference-spotter3.adoc @@ -18,6 +18,8 @@ The `data_source_id` is optional. Provide this when the user has specified or co === Example call +[div tabbed-code] +-- [source,javascript] ---- const session = await callMCPTool("create_analysis_session", { @@ -34,6 +36,7 @@ call_mcp_tool( }, ) ---- +-- === Response @@ -65,6 +68,8 @@ __Optional__|Can be used to provide external information relating to the questio === Example call +[div tabbed-code] +-- [source,javascript] ---- const sendMessage = await callMCPTool("send_session_message", { @@ -89,6 +94,7 @@ call_mcp_tool( }, ) ---- +-- === Response @@ -119,6 +125,8 @@ Send the `analytical_session_id` to specify the session to retrieve updates for. === Example call +[div tabbed-code] +-- [source,typescript] ---- const updates = await callMCPTool("get_session_updates", { @@ -133,6 +141,7 @@ call_mcp_tool( {"analytical_session_id": "sess_abc123"}, # Session ID from create_analysis_session. ) ---- +-- === Response @@ -236,6 +245,8 @@ Create a ThoughtSpot dashboard from answers generated in an analysis session. === Example call +[div tabbed-code] +-- [source,typescript] ---- const dashboard = await callMCPTool("create_dashboard", { @@ -281,6 +292,7 @@ dashboard = call_mcp_tool( }, ) ---- +-- === Response diff --git a/modules/ROOT/pages/rest-apiv2-changelog.adoc b/modules/ROOT/pages/rest-apiv2-changelog.adoc index 77512158a..720af01df 100644 --- a/modules/ROOT/pages/rest-apiv2-changelog.adoc +++ b/modules/ROOT/pages/rest-apiv2-changelog.adoc @@ -8,6 +8,71 @@ This changelog lists the features and enhancements introduced in REST API v2.0. For information about new features and enhancements available for embedded analytics, see xref:whats-new.adoc[What's New]. +== Version 26.5.0.cl, May 2026 + +=== Sync connection metadata attributes +You can now synchronize connection metadata attributes from your Cloud Data Warehouse (CDW) with ThoughtSpot by sending a request to `POST /api/rest/2.0/connections/{connection_identifier}/resync-metadata` API endpoint. + +=== Spotter APIs + +==== New API endpoints + +The following new endpoints allow sending messages to an active conversation +session with a Spotter agent. + +* `POST /api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send` + +Allows sending a message to an active Spotter AI conversation and returns a synchronous response. +* `POST /api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send/stream` + +Allows sending to an active Spotter AI conversation and returns the response as a real-time Server-Sent Events (SSE) stream. + +These new endpoints replace the legacy agent conversation and SSE streaming APIs. + +==== Deprecated endpoints [.version-badge.deprecated]#Deprecated# + +* `POST /api/rest/2.0/ai/agent/{conversation_identifier}/converse` + +Replaced by `POST /api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send`. + +* `POST /api/rest/2.0/ai/agent/converse/sse` + +Replaced by `POST /api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send/stream` + +These endpoints are deprecated and will be removed +in a future release. Embedding applications and integrations using these APIs are advised to migrate to the new API endpoints for improved experience. + +==== Enhancements to conversation creation API [.version-badge.breaking]#Breaking# + +The following enhancements have been introduced for the conversation creation operation workflow with the `POST /api/rest/2.0/ai/agent/conversation/create` API endpoint: + +metadata_context:: +To define the conversation context, the API request must include the `metadata_context` parameter with one of the following values: + +* `AUTO_MODE`: Automatically discovers and selects the most relevant datasets for the user's queries. +* `DATA_SOURCE`: Sets the target context as the data source. You must specify at least one data source ID. +** To set a single data source object metadata context, specify a `data_source_identifier`. +** For multi-data source context, specify the `data_source_identifiers`. ++ +[IMPORTANT] +==== +The `data_source` and `guid` attributes are deprecated in the 26.5.0.cl release version. Integrations using these parameters in ThoughtSpot versions 26.2.0.cl through 26.4.0.cl will continue to work until further notice. However, ThoughtSpot recommends using either `AUTO_MODE` or `DATA_SOURCE` with `data_source_identifier` or `data_source_identifiers` for the metadata context. +==== + +Other context options:: +The `answer_context` and `liveboard_context` are removed and no longer supported. Any existing integration or embedding application passing `answer_context` or `liveboard_context` in the request body must update their workflows to use the `AUTO_MODE` or `DATA_SOURCE` option. + +Enable save chat:: +The `enable_save_chat` parameter, when set to `true`, saves the conversation. + +API response:: +The API response now returns the `conversation_identifier`, which is used in all +subsequent send message or SSE streaming calls. + +=== Liveboard report API enhancements [beta betaBackground]^Beta^ +The `POST /api/rest/2.0/report/liveboard` API endpoint enhances the pdf downloads by introducing the following parameters: + +* `"page_size": "CONTINUOUS"` for a seamless PDF export that matches the full length of your Liveboard. Unlike the A4 format, which introduces forced page breaks between visualizations, this continuous flow maintains your exact design and intended layout. +* `zoom_level` offers various download size options to suit the viewer's screen dimensions, thereby enhancing legibility. This can be set only when `page_size` is specified as `CONTINUOUS`. + +For more information, see xref:data-report-v2-api.adoc#_liveboard_report_api[Liveboard Report API documentation]. + == Version 26.4.0.cl, April 2026 === Variable API endpoints @@ -390,7 +455,7 @@ For more information, see xref:rest-api-java-sdk.adoc#_import_the_sdk_to_your_ap == Version 10.10.0.cl, July 2025 -=== Email template customization APIs: +=== Email template customization APIs This release introduces the following new endpoints for email template customization: * `POST /api/rest/2.0/customization/email` + diff --git a/modules/ROOT/pages/spotter-agent-apis.adoc b/modules/ROOT/pages/spotter-agent-apis.adoc new file mode 100644 index 000000000..3eb4a5680 --- /dev/null +++ b/modules/ROOT/pages/spotter-agent-apis.adoc @@ -0,0 +1,1245 @@ += AI APIs (Spotter Agent and Spotter 3) +:toc: true +:toclevels: 2 + +:page-title: Spotter Agent APIs +:page-pageid: spotter-agent-apis +:page-description: You can use Spotter REST APIs to receive Answers for your analytical queries sent through the conversational experience with ThoughtSpot. + +ThoughtSpot's Spotter Agent APIs allow users to start a conversation session with Spotter Agent and send queries to explore data and receive responses synchronously or as a real-time Server-Sent Events (SSE) stream. + +== Overview +Spotter Agent APIs support conversation sessions with natural language query strings, provide context-aware and guided data analysis, and allow integration with other agentic systems. + +The key capabilities of the Spotter APIs include the following: + +* Initiating and managing conversational sessions +* Processing natural-language queries +* Generating analytical responses, insights, and visualizations +* Recommending relevant datasets or data sources +* Decomposing complex user queries + +== API endpoints + +The AI REST API endpoints listed in the following table provide all the functionality necessary to implement a Spotter 3 conversational experience in your application, from data source discovery through to streaming query responses. +The API endpoints introduced for Spotter 2 also support Spotter 3 capabilities as of version 26.2.0.cl. Some of these API endpoints are deprecated in 26.5.0.cl; ThoughtSpot recommends using the new API endpoints instead. + +Initialize session:: +Call the create agent conversation API (`/api/rest/2.0/ai/agent/conversation/create`) with a data source ID to establish the session context. When auto mode is enabled, and no data source ID is specified in the API request, Spotter will automatically identify the appropriate data source. + +Execute queries:: +To execute queries and generate a standard response synchronously, use the Send agent conversation message API (`/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send`). The send agent message API (`/api/rest/2.0/ai/agent/{conversation_identifier}/converse`) is deprecated in 26.5.0.cl and later versions. + +Real-time output (streaming):: +To stream responses to the application UI in real-time, use the `POST /api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send/stream`. The legacy streaming API (`/api/rest/2.0/ai/agent/converse/sse`) is deprecated in 26.5.0.cl and later versions. + +=== Supported API endpoints + +[width="100%" cols="1"] +|===== +a|`POST /api/rest/2.0/ai/agent/conversation/create` + +xref:spotter-agent-apis.adoc#_create_a_conversation_session_with_spotter_agent[Creates a conversation session with the Spotter agent] to generate Answers for the specified data context. +__Available on ThoughtSpot Cloud instances from 10.13.0.cl onwards. Breaking changes introduced in 26.5.0.cl.__ + +a| `POST /api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send` [.version-badge.new]#New# + +xref:spotter-agent-apis.adoc#_send_queries_to_a_conversation_session[Sends natural language messages] to an existing Spotter agent conversation and returns the complete response synchronously. +__Replaces /api/rest/2.0/ai/agent/{conversation_identifier}/converse__. + +a|`POST /api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send/stream` [.version-badge.new]#New# + +xref:spotter-agent-apis.adoc#_send_a_query_to_agent_and_get_streaming_responses[Sends one or more natural language messages] to an existing Spotter agent conversation and returns the response as a real-time Server-Sent Events (SSE) stream. +__Replaces /api/rest/2.0/ai/agent/{conversation_identifier}/converse__. + +a| `POST /api/rest/2.0/ai/data-source-suggestions` [beta betaBackground]^Beta^ + +xref:spotter-agent-apis.adoc#_get_data_source_suggestions[Returns a list of relevant data sources], such as Models, based on a query and thus helping users and agents choose the most appropriate data source for analytics. + +__Available on ThoughtSpot Cloud instances from 10.15.0.cl onwards__. + +a| `POST /api/rest/2.0/ai/relevant-questions/` [beta betaBackground]^Beta^ + +xref:spotter-agent-apis.adoc#_get_relevant_questions[Decomposes a user query] into relevant sub-questions. Guides users to explore data more deeply for a comprehensive analysis. + +__Available on ThoughtSpot Cloud instances from 10.13.0.cl onwards__. + +a| `POST /api/rest/2.0/ai/agent/converse/sse` [.version-badge.deprecated]#Deprecated# + +Legacy API endpoint for streaming responses, including tokens and visualizations, for a specific conversation context. +__Deprecated in 26.5.0.cl__. + +a| `POST /api/rest/2.0/ai/agent/{conversation_identifier}/converse` [.version-badge.deprecated]#Deprecated# + +Legacy API endpoint to send natural language queries to a conversation session with Spotter agent. + +__Deprecated in 26.5.0.cl__. +|===== + +== Create a conversation session with Spotter Agent + +The `/api/rest/2.0/ai/agent/conversation/create` API endpoint creates a new conversation session with Spotter Agent for a specific or multi-data context and returns a conversation ID. + +=== Request parameters +The request body must include the `metadata_context`. REST API clients must have at least view access to the data source objects specified in the API request to create a conversation session and use it for subsequent queries. + +[width="100%" cols="2,4"] +[options='header'] +|===== +|Form parameter| Description +|`metadata_context` a| Defines the data context for the conversation. + +* `type` + +Metadata context type. The context type is mandatory. Select one of the following values: + +** `AUTO_MODE` to allow Spotter Agent to automatically discover and select the most relevant datasets for user's queries. +** `DATA_SOURCE` to set a specific data source as the data context. You must specify `data_source_context` and data source IDs. + +To set a specific data source object, use `data_source_identifier`. + +To set multi-data context, use `data_source_identifiers`. +** `data_source` [.version-badge.deprecated]#Deprecated# + +This option is deprecated in 26.5.0.cl. ThoughtSpot recommends using the `DATA_SOURCE` with `data_source_context` and data source IDs instead. + +|`conversation_settings` a|__Optional__. Defines additional parameters for the conversation context. You can set any of the following attributes as needed: + +* `enable_contextual_change_analysis` + +__Boolean__. When enabled, Spotter analyzes how context changes over time, that is, comparing results from different queries. Enabled by default in 26.2.0.cl and later versions. +* `enable_natural_language_answer_generation` + +__Boolean__. Allows sending natural language queries to the conversation session. Enabled by default in 26.2.0.cl and later versions. +* `enable_reasoning` + +__Boolean__. Allows Spotter to use reasoning for deep analysis and precise responses. Enabled by default in 26.2.0.cl and later versions. +* `enable_save_chat` + +When set to `true`, adds the conversation to chat history. +|===== + +=== Example request + +With AUTO_MODE for metadata context:: + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/agent/conversation/create' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "metadata_context": { + "type": "AUTO_MODE" + }, + "conversation_settings": { + "enable_save_chat": true + } +}' +---- + +For a single data source as the data context:: + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/agent/conversation/create' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "metadata_context": { + "type": "DATA_SOURCE", + "data_source_context": { + "data_source_identifier": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" + } + }, + "conversation_settings": {} +}' +---- + +For multi-data source context:: + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/agent/conversation/create' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "metadata_context": { + "type": "DATA_SOURCE", + "data_source_context": { + "data_source_identifiers": [ + "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "b2c3d4e5-f6a7-8901-bcde-f12345678901" + ] + } + }, + "conversation_settings": { + "enable_save_chat": true + } +}' +---- + +=== API response + +If the API request is successful, the API returns the conversation ID and identifier in the response body. + +[source,JSON] +---- +{ + "conversation_id": "wwHQ5j8O8dQC", + "conversation_identifier": "wwHQ5j8O8dQC" +} +---- + +* `conversation_identifier` + +Use this for all subsequent message calls. +* `conversation_id` [.version-badge.deprecated]#Deprecated# + +Returns the same value as `conversation_identifier`. + +== Send queries to a conversation session + +To send queries to an ongoing conversation session with the Spotter agent and receive a response synchronously, use the `/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send` API endpoint. + +This API operation requires the conversation ID obtained from the conversation creation API endpoint (`/api/rest/2.0/ai/agent/conversation/create`). The user making the API request must have access to the conversation session. The API request body must include at least one message in natural language format. + +=== Request parameters + +[width="100%" cols="2,2,4"] +[options='header'] +|===== +|Parameter|Type| Description +|`conversation_identifier`|Path parameter|__String__. Required. Specify the conversation ID received from the xref:spotter-agent-apis.adoc#_create_a_conversation_session_with_spotter_agent[POST /api/rest/2.0/ai/agent/conversation/create] API call. +|`messages`|Form parameter|_Array of strings_. Required. Specify at least one query in natural language. For example, `total sales of jackets last month`. +|===== + + +//// +|`settings` |__Optional__. Defines additional parameters for the conversation context. You can set any of the following attributes as needed: + +* `enable_contextual_change_analysis` + +__Boolean__. When enabled, Spotter analyzes how the context changes over time, that is comparing results from different queries. +* `enable_natural_language_answer_generation` + +__Boolean__. Allows sending natural language queries to the conversation session. +* `enable_reasoning` + +__Boolean__. Allows Spotter to use reasoning for deep analysis and precise responses. +//// + +=== Request and response examples + +The following example sends a data comparison query to a conversation session. The conversation ID is specified in the request URL as a path parameter. + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "messages": [ + "Sales in 2025 vs 2024" + ] +}' +---- + +If the request is successful, the API returns an array of objects in the response. The messages in the API response include the following parts: + +[source,JSON] +---- +[ + { + "type": "text", + "text": "\n\nI'll compare sales between 2025 and 2024. First, let me get the dataset context.", + "metadata": {}, + "internal": {}, + "agent_context": "" + }, + { + "type": "text", + "text": "```json\n{\"dataset_name\":\"(Sample) Retail - Apparel\",\"columns\":[{\"name\":\"sales\",\"type\":\"MEASURE\"},{\"name\":\"date\",\"type\":\"ATTRIBUTE\"}]}\n```", + "metadata": {}, + "internal": {}, + "agent_context": "" + }, + { + "type": "answer", + "title": "Compare total sales for 2025 vs 2024", + "description": "", + "session_id": "842bb67a-e08e-4861-97e8-8db9538db51d", + "gen_no": 2, + "sage_query": "[sales] [date] = '2025' vs [date] = '2024'", + "tml_tokens": ["[sales]", "[date] = '2025' vs [date] = '2024'"], + "formulas": [], + "parameters": [], + "subqueries": [], + "viz_suggestion": "CAEQIBomEiQ2NjE5NzI0Yy1kMjVlLTU4MDItOWNjOC1jNDA3MWY3OWY5MzAoATIA", + "metadata": { + "output": "", + "worksheet_id": "cd252e5c-b552-49a8-821d-3eadaa049cca", + "chart_type": "KPI", + "interrupted": false, + "data_awareness_enabled": true + }, + "internal": {} + }, + { + "type": "text", + "text": "\n\nThe visualization shows year-over-year comparison. You can identify growth or decline trends.", + "metadata": {}, + "internal": {}, + "agent_context": "" + } +] +---- + +The following example sends a follow-up question to the same conversation session. + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "messages": [ + "Now break that down by product category" + ] +}' +---- + +If the request is successful, the agent returns the response for the follow-up question: + +[source,JSON] +---- +[{ + "type": "text", + "text": "I'll add product category to the comparison.", + "metadata": {}, + "internal": {}, + "agent_context": "" + }, + { + "type": "answer", + "title": "Sales by Product Category: 2025 vs 2024", + "session_id": "9abc1234-0000-0000-0000-000000000005", + "gen_no": 3, + "sage_query": "[sales] [product category] [date] = '2025' vs [date] = '2024'", + "tml_tokens": ["[sales]", "[product category]", "[date] = '2025' vs [date] = '2024'"], + "formulas": [], + "parameters": [], + "subqueries": [], + "viz_suggestion": "", + "metadata": { + "chart_type": "BAR", + "worksheet_id": "cd252e5c-b552-49a8-821d-3eadaa049cca" + }, + "internal": {} + }] +---- + +In each response, the agent returns the following information: + +* `type` + +Type of the message, such as text, answer, or error. +* `text` + +Response message generated for the query. +* `metadata` + +Additional information based on the message type. For example, answer metadata, chart type, or the data source ID. +* `tml_tokens` + +Query string broken down as TML tokens. + +In case of errors, the response returns the error details: + +[source,JSON] +---- +[{ + "type": "error", + "message": "The conversation session has expired. Please create a new conversation.", + "code": "SESSION_EXPIRED" +}] +---- + + + +//// +The following example shows the response text contents for the `answer` message type. + +[source,JSON] +---- +[ + { + "id": "r24X7D99SROD", + "type": "answer", + "group_id": "o8dQ9SAWdtrL", + "metadata": { + "sage_query": "[sales] [item type] = [item type].'jackets'", + "session_id": "b321b404-cbf1-4905-9b0c-b93ad4eedf89", + "gen_no": 1, + "transaction_id": "6874259d-13b1-478c-83cb-b3ed52628850", + "generation_number": 1, + "warning_details": null, + "ambiguous_phrases": null, + "query_intent": null, + "assumptions": "You want to see the total sales amount for jackets item type.", + "tml_phrases": [ + "[sales]", + "[item type] = [item type].'jackets'" + ], + "cached": false, + "sub_queries": null, + "title": "Net sales of Jackets", + "worksheet_id": "cd252e5c-b552-49a8-821d-3eadaa049cca" + }, + "title": "Net sales of Jackets" + } +] +---- + +The session ID and generation number serve as the data context for the Answer. You can use this information to create a new conversation session using `/api/rest/2.0/ai/agent/conversation/create`, or download the answer via the `/api/rest/2.0/report/answer` API endpoint. + + +* The tokens and TML phrases returned in the response can be used as inputs for the search data API call to get an Answer. +//// + +== Send a query to agent and get streaming responses + +To send queries to an ongoing conversation session with Spotter agent and receive streaming responses, use the `/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send/stream` API endpoint. This API endpoint uses the SSE protocol to deliver data incrementally in real time, rather than waiting for the entire response to be generated before sending it to the client. + +The `/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send/stream` API can be used as an integrated tool for real-time streaming of conversational interactions between agents and the ThoughtSpot backend. + +=== Request parameters + +[width="100%" cols="2,4"] +[options='header'] +|===== +|Parameter| Description +|`conversation_identifier` |__String__. Specify the conversation ID received from the xref:spotter-agent-apis.adoc#_create_a_conversation_session_with_spotter_agent[POST /api/rest/2.0/ai/agent/conversation/create] API call. +|`messages`|_Array of strings_. Include at least one natural language query. For example, `Sales data for Jackets`, `Top performing products in the west coast`. +|===== + +=== Example request + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send/stream' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "conversation_identifier": "h2I_pTGaRQof", + "messages": [ + "Net sales of Jackets" + ] +}' +---- + +=== API response + +If the API request is successful, the response includes a stream of events, each containing a partial or complete message from the AI agent, rather than a single JSON object. + +Each event is a simple text-based message in a specific format, `data: \n\n`; `\n\n` means that each message sent from the server to the client is prefixed with the `data:` keyword, followed by the actual payload (``), and ends with two newline characters (`\n\n`). + +The API uses this format so that the clients can reconstruct the AI-generated response as it streams in, chunk by chunk, and show the responses in real-time. In agentic workflows, the receiving client or agent listens to the SSE stream, parses each event, and assembles the full response for its users. + +==== Example response +If the request is valid, the API returns SSE streams. Each line has the form `data: [{"type": "...", ...}]`, a JSON array of event objects. + +[source,JSON] +---- +data: [{"type":"ack","node_id":"aGxzcFVrtom8"}] + +data: [{"type":"conv_title","title":"Sales 2025 vs 2024","conv_id":"-XIi04l5rrof"}] + +data: [{"type":"notification","group_id":"cDEsAQbSnd3J","metadata":{"type":"thinking","tool_title":"Analyzing Sales Performance: 2025 vs 2024"},"code":"TOOL_CALL_NOTIFICATION"}] + +data: [{"id":"mNAdvy-NK2l6","type":"text-chunk","group_id":"cDEsAQbSnd3J","metadata":{"format":"markdown","type":"thinking"},"content":"\n\nI need to compare sales performance between 2025 and 2024."}] + +data: [{"type":"notification","group_id":"m1MTvttEUa7o","code":"nls_start"}] + +data: [{"id":"hxWMDP-pgR3B","type":"answer","group_id":"m1MTvttEUa7o","metadata":{"sage_query":"[sales] [date] = '2025' vs [date] = '2024'","session_id":"431adcf9-1328-4d8c-81a1-0faa7fa37ba6","title":"Compare sales for 2025 vs 2024"},"title":"Compare sales for 2025 vs 2024"}] + +data: [{"type":"notification","code":"FINAL_RESPONSE_NOTIFICATION"}] +---- +For the complete response in one payload, use `sendAgentConversationMessage` instead. + +//// +[source,] +---- +data: [{"type": "ack", "node_id": "BRxCtJ-aGt8l"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": "I"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " understand"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " you're"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " interested"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " in"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " the"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " net"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " sales"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " of"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " Jackets"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": "."}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " I'll"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " retrieve"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " the"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " relevant"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " data"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " for"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " you"}] + +data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": "."}] + +data: [{"type": "notification", "group_id": "o8dQ9SAWdtrL", "metadata": {"title": "Net sales of Jackets"}, "code": "nls_start"}] + +data: [{"type": "notification", "group_id": "o8dQ9SAWdtrL", "code": "QH", "message": "Fetching Worksheet Data"}] + +data: [{"type": "notification", "group_id": "o8dQ9SAWdtrL", "code": "TML_GEN", "message": "Translating your query with the Reasoning Engine"}] + +data: [{"type": "notification", "group_id": "o8dQ9SAWdtrL", "code": "ANSWER_GEN", "message": "Verifying results with the Trust Layer"}] + +data: [{"id": "r24X7D99SROD", "type": "answer", "group_id": "o8dQ9SAWdtrL", "metadata": {"sage_query": "[sales] [item type] = [item type].'jackets'", "session_id": "b321b404-cbf1-4905-9b0c-b93ad4eedf89", "gen_no": 1, "transaction_id": "6874259d-13b1-478c-83cb-b3ed52628850", "generation_number": 1, "warning_details": null, "ambiguous_phrases": null, "query_intent": null, "assumptions": "You want to see the total sales amount for jackets item type.", "tml_phrases": ["[sales]", "[item type] = [item type].'jackets'"], "cached": false, "sub_queries": null, "title": "Net sales of Jackets", "worksheet_id": "cd252e5c-b552-49a8-821d-3eadaa049cca"}, "title": "Net sales of Jackets"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "The"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " net"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " sales"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " for"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " Jackets"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " have"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " been"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " visual"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "ized"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " for"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " you"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "."}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " This"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " analysis"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " specifically"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " filtered"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " for"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " the"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " item"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " type"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "jackets"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "\""}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " and"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " calculated"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " the"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " total"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " sales"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " amount"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " associated"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " with"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " those"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " products"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ".\n\n"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "**"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "Summary"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " &"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " Insights"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ":"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "**\n"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "-"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " The"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " visualization"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " shows"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " the"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " total"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " net"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " sales"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " for"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " all"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " jacket"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " transactions"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " in"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " your"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " apparel"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " dataset"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ".\n"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "-"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " The"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " calculation"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " uses"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " only"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " sales"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " amounts"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " where"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " the"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " item"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " type"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " is"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " \""}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "J"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "ackets"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ".\"\n"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "-"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " This"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " information"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " is"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " useful"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " for"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " understanding"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " the"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " revenue"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " contribution"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " of"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " jackets"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " within"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " your"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " product"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " mix"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ".\n\n"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "If"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " you'd"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " like"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " to"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " see"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " a"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " breakdown"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " by"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " region"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ","}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " state"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ","}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " time"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " period"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ","}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " or"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " compare"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " jacket"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " sales"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " to"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " other"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " product"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " types"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ","}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " please"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " let"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " me"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " know"}] + +data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "!"}] +---- +//// + +==== SSE event types +The SSE event types streamed in the API response include: + +* `ack` + +Confirms receipt of the request. For example, the type in the first message `data: [{"type": "ack", "node_id": "BRxCtJ-aGt8l"}]`, which indicates that the server has received the client's request and is acknowledging it. +* `conv_title` + +A conversation title (`title`, `conv_id`). +* `notification` + +Progress or status update (`group_id`, `metadata`, `code`). For example, `TOOL_CALL_NOTIFICATION`, `nls_start`, `FINAL_RESPONSE_NOTIFICATION`. +* `type` + +Type can be `thinking`, `text` +* `text` + +Complete text block in markdown format. +* `text-chunk` + +Text fragments in incremental streaming, often in markdown (`id`, `group_id`, `metadata` with `format`) +* `content` + +The actual text content sent incrementally. For example, `"I"`, `"understand"`, `"you're"`, `"interested"`, `"in"`, `"the"`, `"net"`, `"sales"`, and so on. +* `text` + +Full text block with same structure as text-chunk. +* `answer` + +Structured answer with metadata (`id`, `group_id`, `metadata` with `sage_query`, `session_id`, `title` and more) +* `error` + +In case of failures. +* `*-interrupt` + +If the generation was stopped mid-stream. +* `group_id` + +Groups related chunks together. + +For more information and examples, see xref:spotter-agent-apis.adoc#_sse_event_payload_reference[SSE event payload reference]. + +=== Thinking versus output events +Spotter responses have two phases: + +* A *thinking phase*, where the AI reasons through the query and calls internal tools, followed by an *output phase* containing the final response delivered to the user. + + +Events in the thinking phase carry `"metadata": { "type": "thinking" }`. All other events are final output. + +Every event includes a `group_id`. Events sharing the same `group_id` belong together. During the thinking phase, each tool call gets its own `group_id`. A `FINAL_RESPONSE_NOTIFICATION` notification marks the boundary between the thinking and output phases. + +[mermaid] +---- +THINKING PHASE +─────────────────────────────────────────────────────────── +ack + +┌─ group_id: g1 ── Tool Call 1 ("Searching data") ─────────┐ +│ notification (thinking, TOOL_CALL_NOTIFICATION) │ +│ text-chunk (thinking) │ +│ answer (thinking) │ +└──────────────────────────────────────────────────────────┘ + +┌─ group_id: g2 ── Tool Call 2 ("Running code") ───────────┐ +│ notification (thinking, TOOL_CALL_NOTIFICATION) │ +│ text-chunk (thinking) │ +│ text-chunk (thinking) │ +└──────────────────────────────────────────────────────────┘ + +notification (FINAL_RESPONSE_NOTIFICATION) ←── boundary +──────────────────────────────────────────────────────────── + +OUTPUT PHASE +──────────────────────────────────────────────────────────── +┌─ group_id: g3 ────────────────────────────────────────────┐ +│ text "Here are the results:" │ +│ answer (final visualization) │ +└───────────────────────────────────────────────────────────┘ +[stream closes] +---- + +==== Notification codes reference + +[width="100%" cols="2,4"] +[options='header'] +|=== +|Code| When it appears +|`QH`|Query handling started +|`TML_GEN` / `TML_GEN_RETRY`|Generating or retrying TML +|`ANSWER_GEN`|Generating an answer +|`IDENTIFYING_ATTRIBUTES`|Identifying data attributes +|`PERFORMING_CHANGE_ANALYSIS`|Running change analysis +|`PERFORMING_FORECASTING_ANALYSIS`|Running forecasting +|`SUMMARIZING_RESULTS`|Summarizing results +|`TOOL_CALL_NOTIFICATION`|Tool invocation (during thinking phase) +|`FINAL_RESPONSE_NOTIFICATION`|Marks the transition from thinking to output +|`search_datasets_start` / +search_datasets_end+|Data source discovery in progress or complete +|`approval_required`|An external tool requires user permission before proceeding +|=== + +=== SSE event payload reference + +==== ack + +[source,JSON] +---- +data: { + "type": "ack", + "group_id": "a1b2c3", + "id": "evt-001", + "node_id": "resp-node-abc" +} +---- + +==== notification (thinking — tool call) + +[source,JSON] +---- +data: { + "type": "notification", + "group_id": "g1", + "id": "evt-002", + "code": "TOOL_CALL_NOTIFICATION", + "message": "Searching for relevant data", + "metadata": { + "type": "thinking", + "tool_title": "Searching sales data", + "tool_code": "RUNNING_CODE_EXECUTION", + "tool_name": "code_interpreter" + } +} +---- + +==== notification (thinking - external tool with MCP integration) + +[source,JSON] +---- +data: { + "type": "notification", + "group_id": "g2", + "id": "evt-003", + "code": "TOOL_CALL_NOTIFICATION", + "message": "Querying Salesforce", + "metadata": { + "type": "thinking", + "tool_title": "Salesforce: Get Opportunities", + "tool_name": "get_opportunities", + "integration_id": "int-sf-123", + "integration_name": "Salesforce" + } +} +---- + +==== notification (approval required) +Sent when an external MCP tool requires explicit user permission before proceeding. Your application should prompt the user to approve or deny the action before continuing. + +[source,JSON] +---- +data: { + "type": "notification", + "group_id": "g2", + "id": "evt-005", + "code": "approval_required", + "metadata": { + "request_id": "perm-req-789", + "integration_id": "int-sf-123", + "integration_name": "Salesforce", + "tool_name": "get_opportunities", + "annotated_title": "Access Salesforce Opportunities" + } +} +---- + +==== notification (FINAL_RESPONSE_NOTIFICATION) + +[source,JSON] +---- +data: { + "type": "notification", + "group_id": "g1", + "id": "evt-004", + "code": "FINAL_RESPONSE_NOTIFICATION", + "message": "" +} +---- + +==== text + +[source,JSON] +---- +data: { + "type": "text", + "group_id": "g3", + "id": "evt-007", + "content": "Here is the total revenue breakdown by region for Q4 2025:\n\n- **North America:** $4.2M\n- **EMEA:** $2.8M\n- **APAC:** $1.5M" +} +---- + +==== text-chunk +Multiple chunks sharing the same `id` should be appended together to reconstruct the full text item. + +[source,JSON] +---- +data: { "type": "text-chunk", "group_id": "g3", "id": "evt-009", "content": "Based on the analysis, " } +data: { "type": "text-chunk", "group_id": "g3", "id": "evt-009", "content": "revenue grew 12% quarter-over-quarter." } +---- + +==== answer +When an `answer` event is received, the `session_id` and `gen_no` fields are returned. You can export the visualization data using the Export Answer Report API to process the results. This allows users to download the answer as a PDF, PNG, CSV, or XLSX file. + +[source,JSON] +---- +data: { + "type": "answer", + "group_id": "g3", + "id": "evt-010", + "title": "Revenue by Region Q4 2025", + "metadata": { + "session_id": "sess-abc-123", + "gen_no": 1, + "transaction_id": "txn-456", + "worksheet_id": "ws-def-789", + "cached": false, + "is_hidden": false + } +} +---- + +==== search_datasets +Emitted as a start/end pair during Auto mode data source discovery. + + +[source,JSON] +---- +data: { "type": "search_datasets", "group_id": "g0", "id": "evt-012", "code": "search_datasets_start", "metadata": {} } + +data: { + "type": "search_datasets", + "group_id": "g0", + "id": "evt-013", + "code": "search_datasets_end", + "metadata": { + "data_sources": [ + { "worksheet_id": "ws-1", "worksheet_name": "Sales Data", "confidence": "high", "reasoning": "Contains revenue columns" }, + { "worksheet_id": "ws-2", "worksheet_name": "Marketing Data", "confidence": "low", "reasoning": "No revenue columns" } + ], + "auto_selected": { "worksheet_id": "ws-1", "worksheet_name": "Sales Data", "confidence": "high", "reasoning": "Best match" } + } +} +---- +==== file + +[source,JSON] +---- +data: { + "type": "file", + "group_id": "g3", + "id": "evt-014", + "files": [ + { "ts_file_id": "file-abc-001", "display_name": "quarterly_report.csv", "file_type": "csv", "created_at": "2025-11-15T10:30:00Z" }, + { "ts_file_id": "file-abc-002", "display_name": "chart.png", "file_type": "png", "created_at": "2025-11-15T10:30:01Z" } + ], + "metadata": { "conv_id": "conv-123" } +} +---- +==== conv_title + +[source,JSON] +---- +data: { + "type": "conv_title", + "group_id": "g0", + "id": "evt-015", + "title": "Revenue Analysis Q4 2025", + "conv_id": "conv-123" +} +---- + +==== error + +[source,JSON] +---- +data: { + "type": "error", + "group_id": "g3", + "id": "evt-016", + "code": "RATE_LIMIT_EXCEEDED", + "message": "Too many requests", + "display_message": "You've exceeded the rate limit. Please try again in a few minutes." +} +---- +==== agent-interrupt + +[source,JSON] +---- +Sent when generation is stopped mid-stream. +data: { + "type": "notification", + "group_id": "g3", + "id": "evt-017", + "code": "agent-interrupt", + "message": "Generation stopped" +} +---- + +[#process_results] +== Process results generated from a conversation session +To export or download the Answer data generated by the Spotter APIs, use the xref:data-report-v2-api.adoc#exportSpotterData[Answer report] API. + +The `session_id` and `gen_no` values from the `answer` event metadata are required to identify the answer to export. + +NOTE: Requires at least view access to the Answer. + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/report/answer' \ + -H 'Authorization: Bearer {Bearer_token}' \ + -H 'Accept: application/octet-stream' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "session_identifier": "sess-abc-123", + "generation_number": 1, + "file_format": "CSV" +}' +---- +The `file_format` parameter accepts `PDF`, `PNG`, `CSV`, or `XLSX`. + +[NOTE] +==== +Using tokens generated by the Spotter API in a xref:data-report-v2-api.adoc#_search_data_api[Search Data API] request can return invalid column errors, because these tokens may reference formulas or columns not present in the data model. Instead, use the xref:data-report-v2-api.adoc#exportSpotterData[Answer report] API and include the session ID and generation number obtained from the Spotter API in your API request to retrieve the data. +==== + + +== Data literacy and query assistance +The query assistance APIs help users find the appropriate dataset for a given query string, suggest what questions can be asked, and return example questions. These APIs are specifically designed to improve data literacy for users who may not be familiar with the underlying data, making it easier for them to explore and analyze data effectively. + +=== Get data source suggestions + +The `POST /api/rest/2.0/ai/data-source-suggestions` API provides relevant data source recommendations for a user-submitted natural language query. To use this API, you must have at least view access to the underlying metadata object referenced in the response. + +==== Request parameters + +[width="100%" cols="2,4"] +[options='header'] +|==== +|Parameter| Description +|`metadata_context` a| Required. Specify one of the following attributes to set the metadata context: + +* `data_source_identifiers` + +__Array of strings__. IDs of the data source object such as Models. +* `answer_identifiers` + +__Array of strings__. GUIDs of the Answer objects that you want to use as metadata. +* `conversation_identifier` + +__String__. ID of the conversation session. +* `liveboard_identifiers` + +__Array of strings__. GUIDs of the Liveboards that you want to use as metadata. + +| `query` |__String__. Required parameter. Specify the query string that needs to be decomposed into smaller, analytical sub-questions. +|`limit_relevant_questions` + +__Optional__ | __Integer__. Sets a limit on the number of sub-questions to return in the response. Default is 5. +|`bypass_cache` + +__Optional__| __Boolean__. When set to `true`, disables cache and forces fresh computation. +|`ai_context` + +__Optional__. a| Additional context to guide the response. Define the following attributes as needed: +|==== + +==== Example request + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/data-source-suggestions' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "metadata_context": { + "data_source_identifiers": [ + "cd252e5c-b552-49a8-821d-3eadaa049cca" + ] + }, + "query": "Net sales of Jackets in west coast", + "limit_relevant_questions": 3 +}' +---- + +==== API response +If the API request is successful, ThoughtSpot returns a ranked list of data sources, each annotated with relevant reasoning. + +[source,JSON] +---- +{ + "relevant_questions": [ + { + "query": "What is the trend of sales by type over time?", + "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", + "data_source_name": "(Sample) Retail - Apparel" + }, + { + "query": "Sales by item", + "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", + "data_source_name": "(Sample) Retail - Apparel" + }, + { + "query": "Sales across regions", + "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", + "data_source_name": "(Sample) Retail - Apparel" + } + ] +} +---- + +The returned results include metadata such as: + +* `confidence` + +A float indicating the Model's confidence in the relevance of each recommendation. +* `details` + +The data source ID, name, and description for each recommended data source. +* `reasoning` + +Reason provided by the LLM to explain why each data source was recommended. + +=== Get relevant questions + +The `/api/rest/2.0/ai/relevant-questions/` API endpoint breaks down a user-submitted query into relevant sub-questions. It accepts the original query and optional additional context, then generates a set of related questions to help users explore their data comprehensively. + +During agentic interactions, this API can be used as an integrated tool to decompose user queries and suggest relevant questions for a specific data context. REST clients can also call this API directly to fetch relevant questions via a `POST` request. + +==== Request parameters + +[width="100%" cols="2,4"] +[options='header'] +|===== +|Parameter| Description +|`metadata_context` a| Required. Specify one of the following attributes to set the metadata context: + +* `data_source_identifiers` + +__Array of strings__. IDs of the data source object such as Models. +* `answer_identifiers` + +__Array of strings__. GUIDs of the Answer objects that you want to use as metadata. +* `conversation_identifier` + +__String__. ID of the conversation session. +* `liveboard_identifiers` + +__Array of strings__. GUIDs of the Liveboards that you want to use as metadata. + +| `query` |__String__. Required parameter. Specify the query string that needs to be decomposed into smaller, analytical sub-questions. +|`limit_relevant_questions` + +__Optional__ | __Integer__. Sets a limit on the number of sub-questions to return in the response. Default is 5. +|`bypass_cache` + +__Optional__| __Boolean__. When set to `true`, disables cache and forces fresh computation. +|`ai_context` + +__Optional__. a| Additional context to guide the response. Define the following attributes as needed: + +* `instructions` + +__Array of strings__. Custom user instructions to influence how the AI interprets and processes the query. +* `content` + +__Array of strings__. Additional input such as raw text or CSV-formatted data to enhance context and answer quality. +|===== + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/relevant-questions/' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "metadata_context": { + "data_source_identifiers": [ + "cd252e5c-b552-49a8-821d-3eadaa049cca" + ] + }, + "query": "Net sales of Jackets in west coast", + "limit_relevant_questions": 3 +}' +---- + +==== Example response +If the request is successful, the API returns a set of questions related to the query and metadata context in the `relevant_questions` array. Each object in the `relevant_questions` array contains the following fields: + +* `query` + +A string containing the natural language (NL) sub-question. +* `data_source_identifier` + +GUID of the data source object. +* `data_source_name` + +Name of the associated data source object. + +[source,JSON] +---- +{ + "relevant_questions": [ + { + "query": "What is the trend of sales by type over time?", + "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", + "data_source_name": "(Sample) Retail - Apparel" + }, + { + "query": "Sales by item", + "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", + "data_source_name": "(Sample) Retail - Apparel" + }, + { + "query": "Sales across regions", + "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", + "data_source_name": "(Sample) Retail - Apparel" + } + ] +} +---- + +== Additional resources + +* Visit the +++REST API v2.0 Playground+++ to view the API endpoints and verify the request and response workflows. +* For information about MCP tools, see xref:mcp-integration.adoc[MCP server integration]. diff --git a/modules/ROOT/pages/spotter-apis.adoc b/modules/ROOT/pages/spotter-apis.adoc index c13019ee4..f4ee15d71 100644 --- a/modules/ROOT/pages/spotter-apis.adoc +++ b/modules/ROOT/pages/spotter-apis.adoc @@ -1,20 +1,12 @@ -= Spotter AI APIs += Spotter APIs :toc: true :toclevels: 2 :page-title: Spotter APIs :page-pageid: spotter-api -:page-description: You can use Spotter REST APIs to receive Answers for your analytical queries sent through the conversational experience with ThoughtSpot. +:page-description: You can use Spotter REST APIs to receive Answers for your analytical queries sent through the conversational experience with ThoughtSpot. -ThoughtSpot's Spotter AI APIs [beta betaBackground]^Beta^ allow users to query and explore data through conversational interactions. - -[NOTE] -==== -The Spotter AI APIs are in Beta and disabled by default on ThoughtSpot instances. To enable these APIs on your instance, contact ThoughtSpot Support. -==== - -== Overview -Spotter AI APIs collectively support natural-language-driven analytics, context-aware and guided data analysis, and integration with agentic systems. +The Spotter APIs support natural-language-driven analytics, context-aware and guided data analysis, and integration with agentic systems. The key capabilities of the Spotter APIs include the following: @@ -26,66 +18,26 @@ The key capabilities of the Spotter APIs include the following: Spotter manages conversation sessions, context tracking, and response generation for user-submitted queries. The Spotter APIs are designed for use in Spotter-driven analytics and also for agentic interactions within an orchestrated agent framework. -=== Locale settings for API requests - -When using the xref:spotter-apis.adoc#_generate_a_single_answer[Single Answer] and xref:spotter-apis.adoc#_send_a_question_to_generate_answer[Send message] APIs, the locale used for API requests depends on your application's locale settings: - -* If your application is set to "Use browser language," the API will not apply the default locale. In this case, you must explicitly include the desired locale code in the `Accept-Language` header of your API request. If you do not specify the locale, the API may not return responses in the expected language or regional format. -* If you have set a specific locale in your ThoughtSpot instance or user profile, the API will use this locale to generate responses, overriding the browser or OS locale. - -To ensure consistent localization, set the `Accept-Language` header in your API requests when relying on browser language detection, or configure the locale explicitly in the user profile settings in ThoughtSpot. - -=== API endpoints -Each of the Spotter AI APIs serves a specific function: - -[width="100%" cols="2,4"] -[options='header'] -|===== -|Category| API endpoints -|Conversational analytics with Spotter (Classic) a| - -* `POST /api/rest/2.0/ai/conversation/create` + -xref:spotter-apis.adoc#_create_a_conversation_session[Creates a conversation session] with Spotter to generate Answers from a specific data Model. The resulting session sets the context for subsequent queries and responses. +Spotter API operations require `CAN_USE_SPOTTER` privilege and at least view-level access to the underlying metadata entities referenced in the response. -* `POST /api/rest/2.0/ai/conversation/{conversation_identifier}/converse` + -Allows xref:spotter-apis.adoc#_send_a_query_to_a_conversation_session[Sending a message or follow-up query] to an ongoing conversation session. +== Supported API operations -* `POST /api/rest/2.0/ai/answer/create` + -xref:spotter-apis.adoc#_generate_a_single_answer[Generates an answer] for a natural language query specified in the API request. +For information about supported API operations, see the following pages: -|Advanced analytics and agentic interaction a| * `POST /api/rest/2.0/ai/agent/conversation/create` + -xref:spotter-apis.adoc#_create_a_conversation_session_with_spotter_agent[Creates a conversation session with the Spotter agent] to generate Answers for the specified data context. This API endpoint is designed for agentic or orchestrated frameworks that leverage Spotter agent's capabilities for advanced analytics, context-aware conversations, and data literacy. + -__Available on ThoughtSpot Cloud instances from 10.13.0.cl onwards__. +* xref:spotter-classic-apis.adoc[APIs for Spotter classic workflow] +* xref:spotter-agent-apis.adoc[APIs for Spotter agent workflows] +* xref:spotter-nl-instructions.adoc[APIs for Spotter coaching and NL instructions] -* `POST /api/rest/2.0/ai/agent/converse/sse` + -xref:spotter-apis.adoc#_send_a_question_and_generate_streaming_responses[Streams responses], including tokens and visualizations, for a specific conversation context. This API endpoint can be used for real-time agentic interactions and orchestrated experiences. + -__Available on ThoughtSpot Cloud instances from 10.13.0.cl onwards__. +== Locale settings for API requests -* `POST /api/rest/2.0/ai/agent/{conversation_identifier}/converse` + -xref:spotter-apis.adoc#_send_queries_to_a_conversation_session_with_spotter_agent[Sends a message] to an ongoing conversation session with Spotter agent. + -__Available on ThoughtSpot Cloud instances from 10.15.0.cl onwards__. +When using the xref:spotter-classic-apis.adoc#_generate_a_single_answer[Single Answer] and xref:spotter-classic-apis.adoc#_send_a_query_to_a_conversation_session[Send message] APIs, the locale used for API requests depends on your application's locale settings: -|Data literacy and guided analysis a| -* `POST /api/rest/2.0/ai/data-source-suggestions` + -xref:spotter-apis.adoc#_get_data_source_suggestions[Returns a list of relevant data sources], such as Models, based on a query and thus helping users and agents choose the most appropriate data source for analytics. + -__Available on ThoughtSpot Cloud instances from 10.15.0.cl onwards__. - -* `POST /api/rest/2.0/ai/relevant-questions/`] + -xref:spotter-apis.adoc#_get_relevant_questions[Decomposes a user query] into relevant sub-questions. Guides users to explore data more deeply for a comprehensive analysis. + -__Available on ThoughtSpot Cloud instances from 10.13.0.cl onwards__. - -|NL instructions to coach Spotter a| * `POST /api/rest/2.0/ai/instructions/set` + -xref:spotter-apis.adoc#_set_nl_instructions[Sets natural language instructions] on a specific data model to guide Spotter and enhance the quality of Spotter-generated responses. + -__Available on ThoughtSpot Cloud instances from 10.15.0.cl onwards__. - -* `POST /api/rest/2.0/ai/instructions/get` + -xref:spotter-apis.adoc#_retrieve_nl_instructions_assigned_to_a_model[Retrieves NL instructions assigned to a Model] + -__Available on ThoughtSpot Cloud instances from 10.15.0.cl onwards__. -|===== +* If your application is set to "Use browser language", the API will use this locale to generate responses. To override this setting, you must explicitly include the desired locale code in the `Accept-Language` header of your API request. To ensure consistent localization, set the `Accept-Language` header in your API requests when relying on browser language detection, or configure the locale explicitly in the user profile settings in ThoughtSpot. +* If you have set a specific locale in your ThoughtSpot instance or user profile, the API will use this locale to generate responses, overriding the browser or OS locale. == Per-user API rate limits -The following rate limits apply to xref:spotter-apis.adoc#_conversational_analytics_with_spotter_agent[Spotter agent APIs] per user: +The following rate limits apply to Spotter agent APIs per user: * A maximum of 10 conversation creation requests per minute. * A maximum of 30 query messages to a conversation session per minute. @@ -95,1286 +47,17 @@ The following rate limits apply to xref:spotter-apis.adoc#_conversational_analyt |===== |API endpoint| Rate Limit (per user, per minute) |`/api/rest/2.0/ai/agent/conversation/create` | 10 -|`/api/rest/2.0/ai/agent/{conversation_identifier}/converse`| 30 -|`/api/rest/2.0/ai/agent/converse/sse` | 30 +|`/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send`| 30 +|`POST /api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send/stream` | 30 +|`/api/rest/2.0/ai/agent/{conversation_identifier}/converse` [.version-badge.deprecated]#Deprecated# | 30 +|`/api/rest/2.0/ai/agent/converse/sse` [.version-badge.deprecated]#Deprecated# | 30 || |===== If you are integrating these APIs in your environment, consider implementing a retry logic to handle the rate limit errors. -== Conversational analytics with Spotter (Classic) -In the Spotter classic mode, the conversation session and context will be managed by Spotter. The APIs allow users to interact directly with Spotter with no specific agentic capabilities or framework. - -=== Create a conversation session -To create a conversation session with Spotter, send a `POST` request to the `/api/rest/2.0/ai/conversation/create` API endpoint. The resulting conversation session maintains the context and can be used to send queries and follow-up questions to generate answers. - -==== Request parameters -Include the following parameters in the request body: - -[width="100%" cols="2,4"] -[options='header'] -|===== -|Form parameter|Description -|`metadata_identifier`|_String_. Required. Specify the GUID of the data source objects such as ThoughtSpot Models. The metadata object specified in the API request will be used as a data source for the conversation. -|`tokens` + -__Optional__ a|_String_. To set the context for the conversation, you can specify a set of keywords as token string. For example, `[sales],[item type],[state]`. -|===== - -==== Example requests - -===== With tokens -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/conversation/create' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' \ - --data-raw '{ - "metadata_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", - "tokens": "[sales],[item type],[Jackets]" -}' ----- - -===== Without tokens - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/conversation/create' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' \ - --data-raw '{ - "metadata_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca" -}' ----- - -==== API response - -If the API request is successful, a conversation identifier is created. Note the GUID of the conversation and use it when sending follow-up queries. - -[source,JSON] ----- -{"conversation_identifier":"98f9b8b0-6224-4f9d-b61c-f41307bb6a89"} ----- - - -=== Send a query to a conversation session -To send a question to an ongoing conversation session or ask follow-up questions to , send a `POST` request body with conversation ID and query text to the `POST /api/rest/2.0/ai/conversation/{conversation_identifier}/converse` API endpoint. - -This API endpoint supports only the conversation sessions created using the `POST /api/rest/2.0/ai/conversation/create` API call. - -==== Request parameters - -[width="100%" cols="2,2,4"] -[options='header'] -|===== -|Parameter|Type| Description -|`conversation_identifier`|Path parameter|__String__. Required. Specify the GUID of the conversation received from the xref:spotter-apis.adoc#_create_a_conversation_session[create conversation API call]. -|`metadata_identifier`|Form parameter|_String_. Required. Specify the GUID of the data source object, for example, Model. The metadata object specified in the API request will be used as a data source for the follow-up conversation. -|`message`|Form parameter|_String_. Required. Specify a natural language query string. For example, `Sales data for Jackets`. -|===== - -==== Example request - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/conversation/03f48527-b973-4efa-81fd-a8568a4f9e78/converse' \ - -H 'Accept: application/json' \ - -H 'accept-language: en-US', \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' \ - --data-raw '{ - "metadata_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", - "message": "Top performing products in the west coast" -}' ----- - -==== API response - -If the API request is successful, the following data is sent in the API response: - -* `session_identifier` + -GUID of the Answer session. -* `generation_number` + -Number assigned to the Answer session. -* `message_type` + -Type of response received for the query. For example, `TSAnswer` (ThoughtSpot Answer). -* `visualization_type` + -The data format of the generated Answer, for example, a chart or table. When you download this Answer, the data will be exported in the format indicated by the `visualization_type`. -* `tokens` + -Tokens generated from the natural language search query specified in the API request. These tokens can be used as input to the `/api/rest/2.0/ai/conversation/create` API endpoint to set the context for a conversation session. - -[NOTE] -==== -Note the session ID and generation number. To export the Answer generated from this conversation, send these attributes in the `POST` request body to the `/api/rest/2.0/report/answer` endpoint. -==== - -[source,JSON] ----- -[ - { - "session_identifier": "1290f8bc-415a-4ecb-ae3b-e1daa593eb24", - "generation_number": 3, - "message_type": "TSAnswer", - "visualization_type": "Chart", - "tokens": "[sales], [state], [item type], [region] = [region].'west', sort by [sales] descending" - } -] ----- - -==== Ask follow-up questions - -The API retains the context of previous queries when you send follow-up questions. To verify this, you can send another API request with a follow-up question to drill down into the data. - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/conversation/03f48527-b973-4efa-81fd-a8568a4f9e78/converse' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' \ - --data-raw '{ - "metadata_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", - "message": "which city has the better sales of jackets here?" -}' ----- - -The API retrains the context of the initial question and returns a response: - -[source,JSON] ----- -[ - { - "session_identifier": "ee077665-08e1-4a9d-bfdf-7b2fe0ca5c79", - "generation_number": 3, - "message_type": "TSAnswer", - "visualization_type": "Table", - "tokens": "[sales], by [city], [state], [item type] = [item type].'jackets', [region] = [region].'west', sort by [sales] descending" - } -] ----- - -=== Generate a single Answer -To generate an Answer from a natural language search query, send a `POST` request to the `/api/rest/2.0/ai/answer/create` API endpoint. In the request body, include the query and the data source ID. - -==== Request parameters - -[width="100%" cols="2,4"] -[options='header'] -|===== -|Form parameter| Description -|`query`|__String__. Required. Specify the string as a natural language query. For example, `Top performing products in the west coast`. -|`metadata_identifier`|_String_. Required. Specify the GUID of the data source object, for example, Model. The metadata object specified in the API request will be used as a data source for the follow-up conversation. -|===== - -==== Example request -In the following example, a query string and the model ID are included in the request body to set the context of the conversation. - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/answer/create' \ - -H 'Accept: application/json' \ - -H 'accept-language: en-US', \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN} \ - --data-raw '{ - "query": "Top performing products in the west coast", - "metadata_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca" -}' ----- - -==== API response - -If the API request is successful, the following data is sent in the API response: - -* `session_identifier` + -GUID of the Answer session. -* `generation_number` + -Number assigned to the Answer session. -* `message_type` -Type of response received for the query. For example, `TSAnswer` (ThoughtSpot Answer). -* `visualization_type` + -The data format of the generated Answer; for example, a chart or table. When you download this Answer, the data will be exported in the format indicated by the `visualization_type`. -* `tokens` + -Tokens generated from the natural language search query specified in the API request. These tokens can be used as input to the `/api/rest/2.0/ai/conversation/create` endpoint to set the context for a conversation session. - -[NOTE] -==== -Note the session ID and generation number. To export the result generated from this API call, send these attributes in the `POST` request body to the `/api/rest/2.0/report/answer` endpoint. -==== - -[source,JSON] ----- -[{ - "session_identifier": "57784fa1-10fa-431d-8d82-a1657d627bbe", - "generation_number": 2, - "message_type": "TSAnswer", - "visualization_type": "Undefined", - "tokens": "[product], [region] = [region].'west', sort by [sales] descending" -}] ----- - -== Conversational analytics with Spotter agent -Spotter agent is an advanced, agentic version of Spotter, which supports context-aware interactions, data literacy features, and follow-up conversations for deeper analytics. Spotter agent can be used for complex reasoning and agentic interactions in an orchestrated framework. - -=== Create a conversation session with Spotter agent - -The `/api/rest/2.0/ai/agent/conversation/create` API endpoint allows you to initiate a new conversation session with Spotter Agent for different data contexts, such as Answers, Liveboards, or Models. - -[NOTE] -==== -Clients must have at least view access to the objects specified in the API request to create a conversation context and use it for subsequent queries. -==== - -==== Request parameters -To set the context for the conversation session, you must specify the metadata type and context in the `POST` request body. Optionally, you can also define additional parameters to refine the data context and generate precise responses. - -[width="100%" cols="2,4"] -[options='header'] -|===== -|Form parameter| Description -|`metadata_context` a| Defines the data context for the conversation. - -* `type` + -Metadata context type. The context type is mandatory. Select one of the following values: -** `data_source` - To set a data source context for the conversation session. + -If the context type is `data_source`, you must define the `data_source_context` in the request payload. -** `answer` - To use an existing Spotter-generated Answer as the object. + -If the context type is `answer`, you must define both `data_source_context` and `answer_context` in the request payload. -** `liveboard` - To use an existing Liveboard as context. + -If the context type is `liveboard`, you must define `data_source_context`, `liveboard_context`, and `answer_context` in the request payload. - -* `answer_context` + -If the metadata type is set as `answer` or `liveboard`, specify the following attributes: -** `session_identifier`: __string__, Unique ID representing the answer session. -** `generation_number`: __Integer__. Specific generation/version number of the answer within a conversation session. -+ -The session identifier and generation numbers are assigned to the Answers generated from the Spotter AI REST APIs. These properties serve as the ID of the AI-generated Answer within the ThoughtSpot system. - -* `liveboard_context` + -If the metadata type is set as `liveboard`, specify the GUIDs of the Liveboard and visualization. -* `data_source_context` + -Specify the GUID of the data source object. Required parameter for all types of metadata context. - -|`conversation_settings` a|__Optional__. Defines additional parameters for the conversation context. You can set any of the following attributes as needed: - -* `enable_contextual_change_analysis` + -__Boolean__. When enabled, Spotter analyzes how context changes over time, that is comparing results from different queries. -* `enable_natural_language_answer_generation` + -__Boolean__. Allows sending natural language queries to the conversation session. -* `enable_reasoning` + -__Boolean__. Allows Spotter to use reasoning for deep analysis and precise responses. -|===== - -==== Example request - -The following example shows the request payload for the `data_source` context type: - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/agent/conversation/create' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' \ - --data-raw '{ - "metadata_context": { - "type": "data_source", - "data_source_context": { - "guid": "cd252e5c-b552-49a8-821d-3eadaa049cca" - } - }, - "conversation_settings": { - "enable_contextual_change_analysis": false, - "enable_natural_language_answer_generation": true, - "enable_reasoning": true - } -}' ----- - -The following example shows the request payload for the `liveboard` context type: - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/agent/conversation/create' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' \ - --data-raw '{ - "metadata_context": { - "type": "liveboard", - "answer_context": { - "session_identifier": "c3a00fa7-fd01-4d58-8c84-0704df986d9d", - "generation_number": 2 - }, - "liveboard_context": { - "liveboard_identifier": "cffdc614-0214-42ba-9f57-cb6e8312fe5a", - "visualization_identifier": "da0ed3da-ce1f-4071-8876-74d551b05faf" - }, - "data_source_context": { - "guid": "54beb173-d755-42e0-8f73-4d4ec768114f" - } - }, - "conversation_settings": { - "enable_contextual_change_analysis": false, - "enable_natural_language_answer_generation": true, - "enable_reasoning": false - } -}' ----- - -The following example shows the request payload for the `answer` context type: - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/agent/conversation/create' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' \ - --data-raw '{ - "metadata_context": { - "type": "answer", - "answer_context": { - "session_identifier": "f131ca07-47e9-4f56-9e21-454120912ae1", - "generation_number": 1 - }, - "data_source_context": { - "guid": "cd252e5c-b552-49a8-821d-3eadaa049cca" - } - }, - "conversation_settings": { - "enable_contextual_change_analysis": false, - "enable_natural_language_answer_generation": true, - "enable_reasoning": false - } -}' ----- - -==== API response - -If the API request is successful, the API returns the conversation ID. You can use this ID to send follow-up questions to the conversation session. - -[source,JSON] ----- -{"conversation_id":"q9tZYf_6WnFC"} ----- -Note the conversation ID for subsequent agentic interactions and API calls. - -=== Send a question and generate streaming responses - -To send queries to an ongoing conversation session with Spotter agent and receive streaming responses, use the `/api/rest/2.0/ai/agent/converse/sse` API endpoint. This API endpoint uses the SSE protocol to deliver data incrementally as it becomes available, rather than waiting for the entire response to be generated before sending it to the client. - -The `/api/rest/2.0/ai/agent/converse/sse` API can be used as an integrated tool for real-time streaming of conversational interactions between agents and the ThoughtSpot backend. It enables AI agents to send user queries and receive incremental, streamed responses that can be processed and sent to users. REST clients can also send a `POST` request with a conversation ID and query string to fetch streaming responses. - -==== Request parameters - -[width="100%" cols="2,4"] -[options='header'] -|===== -|Parameter| Description -|`conversation_identifier` |__String__. Specify the conversation ID received from the xref:spotter-apis.adoc#_create_a_conversation_session_with_spotter_agent[POST /api/rest/2.0/ai/agent/conversation/create] API call. -|`messages`|_Array of Strings_. Include at least one natural language query. For example, `Sales data for Jackets`, `Top performing products in the west coast`. -|===== - -//// -|`settings` |__Optional__. Defines additional parameters for the conversation context. You can set any of the following attributes as needed: - -* `enable_contextual_change_analysis` + -__Boolean__. When enabled, Spotter analyzes how the context changes over time, that is comparing results from different queries. -* `enable_natural_language_answer_generation` + -__Boolean__. Allows sending natural language queries to the conversation session. -* `enable_reasoning` + -__Boolean__. Allows Spotter to use reasoning for deep analysis and precise responses. -//// - -==== Example request - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/agent/converse/sse' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' \ - --data-raw '{ - "conversation_identifier": "h2I_pTGaRQof", - "messages": [ - "Net sales of Jackets" - ] -}' ----- - -==== API response - -If the API request is successful, the response includes a stream of events, each containing a partial or complete message from the AI agent, rather than a single JSON object. - -Each event is a simple text-based message in a specific format, `data: \n\n`; `\n\n` means that each message sent from the server to the client is prefixed with `data:` keyword, followed by the actual payload (``), and ends with two newline characters (`\n\n`). - -The API uses this format so that the clients can reconstruct the AI-generated response as it streams in, chunk by chunk, and show the responses in real-time. In agentic workflows, the receiving client or agent listens to the SSE stream, parses each event, and assembles the full response for its users. - -===== Example response - -[source,] ----- -data: [{"type": "ack", "node_id": "BRxCtJ-aGt8l"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": "I"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " understand"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " you're"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " interested"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " in"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " the"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " net"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " sales"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " of"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " Jackets"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": "."}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " I'll"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " retrieve"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " the"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " relevant"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " data"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " for"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": " you"}] - -data: [{"id": "OJ0zMh4PVa-y", "type": "text-chunk", "group_id": "czoDDhNwwU7z", "metadata": {"format": "markdown"}, "content": "."}] - -data: [{"type": "notification", "group_id": "o8dQ9SAWdtrL", "metadata": {"title": "Net sales of Jackets"}, "code": "nls_start"}] - -data: [{"type": "notification", "group_id": "o8dQ9SAWdtrL", "code": "QH", "message": "Fetching Worksheet Data"}] - -data: [{"type": "notification", "group_id": "o8dQ9SAWdtrL", "code": "TML_GEN", "message": "Translating your query with the Reasoning Engine"}] - -data: [{"type": "notification", "group_id": "o8dQ9SAWdtrL", "code": "ANSWER_GEN", "message": "Verifying results with the Trust Layer"}] - -data: [{"id": "r24X7D99SROD", "type": "answer", "group_id": "o8dQ9SAWdtrL", "metadata": {"sage_query": "[sales] [item type] = [item type].'jackets'", "session_id": "b321b404-cbf1-4905-9b0c-b93ad4eedf89", "gen_no": 1, "transaction_id": "6874259d-13b1-478c-83cb-b3ed52628850", "generation_number": 1, "warning_details": null, "ambiguous_phrases": null, "query_intent": null, "assumptions": "You want to see the total sales amount for jackets item type.", "tml_phrases": ["[sales]", "[item type] = [item type].'jackets'"], "cached": false, "sub_queries": null, "title": "Net sales of Jackets", "worksheet_id": "cd252e5c-b552-49a8-821d-3eadaa049cca"}, "title": "Net sales of Jackets"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "The"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " net"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " sales"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " for"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " Jackets"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " have"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " been"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " visual"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "ized"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " for"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " you"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "."}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " This"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " analysis"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " specifically"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " filtered"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " for"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " the"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " item"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " type"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "jackets"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "\""}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " and"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " calculated"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " the"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " total"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " sales"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " amount"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " associated"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " with"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " those"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " products"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ".\n\n"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "**"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "Summary"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " &"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " Insights"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ":"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "**\n"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "-"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " The"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " visualization"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " shows"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " the"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " total"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " net"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " sales"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " for"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " all"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " jacket"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " transactions"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " in"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " your"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " apparel"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " dataset"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ".\n"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "-"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " The"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " calculation"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " uses"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " only"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " sales"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " amounts"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " where"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " the"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " item"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " type"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " is"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " \""}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "J"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "ackets"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ".\"\n"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "-"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " This"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " information"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " is"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " useful"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " for"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " understanding"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " the"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " revenue"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " contribution"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " of"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " jackets"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " within"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " your"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " product"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " mix"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ".\n\n"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "If"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " you'd"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " like"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " to"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " see"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " a"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " breakdown"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " by"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " region"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ","}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " state"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ","}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " time"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " period"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ","}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " or"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " compare"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " jacket"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " sales"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " to"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " other"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " product"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " types"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": ","}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " please"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " let"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " me"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": " know"}] - -data: [{"id": "BgY16KR8nVL1", "type": "text-chunk", "group_id": "_ARJXDKbFhHF", "metadata": {"format": "markdown"}, "content": "!"}] ----- - -The messages in the API response include the following parts: - -* `id` + -A unique identifier for the message group -* `type` -Type of the message. Valid types are: -** `ack` + -Confirms receipt of the request. For example, the type in the first message `data: [{"type": "ack", "node_id": "BRxCtJ-aGt8l"}]`, which indicates that the server has received the client's request and is acknowledging it. -** `text / text-chunk` + -Content chunks, optionally formatted. -** `answer` + -The final structured response with metadata and analytics -** `error` + -Indicates a failure. -** `notification` + -Notification messages. -* `group_id` + -Groups related chunks together. -* `metadata`: -Indicates content format, for example, markdown. -* `content` + -The actual text content sent incrementally. For example, `"I"`, `"understand"`, `"you're"`, `"interested"`, `"in"`, `"the"`, `"net"`, `"sales"`, and so on. - -The following example shows the response text contents for the `answer` message type. - -[source,JSON] ----- -[ - { - "id": "r24X7D99SROD", - "type": "answer", - "group_id": "o8dQ9SAWdtrL", - "metadata": { - "sage_query": "[sales] [item type] = [item type].'jackets'", - "session_id": "b321b404-cbf1-4905-9b0c-b93ad4eedf89", - "gen_no": 1, - "transaction_id": "6874259d-13b1-478c-83cb-b3ed52628850", - "generation_number": 1, - "warning_details": null, - "ambiguous_phrases": null, - "query_intent": null, - "assumptions": "You want to see the total sales amount for jackets item type.", - "tml_phrases": [ - "[sales]", - "[item type] = [item type].'jackets'" - ], - "cached": false, - "sub_queries": null, - "title": "Net sales of Jackets", - "worksheet_id": "cd252e5c-b552-49a8-821d-3eadaa049cca" - }, - "title": "Net sales of Jackets" - } -] ----- - -The session ID and generation number serve as the data context for the Answer. You can use this information to create a new conversation session using `/api/rest/2.0/ai/agent/conversation/create`, or download the answer via the `/api/rest/2.0/report/answer` API endpoint. - -//// -* The tokens and TML phrases returned in the response can be used as inputs for the search data API call to get an Answer. -//// - -=== Send queries to a conversation session with Spotter agent - -To send queries to an ongoing conversation session with the Spotter agent, use the `/api/rest/2.0/ai/agent/{conversation_identifier}/converse` API endpoint. -To use this API, the user must have access to the relevant conversational session and include its ID in the API request URL. The API request body must include at least one message in natural language format. - -==== Request parameters - -[width="100%" cols="2,2,4"] -[options='header'] -|===== -|Parameter|Type| Description -|`conversation_identifier`|Path parameter|__String__. Required. Specify the conversation ID received from the xref:spotter-apis.adoc#_create_a_conversation_session_with_spotter_agent[POST /api/rest/2.0/ai/agent/conversation/create] API call. -|`messages`|Form parameter|_Array of strings_. Required. Specify at least one query in natural language. For example, `total sales of jackets last month`. -|===== - - -//// -|`settings` |__Optional__. Defines additional parameters for the conversation context. You can set any of the following attributes as needed: - -* `enable_contextual_change_analysis` + -__Boolean__. When enabled, Spotter analyzes how the context changes over time, that is comparing results from different queries. -* `enable_natural_language_answer_generation` + -__Boolean__. Allows sending natural language queries to the conversation session. -* `enable_reasoning` + -__Boolean__. Allows Spotter to use reasoning for deep analysis and precise responses. -//// - -==== Example request - -The following example shows the request body with the query text and the conversation ID. - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/agent/-1XZmqqMcbtm/converse' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' \ - --data-raw '{ - "messages": [ - "total sales of jackets" - ] -}' ----- - -==== API response - -If the request is successful, the API returns an array of objects in the response. The messages in the API response include the following parts: - -* `type` + -Type of the message, such as text, answer, or error. -* `text` + -Response message generated for the query. -* `metadata` + -Additional information based on the message type. - -The following example shows the response text contents for the `answer` message type. - -[source,JSON] ----- -{ - "messages":[ - { - "metadata":{ - }, - "internal":{ - }, - "type":"text", - "text":"Let me retrieve the total sales of jackets from the dataset.", - "agent_context":"" - }, - { - "metadata":{ - "output":"{metadata-output}", - "worksheet_id":"cd252e5c-b552-49a8-821d-3eadaa049cca", - "assumptions":"You want to know the total sales amount for jackets specifically.", - "chart_type":"KPI", - "data_awareness_enabled":true - }, - "internal":{ - }, - "type":"answer", - "title":"total sales of jackets", - "description":"", - "session_id":"19a5da20-28c5-4266-a3be-e1c61f122b5d", - "gen_no":1, - "sage_query":"sum [sales] [item type] = [item type].'jackets'", - "tml_tokens":[ - "sum [sales]", - "[item type] = [item type].'jackets'" - ], - "formulas":[ - ], - "subqueries":[ - ], - "viz_suggestion":"CAAQIBomEiQzNGRmZjA2ZS0yNTViLTQ3NjUtYmJmYi00M2EwOGEzYmI4MjkoATIA", - "ac_state":null - }, - { - "metadata":{ - }, - "internal":{ - }, - "type":"text", - "text":"The total sales of jackets has already been visualized for you.\n\n**Summary & Insights:**\n- The result represents the overall sales amount specifically for the item type \"jackets\".\n- This metric is useful for understanding the revenue contribution of jackets within your apparel product portfolio.\n- You can use this figure to benchmark jacket performance against other item types, evaluate promotional effectiveness, or inform inventory decisions.\n\nIf you’d like a breakdown by region, store, or time period, just let me know!", - "agent_context":"" - } - ], - "__args":{ - "conversation_identifier":"IrnWPL1NFc6H", - "messages":[ - "total sales of jackets" - ] - } -} ----- - -The session ID and generation number serve as the data context for the Answer. You can use this information to create a new conversation session using `/api/rest/2.0/ai/agent/conversation/create`, or download the answer via the `/api/rest/2.0/report/answer` API endpoint. - -[#process_results] -== Processing results generated from Spotter APIs -To export or download the Answer data generated by the Spotter APIs, use the xref:data-report-v2-api.adoc#exportSpotterData[Answer report] API. - -[NOTE] -==== -Using tokens generated by the Spotter API in a xref:data-report-v2-api.adoc#_search_data_api[Search Data API] request can return invalid column errors, because these tokens may reference formulas or columns not present in the data model. Instead, use the xref:data-report-v2-api.adoc#exportSpotterData[Answer report] API and include the session ID and generation number obtained from the Spotter API in your API request to retrieve the data. -==== - -== Data literacy and query assistance -The query assistance APIs help users find the appropriate dataset for a given query string, suggest what questions can be asked, and return example questions. These APIs are specifically designed to improve data literacy for users who may not be familiar with the underlying data, making it easier for them to explore and analyze data effectively. - -=== Get data source suggestions - -The `POST /api/rest/2.0/ai/data-source-suggestions` API provides relevant data source recommendations for a user-submitted natural language query. To use this API, you must have at least view access to the underlying metadata object referenced in the response. - -==== Request parameters - -[width="100%" cols="2,4"] -[options='header'] -|==== -|Parameter| Description -|`metadata_context` a| Required. Specify one of the following attributes to set the metadata context: - -* `data_source_identifiers` + -__Array of strings__. IDs of the data source object such as Models. -* `answer_identifiers` + -__Array of strings__. GUIDs of the Answer objects that you want to use as metadata. -* `conversation_identifier` + -__String__. ID of the conversation session. -* `liveboard_identifiers` + -__Array of strings__. GUIDs of the Liveboards that you want to use as metadata. - -| `query` |__String__. Required parameter. Specify the query string that needs to be decomposed into smaller, analytical sub-questions. -|`limit_relevant_questions` + -__Optional__ | __Integer__. Sets a limit on the number of sub-questions to return in the response. Default is 5. -|`bypass_cache` + -__Optional__| __Boolean__. When set to `true`, disables cache and forces fresh computation. -|`ai_context` + -__Optional__. a| Additional context to guide the response. Define the following attributes as needed: -|==== - -==== Example request - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/relevant-questions/' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' - --data-raw '{ - "metadata_context": { - "data_source_identifiers": [ - "cd252e5c-b552-49a8-821d-3eadaa049cca" - ] - }, - "query": "Net sales of Jackets in west coast", - "limit_relevant_questions": 3 -}' ----- - -==== API response -If the API request is successful, ThoughtSpot returns a ranked list of data sources, each annotated with relevant reasoning. - -[source,JSON] ----- -{ - "relevant_questions": [ - { - "query": "What is the trend of sales by type over time?", - "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", - "data_source_name": "(Sample) Retail - Apparel" - }, - { - "query": "Sales by item", - "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", - "data_source_name": "(Sample) Retail - Apparel" - }, - { - "query": "Sales across regions", - "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", - "data_source_name": "(Sample) Retail - Apparel" - } - ] -} ----- - -The returned results include metadata such as: - -* `confidence` + -A float indicating the Model's confidence in the relevance of each recommendation. -* `details` + -The data source ID, name, and description for each recommended data source. -* `reasoning` + -Reason provided by the LLM to explain why each data source was recommended. - -=== Get relevant questions - -The `/api/rest/2.0/ai/relevant-questions/` API endpoint breaks down a user-submitted query into relevant sub-questions. It accepts the original query and optional additional context, then generates a set of related questions to help users explore their data comprehensively. - -During agentic interactions, this API can be used as an integrated tool to decompose user queries and suggest relevant questions for a specific data context. REST clients can also call this API directly to fetch relevant questions via a `POST` request. - -==== Request parameters - -[width="100%" cols="2,4"] -[options='header'] -|===== -|Parameter| Description -|`metadata_context` a| Required. Specify one of the following attributes to set the metadata context: - -* `data_source_identifiers` + -__Array of strings__. IDs of the data source object such as Models. -* `answer_identifiers` + -__Array of strings__. GUIDs of the Answer objects that you want to use as metadata. -* `conversation_identifier` + -__String__. ID of the conversation session. -* `liveboard_identifiers` + -__Array of strings__. GUIDs of the Liveboards that you want to use as metadata. - -| `query` |__String__. Required parameter. Specify the query string that needs to be decomposed into smaller, analytical sub-questions. -|`limit_relevant_questions` + -__Optional__ | __Integer__. Sets a limit on the number of sub-questions to return in the response. Default is 5. -|`bypass_cache` + -__Optional__| __Boolean__. When set to `true`, disables cache and forces fresh computation. -|`ai_context` + -__Optional__. a| Additional context to guide the response. Define the following attributes as needed: - -* `instructions` + -__Array of strings__. Custom user instructions to influence how the AI interprets and processes the query. -* `content` + -__Array of strings__. Additional input such as raw text or CSV-formatted data to enhance context and answer quality. -|===== - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/relevant-questions/' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' - --data-raw '{ - "metadata_context": { - "data_source_identifiers": [ - "cd252e5c-b552-49a8-821d-3eadaa049cca" - ] - }, - "query": "Net sales of Jackets in west coast", - "limit_relevant_questions": 3 -}' ----- - -==== Example response -If the request is successful, the API returns a set of questions related to the query and metadata context in the `relevant_questions` array. Each object in the `relevant_questions` array contains the following fields: - -* `query` + -A string containing the natural language (NL) sub-question. -* `data_source_identifier` + -GUID of the data source object. -* `data_source_name` + -Name of the associated data source object. - -[source,JSON] ----- -{ - "relevant_questions": [ - { - "query": "What is the trend of sales by type over time?", - "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", - "data_source_name": "(Sample) Retail - Apparel" - }, - { - "query": "Sales by item", - "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", - "data_source_name": "(Sample) Retail - Apparel" - }, - { - "query": "Sales across regions", - "data_source_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", - "data_source_name": "(Sample) Retail - Apparel" - } - ] -} ----- - -== NL instructions to coach Spotter -Administrators and data owners can guide and refine how Spotter interprets and answers user questions. The natural language (NL) instructions API allows setting instructions at the data model level. The API provides business context and preferred interpretations for specific queries or terminology to coach Spotter, but it does not train or change the underlying LLM. - -=== Set NL instructions -To coach and instruct the Spotter system on how to interpret queries, apply filters, select columns, handle data nuances, and present answers using the data from a specific model, you can set global rules in natural language format. Setting instructions helps Spotter generate precise and consistent responses for user queries. - -To set instructions for a Model, send a `POST` request to the `/api/rest/2.0/ai/instructions/set` API endpoint. - -[NOTE] -==== -To set NL instructions, you'll need administration or data management privileges, or at least edit access to the data Model. -==== - -==== Request parameters - -[width="100%" cols="2,4"] -[options='header'] -|===== -|Form parameter| Description -|`data_source_identifier`|__String__. ID of the Model. -|`nl_instructions_info` a|Instructions in the natural language format. - -* `instructions` + -_Array of strings_. Include the rules that you want to add in the `ìnstructions` array. Ensure that the instructions do not exceed 3000 characters. -* `scope` -Sets the scope for the rules. By default, the rules are applied globally for all Spotter users who can access the Model specified in the request. -|===== - -==== Example request - -The following example defines instructions to coach Spotter on how to interpret the query: - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/instructions/set' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN} \ - --data-raw '{ - "data_source_identifier": "71311827-31bb-48b2-8465-9a215adbc05d", - "nl_instructions_info": [ - { - "instructions": [ - "When I ask for last month, use ‘last 30 days’ as a filter.", - "Exclude orders where order_status = '\''CANCELLED-USER'\'' when calculating total revenue" - ], - "scope": "GLOBAL" - } - ] -}' ----- - -==== Example response -If the API request is successful, ThoughtSpot returns the `{"success":true}` response. - -=== Retrieve NL instructions assigned to a Model - -To view the NL instructions assigned for a Model, send a `POST` request to the `/api/rest/2.0/ai/instructions/get` API endpoint. - -Only Spotter users with view access to the data model can retrieve instructions via API requests. - -==== Request parameters - -[width="100%" cols="2,4"] -[options='header'] -|===== -|Form parameter| Description -|`data_source_identifier`|__String__. ID of the Model from which you want to fetch instructions. -|===== - -==== Example request -The following example shows the request body for retrieving NL instructions configured on a Model: - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/instructions/set' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN} \ - --data-raw '{ - "data_source_identifier": "3bbeac16-a723-4886-9eba-c4779d07fd83" -}' ----- - -==== Example response -If the instructions are configured on the Model specified in the API request, ThoughtSpot returns an array of instructions in the API response. - -[source,JSON] ----- -{ - "nl_instructions_info": [ - { - "instructions": [ - "When I ask for last month, use ‘last 30 days’ as a filter.", - "Exclude orders where order_status = 'CANCELLED-USER' when calculating total revenue" - ], - "scope": "GLOBAL" - } - ] -} ----- - -== Spotter coaching access - -ThoughtSpot supports publishing Spotter coaching information to other Orgs.Coaching changes from the primary Org are synchronized with the data models published in secondary Orgs. - -=== Assign Spotter coaching access privilege - -To allow users and groups to access spotter coaching information in data models, assign the `SPOTTER_COACHING_PRIVILEGE` via `POST` request to the `/api/rest/2.0/security/metadata/manage-object-privilege` API endpoint. - -In the API request, specify the data model, user, group, and ensure that the object privilege is set to `SPOTTER_COACHING_PRIVILEGE`. - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/security/metadata/manage-object-privilege' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' \ - --data-raw '{ - "operation": "ADD", - "metadata_type": "LOGICAL_TABLE", - "object_privilege_types": [ - "SPOTTER_COACHING_PRIVILEGE" - ], - "metadata_identifiers": [ - "62f3e9b5-4fcc-4352-b8ad-fdddc2287506" - ], - "principals": [ - { - "identifier": "UserA", - "type": "USER" - } - ] -}' ----- - -If the request is successful, the API returns the 204 response code. - -=== Get a list of users or groups with Spotter coaching privilege - -To get a list of users and groups with the Spotter coaching privilege for a specific data model or all data models, send a `POST` request to the `/api/rest/2.0/security/metadata/fetch-object-privileges` API endpoint. - -In the API request, specify the user or the group for which you want to retrieve the object privilege details. - - -[source,cURL] ----- -curl -X POST \ - --url 'https://{ThoughtSpot-Host}/api/rest/2.0/security/metadata/fetch-object-privileges' \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'Authorization: Bearer {AUTH_TOKEN}' \ - --data-raw '{ - "metadata": [ - { - "identifier": "53141e3b-331d-4a74-80a2-e4322f9d8339", - "type": "LOGICAL_TABLE" - } - ], - "record_offset": 0, - "record_size": 20, - "principals": [ - { - "identifier": "UserA", - "type": "USER" - } - ] -}' ----- - -If the request is successful, ThoughtSpot returns the object privilege details in the API response: - -[source,JSON] ----- -{ - "metadata_object_privileges":[ - { - "metadata_id":"53141e3b-331d-4a74-80a2-e4322f9d8339", - "metadata_name":"Model_formula_variable", - "metadata_type":"WORKSHEET", - "principal_object_privilege_info":[ - { - "principal_type":"USER", - "principal_object_privileges":[ - { - "principal_id":"0000083e-e253-10af-aa97-5e45d512ebbd", - "principal_name":"rani.gangwar@thoughtspot.com", - "principal_sub_type":"OIDC_USER", - "object_privileges":"[SPOTTER_COACHING_PRIVILEGE]" - } - ] - } - ] - } - ] -} ----- - == Additional resources * Visit the +++REST API v2.0 Playground+++ to view the API endpoints and verify the request and response workflows. -* For information about MCP tools, see xref:mcp-integration.adoc[MCP server integration]. +* For information about embedding Spotter in your app, see xref:embed-spotter.adoc[Embed Spotter]. +* For information about MCP server, see xref:mcp-integration.adoc[MCP server integration]. diff --git a/modules/ROOT/pages/spotter-classic-apis.adoc b/modules/ROOT/pages/spotter-classic-apis.adoc new file mode 100644 index 000000000..0b93fc5f2 --- /dev/null +++ b/modules/ROOT/pages/spotter-classic-apis.adoc @@ -0,0 +1,264 @@ += AI APIs (Spotter Classic) +:toc: true +:toclevels: 2 + +:page-title: Spotter APIs +:page-pageid: spotter-apis-classic +:page-description: You can use Spotter REST APIs to receive Answers for your analytical queries sent through the conversational experience with ThoughtSpot. + +This document describes how to use AI APIs with Spotter Classic to query and explore data through conversational interactions. +For information about APIs for agent interactions, see xref:spotter-agent-apis.adoc[Spotter Agent APIs]. + + +== Overview +The key capabilities of the Spotter APIs include the following: + +* Initiating and managing conversational sessions +* Processing natural-language queries and interpreting user intent +* Generating analytical responses, insights, and visualizations for user queries. +//* Recommending relevant datasets or data sources +//* Decomposing complex user queries + +In the Spotter classic mode, the conversation session and context is managed by Spotter. The APIs allow users to interact directly with Spotter with no specific agentic capabilities or framework. + +=== Locale settings for API requests + +When using the xref:spotter-classic-apis.adoc#_generate_a_single_answer[Single Answer] and xref:spotter-classic-apis.adoc#_send_a_query_to_a_conversation_session[Send message] APIs, the locale used for API requests depends on your application's locale settings: + +* If your application is set to "Use browser language," the API will not apply the default locale. In this case, you must explicitly include the desired locale code in the `Accept-Language` header of your API request. If you do not specify the locale, the API may not return responses in the expected language or regional format. +* If you have set a specific locale in your ThoughtSpot instance or user profile, the API will use this locale to generate responses, overriding the browser or OS locale. + +To ensure consistent localization, set the `Accept-Language` header in your API requests when relying on browser language detection, or configure the locale explicitly in the user profile settings in ThoughtSpot. + +=== API endpoints +Each of the Spotter AI APIs serves a specific function: + +[width="100%" cols="1"] +[options='header'] +|===== +a| `POST /api/rest/2.0/ai/conversation/create` [beta betaBackground]^Beta^ + + +xref:spotter-classic-apis.adoc#_create_a_conversation_session[Creates a conversation session] with Spotter to generate Answers from a specific data Model. The resulting session sets the context for subsequent queries and responses. + +a| `POST /api/rest/2.0/ai/conversation/{conversation_identifier}/converse` [beta betaBackground]^Beta^ + +Allows xref:spotter-classic-apis.adoc#_send_a_query_to_a_conversation_session[sending a message or follow-up query] to an ongoing conversation session. + +a| `POST /api/rest/2.0/ai/answer/create` + +xref:spotter-classic-apis.adoc#_generate_a_single_answer[Generates an answer] for a natural language query specified in the API request. +|===== + +== Create a conversation session +To create a conversation session with Spotter, send a `POST` request to the `/api/rest/2.0/ai/conversation/create` API endpoint. The resulting conversation session maintains the context and can be used to send queries and follow-up questions to generate answers. + +=== Request parameters +Include the following parameters in the request body: + +[width="100%" cols="2,4"] +[options='header'] +|===== +|Form parameter|Description +|`metadata_identifier`|_String_. Required. Specify the GUID of the data source objects such as ThoughtSpot Models. The metadata object specified in the API request will be used as a data source for the conversation. +|`tokens` + +__Optional__ a|_String_. To set the context for the conversation, you can specify a set of keywords as token string. For example, `[sales],[item type],[state]`. +|===== + +=== Example requests + +==== With tokens +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/conversation/create' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "metadata_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", + "tokens": "[sales],[item type],[Jackets]" +}' +---- + +==== Without tokens + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/conversation/create' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "metadata_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca" +}' +---- + +=== API response + +If the API request is successful, a conversation identifier is created. Note the GUID of the conversation and use it when sending follow-up queries. + +[source,JSON] +---- +{"conversation_identifier":"98f9b8b0-6224-4f9d-b61c-f41307bb6a89"} +---- + +== Send a query to a conversation session +To send a question to an ongoing conversation session or ask follow-up questions, send a `POST` request body with conversation ID and query text to the `POST /api/rest/2.0/ai/conversation/{conversation_identifier}/converse` API endpoint. + +This API endpoint supports only the conversation sessions created using the `POST /api/rest/2.0/ai/conversation/create` API call. + +=== Request parameters + +[width="100%" cols="2,2,4"] +[options='header'] +|===== +|Parameter|Type| Description +|`conversation_identifier`|Path parameter|__String__. Required. Specify the GUID of the conversation received from the xref:spotter-apis.adoc#_create_a_conversation_session[create conversation API call]. +|`metadata_identifier`|Form parameter|_String_. Required. Specify the GUID of the data source object, for example, Model. The metadata object specified in the API request will be used as a data source for the follow-up conversation. +|`message`|Form parameter|_String_. Required. Specify a natural language query string. For example, `Sales data for Jackets`. +|===== + +=== Example request + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/conversation/03f48527-b973-4efa-81fd-a8568a4f9e78/converse' \ + -H 'Accept: application/json' \ + -H 'accept-language: en-US' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "metadata_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", + "message": "Top performing products in the west coast" +}' +---- + +=== API response + +If the API request is successful, the following data is sent in the API response: + +* `session_identifier` + +GUID of the Answer session. +* `generation_number` + +Number assigned to the Answer session. +* `message_type` + +Type of response received for the query. For example, `TSAnswer` (ThoughtSpot Answer). +* `visualization_type` + +The data format of the generated Answer, for example, a chart or table. When you download this Answer, the data will be exported in the format indicated by the `visualization_type`. +* `tokens` + +Tokens generated from the natural language search query specified in the API request. These tokens can be used as input to the `/api/rest/2.0/ai/conversation/create` API endpoint to set the context for a conversation session. + +[NOTE] +==== +Note the session ID and generation number. To export the Answer generated from this conversation, send these attributes in the `POST` request body to the `/api/rest/2.0/report/answer` endpoint. +==== + +[source,JSON] +---- +[ + { + "session_identifier": "1290f8bc-415a-4ecb-ae3b-e1daa593eb24", + "generation_number": 3, + "message_type": "TSAnswer", + "visualization_type": "Chart", + "tokens": "[sales], [state], [item type], [region] = [region].'west', sort by [sales] descending" + } +] +---- + +=== Ask follow-up questions + +The API retains the context of previous queries when you send follow-up questions. To verify this, you can send another API request with a follow-up question to drill down into the data. + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/conversation/03f48527-b973-4efa-81fd-a8568a4f9e78/converse' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "metadata_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca", + "message": "which city has the better sales of jackets here?" +}' +---- + +The API retains the context of the initial question and returns a response: + +[source,JSON] +---- +[ + { + "session_identifier": "ee077665-08e1-4a9d-bfdf-7b2fe0ca5c79", + "generation_number": 3, + "message_type": "TSAnswer", + "visualization_type": "Table", + "tokens": "[sales], by [city], [state], [item type] = [item type].'jackets', [region] = [region].'west', sort by [sales] descending" + } +] +---- + +== Generate a single Answer +To generate an Answer from a natural language search query, send a `POST` request to the `/api/rest/2.0/ai/answer/create` API endpoint. In the request body, include the query and the data source ID. + +=== Request parameters + +[width="100%" cols="2,4"] +[options='header'] +|===== +|Form parameter| Description +|`query`|__String__. Required. Specify the string as a natural language query. For example, `Top performing products in the west coast`. +|`metadata_identifier`|_String_. Required. Specify the GUID of the data source object, for example, Model. The metadata object specified in the API request will be used as the data source for generating the Answer. +|===== + +=== Example request +In the following example, a query string and the model ID are included in the request body to generate the Answer. + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/answer/create' \ + -H 'Accept: application/json' \ + -H 'accept-language: en-US' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "query": "Top performing products in the west coast", + "metadata_identifier": "cd252e5c-b552-49a8-821d-3eadaa049cca" +}' +---- + +=== API response + +If the API request is successful, the following data is sent in the API response: + +* `session_identifier` + +GUID of the Answer session. +* `generation_number` + +Number assigned to the Answer session. +* `message_type` + +Type of response received for the query. For example, `TSAnswer` (ThoughtSpot Answer). +* `visualization_type` + +The data format of the generated Answer; for example, a chart or table. When you download this Answer, the data will be exported in the format indicated by the `visualization_type`. +* `tokens` + +Tokens generated from the natural language search query specified in the API request. These tokens can be used as input to the `/api/rest/2.0/ai/conversation/create` endpoint to set the context for a conversation session. + +[NOTE] +==== +Note the session ID and generation number. To export the result generated from this API call, send these attributes in the `POST` request body to the `/api/rest/2.0/report/answer` endpoint. +==== + +[source,JSON] +---- +[{ + "session_identifier": "57784fa1-10fa-431d-8d82-a1657d627bbe", + "generation_number": 2, + "message_type": "TSAnswer", + "visualization_type": "Undefined", + "tokens": "[product], [region] = [region].'west', sort by [sales] descending" +}] +---- + +== Additional resources + +Visit the +++REST API v2.0 Playground+++ to verify the request and response workflows. diff --git a/modules/ROOT/pages/spotter-in-custom-chatbot.adoc b/modules/ROOT/pages/spotter-in-custom-chatbot.adoc deleted file mode 100644 index 04c01d17e..000000000 --- a/modules/ROOT/pages/spotter-in-custom-chatbot.adoc +++ /dev/null @@ -1,68 +0,0 @@ -== Integrating Spotter into your own Chatbot - -In this article we will use ThoughtSpot's https://github.com/thoughtspot/visual-embed-sdk[visual embed SDK] to add analytics and interactive data visualizations to your own chatbot. The full code written below is available at https://codesandbox.io/p/sandbox/bodyless-sample-doc-5q3dwr[codesanbox]. - -=== Install Visual embed SDK - - $ npm i @thoughtspot/visual-embed-sdk - -=== Configure security and authentication - -. Allowlist the application which will embed thoughtspot visualizations. Basically adding the correct CORS and frame-ancestors CSP. More details on how to do that https://developers.thoughtspot.com/docs/security-settings[here]. -. Configure the authentication scheme which works best for your use case. Read https://developers.thoughtspot.com/docs/embed-auth[this guide], to help you choose. For the purpose of this article we will use `AuthType.None` and assume you are logged into your instance in a different Tab, as setting up the other scehmes are covered in https://developers.thoughtspot.com/docs/embed-auth[this article]. - -=== Get the data model - -For this guide we assume that you have already connected your database, and created a ThoughtSpot data model. Please log into your instance to get the `id` of the model you want to use. In this article we use a https://try-everywhere.thoughtspot.cloud/#/everywhere[demo] Thoughtspot instance with a sample data model. - -=== Initialize the SDK - -[,js] ----- -import { - SpotterAgentEmbed, - init, - AuthType, -} from "@thoughtspot/visual-embed-sdk"; - -init({ - thoughtSpotHost: "https://.thoughtspot.cloud", - authType: AuthType.None, // Or your authentication scheme. -}); ----- - -=== Create a new conversation - -To use the spotter conversational analytics, you start by creating a new conversation. This conversation holds the context to all messages sent to ThoughtSpot by your bot. This enables a truly conversational experience for your users. - -[,js] ----- -const conversation = new SpotterAgentEmbed({ - // ID of the data source object - worksheetId: "", - }); ----- - -=== Send messages and get interactive visualizations in response - -Once you have a conversation, you would use it to send user messages to ThoughtSpot Spotter AI which will evaluate and generate data on your data model and send back the visualization. - -[,js] ----- -// Get the response from ThoughtSpot Spotter -const { container } = await conversation.sendMessage(message); - -// Create a new DOM element, to host the visualization returned above. -const div = document.createElement("div"); - -// Add any styling you might want to this element. -div.classList.add("viz"); -// Add the container of the visualization as contents to this dom element. -div.append(container); -// insert the DOM into your application. -app.insertAdjacentElement("beforeend", div); ----- - -=== That's all folks! - -And, thats it! Super quick start on how to leverage Spotter embed APIs to integrate with your own chatbot. Look at the full https://codesandbox.io/p/sandbox/bodyless-sample-doc-5q3dwr[codesandbox] to see it in action in a dummy chatbot we created. diff --git a/modules/ROOT/pages/spotter-nl-instructions.adoc b/modules/ROOT/pages/spotter-nl-instructions.adoc new file mode 100644 index 000000000..4a278c469 --- /dev/null +++ b/modules/ROOT/pages/spotter-nl-instructions.adoc @@ -0,0 +1,211 @@ += Spotter coaching APIs +:toc: true +:toclevels: 2 + +:page-title: Spotter APIs +:page-pageid: spotter-coaching-apis +:page-description: You can use Spotter REST APIs to receive Answers for your analytical queries sent through the conversational experience with ThoughtSpot. + +Administrators and data owners can guide and refine how Spotter interprets and answers user questions. The natural language (NL) instructions API allows you to set instructions at the data model level. The API provides business context and preferred interpretations for specific queries or terminology to coach Spotter, but it does not train or change the underlying LLM. + +== Set NL instructions +To coach and instruct the Spotter system on how to interpret queries, apply filters, select columns, handle data nuances, and present answers using the data from a specific model, you can set global rules in natural language format. Setting instructions helps Spotter generate precise and consistent responses for user queries. + +To set instructions for a Model, send a `POST` request to the `/api/rest/2.0/ai/instructions/set` API endpoint. + +[NOTE] +==== +To set NL instructions, you need administration or data management privileges, or at least edit access to the data Model. +==== + +=== Request parameters + +[width="100%" cols="2,4"] +[options='header'] +|===== +|Form parameter| Description +|`data_source_identifier`|__String__. ID of the Model. +|`nl_instructions_info` a|Instructions in the natural language format. + +* `instructions` + +_Array of strings_. Include the rules that you want to add in the `instructions` array. Ensure that the instructions do not exceed 3000 characters. +* `scope` +Sets the scope for the rules. By default, the rules are applied globally for all Spotter users who can access the Model specified in the request. +|===== + +=== Example request + +The following example defines instructions to coach Spotter on how to interpret the query: + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/instructions/set' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "data_source_identifier": "71311827-31bb-48b2-8465-9a215adbc05d", + "nl_instructions_info": [ + { + "instructions": [ + "When I ask for last month, use ‘last 30 days’ as a filter.", + "Exclude orders where order_status = '\''CANCELLED-USER'\'' when calculating total revenue" + ], + "scope": "GLOBAL" + } + ] +}' +---- + +=== Example response +If the API request is successful, ThoughtSpot returns the `{"success":true}` response. + +== Retrieve NL instructions assigned to a Model + +To view the NL instructions assigned for a Model, send a `POST` request to the `/api/rest/2.0/ai/instructions/get` API endpoint. + +Only Spotter users with view access to the data model can retrieve instructions via API requests. + +=== Request parameters + +[width="100%" cols="2,4"] +[options='header'] +|===== +|Form parameter| Description +|`data_source_identifier`|__String__. ID of the Model from which you want to fetch instructions. +|===== + +=== Example request +The following example shows the request body for retrieving NL instructions configured on a Model: + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/ai/instructions/get' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "data_source_identifier": "3bbeac16-a723-4886-9eba-c4779d07fd83" +}' +---- + +=== Example response +If the instructions are configured on the Model specified in the API request, ThoughtSpot returns an array of instructions in the API response. + +[source,JSON] +---- +{ + "nl_instructions_info": [ + { + "instructions": [ + "When I ask for last month, use ‘last 30 days’ as a filter.", + "Exclude orders where order_status = 'CANCELLED-USER' when calculating total revenue" + ], + "scope": "GLOBAL" + } + ] +} +---- + +== Spotter coaching access + +ThoughtSpot supports publishing Spotter coaching information to other Orgs. Coaching changes from the primary Org are synchronized with the data models published in secondary Orgs. + +=== Assign Spotter coaching access privilege + +To allow users and groups to access spotter coaching information in data models, assign the `SPOTTER_COACHING_PRIVILEGE` via `POST` request to the `/api/rest/2.0/security/metadata/manage-object-privilege` API endpoint. + +In the API request, specify the data model, user, and group, and ensure that the object privilege is set to `SPOTTER_COACHING_PRIVILEGE`. + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/security/metadata/manage-object-privilege' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "operation": "ADD", + "metadata_type": "LOGICAL_TABLE", + "object_privilege_types": [ + "SPOTTER_COACHING_PRIVILEGE" + ], + "metadata_identifiers": [ + "62f3e9b5-4fcc-4352-b8ad-fdddc2287506" + ], + "principals": [ + { + "identifier": "UserA", + "type": "USER" + } + ] +}' +---- + +If the request is successful, the API returns the 204 response code. + +=== Get a list of users or groups with Spotter coaching privilege + +To get a list of users and groups with the Spotter coaching privilege for a specific data model or all data models, send a `POST` request to the `/api/rest/2.0/security/metadata/fetch-object-privileges` API endpoint. + +In the API request, specify the user or the group for which you want to retrieve the object privilege details. + + +[source,cURL] +---- +curl -X POST \ + --url 'https://{ThoughtSpot-Host}/api/rest/2.0/security/metadata/fetch-object-privileges' \ + -H 'Accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {AUTH_TOKEN}' \ + --data-raw '{ + "metadata": [ + { + "identifier": "53141e3b-331d-4a74-80a2-e4322f9d8339", + "type": "LOGICAL_TABLE" + } + ], + "record_offset": 0, + "record_size": 20, + "principals": [ + { + "identifier": "UserA", + "type": "USER" + } + ] +}' +---- + +If the request is successful, ThoughtSpot returns the object privilege details in the API response: + +[source,JSON] +---- +{ + "metadata_object_privileges":[ + { + "metadata_id":"53141e3b-331d-4a74-80a2-e4322f9d8339", + "metadata_name":"Model_formula_variable", + "metadata_type":"WORKSHEET", + "principal_object_privilege_info":[ + { + "principal_type":"USER", + "principal_object_privileges":[ + { + "principal_id":"0000083e-e253-10af-aa97-5e45d512ebbd", + "principal_name":"rani.gangwar@thoughtspot.com", + "principal_sub_type":"OIDC_USER", + "object_privileges":"[SPOTTER_COACHING_PRIVILEGE]" + } + ] + } + ] + } + ] +} +---- + +== Additional resources + +* Visit the +++REST API v2.0 Playground+++ to view the API endpoints and verify the request and response workflows. +* For information about MCP tools, see xref:mcp-integration.adoc[MCP server integration]. diff --git a/modules/ROOT/pages/spottercode-integration.adoc b/modules/ROOT/pages/spottercode-integration.adoc index f213c0bfc..386f231c9 100644 --- a/modules/ROOT/pages/spottercode-integration.adoc +++ b/modules/ROOT/pages/spottercode-integration.adoc @@ -170,10 +170,3 @@ video::./images/cursor-lb-embed.mp4[width=100%,options="autoplay,loop"] * `additionalDocs` - To include more documentation for extra context, such as Java or TypeScript SDK guidance. //// - - - - - - - diff --git a/modules/ROOT/pages/variables.adoc b/modules/ROOT/pages/variables.adoc index 025beb6ca..a5d4ce38b 100644 --- a/modules/ROOT/pages/variables.adoc +++ b/modules/ROOT/pages/variables.adoc @@ -55,7 +55,6 @@ xref:variables.adoc#_delete_a_variable[Deletes the variables] specified in the A * Variable APIs for creating, deleting, searching, and assigning values can only be used by the ThoughtSpot instance administrator. * These APIs can only be used from the primary Org. ==== - //// [NOTE] ==== diff --git a/modules/ROOT/pages/webhooks-comm-channel.adoc b/modules/ROOT/pages/webhooks-comm-channel.adoc index 50442d032..ad7ce839c 100644 --- a/modules/ROOT/pages/webhooks-comm-channel.adoc +++ b/modules/ROOT/pages/webhooks-comm-channel.adoc @@ -1,4 +1,4 @@ -= Configure, validate and monitor communication channels += Configure and monitor communication channels :toc: true :toclevels: 3 diff --git a/modules/ROOT/pages/whats-new-prev-history.adoc b/modules/ROOT/pages/whats-new-prev-history.adoc new file mode 100644 index 000000000..e2661ee2c --- /dev/null +++ b/modules/ROOT/pages/whats-new-prev-history.adoc @@ -0,0 +1,2599 @@ += What’s new +:toc: true +:toclevels: 1 + +:page-title: What's new +:page-pageid: whats-new-prev-releases +:page-description: New features and enhancements + +This page lists new features, enhancements, and deprecated functionality introduced for ThoughtSpot Embedded instances in release versions before the year 2026. For information about the features introduced in the new release versions in 2026, see xref:whats-new.adoc[What's new]. + +== Version 10.15.0.cl + +.Theme Builder +[%collapsible] +==== +Theme Builder is now generally available (GA) and will be rolled out to all ThoughtSpot instances in customer deployments over the next few weeks. + +When this feature is enabled on your instance, you can access it from the *Develop* page in ThoughtSpot and use it to customize styles and UX themes directly within the product. + +For more information, see xref:theme-builder.adoc[Theme Builder]. +==== + +.V3 navigation and home page experience +[%collapsible] +==== +The new V3 navigation and home page experience is now generally available (GA) and can be enabled on ThoughtSpot embedded instances. + +The default UI experience in full application embedding remains the classic (V1) experience until further notice. Developers embedding the full ThoughtSpot application can enable the V3 experience in their applications by setting the appropriate configuration options in their embed code. + +For more information, see xref:full-app-customize.adoc[Customizing full application embedding]. +==== + +.Formula variables in RLS rules +[%collapsible] +==== +You can now create formula variables using the Variable REST API and use these variables in RLS rules for a specific data context and in ABAC token requests to dynamically assign security attributes to users. + +For more information, see xref:abac_rls-variables.adoc[ABAC via RLS with variables]. +==== +.Spotter APIs +[%collapsible] +==== +ThoughtSpot introduces new REST APIs for the following Spotter workflows: +//* To get data source suggestions based on a user's query +* To send queries to a conversation session with the Spotter agent +* To set natural language (NL) instructions on a model to coach the Spotter system +* To fetch NL instructions configured on a model + +For more information, see xref:spotter-apis.adoc[Spotter APIs]. +==== +.Embed events and parameters to intercept API calls +[%collapsible] +==== +You can now intercept API calls from the embedded ThoughtSpot application using the `interceptUrls` attribute in the Visual Embed SDK. This feature lets you control API requests in your embedding application and use embed events to modify, block, or handle requests before they are sent to the backend. For more information, see xref:api-intercept.adoc[Intercept API calls and search requests]. +==== +.Icon customization enhancements +[%collapsible] +==== +You can now replace or customize the chart switcher toggle and icons in the Charts drawer on an Answer or visualization page using SVG sprites. Previously, these icons were fixed to ThoughtSpot defaults and were not configurable. In the new version, these icons are available as SVG components and can be replaced by developers through the xref:customize-icons.adoc[icon customization framework] as needed. +==== +.Mobile Embed SDK +[%collapsible] +==== +The SDKs for embedding ThoughtSpot components in mobile apps are now Generally Available (GA). For more information about the SDKs and how to embed a ThoughtSpot component in a mobile app, see xref:mobile-embed.adoc[Mobile embed documentation]. +==== +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.44.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== +.REST API +[%collapsible] +==== +For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 10.14.0.cl + +.Code based custom actions +[%collapsible] +==== +ThoughtSpot now enables developers to define custom action in their embed code through the Visual Embed SDK. This enhancement enables code based customization of actions for Liveboards, Visualizations, Answers, and Spotter. With this functionality, developers can add custom actions that show up as new menu options in one of the following UI elements: + +* the primary menu bar +* the **More** options menu image:./images/icon-more-10px.png[the more options menu] +* the contextual menu that appears when a user right-clicks on an Answer or visualization + + +Key characteristics of code-based custom actions: + +* Can be maintained within your codebase to facilitate migration across organizations and clusters. +* Can have controlled visibility in ThoughtSpot by evaluating conditions within your application logic. This approach enables you to dynamically display or hide custom actions based on specific criteria, ensuring that only relevant actions are presented to users in different contexts. +* Can be assigned to Liveboards. +* Can be conditionally displayed based on the presence of a specific column in a visualization. + +For more information, see xref:code-based-custom-actions.adoc[Code based custom actions]. +==== + +.Webhooks for Liveboard schedule events [beta betaBackground]^Beta^ +[%collapsible] +==== +You can now configure a xref:webhooks-lb-schedule.adoc[webhook for Liveboard schedule events] to automate notifications to external applications. This feature allows you to send Liveboard reports directly to a webhook endpoint and create your own custom emails or workflow. + +This feature is currently in beta and is not enabled by default. To enable it on your instance, contact ThoughtSpot Support. +==== + +=== Template variables for publishing +The variable APIs include several enhancements to streamline variable creation and update workflows. +For information about the new enhancements and breaking changes, see xref:rest-apiv2-changelog.adoc#_variable_api_enhancements[REST API changelog] and xref:variables.adoc[Variables documentation]. + +.Parameter chip visibility configuration [tag redBackground]#BREAKING CHANGE# +[%collapsible] +==== +The `HostEvent.UpdateParameters` event in the Visual Embed SDK now includes the `isVisibleToUser` attribute, which allows you to control the visibility of Parameter chips on embedded ThoughtSpot pages. + +Before this enhancement, the Parameter chip display behavior was inconsistent across embed types when the Parameter values were updated via `HostEvent.UpdateParameters` requests. With the new change, the `isVisibleToUser` attribute in `HostEvent.UpdateParameters` is set to `false` by default for all embed types. + +With the new enhancement, the embedded pages that previously kept the parameter chip visible after an override via `HostEvent.UpdateParameters` will now hide it unless the `isVisibleToUser` attribute is explicitly set to `true`. + +This behavior may introduce a breaking change if your current implementation relies on the previous default chip visibility behavior. To retain chip visibility, developers must update their embedding implementation to pass `isVisibleToUser: true` in their `HostEvent.UpdateParameters` requests. + +For more information, see xref:runtime-parameters.adoc#_show_or_hide_parameter_chips_in_embedded_sessions[Runtime Parameter overrides]. +==== +.Pre-rendering enhancements +[%collapsible] +==== +Pre-rendering now provides enhanced flexibility and granular control over for rendering embedded ThoughtSpot components. For more information, see xref:prerender.adoc[Pre-rendering ThoughtSpot Embed components]. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.43.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== +.REST API +[%collapsible] +==== +For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 10.13.0.cl + +.Spotter AI APIs +[%collapsible] +==== +ThoughtSpot introduces the following new xref:spotter-apis.adoc[Spotter AI APIs] [beta betaBackground]^Beta^, to provide contextual and agentic capabilities for integration with external clients and custom AI applications: + +* `/api/rest/2.0/ai/agent/conversation/create` +//* `/api/rest/2.0/ai/data-source-suggestions` +* `/api/rest/2.0/ai/relevant-questions/` +* `/api/rest/2.0/ai/agent/converse/sse` + +These APIs are designed to build context with each interaction, orchestrate reasoning, and expose tools and skills for natural language analytics. + +For more information, see xref:spotter-apis.adoc[Spotter AI APIs]. + +//// +With the introduction of these APIs, the following legacy API endpoints will be deprecated: + +* `POST /api/rest/2.0/ai/conversation/create` +* `POST /api/rest/2.0/ai/conversation/{conversation_identifier}/converse` +* `POST /api/rest/2.0/ai/analytical-questions` + +The above-listed AI endpoints will be available in the Playground until further notice. However, we recommend using the new APIs for better context management, extensibility, and integration options. +//// +==== + +.Support for runtime overrides in Spotter embed +[%collapsible] +==== +You can apply runtime filters and parameter overrides to Spotter sessions and interactions using the Visual Embed SDK. When these overrides are configured in the SDK, they are applied to the data used for Spotter queries, and the generated answers in these sessions will reflect the applied overrides. + +The Visual Embed SDK Playground for Spotter embedding includes an option to set runtime overrides. You can test and preview the results before updating your embed code. + +For more information, see xref:runtime-filters.adoc[Runtime filters] and xref:runtime-parameters.adoc[Runtime Parameters]. +==== + +.Full application embed experience +[%collapsible] +==== +* The new experience with a sliding navigation panel and modular home page is now available as an Early Access feature for ThoughtSpot embedded application users. ++ +The new experience introduces a left navigation panel with a persona-based app selector and a modular home page with customizable components. This feature is turned off by default on ThoughtSpot. If this feature is enabled on your instance, you can enable it in full application embed using the `discoveryExperience` SDK property. ++ +For more information, see xref:full-app-customize.adoc[V3 navigation and home page experience]. + +* List pages, such as Answers and Liveboards, now include enhanced sorting and filtering capabilities. These pages also allow users to organize, find, and personalize content. Developers can customize the visibility of columns in their embeds by configuring the xref:AppViewConfig.adoc#_hiddenlistcolumns[`hiddenListColumns`] property in the SDK. ++ +For more information, see xref:full-app-customize.adoc#_hide_columns_on_list_pages_new_experience[Hide columns on List pages]. +==== + +.Worksheet deprecation and removal +[%collapsible] +==== +Worksheets are replaced with Models, and all application workflows will require you to use Models. If you are importing worksheet TMLs, the import operation may fail with an error, requiring users to convert Worksheets to Models. Please update your CI/CD and Git workflows to use Model TMLs instead of Worksheets. + +For more information, see xref:deprecated-features.adoc#_worksheet_deprecation_and_removal[Worksheet deprecation]. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.42.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 10.12.0.cl + +.Liveboard grouping and styling [beta betaBackground]^Beta^ +[%collapsible] +==== +You can now create a visual group of Answers and note tiles on an embedded Liveboard and customize the look and feel of the Liveboard, groups, and visualizations using the new styling panel. + +The Liveboard styling and grouping feature is disabled by default on embedded apps. To enable this feature on your embed, set `isLiveboardStylingAndGroupingEnabled` to `true` in the SDK and contact ThoughtSpot Support. + +[NOTE] +The `isLiveboardStylingAndGrouping` attribute is now replaced with `isLiveboardMasterpiecesEnabled`. + +When this feature is enabled, you can use the following CSS variables in the Visual Embed SDK to style your Liveboard elements: + +* `--ts-var-liveboard-layout-background` +* `--ts-var-liveboard-group-background` +* `--ts-var-liveboard-group-title-font-color` +* `--ts-var-liveboard-group-border-color` +* `--ts-var-liveboard-group-description-font-color` +* `--ts-var-liveboard-group-tile-title-font-color` +* `--ts-var-liveboard-group-tile-description-font-color` + +For more information, see xref:customize-css-styles.adoc#grp-style[CSS variables reference]. +==== +.Lazy loading of visualizations on a Liveboard +[%collapsible] +==== +To optimize initial load time, you can now enable lazy loading of Liveboard visualizations using the `lazyLoadingForFullHeight` parameter. When both `fullHeight` and `lazyLoadingForFullHeight` attributes are set to `true`, visualizations in the embedded Liveboard are loaded incrementally as the user scrolls, rather than all at once on initial load. For more information, see xref:lazy-loading-fullheight.adoc[Lazy loading of Liveboard visualizations]. +==== + +.Spotter embed enhancements +[%collapsible] +==== +Spotter coaching:: +Your application users can now coach Spotter based on an ongoing conversation. +The *Add to coaching* feature is turned off by default on ThoughtSpot instances. To enable this feature, contact your administrator. + +Spotter Agent embedding:: +To embed Spotter Agent in a React app, the SDK provides a React component and the `useSpotterAgent` custom React hook. For more information, see xref:embed-ts-react-app.adoc#_embed_spotter_agent_in_your_own_app[Embed Spotter Agent in your React app]. + +For information about the other SDK enhancements, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.Full application embed +[%collapsible] +==== +In full application embed, developers can now enable the new navigation panel and home page experience. The new experience also organizes the application menu into separate persona-based contextual sections. The new interface also provides a slider to allow users to view or hide the left navigation panel. + +The new navigation experience is disabled by default and is available for Early Access. To enable this feature on your instance, contact your ThoughtSpot administrator and then configure the xref:AppViewConfig.adoc#_discoveryexperience[`discovery experience`] property in the SDK. +==== + +.REST API +[%collapsible] +==== +[discrete] +==== Connection configuration APIs +ThoughtSpot now supports multiple configurations per data Connection. This feature allows data engineers to define and manage several distinct Connection configurations under a single data Connection object in ThoughtSpot. This feature is available only for Snowflake, Databricks, and BigQuery Cloud Data Warehouses (CDW) connections. + +For more information, see xref:connection-config.adoc[Connection Configuration]. + +[discrete] +==== Custom calendar APIs + +You can now create and manage custom calendars for a given Connection object. For more information, see the API documentation in the REST API v2 Playground. For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. + +[discrete] +==== Other enhancements +For information about other REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.41.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +== Version 10.11.0.cl + +.Spotter embed enhancements +[%collapsible] +==== +Spotter embed now supports a comprehensive set of embed and host events that enable interaction between the embedded Spotter component and the host application. + +Developers can use these events to: + +* Listen for key Spotter user interactions and system events, such as downloads, edits, visual changes, and Spotter-specific query responses, by registering handlers for embed events. +* Trigger specific host events from the application to programmatically control actions such as starting a search, resetting the conversation, saving, downloading, and adding Spotter-generated Answers to a Liveboard. + +For a complete list of events, see the following pages: + +* xref:api-changelog.adoc[Visual Embed SDK changelog] +* xref:EmbedEvent.adoc[EmbedEvent] +* xref:HostEvent.adoc[HostEvent] +==== + +.Primary action configuration for Liveboard visualizations +[%collapsible] +==== +You can now override the action assigned to the primary button that appears on visualization tiles of an embedded Liveboard. The `primaryAction` parameter in the Visual Embed SDK allows developers to set that primary action for the embedded Liveboard visualizations. + +For more information, see xref:embed-actions.adoc#_override_default_primary_actions[Override default primary action]. +==== + +.Enhancements to the API response format for Liveboards +[%collapsible] +==== +The `liveboard_reponse_version` parameter in search metadata (`/api/rest/2.0/metadata/search`) REST API request now allows you to retrieve details of Liveboard tabs, visualizations, and filters in a structured format. + +For more information, see xref:rest-api-v2-metadata-search.adoc#_response_format_for_liveboards[Response format for Liveboard objects]. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.40.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 10.10.0.cl + +.Email customization per Org [beta betaBackground]^Beta^ +[%collapsible] +==== +ThoughtSpot embedded users can now customize their automated email notifications for each Org through REST APIs v2. You can customize features such as the company logo, style, and fonts, visibility of components in the template, and ThoughtSpot-specific content in notification emails, thus ensuring a consistent brand experience. + +For more information, see xref:customize-email-apis.adoc[Customize email template]. + +[NOTE] +These APIs are currently in beta and turned off by default on ThoughtSpot instances. To enable this feature on your instance, contact ThoughtSpot Support. +==== + +.Publishing content to Orgs [beta betaBackground]^Beta^ + +[%collapsible] +==== +The publishing feature enables administrators to publish objects from the Primary Org to other Orgs within a multi-tenant instance. This feature simplifies the deployment process for ThoughtSpot administrators, especially when the same object needs to be made available to multiple Orgs within an instance. It also eliminates the need to create duplicate copies of the object, thereby optimizing memory usage. + +The publishing feature includes a set of REST APIs that ThoughtSpot administrators can use to create and assign variables, parameterize properties of underlying data objects such as Connections and Tables per Org, and publish objects from the Primary Org to other Orgs on their instance. For more information, see xref:publishing-overview.adoc[Publishing content to Orgs]. + +[NOTE] +The publishing feature is in beta and turned off by default on ThoughtSpot instances. To enable this feature on your instance, contact ThoughtSpot Support. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.39.x, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 10.9.0.cl + +.String IDs for customizing text strings +[%collapsible] +==== +You can now customize a specific occurrence of a text string in the ThoughtSpot UI using string IDs. String IDs allow you to selectively and precisely override the visible text strings in the UI and prevent unintended text changes. + +For more information, see xref:customize-text-strings.adoc[Customize text strings]. +==== +.Mobile embed SDKs +[%collapsible] +==== +ThoughtSpot provides the following new SDKs to embed ThoughtSpot in mobile apps: + +* link:https://github.com/thoughtspot/flutter-embed-sdk[Flutter Embed SDK, window=_blank] [beta betaBackground]^Beta^ to embed ThoughtSpot content in a Flutter app +* link:https://github.com/thoughtspot/swift-embed-sdk[Swift Embed SDK, window=_blank] [beta betaBackground]^Beta^ to embed ThoughtSpot content in an iOS native app +* link:https://github.com/thoughtspot/android-embed-sdk[Android Embed SDK, window=_blank] [beta betaBackground]^Beta^ to embed ThoughtSpot content in an Android native app + +For more information and quickstart guides, see xref:mobile-embed.adoc[Mobile embed documentation]. +==== +.Spotter embed components +[%collapsible] +==== +The following Spotter embed components are now deprecated and replaced with new components: + +* `ConversationEmbed` + +Replaced with `SpotterEmbed` +* `ConversationViewConfig` + +Replaced with `SpotterEmbedViewConfig` +* `BodylessConversation` + +Replaced with `SpotterAgentEmbed` +* `BodylessConversationViewConfig` + +Replaced with `SpotterAgentEmbedViewConfig` + +[discrete] +==== Impact on Spotter embed deployments +The new Spotter embed components are available for use with the Visual Embed SDK v1.38.0 and later. +The `ConversationEmbed`, `ConversationViewConfig`, `BodylessConversation`, and `BodylessConversationViewConfig` components are deprecated in Visual Embed SDK v1.38.0 and later versions. +The old component names will be visible in the code panel of the Visual Embed Playground on ThoughtSpot instances with 10.9.0.cl or earlier. The component names in the Playground will be updated in an upcoming version. + +[discrete] +==== Recommended action +The Spotter embed component changes do not break your existing Spotter embed implementation. Your implementation with the old component names will continue to function until further notice. However, ThoughtSpot recommends transitioning to the new names as early as you can, to allow sufficient time for testing your implementation with the updated names. + +For Spotter embed documentation and code samples with new components, see xref:embed-spotter.adoc[Embed Spotter]. +==== +.Ability to control the visibility of columns in full app embedding +[%collapsible] +==== +You can now show or hide the following columns on the *Liveboards*, and *Answers* list pages in full application embeds: + +* `Favorite` +* `Author` +* `Last modified` +* `Tags` +* `Share` + +For more information, see xref:full-app-customize.adoc#_hide_columns_on_list_pages_new_experience[Customize full application embedding]. +==== +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.38.x, see xref:api-changelog.adoc[Visual Embed changelog]. +==== +.REST API +[%collapsible] +==== +For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== +.REST API Java SDK +[%collapsible] +==== +The REST API Java SDK enables developers to interact programmatically with ThoughtSpot REST APIs from Java applications. It provides a client library with Java methods and classes that map to API endpoints, handle authentication, send API requests, and allow creating and modifying ThoughtSpot resources and objects. + +For information about how to install and use the SDK, see xref:rest-api-java-sdk.adoc[Java SDK for REST APIs]. +==== + +== Version 10.8.0.cl + +.React Native SDK to embed ThoughtSpot in a mobile app [beta betaBackground]^Beta^ +[%collapsible] +==== +Developers can now embed ThoughtSpot Analytics in their mobile apps using the React Native Embed SDK [beta betaBackground]^Beta^. With the React Native Embed SDK, developers can use native resources and a single codebase to build their mobile app with embedded ThoughtSpot content for both *iOS* and *Android* platforms. + +In the initial release, the SDK supports embedding a Liveboard component and customizing the embedded view. For more information, see xref:mobilesdk-quick-start.adoc[React Native SDK quick start guide]. +==== +.External tools and custom script integration +[%collapsible] +==== +You can now integrate third-party tools and execute custom scripts within your embed. This feature is disabled by default on ThoughtSpot instances. When enabled, you can use this feature to integrate your preferred analytics and product-guide tools such as Pendo, LogRocket, and Mixpanel into your ThoughtSpot embed. + +While you can inject custom Javascript into your embeds, it is essential to consider the associated security risks and vulnerabilities, such as Cross-site scripting (XSS). Before contacting Support to enable this feature on your instance, assess the potential security risks to your application environment and review your organization's security guidelines. We recommend that you sanitize user data before rendering and ensure that your environment runs scripts from trusted domains only. For more information, see xref:3rd-party-script.adoc[Integrate third-party tools and scripts]. +==== +.Recommended action for deployments that use pendoTrackingKey +[%collapsible] +==== +If you are using the xref:EmbedConfig.adoc#_pendotrackingkey[pendoTrackingKey] setting in the Visual Embed SDK, note that ThoughtSpot will deprecate this attribute six months after the 10.8.0.cl release. While you can continue using `pendoTrackingKey` until its deprecation, we recommend using the xref:3rd-party-script.adoc[external tools integration] feature to integrate your preferred tool for analytics and product guides. For additional information or migration assistance, contact ThoughtSpot Support. +==== +.Help menu and information center changes +[%collapsible] +==== +In the 10.8.0.cl release, ThoughtSpot introduces a unified help and support experience that will eventually replace the information center panel generated by Pendo. +The new information panel provides access to ThoughtSpot documentation and support and also allows you to add custom links. This feature will be enabled gradually on ThoughtSpot instances. + +This change will affect your instance if you have embedded the full ThoughtSpot experience with the top navigation bar and Help (?) icon, using `showPrimaryNavbar: true` and `disableProfileAndHelp: false` settings in the Visual Embed SDK. + +Customer environments currently using the legacy information center during embedded sessions will continue to do so for the next few months to minimize disruption. Your ThoughtSpot Customer Success team will contact you and assist you in migrating to the new experience. + +To facilitate testing and the rollout of the new information center, ThoughtSpot provides the xref:AppViewConfig.adoc#_enablependohelp[enablePendoHelp] SDK flag. By default, the `enablePendoHelp` is set to `true` to ensure that your embedded sessions use the legacy information center generated by Pendo. To enable the new experience, you need to set `enablePendoHelp` to `false`. +==== +.Column name localization [beta betaBackground]^Beta^ +[%collapsible] +==== +ThoughtSpot now supports column name and description aliases in a Worksheet or Model, which can be used for localizing the Search and Answer interfaces. This feature is disabled by default on ThoughtSpot instances. To enable this feature, contact ThoughtSpot support. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.37.x, see xref:api-changelog.adoc[Visual Embed changelog]. +==== +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 10.6.0.cl + +.Spotter embed enhancements +[%collapsible] +==== +Spotter is enabled on ThoughtSpot instances by default and is now generally available for embedding in your applications and chatbot. + +This release also introduces several enhancements to Spotter embed: + +* xref:embed-spotter.adoc#configControls[Configuration controls in the SDK] to disable or hide the data source, and show or hide sample questions +* xref:embed-spotter.adoc#SpotterCSS[Customization controls for CSS overrides], xref:embed-spotter.adoc#spotterMenuActions[action IDs] for menu customization on the Spotter page. +* Additional options in the xref:developer-playground.adoc#playground-spotter[Spotter Playground experience], which allow users to explore the customization settings available for Spotter. + +For more information, see xref:embed-spotter.adoc[Embed Spotter]. +==== +.Theme builder for ThoughtSpot interface customization [beta betaBackground]^Beta^ +[%collapsible] +==== +ThoughtSpot now offers link:https://developers.thoughtspot.com/docs/theme-builder[Theme Builder, window=_blank] [beta betaBackground]^Beta^, a graphical representation of CSS controls and themes to assist developers with the CSS customization framework. Theme Builder allows you to explore and preview the CSS customization options available with the Visual Embed SDK to customize the look and feel of the ThoughtSpot application interface. + +Developers embedding ThoughtSpot can preview the customization options in Theme Builder for various embed components, including Liveboard, Visualizations, Search page, and the full application experience. Additionally, you can view and download the default CSS variables in JSON format and upload a JSON file containing custom values for these CSS variables. + +For more information, see xref:theme-builder.adoc[Theme Builder]. +==== +.Multi-Factor authentication and REST API behavior +[%collapsible] +==== +ThoughtSpot now supports Multi-Factor authentication (MFA) [beta betaBackground]^Beta^ for environments using local authentication with IAMv2. MFA is in beta and disabled by default on ThoughtSpot instances. When enabled on a ThoughtSpot instance, administrators can enable MFA for all local users authenticating to ThoughtSpot with `username` and `password`. + +[tag redBackground]#BREAKING CHANGE# + +When MFA is enabled on your ThoughtSpot instance, using basic authentication in REST API calls to the following API endpoints will result in an error: + +* `POST /api/rest/2.0/auth/session/login` +* `POST /api/rest/2.0/auth/token/object` +* `POST /api/rest/2.0/auth/token/full` +* `POST /api/rest/2.0/auth/token/custom` +* `POST /tspublic/v1/session/login` + +When MFA is enabled on a ThoughtSpot instance, local authentication users cannot log in with their `username` and `password` and are prompted to enable MFA when they try to log in via UI. Setting up MFA via APIs is not supported. + +If you are using REST APIs with basic authentication, ThoughtSpot recommends updating your application environment to use `username` and `secret_key` to generate authentication token. To stay security compliant and avoid breaking changes, before activating MFA for your users, we recommend that you enable *Trusted Authentication* on your instance and set up your embed and REST API environments to use token-based authentication. For more information and assistance, contact ThoughtSpot Support. +==== +.Liveboard enhancements +[%collapsible] +==== +[discrete] +==== Compact Liveboard header [earlyAccess eaBackground]#Early Access# + +Developers embedding ThoughtSpot Liveboards can now enable the Compact Liveboard feature for their application users. When enabled, this feature optimizes Liveboard header space, moves the tabs panel to the top of the header, and maximizes the visibility of the charts and tables on the Liveboard. + +Compact Liveboard header is disabled by default. To enable this feature, set `isLiveboardCompactHeaderEnabled` to `true` in the SDK. + +[discrete] +==== Show only relevant filters and Parameters on Liveboards + +By default, Liveboards display all filters and parameters, including those that are not applicable to the visualizations in a tab. On embedded Liveboards, developers can control the visibility of filters and Parameters for visualizations in a tab using the `hideirrelevantchipsinliveboardtabs` property in the SDK. + +For more information about filters for Liveboard tabs, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-filters#_apply_filters_to_specific_visualizations_or_tabs[Apply filters to specific visualizations or tabs]. +==== +.Worksheet to Model conversion +[%collapsible] +==== +You can now convert a Worksheet to a Model via a REST API POST call to the ++++/api/rest/2.0/metadata/worksheets/convert+++ endpoint. + +ThoughtSpot recommends migrating your Worksheet data to Models, because Worksheets are deprecated in ThoughtSpot and will be removed from the product in 10.10.0.cl release. +==== +.ThoughtSpot Enterprise Org enablement +[%collapsible] +==== +Starting with ThoughtSpot Cloud 10.6.0.cl release, all ThoughtSpot Enterprise instances will gradually be enabled with Orgs. Your environment will remain a single-tenant instance until you create Orgs. When the Orgs feature is enabled on your instance, you can switch to a single-tenant mode anytime by deleting all user-created Orgs and using only the default Primary Org. +==== +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.36.x, see xref:api-changelog.adoc[Visual Embed changelog]. +==== +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 10.5.0.cl + +.Default search experience on embedded ThoughtSpot Home page +[%collapsible] +==== +If your ThoughtSpot instance is upgraded from 10.1.0.cl to 10.5.0.cl, the Natural Language Search interface will be the default search experience on the embedded ThoughtSpot Home page. The split search experience, which was introduced in 10.3.0.cl, will be turned off by default on these instances. For applications embedding full ThoughtSpot experience, the `isUnifiedSearchExperienceEnabled` property will be set to `true` in the Visual Embed SDK. Your application users can continue to use the unified experience until it is deprecated. However, developers can choose to disable the unified search experience and customize the Home page search experience for their application users. + +On instances upgraded from 10.3.0.cl or 10.4.0.cl to 10.5.0.cl, Object Search will be the default search experience on the embedded ThoughtSpot Home page. The unified search experience will be disabled by default and the `isUnifiedSearchExperienceEnabled` property in the Visual Embed SDK will be set to `false`. If required, developers can switch to AI Search experience by setting the `homePageSearchBarMode` property to `aiAnswer`. + +For more information, see xref:full-app-customize.adoc#_search_experience_on_home_page[Home page search experience customization]. +==== +.Support for partitioned cookies +[%collapsible] +==== +With most web browsers blocking third-party cookies, cookies will no longer be shared across the ThoughtSpot +embedded pages and the host application, or other tabs in the browser. If your embed no longer functions without the use of third-party cookies, consider using one of the following options: + +* Update your implementation to use cookieless authentication; for example, `AuthType.EmbeddedSSO` or `AuthType.TrustedAuthTokenCookieless` (Recommended) +* Customize the domain of your ThoughtSpot instance to match the domain of your host application. + +For more information, see xref:custom-domain-configuration.adoc[Custom domain configuration]. +* Enable partitioned cookies on your ThoughtSpot instance. + +If your implementation relies on cookies or if you are using `AuthType.None` in your development and test environments, ThoughtSpot administrators have the option to enable partitioned cookies on their instance. With partitioned cookies, you can restrict cookie sharing between different sites and thus prevent cross-site tracking. ++ +On browsers that support partitioned cookies, the session cookie will persist in the ThoughtSpot app after a successful login. When using the `AuthType.None` embed authentication method in development or test environments with partitioned cookies, users must log in to their ThoughtSpot instance using basic authentication for seamless access to the embed. ++ +[NOTE] +Safari blocks all third-party cookies and does not support partitioned cookies. ThoughtSpot recommends switching to a Web browser that supports partitioned cookies or using cookieless authentication. + +For more information, see xref:security-settings.adoc#_enable_partitioned_cookies[Security Settings]. +==== + +.ABAC via tokens implementation changes +[%collapsible] +==== +The ABAC via tokens feature is GA in 10.5.0.cl. Several changes have been introduced since the ThoughtSpot 10.4.0.cl release to improve the ABAC configuration workflows: + +* The `user_parameters` property in `auth/token/full` and `auth/token/object` APIs used for the xref:abac-user-parameters-beta.adoc[beta implementation of ABAC] was deprecated in 10.4.0.cl. +* Starting from 10.4.0.cl, administrators are advised to xref:abac-user-parameters.adoc[use the `/api/rest/2.0/auth/token/custom` API endpoint] to define security attributes for ABAC implementation. + +If you have implemented ABAC using `auth/token/full` or `auth/token/object` API endpoints and your cluster is upgraded to 10.4.0.cl or 10.5.0.cl, you can migrate your implementation to start using the `/api/rest/2.0/auth/token/custom` API endpoint. For more information, refer to xref:jwt-migration.adoc[ABAC migration guide]. +==== +.Orgs context for custom links +[%collapsible] +==== +Starting with ThoughtSpot Cloud 10.5.0.cl release, developers embedding ThoughtSpot in their application can include the Org context in ThoughtSpot URLs using custom link settings. +//For instance, being able to seamlessly access content from a different Org, while being logged in another Org. + +This feature is turned off by default. To enable this feature on your ThoughtSpot instance, contact link:https://community.thoughtspot.com/customers/s/contactsupport[ThoughSpot Support, window=_blank]. For more information, see xref:orgs.adoc[Orgs context for sharing links]. +==== + +.Migration to IAMv2 +[%collapsible] +==== +All new ThoughtSpot application instances are enabled with enhanced Identity and Access Management (IAMv2). The existing ThoughtSpot embedded instances will be migrated to IAMv2 during the maintenance windows. + +* To ensure a seamless migration, review and follow the link:https://docs.thoughtspot.com/cloud/latest/okta-iam#_before_migrating_to_iam_v2[steps in the ThoughtSpot product documentation, window=_blank]. +* To understand changes to the API endpoints with this upgrade, see xref:api-user-management.adoc[User migration to IAMv2] +* For more information, see link:https://docs.thoughtspot.com/cloud/latest/okta-iam[Identity and Access Management V2, window=_blank]. +==== +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.35.x, see xref:api-changelog.adoc[Visual Embed changelog]. +==== +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== +== Version 10.4.0.cl + +.Spotter AI for conversational analytics +[%collapsible] +==== +ThoughtSpot Spotter [beta betaBackground]^Beta^ enables users to find insights from their data through a conversational interface powered by Generative AI. Spotter functions as your AI Analyst and allows your application users to start a conversation, ask follow-up questions on the results generated by ThoughtSpot, and get the data they need. + +For more information, see the following pages: + +* xref:embed-spotter.adoc#_embed_spotter_using_visual_embed_sdk[Embed Spotter in your app] + +* xref:spotter-apis.adoc[Generate Answers from AI APIs] +* xref:spotter-in-custom-chatbot.adoc[Spotter tutorials] + +[NOTE] +The Spotter feature is in beta and disabled by default on ThoughtSpot Embedded instances. To enable this feature on your instance, contact ThoughtSpot Support. +==== + +.ABAC token generation enhancements +[%collapsible] +==== +To generate a token with custom rules, attributes, and filter conditions for Attribute-Based Access Control (ABAC) [beta betaBackground]^Beta^, you can use the `/api/rest/2.0/auth/token/custom` API endpoint instead of the `user_parameters` property in `/api/rest/2.0/auth/token/full` and `/api/rest/2.0/auth/token/object` APIs. + +For more information, see xref:authentication.adoc#_get_tokens_with_custom_rules_and_filter_conditions[Get tokens with custom rules and filter conditions]. +==== + +.Visual Embed Playground enhancements +[%collapsible] +==== +The Visual Embed Playground provides several checkboxes and customization settings for ThoughtSpot embed components. You can use these checkboxes to customize your embedded view, view results instantly, and copy code. + +For more information, see xref:developer-playground.adoc[Visual Embed Playground]. +==== +.Models +[%collapsible] +==== +Models are now available on ThoughtSpot embedded instances. ThoughtSpot recommends using Models as data source objects for Answers and Liveboards instead of Worksheets from 10.4.0.cl release onwards. + +Worksheets are deprecated in 10.4.0.cl and will be removed from ThoughtSpot in an upcoming release. If you are embedding full ThoughtSpot application or the Data Workspace page in your app, you will notice that the Worksheet creation option is disabled by default. However, existing Worksheets continue to be available and editable. To enable Worksheet creation on your instance, contact ThoughtSpot Support. +==== +.Orgs enablement +[%collapsible] +==== +Starting with ThoughtSpot Cloud 10.4.0.cl release, Orgs will be enabled by default on all new ThoughtSpot instances. Your environment remains a single-tenant instance until you create Orgs. +If the Orgs feature is enabled on your instance, you can switch to a single-tenant mode anytime by deleting the Orgs and using just the Primary Org. + +For more information, see xref:orgs.adoc[Multi-tenancy with Orgs]. +==== +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.34.x, see xref:api-changelog.adoc[Visual Embed changelog]. +==== +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +.Feature deprecations +[%collapsible] +==== +The Search Assist feature for Worksheets and the **Enable Search Assist** checkbox in Search Embed Playground are removed from ThoughtSpot in 10.4.0.cl. If your embedding application uses the `enableSearchAssist` property, you may want to update your deployment. + +For more information, see xref:deprecated-features.adoc#_search_assist[Deprecated features]. +==== + +== Version 10.3.0.cl + +.Natural language search and object search +[%collapsible] +==== +Starting from the ThoughtSpot 10.3.0.cl release, the **Home** page does not provide a combined search experience with Natural Language Search and Object Search. As a result, Object Search will become the default search experience on the **Home** page, and Natural Language Search will be disabled by default. + +If you are embedding the **Home** page of ThoughtSpot application in your app, and you want to retain both the object Search and Natural Language Search experience for your users, you can customize the search type in the Visual Embed SDK. For more information, see xref:full-app-customize.adoc#_customize_search_experience[Search experience customization]. +==== + +.Selective user access +[%collapsible] +==== +With selective user access, you can allow users without the administrator or developer privilege to securely access the non-embedded pages. + +For more information, see xref:selective-user-access.adoc[User access to non-embedded content]. +==== + +.Liveboard experience enhancements +[%collapsible] +==== +You can now customize the width of the Liveboard breakpoint on an embedded instance. To enable it, you must set the `enable2ColumnLayout` property to `true`. + +For more information, see xref:embed-pinboard.adoc#_redefine_liveboard_breakpoint_widths[Redefine Liveboard breakpoint widths]. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.33.x, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +.Feature deprecations +[%collapsible] +==== +In the 10.3.0.cl release, the application background customization option on the **Admin** > **Style customization** and **Develop** > **Customizations** > **Styles** is deprecated. For more information, see xref:deprecated-features.adoc#_application_background_customization_via_ui[Application background customization]. +==== + +== Version 10.1.0.cl + +.Customization of the new Data Panel experience +[%collapsible] +==== +The CSS customization framework now supports customizing the look and feel of the new Data Panel experience. For more information, see xref:embed-search.adoc#_data_panel_experience_in_the_embedded_search_page[Embed Search] and xref:css-customization.adoc[CSS customization framework]. +==== + +.UI changes in the Liveboard and Answers list pages +[%collapsible] +==== +If you have embedded full application experience with **Liveboards** and **Answers** listing pages, note the following UI changes: + +* The *Edit TML*, *Export TML*, and *Import TML* actions are no longer available on the *Liveboards* and *Answers* listing pages. You can use the TML menu actions on the individual Liveboard and Answer pages, or the import and export TML options available on the **Data Workspace** > **Utilities** page. +* To add new tags or assign a tag to an object, users can use the **Edit tags** button on the **Liveboards** and **Answers** pages. However, users cannot rename or delete a tag. +==== +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.32.x, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +.Feature deprecations +[%collapsible] +==== +In 10.1.0.cl release, the following features are deprecated and removed from the UI: + +* Classic experience mode for Liveboards, SpotIQ, and Answers. For more information, see xref:deprecated-features.adoc#_classic_experience_for_liveboards_answers_and_spotiq[Deprecation announcements]. +* Page title customization setting in the **Admin** > **Style customization** and **Develop** > **Customizations** > **Styles** page. For more information, see xref:deprecated-features.adoc#_page_title_customization[Deprecation announcements]. +==== + +== Version 10.0.0.cl + +.Customize number, currency, and date format +[%collapsible] +==== +You can now customize the number, date, and currency format displayed on embedded pages. + +For more information, see xref:locale-setting.adoc#_set_locale_in_the_sdk[Set locale]. +==== +.Git integration +[%collapsible] +==== +If xref:roles.adoc[RBAC] is enabled on your instance, ensure that the Version Control API users have the `Can manage version control` (`CAN_MANAGE_VERSION_CONTROL`) Role privilege. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.31.x, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information on REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +.Feature deprecations +[%collapsible] +==== +For information about deprecated features, see xref:deprecated-features.adoc[Deprecation announcements]. +==== + +== Version 9.12.5.cl + +.New home page and navigation [earlyAccess eaBackground]#Early Access# +[%collapsible] +==== +The new navigation and Home page experience is now available for ThoughtSpot users. + +ThoughtSpot administrators can enable this feature on their application instance on the **Admin** page. If the new navigation and Home page experience is enabled on your instance, users can turn on the New Experience mode on their *Profile* settings page. + +On embedding apps, the new navigation and Home page experience is disabled by default. To enable it, you must set the `modularHomeExperience` property to `true` in the `AppEmbed` component. + +The new navigation and Home page experience introduces the following notable changes: + +* The top navigation menu bar is replaced with an app selector image:./images/app_switcher.png[the app switcher menu] that allows users to switch between different apps. +* The **Insights** module presents a redesigned Home page with modular content and a left navigation panel. Users can navigate to Liveboards, Answers, SpotIQ Analysis, and Monitor Subscriptions pages from the Home page by using the left navigation menu options. + +For more information, see xref:full-app-customize.adoc[Customize full application embedding]. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.30.x, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 9.12.0.cl + +.SSO authentication with IAMv2 +[%collapsible] +==== +ThoughtSpot now supports managing user authentication through IAMv2 on embedded instances. With this feature, administrators can set up SAML and OIDC authentication with Identity providers such as Okta, Google, and so on. You can also map Identity Provider (IDP) attributes on the ThoughtSpot Admin page when setting up OIDC or SAML authentication on your instance. + +IAMv2 is turned off by default. To enable it on your instance, contact ThoughtSpot Support. + +For more information, see xref:configure-saml.adoc#IAMv2[SAML SSO authentication] and xref:configure-oidc.adoc#IAMv2[OpenID Connect authentication]. +==== + +.OIDC authentication on Orgs-enabled clusters +[%collapsible] +==== +ThoughtSpot now supports Orgs through OpenID Connect (OIDC) authentication on embedded instances. With Org mapping, the IdP will have the ability to assign users to specific Orgs when they log in via OIDC authentication. You need administrator privileges to enable Org mapping on the cluster. + +For more information, see xref:orgs.adoc#_oidc_authentication[Multi-tenancy with Orgs] and xref:configure-oidc.adoc#orgMapping[OpenID Connect authentication]. +==== + +.Ask Sage [beta betaBackground]^Beta^ +[%collapsible] +==== +ThoughtSpot application users can now ask follow-up questions and seek clarifications about visualizations and Answers generated using natural language search. The **Ask Sage** action on Liveboard visualizations and **Ask a follow-up** action search results page allow you to start a conversation with the AI analyst, ask successive questions, and refine the Answer retrieved from a Natural Language Search query. + +The **Ask Sage** feature is turned off by default. To enable this feature on your instance, contact ThoughtSpot Support. To enable or disable this feature for embedded application users, use the `enableAskSage` attribute. +==== + +.Liveboard UI changes +[%collapsible] +==== +The following TML menu actions are now grouped under the *TML* sub-menu of the **More** image:./images/icon-more-10px.png[the more options menu]menu. + +* Export TML +* Edit TML +* Update TML +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.29.x, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + + +== Version 9.10.5.cl + +.Row-level security via tokens [beta betaBackground]^Beta^ +[%collapsible] +==== +You can now implement Row-Level Security (RLS) and Attribute-Based Access Control (ABAC) via tokens for ThoughtSpot embedded application users. You can now configure your authentication process in the SDK to assign security attributes for any user during session creation. + +For more information, see xref:abac-user-parameters.adoc[ABAC via token]. + +[NOTE] +ABAC via tokens is supported only with the Trusted Authentication method. +==== + +.AI Highlights [earlyAccess eaBackground]#Early Access# + +[%collapsible] +==== +You can now get quick insights on how top metrics have changed in your Liveboard via AI Highlights. + +* Users with administration privileges can enable AI Highlights at the cluster level on the **Admin** page. +* When AI Highlights is enabled, the AI highlights image:./images/ai-highlights.png[AI Highlights icon] icon appears on the Liveboard header and the **Edit** button moves to the **More** menu image:./images/icon-more-10px.png[the more options menu]. +* You can hide this feature on your embedded instance by adding `Action.AIHighlights` to the `hiddenActions` array in the SDK. + +For more information, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-ai-highlights[AI Highlights, window=_blank]. +==== + +.Granular Roles for data management +[%collapsible] +==== +If the RBAC is enabled on your ThoughtSpot instance, administrators can use the following Roles for granular access control and data management: + +* `CAN_MANAGE_CUSTOM_CALENDAR` +* `CAN_CREATE_OR_EDIT_CONNECTIONS` +* `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` + +For more information, see xref:roles.adoc[Role-based access control]. + +[NOTE] +The RBAC feature is in beta and turned off by default. To enable this feature, contact ThoughtSpot Support. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.29.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + + +== Version 9.10.0.cl + +.Integration with Vercel projects +[%collapsible] +==== +You can now integrate your ThoughtSpot instance with a Vercel project. If you are using Vercel to build and maintain your embedding application, you can install ThoughtSpot analytics integration, connect to ThoughtSpot data, and embed content in your app seamlessly. + +For more information, see xref:vercel-int.adoc[Vercel integration]. +==== + +.CSS variables for custom styling +[%collapsible] +==== +The following custom CSS variables are deprecated and not supported from 9.10.0.cl onwards: + +* `--ts-var-sage-bar-img-url` +* `--ts-var-sage-bar-img-color` +* `--ts-var-sage-bar-img-visibility` +==== + +.Security settings for non-embedded instances +[%collapsible] +==== +The **Security Settings** page in the **Develop** tab now allows any ThoughtSpot user with developer or admin privileges to modify CSP settings for image, font, and style import. + +For more information, see xref:security-settings.adoc[Security Settings]. +==== +.Support for Sage coach +[%collapsible] +==== +In full application embedding, you can now review user feedback on the natural language search queries on the **Data** page. +//For more information, see link:https://docs.thoughtspot.com/cloud/latest/sage-coach[Sage Coach, window=_blank]. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.28.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 9.8.0.cl + +.Support for Natural Language Search embedding +[%collapsible] +==== +You can now embed ThoughtSpot Search with Natural Language Search capabilities using `SageEmbed` SDK package. Natural Language Search allows your application users to search for data using natural language query strings. This feature also provides AI-suggested sample questions and popular queries to assist users in their data search operations. + +Using `SageEmbed`, you can embed the ThoughtSpot Search interface with Natural Language Search components in your app and also customize the search experience as per your requirements. + +For more information, see xref:embed-nls.adoc[Embed Natural Language Search]. +==== + +.Embed Playground enhancements +[%collapsible] +==== +The Visual Embed playground now allows you to explore Natural Language Search embedding options and Search page customization capabilities. For more information, see xref:developer-playground.adoc#playground-nls-search[Natural Language Search]. +==== + +.Git integration enhancements +[%collapsible] +==== +The **Deploy Commit** Version Control API now provides the `VALIDATE_ONLY` option to validate TML imports to the destination environment. If your destination environment has TML content that has been modified or is different from the content on the main branch, you can run the validation before deploying changes to the destination environment. + +For more information, see xref:version_control.adoc#_deploy_commits[Deploy commits]. +==== + +.CSS variables for Natural Language Search interface customization +[%collapsible] +==== +To customize Natural Language Search interface, you can use the following variables in your custom CSS: + +* `--ts-var-sage-bar-header-background-color` +* `--ts-var-source-selector-background-color` +* `--ts-var-sage-search-box-font-color` +* `--ts-var-sage-search-box-background-color` +* `--ts-var-sage-embed-background-color` +* `--ts-var-sage-seed-questions-background` +* `--ts-var-sage-seed-questions-font-color` +* `--ts-var-sage-seed-questions-hover-background` +* `--ts-var-sage-bar-img-url` +* `--ts-var-sage-bar-img-color` +* `--ts-var-sage-bar-img-visibility` + +For mor information, see xref:css-customization.adoc#_natural_language_search_interface[Customize CSS]. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.27.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + + +== Version 9.7.0.cl + +.Git integration and version control +[%collapsible] +==== +The Git integration feature and Version Control APIs are GA and enabled by default on ThoughtSpot. This version also includes several enhancements to the Version Control APIs. +For more information, see xref:rest-apiv2-changelog.adoc#_version_control_apis[REST API v2 Changelog] and xref:version_control.adoc[Git integration and version control]. +==== + +.Custom styles +[%collapsible] +==== +You can now customize icon sprites and add custom text strings. For more information, see xref:css-customization.adoc#_customize_text_strings[Customize text strings] and xref:css-customization.adoc#_customize_icons[Customize icons]. +==== + +.Liveboard experience +[%collapsible] +==== +Personalized Liveboard Views [tag purpleBackground]#Early Access#:: + +Embedding application users can now create a personalized version of Liveboard with their changes. The personalized Liveboard view inherits any changes made to the master Liveboard, including changes made to pinned visualizations, tabs, filter chips, and re-ordering. ++ +This feature is disabled by default and can be enabled by administrators. For more information, see link:https://docs.thoughtspot.com/cloud/latest/personalized-liveboard-views[ThoughtSpot Product Documentation]. + +Embedding in note tiles:: +You can now embed interactive content such as videos in an iFrame on a Liveboard Note tile. For more information, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-notes#embed[ThoughtSpot Product Documentation]. + +Liveboard customization:: +You can now customize Liveboard headers, show or hide Liveboard users, tabs, description text, and Liveboard title. + +For more information, see xref:api-changelog.adoc#_version_1_26_0_november_2023[Visual Embed SDK Changelog] and xref:LiveboardViewConfig.adoc[SDK documentation]. +==== + +.Search experience +[%collapsible] +==== +You can now enable the new data panel experience on the embedded Search page in the SDK. The new data panel experience is turned off by default on embedded ThoughtSpot instances. + +For more information, see xref:embed-search.adoc#_data_panel_experience_in_the_embedded_search_page[Embed ThoughtSpot Search]. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.26.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + + +== Version 9.6.0.cl +.Playground enhancements +[%collapsible] +==== +The 9.6.0.cl release adds the following features to the Visual Embed Playground: + +* Liveboard tab selection + +The Playground page for Liveboard embedding now shows the tab selection drop-down, which allows users to set the default tab view on an embedded Liveboard. + +* Use host event checkbox + ++ +On selecting the *Use host event* checkbox, the code panel in the Playground displays the code snippet to try out host events. You can use this code snippet to register a host event and trigger an action using the *Try Event* button in the Playground. +==== + +.Home page experience in Full application embedding mode +[%collapsible] +==== +If you are embedding the full ThoughtSpot experience with the ThoughtSpot Sage feature, the Home page allows you to use AI-generated search answers. To enable AI-assisted search on your instance, contact ThoughtSpot Support. +==== + +.Role-Based Access Control [beta betaBackground]^Beta^ +[%collapsible] +==== +The role-based access control (RBAC) feature allows administrators to create a role in the UI or via REST API calls and assign a set of privileges. With the RBAC feature, you can assign granular permissions and control user access to ThoughtSpot features and application workflows. For more information, see xref:roles.adoc[Role-based Access Control]. + +The RBAC feature is turned off by default. To enable this feature, contact ThoughtSpot Support. +==== +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.25.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 9.5.0.cl + +.Webhooks for KPI monitor alerts [beta betaBackground]^Beta^ +[%collapsible] +==== +ThoughtSpot administrators and developers can now create a Webhook to send KPI monitor alerts to the REST endpoint of an external application. The Webhooks feature is turned off by default. To enable this feature on your instance, contact ThoughtSpot Support. + +For more information, see xref:webhooks.adoc[Webhooks for KPI Monitor alerts]. +==== + +.Version control and Git integration [beta betaBackground]^Beta^ +[%collapsible] +==== +The Git integration feature now supports pushing commits and publishing content to Org-based deployment environments. If your ThoughtSpot cluster has Orgs and multi-tenancy enabled, you can create `dev` and `prod` environments on the same ThoughtSpot instance and connect these environments to your GitHub repository. + +For more information, see xref:version_control.adoc[Git integration and version control]. +==== + +.SDK library to embed AI-powered ThoughtSpot Search experience [beta betaBackground]^Beta^ +[%collapsible] +==== +The Visual Embed SDK provides a new JavaScript library to embed the Search page with AI-powered features such as natural language search and AI-suggested answers. To view the AI-suggested answers, make sure the AI search support is enabled on the data source or worksheet used for searching data. + +//ThoughtSpot does not display AI-suggested search responses if the xref:search-assist-tse.adoc[Search Assist] feature is enabled. + +For more information, see xref:SageEmbed.adoc[SageEmbed SDK reference]. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.24.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 9.4.0.cl + +.Version control and Git integration [beta betaBackground]^Beta^ +[%collapsible] +==== +GUID mapping:: + +If a TML file on your source environment contains GUIDs that don't match the GUIDs on your destination environment, the version control APIs can now automatically handle the mapping of GUIDs when deploying the TML content. + ++ +For more information, see xref:version_control.adoc#_guid_mapping[Git integration and version control]. + +Folder structure changes [tag redBackground]#BREAKING CHANGE#:: + +The folder structure of the TML objects in the Git repository is modified in 9.4.0.cl. In earlier releases, the TML objects were stored in the object directory of the `primary` root folder, for example `primary/liveboard`. Starting from 9.4.0.cl, the TML objects will be stored in the object folder at the root level. ThoughtSpot will not migrate your existing TML files from `primary/` to the new folder structure. You must move these files to the respective object directory at the root level. + +File naming convention [tag redBackground]#BREAKING CHANGE#:: +Starting from 9.4.0.cl, the TML files pushed to a Git branch from a ThoughtSpot instance are named in the +`..tml` format. The earlier releases used the `..tml` naming convention for TML files. This change may break your current setup. We recommend that you reconfigure the Git connection on your ThoughtSpot instance and start using the version control feature from scratch. +==== + +.Security settings enhancements for Orgs +[%collapsible] +==== + +CORS settings per Org:: + +On multi-tenant clusters with Orgs, developers can now add a list of CORS hosts at the Org level. For more information, see xref:security-settings.adoc#cors-hosts[Security Settings]. + +Block user access to non-embedded application pages:: + +ThoughtSpot administrators and developers can now enable the **Block non-embed full app access** feature at the Org level. + +For more information, see xref:security-settings.adoc#_block_access_to_non_embedded_thoughtspot_pages[Security Settings]. +==== + +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.23.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + + +== Version 9.3.0.cl + +.Support for cookieless authentication +[%collapsible] +==== +Developers can now enable cookieless authentication when embedding ThoughtSpot in their applications. The cookieless authentication method allows using a bearer token instead of session cookies when users interact with embedded content or initiate API requests. If the embedded content does not load from the same domain as your embedding application, and your Web browser does not allow third-party cookies, you can use Cookieless authentication in the Trusted authentication mode. + +For more information, see xref:embed-authentication.adoc#trusted-auth-embed[Trusted authentication]. +==== + +.Idle sensing and APIs for managing cluster states +[%collapsible] +==== +ThoughtSpot Cloud clusters support idle sensing in embedded deployments. With idle sensing enabled on your embedded ThoughtSpot instance, your instance becomes inactive if there is no active user session detected for a period of 120 minutes. You can restart an inactive cluster using API when required. + +For more information, see xref:tse-eco-mode.adoc[Manage your cluster state]. +==== + +.Per-Org style customization +[%collapsible] +==== +The *Develop* tab now allows customizing UI styles and layout at the Org level. To enable this feature on your multi-tenant instance, contact ThoughtSpot support. + +For more information, see xref:style-customization.adoc#_custom_styles_for_orgs_on_multi_tenant_clusters[Custom styles for Orgs on multi-tenant clusters]. +==== + +.Version control and Git integration via REST API [beta betaBackground]^Beta^ +[%collapsible] +==== +You can now connect your ThoughtSpot instance to a Git repository and push commits from your application instance to a Git branch via REST API. With the Git integration [beta betaBackground]^Beta^ feature, ThoughtSpot provides the ability to integrate your application environment with Git workflows and deploy commits from a development instance to a production cluster. + +For more information, see xref:version_control.adoc[Version control with Git integration]. +==== + +.Visual Embed Playground enhancements + +[%collapsible] +==== +The Visual Embed developer Playground now includes a *Try* button in the preview panel. The *Try* button is attached to an event handler. You can register a host event and click *Try* to trigger an action on the embedded page in the Playground. + +For more information, see xref:embed-events.adoc[Events reference]. +==== + +.Visual Embed SDK + +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK versions 1.22.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 9.2.0.cl + +.Per-Org secret key and tokens for Trusted authentication + +[%collapsible] +==== +ThoughtSpot now supports generating secret keys per Org. Org administrators can generate a secret key for trusted authentication in their Org context and allow their Org users to obtain authentication tokens using this secret key. + +Starting from 9.2.0.cl, Org users require Org-specific authentication tokens issued for their user accounts when switching between Orgs. When generating an authentication token via REST API, make sure to request separate tokens for each Org context. + +For more information, see xref:trusted-authentication.adoc#trusted-auth-enable[Trusted authentication]. +==== + +.Custom styles + +[%collapsible] +==== +The 9.2.0.cl release introduces the following new variables for custom styling of the ThoughtSpot Search page: + +* `--ts-var-search-auto-complete-font-color` +* `--ts-var-search-auto-complete-subtext-font-color` +* `--ts-var-answer-edit-panel-background-color` + +For more information, see xref:css-customization.adoc#_search_bar_and_data_panel[Customize CSS]. +==== + +.GraphQL playground [beta betaBackground]^Beta^ +[%collapsible] +==== +The *Develop* tab in the ThoughtSpot UI introduces the GraphQL playground to allow users to interact with GraphQL endpoints and run query and mutation operations. To enable this feature on your instance, contact ThoughtSpot Support. + +For more information, see xref:graphql-playground.adoc[GraphQL Playground]. +==== +.Runtime Parameter overrides +[%collapsible] +==== +Embedded application users can now create Worksheet and Answer Parameters to optimize data queries. You can also adjust values and apply overrides at runtime on a Liveboard or Answer either via REST API or by appending Parameters to the query URL in the UI. + +For more information, see xref:runtime-parameters.adoc[Runtime Parameter overrides]. +==== +.Link customization +[%collapsible] +==== +You can now customize the navigation links in your app using the *Generic link* option in the *Develop* > *Customization* > *Link settings* page. + +For more information, see xref:customize-links.adoc#_customize_link_format[Customize links]. +==== +.Cross filters on Liveboard visualizations [earlyAccess eaBackground]#Early Access# +[%collapsible] +==== +ThoughtSpot now supports brushing and linking of visualizations on a Liveboard using cross filters. Cross filters allow you to present a coordinated view of a Liveboard by applying filters across all visualizations based on the current selection. + +[NOTE] +The Cross filters feature is turned off by default. To enable this feature on your instance, contact your ThoughtSpot administrator. + +To hide or disable the cross filter feature on an embedded instance, use the `Action.CrossFilter` and `Action.RemoveCrossFilter` parameters in the SDK. For more information, see xref:embed-actions.adoc[Show or hide menu items] and xref:Action.adoc[Action reference]. +[discrete] +=== Contextual menu behavior + +By default, the contextual menu in ThoughtSpot application pages is set as right-click pop-up menu. Starting from 9.2.0.cl, you can set the contextual menu to trigger on left-click. + +To trigger the contextual menu on left-click or right-click on an embedded app, you can use the `contextMenuTrigger` property in the Visual Embed SDK. In the following example, the contextual menu is configured to trigger on left-click. + +---- +contextMenuTrigger: "left-click" +---- + +---- +contextMenuTrigger: ContextMenuTriggerOptions.LEFT_CLICK +---- + +When set as right-click menu (default behavior):: +The contextual menu opens on right-click. If you want to monitor right-click actions and listen to the right-click events on a chart or table, use `EmbedEvent.VizPointRightClick` event. For more information, see link:https://developers.thoughtspot.com/docs/Enumeration_EmbedEvent#_vizpointrightclick[VizPointRightClick]. + +When set as left-click menu:: +The contextual menu opens on left-click. If your app is already using `EmbedEvent.VizPointClick` to listen to left-click events on a visualization, the `VizPointClick` event will be triggered whenever a user clicks on an action in the contextual menu. If you are using `EmbedEvent.VizPointClick` to trigger actions such as updating runtime filters on a Liveboard visualization, the click events from left-click contextual menu may impact your app’s current workflow. + ++ +We recommend using a development environment to test your customizations before rolling them out on production servers. For more information, contact ThoughtSpot Support. +==== +.Note tiles on Liveboards [earlyAccess eaBackground]#Early Access# +[%collapsible] +==== +In the new Liveboard experience mode, you can now add Note tiles with custom text, images, and links. This feature is turned off by default and can be enabled by ThoughtSpot administrators. + +For more information, see xref:embed-pinboard.adoc#noteTiles[Note tiles]. +==== +.Visual Embed SDK +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK versions 1.20.0 and 1.21.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +==== + +== Version 9.0.0.cl + +.New Liveboard experience +[%collapsible] +==== +The xref:embed-pinboard.adoc#lbv2[new Liveboard experience] is now Generally Available (GA) on embedded instances and is enabled by default. +==== + +.New CSS variables for custom styling +[%collapsible] +==== +The CSS customization feature supports new variables to customize the look and feel of the following UI elements: + +* Search bar and navigation panel +* Search suggestion panel +* Dialogs + +For more information, see xref:css-customization.adoc[Customize CSS]. +==== +.REST API v2.0 endpoints and Playground +[%collapsible] +==== +Starting with 9.0.0.cl, the REST API v2 [beta betaBackground]^Beta^ API endpoints are deprecated and removed from the REST API v2 Playground. A set of new endpoints is now generally available (GA) on all ThoughtSpot instances. + +The new REST API v2.0 endpoints introduce several improvements to the request and response structure and let you perform more tasks in a single API call. For example, you can create a new user, map the user to groups and Orgs, set home Liveboards for the user, and assign privileges in a single API request. + +[div announcementBlock] +-- +* All REST API v2 [beta betaBackground]^Beta^ endpoints are deprecated, but remain functional until further notice. The REST API SDK that was available with REST API v2 [beta betaBackground]^Beta^ version is no longer supported. + +ThoughtSpot does not recommend using REST API v2 [beta betaBackground]^Beta^ endpoints for production use cases. For more information, see xref:deprecated-features.adoc#_deprecation_of_rest_v2_api[Deprecation announcements]. +* The new REST API v2.0 endpoints are not an extension of the REST API v2 [beta betaBackground]^Beta^ endpoints. The resource categories, base path, endpoint URIs, and the structure of API requests and responses are different from those of the REST API v2 [beta betaBackground]^Beta^ version. +* Some API operations such as the CRUD operations for data connections and passing runtime filters on Liveboard visualizations are not available in the initial release. For more information, see xref:rest-api-v1v2-comparison.adoc[REST API v1 and v2.0 comparison] and xref:rest-api-v2-reference.adoc[REST API v2.0 reference]. +* For Org CRUD operations in production environments, ThoughtSpot recommends using xref:org-manage-api.adoc[REST API v1 endpoints]. +-- +==== + +.Early Access features +[%collapsible] +==== +Starting from 9.0.0.cl, ThoughtSpot allows its administrators to turn on Early Access features from the Admin portal. Early Access features are qualified by ThoughSpot for customer use but are not enabled by default on ThoughtSpot instances until the features are GA. + +The 9.0.0.cl release introduces the following Early Access features: + +* Custom maps ++ +Allows uploading map files (TopoJSON) to configure custom regions and visualize data on these regions. For more information, see link:https://docs.thoughtspot.com/cloud/latest/geomaps-custom[Upload custom geo maps, window=_blank]. + +* Mandatory filters ++ +Allows setting certain filters as mandatory on a Liveboard. For more information, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-filters-mandatory[Mandatory Liveboard filter, window=_blank]. + +* Chart configuration experience ++ +Allows making multiple edits to a chart configuration and applying all changes at once. For more information, see link:https://docs.thoughtspot.com/cloud/latest/chart-x-axis[Reorder labels on the axis or legend, window=_blank]. + +* Chart data labels ++ +Allows displaying data labels in a lighter color on charts with a dark background. For more information, see link:https://docs.thoughtspot.com/cloud/latest/chart-data-labels[Show data labels, window=_blank]. +==== + +.Visual Embed SDK version 1.19.0 +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.19.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API v1 enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog]. +==== + +== Version 8.10.0.cl + +.Ability to embed only the Search bar in an app [beta betaBackground]^Beta^ +[%collapsible] +==== +You can now embed the ThoughtSpot search bar component in your app. For example, if you are using Google Sheets for data analysis, you can embed the ThoughtSpot search bar and let your users search data from a specific data source. The embedded Search bar allows passing search tokens and modifying search options. You can also retrieve the search results as raw data and let your host application render it in the format you want. + +For more information, see xref:embed-searchbar.adoc[Embed ThoughtSpot search bar]. +==== + +.Advanced style customization with custom CSS +[%collapsible] +==== +The CSS customization feature supports new variables to customize the look and feel of the following UI elements: + +* Search data button in the navigation panel +* Font type and text style of search tokens +* Data panel on the Search and saved Answer pages +* Filter chips on Liveboard, visualizations, and Answer pages +* Menu components +* X-axis and Y-axis titles and labels on charts + +For more information, see xref:css-customization.adoc[Customize CSS]. +==== + +.CSP allowlist for font, image and stylesheet sources +[%collapsible] +==== +You can now enable CSP overrides for font, stylesheet, and image sources in ThoughtSpot UI. If you want to load fonts, stylesheets, images, or favicons from an external source, add the source URLs to the CSP allowlist on the *Security Settings* page. + +For more information, see xref:security-settings.adoc#_add_trusted_domains_for_font_css_and_image_import[Security Settings]. +==== + +.Multi-tenancy with Orgs +[%collapsible] +==== +You can now set up your ThoughtSpot Cloud instance as a multi-tenant cluster and partition it into logical and isolated workspaces called *Orgs*. Each Org can have its own users, groups, and metadata, and stay independent of and invisible to other Orgs configured on the same application instance. + +For more information, see xref:orgs.adoc[Multi-tenancy with Orgs]. +==== + +.Visual Embed SDK version 1.18.0 +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.18.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API v1 enhancements, see xref:rest-apiv1-changelog.adoc[REST API changelog]. +==== + +== Version 8.9.0.cl + +.Improvements to authentication methods and AuthType enums in the SDK +[%collapsible] +==== +The following changes are introduced in the Visual Embed SDK to improve the authentication framework and options for embedded application users: + +* New auth type enum for embedded SSO authentication ++ +The `AuthType.EmbeddedSSO` enum allows you to enable SSO login on embedded instances. This authentication method allows you to use your current SAML IdP or OpenID Connect configuration and redirect users to the IdP for authentication within the embedded iFrame. + +* Changes to the existing `AuthType` enums: + +** `AuthType.SAML` is renamed as `AuthType.SAMLRedirect` + +** `AuthType.OIDC` is renamed as `AuthType.OIDCRedirect` + +** `AuthType.AuthServer` is renamed to `AuthType.TrustedAuthToken` + + +For more information, see xref:embed-authentication.adoc[Authentication]. +==== + +.Just-in-time user creation and dynamic privilege assignment +[%collapsible] +==== +Starting from 8.9.0.cl, the xref:session-api.adoc#session-authToken[/tspublic/v1/session/auth/token] endpoint supports just-in-time provisioning of users. If the user specified in the API request does not exist in the ThoughtSpot system, you can set the `autocreate` property to `true` to add the user to ThoughtSpot and assign the user to `groups`. +==== +.Advanced style customization [beta betaBackground]^Beta^ +[%collapsible] +==== +ThoughtSpot now allows you to override style specifications of the embedded UI pages and elements with custom CSS. Custom CSS provides granular control over the design elements and lets you modify the properties of these elements +to match the look and feel of your host application. + +To help users visualize and preview the CSS overrides, the *Visual Embed* playground will include the *Apply custom styles* checkbox, which allows you to explore the variables available for customization. + +For more information, see xref:style-customization.adoc[Customize styles and layout] and xref:css-customization.adoc[Customize CSS using SDK]. + +==== +.Visual Embed SDK version 1.17.0 +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.17.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== +.REST API +[%collapsible] +==== +For information about REST API v1 enhancements, see xref:rest-apiv1-changelog.adoc[REST API changelog]. +==== + +== Version 8.8.0.cl +.Custom tile size for visualizations on a Liveboard (New Liveboard experience only) +[%collapsible] +==== +ThoughtSpot users can now customize the tile size of a visualization on a Liveboard. In the earlier versions, ThoughtSpot allowed resizing visualizations using predefined layout options available in the *More* menu image:./images/icon-more-10px.png[the more options menu]. With custom tile size, users can now change the size of a visualization just by clicking and dragging the tile to the desired size. + +This feature is in beta and disabled by default on all Thoughtspot instances. To enable this feature on your instance, contact ThoughtSpot Support. +==== +.Visual Embed SDK version 1.16.0 +[%collapsible] +==== +For information about the new features and enhancements introduced in Visual Embed SDK version 1.16.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== +.REST API v1 +[%collapsible] +==== +For information about REST API v1 enhancements, see xref:rest-apiv1-changelog.adoc[REST API changelog]. +==== +.Bug fixes and improvements +[%collapsible] +==== +Bug fixes and new improvements in embedded user experience. + +For more information, see xref:fixed-issues.adoc[Fixed issues]. +==== + +== Version 8.7.0.cl + +.Liveboard tabs +[%collapsible] +==== +The new Liveboard experience[beta betaBackground]^Beta^ now supports organizing visualizations in tabs. Users with edit access to a Liveboard can add, edit, and move visualizations to tabs on a Liveboard. On embedded ThoughtSpot instances, developers can set a specific tab as an active tab using the Visual Embed SDK. + +This feature is available only on deployments that have the new Liveboard experience enabled. For more information, see xref:embed-pinboard.adoc#_liveboard_tabs[Customize Liveboard tabs]. + +[IMPORTANT] +The new Liveboard experience is in BETA on embedded ThoughtSpot instances. This feature is turned off by default on embedded ThoughtSpot instances. +==== +.Visual Embed SDK version 1.15.0 +[%collapsible] +==== +For information about the new features and enhancements in the Visual Embed SDK version 1.15.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API v1 +[%collapsible] +==== +For information about REST API v1 enhancements, see xref:rest-apiv1-changelog.adoc[REST API changelog]. +==== + +.REST API v2 [beta betaBackground]^Beta^ +[%collapsible] +==== +The REST API v2 [beta betaBackground]^Beta^ feature will be deprecated in 8.10.0.cl and replaced with the new v2.0 API endpoints. For more information, see xref:deprecated-features.adoc[Deprecation announcements]. +==== + +== Version 8.6.0.cl + +.Liveboard new experience [beta betaBackground]^Beta^ +[%collapsible] +==== +The new Liveboard experience is now available on embedded ThoughtSpot instances. In addition to the existing Liveboard features, the new experience introduces several notable changes to the *Liveboard* page: + +Liveboard editing:: +To edit a Liveboard, users must switch to the edit mode by clicking the *Edit* button on the Liveboard page. +The edit mode allows you to edit the Liveboard title and description text, apply filters, copy the Liveboard, modify the layout of the visualization tiles, delete a visualization, and so on. + +Liveboard filters:: +* The Liveboard filter configuration options are available on a single modal. +* When a user creates a copy of a Liveboard, the filters applied to its visualizations are also copied. + +Other features and enhancements:: +* The *Add filters* action is placed in the primary menu bar and can be viewed only when a Liveboard is in edit mode. Only users with edit access to the Liveboard can apply filters. +* The *Undo*, *Redo*, and *Reset* actions for visualizations. +* The *Liveboard Info* action label in the More image:./images/icon-more-10px.png[the more options menu] menu is renamed to *Show Liveboard details*. +* The *Schedule* action is placed in the More image:./images/icon-more-10px.png[the more options menu] menu. +* Improved visualization Explore experience. + +Deprecated features:: +The following features are *_not_* available with the new Liveboard experience: +* The *Copy embed link* and *Copy link* menu actions in the More image:./images/icon-more-10px.png[the more options menu] menu of a Liveboard +* The edit title icon on visualization tiles +* The *Share* button on visualizations + +For more information about the new Liveboard experience, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-experience-new[New Liveboard experience, window=_blank]. + +[discrete] +==== New Liveboard experience rollout on embedded instances + +The new Liveboard experience is currently available in BETA on embedded ThoughtSpot instances. The new liveboard experience will be rolled out on embedded instances in phases: + +In ThoughtSpot Cloud 8.6.0.cl:: + +The new Liveboard experience is turned off by default on embedded ThoughtSpot instances. If you are using the Visual Embed SDK to embed ThoughtSpot, you can xref:embed-pinboard.adoc#lbv2[set the `liveboardV2` parameter] in the SDK package to `true` and enable the new experience globally for all users on your instance. + + ++ +ThoughtSpot users with administrator privileges can also link:https://docs.thoughtspot.com/cloud/latest/liveboard-experience-new[turn on the new Liveboard experience, window=_blank] at the cluster level. + +In later releases:: +The new Liveboard Experience will be turned on by default for all embed application users. To switch to the classic experience, you can set the `liveboardV2` parameter to `false` in the SDK, or change the Liveboard experience preference in the `Admin` tab of the ThoughtSpot UI. + +[NOTE] +The Liveboard experience setting in the SDK takes precedence over the cluster-level settings in the *Admin* tab. + +[discrete] +==== Actions and Events in the SDK +If you have enabled the new Liveboard experience on your instance, you can use the `Action` and `Event` enumeration members available in the SDK package to customize an embedded object and improve interactivity. + +For example, to disable the *Delete* action for a visualization object on the Liveboard, you can use the `Action.Remove` enum. Similarly, you can trigger events such as `VizPointClick` on visualizations in an embedded Liveboard. + +==== + +.Visual Embed SDK version 1.14.0 +[%collapsible] +==== +For information about the new features and enhancements in the Visual Embed SDK version 1.14.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API +[%collapsible] +==== +For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API changelog]. +==== + +== Version 8.5.0.cl + +.Search Assist support for embedded instances +[%collapsible] +==== +Your application users can now access sample search walkthrough lessons created using Search Assist on embedded ThoughtSpot instances. If the Search Assist feature is enabled in the SDK, and the Search Assist lessons are created on the Worksheet, users can view sample search questions and follow the actions in the walkthrough to get answers. + +//For more information, see xref:search-assist-tse.adoc[Enable Search Assist, window=_blank]. +==== + +.Visual Embed SDK 1.13.0 +[%collapsible] +==== +For information about the new features and enhancements in the Visual Embed SDK version 1.13.0, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.ThoughtSpot UI +[%collapsible] +==== +The new Data workspace is Generally Available (GA) in 8.5.0.cl on ThoughtSpot instances. For more information about the new Data tab, SpotApps, and other related features, see link:https://docs.thoughtspot.com/cloud/latest/notes[ThoughtSpot product documentation]. + +[IMPORTANT] +While some customizable actions from the Visual Embed SDK will be honored from within an embedded instance of the new Data workspace page, full support of this page in embedded ThoughtSpot instances is planned for a future release. If you are actively embedding and customizing the `Data` tab for your application and wish to retain the legacy `Data` tab, contact ThoughtSpot Support. + +==== + +== Version 8.4.0.cl + +.Link customization +[%collapsible] +==== +This release allows query parameters in the Liveboard, saved Answer, and visualization URLs that are customized for an embedded ThoughtSpot instance. For example, you can customize the *Unsubscribe* link sent in email notifications for KPI charts by adding `{ts-query-params}` to the visualization URL, and thus allow users to unsubscribe from KPI threshold alerts at any time. + +For more information, see xref:customize-links.adoc[Customize links]. +==== + +.Visual Embed SDK 1.12.0 + +[%collapsible] +==== +The Visual Embed SDK version 1.12.0 introduces new events. For more information, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API v2 [beta betaBackground]^Beta^ +[%collapsible] +==== +[width="100%" cols="1,4"] +|==== +|| +|[tag greenBackground]#NEW ENDPOINTS# a| This release introduces the following new REST API v2 [beta betaBackground]^Beta^ endpoints: + + +* Data + +** `*GET* /tspublic/rest/v2/data/answer/querysql` + +** `*GET* /tspublic/rest/v2/data/liveboard/querysql` +* Admin +** `*PUT* /tspublic/rest/v2/admin/assignauthor` +|[tag redBackground]#BREAKING CHANGES# a| * The method names for the following endpoints will be changed in the SDK. + +** `/tspublic/rest/v2/user/addgroup` + +** `/tspublic/rest/v2/user/removegroup` + +* The `/tspublic/rest/v2/admin/changeowner` endpoint will be renamed as `/tspublic/rest/v2/admin/changeauthor`. +|==== +==== + +== Version 8.3.0.cl + +.Visual Embed SDK 1.11.0 +[%collapsible] +==== +The Visual Embed SDK version 1.11.0 introduces several new events for embedded components. For more information, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API v2 [beta betaBackground]^Beta^ +[%collapsible] +==== +[width="100%" cols="1,4"] +|==== +|| +|[tag greenBackground]#NEW ENDPOINTS# a| The following REST API v2 [beta betaBackground]^Beta^ endpoints are now available: + +* Connection endpoints + +** `GET /tspublic/rest/v2/connection/database` + +** `POST /tspublic/rest/v2/connection/table` + +** `POST /tspublic/rest/v2/connection/tablecoloumn` + +* Report endpoint + +** `POST /tspublic/rest/v2/report/liveboard` + +* Security endpoints + +** `POST /tspublic/rest/v2/security/share/tsobject` + +** `POST /tspublic/rest/v2/security/share/visualization` + +** `GET /tspublic/rest/v2/security/permission/tsobject` + +** `GET /tspublic/rest/v2/security/permission/principal` + +** `POST /tspublic/rest/v2/security/permission/tsobject/search` + +** `POST /tspublic/rest/v2/security/permission/principal/search` + +* Custom action endpoints + +** `GET /tspublic/rest/v2/customaction` + +** `POST /tspublic/rest/v2/customaction/create` + +** `PUT /tspublic/rest/v2/customaction/update` + +** `DELETE /tspublic/rest/v2/customaction/delete` + +** `POST /tspublic/rest/v2/customaction/search` + +** `GET /tspublic/rest/v2/customaction/association` + +** `DELETE /tspublic/rest/v2/customactions/association/delete` + +|[tag orangeBackground]#MODIFIED# a| +* The `x-requested-by` header is not mandatory for API requests to the REST API v2 [beta betaBackground]^Beta^ endpoints. +* The `createdBy` attribute in the `/tspublic/rest/v2/metadata/header/search` API is renamed to `author`. +* The attributes with the `boolean` data type in the API endpoints are changed to `string` data type. If a boolean attribute was set as `true` in your existing setup, the value will be changed to `"true"`. +|[tag redBackground]#BREAKING CHANGES# a| + +* Note the change in HTTP request method for the following REST API v2 [beta betaBackground]^Beta^ endpoints: + +** `**PUT** /tspublic/rest/v2/metadata/tag/assign` + +** `**PUT** /tspublic/rest/v2/metadata/tag/unassign` + +** `**PUT** /tspublic/rest/v2/metadata/favorite/assign` + +** `**PUT** /tspublic/rest/v2/metadata/favorite/unassign` + +** `**PUT** /tspublic/rest/v2/metadata/homeliveboard/assign` + +** `**PUT** /tspublic/rest/v2/metadata/homeliveboard/unassign` + +* In the REST API SDK [beta betaBackground]^Beta^, the classes corresponding to enumerations used for string fields such as the `type` field in metadata API, are renamed. If you are using the REST API SDK in your environments, make sure the class names are updated. +|[tag redBackground]#REMOVED# a| The `ownedBy` attribute is removed from the `/tspublic/rest/v2/metadata/header/search` API endpoint. +|==== +==== + +== Version 8.2.0.cl + +//// +=== Custom actions +[width="100%" cols="1,4"] +|==== +|| +|[tag greenBackground]#NEW FEATURE# a| +++
App actions for Slack integration
+++ + +ThoughtSpot introduces app actions[beta betaBackground]^Beta^ to support seamless integration with third-party business apps such as Slack. Your application users can now connect ThoughtSpot with their Slack workspaces and deliver insights directly to Slack channels. + +Users with developer or admin privileges can create an app action for Slack[beta betaBackground]^Beta^ in the Developer portal and add it as a menu action on visualizations and saved answers. On clicking this action, ThoughtSpot users can initiate the Slack integration workflow and send data to their Slack channels without leaving the ThoughtSpot UI. + +For more information, see xref:app-actions.adoc[App actions] and xref:push-data-to-slack.adoc[Push data to a Slack workspace]. +|==== +//// + +.Visual Embed SDK 1.10.x +[%collapsible] +==== +The Visual Embed SDK version 1.10.x introduces new attributes and bug fixes. For more information, see xref:api-changelog.adoc[Visual Embed changelog]. +==== + +.REST API v1 +[%collapsible] +==== +New endpoints for data connection queries. For more information, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog]. +==== + +.REST API v2 [beta betaBackground]^Beta^ + +[%collapsible] +==== +Starting from 8.2.0.cl release, the xref:rest-api-v2.adoc[REST API Playground and SDK] [beta betaBackground]^Beta^ feature is enabled by default on ThoughtSpot instances. + +The 8.2.0.cl release also introduces the following features: + +Endpoint URL path:: +The REST API v2 [beta betaBackground]^Beta^ endpoint URL path is changed from `/api/rest/v2` to `/tspublic/rest/v2/`. For example, the `GET /api/rest/v2/connection` endpoint is now available as `GET /tspublic/rest/v2/connection`. + +Trusted authentication:: +If trusted authentication is enabled on your instance, you can now obtain a login token to authenticate to ThoughtSpot and authorize your API requests. + +For more information, see xref:authentication.adoc#trustedAuthToken[REST API v2 authentication]. + +SDK for .NET clients:: +ThoughtSpot provides the .NET SDK to allow developers to interact with REST APIs from .NET applications. You can download the SDK from NuGet Package Manager and install it using the NuGet GUI. For more information, see xref:rest-api-sdk-libraries.adoc[REST API SDK and client libraries]. + +New API endpoints:: + +* `GET /tspublic/rest/v2/admin/configuration` +* `GET /tspublic/rest/v2/admin/configuration/overrides` +* `PUT /tspublic/rest/v2/admin/configuration/update` +* `PUT /tspublic/rest/v2/admin/resetpassword` +* `PUT /tspublic/rest/v2/admin/syncprincipal` +* `PUT /tspublic/rest/v2/admin/changeowner` +* `PUT /tspublic/rest/v2/user/changepassword` +* `POST /tspublic/rest/v2/data/search` +* `POST /tspublic/rest/v2/data/answer` +* `POST /tspublic/rest/v2/data/liveboard` +* `POST /tspublic/rest/v2/report/answer` +* `GET /tspublic/rest/v2/logs/events` + +//For more information, see xref:rest-api-v2-reference-beta.adoc[REST API v2 Reference]. + +==== + +== Version 8.1.0.cl + +.Visual Embed SDK version 1.9.x +[%collapsible] +==== +The Visual Embed SDK version 1.9.x introduces new action enumerations, events, and attributes. For more information, see xref:api-changelog.adoc[Visual Embed Changelog]. +==== + +.REST API v2 [beta betaBackground]^Beta^ +[%collapsible] +==== +The following REST API v2 endpoints are now available on instances on which the REST API v2 Playground and SDK feature is enabled. + +* `GET /api/rest/v2/connection` +* `POST /api/rest/v2/connection/create` +* `PUT /api/rest/v2/connection/update` +* `DELETE /api/rest/v2/connection/delete` +* `PUT /api/rest/v2/connection/addtable` +* `PUT /api/rest/v2/connection/removetable` +* `POST /api/rest/v2/connection/search` +* `DELETE /api/rest/v2/metadata/delete` +* `GET /api/rest/v2/metadata/header` + +The REST API v2 Playground and SDK is a limited availability feature and is in beta. + +For more information, see xref:rest-api-v2.adoc[REST API v2] and xref:rest-api-v2-reference.adoc[REST API v2 Reference]. +==== + + +== Version 8.0.0.cl + +.Visual Embed SDK version 1.8.x +[%collapsible] +==== +[width="100%" cols="1,4"] +|==== +|| +|[tag redBackground]#BREAKING CHANGE# | +++
Auto login
+++ + +The `autoLogin` attribute is now set as `false` by default. This attribute is used in the `init` method to automatically re-login a user when a user session expires. +|[tag greenBackground]#NEW FEATURE# | +++
Authentication
+++ + +The `init` method now returns an `authPromise` that resolves when the authentication is completed. +|==== + +==== + + +.Embed application +[%collapsible] +==== +[width="100%" cols="1,4"] +|==== +|[tag greenBackground]#NEW FEATURE# a| +++
OpenID Connect authentication
+++ + +ThoughtSpot now supports OpenID Connect (OIDC) authentication framework on embedded instances. Your application users can now authenticate to an authorization server at your OpenID provider and access embedded ThoughtSpot content using their SSO credentials. + +For more information, see xref:configure-oidc.adoc[OpenID Connect authentication]. + +|[tag redBackground]#REMOVED# a| +++
Follow button
+++ + +If you have embedded the full ThoughtSpot application, you will notice that the *Follow* button on the Liveboards page is removed. You can now schedule email notifications using the **Schedule** feature and follow Liveboard updates. +|==== +==== + + +.Visual Embed SDK 1.7.0 + +[%collapsible] +==== +[width="100%" cols="1,4"] +|==== + +|[tag greenBackground]#NEW FEATURE# |+++
OIDC AuthType
+++ + +The SDK supports the `OIDC` `authType` in `init` calls. If you want your application users to authenticate to an OpenID provider and use their SSO credentials to access the embedded ThoughtSpot content, you can enable the `OIDC` authentication type in the SDK. + +For more information, see xref:embed-authentication#oidc-auth.adoc[Authentication and security attributes]. +|[tag greenBackground]#NEW FEATURE# a|+++
Embed events
+++ + +The SDK includes the following new event: + +* `RouteChange` + +For more information, see xref:embed-events.adoc[Events reference]. + +|==== +==== + +.REST API Playground and SDK [beta betaBackground]^Beta^ + +[%collapsible] +==== + +[width="100%" cols="1,4"] +|==== +|[tag greenBackground]#NEW FEATURE# a| +++
REST API Playground and SDK
+++ + +ThoughtSpot introduces the v2 [beta betaBackground]^Beta^ version of REST API endpoints and an interactive Playground to explore the API request and response workflows. + +The API Playground offers several distinct features, such as an interactive code panel, a catalog of resource-oriented endpoint URLs, language-specific SDK and client libraries, code samples, and API reference documentation. + +You can use any standards-compliant HTTP client or use the Playground to make an API call. If you want to construct your queries and process API responses programmatically, you can download the SDK and client libraries in the programming language of your choice and integrate them with your applications. + +The REST API Playground and SDK is a limited availability feature and is in beta. To preview this feature, visit link:https://try-everywhere.thoughtspot.cloud/v2/#/everywhere/api/rest/playgroundV2[ThoughtSpot Live Playground, window=_blank]. To enable this feature on your ThoughtSpot instance, contact ThoughtSpot Support. + +For more information, see xref:rest-api-v2.adoc[REST API v2]. +|==== +==== + + +== Version ts8.nov.cl + +.Developer portal +[%collapsible] +==== +[width="100%" cols="1,4"] +|==== +|[tag orangeBackground]#CHANGE NOTICE# a| +++
Pinboards are now Liveboards!
+++ + +Effective from the ThoughtSpot 8 November Cloud release, ThoughtSpot pinboards are rebranded as Liveboards and optimized for live analytics in cloud deployments. Along with granular insights, Liveboards offer interactive data analytics experience with enhanced capabilities. + +As part of rebranding, we have made some terminology changes in the ThoughtSpot UI and Developer portal. We are in the process of rolling out terminology changes across all ThoughtSpot interfaces, platforms, and information artifacts. During this period, your environment may show some instances of `pinboard` based on the rebranding rollout stage. In some cases, we may even continue to use the legacy terminology for backward compatibility, and to ensure that your existing integrations work seamlessly. For more information, see xref:terminology-update.adoc[Terminology changes]. +|==== +==== + + +.Custom actions +[%collapsible] +==== +[width="100%" cols="1,4"] +|==== +|[tag greenBackground]#NEW FEATURE# a| +++
Custom action association to user groups
+++ + +ThoughtSpot now allows you to restrict a custom action's availability to specific user groups. Developers can associate a custom action to one or several user groups in the Developer portal and allow only authorized users to view and access the custom action on a Worksheet, Answer, or visualization. + +For more information, see xref:customize-actions-menu.adoc#access-control[Custom actions] and xref:custom-actions-url.adoc[Configure a custom URL action]. +|==== +==== + +.User access +[%collapsible] +==== +[width="100%" cols="1,4"] +|==== +|[tag greenBackground]#NEW FEATURE# |ThoughtSpot now supports restricting embed user access to the non-embedded ThoughtSpot application instance. By default, all embedded ThoughtSpot users can navigate to and log in to the non-embedded ThoughtSpot application instance. +If you want to allow only users with administrator or developer privileges to access the non-embedded ThoughtSpot application instance, contact ThoughtSpot Support. +|==== +==== + + +.Visual Embed SDK version 1.6.x +[%collapsible] +==== + +[width="100%" cols="1,4"] +|==== +|[tag greenBackground]#NEW FEATURE# a|+++
Visible actions
+++ + +You can now configure a set of ThoughtSpot UI actions as visible actions and display these actions in the embedded UI. If your embedded instance requires only a few actions, you can use the `visibleActions` API to show only these actions in the embedded ThoughtSpot UI. + +For more information, see xref:embed-actions.adoc[Show or hide UI actions]. + +|[tag orangeBackground]#MODIFIED# | +++
Terminology changes
+++ + +The SDK library and object parameter names are modified to rebrand pinboards as Liveboards. For a complete list of changes, see xref:terminology-update.adoc#sdk-changes[Terminology changes]. + +|[tag greenBackground]#NEW FEATURE# a|+++
Embed events
+++ + +The SDK supports the following new events: + +* `DialogOpen` +* `DialogClose` + +For more information, see xref:embed-events.adoc[Events reference]. + +|==== +==== + +.REST API +[%collapsible] +==== +[width="100%" cols="1,4"] +|==== +|[tag greenBackground]#NEW FEATURE# a|`POST /tspublic/v1/session/login/token` + +This API allows you to send the login token and user information in the request body. For more information, see the xref:session-api.adoc#session-loginToken[REST API reference page]. + +|[tag orangeBackground]#MODIFIED# a| The `/tspublic/v1/connection/create` and `/tspublic/v1/connection/update` endpoints now allow configuring and modifying a connection without importing tables. + +For more information, see xref:connections-api.adoc[Data connection APIs]. +|[tag orangeBackground]#MODIFIED#|You can now filter metadata objects by author GUIDs using the `authorguid` attribute in the `/tspublic/v1/metadata/list` endpoint. + +For more information, see xref:metadata-api.adoc#metadata-list[Get a list of metadata objects]. +|==== + +==== + +.ThoughtSpot application UI +[%collapsible] +==== + +To make it easier for users to find new insights, the **Search data** functionality is moved from the search bar toggle on the **Home** page to the **Search data** button in the main navigation bar. + +Note that if you are embedding the full application without the navigation bar, your application users may not be able to access the **Search data** button. If you must include the Search bar toggle on the **Home** page, contact ThoughtSpot Support to restore this feature on your cluster. + +image:./images/search-toggle.png[Search toggle, width=auto] + +image:./images/search-data-btn.png[Search data button, width=auto] + +==== + +== Version ts7.oct.cl + +.Custom actions +[%collapsible] +==== + +[width="100%" cols="1,4"] +|==== +|[tag orangeBackground]#MODIFIED# a|+++
Custom actions feature availability
+++ + +Starting from ThoughtSpot 7 Cloud October release, you _do not_ require a separate license to create or manage custom actions. The *Custom action* feature is unlocked on all clusters that have a valid ThoughtSpot Enterprise Cloud service subscription. ThoughtSpot Cloud service users with Developer or Admin privileges can access the *Custom actions* feature in the *Develop* tab. + +|[tag redBackground]#REMOVED# a|+++
The Only allow in context menu checkbox +++ + +The *Only allow in context menu* checkbox in the custom action creation dialog is removed from the UI. This checkbox was available in previous releases to allow developers to set a custom action to appear only in the contextual menu on pinboard visualizations, charts, or tables. + +If you have created custom actions with the *Only allow in context menu* setting enabled on your instance, note these custom action workflow changes: + +* If you have a *Global* custom action with the *Only allow in context menu* setting enabled, the configuration setting _is not_ preserved and the action is placed in the **More** image:./images/icon-more-10px.png[the more options menu] menu instead of the contextual menu. ++ +You can xref:custom-actions-edit.adoc[modify the position of this action] by using the *Edit* option in the *Custom actions* panel on a visualization or search results page. + +* If you have a *Local* custom action with the *Only allow in context menu* setting enabled and the action is already assigned to a Worksheet, visualization, chart, or table, the configuration setting _is_ preserved and the custom action shows up in the contextual menu. + +* If you have a *Local* custom action with the *Only allow in context menu* setting enabled, but it is not assigned to a Worksheet, visualization, chart, or table, the action will not be available as a menu item or button. You must add the action to a visualization, chart, or table, and configure its position as required. For more information, see xref:custom-actions-viz.adoc[Add a custom action to a visualization] and xref:custom-actions-worksheet.adoc[Add custom actions to a Worksheet]. + +|==== +==== + +.Visual Embed SDK version 1.5.0 + +[%collapsible] +==== + +The ThoughtSpot 7 Cloud October release introduces the Visual Embed SDK version 1.5.0, which includes the following new features and enhancements. + +[width="100%" cols="1,4"] +|==== +|| +|[tag greenBackground]#NEW FEATURE# | +++
Render embedded objects in queue
+++ + +The SDK now supports rendering embedded objects in a queue. If you have multiple embedded objects, you can enable the `queueMultiRenders` parameter to queue your embedded objects and render them one after another. This feature helps in decreasing the load on the web browsers and improving your application loading experience. By default, this attribute is set to `false`. + +|[tag greenBackground]#NEW FEATURE# a|+++
Liveboard embed
+++ + +The `pinboardEmbed` package includes the `defaultHeight` attribute that sets a minimum height for embedded objects on a pinboard page and the corresponding visualization pages that a user can navigate to. + +For more information, see xref:embed-search.adoc[Embed a pinboard]. + +|[tag greenBackground]#NEW FEATURE# a|+++
Embed events
+++ + +The SDK EmbedEvent library includes the following new events: + +* `VizPointDoubleClick` +* `Drilldown` +* `SetVisibleVizs` + +For more information, see xref:embed-events.adoc[Events reference]. + +|==== +==== + +.REST APIs +[%collapsible] +==== +The ThoughtSpot 7 Cloud October release includes the following new REST API endpoints. For more information about these APIs, see xref:rest-api-reference.adoc[REST API Reference]. + +* `POST /tspublic/v1/group/{groupid}/users` +* `GET /tspublic/v1/group/{groupid}/users` +* `DELETE /tspublic/v1/group/{groupid}/users` +* `PUT /tspublic/v1/user/email` +* `POST /tspublic/v1/user/{userid}/groups` +* `GET /tspublic/v1/user/{userid}/groups` +* `PUT /tspublic/v1/user/{userid}/groups` +* `DELETE /tspublic/v1/user/{userid}/groups` +==== + + +== Version ts7.sep.cl + +.Licensing +[%collapsible] +==== + +[width="100%" cols="1,4"] +|==== +|[tag greenBackground]#NEW FEATURE# a| +++
+++New ThoughtSpot license for embedded analytics +++
+++ + +ThoughtSpot introduces the ThoughtSpot Embedded Edition license that grants access to Developer portal, Playground, customization workflows, Visual Embed SDK, and REST APIs. If you have a ThoughtSpot Enterprise Cloud Service subscription and you want to avail the benefits of ThoughtSpot Embedded analytics, you can now request for a license upgrade. + +The new licensing model introduces several notable changes in the ThoughtSpot Developer portal: + +* On clusters that _do not_ have the ThoughtSpot Embedded Edition license, the ThoughtSpot Developer Portal displays a locked icon next to the customization menu actions. When you click the locked icon, the UI prompts you to sign up for a free trial or upgrade your license. +* The ThoughtSpot Enterprise Cloud service subscribers can either start a 30-day free trial or initiate a license upgrade from the UI. +* Free trial users can initiate a license upgrade request by clicking **Upgrade Now** at any time during the evaluation period, or when the trial expires. +* If you click *Upgrade* or **Upgrade Now**, ThoughtSpot opens the Live Chat Support widget. You can start a conversation with the Sales personnel to initiate the license upgrade. + +For more information about the licensing model and upgrade process, see xref:get-started-tse.adoc[Get started with embedded analytics]. +|==== + +==== + +.Developer portal enhancements +[%collapsible] +==== +[width="100%" cols="1,4"] +|==== +|[tag greenBackground]#NEW FEATURE# a| +++
+++Developer Playground enhancements+++
+++ + +* The *Full app* Playground page includes the *Hide profile and help* checkbox to provide a preview of the `disableHelpAndProfile` function that can hide the Help and Profile icons in the ThoughtSpot navigation bar. + +* The *Full Height* checkbox in *Pinboard* Playground provides a preview of the `fullHeight` attribute that can dynamically resize the embedded pinboard frame according to the height of the pinboard. + +For more information, see xref:developer-playground.adoc[Developer Playground]. +|==== + +==== + +.Visual Embed SDK version 1.4.0 + +[%collapsible] +==== +The ThoughtSpot 7 Cloud September release introduces the Visual Embed SDK version 1.4.0, which includes the following new features and enhancements. + +[width="100%" cols="1,4"] +|==== +|| +|[tag greenBackground]#NEW FEATURE# a|+++
+++Prefetch API+++
+++ + +The `prefetch` API fetches static resources from a given URL before your application loads. Web browsers can then cache the prefetched resources locally and serve them from a user's local disk. You can use this API to load the embedded objects faster and improve your application response time. + +For more information, see xref:prefetch-and-cache.adoc[Prefetch static resources]. + +|[tag greenBackground]#NEW FEATURE# a|+++
+++In-app page navigation+++
+++ + +The `navigateToPage` method in the SDK lets you provide quick and direct access to a specific pinboard, saved Answer, or an application page. You can add a custom menu action or button in your application UI that calls the `navigateToPage` method and leads your users to the page specified in the `path` parameter. + +For more information, see xref:page-navigation.adoc[Add a custom action for in-app navigation]. + +|[tag greenBackground]#NEW FEATURE# a|+++
+++Full application embedding+++
+++ + +The `appEmbed` SDK package includes the following new attributes: + +* The `disableProfileAndHelp` attribute to show or hide the `Help (?)` and the user profile menu in the navigation bar of your embedded app. + +* The `hideObjects` attribute to hide specific objects from a user's page view. + +For more information, see xref:full-embed.adoc[Embed full application]. + +|[tag greenBackground]#NEW FEATURE# |+++
+++Search embed +++
+++ + +The `searchEmbed` package includes the `forceTable` attribute that sets tabular view as the default format for presenting search data. You can use set this attribute to `true` to force search results to appear in the table view. + +For more information, see xref:embed-search.adoc[Embed ThoughtSpot search]. + +|[tag redBackground]#REMOVED# | + +The `searchQuery` parameter is no longer supported and is removed from the `searchEmbed` SDK package. +|[tag greenBackground]#NEW FEATURE# a|+++
+++Embed events +++
+++ +The SDK EmbedEvent library includes the following events: + +* `QueryChanged` +* `AuthExpire` + +For more information, see xref:embed-events.adoc[Subscribe to Events]. +|==== + +==== + +.REST APIs + +[%collapsible] +==== + +The ThoughtSpot 7 Cloud September release includes the following new endpoints and modifications to the REST APIs. For more information, see xref:rest-api-reference.adoc[REST API Reference]. + +.New APIs + +* `POST /tspublic/v1/connection/create` +* `POST /tspublic/v1/connection/update` +* `POST /tspublic/v1/connection/export` +* `POST /tspublic/v1/connection/delete` +* `POST /tspublic/v1/metadata/unassigntag` +* `GET /tspublic/v1/metadata/list` +* `GET /tspublic/v1/security/metadata/permissions` +* `GET /tspublic/v1/security/metadata/{id}/permissions` +* `GET /tspublic/v1/security/effectivepermissionbulk` +* `GET /tspublic/v1/session/info` +* `POST /tspublic/v1/user/activate` +* `POST /tspublic/v1/user/inactivate` +* `POST /tspublic/v1/user/session/invalidate` +* `POST /tspublic/v1/user/resetpassword` +* `PUT /tspublic/v1/group/{groupid}/users` +* `POST /tspublic/v1/group/{groupid}/groups` +* `PUT /tspublic/v1/group/{groupid}/groups` +* `GET /tspublic/v1/group/{groupid}/groups` +* `POST /tspublic/v1/group/addmemberships` +* `POST /tspublic/v1/group/removememberships` +* `DELETE /tspublic/v1/group/{groupid}/groups` + + +.Modified APIs + +* `POST /tspublic/v1/metadata/assigntag` + +==== + +== Version ts7.aug.cl + +.Custom actions +[%collapsible] +==== + +[width="100%" cols="1,4"] +|==== +|| +|[tag greenBackground]#NEW FEATURE# a| +++
Custom actions for worksheets
+++ + +The Worksheet pages now include a `Custom actions` tab that shows the custom actions created in the Developer portal. ThoughtSpot users can add these actions to a Worksheet and place them as primary actions or menu items in the new visualizations built from that Worksheet. + +This feature is available to all ThoughtSpot users who have edit privileges to a Worksheet. + +For more information, see xref:custom-actions-worksheet.adoc[Add custom actions to a Worksheet]. + +|[tag greenBackground]#NEW FEATURE# a| +++
Query parameters for URL-based custom actions
+++ + +The Developer portal now allows you to add arbitrary key-value pairs as query parameters for a URL action. If a URL endpoint requires specific information, such as the database details or data object attributes, you can add a key-value pair of these attributes when creating a custom action. When the custom action workflow is triggered, these attributes are passed as query parameters in `GET` requests to get the data payload from ThoughtSpot. + +For more information, see xref:custom-actions-url.adoc[Configure a custom URL action]. +|==== + +==== + +.Visual Embed SDK version 1.3.1 + +[%collapsible] +==== +The ThoughtSpot 7 Cloud August release supports Visual Embed SDK version 1.3.1, which includes the following features and enhancements. + +[width="100%" cols="1,4"] +|==== +|| +|[tag greenBackground]#NEW FEATURE# a| +++
searchOptions
+++ + +The `searchEmbed` SDK package introduces the `searchOptions` parameter for setting search tokens. The `searchOptions` parameter includes the following attributes: + +* `searchTokenString` ++ +A TML query string to define search tokens. + +* `executeSearch` ++ +When set to `true`, it executes search and shows the search results. + +For more information, see xref:embed-search.adoc#search-query[Embed ThoughtSpot search]. + +|[tag redBackground]#DEPRECATED# a| +++
searchQuery
+++ + +The `searchQuery` parameter in the `searchEmbed` SDK package is deprecated in the Visual Embed SDK version 1.3.1. Instead, you can use the `searchOptions` parameter to define the search token string. + +For more information about `searchOptions`, see xref:embed-search.adoc#search-query[Embed ThoughtSpot search]. + +|[tag greenBackground]#NEW FEATURE# a| +++
autoLogin
+++ + +The SDK now supports logging in users automatically after a user session has expired. + +For more information, see xref:embed-authentication.adoc#embed-session-sec[Embed user authentication]. + +|[tag greenBackground]#NEW FEATURE# a| +++
shouldEncodeUrlQueryParams
+++ + +You can now convert query parameters in the ThoughtSpot generated URLs to base64-encoded format. You can enable this attribute to secure your cluster from cross-site scripting attacks. +|[tag redBackground]#BREAKING CHANGE# a| +++
Data structure changes in custom action response payloads
+++ + +* The data structure passed in the custom action response for search now shows as `payload.data.embedAnswerData` instead of `payload.data.columnsAndData`. + +* The Answer payload for custom actions includes the following metadata: + +** `reportBookmetadata` ++ +Includes visualization metadata attributes such as description, object header metadata, author details, timestamp of the Answer creation, and modification. + +** user data ++ +Includes user information such as username, GUID of the user, and email address. + +To view a sample response payload, see xref:callback-response-payload.adoc#search-data-payload[Custom action response payload]. + +|[tag greenBackground]#NEW FEATURE# a| +++
preventPinboardFilterRemoval
+++ + +The `pinboardEmbed` SDK package now includes the `preventPinboardFilterRemoval` attribute. You can use this attribute to disable the filter removal action and thus prevent users from removing the filter chips added on a pinboard page. + +For more information, see xref:embed-pinboard.adoc[Embed a pinboard] and xref:embed-a-viz.adoc[Embed a visualization]. +|[tag greenBackground]#NEW FEATURE# a| +++
suppressNoCookieAccessAlert
+++ + +You can now set custom alerts for `noCookieAccess` events. By default, the SDK triggers a `noCookieAccess` event and generates an alert when a user's browser blocks third-party cookies. The `suppressNoCookieAccessAlert` allows you to disable this alert. + +|[tag greenBackground]#NEW FEATURE# a| +++
Support for fetching callback custom action payload in batches
+++ + +The Visual Embed SDK now supports processing data in batches for callback custom action responses. +The callback custom action event in the SDK package supports defining `batchSize` and `offset` values to paginate the Answer payload and send the records in batches. + +For more information, see xref:push-data-to-external-app.adoc#large-dataset[Callback custom action workflow]. +|==== + +==== + +.REST APIs +[%collapsible] +==== + +The ThoughtSpot 7 Cloud August release introduces several new APIs to xref:user-api.adoc[manage users], xref:group-api.adoc[user groups], xref:admin-api.adoc[cluster configuration], xref:dependency-apis.adoc[object dependencies], and so on. + +For a complete list of APIs, see xref:rest-api-reference.adoc[REST API Reference]. + +==== + + +== Version ts7.jun.cl + +.Custom actions +[%collapsible] +==== + +[width="100%" cols="1,4"] +|==== +|[tag greenBackground]#NEW FEATURE# a|+++
Global and local custom actions
+++ + +The ThoughtSpot developer portal now supports configuring a custom action as a __global__ or __local__ action. This feature allows you to determine and control the placement of custom actions in the ThoughtSpot UI. Developers can now choose to create a custom action that will appear on all visualizations, or a specific custom action that can be added to a visualization by a ThoughtSpot user. The custom actions panel in the visualization page allows ThoughtSpot users to view the available custom actions and add an action to any visualization. + +For example, if you want an action that triggers a callback into your parent app, which would then post its data to Slack, you might want to add a custom action globally to all visualizations. Similarly, if you want to send the data obtained from a specific visualization to a URL, you can associate a custom action locally to that visualization. + +For more information, see xref:customize-actions-menu.adoc[Custom actions] and xref:custom-actions-viz.adoc[Add a custom action to a specific visualization]. + +|[tag greenBackground]#NEW FEATURE# a|+++
Authentication schemes for custom actions
+++ + +You can now apply an authentication scheme for a custom action that triggers a data payload to a specific URL target. If an action requires your users to authenticate to send data to a URL, you can specify the authentication method and authorization attributes when creating a custom action in the Developer portal. +ThoughtSpot will use this information to send the required attributes in the `Authorization` headers to the URL endpoint configured in the custom action. + +|[tag greenBackground]#NEW FEATURE# a| ++++
Custom action position settings
+++ + +ThoughtSpot users with edit privileges can now define or modify the position of a custom action on visualization pages. When a developer creates a custom action in the Developer portal, ThoughtSpot adds a menu item to the **More** image:./images/icon-more-10px.png[the more options menu] menu by default. ThoughtSpot users can change this to a context menu action or a primary action at any time. + +If your application instance requires an action that sends only a single row of data from charts or tables, developers can configure a custom action and restrict it to only the contextual menu. If this setting is enabled on a custom action, ThoughtSpot users cannot modify this action on a visualization page. + +For more information, see xref:custom-actions-viz.adoc[Add a custom action to a specific visualization]. +|==== + +==== + +.Custom link format for embedded instances +[%collapsible] +==== + +ThoughtSpot generates links to access objects, such as pinboards, visualizations, and answers, when a user shares an object with another user or follows a pinboard to receive periodic notifications. If you have embedded ThoughtSpot in your application, you might want to generate these links in the format that preserves your host application context. + +For embedded instances, ThoughtSpot now allows you to customize the format of these links in the Developer portal. The *Link Settings* page in the Developer portal allows you to customize the link format for various resource URLs and the *unsubscribe* link sent in email notifications. + +For more information, see xref:customize-links.adoc[Customize links]. +==== + +.REST APIs +[%collapsible] +==== + +The ThoughtSpot 7 Cloud June release includes several new and modified APIs: + +.New APIs + +* `POST /tspublic/v1/security/share` ++ +Use this API to share ThoughtSpot objects with another user or user group. For more information, see xref:security-api.adoc#share-object[Share objects with another user]. + +* `POST /tspublic/v1/security/shareviz` ++ +Use this API to share a specific ThoughtSpot visualization with another user or user group. For more information, see xref:security-api.adoc#shareviz[Share a visualization with another user or user group]. + +* `GET /tspublic/v1/session/login/token` ++ +Use this API to get a login token for a ThoughtSpot user when trusted authentication is enabled. For more information, see xref:session-api.adoc#session-loginToken[Authenticate and log in a user]. + +* `POST /tspublic/v1/metadata/assigntag` ++ +Use this API to programmatically assign a tag to a ThoughtSpot object such as a pinboard, Answer, table, or Worksheet. For more information, see xref:metadata-api.adoc#assign-tag[Assign tags to metadata objects]. + +* `POST /tspublic/v1/metadata/details` ++ +Use this API to query metadata details for a specific data object such as a pinboard, Answer, or a Worksheet. For more information, see xref:metadata-api.adoc#metadata-details[Get metadata details]. + +* `POST /tspublic/v1/metadata/markunmarkfavoritefor` ++ +Use this API to add pinboards and answers to a user's favorites list. For more information, see xref:metadata-api.adoc#set-favorite[Set objects as favorites]. + +* `DELETE /tspublic/v1/metadata/markunmarkfavoritefor` ++ +Use this API to remove an object from a user's favorites list. For more information, see xref:metadata-api.adoc#del-object-fav[Remove objects from favorites]. + +* `POST /tspublic/v1/session/homepinboard` ++ +Use this API to set a pinboard as the home pinboard for a user account. For more information, see xref:session-api.adoc#set-home-pinboard[Set a pinboard as a home pinboard]. + +* `GET /tspublic/v1/session/homepinboard` ++ +Use this API to get the GUID of the pinboard set as a home pinboard. For more information, see xref:session-api.adoc#get-home-pinboard[Get details of the home pinboard]. + +* `DELETE /tspublic/v1/session/homepinboard` ++ +Use this API to remove the home pinboard. For more information, see xref:session-api.adoc#del-home-pinboard[Remove a home pinboard]. + + +.Other API enhancements + +The `POST /tspublic/v1/user/updatepreference` API now includes the optional `username` parameter to allow API users to specify the `username` of the ThoughtSpot user whose profile is being modified. +For more information, see xref:user-api.adoc#updatepreference-api[Update a user profile]. + +==== + + +== Version ts7.may.cl + +.Custom actions in the context menu +[%collapsible] +==== +You can now add a custom action to the contextual menu to send data or initiate an action from an embedded visualization. The *Customization* > *Actions* page in the *Develop* tab allows you to add a custom action to the contextual menu for visualizations in the *Answers* or *Pinboards* page. + +For more information, see xref:customize-actions-menu.adoc[Add custom actions]. +==== + +.Visual Embed SDK version 1.2.0 +[%collapsible] +==== + +[width="100%" cols="1,4"] +|==== +|[tag greenBackground]#NEW FEATURE# a|+++
SAML authentication
+++ + +The Visual Embed SDK packages now include the `noRedirect` attribute as an optional parameter for the `SSO` `AuthType`. If you want to display the SAML authentication workflow in a pop-up window, instead of refreshing the application web page to direct users to the SAML login page, you can set the `noRedirect` attribute to `true`. + +For more information, see the instructions for embedding xref:full-embed.adoc[ThoughtSpot pages], xref:embed-search.adoc[search], xref:embed-pinboard.adoc[pinboard], and xref:embed-a-viz.adoc[visualizations]. + +|[tag greenBackground]#NEW FEATURE# a|+++
Visual Embed SDK notification when third-party cookies are disabled
+++ + +When a user accesses the embedded application from a web browser that has third-party cookies disabled, the Visual Embed SDK emits the `NoCookieAccess` event to notify the developer. Cookies are disabled by default in Safari. Users can enable third-party cookies in Safari’s Preferences setting page or use another web browser. +To know how to enable this setting by default on Safari for a ThoughtSpot embedded instance, contact ThoughtSpot Support. + +|[tag greenBackground]#NEW FEATURE# a|+++
Pinboard actions
+++ +The *More* menu image:./images/icon-more-10px.png[the more options menu] in the embedded Pinboard page now shows the following actions for pinboard and visualizations. + +Pinboard:: +* Save +* Make a copy +* Add filters +* Configure filters +* Present +* Download as PDF +* Pinboard info +* Manage schedules + + +[NOTE] +Users with edit permissions can view and access the *Save*, *Add filters*, *Configure filters*, and *Manage schedules* actions. +|[tag greenBackground]#NEW FEATURE# a|+++
Visualization actions
+++ + +Visualizations on a pinboard: + +* Pin +* Download +* Edit +* Present +* Download as CSV +* Download as XLSX +* Download as PDF + +[NOTE] +Users with edit permissions can view and access the *Edit* action. The *Download as CSV*, *Download as XSLX*, and *Download as PDF* actions are available for table visualizations. The *Download* action is available for chart visualizations. + +|==== + +==== + +.Performance optimization +[%collapsible] +==== +This release introduces the following performance improvements for ThoughtSpot embedded applications: + +* Faster loading of embedded objects and application pages. +* Faster loading of preview results in the Playground. +==== +.REST APIs +[%collapsible] +==== +The ThoughtSpot 7 Cloud May release introduces the following REST APIs: + +* `*POST* /tspublic/v1/user/updatepreference` ++ +You can use this API to programmatically update a ThoughtSpot user's profile settings such as the email address, locale preference, notification settings, and the preference for revisiting the onboarding experience. For more information, see xref:user-api.adoc#updatepreference-api[User API]. + +* `*GET* /tspublic/v1/metadata/listas` ++ +You can use this API to get a list of object headers for a ThoughtSpot user or user group. For more information, see xref:metadata-api.adoc#headers-metadata-users[Metadata API]. +==== diff --git a/modules/ROOT/pages/whats-new.adoc b/modules/ROOT/pages/whats-new.adoc index d24d0b805..1ee092727 100644 --- a/modules/ROOT/pages/whats-new.adoc +++ b/modules/ROOT/pages/whats-new.adoc @@ -6,23 +6,116 @@ :page-pageid: whats-new :page-description: New features and enhancements -This page lists new features, enhancements, and deprecated functionality in ThoughtSpot Embedded instances. +This page lists new features, enhancements, and deprecated functionality introduced for ThoughtSpot Embedded instances in 2026. For information about the features introduced in the previous release versions, see xref:whats-new-prev-history.adoc[release history]. -== Version 26.4.0.cl +// ============================================================ +// VERSION TEMPLATE — copy this block for each new release +// ============================================================ +// +// +// [.version-badge.breaking]#Breaking# / +// [.version-badge.new]#New# / +// [.version-badge.deprecated]#Deprecated# / +// [.version-badge.fixed]#Fixed# +// +// *API version string:* `?api-version=YYYY-MM-DD` +// *Status:* Current / Supported / Deprecated +// *Affects:* Developers, Administrators, End Users +// ============================================================ -=== MCP Server with Spotter 3 support for advanced analytics -ThoughtSpot MCP Server now supports a new version powered by the Spotter 3 engine, bringing advanced analytics including "why" questions, forecasting, and multi-step deep research. Additional capabilities include real-time response streaming, session-based follow-up conversations, and inline chart visualizations within MCP-aware clients such as Claude. +== May 2026 +**Release version**: ThoughtSpot Cloud 26.5.0.cl + +*Upgrade notes*: ⚠️Includes breaking changes to Spotter APIs. Refer to the xref:rest-apiv2-changelog.adoc[REST API changelog] for more information. + +*Recommended SDK versions*: Visual Embed SDK v1.48.0 and later -=== Theme builder in AI mode +[.cl-table, cols="2,4", frame=none, grid=none] +|===== +a| +[.cl-label] +*Version 26.5.0.cl* + +a| + +[discrete] +==== Liveboard downloads + +Continuous Liveboard PDF export [beta betaBackground]^Beta^:: +In PDF downloads, Liveboard tabs can now be rendered in a single page matching the UI layout. This feature can be enabled by setting `isContinuousLiveboardPDFEnabled` to `true` in the SDK. Setting this flag to `false` returns to the paginated PDF view. + +Liveboard download in XLSX and CSV formats:: +Embedded Liveboards can now be downloaded in the PDF, XLlX and CSV file formats. To enable this feature, ensure that the `isLiveboardXLSXCSVDownloadEnabled` parameter is set to `true`. + +Excel exports for pivot tables:: +Pivot table visualizations can now be exported to Excel format. + +For more information, see xref:embed-pinboard.adoc#_liveboard_download_options[Liveboard download options]. + +--- + +[discrete] +==== Visualization edit interface within the Liveboard view + +Users can now edit the underlying query of an answer directly within the Liveboard. When this feature is enabled, the edit button for visualization appears in the answer's floating toolbar when the Liveboard is opened in the edit mode. Clicking the edit button opens the Answer interface preloaded with the answer's current query context. You can make the edits and save the changes without leaving the Liveboard. + +--- + +[discrete] +==== KPI charts in embedded Liveboards + +Embedded Liveboards support advanced controls KPI chart customization. For more information, see link:https://docs.thoughtspot.com/cloud/latest/chart-kpi#advanced[KPI charts]. + +--- + +=== Per‑org and per‑user timezone control via variables [beta betaBackground]^Beta^ + +You can centrally control timezone behavior per org and per user in embedded deployments using the new template variable `ts_user_timezone` and variable APIs. + +For multi‑org and multi‑tenant environment, each tenant org and user can be configured independently, guaranteeing isolation and consistency of time‑based analytics across regions. Administrators can reference the timezone variable in formulas to render and filter timestamp data correctly for each embedded user, without separate content per region. + + +[discrete] +==== Visual Embed SDK +The Visual Embed SDK version 1.48.0 includes several new features and enhancements. For more information, see the xref:api-changelog.adoc[Visual Embed changelog]. + +--- + +[discrete] +==== REST API v2 +This release introduces new Spotter API endpoints and modifications to the agent conversation APIs, and deprecates legacy agent endpoints. For information about REST API v2 enhancements, see the xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. + +|===== + + +== April 2026 + +**Release version**: ThoughtSpot Cloud 26.4.0.cl + +*Upgrade notes*: ⚠️Variable update and delete API and metadata parameterization endpoints are deprecated and replaced with new API endpoints. Refer to xref:rest-apiv2-changelog.adoc#version_26_4_0_cl_april_2026[REST API changelog] and xref:deprecated-features.adoc[Deprecation announcements]. + +*Recommended SDK versions*: Visual Embed SDK v1.47.0 and later + +[.cl-table, cols="2,4", frame=none, grid=none] +|=== + +a| +[.cl-label] +*Version 26.4.0.cl* + +a| + +[discrete] +==== Theme builder in AI mode The Theme Builder now has an AI mode that enables developers to explore and preview style customizations for their embedded application’s branding using natural language instructions and uploaded brand assets. You can execute style updates such as applying colors directly from a PDF branding guide, updating all button shapes with higher contrast, matching a header to a dark background based on a screenshot, or importing typography and spacing from a JSON file. In the AI mode, Theme builder interprets your intent and applies the changes instantly. For more information, see xref:theme-builder.adoc[Theme builder]. -=== Webhook integration +--- + + +[discrete] +==== Webhook integration In this release version, the following enhancements are introduced in the webhook configuration and delivery status monitoring workflows: Channel validation:: @@ -34,14 +127,21 @@ Administrators can also monitor the status of a webhook delivery via a `POST /ap Support for custom HTTP headers in webhook requests:: When configuring or updating a webhook, you can now specify custom headers to include in every outbound request, in addition to the standard HTTP and authentication headers that ThoughtSpot sends. For more information, refer to the xref:webhooks-lb-schedule.adoc#_create_a_webhook[webhook documentation]. -=== Spotter embed enhancements +--- + + +[discrete] +==== Spotter embed enhancements You can now customize the appearance and contents of the chat history sidebar panel in Spotter embedding. You can also customize the branding and logo in the Spotter chat interface. For more information, see xref:embed-spotter.adoc#_chat_history_panel[Customizing chat history sidebar] and xref:embed-spotter.adoc#_hiding_the_spotter_icon_and_thoughtspot_branding_chat_interface[Hiding logo and brand label in Spotter chat interface]. -=== Liveboard enhancements +--- + +[discrete] +==== Liveboard enhancements The following enhancements are introduced in Liveboard export and filtering workflows. Embedding a personalized Liveboard view:: @@ -56,7 +156,11 @@ The rolling date filters with the **Last ** and **Next * Liveboard PNG export:: The PNG export workflow in the `/api/rest/2.0/report/liveboard` REST API is enhanced to provide high-resolution PNG files. The legacy PNG workflow is deprecated in 26.4.0.cl. For more information about breaking changes and deprecation guidelines, see xref:deprecated-features.adoc[Deprecation announcements]. For information about the new PNG download workflow, see xref:data-report-v2-api.adoc#_liveboard_report_api[Liveboard report API documentation]. -=== Full app embedding +--- + + +[discrete] +==== Full app embedding In full application embedded deployments with the V3 navigation and home page experience, the default list page experience is set to ListPage v3 experience. The ListPage V3 experience provides a refreshed list layout and styling, including the following enhancements: @@ -67,7 +171,11 @@ The ListPage V3 experience provides a refreshed list layout and styling, includi For more information, see xref:full-app-customize.adoc#_customize_list_page_experience[List page customization]. -=== Variable API enhancements +--- + + +[discrete] +==== Variable API The variable REST API provides new API endpoints for the following bulk operations: * Bulk deletion: @@ -82,12 +190,20 @@ The `/api/rest/2.0/template/variables/update-values` and `/api/rest/2.0/template For more information, see xref:variables.adoc[Variables documentation]. -=== Metadata parameterization +--- + + +[discrete] +==== Metadata parameterization You can now parameterize multiple properties of metadata objects using `POST /api/rest/2.0/metadata/parameterize-fields`. The legacy endpoint `/api/rest/2.0/metadata/parameterize` is deprecated in 26.4.0.cl and later versions, and is replaced with the new endpoint to allow updating multiple fields in a single API request. For more information, see xref:metadata-parameterization.adoc[Metadata parameterization documentation]. -=== Collections [beta betaBackground]^Beta^ +--- + + +[discrete] +==== Collections [beta betaBackground]^Beta^ ThoughtSpot embedded users can now use REST APIs v2 to organize different ThoughtSpot objects into organizational containers called *Collections*. These objects can be Liveboards, Answers, data models, tables, and even other Collections. For more information, see xref:collections.adoc[Collections]. @@ -96,21 +212,44 @@ For more information, see xref:collections.adoc[Collections]. ==== These APIs are currently in beta and turned off by default on ThoughtSpot instances. To enable this feature on your instance, contact ThoughtSpot Support. ==== +--- -=== Visual Embed SDK +[discrete] +==== Visual Embed SDK For information about the new features and enhancements introduced in Visual Embed SDK version 1.46.0, see the xref:api-changelog.adoc[Visual Embed changelog]. -=== REST API v2 + +[discrete] +==== REST API v2 For information about REST API v2 enhancements, see the xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -== Version 26.3.0.cl +--- +|=== + +== March 2026 + +**Release version**: ThoughtSpot Cloud 26.3.0.cl + +*Upgrade notes*: ⚠️Includes feature deprecations. Refer to xref:rest-apiv2-changelog.adoc#_custom_access_token_api[REST API changelog] and xref:deprecated-features.adoc[Deprecation announcements]. + +*Recommended SDK versions*: Visual Embed SDK v1.46.0 and later + +[.cl-table, cols="2,4", frame=none, grid=none] +|=== -=== ThoughtSpot integration with Amazon S3 storage for webhook delivery +a| +[.cl-label] +*Version 26.3.0.cl* + +a| +[discrete] +==== Amazon S3 storage destination for webhook delivery You can now configure ThoughtSpot to deliver webhook payloads and attachments directly into your own Amazon S3 storage using secure AWS cross-account access. To enable this integration, your AWS administrator must create an IAM role with S3 permissions and trust policy, and then register a webhook in ThoughtSpot to deliver the payloads and attachments directly to your S3 bucket. For more information, see xref:webhooks-s3-storage.adoc[Amazon S3 storage integration for webhook delivery]. -=== Host event enhancements for context-aware routing +--- + +[discrete] +==== Host event enhancements for context-aware routing HostEvents in the Visual Embed SDK are enhanced to improve event routing and context targeting in ThoughtSpot embedded applications. @@ -118,7 +257,10 @@ Developers can use the page context framework in the SDK to route host events to For more information, see xref:events-context-aware-routing.adoc[Context-based execution of host events]. -=== JWT-based ABAC implementation +--- + +[discrete] +==== JWT-based ABAC implementation The legacy JWT-based approach that uses `filter_rules` and `parameter_values` to implement Attribute-Based Access Control (ABAC) is deprecated. As part of this deprecation, the following changes have been introduced to the custom authentication token API workflow and REST API Playground: @@ -131,7 +273,10 @@ Existing ABAC implementations that use `filter_rules` will continue to function For new deployments, use ABAC via RLS with custom variables and pass data security attributes through the `variable_values` property in the custom access token, and define your RLS rules based on those variables. For more information, see xref:abac_rls-variables.adoc[ABAC via RLS]. -=== Spotter coaching access across published Orgs +--- + +[discrete] +==== Spotter coaching access across published Orgs Starting with the 26.3.0.cl release, ThoughtSpot supports publishing Spotter coaching information to other Orgs. Coaching changes from the primary Org are synchronized with the data models published in secondary Orgs. Administrators and users with edit access to data models can programmatically control user access to Spotter coaching information using the object privilege REST API endpoint, `/api/rest/2.0/security/metadata/manage-object-privilege`. They can assign `SPOTTER_COACHING_PRIVILEGE` to other users and user groups, allowing access to the coaching information without requiring data model editing or administration privileges. @@ -140,46 +285,73 @@ Users and groups with `SPOTTER_COACHING_PRIVILEGE` can import and export coachin For more information, see xref:spotter-apis.adoc#_spotter_coaching_access[Spotter coaching access]. -//// -=== Spotter embed enhancements -Developers can customize the appearance of the chat history sidebar in the embedded Spotter 3 interface. +--- -For more information, see xref:embed-spotter.adoc#_chat_history_panel[Spotter embed documentation]. -//// - -=== Full application embedding +[discrete] +==== Full application embedding The height and aspect ratio of the logo in the top-left corner of the ThoughtSpot application interface have been updated for visual alignment and consistency across pages. This enhancement is available only in the V3 navigation and home page experience. If you have embedded the full application with the V3 navigation experience, you may notice that the logo appears smaller in the top navigation. This is a design update and does not require any configuration changes to your current embedding implementation. However, we recommend that you review the logo size and appearance, and adjust your custom logo if necessary. For information about adding a custom logo image, see xref:customize-style.adoc#logo-change[Customize application logo and favicon]. -=== Visual Embed SDK +--- + +[discrete] +==== Visual Embed SDK For information about the new features and enhancements introduced in Visual Embed SDK version 1.46.0, see the xref:api-changelog.adoc[Visual Embed changelog]. -=== REST API v2 +--- + +[discrete] +==== REST API v2 For information about REST API v2 enhancements, see the xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -== Version 26.2.0.cl +--- + +|=== + +== February 2026 +**Release version**: ThoughtSpot Cloud 26.2.0.cl + +*Upgrade notes*: ⚠️Includes API parameter deprecations. Refer to xref:rest-apiv2-changelog.adoc[REST API changelog] and xref:deprecated-features.adoc[Deprecation announcements]. + +*Recommended SDK versions*: Visual Embed SDK v1.45.0 and later -=== SpotterCode extension for IDEs [earlyAccess eaBackground]#Early Access# + +[.cl-table, cols="2,4", frame=none, grid=none] +|=== +a| +[.cl-label] +*Version 26.2.0.cl* + +a| +[discrete] +==== SpotterCode extension for IDEs [earlyAccess eaBackground]#Early Access# ThoughtSpot introduces SpotterCode, an AI-powered Model Context Protocol (MCP) extension for Integrated Development Environments (IDEs) such as Cursor, Visual Studio Code, and Claude Code. When integrated, SpotterCode enables the AI agent in the IDE to access ThoughtSpot SDKs and API documentation resources and provide in-context coding assistance to developers embedding ThoughtSpot content within their applications. SpotterCode is available as an Early Access feature and can be integrated with development environments that support MCP servers and tools. For more information, see xref:spottercode.adoc[SpotterCode], xref:spottercode-integration.adoc[Integrating SpotterCode in IDEs], and xref:spottercode-prompt-guide.adoc[SpotterCode prompting guide]. -=== Spotter 3 experience [earlyAccess eaBackground]#Early Access# +--- + +[discrete] +==== Spotter 3 experience [earlyAccess eaBackground]#Early Access# You can now embed the Spotter 3 experience, which introduces several new capabilities, agentic analytics, and enhanced user experience. Spotter 3 is an Early Access feature and is disabled by default on ThoughtSpot embedded instances. For more information, see xref:embed-ai-analytics.adoc[Embed AI Search and Analytics] and xref:embed-spotter.adoc[Spotter embedding documentation]. -=== Rate limits for REST APIs +--- + +[discrete] +==== Rate limits for REST APIs To prevent excessive requests from reaching application servers and ensure API stability and service quality for REST API users, ThoughtSpot enforces rate limits on public API requests per client IP. These limits are applied globally at the cluster level for all public API requests, including calls to both REST API v1 and v2 endpoints. //Administrators can adjust these limits for their ThoughtSpot deployments as needed. For more information, see xref:about-rest-apis.adoc#_rate_limits_for_api_requests[Rate limits for REST APIs]. -=== Security settings via REST APIs +--- + +[discrete] +==== Security settings via REST APIs Security settings that ensure data security and a seamless embedded user experience can now be configured through REST APIs v2. Administrators and developers can configure allowlists for: * Content Security Policy (CSP) @@ -189,2613 +361,118 @@ Security settings that ensure data security and a seamless embedded user experie For more information, see xref:security-settings.adoc[Security Settings]. -=== WebSocket support for external tools +--- + +[discrete] +==== WebSocket support for external tools ThoughtSpot supports secure WebSocket (`wss://`) endpoints for external tool script integrations, for example, tools that open WebSocket connections from the browser. To allow a WebSocket host, add the corresponding `wss://` URL to both your CSP allowlists. Only hosts explicitly listed with the `wss://` protocol are permitted. Existing `https://` entries in the allowlists remain unchanged and continue to function as expected. For more information, see xref:3rd-party-script.adoc#_allow_websocket_endpoints[External tools and script integration]. -=== Visual Embed SDK -For information about the new features and enhancements introduced in Visual Embed SDK version 1.45.0, see the xref:api-changelog.adoc[Visual Embed changelog]. - -=== REST API v2 -For information about REST API v2 enhancements, see the xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. - -== Version 10.15.0.cl - -.Theme Builder -[%collapsible] -==== -Theme Builder is now generally available (GA) and will be rolled out to all ThoughtSpot instances in customer deployments over the next few weeks. - -When this feature is enabled on your instance, you can access it from the *Develop* page in ThoughtSpot and use it to customize styles and UX themes directly within the product. - -For more information, see xref:theme-builder.adoc[Theme Builder]. -==== - -.V3 navigation and home page experience -[%collapsible] -==== -The new V3 navigation and home page experience is now generally available (GA) and can be enabled on ThoughtSpot embedded instances. - -The default UI experience in full application embedding remains the classic (V1) experience until further notice. Developers embedding the full ThoughtSpot application can enable the V3 experience in their applications by setting the appropriate configuration options in their embed code. - -For more information, see xref:full-app-customize.adoc[Customizing full application embedding]. -==== - -.Formula variables in RLS rules -[%collapsible] -==== -You can now create formula variables using the Variable REST API and use these variables in RLS rules for a specific data context and in ABAC token requests to dynamically assign security attributes to users. - -For more information, see xref:abac_rls-variables.adoc[ABAC via RLS with variables]. -==== -.Spotter APIs -[%collapsible] -==== -ThoughtSpot introduces new REST APIs for the following Spotter workflows: -//* To get data source suggestions based on a user's query -* To send queries to a conversation session with the Spotter agent -* To set natural language (NL) instructions on a model to coach the Spotter system -* To fetch NL instructions configured on a model - -For more information, see xref:spotter-apis.adoc[Spotter APIs]. -==== -.Embed events and parameters to intercept API calls -[%collapsible] -==== -You can now intercept API calls from the embedded ThoughtSpot application using the `interceptUrls` attribute in the Visual Embed SDK. This feature lets you control API requests in your embedding application and use embed events to modify, block, or handle requests before they are sent to the backend. For more information, see xref:api-intercept.adoc[Intercept API calls and search requests]. -==== -.Icon customization enhancements -[%collapsible] -==== -You can now replace or customize the chart switcher toggle and icons in the Charts drawer on an Answer or visualization page using SVG sprites. Previously, these icons were fixed to ThoughtSpot defaults and were not configurable. In the new version, these icons are available as SVG components and can be replaced by developers through the xref:customize-icons.adoc[icon customization framework] as needed. -==== -.Mobile Embed SDK -[%collapsible] -==== -The SDKs for embedding ThoughtSpot components in mobile apps are now Generally Available (GA). For more information about the SDKs and how to embed a ThoughtSpot component in a mobile app, see xref:mobile-embed.adoc[Mobile embed documentation]. -==== -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.44.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== -.REST API -[%collapsible] -==== -For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -== Version 10.14.0.cl - -.Code based custom actions -[%collapsible] -==== -ThoughtSpot now enables developers to define custom action in their embed code through the Visual Embed SDK. This enhancement enables code based customization of actions for Liveboards, Visualizations, Answers, and Spotter. With this functionality, developers can add custom actions that show up as new menu options in one of the following UI elements: - -* the primary menu bar -* the **More** options menu image:./images/icon-more-10px.png[the more options menu] -* the contextual menu that appears when a user right-clicks on an Answer or visualization + - -Key characteristics of code-based custom actions: - -* Can be maintained within your codebase to facilitate migration across organizations and clusters. -* Can have controlled visibility in ThoughtSpot by evaluating conditions within your application logic. This approach enables you to dynamically display or hide custom actions based on specific criteria, ensuring that only relevant actions are presented to users in different contexts. -* Can be assigned to Liveboards. -* Can be conditionally displayed based on the presence of a specific column in a visualization. - -For more information, see xref:code-based-custom-actions.adoc[Code based custom actions]. -==== - -.Webhooks for Liveboard schedule events [beta betaBackground]^Beta^ -[%collapsible] -==== -You can now configure a xref:webhooks-lb-schedule.adoc[webhook for Liveboard schedule events] to automate notifications to external applications. This feature allows you to send Liveboard reports directly to a webhook endpoint and create your own custom emails or workflow. - -This feature is currently in beta and is not enabled by default. To enable it on your instance, contact ThoughtSpot Support. -==== - -.Template variables for publishing -[%collapsible] -==== -The variable APIs include several enhancements to streamline variable creation and update workflows. -For information about the new enhancements and breaking changes, see xref:rest-apiv2-changelog.adoc#_variable_api_enhancements[REST API changelog] and xref:variables.adoc[Variables documentation]. -==== +--- -.Parameter chip visibility configuration [tag redBackground]#BREAKING CHANGE# -[%collapsible] -==== -The `HostEvent.UpdateParameters` event in the Visual Embed SDK now includes the `isVisibleToUser` attribute, which allows you to control the visibility of Parameter chips on embedded ThoughtSpot pages. -Before this enhancement, the Parameter chip display behavior was inconsistent across embed types when the Parameter values were updated via `HostEvent.UpdateParameters` requests. With the new change, the `isVisibleToUser` attribute in `HostEvent.UpdateParameters` is set to `false` by default for all embed types. +[discrete] +==== Visual Embed SDK +For information about the new features and enhancements introduced in Visual Embed SDK version 1.45.0, see the xref:api-changelog.adoc[Visual Embed changelog]. -With the new enhancement, the embedded pages that previously kept the parameter chip visible after an override via `HostEvent.UpdateParameters` will now hide it unless the `isVisibleToUser` attribute is explicitly set to `true`. + -This behavior may introduce a breaking change if your current implementation relies on the previous default chip visibility behavior. To retain chip visibility, developers must update their embedding implementation to pass `isVisibleToUser: true` in their `HostEvent.UpdateParameters` requests. +--- -For more information, see xref:runtime-parameters.adoc#_show_or_hide_parameter_chips_in_embedded_sessions[Runtime Parameter overrides]. -==== -.Pre-rendering enhancements -[%collapsible] -==== -Pre-rendering now provides enhanced flexibility and granular control over for rendering embedded ThoughtSpot components. For more information, see xref:prerender.adoc[Pre-rendering ThoughtSpot Embed components]. -==== +[discrete] +==== REST API v2 +For information about REST API v2 enhancements, see the xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.43.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== -.REST API -[%collapsible] -==== -For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== +--- +|=== -== Version 10.13.0.cl -.Spotter AI APIs -[%collapsible] -==== -ThoughtSpot introduces the following new xref:spotter-apis.adoc[Spotter AI APIs] [beta betaBackground]^Beta^, to provide contextual and agentic capabilities for integration with external clients and custom AI applications: +== January 2026 -* `/api/rest/2.0/ai/agent/conversation/create` -//* `/api/rest/2.0/ai/data-source-suggestions` -* `/api/rest/2.0/ai/relevant-questions/` -* `/api/rest/2.0/ai/agent/converse/sse` +**Release version**: ThoughtSpot Cloud 10.15.0.cl + +*Upgrade notes*: No breaking changes. + +*Recommended SDK versions*: Visual Embed SDK v1.44.0 and later -These APIs are designed to build context with each interaction, orchestrate reasoning, and expose tools and skills for natural language analytics. -For more information, see xref:spotter-apis.adoc[Spotter AI APIs]. +[.cl-table, cols="2,4", frame=none, grid=none] +|=== +a| +[.cl-label] +*Version 10.15.0.cl* -//// -With the introduction of these APIs, the following legacy API endpoints will be deprecated: +a| +[discrete] +==== Theme Builder +Theme Builder is now generally available (GA) and will be rolled out to all ThoughtSpot instances in customer deployments over the next few weeks. -* `POST /api/rest/2.0/ai/conversation/create` -* `POST /api/rest/2.0/ai/conversation/{conversation_identifier}/converse` -* `POST /api/rest/2.0/ai/analytical-questions` +When this feature is enabled on your instance, you can access it from the *Develop* page in ThoughtSpot and use it to customize styles and UX themes directly within the product. -The above-listed AI endpoints will be available in the Playground until further notice. However, we recommend using the new APIs for better context management, extensibility, and integration options. -//// -==== +For more information, see xref:theme-builder.adoc[Theme Builder]. -.Support for runtime overrides in Spotter embed -[%collapsible] -==== -You can apply runtime filters and parameter overrides to Spotter sessions and interactions using the Visual Embed SDK. When these overrides are configured in the SDK, they are applied to the data used for Spotter queries, and the generated answers in these sessions will reflect the applied overrides. +--- -The Visual Embed SDK Playground for Spotter embedding includes an option to set runtime overrides. You can test and preview the results before updating your embed code. +[discrete] +==== V3 navigation and home page experience -For more information, see xref:runtime-filters.adoc[Runtime filters] and xref:runtime-parameters.adoc[Runtime Parameters]. -==== +The new V3 navigation and home page experience is now generally available (GA) and can be enabled on ThoughtSpot embedded instances. -.Full application embed experience -[%collapsible] -==== -* The new experience with a sliding navigation panel and modular home page is now available as an Early Access feature for ThoughtSpot embedded application users. -+ -The new experience introduces a left navigation panel with a persona-based app selector and a modular home page with customizable components. This feature is turned off by default on ThoughtSpot. If this feature is enabled on your instance, you can enable it in full application embed using the `discoveryExperience` SDK property. -+ -For more information, see xref:full-app-customize.adoc[V3 navigation and home page experience]. - -* List pages, such as Answers and Liveboards, now include enhanced sorting and filtering capabilities. These pages also allow users to organize, find, and personalize content. Developers can customize the visibility of columns in their embeds by configuring the xref:AppViewConfig.adoc#_hiddenlistcolumns[`hiddenListColumns`] property in the SDK. -+ -For more information, see xref:full-app-customize.adoc#_hide_columns_on_list_pages_new_experience[Hide columns on List pages]. -==== +The default UI experience in full application embedding remains the classic (V1) experience until further notice. Developers embedding the full ThoughtSpot application can enable the V3 experience in their applications by setting the appropriate configuration options in their embed code. -.Worksheet deprecation and removal -[%collapsible] -==== -Worksheets are replaced with Models, and all application workflows will require you to use Models. If you are importing worksheet TMLs, the import operation may fail with an error, requiring users to convert Worksheets to Models. Please update your CI/CD and Git workflows to use Model TMLs instead of Worksheets. +For more information, see xref:full-app-customize.adoc[Customizing full application embedding]. -For more information, see xref:deprecated-features.adoc#_worksheet_deprecation_and_removal[Worksheet deprecation]. -==== +--- -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.42.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== +[discrete] +==== Formula variables in RLS rules -.REST API -[%collapsible] -==== -For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== +You can now create formula variables using the Variable REST API and use these variables in RLS rules for a specific data context and in ABAC token requests to dynamically assign security attributes to users. -== Version 10.12.0.cl +For more information, see xref:abac_rls-variables.adoc[ABAC via RLS with variables]. -.Liveboard grouping and styling [beta betaBackground]^Beta^ -[%collapsible] -==== -You can now create a visual group of Answers and note tiles on an embedded Liveboard and customize the look and feel of the Liveboard, groups, and visualizations using the new styling panel. +--- -The Liveboard styling and grouping feature is disabled by default on embedded apps. To enable this feature on your embed, set `isLiveboardStylingAndGroupingEnabled` to `true` in the SDK and contact ThoughtSpot Support. +[discrete] +==== Spotter APIs -[NOTE] -The `isLiveboardStylingAndGrouping` attribute is now replaced with `isLiveboardMasterpiecesEnabled`. +ThoughtSpot introduces new REST APIs for the following Spotter workflows: -When this feature is enabled, you can use the following CSS variables in the Visual Embed SDK to style your Liveboard elements: +* To send queries to a conversation session with the Spotter agent +* To set natural language (NL) instructions on a model to coach the Spotter system +* To fetch NL instructions configured on a model -* `--ts-var-liveboard-layout-background` -* `--ts-var-liveboard-group-background` -* `--ts-var-liveboard-group-title-font-color` -* `--ts-var-liveboard-group-border-color` -* `--ts-var-liveboard-group-description-font-color` -* `--ts-var-liveboard-group-tile-title-font-color` -* `--ts-var-liveboard-group-tile-description-font-color` +For more information, see xref:spotter-apis.adoc[Spotter APIs]. -For more information, see xref:customize-css-styles.adoc#grp-style[CSS variables reference]. -==== -.Lazy loading of visualizations on a Liveboard -[%collapsible] -==== -To optimize initial load time, you can now enable lazy loading of Liveboard visualizations using the `lazyLoadingForFullHeight` parameter. When both `fullHeight` and `lazyLoadingForFullHeight` attributes are set to `true`, visualizations in the embedded Liveboard are loaded incrementally as the user scrolls, rather than all at once on initial load. For more information, see xref:lazy-loading-fullheight.adoc[Lazy loading of Liveboard visualizations]. -==== +--- -.Spotter embed enhancements -[%collapsible] -==== -Spotter coaching:: -Your application users can now coach Spotter based on an ongoing conversation. -The *Add to coaching* feature is turned off by default on ThoughtSpot instances. To enable this feature, contact your administrator. +[discrete] +==== Embed events and parameters to intercept API calls +You can now intercept API calls from the embedded ThoughtSpot application using the `interceptUrls` attribute in the Visual Embed SDK. This feature lets you control API requests in your embedding application and use embed events to modify, block, or handle requests before they are sent to the backend. For more information, see xref:api-intercept.adoc[Intercept API calls and search requests]. -Spotter Agent embedding:: -To embed Spotter Agent in a React app, the SDK provides a React component and the `useSpotterAgent` custom React hook. For more information, see xref:embed-ts-react-app.adoc#_embed_spotter_agent_in_your_own_app[Embed Spotter Agent in your React app]. +--- -For information about the other SDK enhancements, see xref:_visual_embed_changelog[Visual Embed Changelog]. -==== +[discrete] +==== Icon customization enhancements -.Full application embed -[%collapsible] -==== -In full application embed, developers can now enable the new navigation panel and home page experience. The new experience also organizes the application menu into separate persona-based contextual sections. The new interface also provides a slider to allow users to view or hide the left navigation panel. +You can now replace or customize the chart switcher toggle and icons in the Charts drawer on an Answer or visualization page using SVG sprites. Previously, these icons were fixed to ThoughtSpot defaults and were not configurable. In the new version, these icons are available as SVG components and can be replaced by developers through the xref:customize-icons.adoc[icon customization framework] as needed. -The new navigation experience is disabled by default and is available for Early Access. To enable this feature on your instance, contact your ThoughtSpot administrator and then configure the xref:AppViewConfig.adoc#_discoveryexperience[`discovery experience`] property in the SDK. -==== +--- -.REST API -[%collapsible] -==== [discrete] -==== Connection configuration APIs -ThoughtSpot now supports multiple configurations per data Connection. This feature allows data engineers to define and manage several distinct Connection configurations under a single data Connection object in ThoughtSpot. This feature is available only for Snowflake, Databricks, and BigQuery Cloud Data Warehouses (CDW) connections. +==== Mobile Embed SDK +The SDKs for embedding ThoughtSpot components in mobile apps are now Generally Available (GA). For more information about the SDKs and how to embed a ThoughtSpot component in a mobile app, see xref:mobile-embed.adoc[Mobile embed documentation]. -For more information, see xref:connection-config.adoc[Connection Configuration]. +--- [discrete] -<<<<<<< HEAD +==== Visual Embed SDK +For information about the new features and enhancements introduced in Visual Embed SDK version 1.44.0, see xref:api-changelog.adoc[Visual Embed changelog]. ==== Custom calendar APIs -======= -==== REST API -For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. ->>>>>>> 7c10f998 (whats new and css edits) -You can now create and manage custom calendars for a given Connection object. For more information, see the API documentation in the REST API v2 Playground. For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. +--- [discrete] -==== Other enhancements -For information about other REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.41.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -== Version 10.11.0.cl - -.Spotter embed enhancements -[%collapsible] -==== -Spotter embed now supports a comprehensive set of embed and host events that enable interaction between the embedded Spotter component and the host application. - -Developers can use these events to: - -* Listen for key Spotter user interactions and system events, such as downloads, edits, visual changes, and Spotter-specific query responses, by registering handlers for embed events. -* Trigger specific host events from the application to programmatically control actions such as starting a search, resetting the conversation, saving, downloading, and adding Spotter-generated Answers to a Liveboard. - -For a complete list of events, see the following pages: - -* xref:api-changelog.adoc[Visual Embed SDK changelog] -* xref:EmbedEvent.adoc[EmbedEvent] -* xref:HostEvent.adoc[HostEvent] -==== - -.Primary action configuration for Liveboard visualizations -[%collapsible] -==== -You can now override the action assigned to the primary button that appears on visualization tiles of an embedded Liveboard. The `primaryAction` parameter in the Visual Embed SDK allows developers to set that primary action for the embedded Liveboard visualizations. - -For more information, see xref:embed-actions.adoc#_override_default_primary_actions[Override default primary action]. -==== - -.Enhancements to the API response format for Liveboards -[%collapsible] -==== -The `liveboard_reponse_version` parameter in search metadata (`/api/rest/2.0/metadata/search`) REST API request now allows you to retrieve details of Liveboard tabs, visualizations, and filters in a structured format. - -For more information, see xref:rest-api-v2-metadata-search.adoc#_response_format_for_liveboards[Response format for Liveboard objects]. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.40.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== +==== REST API For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -== Version 10.10.0.cl -.Email customization per Org [beta betaBackground]^Beta^ -[%collapsible] -==== -ThoughtSpot embedded users can now customize their automated email notifications for each Org through REST APIs v2. You can customize features such as the company logo, style, and fonts, visibility of components in the template, and ThoughtSpot-specific content in notification emails, thus ensuring a consistent brand experience. - -For more information, see xref:customize-email-apis.adoc[Customize email template]. - -[NOTE] -These APIs are currently in beta and turned off by default on ThoughtSpot instances. To enable this feature on your instance, contact ThoughtSpot Support. -==== - -.Publishing content to Orgs [beta betaBackground]^Beta^ - -[%collapsible] -==== -The publishing feature enables administrators to publish objects from the Primary Org to other Orgs within a multi-tenant instance. This feature simplifies the deployment process for ThoughtSpot administrators, especially when the same object needs to be made available to multiple Orgs within an instance. It also eliminates the need to create duplicate copies of the object, thereby optimizing memory usage. - -The publishing feature includes a set of REST APIs that ThoughtSpot administrators can use to create and assign variables, parameterize properties of underlying data objects such as Connections and Tables per Org, and publish objects from the Primary Org to other Orgs on their instance. For more information, see xref:publishing-overview.adoc[Publishing content to Orgs]. - -[NOTE] -The publishing feature is in beta and turned off by default on ThoughtSpot instances. To enable this feature on your instance, contact ThoughtSpot Support. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.39.x, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -== Version 10.9.0.cl - -.String IDs for customizing text strings -[%collapsible] -==== -You can now customize a specific occurrence of a text string in the ThoughtSpot UI using string IDs. String IDs allow you to selectively and precisely override the visible text strings in the UI and prevent unintended text changes. - -For more information, see xref:customize-text-strings.adoc[Customize text strings]. -==== -.Mobile embed SDKs -[%collapsible] -==== -ThoughtSpot provides the following new SDKs to embed ThoughtSpot in mobile apps: - -* link:https://github.com/thoughtspot/flutter-embed-sdk[Flutter Embed SDK, window=_blank] [beta betaBackground]^Beta^ to embed ThoughtSpot content in a Flutter app -* link:https://github.com/thoughtspot/swift-embed-sdk[Swift Embed SDK, window=_blank] [beta betaBackground]^Beta^ to embed ThoughtSpot content in an iOS native app -* link:https://github.com/thoughtspot/android-embed-sdk[Android Embed SDK, window=_blank] [beta betaBackground]^Beta^ to embed ThoughtSpot content in an Android native app - -For more information and quickstart guides, see xref:mobile-embed.adoc[Mobile embed documentation]. -==== -.Spotter embed components -[%collapsible] -==== -The following Spotter embed components are now deprecated and replaced with new components: - -* `ConversationEmbed` + -Replaced with `SpotterEmbed` -* `ConversationViewConfig` + -Replaced with `SpotterEmbedViewConfig` -* `BodylessConversation` + -Replaced with `SpotterAgentEmbed` -* `BodylessConversationViewConfig` + -Replaced with `SpotterAgentEmbedViewConfig` - -[discrete] -==== Impact on Spotter embed deployments -The new Spotter embed components are available for use with the Visual Embed SDK v1.38.0 and later. -The `ConversationEmbed`, `ConversationViewConfig`, `BodylessConversation`, and `BodylessConversationViewConfig` components are deprecated in Visual Embed SDK v1.38.0 and later versions. -The old component names will be visible in the code panel of the Visual Embed Playground on ThoughtSpot instances with 10.9.0.cl or earlier. The component names in the Playground will be updated in an upcoming version. - -[discrete] -==== Recommended action -The Spotter embed component changes do not break your existing Spotter embed implementation. Your implementation with the old component names will continue to function until further notice. However, ThoughtSpot recommends transitioning to the new names as early as you can, to allow sufficient time for testing your implementation with the updated names. - -For Spotter embed documentation and code samples with new components, see xref:embed-spotter.adoc[Embed Spotter]. -==== -.Ability to control the visibility of columns in full app embedding -[%collapsible] -==== -You can now show or hide the following columns on the *Liveboards*, and *Answers* list pages in full application embeds: - -* `Favorite` -* `Author` -* `Last modified` -* `Tags` -* `Share` - -For more information, see xref:full-app-customize.adoc#_hide_columns_on_list_pages_new_experience[Customize full application embedding]. -==== -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.38.x, see xref:api-changelog.adoc[Visual Embed changelog]. -==== -.REST API -[%collapsible] -==== -For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== -.REST API Java SDK -[%collapsible] -==== -The REST API Java SDK enables developers to interact programmatically with ThoughtSpot REST APIs from Java applications. It provides a client library with Java methods and classes that map to API endpoints, handle authentication, send API requests, and allow creating and modifying ThoughtSpot resources and objects. - -For information about how to install and use the SDK, see xref:rest-api-java-sdk.adoc[Java SDK for REST APIs]. -==== - -== Version 10.8.0.cl - -.React Native SDK to embed ThoughtSpot in a mobile app [beta betaBackground]^Beta^ -[%collapsible] -==== -Developers can now embed ThoughtSpot Analytics in their mobile apps using the React Native Embed SDK [beta betaBackground]^Beta^. With the React Native Embed SDK, developers can use native resources and a single codebase to build their mobile app with embedded ThoughtSpot content for both *iOS* and *Android* platforms. - -In the initial release, the SDK supports embedding a Liveboard component and customizing the embedded view. For more information, see xref:mobilesdk-quick-start.adoc[React Native SDK quick start guide]. -==== -.External tools and custom script integration -[%collapsible] -==== -You can now integrate third-party tools and execute custom scripts within your embed. This feature is disabled by default on ThoughtSpot instances. When enabled, you can use this feature to integrate your preferred analytics and product-guide tools such as Pendo, LogRocket, and Mixpanel into your ThoughtSpot embed. - -While you can inject custom Javascript into your embeds, it is essential to consider the associated security risks and vulnerabilities, such as Cross-site scripting (XSS). Before contacting Support to enable this feature on your instance, assess the potential security risks to your application environment and review your organization's security guidelines. We recommend that you sanitize user data before rendering and ensure that your environment runs scripts from trusted domains only. For more information, see xref:3rd-party-script.adoc[Integrate third-party tools and scripts]. -==== -.Recommended action for deployments that use pendoTrackingKey -[%collapsible] -==== -If you are using the xref:EmbedConfig.adoc#_pendotrackingkey[pendoTrackingKey] setting in the Visual Embed SDK, note that ThoughtSpot will deprecate this attribute six months after the 10.8.0.cl release. While you can continue using `pendoTrackingKey` until its deprecation, we recommend using the xref:3rd-party-script.adoc[external tools integration] feature to integrate your preferred tool for analytics and product guides. For additional information or migration assistance, contact ThoughtSpot Support. -==== -.Help menu and information center changes -[%collapsible] -==== -In the 10.8.0.cl release, ThoughtSpot introduces a unified help and support experience that will eventually replace the information center panel generated by Pendo. -The new information panel provides access to ThoughtSpot documentation and support and also allows you to add custom links. This feature will be enabled gradually on ThoughtSpot instances. - -This change will affect your instance if you have embedded the full ThoughtSpot experience with the top navigation bar and Help (?) icon, using `showPrimaryNavbar: true` and `disableProfileAndHelp: false` settings in the Visual Embed SDK. - -Customer environments currently using the legacy information center during embedded sessions will continue to do so for the next few months to minimize disruption. Your ThoughtSpot Customer Success team will contact you and assist you in migrating to the new experience. - -To facilitate testing and the rollout of the new information center, ThoughtSpot provides the xref:AppViewConfig.adoc#_enablependohelp[enablePendoHelp] SDK flag. By default, the `enablePendoHelp` is set to `true` to ensure that your embedded sessions use the legacy information center generated by Pendo. To enable the new experience, you need to set `enablePendoHelp` to `false`. -==== -.Column name localization [beta betaBackground]^Beta^ -[%collapsible] -==== -ThoughtSpot now supports column name and description aliases in a Worksheet or Model, which can be used for localizing the Search and Answer interfaces. This feature is disabled by default on ThoughtSpot instances. To enable this feature, contact ThoughtSpot support. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.37.x, see xref:api-changelog.adoc[Visual Embed changelog]. -==== -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -== Version 10.6.0.cl - -.Spotter embed enhancements -[%collapsible] -==== -Spotter is enabled on ThoughtSpot instances by default and is now generally available for embedding in your applications and chatbot. - -This release also introduces several enhancements to Spotter embed: - -* xref:embed-spotter.adoc#configControls[Configuration controls in the SDK] to disable or hide the data source, and show or hide sample questions -* xref:embed-spotter.adoc#SpotterCSS[Customization controls for CSS overrides], xref:embed-spotter.adoc#spotterMenuActions[action IDs] for menu customization on the Spotter page. -* Additional options in the xref:developer-playground.adoc#playground-spotter[Spotter Playground experience], which allow users to explore the customization settings available for Spotter. - -For more information, see xref:embed-spotter.adoc[Embed Spotter]. -==== -.Theme builder for ThoughtSpot interface customization [beta betaBackground]^Beta^ -[%collapsible] -==== -ThoughtSpot now offers link:https://developers.thoughtspot.com/docs/theme-builder[Theme Builder, window=_blank] [beta betaBackground]^Beta^, a graphical representation of CSS controls and themes to assist developers with the CSS customization framework. Theme Builder allows you to explore and preview the CSS customization options available with the Visual Embed SDK to customize the look and feel of the ThoughtSpot application interface. - -Developers embedding ThoughtSpot can preview the customization options in Theme Builder for various embed components, including Liveboard, Visualizations, Search page, and the full application experience. Additionally, you can view and download the default CSS variables in JSON format and upload a JSON file containing custom values for these CSS variables. - -For more information, see xref:theme-builder.adoc[Theme Builder]. -==== -.Multi-Factor authentication and REST API behavior -[%collapsible] -==== -ThoughtSpot now supports Multi-Factor authentication (MFA) [beta betaBackground]^Beta^ for environments using local authentication with IAMv2. MFA is in beta and disabled by default on ThoughtSpot instances. When enabled on a ThoughtSpot instance, administrators can enable MFA for all local users authenticating to ThoughtSpot with `username` and `password`. - -[tag redBackground]#BREAKING CHANGE# - -When MFA is enabled on your ThoughtSpot instance, using basic authentication in REST API calls to the following API endpoints will result in an error: - -* `POST /api/rest/2.0/auth/session/login` -* `POST /api/rest/2.0/auth/token/object` -* `POST /api/rest/2.0/auth/token/full` -* `POST /api/rest/2.0/auth/token/custom` -* `POST /tspublic/v1/session/login` - -When MFA is enabled on a ThoughtSpot instance, local authentication users cannot log in with their `username` and `password` and are prompted to enable MFA when they try to log in via UI. Setting up MFA via APIs is not supported. - -If you are using REST APIs with basic authentication, ThoughtSpot recommends updating your application environment to use `username` and `secret_key` to generate authentication token. To stay security compliant and avoid breaking changes, before activating MFA for your users, we recommend that you enable *Trusted Authentication* on your instance and set up your embed and REST API environments to use token-based authentication. For more information and assistance, contact ThoughtSpot Support. -==== -.Liveboard enhancements -[%collapsible] -==== -[discrete] -==== Compact Liveboard header [earlyAccess eaBackground]#Early Access# - -Developers embedding ThoughtSpot Liveboards can now enable the Compact Liveboard feature for their application users. When enabled, this feature optimizes Liveboard header space, moves the tabs panel to the top of the header, and maximizes the visibility of the charts and tables on the Liveboard. - -Compact Liveboard header is disabled by default. To enable this feature, set `isLiveboardCompactHeaderEnabled` to `true` in the SDK. - -[discrete] -==== Show only relevant filters and Parameters on Liveboards - -By default, Liveboards display all filters and parameters, including those that are not applicable to the visualizations in a tab. On embedded Liveboards, developers can control the visibility of filters and Parameters for visualizations in a tab using the `hideirrelevantchipsinliveboardtabs` property in the SDK. - -For more information about filters for Liveboard tabs, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-filters#_apply_filters_to_specific_visualizations_or_tabs[Apply filters to specific visualizations or tabs]. -==== -.Worksheet to Model conversion -[%collapsible] -==== -You can now convert a Worksheet to a Model via a REST API POST call to the -+++/api/rest/2.0/metadata/worksheets/convert+++ endpoint. - -ThoughtSpot recommends migrating your Worksheet data to Models, because Worksheets are deprecated in ThoughtSpot and will be removed from the product in 10.10.0.cl release. -==== -.ThoughtSpot Enterprise Org enablement -[%collapsible] -==== -Starting with ThoughtSpot Cloud 10.6.0.cl release, all ThoughtSpot Enterprise instances will gradually be enabled with Orgs. Your environment will remain a single-tenant instance until you create Orgs. When the Orgs feature is enabled on your instance, you can switch to a single-tenant mode anytime by deleting all user-created Orgs and using only the default Primary Org. -==== -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.36.x, see xref:api-changelog.adoc[Visual Embed changelog]. -==== -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -== Version 10.5.0.cl - -.Default search experience on embedded ThoughtSpot Home page -[%collapsible] -==== -If your ThoughtSpot instance is upgraded from 10.1.0.cl to 10.5.0.cl, the Natural Language Search interface will be the default search experience on the embedded ThoughtSpot Home page. The split search experience, which was introduced in 10.3.0.cl, will be turned off by default on these instances. For applications embedding full ThoughtSpot experience, the `isUnifiedSearchExperienceEnabled` property will be set to `true` in the Visual Embed SDK. Your application users can continue to use the unified experience until it is deprecated. However, developers can choose to disable the unified search experience and customize the Home page search experience for their application users. - -On instances upgraded from 10.3.0.cl or 10.4.0.cl to 10.5.0.cl, Object Search will be the default search experience on the embedded ThoughtSpot Home page. The unified search experience will be disabled by default and the `isUnifiedSearchExperienceEnabled` property in the Visual Embed SDK will be set to `false`. If required, developers can switch to AI Search experience by setting the `homePageSearchBarMode` property to `aiAnswer`. - -For more information, see xref:full-app-customize.adoc#_search_experience_on_home_page[Home page search experience customization]. -==== -.Support for partitioned cookies -[%collapsible] -==== -With most web browsers blocking third-party cookies, cookies will no longer be shared across the ThoughtSpot -embedded pages and the host application, or other tabs in the browser. If your embed no longer functions without the use of third-party cookies, consider using one of the following options: - -* Update your implementation to use cookieless authentication; for example, `AuthType.EmbeddedSSO` or `AuthType.TrustedAuthTokenCookieless` (Recommended) -* Customize the domain of your ThoughtSpot instance to match the domain of your host application. + -For more information, see xref:custom-domain-configuration.adoc[Custom domain configuration]. -* Enable partitioned cookies on your ThoughtSpot instance. + -If your implementation relies on cookies or if you are using `AuthType.None` in your development and test environments, ThoughtSpot administrators have the option to enable partitioned cookies on their instance. With partitioned cookies, you can restrict cookie sharing between different sites and thus prevent cross-site tracking. -+ -On browsers that support partitioned cookies, the session cookie will persist in the ThoughtSpot app after a successful login. When using the `AuthType.None` embed authentication method in development or test environments with partitioned cookies, users must log in to their ThoughtSpot instance using basic authentication for seamless access to the embed. -+ -[NOTE] -Safari blocks all third-party cookies and does not support partitioned cookies. ThoughtSpot recommends switching to a Web browser that supports partitioned cookies or using cookieless authentication. - -For more information, see xref:security-settings.adoc#_enable_partitioned_cookies[Security Settings]. -==== - -.ABAC via tokens implementation changes -[%collapsible] -==== -The ABAC via tokens feature is GA in 10.5.0.cl. Several changes have been introduced since the ThoughtSpot 10.4.0.cl release to improve the ABAC configuration workflows: - -* The `user_parameters` property in `auth/token/full` and `auth/token/object` APIs used for the xref:abac-user-parameters-beta.adoc[beta implementation of ABAC] was deprecated in 10.4.0.cl. -* Starting from 10.4.0.cl, administrators are advised to xref:abac-user-parameters.adoc[use the `/api/rest/2.0/auth/token/custom` API endpoint] to define security attributes for ABAC implementation. - -If you have implemented ABAC using `auth/token/full` or `auth/token/object` API endpoints and your cluster is upgraded to 10.4.0.cl or 10.5.0.cl, you can migrate your implementation to start using the `/api/rest/2.0/auth/token/custom` API endpoint. For more information, refer to xref:jwt-migration.adoc[ABAC migration guide]. -==== -.Orgs context for custom links -[%collapsible] -==== -Starting with ThoughtSpot Cloud 10.5.0.cl release, developers embedding ThoughtSpot in their application can include the Org context in ThoughtSpot URLs using custom link settings. -//For instance, being able to seamlessly access content from a different Org, while being logged in another Org. - -This feature is turned off by default. To enable this feature on your ThoughtSpot instance, contact link:https://community.thoughtspot.com/customers/s/contactsupport[ThoughSpot Support, window=_blank]. For more information, see xref:orgs.adoc[Orgs context for sharing links]. -==== - -.Migration to IAMv2 -[%collapsible] -==== -All new ThoughtSpot application instances are enabled with enhanced Identity and Access Management (IAMv2). The existing ThoughtSpot embedded instances will be migrated to IAMv2 during the maintenance windows. - -* To ensure a seamless migration, review and follow the link:https://docs.thoughtspot.com/cloud/latest/okta-iam#_before_migrating_to_iam_v2[steps in the ThoughtSpot product documentation, window=_blank]. -* To understand changes to the API endpoints with this upgrade, see xref:api-user-management.adoc[User migration to IAMv2] -* For more information, see link:https://docs.thoughtspot.com/cloud/latest/okta-iam[Identity and Access Management V2, window=_blank]. -==== -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.35.x, see xref:api-changelog.adoc[Visual Embed changelog]. -==== -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== -== Version 10.4.0.cl - -.Spotter AI for conversational analytics -[%collapsible] -==== -ThoughtSpot Spotter [beta betaBackground]^Beta^ enables users to find insights from their data through a conversational interface powered by Generative AI. Spotter functions as your AI Analyst and allows your application users to start a conversation, ask follow-up questions on the results generated by ThoughtSpot, and get the data they need. - -For more information, see the following pages: - -* xref:embed-spotter.adoc#_embed_spotter_using_visual_embed_sdk[Embed Spotter in your app] + -* xref:spotter-apis.adoc[Generate Answers from AI APIs] -* xref:spotter-in-custom-chatbot.adoc[Spotter tutorials] - -[NOTE] -The Spotter feature is in beta and disabled by default on ThoughtSpot Embedded instances. To enable this feature on your instance, contact ThoughtSpot Support. -==== - -.ABAC token generation enhancements -[%collapsible] -==== -To generate a token with custom rules, attributes, and filter conditions for Attribute-Based Access Control (ABAC) [beta betaBackground]^Beta^, you can use the `/api/rest/2.0/auth/token/custom` API endpoint instead of the `user_parameters` property in `/api/rest/2.0/auth/token/full` and `/api/rest/2.0/auth/token/object` APIs. - -For more information, see xref:authentication.adoc#_get_tokens_with_custom_rules_and_filter_conditions[Get tokens with custom rules and filter conditions]. -==== - -.Visual Embed Playground enhancements -[%collapsible] -==== -The Visual Embed Playground provides several checkboxes and customization settings for ThoughtSpot embed components. You can use these checkboxes to customize your embedded view, view results instantly, and copy code. - -For more information, see xref:developer-playground.adoc[Visual Embed Playground]. -==== -.Models -[%collapsible] -==== -Models are now available on ThoughtSpot embedded instances. ThoughtSpot recommends using Models as data source objects for Answers and Liveboards instead of Worksheets from 10.4.0.cl release onwards. - -Worksheets are deprecated in 10.4.0.cl and will be removed from ThoughtSpot in an upcoming release. If you are embedding full ThoughtSpot application or the Data Workspace page in your app, you will notice that the Worksheet creation option is disabled by default. However, existing Worksheets continue to be available and editable. To enable Worksheet creation on your instance, contact ThoughtSpot Support. -==== -.Orgs enablement -[%collapsible] -==== -Starting with ThoughtSpot Cloud 10.4.0.cl release, Orgs will be enabled by default on all new ThoughtSpot instances. Your environment remains a single-tenant instance until you create Orgs. -If the Orgs feature is enabled on your instance, you can switch to a single-tenant mode anytime by deleting the Orgs and using just the Primary Org. - -For more information, see xref:orgs.adoc[Multi-tenancy with Orgs]. -==== -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.34.x, see xref:api-changelog.adoc[Visual Embed changelog]. -==== -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -.Feature deprecations -[%collapsible] -==== -The Search Assist feature for Worksheets and the **Enable Search Assist** checkbox in Search Embed Playground are removed from ThoughtSpot in 10.4.0.cl. If your embedding application uses the `enableSearchAssist` property, you may want to update your deployment. - -For more information, see xref:deprecated-features.adoc#_search_assist[Deprecated features]. -==== - -== Version 10.3.0.cl - -.Natural language search and object search -[%collapsible] -==== -Starting from the ThoughtSpot 10.3.0.cl release, the **Home** page does not provide a combined search experience with Natural Language Search and Object Search. As a result, Object Search will become the default search experience on the **Home** page, and Natural Language Search will be disabled by default. - -If you are embedding the **Home** page of ThoughtSpot application in your app, and you want to retain both the object Search and Natural Language Search experience for your users, you can customize the search type in the Visual Embed SDK. For more information, see xref:full-app-customize.adoc#_customize_search_experience[Search experience customization]. -==== - -.Selective user access -[%collapsible] -==== -With selective user access, you can allow users without the administrator or developer privilege to securely access the non-embedded pages. - -For more information, see xref:selective-user-access.adoc[User access to non-embedded content]. -==== - -.Liveboard experience enhancements -[%collapsible] -==== -You can now customize the width of the Liveboard breakpoint on an embedded instance. To enable it, you must set the `enable2ColumnLayout` property to `true`. - -For more information, see xref:embed-pinboard.adoc#_redefine_liveboard_breakpoint_widths[Redefine Liveboard breakpoint widths]. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.33.x, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -.Feature deprecations -[%collapsible] -==== -In the 10.3.0.cl release, the application background customization option on the **Admin** > **Style customization** and **Develop** > **Customizations** > **Styles** is deprecated. For more information, see xref:deprecated-features.adoc#_application_background_customization_via_ui[Application background customization]. -==== - -== Version 10.1.0.cl - -.Customization of the new Data Panel experience -[%collapsible] -==== -The CSS customization framework now supports customizing the look and feel of the new Data Panel experience. For more information, see xref:embed-search.adoc#_data_panel_experience_in_the_embedded_search_page[Embed Search] and xref:css-customization.adoc[CSS customization framework]. -==== - -.UI changes in the Liveboard and Answers list pages -[%collapsible] -==== -If you have embedded full application experience with **Liveboards** and **Answers** listing pages, note the following UI changes: - -* The *Edit TML*, *Export TML*, and *Import TML* actions are no longer available on the *Liveboards* and *Answers* listing pages. You can use the TML menu actions on the individual Liveboard and Answer pages, or the import and export TML options available on the **Data Workspace** > **Utilities** page. -* To add new tags or assign a tag to an object, users can use the **Edit tags** button on the **Liveboards** and **Answers** pages. However, users cannot rename or delete a tag. -==== -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.32.x, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -.Feature deprecations -[%collapsible] -==== -In 10.1.0.cl release, the following features are deprecated and removed from the UI: - -* Classic experience mode for Liveboards, SpotIQ, and Answers. For more information, see xref:deprecated-features.adoc#_classic_experience_for_liveboards_answers_and_spotiq[Deprecation announcements]. -* Page title customization setting in the **Admin** > **Style customization** and **Develop** > **Customizations** > **Styles** page. For more information, see xref:deprecated-features.adoc#_page_title_customization[Deprecation announcements]. -==== - -== Version 10.0.0.cl - -.Customize number, currency, and date format -[%collapsible] -==== -You can now customize the number, date, and currency format displayed on embedded pages. - -For more information, see xref:locale-setting.adoc#_set_locale_in_the_sdk[Set locale]. -==== -.Git integration -[%collapsible] -==== -If xref:roles.adoc[RBAC] is enabled on your instance, ensure that the Version Control API users have the `Can manage version control` (`CAN_MANAGE_VERSION_CONTROL`) Role privilege. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.31.x, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information on REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -.Feature deprecations -[%collapsible] -==== -For information about deprecated features, see xref:deprecated-features.adoc[Deprecation announcements]. -==== - -== Version 9.12.5.cl - -.New home page and navigation [earlyAccess eaBackground]#Early Access# -[%collapsible] -==== -The new navigation and Home page experience is now available for ThoughtSpot users. - -ThoughtSpot administrators can enable this feature on their application instance on the **Admin** page. If the new navigation and Home page experience is enabled on your instance, users can turn on the New Experience mode on their *Profile* settings page. - -On embedding apps, the new navigation and Home page experience is disabled by default. To enable it, you must set the `modularHomeExperience` property to `true` in the `AppEmbed` component. - -The new navigation and Home page experience introduces the following notable changes: - -* The top navigation menu bar is replaced with an app selector image:./images/app_switcher.png[the app switcher menu] that allows users to switch between different apps. -* The **Insights** module presents a redesigned Home page with modular content and a left navigation panel. Users can navigate to Liveboards, Answers, SpotIQ Analysis, and Monitor Subscriptions pages from the Home page by using the left navigation menu options. - -For more information, see xref:full-app-customize.adoc[Customize full application embedding]. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.30.x, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -== Version 9.12.0.cl - -.SSO authentication with IAMv2 -[%collapsible] -==== -ThoughtSpot now supports managing user authentication through IAMv2 on embedded instances. With this feature, administrators can set up SAML and OIDC authentication with Identity providers such as Okta, Google, and so on. You can also map Identity Provider (IDP) attributes on the ThoughtSpot Admin page when setting up OIDC or SAML authentication on your instance. - -IAMv2 is turned off by default. To enable it on your instance, contact ThoughtSpot Support. - -For more information, see xref:configure-saml.adoc#IAMv2[SAML SSO authentication] and xref:configure-oidc.adoc#IAMv2[OpenID Connect authentication]. -==== - -.OIDC authentication on Orgs-enabled clusters -[%collapsible] -==== -ThoughtSpot now supports Orgs through OpenID Connect (OIDC) authentication on embedded instances. With Org mapping, the IdP will have the ability to assign users to specific Orgs when they log in via OIDC authentication. You need administrator privileges to enable Org mapping on the cluster. - -For more information, see xref:orgs.adoc#_oidc_authentication[Multi-tenancy with Orgs] and xref:configure-oidc.adoc#orgMapping[OpenID Connect authentication]. -==== - -.Ask Sage [beta betaBackground]^Beta^ -[%collapsible] -==== -ThoughtSpot application users can now ask follow-up questions and seek clarifications about visualizations and Answers generated using natural language search. The **Ask Sage** action on Liveboard visualizations and **Ask a follow-up** action search results page allow you to start a conversation with the AI analyst, ask successive questions, and refine the Answer retrieved from a Natural Language Search query. - -The **Ask Sage** feature is turned off by default. To enable this feature on your instance, contact ThoughtSpot Support. To enable or disable this feature for embedded application users, use the `enableAskSage` attribute. -==== - -.Liveboard UI changes -[%collapsible] -==== -The following TML menu actions are now grouped under the *TML* sub-menu of the **More** image:./images/icon-more-10px.png[the more options menu]menu. - -* Export TML -* Edit TML -* Update TML -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.29.x, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - - -== Version 9.10.5.cl - -.Row-level security via tokens [beta betaBackground]^Beta^ -[%collapsible] -==== -You can now implement Row-Level Security (RLS) and Attribute-Based Access Control (ABAC) via tokens for ThoughtSpot embedded application users. You can now configure your authentication process in the SDK to assign security attributes for any user during session creation. - -For more information, see xref:abac-user-parameters.adoc[ABAC via token]. - -[NOTE] -ABAC via tokens is supported only with the Trusted Authentication method. -==== - -.AI Highlights [earlyAccess eaBackground]#Early Access# - -[%collapsible] -==== -You can now get quick insights on how top metrics have changed in your Liveboard via AI Highlights. - -* Users with administration privileges can enable AI Highlights at the cluster level on the **Admin** page. -* When AI Highlights is enabled, the AI highlights image:./images/ai-highlights.png[AI Highlights icon] icon appears on the Liveboard header and the **Edit** button moves to the **More** menu image:./images/icon-more-10px.png[the more options menu]. -* You can hide this feature on your embedded instance by adding `Action.AIHighlights` to the `hiddenActions` array in the SDK. - -For more information, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-ai-highlights[AI Highlights, window=_blank]. -==== - -.Granular Roles for data management -[%collapsible] -==== -If the RBAC is enabled on your ThoughtSpot instance, administrators can use the following Roles for granular access control and data management: - -* `CAN_MANAGE_CUSTOM_CALENDAR` -* `CAN_CREATE_OR_EDIT_CONNECTIONS` -* `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` - -For more information, see xref:roles.adoc[Role-based access control]. - -[NOTE] -The RBAC feature is in beta and turned off by default. To enable this feature, contact ThoughtSpot Support. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.29.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - - -== Version 9.10.0.cl - -.Integration with Vercel projects -[%collapsible] -==== -You can now integrate your ThoughtSpot instance with a Vercel project. If you are using Vercel to build and maintain your embedding application, you can install ThoughtSpot analytics integration, connect to ThoughtSpot data, and embed content in your app seamlessly. - -For more information, see xref:vercel-int.adoc[Vercel integration]. -==== - -.CSS variables for custom styling -[%collapsible] -==== -The following custom CSS variables are deprecated and not supported from 9.10.0.cl onwards: - -* `--ts-var-sage-bar-img-url` -* `--ts-var-sage-bar-img-color` -* `--ts-var-sage-bar-img-visibility` -==== - -.Security settings for non-embedded instances -[%collapsible] -==== -The **Security Settings** page in the **Develop** tab now allows any ThoughtSpot user with developer or admin privileges to modify CSP settings for image, font, and style import. - -For more information, see xref:security-settings.adoc[Security Settings]. -==== -.Support for Sage coach -[%collapsible] -==== -In full application embedding, you can now review user feedback on the natural language search queries on the **Data** page. -//For more information, see link:https://docs.thoughtspot.com/cloud/latest/sage-coach[Sage Coach, window=_blank]. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.28.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -== Version 9.8.0.cl - -.Support for Natural Language Search embedding -[%collapsible] -==== -You can now embed ThoughtSpot Search with Natural Language Search capabilities using `SageEmbed` SDK package. Natural Language Search allows your application users to search for data using natural language query strings. This feature also provides AI-suggested sample questions and popular queries to assist users in their data search operations. - -Using `SageEmbed`, you can embed the ThoughtSpot Search interface with Natural Language Search components in your app and also customize the search experience as per your requirements. - -For more information, see xref:embed-nls.adoc[Embed Natural Language Search]. -==== - -.Embed Playground enhancements -[%collapsible] -==== -The Visual Embed playground now allows you to explore Natural Language Search embedding options and Search page customization capabilities. For more information, see xref:developer-playground.adoc#playground-nls-search[Natural Language Search]. -==== - -.Git integration enhancements -[%collapsible] -==== -The **Deploy Commit** Version Control API now provides the `VALIDATE_ONLY` option to validate TML imports to the destination environment. If your destination environment has TML content that has been modified or is different from the content on the main branch, you can run the validation before deploying changes to the destination environment. - -For more information, see xref:version_control.adoc#_deploy_commits[Deploy commits]. -==== - -.CSS variables for Natural Language Search interface customization -[%collapsible] -==== -To customize Natural Language Search interface, you can use the following variables in your custom CSS: - -* `--ts-var-sage-bar-header-background-color` -* `--ts-var-source-selector-background-color` -* `--ts-var-sage-search-box-font-color` -* `--ts-var-sage-search-box-background-color` -* `--ts-var-sage-embed-background-color` -* `--ts-var-sage-seed-questions-background` -* `--ts-var-sage-seed-questions-font-color` -* `--ts-var-sage-seed-questions-hover-background` -* `--ts-var-sage-bar-img-url` -* `--ts-var-sage-bar-img-color` -* `--ts-var-sage-bar-img-visibility` - -For mor information, see xref:css-customization.adoc#_natural_language_search_interface[Customize CSS]. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.27.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - - -== Version 9.7.0.cl - -.Git integration and version control -[%collapsible] -==== -The Git integration feature and Version Control APIs are GA and enabled by default on ThoughtSpot. This version also includes several enhancements to the Version Control APIs. -For more information, see xref:rest-apiv2-changelog.adoc#_version_control_apis[REST API v2 Changelog] and xref:version_control.adoc[Git integration and version control]. -==== - -.Custom styles -[%collapsible] -==== -You can now customize icon sprites and add custom text strings. For more information, see xref:css-customization.adoc#_customize_text_strings[Customize text strings] and xref:css-customization.adoc#_customize_icons[Customize icons]. -==== - -.Liveboard experience -[%collapsible] -==== -Personalized Liveboard Views [tag purpleBackground]#Early Access#:: - -Embedding application users can now create a personalized version of Liveboard with their changes. The personalized Liveboard view inherits any changes made to the master Liveboard, including changes made to pinned visualizations, tabs, filter chips, and re-ordering. -+ -This feature is disabled by default and can be enabled by administrators. For more information, see link:https://docs.thoughtspot.com/cloud/latest/personalized-liveboard-views[ThoughtSpot Product Documentation]. - -Embedding in note tiles:: -You can now embed interactive content such as videos in an iFrame on a Liveboard Note tile. For more information, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-notes#embed[ThoughtSpot Product Documentation]. - -Liveboard customization:: -You can now customize Liveboard headers, show or hide Liveboard users, tabs, description text, and Liveboard title. - -For more information, see xref:api-changelog.adoc#_version_1_26_0_november_2023[Visual Embed SDK Changelog] and xref:LiveboardViewConfig.adoc[SDK documentation]. -==== - -.Search experience -[%collapsible] -==== -You can now enable the new data panel experience on the embedded Search page in the SDK. The new data panel experience is turned off by default on embedded ThoughtSpot instances. - -For more information, see xref:embed-search.adoc#_data_panel_experience_in_the_embedded_search_page[Embed ThoughtSpot Search]. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.26.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - - -== Version 9.6.0.cl -.Playground enhancements -[%collapsible] -==== -The 9.6.0.cl release adds the following features to the Visual Embed Playground: - -* Liveboard tab selection + -The Playground page for Liveboard embedding now shows the tab selection drop-down, which allows users to set the default tab view on an embedded Liveboard. - -* Use host event checkbox + -+ -On selecting the *Use host event* checkbox, the code panel in the Playground displays the code snippet to try out host events. You can use this code snippet to register a host event and trigger an action using the *Try Event* button in the Playground. -==== - -.Home page experience in Full application embedding mode -[%collapsible] -==== -If you are embedding the full ThoughtSpot experience with the ThoughtSpot Sage feature, the Home page allows you to use AI-generated search answers. To enable AI-assisted search on your instance, contact ThoughtSpot Support. -==== - -.Role-Based Access Control [beta betaBackground]^Beta^ -[%collapsible] -==== -The role-based access control (RBAC) feature allows administrators to create a role in the UI or via REST API calls and assign a set of privileges. With the RBAC feature, you can assign granular permissions and control user access to ThoughtSpot features and application workflows. For more information, see xref:roles.adoc[Role-based Access Control]. - -The RBAC feature is turned off by default. To enable this feature, contact ThoughtSpot Support. -==== -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.25.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -== Version 9.5.0.cl - -.Webhooks for KPI monitor alerts [beta betaBackground]^Beta^ -[%collapsible] -==== -ThoughtSpot administrators and developers can now create a Webhook to send KPI monitor alerts to the REST endpoint of an external application. The Webhooks feature is turned off by default. To enable this feature on your instance, contact ThoughtSpot Support. - -For more information, see xref:webhooks.adoc[Webhooks for KPI Monitor alerts]. -==== - -.Version control and Git integration [beta betaBackground]^Beta^ -[%collapsible] -==== -The Git integration feature now supports pushing commits and publishing content to Org-based deployment environments. If your ThoughtSpot cluster has Orgs and multi-tenancy enabled, you can create `dev` and `prod` environments on the same ThoughtSpot instance and connect these environments to your GitHub repository. - -For more information, see xref:version_control.adoc[Git integration and version control]. -==== - -.SDK library to embed AI-powered ThoughtSpot Search experience [beta betaBackground]^Beta^ -[%collapsible] -==== -The Visual Embed SDK provides a new JavaScript library to embed the Search page with AI-powered features such as natural language search and AI-suggested answers. To view the AI-suggested answers, make sure the AI search support is enabled on the data source or worksheet used for searching data. - -//ThoughtSpot does not display AI-suggested search responses if the xref:search-assist-tse.adoc[Search Assist] feature is enabled. - -For more information, see xref:SageEmbed.adoc[SageEmbed SDK reference]. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.24.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -== Version 9.4.0.cl - -.Version control and Git integration [beta betaBackground]^Beta^ -[%collapsible] -==== -GUID mapping:: - -If a TML file on your source environment contains GUIDs that don't match the GUIDs on your destination environment, the version control APIs can now automatically handle the mapping of GUIDs when deploying the TML content. - -+ -For more information, see xref:version_control.adoc#_guid_mapping[Git integration and version control]. - -Folder structure changes [tag redBackground]#BREAKING CHANGE#:: - -The folder structure of the TML objects in the Git repository is modified in 9.4.0.cl. In earlier releases, the TML objects were stored in the object directory of the `primary` root folder, for example `primary/liveboard`. Starting from 9.4.0.cl, the TML objects will be stored in the object folder at the root level. ThoughtSpot will not migrate your existing TML files from `primary/` to the new folder structure. You must move these files to the respective object directory at the root level. - -File naming convention [tag redBackground]#BREAKING CHANGE#:: -Starting from 9.4.0.cl, the TML files pushed to a Git branch from a ThoughtSpot instance are named in the -`..tml` format. The earlier releases used the `..tml` naming convention for TML files. This change may break your current setup. We recommend that you reconfigure the Git connection on your ThoughtSpot instance and start using the version control feature from scratch. -==== - -.Security settings enhancements for Orgs -[%collapsible] -==== - -CORS settings per Org:: - -On multi-tenant clusters with Orgs, developers can now add a list of CORS hosts at the Org level. For more information, see xref:security-settings.adoc#cors-hosts[Security Settings]. - -Block user access to non-embedded application pages:: - -ThoughtSpot administrators and developers can now enable the **Block non-embed full app access** feature at the Org level. - -For more information, see xref:security-settings.adoc#_block_access_to_non_embedded_thoughtspot_pages[Security Settings]. -==== - -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.23.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - - -== Version 9.3.0.cl - -.Support for cookieless authentication -[%collapsible] -==== -Developers can now enable cookieless authentication when embedding ThoughtSpot in their applications. The cookieless authentication method allows using a bearer token instead of session cookies when users interact with embedded content or initiate API requests. If the embedded content does not load from the same domain as your embedding application, and your Web browser does not allow third-party cookies, you can use Cookieless authentication in the Trusted authentication mode. - -For more information, see xref:embed-authentication.adoc#trusted-auth-embed[Trusted authentication]. -==== - -.Idle sensing and APIs for managing cluster states -[%collapsible] -==== -ThoughtSpot Cloud clusters support idle sensing in embedded deployments. With idle sensing enabled on your embedded ThoughtSpot instance, your instance becomes inactive if there is no active user session detected for a period of 120 minutes. You can restart an inactive cluster using API when required. - -For more information, see xref:tse-eco-mode.adoc[Manage your cluster state]. -==== - -.Per-Org style customization -[%collapsible] -==== -The *Develop* tab now allows customizing UI styles and layout at the Org level. To enable this feature on your multi-tenant instance, contact ThoughtSpot support. - -For more information, see xref:style-customization.adoc#_custom_styles_for_orgs_on_multi_tenant_clusters[Custom styles for Orgs on multi-tenant clusters]. -==== - -.Version control and Git integration via REST API [beta betaBackground]^Beta^ -[%collapsible] -==== -You can now connect your ThoughtSpot instance to a Git repository and push commits from your application instance to a Git branch via REST API. With the Git integration [beta betaBackground]^Beta^ feature, ThoughtSpot provides the ability to integrate your application environment with Git workflows and deploy commits from a development instance to a production cluster. - -For more information, see xref:version_control.adoc[Version control with Git integration]. -==== - -.Visual Embed Playground enhancements - -[%collapsible] -==== -The Visual Embed developer Playground now includes a *Try* button in the preview panel. The *Try* button is attached to an event handler. You can register a host event and click *Try* to trigger an action on the embedded page in the Playground. - -For more information, see xref:embed-events.adoc[Events reference]. -==== - -.Visual Embed SDK - -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK versions 1.22.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -== Version 9.2.0.cl - -.Per-Org secret key and tokens for Trusted authentication - -[%collapsible] -==== -ThoughtSpot now supports generating secret keys per Org. Org administrators can generate a secret key for trusted authentication in their Org context and allow their Org users to obtain authentication tokens using this secret key. - -Starting from 9.2.0.cl, Org users require Org-specific authentication tokens issued for their user accounts when switching between Orgs. When generating an authentication token via REST API, make sure to request separate tokens for each Org context. - -For more information, see xref:trusted-authentication.adoc#trusted-auth-enable[Trusted authentication]. -==== - -.Custom styles - -[%collapsible] -==== -The 9.2.0.cl release introduces the following new variables for custom styling of the ThoughtSpot Search page: - -* `--ts-var-search-auto-complete-font-color` -* `--ts-var-search-auto-complete-subtext-font-color` -* `--ts-var-answer-edit-panel-background-color` - -For more information, see xref:css-customization.adoc#_search_bar_and_data_panel[Customize CSS]. -==== - -.GraphQL playground [beta betaBackground]^Beta^ -[%collapsible] -==== -The *Develop* tab in the ThoughtSpot UI introduces the GraphQL playground to allow users to interact with GraphQL endpoints and run query and mutation operations. To enable this feature on your instance, contact ThoughtSpot Support. - -For more information, see xref:graphql-playground.adoc[GraphQL Playground]. -==== -.Runtime Parameter overrides -[%collapsible] -==== -Embedded application users can now create Worksheet and Answer Parameters to optimize data queries. You can also adjust values and apply overrides at runtime on a Liveboard or Answer either via REST API or by appending Parameters to the query URL in the UI. - -For more information, see xref:runtime-parameters.adoc[Runtime Parameter overrides]. -==== -.Link customization -[%collapsible] -==== -You can now customize the navigation links in your app using the *Generic link* option in the *Develop* > *Customization* > *Link settings* page. - -For more information, see xref:customize-links.adoc#_customize_link_format[Customize links]. -==== -.Cross filters on Liveboard visualizations [earlyAccess eaBackground]#Early Access# -[%collapsible] -==== -ThoughtSpot now supports brushing and linking of visualizations on a Liveboard using cross filters. Cross filters allow you to present a coordinated view of a Liveboard by applying filters across all visualizations based on the current selection. - -[NOTE] -The Cross filters feature is turned off by default. To enable this feature on your instance, contact your ThoughtSpot administrator. - -To hide or disable the cross filter feature on an embedded instance, use the `Action.CrossFilter` and `Action.RemoveCrossFilter` parameters in the SDK. For more information, see xref:embed-actions.adoc[Show or hide menu items] and xref:Action.adoc[Action reference]. -[discrete] -=== Contextual menu behavior - -By default, the contextual menu in ThoughtSpot application pages is set as right-click pop-up menu. Starting from 9.2.0.cl, you can set the contextual menu to trigger on left-click. - -To trigger the contextual menu on left-click or right-click on an embedded app, you can use the `contextMenuTrigger` property in the Visual Embed SDK. In the following example, the contextual menu is configured to trigger on left-click. - ----- -contextMenuTrigger: "left-click" ----- - ----- -contextMenuTrigger: ContextMenuTriggerOptions.LEFT_CLICK ----- - -When set as right-click menu (default behavior):: -The contextual menu opens on right-click. If you want to monitor right-click actions and listen to the right-click events on a chart or table, use `EmbedEvent.VizPointRightClick` event. For more information, see link:https://developers.thoughtspot.com/docs/Enumeration_EmbedEvent#_vizpointrightclick[VizPointRightClick]. - -When set as left-click menu:: -The contextual menu opens on left-click. If your app is already using `EmbedEvent.VizPointClick` to listen to left-click events on a visualization, the `VizPointClick` event will be triggered whenever a user clicks on an action in the contextual menu. If you are using `EmbedEvent.VizPointClick` to trigger actions such as updating runtime filters on a Liveboard visualization, the click events from left-click contextual menu may impact your app’s current workflow. - -+ -We recommend using a development environment to test your customizations before rolling them out on production servers. For more information, contact ThoughtSpot Support. -==== -.Note tiles on Liveboards [earlyAccess eaBackground]#Early Access# -[%collapsible] -==== -In the new Liveboard experience mode, you can now add Note tiles with custom text, images, and links. This feature is turned off by default and can be enabled by ThoughtSpot administrators. - -For more information, see xref:embed-pinboard.adoc#noteTiles[Note tiles]. -==== -.Visual Embed SDK -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK versions 1.20.0 and 1.21.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog] and xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -==== - -== Version 9.0.0.cl - -.New Liveboard experience -[%collapsible] -==== -The xref:embed-pinboard.adoc#lbv2[new Liveboard experience] is now Generally Available (GA) on embedded instances and is enabled by default. -==== - -.New CSS variables for custom styling -[%collapsible] -==== -The CSS customization feature supports new variables to customize the look and feel of the following UI elements: - -* Search bar and navigation panel -* Search suggestion panel -* Dialogs - -For more information, see xref:css-customization.adoc[Customize CSS]. -==== -.REST API v2.0 endpoints and Playground -[%collapsible] -==== -Starting with 9.0.0.cl, the REST API v2 [beta betaBackground]^Beta^ API endpoints are deprecated and removed from the REST API v2 Playground. A set of new endpoints is now generally available (GA) on all ThoughtSpot instances. - -The new REST API v2.0 endpoints introduce several improvements to the request and response structure and let you perform more tasks in a single API call. For example, you can create a new user, map the user to groups and Orgs, set home Liveboards for the user, and assign privileges in a single API request. - -[div announcementBlock] --- -* All REST API v2 [beta betaBackground]^Beta^ endpoints are deprecated, but remain functional until further notice. The REST API SDK that was available with REST API v2 [beta betaBackground]^Beta^ version is no longer supported. + -ThoughtSpot does not recommend using REST API v2 [beta betaBackground]^Beta^ endpoints for production use cases. For more information, see xref:deprecated-features.adoc#_deprecation_of_rest_v2_api[Deprecation announcements]. -* The new REST API v2.0 endpoints are not an extension of the REST API v2 [beta betaBackground]^Beta^ endpoints. The resource categories, base path, endpoint URIs, and the structure of API requests and responses are different from those of the REST API v2 [beta betaBackground]^Beta^ version. -* Some API operations such as the CRUD operations for data connections and passing runtime filters on Liveboard visualizations are not available in the initial release. For more information, see xref:rest-api-v1v2-comparison.adoc[REST API v1 and v2.0 comparison] and xref:rest-api-v2-reference.adoc[REST API v2.0 reference]. -* For Org CRUD operations in production environments, ThoughtSpot recommends using xref:org-manage-api.adoc[REST API v1 endpoints]. --- -==== - -.Early Access features -[%collapsible] -==== -Starting from 9.0.0.cl, ThoughtSpot allows its administrators to turn on Early Access features from the Admin portal. Early Access features are qualified by ThoughSpot for customer use but are not enabled by default on ThoughtSpot instances until the features are GA. - -The 9.0.0.cl release introduces the following Early Access features: - -* Custom maps -+ -Allows uploading map files (TopoJSON) to configure custom regions and visualize data on these regions. For more information, see link:https://docs.thoughtspot.com/cloud/latest/geomaps-custom[Upload custom geo maps, window=_blank]. - -* Mandatory filters -+ -Allows setting certain filters as mandatory on a Liveboard. For more information, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-filters-mandatory[Mandatory Liveboard filter, window=_blank]. - -* Chart configuration experience -+ -Allows making multiple edits to a chart configuration and applying all changes at once. For more information, see link:https://docs.thoughtspot.com/cloud/latest/chart-x-axis[Reorder labels on the axis or legend, window=_blank]. - -* Chart data labels -+ -Allows displaying data labels in a lighter color on charts with a dark background. For more information, see link:https://docs.thoughtspot.com/cloud/latest/chart-data-labels[Show data labels, window=_blank]. -==== - -.Visual Embed SDK version 1.19.0 -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.19.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API v1 enhancements, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog]. -==== - -== Version 8.10.0.cl - -.Ability to embed only the Search bar in an app [beta betaBackground]^Beta^ -[%collapsible] -==== -You can now embed the ThoughtSpot search bar component in your app. For example, if you are using Google Sheets for data analysis, you can embed the ThoughtSpot search bar and let your users search data from a specific data source. The embedded Search bar allows passing search tokens and modifying search options. You can also retrieve the search results as raw data and let your host application render it in the format you want. - -For more information, see xref:embed-searchbar.adoc[Embed ThoughtSpot search bar]. -==== - -.Advanced style customization with custom CSS -[%collapsible] -==== -The CSS customization feature supports new variables to customize the look and feel of the following UI elements: - -* Search data button in the navigation panel -* Font type and text style of search tokens -* Data panel on the Search and saved Answer pages -* Filter chips on Liveboard, visualizations, and Answer pages -* Menu components -* X-axis and Y-axis titles and labels on charts - -For more information, see xref:css-customization.adoc[Customize CSS]. -==== - -.CSP allowlist for font, image and stylesheet sources -[%collapsible] -==== -You can now enable CSP overrides for font, stylesheet, and image sources in ThoughtSpot UI. If you want to load fonts, stylesheets, images, or favicons from an external source, add the source URLs to the CSP allowlist on the *Security Settings* page. - -For more information, see xref:security-settings.adoc#_add_trusted_domains_for_font_css_and_image_import[Security Settings]. -==== - -.Multi-tenancy with Orgs -[%collapsible] -==== -You can now set up your ThoughtSpot Cloud instance as a multi-tenant cluster and partition it into logical and isolated workspaces called *Orgs*. Each Org can have its own users, groups, and metadata, and stay independent of and invisible to other Orgs configured on the same application instance. - -For more information, see xref:orgs.adoc[Multi-tenancy with Orgs]. -==== - -.Visual Embed SDK version 1.18.0 -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.18.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API v1 enhancements, see xref:rest-apiv1-changelog.adoc[REST API changelog]. -==== - -== Version 8.9.0.cl - -.Improvements to authentication methods and AuthType enums in the SDK -[%collapsible] -==== -The following changes are introduced in the Visual Embed SDK to improve the authentication framework and options for embedded application users: - -* New auth type enum for embedded SSO authentication -+ -The `AuthType.EmbeddedSSO` enum allows you to enable SSO login on embedded instances. This authentication method allows you to use your current SAML IdP or OpenID Connect configuration and redirect users to the IdP for authentication within the embedded iFrame. - -* Changes to the existing `AuthType` enums: + -** `AuthType.SAML` is renamed as `AuthType.SAMLRedirect` + -** `AuthType.OIDC` is renamed as `AuthType.OIDCRedirect` + -** `AuthType.AuthServer` is renamed to `AuthType.TrustedAuthToken` + - -For more information, see xref:embed-authentication.adoc[Authentication]. -==== - -.Just-in-time user creation and dynamic privilege assignment -[%collapsible] -==== -Starting from 8.9.0.cl, the xref:session-api.adoc#session-authToken[/tspublic/v1/session/auth/token] endpoint supports just-in-time provisioning of users. If the user specified in the API request does not exist in the ThoughtSpot system, you can set the `autocreate` property to `true` to add the user to ThoughtSpot and assign the user to `groups`. -==== -.Advanced style customization [beta betaBackground]^Beta^ -[%collapsible] -==== -ThoughtSpot now allows you to override style specifications of the embedded UI pages and elements with custom CSS. Custom CSS provides granular control over the design elements and lets you modify the properties of these elements -to match the look and feel of your host application. - -To help users visualize and preview the CSS overrides, the *Visual Embed* playground will include the *Apply custom styles* checkbox, which allows you to explore the variables available for customization. - -For more information, see xref:style-customization.adoc[Customize styles and layout] and xref:css-customization.adoc[Customize CSS using SDK]. - -==== -.Visual Embed SDK version 1.17.0 -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.17.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== -.REST API -[%collapsible] -==== -For information about REST API v1 enhancements, see xref:rest-apiv1-changelog.adoc[REST API changelog]. -==== - -== Version 8.8.0.cl -.Custom tile size for visualizations on a Liveboard (New Liveboard experience only) -[%collapsible] -==== -ThoughtSpot users can now customize the tile size of a visualization on a Liveboard. In the earlier versions, ThoughtSpot allowed resizing visualizations using predefined layout options available in the *More* menu image:./images/icon-more-10px.png[the more options menu]. With custom tile size, users can now change the size of a visualization just by clicking and dragging the tile to the desired size. - -This feature is in beta and disabled by default on all Thoughtspot instances. To enable this feature on your instance, contact ThoughtSpot Support. -==== -.Visual Embed SDK version 1.16.0 -[%collapsible] -==== -For information about the new features and enhancements introduced in Visual Embed SDK version 1.16.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== -.REST API v1 -[%collapsible] -==== -For information about REST API v1 enhancements, see xref:rest-apiv1-changelog.adoc[REST API changelog]. -==== -.Bug fixes and improvements -[%collapsible] -==== -Bug fixes and new improvements in embedded user experience. + -For more information, see xref:fixed-issues.adoc[Fixed issues]. -==== - -== Version 8.7.0.cl - -.Liveboard tabs -[%collapsible] -==== -The new Liveboard experience[beta betaBackground]^Beta^ now supports organizing visualizations in tabs. Users with edit access to a Liveboard can add, edit, and move visualizations to tabs on a Liveboard. On embedded ThoughtSpot instances, developers can set a specific tab as an active tab using the Visual Embed SDK. - -This feature is available only on deployments that have the new Liveboard experience enabled. For more information, see xref:embed-pinboard.adoc#_liveboard_tabs[Customize Liveboard tabs]. - -[IMPORTANT] -The new Liveboard experience is in BETA on embedded ThoughtSpot instances. This feature is turned off by default on embedded ThoughtSpot instances. -==== -.Visual Embed SDK version 1.15.0 -[%collapsible] -==== -For information about the new features and enhancements in the Visual Embed SDK version 1.15.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API v1 -[%collapsible] -==== -For information about REST API v1 enhancements, see xref:rest-apiv1-changelog.adoc[REST API changelog]. -==== - -.REST API v2 [beta betaBackground]^Beta^ -[%collapsible] -==== -The REST API v2 [beta betaBackground]^Beta^ feature will be deprecated in 8.10.0.cl and replaced with the new v2.0 API endpoints. For more information, see xref:deprecated-features.adoc[Deprecation announcements]. -==== - -== Version 8.6.0.cl - -.Liveboard new experience [beta betaBackground]^Beta^ -[%collapsible] -==== -The new Liveboard experience is now available on embedded ThoughtSpot instances. In addition to the existing Liveboard features, the new experience introduces several notable changes to the *Liveboard* page: - -Liveboard editing:: -To edit a Liveboard, users must switch to the edit mode by clicking the *Edit* button on the Liveboard page. -The edit mode allows you to edit the Liveboard title and description text, apply filters, copy the Liveboard, modify the layout of the visualization tiles, delete a visualization, and so on. - -Liveboard filters:: -* The Liveboard filter configuration options are available on a single modal. -* When a user creates a copy of a Liveboard, the filters applied to its visualizations are also copied. - -Other features and enhancements:: -* The *Add filters* action is placed in the primary menu bar and can be viewed only when a Liveboard is in edit mode. Only users with edit access to the Liveboard can apply filters. -* The *Undo*, *Redo*, and *Reset* actions for visualizations. -* The *Liveboard Info* action label in the More image:./images/icon-more-10px.png[the more options menu] menu is renamed to *Show Liveboard details*. -* The *Schedule* action is placed in the More image:./images/icon-more-10px.png[the more options menu] menu. -* Improved visualization Explore experience. - -Deprecated features:: -The following features are *_not_* available with the new Liveboard experience: -* The *Copy embed link* and *Copy link* menu actions in the More image:./images/icon-more-10px.png[the more options menu] menu of a Liveboard -* The edit title icon on visualization tiles -* The *Share* button on visualizations - -For more information about the new Liveboard experience, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-experience-new[New Liveboard experience, window=_blank]. - -[discrete] -==== New Liveboard experience rollout on embedded instances - -The new Liveboard experience is currently available in BETA on embedded ThoughtSpot instances. The new liveboard experience will be rolled out on embedded instances in phases: - -In ThoughtSpot Cloud 8.6.0.cl:: - -The new Liveboard experience is turned off by default on embedded ThoughtSpot instances. If you are using the Visual Embed SDK to embed ThoughtSpot, you can xref:embed-pinboard.adoc#lbv2[set the `liveboardV2` parameter] in the SDK package to `true` and enable the new experience globally for all users on your instance. + - -+ -ThoughtSpot users with administrator privileges can also link:https://docs.thoughtspot.com/cloud/latest/liveboard-experience-new[turn on the new Liveboard experience, window=_blank] at the cluster level. - -In later releases:: -The new Liveboard Experience will be turned on by default for all embed application users. To switch to the classic experience, you can set the `liveboardV2` parameter to `false` in the SDK, or change the Liveboard experience preference in the `Admin` tab of the ThoughtSpot UI. - -[NOTE] -The Liveboard experience setting in the SDK takes precedence over the cluster-level settings in the *Admin* tab. - -[discrete] -==== Actions and Events in the SDK -If you have enabled the new Liveboard experience on your instance, you can use the `Action` and `Event` enumeration members available in the SDK package to customize an embedded object and improve interactivity. - -For example, to disable the *Delete* action for a visualization object on the Liveboard, you can use the `Action.Remove` enum. Similarly, you can trigger events such as `VizPointClick` on visualizations in an embedded Liveboard. - -==== - -.Visual Embed SDK version 1.14.0 -[%collapsible] -==== -For information about the new features and enhancements in the Visual Embed SDK version 1.14.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API -[%collapsible] -==== -For information about REST API enhancements, see xref:rest-apiv1-changelog.adoc[REST API changelog]. -==== - -== Version 8.5.0.cl - -.Search Assist support for embedded instances -[%collapsible] -==== -Your application users can now access sample search walkthrough lessons created using Search Assist on embedded ThoughtSpot instances. If the Search Assist feature is enabled in the SDK, and the Search Assist lessons are created on the Worksheet, users can view sample search questions and follow the actions in the walkthrough to get answers. - -//For more information, see xref:search-assist-tse.adoc[Enable Search Assist, window=_blank]. -==== - -.Visual Embed SDK 1.13.0 -[%collapsible] -==== -For information about the new features and enhancements in the Visual Embed SDK version 1.13.0, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.ThoughtSpot UI -[%collapsible] -==== -The new Data workspace is Generally Available (GA) in 8.5.0.cl on ThoughtSpot instances. For more information about the new Data tab, SpotApps, and other related features, see link:https://docs.thoughtspot.com/cloud/latest/notes[ThoughtSpot product documentation]. - -[IMPORTANT] -While some customizable actions from the Visual Embed SDK will be honored from within an embedded instance of the new Data workspace page, full support of this page in embedded ThoughtSpot instances is planned for a future release. If you are actively embedding and customizing the `Data` tab for your application and wish to retain the legacy `Data` tab, contact ThoughtSpot Support. - -==== - -== Version 8.4.0.cl - -.Link customization -[%collapsible] -==== -This release allows query parameters in the Liveboard, saved Answer, and visualization URLs that are customized for an embedded ThoughtSpot instance. For example, you can customize the *Unsubscribe* link sent in email notifications for KPI charts by adding `{ts-query-params}` to the visualization URL, and thus allow users to unsubscribe from KPI threshold alerts at any time. - -For more information, see xref:customize-links.adoc[Customize links]. -==== - -.Visual Embed SDK 1.12.0 - -[%collapsible] -==== -The Visual Embed SDK version 1.12.0 introduces new events. For more information, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API v2 [beta betaBackground]^Beta^ -[%collapsible] -==== -[width="100%" cols="1,4"] -|==== -|| -|[tag greenBackground]#NEW ENDPOINTS# a| This release introduces the following new REST API v2 [beta betaBackground]^Beta^ endpoints: + - -* Data + -** `*GET* /tspublic/rest/v2/data/answer/querysql` + -** `*GET* /tspublic/rest/v2/data/liveboard/querysql` -* Admin -** `*PUT* /tspublic/rest/v2/admin/assignauthor` -|[tag redBackground]#BREAKING CHANGES# a| * The method names for the following endpoints will be changed in the SDK. + -** `/tspublic/rest/v2/user/addgroup` + -** `/tspublic/rest/v2/user/removegroup` + -* The `/tspublic/rest/v2/admin/changeowner` endpoint will be renamed as `/tspublic/rest/v2/admin/changeauthor`. -|==== -==== - -== Version 8.3.0.cl - -.Visual Embed SDK 1.11.0 -[%collapsible] -==== -The Visual Embed SDK version 1.11.0 introduces several new events for embedded components. For more information, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API v2 [beta betaBackground]^Beta^ -[%collapsible] -==== -[width="100%" cols="1,4"] -|==== -|| -|[tag greenBackground]#NEW ENDPOINTS# a| The following REST API v2 [beta betaBackground]^Beta^ endpoints are now available: - -* Connection endpoints + -** `GET /tspublic/rest/v2/connection/database` + -** `POST /tspublic/rest/v2/connection/table` + -** `POST /tspublic/rest/v2/connection/tablecoloumn` + -* Report endpoint + -** `POST /tspublic/rest/v2/report/liveboard` + -* Security endpoints + -** `POST /tspublic/rest/v2/security/share/tsobject` + -** `POST /tspublic/rest/v2/security/share/visualization` + -** `GET /tspublic/rest/v2/security/permission/tsobject` + -** `GET /tspublic/rest/v2/security/permission/principal` + -** `POST /tspublic/rest/v2/security/permission/tsobject/search` + -** `POST /tspublic/rest/v2/security/permission/principal/search` + -* Custom action endpoints + -** `GET /tspublic/rest/v2/customaction` + -** `POST /tspublic/rest/v2/customaction/create` + -** `PUT /tspublic/rest/v2/customaction/update` + -** `DELETE /tspublic/rest/v2/customaction/delete` + -** `POST /tspublic/rest/v2/customaction/search` + -** `GET /tspublic/rest/v2/customaction/association` + -** `DELETE /tspublic/rest/v2/customactions/association/delete` - -|[tag orangeBackground]#MODIFIED# a| -* The `x-requested-by` header is not mandatory for API requests to the REST API v2 [beta betaBackground]^Beta^ endpoints. -* The `createdBy` attribute in the `/tspublic/rest/v2/metadata/header/search` API is renamed to `author`. -* The attributes with the `boolean` data type in the API endpoints are changed to `string` data type. If a boolean attribute was set as `true` in your existing setup, the value will be changed to `"true"`. -|[tag redBackground]#BREAKING CHANGES# a| - -* Note the change in HTTP request method for the following REST API v2 [beta betaBackground]^Beta^ endpoints: + -** `**PUT** /tspublic/rest/v2/metadata/tag/assign` + -** `**PUT** /tspublic/rest/v2/metadata/tag/unassign` + -** `**PUT** /tspublic/rest/v2/metadata/favorite/assign` + -** `**PUT** /tspublic/rest/v2/metadata/favorite/unassign` + -** `**PUT** /tspublic/rest/v2/metadata/homeliveboard/assign` + -** `**PUT** /tspublic/rest/v2/metadata/homeliveboard/unassign` + -* In the REST API SDK [beta betaBackground]^Beta^, the classes corresponding to enumerations used for string fields such as the `type` field in metadata API, are renamed. If you are using the REST API SDK in your environments, make sure the class names are updated. -|[tag redBackground]#REMOVED# a| The `ownedBy` attribute is removed from the `/tspublic/rest/v2/metadata/header/search` API endpoint. -|==== -==== - -== Version 8.2.0.cl - -//// -=== Custom actions -[width="100%" cols="1,4"] -|==== -|| -|[tag greenBackground]#NEW FEATURE# a| +++
App actions for Slack integration
+++ - -ThoughtSpot introduces app actions[beta betaBackground]^Beta^ to support seamless integration with third-party business apps such as Slack. Your application users can now connect ThoughtSpot with their Slack workspaces and deliver insights directly to Slack channels. - -Users with developer or admin privileges can create an app action for Slack[beta betaBackground]^Beta^ in the Developer portal and add it as a menu action on visualizations and saved answers. On clicking this action, ThoughtSpot users can initiate the Slack integration workflow and send data to their Slack channels without leaving the ThoughtSpot UI. - -For more information, see xref:app-actions.adoc[App actions] and xref:push-data-to-slack.adoc[Push data to a Slack workspace]. -|==== -//// - -.Visual Embed SDK 1.10.x -[%collapsible] -==== -The Visual Embed SDK version 1.10.x introduces new attributes and bug fixes. For more information, see xref:api-changelog.adoc[Visual Embed changelog]. -==== - -.REST API v1 -[%collapsible] -==== -New endpoints for data connection queries. For more information, see xref:rest-apiv1-changelog.adoc[REST API v1 changelog]. -==== - -.REST API v2 [beta betaBackground]^Beta^ - -[%collapsible] -==== -Starting from 8.2.0.cl release, the xref:rest-api-v2.adoc[REST API Playground and SDK] [beta betaBackground]^Beta^ feature is enabled by default on ThoughtSpot instances. - -The 8.2.0.cl release also introduces the following features: - -Endpoint URL path:: -The REST API v2 [beta betaBackground]^Beta^ endpoint URL path is changed from `/api/rest/v2` to `/tspublic/rest/v2/`. For example, the `GET /api/rest/v2/connection` endpoint is now available as `GET /tspublic/rest/v2/connection`. - -Trusted authentication:: -If trusted authentication is enabled on your instance, you can now obtain a login token to authenticate to ThoughtSpot and authorize your API requests. - -For more information, see xref:authentication.adoc#trustedAuthToken[REST API v2 authentication]. - -SDK for .NET clients:: -ThoughtSpot provides the .NET SDK to allow developers to interact with REST APIs from .NET applications. You can download the SDK from NuGet Package Manager and install it using the NuGet GUI. For more information, see xref:rest-api-sdk-libraries.adoc[REST API SDK and client libraries]. - -New API endpoints:: - -* `GET /tspublic/rest/v2/admin/configuration` -* `GET /tspublic/rest/v2/admin/configuration/overrides` -* `PUT /tspublic/rest/v2/admin/configuration/update` -* `PUT /tspublic/rest/v2/admin/resetpassword` -* `PUT /tspublic/rest/v2/admin/syncprincipal` -* `PUT /tspublic/rest/v2/admin/changeowner` -* `PUT /tspublic/rest/v2/user/changepassword` -* `POST /tspublic/rest/v2/data/search` -* `POST /tspublic/rest/v2/data/answer` -* `POST /tspublic/rest/v2/data/liveboard` -* `POST /tspublic/rest/v2/report/answer` -* `GET /tspublic/rest/v2/logs/events` - -//For more information, see xref:rest-api-v2-reference-beta.adoc[REST API v2 Reference]. - -==== - -== Version 8.1.0.cl - -.Visual Embed SDK version 1.9.x -[%collapsible] -==== -The Visual Embed SDK version 1.9.x introduces new action enumerations, events, and attributes. For more information, see xref:api-changelog.adoc[Visual Embed Changelog]. -==== - -.REST API v2 [beta betaBackground]^Beta^ -[%collapsible] -==== -The following REST API v2 endpoints are now available on instances on which the REST API v2 Playground and SDK feature is enabled. - -* `GET /api/rest/v2/connection` -* `POST /api/rest/v2/connection/create` -* `PUT /api/rest/v2/connection/update` -* `DELETE /api/rest/v2/connection/delete` -* `PUT /api/rest/v2/connection/addtable` -* `PUT /api/rest/v2/connection/removetable` -* `POST /api/rest/v2/connection/search` -* `DELETE /api/rest/v2/metadata/delete` -* `GET /api/rest/v2/metadata/header` - -The REST API v2 Playground and SDK is a limited availability feature and is in beta. - -For more information, see xref:rest-api-v2.adoc[REST API v2] and xref:rest-api-v2-reference.adoc[REST API v2 Reference]. -==== - - -== Version 8.0.0.cl - -.Visual Embed SDK version 1.8.x -[%collapsible] -==== -[width="100%" cols="1,4"] -|==== -|| -|[tag redBackground]#BREAKING CHANGE# | +++
Auto login
+++ - -The `autoLogin` attribute is now set as `false` by default. This attribute is used in the `init` method to automatically re-login a user when a user session expires. -|[tag greenBackground]#NEW FEATURE# | +++
Authentication
+++ - -The `init` method now returns an `authPromise` that resolves when the authentication is completed. -|==== - -==== - - -.Embed application -[%collapsible] -==== -[width="100%" cols="1,4"] -|==== -|[tag greenBackground]#NEW FEATURE# a| +++
OpenID Connect authentication
+++ - -ThoughtSpot now supports OpenID Connect (OIDC) authentication framework on embedded instances. Your application users can now authenticate to an authorization server at your OpenID provider and access embedded ThoughtSpot content using their SSO credentials. - -For more information, see xref:configure-oidc.adoc[OpenID Connect authentication]. - -|[tag redBackground]#REMOVED# a| +++
Follow button
+++ - -If you have embedded the full ThoughtSpot application, you will notice that the *Follow* button on the Liveboards page is removed. You can now schedule email notifications using the **Schedule** feature and follow Liveboard updates. -|==== -==== - - -.Visual Embed SDK 1.7.0 - -[%collapsible] -==== -[width="100%" cols="1,4"] -|==== - -|[tag greenBackground]#NEW FEATURE# |+++
OIDC AuthType
+++ - -The SDK supports the `OIDC` `authType` in `init` calls. If you want your application users to authenticate to an OpenID provider and use their SSO credentials to access the embedded ThoughtSpot content, you can enable the `OIDC` authentication type in the SDK. - -For more information, see xref:embed-authentication#oidc-auth.adoc[Authentication and security attributes]. -|[tag greenBackground]#NEW FEATURE# a|+++
Embed events
+++ - -The SDK includes the following new event: - -* `RouteChange` - -For more information, see xref:embed-events.adoc[Events reference]. - -|==== -==== - -.REST API Playground and SDK [beta betaBackground]^Beta^ - -[%collapsible] -==== - -[width="100%" cols="1,4"] -|==== -|[tag greenBackground]#NEW FEATURE# a| +++
REST API Playground and SDK
+++ - -ThoughtSpot introduces the v2 [beta betaBackground]^Beta^ version of REST API endpoints and an interactive Playground to explore the API request and response workflows. - -The API Playground offers several distinct features, such as an interactive code panel, a catalog of resource-oriented endpoint URLs, language-specific SDK and client libraries, code samples, and API reference documentation. - -You can use any standards-compliant HTTP client or use the Playground to make an API call. If you want to construct your queries and process API responses programmatically, you can download the SDK and client libraries in the programming language of your choice and integrate them with your applications. - -The REST API Playground and SDK is a limited availability feature and is in beta. To preview this feature, visit link:https://try-everywhere.thoughtspot.cloud/v2/#/everywhere/api/rest/playgroundV2[ThoughtSpot Live Playground, window=_blank]. To enable this feature on your ThoughtSpot instance, contact ThoughtSpot Support. - -For more information, see xref:rest-api-v2.adoc[REST API v2]. -|==== -==== - - -== Version ts8.nov.cl - -.Developer portal -[%collapsible] -==== -[width="100%" cols="1,4"] -|==== -|[tag orangeBackground]#CHANGE NOTICE# a| +++
Pinboards are now Liveboards!
+++ - -Effective from the ThoughtSpot 8 November Cloud release, ThoughtSpot pinboards are rebranded as Liveboards and optimized for live analytics in cloud deployments. Along with granular insights, Liveboards offer interactive data analytics experience with enhanced capabilities. - -As part of rebranding, we have made some terminology changes in the ThoughtSpot UI and Developer portal. We are in the process of rolling out terminology changes across all ThoughtSpot interfaces, platforms, and information artifacts. During this period, your environment may show some instances of `pinboard` based on the rebranding rollout stage. In some cases, we may even continue to use the legacy terminology for backward compatibility, and to ensure that your existing integrations work seamlessly. For more information, see xref:terminology-update.adoc[Terminology changes]. -|==== -==== - - -.Custom actions -[%collapsible] -==== -[width="100%" cols="1,4"] -|==== -|[tag greenBackground]#NEW FEATURE# a| +++
Custom action association to user groups
+++ - -ThoughtSpot now allows you to restrict a custom action's availability to specific user groups. Developers can associate a custom action to one or several user groups in the Developer portal and allow only authorized users to view and access the custom action on a Worksheet, Answer, or visualization. - -For more information, see xref:customize-actions-menu.adoc#access-control[Custom actions] and xref:custom-actions-url.adoc[Configure a custom URL action]. -|==== -==== - -.User access -[%collapsible] -==== -[width="100%" cols="1,4"] -|==== -|[tag greenBackground]#NEW FEATURE# |ThoughtSpot now supports restricting embed user access to the non-embedded ThoughtSpot application instance. By default, all embedded ThoughtSpot users can navigate to and log in to the non-embedded ThoughtSpot application instance. -If you want to allow only users with administrator or developer privileges to access the non-embedded ThoughtSpot application instance, contact ThoughtSpot Support. -|==== -==== - - -.Visual Embed SDK version 1.6.x -[%collapsible] -==== - -[width="100%" cols="1,4"] -|==== -|[tag greenBackground]#NEW FEATURE# a|+++
Visible actions
+++ - -You can now configure a set of ThoughtSpot UI actions as visible actions and display these actions in the embedded UI. If your embedded instance requires only a few actions, you can use the `visibleActions` API to show only these actions in the embedded ThoughtSpot UI. - -For more information, see xref:embed-actions.adoc[Show or hide UI actions]. - -|[tag orangeBackground]#MODIFIED# | +++
Terminology changes
+++ - -The SDK library and object parameter names are modified to rebrand pinboards as Liveboards. For a complete list of changes, see xref:terminology-update.adoc#sdk-changes[Terminology changes]. - -|[tag greenBackground]#NEW FEATURE# a|+++
Embed events
+++ - -The SDK supports the following new events: - -* `DialogOpen` -* `DialogClose` - -For more information, see xref:embed-events.adoc[Events reference]. - -|==== -==== - -.REST API -[%collapsible] -==== -[width="100%" cols="1,4"] -|==== -|[tag greenBackground]#NEW FEATURE# a|`POST /tspublic/v1/session/login/token` - -This API allows you to send the login token and user information in the request body. For more information, see the xref:session-api.adoc#session-loginToken[REST API reference page]. - -|[tag orangeBackground]#MODIFIED# a| The `/tspublic/v1/connection/create` and `/tspublic/v1/connection/update` endpoints now allow configuring and modifying a connection without importing tables. - -For more information, see xref:connections-api.adoc[Data connection APIs]. -|[tag orangeBackground]#MODIFIED#|You can now filter metadata objects by author GUIDs using the `authorguid` attribute in the `/tspublic/v1/metadata/list` endpoint. - -For more information, see xref:metadata-api.adoc#metadata-list[Get a list of metadata objects]. -|==== - -==== - -.ThoughtSpot application UI -[%collapsible] -==== - -To make it easier for users to find new insights, the **Search data** functionality is moved from the search bar toggle on the **Home** page to the **Search data** button in the main navigation bar. - -Note that if you are embedding the full application without the navigation bar, your application users may not be able to access the **Search data** button. If you must include the Search bar toggle on the **Home** page, contact ThoughtSpot Support to restore this feature on your cluster. - -image:./images/search-toggle.png[Search toggle, width=auto] - -image:./images/search-data-btn.png[Search data button, width=auto] - -==== - -== Version ts7.oct.cl - -.Custom actions -[%collapsible] -==== - -[width="100%" cols="1,4"] -|==== -|[tag orangeBackground]#MODIFIED# a|+++
Custom actions feature availability
+++ - -Starting from ThoughtSpot 7 Cloud October release, you _do not_ require a separate license to create or manage custom actions. The *Custom action* feature is unlocked on all clusters that have a valid ThoughtSpot Enterprise Cloud service subscription. ThoughtSpot Cloud service users with Developer or Admin privileges can access the *Custom actions* feature in the *Develop* tab. - -|[tag redBackground]#REMOVED# a|+++
The Only allow in context menu checkbox +++ - -The *Only allow in context menu* checkbox in the custom action creation dialog is removed from the UI. This checkbox was available in previous releases to allow developers to set a custom action to appear only in the contextual menu on pinboard visualizations, charts, or tables. - -If you have created custom actions with the *Only allow in context menu* setting enabled on your instance, note these custom action workflow changes: - -* If you have a *Global* custom action with the *Only allow in context menu* setting enabled, the configuration setting _is not_ preserved and the action is placed in the **More** image:./images/icon-more-10px.png[the more options menu] menu instead of the contextual menu. -+ -You can xref:custom-actions-edit.adoc[modify the position of this action] by using the *Edit* option in the *Custom actions* panel on a visualization or search results page. - -* If you have a *Local* custom action with the *Only allow in context menu* setting enabled and the action is already assigned to a Worksheet, visualization, chart, or table, the configuration setting _is_ preserved and the custom action shows up in the contextual menu. - -* If you have a *Local* custom action with the *Only allow in context menu* setting enabled, but it is not assigned to a Worksheet, visualization, chart, or table, the action will not be available as a menu item or button. You must add the action to a visualization, chart, or table, and configure its position as required. For more information, see xref:custom-actions-viz.adoc[Add a custom action to a visualization] and xref:custom-actions-worksheet.adoc[Add custom actions to a Worksheet]. - -|==== -==== - -.Visual Embed SDK version 1.5.0 - -[%collapsible] -==== - -The ThoughtSpot 7 Cloud October release introduces the Visual Embed SDK version 1.5.0, which includes the following new features and enhancements. - -[width="100%" cols="1,4"] -|==== -|| -|[tag greenBackground]#NEW FEATURE# | +++
Render embedded objects in queue
+++ - -The SDK now supports rendering embedded objects in a queue. If you have multiple embedded objects, you can enable the `queueMultiRenders` parameter to queue your embedded objects and render them one after another. This feature helps in decreasing the load on the web browsers and improving your application loading experience. By default, this attribute is set to `false`. - -|[tag greenBackground]#NEW FEATURE# a|+++
Liveboard embed
+++ - -The `pinboardEmbed` package includes the `defaultHeight` attribute that sets a minimum height for embedded objects on a pinboard page and the corresponding visualization pages that a user can navigate to. - -For more information, see xref:embed-search.adoc[Embed a pinboard]. - -|[tag greenBackground]#NEW FEATURE# a|+++
Embed events
+++ - -The SDK EmbedEvent library includes the following new events: - -* `VizPointDoubleClick` -* `Drilldown` -* `SetVisibleVizs` - -For more information, see xref:embed-events.adoc[Events reference]. - -|==== -==== - -.REST APIs -[%collapsible] -==== -The ThoughtSpot 7 Cloud October release includes the following new REST API endpoints. For more information about these APIs, see xref:rest-api-reference.adoc[REST API Reference]. - -* `POST /tspublic/v1/group/{groupid}/users` -* `GET /tspublic/v1/group/{groupid}/users` -* `DELETE /tspublic/v1/group/{groupid}/users` -* `PUT /tspublic/v1/user/email` -* `POST /tspublic/v1/user/{userid}/groups` -* `GET /tspublic/v1/user/{userid}/groups` -* `PUT /tspublic/v1/user/{userid}/groups` -* `DELETE /tspublic/v1/user/{userid}/groups` -==== - - -== Version ts7.sep.cl - -.Licensing -[%collapsible] -==== - -[width="100%" cols="1,4"] -|==== -|[tag greenBackground]#NEW FEATURE# a| +++
+++New ThoughtSpot license for embedded analytics +++
+++ - -ThoughtSpot introduces the ThoughtSpot Embedded Edition license that grants access to Developer portal, Playground, customization workflows, Visual Embed SDK, and REST APIs. If you have a ThoughtSpot Enterprise Cloud Service subscription and you want to avail the benefits of ThoughtSpot Embedded analytics, you can now request for a license upgrade. - -The new licensing model introduces several notable changes in the ThoughtSpot Developer portal: - -* On clusters that _do not_ have the ThoughtSpot Embedded Edition license, the ThoughtSpot Developer Portal displays a locked icon next to the customization menu actions. When you click the locked icon, the UI prompts you to sign up for a free trial or upgrade your license. -* The ThoughtSpot Enterprise Cloud service subscribers can either start a 30-day free trial or initiate a license upgrade from the UI. -* Free trial users can initiate a license upgrade request by clicking **Upgrade Now** at any time during the evaluation period, or when the trial expires. -* If you click *Upgrade* or **Upgrade Now**, ThoughtSpot opens the Live Chat Support widget. You can start a conversation with the Sales personnel to initiate the license upgrade. - -For more information about the licensing model and upgrade process, see xref:get-started-tse.adoc[Get started with embedded analytics]. -|==== - -==== - -.Developer portal enhancements -[%collapsible] -==== -[width="100%" cols="1,4"] -|==== -|[tag greenBackground]#NEW FEATURE# a| +++
+++Developer Playground enhancements+++
+++ - -* The *Full app* Playground page includes the *Hide profile and help* checkbox to provide a preview of the `disableHelpAndProfile` function that can hide the Help and Profile icons in the ThoughtSpot navigation bar. - -* The *Full Height* checkbox in *Pinboard* Playground provides a preview of the `fullHeight` attribute that can dynamically resize the embedded pinboard frame according to the height of the pinboard. - -For more information, see xref:developer-playground.adoc[Developer Playground]. -|==== - -==== - -.Visual Embed SDK version 1.4.0 - -[%collapsible] -==== -The ThoughtSpot 7 Cloud September release introduces the Visual Embed SDK version 1.4.0, which includes the following new features and enhancements. - -[width="100%" cols="1,4"] -|==== -|| -|[tag greenBackground]#NEW FEATURE# a|+++
+++Prefetch API+++
+++ - -The `prefetch` API fetches static resources from a given URL before your application loads. Web browsers can then cache the prefetched resources locally and serve them from a user's local disk. You can use this API to load the embedded objects faster and improve your application response time. - -For more information, see xref:prefetch-and-cache.adoc[Prefetch static resources]. - -|[tag greenBackground]#NEW FEATURE# a|+++
+++In-app page navigation+++
+++ - -The `navigateToPage` method in the SDK lets you provide quick and direct access to a specific pinboard, saved Answer, or an application page. You can add a custom menu action or button in your application UI that calls the `navigateToPage` method and leads your users to the page specified in the `path` parameter. - -For more information, see xref:page-navigation.adoc[Add a custom action for in-app navigation]. - -|[tag greenBackground]#NEW FEATURE# a|+++
+++Full application embedding+++
+++ - -The `appEmbed` SDK package includes the following new attributes: - -* The `disableProfileAndHelp` attribute to show or hide the `Help (?)` and the user profile menu in the navigation bar of your embedded app. - -* The `hideObjects` attribute to hide specific objects from a user's page view. - -For more information, see xref:full-embed.adoc[Embed full application]. - -|[tag greenBackground]#NEW FEATURE# |+++
+++Search embed +++
+++ - -The `searchEmbed` package includes the `forceTable` attribute that sets tabular view as the default format for presenting search data. You can use set this attribute to `true` to force search results to appear in the table view. - -For more information, see xref:embed-search.adoc[Embed ThoughtSpot search]. - -|[tag redBackground]#REMOVED# | - -The `searchQuery` parameter is no longer supported and is removed from the `searchEmbed` SDK package. -|[tag greenBackground]#NEW FEATURE# a|+++
+++Embed events +++
+++ -The SDK EmbedEvent library includes the following events: - -* `QueryChanged` -* `AuthExpire` - -For more information, see xref:embed-events.adoc[Subscribe to Events]. -|==== - -==== - -.REST APIs - -[%collapsible] -==== - -The ThoughtSpot 7 Cloud September release includes the following new endpoints and modifications to the REST APIs. For more information, see xref:rest-api-reference.adoc[REST API Reference]. - -.New APIs - -* `POST /tspublic/v1/connection/create` -* `POST /tspublic/v1/connection/update` -* `POST /tspublic/v1/connection/export` -* `POST /tspublic/v1/connection/delete` -* `POST /tspublic/v1/metadata/unassigntag` -* `GET /tspublic/v1/metadata/list` -* `GET /tspublic/v1/security/metadata/permissions` -* `GET /tspublic/v1/security/metadata/{id}/permissions` -* `GET /tspublic/v1/security/effectivepermissionbulk` -* `GET /tspublic/v1/session/info` -* `POST /tspublic/v1/user/activate` -* `POST /tspublic/v1/user/inactivate` -* `POST /tspublic/v1/user/session/invalidate` -* `POST /tspublic/v1/user/resetpassword` -* `PUT /tspublic/v1/group/{groupid}/users` -* `POST /tspublic/v1/group/{groupid}/groups` -* `PUT /tspublic/v1/group/{groupid}/groups` -* `GET /tspublic/v1/group/{groupid}/groups` -* `POST /tspublic/v1/group/addmemberships` -* `POST /tspublic/v1/group/removememberships` -* `DELETE /tspublic/v1/group/{groupid}/groups` - - -.Modified APIs - -* `POST /tspublic/v1/metadata/assigntag` - -==== - -== Version ts7.aug.cl - -.Custom actions -[%collapsible] -==== - -[width="100%" cols="1,4"] -|==== -|| -|[tag greenBackground]#NEW FEATURE# a| +++
Custom actions for worksheets
+++ - -The Worksheet pages now include a `Custom actions` tab that shows the custom actions created in the Developer portal. ThoughtSpot users can add these actions to a Worksheet and place them as primary actions or menu items in the new visualizations built from that Worksheet. - -This feature is available to all ThoughtSpot users who have edit privileges to a Worksheet. - -For more information, see xref:custom-actions-worksheet.adoc[Add custom actions to a Worksheet]. - -|[tag greenBackground]#NEW FEATURE# a| +++
Query parameters for URL-based custom actions
+++ - -The Developer portal now allows you to add arbitrary key-value pairs as query parameters for a URL action. If a URL endpoint requires specific information, such as the database details or data object attributes, you can add a key-value pair of these attributes when creating a custom action. When the custom action workflow is triggered, these attributes are passed as query parameters in `GET` requests to get the data payload from ThoughtSpot. - -For more information, see xref:custom-actions-url.adoc[Configure a custom URL action]. -|==== - -==== - -.Visual Embed SDK version 1.3.1 - -[%collapsible] -==== -The ThoughtSpot 7 Cloud August release supports Visual Embed SDK version 1.3.1, which includes the following features and enhancements. - -[width="100%" cols="1,4"] -|==== -|| -|[tag greenBackground]#NEW FEATURE# a| +++
searchOptions
+++ - -The `searchEmbed` SDK package introduces the `searchOptions` parameter for setting search tokens. The `searchOptions` parameter includes the following attributes: - -* `searchTokenString` -+ -A TML query string to define search tokens. - -* `executeSearch` -+ -When set to `true`, it executes search and shows the search results. - -For more information, see xref:embed-search.adoc#search-query[Embed ThoughtSpot search]. - -|[tag redBackground]#DEPRECATED# a| +++
searchQuery
+++ - -The `searchQuery` parameter in the `searchEmbed` SDK package is deprecated in the Visual Embed SDK version 1.3.1. Instead, you can use the `searchOptions` parameter to define the search token string. - -For more information about `searchOptions`, see xref:embed-search.adoc#search-query[Embed ThoughtSpot search]. - -|[tag greenBackground]#NEW FEATURE# a| +++
autoLogin
+++ - -The SDK now supports logging in users automatically after a user session has expired. - -For more information, see xref:embed-authentication.adoc#embed-session-sec[Embed user authentication]. - -|[tag greenBackground]#NEW FEATURE# a| +++
shouldEncodeUrlQueryParams
+++ - -You can now convert query parameters in the ThoughtSpot generated URLs to base64-encoded format. You can enable this attribute to secure your cluster from cross-site scripting attacks. -|[tag redBackground]#BREAKING CHANGE# a| +++
Data structure changes in custom action response payloads
+++ - -* The data structure passed in the custom action response for search now shows as `payload.data.embedAnswerData` instead of `payload.data.columnsAndData`. - -* The Answer payload for custom actions includes the following metadata: - -** `reportBookmetadata` -+ -Includes visualization metadata attributes such as description, object header metadata, author details, timestamp of the Answer creation, and modification. - -** user data -+ -Includes user information such as username, GUID of the user, and email address. - -To view a sample response payload, see xref:callback-response-payload.adoc#search-data-payload[Custom action response payload]. - -|[tag greenBackground]#NEW FEATURE# a| +++
preventPinboardFilterRemoval
+++ - -The `pinboardEmbed` SDK package now includes the `preventPinboardFilterRemoval` attribute. You can use this attribute to disable the filter removal action and thus prevent users from removing the filter chips added on a pinboard page. - -For more information, see xref:embed-pinboard.adoc[Embed a pinboard] and xref:embed-a-viz.adoc[Embed a visualization]. -|[tag greenBackground]#NEW FEATURE# a| +++
suppressNoCookieAccessAlert
+++ - -You can now set custom alerts for `noCookieAccess` events. By default, the SDK triggers a `noCookieAccess` event and generates an alert when a user's browser blocks third-party cookies. The `suppressNoCookieAccessAlert` allows you to disable this alert. - -|[tag greenBackground]#NEW FEATURE# a| +++
Support for fetching callback custom action payload in batches
+++ - -The Visual Embed SDK now supports processing data in batches for callback custom action responses. -The callback custom action event in the SDK package supports defining `batchSize` and `offset` values to paginate the Answer payload and send the records in batches. - -For more information, see xref:push-data-to-external-app.adoc#large-dataset[Callback custom action workflow]. -|==== - -==== - -.REST APIs -[%collapsible] -==== - -The ThoughtSpot 7 Cloud August release introduces several new APIs to xref:user-api.adoc[manage users], xref:group-api.adoc[user groups], xref:admin-api.adoc[cluster configuration], xref:dependency-apis.adoc[object dependencies], and so on. - -For a complete list of APIs, see xref:rest-api-reference.adoc[REST API Reference]. - -==== - - -== Version ts7.jun.cl - -.Custom actions -[%collapsible] -==== - -[width="100%" cols="1,4"] -|==== -|[tag greenBackground]#NEW FEATURE# a|+++
Global and local custom actions
+++ - -The ThoughtSpot developer portal now supports configuring a custom action as a __global__ or __local__ action. This feature allows you to determine and control the placement of custom actions in the ThoughtSpot UI. Developers can now choose to create a custom action that will appear on all visualizations, or a specific custom action that can be added to a visualization by a ThoughtSpot user. The custom actions panel in the visualization page allows ThoughtSpot users to view the available custom actions and add an action to any visualization. - -For example, if you want an action that triggers a callback into your parent app, which would then post its data to Slack, you might want to add a custom action globally to all visualizations. Similarly, if you want to send the data obtained from a specific visualization to a URL, you can associate a custom action locally to that visualization. - -For more information, see xref:customize-actions-menu.adoc[Custom actions] and xref:custom-actions-viz.adoc[Add a custom action to a specific visualization]. - -|[tag greenBackground]#NEW FEATURE# a|+++
Authentication schemes for custom actions
+++ - -You can now apply an authentication scheme for a custom action that triggers a data payload to a specific URL target. If an action requires your users to authenticate to send data to a URL, you can specify the authentication method and authorization attributes when creating a custom action in the Developer portal. -ThoughtSpot will use this information to send the required attributes in the `Authorization` headers to the URL endpoint configured in the custom action. - -|[tag greenBackground]#NEW FEATURE# a| -+++
Custom action position settings
+++ - -ThoughtSpot users with edit privileges can now define or modify the position of a custom action on visualization pages. When a developer creates a custom action in the Developer portal, ThoughtSpot adds a menu item to the **More** image:./images/icon-more-10px.png[the more options menu] menu by default. ThoughtSpot users can change this to a context menu action or a primary action at any time. - -If your application instance requires an action that sends only a single row of data from charts or tables, developers can configure a custom action and restrict it to only the contextual menu. If this setting is enabled on a custom action, ThoughtSpot users cannot modify this action on a visualization page. - -For more information, see xref:custom-actions-viz.adoc[Add a custom action to a specific visualization]. -|==== - -==== - -.Custom link format for embedded instances -[%collapsible] -==== - -ThoughtSpot generates links to access objects, such as pinboards, visualizations, and answers, when a user shares an object with another user or follows a pinboard to receive periodic notifications. If you have embedded ThoughtSpot in your application, you might want to generate these links in the format that preserves your host application context. - -For embedded instances, ThoughtSpot now allows you to customize the format of these links in the Developer portal. The *Link Settings* page in the Developer portal allows you to customize the link format for various resource URLs and the *unsubscribe* link sent in email notifications. - -For more information, see xref:customize-links.adoc[Customize links]. -==== - -.REST APIs -[%collapsible] -==== - -The ThoughtSpot 7 Cloud June release includes several new and modified APIs: - -.New APIs - -* `POST /tspublic/v1/security/share` -+ -Use this API to share ThoughtSpot objects with another user or user group. For more information, see xref:security-api.adoc#share-object[Share objects with another user]. - -* `POST /tspublic/v1/security/shareviz` -+ -Use this API to share a specific ThoughtSpot visualization with another user or user group. For more information, see xref:security-api.adoc#shareviz[Share a visualization with another user or user group]. - -* `GET /tspublic/v1/session/login/token` -+ -Use this API to get a login token for a ThoughtSpot user when trusted authentication is enabled. For more information, see xref:session-api.adoc#session-loginToken[Authenticate and log in a user]. - -* `POST /tspublic/v1/metadata/assigntag` -+ -Use this API to programmatically assign a tag to a ThoughtSpot object such as a pinboard, Answer, table, or Worksheet. For more information, see xref:metadata-api.adoc#assign-tag[Assign tags to metadata objects]. - -* `POST /tspublic/v1/metadata/details` -+ -Use this API to query metadata details for a specific data object such as a pinboard, Answer, or a Worksheet. For more information, see xref:metadata-api.adoc#metadata-details[Get metadata details]. - -* `POST /tspublic/v1/metadata/markunmarkfavoritefor` -+ -Use this API to add pinboards and answers to a user's favorites list. For more information, see xref:metadata-api.adoc#set-favorite[Set objects as favorites]. - -* `DELETE /tspublic/v1/metadata/markunmarkfavoritefor` -+ -Use this API to remove an object from a user's favorites list. For more information, see xref:metadata-api.adoc#del-object-fav[Remove objects from favorites]. - -* `POST /tspublic/v1/session/homepinboard` -+ -Use this API to set a pinboard as the home pinboard for a user account. For more information, see xref:session-api.adoc#set-home-pinboard[Set a pinboard as a home pinboard]. - -* `GET /tspublic/v1/session/homepinboard` -+ -Use this API to get the GUID of the pinboard set as a home pinboard. For more information, see xref:session-api.adoc#get-home-pinboard[Get details of the home pinboard]. - -* `DELETE /tspublic/v1/session/homepinboard` -+ -Use this API to remove the home pinboard. For more information, see xref:session-api.adoc#del-home-pinboard[Remove a home pinboard]. - - -.Other API enhancements - -The `POST /tspublic/v1/user/updatepreference` API now includes the optional `username` parameter to allow API users to specify the `username` of the ThoughtSpot user whose profile is being modified. -For more information, see xref:user-api.adoc#updatepreference-api[Update a user profile]. - -==== - - -== Version ts7.may.cl - -.Custom actions in the context menu -[%collapsible] -==== -You can now add a custom action to the contextual menu to send data or initiate an action from an embedded visualization. The *Customization* > *Actions* page in the *Develop* tab allows you to add a custom action to the contextual menu for visualizations in the *Answers* or *Pinboards* page. - -For more information, see xref:customize-actions-menu.adoc[Add custom actions]. -==== - -.Visual Embed SDK version 1.2.0 -[%collapsible] -==== - -[width="100%" cols="1,4"] -|==== -|[tag greenBackground]#NEW FEATURE# a|+++
SAML authentication
+++ - -The Visual Embed SDK packages now include the `noRedirect` attribute as an optional parameter for the `SSO` `AuthType`. If you want to display the SAML authentication workflow in a pop-up window, instead of refreshing the application web page to direct users to the SAML login page, you can set the `noRedirect` attribute to `true`. - -For more information, see the instructions for embedding xref:full-embed.adoc[ThoughtSpot pages], xref:embed-search.adoc[search], xref:embed-pinboard.adoc[pinboard], and xref:embed-a-viz.adoc[visualizations]. - -|[tag greenBackground]#NEW FEATURE# a|+++
Visual Embed SDK notification when third-party cookies are disabled
+++ - -When a user accesses the embedded application from a web browser that has third-party cookies disabled, the Visual Embed SDK emits the `NoCookieAccess` event to notify the developer. Cookies are disabled by default in Safari. Users can enable third-party cookies in Safari’s Preferences setting page or use another web browser. -To know how to enable this setting by default on Safari for a ThoughtSpot embedded instance, contact ThoughtSpot Support. - -|[tag greenBackground]#NEW FEATURE# a|+++
Pinboard actions
+++ -The *More* menu image:./images/icon-more-10px.png[the more options menu] in the embedded Pinboard page now shows the following actions for pinboard and visualizations. - -Pinboard:: -* Save -* Make a copy -* Add filters -* Configure filters -* Present -* Download as PDF -* Pinboard info -* Manage schedules - - -[NOTE] -Users with edit permissions can view and access the *Save*, *Add filters*, *Configure filters*, and *Manage schedules* actions. -|[tag greenBackground]#NEW FEATURE# a|+++
Visualization actions
+++ - -Visualizations on a pinboard: - -* Pin -* Download -* Edit -* Present -* Download as CSV -* Download as XLSX -* Download as PDF - -[NOTE] -Users with edit permissions can view and access the *Edit* action. The *Download as CSV*, *Download as XSLX*, and *Download as PDF* actions are available for table visualizations. The *Download* action is available for chart visualizations. - -|==== - -==== - -.Performance optimization -[%collapsible] -==== -This release introduces the following performance improvements for ThoughtSpot embedded applications: - -* Faster loading of embedded objects and application pages. -* Faster loading of preview results in the Playground. -==== -.REST APIs -[%collapsible] -==== -The ThoughtSpot 7 Cloud May release introduces the following REST APIs: - -* `*POST* /tspublic/v1/user/updatepreference` -+ -You can use this API to programmatically update a ThoughtSpot user's profile settings such as the email address, locale preference, notification settings, and the preference for revisiting the onboarding experience. For more information, see xref:user-api.adoc#updatepreference-api[User API]. - -* `*GET* /tspublic/v1/metadata/listas` -+ -You can use this API to get a list of object headers for a ThoughtSpot user or user group. For more information, see xref:metadata-api.adoc#headers-metadata-users[Metadata API]. -==== +|=== diff --git a/package-lock.json b/package-lock.json index e4e9d1f23..00b381396 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,6 +9,7 @@ "dependencies": { "@vercel/analytics": "^1.0.2", "algoliasearch": "^4.10.5", + "cheerio": "^1.2.0", "classnames": "^2.3.1", "eventemitter3": "^4.0.7", "gatsby-plugin-vercel": "^1.0.3", @@ -17,17 +18,19 @@ "lodash": "^4.17.21", "mixpanel-browser": "^2.45.0", "react-helmet": "^6.1.0", + "turndown": "^7.2.4", + "turndown-plugin-gfm": "^1.0.2", "use-deep-compare-effect": "^1.8.1" }, "devDependencies": { "@react-icons/all-files": "^4.1.0", "@testing-library/jest-dom": "^5.14.1", - "@testing-library/react": "^11.2.7", + "@testing-library/react": "^13.4.0", "@types/mixpanel-browser": "^2.35.6", "@types/react": "^18.2.14", "@types/react-helmet": "^6.1.6", "@types/react-modal": "^3.16.0", - "@types/react-test-renderer": "^17.0.1", + "@types/react-test-renderer": "^18.0.0", "@typescript-eslint/eslint-plugin": "^4.6.0", "@typescript-eslint/parser": "^4.6.0", "asciidoctor": "^2.2.1", @@ -2218,19 +2221,6 @@ "node": ">=6.9.0" } }, - "node_modules/@babel/runtime-corejs3": { - "version": "7.22.6", - "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.22.6.tgz", - "integrity": "sha512-M+37LLIRBTEVjktoJjbw4KVhupF0U/3PYUCbBwgAd9k17hoKhRu1n935QiG7Tuxv0LJOMrb2vuKEeYUlv0iyiw==", - "dev": true, - "dependencies": { - "core-js-pure": "^3.30.2", - "regenerator-runtime": "^0.13.11" - }, - "engines": { - "node": ">=6.9.0" - } - }, "node_modules/@babel/template": { "version": "7.22.5", "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.22.5.tgz", @@ -2831,14 +2821,6 @@ "tslib": "^2.4.0" } }, - "node_modules/@gar/promisify": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@gar/promisify/-/promisify-1.1.3.tgz", - "integrity": "sha512-k2Ty1JcVojjJFwrg/ThKi2ujJ7XNLYaFGNB/bWT9wGR+oSMJHMa5w+CUq6p/pVrKeNNgA7pCqEcjSnHVoqJQFw==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/@gatsbyjs/parcel-namer-relative-to-cwd": { "version": "1.10.0", "resolved": "https://registry.npmjs.org/@gatsbyjs/parcel-namer-relative-to-cwd/-/parcel-namer-relative-to-cwd-1.10.0.tgz", @@ -4419,6 +4401,12 @@ "node": ">=12.0.0" } }, + "node_modules/@mixmark-io/domino": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/@mixmark-io/domino/-/domino-2.2.0.tgz", + "integrity": "sha512-Y28PR25bHXUg88kCV7nivXrP2Nj2RueZ3/l/jdx6J9f8J4nsEGcgX0Qe6lt7Pa+J79+kPiJU3LguR6O/6zrLOw==", + "license": "BSD-2-Clause" + }, "node_modules/@mrmlnc/readdir-enhanced": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/@mrmlnc/readdir-enhanced/-/readdir-enhanced-2.2.1.tgz", @@ -4543,87 +4531,6 @@ "node": ">= 8" } }, - "node_modules/@npmcli/fs": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/@npmcli/fs/-/fs-1.1.1.tgz", - "integrity": "sha512-8KG5RD0GVP4ydEzRn/I4BNDuxDtqVbOdm8675T49OIG/NGhaK0pjPX7ZcDlvKYbA+ulvVK3ztfcF4uBdOxuJbQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "@gar/promisify": "^1.0.1", - "semver": "^7.3.5" - } - }, - "node_modules/@npmcli/fs/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/@npmcli/fs/node_modules/semver": { - "version": "7.5.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", - "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "lru-cache": "^6.0.0" - }, - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/@npmcli/fs/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - }, - "node_modules/@npmcli/move-file": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@npmcli/move-file/-/move-file-1.1.2.tgz", - "integrity": "sha512-1SUf/Cg2GzGDyaf15aR9St9TWlb+XvbZXWpDx8YKs7MLzMH/BCeopv+y9vzrzgkfykCGuWOlSu3mZhj2+FQcrg==", - "deprecated": "This functionality has been moved to @npmcli/fs", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "mkdirp": "^1.0.4", - "rimraf": "^3.0.2" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/@npmcli/move-file/node_modules/mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "dev": true, - "optional": true, - "peer": true, - "bin": { - "mkdirp": "bin/cmd.js" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/@parcel/bundler-default": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/@parcel/bundler-default/-/bundler-default-2.6.2.tgz", @@ -6037,22 +5944,23 @@ } }, "node_modules/@testing-library/dom": { - "version": "7.31.2", - "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-7.31.2.tgz", - "integrity": "sha512-3UqjCpey6HiTZT92vODYLPxTBWlM8ZOOjr3LX5F37/VRipW2M1kX6I/Cm4VXzteZqfGfagg8yXywpcOgQBlNsQ==", + "version": "8.20.1", + "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-8.20.1.tgz", + "integrity": "sha512-/DiOQ5xBxgdYRC8LNk7U+RWat0S3qRLeIw3ZIkMQ9kkVlRmwD/Eg8k8CqIpD6GW7u20JIUOfMKbxtiLutpjQ4g==", "dev": true, + "license": "MIT", "dependencies": { "@babel/code-frame": "^7.10.4", "@babel/runtime": "^7.12.5", - "@types/aria-query": "^4.2.0", - "aria-query": "^4.2.2", + "@types/aria-query": "^5.0.1", + "aria-query": "5.1.3", "chalk": "^4.1.0", - "dom-accessibility-api": "^0.5.6", - "lz-string": "^1.4.4", - "pretty-format": "^26.6.2" + "dom-accessibility-api": "^0.5.9", + "lz-string": "^1.5.0", + "pretty-format": "^27.0.2" }, "engines": { - "node": ">=10" + "node": ">=12" } }, "node_modules/@testing-library/dom/node_modules/ansi-styles": { @@ -6060,6 +5968,7 @@ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", "dev": true, + "license": "MIT", "dependencies": { "color-convert": "^2.0.1" }, @@ -6071,16 +5980,13 @@ } }, "node_modules/@testing-library/dom/node_modules/aria-query": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-4.2.2.tgz", - "integrity": "sha512-o/HelwhuKpTj/frsOsbNLNgnNGVIFsVP/SW2BSF14gVl7kAfMOJ6/8wUAUvG1R1NHKrfG+2sHZTu0yauT1qBrA==", + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.1.3.tgz", + "integrity": "sha512-R5iJ5lkuHybztUfuOAznmboyjWq8O6sqNqtK7CLOqdydi54VNbORp49mb14KbWgG1QD3JFO9hJdZ+y4KutfdOQ==", "dev": true, + "license": "Apache-2.0", "dependencies": { - "@babel/runtime": "^7.10.2", - "@babel/runtime-corejs3": "^7.10.2" - }, - "engines": { - "node": ">=6.0" + "deep-equal": "^2.0.5" } }, "node_modules/@testing-library/dom/node_modules/chalk": { @@ -6088,6 +5994,7 @@ "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", "dev": true, + "license": "MIT", "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" @@ -6104,6 +6011,7 @@ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", "dev": true, + "license": "MIT", "dependencies": { "color-name": "~1.1.4" }, @@ -6115,22 +6023,53 @@ "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@testing-library/dom/node_modules/has-flag": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } }, + "node_modules/@testing-library/dom/node_modules/pretty-format": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", + "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1", + "ansi-styles": "^5.0.0", + "react-is": "^17.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@testing-library/dom/node_modules/pretty-format/node_modules/ansi-styles": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", + "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, "node_modules/@testing-library/dom/node_modules/supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", "dev": true, + "license": "MIT", "dependencies": { "has-flag": "^4.0.0" }, @@ -6228,20 +6167,22 @@ } }, "node_modules/@testing-library/react": { - "version": "11.2.7", - "resolved": "https://registry.npmjs.org/@testing-library/react/-/react-11.2.7.tgz", - "integrity": "sha512-tzRNp7pzd5QmbtXNG/mhdcl7Awfu/Iz1RaVHY75zTdOkmHCuzMhRL83gWHSgOAcjS3CCbyfwUHMZgRJb4kAfpA==", + "version": "13.4.0", + "resolved": "https://registry.npmjs.org/@testing-library/react/-/react-13.4.0.tgz", + "integrity": "sha512-sXOGON+WNTh3MLE9rve97ftaZukN3oNf2KjDy7YTx6hcTO2uuLHuCGynMDhFwGw/jYf4OJ2Qk0i4i79qMNNkyw==", "dev": true, + "license": "MIT", "dependencies": { "@babel/runtime": "^7.12.5", - "@testing-library/dom": "^7.28.1" + "@testing-library/dom": "^8.5.0", + "@types/react-dom": "^18.0.0" }, "engines": { - "node": ">=10" + "node": ">=12" }, "peerDependencies": { - "react": "*", - "react-dom": "*" + "react": "^18.0.0", + "react-dom": "^18.0.0" } }, "node_modules/@tokenizer/token": { @@ -6307,10 +6248,11 @@ "integrity": "sha512-qLOvfmlG2vCVw5fo/oz8WAZYlpe5a5OurgTj3diIxJCdjRHpapC+vQCz3er9LV79Vcat+DifBjeAhOAdmndtDQ==" }, "node_modules/@types/aria-query": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-4.2.2.tgz", - "integrity": "sha512-HnYpAE1Y6kRyKM/XkEuiRQhTHvkzMBurTHnpFLYLBGPIylZNPs9jJcuOOYWxPLJCSEtmZT0Y8rHDokKN7rRTig==", - "dev": true + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-5.0.4.tgz", + "integrity": "sha512-rfT93uj5s0PRL7EzccGMs3brplhcrghnDoV26NqKhCAS1hVo+WdNsPvE/yb6ilfr5hi2MEk6d5EWJTKdxg8jVw==", + "dev": true, + "license": "MIT" }, "node_modules/@types/babel__core": { "version": "7.20.1", @@ -6570,14 +6512,6 @@ "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-5.1.2.tgz", "integrity": "sha512-K0VQKziLUWkVKiRVrx4a40iPaxTUefQmjtkQofBkYRcoaaL/8rhwDWww9qWbrgicNOgnpIsMxyNIUM4+n6dUIA==" }, - "node_modules/@types/minimist": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/@types/minimist/-/minimist-1.2.2.tgz", - "integrity": "sha512-jhuKLIRrhvCPLqwPcx6INqmKeiA5EWrsCOPhrlFSrbrmU4ZMPjj5Ul/oLCMDO98XRUIwVm78xICz4EPCektzeQ==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/@types/mixpanel-browser": { "version": "2.47.1", "resolved": "https://registry.npmjs.org/@types/mixpanel-browser/-/mixpanel-browser-2.47.1.tgz", @@ -6650,6 +6584,16 @@ "csstype": "^3.0.2" } }, + "node_modules/@types/react-dom": { + "version": "18.3.7", + "resolved": "https://registry.npmjs.org/@types/react-dom/-/react-dom-18.3.7.tgz", + "integrity": "sha512-MEe3UeoENYVFXzoXEWsvcpg6ZvlrFNlOQ7EOsvhI3CfAXwzPfO8Qwuxd40nepsYKqyyVQnTdEfv68q91yLcKrQ==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "@types/react": "^18.0.0" + } + }, "node_modules/@types/react-helmet": { "version": "6.1.6", "resolved": "https://registry.npmjs.org/@types/react-helmet/-/react-helmet-6.1.6.tgz", @@ -6669,23 +6613,13 @@ } }, "node_modules/@types/react-test-renderer": { - "version": "17.0.2", - "resolved": "https://registry.npmjs.org/@types/react-test-renderer/-/react-test-renderer-17.0.2.tgz", - "integrity": "sha512-+F1KONQTBHDBBhbHuT2GNydeMpPuviduXIVJRB7Y4nma4NR5DrTJfMMZ+jbhEHbpwL+Uqhs1WXh4KHiyrtYTPg==", - "dev": true, - "dependencies": { - "@types/react": "^17" - } - }, - "node_modules/@types/react-test-renderer/node_modules/@types/react": { - "version": "17.0.62", - "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.62.tgz", - "integrity": "sha512-eANCyz9DG8p/Vdhr0ZKST8JV12PhH2ACCDYlFw6DIO+D+ca+uP4jtEDEpVqXZrh/uZdXQGwk7whJa3ah5DtyLw==", + "version": "18.3.1", + "resolved": "https://registry.npmjs.org/@types/react-test-renderer/-/react-test-renderer-18.3.1.tgz", + "integrity": "sha512-vAhnk0tG2eGa37lkU9+s5SoroCsRI08xnsWFiAXOuPH2jqzMbcXvKExXViPi1P5fIklDeCvXqyrdmipFaSkZrA==", "dev": true, + "license": "MIT", "dependencies": { - "@types/prop-types": "*", - "@types/scheduler": "*", - "csstype": "^3.0.2" + "@types/react": "^18" } }, "node_modules/@types/responselike": { @@ -7143,14 +7077,6 @@ "integrity": "sha512-j2afSsaIENvHZN2B8GOpF566vZ5WVk5opAiMTvWgaQT8DkbOqsTfvNAvHoRGU2zzP8cPoqys+xHTRDWW8L+/BA==", "dev": true }, - "node_modules/abbrev": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", - "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/abortcontroller-polyfill": { "version": "1.7.5", "resolved": "https://registry.npmjs.org/abortcontroller-polyfill/-/abortcontroller-polyfill-1.7.5.tgz", @@ -7269,35 +7195,6 @@ "node": ">= 6.0.0" } }, - "node_modules/agentkeepalive": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/agentkeepalive/-/agentkeepalive-4.5.0.tgz", - "integrity": "sha512-5GG/5IbQQpC9FpkRGsSvZI5QYeSCzlJHdpBQntCsuTOxhKD8lqKhrleg2Yi7yvMIf82Ycmmqln9U8V9qwEiJew==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "humanize-ms": "^1.2.1" - }, - "engines": { - "node": ">= 8.0.0" - } - }, - "node_modules/aggregate-error": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", - "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "clean-stack": "^2.0.0", - "indent-string": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/ajv": { "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", @@ -7446,14 +7343,6 @@ "resolved": "https://registry.npmjs.org/application-config-path/-/application-config-path-0.1.1.tgz", "integrity": "sha512-zy9cHePtMP0YhwG+CfHm0bgwdnga2X3gZexpdCwEj//dpb+TKajtiC8REEUJUSq6Ab4f9cgNy2l8ObXzCXFkEw==" }, - "node_modules/aproba": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/aproba/-/aproba-2.0.0.tgz", - "integrity": "sha512-lYe4Gx7QT+MKGbDsA+Z+he/Wtef0BiwDOlK/XkBrdfsh9J/jPPXbX0tE9x9cl27Tmu5gg3QUbUrQYa/y+KOHPQ==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/arch": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/arch/-/arch-2.2.0.tgz", @@ -7473,37 +7362,6 @@ } ] }, - "node_modules/are-we-there-yet": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/are-we-there-yet/-/are-we-there-yet-2.0.0.tgz", - "integrity": "sha512-Ci/qENmwHnsYo9xKIcUJN5LeDKdJ6R1Z1j9V/J5wyq8nh/mYPEpIKJbBZXtZjG04HiK7zV/p6Vs9952MrMeUIw==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "delegates": "^1.0.0", - "readable-stream": "^3.6.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/are-we-there-yet/node_modules/readable-stream": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", - "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "inherits": "^2.0.3", - "string_decoder": "^1.1.1", - "util-deprecate": "^1.0.1" - }, - "engines": { - "node": ">= 6" - } - }, "node_modules/arg": { "version": "5.0.2", "resolved": "https://registry.npmjs.org/arg/-/arg-5.0.2.tgz", @@ -7811,17 +7669,6 @@ "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz", "integrity": "sha512-ncTzHV7NvsQZkYe1DW7cbDLm0YpzHmZF5r/iyP3ZnQtMiJ+pjzisCiMNI+Sj+xQF5pXhSHxSB3uDbsBTzY/c2A==" }, - "node_modules/async-foreach": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/async-foreach/-/async-foreach-0.1.3.tgz", - "integrity": "sha512-VUeSMD8nEGBWaZK4lizI1sf3yEC7pnAQ/mrI7pC2fBz2s/tq5jWWEngTwaf0Gruu/OoXRGLGg1XFqpYBiGTYJA==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": "*" - } - }, "node_modules/asynckit": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", @@ -7890,9 +7737,13 @@ } }, "node_modules/available-typed-arrays": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.5.tgz", - "integrity": "sha512-DMD0KiN46eipeziST1LPP/STfDU0sufISXmjSgvVsoU2tqxctQeASejWcfNtxYKqETM1UxQ8sp2OrSBWpHY6sw==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "license": "MIT", + "dependencies": { + "possible-typed-array-names": "^1.0.0" + }, "engines": { "node": ">= 0.4" }, @@ -7944,6 +7795,7 @@ "resolved": "https://registry.npmjs.org/babel-eslint/-/babel-eslint-10.1.0.tgz", "integrity": "sha512-ifWaTHQ0ce+448CYop8AdrQiBsGrnC+bMgfyKFdi6EsPLTAWG+QfyDeM6OH+FmWnKvEq5NnBMLvlBUPKQZoDSg==", "deprecated": "babel-eslint is now @babel/eslint-parser. This package will no longer receive updates.", + "license": "MIT", "peer": true, "dependencies": { "@babel/code-frame": "^7.0.0", @@ -7964,6 +7816,7 @@ "version": "1.3.0", "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "license": "Apache-2.0", "peer": true, "engines": { "node": ">=4" @@ -8774,95 +8627,6 @@ "node": ">= 0.8" } }, - "node_modules/cacache": { - "version": "15.3.0", - "resolved": "https://registry.npmjs.org/cacache/-/cacache-15.3.0.tgz", - "integrity": "sha512-VVdYzXEn+cnbXpFgWs5hTT7OScegHVmLhJIR8Ufqk3iFD6A6j5iSX1KuBTfNEv4tdJWE2PzA6IVFtcLC7fN9wQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "@npmcli/fs": "^1.0.0", - "@npmcli/move-file": "^1.0.1", - "chownr": "^2.0.0", - "fs-minipass": "^2.0.0", - "glob": "^7.1.4", - "infer-owner": "^1.0.4", - "lru-cache": "^6.0.0", - "minipass": "^3.1.1", - "minipass-collect": "^1.0.2", - "minipass-flush": "^1.0.5", - "minipass-pipeline": "^1.2.2", - "mkdirp": "^1.0.3", - "p-map": "^4.0.0", - "promise-inflight": "^1.0.1", - "rimraf": "^3.0.2", - "ssri": "^8.0.1", - "tar": "^6.0.2", - "unique-filename": "^1.1.1" - }, - "engines": { - "node": ">= 10" - } - }, - "node_modules/cacache/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/cacache/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/cacache/node_modules/mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "dev": true, - "optional": true, - "peer": true, - "bin": { - "mkdirp": "bin/cmd.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/cacache/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/cache-base": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/cache-base/-/cache-base-1.0.1.tgz", @@ -8946,12 +8710,47 @@ } }, "node_modules/call-bind": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.9.tgz", + "integrity": "sha512-a/hy+pNsFUTR+Iz8TCJvXudKVLAnz/DyeSUo10I5yvFDQJBFU2s9uqQpoSrJlroHUKoKqzg+epxyP9lqFdzfBQ==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "get-intrinsic": "^1.3.0", + "set-function-length": "^1.2.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/call-bind-apply-helpers": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", - "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "license": "MIT", "dependencies": { - "function-bind": "^1.1.1", - "get-intrinsic": "^1.0.2" + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -8987,36 +8786,6 @@ "node": ">=6" } }, - "node_modules/camelcase-keys": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/camelcase-keys/-/camelcase-keys-6.2.2.tgz", - "integrity": "sha512-YrwaA0vEKazPBkn0ipTiMpSajYDSe+KjQfrjhcBMxJt/znbvlHd8Pw/Vamaz5EB4Wfhs3SUR3Z9mwRu/P3s3Yg==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "camelcase": "^5.3.1", - "map-obj": "^4.0.0", - "quick-lru": "^4.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/camelcase-keys/node_modules/quick-lru": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-4.0.1.tgz", - "integrity": "sha512-ARhCpm70fzdcvNQfPoy49IaanKkTlRWF2JMzqhcJbhSFRZv7nPTvZJdcY7301IPmvW+/p0RgIWnQDLJxifsQ7g==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=8" - } - }, "node_modules/caniuse-api": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/caniuse-api/-/caniuse-api-3.0.0.tgz", @@ -9029,9 +8798,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001519", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001519.tgz", - "integrity": "sha512-0QHgqR+Jv4bxHMp8kZ1Kn8CH55OikjKJ6JmKkZYP1F3D7w+lnFXF70nG5eNfsZS89jadi5Ywy5UCSKLAglIRkg==", + "version": "1.0.30001792", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001792.tgz", + "integrity": "sha512-hVLMUZFgR4JJ6ACt1uEESvQN1/dBVqPAKY0hgrV70eN3391K6juAfTjKZLKvOMsx8PxA7gsY1/tLMMTcfFLLpw==", "funding": [ { "type": "opencollective", @@ -9045,7 +8814,8 @@ "type": "github", "url": "https://github.com/sponsors/ai" } - ] + ], + "license": "CC-BY-4.0" }, "node_modules/capital-case": { "version": "1.0.4", @@ -9168,6 +8938,238 @@ "resolved": "https://registry.npmjs.org/chardet/-/chardet-0.7.0.tgz", "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==" }, + "node_modules/cheerio": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.2.0.tgz", + "integrity": "sha512-WDrybc/gKFpTYQutKIK6UvfcuxijIZfMfXaYm8NMsPQxSYvf+13fXUJ4rztGGbJcBQ/GF55gvrZ0Bc0bj/mqvg==", + "license": "MIT", + "dependencies": { + "cheerio-select": "^2.1.0", + "dom-serializer": "^2.0.0", + "domhandler": "^5.0.3", + "domutils": "^3.2.2", + "encoding-sniffer": "^0.2.1", + "htmlparser2": "^10.1.0", + "parse5": "^7.3.0", + "parse5-htmlparser2-tree-adapter": "^7.1.0", + "parse5-parser-stream": "^7.1.2", + "undici": "^7.19.0", + "whatwg-mimetype": "^4.0.0" + }, + "engines": { + "node": ">=20.18.1" + }, + "funding": { + "url": "https://github.com/cheeriojs/cheerio?sponsor=1" + } + }, + "node_modules/cheerio-select": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-2.1.0.tgz", + "integrity": "sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0", + "css-select": "^5.1.0", + "css-what": "^6.1.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/cheerio-select/node_modules/css-select": { + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.2.2.tgz", + "integrity": "sha512-TizTzUddG/xYLA3NXodFM0fSbNizXjOKhqiQQwvhlspadZokn1KDy0NZFS0wuEubIYAV5/c1/lAr0TaaFXEXzw==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0", + "css-what": "^6.1.0", + "domhandler": "^5.0.2", + "domutils": "^3.0.1", + "nth-check": "^2.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/cheerio-select/node_modules/dom-serializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", + "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==", + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.2", + "entities": "^4.2.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/cheerio-select/node_modules/domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "license": "BSD-2-Clause", + "dependencies": { + "domelementtype": "^2.3.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/cheerio-select/node_modules/domutils": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.2.2.tgz", + "integrity": "sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==", + "license": "BSD-2-Clause", + "dependencies": { + "dom-serializer": "^2.0.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, + "node_modules/cheerio-select/node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/cheerio/node_modules/dom-serializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", + "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==", + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.2", + "entities": "^4.2.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/cheerio/node_modules/domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "license": "BSD-2-Clause", + "dependencies": { + "domelementtype": "^2.3.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/cheerio/node_modules/domutils": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.2.2.tgz", + "integrity": "sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==", + "license": "BSD-2-Clause", + "dependencies": { + "dom-serializer": "^2.0.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, + "node_modules/cheerio/node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/cheerio/node_modules/htmlparser2": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-10.1.0.tgz", + "integrity": "sha512-VTZkM9GWRAtEpveh7MSF6SjjrpNVNNVJfFup7xTY3UpFtm67foy9HDVXneLtFVt4pMz5kZtgNcvCniNFb1hlEQ==", + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.2.2", + "entities": "^7.0.1" + } + }, + "node_modules/cheerio/node_modules/htmlparser2/node_modules/entities": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-7.0.1.tgz", + "integrity": "sha512-TWrgLOFUQTH994YUyl1yT4uyavY5nNB5muff+RtWaqNVCAK408b5ZnnbNAUEWLTCpum9w6arT70i1XdQ4UeOPA==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/cheerio/node_modules/parse5": { + "version": "7.3.0", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", + "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", + "license": "MIT", + "dependencies": { + "entities": "^6.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/cheerio/node_modules/parse5/node_modules/entities": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", + "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/cheerio/node_modules/whatwg-mimetype": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz", + "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==", + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/chokidar": { "version": "3.5.3", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.5.3.tgz", @@ -9194,17 +9196,6 @@ "fsevents": "~2.3.2" } }, - "node_modules/chownr": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/chownr/-/chownr-2.0.0.tgz", - "integrity": "sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=10" - } - }, "node_modules/chrome-trace-event": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.3.tgz", @@ -9324,17 +9315,6 @@ "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.3.2.tgz", "integrity": "sha512-CSbhY4cFEJRe6/GQzIk5qXZ4Jeg5pcsP7b5peFSDpffpe1cqjASH/n9UTjBwOp6XpMSTwQ8Za2K5V02ueA7Tmw==" }, - "node_modules/clean-stack": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", - "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=6" - } - }, "node_modules/cli-boxes": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-2.2.1.tgz", @@ -9600,17 +9580,6 @@ "simple-swizzle": "^0.2.2" } }, - "node_modules/color-support": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/color-support/-/color-support-1.1.3.tgz", - "integrity": "sha512-qiBjkpbMLO/HL68y+lh4q0/O1MZFj2RX6X/KmMa3+gJD3z+WwI1ZzDHysvqHGS3mP6mznPckpXmw1nI9cJjyRg==", - "dev": true, - "optional": true, - "peer": true, - "bin": { - "color-support": "bin.js" - } - }, "node_modules/color/node_modules/color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", @@ -9801,14 +9770,6 @@ "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.11.tgz", "integrity": "sha512-JsPKdmh8ZkmnHxDk55FZ1TqVLvEQTvoByJZRN9jzI0UjxK/QgAmsphz7PGtqgPieQZ/CQcHWXCR7ATDNhGe+YA==" }, - "node_modules/console-control-strings": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz", - "integrity": "sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/constant-case": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/constant-case/-/constant-case-3.0.4.tgz", @@ -10407,35 +10368,6 @@ "node": ">=0.10.0" } }, - "node_modules/decamelize-keys": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/decamelize-keys/-/decamelize-keys-1.1.1.tgz", - "integrity": "sha512-WiPxgEirIV0/eIOMcnFBA3/IJZAZqKnwAwWyvvdi4lsr1WCN22nhdf/3db3DoZcUjTV2SqfzIwNyp6y2xs3nmg==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "decamelize": "^1.1.0", - "map-obj": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/decamelize-keys/node_modules/map-obj": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-1.0.1.tgz", - "integrity": "sha512-7N/q3lyZ+LVCp7PzuxrJr4KMbBE2hW7BT7YNia330OFxIf4d3r5zVpicP2650l7CPN6RM9zOJRl3NGpqSiw3Eg==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/decimal.js": { "version": "10.4.3", "resolved": "https://registry.npmjs.org/decimal.js/-/decimal.js-10.4.3.tgz", @@ -10475,6 +10407,46 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/deep-equal": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/deep-equal/-/deep-equal-2.2.3.tgz", + "integrity": "sha512-ZIwpnevOurS8bpT4192sqAowWM76JDKSHYzMLty3BZGSswgq6pBaH3DhCSW5xVAZICZyKdOBPjwww5wfgT/6PA==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-buffer-byte-length": "^1.0.0", + "call-bind": "^1.0.5", + "es-get-iterator": "^1.1.3", + "get-intrinsic": "^1.2.2", + "is-arguments": "^1.1.1", + "is-array-buffer": "^3.0.2", + "is-date-object": "^1.0.5", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.2", + "isarray": "^2.0.5", + "object-is": "^1.1.5", + "object-keys": "^1.1.1", + "object.assign": "^4.1.4", + "regexp.prototype.flags": "^1.5.1", + "side-channel": "^1.0.4", + "which-boxed-primitive": "^1.0.2", + "which-collection": "^1.0.1", + "which-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/deep-equal/node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "license": "MIT" + }, "node_modules/deep-extend": { "version": "0.6.0", "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", @@ -10504,6 +10476,23 @@ "node": ">=10" } }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/define-lazy-prop": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz", @@ -10513,10 +10502,12 @@ } }, "node_modules/define-properties": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.0.tgz", - "integrity": "sha512-xvqAVKGfT1+UAvPwKTVw/njhdQ8ZhXK4lI0bCIuCMrp2up9nPnaDftrLtmpTazqd1o+UY4zgzU+avtMbDP+ldA==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "license": "MIT", "dependencies": { + "define-data-property": "^1.0.1", "has-property-descriptors": "^1.0.0", "object-keys": "^1.1.1" }, @@ -10547,14 +10538,6 @@ "node": ">=0.4.0" } }, - "node_modules/delegates": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/delegates/-/delegates-1.0.0.tgz", - "integrity": "sha512-bd2L678uiWATM6m5Z1VzNCErI3jiGzt6HGY8OVICs40JQq/HALfbyNJmp0UDakEY4pMMaN0Ly5om/B1VI/+xfQ==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/depd": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", @@ -10976,6 +10959,20 @@ "node": "*" } }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/duplexer": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", @@ -11039,22 +11036,24 @@ "node": ">= 0.8" } }, - "node_modules/encoding": { - "version": "0.1.13", - "resolved": "https://registry.npmjs.org/encoding/-/encoding-0.1.13.tgz", - "integrity": "sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A==", - "optional": true, - "peer": true, + "node_modules/encoding-sniffer": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/encoding-sniffer/-/encoding-sniffer-0.2.1.tgz", + "integrity": "sha512-5gvq20T6vfpekVtqrYQsSCFZ1wEg5+wW0/QaZMWkFr6BqD3NfKs0rLCx4rrVlSWJeZb5NBJgVLswK/w2MWU+Gw==", + "license": "MIT", "dependencies": { - "iconv-lite": "^0.6.2" + "iconv-lite": "^0.6.3", + "whatwg-encoding": "^3.1.1" + }, + "funding": { + "url": "https://github.com/fb55/encoding-sniffer?sponsor=1" } }, - "node_modules/encoding/node_modules/iconv-lite": { + "node_modules/encoding-sniffer/node_modules/iconv-lite": { "version": "0.6.3", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", - "optional": true, - "peer": true, + "license": "MIT", "dependencies": { "safer-buffer": ">= 2.1.2 < 3.0.0" }, @@ -11062,6 +11061,19 @@ "node": ">=0.10.0" } }, + "node_modules/encoding-sniffer/node_modules/whatwg-encoding": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz", + "integrity": "sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ==", + "deprecated": "Use @exodus/bytes instead for a more spec-conformant and faster implementation", + "license": "MIT", + "dependencies": { + "iconv-lite": "0.6.3" + }, + "engines": { + "node": ">=18" + } + }, "node_modules/end-of-stream": { "version": "1.4.4", "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", @@ -11185,17 +11197,6 @@ "url": "https://github.com/fb55/entities?sponsor=1" } }, - "node_modules/env-paths": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/env-paths/-/env-paths-2.2.1.tgz", - "integrity": "sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=6" - } - }, "node_modules/envinfo": { "version": "7.10.0", "resolved": "https://registry.npmjs.org/envinfo/-/envinfo-7.10.0.tgz", @@ -11212,14 +11213,6 @@ "resolved": "https://registry.npmjs.org/eol/-/eol-0.9.1.tgz", "integrity": "sha512-Ds/TEoZjwggRoz/Q2O7SE3i4Jm66mqTDfmdHdq/7DKVk3bro9Q8h6WdXKdPqFLMoqxrDK5SVRzHVPOS6uuGtrg==" }, - "node_modules/err-code": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/err-code/-/err-code-2.0.3.tgz", - "integrity": "sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/error-ex": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", @@ -11288,11 +11281,69 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-get-iterator": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/es-get-iterator/-/es-get-iterator-1.1.3.tgz", + "integrity": "sha512-sPZmqHBe6JIiTfN5q2pEi//TwxmAFHwj/XEuYjTuse78i8KxaqMTTzxPoFKuzRpDpTJ+0NAbpfenkmH2rePtuw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.3", + "has-symbols": "^1.0.3", + "is-arguments": "^1.1.1", + "is-map": "^2.0.2", + "is-set": "^2.0.2", + "is-string": "^1.0.7", + "isarray": "^2.0.5", + "stop-iteration-iterator": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-get-iterator/node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "license": "MIT" + }, "node_modules/es-module-lexer": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.3.0.tgz", "integrity": "sha512-vZK7T0N2CBmBOixhmjdqx2gWVbFZ4DXZ/NyRMZVlJXPa7CyFS+/a4QQsDGDQy9ZfEzxFuNEsMLeQJnKP2p5/JA==" }, + "node_modules/es-object-atoms": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/es-set-tostringtag": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.1.tgz", @@ -13269,11 +13320,18 @@ } }, "node_modules/for-each": { - "version": "0.3.3", - "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz", - "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==", + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.5.tgz", + "integrity": "sha512-dKx12eRCVIzqCxFGplyFKJMPvLEWgmNtUrpTiJIR5u97zEhRG8ySrtboPHZXx7daLxQVrl643cTzbab2tkQjxg==", + "license": "MIT", "dependencies": { - "is-callable": "^1.1.3" + "is-callable": "^1.2.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, "node_modules/for-in": { @@ -13573,20 +13631,6 @@ "node": ">=12" } }, - "node_modules/fs-minipass": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-2.1.0.tgz", - "integrity": "sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "minipass": "^3.0.0" - }, - "engines": { - "node": ">= 8" - } - }, "node_modules/fs-monkey": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/fs-monkey/-/fs-monkey-1.0.4.tgz", @@ -13611,9 +13655,13 @@ } }, "node_modules/function-bind": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", - "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==" + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, "node_modules/function.prototype.name": { "version": "1.1.5", @@ -15280,42 +15328,6 @@ "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" }, - "node_modules/gauge": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/gauge/-/gauge-3.0.2.tgz", - "integrity": "sha512-+5J6MS/5XksCuXq++uFRsnUd7Ovu1XenbeuIuNRJxYWjgQbPuFhT14lAvsWfqfAmnwluf1OwMjz39HjfLPci0Q==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "aproba": "^1.0.3 || ^2.0.0", - "color-support": "^1.1.2", - "console-control-strings": "^1.0.0", - "has-unicode": "^2.0.1", - "object-assign": "^4.1.1", - "signal-exit": "^3.0.0", - "string-width": "^4.2.3", - "strip-ansi": "^6.0.1", - "wide-align": "^1.1.2" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/gaze": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/gaze/-/gaze-1.1.3.tgz", - "integrity": "sha512-BRdNm8hbWzFzWHERTrejLqwHDfS4GibPoq5wjTPIoJHoBtKGPg3xAFfxmM+9ztbXelxcf2hwQcaz1PtmFeue8g==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "globule": "^1.0.0" - }, - "engines": { - "node": ">= 4.0.0" - } - }, "node_modules/gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", @@ -15333,14 +15345,24 @@ } }, "node_modules/get-intrinsic": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.1.tgz", - "integrity": "sha512-2DcsyfABl+gVHEfCOaTrWgyt+tb6MSEGmKq+kI5HwLbIYgjgmMcV8KQ41uaKz1xxUcn9tJtgFbQUEVcEbd0FYw==", - "dependencies": { - "function-bind": "^1.1.1", - "has": "^1.0.3", - "has-proto": "^1.0.1", - "has-symbols": "^1.0.3" + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -15363,6 +15385,19 @@ "node": ">=4" } }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/get-stdin": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-0.1.0.tgz", @@ -15630,42 +15665,13 @@ "node": ">=8.6.0" } }, - "node_modules/globule": { - "version": "1.3.4", - "resolved": "https://registry.npmjs.org/globule/-/globule-1.3.4.tgz", - "integrity": "sha512-OPTIfhMBh7JbBYDpa5b+Q5ptmMWKwcNcFSR/0c6t8V4f3ZAVBEsKNY37QdVqmLRYSMhOUGYrY0QhSoEpzGr/Eg==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "glob": "~7.1.1", - "lodash": "^4.17.21", - "minimatch": "~3.0.2" - }, - "engines": { - "node": ">= 0.10" - } - }, - "node_modules/globule/node_modules/minimatch": { - "version": "3.0.8", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.8.tgz", - "integrity": "sha512-6FsRAQsxQ61mw+qP1ZzbL9Bc78x2p5OqNgNpnoAFLTrX8n5Kxph0CsnhmKKNXTWjXqU5L0pGPR7hYk+XWZr60Q==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/gopd": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", - "integrity": "sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==", - "dependencies": { - "get-intrinsic": "^1.1.3" + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "license": "MIT", + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -15801,17 +15807,6 @@ "node": ">=6" } }, - "node_modules/hard-rejection": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/hard-rejection/-/hard-rejection-2.1.0.tgz", - "integrity": "sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=6" - } - }, "node_modules/harmony-reflect": { "version": "1.6.2", "resolved": "https://registry.npmjs.org/harmony-reflect/-/harmony-reflect-1.6.2.tgz", @@ -15846,11 +15841,12 @@ } }, "node_modules/has-property-descriptors": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.0.tgz", - "integrity": "sha512-62DVLZGoiEBDHQyqG4w9xCuZ7eJEwNmJRWw2VY84Oedb7WFcA27fiEVe8oUQx9hAUJ4ekurquucTGwsyO1XGdQ==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "license": "MIT", "dependencies": { - "get-intrinsic": "^1.1.1" + "es-define-property": "^1.0.0" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -15868,9 +15864,10 @@ } }, "node_modules/has-symbols": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", - "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -15879,11 +15876,12 @@ } }, "node_modules/has-tostringtag": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.0.tgz", - "integrity": "sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "license": "MIT", "dependencies": { - "has-symbols": "^1.0.2" + "has-symbols": "^1.0.3" }, "engines": { "node": ">= 0.4" @@ -15892,14 +15890,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/has-unicode": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/has-unicode/-/has-unicode-2.0.1.tgz", - "integrity": "sha512-8Rf9Y83NBReMnx0gFzA8JImQACstCYWUplepDa9xprwwtmgEZUF0h/i5xSA625zB/I37EtrswSST6OXxwaaIJQ==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/has-value": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/has-value/-/has-value-1.0.0.tgz", @@ -16000,6 +15990,18 @@ "node": ">=8" } }, + "node_modules/hasown": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.3.tgz", + "integrity": "sha512-ej4AhfhfL2Q2zpMmLo7U1Uv9+PyhIZpgQLGT1F9miIGmiCJIoCgSmczFdrc97mWT4kVY72KA+WnnhJ5pghSvSg==", + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/hast-to-hyperscript": { "version": "9.0.1", "resolved": "https://registry.npmjs.org/hast-to-hyperscript/-/hast-to-hyperscript-9.0.1.tgz", @@ -16428,17 +16430,6 @@ "node": ">=10.17.0" } }, - "node_modules/humanize-ms": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/humanize-ms/-/humanize-ms-1.2.1.tgz", - "integrity": "sha512-Fl70vYtsAFb/C06PTS9dZBo7ihau+Tu/DNCk/OyHhea07S+aeMWpFFkUaXRa8fI+ScZbEI8dfSxwY7gxZ9SAVQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "ms": "^2.0.0" - } - }, "node_modules/iconv-lite": { "version": "0.4.24", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", @@ -16595,14 +16586,6 @@ "node": ">=8" } }, - "node_modules/infer-owner": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/infer-owner/-/infer-owner-1.0.4.tgz", - "integrity": "sha512-IClj+Xz94+d7irH5qRyfJonOdfTzuDaifE6ZPWfx0N0+/ATZCbuTPq2prFl526urkQd90WyUKIh1DfBQ2hMz9A==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -16715,13 +16698,14 @@ } }, "node_modules/internal-slot": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.5.tgz", - "integrity": "sha512-Y+R5hJrzs52QCG2laLn4udYVnxsfny9CpOhNhUvk/SSSVyF6T27FzRbF0sroPidSu3X8oEAkOn2K804mjpt6UQ==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.1.0.tgz", + "integrity": "sha512-4gd7VpWNQNB4UKKCFFVcp1AVv+FMOgs9NKzjHKusc8jTMhd5eL1NqQqOpE0KzMds804/yHlglp3uxgluOqAPLw==", + "license": "MIT", "dependencies": { - "get-intrinsic": "^1.2.0", - "has": "^1.0.3", - "side-channel": "^1.0.4" + "es-errors": "^1.3.0", + "hasown": "^2.0.2", + "side-channel": "^1.1.0" }, "engines": { "node": ">= 0.4" @@ -16753,14 +16737,6 @@ "loose-envify": "^1.0.0" } }, - "node_modules/ip": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ip/-/ip-2.0.0.tgz", - "integrity": "sha512-WKa+XuLG1A1R0UWhl2+1XQSi+fZWMsYKffMZTTYsiZaUD8k2yDAj5atimTUD2TZkyCkNEeYE5NhFZmupOGtjYQ==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/ipaddr.js": { "version": "1.9.1", "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", @@ -17086,14 +17062,6 @@ "node": ">=0.10.0" } }, - "node_modules/is-lambda": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-lambda/-/is-lambda-1.0.1.tgz", - "integrity": "sha512-z7CMFGNrENq5iFB9Bqo64Xk6Y9sg+epq1myIcdHaGnbMTYOxvzsEtdYqQUylB7LxfkvgrrjP32T6Ywciio9UIQ==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/is-lower-case": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/is-lower-case/-/is-lower-case-2.0.2.tgz", @@ -17102,6 +17070,19 @@ "tslib": "^2.0.3" } }, + "node_modules/is-map": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-map/-/is-map-2.0.3.tgz", + "integrity": "sha512-1Qed0/Hr2m+YqxnM09CjA2d/i6YZNfF6R2oRAOj36eUdS6qIV/huPJNSEpKbupewFs+ZsJlxsjjPbc0/afW6Lw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-negative-zero": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.2.tgz", @@ -17162,17 +17143,6 @@ "node": ">=8" } }, - "node_modules/is-plain-obj": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz", - "integrity": "sha512-yvkRyxmFKEOQ4pNXCmJG5AEQNlXJS5LaONXo5/cLdTZdWvsZ1ioJEonLGAosKlMWE8lwUy/bJzMjcw8az73+Fg==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/is-plain-object": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", @@ -17240,6 +17210,19 @@ "node": ">=6" } }, + "node_modules/is-set": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-set/-/is-set-2.0.3.tgz", + "integrity": "sha512-iPAjerrse27/ygGLxw+EBR9agv9Y6uLeYVJMu+QNCoouJ1/1ri0mGrcWpfCqFZuzzx3WjtwxG098X+n4OuRkPg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-shared-array-buffer": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.2.tgz", @@ -17355,6 +17338,19 @@ "node": ">=0.10.0" } }, + "node_modules/is-weakmap": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.2.tgz", + "integrity": "sha512-K5pXYOm9wqY1RgjpL3YTkF39tni1XajUIkawTLUo9EZEVUFga5gSQJF8nNS7ZwJQ02y+1YCNYcMh+HIf1ZqE+w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-weakref": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", @@ -17366,6 +17362,23 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-weakset": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.4.tgz", + "integrity": "sha512-mfcwb6IzQyOKTs84CQMrOwW4gQcaTOAWJ0zzJCl2WSPDrWk/OzDaImWFH3djXhb24g4eudZfLRozAvPGw4d9hQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-windows": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz", @@ -19805,14 +19818,6 @@ "@sideway/pinpoint": "^2.0.0" } }, - "node_modules/js-base64": { - "version": "2.6.4", - "resolved": "https://registry.npmjs.org/js-base64/-/js-base64-2.6.4.tgz", - "integrity": "sha512-pZe//GGmwJndub7ZghVHz7vjb2LgC1m8B07Au3eYqeqv9emhESByMXxaEgkUkEqJe87oBbSniGYoQNIBklc7IQ==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -20323,6 +20328,7 @@ "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.5.0.tgz", "integrity": "sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==", "dev": true, + "license": "MIT", "bin": { "lz-string": "bin/bin.js" } @@ -20347,57 +20353,6 @@ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", "dev": true }, - "node_modules/make-fetch-happen": { - "version": "9.1.0", - "resolved": "https://registry.npmjs.org/make-fetch-happen/-/make-fetch-happen-9.1.0.tgz", - "integrity": "sha512-+zopwDy7DNknmwPQplem5lAZX/eCOzSvSNNcSKm5eVwTkOBzoktEfXsa9L23J/GIRhxRsaxzkPEhrJEpE2F4Gg==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "agentkeepalive": "^4.1.3", - "cacache": "^15.2.0", - "http-cache-semantics": "^4.1.0", - "http-proxy-agent": "^4.0.1", - "https-proxy-agent": "^5.0.0", - "is-lambda": "^1.0.1", - "lru-cache": "^6.0.0", - "minipass": "^3.1.3", - "minipass-collect": "^1.0.2", - "minipass-fetch": "^1.3.2", - "minipass-flush": "^1.0.5", - "minipass-pipeline": "^1.2.4", - "negotiator": "^0.6.2", - "promise-retry": "^2.0.1", - "socks-proxy-agent": "^6.0.0", - "ssri": "^8.0.0" - }, - "engines": { - "node": ">= 10" - } - }, - "node_modules/make-fetch-happen/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/make-fetch-happen/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/makeerror": { "version": "1.0.12", "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz", @@ -20434,20 +20389,6 @@ "node": ">=0.10.0" } }, - "node_modules/map-obj": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-4.3.0.tgz", - "integrity": "sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/map-visit": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/map-visit/-/map-visit-1.0.0.tgz", @@ -20471,6 +20412,15 @@ "node": ">= 12" } }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, "node_modules/md5-file": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/md5-file/-/md5-file-5.0.0.tgz", @@ -20549,48 +20499,6 @@ "timers-ext": "^0.1.7" } }, - "node_modules/meow": { - "version": "9.0.0", - "resolved": "https://registry.npmjs.org/meow/-/meow-9.0.0.tgz", - "integrity": "sha512-+obSblOQmRhcyBt62furQqRAQpNyWXo8BuQ5bN7dG8wmwQ+vwHKp/rCFD4CrTP8CsDQD1sjoZ94K417XEUk8IQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "@types/minimist": "^1.2.0", - "camelcase-keys": "^6.2.2", - "decamelize": "^1.2.0", - "decamelize-keys": "^1.1.0", - "hard-rejection": "^2.1.0", - "minimist-options": "4.1.0", - "normalize-package-data": "^3.0.0", - "read-pkg-up": "^7.0.1", - "redent": "^3.0.0", - "trim-newlines": "^3.0.0", - "type-fest": "^0.18.0", - "yargs-parser": "^20.2.3" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/meow/node_modules/type-fest": { - "version": "0.18.1", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.18.1.tgz", - "integrity": "sha512-OIAYXk8+ISY+qTOwkHtKqzAuxchoMiD9Udx+FSGQDuiRR+PJKJHc2NJAXlbhkGwTt/4/nKZxELY1w3ReWOL8mw==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/merge-descriptors": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz", @@ -20723,153 +20631,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/minimist-options": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/minimist-options/-/minimist-options-4.1.0.tgz", - "integrity": "sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "arrify": "^1.0.1", - "is-plain-obj": "^1.1.0", - "kind-of": "^6.0.3" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/minimist-options/node_modules/arrify": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/arrify/-/arrify-1.0.1.tgz", - "integrity": "sha512-3CYzex9M9FGQjCGMGyi6/31c8GJbgb0qGyrx5HWxPd0aCwh4cB2YjMb2Xf9UuoogrMrlO9cTqnB5rI5GHZTcUA==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minipass-collect": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/minipass-collect/-/minipass-collect-1.0.2.tgz", - "integrity": "sha512-6T6lH0H8OG9kITm/Jm6tdooIbogG9e0tLgpY6mphXSm/A9u8Nq1ryBG+Qspiub9LjWlBPsPS3tWQ/Botq4FdxA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "minipass": "^3.0.0" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/minipass-fetch": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/minipass-fetch/-/minipass-fetch-1.4.1.tgz", - "integrity": "sha512-CGH1eblLq26Y15+Azk7ey4xh0J/XfJfrCox5LDJiKqI2Q2iwOLOKrlmIaODiSQS8d18jalF6y2K2ePUm0CmShw==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "minipass": "^3.1.0", - "minipass-sized": "^1.0.3", - "minizlib": "^2.0.0" - }, - "engines": { - "node": ">=8" - }, - "optionalDependencies": { - "encoding": "^0.1.12" - } - }, - "node_modules/minipass-flush": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/minipass-flush/-/minipass-flush-1.0.5.tgz", - "integrity": "sha512-JmQSYYpPUqX5Jyn1mXaRwOda1uQ8HP5KAT/oDSLCzt1BYRhQU0/hDtsB1ufZfEEzMZ9aAVmsBw8+FWsIXlClWw==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "minipass": "^3.0.0" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/minipass-pipeline": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/minipass-pipeline/-/minipass-pipeline-1.2.4.tgz", - "integrity": "sha512-xuIq7cIOt09RPRJ19gdi4b+RiNvDFYe5JH+ggNvBqGqpQXcru3PcRmOZuHBKWK1Txf9+cQ+HMVN4d6z46LZP7A==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "minipass": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minipass-sized": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/minipass-sized/-/minipass-sized-1.0.3.tgz", - "integrity": "sha512-MbkQQ2CTiBMlA2Dm/5cY+9SWFEN8pzzOXi6rlM5Xxq0Yqbda5ZQy9sU75a673FE9ZK0Zsbr6Y5iP6u9nktfg2g==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "minipass": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minipass/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - }, - "node_modules/minizlib": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-2.1.2.tgz", - "integrity": "sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "minipass": "^3.0.0", - "yallist": "^4.0.0" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/minizlib/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/mitt": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/mitt/-/mitt-1.2.0.tgz", @@ -20989,14 +20750,6 @@ "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==" }, - "node_modules/nan": { - "version": "2.17.0", - "resolved": "https://registry.npmjs.org/nan/-/nan-2.17.0.tgz", - "integrity": "sha512-2ZTgtl0nJsO0KQCjEpxcIr5D+Yv90plTitZt9JBfQvVJDS5seMl3FOvsh3+9CoYWXf/1l5OaZzzF6nDm4cagaQ==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/nanoid": { "version": "3.3.6", "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.6.tgz", @@ -21188,32 +20941,6 @@ "webidl-conversions": "^3.0.0" } }, - "node_modules/node-gyp": { - "version": "8.4.1", - "resolved": "https://registry.npmjs.org/node-gyp/-/node-gyp-8.4.1.tgz", - "integrity": "sha512-olTJRgUtAb/hOXG0E93wZDs5YiJlgbXxTwQAFHyNlRsXQnYzUaF2aGgujZbw+hR8aF4ZG/rST57bWMWD16jr9w==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "env-paths": "^2.2.0", - "glob": "^7.1.4", - "graceful-fs": "^4.2.6", - "make-fetch-happen": "^9.1.0", - "nopt": "^5.0.0", - "npmlog": "^6.0.0", - "rimraf": "^3.0.2", - "semver": "^7.3.5", - "tar": "^6.1.2", - "which": "^2.0.2" - }, - "bin": { - "node-gyp": "bin/node-gyp.js" - }, - "engines": { - "node": ">= 10.12.0" - } - }, "node_modules/node-gyp-build-optional-packages": { "version": "5.0.3", "resolved": "https://registry.npmjs.org/node-gyp-build-optional-packages/-/node-gyp-build-optional-packages-5.0.3.tgz", @@ -21224,136 +20951,6 @@ "node-gyp-build-optional-packages-test": "build-test.js" } }, - "node_modules/node-gyp/node_modules/are-we-there-yet": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/are-we-there-yet/-/are-we-there-yet-3.0.1.tgz", - "integrity": "sha512-QZW4EDmGwlYur0Yyf/b2uGucHQMa8aFUP7eu9ddR73vvhFyt4V0Vl3QHPcTNJ8l6qYOBdxgXdnBXQrHilfRQBg==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "delegates": "^1.0.0", - "readable-stream": "^3.6.0" - }, - "engines": { - "node": "^12.13.0 || ^14.15.0 || >=16.0.0" - } - }, - "node_modules/node-gyp/node_modules/gauge": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/gauge/-/gauge-4.0.4.tgz", - "integrity": "sha512-f9m+BEN5jkg6a0fZjleidjN51VE1X+mPFQ2DJ0uv1V39oCLCbsGe6yjbBnp7eK7z/+GAon99a3nHuqbuuthyPg==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "aproba": "^1.0.3 || ^2.0.0", - "color-support": "^1.1.3", - "console-control-strings": "^1.1.0", - "has-unicode": "^2.0.1", - "signal-exit": "^3.0.7", - "string-width": "^4.2.3", - "strip-ansi": "^6.0.1", - "wide-align": "^1.1.5" - }, - "engines": { - "node": "^12.13.0 || ^14.15.0 || >=16.0.0" - } - }, - "node_modules/node-gyp/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/node-gyp/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/node-gyp/node_modules/npmlog": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/npmlog/-/npmlog-6.0.2.tgz", - "integrity": "sha512-/vBvz5Jfr9dT/aFWd0FIRf+T/Q2WBsLENygUaFUqstqsycmZAP/t5BvFJTK0viFmSUxiUKTUplWy5vt+rvKIxg==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "are-we-there-yet": "^3.0.0", - "console-control-strings": "^1.1.0", - "gauge": "^4.0.3", - "set-blocking": "^2.0.0" - }, - "engines": { - "node": "^12.13.0 || ^14.15.0 || >=16.0.0" - } - }, - "node_modules/node-gyp/node_modules/readable-stream": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", - "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "inherits": "^2.0.3", - "string_decoder": "^1.1.1", - "util-deprecate": "^1.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/node-gyp/node_modules/semver": { - "version": "7.5.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", - "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "lru-cache": "^6.0.0" - }, - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/node-gyp/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/node-html-parser": { "version": "5.4.2", "resolved": "https://registry.npmjs.org/node-html-parser/-/node-html-parser-5.4.2.tgz", @@ -21432,229 +21029,6 @@ "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.13.tgz", "integrity": "sha512-uYr7J37ae/ORWdZeQ1xxMJe3NtdmqMC/JZK+geofDrkLUApKRHPd18/TxtBOJ4A0/+uUIliorNrfYV6s1b02eQ==" }, - "node_modules/node-sass": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/node-sass/-/node-sass-7.0.3.tgz", - "integrity": "sha512-8MIlsY/4dXUkJDYht9pIWBhMil3uHmE8b/AdJPjmFn1nBx9X9BASzfzmsCy0uCCb8eqI3SYYzVPDswWqSx7gjw==", - "dev": true, - "hasInstallScript": true, - "optional": true, - "peer": true, - "dependencies": { - "async-foreach": "^0.1.3", - "chalk": "^4.1.2", - "cross-spawn": "^7.0.3", - "gaze": "^1.0.0", - "get-stdin": "^4.0.1", - "glob": "^7.0.3", - "lodash": "^4.17.15", - "meow": "^9.0.0", - "nan": "^2.13.2", - "node-gyp": "^8.4.1", - "npmlog": "^5.0.0", - "request": "^2.88.0", - "sass-graph": "^4.0.1", - "stdout-stream": "^1.4.0", - "true-case-path": "^1.0.2" - }, - "bin": { - "node-sass": "bin/node-sass" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/node-sass/node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "color-convert": "^2.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/node-sass/node_modules/chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/node-sass/node_modules/color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "color-name": "~1.1.4" - }, - "engines": { - "node": ">=7.0.0" - } - }, - "node_modules/node-sass/node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true, - "optional": true, - "peer": true - }, - "node_modules/node-sass/node_modules/get-stdin": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-4.0.1.tgz", - "integrity": "sha512-F5aQMywwJ2n85s4hJPTT9RPxGmubonuB10MNYo17/xph174n2MIR33HRguhzVag10O/npM7SPk73LMZNP+FaWw==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/node-sass/node_modules/has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/node-sass/node_modules/supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/node-sass/node_modules/true-case-path": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/true-case-path/-/true-case-path-1.0.3.tgz", - "integrity": "sha512-m6s2OdQe5wgpFMC+pAJ+q9djG82O2jcHPOI6RNg1yy9rCYR+WD6Nbpl32fDpfC56nirdRy+opFa/Vk7HYhqaew==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "glob": "^7.1.2" - } - }, - "node_modules/nopt": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/nopt/-/nopt-5.0.0.tgz", - "integrity": "sha512-Tbj67rffqceeLpcRXrT7vKAN8CwfPeIBgM7E6iBkmKLV7bEMwpGgYLGv0jACUsECaa/vuxP0IjEont6umdMgtQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "abbrev": "1" - }, - "bin": { - "nopt": "bin/nopt.js" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/normalize-package-data": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-3.0.3.tgz", - "integrity": "sha512-p2W1sgqij3zMMyRC067Dg16bfzVH+w7hyegmpIvZ4JNjqtGOVAIvLmjBx3yP7YTe9vKJgkoNOPjwQGogDoMXFA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "hosted-git-info": "^4.0.1", - "is-core-module": "^2.5.0", - "semver": "^7.3.4", - "validate-npm-package-license": "^3.0.1" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/normalize-package-data/node_modules/hosted-git-info": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-4.1.0.tgz", - "integrity": "sha512-kyCuEOWjJqZuDbRHzL8V93NzQhwIB71oFWSyzVo+KPZI+pnQPPxucdkrOZvkLRnrf5URsQM+IJ09Dw29cRALIA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "lru-cache": "^6.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/normalize-package-data/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/normalize-package-data/node_modules/semver": { - "version": "7.5.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", - "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "lru-cache": "^6.0.0" - }, - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/normalize-package-data/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/normalize-path": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", @@ -21693,20 +21067,6 @@ "node": ">=8" } }, - "node_modules/npmlog": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/npmlog/-/npmlog-5.0.1.tgz", - "integrity": "sha512-AqZtDUWOMKs1G/8lwylVjrdYgqA4d9nu8hc+0gzRxlDb1I10+FHBGMXs6aiQHFdCUUlqH99MUMuLfzWDNDtfxw==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "are-we-there-yet": "^2.0.0", - "console-control-strings": "^1.1.0", - "gauge": "^3.0.0", - "set-blocking": "^2.0.0" - } - }, "node_modules/nth-check": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", @@ -21849,9 +21209,30 @@ } }, "node_modules/object-inspect": { - "version": "1.12.3", - "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.3.tgz", - "integrity": "sha512-geUvdk7c+eizMNUDkRpW1wJwgfOiOeHbxBR/hLXK1aT6zmVSO0jsQcs7fj6MGw89jC/cjGfLcNOrtMYtGqm81g==", + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-is": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/object-is/-/object-is-1.1.6.tgz", + "integrity": "sha512-F8cZ+KfGlSGi09lJT7/Nd6KJZ9ygtvYC0/UYYLI9nmQKLMnydpB9yvbv9K1uSkEu7FU9vYPmVwLg328tX+ot3Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -22139,23 +21520,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/p-map": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", - "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "aggregate-error": "^3.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/p-try": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", @@ -22401,6 +21765,94 @@ "integrity": "sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==", "dev": true }, + "node_modules/parse5-htmlparser2-tree-adapter": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz", + "integrity": "sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g==", + "license": "MIT", + "dependencies": { + "domhandler": "^5.0.3", + "parse5": "^7.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parse5-htmlparser2-tree-adapter/node_modules/domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "license": "BSD-2-Clause", + "dependencies": { + "domelementtype": "^2.3.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/parse5-htmlparser2-tree-adapter/node_modules/entities": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", + "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/parse5-htmlparser2-tree-adapter/node_modules/parse5": { + "version": "7.3.0", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", + "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", + "license": "MIT", + "dependencies": { + "entities": "^6.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parse5-parser-stream": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/parse5-parser-stream/-/parse5-parser-stream-7.1.2.tgz", + "integrity": "sha512-JyeQc9iwFLn5TbvvqACIF/VXG6abODeB3Fwmv/TGdLk2LfbWkaySGY72at4+Ty7EkPZj854u4CrICqNk2qIbow==", + "license": "MIT", + "dependencies": { + "parse5": "^7.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parse5-parser-stream/node_modules/entities": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", + "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/parse5-parser-stream/node_modules/parse5": { + "version": "7.3.0", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", + "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", + "license": "MIT", + "dependencies": { + "entities": "^6.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, "node_modules/parseley": { "version": "0.7.0", "resolved": "https://registry.npmjs.org/parseley/-/parseley-0.7.0.tgz", @@ -22662,6 +22114,15 @@ "node": ">=0.10.0" } }, + "node_modules/possible-typed-array-names": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.1.0.tgz", + "integrity": "sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, "node_modules/postcss": { "version": "8.4.27", "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.27.tgz", @@ -23360,29 +22821,6 @@ "asap": "~2.0.3" } }, - "node_modules/promise-inflight": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/promise-inflight/-/promise-inflight-1.0.1.tgz", - "integrity": "sha512-6zWPyEOFaQBJYcGMHBKTKJ3u6TBsnMFOIZSa6ce1e/ZrrsOlnHRHbabMjLiBYKp+n44X9eUI6VUPaukCXHuG4g==", - "dev": true, - "optional": true, - "peer": true - }, - "node_modules/promise-retry": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/promise-retry/-/promise-retry-2.0.1.tgz", - "integrity": "sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "err-code": "^2.0.2", - "retry": "^0.12.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/prompts": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", @@ -24275,13 +23713,17 @@ "dev": true }, "node_modules/regexp.prototype.flags": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.0.tgz", - "integrity": "sha512-0SutC3pNudRKgquxGoRGIz946MZVHqbNfPjBdxeOhBrdgDKlRoXmYLQN9xRbrR09ZXWeGAdPuif7egofn6v5LA==", + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.4.tgz", + "integrity": "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==", + "license": "MIT", "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "functions-have-names": "^1.2.3" + "call-bind": "^1.0.8", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "set-function-name": "^2.0.2" }, "engines": { "node": ">= 0.4" @@ -25271,73 +24713,6 @@ "@parcel/watcher": "^2.4.1" } }, - "node_modules/sass-graph": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/sass-graph/-/sass-graph-4.0.1.tgz", - "integrity": "sha512-5YCfmGBmxoIRYHnKK2AKzrAkCoQ8ozO+iumT8K4tXJXRVCPf+7s1/9KxTSW3Rbvf+7Y7b4FR3mWyLnQr3PHocA==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "glob": "^7.0.0", - "lodash": "^4.17.11", - "scss-tokenizer": "^0.4.3", - "yargs": "^17.2.1" - }, - "bin": { - "sassgraph": "bin/sassgraph" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/sass-graph/node_modules/cliui": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", - "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "string-width": "^4.2.0", - "strip-ansi": "^6.0.1", - "wrap-ansi": "^7.0.0" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/sass-graph/node_modules/yargs": { - "version": "17.7.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", - "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "cliui": "^8.0.1", - "escalade": "^3.1.1", - "get-caller-file": "^2.0.5", - "require-directory": "^2.1.1", - "string-width": "^4.2.3", - "y18n": "^5.0.5", - "yargs-parser": "^21.1.1" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/sass-graph/node_modules/yargs-parser": { - "version": "21.1.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", - "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=12" - } - }, "node_modules/sass-loader": { "version": "10.4.1", "resolved": "https://registry.npmjs.org/sass-loader/-/sass-loader-10.4.1.tgz", @@ -25485,29 +24860,6 @@ "url": "https://opencollective.com/webpack" } }, - "node_modules/scss-tokenizer": { - "version": "0.4.3", - "resolved": "https://registry.npmjs.org/scss-tokenizer/-/scss-tokenizer-0.4.3.tgz", - "integrity": "sha512-raKLgf1LI5QMQnG+RxHz6oK0sL3x3I4FN2UDLqgLOGO8hodECNnNh5BXn7fAyBxrA8zVzdQizQ6XjNJQ+uBwMw==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "js-base64": "^2.4.9", - "source-map": "^0.7.3" - } - }, - "node_modules/scss-tokenizer/node_modules/source-map": { - "version": "0.7.4", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.4.tgz", - "integrity": "sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">= 8" - } - }, "node_modules/selderee": { "version": "0.6.0", "resolved": "https://registry.npmjs.org/selderee/-/selderee-0.6.0.tgz", @@ -25628,6 +24980,38 @@ "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", "integrity": "sha512-KiKBS8AnWGEyLzofFfmvKwpdPzqiy16LvQfK3yv/fVH7Bj13/wl3JSR1J+rfgRE9q7xUJK4qvgS8raSOeLUehw==" }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/set-value": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/set-value/-/set-value-2.0.1.tgz", @@ -25799,13 +25183,72 @@ } }, "node_modules/side-channel": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", - "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", + "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "license": "MIT", "dependencies": { - "call-bind": "^1.0.0", - "get-intrinsic": "^1.0.2", - "object-inspect": "^1.9.0" + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3", + "side-channel-list": "^1.0.0", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-list": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.1.tgz", + "integrity": "sha512-mjn/0bi/oUURjc5Xl7IaWi/OJJJumuoJFQJfDDyO46+hBWsfaVM65TBHq2eoZBhzl9EchxOijpkbRC8SVBQU0w==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -25977,18 +25420,6 @@ "node": ">=8.0.0" } }, - "node_modules/smart-buffer": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.2.0.tgz", - "integrity": "sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">= 6.0.0", - "npm": ">= 3.0.0" - } - }, "node_modules/snake-case": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", @@ -26235,38 +25666,6 @@ "node": ">=10.0.0" } }, - "node_modules/socks": { - "version": "2.7.1", - "resolved": "https://registry.npmjs.org/socks/-/socks-2.7.1.tgz", - "integrity": "sha512-7maUZy1N7uo6+WVEX6psASxtNlKaNVMlGQKkG/63nEDdLOWNbiUMoLK7X4uYoLhQstau72mLgfEWcXcwsaHbYQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "ip": "^2.0.0", - "smart-buffer": "^4.2.0" - }, - "engines": { - "node": ">= 10.13.0", - "npm": ">= 3.0.0" - } - }, - "node_modules/socks-proxy-agent": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-6.2.1.tgz", - "integrity": "sha512-a6KW9G+6B3nWZ1yB8G7pJwL3ggLy1uTzKAgCb7ttblwqdz9fMGJUuTy3uFzEP48FAs9FLILlmzDlE2JJhVQaXQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "agent-base": "^6.0.2", - "debug": "^4.3.3", - "socks": "^2.6.2" - }, - "engines": { - "node": ">= 10" - } - }, "node_modules/source-list-map": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/source-list-map/-/source-list-map-2.0.1.tgz", @@ -26415,20 +25814,6 @@ "node": ">=0.10.0" } }, - "node_modules/ssri": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/ssri/-/ssri-8.0.1.tgz", - "integrity": "sha512-97qShzy1AiyxvPNIkLWoGua7xoQzzPjQ0HAH4B0rWKo7SZ6USuPcrUiAFrws0UH8RrbWmgq3LMTObhPIHbbBeQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "minipass": "^3.1.1" - }, - "engines": { - "node": ">= 8" - } - }, "node_modules/st": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/st/-/st-2.0.0.tgz", @@ -26588,15 +25973,18 @@ "node": ">= 0.8" } }, - "node_modules/stdout-stream": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/stdout-stream/-/stdout-stream-1.4.1.tgz", - "integrity": "sha512-j4emi03KXqJWcIeF8eIXkjMFN1Cmb8gUlDYGeBALLPo5qdyTfA9bOtl8m33lRoC+vFMkP3gl0WsDr6+gzxbbTA==", + "node_modules/stop-iteration-iterator": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/stop-iteration-iterator/-/stop-iteration-iterator-1.1.0.tgz", + "integrity": "sha512-eLoXW/DHyl62zxY4SCaIgnRhuMr6ri4juEYARS8E6sCEqzKpOiE521Ucofdx+KnDZl5xmvGYaaKCk5FEOxJCoQ==", "dev": true, - "optional": true, - "peer": true, + "license": "MIT", "dependencies": { - "readable-stream": "^2.0.1" + "es-errors": "^1.3.0", + "internal-slot": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" } }, "node_modules/streamsearch": { @@ -27023,25 +26411,6 @@ "node": ">=6" } }, - "node_modules/tar": { - "version": "6.1.15", - "resolved": "https://registry.npmjs.org/tar/-/tar-6.1.15.tgz", - "integrity": "sha512-/zKt9UyngnxIT/EAGYuxaMYgOIJiP81ab9ZfkILq4oNLPFX50qyYmu7jRj9qeXoxmJHjGlbH0+cm2uy1WCs10A==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "chownr": "^2.0.0", - "fs-minipass": "^2.0.0", - "minipass": "^5.0.0", - "minizlib": "^2.1.1", - "mkdirp": "^1.0.3", - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/tar-fs": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-2.1.1.tgz", @@ -27086,39 +26455,6 @@ "node": ">= 6" } }, - "node_modules/tar/node_modules/minipass": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz", - "integrity": "sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/tar/node_modules/mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "dev": true, - "optional": true, - "peer": true, - "bin": { - "mkdirp": "bin/cmd.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/tar/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - }, "node_modules/term-size": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/term-size/-/term-size-2.2.1.tgz", @@ -27462,17 +26798,6 @@ "node": ">=8" } }, - "node_modules/trim-newlines": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/trim-newlines/-/trim-newlines-3.0.1.tgz", - "integrity": "sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw==", - "dev": true, - "optional": true, - "peer": true, - "engines": { - "node": ">=8" - } - }, "node_modules/trough": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/trough/-/trough-1.0.5.tgz", @@ -27706,6 +27031,25 @@ "node": "*" } }, + "node_modules/turndown": { + "version": "7.2.4", + "resolved": "https://registry.npmjs.org/turndown/-/turndown-7.2.4.tgz", + "integrity": "sha512-I8yFsfRzmzK0WV1pNNOA4A7y4RDfFxPRxb3t+e3ui14qSGOxGtiSP6GjeX+Y6CHb7HYaFj7ECUD7VE5kQMZWGQ==", + "license": "MIT", + "dependencies": { + "@mixmark-io/domino": "^2.2.0" + }, + "engines": { + "node": ">=18", + "npm": ">=9" + } + }, + "node_modules/turndown-plugin-gfm": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/turndown-plugin-gfm/-/turndown-plugin-gfm-1.0.2.tgz", + "integrity": "sha512-vwz9tfvF7XN/jE0dGoBei3FXWuvll78ohzCZQuOb+ZjWrs3a0XhQVomJEb2Qh4VHTPNRO4GPZh0V7VRbiWwkRg==", + "license": "MIT" + }, "node_modules/tweetnacl": { "version": "0.14.5", "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", @@ -27945,6 +27289,15 @@ "node": ">=0.10.0" } }, + "node_modules/undici": { + "version": "7.25.0", + "resolved": "https://registry.npmjs.org/undici/-/undici-7.25.0.tgz", + "integrity": "sha512-xXnp4kTyor2Zq+J1FfPI6Eq3ew5h6Vl0F/8d9XU5zZQf1tX9s2Su1/3PiMmUANFULpmksxkClamIZcaUqryHsQ==", + "license": "MIT", + "engines": { + "node": ">=20.18.1" + } + }, "node_modules/unicode-canonical-property-names-ecmascript": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.0.tgz", @@ -28030,28 +27383,6 @@ "node": ">=0.10.0" } }, - "node_modules/unique-filename": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/unique-filename/-/unique-filename-1.1.1.tgz", - "integrity": "sha512-Vmp0jIp2ln35UTXuryvjzkjGdRyf9b2lTXuSYUiPmzRcl3FDtYqAwOnTJkAngD9SWhnoJzDbTKwaOrZ+STtxNQ==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "unique-slug": "^2.0.0" - } - }, - "node_modules/unique-slug": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/unique-slug/-/unique-slug-2.0.2.tgz", - "integrity": "sha512-zoWr9ObaxALD3DOPfjPSqxt4fnZiWblxHIgeWqW8x7UqDzEtHEQLzji2cuJYQFCU6KmoJikOYAZlrTHHebjx2w==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "imurmurhash": "^0.1.4" - } - }, "node_modules/unique-string": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-2.0.0.tgz", @@ -28956,21 +28287,43 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/which-collection": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-collection/-/which-collection-1.0.2.tgz", + "integrity": "sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-map": "^2.0.3", + "is-set": "^2.0.3", + "is-weakmap": "^2.0.2", + "is-weakset": "^2.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/which-module": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.1.tgz", "integrity": "sha512-iBdZ57RDvnOR9AGBhML2vFZf7h8vmBjhoaZqODJBFWHVtKkDmKuHai3cx5PgVMrX5YDNp27AofYbAwctSS+vhQ==" }, "node_modules/which-typed-array": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.11.tgz", - "integrity": "sha512-qe9UWWpkeG5yzZ0tNYxDmd7vo58HDBc39mZ0xWWpolAGADdFOzkfamWLDxkOWcvHQKVmdTyQdLD4NOfjLWTKew==", + "version": "1.1.20", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.20.tgz", + "integrity": "sha512-LYfpUkmqwl0h9A2HL09Mms427Q1RZWuOHsukfVcKRq9q95iQxdw0ix1JQrqbcDR9PH1QDwf5Qo8OZb5lksZ8Xg==", + "license": "MIT", "dependencies": { - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.2", - "for-each": "^0.3.3", - "gopd": "^1.0.1", - "has-tostringtag": "^1.0.0" + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", + "for-each": "^0.3.5", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-tostringtag": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -28979,17 +28332,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/wide-align": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.5.tgz", - "integrity": "sha512-eDMORYaPNZ4sQIuuYPDHdQvf4gyCF9rEEV/yPxGfwPkRodwEgiMUUXTx/dex+Me0wxx53S+NgUHaP7y3MGlDmg==", - "dev": true, - "optional": true, - "peer": true, - "dependencies": { - "string-width": "^1.0.2 || 2 || 3 || 4" - } - }, "node_modules/widest-line": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz", @@ -30758,16 +30100,6 @@ "regenerator-runtime": "^0.13.11" } }, - "@babel/runtime-corejs3": { - "version": "7.22.6", - "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.22.6.tgz", - "integrity": "sha512-M+37LLIRBTEVjktoJjbw4KVhupF0U/3PYUCbBwgAd9k17hoKhRu1n935QiG7Tuxv0LJOMrb2vuKEeYUlv0iyiw==", - "dev": true, - "requires": { - "core-js-pure": "^3.30.2", - "regenerator-runtime": "^0.13.11" - } - }, "@babel/template": { "version": "7.22.5", "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.22.5.tgz", @@ -31132,14 +30464,6 @@ "tslib": "^2.4.0" } }, - "@gar/promisify": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@gar/promisify/-/promisify-1.1.3.tgz", - "integrity": "sha512-k2Ty1JcVojjJFwrg/ThKi2ujJ7XNLYaFGNB/bWT9wGR+oSMJHMa5w+CUq6p/pVrKeNNgA7pCqEcjSnHVoqJQFw==", - "dev": true, - "optional": true, - "peer": true - }, "@gatsbyjs/parcel-namer-relative-to-cwd": { "version": "1.10.0", "resolved": "https://registry.npmjs.org/@gatsbyjs/parcel-namer-relative-to-cwd/-/parcel-namer-relative-to-cwd-1.10.0.tgz", @@ -32399,6 +31723,11 @@ "json5": "^2.2.1" } }, + "@mixmark-io/domino": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/@mixmark-io/domino/-/domino-2.2.0.tgz", + "integrity": "sha512-Y28PR25bHXUg88kCV7nivXrP2Nj2RueZ3/l/jdx6J9f8J4nsEGcgX0Qe6lt7Pa+J79+kPiJU3LguR6O/6zrLOw==" + }, "@mrmlnc/readdir-enhanced": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/@mrmlnc/readdir-enhanced/-/readdir-enhanced-2.2.1.tgz", @@ -32475,72 +31804,6 @@ "fastq": "^1.6.0" } }, - "@npmcli/fs": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/@npmcli/fs/-/fs-1.1.1.tgz", - "integrity": "sha512-8KG5RD0GVP4ydEzRn/I4BNDuxDtqVbOdm8675T49OIG/NGhaK0pjPX7ZcDlvKYbA+ulvVK3ztfcF4uBdOxuJbQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "@gar/promisify": "^1.0.1", - "semver": "^7.3.5" - }, - "dependencies": { - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "yallist": "^4.0.0" - } - }, - "semver": { - "version": "7.5.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", - "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "lru-cache": "^6.0.0" - } - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - } - } - }, - "@npmcli/move-file": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@npmcli/move-file/-/move-file-1.1.2.tgz", - "integrity": "sha512-1SUf/Cg2GzGDyaf15aR9St9TWlb+XvbZXWpDx8YKs7MLzMH/BCeopv+y9vzrzgkfykCGuWOlSu3mZhj2+FQcrg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "mkdirp": "^1.0.4", - "rimraf": "^3.0.2" - }, - "dependencies": { - "mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "@parcel/bundler-default": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/@parcel/bundler-default/-/bundler-default-2.6.2.tgz", @@ -33369,19 +32632,19 @@ } }, "@testing-library/dom": { - "version": "7.31.2", - "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-7.31.2.tgz", - "integrity": "sha512-3UqjCpey6HiTZT92vODYLPxTBWlM8ZOOjr3LX5F37/VRipW2M1kX6I/Cm4VXzteZqfGfagg8yXywpcOgQBlNsQ==", + "version": "8.20.1", + "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-8.20.1.tgz", + "integrity": "sha512-/DiOQ5xBxgdYRC8LNk7U+RWat0S3qRLeIw3ZIkMQ9kkVlRmwD/Eg8k8CqIpD6GW7u20JIUOfMKbxtiLutpjQ4g==", "dev": true, "requires": { "@babel/code-frame": "^7.10.4", "@babel/runtime": "^7.12.5", - "@types/aria-query": "^4.2.0", - "aria-query": "^4.2.2", + "@types/aria-query": "^5.0.1", + "aria-query": "5.1.3", "chalk": "^4.1.0", - "dom-accessibility-api": "^0.5.6", - "lz-string": "^1.4.4", - "pretty-format": "^26.6.2" + "dom-accessibility-api": "^0.5.9", + "lz-string": "^1.5.0", + "pretty-format": "^27.0.2" }, "dependencies": { "ansi-styles": { @@ -33394,13 +32657,12 @@ } }, "aria-query": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-4.2.2.tgz", - "integrity": "sha512-o/HelwhuKpTj/frsOsbNLNgnNGVIFsVP/SW2BSF14gVl7kAfMOJ6/8wUAUvG1R1NHKrfG+2sHZTu0yauT1qBrA==", + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.1.3.tgz", + "integrity": "sha512-R5iJ5lkuHybztUfuOAznmboyjWq8O6sqNqtK7CLOqdydi54VNbORp49mb14KbWgG1QD3JFO9hJdZ+y4KutfdOQ==", "dev": true, "requires": { - "@babel/runtime": "^7.10.2", - "@babel/runtime-corejs3": "^7.10.2" + "deep-equal": "^2.0.5" } }, "chalk": { @@ -33434,6 +32696,25 @@ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true }, + "pretty-format": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", + "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", + "dev": true, + "requires": { + "ansi-regex": "^5.0.1", + "ansi-styles": "^5.0.0", + "react-is": "^17.0.1" + }, + "dependencies": { + "ansi-styles": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", + "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", + "dev": true + } + } + }, "supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", @@ -33514,13 +32795,14 @@ } }, "@testing-library/react": { - "version": "11.2.7", - "resolved": "https://registry.npmjs.org/@testing-library/react/-/react-11.2.7.tgz", - "integrity": "sha512-tzRNp7pzd5QmbtXNG/mhdcl7Awfu/Iz1RaVHY75zTdOkmHCuzMhRL83gWHSgOAcjS3CCbyfwUHMZgRJb4kAfpA==", + "version": "13.4.0", + "resolved": "https://registry.npmjs.org/@testing-library/react/-/react-13.4.0.tgz", + "integrity": "sha512-sXOGON+WNTh3MLE9rve97ftaZukN3oNf2KjDy7YTx6hcTO2uuLHuCGynMDhFwGw/jYf4OJ2Qk0i4i79qMNNkyw==", "dev": true, "requires": { "@babel/runtime": "^7.12.5", - "@testing-library/dom": "^7.28.1" + "@testing-library/dom": "^8.5.0", + "@types/react-dom": "^18.0.0" } }, "@tokenizer/token": { @@ -33577,9 +32859,9 @@ "integrity": "sha512-qLOvfmlG2vCVw5fo/oz8WAZYlpe5a5OurgTj3diIxJCdjRHpapC+vQCz3er9LV79Vcat+DifBjeAhOAdmndtDQ==" }, "@types/aria-query": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-4.2.2.tgz", - "integrity": "sha512-HnYpAE1Y6kRyKM/XkEuiRQhTHvkzMBurTHnpFLYLBGPIylZNPs9jJcuOOYWxPLJCSEtmZT0Y8rHDokKN7rRTig==", + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-5.0.4.tgz", + "integrity": "sha512-rfT93uj5s0PRL7EzccGMs3brplhcrghnDoV26NqKhCAS1hVo+WdNsPvE/yb6ilfr5hi2MEk6d5EWJTKdxg8jVw==", "dev": true }, "@types/babel__core": { @@ -33833,14 +33115,6 @@ "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-5.1.2.tgz", "integrity": "sha512-K0VQKziLUWkVKiRVrx4a40iPaxTUefQmjtkQofBkYRcoaaL/8rhwDWww9qWbrgicNOgnpIsMxyNIUM4+n6dUIA==" }, - "@types/minimist": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/@types/minimist/-/minimist-1.2.2.tgz", - "integrity": "sha512-jhuKLIRrhvCPLqwPcx6INqmKeiA5EWrsCOPhrlFSrbrmU4ZMPjj5Ul/oLCMDO98XRUIwVm78xICz4EPCektzeQ==", - "dev": true, - "optional": true, - "peer": true - }, "@types/mixpanel-browser": { "version": "2.47.1", "resolved": "https://registry.npmjs.org/@types/mixpanel-browser/-/mixpanel-browser-2.47.1.tgz", @@ -33913,6 +33187,13 @@ "csstype": "^3.0.2" } }, + "@types/react-dom": { + "version": "18.3.7", + "resolved": "https://registry.npmjs.org/@types/react-dom/-/react-dom-18.3.7.tgz", + "integrity": "sha512-MEe3UeoENYVFXzoXEWsvcpg6ZvlrFNlOQ7EOsvhI3CfAXwzPfO8Qwuxd40nepsYKqyyVQnTdEfv68q91yLcKrQ==", + "dev": true, + "requires": {} + }, "@types/react-helmet": { "version": "6.1.6", "resolved": "https://registry.npmjs.org/@types/react-helmet/-/react-helmet-6.1.6.tgz", @@ -33932,25 +33213,12 @@ } }, "@types/react-test-renderer": { - "version": "17.0.2", - "resolved": "https://registry.npmjs.org/@types/react-test-renderer/-/react-test-renderer-17.0.2.tgz", - "integrity": "sha512-+F1KONQTBHDBBhbHuT2GNydeMpPuviduXIVJRB7Y4nma4NR5DrTJfMMZ+jbhEHbpwL+Uqhs1WXh4KHiyrtYTPg==", + "version": "18.3.1", + "resolved": "https://registry.npmjs.org/@types/react-test-renderer/-/react-test-renderer-18.3.1.tgz", + "integrity": "sha512-vAhnk0tG2eGa37lkU9+s5SoroCsRI08xnsWFiAXOuPH2jqzMbcXvKExXViPi1P5fIklDeCvXqyrdmipFaSkZrA==", "dev": true, "requires": { - "@types/react": "^17" - }, - "dependencies": { - "@types/react": { - "version": "17.0.62", - "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.62.tgz", - "integrity": "sha512-eANCyz9DG8p/Vdhr0ZKST8JV12PhH2ACCDYlFw6DIO+D+ca+uP4jtEDEpVqXZrh/uZdXQGwk7whJa3ah5DtyLw==", - "dev": true, - "requires": { - "@types/prop-types": "*", - "@types/scheduler": "*", - "csstype": "^3.0.2" - } - } + "@types/react": "^18" } }, "@types/responselike": { @@ -34320,14 +33588,6 @@ "integrity": "sha512-j2afSsaIENvHZN2B8GOpF566vZ5WVk5opAiMTvWgaQT8DkbOqsTfvNAvHoRGU2zzP8cPoqys+xHTRDWW8L+/BA==", "dev": true }, - "abbrev": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", - "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==", - "dev": true, - "optional": true, - "peer": true - }, "abortcontroller-polyfill": { "version": "1.7.5", "resolved": "https://registry.npmjs.org/abortcontroller-polyfill/-/abortcontroller-polyfill-1.7.5.tgz", @@ -34415,29 +33675,6 @@ "debug": "4" } }, - "agentkeepalive": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/agentkeepalive/-/agentkeepalive-4.5.0.tgz", - "integrity": "sha512-5GG/5IbQQpC9FpkRGsSvZI5QYeSCzlJHdpBQntCsuTOxhKD8lqKhrleg2Yi7yvMIf82Ycmmqln9U8V9qwEiJew==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "humanize-ms": "^1.2.1" - } - }, - "aggregate-error": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", - "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "clean-stack": "^2.0.0", - "indent-string": "^4.0.0" - } - }, "ajv": { "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", @@ -34552,46 +33789,11 @@ "resolved": "https://registry.npmjs.org/application-config-path/-/application-config-path-0.1.1.tgz", "integrity": "sha512-zy9cHePtMP0YhwG+CfHm0bgwdnga2X3gZexpdCwEj//dpb+TKajtiC8REEUJUSq6Ab4f9cgNy2l8ObXzCXFkEw==" }, - "aproba": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/aproba/-/aproba-2.0.0.tgz", - "integrity": "sha512-lYe4Gx7QT+MKGbDsA+Z+he/Wtef0BiwDOlK/XkBrdfsh9J/jPPXbX0tE9x9cl27Tmu5gg3QUbUrQYa/y+KOHPQ==", - "dev": true, - "optional": true, - "peer": true - }, "arch": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/arch/-/arch-2.2.0.tgz", "integrity": "sha512-Of/R0wqp83cgHozfIYLbBMnej79U/SVGOOyuB3VVFv1NRM/PSFMK12x9KVtiYzJqmnU5WR2qp0Z5rHb7sWGnFQ==" }, - "are-we-there-yet": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/are-we-there-yet/-/are-we-there-yet-2.0.0.tgz", - "integrity": "sha512-Ci/qENmwHnsYo9xKIcUJN5LeDKdJ6R1Z1j9V/J5wyq8nh/mYPEpIKJbBZXtZjG04HiK7zV/p6Vs9952MrMeUIw==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "delegates": "^1.0.0", - "readable-stream": "^3.6.0" - }, - "dependencies": { - "readable-stream": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", - "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "inherits": "^2.0.3", - "string_decoder": "^1.1.1", - "util-deprecate": "^1.0.1" - } - } - } - }, "arg": { "version": "5.0.2", "resolved": "https://registry.npmjs.org/arg/-/arg-5.0.2.tgz", @@ -34825,14 +34027,6 @@ } } }, - "async-foreach": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/async-foreach/-/async-foreach-0.1.3.tgz", - "integrity": "sha512-VUeSMD8nEGBWaZK4lizI1sf3yEC7pnAQ/mrI7pC2fBz2s/tq5jWWEngTwaf0Gruu/OoXRGLGg1XFqpYBiGTYJA==", - "dev": true, - "optional": true, - "peer": true - }, "asynckit": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", @@ -34867,9 +34061,12 @@ } }, "available-typed-arrays": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.5.tgz", - "integrity": "sha512-DMD0KiN46eipeziST1LPP/STfDU0sufISXmjSgvVsoU2tqxctQeASejWcfNtxYKqETM1UxQ8sp2OrSBWpHY6sw==" + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "requires": { + "possible-typed-array-names": "^1.0.0" + } }, "aws-sign2": { "version": "0.7.0", @@ -35531,79 +34728,6 @@ "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz", "integrity": "sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw==" }, - "cacache": { - "version": "15.3.0", - "resolved": "https://registry.npmjs.org/cacache/-/cacache-15.3.0.tgz", - "integrity": "sha512-VVdYzXEn+cnbXpFgWs5hTT7OScegHVmLhJIR8Ufqk3iFD6A6j5iSX1KuBTfNEv4tdJWE2PzA6IVFtcLC7fN9wQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "@npmcli/fs": "^1.0.0", - "@npmcli/move-file": "^1.0.1", - "chownr": "^2.0.0", - "fs-minipass": "^2.0.0", - "glob": "^7.1.4", - "infer-owner": "^1.0.4", - "lru-cache": "^6.0.0", - "minipass": "^3.1.1", - "minipass-collect": "^1.0.2", - "minipass-flush": "^1.0.5", - "minipass-pipeline": "^1.2.2", - "mkdirp": "^1.0.3", - "p-map": "^4.0.0", - "promise-inflight": "^1.0.1", - "rimraf": "^3.0.2", - "ssri": "^8.0.1", - "tar": "^6.0.2", - "unique-filename": "^1.1.1" - }, - "dependencies": { - "glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - } - }, - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "yallist": "^4.0.0" - } - }, - "mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "dev": true, - "optional": true, - "peer": true - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "cache-base": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/cache-base/-/cache-base-1.0.1.tgz", @@ -35676,12 +34800,32 @@ } }, "call-bind": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.9.tgz", + "integrity": "sha512-a/hy+pNsFUTR+Iz8TCJvXudKVLAnz/DyeSUo10I5yvFDQJBFU2s9uqQpoSrJlroHUKoKqzg+epxyP9lqFdzfBQ==", + "requires": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "get-intrinsic": "^1.3.0", + "set-function-length": "^1.2.2" + } + }, + "call-bind-apply-helpers": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz", - "integrity": "sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "requires": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + } + }, + "call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", "requires": { - "function-bind": "^1.1.1", - "get-intrinsic": "^1.0.2" + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" } }, "call-me-maybe": { @@ -35708,29 +34852,6 @@ "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==" }, - "camelcase-keys": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/camelcase-keys/-/camelcase-keys-6.2.2.tgz", - "integrity": "sha512-YrwaA0vEKazPBkn0ipTiMpSajYDSe+KjQfrjhcBMxJt/znbvlHd8Pw/Vamaz5EB4Wfhs3SUR3Z9mwRu/P3s3Yg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "camelcase": "^5.3.1", - "map-obj": "^4.0.0", - "quick-lru": "^4.0.1" - }, - "dependencies": { - "quick-lru": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-4.0.1.tgz", - "integrity": "sha512-ARhCpm70fzdcvNQfPoy49IaanKkTlRWF2JMzqhcJbhSFRZv7nPTvZJdcY7301IPmvW+/p0RgIWnQDLJxifsQ7g==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "caniuse-api": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/caniuse-api/-/caniuse-api-3.0.0.tgz", @@ -35743,9 +34864,9 @@ } }, "caniuse-lite": { - "version": "1.0.30001519", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001519.tgz", - "integrity": "sha512-0QHgqR+Jv4bxHMp8kZ1Kn8CH55OikjKJ6JmKkZYP1F3D7w+lnFXF70nG5eNfsZS89jadi5Ywy5UCSKLAglIRkg==" + "version": "1.0.30001792", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001792.tgz", + "integrity": "sha512-hVLMUZFgR4JJ6ACt1uEESvQN1/dBVqPAKY0hgrV70eN3391K6juAfTjKZLKvOMsx8PxA7gsY1/tLMMTcfFLLpw==" }, "capital-case": { "version": "1.0.4", @@ -35847,6 +34968,157 @@ "resolved": "https://registry.npmjs.org/chardet/-/chardet-0.7.0.tgz", "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==" }, + "cheerio": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.2.0.tgz", + "integrity": "sha512-WDrybc/gKFpTYQutKIK6UvfcuxijIZfMfXaYm8NMsPQxSYvf+13fXUJ4rztGGbJcBQ/GF55gvrZ0Bc0bj/mqvg==", + "requires": { + "cheerio-select": "^2.1.0", + "dom-serializer": "^2.0.0", + "domhandler": "^5.0.3", + "domutils": "^3.2.2", + "encoding-sniffer": "^0.2.1", + "htmlparser2": "^10.1.0", + "parse5": "^7.3.0", + "parse5-htmlparser2-tree-adapter": "^7.1.0", + "parse5-parser-stream": "^7.1.2", + "undici": "^7.19.0", + "whatwg-mimetype": "^4.0.0" + }, + "dependencies": { + "dom-serializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", + "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==", + "requires": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.2", + "entities": "^4.2.0" + } + }, + "domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "requires": { + "domelementtype": "^2.3.0" + } + }, + "domutils": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.2.2.tgz", + "integrity": "sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==", + "requires": { + "dom-serializer": "^2.0.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3" + } + }, + "entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==" + }, + "htmlparser2": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-10.1.0.tgz", + "integrity": "sha512-VTZkM9GWRAtEpveh7MSF6SjjrpNVNNVJfFup7xTY3UpFtm67foy9HDVXneLtFVt4pMz5kZtgNcvCniNFb1hlEQ==", + "requires": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.2.2", + "entities": "^7.0.1" + }, + "dependencies": { + "entities": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-7.0.1.tgz", + "integrity": "sha512-TWrgLOFUQTH994YUyl1yT4uyavY5nNB5muff+RtWaqNVCAK408b5ZnnbNAUEWLTCpum9w6arT70i1XdQ4UeOPA==" + } + } + }, + "parse5": { + "version": "7.3.0", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", + "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", + "requires": { + "entities": "^6.0.0" + }, + "dependencies": { + "entities": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", + "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==" + } + } + }, + "whatwg-mimetype": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz", + "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==" + } + } + }, + "cheerio-select": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-2.1.0.tgz", + "integrity": "sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==", + "requires": { + "boolbase": "^1.0.0", + "css-select": "^5.1.0", + "css-what": "^6.1.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1" + }, + "dependencies": { + "css-select": { + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.2.2.tgz", + "integrity": "sha512-TizTzUddG/xYLA3NXodFM0fSbNizXjOKhqiQQwvhlspadZokn1KDy0NZFS0wuEubIYAV5/c1/lAr0TaaFXEXzw==", + "requires": { + "boolbase": "^1.0.0", + "css-what": "^6.1.0", + "domhandler": "^5.0.2", + "domutils": "^3.0.1", + "nth-check": "^2.0.1" + } + }, + "dom-serializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", + "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==", + "requires": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.2", + "entities": "^4.2.0" + } + }, + "domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "requires": { + "domelementtype": "^2.3.0" + } + }, + "domutils": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.2.2.tgz", + "integrity": "sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==", + "requires": { + "dom-serializer": "^2.0.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3" + } + }, + "entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==" + } + } + }, "chokidar": { "version": "3.5.3", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.5.3.tgz", @@ -35862,14 +35134,6 @@ "readdirp": "~3.6.0" } }, - "chownr": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/chownr/-/chownr-2.0.0.tgz", - "integrity": "sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ==", - "dev": true, - "optional": true, - "peer": true - }, "chrome-trace-event": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.3.tgz", @@ -35968,14 +35232,6 @@ "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.3.2.tgz", "integrity": "sha512-CSbhY4cFEJRe6/GQzIk5qXZ4Jeg5pcsP7b5peFSDpffpe1cqjASH/n9UTjBwOp6XpMSTwQ8Za2K5V02ueA7Tmw==" }, - "clean-stack": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", - "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", - "dev": true, - "optional": true, - "peer": true - }, "cli-boxes": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-2.2.1.tgz", @@ -36191,14 +35447,6 @@ "simple-swizzle": "^0.2.2" } }, - "color-support": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/color-support/-/color-support-1.1.3.tgz", - "integrity": "sha512-qiBjkpbMLO/HL68y+lh4q0/O1MZFj2RX6X/KmMa3+gJD3z+WwI1ZzDHysvqHGS3mP6mznPckpXmw1nI9cJjyRg==", - "dev": true, - "optional": true, - "peer": true - }, "colord": { "version": "2.9.3", "resolved": "https://registry.npmjs.org/colord/-/colord-2.9.3.tgz", @@ -36350,14 +35598,6 @@ "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.11.tgz", "integrity": "sha512-JsPKdmh8ZkmnHxDk55FZ1TqVLvEQTvoByJZRN9jzI0UjxK/QgAmsphz7PGtqgPieQZ/CQcHWXCR7ATDNhGe+YA==" }, - "console-control-strings": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz", - "integrity": "sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ==", - "dev": true, - "optional": true, - "peer": true - }, "constant-case": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/constant-case/-/constant-case-3.0.4.tgz", @@ -36789,28 +36029,6 @@ "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", "integrity": "sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA==" }, - "decamelize-keys": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/decamelize-keys/-/decamelize-keys-1.1.1.tgz", - "integrity": "sha512-WiPxgEirIV0/eIOMcnFBA3/IJZAZqKnwAwWyvvdi4lsr1WCN22nhdf/3db3DoZcUjTV2SqfzIwNyp6y2xs3nmg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "decamelize": "^1.1.0", - "map-obj": "^1.0.0" - }, - "dependencies": { - "map-obj": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-1.0.1.tgz", - "integrity": "sha512-7N/q3lyZ+LVCp7PzuxrJr4KMbBE2hW7BT7YNia330OFxIf4d3r5zVpicP2650l7CPN6RM9zOJRl3NGpqSiw3Eg==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "decimal.js": { "version": "10.4.3", "resolved": "https://registry.npmjs.org/decimal.js/-/decimal.js-10.4.3.tgz", @@ -36837,6 +36055,40 @@ } } }, + "deep-equal": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/deep-equal/-/deep-equal-2.2.3.tgz", + "integrity": "sha512-ZIwpnevOurS8bpT4192sqAowWM76JDKSHYzMLty3BZGSswgq6pBaH3DhCSW5xVAZICZyKdOBPjwww5wfgT/6PA==", + "dev": true, + "requires": { + "array-buffer-byte-length": "^1.0.0", + "call-bind": "^1.0.5", + "es-get-iterator": "^1.1.3", + "get-intrinsic": "^1.2.2", + "is-arguments": "^1.1.1", + "is-array-buffer": "^3.0.2", + "is-date-object": "^1.0.5", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.2", + "isarray": "^2.0.5", + "object-is": "^1.1.5", + "object-keys": "^1.1.1", + "object.assign": "^4.1.4", + "regexp.prototype.flags": "^1.5.1", + "side-channel": "^1.0.4", + "which-boxed-primitive": "^1.0.2", + "which-collection": "^1.0.1", + "which-typed-array": "^1.1.13" + }, + "dependencies": { + "isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true + } + } + }, "deep-extend": { "version": "0.6.0", "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", @@ -36857,16 +36109,27 @@ "resolved": "https://registry.npmjs.org/defer-to-connect/-/defer-to-connect-2.0.1.tgz", "integrity": "sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg==" }, + "define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "requires": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + } + }, "define-lazy-prop": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz", "integrity": "sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==" }, "define-properties": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.0.tgz", - "integrity": "sha512-xvqAVKGfT1+UAvPwKTVw/njhdQ8ZhXK4lI0bCIuCMrp2up9nPnaDftrLtmpTazqd1o+UY4zgzU+avtMbDP+ldA==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", "requires": { + "define-data-property": "^1.0.1", "has-property-descriptors": "^1.0.0", "object-keys": "^1.1.1" } @@ -36885,14 +36148,6 @@ "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==" }, - "delegates": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/delegates/-/delegates-1.0.0.tgz", - "integrity": "sha512-bd2L678uiWATM6m5Z1VzNCErI3jiGzt6HGY8OVICs40JQq/HALfbyNJmp0UDakEY4pMMaN0Ly5om/B1VI/+xfQ==", - "dev": true, - "optional": true, - "peer": true - }, "depd": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", @@ -37227,6 +36482,16 @@ } } }, + "dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "requires": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + } + }, "duplexer": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", @@ -37278,25 +36543,30 @@ "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", "integrity": "sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w==" }, - "encoding": { - "version": "0.1.13", - "resolved": "https://registry.npmjs.org/encoding/-/encoding-0.1.13.tgz", - "integrity": "sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A==", - "optional": true, - "peer": true, + "encoding-sniffer": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/encoding-sniffer/-/encoding-sniffer-0.2.1.tgz", + "integrity": "sha512-5gvq20T6vfpekVtqrYQsSCFZ1wEg5+wW0/QaZMWkFr6BqD3NfKs0rLCx4rrVlSWJeZb5NBJgVLswK/w2MWU+Gw==", "requires": { - "iconv-lite": "^0.6.2" + "iconv-lite": "^0.6.3", + "whatwg-encoding": "^3.1.1" }, "dependencies": { "iconv-lite": { "version": "0.6.3", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", - "optional": true, - "peer": true, "requires": { "safer-buffer": ">= 2.1.2 < 3.0.0" } + }, + "whatwg-encoding": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz", + "integrity": "sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ==", + "requires": { + "iconv-lite": "0.6.3" + } } } }, @@ -37381,14 +36651,6 @@ "resolved": "https://registry.npmjs.org/entities/-/entities-3.0.1.tgz", "integrity": "sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q==" }, - "env-paths": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/env-paths/-/env-paths-2.2.1.tgz", - "integrity": "sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A==", - "dev": true, - "optional": true, - "peer": true - }, "envinfo": { "version": "7.10.0", "resolved": "https://registry.npmjs.org/envinfo/-/envinfo-7.10.0.tgz", @@ -37399,14 +36661,6 @@ "resolved": "https://registry.npmjs.org/eol/-/eol-0.9.1.tgz", "integrity": "sha512-Ds/TEoZjwggRoz/Q2O7SE3i4Jm66mqTDfmdHdq/7DKVk3bro9Q8h6WdXKdPqFLMoqxrDK5SVRzHVPOS6uuGtrg==" }, - "err-code": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/err-code/-/err-code-2.0.3.tgz", - "integrity": "sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA==", - "dev": true, - "optional": true, - "peer": true - }, "error-ex": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", @@ -37469,11 +36723,54 @@ "which-typed-array": "^1.1.10" } }, + "es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==" + }, + "es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==" + }, + "es-get-iterator": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/es-get-iterator/-/es-get-iterator-1.1.3.tgz", + "integrity": "sha512-sPZmqHBe6JIiTfN5q2pEi//TwxmAFHwj/XEuYjTuse78i8KxaqMTTzxPoFKuzRpDpTJ+0NAbpfenkmH2rePtuw==", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.3", + "has-symbols": "^1.0.3", + "is-arguments": "^1.1.1", + "is-map": "^2.0.2", + "is-set": "^2.0.2", + "is-string": "^1.0.7", + "isarray": "^2.0.5", + "stop-iteration-iterator": "^1.0.0" + }, + "dependencies": { + "isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true + } + } + }, "es-module-lexer": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.3.0.tgz", "integrity": "sha512-vZK7T0N2CBmBOixhmjdqx2gWVbFZ4DXZ/NyRMZVlJXPa7CyFS+/a4QQsDGDQy9ZfEzxFuNEsMLeQJnKP2p5/JA==" }, + "es-object-atoms": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "requires": { + "es-errors": "^1.3.0" + } + }, "es-set-tostringtag": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.1.tgz", @@ -38974,11 +38271,11 @@ "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==" }, "for-each": { - "version": "0.3.3", - "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz", - "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==", + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.5.tgz", + "integrity": "sha512-dKx12eRCVIzqCxFGplyFKJMPvLEWgmNtUrpTiJIR5u97zEhRG8ySrtboPHZXx7daLxQVrl643cTzbab2tkQjxg==", "requires": { - "is-callable": "^1.1.3" + "is-callable": "^1.2.7" } }, "for-in": { @@ -39182,17 +38479,6 @@ "universalify": "^2.0.0" } }, - "fs-minipass": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-2.1.0.tgz", - "integrity": "sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "minipass": "^3.0.0" - } - }, "fs-monkey": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/fs-monkey/-/fs-monkey-1.0.4.tgz", @@ -39210,9 +38496,9 @@ "optional": true }, "function-bind": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", - "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==" + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==" }, "function.prototype.name": { "version": "1.1.5", @@ -40526,36 +39812,6 @@ "@babel/runtime": "^7.15.4" } }, - "gauge": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/gauge/-/gauge-3.0.2.tgz", - "integrity": "sha512-+5J6MS/5XksCuXq++uFRsnUd7Ovu1XenbeuIuNRJxYWjgQbPuFhT14lAvsWfqfAmnwluf1OwMjz39HjfLPci0Q==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "aproba": "^1.0.3 || ^2.0.0", - "color-support": "^1.1.2", - "console-control-strings": "^1.0.0", - "has-unicode": "^2.0.1", - "object-assign": "^4.1.1", - "signal-exit": "^3.0.0", - "string-width": "^4.2.3", - "strip-ansi": "^6.0.1", - "wide-align": "^1.1.2" - } - }, - "gaze": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/gaze/-/gaze-1.1.3.tgz", - "integrity": "sha512-BRdNm8hbWzFzWHERTrejLqwHDfS4GibPoq5wjTPIoJHoBtKGPg3xAFfxmM+9ztbXelxcf2hwQcaz1PtmFeue8g==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "globule": "^1.0.0" - } - }, "gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", @@ -40567,14 +39823,20 @@ "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==" }, "get-intrinsic": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.1.tgz", - "integrity": "sha512-2DcsyfABl+gVHEfCOaTrWgyt+tb6MSEGmKq+kI5HwLbIYgjgmMcV8KQ41uaKz1xxUcn9tJtgFbQUEVcEbd0FYw==", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", "requires": { - "function-bind": "^1.1.1", - "has": "^1.0.3", - "has-proto": "^1.0.1", - "has-symbols": "^1.0.3" + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" } }, "get-package-type": { @@ -40588,6 +39850,15 @@ "resolved": "https://registry.npmjs.org/get-port/-/get-port-3.2.0.tgz", "integrity": "sha512-x5UJKlgeUiNT8nyo/AcnwLnZuZNcSjSw0kogRB+Whd1fjjFq4B1hySFxSFWWSn4mIBzg3sRNUDFYc4g5gjPoLg==" }, + "get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "requires": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + } + }, "get-stdin": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-0.1.0.tgz", @@ -40800,39 +40071,10 @@ } } }, - "globule": { - "version": "1.3.4", - "resolved": "https://registry.npmjs.org/globule/-/globule-1.3.4.tgz", - "integrity": "sha512-OPTIfhMBh7JbBYDpa5b+Q5ptmMWKwcNcFSR/0c6t8V4f3ZAVBEsKNY37QdVqmLRYSMhOUGYrY0QhSoEpzGr/Eg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "glob": "~7.1.1", - "lodash": "^4.17.21", - "minimatch": "~3.0.2" - }, - "dependencies": { - "minimatch": { - "version": "3.0.8", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.8.tgz", - "integrity": "sha512-6FsRAQsxQ61mw+qP1ZzbL9Bc78x2p5OqNgNpnoAFLTrX8n5Kxph0CsnhmKKNXTWjXqU5L0pGPR7hYk+XWZr60Q==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "brace-expansion": "^1.1.7" - } - } - } - }, "gopd": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", - "integrity": "sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==", - "requires": { - "get-intrinsic": "^1.1.3" - } + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==" }, "got": { "version": "11.8.6", @@ -40931,14 +40173,6 @@ "har-schema": "^2.0.0" } }, - "hard-rejection": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/hard-rejection/-/hard-rejection-2.1.0.tgz", - "integrity": "sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA==", - "dev": true, - "optional": true, - "peer": true - }, "harmony-reflect": { "version": "1.6.2", "resolved": "https://registry.npmjs.org/harmony-reflect/-/harmony-reflect-1.6.2.tgz", @@ -40964,11 +40198,11 @@ "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==" }, "has-property-descriptors": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.0.tgz", - "integrity": "sha512-62DVLZGoiEBDHQyqG4w9xCuZ7eJEwNmJRWw2VY84Oedb7WFcA27fiEVe8oUQx9hAUJ4ekurquucTGwsyO1XGdQ==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", "requires": { - "get-intrinsic": "^1.1.1" + "es-define-property": "^1.0.0" } }, "has-proto": { @@ -40977,26 +40211,18 @@ "integrity": "sha512-7qE+iP+O+bgF9clE5+UoBFzE65mlBiVj3tKCrlNQ0Ogwm0BjpT/gK4SlLYDMybDh5I3TCTKnPPa0oMG7JDYrhg==" }, "has-symbols": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", - "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==" + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==" }, "has-tostringtag": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.0.tgz", - "integrity": "sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", "requires": { - "has-symbols": "^1.0.2" + "has-symbols": "^1.0.3" } }, - "has-unicode": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/has-unicode/-/has-unicode-2.0.1.tgz", - "integrity": "sha512-8Rf9Y83NBReMnx0gFzA8JImQACstCYWUplepDa9xprwwtmgEZUF0h/i5xSA625zB/I37EtrswSST6OXxwaaIJQ==", - "dev": true, - "optional": true, - "peer": true - }, "has-value": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/has-value/-/has-value-1.0.0.tgz", @@ -41076,6 +40302,14 @@ } } }, + "hasown": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.3.tgz", + "integrity": "sha512-ej4AhfhfL2Q2zpMmLo7U1Uv9+PyhIZpgQLGT1F9miIGmiCJIoCgSmczFdrc97mWT4kVY72KA+WnnhJ5pghSvSg==", + "requires": { + "function-bind": "^1.1.2" + } + }, "hast-to-hyperscript": { "version": "9.0.1", "resolved": "https://registry.npmjs.org/hast-to-hyperscript/-/hast-to-hyperscript-9.0.1.tgz", @@ -41400,17 +40634,6 @@ "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==" }, - "humanize-ms": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/humanize-ms/-/humanize-ms-1.2.1.tgz", - "integrity": "sha512-Fl70vYtsAFb/C06PTS9dZBo7ihau+Tu/DNCk/OyHhea07S+aeMWpFFkUaXRa8fI+ScZbEI8dfSxwY7gxZ9SAVQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "ms": "^2.0.0" - } - }, "iconv-lite": { "version": "0.4.24", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", @@ -41501,14 +40724,6 @@ "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", "dev": true }, - "infer-owner": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/infer-owner/-/infer-owner-1.0.4.tgz", - "integrity": "sha512-IClj+Xz94+d7irH5qRyfJonOdfTzuDaifE6ZPWfx0N0+/ATZCbuTPq2prFl526urkQd90WyUKIh1DfBQ2hMz9A==", - "dev": true, - "optional": true, - "peer": true - }, "inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -41599,13 +40814,13 @@ } }, "internal-slot": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.5.tgz", - "integrity": "sha512-Y+R5hJrzs52QCG2laLn4udYVnxsfny9CpOhNhUvk/SSSVyF6T27FzRbF0sroPidSu3X8oEAkOn2K804mjpt6UQ==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.1.0.tgz", + "integrity": "sha512-4gd7VpWNQNB4UKKCFFVcp1AVv+FMOgs9NKzjHKusc8jTMhd5eL1NqQqOpE0KzMds804/yHlglp3uxgluOqAPLw==", "requires": { - "get-intrinsic": "^1.2.0", - "has": "^1.0.3", - "side-channel": "^1.0.4" + "es-errors": "^1.3.0", + "hasown": "^2.0.2", + "side-channel": "^1.1.0" } }, "intl": { @@ -41634,14 +40849,6 @@ "loose-envify": "^1.0.0" } }, - "ip": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ip/-/ip-2.0.0.tgz", - "integrity": "sha512-WKa+XuLG1A1R0UWhl2+1XQSi+fZWMsYKffMZTTYsiZaUD8k2yDAj5atimTUD2TZkyCkNEeYE5NhFZmupOGtjYQ==", - "dev": true, - "optional": true, - "peer": true - }, "ipaddr.js": { "version": "1.9.1", "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", @@ -41850,14 +41057,6 @@ } } }, - "is-lambda": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-lambda/-/is-lambda-1.0.1.tgz", - "integrity": "sha512-z7CMFGNrENq5iFB9Bqo64Xk6Y9sg+epq1myIcdHaGnbMTYOxvzsEtdYqQUylB7LxfkvgrrjP32T6Ywciio9UIQ==", - "dev": true, - "optional": true, - "peer": true - }, "is-lower-case": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/is-lower-case/-/is-lower-case-2.0.2.tgz", @@ -41866,6 +41065,12 @@ "tslib": "^2.0.3" } }, + "is-map": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-map/-/is-map-2.0.3.tgz", + "integrity": "sha512-1Qed0/Hr2m+YqxnM09CjA2d/i6YZNfF6R2oRAOj36eUdS6qIV/huPJNSEpKbupewFs+ZsJlxsjjPbc0/afW6Lw==", + "dev": true + }, "is-negative-zero": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.2.tgz", @@ -41899,14 +41104,6 @@ "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==" }, - "is-plain-obj": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz", - "integrity": "sha512-yvkRyxmFKEOQ4pNXCmJG5AEQNlXJS5LaONXo5/cLdTZdWvsZ1ioJEonLGAosKlMWE8lwUy/bJzMjcw8az73+Fg==", - "dev": true, - "optional": true, - "peer": true - }, "is-plain-object": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", @@ -41956,6 +41153,12 @@ "resolved": "https://registry.npmjs.org/is-root/-/is-root-2.1.0.tgz", "integrity": "sha512-AGOriNp96vNBd3HtU+RzFEc75FfR5ymiYv8E553I71SCeXBiMsVDUtdio1OEFvrPyLIQ9tVR5RxXIFe5PUFjMg==" }, + "is-set": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-set/-/is-set-2.0.3.tgz", + "integrity": "sha512-iPAjerrse27/ygGLxw+EBR9agv9Y6uLeYVJMu+QNCoouJ1/1ri0mGrcWpfCqFZuzzx3WjtwxG098X+n4OuRkPg==", + "dev": true + }, "is-shared-array-buffer": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.2.tgz", @@ -42038,6 +41241,12 @@ "is-invalid-path": "^0.1.0" } }, + "is-weakmap": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.2.tgz", + "integrity": "sha512-K5pXYOm9wqY1RgjpL3YTkF39tni1XajUIkawTLUo9EZEVUFga5gSQJF8nNS7ZwJQ02y+1YCNYcMh+HIf1ZqE+w==", + "dev": true + }, "is-weakref": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", @@ -42046,6 +41255,16 @@ "call-bind": "^1.0.2" } }, + "is-weakset": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.4.tgz", + "integrity": "sha512-mfcwb6IzQyOKTs84CQMrOwW4gQcaTOAWJ0zzJCl2WSPDrWk/OzDaImWFH3djXhb24g4eudZfLRozAvPGw4d9hQ==", + "dev": true, + "requires": { + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" + } + }, "is-windows": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz", @@ -43905,14 +43124,6 @@ "@sideway/pinpoint": "^2.0.0" } }, - "js-base64": { - "version": "2.6.4", - "resolved": "https://registry.npmjs.org/js-base64/-/js-base64-2.6.4.tgz", - "integrity": "sha512-pZe//GGmwJndub7ZghVHz7vjb2LgC1m8B07Au3eYqeqv9emhESByMXxaEgkUkEqJe87oBbSniGYoQNIBklc7IQ==", - "dev": true, - "optional": true, - "peer": true - }, "js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -44354,53 +43565,6 @@ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", "dev": true }, - "make-fetch-happen": { - "version": "9.1.0", - "resolved": "https://registry.npmjs.org/make-fetch-happen/-/make-fetch-happen-9.1.0.tgz", - "integrity": "sha512-+zopwDy7DNknmwPQplem5lAZX/eCOzSvSNNcSKm5eVwTkOBzoktEfXsa9L23J/GIRhxRsaxzkPEhrJEpE2F4Gg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "agentkeepalive": "^4.1.3", - "cacache": "^15.2.0", - "http-cache-semantics": "^4.1.0", - "http-proxy-agent": "^4.0.1", - "https-proxy-agent": "^5.0.0", - "is-lambda": "^1.0.1", - "lru-cache": "^6.0.0", - "minipass": "^3.1.3", - "minipass-collect": "^1.0.2", - "minipass-fetch": "^1.3.2", - "minipass-flush": "^1.0.5", - "minipass-pipeline": "^1.2.4", - "negotiator": "^0.6.2", - "promise-retry": "^2.0.1", - "socks-proxy-agent": "^6.0.0", - "ssri": "^8.0.0" - }, - "dependencies": { - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "yallist": "^4.0.0" - } - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "makeerror": { "version": "1.0.12", "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz", @@ -44430,14 +43594,6 @@ "resolved": "https://registry.npmjs.org/map-cache/-/map-cache-0.2.2.tgz", "integrity": "sha512-8y/eV9QQZCiyn1SprXSrCmqJN0yNRATe+PO8ztwqrvrbdRLA3eYJF0yaR0YayLWkMbsQSKWS9N2gPcGEc4UsZg==" }, - "map-obj": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-4.3.0.tgz", - "integrity": "sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ==", - "dev": true, - "optional": true, - "peer": true - }, "map-visit": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/map-visit/-/map-visit-1.0.0.tgz", @@ -44452,6 +43608,11 @@ "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", "dev": true }, + "math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==" + }, "md5-file": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/md5-file/-/md5-file-5.0.0.tgz", @@ -44511,38 +43672,6 @@ "timers-ext": "^0.1.7" } }, - "meow": { - "version": "9.0.0", - "resolved": "https://registry.npmjs.org/meow/-/meow-9.0.0.tgz", - "integrity": "sha512-+obSblOQmRhcyBt62furQqRAQpNyWXo8BuQ5bN7dG8wmwQ+vwHKp/rCFD4CrTP8CsDQD1sjoZ94K417XEUk8IQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "@types/minimist": "^1.2.0", - "camelcase-keys": "^6.2.2", - "decamelize": "^1.2.0", - "decamelize-keys": "^1.1.0", - "hard-rejection": "^2.1.0", - "minimist-options": "4.1.0", - "normalize-package-data": "^3.0.0", - "read-pkg-up": "^7.0.1", - "redent": "^3.0.0", - "trim-newlines": "^3.0.0", - "type-fest": "^0.18.0", - "yargs-parser": "^20.2.3" - }, - "dependencies": { - "type-fest": { - "version": "0.18.1", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.18.1.tgz", - "integrity": "sha512-OIAYXk8+ISY+qTOwkHtKqzAuxchoMiD9Udx+FSGQDuiRR+PJKJHc2NJAXlbhkGwTt/4/nKZxELY1w3ReWOL8mw==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "merge-descriptors": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz", @@ -44629,130 +43758,6 @@ "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==" }, - "minimist-options": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/minimist-options/-/minimist-options-4.1.0.tgz", - "integrity": "sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "arrify": "^1.0.1", - "is-plain-obj": "^1.1.0", - "kind-of": "^6.0.3" - }, - "dependencies": { - "arrify": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/arrify/-/arrify-1.0.1.tgz", - "integrity": "sha512-3CYzex9M9FGQjCGMGyi6/31c8GJbgb0qGyrx5HWxPd0aCwh4cB2YjMb2Xf9UuoogrMrlO9cTqnB5rI5GHZTcUA==", - "dev": true, - "optional": true, - "peer": true - } - } - }, - "minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "yallist": "^4.0.0" - }, - "dependencies": { - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - } - } - }, - "minipass-collect": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/minipass-collect/-/minipass-collect-1.0.2.tgz", - "integrity": "sha512-6T6lH0H8OG9kITm/Jm6tdooIbogG9e0tLgpY6mphXSm/A9u8Nq1ryBG+Qspiub9LjWlBPsPS3tWQ/Botq4FdxA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "minipass": "^3.0.0" - } - }, - "minipass-fetch": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/minipass-fetch/-/minipass-fetch-1.4.1.tgz", - "integrity": "sha512-CGH1eblLq26Y15+Azk7ey4xh0J/XfJfrCox5LDJiKqI2Q2iwOLOKrlmIaODiSQS8d18jalF6y2K2ePUm0CmShw==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "encoding": "^0.1.12", - "minipass": "^3.1.0", - "minipass-sized": "^1.0.3", - "minizlib": "^2.0.0" - } - }, - "minipass-flush": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/minipass-flush/-/minipass-flush-1.0.5.tgz", - "integrity": "sha512-JmQSYYpPUqX5Jyn1mXaRwOda1uQ8HP5KAT/oDSLCzt1BYRhQU0/hDtsB1ufZfEEzMZ9aAVmsBw8+FWsIXlClWw==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "minipass": "^3.0.0" - } - }, - "minipass-pipeline": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/minipass-pipeline/-/minipass-pipeline-1.2.4.tgz", - "integrity": "sha512-xuIq7cIOt09RPRJ19gdi4b+RiNvDFYe5JH+ggNvBqGqpQXcru3PcRmOZuHBKWK1Txf9+cQ+HMVN4d6z46LZP7A==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "minipass": "^3.0.0" - } - }, - "minipass-sized": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/minipass-sized/-/minipass-sized-1.0.3.tgz", - "integrity": "sha512-MbkQQ2CTiBMlA2Dm/5cY+9SWFEN8pzzOXi6rlM5Xxq0Yqbda5ZQy9sU75a673FE9ZK0Zsbr6Y5iP6u9nktfg2g==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "minipass": "^3.0.0" - } - }, - "minizlib": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-2.1.2.tgz", - "integrity": "sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "minipass": "^3.0.0", - "yallist": "^4.0.0" - }, - "dependencies": { - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "mitt": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/mitt/-/mitt-1.2.0.tgz", @@ -44851,14 +43856,6 @@ "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==" }, - "nan": { - "version": "2.17.0", - "resolved": "https://registry.npmjs.org/nan/-/nan-2.17.0.tgz", - "integrity": "sha512-2ZTgtl0nJsO0KQCjEpxcIr5D+Yv90plTitZt9JBfQvVJDS5seMl3FOvsh3+9CoYWXf/1l5OaZzzF6nDm4cagaQ==", - "dev": true, - "optional": true, - "peer": true - }, "nanoid": { "version": "3.3.6", "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.6.tgz", @@ -45003,131 +44000,6 @@ } } }, - "node-gyp": { - "version": "8.4.1", - "resolved": "https://registry.npmjs.org/node-gyp/-/node-gyp-8.4.1.tgz", - "integrity": "sha512-olTJRgUtAb/hOXG0E93wZDs5YiJlgbXxTwQAFHyNlRsXQnYzUaF2aGgujZbw+hR8aF4ZG/rST57bWMWD16jr9w==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "env-paths": "^2.2.0", - "glob": "^7.1.4", - "graceful-fs": "^4.2.6", - "make-fetch-happen": "^9.1.0", - "nopt": "^5.0.0", - "npmlog": "^6.0.0", - "rimraf": "^3.0.2", - "semver": "^7.3.5", - "tar": "^6.1.2", - "which": "^2.0.2" - }, - "dependencies": { - "are-we-there-yet": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/are-we-there-yet/-/are-we-there-yet-3.0.1.tgz", - "integrity": "sha512-QZW4EDmGwlYur0Yyf/b2uGucHQMa8aFUP7eu9ddR73vvhFyt4V0Vl3QHPcTNJ8l6qYOBdxgXdnBXQrHilfRQBg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "delegates": "^1.0.0", - "readable-stream": "^3.6.0" - } - }, - "gauge": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/gauge/-/gauge-4.0.4.tgz", - "integrity": "sha512-f9m+BEN5jkg6a0fZjleidjN51VE1X+mPFQ2DJ0uv1V39oCLCbsGe6yjbBnp7eK7z/+GAon99a3nHuqbuuthyPg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "aproba": "^1.0.3 || ^2.0.0", - "color-support": "^1.1.3", - "console-control-strings": "^1.1.0", - "has-unicode": "^2.0.1", - "signal-exit": "^3.0.7", - "string-width": "^4.2.3", - "strip-ansi": "^6.0.1", - "wide-align": "^1.1.5" - } - }, - "glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - } - }, - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "yallist": "^4.0.0" - } - }, - "npmlog": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/npmlog/-/npmlog-6.0.2.tgz", - "integrity": "sha512-/vBvz5Jfr9dT/aFWd0FIRf+T/Q2WBsLENygUaFUqstqsycmZAP/t5BvFJTK0viFmSUxiUKTUplWy5vt+rvKIxg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "are-we-there-yet": "^3.0.0", - "console-control-strings": "^1.1.0", - "gauge": "^4.0.3", - "set-blocking": "^2.0.0" - } - }, - "readable-stream": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", - "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "inherits": "^2.0.3", - "string_decoder": "^1.1.1", - "util-deprecate": "^1.0.1" - } - }, - "semver": { - "version": "7.5.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", - "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "lru-cache": "^6.0.0" - } - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "node-gyp-build-optional-packages": { "version": "5.0.3", "resolved": "https://registry.npmjs.org/node-gyp-build-optional-packages/-/node-gyp-build-optional-packages-5.0.3.tgz", @@ -45201,181 +44073,6 @@ "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.13.tgz", "integrity": "sha512-uYr7J37ae/ORWdZeQ1xxMJe3NtdmqMC/JZK+geofDrkLUApKRHPd18/TxtBOJ4A0/+uUIliorNrfYV6s1b02eQ==" }, - "node-sass": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/node-sass/-/node-sass-7.0.3.tgz", - "integrity": "sha512-8MIlsY/4dXUkJDYht9pIWBhMil3uHmE8b/AdJPjmFn1nBx9X9BASzfzmsCy0uCCb8eqI3SYYzVPDswWqSx7gjw==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "async-foreach": "^0.1.3", - "chalk": "^4.1.2", - "cross-spawn": "^7.0.3", - "gaze": "^1.0.0", - "get-stdin": "^4.0.1", - "glob": "^7.0.3", - "lodash": "^4.17.15", - "meow": "^9.0.0", - "nan": "^2.13.2", - "node-gyp": "^8.4.1", - "npmlog": "^5.0.0", - "request": "^2.88.0", - "sass-graph": "^4.0.1", - "stdout-stream": "^1.4.0", - "true-case-path": "^1.0.2" - }, - "dependencies": { - "ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "color-convert": "^2.0.1" - } - }, - "chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - } - }, - "color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "color-name": "~1.1.4" - } - }, - "color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true, - "optional": true, - "peer": true - }, - "get-stdin": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-4.0.1.tgz", - "integrity": "sha512-F5aQMywwJ2n85s4hJPTT9RPxGmubonuB10MNYo17/xph174n2MIR33HRguhzVag10O/npM7SPk73LMZNP+FaWw==", - "dev": true, - "optional": true, - "peer": true - }, - "has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, - "optional": true, - "peer": true - }, - "supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "has-flag": "^4.0.0" - } - }, - "true-case-path": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/true-case-path/-/true-case-path-1.0.3.tgz", - "integrity": "sha512-m6s2OdQe5wgpFMC+pAJ+q9djG82O2jcHPOI6RNg1yy9rCYR+WD6Nbpl32fDpfC56nirdRy+opFa/Vk7HYhqaew==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "glob": "^7.1.2" - } - } - } - }, - "nopt": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/nopt/-/nopt-5.0.0.tgz", - "integrity": "sha512-Tbj67rffqceeLpcRXrT7vKAN8CwfPeIBgM7E6iBkmKLV7bEMwpGgYLGv0jACUsECaa/vuxP0IjEont6umdMgtQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "abbrev": "1" - } - }, - "normalize-package-data": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-3.0.3.tgz", - "integrity": "sha512-p2W1sgqij3zMMyRC067Dg16bfzVH+w7hyegmpIvZ4JNjqtGOVAIvLmjBx3yP7YTe9vKJgkoNOPjwQGogDoMXFA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "hosted-git-info": "^4.0.1", - "is-core-module": "^2.5.0", - "semver": "^7.3.4", - "validate-npm-package-license": "^3.0.1" - }, - "dependencies": { - "hosted-git-info": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-4.1.0.tgz", - "integrity": "sha512-kyCuEOWjJqZuDbRHzL8V93NzQhwIB71oFWSyzVo+KPZI+pnQPPxucdkrOZvkLRnrf5URsQM+IJ09Dw29cRALIA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "lru-cache": "^6.0.0" - } - }, - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "yallist": "^4.0.0" - } - }, - "semver": { - "version": "7.5.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", - "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "lru-cache": "^6.0.0" - } - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "normalize-path": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", @@ -45399,20 +44096,6 @@ "path-key": "^3.0.0" } }, - "npmlog": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/npmlog/-/npmlog-5.0.1.tgz", - "integrity": "sha512-AqZtDUWOMKs1G/8lwylVjrdYgqA4d9nu8hc+0gzRxlDb1I10+FHBGMXs6aiQHFdCUUlqH99MUMuLfzWDNDtfxw==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "are-we-there-yet": "^2.0.0", - "console-control-strings": "^1.1.0", - "gauge": "^3.0.0", - "set-blocking": "^2.0.0" - } - }, "nth-check": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", @@ -45519,9 +44202,19 @@ } }, "object-inspect": { - "version": "1.12.3", - "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.3.tgz", - "integrity": "sha512-geUvdk7c+eizMNUDkRpW1wJwgfOiOeHbxBR/hLXK1aT6zmVSO0jsQcs7fj6MGw89jC/cjGfLcNOrtMYtGqm81g==" + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==" + }, + "object-is": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/object-is/-/object-is-1.1.6.tgz", + "integrity": "sha512-F8cZ+KfGlSGi09lJT7/Nd6KJZ9ygtvYC0/UYYLI9nmQKLMnydpB9yvbv9K1uSkEu7FU9vYPmVwLg328tX+ot3Q==", + "dev": true, + "requires": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1" + } }, "object-keys": { "version": "1.1.1", @@ -45718,17 +44411,6 @@ } } }, - "p-map": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", - "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "aggregate-error": "^3.0.0" - } - }, "p-try": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", @@ -45928,6 +44610,61 @@ "integrity": "sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==", "dev": true }, + "parse5-htmlparser2-tree-adapter": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz", + "integrity": "sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g==", + "requires": { + "domhandler": "^5.0.3", + "parse5": "^7.0.0" + }, + "dependencies": { + "domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "requires": { + "domelementtype": "^2.3.0" + } + }, + "entities": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", + "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==" + }, + "parse5": { + "version": "7.3.0", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", + "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", + "requires": { + "entities": "^6.0.0" + } + } + } + }, + "parse5-parser-stream": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/parse5-parser-stream/-/parse5-parser-stream-7.1.2.tgz", + "integrity": "sha512-JyeQc9iwFLn5TbvvqACIF/VXG6abODeB3Fwmv/TGdLk2LfbWkaySGY72at4+Ty7EkPZj854u4CrICqNk2qIbow==", + "requires": { + "parse5": "^7.0.0" + }, + "dependencies": { + "entities": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", + "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==" + }, + "parse5": { + "version": "7.3.0", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", + "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", + "requires": { + "entities": "^6.0.0" + } + } + } + }, "parseley": { "version": "0.7.0", "resolved": "https://registry.npmjs.org/parseley/-/parseley-0.7.0.tgz", @@ -46121,6 +44858,11 @@ "resolved": "https://registry.npmjs.org/posix-character-classes/-/posix-character-classes-0.1.1.tgz", "integrity": "sha512-xTgYBc3fuo7Yt7JbiuFxSYGToMoz8fLoE6TC9Wx1P/u+LfeThMOAqmuyECnlBaaJb+u1m9hHiXUEtwW4OzfUJg==" }, + "possible-typed-array-names": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.1.0.tgz", + "integrity": "sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg==" + }, "postcss": { "version": "8.4.27", "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.27.tgz", @@ -46561,26 +45303,6 @@ "asap": "~2.0.3" } }, - "promise-inflight": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/promise-inflight/-/promise-inflight-1.0.1.tgz", - "integrity": "sha512-6zWPyEOFaQBJYcGMHBKTKJ3u6TBsnMFOIZSa6ce1e/ZrrsOlnHRHbabMjLiBYKp+n44X9eUI6VUPaukCXHuG4g==", - "dev": true, - "optional": true, - "peer": true - }, - "promise-retry": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/promise-retry/-/promise-retry-2.0.1.tgz", - "integrity": "sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "err-code": "^2.0.2", - "retry": "^0.12.0" - } - }, "prompts": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", @@ -47258,13 +45980,16 @@ "dev": true }, "regexp.prototype.flags": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.0.tgz", - "integrity": "sha512-0SutC3pNudRKgquxGoRGIz946MZVHqbNfPjBdxeOhBrdgDKlRoXmYLQN9xRbrR09ZXWeGAdPuif7egofn6v5LA==", + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.4.tgz", + "integrity": "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==", "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "functions-have-names": "^1.2.3" + "call-bind": "^1.0.8", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "set-function-name": "^2.0.2" } }, "regexpp": { @@ -48037,60 +46762,6 @@ } } }, - "sass-graph": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/sass-graph/-/sass-graph-4.0.1.tgz", - "integrity": "sha512-5YCfmGBmxoIRYHnKK2AKzrAkCoQ8ozO+iumT8K4tXJXRVCPf+7s1/9KxTSW3Rbvf+7Y7b4FR3mWyLnQr3PHocA==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "glob": "^7.0.0", - "lodash": "^4.17.11", - "scss-tokenizer": "^0.4.3", - "yargs": "^17.2.1" - }, - "dependencies": { - "cliui": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", - "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "string-width": "^4.2.0", - "strip-ansi": "^6.0.1", - "wrap-ansi": "^7.0.0" - } - }, - "yargs": { - "version": "17.7.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", - "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "cliui": "^8.0.1", - "escalade": "^3.1.1", - "get-caller-file": "^2.0.5", - "require-directory": "^2.1.1", - "string-width": "^4.2.3", - "y18n": "^5.0.5", - "yargs-parser": "^21.1.1" - } - }, - "yargs-parser": { - "version": "21.1.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", - "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "sass-loader": { "version": "10.4.1", "resolved": "https://registry.npmjs.org/sass-loader/-/sass-loader-10.4.1.tgz", @@ -48163,28 +46834,6 @@ "ajv-keywords": "^3.5.2" } }, - "scss-tokenizer": { - "version": "0.4.3", - "resolved": "https://registry.npmjs.org/scss-tokenizer/-/scss-tokenizer-0.4.3.tgz", - "integrity": "sha512-raKLgf1LI5QMQnG+RxHz6oK0sL3x3I4FN2UDLqgLOGO8hodECNnNh5BXn7fAyBxrA8zVzdQizQ6XjNJQ+uBwMw==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "js-base64": "^2.4.9", - "source-map": "^0.7.3" - }, - "dependencies": { - "source-map": { - "version": "0.7.4", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.4.tgz", - "integrity": "sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "selderee": { "version": "0.6.0", "resolved": "https://registry.npmjs.org/selderee/-/selderee-0.6.0.tgz", @@ -48288,6 +46937,30 @@ "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", "integrity": "sha512-KiKBS8AnWGEyLzofFfmvKwpdPzqiy16LvQfK3yv/fVH7Bj13/wl3JSR1J+rfgRE9q7xUJK4qvgS8raSOeLUehw==" }, + "set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "requires": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + } + }, + "set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "requires": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + } + }, "set-value": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/set-value/-/set-value-2.0.1.tgz", @@ -48423,13 +47096,47 @@ } }, "side-channel": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", - "integrity": "sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", + "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", "requires": { - "call-bind": "^1.0.0", - "get-intrinsic": "^1.0.2", - "object-inspect": "^1.9.0" + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3", + "side-channel-list": "^1.0.0", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + } + }, + "side-channel-list": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.1.tgz", + "integrity": "sha512-mjn/0bi/oUURjc5Xl7IaWi/OJJJumuoJFQJfDDyO46+hBWsfaVM65TBHq2eoZBhzl9EchxOijpkbRC8SVBQU0w==", + "requires": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.4" + } + }, + "side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "requires": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + } + }, + "side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "requires": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" } }, "signal-exit": { @@ -48548,14 +47255,6 @@ "resolved": "https://registry.npmjs.org/slugify/-/slugify-1.6.6.tgz", "integrity": "sha512-h+z7HKHYXj6wJU+AnS/+IH8Uh9fdcX1Lrhg1/VMdf9PwoBQXFcXiAdsy2tSK0P6gKwJLXp02r90ahUCqHk9rrw==" }, - "smart-buffer": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.2.0.tgz", - "integrity": "sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg==", - "dev": true, - "optional": true, - "peer": true - }, "snake-case": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", @@ -48758,31 +47457,6 @@ "debug": "~4.3.1" } }, - "socks": { - "version": "2.7.1", - "resolved": "https://registry.npmjs.org/socks/-/socks-2.7.1.tgz", - "integrity": "sha512-7maUZy1N7uo6+WVEX6psASxtNlKaNVMlGQKkG/63nEDdLOWNbiUMoLK7X4uYoLhQstau72mLgfEWcXcwsaHbYQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "ip": "^2.0.0", - "smart-buffer": "^4.2.0" - } - }, - "socks-proxy-agent": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-6.2.1.tgz", - "integrity": "sha512-a6KW9G+6B3nWZ1yB8G7pJwL3ggLy1uTzKAgCb7ttblwqdz9fMGJUuTy3uFzEP48FAs9FLILlmzDlE2JJhVQaXQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "agent-base": "^6.0.2", - "debug": "^4.3.3", - "socks": "^2.6.2" - } - }, "source-list-map": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/source-list-map/-/source-list-map-2.0.1.tgz", @@ -48905,17 +47579,6 @@ "tweetnacl": "~0.14.0" } }, - "ssri": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/ssri/-/ssri-8.0.1.tgz", - "integrity": "sha512-97qShzy1AiyxvPNIkLWoGua7xoQzzPjQ0HAH4B0rWKo7SZ6USuPcrUiAFrws0UH8RrbWmgq3LMTObhPIHbbBeQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "minipass": "^3.1.1" - } - }, "st": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/st/-/st-2.0.0.tgz", @@ -49041,15 +47704,14 @@ "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz", "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==" }, - "stdout-stream": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/stdout-stream/-/stdout-stream-1.4.1.tgz", - "integrity": "sha512-j4emi03KXqJWcIeF8eIXkjMFN1Cmb8gUlDYGeBALLPo5qdyTfA9bOtl8m33lRoC+vFMkP3gl0WsDr6+gzxbbTA==", + "stop-iteration-iterator": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/stop-iteration-iterator/-/stop-iteration-iterator-1.1.0.tgz", + "integrity": "sha512-eLoXW/DHyl62zxY4SCaIgnRhuMr6ri4juEYARS8E6sCEqzKpOiE521Ucofdx+KnDZl5xmvGYaaKCk5FEOxJCoQ==", "dev": true, - "optional": true, - "peer": true, "requires": { - "readable-stream": "^2.0.1" + "es-errors": "^1.3.0", + "internal-slot": "^1.1.0" } }, "streamsearch": { @@ -49373,48 +48035,6 @@ "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.2.1.tgz", "integrity": "sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ==" }, - "tar": { - "version": "6.1.15", - "resolved": "https://registry.npmjs.org/tar/-/tar-6.1.15.tgz", - "integrity": "sha512-/zKt9UyngnxIT/EAGYuxaMYgOIJiP81ab9ZfkILq4oNLPFX50qyYmu7jRj9qeXoxmJHjGlbH0+cm2uy1WCs10A==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "chownr": "^2.0.0", - "fs-minipass": "^2.0.0", - "minipass": "^5.0.0", - "minizlib": "^2.1.1", - "mkdirp": "^1.0.3", - "yallist": "^4.0.0" - }, - "dependencies": { - "minipass": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz", - "integrity": "sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==", - "dev": true, - "optional": true, - "peer": true - }, - "mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "dev": true, - "optional": true, - "peer": true - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true, - "peer": true - } - } - }, "tar-fs": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-2.1.1.tgz", @@ -49704,14 +48324,6 @@ "punycode": "^2.1.1" } }, - "trim-newlines": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/trim-newlines/-/trim-newlines-3.0.1.tgz", - "integrity": "sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw==", - "dev": true, - "optional": true, - "peer": true - }, "trough": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/trough/-/trough-1.0.5.tgz", @@ -49873,6 +48485,19 @@ "safe-buffer": "^5.0.1" } }, + "turndown": { + "version": "7.2.4", + "resolved": "https://registry.npmjs.org/turndown/-/turndown-7.2.4.tgz", + "integrity": "sha512-I8yFsfRzmzK0WV1pNNOA4A7y4RDfFxPRxb3t+e3ui14qSGOxGtiSP6GjeX+Y6CHb7HYaFj7ECUD7VE5kQMZWGQ==", + "requires": { + "@mixmark-io/domino": "^2.2.0" + } + }, + "turndown-plugin-gfm": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/turndown-plugin-gfm/-/turndown-plugin-gfm-1.0.2.tgz", + "integrity": "sha512-vwz9tfvF7XN/jE0dGoBei3FXWuvll78ohzCZQuOb+ZjWrs3a0XhQVomJEb2Qh4VHTPNRO4GPZh0V7VRbiWwkRg==" + }, "tweetnacl": { "version": "0.14.5", "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", @@ -50037,6 +48662,11 @@ "resolved": "https://registry.npmjs.org/unc-path-regex/-/unc-path-regex-0.1.2.tgz", "integrity": "sha512-eXL4nmJT7oCpkZsHZUOJo8hcX3GbsiDOa0Qu9F646fi8dT3XuSVopVqAcEiVzSKKH7UoDti23wNX3qGFxcW5Qg==" }, + "undici": { + "version": "7.25.0", + "resolved": "https://registry.npmjs.org/undici/-/undici-7.25.0.tgz", + "integrity": "sha512-xXnp4kTyor2Zq+J1FfPI6Eq3ew5h6Vl0F/8d9XU5zZQf1tX9s2Su1/3PiMmUANFULpmksxkClamIZcaUqryHsQ==" + }, "unicode-canonical-property-names-ecmascript": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.0.tgz", @@ -50101,28 +48731,6 @@ } } }, - "unique-filename": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/unique-filename/-/unique-filename-1.1.1.tgz", - "integrity": "sha512-Vmp0jIp2ln35UTXuryvjzkjGdRyf9b2lTXuSYUiPmzRcl3FDtYqAwOnTJkAngD9SWhnoJzDbTKwaOrZ+STtxNQ==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "unique-slug": "^2.0.0" - } - }, - "unique-slug": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/unique-slug/-/unique-slug-2.0.2.tgz", - "integrity": "sha512-zoWr9ObaxALD3DOPfjPSqxt4fnZiWblxHIgeWqW8x7UqDzEtHEQLzji2cuJYQFCU6KmoJikOYAZlrTHHebjx2w==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "imurmurhash": "^0.1.4" - } - }, "unique-string": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-2.0.0.tgz", @@ -50804,32 +49412,35 @@ "is-symbol": "^1.0.3" } }, + "which-collection": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-collection/-/which-collection-1.0.2.tgz", + "integrity": "sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw==", + "dev": true, + "requires": { + "is-map": "^2.0.3", + "is-set": "^2.0.3", + "is-weakmap": "^2.0.2", + "is-weakset": "^2.0.3" + } + }, "which-module": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.1.tgz", "integrity": "sha512-iBdZ57RDvnOR9AGBhML2vFZf7h8vmBjhoaZqODJBFWHVtKkDmKuHai3cx5PgVMrX5YDNp27AofYbAwctSS+vhQ==" }, "which-typed-array": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.11.tgz", - "integrity": "sha512-qe9UWWpkeG5yzZ0tNYxDmd7vo58HDBc39mZ0xWWpolAGADdFOzkfamWLDxkOWcvHQKVmdTyQdLD4NOfjLWTKew==", - "requires": { - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.2", - "for-each": "^0.3.3", - "gopd": "^1.0.1", - "has-tostringtag": "^1.0.0" - } - }, - "wide-align": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.5.tgz", - "integrity": "sha512-eDMORYaPNZ4sQIuuYPDHdQvf4gyCF9rEEV/yPxGfwPkRodwEgiMUUXTx/dex+Me0wxx53S+NgUHaP7y3MGlDmg==", - "dev": true, - "optional": true, - "peer": true, - "requires": { - "string-width": "^1.0.2 || 2 || 3 || 4" + "version": "1.1.20", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.20.tgz", + "integrity": "sha512-LYfpUkmqwl0h9A2HL09Mms427Q1RZWuOHsukfVcKRq9q95iQxdw0ix1JQrqbcDR9PH1QDwf5Qo8OZb5lksZ8Xg==", + "requires": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", + "for-each": "^0.3.5", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-tostringtag": "^1.0.2" } }, "widest-line": { diff --git a/package.json b/package.json index d0759507f..c93495e13 100644 --- a/package.json +++ b/package.json @@ -22,6 +22,7 @@ "dependencies": { "@vercel/analytics": "^1.0.2", "algoliasearch": "^4.10.5", + "cheerio": "^1.2.0", "classnames": "^2.3.1", "eventemitter3": "^4.0.7", "gatsby-plugin-vercel": "^1.0.3", @@ -30,17 +31,19 @@ "lodash": "^4.17.21", "mixpanel-browser": "^2.45.0", "react-helmet": "^6.1.0", + "turndown": "^7.2.4", + "turndown-plugin-gfm": "^1.0.2", "use-deep-compare-effect": "^1.8.1" }, "devDependencies": { "@react-icons/all-files": "^4.1.0", "@testing-library/jest-dom": "^5.14.1", - "@testing-library/react": "^11.2.7", + "@testing-library/react": "^13.4.0", "@types/mixpanel-browser": "^2.35.6", "@types/react": "^18.2.14", "@types/react-helmet": "^6.1.6", "@types/react-modal": "^3.16.0", - "@types/react-test-renderer": "^17.0.1", + "@types/react-test-renderer": "^18.0.0", "@typescript-eslint/eslint-plugin": "^4.6.0", "@typescript-eslint/parser": "^4.6.0", "asciidoctor": "^2.2.1", @@ -74,7 +77,6 @@ "identity-obj-proxy": "^3.0.0", "jest": "^26.6.3", "jsdom": "^17.0.0", - "sass": "^1.80.6", "prettier": "2.1.2", "react": "^18.0.0", "react-dom": "^18.0.0", @@ -83,6 +85,7 @@ "react-resize-detector": "^9.x.0", "react-test-renderer": "^18.0.x", "react-use-flexsearch": "^0.1.1", + "sass": "^1.80.6", "ts-jest": "^26.5.5", "ts-node": "^10.9.1", "tsx": "^4.7.1", @@ -105,4 +108,4 @@ "globals": { "window": {} } -} \ No newline at end of file +} diff --git a/src/assets/styles/admonition.scss b/src/assets/styles/admonition.scss index 70e082a27..e7dd3e6f4 100644 --- a/src/assets/styles/admonition.scss +++ b/src/assets/styles/admonition.scss @@ -5,11 +5,11 @@ line-height: $admonition-content-line-height; p { - font-size: calc((#{$admonition-font-factor-p} / #{$rem-base}) * 1rem); + font-size: 13px; } td.content { - font-size: calc((#{$admonition-font-factor-p} / #{$rem-base}) * 1rem); + font-size: 13px; padding: 2rem 1rem 0 0.75rem; background: var(--admonition-background); width: 100%; @@ -36,6 +36,7 @@ top: 0; left: 0; padding: 0.5rem 0; + margin: 2px 0 0 0; height: 1.25rem; font-weight: $font-weight-bold; text-transform: uppercase; @@ -80,4 +81,4 @@ position: relative; width: 100%; } -} +} \ No newline at end of file diff --git a/src/assets/styles/index.scss b/src/assets/styles/index.scss index 6a648d22d..6bc712713 100644 --- a/src/assets/styles/index.scss +++ b/src/assets/styles/index.scss @@ -44,6 +44,8 @@ body { } } +$secondary-header-height: 44px; + main { display: flow-root; background-color: var(--body-background-color); @@ -51,7 +53,15 @@ main { main { display: flex; - height: calc(100lvh - $header-height); + height: calc(100lvh - #{$header-height} - #{$secondary-header-height}); +} + +.withHeaderFooter main { + height: calc(100lvh - #{$header-height} - #{$secondary-header-height}); +} + +#wrapper { + position: relative; } * { @@ -92,16 +102,16 @@ a { /*active class with background*/ .activelink { - background: $hovercolor; - color: var(--secondary-color); + background: var(--side-nav-active-bg); + color: var(--var-note-color); } /*end active class with background*/ /*active class without background*/ -/*to override document componet style used important*/ +/*to override document component style used important*/ .active { - color: var(--secondary-color) !important; + color: var(--var-note-color) !important; } /*active class without background*/ @@ -139,7 +149,8 @@ a { .docmapWrapper { height: calc(100lvh - $document-padding); padding: 10px $padding-md 80px $padding-md; - width: 25%; + width: 260px; + flex-shrink: 0; overflow-y: auto; } @@ -202,8 +213,9 @@ button { /*Tags style start*/ .video { - width: 800px; - height: 600px; + width: 100%; + max-width: 800px; + aspect-ratio: 4 / 3; } .tag { @@ -308,6 +320,43 @@ button { border: solid 1px #fea85f; } +.version-badge { + border-radius: $tag-border-radius; + display: inline-flex; + align-items: center; + font-size: 14px; + font-weight: 600; + padding: $tag-padding; + margin: 2px; + vertical-align: middle; + height: 25px; + line-height: $line-height-doc; + text-align: center; + margin: 2px; + min-width: $tag-width; + padding: $tag-padding; +} + +.version-badge.breaking { + background-color: #d32f2f; + color: #ffffff; +} + +.version-badge.new { + background-color: #2e7d32; + color: #ffffff; +} + +.version-badge.deprecated { + background-color: #d32f2f; + color: #f1f4f8; +} + +.version-badge.fixed { + background-color: #1565c0; + color: #ffffff; +} + .definedInTag { font-size: $font-size-small; @@ -419,8 +468,8 @@ button { flex-direction: column; justify-content: space-between; margin: 10px; - border-radius: 6px; - border: 1px solid $lightgrey; + border-radius: 10px; + border: 1px solid var(--search-border-color); &:hover { box-shadow: var(--box-shadow-hover); @@ -451,7 +500,7 @@ button { } .container { - margin: 0 0 30px 0; + margin: 0 0 5px 0; padding: 0px; width: auto; } @@ -554,6 +603,18 @@ button { padding: 5px; } + +.calloutBox { + border: 0.5px solid #9FE9FF; + border-radius: 10px; + height: auto; + width: 100%; + padding: 20px; + background-color: #9FE9FF; + margin-top: 20px; +} + + .introList { font-size: 13px; font-weight: $font-weight-normal; @@ -588,32 +649,39 @@ button { } } +/* Admonition */ + .admonitionblock.note { - border-left: 5px solid var(--var-note-color); + border-left: 4px solid var(--var-note-color); td.content { - border: none !important; - border-radius: 0 !important; - box-shadow: none !important; + border: 1px solid var(--note-border-color); + box-shadow: 0 1px 1px var(--note-border-color); + border-radius: 5px !important;; + background: var(--note-block-color); + } td.icon { left: 20px !important; - top: 5px !important; + top: 10px !important; + padding-bottom: 10px; } } .admonitionblock.important { - border-left: 5px solid var(--var-important-color); + border-left: 4px solid var(--var-important-color); td.content { - border: none !important; - border-radius: 0 !important; - box-shadow: none !important; + border: 1px solid var(--important-border-color); + box-shadow: 0 1px 1px var(--important-border-color); + border-radius: 5px !important; + background: var(--important-block-color); } td.icon { left: 20px !important; - top: 5px !important; + top: 10px !important; + padding-bottom: 10px; } } .admonitionblock.warning { - border-left: 5px solid var(--var-important-color); + border-left: 5px solid $warning-color; td.content { border: none !important; border-radius: 0 !important; @@ -625,6 +693,20 @@ button { } } +.admonitionblock.tip { + border-left: 5px solid $tip-color; + td.content { + border: 0 !important; + border-radius: 0.5 !important; + box-shadow: none !important; + } + td.icon { + left: 20px !important; + top: 10px !important; + } +} + + .videoContainer { border-radius: 10px; overflow-x: auto; @@ -711,11 +793,11 @@ a.anchor { } ::-webkit-scrollbar { - height: 0.4em; + height: 0.2em; } ::-webkit-scrollbar-track { - -webkit-box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.1); + border: none; border-radius: 10px; } @@ -733,7 +815,7 @@ a.anchor { @media screen and (min-width: 1024px) and (max-width: 1300px) { .docmapWrapper { - width: 35%; + width: 220px; } } @@ -1019,24 +1101,24 @@ a.anchor { } } .header-banner { - min-height: 259px; - background-color: var(--header-background-color); - color: var(--header-primary-color); - padding: 40px 0 0 40px; + min-height: 240px; + background: var(--header-banner-background); + box-shadow: 0 3px 3px #122246; + padding: 30px 0 0 40px; + .header-banner-text { display: flex; flex-direction: column; + color: #fff; width: 60%; h1 { font-size: $font-size-large; - font-weight: $font-weight-normal; + font-weight: 400; margin: 0; - color: var(--header-primary-color); } h5 { font-size: $font-size-h5; - color: var(--header-primary-color); font-weight: $font-weight-normal; line-height: 24px; letter-spacing: -0.064px; @@ -1044,8 +1126,18 @@ a.anchor { } } +.cardHeading { + font-size: $font-size-h2; + color: var(--primary-color) #1d232f; + font-weight: $font-weight-normal; + line-height: 24px; + letter-spacing: -0.064px; + padding: 2px 0 20px 10px; + margin-top: 20px; +} + .document-body-wrapper { - padding: 30px; + padding: 5px 30px 20px 30px; } .searchInputBanner { padding: 20px 0; @@ -1054,7 +1146,7 @@ a.anchor { height: 20px; width: 20px; bottom: 8px; - color: var(--border-color); + color: var(--border-color-home-search); } .searchInputContainer { width: 50%; @@ -1062,11 +1154,11 @@ a.anchor { } .search-input-banner { width: 100%; - border-bottom: 1px solid var(--body-background-color); + border-bottom: 1px solid var(--border-color-home-search); height: 40px; padding-left: 36px; font-size: 18px; - color: var(--border-color); + color: var(--border-color-home-search); cursor: text; } } @@ -1100,7 +1192,7 @@ a.anchor { tbody tr { &:first-child { - border-top: 1px solid var(--border-color);; + border-top: 1px solid var(--border-color); } } @@ -1270,1277 +1362,4 @@ a.anchor { padding-top: 0; } } -}@import './variables.scss'; - @import './padding.scss'; - @import './margin.scss'; - - @font-face { - font-family: 'Optimo-Plain'; - src: url('../fonts/Plain-Medium.otf') format('opentype'); - font-weight: $font-weight-bold; - font-style: normal; - font-display: swap; - } - - @font-face { - font-family: 'Optimo-Plain'; - src: url('../fonts/Plain-Light.otf') format('opentype'); - font-weight: $font-weight-normal; - font-style: normal; - font-display: swap; - } - - html { - scroll-behavior: smooth; - scroll-padding-top: 40px; /* match header height */ - } - - body { - margin: $gutter; - padding: $gutter; - font-family: 'Optimo-Plain'; - font-size: $font-size-normal; - overflow-y: hidden; - animation: display-transition 1s ease-out; - } - - @keyframes display-transition { - 0% { - opacity: 0; - } - 99%{ - opacity: 0; - } - 100% { - opacity: 1; - } - } - - main { - display: flow-root; - background-color: var(--body-background-color); - } - - main { - display: flex; - height: calc(100lvh - $header-height); - } - - * { - box-sizing: border-box; - } - - strong, - b { - font-weight: bold; - } - - .anchor { - display: block; - padding-top: 80px; /* height of sticky header */ - margin-top: -80px; - } - - .anchor-link { - scroll-margin: 120px; - } - - a { - text-decoration: none; - } - - .m-0 { - margin: $gutter; - } - - .containerWrapper { - padding: 13px 25px; - } - - .d-inline-block { - display: inline-block; - } - - /*active class with background*/ - - .activelink { - background: $hovercolor; - color: var(--secondary-color); - } - - /*end active class with background*/ - - /*active class without background*/ - /*to override document componet style used important*/ - .active { - color: var(--secondary-color) !important; - } - - /*active class without background*/ - - /*visited class*/ - - .visited { - color: $disabledcolor; - } - - /*end visited class*/ - - .headerPlaceholder { - height: $header-height; - } - - .introWrapper { - display: flex; - } - - .documentWrapperContainer { - height: calc(100lvh - $document-padding); - width: calc(100%); - overflow-y: auto; - - &:not(:last-child) { - margin-right: 4rem; - } - } - - .documentWrapperContainer::-webkit-scrollbar { - display: none; - } - - .docmapWrapper { - height: calc(100lvh - $document-padding); - padding: 10px $padding-md 80px $padding-md; - width: 25%; - overflow-y: auto; - } - - .docmapWrapper::-webkit-scrollbar { - display: none; - } - - .playgroundWrapper { - height: 100%; - width: 100%; - overflow-y: auto; - } - - .pb-10 { - padding-bottom: 10px; - } - - // TODO : improve all this to use flex - .restApiWrapper { - width: 100%; - height: 100lvh; - overflow: hidden; - - iframe { - // for back button - height: calc(100% - 45px); - border: none; - } - } - - // in case header is loaded - .withHeaderFooter .restApiWrapper { - height: 100%; - } - - button { - cursor: pointer; - } - - .widthAuto { - width: auto; - img { - width: auto; - max-width: 100%; - } - } - - .bordered img { - border: 1px solid var(--border-color); - } - - .displayNone { - display: none; - } - - .icon { - color: var(--icon-color); - } - - /*Tags style start*/ - - .video { - width: 800px; - height: 600px; - } - - .tag { - border-radius: $tag-border-radius; - display: inline-block; - font-size: $tag-font-size !important; - font-weight: $tag-font-weight !important; - height: $tag-height; - line-height: $tag-line-height !important; - margin-right: $tag-margin-right; - text-align: center; - min-width: $tag-width; - padding: $tag-padding; - color: $tag-font-color; - } - .tag.tick { - border-radius: $tag-border-radius; - display: inline-flex; - font-size: 13px !important; - font-weight: $tag-font-weight !important; - height: 18px; - margin-right: $tag-margin-right; - align-items: center; - min-width: $tag-width; - padding: 9px 5px; - color: $tag-font-color; - } - .tag.tick.greyBackground { - background-color: #cccdcd; - color: var(--primary-color); - border-radius: $tag-border-radius; - display: inline-flex; - font-size: 13px !important; - font-weight: $tag-font-weight !important; - min-height: 16px; - margin-right: $tag-margin-right; - align-items: center; - padding: 9px 5px; - } - - .version { - display: inline-block; - font-size: $font-size-small; - height: 25px; - line-height: $line-height-doc; - text-align: center; - margin: 2px; - min-width: $tag-width; - padding: $tag-padding; - color: var(--primary-color); - border: solid 1px; - border-color: $disabledcolor; - } - - .version-badge { - border-radius: $tag-border-radius; - display: inline-flex; - align-items: center; - font-size: 14px; - font-weight: 600; - padding: $tag-padding; - margin: 2px; - text-align: center; - vertical-align: middle; - height: 25px; - line-height: $line-height-doc; - text-align: center; - margin: 2px; - min-width: $tag-width; - padding: $tag-padding; - } - - .version-badge.breaking { - background-color: #d32f2f; - color: #ffffff; - } - - .version-badge.new { - background-color: #2e7d32; - color: #ffffff; - } - - .version-badge.deprecated { - background-color: #d32f2f; - color: #f1f4f8; - } - - .version-badge.fixed { - background-color: #1565c0; - color: #ffffff; - } - - .deprecated { - display: inline-block; - font-size: 14px; - height: 25px; - line-height: $line-height-doc; - text-align: center; - margin: 2px; - min-width: $tag-width; - padding: $tag-padding; - color: var(--primary-color); - border: solid 1px #fea85f; - } - - - .definedInTag { - font-size: $font-size-small; - line-height: 8pt; - margin: 0; - color: $darkgrey; - a { - color: $darkgrey; - } - } - - - .beta { - border-radius: $beta-border-radius; - display: inline-flex; - display: inline-flex; - font-size: 13px; - font-weight: $font-weight-normal; - height: 22px; - min-width: $tag-width; - padding: $beta-padding; - color: $tag-font-color; - margin: -3px 3px 3px; - justify-content: center; - align-items: center; - } - - .earlyAccess { - border-radius: $beta-border-radius; - display: inline-flex; - font-size: 11px; - display: inline-flex; - font-size: 11px; - font-weight: $font-weight-normal; - height: 22px; - min-width: $tag-width; - padding: $beta-padding; - color: $tag-font-color; - margin: -3px 3px 3px; - justify-content: center; - align-items: center; - } - - .blueBackground { - background-color: $note-color; - } - - .purpleBackground { - background-color: #8c62f5; - } - - .redBackground { - background-color: $important-color; - } - - .greenBackground { - background-color: $tip-color; - } - - .greyBackground { - background-color: #eaedf2; - } - - .greyDarkBackground { - background-color: #a5acb9; - } - - .orangeBackground { - background-color: $warning-color; - } - - .yellowBackground { - background-color: $tag-color-yellow; - } - - .noBackground { - background-color: $tag-color-white; - } - - .lightBackground { - background-color: $tag-color-light; - } - - .betaBackground { - background-color: #06bf7f; - } - - .eaBackground { - background-color: #8c62f5; - } - - /*Tags style end*/ - - /* Div box style start */ - - .announcementBlock { - border: 0.5px solid $disabledcolor; - font-color: var(--announcement-font-color); - border-radius: 10px; - height: auto; - width: 100%; - padding: 0 $padding-md $padding-md $padding-md; - background-color: var(--announcement-block-color); - } - - .boxDiv { - padding: 15px; - display: flex; - flex-direction: column; - justify-content: space-between; - margin: 10px; - border-radius: 6px; - border: 1px solid $lightgrey; - - &:hover { - box-shadow: var(--box-shadow-hover); - } - } - - .typeDoc { - padding: 15px; - display: inline-block; - margin-left: 0; - margin: 10px 10px 10px 0; - width: 100%; - box-shadow: var(--box-shadow); - border-top: 2px solid #d3d3d3; - border-radius: 0; - } - - .codeTypeDoc { - font-color: #188038; - } - - .parameter { - font-size: $font-size-doc; - font-weight: bold; - line-height: 14pt; - margin: 0; - color: var(--primary-color); - } - - .container { - margin: 0 0 30px 0; - padding: 0px; - width: auto; - } - - .homeHeader { - display: inline-block; - padding: 5px; - width: 100%; - margin: 0; - vertical-align: top; - } - - .homeHeaderText { - display: inline-block; - padding: 5px 5px 5px 20px; - width: 600px; - max-width: 33%; - margin: 0; - vertical-align: top; - } - - .homeBullet { - border-radius: 25pt; - display: inline-block; - font-size: 16px; - font-weight: $font-weight-bold; - line-height: $tag-line-height !important; - margin-right: $tag-margin-right; - text-align: center; - min-width: auto; - padding: 0 8px 0 8px; - color: $darkblue; - } - - .blockHome { - border-top: 0.5px solid var(--border-color); - border-bottom: 0.5px solid var(--border-color); - margin: 20px 10px 5px 10px; - } - - .blockHomeContent { - padding: 15px; - display: inline-block; - margin: 10px; - } - - .boxHalfWidth { - display: flex; - padding: 15px; - flex-direction: column; - justify-content: space-between; - height: 225px; - max-height: 500px; - width: auto; - max-width: 500px; - margin: 10px; - box-shadow: var(--box-shadow); - border-radius: 10px; - &:hover { - box-shadow: var(--box-shadow-hover); - } - } - .definedInTag { - color: gray; - a { - color: gray; - } - } - - .boxFullWidth { - width: 100%; - box-shadow: var(--box-shadow); - border: 1px solid var(--border-color); - margin: 10px; - padding: 15px; - overflow: scroll; - } - - .divider { - border-bottom: 0.5px solid var(--border-color); - display: block; - width: 100%; - margin: 5px auto; - } - - .typeDocBlock { - width: 100%; - box-shadow: var(--box-shadow); - border: 0.5px solid var(--border-color); - margin: 10px; - padding: 15px; - border-radius: 10px; - } - - .boxBody { - font-size: 13px; - font-weight: $font-weight-normal; - line-height: 18pt; - color: var(--primary-color); - padding: 5px; - } - - .introList { - font-size: 13px; - font-weight: $font-weight-normal; - line-height: 18pt; - color: var(--primary-color); - padding: 5px 5px $padding-md 5px; - overflow: auto; - } - - .boxAuto { - border: 0.5px solid $disabledcolor; - height: auto; - width: 100%; - padding: 0 0 0 2px; - } - - .tableContainer { - border: 0.5px solid $disabledcolor; - padding: 0 0 0 5px; - overflow-x: auto; - } - - .tableStyle1 { - border: none !important; - padding: 0 !important; - td { - border: none !important; - - .tag { - margin: 5px 5px 5px 0; - } - } - } - - .admonitionblock.note { - border-left: 5px solid var(--var-note-color); - td.content { - border: none !important; - border-radius: 0 !important; - box-shadow: none !important; - } - td.icon { - left: 20px !important; - top: 5px !important; - } - } - .admonitionblock.important { - border-left: 5px solid var(--var-important-color); - td.content { - border: none !important; - border-radius: 0 !important; - box-shadow: none !important; - } - td.icon { - left: 20px !important; - top: 5px !important; - } - } - .admonitionblock.warning { - border-left: 5px solid var(--var-important-color); - td.content { - border: none !important; - border-radius: 0 !important; - box-shadow: none !important; - } - td.icon { - left: 20px !important; - top: 5px !important; - } - } - - .videoContainer { - border-radius: 10px; - overflow-x: auto; - width: 100%; - box-shadow: var(--box-shadow); - border: 2px solid var(--border-color); - margin: 10px; - padding: 15px; - } - - summary.title { - font-size: $font-size-summ-title; - margin-top: $margin-sm; - margin-left: 3px; - font-weight: $font-weight-normal; - line-height: $line-height-doc; - color: var(--primary-color); - } - - .introTile { - padding: $padding-md; - display: inline-block; - margin: 1px; - width: 100%; - box-shadow: var(--box-shadow); - border-top: 0.5px solid $lightgrey; - height: 700px; - border-radius: 10px; - &:hover { - box-shadow: var(--box-shadow-hover); - } - } - - .cardHead { - border-bottom: 1px solid var(--border-color); - text-align: center; - color: var(--primary-color); - font-size: $font-size-h5; - margin: auto; - padding: 10px; - font-weight: $font-weight-bold; - } - - .cardBlockHeading { - margin-top: $margin-lg; - padding-bottom: $padding-sm; - border-bottom: 1px solid var(--border-color); - font-size: 26px; - font-weight: $font-weight-bold; - text-align: center; - } - - a.anchor { - position: absolute; - text-decoration: none; - width: 1.75ex; - margin-left: -1.5ex; - visibility: hidden; - font-size: 0.8em; - font-weight: 400; - } - - .introCard { - padding: 15px; - display: inline-block; - position: relative; - height: 225px; - max-height: 500px; - width: 300px; - max-width: 400px; - margin: 10px; - box-shadow: var(--box-shadow); - border-radius: 10px; - &:hover { - box-shadow: var(--box-shadow-hover); - } - } - - /* Div box style end */ - - /*Scrollbar styling start*/ - ::-webkit-scrollbar { - width: 0.2em; - } - - ::-webkit-scrollbar { - height: 0.4em; - } - - ::-webkit-scrollbar-track { - -webkit-box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.1); - border-radius: 10px; - } - - ::-webkit-scrollbar-thumb { - background-color: var(--scrollbar-color); - outline: none; - border-radius: 4px; - } - - .documentBody { - width: 100%; - height: 100%; - overflow-x: auto; - } - - @media screen and (min-width: 1024px) and (max-width: 1300px) { - .docmapWrapper { - width: 35%; - } - } - - @media screen and (min-width: $tablet-resolution-min) and (max-width: $tablet-resolution-max) { - .docmapWrapper { - display: none; - } - } - - @media screen and (max-width: $tablet-resolution-max) { - .docmapWrapper { - display: none; - } - } - - /* Scrollbar styling end*/ - @media screen and (min-width: 767px) and (max-width: 1024px) { - .homeBanner { - display: none; - } - - .homeHeader { - width: 100%; - max-width: 100%; - } - - .documentWrapperContainer { - width: 100%; - - &:not(:last-child) { - margin-right: 0px; - } - } - .homeHeaderText { - width: 100%; - max-width: 100%; - } - .homeHeader { - width: 100%; - } - .introTile { - height: 100%; - margin: 10px; - } - .boxBody { - font-size: 12px; - } - } - - @media screen and (max-width: $tablet-resolution-min) { - .documentWrapperContainer { - width: 100%; - overflow-x: auto; - - &:not(:last-child) { - margin-right: 0px; - } - - pre { - overflow-x: auto; - } - } - } - - @media screen and (max-width: $mobile-resolution-max) { - .documentWrapperContainer { - width: 100%; - overflow-x: auto; - - &:not(:last-child) { - margin-right: 0px; - } - - pre { - overflow-x: auto; - } - } - } - - .leftNavContainer { - height: -webkit-fill-available; - } - - @media screen and (max-width: $mobile-resolution-max) { - .homeBanner { - display: none; - } - - .homeHeader { - width: 100%; - max-width: 100%; - } - - .blockHome { - border: 0; - } - - .containerWrapper { - padding: 10px 10px 10px 12px; - } - - .documentBody { - padding-left: 0; - padding-right: 0; - } - - .homeHeaderText { - width: 100%; - max-width: 100%; - border-top: 0.5px solid var(--border-color); - } - - .blockHome { - border: 0; - } - - .introCard { - width: 100%; - } - - .boxDiv { - width: 100%; - } - - .boxHalfWidth { - width: 100%; - } - - .introTile { - height: 100%; - margin: 5px; - } - .tableContainer { - overflow: scroll; - } - .leftNavContainer { - margin-top: 0px; - height: auto; - } - } - - @media screen and (max-width: $mobile-resolution-max) { - main { - flex-direction: column; - } - } - - .searchResultHighlightColor { - color: var(--secondary-color); - } - - /* typedoc styles*/ - - .typedoc-Enumeration, - .typedoc-Enumeration_member, - .typedoc-Class, - .typedoc-Class_member, - .typedoc-Interface, - .typedoc-Interface_member, - .typedoc-Type_alias, - .typedoc-Constructor, - .typedoc-Method, - .typedoc-Property, - .typedoc-Function { - :before { - content: ''; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(../icons/icons.png); - } - a { - word-wrap: break-word; - white-space: nowrap; - } - } - - .typedoc-Enumeration { - a { - color: #bf982a; - } - :before { - background-position: 0px -136px; - background-image: url(../icons/icons.png); - } - } - - .typedoc-Enumeration_member { - a { - color: #937210; - } - :before { - background-position: 0px -136px; - background-image: url(../icons/icons.png); - } - } - - .typedoc-Constructor { - a { - color: #0672de; - } - :before { - background-position: -51px -102px; - background-image: url(../icons/icons.png); - } - } - - .typedoc-Method { - a { - color: #0672de; - } - :before { - background-position: -68px -68px; - background-image: url(../icons/icons.png); - } - } - - .typedoc-Property { - a { - color: #647f1b; - } - :before { - background-position: -221px 0px; - background-image: url(../icons/icons.png); - } - } - - .typedoc-signature { - a { - color: #937210; - } - :before { - background-position: 0px -153px; - } - } - - .typedoc-Class { - a { - color: #0550ae; - } - :before { - background-position: 0px -34px; - } - } - - .typedoc-Class_member { - a { - color: #0550ae; - } - :before { - background-position: -51px -102px; - } - } - - .typedoc-Interface { - a { - color: #647f1b; - } - :before { - background-position: 0px -68px; - display: inline-block; - background-image: url(../icons/icons.png); - } - } - - .typedoc-Type_alias { - a { - color: rgb(144, 10, 227); - } - :before { - background-position: 0px -170px; - } - } - - .typedoc-Function { - a { - color: rgb(144, 10, 227); - } - :before { - background-position: -136px -68px; - } - } - .header-banner { - min-height: 259px; - background-color: var(--header-background-color); - color: var(--header-primary-color); - padding: 40px 0 0 40px; - - .header-banner-text { - display: flex; - flex-direction: column; - width: 60%; - h1 { - font-size: $font-size-large; - font-weight: $font-weight-normal; - margin: 0; - color: var(--header-primary-color); - } - h5 { - font-size: $font-size-h5; - color: var(--header-primary-color); - font-weight: $font-weight-normal; - line-height: 24px; - letter-spacing: -0.064px; - } - } - } - - .document-body-wrapper { - padding: 30px; - } - .searchInputBanner { - padding: 20px 0; - .searchIcon { - left: 25px; - height: 20px; - width: 20px; - bottom: 8px; - color: var(--border-color); - } - .searchInputContainer { - width: 50%; - margin-left: -20px; - } - .search-input-banner { - width: 100%; - border-bottom: 1px solid var(--body-background-color); - height: 40px; - padding-left: 36px; - font-size: 18px; - color: var(--border-color); - cursor: text; - } - } - .flex { - display: flex; - flex-wrap: wrap; - } - - /* ── Changelog two-column table layout ───────────────────────────────────── - Usage in AsciiDoc: - [.cl-table, cols="1,4", frame=none, grid=none] - |=== - a| left cell (label) a| right cell (content) - |=== - The .cl-label role on a paragraph in the left cell applies brand color. - ── */ - - .documentView table.tableblock.cl-table { - width: 100%; - border-spacing: 0; - border-collapse: collapse; - - - /* reset borders applied by the generic table rule */ - th, - td { - border-bottom: none; - border-top: none; - } - - tbody tr { - - &:first-child { - border-top: 1px solid var(--border-color);; - - } - } - - /* left label cell */ - td.tableblock:first-child { - padding: 28px 36px 28px 0; - vertical-align: top; - - - /* sticky label: stays pinned while the right cell's content scrolls */ - > .content { - position: sticky; - top: 80px; - } - } - - /* right content cell — can hold any number of headings and blocks */ - td.tableblock:last-child { - padding: 28px 0; - vertical-align: top; - - /* first element sits flush with the top of the label */ - > .content > *:first-child { - margin-top: 0; - } - } - - /* optional .cl-label role on a paragraph in the left cell */ - .cl-label p { - display: inline-block; - border: 1px solid var(--rel-notes-pill-border); - background-color: var(--rel-notes-tag-bg-color); - color: var(--rel-notes-tag-text); - font-size: 14px; - font-weight: 350; - border-radius: $tag-border-radius; - padding: 6px 16px; - line-height: 1.4; - margin: 0; - } - } - - /* mobile: stack columns */ - @media screen and (max-width: $mobile-resolution-max) { - .documentView table.tableblock.cl-table { - display: block; - - tbody, - tr { - display: block; - } - - td.tableblock:first-child, - td.tableblock:last-child { - display: block; - padding: 0; - white-space: normal; - } - - td.tableblock:first-child { - padding-bottom: 8px; - } - - tbody tr { - padding: 20px 0; - } - } - } - - /* ── Release notes two-column timeline layout ─────────────────────────────── - Usage in AsciiDoc: - == Month Year ← h2 month section divider - [.release-meta] - 2026-04-15 [tag greenBackground]#Category# ← date + tag(s) → left column (sticky) - === Feature title ← h3 → right column - Body content... ← right column content - Writers add [.release-meta] before each === entry. Everything else is - standard AsciiDoc. No React changes required. - ── */ - - /* ── Date/tag text styling (applies at all breakpoints) ── */ - .documentView .sect1 .sectionbody > .paragraph.release-meta p { - font-size: 16px; - font-weight: 500; - color: var(--rel-notes-tag-text); - display: flex; - flex-direction: column; - align-items: flex-start; - gap: 6px; - margin: 0; - flex-wrap: wrap; - } - - /* ── Two-column grid layout ── */ - .documentView .sect1:has(.paragraph.release-meta) { - /* Month header (h2) stays above the grid — it's outside .sectionbody */ - - .sectionbody { - display: grid; - grid-template-columns: 190px 1fr; - column-gap: 40px; - align-items: start; - } - - /* Left column: date + tags — sticky while right column scrolls */ - .sectionbody > .paragraph.release-meta { - position: sticky; - top: 80px; - align-self: start; - margin: 0; - padding-top: 28px; - border-top: 1px solid var(--border-color); - - /* first entry has no top border */ - &:first-child { - padding: 10px 5px 5px 10px; - background-color: var(--rel-notes-tag-bg-color); - color: var(--rel-notes-tag-text); - font-weight: 400; - border-radius: 25px; - border-top: none; - } - } - - /* Right column: feature content */ - .sectionbody > .sect2 { - padding-top: 28px; - border-top: 1px solid var(--border-color); - - /* h3 sits flush against the top of its grid cell */ - > h3, - > h3.linkable-header { - margin-top: 0; - } - } - - /* first right-column cell matches the first left-column cell: no border */ - .sectionbody > .paragraph.release-meta:first-child + .sect2 { - border-top: none; - padding-top: 0; - } - } - - /* ── Mobile: revert to single column ── */ - @media screen and (max-width: $mobile-resolution-max) { - .documentView .sect1:has(.paragraph.release-meta) { - .sectionbody { - display: block; - } - - .sectionbody > .paragraph.release-meta { - position: static; - margin-top: 24px; - padding-top: 24px; - border-top: 1px solid var(--border-color); - - &:first-child { - margin-top: 0; - padding-top: 0; - border-top: none; - } - } - - .sectionbody > .sect2 { - border-top: none; - padding-top: 0; - } - } - } +} diff --git a/src/assets/styles/variables.scss b/src/assets/styles/variables.scss index 18b1567b7..ed68be159 100644 --- a/src/assets/styles/variables.scss +++ b/src/assets/styles/variables.scss @@ -1,4 +1,15 @@ $gutter: 0; + +/* ThoughtSpot brand palette */ +$ts-black: #000000; +$ts-grey: #f1f4f8; +$ts-blue: #0568fa; +$ts-navy: #012676; +$ts-cyan: #74daff; +$ts-teal: #6dbec4; +$ts-purple: #dcadff; +$ts-yellow: #fcde18; + /*Colors*/ $gray-80: #323946; $white: #fff; @@ -6,7 +17,7 @@ $darkblue: #2770ef; $secondarycolor: #2770ef; $lightgrey: #eaedf2; $darkgrey: #777e8b; -$hovercolor: rgba(113, 161, 244, 0.12); +$hovercolor: rgba(5, 104, 250, 0.1); $text-container-background: rgba(192, 198, 207, 0.12); $disabledcolor: #a5acb9; $result-container-max-height: 320px; @@ -29,10 +40,11 @@ $header-zIndex: 10; $header-logo-width: 273px; $header-link-margin: 45px; $font-weight-normal: 300; +$font-weight-heading: 460; $font-weight-bold: 600; $line-height-normal: 31px; $line-height-button: 16px; -$line-height-doc: 1.6rem; +$line-height-doc: 1.75rem; $line-height-result-title: 20px; $line-height-result-footer: 18px; $font-size-x-small: 11px; @@ -41,9 +53,10 @@ $font-size-home: 13px; $font-size-normal: 14px; $font-size-table: 14px; $font-size-doc: 14px; +$font-size-sidebar: 14px; $font-size-code: 13px; -$line-height-code: 1.4rem; -$font-size-large: 36px; +$line-height-code: 1.5rem; +$font-size-large: 30px; $font-size-404: 1.25rem; $padding-md: 24px; $margin-lg: 35px; @@ -55,7 +68,7 @@ $padding-sm: 10px; $padding-lg: 28px; $document-margin-top: 88px; $document-padding: 20px; -$padding-nested-ul: 20px; +$padding-nested-ul: 5px; $margin-links: 12px; $docmap-width-desktop: 250px; $docmap-width-tablet: 180px; @@ -85,12 +98,13 @@ $arrow-icon-width: 12px; $title-margin: 10px; $sub-title-margin: 30px; $sub-title-margin-h5: 10px; -$font-size-h2: 26px; -$font-size-h3: 23px; +$font-size-h1: 30px; +$font-size-h2: 25px; +$font-size-h3: 22px; $font-size-h4: 20px; $font-size-h5: 16px; $font-size-summ-title: 17px; -$font-size-breadcrums: 13px; +$font-size-breadcrums: 12px; $font-size-breadcrums-mobile: 10px; $icon-width: 30px; $icon-height: 30px; @@ -127,6 +141,7 @@ $important-on-color: $color-white; $note-on-color: $color-white; $tip-on-color: $color-white; $panel-background: $color-smoke-30; + /* fonts */ $rem-base: 18; $body-font-size-desktop: 1.125em; /* 18px */ @@ -143,6 +158,7 @@ $admonition-font-factor-p: 16; $admonition-content-line-height: 24px; $admonition-font-factor-pre: 15; + /*Tag variables*/ $beta-border-radius: 6px; $beta-padding: 4.5px 5px 3px 5px; @@ -160,32 +176,58 @@ $tag-color-white: var(--body-background-color); $tag-color-light: $lightgrey; :root { + /* Brand tokens */ + --ts-black: #000000; + --ts-grey: #f1f4f8; + --ts-blue: #0568fa; + --ts-navy: #012676; + --ts-cyan: #74daff; + --ts-teal: #6dbec4; + --ts-purple: #dcadff; + --ts-yellow: #fcde18; + --body-background-color: #fff; --primary-color: #1d232f; --header-primary-color: #fff; - --header-color: #000000; - --header-border-color: #000000; - --header-link-color: #404040; - --nav-bar-color: #f6f8fa; + --header-color: #08062B; + --header-border-color: #08072C; + --header-link-color: rgba(255, 255, 255, 0.85); + --nav-bar-color: #08062B; + --left-nav-color: #fff; + --header-banner-background: linear-gradient(180deg, #08062B, #122246, #122246); + --panel-bg-color: #f1f4f8; + --secondary-header-bg: #08062B; + --secondary-header-border: #323946; + --secondary-header-text: #f1f4f8; + --secondary-header-active: #0568fa; --rel-notes-tag-bg-color: #dce5f9; --rel-notes-tag-text: #0568fa; - --rel-notes-pill-border: #aac2f8; + --rel-notes-pill-border: #aac2f8; --breadcrums-font-color: #5f6368; + --docmap-border-color: #d9d9d9; + --border-color-home-search: #a5acb9; --announcement-block-color: #e1e1e1; - --admonition-background: #fff; - --code-block-color: #283142; - --code-text-color: #eceff1; + --announcement-text-color: #1d232f; + --admonition-background: #f1f4f8; + --code-block-color: #0d1117; + --code-block-light: #f6f8fa; + --code-text-color: #e6edf3; --code-text-bg: #f6f8fa; - --side-nav-text: #404040; - --text-color-code-lang: #999; - --icon-color: #999; + --side-nav-text: #374151; + --sidebar-title: #393939; + --side-nav-active-bg: rgba(5, 104, 250, 0.08); + --side-nav-active-text: #0568fa; + --text-color-code-lang: #fff; + --icon-color: #6b7280; --back-button-color: #1d232f; --back-button-background: #eaedf2; - --block-background: #eaedf2; - --border-color: #d9d9d9; + --block-background: #f1f4f8; + --search-border-color: #cccdcd; + --border-color: #eaedf2; --table-header-color: #fff; - --border-color-tr: #cccdcd; + --border-color-tr: #e5e7eb; --scrollbar-color: #a5acb9; + --docmap-scrollbar-color: #0568fa; --color-jet-70: #d14; --highlight-purple: #9334e6; --highlight-green: #188038; @@ -198,64 +240,103 @@ $tag-color-light: $lightgrey; --highlight-darkred: #900; --highlight-lilac: #d7aefb; --highlight-violet: #990073; - --secondary-color: #2770ef; - --header-background-color: #1d232f; - --var-note-color: #1d232f; - --var-important-color: #E22B3D; - --var-docmap-nested-color: #777E8B; - --box-shadow: 0 2px 2px 0 rgba(0, 0, 0, 12%), 0 0px 6px 0 rgba(0, 0, 0, 11%); - --box-shadow-hover: 0 16px 20px 0 rgba(0, 0, 0, 12%), - 0 16px 20px 0 rgba(0, 0, 0, 12%); + --secondary-color: #393939; + --link-text-color: #0568fa; + --header-background-color: #012676; + --var-note-color: #0568fa; + --note-block-color: #eef7ff; + --note-border-color: #7492d5; + --var-important-color: #e22b3d; + --important-border-color: #cccdcd; + --important-block-color: #f1f4f8; + --var-docmap-nested-color: #6b7280; + --box-shadow: 0 1px 3px 0 rgba(0, 0, 0, 0.1), 0 1px 2px 0 rgba(0, 0, 0, 0.06); + --box-shadow-hover: 0 4px 6px -1px rgba(0, 0, 0, 0.1), + 0 2px 4px -1px rgba(0, 0, 0, 0.06); + --sidebar-connector-color: #d1d5db; + --copy-btn-bg: #f3f4f6; + --copy-btn-hover: #e5e7eb; + --was-helpful-bg: #f9fafb; + --was-helpful-border: #e5e7eb; } #wrapper[data-theme='dark'], #docsModal[data-theme='dark'] { - --body-background-color: #21252c; - --header-color: #323946; - --header-border-color: #777e8b; + + --body-background-color: #161b22; + --header-color: #0d1117; + --header-border-color: #cccdcd; + --header-link-color: rgba(255, 255, 255, 0.85); + --nav-bar-color: #0d1117; + --left-nav-color: #161b22; + --panel-bg-color: #0d1117; + --secondary-header-bg: #0d1117; + --secondary-header-border: #393939; + --secondary-header-text: #c9d1d9; + --secondary-header-active: #0086b3; + --primary-color: #cccdcd; + --header-primary-color: #cccdcd; + --header-banner-background: linear-gradient(180deg, #0d1117, #1B3E61); + --breadcrums-font-color: #8b949e; + --docmap-border-color: #30363d; --rel-notes-tag-bg-color: #232F43; --rel-notes-tag-text: #fff; --rel-notes-pill-border: #74daff; - --header-link-color: #1d232f; - --nav-bar-color: #21252c; - --primary-color: #e8eaed; - --header-primary-color: #1d232f; - --breadcrums-font-color: #a5acb9; --announcement-block-color: #3c4356; - --admonition-background: #3c4356; - --code-block-color: #3c4356; - --code-text-bg: #3c4356; - --code-text-color: #fff; - --side-nav-text: #fff; - --text-color-code-lang: #fff; - --icon-color: #fff; - --back-button-color: #fff; - --table-header-color: #3c4356; - --back-button-background: #a4abb8; - --block-background: none; - --border-color: #e8eaed; - --border-color-tr: #3c4356; - --scrollbar-color: #3c4356; - --color-jet-70: #e18114; - --highlight-purple: #40c4ff; - --highlight-green: aquamarine; - --highlight-lightgreen: #009926; - --highlight-lightblue: #90caf9; + --announcement-text-color: #e6edf3; + --admonition-background: #161b22; + --code-block-color:#1e2430; + --code-block-light: #21262d; + --code-text-bg: #21262d; + --code-text-color: #e6edf3; + --sidebar-title: #5f6368; + --side-nav-text: #c9d1d9; + --side-nav-active-bg: rgba(116, 218, 255, 0.12); + --side-nav-active-text: #74daff; + --text-color-code-lang: #8b949e; + --icon-color: #8b949e; + --back-button-color: #e6edf3; + --table-header-color: #21262d; + --back-button-background: #21262d; + --block-background: #161b22; + --border-color: #30363d; + --search-border-color: #30363d; + --border-color-home-search: #a5acb9; + --border-color-tr: #21262d; + --scrollbar-color: #30363d; + --color-jet-70: #ffa657; + --highlight-purple: #d2a8ff; + --highlight-green: #3fb950; + --highlight-lightgreen: #56d364; + --highlight-lightblue: #79c0ff; --highlight-darkblue: #9fa8da; --highlight-blue: #c5cae9; - --highlight-darkred: #ef9a9a; - --highlight-lilac: #8388fe; + --highlight-darkred: #ffa198; + --highlight-lilac: #b083f0; --highlight-violet: #f8bbd0; - --secondary-color: #8388fe; - --header-background-color: #787e8d; - --var-note-color: #e8eaed; - --var-important-color: #E22B3D; - --var-docmap-nested-color: #777e8b; + --secondary-color: #74daff; + --link-text-color: #74daff; + --header-background-color: #012676; + --var-note-color: #74daff; + --note-block-color: #1e2430; + --note-border-color: #74daff; + --var-important-color: #e22b3d; + --var-important-border-color: #1e2430; + --important-block-color: #1e2430; + --var-docmap-nested-color: #8b949e; + --sidebar-connector-color: #30363d; + --copy-btn-bg: #21262d; + --copy-btn-hover: #30363d; + --was-helpful-bg: #161b22; + --was-helpful-border: #30363d; + + --box-shadow: 0 1px 3px 0 rgba(0, 0, 0, 0.4), 0 1px 2px 0 rgba(0, 0, 0, 0.3); + --box-shadow-hover: 0 4px 6px -1px rgba(0, 0, 0, 0.4), + 0 2px 4px -1px rgba(0, 0, 0, 0.3); - --box-shadow: 0 2px 2px 0 rgba(255, 255, 255, 12%), - 0 0px 6px 0 rgba(255, 255, 255, 11%); - --box-shadow-hover: 0 16px 20px 0 rgb(255 255 255 / 6%), - 0 16px 20px 0 rgb(255 255 255 / 6%); + .header-banner { + box-shadow: none; + } } -$header-height: 65px; +$header-height: 60px; diff --git a/src/components/AnnouncementBanner/index.scss b/src/components/AnnouncementBanner/index.scss index bff42281f..febd9aebb 100644 --- a/src/components/AnnouncementBanner/index.scss +++ b/src/components/AnnouncementBanner/index.scss @@ -1,38 +1,84 @@ +@import '../../assets/styles/variables.scss'; + .announcementBanner { width: 100%; - border-bottom: 1px solid var(--border-color); - background: #dce5f9; - color: var(--primary-color); + background: linear-gradient(180deg,#36658e,#1b3258); + color: #1a3a5c; + + .announcementBanner__content { + color: #fff; + padding: 5px 0 5px 0; + } + + .announcementBanner__link { + color: #fff; + font-weight: 400; + text-decoration: underline; + } + + .announcementBanner__close { + color: #fff; + opacity: 0.7; + + &:hover { + opacity: 1; + } + } } .announcementBanner__inner { display: flex; - gap: 12px; align-items: center; justify-content: center; - padding-top: 10px; - padding-bottom: 10px; + gap: 12px; + padding-top: 9px; + padding-bottom: 9px; + position: relative; } .announcementBanner__content { font-size: 15px; - line-height: 21px; + line-height: 20px; text-align: center; flex: 1 1 auto; - font-weight: 500; - color: #4b5563; + font-weight: 400; } .announcementBanner__link { - color: #1a73e8; - text-decoration: underline; font-size: 15px; + font-weight: 400; +} + +.announcementBanner__close { + display: flex; + align-items: center; + justify-content: center; + background: transparent; + border: none; + cursor: pointer; + padding: 4px; + margin-right: 20px; + border-radius: 4px; + flex-shrink: 0; + transition: background 0.15s ease; + + &:hover { + background: rgba(0, 0, 0, 0.1); + } + + .close-icon { + width: 22px; + height: 22px; + } } @media screen and (max-width: 767px) { .announcementBanner__inner { - flex-direction: column; - align-items: flex-start; + flex-direction: row; + align-items: center; } -} + .announcementBanner__content { + text-align: left; + } +} diff --git a/src/components/AnnouncementBanner/index.tsx b/src/components/AnnouncementBanner/index.tsx index e88c22e38..08018477c 100644 --- a/src/components/AnnouncementBanner/index.tsx +++ b/src/components/AnnouncementBanner/index.tsx @@ -1,24 +1,54 @@ -import React from 'react'; +import React, { useState, useEffect } from 'react'; +import { MdClose } from '@react-icons/all-files/md/MdClose'; +import { IconContext } from '@react-icons/all-files'; import './index.scss'; +type BannerVariant = 'release' | 'info'; + type AnnouncementBannerProps = { enabled?: boolean; message: React.ReactNode; + variant?: BannerVariant; + dismissKey?: string; }; const AnnouncementBanner = (props: AnnouncementBannerProps) => { - const { enabled = true, message } = props; + const { enabled = true, message, variant = 'release', dismissKey = 'announcement-banner' } = props; + const [dismissed, setDismissed] = useState(false); + + useEffect(() => { + const isDismissed = sessionStorage.getItem(dismissKey) === 'dismissed'; + setDismissed(isDismissed); + }, [dismissKey]); - if (!enabled) return null; + const handleDismiss = () => { + sessionStorage.setItem(dismissKey, 'dismissed'); + setDismissed(true); + }; + + if (!enabled || dismissed) return null; return ( -
+
{message}
+
); }; export default AnnouncementBanner; - diff --git a/src/components/Breadcrums/index.scss b/src/components/Breadcrums/index.scss index c053c5d89..52de02678 100644 --- a/src/components/Breadcrums/index.scss +++ b/src/components/Breadcrums/index.scss @@ -1,7 +1,7 @@ @import '../../assets/styles/variables.scss'; .breadcrumsWrapper { - padding: 20px 0 20px; + padding: 10px 0 25px; .breadcrumb { margin: 0; diff --git a/src/components/CopyPageDropdown/index.scss b/src/components/CopyPageDropdown/index.scss new file mode 100644 index 000000000..cda100ace --- /dev/null +++ b/src/components/CopyPageDropdown/index.scss @@ -0,0 +1,146 @@ +@import '../../assets/styles/variables.scss'; + +.copy-page-dropdown { + position: relative; + display: inline-block; + + &__trigger { + display: inline-flex; + align-items: center; + gap: 6px; + padding: 6px 12px; + font-size: 14px; + font-weight: 500; + color: var(--primary-color); + background: var(--body-background-color); + border: 1px solid #cccdcd; + border-radius: 6px; + cursor: pointer; + font-family: 'Optimo-Plain', sans-serif; + transition: all 0.15s ease; + white-space: nowrap; + + &:hover { + border-color: var(--secondary-color, #0568fa); + color: var(--secondary-color, #0568fa); + } + + &.copied { + color: #16a34a; + border-color: #16a34a; + } + + .copy-page-icon { + width: 14px; + height: 14px; + } + + .copy-chevron { + width: 13px; + height: 13px; + transition: transform 0.15s ease; + } + + &[aria-expanded='true'] .copy-chevron { + transform: rotate(180deg); + } + + .copy-page-dropdown__trigger-divider { + width: 1px; + align-self: stretch; + margin: -6px 0; + background: var(--border-color, #d1d5db); + flex-shrink: 0; + } + } + + &__menu { + position: absolute; + top: calc(100% + 6px); + right: 0; + background: var(--body-background-color); + border: 1px solid var(--border-color, #d1d5db); + border-radius: 8px; + box-shadow: 0 8px 24px rgba(0, 0, 0, 0.12); + min-width: 240px; + padding: 6px; + z-index: 50; + animation: cpDropFadeIn 0.12s ease; + } + + &__item { + display: flex; + align-items: flex-start; + gap: 10px; + width: 100%; + padding: 9px 12px; + font-size: 13px; + font-weight: 400; + color: var(--primary-color); + background: transparent; + border: none; + border-radius: 5px; + cursor: pointer; + font-family: 'Optimo-Plain', sans-serif; + text-align: left; + transition: background 0.1s ease; + + &:hover { + background: var(--block-background, #f1f4f8); + + .copy-page-dropdown__item-label { + color: var(--secondary-color, #0568fa); + } + + .menu-item-icon { + color: var(--secondary-color, #0568fa); + } + } + + .menu-item-icon { + width: 14px; + height: 14px; + color: var(--icon-color, #6b7280); + flex-shrink: 0; + margin-top: 2px; + } + } + + &__item-text { + display: flex; + flex-direction: column; + gap: 1px; + } + + &__item-label { + font-size: 13px; + font-weight: 500; + color: var(--primary-color); + line-height: 1.4; + transition: color 0.1s ease; + } + + &__item-sub { + font-size: 11.5px; + color: var(--icon-color, #6b7280); + line-height: 1.3; + font-weight: 400; + } + + &__separator { + height: 1px; + background: var(--border-color, #e5e7eb); + margin: 4px 8px; + } +} + +@keyframes cpDropFadeIn { + from { + opacity: 0; + transform: translateY(-4px); + } + to { + opacity: 1; + transform: translateY(0); + } +} diff --git a/src/components/CopyPageDropdown/index.tsx b/src/components/CopyPageDropdown/index.tsx new file mode 100644 index 000000000..a5baf2079 --- /dev/null +++ b/src/components/CopyPageDropdown/index.tsx @@ -0,0 +1,170 @@ +import React, { useState, useRef, useEffect } from 'react'; +import { IconContext } from '@react-icons/all-files'; +import { FiCopy } from '@react-icons/all-files/fi/FiCopy'; +import { FiChevronDown } from '@react-icons/all-files/fi/FiChevronDown'; +import { FiExternalLink } from '@react-icons/all-files/fi/FiExternalLink'; +import './index.scss'; + +type CopyPageDropdownProps = { + pageTitle?: string; + markdownBody?: string; +}; + +const CopyPageDropdown = (props: CopyPageDropdownProps) => { + const { pageTitle, markdownBody } = props; + const [open, setOpen] = useState(false); + const [copied, setCopied] = useState(false); + const ref = useRef(null); + + useEffect(() => { + const handleClickOutside = (e: MouseEvent) => { + if (ref.current && !ref.current.contains(e.target as Node)) { + setOpen(false); + } + }; + document.addEventListener('mousedown', handleClickOutside); + return () => document.removeEventListener('mousedown', handleClickOutside); + }, []); + + const getPageMarkdown = (): string => { + const sourceUrl = typeof window !== 'undefined' ? window.location.href : ''; + const header = sourceUrl ? `Source: ${sourceUrl}\n\n` : ''; + + /* Prefer build-time Markdown — clean headings, no chain icons */ + if (markdownBody) { + return `${header}${markdownBody}`; + } + + /* Fallback: browser scrape (used if GraphQL field is missing) */ + const title = pageTitle || (typeof document !== 'undefined' ? document.title : ''); + const contentEl = typeof document !== 'undefined' + ? (document.querySelector('.documentView') as HTMLElement) + : null; + if (!contentEl) return `# ${title}\n\n${sourceUrl}`; + + const tmp = document.createElement('div'); + tmp.innerHTML = contentEl.innerHTML; + tmp.querySelectorAll('script, style, a.anchor').forEach(el => el.remove()); + const text = (tmp.innerText || tmp.textContent || '').replace(/\n{3,}/g, '\n\n').trim(); + return `# ${title}\n\n${header}${text}`; + }; + + const handleCopyMarkdown = async () => { + try { + const md = getPageMarkdown(); + await navigator.clipboard.writeText(md); + setCopied(true); + setTimeout(() => setCopied(false), 2000); + } catch (err) { + console.warn('Clipboard write failed:', err); + } + setOpen(false); + }; + + const handleOpenInAI = (aiService: 'chatgpt' | 'claude') => { + const pageUrl = window.location.href; + const prompt = encodeURIComponent( + `Read ${pageUrl} so I can ask questions about it.` + ); + const url = aiService === 'chatgpt' + ? `https://chatgpt.com/?q=${prompt}` + : `https://claude.ai/new?q=${prompt}`; + + window.open(url, '_blank', 'noopener,noreferrer'); + setOpen(false); + }; + + const handleViewMarkdown = () => { + const md = getPageMarkdown(); + const blob = new Blob([md], { type: 'text/plain' }); + const blobUrl = URL.createObjectURL(blob); + window.open(blobUrl, '_blank'); + setTimeout(() => URL.revokeObjectURL(blobUrl), 10000); + setOpen(false); + }; + + return ( +
+ + + {open && ( +
+ + + + + + +
+ + +
+ )} +
+ ); +}; + +export default CopyPageDropdown; diff --git a/src/components/DevDocTemplate/index.tsx b/src/components/DevDocTemplate/index.tsx index c432d67b2..4edeaef04 100644 --- a/src/components/DevDocTemplate/index.tsx +++ b/src/components/DevDocTemplate/index.tsx @@ -14,6 +14,7 @@ import { Seo } from '../Seo'; import { queryStringParser, isPublicSite } from '../../utils/app-utils'; import { passThroughHandler, fetchChild } from '../../utils/doc-utils'; import Header from '../Header'; +import SecondaryHeader, { DocCategory, CATEGORY_PAGEIDS, CATEGORY_NAV_ID } from '../SecondaryHeader'; import LeftSidebar from '../LeftSidebar'; import Docmap from '../Docmap'; import Document from '../Document'; @@ -57,7 +58,7 @@ const DevDocTemplate: FC = (props) => { const { data, location, - pageContext: { namePageIdMap }, + pageContext: { namePageIdMap, navMap = {} }, } = props; const isBrowser = () => typeof window !== 'undefined'; @@ -91,9 +92,8 @@ const DevDocTemplate: FC = (props) => { const initialNavContentData = passThroughHandler(navNode.html, params); const [navContent, setNavContent] = useState(initialNavContentData || ''); - const [breadcrumsData, setBreadcrumsData] = useState( - fetchChild(initialNavContentData) || [], - ); + // breadcrumsData is derived after processedNavMap is built (see useMemo below) + const [activeCategory, setActiveCategory] = useState('guides'); const [showSearch, setShowSearch] = useState(false); const [leftNavOpen, setLeftNavOpen] = useState(false); const [keyword, updateKeyword] = useState(''); @@ -101,13 +101,47 @@ const DevDocTemplate: FC = (props) => { if (typeof window !== 'undefined') return isPublicSite(location.search); return true; }); - const checkout = - typeof window !== 'undefined' - ? localStorage.getItem('theme') === 'dark' - : null; - const [isDarkMode, setDarkMode] = useState(checkout); + const [isDarkMode, setDarkMode] = useState(() => { + if (typeof window === 'undefined') return false; + /* themeMode is only written when the user explicitly clicks the toggle. + If absent, follow OS preference fresh every load. */ + const explicitChoice = localStorage.getItem('themeMode'); + if (explicitChoice) return explicitChoice === 'dark'; + const prefersDark = window.matchMedia?.('(prefers-color-scheme: dark)').matches ?? false; + localStorage.setItem('theme', prefersDark ? 'dark' : 'light'); + return prefersDark; + }); const [key, setKey] = useState(''); + // Pre-process all category nav HTMLs once ({{navprefix}} substitution applied to each) + const processedNavMap = React.useMemo(() => + Object.fromEntries( + Object.entries(navMap as Record).map(([cat, html]) => [ + cat, + passThroughHandler(html, params) || '', + ]), + ), + // navMap is static (from pageContext); params is stable after mount + // eslint-disable-next-line react-hooks/exhaustive-deps + []); + + // Breadcrumb data built from master nav + all category navs for full coverage + const breadcrumsData = React.useMemo(() => { + if (typeof window === 'undefined') return []; + const allHtmls = [ + initialNavContentData, + ...Object.values(processedNavMap as Record), + ]; + return allHtmls.flatMap((html) => fetchChild(html)); + }, [processedNavMap]); + + // Pick the right sidebar content for the active category + const activeNavContent = React.useMemo(() => { + const navId = CATEGORY_NAV_ID[activeCategory]; + const mapKey = navId.startsWith('nav-') ? navId.slice(4) : null; + return (mapKey && processedNavMap[mapKey]) || navContent; + }, [activeCategory, processedNavMap, navContent]); + const isCustomPage = _.values(CUSTOM_PAGE_ID).some( (pageId: string) => pageId === params[TS_PAGE_ID_PARAM], ); @@ -123,6 +157,12 @@ const DevDocTemplate: FC = (props) => { version.iframeUrl === props?.pageContext?.iframeUrl, ); + // True when loaded inside a VersionIframe (outer shell sets ?_iframe=1). + // Outer shell already renders SecondaryHeader, so suppress ours to avoid duplication. + const isIframeMode = + typeof window !== 'undefined' && + new URLSearchParams(location.search).get('_iframe') === '1'; + const isGQPlayGround = params[TS_PAGE_ID_PARAM] === CUSTOM_PAGE_ID.GQ_PLAYGROUND; const isPlayGround = @@ -133,6 +173,38 @@ const DevDocTemplate: FC = (props) => { const isAskDocsPage = params[TS_PAGE_ID_PARAM] === CUSTOM_PAGE_ID.ASK_DOCS; + /* Build pageId → category map by parsing hrefs from each category's nav HTML. + * This means writers only need to update nav-*.adoc — no TypeScript changes needed. */ + const pageIdToCategoryMap = React.useMemo(() => { + if (typeof window === 'undefined') return {}; + const map: Record = {}; + Object.entries(processedNavMap).forEach(([cat, html]) => { + const doc = new DOMParser().parseFromString(html as string, 'text/html'); + doc.querySelectorAll('a[href]').forEach((a) => { + const href = a.getAttribute('href') || ''; + // hrefs are like /docs/pageid or /pageid — extract the last segment + const pageId = href.split('?')[0].split('/').filter(Boolean).pop(); + if (pageId) map[pageId] = cat as DocCategory; + }); + }); + return map; + }, [processedNavMap]); + + /* Detect active category from current page ID */ + useEffect(() => { + const currentPageId = curPageNode.pageAttributes.pageid; + // First try the auto-derived map from nav files + if (pageIdToCategoryMap[currentPageId]) { + setActiveCategory(pageIdToCategoryMap[currentPageId]); + return; + } + // Fall back to the static CATEGORY_PAGEIDS for any pages not yet in a nav file + const found = (Object.entries(CATEGORY_PAGEIDS) as [DocCategory, string[]][]).find( + ([, pageIds]) => pageIds.includes(currentPageId), + ); + if (found) setActiveCategory(found[0]); + }, [curPageNode.pageAttributes.pageid, pageIdToCategoryMap]); + useEffect(() => { // based on query params set if public site is open or not setIsPublicSiteOpen(isPublicSite(location.search)); @@ -151,7 +223,16 @@ const DevDocTemplate: FC = (props) => { useEffect(() => { if (isBrowser()) { - setDarkMode(localStorage.getItem('theme') === 'dark'); + /* Correct SSR mismatch on first hydration */ + const explicitChoice = localStorage.getItem('themeMode'); + let isDark: boolean; + if (explicitChoice) { + isDark = explicitChoice === 'dark'; + } else { + isDark = window.matchMedia?.('(prefers-color-scheme: dark)').matches ?? false; + localStorage.setItem('theme', isDark ? 'dark' : 'light'); + } + setDarkMode(isDark); setKey('dark'); } }, []); @@ -398,7 +479,7 @@ const DevDocTemplate: FC = (props) => { = (props) => { docContent={docContent} breadcrumsData={breadcrumsData} isPublicSiteOpen={isPublicSiteOpen} + markdownBody={curPageNode.fields?.markdownBody} />
{shouldShowRightNav && ( @@ -487,6 +569,12 @@ const DevDocTemplate: FC = (props) => { ); }; + const isEmbeddedContext = () => { + if (!isBrowser()) return false; + const urlParams = new URLSearchParams(location.search); + return urlParams.get('context') === 'embedded' || !isPublicSiteOpen; + }; + const getClassName = () => { let cName = isDarkMode ? 'dark ' : ''; if (isPublicSiteOpen) cName += 'withHeaderFooter'; @@ -494,6 +582,10 @@ const DevDocTemplate: FC = (props) => { return cName; }; + const getWrapperClassName = () => { + return isEmbeddedContext() ? 'embedded-mode' : ''; + }; + const getCloudLatestVersion = () => { const cloudLatest = VERSION_DROPDOWN?.find( (v) => v?.subLabel && v.subLabel.toLowerCase().includes('cloud (latest)'), @@ -570,12 +662,49 @@ const DevDocTemplate: FC = (props) => { HOME_ANNOUNCEMENT_BANNER?.linkHref, ); + const bannerDismissKey = `announcement-${HOME_ANNOUNCEMENT_BANNER?.linkText || 'banner'}`; + return ( <> + {shouldShowAnnouncementBanner() && ( + + {HOME_ANNOUNCEMENT_BANNER?.linkHref && + HOME_ANNOUNCEMENT_BANNER?.linkText && ( + + {HOME_ANNOUNCEMENT_BANNER.linkText} + + )} + {(HOME_ANNOUNCEMENT_BANNER?.linkHref && + HOME_ANNOUNCEMENT_BANNER?.linkText) && ' '} + {HOME_ANNOUNCEMENT_BANNER?.message || + (VERSION_DROPDOWN?.[0]?.label + ? `Version ${VERSION_DROPDOWN[0].label} is now available!` + : 'A new version is now available!')} + + } + /> + )}
@@ -590,49 +719,30 @@ const DevDocTemplate: FC = (props) => { className="headerPlaceholder" style={ isPublicSiteOpen - ? { height: '65px' } + ? { height: '60px' } : { height: '0px' } } >
- {shouldShowAnnouncementBanner() && ( - - {HOME_ANNOUNCEMENT_BANNER?.linkHref && - HOME_ANNOUNCEMENT_BANNER?.linkText && ( - - {HOME_ANNOUNCEMENT_BANNER.linkText} - - )} - {(HOME_ANNOUNCEMENT_BANNER?.linkHref && - HOME_ANNOUNCEMENT_BANNER?.linkText) && ' '} - {HOME_ANNOUNCEMENT_BANNER?.message || - (VERSION_DROPDOWN?.[0]?.label - ? `Version ${VERSION_DROPDOWN[0].label} is now available!` - : 'A new version is now available!')} - - } + {!isIframeMode && !isVersionedIframe && ( + )}
} style={ - !isPublicSiteOpen + isIframeMode ? { height: '100lvh' } - : { height: 'calc(100lvh - 65px)' } + : isVersionedIframe + ? { height: 'calc(100lvh - 65px)' } + : !isPublicSiteOpen + ? { height: 'calc(100lvh - 44px)' } + : { height: 'calc(100lvh - 65px - 44px)' } } > {isPlayGround ? ( @@ -677,6 +787,9 @@ export const query = graphql` description } html + fields { + markdownBody + } } navNode: asciidoc(pageAttributes: { pageid: { eq: $navId } }) { document { @@ -702,6 +815,7 @@ type DevDocTemplateProps = { namePageIdMap: { [key: string]: string; }; + navMap?: { [key: string]: string }; iframeUrl?: string; }; location: Location; @@ -718,4 +832,7 @@ type AsciiDocNode = { description?: string; }; html: string; + fields?: { + markdownBody?: string; + }; }; diff --git a/src/components/Docmap/index.scss b/src/components/Docmap/index.scss index 18282a2d4..d28015f90 100644 --- a/src/components/Docmap/index.scss +++ b/src/components/Docmap/index.scss @@ -1,100 +1,137 @@ -@import '../../assets/styles/variables.scss'; - -.docmapLinks { - width: -webkit-fill-available; - font-size: 14px; - height: 100lvh; - - .tocTitle { - margin: 0; - color: $disabledcolor; - line-height: $line-height-normal; - padding-left: 0; - } - div > ul > { - li { - border-left: 2px solid #d9d9d9; - padding-bottom: 25px !important; - } - li::before { - content: ''; - border-radius: 50%; - padding: 2px 6px; - background: #d9d9d9; - position: relative; - left: -7px; - height: 7px; - } - .active::before { - background: var(--secondary-color) !important; - } - } - - div { - ul { - margin-top: 10px; - list-style-type: none; - padding-left: 0; - background-color: var(--border-color) solid; - - li { - display: flex; - flex-wrap: wrap; - padding-bottom: 15px; - - a { - color: var(--primary-color); - font-weight: $font-weight-normal; - display: flex; - flex-grow: 1; - width: 80%; - margin: -2px 0 0 7px; - } - - a:hover { - color: var(--secondary-color); - } - - ul { - padding-left: $padding-nested-ul; - padding-top: 5px; - li a{ - color: var(--var-docmap-nested-color); - } - } - } - } - } - - #toctitle { - display: none; - } -} - -.defaultStyle { - color: var(--primary-color); - padding: 8px 0; - display: inline-block; -} - -.activeTag { - color: var(--secondary-color) !important; -} - -@media screen and (min-width: $tablet-resolution-min) and (max-width: $tablet-resolution-max) { - .docmapLinks { - display: none; - } - .header-banner .header-banner-text { - width: 100% !important; - } - .searchInputBanner .searchInputContainer { - width: 100% !important; - } -} - -@media screen and (max-width: $tablet-resolution-max) { - .docmapLinks { - display: none; - } -} +@import '../../assets/styles/variables.scss'; + +.docmapLinks { + width: -webkit-fill-available; + font-size: 13px; + height: 100lvh; + + + .tocTitle { + margin: 0; + color: $disabledcolor; + line-height: $line-height-normal; + padding-left: 0; + } + + div { + ul { + margin-top: 10px; + list-style-type: none; + padding-left: 0; + border-left: 1px solid var(--docmap-border-color); + + li { + display: flex; + flex-wrap: wrap; + position: relative; + padding: 2px 0 20px 12px; + border: none; + + > a { + color: var(--primary-color); + font-weight: $font-weight-normal; + display: flex; + flex-grow: 1; + width: 80%; + } + + > a:hover { + color: var(--var-note-color); + } + + &.activeTag { + &::before { + content: ''; + position: absolute; + left: -1px; + top: 0; + bottom: 10px; + width: 1px; + background: var(--var-note-color); + } + + > a { + color: var(--var-note-color) !important; + font-weight: 500; + } + } + + /* Level 2 (H3) */ + ul { + width: 100%; + padding-left: 5px; + padding-top: 4px; + border: none; + + li { + padding-bottom: 12px; + + a { + color: var(--var-docmap-nested-color); + font-size: 13px; + } + + &.activeTag > a { + color: var(--var-note-color) !important; + font-weight: 500; + } + + /* Level 3 (H4) */ + ul { + padding-left: 10px; + padding-top: 2px; + + li { + padding-bottom: 6px; + + a { + font-size: 13px; + color: var(--var-docmap-nested-color); + opacity: 0.8; + } + + &.activeTag > a { + color: var(--var-note-color) !important; + font-weight: 500; + opacity: 1; + } + } + } + } + } + } + } + } + + #toctitle { + display: none; + } +} + +.defaultStyle { + color: var(--primary-color); + padding: 8px 0; + display: inline-block; +} + +.activeTag { + color: var(--var-note-color) !important; +} + +@media screen and (min-width: $tablet-resolution-min) and (max-width: $tablet-resolution-max) { + .docmapLinks { + display: none; + } + .header-banner .header-banner-text { + width: 100% !important; + } + .searchInputBanner .searchInputContainer { + width: 100% !important; + } +} + +@media screen and (max-width: $tablet-resolution-max) { + .docmapLinks { + display: none; + } +} diff --git a/src/components/Docmap/index.tsx b/src/components/Docmap/index.tsx index 40b7451f9..26a341106 100644 --- a/src/components/Docmap/index.tsx +++ b/src/components/Docmap/index.tsx @@ -1,5 +1,4 @@ -import React, { useEffect, useState } from 'react'; -import { INTRO_WRAPPER_MARGIN_TOP } from '../../constants/uiConstants'; +import React, { useEffect, useRef, useState } from 'react'; import t from '../../utils/lang-utils'; import './index.scss'; @@ -9,10 +8,11 @@ const Docmap = (props: { location: Location; }) => { const [toc, setToc] = useState(''); + const [activeId, setActiveId] = useState(''); + const tocRef = useRef(null); + const visibleHeadings = useRef>(new Set()); + useEffect(() => { - // GraphQL doesn't provide any seperate html for Table of Content. It is included in the document itself. - // To extract the TOC from document, we first create a temporary element to set the document as it's innerHTML. - // Them we search for TOC using querySelector on the temporary element and then set the obtained TOC to display in the UI. const doc = document.createElement('div'); doc.innerHTML = props.docContent; const tocEl = doc.querySelector('#toc'); @@ -22,11 +22,7 @@ const Docmap = (props: { if (hash) { const ele = document.querySelector(hash); if (ele) { - ele.scrollIntoView({ - block: 'start', - }); - - // Apply offset to keep header visible + ele.scrollIntoView({ block: 'start' }); window.scrollBy(0, -70); } } @@ -35,25 +31,65 @@ const Docmap = (props: { } }, [props.docContent, props.location.hash]); - // Currently not using - // const toggleActiveClass = (toc: Element, href: string) => { - // toc.querySelectorAll('a').forEach((tag, index) => { - // const temp = tag; - // if (tag.getAttribute('href') === href) { - // temp.classList.add('activeTag'); - // } else if (tag.classList.contains('activeTag')) { - // temp.classList.remove('activeTag'); - // } - // toc.querySelectorAll('a')[index].innerHTML = temp.innerHTML; - // }); - // return toc; - // }; + // Track which heading is currently near the top of the viewport + useEffect(() => { + if (!toc) return () => {}; + visibleHeadings.current.clear(); + + const headings = document.querySelectorAll( + '.documentView h2[id], .documentView h3[id], .documentView h4[id]', + ); + if (!headings.length) return () => {}; + + const headingIds = Array.from(headings).map((h) => h.id); + + const observer = new IntersectionObserver( + (entries) => { + entries.forEach((entry) => { + if (entry.isIntersecting) { + visibleHeadings.current.add(entry.target.id); + } else { + visibleHeadings.current.delete(entry.target.id); + } + }); + // Pick the topmost visible heading in document order + const topVisible = headingIds.find((id) => + visibleHeadings.current.has(id), + ); + if (topVisible) setActiveId(topVisible); + }, + { rootMargin: '-60px 0% -40% 0%', threshold: 0 }, + ); + + headings.forEach((h) => observer.observe(h)); + return () => { + observer.disconnect(); + visibleHeadings.current.clear(); + }; + }, [toc]); + + // Apply activeTag class to the li containing the active TOC link + useEffect(() => { + if (!tocRef.current) return; + tocRef.current + .querySelectorAll('li.activeTag') + .forEach((li) => li.classList.remove('activeTag')); + if (activeId) { + const link = tocRef.current.querySelector( + `a[href="#${activeId}"]`, + ); + if (link?.parentElement?.tagName === 'LI') { + link.parentElement.classList.add('activeTag'); + } + } + }, [activeId, toc]); return ( toc !== '' && (

{t('RIGHT_NAV_SIDERBAR_TITLE')}

diff --git a/src/components/Document/__snapshots__/index.test.tsx.snap b/src/components/Document/__snapshots__/index.test.tsx.snap index 33bdec068..7331b4d67 100644 --- a/src/components/Document/__snapshots__/index.test.tsx.snap +++ b/src/components/Document/__snapshots__/index.test.tsx.snap @@ -6,6 +6,68 @@ exports[`Document should render correctly if isPublicSiteOpen is false 1`] = ` class="documentWrapper" style="width: 100%;" > +
+
+ +
+
+
+
+ +
+
{ element.addEventListener('click', () => { - const textareaElement = document.createElement('textarea'); - textareaElement.value = (args[0] as HTMLElement).innerText; - element.parentElement.appendChild(textareaElement); - textareaElement.select(); - document.execCommand('copy'); - element.parentElement.removeChild(textareaElement); + const text = (args[0] as HTMLElement).innerText; + + /* Copy to clipboard — prefer modern API, fall back to execCommand */ + if (navigator.clipboard) { + navigator.clipboard.writeText(text).catch(() => { + const ta = document.createElement('textarea'); + ta.value = text; + document.body.appendChild(ta); + ta.select(); + document.execCommand('copy'); + document.body.removeChild(ta); + }); + } else { + const ta = document.createElement('textarea'); + ta.value = text; + document.body.appendChild(ta); + ta.select(); + document.execCommand('copy'); + document.body.removeChild(ta); + } + + /* Tooltip appended inside the button so it floats via absolute positioning */ + if (element.querySelector('.tooltip')) return; const divElement = document.createElement('div'); divElement.classList.add('tooltip'); const spanElement = document.createElement('span'); spanElement.classList.add('tooltiptext'); spanElement.innerText = t('CODE_COPY_BTN_AFTER_CLICK_TEXT'); divElement.appendChild(spanElement); - element.parentElement.appendChild(divElement); - /* To remove copy tooltip */ + element.appendChild(divElement); setTimeout(() => { - element.parentElement.removeChild(divElement); - }, 500); + if (element.contains(divElement)) { + element.removeChild(divElement); + } + }, 1500); }); }; export const customizeDocContent = () => { - /* To get all the code blocks from document */ + /* + * Restructure code blocks to have a permanent header bar: + * lang label (left) · copy button (right) + * + * Before: 
...
+ * After:
+ *
+ * JS + * + *
+ * 
...
+ *
+ * + * Guard against double-processing on re-render. + */ document.querySelectorAll(selectors.codeBlocks).forEach((tag) => { + const pre = tag.parentElement; + if (!pre || pre.parentElement?.classList.contains('code-block-wrapper')) return; + + /* ── Header bar ── */ + const header = document.createElement('div'); + header.classList.add('code-block-header'); + + /* Language label (left) */ + const langSpan = document.createElement('span'); + const rawLang = tag.getAttribute('data-lang') || ''; + langSpan.classList.add('lang'); + langSpan.innerText = rawLang; + header.appendChild(langSpan); + + /* Copy button (right) */ const buttonElement = document.createElement('button'); buttonElement.setAttribute('class', 'copyButton'); - enableCopyToClipboard(buttonElement, tag as HTMLElement); + buttonElement.setAttribute('aria-label', t('CODE_COPY_BTN_HOVER_TEXT')); + buttonElement.setAttribute('title', t('CODE_COPY_BTN_HOVER_TEXT')); + const imageElement = document.createElement('span'); - imageElement.innerHTML = getHTMLFromComponent( - , - 'copyIcon', - ); + imageElement.innerHTML = getHTMLFromComponent(, 'copyIcon'); buttonElement.appendChild(imageElement); - const spanElement = document.createElement('span'); - spanElement.innerText = tag.getAttribute('data-lang'); - spanElement.classList.add('lang'); - const wrapperDiv = document.createElement('div'); - wrapperDiv.classList.add('wrapperContainer'); - wrapperDiv.appendChild(spanElement); - wrapperDiv.appendChild(buttonElement); - tag.parentElement.appendChild(wrapperDiv); + + enableCopyToClipboard(buttonElement, tag as HTMLElement); + header.appendChild(buttonElement); + + /* ── Wrap pre in code-block-wrapper ── */ + const wrapper = document.createElement('div'); + wrapper.classList.add('code-block-wrapper'); + pre.parentNode?.insertBefore(wrapper, pre); + wrapper.appendChild(header); + wrapper.appendChild(pre); }); - /* Add copy buttons to marked table cells */ + + /* Add copy buttons to marked table cells (unchanged) */ document .querySelectorAll('.copy-cell-table table, table.copy-cell-table') .forEach((table) => { @@ -59,9 +108,8 @@ export const customizeDocContent = () => { .querySelectorAll('tbody tr td:nth-child(2)') .forEach((cell) => { const cellElement = cell as HTMLElement; - if (cellElement.querySelector('.tableCopyButton')) { - return; - } + if (cellElement.querySelector('.tableCopyButton')) return; + cellElement.classList.add('tableCopyCell'); const contentWrapper = document.createElement('div'); contentWrapper.classList.add('tableCopyContent'); @@ -69,33 +117,26 @@ export const customizeDocContent = () => { contentWrapper.appendChild(cellElement.firstChild); } cellElement.appendChild(contentWrapper); + const buttonElement = document.createElement('button'); buttonElement.setAttribute('class', 'tableCopyButton'); - buttonElement.setAttribute( - 'aria-label', - t('CODE_COPY_BTN_HOVER_TEXT'), - ); - buttonElement.setAttribute( - 'title', - t('CODE_COPY_BTN_HOVER_TEXT'), - ); + buttonElement.setAttribute('aria-label', t('CODE_COPY_BTN_HOVER_TEXT')); + buttonElement.setAttribute('title', t('CODE_COPY_BTN_HOVER_TEXT')); + enableCopyToClipboard(buttonElement, contentWrapper); const imageElement = document.createElement('span'); - imageElement.innerHTML = getHTMLFromComponent( - , - 'copyIcon', - ); + imageElement.innerHTML = getHTMLFromComponent(, 'copyIcon'); buttonElement.appendChild(imageElement); cellElement.appendChild(buttonElement); }); }); - /* To highlight code snippets */ + + /* Syntax highlight */ document.querySelectorAll('pre code').forEach((block) => { hljs.highlightBlock(block as HTMLElement); }); }; -// Checks if the HTML element is in viewport. const isInViewport = (el: HTMLElement) => { const rect = el.getBoundingClientRect(); return rect.top >= 0 && rect.left >= 0; @@ -104,28 +145,21 @@ const isInViewport = (el: HTMLElement) => { export const addScrollListener = () => { document.addEventListener('scroll', () => { const subLinks = document.querySelectorAll(selectors.docmapLinks); - // console.log(subLinks); let flag = false; subLinks.forEach((link, i: number) => { const href = (link as HTMLAnchorElement).href; const hash = href.split('#')[1]; if (hash) { - const targetElement = document.getElementById(hash) - ?.parentElement; + const targetElement = document.getElementById(hash)?.parentElement; if (targetElement) { - const isVisible = isInViewport( - targetElement as HTMLElement, - ); + const isVisible = isInViewport(targetElement as HTMLElement); if (isVisible && !flag) { link.classList.add('active'); link.parentElement?.classList.add('active'); if ( - link?.parentElement?.parentElement?.parentElement - ?.tagName === 'LI' + link?.parentElement?.parentElement?.parentElement?.tagName === 'LI' ) { - link?.parentElement?.parentElement?.parentElement?.classList?.add( - 'active', - ); + link?.parentElement?.parentElement?.parentElement?.classList?.add('active'); } flag = !flag; } else { diff --git a/src/components/Document/index.scss b/src/components/Document/index.scss index 1736422bf..d2ff882e5 100644 --- a/src/components/Document/index.scss +++ b/src/components/Document/index.scss @@ -7,6 +7,12 @@ width: calc(98%); color: var(--primary-color); + .document-toolbar { + float: right; + margin-left: 16px; + padding-top: 6px; + } + .documentView { min-height: 75vh; // padding: $padding-md $padding-md 0; @@ -46,13 +52,14 @@ code { background: var(--code-text-bg); font-family: $font-family-code; - font-size: 13px; - border: 0.5px solid #C0C6CF; - padding: 2px 4px 2px 4px; + font-size: 12.5px; + border: 1px solid var(--border-color); + border-radius: 4px; + padding: 2px 5px; color: var(--primary-color); a { - color: var(--primary-color); + color: var(--link-text-color); } } } @@ -69,68 +76,136 @@ margin: 0 5px 0 5px; } + /* ── Code block wrapper — holds header bar + pre ─────────────────── */ + .code-block-wrapper { + margin: 16px 0; + border-radius: 8px; + border: 1px solid #323946; + overflow: hidden; + } + + /* ── Code block header bar ────────────────────────────────────────── */ + .code-block-header { + display: flex; + align-items: center; + justify-content: space-between; + padding: 7px 12px; + background: #1e2430; + border-bottom: 1px solid #458; + + .lang { + font-size: 13px; + font-weight: 500; + letter-spacing: 0.05em; + text-transform: uppercase; + color: #fff; + font-family: $font-family-code; + } + + .copyButton { + display: inline-flex; + align-items: center; + justify-content: center; + width: 28px; + height: 28px; + padding: 0; + color: #fff; + background: transparent; + border: 1px solid rgba(255, 255, 255, 0.15); + border-radius: 5px; + cursor: pointer; + transition: background 0.15s ease, color 0.15s ease; + position: relative; + + &:hover { + background: rgba(255, 255, 255, 0.1); + color: #fff; + } + + .copyIcon { + height: 14px; + width: 14px; + display: block; + flex-shrink: 0; + } + + /* Tooltip floats below — absolutely positioned so it doesn't shift layout */ + .tooltip { + position: absolute; + top: calc(100% + 6px); + right: 0; + z-index: 10; + pointer-events: none; + + .tooltiptext { + display: block; + background: #1d232f; + color: #fff; + font-size: 11px; + padding: 3px 8px; + border-radius: 4px; + white-space: nowrap; + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.35); + } + } + } + } + pre { white-space: pre-wrap; background: var(--code-block-color); color: var(--code-text-color); width: auto; - padding: 20px 10px 10px 10px; - display: flex; + /* Padding: extra top/bottom spacing as requested */ + padding: 20px 18px 20px 18px; + display: block; font-family: $font-family-code; - justify-content: space-between; overflow: auto; font-size: $font-size-code; max-height: 700px; line-height: $line-height-code; - box-shadow: var(--box-shadow); + border-radius: 0; + border: 1px solid #232F43; + box-shadow: none; + margin: 0; + + /* When NOT inside wrapper (e.g. admonition code), apply standalone style */ + &:not(.code-block-wrapper pre) { + border-radius: 8px; + border: 1px solid var(--border-color); + margin: 16px 0; + } } pre.highlight { - &:hover { - .wrapperContainer { - visibility: visible; - } - } - code { - max-width: 100%; + width: 100%; font-family: $font-family-code; - padding-top: 10px; + padding-top: 0; + display: block; } + } - .wrapperContainer { - max-width: 15%; - position: relative; - visibility: hidden; - padding: 25px; - - .lang { - position: absolute; - top: -20px; - padding: 5px; - right: 36px; - text-transform: uppercase; - color: var(--text-color-code-lang); - } + /* Light mode: keep code blocks dark for better readability */ + #wrapper[data-theme='light'] & { + .code-block-wrapper { + border-color: #1e2430; - .copyButton { - position: absolute; - top: -15px; - padding: 5px; - right: 0px; - border: 0; - background: transparent; + .code-block-header { + background: #1e2430; + border: 1px solid #458; - img { - width: 15px; + .lang { color: #fff; } + .copyButton { + border-color: rgba(255, 255, 255, 0.15); + color: #fff; + &:hover { background: rgba(255, 255, 255, 0.1); color: #cdd9e5; } } } - - .tooltip { - position: absolute; - top: 15px; - right: -8px; - } + } + pre { + background: #1e2430; + color: #cdd9e5; } } @@ -159,7 +234,7 @@ th { border-bottom: 1px solid var(--border-color); - font-size: $font-size-doc; + font-size: 13.5px; text-align: left; padding: 20px $padding-sm 20px $padding-sm; background-color: var(--table-header-color); @@ -169,14 +244,14 @@ } td { - font-size: $font-size-table; + font-size: 13.5px; border-bottom: 1px solid var(--border-color-tr); padding: 5px $padding-md $padding-sm $padding-sm; font-weight: $font-weight-normal; vertical-align: top; p { - font-size: $font-size-table; + font-size: 13.5px; margin: 3px 0; } } @@ -301,16 +376,16 @@ } td { - font-size: $font-size-doc; + font-size: 13.5px; p { - font-size: $font-size-doc; + font-size: 13.5px; } } } .hdlist1 { - font-size: $font-size-doc; + font-size: 13.5px; font-weight: $font-weight-bold; } @@ -347,12 +422,62 @@ a, a:active { - color: var(--secondary-color); + color: var(--link-text-color); + } + + /* ── Tabbed code blocks ───────────────────────────────────────────── */ + .tabbed-code { + margin: 16px 0; + + /* The JS replaceChildren puts a single .code-block-wrapper here */ + .code-tabs-list { + display: flex; + align-items: center; + gap: 2px; + flex: 1; + overflow-x: auto; + scrollbar-width: none; + &::-webkit-scrollbar { display: none; } + } + + .code-tab-btn { + padding: 2px 14px; + height: 28px; + font-size: 13px; + font-weight: 500; + letter-spacing: 0.04em; + text-transform: uppercase; + color: #fff; + background: transparent; + border: none; + border-bottom: 2px solid transparent; + cursor: pointer; + font-family: $font-family-code; + white-space: nowrap; + transition: color 0.15s ease, border-color 0.15s ease; + + &:hover { color: #aac2f8; } + + &.active { + color: #aac2f8 !important; + border-bottom-color: #aac2f8; + font-weight: 600; + } + } + + .code-tab-panel { + &[hidden] { display: none; } + + pre { + border-radius: 0 0 8px 8px; + margin: 0; + } + } } } hr { - border: 0.5px solid var(--border-color) + border: 0.5px solid var(--border-color); } pre { @@ -361,7 +486,7 @@ pre { .doc-wrapper-detail { padding: 20px 0 0 60px; @media (max-width: $mobile-resolution-max) { - padding-top: 0; + padding: 0; } } diff --git a/src/components/Document/index.tsx b/src/components/Document/index.tsx index 1915e558c..4f2f32fb3 100644 --- a/src/components/Document/index.tsx +++ b/src/components/Document/index.tsx @@ -4,6 +4,8 @@ import { customizeDocContent, addScrollListener } from './helper'; import Footer from '../Footer'; import Breadcrums from '../Breadcrums'; import LinkableHeader from '../LinkableHeader'; +import WasThisHelpful from '../WasThisHelpful'; +import CopyPageDropdown from '../CopyPageDropdown'; import { HOME_PAGE_ID } from '../../configs/doc-configs'; import parse, { HTMLReactParserOptions, domToReact, attributesToProps } from 'html-react-parser'; @@ -12,8 +14,9 @@ const Document = (props: { docTitle: string; docContent: string; isPublicSiteOpen: boolean; - shouldShowRightNav: boolean + shouldShowRightNav: boolean; breadcrumsData: any; + markdownBody?: string; }) => { useEffect(() => { customizeDocContent(); @@ -23,39 +26,133 @@ const Document = (props: { addScrollListener(); }, []); + useEffect(() => { + /* ── Tabbed code blocks ────────────────────────────────────────── + * Authoring: wrap multiple [source,...] blocks in [.tabbed-code] -- + * This effect collapses them into a single panel with language tabs. + */ + document.querySelectorAll('.tabbed-code').forEach((container) => { + const wrappers = Array.from( + container.querySelectorAll('.code-block-wrapper'), + ); + if (wrappers.length < 2) return; + + const entries = wrappers.map((w) => ({ + lang: w.querySelector('.lang')?.textContent?.trim() || 'Code', + pre: w.querySelector('pre'), + })).filter((e) => e.pre); + + if (entries.length < 2) return; + + /* Build unified wrapper */ + const block = document.createElement('div'); + block.className = 'code-block-wrapper'; + + /* Shared header: tab buttons + copy button */ + const header = document.createElement('div'); + header.className = 'code-block-header'; + + const tabsRow = document.createElement('div'); + tabsRow.className = 'code-tabs-list'; + header.appendChild(tabsRow); + + /* Copy button — copies visible tab content */ + const copyBtn = document.createElement('button'); + copyBtn.className = 'copyButton'; + copyBtn.innerHTML = ` + + `; + header.appendChild(copyBtn); + block.appendChild(header); + + /* Panels */ + const panels: HTMLElement[] = []; + entries.forEach(({ lang, pre }, idx) => { + const btn = document.createElement('button'); + btn.className = 'code-tab-btn' + (idx === 0 ? ' active' : ''); + btn.textContent = lang; + tabsRow.appendChild(btn); + + const panel = document.createElement('div'); + panel.className = 'code-tab-panel'; + if (idx > 0) panel.hidden = true; + const preClone = pre!.cloneNode(true) as HTMLElement; + panel.appendChild(preClone); + block.appendChild(panel); + panels.push(panel); + + btn.addEventListener('click', () => { + tabsRow.querySelectorAll('.code-tab-btn').forEach((b) => + b.classList.remove('active'), + ); + panels.forEach((p) => { p.hidden = true; }); + btn.classList.add('active'); + panel.hidden = false; + }); + }); + + copyBtn.addEventListener('click', () => { + const visiblePanel = panels.find((p) => !p.hidden); + const text = visiblePanel?.querySelector('pre')?.textContent || ''; + navigator.clipboard.writeText(text).catch(() => {}); + copyBtn.innerHTML = 'Copied!'; + setTimeout(() => { + copyBtn.innerHTML = ` + + `; + }, 1500); + }); + + container.replaceChildren(block); + }); + }, [props.docContent]); + const options: HTMLReactParserOptions = { replace: (domNode: any) => { if (domNode.type === 'tag' && ['h2', 'h3', 'h4'].includes(domNode.name) && !domNode.parent?.attribs?.class?.includes('non-link') ) { - const props = attributesToProps(domNode.attribs); - return ( + const nodeProps = attributesToProps(domNode.attribs); + return ( {domToReact(domNode.children, options)} ) } + return undefined; } }; + const isHomePage = props.pageid === HOME_PAGE_ID; + return (
- {props.pageid !== HOME_PAGE_ID && ( + {!isHomePage && ( )} + {!isHomePage && ( +
+ +
+ )}
{parse(props.docContent, options)}
+ {/* WasThisHelpful temporarily disabled — no endpoint configured yet + {!isHomePage && props.isPublicSiteOpen && ( + + )} + */} {props.isPublicSiteOpen &&
}
); diff --git a/src/components/Dropdown/index.scss b/src/components/Dropdown/index.scss index 81c383205..7add63496 100644 --- a/src/components/Dropdown/index.scss +++ b/src/components/Dropdown/index.scss @@ -1,76 +1,137 @@ @import '../../assets/styles/variables.scss'; .dropdownWrapper { - padding: 5px; + padding: 10px; + .dropdown { - overflow: hidden; - @media screen and (min-width: $tablet-resolution-min) and (max-width: $tablet-resolution-max) { - padding-right: 0px; - margin-right: 0px; - } + overflow: visible; + position: relative; } - .dropdown .dropbtn { + .dropbtn { + display: inline-flex; + align-items: center; + gap: 6px; font-size: 15px; + font-weight: 400; border: none; outline: none; - color: $white; - background-color: inherit; - margin-left: 15px; + color: rgba(255, 255, 255, 0.85); + background-color: transparent; + margin-left: 20px; + margin-right: 5px; + padding: 6px 10px; + cursor: pointer; + font-family: 'Optimo-Plain'; + border-radius: 6px; + transition: background 0.15s ease, color 0.15s ease; + + &:hover { + background: rgba(255, 255, 255, 0.1); + color: #A9E8FF; + } + } + + .arrowDown { + width: 13px; + height: 13px; + margin-left: 2px; + vertical-align: middle; + transition: transform 0.15s ease; } + .dropdown:hover .arrowDown { + transform: rotate(180deg); + } + + /* Panel revealed on hover */ .dropdownContent { display: none; position: absolute; - background-color: #f5f5f5; - border: solid 0.5px #d3d3d3; - min-width: 8rem; - box-shadow: 0px 8px 16px 0px rgba(0, 0, 0, 0.2); - z-index: 1; - right: 80px; - padding: 10px 0 10px 0; + top: 100%; + right: 0; + left: auto; + padding-top: 6px; + z-index: 200; } - .dropdownContent > div { - float: none; - cursor: pointer; - color: var(--header-link-color); - padding: 8px 16px; - text-decoration: none; + .dropdown:hover .dropdownContent { display: block; - text-align: left; - font-size: $font-size-home; } - .dropdownContent div:hover { - color: var(--secondary-color); + /* Two-column panel — mirrors .header-dropdown-menu-panel */ + .version-panel { + display: flex; + flex-direction: row; + align-items: flex-start; + gap: 0; + background: var(--nav-bar-color, #232F43); + border: 1px solid #458; + box-shadow: 0 8px 24px rgba(68, 85, 136, 0.35); + border-radius: 10px; + padding: 6px; + animation: versionDropdownFadeIn 0.15s ease; + white-space: nowrap; } - .dropdown:hover .dropdownContent { - display: block; + .version-section { + flex: 1; + min-width: 140px; } - .arrowDown { - height: 0.8rem; - width: 0.8rem; - vertical-align: middle; - margin-left: 15px; + .version-section-label { + font-size: 10px; + font-weight: 700; + letter-spacing: 0.1em; + text-transform: uppercase; + color: rgba(255, 255, 255, 0.35); + padding: 8px 12px 3px; } - .subLabel { - font-size: $font-size-small; - font-weight: $font-weight-normal; - padding: 3px 0px; + + .version-col-divider { + width: 1px; + background: rgba(255, 255, 255, 0.08); + align-self: stretch; + margin: 6px 4px; + flex-shrink: 0; } - .hide { - display: none; + + .version-item { + display: flex; + flex-direction: column; + cursor: pointer; + color: rgba(255, 255, 255, 0.8); + border-radius: 6px; + padding: 8px 12px; + transition: background 0.1s ease, color 0.1s ease; + + &:hover { + background: rgba(169, 232, 255, 0.08); + color: #A9E8FF; + + .version-item-sub { color: rgba(169, 232, 255, 0.5); } + } + + &.active { + .version-item-label { color: #A9E8FF; } + } } - .versionLabel { - padding-right: 20px; - cursor: default; - font-size: $font-size-home; - font-weight: $font-weight-normal; - user-select: none; + + .version-item-label { + font-size: 14px; + font-weight: 500; + color: inherit; + line-height: 1.3; + } + + .version-item-sub { + font-size: 11.5px; + color: rgba(255, 255, 255, 0.4); + line-height: 1.3; + margin-top: 1px; + transition: color 0.1s ease; } + .dropdownContainer { display: flex; color: $white; @@ -81,6 +142,7 @@ @media screen and (max-width: $mobile-resolution-max) { .dropdownWrapper { min-width: 6rem; + .dropdownContent { right: 5px; } @@ -91,3 +153,14 @@ } } } + +@keyframes versionDropdownFadeIn { + from { + opacity: 0; + transform: translateY(-4px); + } + to { + opacity: 1; + transform: translateY(0); + } +} diff --git a/src/components/Dropdown/index.tsx b/src/components/Dropdown/index.tsx index c5d46cb67..8673e7926 100644 --- a/src/components/Dropdown/index.tsx +++ b/src/components/Dropdown/index.tsx @@ -95,7 +95,6 @@ const Dropdown = (props: { location: Location; isMobile: boolean }) => { // Handle latest version (empty or space link) if (link === ' ' || link === '') { - // If we're in /docs, stay in /docs for the latest version if (currentPath.startsWith('/docs')) { window?.location?.assign('/docs'); } else { @@ -116,6 +115,26 @@ const Dropdown = (props: { location: Location; isMobile: boolean }) => { } }; + const cloudVersions = options.filter((o) => o.label.endsWith('.cl')); + const swVersions = options.filter((o) => o.label.endsWith('.sw')); + + const renderVersionItem = (d: VersionOption) => { + const isActive = d.label === currentVersion?.label; + return ( +
handelClick(d)} + > + {d.label} + {d.subLabel && ( + {d.subLabel} + )} +
+ ); + }; + return (
@@ -125,20 +144,21 @@ const Dropdown = (props: { location: Location; isMobile: boolean }) => {
- {options.map((d) => { - return ( -
handelClick(d)} - > - {d?.label} -
- {d?.subLabel} +
+
+
Cloud
+ {cloudVersions.map(renderVersionItem)} +
+ {swVersions.length > 0 && ( + <> +
+
+
Software
+ {swVersions.map(renderVersionItem)}
-
- ); - })} + + )} +
diff --git a/src/components/Header/index.scss b/src/components/Header/index.scss index beb35a8fc..c8d800792 100644 --- a/src/components/Header/index.scss +++ b/src/components/Header/index.scss @@ -1,104 +1,360 @@ -@import '../../assets/styles/variables.scss'; - -header { - background: var(--header-color); - position: absolute; - top: 0; - left: 0; - width: 100%; - height: $header-height; - border-bottom: var(--header-border-color); - z-index: $header-zIndex; - - .logo-link{ - color: white; - } - - .thoughtspotLogo { - vertical-align: middle; - width: $header-logo-width; - padding-right: 20px; - } - - .headerWrapper { - display: flex; - justify-content: space-between; - padding: 5px 10px 10px 5px; - width: 100%; - } - - .logo { - padding-right: 0px; - } - - .docsWrapper { - margin-left: 20px; - padding-left: 20px; - color: $lightgrey; - cursor: pointer; - } - - .headerLink { - a { - margin-left: $header-link-margin; - padding-left: 40px; - padding-right: 20px; - cursor: pointer; - color: var(--header-link-color); - font-weight: bold; - } - @media (max-width: 820px) { - display: none; - } - } - .dropdownWrapper { - @media (max-width: $mobile-resolution-max) { - display: none; - } - } - .header-logo { - @media (max-width: 820px) { - flex-grow: 1; - } - } - - .headerLinkSelf { - a { - margin-left: $header-link-margin; - cursor: pointer; - color: $lightgrey; - } - @media (max-width: 820px) { - display: none; - } - } - .themeSwitcher { - cursor: pointer; - padding: 5px 20px 0 0; - } - .theme-version-wrapper { - display: flex; - flex-basis: 22%; - max-width: 220px; - } - .theme-icon, - .references .icon { - color: $white; - height: 1.25em; - width: 1.25em; - } - .references { - padding-top: 5px; - display: flex; - @media (max-width: $mobile-resolution-max) { - display: none; - } - .icon-item { - padding-right: 15px; - cursor: pointer; - :last-child { - padding-right: 0; - } - } - } -} +@import '../../assets/styles/variables.scss'; + +header { + background: var(--header-color, #DBDFE7); + position: absolute; + top: 0; + left: 0; + width: 100%; + height: $header-height; + z-index: $header-zIndex; + + .embedded-mode & { + display: none; + } + + .containerWrapper { + height: 100%; + padding: 0 20px; + display: flex; + align-items: center; + } + + .headerWrapper { + display: flex; + align-items: center; + justify-content: space-between; + width: 100%; + gap: 12px; + } + + .header-logo { + flex-shrink: 0; + + @media (max-width: 820px) { + flex-grow: 1; + } + } + + .logo-link { + display: flex; + align-items: center; + color: white; + text-decoration: none; + } + + .logo { + margin: 5px 10px 5px 5px; + padding: 5px 5px 5px 5px; + } + + .thoughtspotLogo { + width: $header-logo-width; + vertical-align: middle; + padding-right: 20px; + } + + .header-nav-link { + display: inline-flex; + align-items: center; + gap: 10px; + padding: 6px 10px; + color: rgba(255, 255, 255, 0.85); + font-size: 15px; + font-weight: 400; + text-decoration: none; + border-radius: 6px; + border: none; + background: transparent; + cursor: pointer; + transition: background 0.15s ease, color 0.15s ease; + font-family: 'Optimo-Plain'; + white-space: nowrap; + + &:hover { + background: rgba(255, 255, 255, 0.1); + color: #A9E8FF; + } + } + + /* ── Desktop nav: Resources hover dropdown + GitHub ─────────────── */ + .header-desktop-nav { + display: flex; + align-items: center; + gap: 4px; + } + + .header-dropdown { + position: relative; + display: inline-flex; + align-items: center; + + .header-chevron { + width: 13px; + height: 13px; + transition: transform 0.15s ease; + } + + &:hover .header-chevron { + transform: rotate(180deg); + } + + &:hover > .header-dropdown-menu { + visibility: visible; + opacity: 1; + } + } + + /* Bridge: keeps hover alive while cursor moves from button into panel */ + .header-dropdown-menu { + visibility: hidden; + opacity: 0; + position: absolute; + top: 100%; + right: 0; + padding-top: 6px; + z-index: 200; + transition: opacity 0.15s ease, visibility 0.15s ease; + } + + .header-dropdown-menu-panel { + background: var(--nav-bar-color, #232F43); + border: 1px solid #458; + box-shadow: 0 8px 24px rgba(68, 85, 136, 0.35); + border-radius: 10px; + min-width: 400px; + padding: 6px; + animation: dropdownFadeIn 0.15s ease; + display: flex; + flex-direction: row; + align-items: flex-start; + gap: 0; + } + + /* ── Mobile: ⋮ click-driven dropdown (hidden on desktop) ────────── */ + .header-more-dropdown { + display: none; + position: relative; + align-items: center; + } + + .header-more-icon { + width: 18px; + height: 18px; + } + + .header-more-panel { + display: flex; + flex-direction: column; + align-items: flex-start; + gap: 0; + position: absolute; + top: calc(100% + 6px); + right: 0; + z-index: 200; + background: var(--nav-bar-color, #232F43); + border: 1px solid #458; + box-shadow: 0 8px 24px rgba(68, 85, 136, 0.35); + border-radius: 10px; + min-width: 260px; + padding: 6px; + animation: dropdownFadeIn 0.15s ease; + + .header-dropdown-col-divider { + width: 100%; + height: 1px; + margin: 4px 0; + align-self: auto; + } + + .header-dropdown-section { + width: 100%; + min-width: unset; + } + } + + /* ── Shared dropdown item styles ────────────────────────────────── */ + .header-dropdown-item { + display: flex; + align-items: center; + gap: 10px; + padding: 9px 12px; + color: rgba(255, 255, 255, 0.8); + font-size: 14px; + text-decoration: none; + border-radius: 6px; + transition: background 0.1s ease, color 0.1s ease; + + &:hover { + background: rgba(169, 232, 255, 0.08); + color: #A9E8FF; + + .dropdown-item-name { color: #A9E8FF; } + .dropdown-item-icon { color: #A9E8FF; } + .external-link-icon { color: rgba(169, 232, 255, 0.5); } + } + + .dropdown-item-icon { + width: 16px; + height: 16px; + color: rgba(255, 255, 255, 0.45); + flex-shrink: 0; + transition: color 0.1s ease; + } + + .dropdown-item-text { + display: flex; + flex-direction: column; + flex: 1; + min-width: 0; + } + + .dropdown-item-name { + font-size: 14px; + font-weight: 500; + color: rgba(255, 255, 255, 0.9); + line-height: 1.3; + transition: color 0.1s ease; + } + + .dropdown-item-sub { + font-size: 11.5px; + color: rgba(255, 255, 255, 0.4); + line-height: 1.3; + margin-top: 1px; + } + + .external-link-icon { + width: 11px; + height: 11px; + color: rgba(255, 255, 255, 0.25); + flex-shrink: 0; + transition: color 0.1s ease; + } + } + + .header-nav-icon { + width: 16px; + height: 16px; + } + + .header-dropdown-section { + flex: 1; + min-width: 180px; + } + + .header-dropdown-section-label { + font-size: 10px; + font-weight: 700; + letter-spacing: 0.1em; + text-transform: uppercase; + color: rgba(255, 255, 255, 0.35); + padding: 8px 12px 3px; + white-space: nowrap; + } + + .header-dropdown-col-divider { + width: 1px; + background: rgba(255, 255, 255, 0.08); + align-self: stretch; + margin: 6px 4px; + flex-shrink: 0; + } + + /* ── Right side ─────────────────────────────────────────────────── */ + .header-right { + display: flex; + align-items: center; + gap: 15px; + flex-shrink: 0; + padding-right: 20px; + margin-right: 5px; + + .dropdownWrapper { + padding: 0; + + .dropdownContainer { + align-items: center; + } + + .dropbtn { + margin-left: 0; + font-size: 16px; + } + } + } + + /* ── Theme toggle ───────────────────────────────────────────────── */ + .theme-toggle-btn { + display: inline-flex; + align-items: center; + justify-content: center; + width: 30px; + height: 30px; + border-radius: 6px; + border: none; + background: transparent; + cursor: pointer; + color: rgba(255, 255, 255, 0.85); + transition: background 0.15s ease, color 0.15s ease; + margin-left: 0; + + &:hover { + background: rgba(255, 255, 255, 0.08); + color: #fff; + } + + .theme-icon { + width: 17px; + height: 17px; + } + } +} + +/* ── Mobile: swap desktop nav for ⋮ button, hide version dropdown ────── */ +@media screen and (max-width: $mobile-resolution-max) { + header { + .containerWrapper { + padding: 0 8px; + } + + .logo { + margin: 0; + padding: 0; + } + + .thoughtspotLogo { + width: 200px; + padding-right: 0; + } + + .header-desktop-nav { + display: none; + } + + .header-more-dropdown { + display: inline-flex; + } + + .header-right { + padding-right: 0; + margin-right: 0; + gap: 4px; + + .dropdownWrapper { + display: none; + } + } + } +} + +@keyframes dropdownFadeIn { + from { + opacity: 0; + transform: translateY(-4px); + } + to { + opacity: 1; + transform: translateY(0); + } +} diff --git a/src/components/Header/index.tsx b/src/components/Header/index.tsx index 5706adb50..763a8e248 100644 --- a/src/components/Header/index.tsx +++ b/src/components/Header/index.tsx @@ -1,16 +1,21 @@ -import React from 'react'; +import React, { useState, useEffect, useRef } from 'react'; import { useResizeDetector } from 'react-resize-detector'; import { IconContext } from '@react-icons/all-files'; import { RiMoonClearLine } from '@react-icons/all-files/ri/RiMoonClearLine'; import { FiSun } from '@react-icons/all-files/fi/FiSun'; import { RiDiscordLine } from '@react-icons/all-files/ri/RiDiscordLine'; import { FiGithub } from '@react-icons/all-files/fi/FiGithub'; +import { FiMoreVertical } from '@react-icons/all-files/fi/FiMoreVertical'; +import { AiOutlineCaretDown } from '@react-icons/all-files/ai/AiOutlineCaretDown'; +import { FiUsers } from '@react-icons/all-files/fi/FiUsers'; +import { FiHelpCircle } from '@react-icons/all-files/fi/FiHelpCircle'; +import { FiExternalLink } from '@react-icons/all-files/fi/FiExternalLink'; +import { FiBook } from '@react-icons/all-files/fi/FiBook'; +import { FiBookOpen } from '@react-icons/all-files/fi/FiBookOpen'; import TSLogo from '../../assets/svg/ts-logo-white-developer.svg'; import t from '../../utils/lang-utils'; import Dropdown from '../Dropdown'; -// import References from './references'; -import Menu from '../Menu'; import { MAX_MOBILE_RESOLUTION } from '../../constants/uiConstants'; import './index.scss'; @@ -20,40 +25,95 @@ const Header = (props: { isDarkMode: boolean; }) => { const { width, ref } = useResizeDetector(); + const [moreOpen, setMoreOpen] = useState(false); + const moreRef = useRef(null); const isMaxMobileResolution = !(width < MAX_MOBILE_RESOLUTION); - const headerLinks = [ - { - name: 'Community', - link: - 'https://community.thoughtspot.com/customers/s/topic/0TO3n000000erVyGAI/developers-embedding', - external: true, - }, + const handleThemeToggle = () => { + const newDark = !props.isDarkMode; + props.setDarkMode(newDark); + localStorage.setItem('theme', newDark ? 'dark' : 'light'); + localStorage.setItem('themeMode', newDark ? 'dark' : 'light'); + }; + + useEffect(() => { + if (!moreOpen) return; + const handler = (e: MouseEvent) => { + if (moreRef.current && !moreRef.current.contains(e.target as Node)) { + setMoreOpen(false); + } + }; + document.addEventListener('mousedown', handler); + return () => document.removeEventListener('mousedown', handler); + }, [moreOpen]); + + const learnLinks = [ { - name: 'Support', - link: 'https://www.thoughtspot.com/support', - external: true, + name: 'Docs', + sub: 'ThoughtSpot Analytics product documentation', + link: 'https://docs.thoughtspot.com/home', + icon: FiBook, }, { - name: 'GitHub', - link: 'https://github.com/thoughtspot/visual-embed-sdk', - external: true, - icon: FiGithub, + name: 'Training', + sub: 'ThoughtSpot Embedded learning paths', + link: 'https://training.thoughtspot.com/path/thoughtspot-embedded', + icon: FiBookOpen, }, + ]; + + const connectLinks = [ { name: 'Discord', + sub: 'Chat with the dev community', link: 'https://discord.gg/YBWP65W6te', - external: true, icon: RiDiscordLine, }, - // { - // name: 'Product documentation', - // link: 'https://docs.thoughtspot.com', - // external: true, - // }, + { + name: 'Community', + sub: 'Connect with other developers', + link: 'https://community.thoughtspot.com/customers/s/topic/0TO3n000000erVyGAI/developers-embedding', + icon: FiUsers, + }, + { + name: 'Support', + sub: 'Get help from ThoughtSpot', + link: 'https://www.thoughtspot.com/support', + icon: FiHelpCircle, + }, ]; + const renderDropdownItems = ( + items: { name: string; sub: string; link: string; icon: any }[], + onClose?: () => void, + ) => + items.map((item) => { + const Icon = item.icon; + return ( + + + + + + {item.name} + {item.sub} + + + + + + ); + }); + return (
} >
+ {/* Logo */} - -
- {isMaxMobileResolution && ( -
- - {props.isDarkMode ? ( - { - localStorage.setItem( - 'theme', - 'light', - ); - props.setDarkMode(false); - }} - /> - ) : ( - { - localStorage.setItem( - 'theme', - 'dark', - ); - props.setDarkMode(true); - }} - /> - )} - -
- )} + +
+ {/* Version dropdown */} + + {/* Desktop: Resources hover dropdown + GitHub link */} +
+ + + {/* Mobile: ⋮ click dropdown with Resources + GitHub */} +
+ + {moreOpen && ( +
+
+
Learn
+ {renderDropdownItems(learnLinks, () => setMoreOpen(false))} +
+
+
+
Connect
+ {renderDropdownItems(connectLinks, () => setMoreOpen(false))} +
+ + )} +
+ + {/* Theme toggle — always visible */} +
- {/* */}
diff --git a/src/components/LeftSidebar/index.scss b/src/components/LeftSidebar/index.scss index 32d2cc3f0..d976c54aa 100644 --- a/src/components/LeftSidebar/index.scss +++ b/src/components/LeftSidebar/index.scss @@ -51,72 +51,131 @@ .asideDisplay { display: block; } + .searchInputLeftNav { - margin-top: 30px; - padding-right: 30px; + margin-top: 25px; + padding-right: 16px; + .searchIconSmall { position: relative; left: 30px; - height: 20px; - width: 20px; + top: 1px; + height: 18px; + width: 18px; + color: var(--icon-color, #6b7280); } input { width: 100%; - border: 1px solid var(--border-color); + border: 1px solid var(--search-border-color); border-radius: 6px; - height: $height-search-input; - padding-left: $padding-left-search-input; - font-size: $font-size-normal; + height: 36px; + padding: 0 8px 0 $padding-left-search-input; + font-size: 14px; + line-height: 36px; color: var(--primary-color); font-family: $font-family-doc; - padding-bottom: 1px; background: var(--body-background-color); + box-sizing: border-box; + outline: none; + + &::placeholder { + color: var(--icon-color, #6b7280); + } + + &:focus { + border-color: var(--secondary-color); + box-shadow: 0 0 0 2px rgba(5, 104, 250, 0.12); + } } } .aside { padding: 0 0 0 10px; width: 100%; - border-right: 0.5px var(--border-color) solid; + border-right: 1px solid var(--search-border-color); left: $gutter; height: 100%; overflow-y: auto; - background: var(--nav-bar-color); + background: var(--left-nav-color); + font-size: 13px; + scrollbar-color: transparent transparent; + + &:hover { + scrollbar-color: var(--scrollbar-color) transparent; + } + + &::-webkit-scrollbar { + width: 3px; + } + + &::-webkit-scrollbar-thumb { + background-color: transparent; + } + + &:hover::-webkit-scrollbar-thumb { + background-color: var(--scrollbar-color); + } .subHeading { margin: $gutter; padding-bottom: $padding-sm; padding-left: $padding-md; - font-size: $font-size-normal; + font-size: 14px; + font-weight: 600; + letter-spacing: 0.07em; + text-transform: uppercase; width: 100%; - color: var(--side-nav-text); + color: var(--icon-color, #6b7280); + } + + /* Sidebar group title: add [.sidebar-title] role to a paragraph in nav adoc files */ + .paragraph.sidebar-title { + padding-left: 0; + margin: 2px 0 5px 0; + padding-top: 15px; + + + p { + font-size: 12px; + font-weight: 700; + text-transform: uppercase; + letter-spacing: 0.001rem; + color: var(--sidebar-title); + padding-right: $padding-xs; + margin: 0; + } } ul { list-style-type: none; - margin: $gutter; - padding-left: 20px; + margin-left: $margin-sm; + padding: 0 5px 0 10px; color: var(--side-nav-text); } .navWrapper { margin-bottom: 12px; - padding-top: 2px; + padding-top: 5px; & > .ulist { & > ul > li { - margin-bottom: $margin-md; + margin: 0 0 2px 2px; & > p { padding-right: $padding-xs; + padding-left: 10px; color: var(--sidebar-text-color); - font-weight: $font-weight-bold; + font-weight: 500; cursor: pointer; display: flex; & > a { color: var(--side-nav-text); - font-weight: $font-weight-bold; + font-weight: 500; padding-right: $padding-xs; + + &:hover { + color: var(--var-note-color); + } } } @@ -124,14 +183,14 @@ ul { padding-left: $padding-nested-ul; li { - margin: $margin-links 0; + margin: 3px 0; p { font-weight: $font-weight-normal; color: var(--primary-color); padding-right: $padding-xs; a { - color: var(--primary-color); + color: var(--note-color); padding-right: $padding-xs; // word-break: break-all; // overflow: hidden; @@ -139,12 +198,12 @@ // width: 95%; &:hover { - color: var(--secondary-color); + color: var(--var-note-color); } } &:hover { - color: var(--secondary-color); + color: var(--var-note-color); } } } @@ -159,22 +218,11 @@ p { padding-right: $padding-xs; - margin: $margin-xs 0; + margin: 2px 0; } } - .iconSpan { - position: relative; - right: 8px; - top: 0px; - img { - width: $icon-width; - position: relative; - top: 2px; - float: right; - } - } - } + } .navWrapper.withHeaderFooter { padding-bottom: 50px; @@ -182,14 +230,17 @@ } a { - font-size: $font-size-normal; + font-size: 13px; font-weight: $font-weight-normal; width: 100%; display: inline-block; + line-height: 1.4; } hr { - display: none; + border: none; + border-top: 1px solid var(--sidebar-connector-color, #d1d5db); + margin: 8px 8px 8px 0; } a[target='_blank'] { @@ -201,8 +252,21 @@ display: flex; cursor: pointer; align-items: center; - flex-direction: row-reverse; - justify-content: flex-end; + justify-content: space-between; + gap: 4px; + + > a { + flex: 1 1 0%; + min-width: 0; + width: 0; + } + + > .iconSpan { + flex: 0 0 auto; + display: flex; + align-items: center; + padding-right: 8px; + } } .externalLinkIcon { @@ -229,8 +293,9 @@ display: flex; justify-content: center; } + .node-child { - padding-left: 15px; + padding-left: 0; } } @@ -247,9 +312,10 @@ .resizable-container { position: relative; height: 100%; + border: 0; } -.resizable{ +.resizable { height: 100%; } diff --git a/src/components/LeftSidebar/index.tsx b/src/components/LeftSidebar/index.tsx index 54e0ac5e1..682917841 100644 --- a/src/components/LeftSidebar/index.tsx +++ b/src/components/LeftSidebar/index.tsx @@ -1,11 +1,6 @@ import React, { useEffect, useState, useRef } from 'react'; import { ResizableBox } from 'react-resizable'; import { useResizeDetector } from 'react-resize-detector'; -import { IconContext } from '@react-icons/all-files'; -import { GiHamburgerMenu } from '@react-icons/all-files/gi/GiHamburgerMenu'; -import { MdClear } from '@react-icons/all-files/md/MdClear'; -import { RiMoonClearLine } from '@react-icons/all-files/ri/RiMoonClearLine'; -import { FiSun } from '@react-icons/all-files/fi/FiSun'; import { removeTrailingSlash, queryStringParser } from '../../utils/app-utils'; import { NAV_PREFIX, TS_PAGE_ID_PARAM } from '../../configs/doc-configs'; import { @@ -56,7 +51,11 @@ const LeftSideBar = (props: { const pageid = removeTrailingSlash(props.location.pathname).replace(/^\/*/, '') || getPageIdFromUrl(props.location.href); - const tag = divElement.querySelector(`a[href='/${pageid}']`); + const allLinks = divElement.querySelectorAll('a'); + const tag = Array.from(allLinks).find((a) => { + const href = a.getAttribute('href'); + return href === `/${pageid}` || href?.endsWith(`/${pageid}`); + }); if (tag) { tag.classList.add('active'); } @@ -67,7 +66,7 @@ const LeftSideBar = (props: { expandedTabsRef.current, ); setNavContent(updatedHTML); - }, [params[NAV_PREFIX], params[TS_PAGE_ID_PARAM], props.navContent]); + }, [params[NAV_PREFIX], params[TS_PAGE_ID_PARAM], props.navContent, props.location.pathname]); const toggleExpandOnTab = (text: string) => { const allTabsRef = { ...expandedTabsRef.current }; @@ -87,11 +86,6 @@ const LeftSideBar = (props: { ); }, [props.curPageid, isMaxMobileResolution, navContent]); - const onMenuClick = () => { - props.setLeftNavOpen(!props.leftNavOpen); - document.documentElement.scrollTop = 0; - }; - const renderLeftNav = () => { return isMaxMobileResolution ? (
@@ -130,41 +124,6 @@ const LeftSideBar = (props: {
) : (
-
- - - - - {props.isDarkMode ? ( - props.setDarkMode(false)} - /> - ) : ( - props.setDarkMode(true)} /> - )} - - - - -
{ +type MenuChild = { label: string; link: string; external?: boolean }; +type MenuItem = { name: string; link?: string; icon?: any; child?: MenuChild[] }; + +const Menu = (props: { config: MenuItem[] }) => { const { config = [] } = props; - const handelClick = (menu: { link: string; external: boolean }) => { + const handelClick = (menu: { link: string; external?: boolean }) => { const { external = false, link } = menu; let url = location.origin + '/' + link; let target = '_self'; @@ -30,10 +33,10 @@ const Menu = (props: { config: {} }) => { return (
{config?.map((c) => ( -
+
+ + ))} + + + {/* Mobile: nav-toggle + category picker */} +
+ + +
+ + {mobileMenuOpen && ( +
+ {categories.map((cat) => ( + + ))} + +
+ )} +
+
{/* end mobile-left */} + + {/* Mobile only: version dropdown */} +
+ +
+ + {/* Desktop only: AskDocs link */} + +
+ + ); +}; + +export default SecondaryHeader; diff --git a/src/components/Seo/index.tsx b/src/components/Seo/index.tsx index 08d01b246..5143f0e12 100644 --- a/src/components/Seo/index.tsx +++ b/src/components/Seo/index.tsx @@ -32,6 +32,7 @@ export const Seo: FC = ({ return ( <> {seo.title} + diff --git a/src/components/WasThisHelpful/index.scss b/src/components/WasThisHelpful/index.scss new file mode 100644 index 000000000..7876f85ee --- /dev/null +++ b/src/components/WasThisHelpful/index.scss @@ -0,0 +1,173 @@ +@import '../../assets/styles/variables.scss'; + +.was-helpful { + margin: 40px 0 20px; + padding: 20px 24px; + background: var(--was-helpful-bg, #f9fafb); + border: 1px solid var(--was-helpful-border, #e5e7eb); + border-radius: 10px; + + &__prompt { + font-size: 14px; + font-weight: 600; + color: var(--primary-color); + margin-bottom: 12px; + } + + &__actions { + display: flex; + gap: 8px; + align-items: center; + } + + &__btn { + display: inline-flex; + align-items: center; + gap: 6px; + padding: 7px 16px; + font-size: 13px; + font-weight: 500; + border: 1px solid var(--border-color, #d1d5db); + border-radius: 6px; + background: var(--body-background-color); + color: var(--primary-color); + cursor: pointer; + font-family: 'Optimo-Plain', sans-serif; + transition: all 0.15s ease; + + &:hover { + border-color: var(--secondary-color, #0568fa); + color: var(--secondary-color, #0568fa); + background: rgba(5, 104, 250, 0.04); + } + + &.active { + border-color: var(--secondary-color, #0568fa); + background: rgba(5, 104, 250, 0.08); + color: var(--secondary-color, #0568fa); + } + + &--up.active { + border-color: #16a34a; + background: rgba(22, 163, 74, 0.08); + color: #15803d; + } + + &--down.active { + border-color: #dc2626; + background: rgba(220, 38, 38, 0.06); + color: #b91c1c; + } + } + + &__emoji { + font-size: 16px; + line-height: 1; + } + + &__followup { + margin-top: 16px; + border-top: 1px solid var(--border-color, #e5e7eb); + padding-top: 16px; + } + + &__followup-text { + font-size: 13px; + font-weight: 600; + color: var(--primary-color); + margin: 0 0 10px; + } + + &__form { + display: flex; + flex-direction: column; + gap: 10px; + } + + &__textarea { + width: 100%; + padding: 10px 12px; + font-size: 13px; + font-family: 'Optimo-Plain', sans-serif; + border: 1px solid var(--border-color, #d1d5db); + border-radius: 6px; + background: var(--body-background-color); + color: var(--primary-color); + resize: vertical; + outline: none; + transition: border-color 0.15s ease; + + &:focus { + border-color: var(--secondary-color, #0568fa); + box-shadow: 0 0 0 3px rgba(5, 104, 250, 0.1); + } + + &::placeholder { + color: var(--icon-color, #9ca3af); + } + } + + &__form-actions { + display: flex; + gap: 8px; + align-items: center; + } + + &__submit { + padding: 7px 18px; + font-size: 13px; + font-weight: 600; + background: var(--secondary-color, #0568fa); + color: #fff; + border: none; + border-radius: 6px; + cursor: pointer; + font-family: 'Optimo-Plain', sans-serif; + transition: opacity 0.15s ease; + + &:hover { + opacity: 0.9; + } + } + + &__skip { + padding: 7px 14px; + font-size: 13px; + font-weight: 500; + background: transparent; + color: var(--icon-color, #6b7280); + border: 1px solid var(--border-color, #d1d5db); + border-radius: 6px; + cursor: pointer; + font-family: 'Optimo-Plain', sans-serif; + transition: all 0.15s ease; + + &:hover { + color: var(--primary-color); + border-color: var(--primary-color); + } + } + + &__thanks { + font-size: 14px; + font-weight: 500; + color: #16a34a; + display: flex; + align-items: center; + gap: 8px; + + &::before { + content: '✓'; + display: inline-flex; + align-items: center; + justify-content: center; + width: 20px; + height: 20px; + background: #dcfce7; + border-radius: 50%; + font-size: 12px; + font-weight: 700; + flex-shrink: 0; + } + } +} diff --git a/src/components/WasThisHelpful/index.tsx b/src/components/WasThisHelpful/index.tsx new file mode 100644 index 000000000..7feaa918a --- /dev/null +++ b/src/components/WasThisHelpful/index.tsx @@ -0,0 +1,122 @@ +import React, { useState } from 'react'; +import './index.scss'; + +type FeedbackState = 'idle' | 'helpful' | 'not-helpful' | 'submitted'; + +/* + * Feedback submission hook. + * + * Currently logs to the browser console. + * To wire up a real endpoint, replace the console.log with a fetch() call: + * + * fetch('/api/feedback', { + * method: 'POST', + * headers: { 'Content-Type': 'application/json' }, + * body: JSON.stringify(payload), + * }); + * + * Common integrations: Google Analytics event, Segment track(), Airtable API, + * GitHub Discussions API, or a custom backend endpoint. + */ +const submitFeedback = (payload: { + url: string; + helpful: boolean; + comment?: string; +}) => { + console.log('[Feedback] Page feedback received:', payload); + /* ── Replace the line above with your endpoint call ── */ +}; + +const WasThisHelpful = () => { + const [state, setFeedbackState] = useState('idle'); + const [feedback, setFeedback] = useState(''); + + const pageUrl = typeof window !== 'undefined' ? window.location.href : ''; + + /* Thumbs up → immediately thank the user; no follow-up form */ + const handleThumbsUp = () => { + submitFeedback({ url: pageUrl, helpful: true }); + setFeedbackState('submitted'); + }; + + /* Thumbs down → show improvement text input */ + const handleThumbsDown = () => { + setFeedbackState('not-helpful'); + }; + + const handleSubmit = (e: React.FormEvent) => { + e.preventDefault(); + submitFeedback({ url: pageUrl, helpful: false, comment: feedback }); + setFeedbackState('submitted'); + }; + + const handleSkip = () => { + submitFeedback({ url: pageUrl, helpful: false }); + setFeedbackState('submitted'); + }; + + if (state === 'submitted') { + return ( +
+
+ Thank you for your feedback! +
+
+ ); + } + + return ( +
+
+ Was this information helpful? +
+
+ + +
+ + {state === 'not-helpful' && ( +
+

What can we improve?

+
+