@thoughtspot/visual-embed-sdk 1.51.2 → 1.52.1

package/dist/src/contracts/host-event-contracts.d.ts

@@ -0,0 +1,378 @@
+/**
+ * Copyright (c) 2026
+ *
+ * Typed contracts for {@link HostEvent} requests and responses.
+ *
+ * This module is the single source of truth for host event payload shapes.
+ * It is published under the `@thoughtspot/visual-embed-sdk/contracts` subpath
+ * so the ThoughtSpot app (host) can consume the exact same contract types the
+ * SDK compiles against, preventing SDK <-> host contract drift.
+ *
+ * Contract evolution rules (enforced by contracts.spec.ts snapshot):
+ * - Additive only: new events and new OPTIONAL fields may be added.
+ * - Never remove or rename an event key, or change an existing field's type.
+ * - An event absent from the maps below intentionally resolves to `any`
+ *   (untyped, backward compatible) until it is audited and added.
+ * @module contracts
+ */
+import type { ContextType, HostEvent, RuntimeFilter, RuntimeParameter } from '../types';
+import type { Applicability, EmbedApiHostEventMapping, UIPassthroughContractBase, UIPassthroughRequest, UIPassthroughResponse } from './ui-passthrough-contracts';
+/**
+ * Request for host events that MAY target a specific visualization.
+ * Omitting vizId targets the current answer/liveboard as a whole.
+ * (In some contexts, e.g. Spotter, the app requires vizId at runtime.)
+ */
+export interface VizScopedRequest {
+    vizId?: string;
+}
+/**
+ * Request for host events that MUST target a specific visualization.
+ */
+export interface RequiredVizRequest {
+    vizId: string;
+}
+/**
+ * Request for Spotter conversation-scoped host events.
+ */
+export interface ConversationScopedRequest {
+    conversationId: string;
+}
+/**
+ * Request payload for {@link HostEvent.OpenFilter}. Field requirements
+ * vary by context (Search requires columnId/type/dataType/name); the
+ * contract is the cross-context superset — the app validates per context
+ * at runtime. Per-context views: {@link OpenFilterLiveboardRequest},
+ * {@link OpenFilterSpotterRequest}, {@link OpenFilterSearchRequest}.
+ */
+export interface OpenFilterRequest {
+    column: {
+        columnId?: string;
+        columnName?: string;
+        type?: string;
+        dataType?: string;
+        name?: string;
+        isStrictDateColumn?: boolean;
+    };
+    applicability?: Applicability;
+    visualizationId?: string;
+    liveboardId?: string;
+}
+/**
+ * `OpenFilter` in Liveboard context: full column plus scoping fields.
+ * A per-context view of {@link OpenFilterRequest} (documentation only today;
+ * `trigger()` accepts the superset).
+ */
+export interface OpenFilterLiveboardRequest {
+    column: {
+        columnId?: string;
+        columnName?: string;
+    };
+    applicability?: Applicability;
+    visualizationId?: string;
+    liveboardId?: string;
+}
+/**
+ * `OpenFilter` in Spotter context: only the column identity is accepted.
+ */
+export interface OpenFilterSpotterRequest {
+    column: {
+        columnId?: string;
+        columnName?: string;
+    };
+}
+/**
+ * `OpenFilter` in Search/Answer context: column identity plus column metadata.
+ */
+export interface OpenFilterSearchRequest {
+    column: {
+        columnId?: string;
+        columnName?: string;
+        type?: string;
+        dataType?: string;
+        name?: string;
+        isStrictDateColumn?: boolean;
+    };
+}
+/**
+ * Request payload for {@link HostEvent.DrillDown}. Drills on selected or
+ * clicked points of a visualization. In Liveboard context `vizId` is required
+ * at runtime (documentation only today; `trigger()` is not yet type-enforced).
+ */
+export interface DrillDownRequest {
+    points: {
+        clickedPoint?: object;
+        selectedPoints?: object[];
+    };
+    columnGuid?: string;
+    autoDrillDown?: boolean;
+    vizId?: string;
+}
+/**
+ * Request payload for {@link HostEvent.OpenParameter}. One of parameterId
+ * or parameterName must be provided (validated at runtime).
+ */
+export interface OpenParameterRequest {
+    parameter: {
+        parameterId?: string;
+        parameterName?: string;
+    };
+    applicability?: Applicability;
+}
+/**
+ * Request payload for {@link HostEvent.Search}.
+ */
+export interface SearchRequest {
+    searchQuery: string;
+    dataSources: string[];
+    execute?: boolean;
+}
+/**
+ * Request payload for {@link HostEvent.SpotterSearch}.
+ */
+export interface SpotterSearchRequest {
+    query: string;
+    executeSearch: boolean;
+}
+/**
+ * A single cross-filter condition for {@link HostEvent.UpdateCrossFilter}.
+ */
+export interface CrossFilterCondition {
+    columnName?: string;
+    operator?: string;
+    values: Array<string | number | boolean>;
+}
+/**
+ * Request payload for {@link HostEvent.UpdateCrossFilter}.
+ */
+export interface UpdateCrossFilterRequest {
+    vizId: string;
+    conditions: CrossFilterCondition[];
+}
+/**
+ * A single filter entry for {@link HostEvent.UpdateFilters}. Supports both
+ * the current (columnName/operator) and legacy (column/oper) field names.
+ */
+export interface HostFilterUpdate {
+    columnName?: string;
+    columnId?: string;
+    operator?: string;
+    values: Array<string | number | boolean>;
+    type?: string;
+    datePeriod?: string;
+    negate?: boolean;
+    /** Legacy field name for columnName. */
+    column?: string;
+    /** Legacy field name for operator. */
+    oper?: string;
+    applicability?: Applicability;
+}
+/**
+ * Request payload for {@link HostEvent.UpdateFilters} (singular or plural
+ * form).
+ */
+export interface UpdateFiltersRequest {
+    filter?: HostFilterUpdate;
+    filters?: HostFilterUpdate[];
+    /**
+     * Scope the update to a specific visualization on a Liveboard.
+     * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+     */
+    visualizationId?: string;
+    /**
+     * Scope the update to a specific Liveboard.
+     * @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
+     */
+    liveboardId?: string;
+}
+/**
+ * Request payload for personalised-view host events.
+ */
+export interface PersonalisedViewRequest {
+    viewId?: string;
+    viewName?: string;
+}
+/**
+ * Request payload for schedule-email related host events.
+ */
+export interface ScheduleEmailRequest {
+    sendToSelf?: boolean;
+}
+/**
+ * Object form of the {@link HostEvent.Navigate} payload.
+ */
+export interface NavigateRequest {
+    /**
+     * Route to navigate to, or a history delta such as `1` or `-1`.
+     */
+    path: string | number;
+    /**
+     * When `true`, replaces the current history entry instead of pushing.
+     */
+    replace?: boolean;
+}
+/**
+ * Request payload for {@link HostEvent.SetActiveTab}.
+ */
+export interface SetActiveTabRequest {
+    /**
+     * Id of the liveboard tab to make active.
+     */
+    tabId: string;
+}
+/**
+ * Typed request payloads for host events that do not go through the UI
+ * passthrough pipeline (`HostEvent` member → request type; `void` = no payload).
+ *
+ * Shapes are transcribed from the host's runtime validation schemas
+ * (embed-util HostEventContract) — what the ThoughtSpot app actually enforces —
+ * flattened across contexts to the permissive superset (context-specific
+ * requirements are validated at runtime).
+ *
+ * Responses are typed only for UI-passthrough-backed events today (see
+ * {@link HostEventResponse}). Add a response map alongside this one when the
+ * first explicit response shape is specified; tightening later is additive.
+ *
+ * Deliberately absent (do not add without an audit):
+ * - DrillDown: the runtime schema (object-shaped points) and the UI
+ *   passthrough contract (string-shaped points) disagree — resolve the
+ *   drift first.
+ * - GetAnswerSession/GetParameters/GetTML: typed via the UI passthrough
+ *   mapping; their Spotter-context vizId requirement is runtime-only.
+ */
+export interface HostEventRequestMap {
+    [HostEvent.UpdateRuntimeFilters]: RuntimeFilter[];
+    [HostEvent.UpdateParameters]: RuntimeParameter[];
+    [HostEvent.UpdateFilters]: UpdateFiltersRequest;
+    [HostEvent.UpdateCrossFilter]: UpdateCrossFilterRequest;
+    [HostEvent.OpenFilter]: OpenFilterRequest;
+    [HostEvent.OpenParameter]: OpenParameterRequest;
+    [HostEvent.SetVisibleVizs]: string[];
+    [HostEvent.SetVisibleTabs]: string[];
+    [HostEvent.SetHiddenTabs]: string[];
+    [HostEvent.SetActiveTab]: SetActiveTabRequest;
+    [HostEvent.Navigate]: string | number | NavigateRequest;
+    [HostEvent.Search]: SearchRequest;
+    [HostEvent.ResetSearch]: void;
+    [HostEvent.AddColumns]: {
+        columnIds: string[];
+    };
+    [HostEvent.RemoveColumn]: {
+        columnId: string;
+    };
+    [HostEvent.Edit]: VizScopedRequest;
+    [HostEvent.Save]: VizScopedRequest;
+    [HostEvent.Delete]: VizScopedRequest;
+    [HostEvent.Share]: VizScopedRequest;
+    [HostEvent.Present]: VizScopedRequest;
+    [HostEvent.CopyLink]: VizScopedRequest;
+    [HostEvent.ExportTML]: VizScopedRequest;
+    [HostEvent.EditTML]: VizScopedRequest;
+    [HostEvent.UpdateTML]: VizScopedRequest;
+    [HostEvent.SchedulesList]: VizScopedRequest;
+    [HostEvent.Schedule]: VizScopedRequest;
+    [HostEvent.SpotIQAnalyze]: VizScopedRequest;
+    [HostEvent.ShowUnderlyingData]: VizScopedRequest;
+    [HostEvent.CreateMonitor]: VizScopedRequest;
+    [HostEvent.ManageMonitor]: VizScopedRequest;
+    [HostEvent.SyncToSheets]: VizScopedRequest;
+    [HostEvent.SyncToOtherApps]: VizScopedRequest;
+    [HostEvent.ManagePipelines]: VizScopedRequest;
+    [HostEvent.DownloadAsPng]: VizScopedRequest;
+    [HostEvent.DownloadAsCsv]: VizScopedRequest;
+    [HostEvent.DownloadAsXlsx]: VizScopedRequest;
+    [HostEvent.DownloadAsPdf]: VizScopedRequest & {
+        liveboardId?: string;
+    };
+    [HostEvent.Explore]: RequiredVizRequest;
+    [HostEvent.AskSage]: RequiredVizRequest;
+    [HostEvent.AskSpotter]: RequiredVizRequest;
+    [HostEvent.AnswerChartSwitcher]: RequiredVizRequest;
+    [HostEvent.UpdatePersonalisedView]: Pick<PersonalisedViewRequest, 'viewId'>;
+    [HostEvent.SelectPersonalizedView]: PersonalisedViewRequest;
+    [HostEvent.ResetLiveboardPersonalisedView]: void;
+    [HostEvent.AIHighlights]: void;
+    [HostEvent.SendTestScheduleEmail]: ScheduleEmailRequest;
+    [HostEvent.RefreshLiveboardBrowserCache]: ScheduleEmailRequest;
+    [HostEvent.SpotterSearch]: SpotterSearchRequest;
+    [HostEvent.ResetSpotterConversation]: void;
+    [HostEvent.ShareSpotterConversation]: ConversationScopedRequest;
+    [HostEvent.CloseSpotterShareConversation]: void;
+    [HostEvent.ExitSpotterSharedConversation]: void;
+    [HostEvent.PinSpotterConversation]: ConversationScopedRequest;
+    [HostEvent.UnpinSpotterConversation]: ConversationScopedRequest;
+    [HostEvent.EditLastPrompt]: string;
+    [HostEvent.DeleteLastPrompt]: void;
+    [HostEvent.PreviewSpotterData]: void;
+    [HostEvent.SpotterVizSendUserMessage]: {
+        query: string;
+    };
+    [HostEvent.InitSpotterVizConversation]: void;
+    [HostEvent.OpenSpotterVizPanel]: void;
+    [HostEvent.CloseSpotterVizPanel]: void;
+}
+/**
+ * Per-context request shapes for events whose payload varies by
+/**
+ * Resolves the typed request payload for a host event.
+ * Resolution order:
+ * 1. Explicitly typed request in {@link HostEventRequestMap}
+ * 2. UI passthrough backed contract ({@link EmbedApiHostEventMapping})
+ * 3. `any` (event not audited/typed yet — backward compatible)
+ *
+ * Requests are the cross-context superset today. The per-context `*Request`
+ * interfaces (e.g. {@link OpenFilterLiveboardRequest}) document how the shape
+ * narrows by context; a later release may thread the caller's context to
+ * enforce it.
+ */
+export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof HostEventRequestMap ? HostEventRequestMap[HostEventT] : HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
+/**
+ * Resolves the typed response payload for a host event. Only UI passthrough
+ * backed events have typed responses today; everything else resolves to `any`.
+ */
+export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType = ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
+/**
+ * Payload type accepted by `embed.trigger()`. Keeps the historical
+ * `PayloadT` escape hatch so untyped existing call sites keep compiling.
+ */
+export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
+/**
+ * Deep `Partial` of a request type: every field optional at every depth, with no
+ * index signature — so object literals carrying unknown fields are flagged.
+ */
+export type DeepPartial<T> = T extends (infer U)[] ? DeepPartial<U>[] : T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+/**
+ * `trigger()`'s `data` type: an all-optional view of the event's request type.
+ * See {@link HostEventRequest} and the `*Request` interfaces, e.g. {@link SearchRequest}.
+ * No-payload events take `{}`. SDK 1.54.0 makes this strict (required fields enforced).
+ */
+export type TriggerData<HostEventT extends HostEvent> = HostEventRequest<HostEventT> extends void ? Record<string, never> : DeepPartial<HostEventRequest<HostEventT>>;
+/**
+ * Response type returned by `embed.trigger()`.
+ */
+export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType = ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
+/**
+ * String-name keyed views of the contracts, for the host (ThoughtSpot app)
+ * side, which addresses events by their wire value (e.g.
+ * 'UpdateRuntimeFilters') rather than the {@link HostEvent} enum member.
+ */
+export type HostEventName = `${HostEvent}`;
+/**
+ * Resolves a host event's request type from its wire name.
+ */
+export type HostEventRequestByName<NameT extends string> = {
+    [EventT in HostEvent]: `${EventT}` extends NameT ? HostEventRequest<EventT> : never;
+}[HostEvent] extends never ? any : {
+    [EventT in HostEvent]: `${EventT}` extends NameT ? HostEventRequest<EventT> : never;
+}[HostEvent];
+/**
+ * Resolves a host event's response type from its wire name.
+ */
+export type HostEventResponseByName<NameT extends string> = {
+    [EventT in HostEvent]: `${EventT}` extends NameT ? HostEventResponse<EventT> : never;
+}[HostEvent] extends never ? any : {
+    [EventT in HostEvent]: `${EventT}` extends NameT ? HostEventResponse<EventT> : never;
+}[HostEvent];
+export type { UIPassthroughContractBase, EmbedApiHostEventMapping };
+//# sourceMappingURL=host-event-contracts.d.ts.map

package/dist/src/contracts/host-event-contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"host-event-contracts.d.ts","sourceRoot":"","sources":["host-event-contracts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,KAAK,EACR,WAAW,EACX,SAAS,EACT,aAAa,EACb,gBAAgB,EACnB,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EACR,aAAa,EACb,wBAAwB,EACxB,yBAAyB,EACzB,oBAAoB,EACpB,qBAAqB,EACxB,MAAM,4BAA4B,CAAC;AAEpC;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAChC,CAAC;IACF,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC,MAAM,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACnD,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,MAAM,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACtD;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,MAAM,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAChC,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,MAAM,EAAE;QACJ,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;KAC7B,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,SAAS,EAAE;QACP,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,aAAa,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,oBAAoB,EAAE,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC7B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,mBAAmB;IAEhC,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,aAAa,EAAE,CAAC;IAClD,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACjD,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,oBAAoB,CAAC;IAChD,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;IACxD,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC1C,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,oBAAoB,CAAC;IAGhD,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IACrC,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IACrC,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,mBAAmB,CAAC;IAG9C,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,eAAe,CAAC;IAGxD,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;IAClC,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC;IAC9B,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE;QAAE,SAAS,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAChD,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAI/C,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACnC,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACnC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,gBAAgB,CAAC;IACrC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACpC,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC;IACtC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACvC,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IACxC,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC;IACtC,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IACxC,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,gBAAgB,CAAC;IAC5C,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACvC,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,gBAAgB,CAAC;IAC5C,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,gBAAgB,CAAC;IACjD,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,gBAAgB,CAAC;IAC5C,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,gBAAgB,CAAC;IAC5C,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAC3C,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,gBAAgB,CAAC;IAC9C,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,gBAAgB,CAAC;IAE9C,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,gBAAgB,CAAC;IAC5C,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,gBAAgB,CAAC;IAC5C,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,gBAAgB,CAAC;IAC7C,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,gBAAgB,GAAG;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAGvE,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;IACxC,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;IACxC,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAC3C,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,kBAAkB,CAAC;IAGpD,CAAC,SAAS,CAAC,sBAAsB,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,QAAQ,CAAC,CAAC;IAC5E,CAAC,SAAS,CAAC,sBAAsB,CAAC,EAAE,uBAAuB,CAAC;IAC5D,CAAC,SAAS,CAAC,8BAA8B,CAAC,EAAE,IAAI,CAAC;IACjD,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC;IAC/B,CAAC,SAAS,CAAC,qBAAqB,CAAC,EAAE,oBAAoB,CAAC;IACxD,CAAC,SAAS,CAAC,4BAA4B,CAAC,EAAE,oBAAoB,CAAC;IAG/D,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,oBAAoB,CAAC;IAChD,CAAC,SAAS,CAAC,wBAAwB,CAAC,EAAE,IAAI,CAAC;IAC3C,CAAC,SAAS,CAAC,wBAAwB,CAAC,EAAE,yBAAyB,CAAC;IAChE,CAAC,SAAS,CAAC,6BAA6B,CAAC,EAAE,IAAI,CAAC;IAChD,CAAC,SAAS,CAAC,6BAA6B,CAAC,EAAE,IAAI,CAAC;IAChD,CAAC,SAAS,CAAC,sBAAsB,CAAC,EAAE,yBAAyB,CAAC;IAC9D,CAAC,SAAS,CAAC,wBAAwB,CAAC,EAAE,yBAAyB,CAAC;IAChE,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACnC,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC;IACnC,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,IAAI,CAAC;IACrC,CAAC,SAAS,CAAC,yBAAyB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACzD,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,CAAC;IAC7C,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,IAAI,CAAC;IACtC,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAC;CAC1C;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,gBAAgB,CAAC,UAAU,SAAS,SAAS,IACrD,UAAU,SAAS,MAAM,mBAAmB,GACtC,mBAAmB,CAAC,UAAU,CAAC,GAC/B,UAAU,SAAS,MAAM,wBAAwB,GAC7C,oBAAoB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,GAC1D,GAAG,CAAC;AAClB;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CACzB,UAAU,SAAS,SAAS,EAE5B,QAAQ,SAAS,WAAW,GAAG,WAAW,IAC1C,UAAU,SAAS,MAAM,wBAAwB,GAC/C,qBAAqB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,GAC3D,GAAG,CAAC;AAEV;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,QAAQ,EAAE,UAAU,SAAS,SAAS,IAC7D,QAAQ,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IACrB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACf,WAAW,CAAC,CAAC,CAAC,EAAE,GAChB,CAAC,SAAS,MAAM,GACZ;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACtC,CAAC,CAAC;AAEhB;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,UAAU,SAAS,SAAS,IAChD,gBAAgB,CAAC,UAAU,CAAC,SAAS,IAAI,GACvC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACrB,WAAW,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,eAAe,CACvB,QAAQ,EACR,UAAU,SAAS,SAAS,EAC5B,QAAQ,SAAS,WAAW,GAAG,WAAW,IAC1C,QAAQ,SAAS,gBAAgB,CAAC,UAAU,CAAC,GAC3C,iBAAiB,CAAC,UAAU,EAAE,QAAQ,CAAC,GACvC,GAAG,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,GAAG,SAAS,EAAE,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAAC,KAAK,SAAS,MAAM,IAAI;KACtD,MAAM,IAAI,SAAS,GAAG,GAAG,MAAM,EAAE,SAAS,KAAK,GAC1C,gBAAgB,CAAC,MAAM,CAAC,GACxB,KAAK;CACd,CAAC,SAAS,CAAC,SAAS,KAAK,GACpB,GAAG,GACH;KACG,MAAM,IAAI,SAAS,GAAG,GAAG,MAAM,EAAE,SAAS,KAAK,GAC1C,gBAAgB,CAAC,MAAM,CAAC,GACxB,KAAK;CACd,CAAC,SAAS,CAAC,CAAC;AAEjB;;GAEG;AACH,MAAM,MAAM,uBAAuB,CAAC,KAAK,SAAS,MAAM,IAAI;KACvD,MAAM,IAAI,SAAS,GAAG,GAAG,MAAM,EAAE,SAAS,KAAK,GAC1C,iBAAiB,CAAC,MAAM,CAAC,GACzB,KAAK;CACd,CAAC,SAAS,CAAC,SAAS,KAAK,GACpB,GAAG,GACH;KACG,MAAM,IAAI,SAAS,GAAG,GAAG,MAAM,EAAE,SAAS,KAAK,GAC1C,iBAAiB,CAAC,MAAM,CAAC,GACzB,KAAK;CACd,CAAC,SAAS,CAAC,CAAC;AAEjB,YAAY,EAAE,yBAAyB,EAAE,wBAAwB,EAAE,CAAC"}

package/dist/src/contracts/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) 2026
+ *
+ * `@thoughtspot/visual-embed-sdk/contracts`
+ *
+ * Single source of truth for the Visual Embed SDK <-> ThoughtSpot app event
+ * contracts. Consumed by:
+ * - the SDK itself (compile-time types for `trigger()` / `on()`),
+ * - the ThoughtSpot app (host-side handler typing + runtime validation),
+ * - documentation generation.
+ *
+ * Evolution policy: ADDITIVE ONLY. See host-event-contracts.ts header.
+ * @module contracts
+ */
+export { HostEvent, EmbedEvent, ContextType, } from '../types';
+export type { RuntimeFilter, RuntimeParameter, MessagePayload, CustomAction, CustomActionPayload, } from '../types';
+export { CustomActionsPosition, CustomActionTarget, } from '../types';
+export * from './host-event-contracts';
+export * from './embed-event-payloads';
+export { UIPassthroughEvent, ApplicabilityLevel, } from './ui-passthrough-contracts';
+export type { Applicability, FilterUpdate, LiveboardFilter, LiveboardParameter, LiveboardTab, LiveboardGroup, UIPassthroughRequest, UIPassthroughResponse, UIPassthroughArrayResponse, } from './ui-passthrough-contracts';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/contracts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,OAAO,EACH,SAAS,EACT,UAAU,EACV,WAAW,GACd,MAAM,UAAU,CAAC;AAClB,YAAY,EACR,aAAa,EACb,gBAAgB,EAChB,cAAc,EAGd,YAAY,EACZ,mBAAmB,GACtB,MAAM,UAAU,CAAC;AAClB,OAAO,EACH,qBAAqB,EACrB,kBAAkB,GACrB,MAAM,UAAU,CAAC;AAElB,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AAIvC,OAAO,EACH,kBAAkB,EAClB,kBAAkB,GACrB,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACR,aAAa,EACb,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,oBAAoB,EACpB,qBAAqB,EACrB,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC"}