spacetimedb 2.5.0 → 2.6.0

package/src/sdk/client_cache.ts

@@ -1,129 +1,129 @@
-import type { TableNamesOf, UntypedSchemaDef } from '../lib/schema.ts';
-import type { UntypedTableDef } from '../lib/table.ts';
-import type { Values } from '../lib/type_util.ts';
-import type { UntypedRemoteModule } from './spacetime_module.ts';
-import { type TableCache, TableCacheImpl } from './table_cache.ts';
-
-type TableName<SchemaDef> = [SchemaDef] extends [UntypedSchemaDef]
-  ? TableNamesOf<SchemaDef>
-  : string;
-
-export type TableDefForTableName<
-  SchemaDef extends UntypedSchemaDef,
-  N extends TableName<SchemaDef>,
-> = [SchemaDef] extends [UntypedSchemaDef]
-  ? Values<SchemaDef['tables']> & { accessorName: N }
-  : UntypedTableDef & { accessorName: N };
-
-type TableCacheForTableName<
-  RemoteModule extends UntypedRemoteModule,
-  TableName extends TableNamesOf<RemoteModule>,
-> = TableCache<RemoteModule, TableName>;
-
-/**
- * This is a helper class that provides a mapping from table names to their corresponding TableCache instances
- * while preserving the correspondence between the key and value type.
- */
-class TableMap<RemoteModule extends UntypedRemoteModule> {
-  private readonly map: Map<
-    string,
-    TableCacheForTableName<RemoteModule, TableName<RemoteModule>>
-  > = new Map();
-
-  get<K extends TableName<RemoteModule>>(
-    key: K
-  ): TableCacheForTableName<RemoteModule, K> | undefined {
-    // Cast required: a Map<string, Union> can't refine the union to the exact K-specific member on get<K>(key: K).
-    return this.map.get(key) as
-      | TableCacheForTableName<RemoteModule, K>
-      | undefined;
-  }
-
-  set<K extends TableName<RemoteModule>>(
-    key: K,
-    value: TableCacheForTableName<RemoteModule, K>
-  ): this {
-    this.map.set(key, value);
-    return this;
-  }
-
-  has(key: TableName<RemoteModule>): boolean {
-    return this.map.has(key);
-  }
-
-  delete(key: TableName<RemoteModule>): boolean {
-    return this.map.delete(key);
-  }
-
-  // optional: iteration stays broadly typed (cannot express per-key relation here)
-  keys(): IterableIterator<string> {
-    return this.map.keys();
-  }
-  values(): IterableIterator<
-    TableCacheForTableName<RemoteModule, TableName<RemoteModule>>
-  > {
-    return this.map.values();
-  }
-  entries(): IterableIterator<
-    [string, TableCacheForTableName<RemoteModule, TableName<RemoteModule>>]
-  > {
-    return this.map.entries();
-  }
-  [Symbol.iterator]() {
-    return this.entries();
-  }
-}
-
-/**
- * ClientCache maintains a cache of TableCache instances for each table in the database.
- * It provides methods to get or create TableCache instances by table name,
- * ensuring type safety based on the provided SchemaDef.
- */
-export class ClientCache<RemoteModule extends UntypedRemoteModule> {
-  /**
-   * The tables in the database.
-   */
-  readonly tables = new TableMap<RemoteModule>();
-
-  /**
-   * Returns the table with the given name.
-   * - If SchemaDef is a concrete schema, `name` is constrained to known table names,
-   *   and the return type matches that table.
-   * - If SchemaDef is undefined, `name` is string and the return type is untyped.
-   */
-  getTable<N extends TableName<RemoteModule>>(
-    name: N
-  ): TableCacheForTableName<RemoteModule, N> {
-    const table = this.tables.get(name);
-    if (!table) {
-      console.error(
-        'The table has not been registered for this client. Please register the table before using it. If you have registered global tables using the SpacetimeDBClient.registerTables() or `registerTable()` method, please make sure that is executed first!'
-      );
-      throw new Error(`Table ${String(name)} does not exist`);
-    }
-    return table;
-  }
-
-  /**
-   * Returns the table with the given name, creating it if needed.
-   * - Typed mode: `tableTypeInfo.tableName` is constrained to known names and
-   *   the return type matches that table.
-   * - Untyped mode: accepts any string and returns an untyped TableCache.
-   */
-  getOrCreateTable<N extends TableName<RemoteModule>>(
-    tableDef: TableDefForTableName<RemoteModule, N>
-  ): TableCacheForTableName<RemoteModule, N> {
-    const name = tableDef.accessorName;
-
-    const table = this.tables.get(name);
-    if (table) {
-      return table;
-    }
-
-    const newTable = new TableCacheImpl<RemoteModule, N>(
-      tableDef
-    ) as TableCache<RemoteModule, N>;
-    this.tables.set(name, newTable);
-    return newTable;
-  }
-}
+import type { TableNamesOf, UntypedSchemaDef } from '../lib/schema.ts';
+import type { UntypedTableDef } from '../lib/table.ts';
+import type { Values } from '../lib/type_util.ts';
+import type { UntypedRemoteModule } from './spacetime_module.ts';
+import { type TableCache, TableCacheImpl } from './table_cache.ts';
+
+type TableName<SchemaDef> = [SchemaDef] extends [UntypedSchemaDef]
+  ? TableNamesOf<SchemaDef>
+  : string;
+
+export type TableDefForTableName<
+  SchemaDef extends UntypedSchemaDef,
+  N extends TableName<SchemaDef>,
+> = [SchemaDef] extends [UntypedSchemaDef]
+  ? Values<SchemaDef['tables']> & { accessorName: N }
+  : UntypedTableDef & { accessorName: N };
+
+type TableCacheForTableName<
+  RemoteModule extends UntypedRemoteModule,
+  TableName extends TableNamesOf<RemoteModule>,
+> = TableCache<RemoteModule, TableName>;
+
+/**
+ * This is a helper class that provides a mapping from table names to their corresponding TableCache instances
+ * while preserving the correspondence between the key and value type.
+ */
+class TableMap<RemoteModule extends UntypedRemoteModule> {
+  private readonly map: Map<
+    string,
+    TableCacheForTableName<RemoteModule, TableName<RemoteModule>>
+  > = new Map();
+
+  get<K extends TableName<RemoteModule>>(
+    key: K
+  ): TableCacheForTableName<RemoteModule, K> | undefined {
+    // Cast required: a Map<string, Union> can't refine the union to the exact K-specific member on get<K>(key: K).
+    return this.map.get(key) as
+      | TableCacheForTableName<RemoteModule, K>
+      | undefined;
+  }
+
+  set<K extends TableName<RemoteModule>>(
+    key: K,
+    value: TableCacheForTableName<RemoteModule, K>
+  ): this {
+    this.map.set(key, value);
+    return this;
+  }
+
+  has(key: TableName<RemoteModule>): boolean {
+    return this.map.has(key);
+  }
+
+  delete(key: TableName<RemoteModule>): boolean {
+    return this.map.delete(key);
+  }
+
+  // optional: iteration stays broadly typed (cannot express per-key relation here)
+  keys(): IterableIterator<string> {
+    return this.map.keys();
+  }
+  values(): IterableIterator<
+    TableCacheForTableName<RemoteModule, TableName<RemoteModule>>
+  > {
+    return this.map.values();
+  }
+  entries(): IterableIterator<
+    [string, TableCacheForTableName<RemoteModule, TableName<RemoteModule>>]
+  > {
+    return this.map.entries();
+  }
+  [Symbol.iterator]() {
+    return this.entries();
+  }
+}
+
+/**
+ * ClientCache maintains a cache of TableCache instances for each table in the database.
+ * It provides methods to get or create TableCache instances by table name,
+ * ensuring type safety based on the provided SchemaDef.
+ */
+export class ClientCache<RemoteModule extends UntypedRemoteModule> {
+  /**
+   * The tables in the database.
+   */
+  readonly tables = new TableMap<RemoteModule>();
+
+  /**
+   * Returns the table with the given name.
+   * - If SchemaDef is a concrete schema, `name` is constrained to known table names,
+   *   and the return type matches that table.
+   * - If SchemaDef is undefined, `name` is string and the return type is untyped.
+   */
+  getTable<N extends TableName<RemoteModule>>(
+    name: N
+  ): TableCacheForTableName<RemoteModule, N> {
+    const table = this.tables.get(name);
+    if (!table) {
+      console.error(
+        'The table has not been registered for this client. Please register the table before using it. If you have registered global tables using the SpacetimeDBClient.registerTables() or `registerTable()` method, please make sure that is executed first!'
+      );
+      throw new Error(`Table ${String(name)} does not exist`);
+    }
+    return table;
+  }
+
+  /**
+   * Returns the table with the given name, creating it if needed.
+   * - Typed mode: `tableTypeInfo.tableName` is constrained to known names and
+   *   the return type matches that table.
+   * - Untyped mode: accepts any string and returns an untyped TableCache.
+   */
+  getOrCreateTable<N extends TableName<RemoteModule>>(
+    tableDef: TableDefForTableName<RemoteModule, N>
+  ): TableCacheForTableName<RemoteModule, N> {
+    const name = tableDef.accessorName;
+
+    const table = this.tables.get(name);
+    if (table) {
+      return table;
+    }
+
+    const newTable = new TableCacheImpl<RemoteModule, N>(
+      tableDef
+    ) as TableCache<RemoteModule, N>;
+    this.tables.set(name, newTable);
+    return newTable;
+  }
+}

package/src/sdk/client_table.ts

@@ -1,179 +1,179 @@
-import type { ReadonlyIndexes } from '../lib/indexes';
-import type { TableNamesOf } from '../lib/schema';
-import type {
-  ReadonlyTableMethods,
-  RowType,
-  TableIndexes,
-  UntypedTableDef,
-} from '../lib/table';
-import type { ColumnBuilder } from '../lib/type_builders';
-import type { Prettify } from '../lib/type_util';
-import type { TableDefForTableName } from './client_cache';
-import type { EventContextInterface } from './event_context';
-import type { UntypedRemoteModule } from './spacetime_module';
-
-export type ClientTablePrimaryKeyMethods<
-  RemoteModule extends UntypedRemoteModule,
-  TableName extends TableNamesOf<RemoteModule>,
-> = {
-  /**
-   * Registers a callback to be invoked when a row is updated in the table.
-   * Requires that the table has a primary key defined.
-   * @param cb The callback to invoke when a row is updated.
-   */
-  onUpdate(
-    cb: (
-      ctx: EventContextInterface<RemoteModule>,
-      oldRow: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>,
-      newRow: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
-    ) => void
-  ): void;
-
-  /**
-   * Removes a previously registered update event listener.
-   * @param cb The callback to remove from the update event listeners.
-   */
-  removeOnUpdate(
-    cb: (
-      ctx: EventContextInterface<RemoteModule>,
-      oldRow: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>,
-      newRow: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
-    ) => void
-  ): void;
-};
-
-export type ClientTableInsertMethods<
-  RemoteModule extends UntypedRemoteModule,
-  TableName extends TableNamesOf<RemoteModule>,
-> = {
-  /**
-   * Registers a callback to be invoked when a row is inserted into the table.
-   */
-  onInsert(
-    cb: (
-      ctx: EventContextInterface<RemoteModule>,
-      row: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
-    ) => void
-  ): void;
-
-  /**
-   *  Removes a previously registered insert event listener.
-   * @param cb The callback to remove from the insert event listeners.
-   */
-  removeOnInsert(
-    cb: (
-      ctx: EventContextInterface<RemoteModule>,
-      row: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
-    ) => void
-  ): void;
-};
-
-export type ClientTableDeleteMethods<
-  RemoteModule extends UntypedRemoteModule,
-  TableName extends TableNamesOf<RemoteModule>,
-> = {
-  /**
-   * Registers a callback to be invoked when a row is deleted from the table.
-   */
-  onDelete(
-    cb: (
-      ctx: EventContextInterface<RemoteModule>,
-      row: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
-    ) => void
-  ): void;
-
-  /**
-   * Removes a previously registered delete event listener.
-   * @param cb The callback to remove from the delete event listeners.
-   */
-  removeOnDelete(
-    cb: (
-      ctx: EventContextInterface<RemoteModule>,
-      row: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
-    ) => void
-  ): void;
-};
-
-export type ClientTableMethods<
-  RemoteModule extends UntypedRemoteModule,
-  TableName extends TableNamesOf<RemoteModule>,
-> = ClientTableInsertMethods<RemoteModule, TableName> &
-  ClientTableDeleteMethods<RemoteModule, TableName>;
-
-/**
- * Table<Row, UniqueConstraintViolation = never, AutoIncOverflow = never>
- *
- * - Row: row shape
- * - UCV: unique-constraint violation error type (never if none)
- * - AIO: auto-increment overflow error type (never if none)
- */
-export type ClientTable<
-  RemoteModule extends UntypedRemoteModule,
-  TableName extends TableNamesOf<RemoteModule>,
-> = Prettify<
-  ClientTableCore<RemoteModule, TableName> &
-    ReadonlyIndexes<
-      TableDefForTableName<RemoteModule, TableName>,
-      TableIndexes<TableDefForTableName<RemoteModule, TableName>>
-    >
->;
-
-type IsEventTable<TableDef extends UntypedTableDef> = TableDef extends {
-  isEvent: true;
-}
-  ? true
-  : false;
-
-type HasPrimaryKey<TableDef extends UntypedTableDef> = ColumnsHavePrimaryKey<
-  TableDef['columns']
->;
-
-type ColumnsHavePrimaryKey<
-  Cs extends Record<string, ColumnBuilder<any, any, any>>,
-> = {
-  [K in keyof Cs]: Cs[K] extends ColumnBuilder<any, any, infer M>
-    ? M extends { isPrimaryKey: true }
-      ? true
-      : never
-    : never;
-}[keyof Cs] extends true
-  ? true
-  : false;
-
-type MaybePKMethods<
-  RemoteModule extends UntypedRemoteModule,
-  TableName extends TableNamesOf<RemoteModule>,
-> = Partial<ClientTablePrimaryKeyMethods<RemoteModule, TableName>>;
-
-/**
- * A variant of ClientTableCore where the primary key methods are always optional,
- * allowing for classes like TableCache to implement this interface
- */
-export type ClientTableCoreImplementable<
-  RemoteModule extends UntypedRemoteModule,
-  TableName extends TableNamesOf<RemoteModule>,
-> = ReadonlyTableMethods<TableDefForTableName<RemoteModule, TableName>> &
-  ClientTableMethods<RemoteModule, TableName> &
-  // always present but optional -> statically known member set
-  MaybePKMethods<RemoteModule, TableName>;
-
-/**
- * Core methods of ClientTable, without the indexes mixed in.
- * Includes only statically known methods.
- *
- * Event tables only expose insert callbacks (no delete or update),
- * matching the Rust SDK's `EventTable` trait.
- */
-export type ClientTableCore<
-  RemoteModule extends UntypedRemoteModule,
-  TableName extends TableNamesOf<RemoteModule>,
-> = ReadonlyTableMethods<TableDefForTableName<RemoteModule, TableName>> &
-  ClientTableInsertMethods<RemoteModule, TableName> &
-  (IsEventTable<TableDefForTableName<RemoteModule, TableName>> extends true
-    ? {}
-    : ClientTableDeleteMethods<RemoteModule, TableName> &
-        (HasPrimaryKey<
-          TableDefForTableName<RemoteModule, TableName>
-        > extends true
-          ? ClientTablePrimaryKeyMethods<RemoteModule, TableName>
-          : {}));
+import type { ReadonlyIndexes } from '../lib/indexes';
+import type { TableNamesOf } from '../lib/schema';
+import type {
+  ReadonlyTableMethods,
+  RowType,
+  TableIndexes,
+  UntypedTableDef,
+} from '../lib/table';
+import type { ColumnBuilder } from '../lib/type_builders';
+import type { Prettify } from '../lib/type_util';
+import type { TableDefForTableName } from './client_cache';
+import type { EventContextInterface } from './event_context';
+import type { UntypedRemoteModule } from './spacetime_module';
+
+export type ClientTablePrimaryKeyMethods<
+  RemoteModule extends UntypedRemoteModule,
+  TableName extends TableNamesOf<RemoteModule>,
+> = {
+  /**
+   * Registers a callback to be invoked when a row is updated in the table.
+   * Requires that the table has a primary key defined.
+   * @param cb The callback to invoke when a row is updated.
+   */
+  onUpdate(
+    cb: (
+      ctx: EventContextInterface<RemoteModule>,
+      oldRow: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>,
+      newRow: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
+    ) => void
+  ): void;
+
+  /**
+   * Removes a previously registered update event listener.
+   * @param cb The callback to remove from the update event listeners.
+   */
+  removeOnUpdate(
+    cb: (
+      ctx: EventContextInterface<RemoteModule>,
+      oldRow: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>,
+      newRow: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
+    ) => void
+  ): void;
+};
+
+export type ClientTableInsertMethods<
+  RemoteModule extends UntypedRemoteModule,
+  TableName extends TableNamesOf<RemoteModule>,
+> = {
+  /**
+   * Registers a callback to be invoked when a row is inserted into the table.
+   */
+  onInsert(
+    cb: (
+      ctx: EventContextInterface<RemoteModule>,
+      row: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
+    ) => void
+  ): void;
+
+  /**
+   *  Removes a previously registered insert event listener.
+   * @param cb The callback to remove from the insert event listeners.
+   */
+  removeOnInsert(
+    cb: (
+      ctx: EventContextInterface<RemoteModule>,
+      row: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
+    ) => void
+  ): void;
+};
+
+export type ClientTableDeleteMethods<
+  RemoteModule extends UntypedRemoteModule,
+  TableName extends TableNamesOf<RemoteModule>,
+> = {
+  /**
+   * Registers a callback to be invoked when a row is deleted from the table.
+   */
+  onDelete(
+    cb: (
+      ctx: EventContextInterface<RemoteModule>,
+      row: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
+    ) => void
+  ): void;
+
+  /**
+   * Removes a previously registered delete event listener.
+   * @param cb The callback to remove from the delete event listeners.
+   */
+  removeOnDelete(
+    cb: (
+      ctx: EventContextInterface<RemoteModule>,
+      row: Prettify<RowType<TableDefForTableName<RemoteModule, TableName>>>
+    ) => void
+  ): void;
+};
+
+export type ClientTableMethods<
+  RemoteModule extends UntypedRemoteModule,
+  TableName extends TableNamesOf<RemoteModule>,
+> = ClientTableInsertMethods<RemoteModule, TableName> &
+  ClientTableDeleteMethods<RemoteModule, TableName>;
+
+/**
+ * Table<Row, UniqueConstraintViolation = never, AutoIncOverflow = never>
+ *
+ * - Row: row shape
+ * - UCV: unique-constraint violation error type (never if none)
+ * - AIO: auto-increment overflow error type (never if none)
+ */
+export type ClientTable<
+  RemoteModule extends UntypedRemoteModule,
+  TableName extends TableNamesOf<RemoteModule>,
+> = Prettify<
+  ClientTableCore<RemoteModule, TableName> &
+    ReadonlyIndexes<
+      TableDefForTableName<RemoteModule, TableName>,
+      TableIndexes<TableDefForTableName<RemoteModule, TableName>>
+    >
+>;
+
+type IsEventTable<TableDef extends UntypedTableDef> = TableDef extends {
+  isEvent: true;
+}
+  ? true
+  : false;
+
+type HasPrimaryKey<TableDef extends UntypedTableDef> = ColumnsHavePrimaryKey<
+  TableDef['columns']
+>;
+
+type ColumnsHavePrimaryKey<
+  Cs extends Record<string, ColumnBuilder<any, any, any>>,
+> = {
+  [K in keyof Cs]: Cs[K] extends ColumnBuilder<any, any, infer M>
+    ? M extends { isPrimaryKey: true }
+      ? true
+      : never
+    : never;
+}[keyof Cs] extends true
+  ? true
+  : false;
+
+type MaybePKMethods<
+  RemoteModule extends UntypedRemoteModule,
+  TableName extends TableNamesOf<RemoteModule>,
+> = Partial<ClientTablePrimaryKeyMethods<RemoteModule, TableName>>;
+
+/**
+ * A variant of ClientTableCore where the primary key methods are always optional,
+ * allowing for classes like TableCache to implement this interface
+ */
+export type ClientTableCoreImplementable<
+  RemoteModule extends UntypedRemoteModule,
+  TableName extends TableNamesOf<RemoteModule>,
+> = ReadonlyTableMethods<TableDefForTableName<RemoteModule, TableName>> &
+  ClientTableMethods<RemoteModule, TableName> &
+  // always present but optional -> statically known member set
+  MaybePKMethods<RemoteModule, TableName>;
+
+/**
+ * Core methods of ClientTable, without the indexes mixed in.
+ * Includes only statically known methods.
+ *
+ * Event tables only expose insert callbacks (no delete or update),
+ * matching the Rust SDK's `EventTable` trait.
+ */
+export type ClientTableCore<
+  RemoteModule extends UntypedRemoteModule,
+  TableName extends TableNamesOf<RemoteModule>,
+> = ReadonlyTableMethods<TableDefForTableName<RemoteModule, TableName>> &
+  ClientTableInsertMethods<RemoteModule, TableName> &
+  (IsEventTable<TableDefForTableName<RemoteModule, TableName>> extends true
+    ? {}
+    : ClientTableDeleteMethods<RemoteModule, TableName> &
+        (HasPrimaryKey<
+          TableDefForTableName<RemoteModule, TableName>
+        > extends true
+          ? ClientTablePrimaryKeyMethods<RemoteModule, TableName>
+          : {}));