Host events2

[ruchI9897]

No description provided.

[mnk-blr]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scanner	Critical	High	Medium	Low	Total (0)
✅	Licenses	0	0	0	0	0 issues
✅	Open Source Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[gemini-code-assist]

Summary of Changes

Hello @ruchI9897, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the host event system by introducing an optional context parameter, enabling more flexible data passing with events. Concurrently, it significantly improves the clarity and utility of the host event documentation, particularly for Spotter embed scenarios, by providing dynamic examples for vizId retrieval and standardizing terminology.

Highlights

• Context Parameter Addition: A new optional context parameter has been introduced to host event triggering functions, allowing additional data to be passed along with events.
• Host Event Documentation Enhancements: Updated documentation for numerous host events (e.g., Pin, DownloadAsPdf, MakeACopy) to provide dynamic vizId examples using EmbedEvent.Data for Spotter embed scenarios.
• API Signature Updates: The processTrigger and hostEventFallback methods in HostEventClient, and the trigger method in TsEmbed, have been updated to accommodate the new context parameter.
• Spotter Terminology Refinement: Documentation now consistently refers to 'Visualization ID' instead of 'Answer ID' in Spotter embed contexts for clarity, and the HostEvent.Edit example has been simplified.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a context parameter to the host event triggering mechanism, allowing additional data to be passed along with events. This change is consistently applied across host-event-client.ts, ts-embed.ts, and processTrigger.ts. The PR also includes valuable documentation updates in types.ts, replacing hardcoded GUIDs in examples with a more practical approach of dynamically obtaining vizId. My review includes a suggestion to improve type safety for the new context parameter in the public trigger method and points out a minor typo in the documentation.

[gemini-code-assist]

The new context parameter is typed as any. To improve type safety and leverage the generic ContextT type already defined in HostEventClient.triggerHostEvent, you could make the trigger method generic for the context as well. This would provide better type checking for SDK users.

Suggested change

	public async trigger<HostEventT extends HostEvent, PayloadT>(
	messageType: HostEventT,
	data: TriggerPayload<PayloadT, HostEventT> = {} as any,
	context: any = {},
	): Promise<TriggerResponse<PayloadT, HostEventT>> {
	public async trigger<HostEventT extends HostEvent, PayloadT, ContextT>(
	messageType: HostEventT,
	data: TriggerPayload<PayloadT, HostEventT> = {} as any,
	context?: ContextT,
	): Promise<TriggerResponse<PayloadT, HostEventT>> {

[gemini-code-assist]

There's a small typo in the JSDoc comment. It seems an extra asterisk was added before @example.

Suggested change

	* * @example
	* @example