From dd53b0c4e1443fee64e3db2fd03b80af93ff5849 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Mon, 30 Jun 2025 21:30:20 +0530 Subject: [PATCH 01/19] Update index.ts --- scripts/Converter/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/Converter/index.ts b/scripts/Converter/index.ts index 955ad1be6..cc980e725 100644 --- a/scripts/Converter/index.ts +++ b/scripts/Converter/index.ts @@ -164,7 +164,7 @@ class TypeDocInternalParser { ) => string; static GITHUB_LINK = - 'https://github.com/thoughtspot/visual-embed-sdk/blob/main/src'; + 'https://github.com/thoughtspot/visual-embed-sdk/blob/typo-fixes/src'; static covertTypeDocText = (text: string) => { // convert all {@link Name.hash} From 43188582434581d6265923efe36164b55679e3e6 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Mon, 30 Jun 2025 21:45:43 +0530 Subject: [PATCH 02/19] Update typedocConverter.json --- typedocConverter.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/typedocConverter.json b/typedocConverter.json index ce6f4a701..7798056e2 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { - "branch": "main", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/{branch}/static/typedoc/typedoc.json" + "branch": "typo-fixes", + "typeDocFilePath": "https://github.com/thoughtspot/visual-embed-sdk/blob/typo-fixes/static/typedoc/typedoc.json" } From 37f2a6ce72a03e90206e3b7aca015e38c1152041 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Mon, 30 Jun 2025 21:50:45 +0530 Subject: [PATCH 03/19] Update typedocConverter.json --- typedocConverter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/typedocConverter.json b/typedocConverter.json index 7798056e2..e470225ef 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { "branch": "typo-fixes", - "typeDocFilePath": "https://github.com/thoughtspot/visual-embed-sdk/blob/typo-fixes/static/typedoc/typedoc.json" + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/typo-fixes/static/typedoc/typedoc.json" } From 2387cda6f6e05adff4935464743bfa179794d5c0 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Mon, 30 Jun 2025 21:51:15 +0530 Subject: [PATCH 04/19] Update index.ts --- scripts/Converter/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/Converter/index.ts b/scripts/Converter/index.ts index cc980e725..955ad1be6 100644 --- a/scripts/Converter/index.ts +++ b/scripts/Converter/index.ts @@ -164,7 +164,7 @@ class TypeDocInternalParser { ) => string; static GITHUB_LINK = - 'https://github.com/thoughtspot/visual-embed-sdk/blob/typo-fixes/src'; + 'https://github.com/thoughtspot/visual-embed-sdk/blob/main/src'; static covertTypeDocText = (text: string) => { // convert all {@link Name.hash} From 92a58db9dcaad6dc0208deafeabb90f2f98d111d Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Tue, 8 Jul 2025 20:05:02 +0530 Subject: [PATCH 05/19] Update typedocConverter.json --- typedocConverter.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/typedocConverter.json b/typedocConverter.json index e470225ef..f187b2849 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { - "branch": "typo-fixes", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/typo-fixes/static/typedoc/typedoc.json" + "branch": "getInitConfig-desc-update", + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/getInitConfig-desc-update/static/typedoc/typedoc.json" } From cfe486b6e9b255312eeb0e63ee008ab352408898 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Fri, 18 Jul 2025 06:56:56 +0530 Subject: [PATCH 06/19] Update typedocConverter.json --- typedocConverter.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/typedocConverter.json b/typedocConverter.json index f187b2849..6874fb19e 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { - "branch": "getInitConfig-desc-update", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/getInitConfig-desc-update/static/typedoc/typedoc.json" + "branch": "typo-fix", + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/typo-fix/static/typedoc/typedoc.json" } From ed37a7ed99de55d157e909612bb37311768aa5f6 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Tue, 22 Jul 2025 10:45:44 +0530 Subject: [PATCH 07/19] Update typedocConverter.json --- typedocConverter.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/typedocConverter.json b/typedocConverter.json index 6874fb19e..13db95b0a 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { - "branch": "typo-fix", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/typo-fix/static/typedoc/typedoc.json" + "branch": "SCAL-262671", + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/SCAL-262671/static/typedoc/typedoc.json" } From 9ae161c0be428772235c762c9ef7284bf7a80cc6 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Thu, 24 Jul 2025 13:54:18 +0530 Subject: [PATCH 08/19] Update typedocConverter.json --- typedocConverter.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/typedocConverter.json b/typedocConverter.json index 13db95b0a..8ba709b8b 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { - "branch": "SCAL-262671", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/SCAL-262671/static/typedoc/typedoc.json" + "branch": "version-fix", + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/version-fix/static/typedoc/typedoc.json" } From 523e5d533af69af639be2b7dc75d25e8dc7c00a9 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Wed, 24 Sep 2025 10:55:03 +0530 Subject: [PATCH 09/19] Update typedocConverter.json --- typedocConverter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/typedocConverter.json b/typedocConverter.json index 8ba709b8b..ad26af73e 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { "branch": "version-fix", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/version-fix/static/typedoc/typedoc.json" + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/SCAL-273568-doc-fixes/static/typedoc/typedoc.json" } From 8694c95b9199efe37a69a61561d65d888a52bc03 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Tue, 21 Oct 2025 08:27:50 +0530 Subject: [PATCH 10/19] Update typedocConverter.json --- typedocConverter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/typedocConverter.json b/typedocConverter.json index ad26af73e..e1153c48e 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { "branch": "version-fix", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/SCAL-273568-doc-fixes/static/typedoc/typedoc.json" + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/doc-fixes-WS-terminology-update/static/typedoc/typedoc.json" } From e659a72fbfbb0695475ab502c75b243c725d1948 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Fri, 24 Oct 2025 08:37:54 +0530 Subject: [PATCH 11/19] Update typedocConverter.json --- typedocConverter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/typedocConverter.json b/typedocConverter.json index e1153c48e..5b6755229 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { "branch": "version-fix", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/doc-fixes-WS-terminology-update/static/typedoc/typedoc.json" + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/SCAL-256747-parameter-example/static/typedoc/typedoc.json" } From 9f4e06110afca8a4a08fc423692736db6a553a3c Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Wed, 17 Dec 2025 21:53:47 +0530 Subject: [PATCH 12/19] Update typedocConverter.json --- typedocConverter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/typedocConverter.json b/typedocConverter.json index 5b6755229..e3250f263 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { "branch": "version-fix", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/SCAL-256747-parameter-example/static/typedoc/typedoc.json" + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/v3-flag-updates-and-fixes/static/typedoc/typedoc.json" } From 8b791f442de3e6057003da102218dc90ec3c138b Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Sun, 11 Jan 2026 22:45:06 +0530 Subject: [PATCH 13/19] Update typedocConverter.json --- typedocConverter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/typedocConverter.json b/typedocConverter.json index e3250f263..a8dc1c3ae 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { "branch": "version-fix", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/v3-flag-updates-and-fixes/static/typedoc/typedoc.json" + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/doc-formatting-fixes/static/typedoc/typedoc.json" } From 34e52581c46832fdd4fe840d08d8cbe8f582c0aa Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Mon, 12 Jan 2026 06:28:46 +0530 Subject: [PATCH 14/19] Update index.ts --- scripts/Converter/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/Converter/index.ts b/scripts/Converter/index.ts index 955ad1be6..d1d28b2d4 100644 --- a/scripts/Converter/index.ts +++ b/scripts/Converter/index.ts @@ -195,7 +195,7 @@ class TypeDocInternalParser { if (tag.tag === 'example') return `${tag.text}\n`; if (tag.tag === 'param') { - return `\nParameter::\n${tag.text}\n`; + return `\nParameter::\n${this.covertTypeDocText(tag.text)}\n`; } if (tag.tag === 'deprecated') { return `[deprecated]#Deprecated : ${tag.text.replace( From cc157094e4c9d33cbad823950995fa9b0e34c190 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Mon, 12 Jan 2026 07:37:47 +0530 Subject: [PATCH 15/19] typedoc link converter --- scripts/Converter/index.ts | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/scripts/Converter/index.ts b/scripts/Converter/index.ts index d1d28b2d4..6691b95eb 100644 --- a/scripts/Converter/index.ts +++ b/scripts/Converter/index.ts @@ -167,21 +167,26 @@ class TypeDocInternalParser { 'https://github.com/thoughtspot/visual-embed-sdk/blob/main/src'; static covertTypeDocText = (text: string) => { - // convert all {@link Name.hash} - // to xref:Name.adoc#hash[Name] - const matches = text.match(/{@link\s[^{]+}/g); - if (!matches) return text; - const updatedText = matches?.reduce((prevUpdatedText, curLinkText) => { - const linkTo = curLinkText.split(/\s/)[1].replace('}', ''); - const newLinkText = this.convertNameToLink(linkTo, true); + // 1) Convert Markdown links -> AsciiDoc links + let updated = text.replace( + /\[([^\]]+)\]\((https?:\/\/[^)]+)\)/g, + 'link:$2[$1]', + ); - if (!newLinkText) return prevUpdatedText; + // 2) Existing logic: convert {@link Name.hash} -> xref:... + const matches = updated.match(/{@link\s[^{]+}/g); + if (!matches) return updated; - return prevUpdatedText.replace(curLinkText, newLinkText); - }, text); + const updatedText = matches.reduce((prevUpdatedText, curLinkText) => { + const linkTo = curLinkText.split(/\s/)[1].replace('}', ''); + const newLinkText = this.convertNameToLink(linkTo, true); + if (!newLinkText) return prevUpdatedText; + return prevUpdatedText.replace(curLinkText, newLinkText); + }, updated); - return updatedText; - }; + return updatedText; + }; +}; // function to parse a tag static parseTag(tag: TypeDocCommentTag): string { From 9d66810676d7e834ed5c617f369cf620d1027cdf Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Mon, 12 Jan 2026 07:48:37 +0530 Subject: [PATCH 16/19] Fix formatting issues in covertTypeDocText method --- scripts/Converter/index.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/scripts/Converter/index.ts b/scripts/Converter/index.ts index 6691b95eb..34034ca70 100644 --- a/scripts/Converter/index.ts +++ b/scripts/Converter/index.ts @@ -168,16 +168,16 @@ class TypeDocInternalParser { static covertTypeDocText = (text: string) => { // 1) Convert Markdown links -> AsciiDoc links - let updated = text.replace( - /\[([^\]]+)\]\((https?:\/\/[^)]+)\)/g, - 'link:$2[$1]', + let updated = text.replace( + /\[([^\]]+)\]\((https?:\/\/[^)]+)\)/g, + 'link:$2[$1]', ); // 2) Existing logic: convert {@link Name.hash} -> xref:... - const matches = updated.match(/{@link\s[^{]+}/g); + const matches = updated.match(/{@link\s[^{]+}/g); if (!matches) return updated; - const updatedText = matches.reduce((prevUpdatedText, curLinkText) => { + const updatedText = matches.reduce((prevUpdatedText, curLinkText) => { const linkTo = curLinkText.split(/\s/)[1].replace('}', ''); const newLinkText = this.convertNameToLink(linkTo, true); if (!newLinkText) return prevUpdatedText; @@ -185,7 +185,7 @@ class TypeDocInternalParser { }, updated); return updatedText; - }; + }; }; // function to parse a tag From 48f14a945deb2bef53cf0b82c255d60934b63aab Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Mon, 12 Jan 2026 07:57:54 +0530 Subject: [PATCH 17/19] Refactor TypeDocInternalParser methods for consistency --- scripts/Converter/index.ts | 40 +++++++++++++++----------------------- 1 file changed, 16 insertions(+), 24 deletions(-) diff --git a/scripts/Converter/index.ts b/scripts/Converter/index.ts index 34034ca70..cd213d1e0 100644 --- a/scripts/Converter/index.ts +++ b/scripts/Converter/index.ts @@ -155,38 +155,30 @@ const _indent = ( // All the parse functions are to be used internally (its used to get sub content) class TypeDocInternalParser { - static convertToItalic = (name: string | undefined) => - name ? `_${name}_` : ''; + static convertToItalic = (name: string | undefined) => (name ? `_${name}_` : ''); - static convertNameToLink: ( - node: string | undefined, - includeParent?: boolean, - ) => string; + static convertNameToLink: (node: string | undefined, includeParent?: boolean) => string; - static GITHUB_LINK = - 'https://github.com/thoughtspot/visual-embed-sdk/blob/main/src'; + static GITHUB_LINK = 'https://github.com/thoughtspot/visual-embed-sdk/blob/main/src'; - static covertTypeDocText = (text: string) => { + static covertTypeDocText = (text: string) => { // 1) Convert Markdown links -> AsciiDoc links - let updated = text.replace( - /\[([^\]]+)\]\((https?:\/\/[^)]+)\)/g, - 'link:$2[$1]', + const updated = text.replace( + /\[([^\]]+)\]\((https?:\/\/[^)]+)\)/g, + 'link:$2[$1]', ); // 2) Existing logic: convert {@link Name.hash} -> xref:... - const matches = updated.match(/{@link\s[^{]+}/g); - if (!matches) return updated; - - const updatedText = matches.reduce((prevUpdatedText, curLinkText) => { - const linkTo = curLinkText.split(/\s/)[1].replace('}', ''); - const newLinkText = this.convertNameToLink(linkTo, true); - if (!newLinkText) return prevUpdatedText; - return prevUpdatedText.replace(curLinkText, newLinkText); + const matches = updated.match(/{@link\s[^{]+}/g); + if (!matches) return updated; + + return matches.reduce((prevUpdatedText, curLinkText) => { + const linkTo = curLinkText.split(/\s/)[1].replace('}', ''); + const newLinkText = this.convertNameToLink(linkTo, true); + if (!newLinkText) return prevUpdatedText; + return prevUpdatedText.replace(curLinkText, newLinkText); }, updated); - - return updatedText; - }; -}; + }; // function to parse a tag static parseTag(tag: TypeDocCommentTag): string { From ef8e8433d5558956a0c3709e4cd5bb94adef22d9 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Mon, 12 Jan 2026 11:14:20 +0530 Subject: [PATCH 18/19] Update typedocConverter.json --- typedocConverter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/typedocConverter.json b/typedocConverter.json index a8dc1c3ae..b988e2276 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { "branch": "version-fix", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/doc-formatting-fixes/static/typedoc/typedoc.json" + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/SCAL-288312/static/typedoc/typedoc.json" } From e9f4c22785dd6e147f5c462674dfb9fae306a1a9 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Mon, 12 Jan 2026 11:30:49 +0530 Subject: [PATCH 19/19] Fix regex replacement for closing braces in links --- scripts/Converter/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/Converter/index.ts b/scripts/Converter/index.ts index cd213d1e0..8dd6b87ab 100644 --- a/scripts/Converter/index.ts +++ b/scripts/Converter/index.ts @@ -173,7 +173,7 @@ class TypeDocInternalParser { if (!matches) return updated; return matches.reduce((prevUpdatedText, curLinkText) => { - const linkTo = curLinkText.split(/\s/)[1].replace('}', ''); + const linkTo = curLinkText.split(/\s/)[1].replace(/}/g, ''); const newLinkText = this.convertNameToLink(linkTo, true); if (!newLinkText) return prevUpdatedText; return prevUpdatedText.replace(curLinkText, newLinkText);