feat(api): support unknown types for event emit payload, closes #2929 (#2964)

Author: lucasfernog

.changes/api-emit-payload-type.md

@@ -0,0 +1,5 @@
+---
+"api": patch
+---
+
+Event `emit` now automatically serialize non-string types.

core/tauri/scripts/bundle.js

@@ -109,8 +109,8 @@ async function once<T>(
  * @param [payload] Event payload
  * @returns
  */
-async function emit(event: string, payload?: string): Promise<void> {
-  return emitEvent(event, undefined, payload)
+async function emit(event: string, payload?: unknown): Promise<void> {
+  return emitEvent(event, null, payload)
 }
 
 export type { Event, EventName, EventCallback, UnlistenFn }

tooling/api/src/event.ts

@@ -15,16 +15,16 @@ import { invokeTauriCommand } from './tauri'
  */
 async function emit(
   event: string,
-  windowLabel: WindowLabel,
-  payload?: string
+  windowLabel: WindowLabel | null,
+  payload?: unknown
 ): Promise<void> {
   await invokeTauriCommand({
     __tauriModule: 'Event',
     message: {
       cmd: 'emit',
       event,
       windowLabel,
-      payload
+      payload: typeof payload === 'string' ? payload : JSON.stringify(payload)
     }
   })
 }

tooling/api/src/helpers/event.ts

@@ -283,7 +283,7 @@ class WebviewWindowHandle {
    * @param event Event name.
    * @param payload Event payload.
    */
-  async emit(event: string, payload?: string): Promise<void> {
+  async emit(event: string, payload?: unknown): Promise<void> {
     if (localTauriEvents.includes(event)) {
       // eslint-disable-next-line
       for (const handler of this.listeners[event] || []) {