fix!: new laravel-echo typing system

manchenkoff · manchenkoff · commit 113e962c75c2 · 2024-11-19T01:18:22.000+01:00
diff --git a/src/runtime/composables/useEcho.ts b/src/runtime/composables/useEcho.ts
@@ -1,8 +1,9 @@
 import type Echo from 'laravel-echo'
+import type { SupportedBroadcaster } from '../types'
 import { useNuxtApp } from '#app'
 
-export const useEcho = (): Echo => {
+export const useEcho = (): Echo<SupportedBroadcaster> => {
   const { $echo } = useNuxtApp()
 
-  return $echo as Echo
+  return $echo as Echo<SupportedBroadcaster>
 }
diff --git a/src/runtime/plugin.client.ts b/src/runtime/plugin.client.ts
@@ -4,15 +4,15 @@ import type { ChannelAuthorizationData } from 'pusher-js/types/src/core/auth/opt
 import { type ConsolaInstance, createConsola } from 'consola'
 import type { FetchOptions } from 'ofetch'
 import { useEchoConfig } from './composables/useEchoConfig'
-import type { Authentication, ModuleOptions } from './types'
+import type { Authentication, ModuleOptions, SupportedBroadcaster } from './types'
 import { createError, defineNuxtPlugin, useCookie } from '#app'
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const Pusher = (PusherPkg as any).default || PusherPkg
 
 declare global {
   interface Window {
-    Echo: Echo
+    Echo: Echo<SupportedBroadcaster>
     Pusher: typeof Pusher
   }
 }
diff --git a/src/runtime/types.ts b/src/runtime/types.ts
@@ -1,3 +1,5 @@
+export type SupportedBroadcaster = 'reverb' | 'pusher'
+
 export interface Authentication {
   /**
    * The base URL of Laravel application.
@@ -36,7 +38,7 @@ export interface ModuleOptions {
    * The Laravel broadcaster type to use.
    * @default 'reverb'
    */
-  broadcaster: 'reverb' | 'pusher'
+  broadcaster: SupportedBroadcaster
   /**
    * The host to connect to WebSocket.
    * @default 'localhost'
