fix(api): resolve TypeScript errors in webviewWindow.ts

packages/api/src/webviewWindow.ts

@@ -15,15 +15,21 @@ import type { EventName, EventCallback, UnlistenFn } from './event'
 import { invoke } from './core'
 import type { Color, DragDropEvent } from './webview'
 
+// Internal-only type to avoid @ts-expect-error everywhere
+interface InternalWebviewOptions
+  extends Omit<WebviewOptions, 'x' | 'y' | 'width' | 'height'> {
+  skip?: boolean
+  parent?: Window | WebviewWindow | string
+}
+
 /**
  * Get an instance of `Webview` for the current webview window.
  *
  * @since 2.0.0
  */
 function getCurrentWebviewWindow(): WebviewWindow {
   const webview = getCurrentWebview()
-  // @ts-expect-error `skip` is not defined in the public API but it is handled by the constructor
-  return new WebviewWindow(webview.label, { skip: true })
+  return new WebviewWindow(webview.label, { skip: true } as any)
 }
 
 /**
@@ -36,9 +42,8 @@ async function getAllWebviewWindows(): Promise<WebviewWindow[]> {
     windows.map(
       (w) =>
         new WebviewWindow(w, {
-          // @ts-expect-error `skip` is not defined in the public API but it is handled by the constructor
           skip: true
-        })
+        } as any)
     )
   )
 }
@@ -53,43 +58,24 @@ class WebviewWindow {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   listeners: Record<string, Array<EventCallback<any>>>
 
-  /**
-   * Creates a new {@link Window} hosting a {@link Webview}.
-   * @example
-   * ```typescript
-   * import { WebviewWindow } from '@tauri-apps/api/webviewWindow'
-   * const webview = new WebviewWindow('my-label', {
-   *   url: 'https://github.com/tauri-apps/tauri'
-   * });
-   * webview.once('tauri://created', function () {
-   *  // webview successfully created
-   * });
-   * webview.once('tauri://error', function (e) {
-   *  // an error happened creating the webview
-   * });
-   * ```
-   *
-   * @param label The unique webview label. Must be alphanumeric: `a-zA-Z-/:_`.
-   * @returns The {@link WebviewWindow} instance to communicate with the window and webview.
-   */
   constructor(
     label: WebviewLabel,
     options: Omit<WebviewOptions, 'x' | 'y' | 'width' | 'height'>
-      & WindowOptions = {}
+      & WindowOptions & { skip?: boolean } = {}
   ) {
     this.label = label
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     this.listeners = Object.create(null)
 
-    // @ts-expect-error `skip` is not a public API so it is not defined in WebviewOptions
-    if (!options?.skip) {
+    const internalOptions = options as InternalWebviewOptions
+
+    if (!internalOptions?.skip) {
       invoke('plugin:webview|create_webview_window', {
         options: {
-          ...options,
+          ...internalOptions,
           parent:
-            typeof options.parent === 'string'
-              ? options.parent
-              : options.parent?.label,
+            typeof internalOptions.parent === 'string'
+              ? internalOptions.parent
+              : internalOptions.parent?.label,
           label
         }
       })
@@ -98,104 +84,48 @@ class WebviewWindow {
     }
   }
 
-  /**
-   * Gets the Webview for the webview associated with the given label.
-   * @example
-   * ```typescript
-   * import { Webview } from '@tauri-apps/api/webviewWindow';
-   * const mainWebview = Webview.getByLabel('main');
-   * ```
-   *
-   * @param label The webview label.
-   * @returns The Webview instance to communicate with the webview or null if the webview doesn't exist.
-   */
   static async getByLabel(label: string): Promise<WebviewWindow | null> {
     const webview =
       (await getAllWebviewWindows()).find((w) => w.label === label) ?? null
     if (webview) {
-      // @ts-expect-error `skip` is not defined in the public API but it is handled by the constructor
-      return new WebviewWindow(webview.label, { skip: true })
+      return new WebviewWindow(webview.label, { skip: true } as any)
     }
     return null
   }
 
-  /**
-   * Get an instance of `Webview` for the current webview.
-   */
   static getCurrent(): WebviewWindow {
     return getCurrentWebviewWindow()
   }
 
-  /**
-   * Gets a list of instances of `Webview` for all available webviews.
-   */
   static async getAll(): Promise<WebviewWindow[]> {
     return getAllWebviewWindows()
   }
 
-  /**
-   * Listen to an emitted event on this webivew window.
-   *
-   * @example
-   * ```typescript
-   * import { WebviewWindow } from '@tauri-apps/api/webviewWindow';
-   * const unlisten = await WebviewWindow.getCurrent().listen<string>('state-changed', (event) => {
-   *   console.log(`Got error: ${payload}`);
-   * });
-   *
-   * // you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
-   * unlisten();
-   * ```
-   *
-   * @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
-   * @param handler Event handler.
-   * @returns A promise resolving to a function to unlisten to the event.
-   * Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
-   */
   async listen<T>(
     event: EventName,
     handler: EventCallback<T>
   ): Promise<UnlistenFn> {
     if (this._handleTauriEvent(event, handler)) {
       return () => {
-        // eslint-disable-next-line security/detect-object-injection
         const listeners = this.listeners[event]
-        listeners.splice(listeners.indexOf(handler), 1)
+        const idx = listeners.indexOf(handler)
+        if (idx >= 0) listeners.splice(idx, 1)
       }
     }
     return listen(event, handler, {
       target: { kind: 'WebviewWindow', label: this.label }
     })
   }
 
-  /**
-   * Listen to an emitted event on this webview window only once.
-   *
-   * @example
-   * ```typescript
-   * import { WebviewWindow } from '@tauri-apps/api/webviewWindow';
-   * const unlisten = await WebviewWindow.getCurrent().once<null>('initialized', (event) => {
-   *   console.log(`Webview initialized!`);
-   * });
-   *
-   * // you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
-   * unlisten();
-   * ```
-   *
-   * @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
-   * @param handler Event handler.
-   * @returns A promise resolving to a function to unlisten to the event.
-   * Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
-   */
   async once<T>(
     event: EventName,
     handler: EventCallback<T>
   ): Promise<UnlistenFn> {
     if (this._handleTauriEvent(event, handler)) {
       return () => {
-        // eslint-disable-next-line security/detect-object-injection
         const listeners = this.listeners[event]
-        listeners.splice(listeners.indexOf(handler), 1)
+        const idx = listeners.indexOf(handler)
+        if (idx >= 0) listeners.splice(idx, 1)
       }
     }
     return once(event, handler, {
@@ -206,27 +136,18 @@ class WebviewWindow {
   /**
    * Set the window and webview background color.
    *
-   * #### Platform-specific:
-   *
-   * - **Android / iOS:** Unsupported for the window layer.
-   * - **macOS / iOS**: Not implemented for the webview layer.
-   * - **Windows**:
-   *   - alpha channel is ignored for the window layer.
-   *   - On Windows 7, alpha channel is ignored for the webview layer.
-   *   - On Windows 8 and newer, if alpha channel is not `0`, it will be ignored.
-   *
-   * @returns A promise indicating the success or failure of the operation.
-   *
    * @since 2.1.0
    */
   async setBackgroundColor(color: Color): Promise<void> {
-    return invoke('plugin:window|set_background_color', { color }).then(() => {
-      return invoke('plugin:webview|set_webview_background_color', { color })
-    })
+    try {
+      await invoke('plugin:window|set_background_color', { color })
+      await invoke('plugin:webview|set_webview_background_color', { color })
+    } catch (err) {
+      throw new Error(`Failed to set background color: ${String(err)}`)
+    }
   }
 }
 
-// Order matters, we use window APIs by default
 applyMixins(WebviewWindow, [Window, Webview])
 
 /** Extends a base class by other specified classes, without overriding existing properties */
@@ -243,12 +164,12 @@ function applyMixins(
         typeof baseClass.prototype === 'object'
         && baseClass.prototype
         && name in baseClass.prototype
-      )
+      ) {
         return
+      }
       Object.defineProperty(
         baseClass.prototype,
         name,
-        // eslint-disable-next-line
         Object.getOwnPropertyDescriptor(extendedClass.prototype, name)
           ?? Object.create(null)
       )