fix!: exclude websocket features from main entry file (#125)

* fix: exclude websocket features from main entry file

* fix: make 'defineGraphqlWebSocket' backward compatible with 1.x.x API
since it does not require await import anymore

* docs: update readme

* fix linter

---------

Co-authored-by: Alexei Myshkouski <[email protected]>
Co-authored-by: Tobias Diez <[email protected]>

Author: 3 people

README.md

@@ -90,10 +90,8 @@ Then you can add a WebSocket handler to your `h3` app using the `defineGraphqlWe
 ```js
 import { createApp } from 'h3'
 import { ApolloServer } from '@apollo/server'
-import {
-  startServerAndCreateH3Handler,
-  defineGraphqlWebSocketHandler,
-} from '@as-integrations/h3'
+import { startServerAndCreateH3Handler } from '@as-integrations/h3'
+import { defineGraphqlWebSocketHandler } from '@as-integrations/h3/websocket'
 import { makeExecutableSchema } from '@graphql-tools/schema'
 
 // Define your schema and resolvers

examples/websocket.ts

@@ -64,7 +64,7 @@ app.use(
   '/ws',
   startServerAndCreateH3Handler(apollo, {
     websocket: {
-      ...(await defineGraphqlWebSocket({ schema })),
+      ...defineGraphqlWebSocket({ schema }),
       error(peer, error) {
         console.error('[ws] error', peer, error)
         // In a real app, you would want to properly log this error
@@ -90,7 +90,7 @@ app.use(
 app.use(
   '/_ws',
   defineWebSocketHandler({
-    ...(await defineGraphqlWebSocket({ schema })),
+    ...defineGraphqlWebSocket({ schema }),
     error(peer, error) {
       console.log('[ws] error', peer, error)
     },

package.json

@@ -11,6 +11,11 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
+    },
+    "./websocket": {
+      "types": "./dist/websocket.d.ts",
+      "import": "./dist/websocket.mjs",
+      "require": "./dist/websocket.cjs"
     }
   },
   "main": "./dist/index.cjs",

src/index.ts

@@ -18,10 +18,6 @@ import {
   RequestHeaders,
 } from 'h3'
 import type { WithRequired } from '@apollo/utils.withrequired'
-export {
-  defineGraphqlWebSocket,
-  defineGraphqlWebSocketHandler,
-} from './websocket'
 
 export interface H3ContextFunctionArgument {
   event: H3Event

src/websocket.ts

@@ -1,4 +1,10 @@
-import type { ServerOptions, ConnectionInitMessage } from 'graphql-ws'
+import {
+  makeServer,
+  DEPRECATED_GRAPHQL_WS_PROTOCOL,
+  CloseCode,
+  ServerOptions,
+  ConnectionInitMessage,
+} from 'graphql-ws'
 import {
   defineWebSocket,
   defineWebSocketHandler,
@@ -38,13 +44,10 @@ interface Client {
  * Use this over {@link defineGraphqlWebSocketHandler} if you need more control over the WebSocket server or
  * if you want to add custom hooks (e.g. for authentication or logging).
  */
-export async function defineGraphqlWebSocket<
+export function defineGraphqlWebSocket<
   P extends ConnectionInitMessage['payload'] = ConnectionInitMessage['payload'],
   E extends Record<PropertyKey, unknown> = Record<PropertyKey, never>,
->(options: ServerOptions<P, Extra & Partial<E>>): Promise<Partial<Hooks>> {
-  // Local import since graphql-ws is only an optional peer dependency
-  const { makeServer, DEPRECATED_GRAPHQL_WS_PROTOCOL, CloseCode } =
-    await import('graphql-ws')
+>(options: ServerOptions<P, Extra & Partial<E>>): Partial<Hooks> {
   const server = makeServer(options)
   const peers = new WeakMap<Peer, Client>()
   return defineWebSocket({
@@ -112,5 +115,5 @@ export async function defineGraphqlWebSocketHandler<
 >(
   options: ServerOptions<P, Extra & Partial<E>>,
 ): Promise<EventHandler<EventHandlerRequest, never>> {
-  return defineWebSocketHandler(await defineGraphqlWebSocket(options))
+  return defineWebSocketHandler(defineGraphqlWebSocket(options))
 }