@thoughtspot/visual-embed-sdk 1.9.0-alpha.0 → 1.9.2
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.
- package/CHANGELOG.md +10 -0
- package/README.md +50 -20
- package/dist/src/embed/base.d.ts +1 -1
- package/dist/src/embed/liveboard.d.ts +7 -0
- package/dist/src/embed/search.d.ts +4 -0
- package/dist/src/embed/ts-embed.d.ts +1 -1
- package/dist/src/react/index.d.ts +7 -5
- package/dist/src/react/util.d.ts +1 -1
- package/dist/src/types.d.ts +18 -9
- package/dist/tsembed.es.js +24 -12
- package/dist/tsembed.js +24 -12
- package/lib/package.json +1 -1
- package/lib/src/auth.js +1 -1
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.js +5 -5
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +1 -1
- package/lib/src/embed/base.js +1 -1
- package/lib/src/embed/liveboard.d.ts +7 -0
- package/lib/src/embed/liveboard.js +4 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +11 -0
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/search.d.ts +4 -0
- package/lib/src/embed/search.js +1 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +1 -1
- package/lib/src/react/index.d.ts +7 -5
- package/lib/src/react/index.js +10 -3
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +34 -5
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/react/util.d.ts +1 -1
- package/lib/src/react/util.js.map +1 -1
- package/lib/src/types.d.ts +18 -9
- package/lib/src/types.js +16 -7
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +31 -11
- package/package.json +1 -1
- package/src/auth.spec.ts +15 -5
- package/src/auth.ts +1 -1
- package/src/embed/base.ts +1 -1
- package/src/embed/liveboard.spec.ts +13 -0
- package/src/embed/liveboard.ts +11 -0
- package/src/embed/search.ts +5 -0
- package/src/embed/ts-embed.ts +1 -1
- package/src/react/index.spec.tsx +46 -4
- package/src/react/index.tsx +33 -22
- package/src/react/util.ts +2 -1
- package/src/types.ts +16 -7
package/CHANGELOG.md
CHANGED
|
@@ -2,12 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
Please find the comprehensive list of changes for ThoughtSpot releases and SDK [here](https://developers.thoughtspot.com/docs/?pageid=whats-new)
|
|
4
4
|
|
|
5
|
+
## 1.8.1
|
|
6
|
+
|
|
7
|
+
### Bug fix
|
|
8
|
+
|
|
9
|
+
- `authEndpoint` in AuthServer authentication scheme was failing because of a missing `await`.
|
|
10
|
+
|
|
5
11
|
## 1.8.0
|
|
6
12
|
|
|
7
13
|
### Breaking Changes
|
|
8
14
|
|
|
9
15
|
- `autoLogin` option in `init` method is now by default `false` instead of `true`.
|
|
10
16
|
|
|
17
|
+
### New Features
|
|
18
|
+
|
|
19
|
+
- `init` method now returns the `authPromise` which resolves when auth is complete.
|
|
20
|
+
|
|
11
21
|
## 1.7.0 (and earlier)
|
|
12
22
|
|
|
13
23
|
- Please check the full list of changes [here](https://developers.thoughtspot.com/docs/?pageid=whats-new)
|
package/README.md
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
|
|
2
1
|
<p align="center">
|
|
3
2
|
<img src="https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/main/static/doc-images/images/TS-Logo-black-no-bg.svg" width=100 align="center" alt="ThoughtSpot" />
|
|
4
3
|
</p>
|
|
5
4
|
|
|
6
5
|
<br/>
|
|
7
6
|
|
|
8
|
-
# ThoughtSpot Visual Embed SDK
|
|
7
|
+
# ThoughtSpot Visual Embed SDK [](https://coveralls.io/github/ts-blink/embed-sdk?branch=main)  [](https://www.jsdelivr.com/package/npm/@thoughtspot/visual-embed-sdk)
|
|
9
8
|
|
|
10
9
|
SDK to embed ThoughtSpot into your web apps.
|
|
11
10
|
|
|
@@ -28,11 +27,16 @@ The SDK is written in TypeScript and is also provided both as ES Module (ESM) an
|
|
|
28
27
|
import * as TsEmbedSDK from '@thoughtspot/visual-embed-sdk';
|
|
29
28
|
|
|
30
29
|
// NPM <script>
|
|
31
|
-
<script src=
|
|
30
|
+
<script src="https://cdn.jsdelivr.net/npm/@thoughtspot/visual-embed-sdk/dist/tsembed.js"></script>;
|
|
32
31
|
|
|
33
32
|
// ES6 from web
|
|
34
|
-
import {
|
|
33
|
+
import {
|
|
34
|
+
LiveboardEmbed,
|
|
35
|
+
AuthType,
|
|
36
|
+
init,
|
|
37
|
+
} from 'https://cdn.jsdelivr.net/npm/@thoughtspot/visual-embed-sdk/dist/tsembed.es.js';
|
|
35
38
|
```
|
|
39
|
+
|
|
36
40
|
<br/>
|
|
37
41
|
|
|
38
42
|
## Live Playground
|
|
@@ -43,8 +47,8 @@ Visit our [code playground](https://try-everywhere.thoughtspot.cloud/v2/#/everyw
|
|
|
43
47
|
|
|
44
48
|
## Full API Reference
|
|
45
49
|
|
|
46
|
-
-
|
|
47
|
-
-
|
|
50
|
+
- Detailed [developer guide](https://try-everywhere.thoughtspot.cloud/v2/#/everywhere/documentation/en/?pageid=getting-started).
|
|
51
|
+
- Please visit our [API reference docs](https://developers.thoughtspot.com/docs/typedoc/modules.html).
|
|
48
52
|
|
|
49
53
|
<br/>
|
|
50
54
|
|
|
@@ -55,7 +59,7 @@ liveboards, visualizations or the even full app version.
|
|
|
55
59
|
|
|
56
60
|
### Embedded Search
|
|
57
61
|
|
|
58
|
-
```js
|
|
62
|
+
```js
|
|
59
63
|
// NPM
|
|
60
64
|
import { SearchEmbed, AuthType, init } from '@thoughtspot/visual-embed-sdk';
|
|
61
65
|
// or ES6
|
|
@@ -117,15 +121,13 @@ init({
|
|
|
117
121
|
authType: AuthType.None,
|
|
118
122
|
});
|
|
119
123
|
|
|
120
|
-
const appEmbed = new AppEmbed(
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
pageId: Page.Data,
|
|
128
|
-
});
|
|
124
|
+
const appEmbed = new AppEmbed(document.getElementById('ts-embed'), {
|
|
125
|
+
frameParams: {
|
|
126
|
+
width: '100%',
|
|
127
|
+
height: '100%',
|
|
128
|
+
},
|
|
129
|
+
pageId: Page.Data,
|
|
130
|
+
});
|
|
129
131
|
|
|
130
132
|
appEmbed.render();
|
|
131
133
|
```
|
|
@@ -136,6 +138,7 @@ All the above flavors of embedding are also provided as React components for you
|
|
|
136
138
|
The constructor options are passed as props and the event listeners can be attached using `on<EventName>` convention.
|
|
137
139
|
|
|
138
140
|
### Search Component
|
|
141
|
+
|
|
139
142
|
```js
|
|
140
143
|
import { init } from '@thoughtspot/visual-embed-sdk';
|
|
141
144
|
import { SearchEmbed } from '@thoughtspot/visual-embed-sdk/react';
|
|
@@ -153,12 +156,39 @@ const MyComponent = ({ dataSources }) => {
|
|
|
153
156
|
const onCustomAction = (actionEvent) => {
|
|
154
157
|
// Do something with actionEvent.
|
|
155
158
|
};
|
|
156
|
-
|
|
157
|
-
return
|
|
158
|
-
|
|
159
|
+
|
|
160
|
+
return (
|
|
161
|
+
<SearchEmbed
|
|
162
|
+
dataSources={dataSources}
|
|
163
|
+
onCustomAction={onCustomAction}
|
|
164
|
+
/>
|
|
165
|
+
);
|
|
166
|
+
};
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### Triggering events on React components
|
|
170
|
+
|
|
171
|
+
```jsx
|
|
172
|
+
import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
173
|
+
import { LiveboardEmbed, useEmbedRef } from '@thoughtspot/visual-embed-sdk/react';
|
|
174
|
+
|
|
175
|
+
const MyComponent = () => {
|
|
176
|
+
const embedRef = useEmbedRef();
|
|
177
|
+
const onLiveboardRendered = () => {
|
|
178
|
+
embedRef.current.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
179
|
+
};
|
|
180
|
+
|
|
181
|
+
return (
|
|
182
|
+
<LiveboardEmbed
|
|
183
|
+
ref={embedRef}
|
|
184
|
+
liveboardId="<liveboard-guid>"
|
|
185
|
+
onLiveboardRendered={onLiveboardRendered}
|
|
186
|
+
/>
|
|
187
|
+
);
|
|
188
|
+
};
|
|
159
189
|
```
|
|
160
190
|
|
|
161
|
-
###
|
|
191
|
+
###
|
|
162
192
|
|
|
163
193
|
<br/>
|
|
164
194
|
<br/>
|
package/dist/src/embed/base.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ export declare const getAuthPromise: () => Promise<void>;
|
|
|
12
12
|
*/
|
|
13
13
|
export declare const prefetch: (url?: string) => void;
|
|
14
14
|
/**
|
|
15
|
-
* Initialize the ThoughtSpot embed
|
|
15
|
+
* Initialize the ThoughtSpot embed SDK globally and perform
|
|
16
16
|
* authentication if applicable.
|
|
17
17
|
* @param embedConfig The configuration object containing ThoughtSpot host,
|
|
18
18
|
* authentication mechanism and so on.
|
|
@@ -51,6 +51,13 @@ export interface LiveboardViewConfig extends ViewConfig {
|
|
|
51
51
|
* Liveboard page will be read-only (no X buttons)
|
|
52
52
|
*/
|
|
53
53
|
preventLiveboardFilterRemoval?: boolean;
|
|
54
|
+
/**
|
|
55
|
+
* Array of viz ids which should be visible when the liveboard
|
|
56
|
+
* first renders. This can be changed by triggering the "SetVisibleVizs"
|
|
57
|
+
* event.
|
|
58
|
+
* @version 1.9.1 or later
|
|
59
|
+
*/
|
|
60
|
+
visibleVizs?: string[];
|
|
54
61
|
/**
|
|
55
62
|
* To support backward compatibilty
|
|
56
63
|
* @hidden
|
|
@@ -44,6 +44,10 @@ export interface SearchViewConfig extends ViewConfig {
|
|
|
44
44
|
* using raw answer data.
|
|
45
45
|
*/
|
|
46
46
|
hideResults?: boolean;
|
|
47
|
+
/**
|
|
48
|
+
* If set to true, expands all the data sources panel.
|
|
49
|
+
*/
|
|
50
|
+
expandAllDataSource?: boolean;
|
|
47
51
|
/**
|
|
48
52
|
* If set to true, the Search Assist feature is enabled.
|
|
49
53
|
*/
|
|
@@ -71,7 +71,7 @@ export interface ViewConfig {
|
|
|
71
71
|
* This is an object (key/val) of override flags which will be applied
|
|
72
72
|
* to the internal embedded object. This can be used to add any
|
|
73
73
|
* URL flag.
|
|
74
|
-
* @version 1.8.0
|
|
74
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
75
75
|
*/
|
|
76
76
|
additionalFlags?: {
|
|
77
77
|
[key: string]: string | number | boolean;
|
|
@@ -1,16 +1,18 @@
|
|
|
1
|
-
|
|
1
|
+
import React from 'react';
|
|
2
2
|
import { SearchViewConfig } from '../embed/search';
|
|
3
3
|
import { AppViewConfig } from '../embed/app';
|
|
4
4
|
import { LiveboardViewConfig } from '../embed/liveboard';
|
|
5
|
+
import { TsEmbed } from '../embed/ts-embed';
|
|
5
6
|
import { EmbedProps } from './util';
|
|
6
7
|
interface SearchProps extends EmbedProps, SearchViewConfig {
|
|
7
8
|
}
|
|
8
|
-
export declare const SearchEmbed:
|
|
9
|
+
export declare const SearchEmbed: React.ForwardRefExoticComponent<SearchProps & React.RefAttributes<TsEmbed>>;
|
|
9
10
|
interface AppProps extends EmbedProps, AppViewConfig {
|
|
10
11
|
}
|
|
11
|
-
export declare const AppEmbed:
|
|
12
|
+
export declare const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttributes<TsEmbed>>;
|
|
12
13
|
interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
|
|
13
14
|
}
|
|
14
|
-
export declare const LiveboardEmbed:
|
|
15
|
-
export declare const PinboardEmbed:
|
|
15
|
+
export declare const LiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<TsEmbed>>;
|
|
16
|
+
export declare const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<TsEmbed>>;
|
|
17
|
+
export declare const useEmbedRef: () => React.MutableRefObject<TsEmbed>;
|
|
16
18
|
export {};
|
package/dist/src/react/util.d.ts
CHANGED
|
@@ -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;
|
package/dist/src/types.d.ts
CHANGED
|
@@ -270,7 +270,7 @@ export declare enum EmbedEvent {
|
|
|
270
270
|
/**
|
|
271
271
|
* One or more data columns have been selected.
|
|
272
272
|
* @return columnIds - the list of columns
|
|
273
|
-
* @version SDK: 1.
|
|
273
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl
|
|
274
274
|
*/
|
|
275
275
|
AddRemoveColumns = "addRemoveColumns",
|
|
276
276
|
/**
|
|
@@ -342,7 +342,14 @@ export declare enum EmbedEvent {
|
|
|
342
342
|
* Emitted when any modal is closed in the app
|
|
343
343
|
* @version 1.6.0 or later
|
|
344
344
|
*/
|
|
345
|
-
DialogClose = "dialog-close"
|
|
345
|
+
DialogClose = "dialog-close",
|
|
346
|
+
/**
|
|
347
|
+
* Emitted when a liveboard has completed rendering,
|
|
348
|
+
* this event can be used as a hook to trigger events on the
|
|
349
|
+
* rendered liveboard
|
|
350
|
+
* @version 1.9.1 or later
|
|
351
|
+
*/
|
|
352
|
+
LiveboardRendered = "PinboardRendered"
|
|
346
353
|
}
|
|
347
354
|
/**
|
|
348
355
|
* Event types that can be triggered by the host application
|
|
@@ -388,7 +395,7 @@ export declare enum HostEvent {
|
|
|
388
395
|
* Update the runtime filters. The runtime filters passed here are extended
|
|
389
396
|
* on to the existing runtime filters if they exist.
|
|
390
397
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
391
|
-
* @version 1.
|
|
398
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
392
399
|
*/
|
|
393
400
|
UpdateRuntimeFilters = "UpdateRuntimeFilters"
|
|
394
401
|
}
|
|
@@ -417,6 +424,7 @@ export declare enum DataSourceVisualMode {
|
|
|
417
424
|
export declare enum Param {
|
|
418
425
|
DataSources = "dataSources",
|
|
419
426
|
DataSourceMode = "dataSourceMode",
|
|
427
|
+
ExpandAllDataSource = "expandAllDataSource",
|
|
420
428
|
DisableActions = "disableAction",
|
|
421
429
|
DisableActionReason = "disableHint",
|
|
422
430
|
ForceTable = "forceTable",
|
|
@@ -439,7 +447,8 @@ export declare enum Param {
|
|
|
439
447
|
ViewPortHeight = "viewPortHeight",
|
|
440
448
|
ViewPortWidth = "viewPortWidth",
|
|
441
449
|
VisibleActions = "visibleAction",
|
|
442
|
-
CustomCSSUrl = "customCssUrl"
|
|
450
|
+
CustomCSSUrl = "customCssUrl",
|
|
451
|
+
visibleVizs = "pinboardVisibleVizs"
|
|
443
452
|
}
|
|
444
453
|
/**
|
|
445
454
|
* The list of actions that can be performed on visual ThoughtSpot
|
|
@@ -507,23 +516,23 @@ export declare enum Action {
|
|
|
507
516
|
RequestAccess = "requestAccess",
|
|
508
517
|
QueryDetailsButtons = "queryDetailsButtons",
|
|
509
518
|
/**
|
|
510
|
-
* @version SDK: 1.
|
|
519
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
511
520
|
*/
|
|
512
521
|
Monitor = "createMonitor",
|
|
513
522
|
/**
|
|
514
|
-
* @version SDK: 1.
|
|
523
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
515
524
|
*/
|
|
516
525
|
AnswerDelete = "onDeleteAnswer",
|
|
517
526
|
/**
|
|
518
|
-
* @version SDK: 1.
|
|
527
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
519
528
|
*/
|
|
520
529
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
521
530
|
/**
|
|
522
|
-
* @version SDK: 1.
|
|
531
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
523
532
|
*/
|
|
524
533
|
AddToFavorites = "addToFavorites",
|
|
525
534
|
/**
|
|
526
|
-
* @version SDK: 1.
|
|
535
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
527
536
|
*/
|
|
528
537
|
EditDetails = "editDetails"
|
|
529
538
|
}
|
package/dist/tsembed.es.js
CHANGED
|
@@ -262,7 +262,7 @@ var EmbedEvent;
|
|
|
262
262
|
/**
|
|
263
263
|
* One or more data columns have been selected.
|
|
264
264
|
* @return columnIds - the list of columns
|
|
265
|
-
* @version SDK: 1.
|
|
265
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl
|
|
266
266
|
*/
|
|
267
267
|
EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
|
|
268
268
|
/**
|
|
@@ -335,6 +335,13 @@ var EmbedEvent;
|
|
|
335
335
|
* @version 1.6.0 or later
|
|
336
336
|
*/
|
|
337
337
|
EmbedEvent["DialogClose"] = "dialog-close";
|
|
338
|
+
/**
|
|
339
|
+
* Emitted when a liveboard has completed rendering,
|
|
340
|
+
* this event can be used as a hook to trigger events on the
|
|
341
|
+
* rendered liveboard
|
|
342
|
+
* @version 1.9.1 or later
|
|
343
|
+
*/
|
|
344
|
+
EmbedEvent["LiveboardRendered"] = "PinboardRendered";
|
|
338
345
|
})(EmbedEvent || (EmbedEvent = {}));
|
|
339
346
|
/**
|
|
340
347
|
* Event types that can be triggered by the host application
|
|
@@ -382,7 +389,7 @@ var HostEvent;
|
|
|
382
389
|
* Update the runtime filters. The runtime filters passed here are extended
|
|
383
390
|
* on to the existing runtime filters if they exist.
|
|
384
391
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
385
|
-
* @version 1.
|
|
392
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
386
393
|
*/
|
|
387
394
|
HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
|
|
388
395
|
})(HostEvent || (HostEvent = {}));
|
|
@@ -415,6 +422,7 @@ var Param;
|
|
|
415
422
|
(function (Param) {
|
|
416
423
|
Param["DataSources"] = "dataSources";
|
|
417
424
|
Param["DataSourceMode"] = "dataSourceMode";
|
|
425
|
+
Param["ExpandAllDataSource"] = "expandAllDataSource";
|
|
418
426
|
Param["DisableActions"] = "disableAction";
|
|
419
427
|
Param["DisableActionReason"] = "disableHint";
|
|
420
428
|
Param["ForceTable"] = "forceTable";
|
|
@@ -438,6 +446,7 @@ var Param;
|
|
|
438
446
|
Param["ViewPortWidth"] = "viewPortWidth";
|
|
439
447
|
Param["VisibleActions"] = "visibleAction";
|
|
440
448
|
Param["CustomCSSUrl"] = "customCssUrl";
|
|
449
|
+
Param["visibleVizs"] = "pinboardVisibleVizs";
|
|
441
450
|
})(Param || (Param = {}));
|
|
442
451
|
/**
|
|
443
452
|
* The list of actions that can be performed on visual ThoughtSpot
|
|
@@ -507,23 +516,23 @@ var Action;
|
|
|
507
516
|
Action["RequestAccess"] = "requestAccess";
|
|
508
517
|
Action["QueryDetailsButtons"] = "queryDetailsButtons";
|
|
509
518
|
/**
|
|
510
|
-
* @version SDK: 1.
|
|
519
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
511
520
|
*/
|
|
512
521
|
Action["Monitor"] = "createMonitor";
|
|
513
522
|
/**
|
|
514
|
-
* @version SDK: 1.
|
|
523
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
515
524
|
*/
|
|
516
525
|
Action["AnswerDelete"] = "onDeleteAnswer";
|
|
517
526
|
/**
|
|
518
|
-
* @version SDK: 1.
|
|
527
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
519
528
|
*/
|
|
520
529
|
Action["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
521
530
|
/**
|
|
522
|
-
* @version SDK: 1.
|
|
531
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
523
532
|
*/
|
|
524
533
|
Action["AddToFavorites"] = "addToFavorites";
|
|
525
534
|
/**
|
|
526
|
-
* @version SDK: 1.
|
|
535
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
527
536
|
*/
|
|
528
537
|
Action["EditDetails"] = "editDetails";
|
|
529
538
|
})(Action || (Action = {}));
|
|
@@ -8591,7 +8600,7 @@ const doTokenAuth = async (embedConfig) => {
|
|
|
8591
8600
|
}
|
|
8592
8601
|
else {
|
|
8593
8602
|
const response = await fetchAuthTokenService(authEndpoint);
|
|
8594
|
-
authToken = response.text();
|
|
8603
|
+
authToken = await response.text();
|
|
8595
8604
|
}
|
|
8596
8605
|
await fetchAuthService(thoughtSpotHost, username, authToken);
|
|
8597
8606
|
loggedInStatus = false;
|
|
@@ -8745,7 +8754,7 @@ const prefetch = (url) => {
|
|
|
8745
8754
|
}
|
|
8746
8755
|
};
|
|
8747
8756
|
/**
|
|
8748
|
-
* Initialize the ThoughtSpot embed
|
|
8757
|
+
* Initialize the ThoughtSpot embed SDK globally and perform
|
|
8749
8758
|
* authentication if applicable.
|
|
8750
8759
|
* @param embedConfig The configuration object containing ThoughtSpot host,
|
|
8751
8760
|
* authentication mechanism and so on.
|
|
@@ -8899,7 +8908,7 @@ function processTrigger(iFrame, messageType, thoughtSpotHost, data) {
|
|
|
8899
8908
|
}
|
|
8900
8909
|
}
|
|
8901
8910
|
|
|
8902
|
-
var name="@thoughtspot/visual-embed-sdk";var version="1.9.
|
|
8911
|
+
var name="@thoughtspot/visual-embed-sdk";var version="1.9.2";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**"];var exports={".":"./lib/src/index.js","./react":"./lib/src/react/index.js"};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p . --incremental false",start:"gatsby develop","build:gatsby":"npm run clean:gatsby && gatsby build --prefix-paths","build:gatsby:noprefix":"npm run clean:gatsby && gatsby build","serve:gatsby":"gatsby serve","clean:gatsby":"gatsby clean","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts",build:"rollup -c",watch:"rollup -cw","docs-cmd":"node scripts/gatsby-commands.js",docgen:"typedoc --tsconfig tsconfig.json --theme typedoc-theme","test-sdk":"jest -c jest.config.sdk.js","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs && npx istanbul-merge --out ./coverage/coverage.json ./coverage/docs/coverage-final.json ./coverage/sdk/coverage-final.json && npx istanbul report --include ./coverage/coverage.json --dir ./coverage lcov",posttest:"cat ./coverage/lcov.info | coveralls",prepublishOnly:"npm run test; npm run tsc; npm run bundle-dts; npm run build","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={algoliasearch:"^4.10.5",classnames:"^2.3.1","mixpanel-browser":"^2.41.0"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1",coveralls:"^3.1.0","dts-bundle":"0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","fs-extra":"^10.0.0",gatsby:"3.1.0","gatsby-plugin-algolia":"^0.22.2","gatsby-plugin-catch-links":"^3.1.0","gatsby-plugin-env-variables":"^2.1.0","gatsby-plugin-intl":"^0.3.3","gatsby-plugin-manifest":"^3.2.0","gatsby-plugin-output":"^0.1.3","gatsby-plugin-sass":"4.1.0","gatsby-plugin-sitemap":"^4.10.0","gatsby-source-filesystem":"3.1.0","gatsby-transformer-asciidoc":"2.1.0","gatsby-transformer-rehype":"2.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-puppeteer":"^4.4.0",jsdom:"^17.0.0","node-sass":"^4.0.0",prettier:"2.1.2",puppeteer:"^7.0.1",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"2.30.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-neo-theme":"^1.1.0","typedoc-plugin-toc-group":"0.0.5",typescript:"^4.1.0","url-search-params-polyfill":"^8.1.0",util:"^0.12.4"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version,description:description,module:module,main:main,types:types,files:files,exports:exports,scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
|
|
8903
8912
|
|
|
8904
8913
|
/**
|
|
8905
8914
|
* Copyright (c) 2022
|
|
@@ -9525,7 +9534,7 @@ class LiveboardEmbed extends V1Embed {
|
|
|
9525
9534
|
*/
|
|
9526
9535
|
getEmbedParams() {
|
|
9527
9536
|
const params = this.getBaseQueryParams();
|
|
9528
|
-
const { enableVizTransformations, fullHeight, defaultHeight, } = this.viewConfig;
|
|
9537
|
+
const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, } = this.viewConfig;
|
|
9529
9538
|
const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval ||
|
|
9530
9539
|
this.viewConfig.preventPinboardFilterRemoval;
|
|
9531
9540
|
if (fullHeight === true) {
|
|
@@ -9540,6 +9549,9 @@ class LiveboardEmbed extends V1Embed {
|
|
|
9540
9549
|
if (preventLiveboardFilterRemoval) {
|
|
9541
9550
|
params[Param.preventLiveboardFilterRemoval] = true;
|
|
9542
9551
|
}
|
|
9552
|
+
if (visibleVizs) {
|
|
9553
|
+
params[Param.visibleVizs] = visibleVizs;
|
|
9554
|
+
}
|
|
9543
9555
|
params[Param.livedBoardEmbed] = true;
|
|
9544
9556
|
const queryParams = getQueryParamString(params, true);
|
|
9545
9557
|
return queryParams;
|
|
@@ -9640,7 +9652,7 @@ class SearchEmbed extends TsEmbed {
|
|
|
9640
9652
|
*/
|
|
9641
9653
|
getIFrameSrc(answerId, dataSources) {
|
|
9642
9654
|
var _a;
|
|
9643
|
-
const { hideResults, enableSearchAssist, forceTable, searchOptions, } = this.viewConfig;
|
|
9655
|
+
const { hideResults, expandAllDataSource, enableSearchAssist, forceTable, searchOptions, } = this.viewConfig;
|
|
9644
9656
|
const answerPath = answerId ? `saved-answer/${answerId}` : 'answer';
|
|
9645
9657
|
const queryParams = this.getBaseQueryParams();
|
|
9646
9658
|
queryParams[Param.HideActions] = [
|
package/dist/tsembed.js
CHANGED
|
@@ -252,7 +252,7 @@
|
|
|
252
252
|
/**
|
|
253
253
|
* One or more data columns have been selected.
|
|
254
254
|
* @return columnIds - the list of columns
|
|
255
|
-
* @version SDK: 1.
|
|
255
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl
|
|
256
256
|
*/
|
|
257
257
|
EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
|
|
258
258
|
/**
|
|
@@ -325,6 +325,13 @@
|
|
|
325
325
|
* @version 1.6.0 or later
|
|
326
326
|
*/
|
|
327
327
|
EmbedEvent["DialogClose"] = "dialog-close";
|
|
328
|
+
/**
|
|
329
|
+
* Emitted when a liveboard has completed rendering,
|
|
330
|
+
* this event can be used as a hook to trigger events on the
|
|
331
|
+
* rendered liveboard
|
|
332
|
+
* @version 1.9.1 or later
|
|
333
|
+
*/
|
|
334
|
+
EmbedEvent["LiveboardRendered"] = "PinboardRendered";
|
|
328
335
|
})(exports.EmbedEvent || (exports.EmbedEvent = {}));
|
|
329
336
|
(function (HostEvent) {
|
|
330
337
|
/**
|
|
@@ -363,7 +370,7 @@
|
|
|
363
370
|
* Update the runtime filters. The runtime filters passed here are extended
|
|
364
371
|
* on to the existing runtime filters if they exist.
|
|
365
372
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
366
|
-
* @version 1.
|
|
373
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
367
374
|
*/
|
|
368
375
|
HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
|
|
369
376
|
})(exports.HostEvent || (exports.HostEvent = {}));
|
|
@@ -390,6 +397,7 @@
|
|
|
390
397
|
(function (Param) {
|
|
391
398
|
Param["DataSources"] = "dataSources";
|
|
392
399
|
Param["DataSourceMode"] = "dataSourceMode";
|
|
400
|
+
Param["ExpandAllDataSource"] = "expandAllDataSource";
|
|
393
401
|
Param["DisableActions"] = "disableAction";
|
|
394
402
|
Param["DisableActionReason"] = "disableHint";
|
|
395
403
|
Param["ForceTable"] = "forceTable";
|
|
@@ -413,6 +421,7 @@
|
|
|
413
421
|
Param["ViewPortWidth"] = "viewPortWidth";
|
|
414
422
|
Param["VisibleActions"] = "visibleAction";
|
|
415
423
|
Param["CustomCSSUrl"] = "customCssUrl";
|
|
424
|
+
Param["visibleVizs"] = "pinboardVisibleVizs";
|
|
416
425
|
})(Param || (Param = {}));
|
|
417
426
|
(function (Action) {
|
|
418
427
|
Action["Save"] = "save";
|
|
@@ -476,23 +485,23 @@
|
|
|
476
485
|
Action["RequestAccess"] = "requestAccess";
|
|
477
486
|
Action["QueryDetailsButtons"] = "queryDetailsButtons";
|
|
478
487
|
/**
|
|
479
|
-
* @version SDK: 1.
|
|
488
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
480
489
|
*/
|
|
481
490
|
Action["Monitor"] = "createMonitor";
|
|
482
491
|
/**
|
|
483
|
-
* @version SDK: 1.
|
|
492
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
484
493
|
*/
|
|
485
494
|
Action["AnswerDelete"] = "onDeleteAnswer";
|
|
486
495
|
/**
|
|
487
|
-
* @version SDK: 1.
|
|
496
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
488
497
|
*/
|
|
489
498
|
Action["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
490
499
|
/**
|
|
491
|
-
* @version SDK: 1.
|
|
500
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
492
501
|
*/
|
|
493
502
|
Action["AddToFavorites"] = "addToFavorites";
|
|
494
503
|
/**
|
|
495
|
-
* @version SDK: 1.
|
|
504
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
496
505
|
*/
|
|
497
506
|
Action["EditDetails"] = "editDetails";
|
|
498
507
|
})(exports.Action || (exports.Action = {}));
|
|
@@ -8560,7 +8569,7 @@
|
|
|
8560
8569
|
}
|
|
8561
8570
|
else {
|
|
8562
8571
|
const response = await fetchAuthTokenService(authEndpoint);
|
|
8563
|
-
authToken = response.text();
|
|
8572
|
+
authToken = await response.text();
|
|
8564
8573
|
}
|
|
8565
8574
|
await fetchAuthService(thoughtSpotHost, username, authToken);
|
|
8566
8575
|
loggedInStatus = false;
|
|
@@ -8714,7 +8723,7 @@
|
|
|
8714
8723
|
}
|
|
8715
8724
|
};
|
|
8716
8725
|
/**
|
|
8717
|
-
* Initialize the ThoughtSpot embed
|
|
8726
|
+
* Initialize the ThoughtSpot embed SDK globally and perform
|
|
8718
8727
|
* authentication if applicable.
|
|
8719
8728
|
* @param embedConfig The configuration object containing ThoughtSpot host,
|
|
8720
8729
|
* authentication mechanism and so on.
|
|
@@ -8868,7 +8877,7 @@
|
|
|
8868
8877
|
}
|
|
8869
8878
|
}
|
|
8870
8879
|
|
|
8871
|
-
var name="@thoughtspot/visual-embed-sdk";var version="1.9.
|
|
8880
|
+
var name="@thoughtspot/visual-embed-sdk";var version="1.9.2";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**"];var exports$1={".":"./lib/src/index.js","./react":"./lib/src/react/index.js"};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p . --incremental false",start:"gatsby develop","build:gatsby":"npm run clean:gatsby && gatsby build --prefix-paths","build:gatsby:noprefix":"npm run clean:gatsby && gatsby build","serve:gatsby":"gatsby serve","clean:gatsby":"gatsby clean","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts",build:"rollup -c",watch:"rollup -cw","docs-cmd":"node scripts/gatsby-commands.js",docgen:"typedoc --tsconfig tsconfig.json --theme typedoc-theme","test-sdk":"jest -c jest.config.sdk.js","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs && npx istanbul-merge --out ./coverage/coverage.json ./coverage/docs/coverage-final.json ./coverage/sdk/coverage-final.json && npx istanbul report --include ./coverage/coverage.json --dir ./coverage lcov",posttest:"cat ./coverage/lcov.info | coveralls",prepublishOnly:"npm run test; npm run tsc; npm run bundle-dts; npm run build","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={algoliasearch:"^4.10.5",classnames:"^2.3.1","mixpanel-browser":"^2.41.0"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1",coveralls:"^3.1.0","dts-bundle":"0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","fs-extra":"^10.0.0",gatsby:"3.1.0","gatsby-plugin-algolia":"^0.22.2","gatsby-plugin-catch-links":"^3.1.0","gatsby-plugin-env-variables":"^2.1.0","gatsby-plugin-intl":"^0.3.3","gatsby-plugin-manifest":"^3.2.0","gatsby-plugin-output":"^0.1.3","gatsby-plugin-sass":"4.1.0","gatsby-plugin-sitemap":"^4.10.0","gatsby-source-filesystem":"3.1.0","gatsby-transformer-asciidoc":"2.1.0","gatsby-transformer-rehype":"2.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-puppeteer":"^4.4.0",jsdom:"^17.0.0","node-sass":"^4.0.0",prettier:"2.1.2",puppeteer:"^7.0.1",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"2.30.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-neo-theme":"^1.1.0","typedoc-plugin-toc-group":"0.0.5",typescript:"^4.1.0","url-search-params-polyfill":"^8.1.0",util:"^0.12.4"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version,description:description,module:module,main:main,types:types,files:files,exports:exports$1,scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
|
|
8872
8881
|
|
|
8873
8882
|
/**
|
|
8874
8883
|
* Copyright (c) 2022
|
|
@@ -9489,7 +9498,7 @@
|
|
|
9489
9498
|
*/
|
|
9490
9499
|
getEmbedParams() {
|
|
9491
9500
|
const params = this.getBaseQueryParams();
|
|
9492
|
-
const { enableVizTransformations, fullHeight, defaultHeight, } = this.viewConfig;
|
|
9501
|
+
const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, } = this.viewConfig;
|
|
9493
9502
|
const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval ||
|
|
9494
9503
|
this.viewConfig.preventPinboardFilterRemoval;
|
|
9495
9504
|
if (fullHeight === true) {
|
|
@@ -9504,6 +9513,9 @@
|
|
|
9504
9513
|
if (preventLiveboardFilterRemoval) {
|
|
9505
9514
|
params[Param.preventLiveboardFilterRemoval] = true;
|
|
9506
9515
|
}
|
|
9516
|
+
if (visibleVizs) {
|
|
9517
|
+
params[Param.visibleVizs] = visibleVizs;
|
|
9518
|
+
}
|
|
9507
9519
|
params[Param.livedBoardEmbed] = true;
|
|
9508
9520
|
const queryParams = getQueryParamString(params, true);
|
|
9509
9521
|
return queryParams;
|
|
@@ -9604,7 +9616,7 @@
|
|
|
9604
9616
|
*/
|
|
9605
9617
|
getIFrameSrc(answerId, dataSources) {
|
|
9606
9618
|
var _a;
|
|
9607
|
-
const { hideResults, enableSearchAssist, forceTable, searchOptions, } = this.viewConfig;
|
|
9619
|
+
const { hideResults, expandAllDataSource, enableSearchAssist, forceTable, searchOptions, } = this.viewConfig;
|
|
9608
9620
|
const answerPath = answerId ? `saved-answer/${answerId}` : 'answer';
|
|
9609
9621
|
const queryParams = this.getBaseQueryParams();
|
|
9610
9622
|
queryParams[Param.HideActions] = [
|
package/lib/package.json
CHANGED
package/lib/src/auth.js
CHANGED
|
@@ -77,7 +77,7 @@ export const doTokenAuth = async (embedConfig) => {
|
|
|
77
77
|
}
|
|
78
78
|
else {
|
|
79
79
|
const response = await fetchAuthTokenService(authEndpoint);
|
|
80
|
-
authToken = response.text();
|
|
80
|
+
authToken = await response.text();
|
|
81
81
|
}
|
|
82
82
|
await fetchAuthService(thoughtSpotHost, username, authToken);
|
|
83
83
|
loggedInStatus = false;
|