@thoughtspot/visual-embed-sdk 1.52.0 → 1.52.2-beta

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.52.0",
+    "version": "1.52.2-beta",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -22,6 +22,11 @@
             "require": "./cjs/src/react/all-types-export.js",
             "types": "./lib/src/react/all-types-export.d.ts"
         },
+        "./contracts": {
+            "import": "./lib/src/contracts/index.js",
+            "require": "./cjs/src/contracts/index.js",
+            "types": "./lib/src/contracts/index.d.ts"
+        },
         "./lib/src/react": {
             "import": "./lib/src/react/all-types-export.js",
             "require": "./cjs/src/react/all-types-export.js",
@@ -32,6 +37,9 @@
         "*": {
             "react": [
                 "./lib/src/react/all-types-export.d.ts"
+            ],
+            "contracts": [
+                "./lib/src/contracts/index.d.ts"
             ]
         }
     },
@@ -44,7 +52,8 @@
     "scripts": {
         "lint": "eslint 'src/**'",
         "lint:fix": "eslint 'src/**/*.*' --fix",
-        "tsc": "tsc -p tsconfig.build.json --incremental false; tsc -p tsconfig.build.json --incremental false --module commonjs --outDir cjs",
+        "tsc": "tsc -p tsconfig.build.json --incremental false && tsc -p tsconfig.build.json --incremental false --module commonjs --outDir cjs",
+        "tsc:check": "tsc -p tsconfig.build.json --incremental false --noEmit",
         "bundle-dts-file": "dts-bundle-generator --config ./dts-config/dts-bundle-file.config.js && node dts-config/wrap-ambient-module.mjs",
         "bundle-dts": "dts-bundle-generator --config ./dts-config/dts-bundle.config.js",
         "bundle-dts-react": "dts-bundle-generator --config ./dts-config/dts-bundle-react.config.js",
@@ -56,11 +65,15 @@
         "test": "npm run test-sdk",
         "posttest": "cat ./coverage/sdk/lcov.info | npx coveralls-next || echo 'Warning: Coveralls upload failed but not breaking the build.'",
         "is-publish-allowed": "node scripts/is-publish-allowed.js",
-        "prepublishOnly": "npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
+        "prepublishOnly": "npm run is-publish-allowed && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
         "check-size": "npm run build && size-limit",
         "publish-dev": "npm publish --tag dev",
         "publish-prod": "npm publish --tag latest",
-        "dev": "vite -c vite.local.config.ts"
+        "dev": "vite -c vite.local.config.ts",
+        "prepare": "husky"
+    },
+    "lint-staged": {
+        "src/**/*.{ts,tsx,js,jsx}": "eslint --fix"
     },
     "peerDependencies": {
         "react": "> 16.8.0",
@@ -115,11 +128,13 @@
         "globals": "^16.0.0",
         "highlight.js": "^10.6.0",
         "html-to-text": "^8.0.0",
+        "husky": "^9.1.7",
         "identity-obj-proxy": "^3.0.0",
         "istanbul-merge": "^2.0.0",
         "jest": "^30.2.0",
         "jest-environment-jsdom": "^29.7.0",
         "jest-fetch-mock": "^3.0.3",
+        "lint-staged": "^17.5.1",
         "prettier": "3.8.1",
         "react": "^16.14.0",
         "react-dom": "^16.14.0",

package/lib/src/contracts/contracts.spec.d.ts

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

package/lib/src/contracts/contracts.spec.d.ts.map

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

package/lib/src/contracts/contracts.spec.js

@@ -0,0 +1,342 @@
+/**
+ * Contract drift guardrails.
+ *
+ * These tests are the CI gate for the additive-only contract policy:
+ * - The explicit wire-value lists below record which events have TYPED
+ *   contracts. Removing an event from the typed maps (or renaming its wire
+ *   value) fails the equality check and must be treated as a breaking change,
+ *   not a refactor.
+ * - Type-level assertions verify the request/response resolution helpers
+ *   keep resolving typed events to their contracts and unknown events to
+ *   `any` (backward compatibility).
+ *
+ * When a list check fails: if you ADDED an event, add its wire value to the
+ * expected list here. If an existing entry disappeared or changed value,
+ * stop — that breaks published SDK consumers and the host runtime validation
+ * derived from these contracts.
+ */
+import { HostEvent, EmbedEvent, RuntimeFilterOp } from '../types';
+import { UIPassthroughEvent } from './ui-passthrough-contracts';
+import * as contractsBarrel from './index';
+// Events with explicitly typed requests in HostEventRequestMap.
+// Keep in sync with the interface — this list is what the snapshot locks.
+const TYPED_HOST_EVENTS = [
+    // Filters and parameters
+    HostEvent.UpdateRuntimeFilters,
+    HostEvent.UpdateParameters,
+    HostEvent.UpdateFilters,
+    HostEvent.UpdateCrossFilter,
+    HostEvent.OpenFilter,
+    HostEvent.OpenParameter,
+    // Tabs and vizs
+    HostEvent.SetVisibleVizs,
+    HostEvent.SetVisibleTabs,
+    HostEvent.SetHiddenTabs,
+    HostEvent.SetActiveTab,
+    // Navigation
+    HostEvent.Navigate,
+    // Search and columns
+    HostEvent.Search,
+    HostEvent.ResetSearch,
+    HostEvent.AddColumns,
+    HostEvent.RemoveColumn,
+    // Viz-scoped actions
+    HostEvent.Edit,
+    HostEvent.Save,
+    HostEvent.Delete,
+    HostEvent.Share,
+    HostEvent.Present,
+    HostEvent.CopyLink,
+    HostEvent.ExportTML,
+    HostEvent.EditTML,
+    HostEvent.UpdateTML,
+    HostEvent.SchedulesList,
+    HostEvent.Schedule,
+    HostEvent.SpotIQAnalyze,
+    HostEvent.ShowUnderlyingData,
+    HostEvent.CreateMonitor,
+    HostEvent.ManageMonitor,
+    HostEvent.SyncToSheets,
+    HostEvent.SyncToOtherApps,
+    HostEvent.ManagePipelines,
+    HostEvent.DownloadAsPng,
+    HostEvent.DownloadAsCsv,
+    HostEvent.DownloadAsXlsx,
+    HostEvent.DownloadAsPdf,
+    HostEvent.Explore,
+    HostEvent.AskSage,
+    HostEvent.AskSpotter,
+    HostEvent.AnswerChartSwitcher,
+    // Liveboard
+    HostEvent.UpdatePersonalisedView,
+    HostEvent.SelectPersonalizedView,
+    HostEvent.ResetLiveboardPersonalisedView,
+    HostEvent.AIHighlights,
+    HostEvent.SendTestScheduleEmail,
+    HostEvent.RefreshLiveboardBrowserCache,
+    // Spotter
+    HostEvent.SpotterSearch,
+    HostEvent.ResetSpotterConversation,
+    HostEvent.ShareSpotterConversation,
+    HostEvent.CloseSpotterShareConversation,
+    HostEvent.ExitSpotterSharedConversation,
+    HostEvent.PinSpotterConversation,
+    HostEvent.UnpinSpotterConversation,
+    HostEvent.EditLastPrompt,
+    HostEvent.DeleteLastPrompt,
+    HostEvent.PreviewSpotterData,
+    HostEvent.SpotterVizSendUserMessage,
+    HostEvent.InitSpotterVizConversation,
+    HostEvent.OpenSpotterVizPanel,
+    HostEvent.CloseSpotterVizPanel,
+];
+// Type-level assertions: compile failures here mean contract resolution
+// regressed. `expectType` is erased at runtime.
+const expectType = (value) => value;
+describe('event contracts (drift guardrails)', () => {
+    // The lists below LOCK the set of typed events. Adding an event is an
+    // intentional, additive edit here; a removed/renamed wire value fails this
+    // test — which is the signal that it is a breaking change, not a refactor.
+    test('typed host event wire values are stable (additive-only)', () => {
+        expect(TYPED_HOST_EVENTS.map((event) => `${event}`).sort()).toEqual([
+            'AIHighlights',
+            'AskSage',
+            'AskSpotter',
+            'CloseSpotterShareConversation',
+            'CloseSpotterVizPanel',
+            'DeleteLastPrompt',
+            'EditLastPrompt',
+            'ExitSpotterSharedConversation',
+            'InitSpotterVizConversation',
+            'Navigate',
+            'OpenSpotterVizPanel',
+            'PinSpotterConversation',
+            'PreviewSpotterData',
+            'ResetLiveboardPersonalisedView',
+            'ResetSpotterConversation',
+            'SelectPersonalisedView',
+            'SetActiveTab',
+            'SetPinboardHiddenTabs',
+            'SetPinboardVisibleTabs',
+            'SetPinboardVisibleVizs',
+            'ShareSpotterConversation',
+            'SpotterSearch',
+            'SpotterVizSendUserMessage',
+            'UnpinSpotterConversation',
+            'UpdateCrossFilter',
+            'UpdateParameters',
+            'UpdatePersonalisedView',
+            'UpdateRuntimeFilters',
+            'addColumns',
+            'answerChartSwitcher',
+            'createMonitor',
+            'downloadAsCSV',
+            'downloadAsPdf',
+            'downloadAsPng',
+            'downloadAsXLSX',
+            'edit',
+            'editTSL',
+            'embedDocument',
+            'explore',
+            'exportTSL',
+            'manage-pipeline',
+            'manageMonitor',
+            'onDeleteAnswer',
+            'openFilter',
+            'openParameter',
+            'present',
+            'refreshLiveboardBrowserCache',
+            'removeColumn',
+            'resetSearch',
+            'save',
+            'schedule-list',
+            'search',
+            'sendTestScheduleEmail',
+            'share',
+            'showUnderlyingData',
+            'spotIQAnalyze',
+            'subscription',
+            'sync-to-other-apps',
+            'sync-to-sheets',
+            'updateFilters',
+            'updateTSL',
+        ]);
+    });
+    test('UI passthrough wire values are stable (additive-only)', () => {
+        expect(Object.values(UIPassthroughEvent).sort()).toEqual([
+            'addVizToPinboard',
+            'drillDown',
+            'getAnswerPageConfig',
+            'getAnswerSession',
+            'getAvailableUiPassthroughs',
+            'getDiscoverabilityStatus',
+            'getExportRequestForCurrentPinboard',
+            'getFilters',
+            'getGroups',
+            'getIframeUrl',
+            'getParameters',
+            'getPinboardPageConfig',
+            'getTML',
+            'getTabs',
+            'getUnsavedAnswerTML',
+            'saveAnswer',
+            'updateFilters',
+        ]);
+    });
+    test('every typed host event is a real HostEvent member', () => {
+        const allHostEventValues = new Set(Object.values(HostEvent));
+        TYPED_HOST_EVENTS.forEach((event) => {
+            expect(allHostEventValues.has(event)).toBe(true);
+        });
+    });
+    test('contract resolution helpers compile against the typed map', () => {
+        // Typed event resolves to its contract type.
+        expectType(undefined);
+        expectType(undefined);
+        expectType(undefined);
+        // Untyped event stays `any` (backward compatible).
+        const untyped = { anything: 'goes' };
+        expect(untyped).toBeDefined();
+        // Response helper resolves for UI-passthrough-backed events.
+        expectType(undefined);
+    });
+    test('embed event enum wire values referenced by typed payloads are stable', () => {
+        expect([
+            EmbedEvent.AuthInit,
+            EmbedEvent.EmbedListenerReady,
+            EmbedEvent.CustomAction,
+        ].map((e) => `${e}`).sort()).toEqual([
+            'EmbedListenerReady',
+            'authInit',
+            'customAction',
+        ]);
+    });
+    test('CustomAction resolves to its typed payload; answerService on the dedicated type', () => {
+        // Wire data resolves to CustomActionPayload.
+        expectType(undefined);
+        // payload.data.id is a typed string (type-level indexed access).
+        expectType(undefined);
+        const svc = undefined;
+        expect(svc).toBeUndefined();
+        // Untyped embed event stays `any` (backward compatible).
+        const untyped = { anything: 'goes' };
+        expect(untyped).toBeDefined();
+    });
+    test('HostEvent doc examples compile against TriggerData (docs and types must agree)', () => {
+        // Payloads copied verbatim from the HostEvent enum @example blocks.
+        // If one stops compiling, the docs or the contract is wrong; fix that.
+        const trigger = (_event, _data) => true;
+        const ok = [
+            trigger(HostEvent.UpdateParameters, [{ name: 'Integer Range Param', value: 10, isVisibleToUser: false }]),
+            trigger(HostEvent.UpdateParameters, [{
+                    name: 'Integer Range Param',
+                    value: 10,
+                    applicability: { level: 'TAB', targetId: 'e0836cad-4fdf-42d4-bd97-567a6b2a6058' },
+                }]),
+            trigger(HostEvent.UpdateRuntimeFilters, [
+                { columnName: 'state', operator: RuntimeFilterOp.EQ, values: ['michigan'] },
+                { columnName: 'product', operator: RuntimeFilterOp.IN, values: ['shoes', 'boots'] },
+            ]),
+            trigger(HostEvent.UpdateFilters, { filter: { column: 'item type', oper: 'IN', values: ['bags', 'shirts'] } }),
+            trigger(HostEvent.UpdateFilters, {
+                filter: { column: 'date', oper: 'EQ', values: ['JULY', '2023'], type: 'MONTH_YEAR' },
+            }),
+            trigger(HostEvent.OpenFilter, {
+                column: { columnId: '<column-GUID>', name: 'column name', type: 'ATTRIBUTE', dataType: 'INT64' },
+            }),
+            trigger(HostEvent.OpenFilter, { column: { columnId: '<column-GUID>' } }),
+            trigger(HostEvent.OpenParameter, { parameter: { parameterId: '<parameter-GUID>' } }),
+            trigger(HostEvent.OpenParameter, {
+                parameter: { parameterId: '<parameter-GUID>' },
+                applicability: { level: 'GROUP', targetId: '<group-GUID>' },
+            }),
+            trigger(HostEvent.UpdateFilters, {
+                filter: {
+                    column: 'item type',
+                    oper: 'IN',
+                    values: ['bags', 'shirts'],
+                    applicability: { level: 'TAB', targetId: 'e0836cad-4fdf-42d4-bd97-567a6b2a6058' },
+                },
+            }),
+            trigger(HostEvent.OpenFilter, {
+                column: { columnId: '<column-GUID>' },
+                applicability: { level: 'TAB', targetId: '<tab-GUID>' },
+            }),
+            trigger(HostEvent.Navigate, -1),
+            trigger(HostEvent.Navigate, 'home'),
+            trigger(HostEvent.Navigate, { path: 'home', replace: true }),
+            trigger(HostEvent.Search, {
+                searchQuery: '[sales] by [item type]',
+                dataSources: ['cd252e5c-b552-49a8-821d-3eadaa049cca'],
+                execute: true,
+            }),
+            trigger(HostEvent.SetActiveTab, { tabId: '730496d6-6903-4601-937e-2c691821af3c' }),
+            trigger(HostEvent.UpdateCrossFilter, {
+                vizId: 'b535c760-8bbe-4e6f-bb26-af56b4129a1e',
+                conditions: [
+                    { columnName: 'Category', values: ['mfgr#12', 'mfgr#14'] },
+                    { columnName: 'color', values: ['mint', 'hot'] },
+                ],
+            }),
+            trigger(HostEvent.SpotterSearch, { query: 'revenue per year', executeSearch: true }),
+        ];
+        expect(ok.every(Boolean)).toBe(true);
+    });
+    // Per-context request interfaces are documentation-only today: exported and
+    // linked from docs, but trigger() still accepts the cross-context superset.
+    test('per-context request interfaces are exported and shaped as documented', () => {
+        expectType({ column: { columnId: 'c' } });
+        expectType({ column: { columnId: 'c', dataType: 'INT64' } });
+        // The default request stays the cross-context superset.
+        expectType({});
+    });
+    test('the /contracts barrel re-exports the public runtime surface', () => {
+        // Importing the barrel executes its re-exports; assert the runtime
+        // values consumers rely on from the /contracts entry point.
+        expect(contractsBarrel.UIPassthroughEvent).toBeDefined();
+        expect(contractsBarrel.CustomActionsPosition).toBeDefined();
+        expect(contractsBarrel.CustomActionTarget).toBeDefined();
+        expect(contractsBarrel.ApplicabilityLevel).toBeDefined();
+    });
+    test('trigger data (TriggerData) autocompletes and flags unknown fields', () => {
+        // Known fields resolve (drives autocomplete + hover).
+        const valid = {
+            filters: [{ columnName: 'Region', values: ['East'] }],
+        };
+        // Omitting fields still compiles (all fields optional).
+        const empty = {};
+        // Extra fields via a variable still compile (no excess check).
+        const viaVariable = {
+            filters: [{ columnName: 'Region', values: ['East'] }],
+            someExtra: 1,
+        };
+        const loose = viaVariable;
+        // Unknown fields on an object literal are flagged — at the top level...
+        const topExtra = {
+            filters: [],
+            // @ts-expect-error — `topLevelExtra` is not on the contract
+            topLevelExtra: 1,
+        };
+        // ...and at any depth.
+        const nestedExtra = {
+            // @ts-expect-error — `legacyField` is not on the filter contract
+            filters: [{ columnName: 'Region', values: ['East'], legacyField: true }],
+        };
+        // A non-literal sharing no field is flagged (TS weak-type check).
+        const unrelated = { totallyDifferent: true };
+        // @ts-expect-error — no overlap with the UpdateFilters contract
+        const zeroOverlap = unrelated;
+        // A wrong TYPE on a known field is flagged.
+        const bad = {
+            // @ts-expect-error — values must be an array, not a number
+            filters: [{ values: 123 }],
+        };
+        // `{}` is accepted for void events (AIHighlights requires it).
+        const voidEmpty = {};
+        // Unmapped events keep a fully permissive payload.
+        const unmapped = { anything: 'goes' };
+        const all = [valid, empty, loose, topExtra, nestedExtra, zeroOverlap, bad];
+        expect([...all, voidEmpty, unmapped].every(Boolean)).toBe(true);
+    });
+});
+//# sourceMappingURL=contracts.spec.js.map

package/lib/src/contracts/contracts.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.spec.js","sourceRoot":"","sources":["../../../src/contracts/contracts.spec.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAiBhE,OAAO,KAAK,eAAe,MAAM,SAAS,CAAC;AAE3C,gEAAgE;AAChE,0EAA0E;AAC1E,MAAM,iBAAiB,GAAgB;IACnC,yBAAyB;IACzB,SAAS,CAAC,oBAAoB;IAC9B,SAAS,CAAC,gBAAgB;IAC1B,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,iBAAiB;IAC3B,SAAS,CAAC,UAAU;IACpB,SAAS,CAAC,aAAa;IACvB,gBAAgB;IAChB,SAAS,CAAC,cAAc;IACxB,SAAS,CAAC,cAAc;IACxB,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,YAAY;IACtB,aAAa;IACb,SAAS,CAAC,QAAQ;IAClB,qBAAqB;IACrB,SAAS,CAAC,MAAM;IAChB,SAAS,CAAC,WAAW;IACrB,SAAS,CAAC,UAAU;IACpB,SAAS,CAAC,YAAY;IACtB,qBAAqB;IACrB,SAAS,CAAC,IAAI;IACd,SAAS,CAAC,IAAI;IACd,SAAS,CAAC,MAAM;IAChB,SAAS,CAAC,KAAK;IACf,SAAS,CAAC,OAAO;IACjB,SAAS,CAAC,QAAQ;IAClB,SAAS,CAAC,SAAS;IACnB,SAAS,CAAC,OAAO;IACjB,SAAS,CAAC,SAAS;IACnB,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,QAAQ;IAClB,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,kBAAkB;IAC5B,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,YAAY;IACtB,SAAS,CAAC,eAAe;IACzB,SAAS,CAAC,eAAe;IACzB,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,cAAc;IACxB,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,OAAO;IACjB,SAAS,CAAC,OAAO;IACjB,SAAS,CAAC,UAAU;IACpB,SAAS,CAAC,mBAAmB;IAC7B,YAAY;IACZ,SAAS,CAAC,sBAAsB;IAChC,SAAS,CAAC,sBAAsB;IAChC,SAAS,CAAC,8BAA8B;IACxC,SAAS,CAAC,YAAY;IACtB,SAAS,CAAC,qBAAqB;IAC/B,SAAS,CAAC,4BAA4B;IACtC,UAAU;IACV,SAAS,CAAC,aAAa;IACvB,SAAS,CAAC,wBAAwB;IAClC,SAAS,CAAC,wBAAwB;IAClC,SAAS,CAAC,6BAA6B;IACvC,SAAS,CAAC,6BAA6B;IACvC,SAAS,CAAC,sBAAsB;IAChC,SAAS,CAAC,wBAAwB;IAClC,SAAS,CAAC,cAAc;IACxB,SAAS,CAAC,gBAAgB;IAC1B,SAAS,CAAC,kBAAkB;IAC5B,SAAS,CAAC,yBAAyB;IACnC,SAAS,CAAC,0BAA0B;IACpC,SAAS,CAAC,mBAAmB;IAC7B,SAAS,CAAC,oBAAoB;CACjC,CAAC;AAEF,wEAAwE;AACxE,gDAAgD;AAChD,MAAM,UAAU,GAAG,CAAI,KAAQ,EAAK,EAAE,CAAC,KAAK,CAAC;AAE7C,QAAQ,CAAC,oCAAoC,EAAE,GAAG,EAAE;IAChD,sEAAsE;IACtE,2EAA2E;IAC3E,2EAA2E;IAC3E,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC;YAChE,cAAc;YACd,SAAS;YACT,YAAY;YACZ,+BAA+B;YAC/B,sBAAsB;YACtB,kBAAkB;YAClB,gBAAgB;YAChB,+BAA+B;YAC/B,4BAA4B;YAC5B,UAAU;YACV,qBAAqB;YACrB,wBAAwB;YACxB,oBAAoB;YACpB,gCAAgC;YAChC,0BAA0B;YAC1B,wBAAwB;YACxB,cAAc;YACd,uBAAuB;YACvB,wBAAwB;YACxB,wBAAwB;YACxB,0BAA0B;YAC1B,eAAe;YACf,2BAA2B;YAC3B,0BAA0B;YAC1B,mBAAmB;YACnB,kBAAkB;YAClB,wBAAwB;YACxB,sBAAsB;YACtB,YAAY;YACZ,qBAAqB;YACrB,eAAe;YACf,eAAe;YACf,eAAe;YACf,eAAe;YACf,gBAAgB;YAChB,MAAM;YACN,SAAS;YACT,eAAe;YACf,SAAS;YACT,WAAW;YACX,iBAAiB;YACjB,eAAe;YACf,gBAAgB;YAChB,YAAY;YACZ,eAAe;YACf,SAAS;YACT,8BAA8B;YAC9B,cAAc;YACd,aAAa;YACb,MAAM;YACN,eAAe;YACf,QAAQ;YACR,uBAAuB;YACvB,OAAO;YACP,oBAAoB;YACpB,eAAe;YACf,cAAc;YACd,oBAAoB;YACpB,gBAAgB;YAChB,eAAe;YACf,WAAW;SACd,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC;YACrD,kBAAkB;YAClB,WAAW;YACX,qBAAqB;YACrB,kBAAkB;YAClB,4BAA4B;YAC5B,0BAA0B;YAC1B,oCAAoC;YACpC,YAAY;YACZ,WAAW;YACX,cAAc;YACd,eAAe;YACf,uBAAuB;YACvB,QAAQ;YACR,SAAS;YACT,qBAAqB;YACrB,YAAY;YACZ,eAAe;SAClB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAS,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QACrE,iBAAiB,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAChC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,6CAA6C;QAC7C,UAAU,CACL,SAAyE,CAC7E,CAAC;QACF,UAAU,CACL,SAAiE,CACrE,CAAC;QACF,UAAU,CACL,SAA6D,CACjE,CAAC;QACF,mDAAmD;QACnD,MAAM,OAAO,GAA8C,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;QAChF,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9B,6DAA6D;QAC7D,UAAU,CACL,SAA6D,CACjE,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sEAAsE,EAAE,GAAG,EAAE;QAC9E,MAAM,CACF;YACI,UAAU,CAAC,QAAQ;YACnB,UAAU,CAAC,kBAAkB;YAC7B,UAAU,CAAC,YAAY;SAC1B,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAC9B,CAAC,OAAO,CAAC;YACN,oBAAoB;YACpB,UAAU;YACV,cAAc;SACjB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iFAAiF,EAAE,GAAG,EAAE;QACzF,6CAA6C;QAC7C,UAAU,CACL,SAAgE,CACpE,CAAC;QACF,iEAAiE;QACjE,UAAU,CACL,SAAiF,CACrF,CAAC;QAGF,MAAM,GAAG,GAAuB,SAAS,CAAC;QAC1C,MAAM,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;QAC5B,yDAAyD;QACzD,MAAM,OAAO,GAAoC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;QACtE,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,gFAAgF,EAAE,GAAG,EAAE;QACxF,oEAAoE;QACpE,uEAAuE;QACvE,MAAM,OAAO,GAAG,CAAsB,MAAS,EAAE,KAAqB,EAAE,EAAE,CAAC,IAAI,CAAC;QAChF,MAAM,EAAE,GAAG;YACP,OAAO,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,KAAK,EAAE,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;YACzG,OAAO,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;oBACjC,IAAI,EAAE,qBAAqB;oBAC3B,KAAK,EAAE,EAAE;oBACT,aAAa,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,sCAAsC,EAAE;iBACpF,CAAC,CAAC;YACH,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE;gBACpC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,UAAU,CAAC,EAAE;gBAC3E,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE;aACtF,CAAC;YACF,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC;YAC7G,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE;gBAC7B,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE;aACvF,CAAC;YACF,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE;gBAC1B,MAAM,EAAE,EAAE,QAAQ,EAAE,eAAe,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE;aACnG,CAAC;YACF,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,eAAe,EAAE,EAAE,CAAC;YACxE,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,kBAAkB,EAAE,EAAE,CAAC;YACpF,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE;gBAC7B,SAAS,EAAE,EAAE,WAAW,EAAE,kBAAkB,EAAE;gBAC9C,aAAa,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE;aAC9D,CAAC;YACF,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE;gBAC7B,MAAM,EAAE;oBACJ,MAAM,EAAE,WAAW;oBACnB,IAAI,EAAE,IAAI;oBACV,MAAM,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;oBAC1B,aAAa,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,sCAAsC,EAAE;iBACpF;aACJ,CAAC;YACF,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE;gBAC1B,MAAM,EAAE,EAAE,QAAQ,EAAE,eAAe,EAAE;gBACrC,aAAa,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE;aAC1D,CAAC;YACF,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC/B,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;YACnC,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAC5D,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;gBACtB,WAAW,EAAE,wBAAwB;gBACrC,WAAW,EAAE,CAAC,sCAAsC,CAAC;gBACrD,OAAO,EAAE,IAAI;aAChB,CAAC;YACF,OAAO,CAAC,SAAS,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,sCAAsC,EAAE,CAAC;YAClF,OAAO,CAAC,SAAS,CAAC,iBAAiB,EAAE;gBACjC,KAAK,EAAE,sCAAsC;gBAC7C,UAAU,EAAE;oBACR,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE;oBAC1D,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;iBACnD;aACJ,CAAC;YACF,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;SACvF,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,4EAA4E;IAC5E,4EAA4E;IAC5E,IAAI,CAAC,sEAAsE,EAAE,GAAG,EAAE;QAC9E,UAAU,CAA2B,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QACpE,UAAU,CACN,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,CACnD,CAAC;QACF,wDAAwD;QACxD,UAAU,CAAoB,EAA4C,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,mEAAmE;QACnE,4DAA4D;QAC5D,MAAM,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,WAAW,EAAE,CAAC;QACzD,MAAM,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5D,MAAM,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,WAAW,EAAE,CAAC;QACzD,MAAM,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,WAAW,EAAE,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAK3E,sDAAsD;QACtD,MAAM,KAAK,GAAyB;YAChC,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;SACxD,CAAC;QACF,wDAAwD;QACxD,MAAM,KAAK,GAAyB,EAAE,CAAC;QACvC,+DAA+D;QAC/D,MAAM,WAAW,GAAG;YAChB,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YACrD,SAAS,EAAE,CAAC;SACf,CAAC;QACF,MAAM,KAAK,GAAyB,WAAW,CAAC;QAChD,wEAAwE;QACxE,MAAM,QAAQ,GAAyB;YACnC,OAAO,EAAE,EAAE;YACX,4DAA4D;YAC5D,aAAa,EAAE,CAAC;SACnB,CAAC;QACF,uBAAuB;QACvB,MAAM,WAAW,GAAyB;YACtC,iEAAiE;YACjE,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;SAC3E,CAAC;QACF,kEAAkE;QAClE,MAAM,SAAS,GAAG,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC;QAC7C,gEAAgE;QAChE,MAAM,WAAW,GAAyB,SAAS,CAAC;QACpD,4CAA4C;QAC5C,MAAM,GAAG,GAAyB;YAC9B,2DAA2D;YAC3D,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;SAC7B,CAAC;QACF,+DAA+D;QAC/D,MAAM,SAAS,GAAuC,EAAE,CAAC;QACzD,mDAAmD;QACnD,MAAM,QAAQ,GAAkC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;QAErE,MAAM,GAAG,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;QAC3E,MAAM,CAAC,CAAC,GAAG,GAAG,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/src/contracts/embed-event-payloads.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Copyright (c) 2026
+ *
+ * Typed payload contracts for {@link EmbedEvent}s (ThoughtSpot app -> SDK).
+ *
+ * The SDK delivers embed events to `embed.on()` callbacks wrapped in the
+ * {@link MessagePayload} envelope `{ type, data, status? }`. The map below
+ * types the `data` field per event. Events absent from the map resolve to
+ * `any` until their payload is audited against what the host actually sends
+ * (codify observed behavior, not documented behavior).
+ *
+ * Same additive-only evolution rules as host-event-contracts.ts.
+ * @module contracts
+ */
+import type { CustomActionPayload, EmbedEvent, MessagePayload } from '../types';
+import type { AnswerService } from '../utils/graphql/answerService/answerService';
+/**
+ * Typed `data` field per embed event. Seed with audited events only.
+ */
+export interface EmbedEventDataExtension {
+    [EmbedEvent.AuthInit]: {
+        /**
+         * Whether authentication was successful.
+         */
+        isLoggedIn?: boolean;
+        [key: string]: any;
+    };
+    [EmbedEvent.EmbedListenerReady]: Record<string, any>;
+    /**
+     * Fired when a callback-type custom action is triggered. Use
+     * `payload.data.id` to identify which action fired.
+     */
+    [EmbedEvent.CustomAction]: CustomActionPayload;
+}
+/**
+ * Resolves the typed `data` payload for an embed event; `any` when the
+ * event has not been audited/typed yet.
+ */
+export type EmbedEventData<EmbedEventT extends EmbedEvent> = EmbedEventT extends keyof EmbedEventDataExtension ? EmbedEventDataExtension[EmbedEventT] : any;
+/**
+ * Full envelope delivered to `embed.on()` callbacks for a given event:
+ * the wire fields (`type`, `status`) plus the typed `data`.
+ */
+export type EmbedEventPayload<EmbedEventT extends EmbedEvent> = Omit<MessagePayload, 'data'> & {
+    data: EmbedEventData<EmbedEventT>;
+};
+/**
+ * Payload delivered to `on(EmbedEvent.CustomAction)`. Beyond the wire fields,
+ * the SDK attaches an {@link AnswerService} built from the event's session and
+ * answer data (see utils/processData.ts `processCustomAction`) — annotate your
+ * callback with this type to access it:
+ *
+ * ```ts
+ * embed.on(EmbedEvent.CustomAction, (payload: CustomActionEventPayload) => {
+ *   if (payload.data.id === 'my-action') {
+ *     payload.answerService?.getUnderlyingDataForPoint([]);
+ *   }
+ * });
+ * ```
+ *
+ * It is a dedicated type rather than folded into `on()`'s generic callback
+ * because the SDK's event registry types callbacks as the plain
+ * {@link MessagePayload}, which the enrichment cannot be intersected into
+ * without restructuring that registry.
+ */
+export type CustomActionEventPayload = EmbedEventPayload<EmbedEvent.CustomAction> & {
+    answerService?: AnswerService;
+};
+/**
+ * String-name keyed view for the host side (addresses events by wire value).
+ */
+export type EmbedEventName = `${EmbedEvent}`;
+//# sourceMappingURL=embed-event-payloads.d.ts.map

package/lib/src/contracts/embed-event-payloads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"embed-event-payloads.d.ts","sourceRoot":"","sources":["../../../src/contracts/embed-event-payloads.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,OAAO,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAIhF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAElF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACtB,CAAC;IACF,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACrD;;;OAGG;IACH,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,mBAAmB,CAAC;CAClD;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,WAAW,SAAS,UAAU,IACrD,WAAW,SAAS,MAAM,uBAAuB,GAC3C,uBAAuB,CAAC,WAAW,CAAC,GACpC,GAAG,CAAC;AAEd;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,WAAW,SAAS,UAAU,IACxD,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,GAAG;IAC3B,IAAI,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;CACrC,CAAC;AAEN;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,wBAAwB,GAChC,iBAAiB,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG;IAAE,aAAa,CAAC,EAAE,aAAa,CAAA;CAAE,CAAC;AAEnF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,UAAU,EAAE,CAAC"}

package/lib/src/contracts/embed-event-payloads.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=embed-event-payloads.js.map

package/lib/src/contracts/embed-event-payloads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"embed-event-payloads.js","sourceRoot":"","sources":["../../../src/contracts/embed-event-payloads.ts"],"names":[],"mappings":""}