fix(client): Don't show $ws when not used WebSockets (#2532)

* fix(client): Don't show `$ws` when not used ws * test(client): add types test * chore: format code * chore: remove no used arg
honojs · Apr 21, 2024 · 5c9d8b4 · 5c9d8b4
1 parent 9f9a41c
commit 5c9d8b4
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 16 deletions.
diff --git a/deno_dist/client/types.ts b/deno_dist/client/types.ts
@@ -33,14 +33,13 @@ export type ClientRequest<S extends Schema> = {
         : {}
       : {}
   ) => URL
-} & {
-  // WebSocket
-  $ws: S['$get'] extends { input: { json: UpgradedWebSocketResponseInputJSONType } }
+} & (S['$get'] extends { input: { json: UpgradedWebSocketResponseInputJSONType } }
     ? S['$get'] extends { input: infer I }
-      ? (args?: Omit<I, 'json'>) => WebSocket
-      : never
-    : never
-}
+      ? {
+          $ws: (args?: Omit<I, 'json'>) => WebSocket
+        }
+      : {}
+    : {})
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type BlankRecordToNever<T> = T extends any

diff --git a/deno_dist/helper/websocket/index.ts b/deno_dist/helper/websocket/index.ts
@@ -12,7 +12,7 @@ export interface WSEvents {
   onError?: (evt: Event, ws: WSContext) => void
 }
 
-export type UpgradedWebSocketResponseInputJSONType = '__websocket' | undefined
+export type UpgradedWebSocketResponseInputJSONType = '__websocket'
 
 /**
  * Upgrade WebSocket Type

diff --git a/src/client/types.test.ts b/src/client/types.test.ts
@@ -0,0 +1,25 @@
+import { expectTypeOf } from 'vitest'
+import { Hono } from '..'
+import { upgradeWebSocket } from '../helper'
+import { hc } from '.'
+
+describe('WebSockets', () => {
+  const app = new Hono()
+    .get(
+      '/ws',
+      upgradeWebSocket(() => ({}))
+    )
+    .get('/', (c) => c.json({}))
+  const client = hc<typeof app>('/')
+
+  it('WebSocket route', () => {
+    expectTypeOf(client.ws).toMatchTypeOf<{
+      $ws: () => WebSocket
+    }>()
+  })
+  it('Not WebSocket Route', () => {
+    expectTypeOf<
+      typeof client.index extends { $ws: () => WebSocket } ? false : true
+    >().toEqualTypeOf(true)
+  })
+})
diff --git a/src/client/types.ts b/src/client/types.ts
@@ -33,14 +33,13 @@ export type ClientRequest<S extends Schema> = {
         : {}
       : {}
   ) => URL
-} & {
-  // WebSocket
-  $ws: S['$get'] extends { input: { json: UpgradedWebSocketResponseInputJSONType } }
+} & (S['$get'] extends { input: { json: UpgradedWebSocketResponseInputJSONType } }
     ? S['$get'] extends { input: infer I }
-      ? (args?: Omit<I, 'json'>) => WebSocket
-      : never
-    : never
-}
+      ? {
+          $ws: (args?: Omit<I, 'json'>) => WebSocket
+        }
+      : {}
+    : {})
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type BlankRecordToNever<T> = T extends any

diff --git a/src/helper/websocket/index.ts b/src/helper/websocket/index.ts
@@ -12,7 +12,7 @@ export interface WSEvents {
   onError?: (evt: Event, ws: WSContext) => void
 }
 
-export type UpgradedWebSocketResponseInputJSONType = '__websocket' | undefined
+export type UpgradedWebSocketResponseInputJSONType = '__websocket'
 
 /**
  * Upgrade WebSocket Type