@thoughtspot/visual-embed-sdk 1.23.0 → 1.23.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/embed/app.d.ts +1 -1
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js +1 -1
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/base.d.ts +8 -0
  7. package/cjs/src/embed/base.d.ts.map +1 -1
  8. package/cjs/src/embed/base.js +8 -0
  9. package/cjs/src/embed/base.js.map +1 -1
  10. package/cjs/src/embed/sage.d.ts +14 -0
  11. package/cjs/src/embed/sage.d.ts.map +1 -1
  12. package/cjs/src/embed/sage.js +12 -3
  13. package/cjs/src/embed/sage.js.map +1 -1
  14. package/cjs/src/embed/sage.spec.js +1 -1
  15. package/cjs/src/embed/sage.spec.js.map +1 -1
  16. package/cjs/src/types.d.ts +364 -247
  17. package/cjs/src/types.d.ts.map +1 -1
  18. package/cjs/src/types.js +342 -241
  19. package/cjs/src/types.js.map +1 -1
  20. package/dist/src/embed/app.d.ts +1 -1
  21. package/dist/src/embed/app.d.ts.map +1 -1
  22. package/dist/src/embed/base.d.ts +8 -0
  23. package/dist/src/embed/base.d.ts.map +1 -1
  24. package/dist/src/embed/sage.d.ts +14 -0
  25. package/dist/src/embed/sage.d.ts.map +1 -1
  26. package/dist/src/types.d.ts +364 -247
  27. package/dist/src/types.d.ts.map +1 -1
  28. package/dist/tsembed-react.es.js +356 -246
  29. package/dist/tsembed-react.js +355 -245
  30. package/dist/tsembed.es.js +364 -246
  31. package/dist/tsembed.js +363 -245
  32. package/dist/visual-embed-sdk-react-full.d.ts +387 -248
  33. package/dist/visual-embed-sdk-react.d.ts +387 -248
  34. package/dist/visual-embed-sdk.d.ts +387 -248
  35. package/lib/package.json +1 -1
  36. package/lib/src/embed/app.d.ts +1 -1
  37. package/lib/src/embed/app.d.ts.map +1 -1
  38. package/lib/src/embed/app.js +1 -1
  39. package/lib/src/embed/app.js.map +1 -1
  40. package/lib/src/embed/base.d.ts +8 -0
  41. package/lib/src/embed/base.d.ts.map +1 -1
  42. package/lib/src/embed/base.js +8 -0
  43. package/lib/src/embed/base.js.map +1 -1
  44. package/lib/src/embed/sage.d.ts +14 -0
  45. package/lib/src/embed/sage.d.ts.map +1 -1
  46. package/lib/src/embed/sage.js +12 -3
  47. package/lib/src/embed/sage.js.map +1 -1
  48. package/lib/src/embed/sage.spec.js +1 -1
  49. package/lib/src/embed/sage.spec.js.map +1 -1
  50. package/lib/src/types.d.ts +364 -247
  51. package/lib/src/types.d.ts.map +1 -1
  52. package/lib/src/types.js +342 -241
  53. package/lib/src/types.js.map +1 -1
  54. package/lib/src/visual-embed-sdk.d.ts +387 -248
  55. package/package.json +1 -1
  56. package/src/embed/app.ts +1 -1
  57. package/src/embed/base.ts +8 -0
  58. package/src/embed/sage.spec.ts +1 -1
  59. package/src/embed/sage.ts +24 -2
  60. package/src/types.ts +351 -247
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thoughtspot/visual-embed-sdk",
3
- "version": "1.23.0",
3
+ "version": "1.23.1",
4
4
  "description": "ThoughtSpot Embed SDK",
5
5
  "module": "lib/src/index.js",
6
6
  "main": "dist/tsembed.js",
package/src/embed/app.ts CHANGED
@@ -47,7 +47,7 @@ export enum Page {
47
47
  /**
48
48
  * SpotIQ listing page
49
49
  */
50
- SpotIQ = 'spotiq',
50
+ SpotIQ = 'insights',
51
51
  }
52
52
 
53
53
  /**
package/src/embed/base.ts CHANGED
@@ -256,6 +256,10 @@ export const renderInQueue = (fn: (next?: (val?: any) => void) => Promise<any>):
256
256
  return fn(() => { }); // eslint-disable-line @typescript-eslint/no-empty-function
257
257
  };
258
258
 
259
+ /**
260
+ * @param data
261
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
262
+ */
259
263
  export const executeTML = async (data: executeTMLInput): Promise<any> => {
260
264
  const { thoughtSpotHost, authType } = config;
261
265
  try {
@@ -299,6 +303,10 @@ export const executeTML = async (data: executeTMLInput): Promise<any> => {
299
303
  });
300
304
  };
301
305
 
306
+ /**
307
+ * @param data
308
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
309
+ */
302
310
  export const exportTML = async (data: exportTMLInput): Promise<any> => {
303
311
  const { thoughtSpotHost, authType } = config;
304
312
  try {
@@ -37,7 +37,7 @@ describe('Sage embed tests', () => {
37
37
  await executeAfterWait(() => {
38
38
  expectUrlMatch(
39
39
  getIFrameSrc(),
40
- `http://${thoughtSpotHost}/?embedApp=true&hideEurekaResults=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=true&hideEurekaSuggestions=true&hideAction=%5B"save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
40
+ `http://${thoughtSpotHost}/?embedApp=true&hideEurekaResults=false&isSageEmbed=true&disableWorksheetChange=false&hideWorksheetSelector=true&hideEurekaSuggestions=true&hideAction=%5B"reportError","save","pin","editACopy","saveAsView","updateTSL","editTSL","onDeleteAnswer","share"%5D#/embed/eureka`,
41
41
  );
42
42
  });
43
43
  });
package/src/embed/sage.ts CHANGED
@@ -17,6 +17,7 @@ import { V1Embed } from './ts-embed';
17
17
  * The configuration attributes for the embedded Natural language search view. Based on
18
18
  * GPT and LLM.
19
19
  *
20
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
20
21
  * @group Embed components
21
22
  */
22
23
  export interface SageViewConfig extends ViewConfig {
@@ -37,6 +38,19 @@ export interface SageViewConfig extends ViewConfig {
37
38
  *
38
39
  */
39
40
  showObjectSuggestions?: boolean;
41
+ /**
42
+ * The query string to pre-fill in natual language search bar
43
+ */
44
+ searchQuery?: string;
45
+ /**
46
+ * If set to true, sample questions would be hidden to user.
47
+ * These sample questions are autogenerated based on selected datasource.
48
+ */
49
+ hideSampleQuestions?: boolean;
50
+ /**
51
+ * The data source GUID to set on load.
52
+ */
53
+ dataSource?: string;
40
54
  }
41
55
  export const HiddenActionItemByDefaultForSageEmbed = [
42
56
  Action.Save,
@@ -78,15 +92,17 @@ export class SageEmbed extends V1Embed {
78
92
  disableWorksheetChange,
79
93
  hideWorksheetSelector,
80
94
  showObjectSuggestions,
95
+ hideSampleQuestions,
81
96
  } = this.viewConfig;
82
97
 
83
- const params = {};
98
+ const params = this.getBaseQueryParams();
84
99
  params[Param.EmbedApp] = true;
85
100
  params[Param.HideEurekaResults] = !showObjectResults;
86
101
  params[Param.IsSageEmbed] = true;
87
102
  params[Param.DisableWorksheetChange] = !!disableWorksheetChange;
88
103
  params[Param.HideWorksheetSelector] = !!hideWorksheetSelector;
89
104
  params[Param.HideEurekaSuggestions] = !showObjectSuggestions;
105
+ params[Param.HideSampleQuestions] = !hideSampleQuestions;
90
106
  params[Param.HideActions] = [
91
107
  ...(params[Param.HideActions] ?? []),
92
108
  ...HiddenActionItemByDefaultForSageEmbed,
@@ -103,9 +119,15 @@ export class SageEmbed extends V1Embed {
103
119
  */
104
120
  private getIFrameSrc() {
105
121
  const path = 'eureka';
122
+ const postHashObj = {};
106
123
  const tsPostHashParams = this.getThoughtSpotPostUrlParams();
107
124
 
108
- return `${this.getRootIframeSrc()}/embed/${path}${tsPostHashParams}`;
125
+ if (this.viewConfig.searchQuery) postHashObj[Param.Query] = this.viewConfig.searchQuery;
126
+ if (this.viewConfig.dataSource) postHashObj[Param.WorksheetId] = this.viewConfig.dataSource;
127
+ let sagePostHashParams = new URLSearchParams(postHashObj).toString();
128
+ if (sagePostHashParams) sagePostHashParams = `${tsPostHashParams ? '&' : '?'}${sagePostHashParams}`;
129
+
130
+ return `${this.getRootIframeSrc()}/embed/${path}${tsPostHashParams}${sagePostHashParams}`;
109
131
  }
110
132
 
111
133
  /**