Added some additional typing to the TS SDK (#3245)

# Description of Changes

This just constrains the types of rows from `any` to `Record<string,
any>`.

# API and ABI breaking changes

Not breaking, purely internal.

# Expected complexity level and risk

1

# Testing

- [x] Just the automated tests

Author: cloutiertyler

sdks/typescript/packages/sdk/src/client_cache.ts

@@ -5,7 +5,7 @@ export class ClientCache {
   /**
    * The tables in the database.
    */
-  tables: Map<string, TableCache>;
+  tables: Map<string, TableCache<any>>;
 
   constructor() {
     this.tables = new Map();
@@ -16,7 +16,9 @@ export class ClientCache {
    * @param name The name of the table.
    * @returns The table
    */
-  getTable(name: string): TableCache {
+  getTable<RowType extends Record<string, any>>(
+    name: string
+  ): TableCache<RowType> {
     const table = this.tables.get(name);
 
     // ! This should not happen as the table should be available but an exception is thrown just in case.
@@ -30,10 +32,10 @@ export class ClientCache {
     return table;
   }
 
-  getOrCreateTable<RowType>(
+  getOrCreateTable<RowType extends Record<string, any>>(
     tableTypeInfo: TableRuntimeTypeInfo
   ): TableCache<RowType> {
-    let table: TableCache;
+    let table: TableCache<RowType>;
     if (!this.tables.has(tableTypeInfo.tableName)) {
       table = new TableCache<RowType>(tableTypeInfo);
       this.tables.set(tableTypeInfo.tableName, table);

sdks/typescript/packages/sdk/src/db_connection_impl.ts

@@ -483,7 +483,9 @@ export class DbConnectionImpl<
         const parsedTableUpdates = await parseDatabaseUpdate(
           message.value.update
         );
-        const subscribeAppliedMessage: SubscribeAppliedMessage = {
+        const subscribeAppliedMessage: SubscribeAppliedMessage<
+          Record<string, any>
+        > = {
           tag: 'SubscribeApplied',
           queryId: message.value.queryId.id,
           tableUpdates: parsedTableUpdates,
@@ -495,7 +497,9 @@ export class DbConnectionImpl<
         const parsedTableUpdates = await parseDatabaseUpdate(
           message.value.update
         );
-        const unsubscribeAppliedMessage: UnsubscribeAppliedMessage = {
+        const unsubscribeAppliedMessage: UnsubscribeAppliedMessage<
+          Record<string, any>
+        > = {
           tag: 'UnsubscribeApplied',
           queryId: message.value.queryId.id,
           tableUpdates: parsedTableUpdates,

sdks/typescript/packages/sdk/src/message_types.ts

@@ -4,14 +4,14 @@ import { Identity } from 'spacetimedb';
 import type { TableUpdate } from './table_cache.ts';
 import { Timestamp } from 'spacetimedb';
 
-export type InitialSubscriptionMessage = {
+export type InitialSubscriptionMessage<RowType extends Record<string, any>> = {
   tag: 'InitialSubscription';
-  tableUpdates: TableUpdate[];
+  tableUpdates: TableUpdate<RowType>[];
 };
 
-export type TransactionUpdateMessage = {
+export type TransactionUpdateMessage<RowType extends Record<string, any>> = {
   tag: 'TransactionUpdate';
-  tableUpdates: TableUpdate[];
+  tableUpdates: TableUpdate<RowType>[];
   identity: Identity;
   connectionId: ConnectionId | null;
   reducerInfo?: {
@@ -24,10 +24,11 @@ export type TransactionUpdateMessage = {
   energyConsumed: bigint;
 };
 
-export type TransactionUpdateLightMessage = {
-  tag: 'TransactionUpdateLight';
-  tableUpdates: TableUpdate[];
-};
+export type TransactionUpdateLightMessage<RowType extends Record<string, any>> =
+  {
+    tag: 'TransactionUpdateLight';
+    tableUpdates: TableUpdate<RowType>[];
+  };
 
 export type IdentityTokenMessage = {
   tag: 'IdentityToken';
@@ -36,16 +37,16 @@ export type IdentityTokenMessage = {
   connectionId: ConnectionId;
 };
 
-export type SubscribeAppliedMessage = {
+export type SubscribeAppliedMessage<RowType extends Record<string, any>> = {
   tag: 'SubscribeApplied';
   queryId: number;
-  tableUpdates: TableUpdate[];
+  tableUpdates: TableUpdate<RowType>[];
 };
 
-export type UnsubscribeAppliedMessage = {
+export type UnsubscribeAppliedMessage<RowType extends Record<string, any>> = {
   tag: 'UnsubscribeApplied';
   queryId: number;
-  tableUpdates: TableUpdate[];
+  tableUpdates: TableUpdate<RowType>[];
 };
 
 export type SubscriptionError = {
@@ -54,11 +55,12 @@ export type SubscriptionError = {
   error: string;
 };
 
-export type Message =
-  | InitialSubscriptionMessage
-  | TransactionUpdateMessage
-  | TransactionUpdateLightMessage
-  | IdentityTokenMessage
-  | SubscribeAppliedMessage
-  | UnsubscribeAppliedMessage
-  | SubscriptionError;
+export type Message<RowType extends Record<string, any> = Record<string, any>> =
+
+    | InitialSubscriptionMessage<RowType>
+    | TransactionUpdateMessage<RowType>
+    | TransactionUpdateLightMessage<RowType>
+    | IdentityTokenMessage
+    | SubscribeAppliedMessage<RowType>
+    | UnsubscribeAppliedMessage<RowType>
+    | SubscriptionError;

sdks/typescript/packages/sdk/src/table_cache.ts

@@ -8,18 +8,21 @@ import {
 import { stdbLogger } from './logger.ts';
 import type { ComparablePrimitive } from 'spacetimedb';
 
-export type Operation = {
+export type Operation<
+  RowType extends Record<string, any> = Record<string, any>,
+> = {
   type: 'insert' | 'delete';
   // For tables with a primary key, this is the primary key value, as a primitive or string.
   // Otherwise, it is an encoding of the full row.
   rowId: ComparablePrimitive;
-  // TODO: Refine this type to at least reflect that it is a product.
-  row: any;
+  row: RowType;
 };
 
-export type TableUpdate = {
+export type TableUpdate<
+  RowType extends Record<string, any> = Record<string, any>,
+> = {
   tableName: string;
-  operations: Operation[];
+  operations: Operation<RowType>[];
 };
 
 export type PendingCallback = {
@@ -30,7 +33,9 @@ export type PendingCallback = {
 /**
  * Builder to generate calls to query a `table` in the database
  */
-export class TableCache<RowType = any> {
+export class TableCache<
+  RowType extends Record<string, any> = Record<string, any>,
+> {
   private rows: Map<ComparablePrimitive, [RowType, number]>;
   private tableTypeInfo: TableRuntimeTypeInfo;
   private emitter: EventEmitter<'insert' | 'delete' | 'update'>;
@@ -57,18 +62,24 @@ export class TableCache<RowType = any> {
   /**
    * @returns The values of the rows in the table
    */
-  iter(): any[] {
+  iter(): RowType[] {
     return Array.from(this.rows.values()).map(([row]) => row);
   }
 
   applyOperations = (
-    operations: Operation[],
+    operations: Operation<RowType>[],
     ctx: EventContextInterface
   ): PendingCallback[] => {
     const pendingCallbacks: PendingCallback[] = [];
     if (this.tableTypeInfo.primaryKeyInfo !== undefined) {
-      const insertMap = new Map<ComparablePrimitive, [Operation, number]>();
-      const deleteMap = new Map<ComparablePrimitive, [Operation, number]>();
+      const insertMap = new Map<
+        ComparablePrimitive,
+        [Operation<RowType>, number]
+      >();
+      const deleteMap = new Map<
+        ComparablePrimitive,
+        [Operation<RowType>, number]
+      >();
       for (const op of operations) {
         if (op.type === 'insert') {
           const [_, prevCount] = insertMap.get(op.rowId) || [op, 0];
@@ -177,7 +188,7 @@ export class TableCache<RowType = any> {
 
   insert = (
     ctx: EventContextInterface,
-    operation: Operation,
+    operation: Operation<RowType>,
     count: number = 1
   ): PendingCallback | undefined => {
     const [_, previousCount] = this.rows.get(operation.rowId) || [
@@ -200,7 +211,7 @@ export class TableCache<RowType = any> {
 
   delete = (
     ctx: EventContextInterface,
-    operation: Operation,
+    operation: Operation<RowType>,
     count: number = 1
   ): PendingCallback | undefined => {
     const [_, previousCount] = this.rows.get(operation.rowId) || [