@plitzi/sdk-shared 0.37.2 → 0.37.4

package/dist/network/spaceEvents.mjs

@@ -2,37 +2,47 @@ import { StyleVariableCategory as e } from "../types/StyleTypes.mjs";
 import { STYLE_STATES as t } from "../style/styleStates.mjs";
 import { z as n } from "zod";
 //#region src/network/spaceEvents.ts
-var r = (e) => typeof e == "object" && !!e && !Array.isArray(e), i = n.custom((e) => r(e) && typeof e.id == "string", { message: "expected an element with an id" }), a = n.array(i), o = n.custom((e) => r(e) && Array.isArray(e.flat), { message: "expected a schema whose `flat` is a list of elements" }), s = n.custom((e) => r(e) && typeof e.id == "string", { message: "expected a page folder with an id" }), c = n.custom((e) => r(e) && typeof e.name == "string", { message: "expected a variable with a name" }), l = n.custom(r, { message: "expected a style attributes object" }), u = n.custom((e) => r(e) && typeof e.family == "string" && typeof e.source == "string", { message: "expected a font with a family and a source" }), d = n.custom((e) => typeof e == "string" || typeof e == "number" || r(e), { message: "expected a style variable value" }), f = n.enum([
+var r = (e) => typeof e == "object" && !!e && !Array.isArray(e), i = n.custom((e) => r(e) && typeof e.id == "string", { message: "expected an element with an id" }), a = n.array(i), o = (e) => ({
+	...e,
+	flat: Object.values(e.flat)
+}), s = (e) => ({
+	...e,
+	flat: Object.fromEntries(e.flat.map((e) => [e.id, e]))
+}), c = n.custom((e) => r(e) && Array.isArray(e.flat), { message: "expected a schema whose `flat` is a list of elements" }), l = n.custom((e) => r(e) && typeof e.id == "string", { message: "expected a page folder with an id" }), u = n.custom((e) => r(e) && typeof e.name == "string", { message: "expected a variable with a name" }), d = n.custom(r, { message: "expected a style attributes object" }), f = n.custom((e) => r(e) && typeof e.family == "string" && typeof e.source == "string", { message: "expected a font with a family and a source" }), p = n.custom((e) => typeof e == "string" || typeof e == "number" || r(e), { message: "expected a style variable value" }), m = n.enum([
 	"desktop",
 	"tablet",
 	"mobile"
-]), p = n.custom((e) => typeof e == "string", { message: "expected a drop position" }), m = n.custom((e) => typeof e == "string", { message: "expected a style category" }), h = n.enum([
+]), h = n.custom((e) => typeof e == "string", { message: "expected a drop position" }), g = n.custom((e) => typeof e == "string", { message: "expected a style category" }), _ = n.enum([
 	"class",
 	"element",
 	"id"
-]), g = n.enum(t), _ = n.enum(e), v = n.object({
+]), v = n.enum(t), y = n.enum(e), b = n.object({
 	componentType: n.string().optional(),
 	styleSelector: n.string().optional(),
-	styleState: g.optional(),
+	styleState: v.optional(),
 	styleVariant: n.string().optional(),
 	styleAncestor: n.string().optional()
-}), y = v.extend({ styleSelector: n.string() }), b = { contextId: n.string() }, x = n.object({ variable: c }), S = n.object({
-	displayMode: f,
+}), x = b.extend({ styleSelector: n.string() }), S = { contextId: n.string() }, C = n.object({ variable: u }), w = n.object({
+	displayMode: m,
 	selector: n.string(),
-	category: _,
+	category: y,
 	name: n.string(),
-	value: d
-}), C = n.object({
-	displayMode: f,
+	value: p
+}), T = n.object({
+	displayMode: m,
 	selector: n.string(),
-	category: _,
+	category: y,
 	name: n.string()
-}), w = n.object({
-	category: _,
+}), E = n.object({
+	category: y,
 	name: n.string(),
-	value: d
-}), T = {
-	SPACE_UPDATED: n.object({ schema: o }),
+	value: p
+}), D = n.object({
+	type: n.string(),
+	resource: n.string(),
+	settings: n.custom(r, { message: "expected a plugin settings object" })
+}), O = {
+	SPACE_UPDATED: n.object({ schema: c }),
 	STYLE_UPDATED: n.object({
 		platform: n.custom(r),
 		variables: n.custom(r),
@@ -42,18 +52,18 @@ var r = (e) => typeof e == "object" && !!e && !Array.isArray(e), i = n.custom((e
 	SPACE_UPDATE_PAGE: n.object({ page: i }),
 	SPACE_SET_HOME_PAGE: n.object({ page: i }),
 	SPACE_REMOVE_PAGE: n.object({ pageId: n.string() }),
-	SPACE_ADD_PAGE_FOLDER: n.object({ pageFolder: s }),
-	SPACE_UPDATE_PAGE_FOLDER: n.object({ pageFolder: s }),
+	SPACE_ADD_PAGE_FOLDER: n.object({ pageFolder: l }),
+	SPACE_UPDATE_PAGE_FOLDER: n.object({ pageFolder: l }),
 	SPACE_REMOVE_PAGE_FOLDER: n.object({ pageFolderId: n.string() }),
-	SPACE_ADD_VARIABLE: x,
-	SPACE_UPDATE_VARIABLE: x,
+	SPACE_ADD_VARIABLE: C,
+	SPACE_UPDATE_VARIABLE: C,
 	SPACE_REMOVE_VARIABLE: n.object({ name: n.string() }),
 	SPACE_ADD_ELEMENT: n.object({
 		element: i,
-		dropPosition: p,
+		dropPosition: h,
 		to: n.string(),
 		initialItems: a.optional(),
-		variables: n.array(c).optional()
+		variables: n.array(u).optional()
 	}),
 	SPACE_UPDATE_ELEMENT: n.object({ element: i }),
 	SPACE_RENAME_ELEMENT: n.object({
@@ -66,22 +76,25 @@ var r = (e) => typeof e == "object" && !!e && !Array.isArray(e), i = n.custom((e
 		from: n.string(),
 		to: n.string(),
 		elementId: n.string(),
-		dropPosition: p
+		dropPosition: h
 	}),
 	SPACE_CLONE_ELEMENT: n.object({
 		to: n.string(),
 		element: i,
-		dropPosition: p,
+		dropPosition: h,
 		initialItems: a
 	}),
 	SPACE_ADD_TEMPLATE: n.object({
 		element: i,
 		style: n.custom(r),
 		to: n.string(),
-		dropPosition: p,
+		dropPosition: h,
 		initialItems: a.optional(),
-		variables: n.array(c).optional()
+		variables: n.array(u).optional()
 	}),
+	SPACE_ADD_PLUGIN: n.object({ plugin: D }),
+	SPACE_UPDATE_PLUGIN: n.object({ plugin: D }),
+	SPACE_REMOVE_PLUGIN: n.object({ pluginType: n.string() }),
 	SPACE_UPDATE_SETTINGS: n.object({
 		path: n.string(),
 		value: n.union([
@@ -91,146 +104,146 @@ var r = (e) => typeof e == "object" && !!e && !Array.isArray(e), i = n.custom((e
 		])
 	}),
 	STYLE_ADD_SELECTOR: n.object({
-		displayMode: f,
+		displayMode: m,
 		selector: n.string(),
-		path: m.optional(),
-		type: h,
-		style: l.optional(),
-		params: v
+		path: g.optional(),
+		type: _,
+		style: d.optional(),
+		params: b
 	}),
 	STYLE_UPDATE_SELECTOR: n.object({
-		displayMode: f,
+		displayMode: m,
 		selector: n.string(),
-		path: m.optional(),
-		style: l.optional(),
-		params: y
+		path: g.optional(),
+		style: d.optional(),
+		params: x
 	}),
 	STYLE_REMOVE_SELECTOR: n.object({
-		displayMode: f,
+		displayMode: m,
 		selector: n.string()
 	}),
 	STYLE_REMOVE_SELECTORS: n.object({
-		displayMode: f,
+		displayMode: m,
 		selectors: n.array(n.string())
 	}),
-	STYLE_ADD_SELECTOR_VARIABLE: S,
-	STYLE_UPDATE_SELECTOR_VARIABLE: S,
-	STYLE_REMOVE_SELECTOR_VARIABLE: C,
-	STYLE_ADD_VARIABLE: w,
-	STYLE_UPDATE_VARIABLE: w,
+	STYLE_ADD_SELECTOR_VARIABLE: w,
+	STYLE_UPDATE_SELECTOR_VARIABLE: w,
+	STYLE_REMOVE_SELECTOR_VARIABLE: T,
+	STYLE_ADD_VARIABLE: E,
+	STYLE_UPDATE_VARIABLE: E,
 	STYLE_REMOVE_VARIABLE: n.object({
-		category: _,
+		category: y,
 		name: n.string()
 	}),
 	STYLE_UPDATE_SETTINGS: n.object({
 		path: n.string(),
 		value: n.string()
 	}),
-	STYLE_ADD_FONT: n.object({ font: u }),
+	STYLE_ADD_FONT: n.object({ font: f }),
 	STYLE_UPDATE_FONT: n.object({
 		family: n.string(),
-		font: u
+		font: f
 	}),
 	STYLE_REMOVE_FONT: n.object({ family: n.string() }),
 	SEGMENT_ADD_ELEMENT: n.object({
-		...b,
+		...S,
 		element: i,
-		dropPosition: p,
+		dropPosition: h,
 		to: n.string(),
 		initialItems: a.optional(),
-		variables: n.array(c).optional()
+		variables: n.array(u).optional()
 	}),
 	SEGMENT_UPDATE_ELEMENT: n.object({
-		...b,
+		...S,
 		element: i
 	}),
 	SEGMENT_RENAME_ELEMENT: n.object({
-		...b,
+		...S,
 		elementId: n.string(),
 		id: n.string()
 	}),
 	SEGMENT_UPDATE_ELEMENTS: n.object({
-		...b,
+		...S,
 		elements: a
 	}),
 	SEGMENT_REMOVE_ELEMENT: n.object({
-		...b,
+		...S,
 		elementId: n.string()
 	}),
 	SEGMENT_MOVE_ELEMENT: n.object({
-		...b,
+		...S,
 		elementId: n.string(),
 		from: n.string(),
 		to: n.string(),
-		dropPosition: p
+		dropPosition: h
 	}),
 	SEGMENT_CLONE_ELEMENT: n.object({
-		...b,
+		...S,
 		element: i,
-		dropPosition: p,
+		dropPosition: h,
 		to: n.string(),
 		initialItems: a.optional()
 	}),
 	SEGMENT_ADD_TEMPLATE: n.object({
-		...b,
+		...S,
 		element: i,
 		style: n.custom(r),
 		to: n.string(),
-		dropPosition: p,
+		dropPosition: h,
 		initialItems: a.optional(),
-		variables: n.array(c).optional()
+		variables: n.array(u).optional()
 	}),
 	SEGMENT_SPACE_ADD_VARIABLE: n.object({
-		...b,
-		variable: c
+		...S,
+		variable: u
 	}),
 	SEGMENT_SPACE_UPDATE_VARIABLE: n.object({
-		...b,
-		variable: c
+		...S,
+		variable: u
 	}),
 	SEGMENT_SPACE_REMOVE_VARIABLE: n.object({
-		...b,
+		...S,
 		variable: n.object({ name: n.string() })
 	}),
 	SEGMENT_STYLE_ADD_SELECTOR: n.object({
-		...b,
-		displayMode: f,
+		...S,
+		displayMode: m,
 		selector: n.string(),
-		type: h,
-		path: m.optional(),
-		style: l.optional(),
-		params: v
+		type: _,
+		path: g.optional(),
+		style: d.optional(),
+		params: b
 	}),
 	SEGMENT_STYLE_UPDATE_SELECTOR: n.object({
-		...b,
-		displayMode: f,
+		...S,
+		displayMode: m,
 		selector: n.string(),
-		path: m.optional(),
-		style: l.optional(),
-		params: y
+		path: g.optional(),
+		style: d.optional(),
+		params: x
 	}),
 	SEGMENT_STYLE_REMOVE_SELECTOR: n.object({
-		...b,
-		displayMode: f,
+		...S,
+		displayMode: m,
 		selector: n.string()
 	}),
 	SEGMENT_STYLE_REMOVE_SELECTORS: n.object({
-		...b,
-		displayMode: f,
+		...S,
+		displayMode: m,
 		selectors: n.array(n.string())
 	}),
-	SEGMENT_STYLE_ADD_SELECTOR_VARIABLE: S.extend(b),
-	SEGMENT_STYLE_UPDATE_SELECTOR_VARIABLE: S.extend(b),
-	SEGMENT_STYLE_REMOVE_SELECTOR_VARIABLE: C.extend(b),
-	SEGMENT_STYLE_ADD_VARIABLE: w.extend(b),
-	SEGMENT_STYLE_UPDATE_VARIABLE: w.extend(b),
+	SEGMENT_STYLE_ADD_SELECTOR_VARIABLE: w.extend(S),
+	SEGMENT_STYLE_UPDATE_SELECTOR_VARIABLE: w.extend(S),
+	SEGMENT_STYLE_REMOVE_SELECTOR_VARIABLE: T.extend(S),
+	SEGMENT_STYLE_ADD_VARIABLE: E.extend(S),
+	SEGMENT_STYLE_UPDATE_VARIABLE: E.extend(S),
 	SEGMENT_STYLE_REMOVE_VARIABLE: n.object({
-		...b,
-		category: _,
+		...S,
+		category: y,
 		name: n.string()
 	})
-}, E = Object.fromEntries(Object.keys(T).map((e) => [e, e])), D = (e, t) => {
-	let n = T[e];
+}, k = Object.fromEntries(Object.keys(O).map((e) => [e, e])), A = (e, t) => {
+	let n = O[e];
 	if (!n) return {
 		ok: !1,
 		issues: [{
@@ -251,4 +264,4 @@ var r = (e) => typeof e == "object" && !!e && !Array.isArray(e), i = n.custom((e
 	};
 };
 //#endregion
-export { E as SpaceEvents, E as default, T as spaceEventSchemas, D as validateSpaceEvent };
+export { k as SpaceEvents, k as default, s as schemaFromWire, o as schemaToWire, O as spaceEventSchemas, A as validateSpaceEvent };

package/dist/realtime/client.d.ts

@@ -0,0 +1,46 @@
+import { RealtimeMessage, RealtimeTransport } from '../types/RealtimeTypes';
+export type RealtimeStatus = 'idle' | 'connecting' | 'open' | 'closed';
+type MessageListener = (message: RealtimeMessage) => void;
+type StatusListener = (status: RealtimeStatus) => void;
+export type RealtimeClient = {
+    /** Listens to a topic; the page's one connection is reopened to include it. Returns what stops listening. */
+    subscribe: (topic: string, listener: MessageListener) => () => void;
+    /**
+     * What opens a topic of a `grant: true` channel: the grant a flow's `realtime.grant` answered. Sent whenever the
+     * connection opens for as long as the topic is listened to — a grant is only asked for at the door, so a new one
+     * reopens nothing the server already let in. `undefined` forgets it.
+     */
+    grant: (topic: string, grant: string | undefined) => void;
+    /** Sends on a topic this page listens to. `false` when the server refused it or there is no connection. */
+    publish: (topic: string, type: string, data: unknown) => Promise<boolean>;
+    onStatus: (listener: StatusListener) => () => void;
+    readonly status: RealtimeStatus;
+    /** This page's name on its channels — the `from` of what it sends — once connected. */
+    readonly me: string | undefined;
+    /** How this page is connected right now: a socket, or a stream (also where a socket could not open). */
+    readonly transport: RealtimeTransport;
+    /** Why the server would not open a topic, when it would not. */
+    refusal: (topic: string) => string | undefined;
+};
+export type RealtimeClientOptions = {
+    /** What to connect with. `websocket` falls back to `sse` for good the first time a socket cannot open. */
+    transport?: RealtimeTransport;
+    fetchImpl?: typeof fetch;
+    WebSocketImpl?: typeof WebSocket;
+};
+/**
+ * A page's realtime connection: every topic it listens to over ONE connection — a Server-Sent Events stream it
+ * publishes to with requests, or a WebSocket that carries both.
+ *
+ * The stream is read with `fetch` rather than `EventSource`: an `EventSource` reconnects on its own, with the same
+ * topics, to a server that may have just refused them. Reconnecting is this client's decision: after a dropped
+ * connection, with a growing wait; never after a refusal.
+ *
+ * A socket that closes before it was ever ready is a socket that cannot open here — HTTP/2, a proxy that drops
+ * upgrades, or a refusal, which a browser does not let a page read — so the client moves to the stream for good. The
+ * stream says which it was.
+ */
+export declare const createRealtimeClient: (endpoint: string, { transport: preferred, fetchImpl, WebSocketImpl }?: RealtimeClientOptions) => RealtimeClient;
+/** The page's client for an endpoint: one connection, however many elements and plugins listen. */
+export declare const realtimeClientFor: (endpoint: string, transport?: RealtimeTransport) => RealtimeClient;
+export {};

package/dist/realtime/client.mjs

@@ -0,0 +1,192 @@
+import "./topics.mjs";
+//#region src/realtime/client.ts
+var e = 30, t = [
+	500,
+	1e3,
+	2e3,
+	5e3,
+	1e4
+], n = 5e3, r = (e) => typeof e == "object" && !!e && "connection" in e && typeof e.connection == "string" && "refused" in e && Array.isArray(e.refused), i = (e) => typeof e == "object" && !!e && "topic" in e && typeof e.topic == "string" && "type" in e && typeof e.type == "string", a = (e) => typeof e == "object" && !!e && "id" in e && typeof e.id == "number" && "ok" in e && typeof e.ok == "boolean", o = (e) => {
+	let t = "message", n = [];
+	for (let r of e.split("\n")) r.startsWith("event: ") ? t = r.slice(7) : r.startsWith("data: ") && n.push(r.slice(6));
+	if (n.length) try {
+		return {
+			event: t,
+			data: JSON.parse(n.join("\n"))
+		};
+	} catch {
+		return;
+	}
+}, s = (e) => {
+	try {
+		let t = JSON.parse(String(e));
+		return typeof t == "object" && t && "event" in t && typeof t.event == "string" ? {
+			event: t.event,
+			data: "data" in t ? t.data : void 0
+		} : void 0;
+	} catch {
+		return;
+	}
+}, c = (e, t) => {
+	let n = new URL(`${e}?${t}`, globalThis.location.href);
+	return n.protocol = n.protocol === "https:" ? "wss:" : "ws:", n.href;
+}, l = (l, { transport: u = "sse", fetchImpl: d = fetch, WebSocketImpl: f = globalThis.WebSocket } = {}) => {
+	let p = /* @__PURE__ */ new Map(), m = /* @__PURE__ */ new Map(), h = /* @__PURE__ */ new Set(), g = "idle", _, v = /* @__PURE__ */ new Map(), y, b, x = 0, S = u === "websocket" && typeof f == "function", C = (e) => {
+		g = e, h.forEach((t) => t(e));
+	}, w = () => [...p.keys()].sort().join(","), T = (e) => {
+		let t = e.split(",").flatMap((e) => m.get(e) ?? []);
+		return `topics=${encodeURIComponent(e)}${t.length ? `&grants=${encodeURIComponent(t.join(","))}` : ""}`;
+	}, E = (e) => {
+		e.type === "$revoked" && e.from === "server" && v.set(e.topic, "revoked"), p.get(e.topic)?.forEach((t) => t(e));
+	}, D = (e, t) => {
+		e.me = t.connection, v = new Map(t.refused.map((e) => [e.topic, e.reason])), x = 0, C("open");
+	}, O = (e) => {
+		if (_ !== e) return;
+		C("connecting");
+		let n = t[Math.min(x, t.length - 1)];
+		x += 1, b = setTimeout(j, n);
+	}, k = (e, t) => {
+		let n = new AbortController(), a, s = {
+			topics: e,
+			transport: "sse",
+			close: () => n.abort(),
+			publish: async (e, t, n) => {
+				if (!a) return !1;
+				let r = await d(l, {
+					method: "POST",
+					headers: { "content-type": "application/json" },
+					credentials: "same-origin",
+					body: JSON.stringify({
+						token: a,
+						topic: e,
+						type: t,
+						data: n
+					})
+				}).catch(() => void 0);
+				return r?.status === 401 && _ === s && j(), r?.ok ?? !1;
+			}
+		}, c = async (e) => {
+			let t = e.body?.getReader();
+			if (!t) return;
+			let n = new TextDecoder(), c = "";
+			for (;;) {
+				let { done: e, value: l } = await t.read();
+				if (e) return;
+				c += n.decode(l, { stream: !0 });
+				let u = c.indexOf("\n\n");
+				for (; u !== -1;) {
+					let e = o(c.slice(0, u));
+					c = c.slice(u + 2), u = c.indexOf("\n\n"), e?.event === "ready" && r(e.data) ? (a = e.data.token, D(s, e.data)) : e?.event === "message" && i(e.data) && E(e.data);
+				}
+			}
+		};
+		return d(`${l}?${t}`, {
+			headers: { accept: "text/event-stream" },
+			credentials: "same-origin",
+			signal: n.signal
+		}).then(async (t) => {
+			if (!t.ok) {
+				v = new Map(e.split(",").map((e) => [e, `http_${t.status}`])), C("closed");
+				return;
+			}
+			throw await c(t), Error("The realtime stream ended");
+		}).catch(() => {
+			n.signal.aborted || O(s);
+		}), s;
+	}, A = (e, t) => {
+		let o = new f(c(l, t)), u = /* @__PURE__ */ new Map(), d = 0, p = !1, m = !1, h = () => {
+			u.forEach((e) => e(!1)), u.clear();
+		}, g = {
+			topics: e,
+			transport: "websocket",
+			close: () => {
+				m = !0, h(), o.close();
+			},
+			publish: (e, t, r) => new Promise((i) => {
+				if (o.readyState !== o.OPEN) {
+					i(!1);
+					return;
+				}
+				d += 1;
+				let a = d, s = setTimeout(() => {
+					u.delete(a), i(!1);
+				}, n);
+				u.set(a, (e) => {
+					clearTimeout(s), i(e);
+				}), o.send(JSON.stringify({
+					id: a,
+					topic: e,
+					type: t,
+					data: r
+				}));
+			})
+		};
+		return o.onmessage = (e) => {
+			let t = s(e.data);
+			t?.event === "ready" && r(t.data) ? (p = !0, D(g, t.data)) : t?.event === "message" && i(t.data) ? E(t.data) : t?.event === "ack" && a(t.data) && (u.get(t.data.id)?.(t.data.ok), u.delete(t.data.id));
+		}, o.onclose = () => {
+			if (h(), !(m || _ !== g)) {
+				if (!p) {
+					S = !1, j();
+					return;
+				}
+				O(g);
+			}
+		}, g;
+	};
+	function j() {
+		_?.close(), _ = void 0;
+		let e = w();
+		if (!e) {
+			C("idle");
+			return;
+		}
+		C("connecting");
+		let t = T(e);
+		_ = S ? A(e, t) : k(e, t);
+	}
+	let M = (t = !1) => {
+		clearTimeout(y), clearTimeout(b), y = setTimeout(() => {
+			(t || _?.topics !== w()) && j();
+		}, e);
+	}, N = (e) => g === "open" && _?.topics.split(",").includes(e) === !0, P = (e) => N(e) ? Promise.resolve(!0) : new Promise((t) => {
+		let r = setTimeout(() => {
+			i(), t(!1);
+		}, n), i = F.onStatus((n) => {
+			(n === "closed" || N(e)) && (clearTimeout(r), i(), t(n !== "closed"));
+		});
+	}), F = {
+		subscribe: (e, t) => {
+			let n = p.get(e) ?? /* @__PURE__ */ new Set();
+			return n.add(t), p.set(e, n), M(), () => {
+				n.delete(t), n.size || (p.delete(e), m.delete(e), M());
+			};
+		},
+		grant: (e, t) => {
+			if (m.get(e) === t) return;
+			t ? m.set(e, t) : m.delete(e);
+			let n = N(e) && !v.has(e);
+			t && p.has(e) && !n && M(!0);
+		},
+		publish: async (e, t, n) => !await P(e) || !_ ? !1 : _.publish(e, t, n),
+		onStatus: (e) => (h.add(e), () => h.delete(e)),
+		get status() {
+			return g;
+		},
+		get me() {
+			return _?.me;
+		},
+		get transport() {
+			return _?.transport ?? (S ? "websocket" : "sse");
+		},
+		refusal: (e) => v.get(e)
+	};
+	return F;
+}, u = /* @__PURE__ */ new Map(), d = (e, t = "sse") => {
+	let n = `${t} ${e}`, r = u.get(n);
+	if (r) return r;
+	let i = l(e, { transport: t });
+	return u.set(n, i), i;
+};
+//#endregion
+export { l as createRealtimeClient, d as realtimeClientFor };

package/dist/realtime/index.d.ts

@@ -0,0 +1,6 @@
+export { createRealtimeClient, realtimeClientFor } from './client';
+export { trackPresence } from './presence';
+export { JOIN_TYPE, LEAVE_TYPE, PRESENCE_TYPE, REVOKED_TYPE, channelLimits, channelProblems, isValidTopic, matchChannel } from './topics';
+export type { RealtimeClient, RealtimeClientOptions, RealtimeStatus } from './client';
+export type { PresenceListeners, PresenceTracker, RealtimeMember } from './presence';
+export type { ChannelMatch } from './topics';

package/dist/realtime/index.mjs

@@ -0,0 +1,4 @@
+import { JOIN_TYPE as e, LEAVE_TYPE as t, PRESENCE_TYPE as n, REVOKED_TYPE as r, channelLimits as i, channelProblems as a, isValidTopic as o, matchChannel as s } from "./topics.mjs";
+import { createRealtimeClient as c, realtimeClientFor as l } from "./client.mjs";
+import { trackPresence as u } from "./presence.mjs";
+export { e as JOIN_TYPE, t as LEAVE_TYPE, n as PRESENCE_TYPE, r as REVOKED_TYPE, i as channelLimits, a as channelProblems, c as createRealtimeClient, o as isValidTopic, s as matchChannel, l as realtimeClientFor, u as trackPresence };

package/dist/realtime/presence.d.ts

@@ -0,0 +1,38 @@
+import { RealtimeClient } from './client';
+import { RealtimeMessage, RealtimeSender } from '../types/RealtimeTypes';
+/** One member of a channel: who they are to the server, and what they announced. */
+export type RealtimeMember = RealtimeSender & {
+    /** What the member announced — a name, a colour, a cursor. */
+    state: unknown;
+    /** Whether this member is this page. */
+    me: boolean;
+};
+export type PresenceTracker = {
+    /** Announces this page's state — and keeps announcing it, so it is not taken for gone. */
+    set: (state: unknown) => void;
+    members: () => RealtimeMember[];
+    stop: () => void;
+};
+/** What a tracker is told: who is here, every message on the topic, and who came and went. */
+export type PresenceListeners = {
+    onChange: (members: RealtimeMember[]) => void;
+    onMessage?: (message: RealtimeMessage) => void;
+    /**
+     * Somebody who joined after this page, once they have said who they are — their first `$presence`. Those already
+     * here when this page came are not arrivals: they answer its `$join` with theirs, and it is they who were here first.
+     */
+    onArrive?: (member: RealtimeMember) => void;
+    /** Somebody who was here went — the server said so, or they stopped being heard — as they last said they were. */
+    onDepart?: (member: RealtimeMember) => void;
+};
+/**
+ * Who is on a topic, kept from what the members say — nothing is stored anywhere.
+ *
+ * A member announces itself (`$presence`) when it sets its state, when somebody new arrives (`$join`) and every
+ * twenty seconds; the server says `$leave` when its connection closes. A member heard from in none of those ways for
+ * a minute is gone, which is what heals a leave that was lost.
+ *
+ * Every tracker of one topic on one client is a view of the same member: `set` from any of them is the page's state,
+ * and a tracker started late begins with everyone already known.
+ */
+export declare const trackPresence: (client: RealtimeClient, topic: string, listener: PresenceListeners) => PresenceTracker;