CBCA (In progress)

src/embed/ts-embed.spec.ts

@@ -346,6 +346,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -382,6 +383,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -424,6 +426,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [HomepageModule.MyLibrary, HomepageModule.Learning],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -462,6 +465,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -503,6 +507,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules:
                             [HomepageModule.MyLibrary, HomepageModule.Watchlist],
                         customVariablesForThirdPartyTools,
@@ -547,6 +552,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -592,6 +598,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -636,6 +643,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -681,6 +689,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -725,6 +734,7 @@ describe('Unit test case for ts embed', () => {
                       [HomeLeftNavItem.Home, HomeLeftNavItem.MonitorSubscription],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -893,6 +903,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools: {},
@@ -977,6 +988,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
                         hiddenListColumns: [],
+                        customActions: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools: {},

src/embed/ts-embed.ts

@@ -34,6 +34,7 @@ import {
     setStyleProperties,
     removeStyleProperties,
     isUndefined,
+    getCustomActions,
 } from '../utils';
 import {
     getThoughtSpotHost,
@@ -379,6 +380,7 @@ export class TsEmbed {
             customVariablesForThirdPartyTools:
                 this.embedConfig.customVariablesForThirdPartyTools || {},
             hiddenListColumns: this.viewConfig.hiddenListColumns || [],
+            customActions: getCustomActions(this.viewConfig.customActions || []),
         };
     }
 

src/index.ts

@@ -60,6 +60,7 @@ import {
     VizPoint,
     CustomActionPayload,
     ListPageColumns,
+    CustomActionsPosition,
 } from './types';
 import { CustomCssVariables } from './css-variables';
 import { SageEmbed, SageViewConfig } from './embed/sage';
@@ -144,6 +145,7 @@ export {
     CustomActionPayload,
     UIPassthroughEvent,
     ListPageColumns,
+    CustomActionsPosition,
 };
 
 export { resetCachedAuthToken } from './authToken';

src/react/index.tsx

@@ -24,7 +24,7 @@
     // Embed.preRender() method instead of the usual render method, and it will
     // not be destroyed when the component is unmounted.
     isPreRenderedComponent = false,
  ) => React.forwardRef<InstanceType<T>, U>(
     (props: U, forwardedRef: React.MutableRefObject<InstanceType<T>>) => {
         const ref = React.useRef<HTMLDivElement>(null);
         const { className, style, ...embedProps } = props;
@@ -534,4 +534,5 @@
     LogLevel,
     getSessionInfo,
     ListPageColumns,
+    CustomActionsPosition,
 } from '../index';

src/types.ts

@@ -1010,6 +1010,11 @@ export interface BaseViewConfig {
      * @private
      */
     insertInToSlide?: boolean;
+    /**
+     * Custom actions are a way to add custom actions to the embedded view which
+     * can be used to trigger custom logic when the action is clicked.
+     */
+    customActions?: CustomAction[];
 }
 
 /**
@@ -5207,6 +5212,33 @@ export interface CustomActionPayload {
     vizId?: string;
 }
 
+export interface CustomAction {
+    name: string;
+    id: string;
+    position: CustomActionsPosition;
+    callback: (payload: any) => void; // give a proper type for the payload
+    metadataIds?: {
+        answerIds?: string[];
+        liveboardIds?: string[];
+        vizIds?: string[];
+    };
+    dataModelIds?: {
+        modelIds?: string[];
+        modelColumnNames?: string[];
+    }
+    orgIds?: string[];
+    groupIds?: string[];
+    // we might have spotter parameters as well
+}
+
+export enum CustomActionsPosition {
+    ANSWERMENU = 'ANSWERMENU',
+    ANSWERPRIMARY = 'ANSWERPRIMARY',
+    ANSWERCONTEXTMENU='ANSWERCONTEXTMENU',
+    LIVEBOARDPRIMARY = 'LIVEBOARDPRIMARY',
+    LIVEBOARDMENU = 'LIVEBOARDMENU',
+}
+
 /**
  * Enum options to show or suppress Visual Embed SDK and
  * ThoughtSpot application logs in the console output.
@@ -5304,4 +5336,5 @@ export interface DefaultAppInitData {
     hiddenHomeLeftNavItems: string[];
     customVariablesForThirdPartyTools: Record<string, any>;
     hiddenListColumns: ListPageColumns[];
+    customActions: CustomAction[];
 }

src/utils.ts

@@ -15,6 +15,7 @@ import {
     DOMSelector,
     RuntimeParameter,
     AllEmbedViewConfig,
+    CustomAction,
 } from './types';
 import { logger } from './utils/logger';
 
@@ -243,6 +244,10 @@ export const getCustomisations = (
     return customizations;
 };
 
+export const getCustomActions = (customActions: CustomAction[]): CustomAction[] => {
+    return customActions;
+};
+
 export const getRuntimeFilters = (runtimefilters: any) => getFilterQuery(runtimefilters || []);
 
 /**