spacetimedb 2.5.0 → 2.6.0

package/src/solid/useTable.ts

@@ -1,203 +1,203 @@
-import { createSignal, onCleanup, createMemo, createComputed } from 'solid-js';
-import { useSpacetimeDB } from './useSpacetimeDB';
-import { type EventContextInterface } from '../sdk/db_connection_impl';
-import type { UntypedRemoteModule } from '../sdk/spacetime_module';
-import type { RowType, UntypedTableDef } from '../lib/table';
-import type { Prettify } from '../lib/type_util';
-import {
-  type Query,
-  type BooleanExpr,
-  toSql,
-  evaluateBooleanExpr,
-  getQueryAccessorName,
-  getQueryWhereClause,
-} from '../lib/query';
-import { createStore, reconcile } from 'solid-js/store';
-
-export interface UseTableCallbacks<RowType> {
-  onInsert?: (row: RowType) => void;
-  onDelete?: (row: RowType) => void;
-  onUpdate?: (oldRow: RowType, newRow: RowType) => void;
-  /** Whether the subscription is active. Defaults to `true`. */
-  enabled?: () => boolean;
-}
-
-type MembershipChange = 'enter' | 'leave' | 'stayIn' | 'stayOut';
-
-function classifyMembership(
-  whereExpr: BooleanExpr<any> | undefined,
-  oldRow: Record<string, any>,
-  newRow: Record<string, any>
-): MembershipChange {
-  if (!whereExpr) return 'stayIn';
-  const oldIn = evaluateBooleanExpr(whereExpr, oldRow);
-  const newIn = evaluateBooleanExpr(whereExpr, newRow);
-  if (oldIn && !newIn) return 'leave';
-  if (!oldIn && newIn) return 'enter';
-  if (oldIn && newIn) return 'stayIn';
-  return 'stayOut';
-}
-
-/**
- * SolidJS primitive to subscribe to a table in SpacetimeDB and receive live updates.
- *
- * Accepts a query builder expression as the first argument:
- * - `tables.user` — subscribe to all rows
- * - `tables.user.where(r => r.online.eq(true))` — subscribe with a filter
- *
- * @param query - A query builder expression (table reference or filtered query).
- * @param callbacks - Optional callbacks for row insert, delete, and update events.
- * @returns A tuple of [rows, isReady].
- *
- * @example
- * ```tsx
- * const [rows, isReady] = useTable(tables.user);
- * const [onlineUsers, isReady] = useTable(
- *   tables.user.where(r => r.online.eq(true)),
- *   { onInsert: (row) => console.log('New user:', row) }
- * );
- * ```
- */
-export function useTable<TableDef extends UntypedTableDef>(
-  query: () => Query<TableDef>,
-  callbacks?: UseTableCallbacks<Prettify<RowType<TableDef>>>
-): [readonly Prettify<RowType<TableDef>>[], () => boolean] {
-  type UseTableRowType = RowType<TableDef>;
-  const enabled = callbacks?.enabled ?? (() => true);
-  const q = createMemo(query);
-  const accessorName = createMemo(() => getQueryAccessorName(q()));
-  const whereExpr = createMemo(() => getQueryWhereClause(q()));
-  const querySql = createMemo(() => toSql(q()));
-
-  let connectionState: import('./connection_state').ConnectionState;
-  try {
-    connectionState = useSpacetimeDB();
-  } catch {
-    throw new Error(
-      'Could not find SpacetimeDB client! Did you forget to add a ' +
-        '`SpacetimeDBProvider`? `useTable` must be used in the SolidJS component tree ' +
-        'under a `SpacetimeDBProvider` component.'
-    );
-  }
-
-  const [rows, setRows] = createStore<readonly Prettify<UseTableRowType>[]>([]);
-
-  let latestTransactionEventId: string | null = null;
-
-  const computeSnapshot = (): readonly Prettify<UseTableRowType>[] => {
-    if (!enabled()) {
-      return [];
-    }
-
-    const connection = connectionState.getConnection();
-    if (!connection) {
-      return [];
-    }
-    const table = connection.db[accessorName()];
-    const result: readonly Prettify<UseTableRowType>[] = whereExpr()
-      ? (Array.from(table.iter()).filter(row =>
-          evaluateBooleanExpr(whereExpr()!, row as Record<string, any>)
-        ) as Prettify<UseTableRowType>[])
-      : (Array.from(table.iter()) as Prettify<UseTableRowType>[]);
-    return result;
-  };
-
-  const [isReady, setIsReady] = createSignal(false);
-
-  createComputed(() => {
-    if (!enabled()) {
-      setIsReady(false);
-      return;
-    }
-
-    const connection = connectionState.getConnection();
-    if (!connectionState.isActive || !connection) {
-      setIsReady(false);
-      return;
-    }
-
-    const cancel = connection
-      .subscriptionBuilder()
-      .onApplied(() => {
-        setIsReady(true);
-      })
-      .subscribe(querySql());
-
-    onCleanup(() => {
-      cancel.unsubscribe();
-    });
-
-    // Bind to table events
-    const table = connection.db[accessorName()];
-
-    const onInsert = (
-      ctx: EventContextInterface<UntypedRemoteModule>,
-      row: any
-    ) => {
-      if (whereExpr() && !evaluateBooleanExpr(whereExpr()!, row)) {
-        return;
-      }
-      callbacks?.onInsert?.(row);
-      if (ctx.event.id !== latestTransactionEventId) {
-        latestTransactionEventId = ctx.event.id;
-        setRows(reconcile(computeSnapshot()));
-      }
-    };
-
-    const onDelete = (
-      ctx: EventContextInterface<UntypedRemoteModule>,
-      row: any
-    ) => {
-      if (whereExpr() && !evaluateBooleanExpr(whereExpr()!, row)) {
-        return;
-      }
-      callbacks?.onDelete?.(row);
-      if (ctx.event.id !== latestTransactionEventId) {
-        latestTransactionEventId = ctx.event.id;
-        setRows(reconcile(computeSnapshot()));
-      }
-    };
-
-    const onUpdate = (
-      ctx: EventContextInterface<UntypedRemoteModule>,
-      oldRow: any,
-      newRow: any
-    ) => {
-      const change = classifyMembership(whereExpr(), oldRow, newRow);
-
-      switch (change) {
-        case 'leave':
-          callbacks?.onDelete?.(oldRow);
-          break;
-        case 'enter':
-          callbacks?.onInsert?.(newRow);
-          break;
-        case 'stayIn':
-          callbacks?.onUpdate?.(oldRow, newRow);
-          break;
-        case 'stayOut':
-          return; // no-op
-      }
-
-      if (ctx.event.id !== latestTransactionEventId) {
-        latestTransactionEventId = ctx.event.id;
-        setRows(reconcile(computeSnapshot()));
-      }
-    };
-
-    table.onInsert(onInsert);
-    table.onDelete(onDelete);
-    table.onUpdate?.(onUpdate);
-
-    // Load initial snapshot
-    setRows(reconcile(computeSnapshot()));
-
-    onCleanup(() => {
-      table.removeOnInsert(onInsert);
-      table.removeOnDelete(onDelete);
-      table.removeOnUpdate?.(onUpdate);
-    });
-  });
-
-  return [rows, isReady];
-}
+import { createSignal, onCleanup, createMemo, createComputed } from 'solid-js';
+import { useSpacetimeDB } from './useSpacetimeDB';
+import { type EventContextInterface } from '../sdk/db_connection_impl';
+import type { UntypedRemoteModule } from '../sdk/spacetime_module';
+import type { RowType, UntypedTableDef } from '../lib/table';
+import type { Prettify } from '../lib/type_util';
+import {
+  type Query,
+  type BooleanExpr,
+  toSql,
+  evaluateBooleanExpr,
+  getQueryAccessorName,
+  getQueryWhereClause,
+} from '../lib/query';
+import { createStore, reconcile } from 'solid-js/store';
+
+export interface UseTableCallbacks<RowType> {
+  onInsert?: (row: RowType) => void;
+  onDelete?: (row: RowType) => void;
+  onUpdate?: (oldRow: RowType, newRow: RowType) => void;
+  /** Whether the subscription is active. Defaults to `true`. */
+  enabled?: () => boolean;
+}
+
+type MembershipChange = 'enter' | 'leave' | 'stayIn' | 'stayOut';
+
+function classifyMembership(
+  whereExpr: BooleanExpr<any> | undefined,
+  oldRow: Record<string, any>,
+  newRow: Record<string, any>
+): MembershipChange {
+  if (!whereExpr) return 'stayIn';
+  const oldIn = evaluateBooleanExpr(whereExpr, oldRow);
+  const newIn = evaluateBooleanExpr(whereExpr, newRow);
+  if (oldIn && !newIn) return 'leave';
+  if (!oldIn && newIn) return 'enter';
+  if (oldIn && newIn) return 'stayIn';
+  return 'stayOut';
+}
+
+/**
+ * SolidJS primitive to subscribe to a table in SpacetimeDB and receive live updates.
+ *
+ * Accepts a query builder expression as the first argument:
+ * - `tables.user` — subscribe to all rows
+ * - `tables.user.where(r => r.online.eq(true))` — subscribe with a filter
+ *
+ * @param query - A query builder expression (table reference or filtered query).
+ * @param callbacks - Optional callbacks for row insert, delete, and update events.
+ * @returns A tuple of [rows, isReady].
+ *
+ * @example
+ * ```tsx
+ * const [rows, isReady] = useTable(tables.user);
+ * const [onlineUsers, isReady] = useTable(
+ *   tables.user.where(r => r.online.eq(true)),
+ *   { onInsert: (row) => console.log('New user:', row) }
+ * );
+ * ```
+ */
+export function useTable<TableDef extends UntypedTableDef>(
+  query: () => Query<TableDef>,
+  callbacks?: UseTableCallbacks<Prettify<RowType<TableDef>>>
+): [readonly Prettify<RowType<TableDef>>[], () => boolean] {
+  type UseTableRowType = RowType<TableDef>;
+  const enabled = callbacks?.enabled ?? (() => true);
+  const q = createMemo(query);
+  const accessorName = createMemo(() => getQueryAccessorName(q()));
+  const whereExpr = createMemo(() => getQueryWhereClause(q()));
+  const querySql = createMemo(() => toSql(q()));
+
+  let connectionState: import('./connection_state').ConnectionState;
+  try {
+    connectionState = useSpacetimeDB();
+  } catch {
+    throw new Error(
+      'Could not find SpacetimeDB client! Did you forget to add a ' +
+        '`SpacetimeDBProvider`? `useTable` must be used in the SolidJS component tree ' +
+        'under a `SpacetimeDBProvider` component.'
+    );
+  }
+
+  const [rows, setRows] = createStore<readonly Prettify<UseTableRowType>[]>([]);
+
+  let latestTransactionEventId: string | null = null;
+
+  const computeSnapshot = (): readonly Prettify<UseTableRowType>[] => {
+    if (!enabled()) {
+      return [];
+    }
+
+    const connection = connectionState.getConnection();
+    if (!connection) {
+      return [];
+    }
+    const table = connection.db[accessorName()];
+    const result: readonly Prettify<UseTableRowType>[] = whereExpr()
+      ? (Array.from(table.iter()).filter(row =>
+          evaluateBooleanExpr(whereExpr()!, row as Record<string, any>)
+        ) as Prettify<UseTableRowType>[])
+      : (Array.from(table.iter()) as Prettify<UseTableRowType>[]);
+    return result;
+  };
+
+  const [isReady, setIsReady] = createSignal(false);
+
+  createComputed(() => {
+    if (!enabled()) {
+      setIsReady(false);
+      return;
+    }
+
+    const connection = connectionState.getConnection();
+    if (!connectionState.isActive || !connection) {
+      setIsReady(false);
+      return;
+    }
+
+    const cancel = connection
+      .subscriptionBuilder()
+      .onApplied(() => {
+        setIsReady(true);
+      })
+      .subscribe(querySql());
+
+    onCleanup(() => {
+      cancel.unsubscribe();
+    });
+
+    // Bind to table events
+    const table = connection.db[accessorName()];
+
+    const onInsert = (
+      ctx: EventContextInterface<UntypedRemoteModule>,
+      row: any
+    ) => {
+      if (whereExpr() && !evaluateBooleanExpr(whereExpr()!, row)) {
+        return;
+      }
+      callbacks?.onInsert?.(row);
+      if (ctx.event.id !== latestTransactionEventId) {
+        latestTransactionEventId = ctx.event.id;
+        setRows(reconcile(computeSnapshot()));
+      }
+    };
+
+    const onDelete = (
+      ctx: EventContextInterface<UntypedRemoteModule>,
+      row: any
+    ) => {
+      if (whereExpr() && !evaluateBooleanExpr(whereExpr()!, row)) {
+        return;
+      }
+      callbacks?.onDelete?.(row);
+      if (ctx.event.id !== latestTransactionEventId) {
+        latestTransactionEventId = ctx.event.id;
+        setRows(reconcile(computeSnapshot()));
+      }
+    };
+
+    const onUpdate = (
+      ctx: EventContextInterface<UntypedRemoteModule>,
+      oldRow: any,
+      newRow: any
+    ) => {
+      const change = classifyMembership(whereExpr(), oldRow, newRow);
+
+      switch (change) {
+        case 'leave':
+          callbacks?.onDelete?.(oldRow);
+          break;
+        case 'enter':
+          callbacks?.onInsert?.(newRow);
+          break;
+        case 'stayIn':
+          callbacks?.onUpdate?.(oldRow, newRow);
+          break;
+        case 'stayOut':
+          return; // no-op
+      }
+
+      if (ctx.event.id !== latestTransactionEventId) {
+        latestTransactionEventId = ctx.event.id;
+        setRows(reconcile(computeSnapshot()));
+      }
+    };
+
+    table.onInsert(onInsert);
+    table.onDelete(onDelete);
+    table.onUpdate?.(onUpdate);
+
+    // Load initial snapshot
+    setRows(reconcile(computeSnapshot()));
+
+    onCleanup(() => {
+      table.removeOnInsert(onInsert);
+      table.removeOnDelete(onDelete);
+      table.removeOnUpdate?.(onUpdate);
+    });
+  });
+
+  return [rows, isReady];
+}

package/src/svelte/SpacetimeDBProvider.ts

@@ -1,101 +1,101 @@
-import { setContext, onDestroy } from 'svelte';
-import { writable, type Writable } from 'svelte/store';
-import {
-  DbConnectionBuilder,
-  type DbConnectionImpl,
-  type ErrorContextInterface,
-  type RemoteModuleOf,
-} from '../sdk/db_connection_impl';
-import { ConnectionId } from '../lib/connection_id';
-import {
-  SPACETIMEDB_CONTEXT_KEY,
-  type ConnectionState,
-} from './connection_state';
-
-let connRef: DbConnectionImpl<any> | null = null;
-let cleanupTimeoutId: ReturnType<typeof setTimeout> | null = null;
-
-export function createSpacetimeDBProvider<
-  DbConnection extends DbConnectionImpl<any>,
->(
-  connectionBuilder: DbConnectionBuilder<DbConnection>
-): Writable<ConnectionState> {
-  const getConnection = () => connRef as DbConnection | null;
-
-  const store = writable<ConnectionState>({
-    isActive: false,
-    identity: undefined,
-    token: undefined,
-    connectionId: ConnectionId.random(),
-    connectionError: undefined,
-    getConnection: getConnection as ConnectionState['getConnection'],
-  });
-
-  if (cleanupTimeoutId) {
-    clearTimeout(cleanupTimeoutId);
-    cleanupTimeoutId = null;
-  }
-
-  if (!connRef) {
-    connRef = connectionBuilder.build();
-  }
-
-  const onConnect = (conn: DbConnection) => {
-    store.update(s => ({
-      ...s,
-      isActive: conn.isActive,
-      identity: conn.identity,
-      token: conn.token,
-      connectionId: conn.connectionId,
-    }));
-  };
-
-  const onDisconnect = (
-    ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>
-  ) => {
-    store.update(s => ({
-      ...s,
-      isActive: ctx.isActive,
-    }));
-  };
-
-  const onConnectError = (
-    ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>,
-    err: Error
-  ) => {
-    store.update(s => ({
-      ...s,
-      isActive: ctx.isActive,
-      connectionError: err,
-    }));
-  };
-
-  connectionBuilder.onConnect(onConnect);
-  connectionBuilder.onDisconnect(onDisconnect);
-  connectionBuilder.onConnectError(onConnectError);
-
-  const conn = connRef;
-  store.update(s => ({
-    ...s,
-    isActive: conn.isActive,
-    identity: conn.identity,
-    token: conn.token,
-    connectionId: conn.connectionId,
-  }));
-
-  setContext(SPACETIMEDB_CONTEXT_KEY, store);
-
-  onDestroy(() => {
-    connRef?.removeOnConnect(onConnect as any);
-    connRef?.removeOnDisconnect(onDisconnect as any);
-    connRef?.removeOnConnectError(onConnectError as any);
-
-    cleanupTimeoutId = setTimeout(() => {
-      connRef?.disconnect();
-      connRef = null;
-      cleanupTimeoutId = null;
-    }, 0);
-  });
-
-  return store;
-}
+import { setContext, onDestroy } from 'svelte';
+import { writable, type Writable } from 'svelte/store';
+import {
+  DbConnectionBuilder,
+  type DbConnectionImpl,
+  type ErrorContextInterface,
+  type RemoteModuleOf,
+} from '../sdk/db_connection_impl';
+import { ConnectionId } from '../lib/connection_id';
+import {
+  SPACETIMEDB_CONTEXT_KEY,
+  type ConnectionState,
+} from './connection_state';
+
+let connRef: DbConnectionImpl<any> | null = null;
+let cleanupTimeoutId: ReturnType<typeof setTimeout> | null = null;
+
+export function createSpacetimeDBProvider<
+  DbConnection extends DbConnectionImpl<any>,
+>(
+  connectionBuilder: DbConnectionBuilder<DbConnection>
+): Writable<ConnectionState> {
+  const getConnection = () => connRef as DbConnection | null;
+
+  const store = writable<ConnectionState>({
+    isActive: false,
+    identity: undefined,
+    token: undefined,
+    connectionId: ConnectionId.random(),
+    connectionError: undefined,
+    getConnection: getConnection as ConnectionState['getConnection'],
+  });
+
+  if (cleanupTimeoutId) {
+    clearTimeout(cleanupTimeoutId);
+    cleanupTimeoutId = null;
+  }
+
+  if (!connRef) {
+    connRef = connectionBuilder.build();
+  }
+
+  const onConnect = (conn: DbConnection) => {
+    store.update(s => ({
+      ...s,
+      isActive: conn.isActive,
+      identity: conn.identity,
+      token: conn.token,
+      connectionId: conn.connectionId,
+    }));
+  };
+
+  const onDisconnect = (
+    ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>
+  ) => {
+    store.update(s => ({
+      ...s,
+      isActive: ctx.isActive,
+    }));
+  };
+
+  const onConnectError = (
+    ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>,
+    err: Error
+  ) => {
+    store.update(s => ({
+      ...s,
+      isActive: ctx.isActive,
+      connectionError: err,
+    }));
+  };
+
+  connectionBuilder.onConnect(onConnect);
+  connectionBuilder.onDisconnect(onDisconnect);
+  connectionBuilder.onConnectError(onConnectError);
+
+  const conn = connRef;
+  store.update(s => ({
+    ...s,
+    isActive: conn.isActive,
+    identity: conn.identity,
+    token: conn.token,
+    connectionId: conn.connectionId,
+  }));
+
+  setContext(SPACETIMEDB_CONTEXT_KEY, store);
+
+  onDestroy(() => {
+    connRef?.removeOnConnect(onConnect as any);
+    connRef?.removeOnDisconnect(onDisconnect as any);
+    connRef?.removeOnConnectError(onConnectError as any);
+
+    cleanupTimeoutId = setTimeout(() => {
+      connRef?.disconnect();
+      connRef = null;
+      cleanupTimeoutId = null;
+    }, 0);
+  });
+
+  return store;
+}

package/src/svelte/connection_state.ts

@@ -1,16 +1,16 @@
-import type { ConnectionId } from '../lib/connection_id';
-import type { Identity } from '../lib/identity';
-import type { DbConnectionImpl } from '../sdk/db_connection_impl';
-
-export type ConnectionState = {
-  isActive: boolean;
-  identity?: Identity;
-  token?: string;
-  connectionId: ConnectionId;
-  connectionError?: Error;
-  getConnection<
-    DbConnection extends DbConnectionImpl<any>,
-  >(): DbConnection | null;
-};
-
-export const SPACETIMEDB_CONTEXT_KEY = Symbol('spacetimedb');
+import type { ConnectionId } from '../lib/connection_id';
+import type { Identity } from '../lib/identity';
+import type { DbConnectionImpl } from '../sdk/db_connection_impl';
+
+export type ConnectionState = {
+  isActive: boolean;
+  identity?: Identity;
+  token?: string;
+  connectionId: ConnectionId;
+  connectionError?: Error;
+  getConnection<
+    DbConnection extends DbConnectionImpl<any>,
+  >(): DbConnection | null;
+};
+
+export const SPACETIMEDB_CONTEXT_KEY = Symbol('spacetimedb');

package/src/svelte/index.ts

@@ -1,4 +1,4 @@
-export * from './SpacetimeDBProvider.ts';
-export { useSpacetimeDB } from './useSpacetimeDB.ts';
-export { useTable } from './useTable.ts';
-export { useReducer } from './useReducer.ts';
+export * from './SpacetimeDBProvider.ts';
+export { useSpacetimeDB } from './useSpacetimeDB.ts';
+export { useTable } from './useTable.ts';
+export { useReducer } from './useReducer.ts';