SCAL-313306: refactor declarative embedParams building in V1Embed

[yinstardev]

Replace imperative embedParams construction with declarative pattern to eliminate mutation chains and improve maintainability. Each embed type now declares contributions separately, merged once in base class.

Changes:

• Create new embedParams-builder.ts with EmbedParamsContribution interface
• Add getEmbedParamsContributions() method to TsEmbed (returns empty by default)
• Update getDefaultAppInitData() to collect and merge contributions declaratively
• Refactor AppEmbed: replaces getAppInitData() with getEmbedParamsContributions()
• Refactor LiveboardEmbed: replaces getAppInitData() with getEmbedParamsContributions()
• Refactor SearchEmbed: adds getEmbedParamsContributions(), preserves searchOptions in getAppInitData()
• Refactor SpotterEmbed: replaces getAppInitData() with getEmbedParamsContributions()
• Add contribution builders to spotter-utils and spotter-viz-utils
• Keep old builder functions for backward compatibility

Benefits:

• Eliminates spread operator chains causing hidden mutations
• Type-safe embedParams with explicit interface
• Easier to test contributions in isolation
• Cleaner code with single responsibility
• Maintains 100% backward compatibility

Tests: all 1103 tests pass

[gemini-code-assist]

Code Review

This pull request introduces a centralized, declarative embedParams builder system (embedParams-builder.ts) to aggregate configuration contributions across various embed classes (AppEmbed, SpotterEmbed, LiveboardEmbed, and SearchEmbed), replacing the previous imperative getAppInitData overrides. The review feedback recommends updating buildEmbedParams to return undefined instead of an empty object when no contributions exist, which avoids bloating the payload. Following this change, the subclass implementations of getEmbedParamsContributions can be simplified to be fully declarative, eliminating redundant boilerplate checks.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

[gemini-code-assist]

If all contributions are empty, buildEmbedParams currently returns an empty object {}. Since {} is truthy, this results in an empty embedParams object being added to the payload (e.g., embedParams: {}), which unnecessarily bloats the payload. Returning undefined when the merged object is empty prevents this.

Suggested change

	export function buildEmbedParams(
	contributions: Partial<EmbedParamsContribution>[]
	): Partial<EmbedParamsContribution> | undefined {
	if (contributions.length === 0) return undefined;
	return contributions.reduce((acc, contrib) => {
	if (!contrib || Object.keys(contrib).length === 0) return acc;
	return { ...acc, ...contrib };
	}, {} as Partial<EmbedParamsContribution>);
	}
	export function buildEmbedParams(
	contributions: Partial<EmbedParamsContribution>[]
	): Partial<EmbedParamsContribution> | undefined {
	const merged = contributions.reduce((acc, contrib) => {
	if (!contrib || Object.keys(contrib).length === 0) return acc;
	return { ...acc, ...contrib };
	}, {} as Partial<EmbedParamsContribution>);
	return Object.keys(merged).length > 0 ? merged : undefined;
	}

References

1. Prefer omitting empty or unset parameters entirely from the payload/URL to avoid bloating. Returning undefined when the merged embedParams object is empty ensures it is omitted. ^(link)
2. When a utility function processes optional configuration and its output is forwarded without immediate narrowing, it is acceptable to keep the return type optional to match the input's optionality, especially if a tighter type wouldn't benefit downstream consumers.

[gemini-code-assist]

With buildEmbedParams updated to safely filter out empty contributions and return undefined when empty, we can simplify this method to be completely declarative and eliminate the imperative boilerplate of checking Object.keys().length and pushing to an array.

    protected async getEmbedParamsContributions(): Promise<Partial<EmbedParamsContribution>[]> {
        return [
            buildSpotterSidebarEmbedParamsContribution(
                this.viewConfig,
                this.handleError.bind(this),
            ),
            buildSpotterVizEmbedParamsContribution(this.viewConfig),
        ];
    }

[gemini-code-assist]

With buildEmbedParams updated to safely filter out empty contributions and return undefined when empty, we can simplify this method to be completely declarative and eliminate the imperative boilerplate of checking Object.keys().length and pushing to an array.

    protected async getEmbedParamsContributions(): Promise<Partial<EmbedParamsContribution>[]> {
        return [
            buildSpotterSidebarEmbedParamsContribution(
                this.viewConfig,
                this.handleError.bind(this),
            ),
        ];
    }

[gemini-code-assist]

With buildEmbedParams updated to safely filter out empty contributions and return undefined when empty, we can simplify this method to be completely declarative and eliminate the imperative boilerplate of checking Object.keys().length and pushing to an array.

    protected async getEmbedParamsContributions(): Promise<Partial<EmbedParamsContribution>[]> {
        return [buildSpotterVizEmbedParamsContribution(this.viewConfig)];
    }

[gemini-code-assist]

With buildEmbedParams updated to safely filter out empty contributions and return undefined when empty, we can simplify this method to be completely declarative and eliminate the imperative boilerplate of checking Object.keys().length and pushing to an array.

    protected async getEmbedParamsContributions(): Promise<Partial<EmbedParamsContribution>[]> {
        return [
            this.viewConfig.visualOverrides
                ? { visualOverridesParams: this.viewConfig.visualOverrides }
                : {},
        ];
    }

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@thoughtspot/visual-embed-sdk@547

commit: 8e0ac2b