@thoughtspot/visual-embed-sdk 1.29.0-alpha.7 → 1.29.0-alpha.SCAL-205893-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.
- package/cjs/package.json +1 -1
- package/cjs/src/auth.d.ts +14 -17
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +45 -59
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/auth.spec.d.ts +12 -0
- package/cjs/src/auth.spec.d.ts.map +1 -1
- package/cjs/src/auth.spec.js +89 -67
- package/cjs/src/auth.spec.js.map +1 -1
- package/cjs/src/authToken.d.ts +1 -1
- package/cjs/src/authToken.d.ts.map +1 -1
- package/cjs/src/authToken.js +18 -5
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/authToken.spec.d.ts +2 -0
- package/cjs/src/authToken.spec.d.ts.map +1 -0
- package/cjs/src/authToken.spec.js +29 -0
- package/cjs/src/authToken.spec.js.map +1 -0
- package/cjs/src/embed/app.spec.js +4 -2
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +2 -0
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js +1 -0
- package/cjs/src/embed/base.spec.js.map +1 -1
- package/cjs/src/embed/embed.spec.js +3 -0
- package/cjs/src/embed/embed.spec.js.map +1 -1
- package/cjs/src/embed/events.spec.js +3 -0
- package/cjs/src/embed/events.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +2 -0
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/pinboard.spec.js +3 -0
- package/cjs/src/embed/pinboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.spec.js +3 -0
- package/cjs/src/embed/sage.spec.js.map +1 -1
- package/cjs/src/embed/search.spec.js +1 -0
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed-trigger.spec.js +3 -0
- package/cjs/src/embed/ts-embed-trigger.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +7 -0
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +7 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +2 -1
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +2 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/mixpanel-service.d.ts +2 -1
- package/cjs/src/mixpanel-service.d.ts.map +1 -1
- package/cjs/src/mixpanel-service.js +1 -0
- package/cjs/src/mixpanel-service.js.map +1 -1
- package/cjs/src/mixpanel-service.spec.js +7 -0
- package/cjs/src/mixpanel-service.spec.js.map +1 -1
- package/cjs/src/react/index.d.ts +1 -1
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +2 -1
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +6 -0
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/types.d.ts +79 -47
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +61 -46
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/authService/authService.d.ts +1 -0
- package/cjs/src/utils/authService/authService.d.ts.map +1 -1
- package/cjs/src/utils/authService/authService.js +1 -0
- package/cjs/src/utils/authService/authService.js.map +1 -1
- package/cjs/src/utils/authService/authService.spec.js +18 -5
- package/cjs/src/utils/authService/authService.spec.js.map +1 -1
- package/cjs/src/utils/authService/tokenizedAuthService.d.ts +15 -2
- package/cjs/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
- package/cjs/src/utils/authService/tokenizedAuthService.js +39 -9
- package/cjs/src/utils/authService/tokenizedAuthService.js.map +1 -1
- package/cjs/src/utils/authService/tokenizedAuthService.spec.d.ts +2 -0
- package/cjs/src/utils/authService/tokenizedAuthService.spec.d.ts.map +1 -0
- package/cjs/src/utils/authService/tokenizedAuthService.spec.js +32 -0
- package/cjs/src/utils/authService/tokenizedAuthService.spec.js.map +1 -0
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +10 -0
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +10 -0
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/processData.js +2 -2
- package/cjs/src/utils/processData.js.map +1 -1
- package/cjs/src/utils/processData.spec.js +3 -2
- package/cjs/src/utils/processData.spec.js.map +1 -1
- package/cjs/src/utils/sessionInfoService.d.ts +66 -0
- package/cjs/src/utils/sessionInfoService.d.ts.map +1 -0
- package/cjs/src/utils/sessionInfoService.js +92 -0
- package/cjs/src/utils/sessionInfoService.js.map +1 -0
- package/cjs/src/utils.d.ts +1 -1
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +4 -1
- package/cjs/src/utils.js.map +1 -1
- package/dist/src/auth.d.ts +14 -17
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/auth.spec.d.ts +12 -0
- package/dist/src/auth.spec.d.ts.map +1 -1
- package/dist/src/authToken.d.ts +1 -1
- package/dist/src/authToken.d.ts.map +1 -1
- package/dist/src/authToken.spec.d.ts +2 -0
- package/dist/src/authToken.spec.d.ts.map +1 -0
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +2 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts +2 -1
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +1 -1
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +79 -47
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/authService/authService.d.ts +1 -0
- package/dist/src/utils/authService/authService.d.ts.map +1 -1
- package/dist/src/utils/authService/tokenizedAuthService.d.ts +15 -2
- package/dist/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
- package/dist/src/utils/authService/tokenizedAuthService.spec.d.ts +2 -0
- package/dist/src/utils/authService/tokenizedAuthService.spec.d.ts.map +1 -0
- package/dist/src/utils/graphql/answerService/answerService.d.ts +10 -0
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils/sessionInfoService.d.ts +66 -0
- package/dist/src/utils/sessionInfoService.d.ts.map +1 -0
- package/dist/src/utils.d.ts +1 -1
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +225 -105
- package/dist/tsembed-react.js +225 -104
- package/dist/tsembed.es.js +233 -116
- package/dist/tsembed.js +233 -116
- package/dist/visual-embed-sdk-react-full.d.ts +171 -66
- package/dist/visual-embed-sdk-react.d.ts +171 -66
- package/dist/visual-embed-sdk.d.ts +171 -66
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts +14 -17
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +44 -56
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.d.ts +12 -0
- package/lib/src/auth.spec.d.ts.map +1 -1
- package/lib/src/auth.spec.js +88 -66
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/authToken.d.ts +1 -1
- package/lib/src/authToken.d.ts.map +1 -1
- package/lib/src/authToken.js +18 -5
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/authToken.spec.d.ts +2 -0
- package/lib/src/authToken.spec.d.ts.map +1 -0
- package/lib/src/authToken.spec.js +26 -0
- package/lib/src/authToken.spec.js.map +1 -0
- package/lib/src/embed/app.spec.js +4 -2
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +3 -1
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +1 -0
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/embed.spec.js +2 -0
- package/lib/src/embed/embed.spec.js.map +1 -1
- package/lib/src/embed/events.spec.js +2 -0
- package/lib/src/embed/events.spec.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +2 -0
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/pinboard.spec.js +2 -0
- package/lib/src/embed/pinboard.spec.js.map +1 -1
- package/lib/src/embed/sage.spec.js +2 -0
- package/lib/src/embed/sage.spec.js.map +1 -1
- package/lib/src/embed/search.spec.js +1 -0
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed-trigger.spec.js +2 -0
- package/lib/src/embed/ts-embed-trigger.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +7 -0
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +7 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +2 -1
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +2 -1
- package/lib/src/index.js.map +1 -1
- package/lib/src/mixpanel-service.d.ts +2 -1
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +1 -0
- package/lib/src/mixpanel-service.js.map +1 -1
- package/lib/src/mixpanel-service.spec.js +7 -0
- package/lib/src/mixpanel-service.spec.js.map +1 -1
- package/lib/src/react/index.d.ts +1 -1
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +1 -1
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +6 -0
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/types.d.ts +79 -47
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +61 -46
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/authService/authService.d.ts +1 -0
- package/lib/src/utils/authService/authService.d.ts.map +1 -1
- package/lib/src/utils/authService/authService.js +1 -0
- package/lib/src/utils/authService/authService.js.map +1 -1
- package/lib/src/utils/authService/authService.spec.js +18 -5
- package/lib/src/utils/authService/authService.spec.js.map +1 -1
- package/lib/src/utils/authService/tokenizedAuthService.d.ts +15 -2
- package/lib/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
- package/lib/src/utils/authService/tokenizedAuthService.js +37 -8
- package/lib/src/utils/authService/tokenizedAuthService.js.map +1 -1
- package/lib/src/utils/authService/tokenizedAuthService.spec.d.ts +2 -0
- package/lib/src/utils/authService/tokenizedAuthService.spec.d.ts.map +1 -0
- package/lib/src/utils/authService/tokenizedAuthService.spec.js +29 -0
- package/lib/src/utils/authService/tokenizedAuthService.spec.js.map +1 -0
- package/lib/src/utils/graphql/answerService/answerService.d.ts +10 -0
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +10 -0
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/processData.js +3 -3
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/utils/processData.spec.js +3 -2
- package/lib/src/utils/processData.spec.js.map +1 -1
- package/lib/src/utils/sessionInfoService.d.ts +66 -0
- package/lib/src/utils/sessionInfoService.d.ts.map +1 -0
- package/lib/src/utils/sessionInfoService.js +85 -0
- package/lib/src/utils/sessionInfoService.js.map +1 -0
- package/lib/src/utils.d.ts +1 -1
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +4 -1
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +176 -67
- package/package.json +1 -1
- package/src/auth.spec.ts +92 -72
- package/src/auth.ts +46 -68
- package/src/authToken.spec.ts +31 -0
- package/src/authToken.ts +17 -5
- package/src/embed/app.spec.ts +4 -2
- package/src/embed/base.spec.ts +1 -0
- package/src/embed/base.ts +3 -0
- package/src/embed/embed.spec.ts +2 -0
- package/src/embed/events.spec.ts +2 -0
- package/src/embed/liveboard.spec.ts +2 -0
- package/src/embed/pinboard.spec.ts +2 -0
- package/src/embed/sage.spec.ts +3 -0
- package/src/embed/search.spec.ts +1 -0
- package/src/embed/ts-embed-trigger.spec.ts +3 -0
- package/src/embed/ts-embed.spec.ts +8 -0
- package/src/embed/ts-embed.ts +7 -0
- package/src/index.ts +2 -1
- package/src/mixpanel-service.spec.ts +12 -3
- package/src/mixpanel-service.ts +3 -1
- package/src/react/index.spec.tsx +7 -0
- package/src/react/index.tsx +1 -0
- package/src/types.ts +80 -47
- package/src/utils/authService/authService.spec.ts +18 -5
- package/src/utils/authService/authService.ts +1 -0
- package/src/utils/authService/tokenizedAuthService.spec.ts +36 -0
- package/src/utils/authService/tokenizedAuthService.ts +38 -8
- package/src/utils/graphql/answerService/answerService.ts +10 -0
- package/src/utils/processData.spec.ts +3 -2
- package/src/utils/processData.ts +3 -3
- package/src/utils/sessionInfoService.ts +101 -0
- package/src/utils.ts +7 -2
|
@@ -1345,12 +1345,6 @@ export let loggedInStatus: boolean;
|
|
|
1345
1345
|
export let samlAuthWindow: Window;
|
|
1346
1346
|
export let samlCompletionPromise: Promise<void>;
|
|
1347
1347
|
export const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
|
|
1348
|
-
interface sessionInfoInterface {
|
|
1349
|
-
userGUID: any;
|
|
1350
|
-
isPublicUser: any;
|
|
1351
|
-
mixpanelToken: any;
|
|
1352
|
-
[key: string]: any;
|
|
1353
|
-
}
|
|
1354
1348
|
/**
|
|
1355
1349
|
* Enum for auth failure types. This is the parameter passed to the listner
|
|
1356
1350
|
* of {@link AuthStatus.FAILURE}.
|
|
@@ -1468,7 +1462,7 @@ export function notifyAuthSDKSuccess(): void;
|
|
|
1468
1462
|
/**
|
|
1469
1463
|
*
|
|
1470
1464
|
*/
|
|
1471
|
-
export function notifyAuthSuccess(): void
|
|
1465
|
+
export function notifyAuthSuccess(): Promise<void>;
|
|
1472
1466
|
/**
|
|
1473
1467
|
*
|
|
1474
1468
|
* @param failureType
|
|
@@ -1478,19 +1472,23 @@ export function notifyAuthFailure(failureType: AuthFailureType): void;
|
|
|
1478
1472
|
*
|
|
1479
1473
|
*/
|
|
1480
1474
|
export function notifyLogout(): void;
|
|
1481
|
-
export const initSession: (sessionDetails: sessionInfoInterface) => void;
|
|
1482
|
-
export const getSessionDetails: (sessionInfoResp: any) => sessionInfoInterface;
|
|
1483
1475
|
/**
|
|
1484
|
-
*
|
|
1476
|
+
* Services to be called after the login is successful,
|
|
1477
|
+
* This should be called after the cookie is set for cookie auth or
|
|
1478
|
+
* after the token is set for cookieless.
|
|
1479
|
+
*
|
|
1480
|
+
* @return {Promise<void>}
|
|
1481
|
+
* @example
|
|
1482
|
+
* ```js
|
|
1483
|
+
* await postLoginService();
|
|
1484
|
+
* ```
|
|
1485
|
+
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1485
1486
|
*/
|
|
1486
|
-
export function
|
|
1487
|
+
export function postLoginService(): Promise<void>;
|
|
1487
1488
|
/**
|
|
1488
|
-
* Return
|
|
1489
|
-
* authentication is successful. And info is available.
|
|
1490
|
-
*
|
|
1491
|
-
* @group Global methods
|
|
1489
|
+
* Return releaseVersion if available
|
|
1492
1490
|
*/
|
|
1493
|
-
export function
|
|
1491
|
+
export function getReleaseVersion(): string;
|
|
1494
1492
|
/**
|
|
1495
1493
|
* Perform token based authentication
|
|
1496
1494
|
*
|
|
@@ -1526,7 +1524,72 @@ export const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
|
1526
1524
|
* Check if we are authenticated to the ThoughtSpot cluster
|
|
1527
1525
|
*/
|
|
1528
1526
|
export const isAuthenticated: () => boolean;
|
|
1529
|
-
|
|
1527
|
+
|
|
1528
|
+
export type SessionInfo = {
|
|
1529
|
+
releaseVersion: string;
|
|
1530
|
+
userGUID: string;
|
|
1531
|
+
currentOrgId: number;
|
|
1532
|
+
privileges: string[];
|
|
1533
|
+
mixpanelToken: string;
|
|
1534
|
+
isPublicUser: boolean;
|
|
1535
|
+
clusterId: string;
|
|
1536
|
+
clusterName: string;
|
|
1537
|
+
[key: string]: any;
|
|
1538
|
+
};
|
|
1539
|
+
/**
|
|
1540
|
+
* Returns the session info object and caches it for future use.
|
|
1541
|
+
* Once fetched the session info object is cached and returned from the cache on
|
|
1542
|
+
* subsequent calls.
|
|
1543
|
+
*
|
|
1544
|
+
* @example ```js
|
|
1545
|
+
* const sessionInfo = await getSessionInfo();
|
|
1546
|
+
* console.log(sessionInfo);
|
|
1547
|
+
* ```
|
|
1548
|
+
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1549
|
+
* @returns {Promise<SessionInfo>} The session info object.
|
|
1550
|
+
*/
|
|
1551
|
+
export function getSessionInfo(): Promise<SessionInfo>;
|
|
1552
|
+
/**
|
|
1553
|
+
* Returns the cached session info object. If the client is not authenticated the
|
|
1554
|
+
* function will return null.
|
|
1555
|
+
*
|
|
1556
|
+
* @example ```js
|
|
1557
|
+
* const sessionInfo = getCachedSessionInfo();
|
|
1558
|
+
* if (sessionInfo) {
|
|
1559
|
+
* console.log(sessionInfo);
|
|
1560
|
+
* } else {
|
|
1561
|
+
* console.log('Not authenticated');
|
|
1562
|
+
* }
|
|
1563
|
+
* ```
|
|
1564
|
+
* @returns {SessionInfo | null} The session info object.
|
|
1565
|
+
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1566
|
+
*/
|
|
1567
|
+
export function getCachedSessionInfo(): SessionInfo | null;
|
|
1568
|
+
/**
|
|
1569
|
+
* Processes the session info response and returns the session info object.
|
|
1570
|
+
*
|
|
1571
|
+
* @param sessionInfoResp {any} Response from the session info API.
|
|
1572
|
+
* @returns {SessionInfo} The session info object.
|
|
1573
|
+
* @example ```js
|
|
1574
|
+
* const sessionInfoResp = await fetch(sessionInfoPath);
|
|
1575
|
+
* const sessionInfo = getSessionDetails(sessionInfoResp);
|
|
1576
|
+
* console.log(sessionInfo);
|
|
1577
|
+
* ```
|
|
1578
|
+
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1579
|
+
*/
|
|
1580
|
+
export const getSessionDetails: (sessionInfoResp: any) => SessionInfo;
|
|
1581
|
+
/**
|
|
1582
|
+
* Resets the cached session info object and forces a new fetch on the next call.
|
|
1583
|
+
*
|
|
1584
|
+
* @example ```js
|
|
1585
|
+
* resetCachedSessionInfo();
|
|
1586
|
+
* const sessionInfo = await getSessionInfo();
|
|
1587
|
+
* console.log(sessionInfo);
|
|
1588
|
+
* ```
|
|
1589
|
+
* @version SDK: 1.28.3 | ThoughtSpot ts7.april.cl, 7.2.1
|
|
1590
|
+
* @returns {void}
|
|
1591
|
+
*/
|
|
1592
|
+
export function resetCachedSessionInfo(): void;
|
|
1530
1593
|
|
|
1531
1594
|
/**
|
|
1532
1595
|
* Copyright (c) 2023
|
|
@@ -2112,6 +2175,23 @@ export interface EmbedConfig {
|
|
|
2112
2175
|
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2113
2176
|
*/
|
|
2114
2177
|
currencyFormat?: string;
|
|
2178
|
+
/**
|
|
2179
|
+
* This flag is used to disable the token verification in the SDK.
|
|
2180
|
+
* Enabling this flag will also disable the caching of the token.
|
|
2181
|
+
*
|
|
2182
|
+
* @hidden
|
|
2183
|
+
*
|
|
2184
|
+
* @example
|
|
2185
|
+
* ```js
|
|
2186
|
+
* init({
|
|
2187
|
+
* ...embedConfig,
|
|
2188
|
+
* disableTokenVerification : true
|
|
2189
|
+
* })
|
|
2190
|
+
* ```
|
|
2191
|
+
*
|
|
2192
|
+
* @version SDK: 1.28.5 | Thoughtspot: *
|
|
2193
|
+
*/
|
|
2194
|
+
disableTokenVerification?: boolean;
|
|
2115
2195
|
}
|
|
2116
2196
|
export interface LayoutConfig {
|
|
2117
2197
|
}
|
|
@@ -2711,7 +2791,7 @@ export interface RuntimeFilter {
|
|
|
2711
2791
|
* a single operand, whereas other operators like BW and IN accept multiple
|
|
2712
2792
|
* operands.
|
|
2713
2793
|
*/
|
|
2714
|
-
values: (number | boolean | string)[];
|
|
2794
|
+
values: (number | boolean | string | bigint)[];
|
|
2715
2795
|
}
|
|
2716
2796
|
/**
|
|
2717
2797
|
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
@@ -2765,6 +2845,8 @@ export enum EmbedEvent {
|
|
|
2765
2845
|
/**
|
|
2766
2846
|
* Authentication has either succeeded or failed.
|
|
2767
2847
|
*
|
|
2848
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2849
|
+
*
|
|
2768
2850
|
* @example
|
|
2769
2851
|
*```js
|
|
2770
2852
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
@@ -2778,6 +2860,8 @@ export enum EmbedEvent {
|
|
|
2778
2860
|
* The embed object container has loaded.
|
|
2779
2861
|
*
|
|
2780
2862
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2863
|
+
*
|
|
2864
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2781
2865
|
* @example
|
|
2782
2866
|
*```js
|
|
2783
2867
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
@@ -2792,6 +2876,8 @@ export enum EmbedEvent {
|
|
|
2792
2876
|
* Data pertaining to answer or Liveboard is received
|
|
2793
2877
|
*
|
|
2794
2878
|
* @return data - The answer or Liveboard data
|
|
2879
|
+
*
|
|
2880
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2795
2881
|
* @example
|
|
2796
2882
|
*```js
|
|
2797
2883
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
@@ -2810,6 +2896,7 @@ export enum EmbedEvent {
|
|
|
2810
2896
|
/**
|
|
2811
2897
|
* Search query has been updated by the user.
|
|
2812
2898
|
*
|
|
2899
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2813
2900
|
* @example
|
|
2814
2901
|
*```js
|
|
2815
2902
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
@@ -2819,12 +2906,14 @@ export enum EmbedEvent {
|
|
|
2819
2906
|
/**
|
|
2820
2907
|
* A drill-down operation has been performed.
|
|
2821
2908
|
*
|
|
2909
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2910
|
+
*
|
|
2822
2911
|
* @returns additionalFilters - Any additional filters applied
|
|
2823
2912
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
2824
2913
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
2825
2914
|
* @example
|
|
2826
2915
|
*```js
|
|
2827
|
-
* searchEmbed.
|
|
2916
|
+
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
2828
2917
|
* points: {
|
|
2829
2918
|
* clickedPoint,
|
|
2830
2919
|
* selectedPoints: selectedPoint
|
|
@@ -2857,6 +2946,8 @@ export enum EmbedEvent {
|
|
|
2857
2946
|
* One or more data sources have been selected.
|
|
2858
2947
|
*
|
|
2859
2948
|
* @returns dataSourceIds - the list of data sources
|
|
2949
|
+
*
|
|
2950
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2860
2951
|
* @example
|
|
2861
2952
|
* ```js
|
|
2862
2953
|
* searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
|
|
@@ -2884,6 +2975,8 @@ export enum EmbedEvent {
|
|
|
2884
2975
|
* @returns actionId - ID of the custom action
|
|
2885
2976
|
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
2886
2977
|
* Answer or Liveboard data
|
|
2978
|
+
*
|
|
2979
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2887
2980
|
* @example
|
|
2888
2981
|
* ```js
|
|
2889
2982
|
* appEmbed.on(EmbedEvent.customAction, payload => {
|
|
@@ -2931,21 +3024,18 @@ export enum EmbedEvent {
|
|
|
2931
3024
|
/**
|
|
2932
3025
|
* An error has occurred. This event is fired for the following error types:
|
|
2933
3026
|
*
|
|
2934
|
-
* API - API call failure error.
|
|
2935
|
-
*
|
|
2936
|
-
*
|
|
2937
|
-
*
|
|
2938
|
-
*
|
|
2939
|
-
*
|
|
2940
|
-
* NON_EXIST_FILTER - Error due to a non-existent filter.
|
|
3027
|
+
* `API` - API call failure error.
|
|
3028
|
+
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen mode.
|
|
3029
|
+
* `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value filter.
|
|
3030
|
+
* `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
3031
|
+
* `INVALID_DATE_VALUE` - Invalid date value error.
|
|
3032
|
+
* `INVALID_OPERATOR` - Use of invalid operator during filter application.
|
|
2941
3033
|
*
|
|
2942
|
-
*
|
|
2943
|
-
*
|
|
2944
|
-
* INVALID_OPERATOR - Use of invalid operator during filter application.
|
|
2945
|
-
*
|
|
2946
|
-
* For more information, see [Developer Documentation](https://developers.thoughtspot.com/docs/events-app-integration#errorType)
|
|
3034
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
|
|
2947
3035
|
*
|
|
2948
3036
|
* @returns error - An error object or message
|
|
3037
|
+
*
|
|
3038
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2949
3039
|
* @example
|
|
2950
3040
|
* ```js
|
|
2951
3041
|
* // API error
|
|
@@ -2971,6 +3061,9 @@ export enum EmbedEvent {
|
|
|
2971
3061
|
* The embedded object has sent an alert.
|
|
2972
3062
|
*
|
|
2973
3063
|
* @returns alert - An alert object
|
|
3064
|
+
*
|
|
3065
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3066
|
+
*
|
|
2974
3067
|
* @example
|
|
2975
3068
|
* ```js
|
|
2976
3069
|
* searchEmbed.on(EmbedEvent.Alert)
|
|
@@ -2980,6 +3073,8 @@ export enum EmbedEvent {
|
|
|
2980
3073
|
/**
|
|
2981
3074
|
* The ThoughtSpot auth session has expired.
|
|
2982
3075
|
*
|
|
3076
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3077
|
+
*
|
|
2983
3078
|
* @example
|
|
2984
3079
|
*```js
|
|
2985
3080
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
@@ -3033,6 +3128,7 @@ export enum EmbedEvent {
|
|
|
3033
3128
|
/**
|
|
3034
3129
|
* Detects the route change.
|
|
3035
3130
|
*
|
|
3131
|
+
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
3036
3132
|
* @example
|
|
3037
3133
|
*```js
|
|
3038
3134
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
@@ -3113,8 +3209,7 @@ export enum EmbedEvent {
|
|
|
3113
3209
|
*/
|
|
3114
3210
|
LiveboardRendered = "PinboardRendered",
|
|
3115
3211
|
/**
|
|
3116
|
-
*
|
|
3117
|
-
* is triggered on all events.
|
|
3212
|
+
* Emits all events.
|
|
3118
3213
|
*
|
|
3119
3214
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3120
3215
|
* @example
|
|
@@ -3131,13 +3226,13 @@ export enum EmbedEvent {
|
|
|
3131
3226
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3132
3227
|
* @example
|
|
3133
3228
|
*```js
|
|
3134
|
-
* //
|
|
3229
|
+
* //Emit when action starts
|
|
3135
3230
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3136
3231
|
* console.log('Save', payload)
|
|
3137
3232
|
* }, {
|
|
3138
3233
|
* start: true
|
|
3139
3234
|
* })
|
|
3140
|
-
* //
|
|
3235
|
+
* //emit when action ends
|
|
3141
3236
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3142
3237
|
* console.log('Save', payload)
|
|
3143
3238
|
* })
|
|
@@ -3155,7 +3250,7 @@ export enum EmbedEvent {
|
|
|
3155
3250
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3156
3251
|
* @example
|
|
3157
3252
|
*```js
|
|
3158
|
-
* liveboardEmbed.
|
|
3253
|
+
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
3159
3254
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3160
3255
|
* })
|
|
3161
3256
|
*```
|
|
@@ -3167,10 +3262,10 @@ export enum EmbedEvent {
|
|
|
3167
3262
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3168
3263
|
* @example
|
|
3169
3264
|
*```js
|
|
3170
|
-
* //
|
|
3265
|
+
* //emit when action starts
|
|
3171
3266
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3172
3267
|
* console.log('download PNG', payload)}, {start: true })
|
|
3173
|
-
* //
|
|
3268
|
+
* //emit when action ends
|
|
3174
3269
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3175
3270
|
* console.log('download PNG', payload)})
|
|
3176
3271
|
*```
|
|
@@ -3182,10 +3277,10 @@ export enum EmbedEvent {
|
|
|
3182
3277
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3183
3278
|
* @example
|
|
3184
3279
|
*```js
|
|
3185
|
-
* //
|
|
3280
|
+
* //emit when action starts
|
|
3186
3281
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3187
3282
|
* console.log('download PDF', payload)}, {start: true })
|
|
3188
|
-
* //
|
|
3283
|
+
* //emit when action ends
|
|
3189
3284
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3190
3285
|
* console.log('download PDF', payload)})
|
|
3191
3286
|
*```
|
|
@@ -3197,10 +3292,10 @@ export enum EmbedEvent {
|
|
|
3197
3292
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3198
3293
|
* @example
|
|
3199
3294
|
*```js
|
|
3200
|
-
* //
|
|
3295
|
+
* //emit when action starts
|
|
3201
3296
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3202
3297
|
* console.log('download CSV', payload)}, {start: true })
|
|
3203
|
-
* //
|
|
3298
|
+
* //emit when action ends
|
|
3204
3299
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3205
3300
|
* console.log('download CSV', payload)})
|
|
3206
3301
|
*```
|
|
@@ -3212,10 +3307,10 @@ export enum EmbedEvent {
|
|
|
3212
3307
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3213
3308
|
* @example
|
|
3214
3309
|
*```js
|
|
3215
|
-
* //
|
|
3310
|
+
* //emit when action starts
|
|
3216
3311
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3217
3312
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
3218
|
-
* //
|
|
3313
|
+
* //emit when action ends
|
|
3219
3314
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3220
3315
|
* console.log('download Xlsx', payload)})
|
|
3221
3316
|
*```
|
|
@@ -3227,7 +3322,7 @@ export enum EmbedEvent {
|
|
|
3227
3322
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3228
3323
|
* @example
|
|
3229
3324
|
*```js
|
|
3230
|
-
* //
|
|
3325
|
+
* //emit when action starts
|
|
3231
3326
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3232
3327
|
* console.log('delete answer', payload)}, {start: true })
|
|
3233
3328
|
* //trigger when action is completed
|
|
@@ -3242,13 +3337,13 @@ export enum EmbedEvent {
|
|
|
3242
3337
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3243
3338
|
* @example
|
|
3244
3339
|
*```js
|
|
3245
|
-
* //
|
|
3340
|
+
* //emit when action starts
|
|
3246
3341
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3247
3342
|
* console.log('pin', payload)
|
|
3248
3343
|
* }, {
|
|
3249
3344
|
* start: true
|
|
3250
3345
|
* })
|
|
3251
|
-
* //
|
|
3346
|
+
* //emit when action ends
|
|
3252
3347
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3253
3348
|
* console.log('pin', payload)
|
|
3254
3349
|
* })
|
|
@@ -3261,13 +3356,13 @@ export enum EmbedEvent {
|
|
|
3261
3356
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3262
3357
|
* @example
|
|
3263
3358
|
*```js
|
|
3264
|
-
* //
|
|
3359
|
+
* //emit when action starts
|
|
3265
3360
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3266
3361
|
* console.log('SpotIQAnalyze', payload)
|
|
3267
3362
|
* }, {
|
|
3268
3363
|
* start: true
|
|
3269
3364
|
* })
|
|
3270
|
-
* //
|
|
3365
|
+
* //emit when action ends
|
|
3271
3366
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3272
3367
|
* console.log('SpotIQ analyze', payload)
|
|
3273
3368
|
* })
|
|
@@ -3280,13 +3375,13 @@ export enum EmbedEvent {
|
|
|
3280
3375
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3281
3376
|
* @example
|
|
3282
3377
|
*```js
|
|
3283
|
-
* //
|
|
3378
|
+
* //emit when action starts
|
|
3284
3379
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3285
3380
|
* console.log('Share', payload)
|
|
3286
3381
|
* }, {
|
|
3287
3382
|
* start: true
|
|
3288
3383
|
* })
|
|
3289
|
-
* //
|
|
3384
|
+
* //emit when action ends
|
|
3290
3385
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3291
3386
|
* console.log('Share', payload)
|
|
3292
3387
|
* })
|
|
@@ -3361,10 +3456,10 @@ export enum EmbedEvent {
|
|
|
3361
3456
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3362
3457
|
* @example
|
|
3363
3458
|
*```js
|
|
3364
|
-
* //
|
|
3459
|
+
* //emit when action starts
|
|
3365
3460
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3366
3461
|
* console.log('Export TML', payload)}, { start: true })
|
|
3367
|
-
* //
|
|
3462
|
+
* //emit when action ends
|
|
3368
3463
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3369
3464
|
* console.log('Export TML', payload)})
|
|
3370
3465
|
*```
|
|
@@ -3388,10 +3483,10 @@ export enum EmbedEvent {
|
|
|
3388
3483
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3389
3484
|
* @example
|
|
3390
3485
|
*```js
|
|
3391
|
-
* //
|
|
3486
|
+
* //emit when action starts
|
|
3392
3487
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3393
3488
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
3394
|
-
* //
|
|
3489
|
+
* //emit when action ends
|
|
3395
3490
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3396
3491
|
* console.log('Copy and edit', payload)})
|
|
3397
3492
|
*```
|
|
@@ -3493,7 +3588,7 @@ export enum EmbedEvent {
|
|
|
3493
3588
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3494
3589
|
* @example
|
|
3495
3590
|
*```js
|
|
3496
|
-
* liveboardEmbed.
|
|
3591
|
+
* liveboardEmbed.on(EmbedEvent.Present)
|
|
3497
3592
|
*```
|
|
3498
3593
|
* @example
|
|
3499
3594
|
*```js
|
|
@@ -3509,7 +3604,7 @@ export enum EmbedEvent {
|
|
|
3509
3604
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3510
3605
|
* @example
|
|
3511
3606
|
*```js
|
|
3512
|
-
* liveboardEmbed.
|
|
3607
|
+
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
3513
3608
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3514
3609
|
*```
|
|
3515
3610
|
*/
|
|
@@ -3520,7 +3615,7 @@ export enum EmbedEvent {
|
|
|
3520
3615
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3521
3616
|
* @example
|
|
3522
3617
|
*```js
|
|
3523
|
-
* liveboardEmbed.
|
|
3618
|
+
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
3524
3619
|
*```
|
|
3525
3620
|
*/
|
|
3526
3621
|
SchedulesList = "schedule-list",
|
|
@@ -3530,7 +3625,7 @@ export enum EmbedEvent {
|
|
|
3530
3625
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3531
3626
|
* @example
|
|
3532
3627
|
*```js
|
|
3533
|
-
* liveboardEmbed.
|
|
3628
|
+
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
3534
3629
|
*```
|
|
3535
3630
|
*/
|
|
3536
3631
|
Cancel = "cancel",
|
|
@@ -3540,7 +3635,7 @@ export enum EmbedEvent {
|
|
|
3540
3635
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3541
3636
|
* @example
|
|
3542
3637
|
*```js
|
|
3543
|
-
* liveboardEmbed.
|
|
3638
|
+
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
3544
3639
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3545
3640
|
*```
|
|
3546
3641
|
*/
|
|
@@ -3551,7 +3646,7 @@ export enum EmbedEvent {
|
|
|
3551
3646
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3552
3647
|
* @example
|
|
3553
3648
|
*```js
|
|
3554
|
-
* liveboardEmbed.
|
|
3649
|
+
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
3555
3650
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3556
3651
|
*```
|
|
3557
3652
|
*/
|
|
@@ -3929,7 +4024,7 @@ export enum HostEvent {
|
|
|
3929
4024
|
*
|
|
3930
4025
|
* @example
|
|
3931
4026
|
* ```js
|
|
3932
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
4027
|
+
* liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
|
|
3933
4028
|
* data=>console.log(data))
|
|
3934
4029
|
* ```
|
|
3935
4030
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
@@ -4393,7 +4488,7 @@ export enum HostEvent {
|
|
|
4393
4488
|
*
|
|
4394
4489
|
* ```js
|
|
4395
4490
|
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
4396
|
-
* filter: { column: 'column name', oper: 'IN', values: [1,2,3]
|
|
4491
|
+
* filter: { column: 'column name', oper: 'IN', values: [1,2,3]}
|
|
4397
4492
|
* })
|
|
4398
4493
|
* ```
|
|
4399
4494
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
@@ -5543,7 +5638,7 @@ export enum Action {
|
|
|
5543
5638
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
5544
5639
|
* ```
|
|
5545
5640
|
*
|
|
5546
|
-
* @version SDK : 1.28.
|
|
5641
|
+
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
5547
5642
|
*/
|
|
5548
5643
|
TML = "tml",
|
|
5549
5644
|
/**
|
|
@@ -6279,6 +6374,16 @@ export interface UnderlyingDataPoint {
|
|
|
6279
6374
|
* const data = await underlying.fetchData(0, 100);
|
|
6280
6375
|
* })
|
|
6281
6376
|
* ```
|
|
6377
|
+
* @example
|
|
6378
|
+
* ```js
|
|
6379
|
+
* embed.on(EmbedEvent.Data, async (e) => {
|
|
6380
|
+
* const service = await embed.getAnswerService();
|
|
6381
|
+
* await service.addColumns([
|
|
6382
|
+
* "<column guid>"
|
|
6383
|
+
* ]);
|
|
6384
|
+
* console.log(await service.fetchData());
|
|
6385
|
+
* });
|
|
6386
|
+
* ```
|
|
6282
6387
|
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
6283
6388
|
* @group Events
|
|
6284
6389
|
*/
|
|
@@ -6418,7 +6523,7 @@ export function uploadMixpanelEvent(eventId: string, eventProps?: {}): void;
|
|
|
6418
6523
|
*
|
|
6419
6524
|
* @param sessionInfo
|
|
6420
6525
|
*/
|
|
6421
|
-
export function initMixpanel(sessionInfo:
|
|
6526
|
+
export function initMixpanel(sessionInfo: SessionInfo): void;
|
|
6422
6527
|
/**
|
|
6423
6528
|
*
|
|
6424
6529
|
*/
|
|
@@ -6435,7 +6540,7 @@ export function testResetMixpanel(): void;
|
|
|
6435
6540
|
*/
|
|
6436
6541
|
export const tokenizedFetch: typeof fetch;
|
|
6437
6542
|
|
|
6438
|
-
export
|
|
6543
|
+
export function getAuthenticationToken(embedConfig: EmbedConfig): Promise<string>;
|
|
6439
6544
|
/**
|
|
6440
6545
|
* Resets the auth token and a new token will be fetched on the next request.
|
|
6441
6546
|
*
|
package/lib/package.json
CHANGED
package/lib/src/auth.d.ts
CHANGED
|
@@ -4,12 +4,6 @@ export declare let loggedInStatus: boolean;
|
|
|
4
4
|
export declare let samlAuthWindow: Window;
|
|
5
5
|
export declare let samlCompletionPromise: Promise<void>;
|
|
6
6
|
export declare const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
|
|
7
|
-
interface sessionInfoInterface {
|
|
8
|
-
userGUID: any;
|
|
9
|
-
isPublicUser: any;
|
|
10
|
-
mixpanelToken: any;
|
|
11
|
-
[key: string]: any;
|
|
12
|
-
}
|
|
13
7
|
/**
|
|
14
8
|
* Enum for auth failure types. This is the parameter passed to the listner
|
|
15
9
|
* of {@link AuthStatus.FAILURE}.
|
|
@@ -127,7 +121,7 @@ export declare function notifyAuthSDKSuccess(): void;
|
|
|
127
121
|
/**
|
|
128
122
|
*
|
|
129
123
|
*/
|
|
130
|
-
export declare function notifyAuthSuccess(): void
|
|
124
|
+
export declare function notifyAuthSuccess(): Promise<void>;
|
|
131
125
|
/**
|
|
132
126
|
*
|
|
133
127
|
* @param failureType
|
|
@@ -137,19 +131,23 @@ export declare function notifyAuthFailure(failureType: AuthFailureType): void;
|
|
|
137
131
|
*
|
|
138
132
|
*/
|
|
139
133
|
export declare function notifyLogout(): void;
|
|
140
|
-
export declare const initSession: (sessionDetails: sessionInfoInterface) => void;
|
|
141
|
-
export declare const getSessionDetails: (sessionInfoResp: any) => sessionInfoInterface;
|
|
142
134
|
/**
|
|
143
|
-
*
|
|
135
|
+
* Services to be called after the login is successful,
|
|
136
|
+
* This should be called after the cookie is set for cookie auth or
|
|
137
|
+
* after the token is set for cookieless.
|
|
138
|
+
*
|
|
139
|
+
* @return {Promise<void>}
|
|
140
|
+
* @example
|
|
141
|
+
* ```js
|
|
142
|
+
* await postLoginService();
|
|
143
|
+
* ```
|
|
144
|
+
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
144
145
|
*/
|
|
145
|
-
export declare function
|
|
146
|
+
export declare function postLoginService(): Promise<void>;
|
|
146
147
|
/**
|
|
147
|
-
* Return
|
|
148
|
-
* authentication is successful. And info is available.
|
|
149
|
-
*
|
|
150
|
-
* @group Global methods
|
|
148
|
+
* Return releaseVersion if available
|
|
151
149
|
*/
|
|
152
|
-
export declare function
|
|
150
|
+
export declare function getReleaseVersion(): string;
|
|
153
151
|
/**
|
|
154
152
|
* Perform token based authentication
|
|
155
153
|
*
|
|
@@ -185,5 +183,4 @@ export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean
|
|
|
185
183
|
* Check if we are authenticated to the ThoughtSpot cluster
|
|
186
184
|
*/
|
|
187
185
|
export declare const isAuthenticated: () => boolean;
|
|
188
|
-
export {};
|
|
189
186
|
//# sourceMappingURL=auth.d.ts.map
|
package/lib/src/auth.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AAIzC,OAAO,EACoB,WAAW,EACrC,MAAM,SAAS,CAAC;AAcjB,eAAO,IAAI,cAAc,SAAQ,CAAC;AAElC,eAAO,IAAI,cAAc,EAAE,MAAa,CAAC;AAEzC,eAAO,IAAI,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAQ,CAAC;AAIvD,eAAO,MAAM,2BAA2B,yCAAyC,CAAC;AAElF;;;;;GAKG;AACH,oBAAY,eAAe;IACvB,GAAG,QAAQ;IACX,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,KAAK,UAAU;CAClB;AAED;;;;GAIG;AACH,oBAAY,UAAU;IAClB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,MAAM,WAAW;IACjB;;;;;;OAMG;IACH,iBAAiB,sBAAsB;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;OAKG;IACH,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IACtF;;;;;OAKG;IACH,EAAE,CACE,KAAK,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAChF,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC1E,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IACxF,IAAI,CACA,KAAK,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAChF,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC5E;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAChD;;;;;;;OAOG;IACH,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9F;;;;OAIG;IACH,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;CAC/C;AAED;;;;GAIG;AACH,oBAAY,SAAS;IACjB;;;OAGG;IACH,iBAAiB,sBAAsB;CAC1C;AAID;;GAEG;AACH,wBAAgB,SAAS,IAAI,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,CAEhE;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,GAAG,IAAI,CAElF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAM3C;AAED;;GAEG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAWvD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI,CAMpE;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,IAAI,CAMnC;AAgBD;;;;;;;;;;;GAWG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAOtD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,WAEhC;AAqBD;;;;GAIG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAgC3E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAgBrF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAa3E,CAAC;AA6EF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAiBxD,CAAC;AAEF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAiBxD,CAAC;AAEF,eAAO,MAAM,MAAM,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAYtE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAoB5E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,QAAO,OAAyB,CAAC"}
|