spacetimedb 2.5.0 → 2.6.0

package/src/solid/SpacetimeDBProvider.ts

@@ -1,97 +1,97 @@
-import {
-  DbConnectionBuilder,
-  type DbConnectionImpl,
-} from '../sdk/db_connection_impl';
-import { onCleanup, createMemo, createComputed } from 'solid-js';
-import { createStore } from 'solid-js/store';
-import { SpacetimeDBContext } from './useSpacetimeDB';
-import type { ConnectionState } from './connection_state';
-import { ConnectionId } from '../lib/connection_id';
-import {
-  ConnectionManager,
-  type ConnectionState as ManagerConnectionState,
-} from '../sdk/connection_manager';
-
-export interface SpacetimeDBProviderProps<
-  DbConnection extends DbConnectionImpl<any>,
-> {
-  connectionBuilder: DbConnectionBuilder<DbConnection>;
-  children?: any;
-}
-
-export function SpacetimeDBProvider<DbConnection extends DbConnectionImpl<any>>(
-  props: SpacetimeDBProviderProps<DbConnection>
-) {
-  const uri = () => props.connectionBuilder.getUri();
-  const moduleName = () => props.connectionBuilder.getModuleName();
-
-  const key = createMemo(() => ConnectionManager.getKey(uri(), moduleName()));
-
-  const fallbackState: ManagerConnectionState = {
-    isActive: false,
-    identity: undefined,
-    token: undefined,
-    connectionId: ConnectionId.random(),
-    connectionError: undefined,
-  };
-
-  const [state, setState] = createStore<ManagerConnectionState>(fallbackState);
-
-  // Subscribe to ConnectionManager state changes
-  createComputed(() => {
-    const currentKey = key();
-
-    const unsubscribe = ConnectionManager.subscribe(currentKey, () => {
-      const snapshot =
-        ConnectionManager.getSnapshot(currentKey) ?? fallbackState;
-      setState(snapshot);
-    });
-
-    // Load initial snapshot
-    const snapshot = ConnectionManager.getSnapshot(currentKey) ?? fallbackState;
-    setState(snapshot);
-
-    onCleanup(() => {
-      unsubscribe();
-    });
-  });
-
-  const getConnection = () =>
-    ConnectionManager.getConnection<DbConnection>(key());
-
-  const contextValue: ConnectionState = {
-    get isActive() {
-      return state.isActive;
-    },
-    get identity() {
-      return state.identity;
-    },
-    get token() {
-      return state.token;
-    },
-    get connectionId() {
-      return state.connectionId;
-    },
-    get connectionError() {
-      return state.connectionError;
-    },
-    getConnection,
-  };
-
-  // Retain / release lifecycle
-  createComputed(() => {
-    const currentKey = key();
-    ConnectionManager.retain(currentKey, props.connectionBuilder);
-
-    onCleanup(() => {
-      ConnectionManager.release(currentKey);
-    });
-  });
-
-  return SpacetimeDBContext.Provider({
-    value: contextValue,
-    get children() {
-      return props.children;
-    },
-  });
-}
+import {
+  DbConnectionBuilder,
+  type DbConnectionImpl,
+} from '../sdk/db_connection_impl';
+import { onCleanup, createMemo, createComputed } from 'solid-js';
+import { createStore } from 'solid-js/store';
+import { SpacetimeDBContext } from './useSpacetimeDB';
+import type { ConnectionState } from './connection_state';
+import { ConnectionId } from '../lib/connection_id';
+import {
+  ConnectionManager,
+  type ConnectionState as ManagerConnectionState,
+} from '../sdk/connection_manager';
+
+export interface SpacetimeDBProviderProps<
+  DbConnection extends DbConnectionImpl<any>,
+> {
+  connectionBuilder: DbConnectionBuilder<DbConnection>;
+  children?: any;
+}
+
+export function SpacetimeDBProvider<DbConnection extends DbConnectionImpl<any>>(
+  props: SpacetimeDBProviderProps<DbConnection>
+) {
+  const uri = () => props.connectionBuilder.getUri();
+  const moduleName = () => props.connectionBuilder.getModuleName();
+
+  const key = createMemo(() => ConnectionManager.getKey(uri(), moduleName()));
+
+  const fallbackState: ManagerConnectionState = {
+    isActive: false,
+    identity: undefined,
+    token: undefined,
+    connectionId: ConnectionId.random(),
+    connectionError: undefined,
+  };
+
+  const [state, setState] = createStore<ManagerConnectionState>(fallbackState);
+
+  // Subscribe to ConnectionManager state changes
+  createComputed(() => {
+    const currentKey = key();
+
+    const unsubscribe = ConnectionManager.subscribe(currentKey, () => {
+      const snapshot =
+        ConnectionManager.getSnapshot(currentKey) ?? fallbackState;
+      setState(snapshot);
+    });
+
+    // Load initial snapshot
+    const snapshot = ConnectionManager.getSnapshot(currentKey) ?? fallbackState;
+    setState(snapshot);
+
+    onCleanup(() => {
+      unsubscribe();
+    });
+  });
+
+  const getConnection = () =>
+    ConnectionManager.getConnection<DbConnection>(key());
+
+  const contextValue: ConnectionState = {
+    get isActive() {
+      return state.isActive;
+    },
+    get identity() {
+      return state.identity;
+    },
+    get token() {
+      return state.token;
+    },
+    get connectionId() {
+      return state.connectionId;
+    },
+    get connectionError() {
+      return state.connectionError;
+    },
+    getConnection,
+  };
+
+  // Retain / release lifecycle
+  createComputed(() => {
+    const currentKey = key();
+    ConnectionManager.retain(currentKey, props.connectionBuilder);
+
+    onCleanup(() => {
+      ConnectionManager.release(currentKey);
+    });
+  });
+
+  return SpacetimeDBContext.Provider({
+    value: contextValue,
+    get children() {
+      return props.children;
+    },
+  });
+}

package/src/solid/connection_state.ts

@@ -1,6 +1,6 @@
-import type { DbConnectionImpl } from '../sdk/db_connection_impl';
-import type { ConnectionState as ManagerConnectionState } from '../sdk/connection_manager';
-
-export type ConnectionState = ManagerConnectionState & {
-  getConnection(): DbConnectionImpl<any> | null;
-};
+import type { DbConnectionImpl } from '../sdk/db_connection_impl';
+import type { ConnectionState as ManagerConnectionState } from '../sdk/connection_manager';
+
+export type ConnectionState = ManagerConnectionState & {
+  getConnection(): DbConnectionImpl<any> | null;
+};

package/src/solid/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';

package/src/solid/useProcedure.ts

@@ -1,57 +1,57 @@
-import { createEffect } from 'solid-js';
-import type { UntypedProcedureDef } from '../sdk/procedures';
-import { useSpacetimeDB } from './useSpacetimeDB';
-import type {
-  ProcedureParamsType,
-  ProcedureReturnType,
-} from '../sdk/type_utils';
-
-export function useProcedure<ProcedureDef extends UntypedProcedureDef>(
-  procedureDef: ProcedureDef
-): (
-  ...params: ProcedureParamsType<ProcedureDef>
-) => Promise<ProcedureReturnType<ProcedureDef>> {
-  const { getConnection, isActive } = useSpacetimeDB();
-  const procedureName = procedureDef.accessorName;
-
-  // Holds calls made before the connection exists
-  const queue: {
-    params: ProcedureParamsType<ProcedureDef>;
-    resolve: (val: any) => void;
-    reject: (err: unknown) => void;
-  }[] = [];
-
-  // Flush when we finally have a connection
-  createEffect(() => {
-    if (!isActive) return;
-
-    const conn = getConnection();
-    if (!conn) return;
-
-    const fn = (conn.procedures as any)[procedureName] as (
-      ...p: ProcedureParamsType<ProcedureDef>
-    ) => Promise<ProcedureReturnType<ProcedureDef>>;
-
-    if (queue.length) {
-      const pending = queue.splice(0);
-      for (const item of pending) {
-        fn(...item.params).then(item.resolve, item.reject);
-      }
-    }
-  });
-
-  return (...params: ProcedureParamsType<ProcedureDef>) => {
-    const conn = getConnection();
-    if (!conn) {
-      return new Promise<ProcedureReturnType<ProcedureDef>>(
-        (resolve, reject) => {
-          queue.push({ params, resolve, reject });
-        }
-      );
-    }
-    const fn = (conn.procedures as any)[procedureName] as (
-      ...p: ProcedureParamsType<ProcedureDef>
-    ) => Promise<ProcedureReturnType<ProcedureDef>>;
-    return fn(...params);
-  };
-}
+import { createEffect } from 'solid-js';
+import type { UntypedProcedureDef } from '../sdk/procedures';
+import { useSpacetimeDB } from './useSpacetimeDB';
+import type {
+  ProcedureParamsType,
+  ProcedureReturnType,
+} from '../sdk/type_utils';
+
+export function useProcedure<ProcedureDef extends UntypedProcedureDef>(
+  procedureDef: ProcedureDef
+): (
+  ...params: ProcedureParamsType<ProcedureDef>
+) => Promise<ProcedureReturnType<ProcedureDef>> {
+  const { getConnection, isActive } = useSpacetimeDB();
+  const procedureName = procedureDef.accessorName;
+
+  // Holds calls made before the connection exists
+  const queue: {
+    params: ProcedureParamsType<ProcedureDef>;
+    resolve: (val: any) => void;
+    reject: (err: unknown) => void;
+  }[] = [];
+
+  // Flush when we finally have a connection
+  createEffect(() => {
+    if (!isActive) return;
+
+    const conn = getConnection();
+    if (!conn) return;
+
+    const fn = (conn.procedures as any)[procedureName] as (
+      ...p: ProcedureParamsType<ProcedureDef>
+    ) => Promise<ProcedureReturnType<ProcedureDef>>;
+
+    if (queue.length) {
+      const pending = queue.splice(0);
+      for (const item of pending) {
+        fn(...item.params).then(item.resolve, item.reject);
+      }
+    }
+  });
+
+  return (...params: ProcedureParamsType<ProcedureDef>) => {
+    const conn = getConnection();
+    if (!conn) {
+      return new Promise<ProcedureReturnType<ProcedureDef>>(
+        (resolve, reject) => {
+          queue.push({ params, resolve, reject });
+        }
+      );
+    }
+    const fn = (conn.procedures as any)[procedureName] as (
+      ...p: ProcedureParamsType<ProcedureDef>
+    ) => Promise<ProcedureReturnType<ProcedureDef>>;
+    return fn(...params);
+  };
+}

package/src/solid/useReducer.ts

@@ -1,50 +1,50 @@
-import { createEffect } from 'solid-js';
-import type { UntypedReducerDef } from '../sdk/reducers';
-import { useSpacetimeDB } from './useSpacetimeDB';
-import type { ParamsType } from '../sdk';
-
-export function useReducer<ReducerDef extends UntypedReducerDef>(
-  reducerDef: ReducerDef
-): (...params: ParamsType<ReducerDef>) => Promise<void> {
-  const { getConnection, isActive } = useSpacetimeDB();
-  const reducerName = reducerDef.accessorName;
-
-  // Holds calls made before the connection exists
-  const queue: {
-    params: ParamsType<ReducerDef>;
-    resolve: () => void;
-    reject: (err: unknown) => void;
-  }[] = [];
-
-  // Flush when we finally have a connection
-  createEffect(() => {
-    if (!isActive) return;
-
-    const conn = getConnection();
-    if (!conn) return;
-
-    const fn = (conn.reducers as any)[reducerName] as (
-      ...p: ParamsType<ReducerDef>
-    ) => Promise<void>;
-
-    if (queue.length) {
-      const pending = queue.splice(0);
-      for (const item of pending) {
-        fn(...item.params).then(item.resolve, item.reject);
-      }
-    }
-  });
-
-  return (...params: ParamsType<ReducerDef>) => {
-    const conn = getConnection();
-    if (!conn) {
-      return new Promise<void>((resolve, reject) => {
-        queue.push({ params, resolve, reject });
-      });
-    }
-    const fn = (conn.reducers as any)[reducerName] as (
-      ...p: ParamsType<ReducerDef>
-    ) => Promise<void>;
-    return fn(...params);
-  };
-}
+import { createEffect } from 'solid-js';
+import type { UntypedReducerDef } from '../sdk/reducers';
+import { useSpacetimeDB } from './useSpacetimeDB';
+import type { ParamsType } from '../sdk';
+
+export function useReducer<ReducerDef extends UntypedReducerDef>(
+  reducerDef: ReducerDef
+): (...params: ParamsType<ReducerDef>) => Promise<void> {
+  const { getConnection, isActive } = useSpacetimeDB();
+  const reducerName = reducerDef.accessorName;
+
+  // Holds calls made before the connection exists
+  const queue: {
+    params: ParamsType<ReducerDef>;
+    resolve: () => void;
+    reject: (err: unknown) => void;
+  }[] = [];
+
+  // Flush when we finally have a connection
+  createEffect(() => {
+    if (!isActive) return;
+
+    const conn = getConnection();
+    if (!conn) return;
+
+    const fn = (conn.reducers as any)[reducerName] as (
+      ...p: ParamsType<ReducerDef>
+    ) => Promise<void>;
+
+    if (queue.length) {
+      const pending = queue.splice(0);
+      for (const item of pending) {
+        fn(...item.params).then(item.resolve, item.reject);
+      }
+    }
+  });
+
+  return (...params: ParamsType<ReducerDef>) => {
+    const conn = getConnection();
+    if (!conn) {
+      return new Promise<void>((resolve, reject) => {
+        queue.push({ params, resolve, reject });
+      });
+    }
+    const fn = (conn.reducers as any)[reducerName] as (
+      ...p: ParamsType<ReducerDef>
+    ) => Promise<void>;
+    return fn(...params);
+  };
+}

package/src/solid/useSpacetimeDB.ts

@@ -1,18 +1,18 @@
-import { createContext, useContext } from 'solid-js';
-import type { ConnectionState } from './connection_state';
-
-export const SpacetimeDBContext = createContext<ConnectionState | undefined>(
-  undefined
-);
-
-// Throws an error if used outside of a SpacetimeDBProvider
-// Error is caught by other hooks like useTable so they can provide better error messages
-export function useSpacetimeDB(): ConnectionState {
-  const context = useContext(SpacetimeDBContext) as ConnectionState | undefined;
-  if (!context) {
-    throw new Error(
-      'useSpacetimeDB must be used within a SpacetimeDBProvider component. Did you forget to add a `SpacetimeDBProvider` to your component tree?'
-    );
-  }
-  return context;
-}
+import { createContext, useContext } from 'solid-js';
+import type { ConnectionState } from './connection_state';
+
+export const SpacetimeDBContext = createContext<ConnectionState | undefined>(
+  undefined
+);
+
+// Throws an error if used outside of a SpacetimeDBProvider
+// Error is caught by other hooks like useTable so they can provide better error messages
+export function useSpacetimeDB(): ConnectionState {
+  const context = useContext(SpacetimeDBContext) as ConnectionState | undefined;
+  if (!context) {
+    throw new Error(
+      'useSpacetimeDB must be used within a SpacetimeDBProvider component. Did you forget to add a `SpacetimeDBProvider` to your component tree?'
+    );
+  }
+  return context;
+}