SvelteKit-integrated-WebSocket

• Purpose: Provides first-class WebSocket support for SvelteKit applications by attaching a WebSocket server to the global state, enabling real-time communication within SvelteKit projects.
• Key Features:
  • Eliminates the need for separate WebSocket server builds by integrating directly with SvelteKit's server-side code.
  • Allows WebSocket server access throughout SvelteKit's server-side logic via globalThis.
  • Supports both development (via Vite plugin) and production environments.
  • Enables WebSocket server interaction from SvelteKit endpoints and hooks.
• Target Audience: SvelteKit developers needing real-time functionality without workarounds or separate server management.
• Framework Support: Primarily designed for SvelteKit (1.21.0+), leveraging Svelte's ecosystem.
• Advantages Over Alternatives:
  • No middleware rebuilds required when WebSocket logic changes.
  • Full integration with SvelteKit's environment variables and shared server code.
  • Direct access to WebSocket server from any server-side context (endpoints, hooks).
• Implementation Highlights:
  • Uses globalThis with Symbol.for() for runtime-wide WebSocket server access.
  • Supports authentication integration via event.locals.
  • Production setup runs alongside built SvelteKit app via custom prodServer.ts.

Inspired by community discussions and trpc-sveltekit .