@thoughtspot/visual-embed-sdk 1.43.0 → 1.44.0

package/lib/src/api-intercept.d.ts

@@ -0,0 +1,51 @@
+import { BaseViewConfig, ApiInterceptFlags, EmbedEvent } from "./types";
+/**
+ * Returns the data to be sent to embed to setup intercepts
+ * the urls to intercept, timeout etc
+ * @param viewConfig
+ * @returns
+ */
+export declare const getInterceptInitData: (viewConfig: BaseViewConfig) => Required<Omit<ApiInterceptFlags, 'isOnBeforeGetVizDataInterceptEnabled'>>;
+/**
+ * Handle Api intercept event and simulate legacy onBeforeGetVizDataIntercept event
+ *
+ * embed sends -> ApiIntercept -> we send
+ *  ApiIntercept
+ *  OnBeforeGetVizDataIntercept (if url is part of DefaultUrlMap.AnswerData)
+ *
+ * @param params
+ * @returns
+ */
+export declare const handleInterceptEvent: (params: {
+    eventData: any;
+    executeEvent: (eventType: EmbedEvent, data: any) => void;
+    viewConfig: BaseViewConfig;
+    getUnsavedAnswerTml: (props: {
+        sessionId?: string;
+        vizId?: string;
+    }) => Promise<{
+        tml: string;
+    }>;
+}) => Promise<void>;
+/**
+ * Support both the legacy and new format of the api intercept response
+ * @param payload
+ * @returns
+ */
+export declare const processApiInterceptResponse: (payload: any) => any;
+export declare const processLegacyInterceptResponse: (payload: any) => {
+    data: {
+        execute: any;
+        response: {
+            body: {
+                errors: {
+                    title: any;
+                    description: any;
+                    isUserError: boolean;
+                }[];
+                data: {};
+            };
+        };
+    };
+};
+//# sourceMappingURL=api-intercept.d.ts.map

package/lib/src/api-intercept.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-intercept.d.ts","sourceRoot":"","sources":["../../src/api-intercept.ts"],"names":[],"mappings":"AAEA,OAAO,EAAsB,cAAc,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAwC5F;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,eAAgB,cAAc,KAAG,SAAS,KAAK,iBAAiB,EAAE,sCAAsC,CAAC,CAgBzI,CAAA;AA6CD;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB;eAClB,GAAG;8BACY,UAAU,QAAQ,GAAG,KAAK,IAAI;gBAC5C,cAAc;iCACG;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,QAAQ;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;mBAwCnG,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,YAAa,GAAG,QAQvD,CAAA;AAED,eAAO,MAAM,8BAA8B,YAAa,GAAG;;;;;;;;;;;;;;CAuB1D,CAAA"}

package/lib/src/api-intercept.js

@@ -0,0 +1,173 @@
+import { getThoughtSpotHost } from "./config";
+import { getEmbedConfig } from "./embed/embedConfig";
+import { InterceptedApiType, EmbedEvent } from "./types";
+import { embedEventStatus } from "./utils";
+import { logger } from "./utils/logger";
+const DefaultInterceptUrlsMap = {
+    [InterceptedApiType.AnswerData]: [
+        '/prism/?op=GetChartWithData',
+        '/prism/?op=GetTableWithHeadlineData',
+        '/prism/?op=GetTableWithData',
+    ],
+    [InterceptedApiType.LiveboardData]: [
+        '/prism/?op=LoadContextBook'
+    ],
+};
+const formatInterceptUrl = (url) => {
+    const host = getThoughtSpotHost(getEmbedConfig());
+    if (url.startsWith('/'))
+        return `${host}${url}`;
+    return url;
+};
+/**
+ * Converts user passed url values to proper urls
+ * [ANSER_DATA] => ['https://host/pris/op?=op']
+ * @param interceptUrls
+ * @returns
+ */
+const processInterceptUrls = (interceptUrls) => {
+    let processedUrls = [...interceptUrls];
+    Object.entries(DefaultInterceptUrlsMap).forEach(([apiType, apiTypeUrls]) => {
+        if (!processedUrls.includes(apiType))
+            return;
+        processedUrls = processedUrls.filter(url => url !== apiType);
+        processedUrls = [...processedUrls, ...apiTypeUrls];
+    });
+    return processedUrls.map(url => formatInterceptUrl(url));
+};
+/**
+ * Returns the data to be sent to embed to setup intercepts
+ * the urls to intercept, timeout etc
+ * @param viewConfig
+ * @returns
+ */
+export const getInterceptInitData = (viewConfig) => {
+    const combinedUrls = [...(viewConfig.interceptUrls || [])];
+    if (viewConfig.isOnBeforeGetVizDataInterceptEnabled) {
+        combinedUrls.push(InterceptedApiType.AnswerData);
+    }
+    const shouldInterceptAll = combinedUrls.includes(InterceptedApiType.ALL);
+    const interceptUrls = shouldInterceptAll ? [InterceptedApiType.ALL] : processInterceptUrls(combinedUrls);
+    const interceptTimeout = viewConfig.interceptTimeout;
+    return {
+        interceptUrls,
+        interceptTimeout,
+    };
+};
+const parseJson = (jsonString) => {
+    try {
+        const json = JSON.parse(jsonString);
+        return [json, null];
+    }
+    catch (error) {
+        return [null, error];
+    }
+};
+/**
+ * Parse the api intercept data and return the parsed data and error if any
+ * Embed returns the input and init from the fetch call
+ */
+const parseInterceptData = (eventDataString) => {
+    try {
+        const [parsedData, error] = parseJson(eventDataString);
+        if (error) {
+            return [null, error];
+        }
+        const { input, init } = parsedData;
+        const [parsedBody, bodyParseError] = parseJson(init.body);
+        if (!bodyParseError) {
+            init.body = parsedBody;
+        }
+        const parsedInit = { input, init };
+        return [parsedInit, null];
+    }
+    catch (error) {
+        return [null, error];
+    }
+};
+const getUrlType = (url) => {
+    for (const [apiType, apiTypeUrls] of Object.entries(DefaultInterceptUrlsMap)) {
+        if (apiTypeUrls.includes(url))
+            return apiType;
+    }
+    // TODO: have a unknown type maybe ??
+    return InterceptedApiType.ALL;
+};
+/**
+ * Handle Api intercept event and simulate legacy onBeforeGetVizDataIntercept event
+ *
+ * embed sends -> ApiIntercept -> we send
+ *  ApiIntercept
+ *  OnBeforeGetVizDataIntercept (if url is part of DefaultUrlMap.AnswerData)
+ *
+ * @param params
+ * @returns
+ */
+export const handleInterceptEvent = async (params) => {
+    var _a, _b, _c, _d, _e;
+    const { eventData, executeEvent, viewConfig, getUnsavedAnswerTml } = params;
+    const [interceptData, bodyParseError] = parseInterceptData(eventData.data);
+    if (bodyParseError) {
+        executeEvent(EmbedEvent.Error, {
+            error: 'Error parsing api intercept body',
+        });
+        logger.error('Error parsing request body', bodyParseError);
+        return;
+    }
+    const { input: requestUrl, init } = interceptData;
+    const sessionId = (_c = (_b = (_a = init === null || init === void 0 ? void 0 : init.body) === null || _a === void 0 ? void 0 : _a.variables) === null || _b === void 0 ? void 0 : _b.session) === null || _c === void 0 ? void 0 : _c.sessionId;
+    const vizId = (_e = (_d = init === null || init === void 0 ? void 0 : init.body) === null || _d === void 0 ? void 0 : _d.variables) === null || _e === void 0 ? void 0 : _e.contextBookId;
+    const answerDataUrls = DefaultInterceptUrlsMap[InterceptedApiType.AnswerData];
+    const legacyInterceptEnabled = viewConfig.isOnBeforeGetVizDataInterceptEnabled;
+    const isAnswerDataUrl = answerDataUrls.includes(requestUrl);
+    const sendLegacyIntercept = isAnswerDataUrl && legacyInterceptEnabled;
+    if (sendLegacyIntercept) {
+        const answerTml = await getUnsavedAnswerTml({ sessionId, vizId });
+        // Build the legacy payload for backwards compatibility
+        const legacyPayload = {
+            data: {
+                data: answerTml,
+                status: embedEventStatus.END,
+                type: EmbedEvent.OnBeforeGetVizDataIntercept
+            }
+        };
+        executeEvent(EmbedEvent.OnBeforeGetVizDataIntercept, legacyPayload);
+    }
+    const urlType = getUrlType(requestUrl);
+    executeEvent(EmbedEvent.ApiIntercept, { ...interceptData, urlType });
+};
+/**
+ * Support both the legacy and new format of the api intercept response
+ * @param payload
+ * @returns
+ */
+export const processApiInterceptResponse = (payload) => {
+    var _a;
+    const isLegacyFormat = (_a = payload === null || payload === void 0 ? void 0 : payload.data) === null || _a === void 0 ? void 0 : _a.error;
+    if (isLegacyFormat) {
+        return processLegacyInterceptResponse(payload);
+    }
+    return payload;
+};
+export const processLegacyInterceptResponse = (payload) => {
+    var _a, _b, _c, _d, _e;
+    const errorText = (_b = (_a = payload === null || payload === void 0 ? void 0 : payload.data) === null || _a === void 0 ? void 0 : _a.error) === null || _b === void 0 ? void 0 : _b.errorText;
+    const errorDescription = (_d = (_c = payload === null || payload === void 0 ? void 0 : payload.data) === null || _c === void 0 ? void 0 : _c.error) === null || _d === void 0 ? void 0 : _d.errorDescription;
+    const payloadToSend = {
+        execute: (_e = payload === null || payload === void 0 ? void 0 : payload.data) === null || _e === void 0 ? void 0 : _e.execute,
+        response: {
+            body: {
+                errors: [
+                    {
+                        title: errorText,
+                        description: errorDescription,
+                        isUserError: true,
+                    },
+                ],
+                data: {},
+            },
+        },
+    };
+    return { data: payloadToSend };
+};
+//# sourceMappingURL=api-intercept.js.map

package/lib/src/api-intercept.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-intercept.js","sourceRoot":"","sources":["../../src/api-intercept.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAqC,UAAU,EAAE,MAAM,SAAS,CAAC;AAC5F,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,MAAM,uBAAuB,GAA0E;IACnG,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAC7B,6BAA6B;QAC7B,qCAAqC;QACrC,6BAA6B;KACpB;IACb,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE;QAChC,4BAA4B;KACnB;CAChB,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAE,EAAE;IACvC,MAAM,IAAI,GAAG,kBAAkB,CAAC,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,IAAI,GAAG,GAAG,EAAE,CAAC;IAChD,OAAO,GAAG,CAAC;AACf,CAAC,CAAA;AAKD;;;;;GAKG;AACH,MAAM,oBAAoB,GAAG,CAAC,aAA8C,EAAE,EAAE;IAC5E,IAAI,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAC;IACvC,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,EAAE;QACvE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,OAAO;QAC7C,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,OAAO,CAAC,CAAC;QAC7D,aAAa,GAAG,CAAC,GAAG,aAAa,EAAE,GAAG,WAAW,CAAC,CAAC;IACvD,CAAC,CAAC,CAAA;IACF,OAAO,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;AAC7D,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,UAA0B,EAA6E,EAAE;IAC1I,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC;IAE3D,IAAK,UAAmC,CAAC,oCAAoC,EAAE;QAC3E,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;KACpD;IAED,MAAM,kBAAkB,GAAG,YAAY,CAAC,QAAQ,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;IACzE,MAAM,aAAa,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAEzG,MAAM,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAErD,OAAO;QACH,aAAa;QACb,gBAAgB;KACnB,CAAC;AACN,CAAC,CAAA;AAED,MAAM,SAAS,GAAG,CAAC,UAAkB,EAAuB,EAAE;IAC1D,IAAI;QACA,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACpC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;KACvB;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;KACxB;AACL,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,kBAAkB,GAAG,CAAC,eAAoB,EAAE,EAAE;IAEhD,IAAI;QACA,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;QACvD,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;SACxB;QAED,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;QAEnC,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,CAAC,cAAc,EAAE;YACjB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;SAC1B;QAED,MAAM,UAAU,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACnC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;KAC7B;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;KACxB;AACL,CAAC,CAAA;AAED,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,EAAE;IAC/B,KAAK,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,EAAE;QAC1E,IAAI,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,OAA6B,CAAC;KACvE;IACD,qCAAqC;IACrC,OAAO,kBAAkB,CAAC,GAAG,CAAC;AAClC,CAAC,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EAAE,MAK1C,EAAE,EAAE;;IAED,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;IAE5E,MAAM,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,kBAAkB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAE3E,IAAI,cAAc,EAAE;QAChB,YAAY,CAAC,UAAU,CAAC,KAAK,EAAE;YAC3B,KAAK,EAAE,kCAAkC;SAC5C,CAAC,CAAC;QACH,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE,cAAc,CAAC,CAAC;QAC3D,OAAO;KACV;IAGD,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,aAAa,CAAC;IAElD,MAAM,SAAS,GAAG,MAAA,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,0CAAE,SAAS,0CAAE,OAAO,0CAAE,SAAS,CAAC;IAC5D,MAAM,KAAK,GAAG,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,0CAAE,SAAS,0CAAE,aAAa,CAAC;IAEnD,MAAM,cAAc,GAAG,uBAAuB,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAC9E,MAAM,sBAAsB,GAAG,UAAU,CAAC,oCAAoC,CAAC;IAC/E,MAAM,eAAe,GAAG,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,mBAAmB,GAAG,eAAe,IAAI,sBAAsB,CAAC;IACtE,IAAI,mBAAmB,EAAE;QACrB,MAAM,SAAS,GAAG,MAAM,mBAAmB,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,uDAAuD;QACvD,MAAM,aAAa,GAAG;YAClB,IAAI,EAAE;gBACF,IAAI,EAAG,SAAS;gBAChB,MAAM,EAAE,gBAAgB,CAAC,GAAG;gBAC5B,IAAI,EAAE,UAAU,CAAC,2BAA2B;aAC/C;SACJ,CAAA;QACD,YAAY,CAAC,UAAU,CAAC,2BAA2B,EAAE,aAAa,CAAC,CAAC;KACvE;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;IACvC,YAAY,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,GAAG,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC;AACzE,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,OAAY,EAAE,EAAE;;IACzD,MAAM,cAAc,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,0CAAE,KAAK,CAAC;IAE5C,IAAI,cAAc,EAAE;QACnB,OAAO,8BAA8B,CAAC,OAAO,CAAC,CAAC;KAC/C;IAED,OAAO,OAAO,CAAC;AAClB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,OAAY,EAAE,EAAE;;IAE3D,MAAM,SAAS,GAAG,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,0CAAE,KAAK,0CAAE,SAAS,CAAC;IAClD,MAAM,gBAAgB,GAAG,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,0CAAE,KAAK,0CAAE,gBAAgB,CAAC;IAEhE,MAAM,aAAa,GAAG;QAClB,OAAO,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,0CAAE,OAAO;QAC/B,QAAQ,EAAE;YACN,IAAI,EAAE;gBACF,MAAM,EAAE;oBACJ;wBACI,KAAK,EAAE,SAAS;wBAChB,WAAW,EAAE,gBAAgB;wBAC7B,WAAW,EAAE,IAAI;qBACpB;iBACJ;gBACD,IAAI,EAAE,EAAE;aACX;SACJ;KACJ,CAAC;IAGF,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;AACnC,CAAC,CAAA"}

package/lib/src/api-intercept.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api-intercept.spec.d.ts.map

package/lib/src/api-intercept.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-intercept.spec.d.ts","sourceRoot":"","sources":["../../src/api-intercept.spec.ts"],"names":[],"mappings":""}