spacetimedb 2.5.0 → 2.6.0

package/src/sdk/db_context.ts

@@ -1,28 +1,28 @@
-import type { ClientDbView } from './db_view';
-import type { ReducersView } from './reducers';
-import type { UntypedRemoteModule } from './spacetime_module';
-import type { SubscriptionBuilderImpl } from './subscription_builder_impl';
-
-/**
- * Interface representing a database context.
- *
- * @template DbView - Type representing the database view.
- * @template ReducersDef - Type representing the reducers.
- */
-export interface DbContext<RemoteModule extends UntypedRemoteModule> {
-  db: ClientDbView<RemoteModule>;
-  reducers: ReducersView<RemoteModule>;
-  isActive: boolean;
-
-  /**
-   * Creates a new subscription builder.
-   *
-   * @returns The subscription builder.
-   */
-  subscriptionBuilder(): SubscriptionBuilderImpl<RemoteModule>;
-
-  /**
-   * Disconnects from the database.
-   */
-  disconnect(): void;
-}
+import type { ClientDbView } from './db_view';
+import type { ReducersView } from './reducers';
+import type { UntypedRemoteModule } from './spacetime_module';
+import type { SubscriptionBuilderImpl } from './subscription_builder_impl';
+
+/**
+ * Interface representing a database context.
+ *
+ * @template DbView - Type representing the database view.
+ * @template ReducersDef - Type representing the reducers.
+ */
+export interface DbContext<RemoteModule extends UntypedRemoteModule> {
+  db: ClientDbView<RemoteModule>;
+  reducers: ReducersView<RemoteModule>;
+  isActive: boolean;
+
+  /**
+   * Creates a new subscription builder.
+   *
+   * @returns The subscription builder.
+   */
+  subscriptionBuilder(): SubscriptionBuilderImpl<RemoteModule>;
+
+  /**
+   * Disconnects from the database.
+   */
+  disconnect(): void;
+}

package/src/sdk/db_view.ts

@@ -1,12 +1,12 @@
-import type { UntypedRemoteModule } from './spacetime_module';
-import type { ClientTable } from './client_table';
-import type { Values } from '../lib/type_util';
-
-/**
- * A type representing a client-side database view, mapping table names to their corresponding client Table handles.
- */
-export type ClientDbView<RemoteModule extends UntypedRemoteModule> = {
-  readonly [TblName in Values<
-    RemoteModule['tables']
-  >['accessorName']]: ClientTable<RemoteModule, TblName>;
-};
+import type { UntypedRemoteModule } from './spacetime_module';
+import type { ClientTable } from './client_table';
+import type { Values } from '../lib/type_util';
+
+/**
+ * A type representing a client-side database view, mapping table names to their corresponding client Table handles.
+ */
+export type ClientDbView<RemoteModule extends UntypedRemoteModule> = {
+  readonly [TblName in Values<
+    RemoteModule['tables']
+  >['accessorName']]: ClientTable<RemoteModule, TblName>;
+};

package/src/sdk/decompress.ts

@@ -1,51 +1,51 @@
-export async function decompress(
-  buffer: Uint8Array<ArrayBuffer>,
-  type: CompressionFormat,
-  chunkSize: number = 128 * 1024 // 128KB
-): Promise<Uint8Array> {
-  // Create a single ReadableStream to handle chunks
-  let offset = 0;
-  const readableStream = new ReadableStream<BufferSource>({
-    pull(controller) {
-      if (offset < buffer.length) {
-        // Slice a chunk of the buffer and enqueue it
-        const chunk = buffer.subarray(
-          offset,
-          Math.min(offset + chunkSize, buffer.length)
-        );
-        controller.enqueue(chunk);
-        offset += chunkSize;
-      } else {
-        controller.close();
-      }
-    },
-  });
-
-  // Create a single DecompressionStream
-  const decompressionStream = new DecompressionStream(type);
-
-  // Pipe the ReadableStream through the DecompressionStream
-  const decompressedStream = readableStream.pipeThrough(decompressionStream);
-
-  // Collect the decompressed chunks efficiently
-  const reader = decompressedStream.getReader();
-  const chunks: Uint8Array[] = [];
-  let totalLength = 0;
-  let result: any;
-
-  while (!(result = await reader.read()).done) {
-    chunks.push(result.value);
-    totalLength += result.value.length;
-  }
-
-  // Allocate a single Uint8Array for the decompressed data
-  const decompressedArray = new Uint8Array(totalLength);
-  let chunkOffset = 0;
-
-  for (const chunk of chunks) {
-    decompressedArray.set(chunk, chunkOffset);
-    chunkOffset += chunk.length;
-  }
-
-  return decompressedArray;
-}
+export async function decompress(
+  buffer: Uint8Array<ArrayBuffer>,
+  type: CompressionFormat,
+  chunkSize: number = 128 * 1024 // 128KB
+): Promise<Uint8Array> {
+  // Create a single ReadableStream to handle chunks
+  let offset = 0;
+  const readableStream = new ReadableStream<BufferSource>({
+    pull(controller) {
+      if (offset < buffer.length) {
+        // Slice a chunk of the buffer and enqueue it
+        const chunk = buffer.subarray(
+          offset,
+          Math.min(offset + chunkSize, buffer.length)
+        );
+        controller.enqueue(chunk);
+        offset += chunkSize;
+      } else {
+        controller.close();
+      }
+    },
+  });
+
+  // Create a single DecompressionStream
+  const decompressionStream = new DecompressionStream(type);
+
+  // Pipe the ReadableStream through the DecompressionStream
+  const decompressedStream = readableStream.pipeThrough(decompressionStream);
+
+  // Collect the decompressed chunks efficiently
+  const reader = decompressedStream.getReader();
+  const chunks: Uint8Array[] = [];
+  let totalLength = 0;
+  let result: any;
+
+  while (!(result = await reader.read()).done) {
+    chunks.push(result.value);
+    totalLength += result.value.length;
+  }
+
+  // Allocate a single Uint8Array for the decompressed data
+  const decompressedArray = new Uint8Array(totalLength);
+  let chunkOffset = 0;
+
+  for (const chunk of chunks) {
+    decompressedArray.set(chunk, chunkOffset);
+    chunkOffset += chunk.length;
+  }
+
+  return decompressedArray;
+}

package/src/sdk/event.ts

@@ -1,18 +1,18 @@
-import type { ReducerEvent } from './reducer_event';
-import type { ReducerEventInfo } from './reducers';
-
-type WithId = {
-  /**
-   * A client-generated id to distinguish between different events.
-   */
-  id: string;
-};
-
-export type Event<Reducer extends ReducerEventInfo> = WithId &
-  (
-    | { tag: 'Reducer'; value: ReducerEvent<Reducer> }
-    | { tag: 'SubscribeApplied' }
-    | { tag: 'UnsubscribeApplied' }
-    | { tag: 'Error'; value: Error }
-    | { tag: 'Transaction' }
-  );
+import type { ReducerEvent } from './reducer_event';
+import type { ReducerEventInfo } from './reducers';
+
+type WithId = {
+  /**
+   * A client-generated id to distinguish between different events.
+   */
+  id: string;
+};
+
+export type Event<Reducer extends ReducerEventInfo> = WithId &
+  (
+    | { tag: 'Reducer'; value: ReducerEvent<Reducer> }
+    | { tag: 'SubscribeApplied' }
+    | { tag: 'UnsubscribeApplied' }
+    | { tag: 'Error'; value: Error }
+    | { tag: 'Transaction' }
+  );

package/src/sdk/event_context.ts

@@ -1,51 +1,51 @@
-import type { InferTypeOfRow } from '../lib/type_builders.ts';
-import type { DbContext } from './db_context';
-import type { Event } from './event.ts';
-import type { ReducerEvent } from './reducer_event.ts';
-import type { ReducerEventInfo } from './reducers.ts';
-import type { UntypedRemoteModule } from './spacetime_module.ts';
-
-export type UntypedEventContext = EventContextInterface<UntypedRemoteModule>;
-
-export interface EventContextInterface<RemoteModule extends UntypedRemoteModule>
-  extends DbContext<RemoteModule> {
-  /** Enum with variants for all possible events. */
-  event: Event<
-    ReducerEventInfo<
-      RemoteModule['reducers'][number]['name'],
-      InferTypeOfRow<RemoteModule['reducers'][number]['params']>
-    >
-  >;
-}
-
-export interface ReducerEventContextInterface<
-  RemoteModule extends UntypedRemoteModule,
-> extends DbContext<RemoteModule> {
-  /** Enum with variants for all possible events. */
-  event: ReducerEvent<
-    ReducerEventInfo<
-      RemoteModule['reducers'][number]['name'],
-      InferTypeOfRow<RemoteModule['reducers'][number]['params']>
-    >
-  >;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface ProcedureEventContextInterface<
-  RemoteModule extends UntypedRemoteModule,
-> extends DbContext<RemoteModule> {
-  /** No event is provided */
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface SubscriptionEventContextInterface<
-  RemoteModule extends UntypedRemoteModule,
-> extends DbContext<RemoteModule> {
-  /** No event is provided **/
-}
-
-export interface ErrorContextInterface<RemoteModule extends UntypedRemoteModule>
-  extends DbContext<RemoteModule> {
-  /** Enum with variants for all possible events. */
-  event?: Error;
-}
+import type { InferTypeOfRow } from '../lib/type_builders.ts';
+import type { DbContext } from './db_context';
+import type { Event } from './event.ts';
+import type { ReducerEvent } from './reducer_event.ts';
+import type { ReducerEventInfo } from './reducers.ts';
+import type { UntypedRemoteModule } from './spacetime_module.ts';
+
+export type UntypedEventContext = EventContextInterface<UntypedRemoteModule>;
+
+export interface EventContextInterface<RemoteModule extends UntypedRemoteModule>
+  extends DbContext<RemoteModule> {
+  /** Enum with variants for all possible events. */
+  event: Event<
+    ReducerEventInfo<
+      RemoteModule['reducers'][number]['name'],
+      InferTypeOfRow<RemoteModule['reducers'][number]['params']>
+    >
+  >;
+}
+
+export interface ReducerEventContextInterface<
+  RemoteModule extends UntypedRemoteModule,
+> extends DbContext<RemoteModule> {
+  /** Enum with variants for all possible events. */
+  event: ReducerEvent<
+    ReducerEventInfo<
+      RemoteModule['reducers'][number]['name'],
+      InferTypeOfRow<RemoteModule['reducers'][number]['params']>
+    >
+  >;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface ProcedureEventContextInterface<
+  RemoteModule extends UntypedRemoteModule,
+> extends DbContext<RemoteModule> {
+  /** No event is provided */
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface SubscriptionEventContextInterface<
+  RemoteModule extends UntypedRemoteModule,
+> extends DbContext<RemoteModule> {
+  /** No event is provided **/
+}
+
+export interface ErrorContextInterface<RemoteModule extends UntypedRemoteModule>
+  extends DbContext<RemoteModule> {
+  /** Enum with variants for all possible events. */
+  event?: Error;
+}

package/src/sdk/event_emitter.ts

@@ -1,32 +1,32 @@
-// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-export class EventEmitter<Key, Callback extends Function = Function> {
-  #events: Map<Key, Set<Callback>> = new Map();
-
-  on(event: Key, callback: Callback): void {
-    let callbacks = this.#events.get(event);
-    if (!callbacks) {
-      callbacks = new Set();
-      this.#events.set(event, callbacks);
-    }
-    callbacks.add(callback);
-  }
-
-  off(event: Key, callback: Callback): void {
-    const callbacks = this.#events.get(event);
-    if (!callbacks) {
-      return;
-    }
-    callbacks.delete(callback);
-  }
-
-  emit(event: Key, ...args: any[]): void {
-    const callbacks = this.#events.get(event);
-    if (!callbacks) {
-      return;
-    }
-
-    for (const callback of callbacks) {
-      callback(...args);
-    }
-  }
-}
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+export class EventEmitter<Key, Callback extends Function = Function> {
+  #events: Map<Key, Set<Callback>> = new Map();
+
+  on(event: Key, callback: Callback): void {
+    let callbacks = this.#events.get(event);
+    if (!callbacks) {
+      callbacks = new Set();
+      this.#events.set(event, callbacks);
+    }
+    callbacks.add(callback);
+  }
+
+  off(event: Key, callback: Callback): void {
+    const callbacks = this.#events.get(event);
+    if (!callbacks) {
+      return;
+    }
+    callbacks.delete(callback);
+  }
+
+  emit(event: Key, ...args: any[]): void {
+    const callbacks = this.#events.get(event);
+    if (!callbacks) {
+      return;
+    }
+
+    for (const callback of callbacks) {
+      callback(...args);
+    }
+  }
+}

package/src/sdk/index.ts

@@ -1,14 +1,14 @@
-// Should be at the top as other modules depend on it
-export * from './db_connection_impl.ts';
-export * from './client_cache.ts';
-export * from './message_types.ts';
-export * from '../lib/errors.ts';
-export * from './logger.ts';
-export { type ClientTable } from './client_table.ts';
-export { type RemoteModule } from './spacetime_module.ts';
-export * from '../lib/type_builders.ts';
-export { schema, convertToAccessorMap } from './schema.ts';
-export { table } from '../lib/table.ts';
-export { reducerSchema, reducers } from './reducers.ts';
-export { procedureSchema, procedures } from './procedures.ts';
-export * from './type_utils.ts';
+// Should be at the top as other modules depend on it
+export * from './db_connection_impl.ts';
+export * from './client_cache.ts';
+export * from './message_types.ts';
+export * from '../lib/errors.ts';
+export * from './logger.ts';
+export { type ClientTable } from './client_table.ts';
+export { type RemoteModule } from './spacetime_module.ts';
+export * from '../lib/type_builders.ts';
+export { schema, convertToAccessorMap } from './schema.ts';
+export { table } from '../lib/table.ts';
+export { reducerSchema, reducers } from './reducers.ts';
+export { procedureSchema, procedures } from './procedures.ts';
+export * from './type_utils.ts';

package/src/sdk/internal.ts

@@ -1,2 +1,2 @@
-// Internal symbols not exported from the public SDK surface.
-export const INTERNAL_REMOTE_MODULE = Symbol('INTERNAL_REMOTE_MODULE');
+// Internal symbols not exported from the public SDK surface.
+export const INTERNAL_REMOTE_MODULE = Symbol('INTERNAL_REMOTE_MODULE');

package/src/sdk/json_api.ts

@@ -1,46 +1,46 @@
-export interface Message {
-  IdentityToken?: IdentityToken | undefined;
-  SubscriptionUpdate?: SubscriptionUpdate | undefined;
-  TransactionUpdate?: TransactionUpdate | undefined;
-}
-
-export interface IdentityToken {
-  identity: string;
-  token: string;
-  address: string;
-}
-
-export interface SubscriptionUpdate {
-  table_updates: TableUpdate[];
-}
-
-export interface TableUpdate {
-  table_id: number;
-  table_name: string;
-  table_row_operations: TableRowOperation[];
-}
-
-export interface TableRowOperation {
-  op: 'insert' | 'delete';
-  row: any[];
-}
-
-export interface TransactionUpdate {
-  event: Event;
-  subscription_update: SubscriptionUpdate;
-}
-
-export interface Event {
-  timestamp: number;
-  status: 'committed' | 'failed' | 'out_of_energy';
-  caller_identity: string;
-  caller_address: string;
-  function_call: FunctionCall;
-  energy_quanta_used: number;
-  message: string;
-}
-
-export interface FunctionCall {
-  reducer: string;
-  args: string;
-}
+export interface Message {
+  IdentityToken?: IdentityToken | undefined;
+  SubscriptionUpdate?: SubscriptionUpdate | undefined;
+  TransactionUpdate?: TransactionUpdate | undefined;
+}
+
+export interface IdentityToken {
+  identity: string;
+  token: string;
+  address: string;
+}
+
+export interface SubscriptionUpdate {
+  table_updates: TableUpdate[];
+}
+
+export interface TableUpdate {
+  table_id: number;
+  table_name: string;
+  table_row_operations: TableRowOperation[];
+}
+
+export interface TableRowOperation {
+  op: 'insert' | 'delete';
+  row: any[];
+}
+
+export interface TransactionUpdate {
+  event: Event;
+  subscription_update: SubscriptionUpdate;
+}
+
+export interface Event {
+  timestamp: number;
+  status: 'committed' | 'failed' | 'out_of_energy';
+  caller_identity: string;
+  caller_address: string;
+  function_call: FunctionCall;
+  energy_quanta_used: number;
+  message: string;
+}
+
+export interface FunctionCall {
+  reducer: string;
+  args: string;
+}