@thoughtspot/visual-embed-sdk 1.10.0-alpha.0 → 1.10.0-alpha.3

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 (75) hide show
  1. package/CHANGELOG.md +48 -0
  2. package/README.md +50 -20
  3. package/dist/src/embed/app.d.ts +13 -1
  4. package/dist/src/embed/base.d.ts +1 -1
  5. package/dist/src/embed/liveboard.d.ts +15 -0
  6. package/dist/src/embed/pinboard.d.ts +91 -0
  7. package/dist/src/embed/ts-embed.d.ts +33 -4
  8. package/dist/src/react/index.d.ts +7 -5
  9. package/dist/src/react/util.d.ts +1 -1
  10. package/dist/src/types.d.ts +201 -7
  11. package/dist/src/utils/plugin.d.ts +0 -0
  12. package/dist/src/utils.d.ts +7 -0
  13. package/dist/src/v1/api.d.ts +19 -0
  14. package/dist/tsembed.es.js +262 -20
  15. package/dist/tsembed.js +262 -20
  16. package/lib/package.json +2 -2
  17. package/lib/src/embed/app.d.ts +13 -1
  18. package/lib/src/embed/app.js +11 -2
  19. package/lib/src/embed/app.js.map +1 -1
  20. package/lib/src/embed/app.spec.js +11 -10
  21. package/lib/src/embed/app.spec.js.map +1 -1
  22. package/lib/src/embed/base.d.ts +1 -1
  23. package/lib/src/embed/base.js +1 -1
  24. package/lib/src/embed/base.spec.js +13 -1
  25. package/lib/src/embed/base.spec.js.map +1 -1
  26. package/lib/src/embed/liveboard.d.ts +15 -0
  27. package/lib/src/embed/liveboard.js +7 -1
  28. package/lib/src/embed/liveboard.js.map +1 -1
  29. package/lib/src/embed/liveboard.spec.js +12 -1
  30. package/lib/src/embed/liveboard.spec.js.map +1 -1
  31. package/lib/src/embed/pinboard.d.ts +91 -0
  32. package/lib/src/embed/pinboard.js +110 -0
  33. package/lib/src/embed/pinboard.js.map +1 -0
  34. package/lib/src/embed/pinboard.spec.js +1 -1
  35. package/lib/src/embed/pinboard.spec.js.map +1 -1
  36. package/lib/src/embed/search.js +2 -1
  37. package/lib/src/embed/search.js.map +1 -1
  38. package/lib/src/embed/ts-embed.d.ts +33 -4
  39. package/lib/src/embed/ts-embed.js +61 -11
  40. package/lib/src/embed/ts-embed.js.map +1 -1
  41. package/lib/src/embed/ts-embed.spec.js +162 -8
  42. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  43. package/lib/src/react/index.d.ts +7 -5
  44. package/lib/src/react/index.js +10 -3
  45. package/lib/src/react/index.js.map +1 -1
  46. package/lib/src/react/index.spec.js +36 -6
  47. package/lib/src/react/index.spec.js.map +1 -1
  48. package/lib/src/react/util.d.ts +1 -1
  49. package/lib/src/react/util.js.map +1 -1
  50. package/lib/src/types.d.ts +201 -7
  51. package/lib/src/types.js +171 -4
  52. package/lib/src/types.js.map +1 -1
  53. package/lib/src/utils/plugin.d.ts +0 -0
  54. package/lib/src/utils/plugin.js +1 -0
  55. package/lib/src/utils/plugin.js.map +1 -0
  56. package/lib/src/utils.d.ts +7 -0
  57. package/lib/src/utils.js +9 -0
  58. package/lib/src/utils.js.map +1 -1
  59. package/lib/src/visual-embed-sdk.d.ts +263 -13
  60. package/package.json +2 -2
  61. package/src/embed/app.spec.ts +11 -10
  62. package/src/embed/app.ts +20 -2
  63. package/src/embed/base.spec.ts +14 -0
  64. package/src/embed/base.ts +1 -1
  65. package/src/embed/liveboard.spec.ts +14 -1
  66. package/src/embed/liveboard.ts +24 -0
  67. package/src/embed/pinboard.spec.ts +1 -1
  68. package/src/embed/search.ts +4 -1
  69. package/src/embed/ts-embed.spec.ts +228 -8
  70. package/src/embed/ts-embed.ts +97 -13
  71. package/src/react/index.spec.tsx +52 -5
  72. package/src/react/index.tsx +39 -22
  73. package/src/react/util.ts +2 -1
  74. package/src/types.ts +211 -5
  75. package/src/utils.ts +14 -0
@@ -2,10 +2,10 @@ import React from 'react';
2
2
  import '@testing-library/jest-dom';
3
3
  import '@testing-library/jest-dom/extend-expect';
4
4
  import { render, waitFor } from '@testing-library/react';
5
- import { getIFrameEl, getIFrameSrc, postMessageToParent, } from '../test/test-utils';
6
- import { SearchEmbed } from './index';
5
+ import { executeAfterWait, getIFrameEl, getIFrameSrc, postMessageToParent, } from '../test/test-utils';
6
+ import { SearchEmbed, LiveboardEmbed, useEmbedRef } from './index';
7
7
  import { AuthType, init } from '../index';
8
- import { EmbedEvent } from '../types';
8
+ import { EmbedEvent, HostEvent } from '../types';
9
9
  import { version } from '../../package.json';
10
10
  const thoughtSpotHost = 'localhost';
11
11
  beforeAll(() => {
@@ -17,16 +17,18 @@ beforeAll(() => {
17
17
  describe('React Components', () => {
18
18
  describe('SearchEmbed', () => {
19
19
  it('Should Render the Iframe with props', async () => {
20
- const { container } = render(React.createElement(SearchEmbed, { hideDataSources: true }));
20
+ const { container } = render(React.createElement(SearchEmbed, { hideDataSources: true, className: "embedClass" }));
21
21
  await waitFor(() => getIFrameEl(container));
22
+ expect(getIFrameEl(container).parentElement.classList.contains('embedClass')).toBe(true);
22
23
  expect(getIFrameSrc(container)).toBe(`http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&hideAction=[%22editACopy%22,%22saveAsView%22,%22updateTSL%22,%22editTSL%22,%22onDeleteAnswer%22]&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true#/embed/answer`);
23
24
  });
24
- it('Should attach event listeners', async () => {
25
+ it('Should attach event listeners', async (done) => {
25
26
  const userGUID = 'absfdfgd';
26
27
  const { container } = render(React.createElement(SearchEmbed, { onInit: (e) => {
27
28
  expect(e.data).toHaveProperty('timestamp');
28
29
  }, onAuthInit: (e) => {
29
30
  expect(e.data.userGUID).toEqual(userGUID);
31
+ done();
30
32
  } }));
31
33
  await waitFor(() => getIFrameEl(container));
32
34
  const iframe = getIFrameEl(container);
@@ -41,8 +43,36 @@ describe('React Components', () => {
41
43
  describe('AppEmbed', () => {
42
44
  //
43
45
  });
44
- describe('PinboardEmbed', () => {
46
+ describe('LiveboardEmbed', () => {
45
47
  //
48
+ it('Should be able to trigger events on the embed using refs', async () => {
49
+ const TestComponent = () => {
50
+ const embedRef = useEmbedRef();
51
+ const onLiveboardRendered = () => {
52
+ embedRef.current.trigger(HostEvent.SetVisibleVizs, [
53
+ 'viz1',
54
+ 'viz2',
55
+ ]);
56
+ };
57
+ return (React.createElement(LiveboardEmbed, { ref: embedRef, liveboardId: "abcd", onLiveboardRendered: onLiveboardRendered }));
58
+ };
59
+ const { container } = render(React.createElement(TestComponent, null));
60
+ await waitFor(() => getIFrameEl(container));
61
+ const iframe = getIFrameEl(container);
62
+ jest.spyOn(iframe.contentWindow, 'postMessage');
63
+ postMessageToParent(iframe.contentWindow, {
64
+ type: EmbedEvent.LiveboardRendered,
65
+ data: {
66
+ userGUID: 'abcd',
67
+ },
68
+ });
69
+ await executeAfterWait(() => {
70
+ expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith({
71
+ type: HostEvent.SetVisibleVizs,
72
+ data: ['viz1', 'viz2'],
73
+ }, `http://${thoughtSpotHost}`);
74
+ });
75
+ });
46
76
  });
47
77
  });
48
78
  //# sourceMappingURL=index.spec.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.spec.js","sourceRoot":"","sources":["../../../src/react/index.spec.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,2BAA2B,CAAC;AACnC,OAAO,yCAAyC,CAAC;AACjD,OAAO,EAAsB,MAAM,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EACH,WAAW,EACX,YAAY,EACZ,mBAAmB,GACtB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAA2B,MAAM,SAAS,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,MAAM,eAAe,GAAG,WAAW,CAAC;AAEpC,SAAS,CAAC,GAAG,EAAE;IACX,IAAI,CAAC;QACD,eAAe;QACf,QAAQ,EAAE,QAAQ,CAAC,IAAI;KAC1B,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACjD,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CACxB,oBAAC,WAAW,IAAC,eAAe,EAAE,IAAI,GAAI,CACzC,CAAC;YAEF,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YAE5C,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAChC,UAAU,eAAe,4EAA4E,OAAO,qLAAqL,CACpS,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;YAC3C,MAAM,QAAQ,GAAG,UAAU,CAAC;YAC5B,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CACxB,oBAAC,WAAW,IACR,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE;oBACV,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;gBAC/C,CAAC,EACD,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE;oBACd,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAC9C,CAAC,GACH,CACL,CAAC;YAEF,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YAC5C,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;YACtC,mBAAmB,CAAC,MAAM,CAAC,aAAa,EAAE;gBACtC,IAAI,EAAE,UAAU,CAAC,QAAQ;gBACzB,IAAI,EAAE;oBACF,QAAQ;iBACX;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QACtB,EAAE;IACN,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC3B,EAAE;IACN,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"index.spec.js","sourceRoot":"","sources":["../../../src/react/index.spec.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,2BAA2B,CAAC;AACnC,OAAO,yCAAyC,CAAC;AACjD,OAAO,EAAsB,MAAM,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EACH,gBAAgB,EAChB,WAAW,EACX,YAAY,EACZ,mBAAmB,GACtB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAY,cAAc,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC7E,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,MAAM,eAAe,GAAG,WAAW,CAAC;AAEpC,SAAS,CAAC,GAAG,EAAE;IACX,IAAI,CAAC;QACD,eAAe;QACf,QAAQ,EAAE,QAAQ,CAAC,IAAI;KAC1B,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACjD,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CACxB,oBAAC,WAAW,IAAC,eAAe,EAAE,IAAI,EAAE,SAAS,EAAC,YAAY,GAAG,CAChE,CAAC;YAEF,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YAE5C,MAAM,CACF,WAAW,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CACnD,YAAY,CACf,CACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAChC,UAAU,eAAe,4EAA4E,OAAO,qLAAqL,CACpS,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC/C,MAAM,QAAQ,GAAG,UAAU,CAAC;YAC5B,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CACxB,oBAAC,WAAW,IACR,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE;oBACV,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;gBAC/C,CAAC,EACD,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE;oBACd,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC1C,IAAI,EAAE,CAAC;gBACX,CAAC,GACH,CACL,CAAC;YAEF,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YAC5C,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;YACtC,mBAAmB,CAAC,MAAM,CAAC,aAAa,EAAE;gBACtC,IAAI,EAAE,UAAU,CAAC,QAAQ;gBACzB,IAAI,EAAE;oBACF,QAAQ;iBACX;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QACtB,EAAE;IACN,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC5B,EAAE;QACF,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACtE,MAAM,aAAa,GAAG,GAAG,EAAE;gBACvB,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;gBAC/B,MAAM,mBAAmB,GAAG,GAAG,EAAE;oBAC7B,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,cAAc,EAAE;wBAC/C,MAAM;wBACN,MAAM;qBACT,CAAC,CAAC;gBACP,CAAC,CAAC;gBAEF,OAAO,CACH,oBAAC,cAAc,IACX,GAAG,EAAE,QAAQ,EACb,WAAW,EAAC,MAAM,EAClB,mBAAmB,EAAE,mBAAmB,GAC1C,CACL,CAAC;YACN,CAAC,CAAC;YAEF,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC,oBAAC,aAAa,OAAG,CAAC,CAAC;YAEhD,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YAC5C,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;YACtC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;YAChD,mBAAmB,CAAC,MAAM,CAAC,aAAa,EAAE;gBACtC,IAAI,EAAE,UAAU,CAAC,iBAAiB;gBAClC,IAAI,EAAE;oBACF,QAAQ,EAAE,MAAM;iBACnB;aACJ,CAAC,CAAC;YACH,MAAM,gBAAgB,CAAC,GAAG,EAAE;gBACxB,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,oBAAoB,CACzD;oBACI,IAAI,EAAE,SAAS,CAAC,cAAc;oBAC9B,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;iBACzB,EACD,UAAU,eAAe,EAAE,CAC9B,CAAC;YACN,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
@@ -1,7 +1,7 @@
1
1
  import { EmbedEvent, MessageCallback } from '../types';
2
2
  import { ViewConfig } from '../embed/ts-embed';
3
3
  export declare type EmbedEventHandlers = {
4
- [key in EmbedEvent as `on${Capitalize<key>}`]?: MessageCallback;
4
+ [key in keyof typeof EmbedEvent as `on${Capitalize<key>}`]?: MessageCallback;
5
5
  };
6
6
  export interface EmbedProps extends ViewConfig, EmbedEventHandlers {
7
7
  className?: string;
@@ -1 +1 @@
1
- {"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/react/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAmB,MAAM,UAAU,CAAC;AAevD,MAAM,UAAU,wBAAwB,CAA6C,KAAQ;IACzF,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAC5B,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QACV,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACtB,MAAM,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAChC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;SACtD;aAAM;YACH,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;SACrC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC,EACD;QACI,UAAU,EAAE,EAAO;QACnB,SAAS,EAAE,EAAE;KAChB,CACJ,CAAC;AACN,CAAC"}
1
+ {"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/react/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAmB,MAAM,UAAU,CAAC;AAgBvD,MAAM,UAAU,wBAAwB,CAA6C,KAAQ;IACzF,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAC5B,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QACV,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACtB,MAAM,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAChC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;SACtD;aAAM;YACH,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;SACrC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC,EACD;QACI,UAAU,EAAE,EAAO;QACnB,SAAS,EAAE,EAAE;KAChB,CACJ,CAAC;AACN,CAAC"}
@@ -112,6 +112,13 @@ export interface EmbedConfig {
112
112
  * @default false
113
113
  */
114
114
  autoLogin?: boolean;
115
+ /**
116
+ * Disable redirection to the login page when the embedded session expires
117
+ * This flag is typically used alongside the combination of auth modes such as {@link AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
118
+ * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl
119
+ * @default false
120
+ */
121
+ disableLoginRedirect?: boolean;
115
122
  /**
116
123
  * Calls the prefetch method internally when set to true
117
124
  * @default false
@@ -133,11 +140,31 @@ export interface EmbedConfig {
133
140
  */
134
141
  customCssUrl?: string;
135
142
  }
143
+ /**
144
+ * MessagePayload: Embed event payload: message type, data and status (start/end)
145
+ */
136
146
  export declare type MessagePayload = {
137
147
  type: string;
138
148
  data: any;
149
+ status?: string;
150
+ };
151
+ /**
152
+ * MessageOptions: By Providing options, getting specific event start / end based on option
153
+ */
154
+ export declare type MessageOptions = {
155
+ start?: boolean;
139
156
  };
157
+ /**
158
+ * MessageCallback: Embed event message callback
159
+ */
140
160
  export declare type MessageCallback = (payload: MessagePayload, responder?: (data: any) => void) => void;
161
+ /**
162
+ * MessageCallbackObj: contains message options & callback function
163
+ */
164
+ export declare type MessageCallbackObj = {
165
+ options: MessageOptions;
166
+ callback: MessageCallback;
167
+ };
141
168
  export declare type GenericCallbackFn = (...args: any[]) => any;
142
169
  export declare type QueryParams = {
143
170
  [key: string]: string;
@@ -285,6 +312,12 @@ export declare enum EmbedEvent {
285
312
  * @version 1.5.0 or later
286
313
  */
287
314
  VizPointDoubleClick = "vizPointDoubleClick",
315
+ /**
316
+ * A click has been triggered on table/chart
317
+ * @return ContextMenuInputPoints - data point that is clicked
318
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
319
+ */
320
+ VizPointClick = "vizPointClick",
288
321
  /**
289
322
  * An error has occurred.
290
323
  * @return error - An error object or message
@@ -342,7 +375,109 @@ export declare enum EmbedEvent {
342
375
  * Emitted when any modal is closed in the app
343
376
  * @version 1.6.0 or later
344
377
  */
345
- DialogClose = "dialog-close"
378
+ DialogClose = "dialog-close",
379
+ /**
380
+ * Emitted when a liveboard has completed rendering,
381
+ * this event can be used as a hook to trigger events on the
382
+ * rendered liveboard
383
+ * @version 1.9.1 or later
384
+ */
385
+ LiveboardRendered = "PinboardRendered",
386
+ /**
387
+ * Emitted when answer is saved in the app
388
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
389
+ */
390
+ Save = "save",
391
+ /**
392
+ * Emitted when the download action is triggered on an answer
393
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
394
+ */
395
+ Download = "download",
396
+ /**
397
+ * Emitted when the Download as PDF action is triggered on an answer
398
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
399
+ */
400
+ DownloadAsPdf = "downloadAsPdf",
401
+ /**
402
+ * Emitted when the Download as CSV action is triggered on an answer
403
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
404
+ */
405
+ DownloadAsCsv = "downloadAsCsv",
406
+ /**
407
+ * Emitted when the Download as XLSX action is triggered on an answer
408
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
409
+ */
410
+ DownloadAsXlsx = "downloadAsXlsx",
411
+ /**
412
+ * Emitted when an answer is deleted in the app
413
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
414
+ */
415
+ AnswerDelete = "answerDelete",
416
+ /**
417
+ * Emitted when an answer is pinned to a Liveboard
418
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
419
+ */
420
+ Pin = "pin",
421
+ /**
422
+ * Emitted when SpotIQ analysis is triggered
423
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
424
+ */
425
+ SpotIQAnalyze = "spotIQAnalyze",
426
+ /**
427
+ * Emitted when a user shares an object with another user or group
428
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
429
+ */
430
+ Share = "share",
431
+ /**
432
+ * Emitted when a user clicks the Include action to include a specific value or data on a chart or table
433
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
434
+ */
435
+ DrillInclude = "context-menu-item-include",
436
+ /**
437
+ * Emitted when a user clicks the Exclude action to exclude a specific value or data on a chart or table
438
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
439
+ */
440
+ DrillExclude = "context-menu-item-exclude",
441
+ /**
442
+ * Emitted when copied column value on the app
443
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
444
+ */
445
+ CopyToClipboard = "context-menu-item-copy-to-clipboard",
446
+ /**
447
+ * Emitted when a user clicks the Update TML action
448
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
449
+ */
450
+ UpdateTML = "updateTSL",
451
+ /**
452
+ * Emitted when a user clicks the Edit TML action
453
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
454
+ */
455
+ EditTML = "editTSL",
456
+ /**
457
+ * Emitted when ExportTML trigger in answer on the app
458
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
459
+ */
460
+ ExportTML = "exportTSL",
461
+ /**
462
+ * Emitted when an answer is saved as a view
463
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
464
+ */
465
+ SaveAsView = "saveAsView",
466
+ /**
467
+ * Emitted when copy of existing answer on the app
468
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
469
+ */
470
+ CopyAEdit = "copyAEdit",
471
+ /**
472
+ * Emitted when a user clicks Show underlying data on an answe
473
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
474
+ */
475
+ ShowUnderlyingData = "showUnderlyingData",
476
+ /**
477
+ * Emitted when an answer is switched to a chart or table view
478
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
479
+ */
480
+ AnswerChartSwitcher = "answerChartSwitcher"
346
481
  }
347
482
  /**
348
483
  * Event types that can be triggered by the host application
@@ -439,7 +574,12 @@ export declare enum Param {
439
574
  ViewPortHeight = "viewPortHeight",
440
575
  ViewPortWidth = "viewPortWidth",
441
576
  VisibleActions = "visibleAction",
442
- CustomCSSUrl = "customCssUrl"
577
+ CustomCSSUrl = "customCssUrl",
578
+ DisableLoginRedirect = "disableLoginRedirect",
579
+ visibleVizs = "pinboardVisibleVizs",
580
+ LiveboardV2Enabled = "isPinboardV2Enabled",
581
+ ShowAlerts = "showAlerts",
582
+ Locale = "locale"
443
583
  }
444
584
  /**
445
585
  * The list of actions that can be performed on visual ThoughtSpot
@@ -447,30 +587,57 @@ export declare enum Param {
447
587
  */
448
588
  export declare enum Action {
449
589
  Save = "save",
590
+ /**
591
+ * @hidden
592
+ */
450
593
  Update = "update",
594
+ /**
595
+ * @hidden
596
+ */
451
597
  SaveUntitled = "saveUntitled",
452
598
  SaveAsView = "saveAsView",
453
599
  MakeACopy = "makeACopy",
454
600
  EditACopy = "editACopy",
455
601
  CopyLink = "embedDocument",
602
+ /**
603
+ * @hidden
604
+ */
456
605
  ResetLayout = "resetLayout",
457
606
  Schedule = "subscription",
458
607
  SchedulesList = "schedule-list",
459
608
  Share = "share",
460
609
  AddFilter = "addFilter",
461
610
  ConfigureFilter = "configureFilter",
611
+ /**
612
+ * @hidden
613
+ */
462
614
  AddFormula = "addFormula",
615
+ /**
616
+ * @hidden
617
+ */
463
618
  SearchOnTop = "searchOnTop",
464
619
  SpotIQAnalyze = "spotIQAnalyze",
620
+ /**
621
+ * @hidden
622
+ */
465
623
  ExplainInsight = "explainInsight",
624
+ /**
625
+ * @hidden
626
+ */
466
627
  SpotIQFollow = "spotIQFollow",
467
628
  ShareViz = "shareViz",
629
+ /**
630
+ * @hidden
631
+ */
468
632
  ReplaySearch = "replaySearch",
469
633
  ShowUnderlyingData = "showUnderlyingData",
470
634
  Download = "download",
471
635
  DownloadAsPdf = "downloadAsPdf",
472
636
  DownloadAsCsv = "downloadAsCSV",
473
637
  DownloadAsXlsx = "downloadAsXLSX",
638
+ /**
639
+ * @hidden
640
+ */
474
641
  DownloadTrace = "downloadTrace",
475
642
  ExportTML = "exportTSL",
476
643
  ImportTML = "importTSL",
@@ -481,18 +648,39 @@ export declare enum Action {
481
648
  Edit = "edit",
482
649
  EditTitle = "editTitle",
483
650
  Remove = "delete",
651
+ /**
652
+ * @hidden
653
+ */
484
654
  Ungroup = "ungroup",
655
+ /**
656
+ * @hidden
657
+ */
485
658
  Describe = "describe",
659
+ /**
660
+ * @hidden
661
+ */
486
662
  Relate = "relate",
663
+ /**
664
+ * @hidden
665
+ */
487
666
  CustomizeHeadlines = "customizeHeadlines",
488
667
  /**
489
668
  * @hidden
490
669
  */
491
670
  PinboardInfo = "pinboardInfo",
492
671
  LiveboardInfo = "pinboardInfo",
672
+ /**
673
+ * @hidden
674
+ */
493
675
  SendAnswerFeedback = "sendFeedback",
676
+ /**
677
+ * @hidden
678
+ */
494
679
  DownloadEmbraceQueries = "downloadEmbraceQueries",
495
680
  Pin = "pin",
681
+ /**
682
+ * @hidden
683
+ */
496
684
  AnalysisInfo = "analysisInfo",
497
685
  Subscription = "subscription",
498
686
  Explore = "explore",
@@ -500,16 +688,18 @@ export declare enum Action {
500
688
  DrillExclude = "context-menu-item-exclude",
501
689
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
502
690
  CopyAndEdit = "context-menu-item-copy-and-edit",
691
+ /**
692
+ * @hidden
693
+ */
503
694
  DrillEdit = "context-menu-item-edit",
504
695
  EditMeasure = "context-menu-item-edit-measure",
505
696
  Separator = "context-menu-item-separator",
697
+ /**
698
+ * @hidden
699
+ */
506
700
  DrillDown = "DRILL",
507
701
  RequestAccess = "requestAccess",
508
702
  QueryDetailsButtons = "queryDetailsButtons",
509
- /**
510
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
511
- */
512
- Monitor = "createMonitor",
513
703
  /**
514
704
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
515
705
  */
@@ -525,7 +715,11 @@ export declare enum Action {
525
715
  /**
526
716
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
527
717
  */
528
- EditDetails = "editDetails"
718
+ EditDetails = "editDetails",
719
+ /**
720
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
721
+ */
722
+ CreateMonitor = "createMonitor"
529
723
  }
530
724
  export interface SessionInterface {
531
725
  sessionId: string;
package/lib/src/types.js CHANGED
@@ -165,6 +165,12 @@ export var EmbedEvent;
165
165
  * @version 1.5.0 or later
166
166
  */
167
167
  EmbedEvent["VizPointDoubleClick"] = "vizPointDoubleClick";
168
+ /**
169
+ * A click has been triggered on table/chart
170
+ * @return ContextMenuInputPoints - data point that is clicked
171
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
172
+ */
173
+ EmbedEvent["VizPointClick"] = "vizPointClick";
168
174
  /**
169
175
  * An error has occurred.
170
176
  * @return error - An error object or message
@@ -223,6 +229,108 @@ export var EmbedEvent;
223
229
  * @version 1.6.0 or later
224
230
  */
225
231
  EmbedEvent["DialogClose"] = "dialog-close";
232
+ /**
233
+ * Emitted when a liveboard has completed rendering,
234
+ * this event can be used as a hook to trigger events on the
235
+ * rendered liveboard
236
+ * @version 1.9.1 or later
237
+ */
238
+ EmbedEvent["LiveboardRendered"] = "PinboardRendered";
239
+ /**
240
+ * Emitted when answer is saved in the app
241
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
242
+ */
243
+ EmbedEvent["Save"] = "save";
244
+ /**
245
+ * Emitted when the download action is triggered on an answer
246
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
247
+ */
248
+ EmbedEvent["Download"] = "download";
249
+ /**
250
+ * Emitted when the Download as PDF action is triggered on an answer
251
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
252
+ */
253
+ EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
254
+ /**
255
+ * Emitted when the Download as CSV action is triggered on an answer
256
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
257
+ */
258
+ EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
259
+ /**
260
+ * Emitted when the Download as XLSX action is triggered on an answer
261
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
262
+ */
263
+ EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
264
+ /**
265
+ * Emitted when an answer is deleted in the app
266
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
267
+ */
268
+ EmbedEvent["AnswerDelete"] = "answerDelete";
269
+ /**
270
+ * Emitted when an answer is pinned to a Liveboard
271
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
272
+ */
273
+ EmbedEvent["Pin"] = "pin";
274
+ /**
275
+ * Emitted when SpotIQ analysis is triggered
276
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
277
+ */
278
+ EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
279
+ /**
280
+ * Emitted when a user shares an object with another user or group
281
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
282
+ */
283
+ EmbedEvent["Share"] = "share";
284
+ /**
285
+ * Emitted when a user clicks the Include action to include a specific value or data on a chart or table
286
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
287
+ */
288
+ EmbedEvent["DrillInclude"] = "context-menu-item-include";
289
+ /**
290
+ * Emitted when a user clicks the Exclude action to exclude a specific value or data on a chart or table
291
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
292
+ */
293
+ EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
294
+ /**
295
+ * Emitted when copied column value on the app
296
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
297
+ */
298
+ EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
299
+ /**
300
+ * Emitted when a user clicks the Update TML action
301
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
302
+ */
303
+ EmbedEvent["UpdateTML"] = "updateTSL";
304
+ /**
305
+ * Emitted when a user clicks the Edit TML action
306
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
307
+ */
308
+ EmbedEvent["EditTML"] = "editTSL";
309
+ /**
310
+ * Emitted when ExportTML trigger in answer on the app
311
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
312
+ */
313
+ EmbedEvent["ExportTML"] = "exportTSL";
314
+ /**
315
+ * Emitted when an answer is saved as a view
316
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
317
+ */
318
+ EmbedEvent["SaveAsView"] = "saveAsView";
319
+ /**
320
+ * Emitted when copy of existing answer on the app
321
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
322
+ */
323
+ EmbedEvent["CopyAEdit"] = "copyAEdit";
324
+ /**
325
+ * Emitted when a user clicks Show underlying data on an answe
326
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
327
+ */
328
+ EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
329
+ /**
330
+ * Emitted when an answer is switched to a chart or table view
331
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
332
+ */
333
+ EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
226
334
  })(EmbedEvent || (EmbedEvent = {}));
227
335
  /**
228
336
  * Event types that can be triggered by the host application
@@ -326,6 +434,11 @@ export var Param;
326
434
  Param["ViewPortWidth"] = "viewPortWidth";
327
435
  Param["VisibleActions"] = "visibleAction";
328
436
  Param["CustomCSSUrl"] = "customCssUrl";
437
+ Param["DisableLoginRedirect"] = "disableLoginRedirect";
438
+ Param["visibleVizs"] = "pinboardVisibleVizs";
439
+ Param["LiveboardV2Enabled"] = "isPinboardV2Enabled";
440
+ Param["ShowAlerts"] = "showAlerts";
441
+ Param["Locale"] = "locale";
329
442
  })(Param || (Param = {}));
330
443
  /**
331
444
  * The list of actions that can be performed on visual ThoughtSpot
@@ -335,30 +448,57 @@ export var Param;
335
448
  export var Action;
336
449
  (function (Action) {
337
450
  Action["Save"] = "save";
451
+ /**
452
+ * @hidden
453
+ */
338
454
  Action["Update"] = "update";
455
+ /**
456
+ * @hidden
457
+ */
339
458
  Action["SaveUntitled"] = "saveUntitled";
340
459
  Action["SaveAsView"] = "saveAsView";
341
460
  Action["MakeACopy"] = "makeACopy";
342
461
  Action["EditACopy"] = "editACopy";
343
462
  Action["CopyLink"] = "embedDocument";
463
+ /**
464
+ * @hidden
465
+ */
344
466
  Action["ResetLayout"] = "resetLayout";
345
467
  Action["Schedule"] = "subscription";
346
468
  Action["SchedulesList"] = "schedule-list";
347
469
  Action["Share"] = "share";
348
470
  Action["AddFilter"] = "addFilter";
349
471
  Action["ConfigureFilter"] = "configureFilter";
472
+ /**
473
+ * @hidden
474
+ */
350
475
  Action["AddFormula"] = "addFormula";
476
+ /**
477
+ * @hidden
478
+ */
351
479
  Action["SearchOnTop"] = "searchOnTop";
352
480
  Action["SpotIQAnalyze"] = "spotIQAnalyze";
481
+ /**
482
+ * @hidden
483
+ */
353
484
  Action["ExplainInsight"] = "explainInsight";
485
+ /**
486
+ * @hidden
487
+ */
354
488
  Action["SpotIQFollow"] = "spotIQFollow";
355
489
  Action["ShareViz"] = "shareViz";
490
+ /**
491
+ * @hidden
492
+ */
356
493
  Action["ReplaySearch"] = "replaySearch";
357
494
  Action["ShowUnderlyingData"] = "showUnderlyingData";
358
495
  Action["Download"] = "download";
359
496
  Action["DownloadAsPdf"] = "downloadAsPdf";
360
497
  Action["DownloadAsCsv"] = "downloadAsCSV";
361
498
  Action["DownloadAsXlsx"] = "downloadAsXLSX";
499
+ /**
500
+ * @hidden
501
+ */
362
502
  Action["DownloadTrace"] = "downloadTrace";
363
503
  Action["ExportTML"] = "exportTSL";
364
504
  Action["ImportTML"] = "importTSL";
@@ -369,18 +509,39 @@ export var Action;
369
509
  Action["Edit"] = "edit";
370
510
  Action["EditTitle"] = "editTitle";
371
511
  Action["Remove"] = "delete";
512
+ /**
513
+ * @hidden
514
+ */
372
515
  Action["Ungroup"] = "ungroup";
516
+ /**
517
+ * @hidden
518
+ */
373
519
  Action["Describe"] = "describe";
520
+ /**
521
+ * @hidden
522
+ */
374
523
  Action["Relate"] = "relate";
524
+ /**
525
+ * @hidden
526
+ */
375
527
  Action["CustomizeHeadlines"] = "customizeHeadlines";
376
528
  /**
377
529
  * @hidden
378
530
  */
379
531
  Action["PinboardInfo"] = "pinboardInfo";
380
532
  Action["LiveboardInfo"] = "pinboardInfo";
533
+ /**
534
+ * @hidden
535
+ */
381
536
  Action["SendAnswerFeedback"] = "sendFeedback";
537
+ /**
538
+ * @hidden
539
+ */
382
540
  Action["DownloadEmbraceQueries"] = "downloadEmbraceQueries";
383
541
  Action["Pin"] = "pin";
542
+ /**
543
+ * @hidden
544
+ */
384
545
  Action["AnalysisInfo"] = "analysisInfo";
385
546
  Action["Subscription"] = "subscription";
386
547
  Action["Explore"] = "explore";
@@ -388,16 +549,18 @@ export var Action;
388
549
  Action["DrillExclude"] = "context-menu-item-exclude";
389
550
  Action["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
390
551
  Action["CopyAndEdit"] = "context-menu-item-copy-and-edit";
552
+ /**
553
+ * @hidden
554
+ */
391
555
  Action["DrillEdit"] = "context-menu-item-edit";
392
556
  Action["EditMeasure"] = "context-menu-item-edit-measure";
393
557
  Action["Separator"] = "context-menu-item-separator";
558
+ /**
559
+ * @hidden
560
+ */
394
561
  Action["DrillDown"] = "DRILL";
395
562
  Action["RequestAccess"] = "requestAccess";
396
563
  Action["QueryDetailsButtons"] = "queryDetailsButtons";
397
- /**
398
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
399
- */
400
- Action["Monitor"] = "createMonitor";
401
564
  /**
402
565
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
403
566
  */
@@ -414,6 +577,10 @@ export var Action;
414
577
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
415
578
  */
416
579
  Action["EditDetails"] = "editDetails";
580
+ /**
581
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
582
+ */
583
+ Action["CreateMonitor"] = "createMonitor";
417
584
  })(Action || (Action = {}));
418
585
  // eslint-disable-next-line no-shadow
419
586
  export var OperationType;