svelte-adapter-uws 0.2.21 → 0.2.23

package/README.md

@@ -1477,13 +1477,18 @@ export function upgrade({ cookies }) {
   return { id: user.id, name: user.name };
 }
 
-export function subscribe(ws, topic, { platform }) {
-  presence.join(ws, topic, platform);
-}
+export const { subscribe, close } = presence.hooks;
+```
 
-export function close(ws, { platform }) {
-  presence.leave(ws, platform);
+The `hooks` object handles everything: `subscribe` calls `join()` for regular topics and sends the current presence list for `__presence:*` topics, `close` calls `leave()`. If you need custom logic (auth gating, topic filtering), wrap the hook:
+
+```js
+export function subscribe(ws, topic, ctx) {
+  if (topic === 'vip' && !ws.getUserData().isVip) return false;
+  presence.hooks.subscribe(ws, topic, ctx);
 }
+
+export const close = presence.hooks.close;
 ```
 
 Use it on the client:
@@ -1527,6 +1532,7 @@ const presence = createPresence({
   select: (userData) => userData  // extract public fields (default: full userData)
 });
 
+presence.hooks                       // ready-made { subscribe, close } hooks
 presence.join(ws, topic, platform)   // add user to topic (call from subscribe hook)
 presence.leave(ws, platform)         // remove from all topics (call from close hook)
 presence.sync(ws, topic, platform)   // send list without joining (for observers)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-adapter-uws",
-  "version": "0.2.21",
+  "version": "0.2.23",
   "description": "SvelteKit adapter for uWebSockets.js - high-performance C++ HTTP server with built-in WebSocket support",
   "author": "Kevin Radziszewski",
   "license": "MIT",

package/plugins/presence/server.d.ts

@@ -115,6 +115,25 @@ export interface PresenceTracker<Selected extends Record<string, any> = Record<s
 
 	/** Clear all presence tracking state. */
 	clear(): void;
+
+	/**
+	 * Ready-made WebSocket hooks for zero-config presence.
+	 *
+	 * `subscribe` handles both regular topics (calls `join`) and `__presence:*`
+	 * topics (calls `sync` so the client gets the current list immediately).
+	 * `close` calls `leave`.
+	 *
+	 * @example
+	 * ```js
+	 * // src/hooks.ws.js
+	 * import { presence } from '$lib/server/presence';
+	 * export const { subscribe, close } = presence.hooks;
+	 * ```
+	 */
+	hooks: {
+		subscribe(ws: WebSocket<any>, topic: string, ctx: { platform: Platform }): void;
+		close(ws: WebSocket<any>, ctx: { platform: Platform }): void;
+	};
 }
 
 /**

package/plugins/presence/server.js

@@ -39,6 +39,10 @@
  *   Get the number of unique users present on a topic.
  * @property {() => void} clear -
  *   Clear all presence tracking state.
+ * @property {{ subscribe: (ws: any, topic: string, ctx: { platform: import('../../index.js').Platform }) => void, close: (ws: any, ctx: { platform: import('../../index.js').Platform }) => void }} hooks -
+ *   Ready-made WebSocket hooks. Handles join for regular topics, sync for
+ *   __presence:* topics, and leave on close. Spread into hooks.ws.js for
+ *   zero-config presence.
  */
 
 /**
@@ -60,16 +64,23 @@
  *
  * @example
  * ```js
- * // src/hooks.ws.js
+ * // src/hooks.ws.js - zero-config (just spread hooks)
  * import { presence } from '$lib/server/presence';
  *
- * export function subscribe(ws, topic, { platform }) {
- *   presence.join(ws, topic, platform);
- * }
+ * export const { subscribe, close } = presence.hooks;
+ * ```
+ *
+ * @example
+ * ```js
+ * // src/hooks.ws.js - with custom logic
+ * import { presence } from '$lib/server/presence';
  *
- * export function close(ws, { platform }) {
- *   presence.leave(ws, platform);
+ * export function subscribe(ws, topic, ctx) {
+ *   if (topic === 'vip' && !ws.getUserData().isVip) return false;
+ *   presence.hooks.subscribe(ws, topic, ctx);
  * }
+ *
+ * export const close = presence.hooks.close;
  * ```
  *
  * @example
@@ -115,7 +126,8 @@ export function createPresence(options = {}) {
 		return '__conn:' + (++connCounter);
 	}
 
-	return {
+	/** @type {PresenceTracker} */
+	const tracker = {
 		join(ws, topic, platform) {
 			// Skip internal topics to prevent recursion when the subscribe
 			// hook fires for __presence:* subscriptions
@@ -226,6 +238,24 @@ export function createPresence(options = {}) {
 			wsTopics.clear();
 			topicPresence.clear();
 			connCounter = 0;
+		},
+
+		hooks: {
+			subscribe(ws, topic, { platform }) {
+				if (topic.startsWith('__presence:')) {
+					// Observer subscribing to presence channel directly --
+					// sync() subscribes + sends the current list
+					tracker.sync(ws, topic.slice(11), platform);
+					return;
+				}
+				// Regular topic -- join presence
+				tracker.join(ws, topic, platform);
+			},
+			close(ws, { platform }) {
+				tracker.leave(ws, platform);
+			}
 		}
 	};
+
+	return tracker;
 }