spacetimedb 2.5.0 → 2.6.0

package/src/tanstack/hooks.ts

@@ -1,83 +1,83 @@
-import { useQuery, useSuspenseQuery } from '@tanstack/react-query';
-import type {
-  UseQueryOptions,
-  UseQueryResult,
-  UseSuspenseQueryOptions,
-  UseSuspenseQueryResult,
-} from '@tanstack/react-query';
-import type { UntypedTableDef, RowType } from '../lib/table';
-import type { Query } from '../lib/query';
-import { spacetimeDBQuery } from './SpacetimeDBQueryClient';
-
-export type UseSpacetimeDBQueryResult<T> = [
-  T[],
-  boolean,
-  UseQueryResult<T[], Error>,
-];
-
-export type UseSpacetimeDBSuspenseQueryResult<T> = [
-  T[],
-  false,
-  UseSuspenseQueryResult<T[], Error>,
-];
-
-// Wraps TanStack Query useQuery and returns [data, loading, query]
-// pass 'skip' as the second argument to set enabled: false, disabling the query
-// until a condition is met
-//
-// Usage:
-//   useSpacetimeDBQuery(tables.person)
-//   useSpacetimeDBQuery(tables.user.where(r => r.online.eq(true)))
-//   useSpacetimeDBQuery(condition ? tables.user : 'skip')
-export function useSpacetimeDBQuery<TableDef extends UntypedTableDef>(
-  queryOrSkip: Query<TableDef> | 'skip',
-  // any useQuery option (e.g. enabled, refetchInterval, select, placeholderData),
-  // except queryKey, queryFn, and meta (managed internally)
-  options?: Omit<
-    UseQueryOptions<
-      RowType<TableDef>[],
-      Error,
-      RowType<TableDef>[],
-      readonly ['spacetimedb', string, string]
-    >,
-    'queryKey' | 'queryFn' | 'meta'
-  >
-): UseSpacetimeDBQueryResult<RowType<TableDef>> {
-  const queryOptions =
-    queryOrSkip === 'skip'
-      ? spacetimeDBQuery('skip')
-      : spacetimeDBQuery(queryOrSkip);
-
-  const query = useQuery({
-    ...queryOptions,
-    ...options,
-  } as UseQueryOptions<RowType<TableDef>[], Error>);
-
-  return [query.data ?? [], query.isPending, query];
-}
-
-// Suspense version of useSpacetimeDBQuery, returns [data, false, query] tuple (loading = false)
-// Instead of returning a loading boolean, this hook suspends the component
-// until data is ready, a parent <Suspense fallback={…}> handles the loading UI.
-// does not support 'skip' because useSuspenseQuery must always resolve
-export function useSpacetimeDBSuspenseQuery<TableDef extends UntypedTableDef>(
-  query: Query<TableDef>,
-  options?: Omit<
-    UseSuspenseQueryOptions<
-      RowType<TableDef>[],
-      Error,
-      RowType<TableDef>[],
-      readonly ['spacetimedb', string, string]
-    >,
-    'queryKey' | 'queryFn' | 'meta'
-  >
-): UseSpacetimeDBSuspenseQueryResult<RowType<TableDef>> {
-  const queryOptions = spacetimeDBQuery(query);
-
-  const q = useSuspenseQuery({
-    ...queryOptions,
-    ...options,
-  } as UseSuspenseQueryOptions<RowType<TableDef>[], Error>);
-
-  return [q.data, false, q];
-}
+import { useQuery, useSuspenseQuery } from '@tanstack/react-query';
+import type {
+  UseQueryOptions,
+  UseQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult,
+} from '@tanstack/react-query';
+import type { UntypedTableDef, RowType } from '../lib/table';
+import type { Query } from '../lib/query';
+import { spacetimeDBQuery } from './SpacetimeDBQueryClient';
+
+export type UseSpacetimeDBQueryResult<T> = [
+  T[],
+  boolean,
+  UseQueryResult<T[], Error>,
+];
+
+export type UseSpacetimeDBSuspenseQueryResult<T> = [
+  T[],
+  false,
+  UseSuspenseQueryResult<T[], Error>,
+];
+
+// Wraps TanStack Query useQuery and returns [data, loading, query]
+// pass 'skip' as the second argument to set enabled: false, disabling the query
+// until a condition is met
+//
+// Usage:
+//   useSpacetimeDBQuery(tables.person)
+//   useSpacetimeDBQuery(tables.user.where(r => r.online.eq(true)))
+//   useSpacetimeDBQuery(condition ? tables.user : 'skip')
+export function useSpacetimeDBQuery<TableDef extends UntypedTableDef>(
+  queryOrSkip: Query<TableDef> | 'skip',
+  // any useQuery option (e.g. enabled, refetchInterval, select, placeholderData),
+  // except queryKey, queryFn, and meta (managed internally)
+  options?: Omit<
+    UseQueryOptions<
+      RowType<TableDef>[],
+      Error,
+      RowType<TableDef>[],
+      readonly ['spacetimedb', string, string]
+    >,
+    'queryKey' | 'queryFn' | 'meta'
+  >
+): UseSpacetimeDBQueryResult<RowType<TableDef>> {
+  const queryOptions =
+    queryOrSkip === 'skip'
+      ? spacetimeDBQuery('skip')
+      : spacetimeDBQuery(queryOrSkip);
+
+  const query = useQuery({
+    ...queryOptions,
+    ...options,
+  } as UseQueryOptions<RowType<TableDef>[], Error>);
+
+  return [query.data ?? [], query.isPending, query];
+}
+
+// Suspense version of useSpacetimeDBQuery, returns [data, false, query] tuple (loading = false)
+// Instead of returning a loading boolean, this hook suspends the component
+// until data is ready, a parent <Suspense fallback={…}> handles the loading UI.
+// does not support 'skip' because useSuspenseQuery must always resolve
+export function useSpacetimeDBSuspenseQuery<TableDef extends UntypedTableDef>(
+  query: Query<TableDef>,
+  options?: Omit<
+    UseSuspenseQueryOptions<
+      RowType<TableDef>[],
+      Error,
+      RowType<TableDef>[],
+      readonly ['spacetimedb', string, string]
+    >,
+    'queryKey' | 'queryFn' | 'meta'
+  >
+): UseSpacetimeDBSuspenseQueryResult<RowType<TableDef>> {
+  const queryOptions = spacetimeDBQuery(query);
+
+  const q = useSuspenseQuery({
+    ...queryOptions,
+    ...options,
+  } as UseSuspenseQueryOptions<RowType<TableDef>[], Error>);
+
+  return [q.data, false, q];
+}

package/src/tanstack/index.ts

@@ -1,16 +1,16 @@
-export {
-  SpacetimeDBQueryClient,
-  spacetimeDBQuery,
-  type SpacetimeDBQueryOptions,
-  type SpacetimeDBQueryOptionsSkipped,
-} from './SpacetimeDBQueryClient';
-export {
-  useSpacetimeDBQuery,
-  useSpacetimeDBSuspenseQuery,
-  type UseSpacetimeDBQueryResult,
-  type UseSpacetimeDBSuspenseQueryResult,
-} from './hooks';
-export * from '../react/SpacetimeDBProvider';
-export { useSpacetimeDB } from '../react/useSpacetimeDB';
-export { useReducer } from '../react/useReducer';
-export { useProcedure } from '../react/useProcedure';
+export {
+  SpacetimeDBQueryClient,
+  spacetimeDBQuery,
+  type SpacetimeDBQueryOptions,
+  type SpacetimeDBQueryOptionsSkipped,
+} from './SpacetimeDBQueryClient';
+export {
+  useSpacetimeDBQuery,
+  useSpacetimeDBSuspenseQuery,
+  type UseSpacetimeDBQueryResult,
+  type UseSpacetimeDBSuspenseQueryResult,
+} from './hooks';
+export * from '../react/SpacetimeDBProvider';
+export { useSpacetimeDB } from '../react/useSpacetimeDB';
+export { useReducer } from '../react/useReducer';
+export { useProcedure } from '../react/useProcedure';

package/src/util-stub.ts

@@ -1 +1 @@
-export const inspect = {};
+export const inspect = {};

package/src/vue/SpacetimeDBProvider.ts

@@ -1,157 +1,157 @@
-import {
-  defineComponent,
-  onMounted,
-  onUnmounted,
-  provide,
-  reactive,
-  type PropType,
-  type Slot,
-} from 'vue';
-import {
-  DbConnectionBuilder,
-  type DbConnectionImpl,
-  type ErrorContextInterface,
-  type RemoteModuleOf,
-} from '../sdk/db_connection_impl';
-import { ConnectionId } from '../lib/connection_id';
-import {
-  SPACETIMEDB_INJECTION_KEY,
-  type ConnectionState,
-} from './connection_state';
-
-export interface SpacetimeDBProviderProps<
-  DbConnection extends DbConnectionImpl<any>,
-> {
-  connectionBuilder: DbConnectionBuilder<DbConnection>;
-}
-
-let connRef: DbConnectionImpl<any> | null = null;
-let cleanupTimeoutId: ReturnType<typeof setTimeout> | null = null;
-
-function setupConnection<DbConnection extends DbConnectionImpl<any>>(
-  connectionBuilder: DbConnectionBuilder<DbConnection>
-): {
-  state: ConnectionState;
-  cleanup: () => void;
-} {
-  const getConnection = <T extends DbConnectionImpl<any>>() =>
-    connRef as T | null;
-
-  const state = reactive<ConnectionState>({
-    isActive: false,
-    identity: undefined,
-    token: undefined,
-    connectionId: ConnectionId.random(),
-    connectionError: undefined,
-    getConnection,
-  });
-
-  provide(SPACETIMEDB_INJECTION_KEY, state);
-
-  let onConnectCallback: ((conn: DbConnection) => void) | null = null;
-  let onDisconnectCallback:
-    | ((ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>) => void)
-    | null = null;
-  let onConnectErrorCallback:
-    | ((
-        ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>,
-        err: Error
-      ) => void)
-    | null = null;
-
-  onMounted(() => {
-    if (cleanupTimeoutId) {
-      clearTimeout(cleanupTimeoutId);
-      cleanupTimeoutId = null;
-    }
-
-    if (!connRef) {
-      connRef = connectionBuilder.build();
-    }
-
-    onConnectCallback = (conn: DbConnection) => {
-      state.isActive = conn.isActive;
-      state.identity = conn.identity;
-      state.token = conn.token;
-      state.connectionId = conn.connectionId;
-      state.connectionError = undefined;
-    };
-
-    onDisconnectCallback = (
-      ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>
-    ) => {
-      state.isActive = ctx.isActive;
-    };
-
-    onConnectErrorCallback = (
-      ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>,
-      err: Error
-    ) => {
-      state.isActive = ctx.isActive;
-      state.connectionError = err;
-    };
-
-    connectionBuilder.onConnect(onConnectCallback);
-    connectionBuilder.onDisconnect(onDisconnectCallback);
-    connectionBuilder.onConnectError(onConnectErrorCallback);
-
-    const conn = connRef;
-    if (conn) {
-      state.isActive = conn.isActive;
-      state.identity = conn.identity;
-      state.token = conn.token;
-      state.connectionId = conn.connectionId;
-    }
-  });
-
-  const cleanup = () => {
-    if (connRef) {
-      if (onConnectCallback) {
-        connRef.removeOnConnect?.(onConnectCallback as any);
-      }
-      if (onDisconnectCallback) {
-        connRef.removeOnDisconnect?.(onDisconnectCallback as any);
-      }
-      if (onConnectErrorCallback) {
-        connRef.removeOnConnectError?.(onConnectErrorCallback as any);
-      }
-
-      cleanupTimeoutId = setTimeout(() => {
-        connRef?.disconnect();
-        connRef = null;
-        cleanupTimeoutId = null;
-      }, 0);
-    }
-  };
-
-  onUnmounted(cleanup);
-
-  return { state, cleanup };
-}
-
-export const SpacetimeDBProvider = defineComponent({
-  name: 'SpacetimeDBProvider',
-
-  props: {
-    connectionBuilder: {
-      type: Object as PropType<DbConnectionBuilder<any>>,
-      required: true,
-    },
-  },
-
-  setup(props, { slots }) {
-    setupConnection(props.connectionBuilder);
-
-    return () => {
-      const defaultSlot = slots.default as Slot | undefined;
-      return defaultSlot ? defaultSlot() : null;
-    };
-  },
-});
-
-export function useSpacetimeDBProvider<
-  DbConnection extends DbConnectionImpl<any>,
->(connectionBuilder: DbConnectionBuilder<DbConnection>): ConnectionState {
-  const { state } = setupConnection(connectionBuilder);
-  return state;
-}
+import {
+  defineComponent,
+  onMounted,
+  onUnmounted,
+  provide,
+  reactive,
+  type PropType,
+  type Slot,
+} from 'vue';
+import {
+  DbConnectionBuilder,
+  type DbConnectionImpl,
+  type ErrorContextInterface,
+  type RemoteModuleOf,
+} from '../sdk/db_connection_impl';
+import { ConnectionId } from '../lib/connection_id';
+import {
+  SPACETIMEDB_INJECTION_KEY,
+  type ConnectionState,
+} from './connection_state';
+
+export interface SpacetimeDBProviderProps<
+  DbConnection extends DbConnectionImpl<any>,
+> {
+  connectionBuilder: DbConnectionBuilder<DbConnection>;
+}
+
+let connRef: DbConnectionImpl<any> | null = null;
+let cleanupTimeoutId: ReturnType<typeof setTimeout> | null = null;
+
+function setupConnection<DbConnection extends DbConnectionImpl<any>>(
+  connectionBuilder: DbConnectionBuilder<DbConnection>
+): {
+  state: ConnectionState;
+  cleanup: () => void;
+} {
+  const getConnection = <T extends DbConnectionImpl<any>>() =>
+    connRef as T | null;
+
+  const state = reactive<ConnectionState>({
+    isActive: false,
+    identity: undefined,
+    token: undefined,
+    connectionId: ConnectionId.random(),
+    connectionError: undefined,
+    getConnection,
+  });
+
+  provide(SPACETIMEDB_INJECTION_KEY, state);
+
+  let onConnectCallback: ((conn: DbConnection) => void) | null = null;
+  let onDisconnectCallback:
+    | ((ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>) => void)
+    | null = null;
+  let onConnectErrorCallback:
+    | ((
+        ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>,
+        err: Error
+      ) => void)
+    | null = null;
+
+  onMounted(() => {
+    if (cleanupTimeoutId) {
+      clearTimeout(cleanupTimeoutId);
+      cleanupTimeoutId = null;
+    }
+
+    if (!connRef) {
+      connRef = connectionBuilder.build();
+    }
+
+    onConnectCallback = (conn: DbConnection) => {
+      state.isActive = conn.isActive;
+      state.identity = conn.identity;
+      state.token = conn.token;
+      state.connectionId = conn.connectionId;
+      state.connectionError = undefined;
+    };
+
+    onDisconnectCallback = (
+      ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>
+    ) => {
+      state.isActive = ctx.isActive;
+    };
+
+    onConnectErrorCallback = (
+      ctx: ErrorContextInterface<RemoteModuleOf<DbConnection>>,
+      err: Error
+    ) => {
+      state.isActive = ctx.isActive;
+      state.connectionError = err;
+    };
+
+    connectionBuilder.onConnect(onConnectCallback);
+    connectionBuilder.onDisconnect(onDisconnectCallback);
+    connectionBuilder.onConnectError(onConnectErrorCallback);
+
+    const conn = connRef;
+    if (conn) {
+      state.isActive = conn.isActive;
+      state.identity = conn.identity;
+      state.token = conn.token;
+      state.connectionId = conn.connectionId;
+    }
+  });
+
+  const cleanup = () => {
+    if (connRef) {
+      if (onConnectCallback) {
+        connRef.removeOnConnect?.(onConnectCallback as any);
+      }
+      if (onDisconnectCallback) {
+        connRef.removeOnDisconnect?.(onDisconnectCallback as any);
+      }
+      if (onConnectErrorCallback) {
+        connRef.removeOnConnectError?.(onConnectErrorCallback as any);
+      }
+
+      cleanupTimeoutId = setTimeout(() => {
+        connRef?.disconnect();
+        connRef = null;
+        cleanupTimeoutId = null;
+      }, 0);
+    }
+  };
+
+  onUnmounted(cleanup);
+
+  return { state, cleanup };
+}
+
+export const SpacetimeDBProvider = defineComponent({
+  name: 'SpacetimeDBProvider',
+
+  props: {
+    connectionBuilder: {
+      type: Object as PropType<DbConnectionBuilder<any>>,
+      required: true,
+    },
+  },
+
+  setup(props, { slots }) {
+    setupConnection(props.connectionBuilder);
+
+    return () => {
+      const defaultSlot = slots.default as Slot | undefined;
+      return defaultSlot ? defaultSlot() : null;
+    };
+  },
+});
+
+export function useSpacetimeDBProvider<
+  DbConnection extends DbConnectionImpl<any>,
+>(connectionBuilder: DbConnectionBuilder<DbConnection>): ConnectionState {
+  const { state } = setupConnection(connectionBuilder);
+  return state;
+}

package/src/vue/connection_state.ts

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

package/src/vue/index.ts

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