@instantdb/react-common 0.22.15-experimental.react-common.18536829600.1

package/dist/esm/InstantReactAbstractDatabase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstantReactAbstractDatabase.js","sourceRoot":"","sources":["../../src/InstantReactAbstractDatabase.tsx"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAIL,MAAM,EAWN,IAAI,IAAI,SAAS,EAMjB,YAAY,GAEb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAEL,WAAW,EACX,SAAS,EACT,MAAM,EACN,QAAQ,EACR,oBAAoB,GACrB,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAEhE,MAAM,gBAAgB,GAAG;IACvB,SAAS,EAAE,IAAI;IACf,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,SAAS;CACjB,CAAC;AAEF,MAAM,CAAC,OAAO,OAAgB,4BAA4B;IAoBxD,YAAY,MAAc,EAAE,QAAoC;QAbzD,OAAE,GAAG,MAAM,EAAU,CAAC;QA6B7B;;;;;;;;WAQG;QACH,eAAU,GAAG,CAAC,IAAY,EAAmB,EAAE;YAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC,CAAC;QAEF;;;;;;;;;;WAUG;QACH,eAAU,GAAG,CAAC,IAAY,EAAiB,EAAE;YAC3C,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;YAE5D,SAAS,CAAC,GAAG,EAAE;gBACb,IAAI,OAAO,GAAG,IAAI,CAAC;gBACnB,MAAM,CAAC,GAAG,GAAS,EAAE;oBACnB,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;oBACvC,IAAI,CAAC,OAAO;wBAAE,OAAO;oBACrB,UAAU,CAAC,EAAE,CAAC,CAAC;gBACjB,CAAC,CAAA,CAAC;gBACF,CAAC,EAAE,CAAC;gBACJ,OAAO;YACT,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YAEX,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC;QAqBF;;;;;;;;;;WAUG;QACH,UAAK,GAAG,KAAK,CAAC;QAEd;;;;;;;;;;;;;;;;;;;;;;WAsBG;QACH,aAAQ,GAAG,CACT,MAAiE,EACjE,EAAE;YACF,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC,CAAC;QAEF;;;;;;;;;;;;;;;;;;;;;;;WAuBG;QACH,aAAQ,GAAG,CACT,KAAe,EACf,IAAqB,EAKrB,EAAE;YACF,OAAO,gBAAgB,CACrB,IAAI,CAAC,IAAI,EACT,KAAK,EACL,IAAI,CACL,CAAC,KAAK,CAAC;QACV,CAAC,CAAC;QAEF;;;;;;;;;;;;;;;;;;;;;;WAsBG;QACH,YAAO,GAAG,GAAc,EAAE;YACxB,iDAAiD;YACjD,0DAA0D;YAC1D,0CAA0C;YAC1C,2EAA2E;YAC3E,uCAAuC;YACvC,MAAM,cAAc,GAAG,MAAM,CAC3B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CACtC,CAAC;YAEF,uEAAuE;YACvE,2EAA2E;YAC3E,MAAM,SAAS,GAAG,WAAW,CAAC,CAAC,EAAY,EAAE,EAAE;gBAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,EAAE;oBACnD,cAAc,CAAC,OAAO,mBAAK,SAAS,EAAE,KAAK,IAAK,IAAI,CAAE,CAAC;oBACvD,EAAE,EAAE,CAAC;gBACP,CAAC,CAAC,CAAC;gBAEH,OAAO,WAAW,CAAC;YACrB,CAAC,EAAE,EAAE,CAAC,CAAC;YAEP,MAAM,KAAK,GAAG,oBAAoB,CAChC,SAAS,EACT,GAAG,EAAE,CAAC,cAAc,CAAC,OAAO,EAC5B,GAAG,EAAE,CAAC,gBAAgB,CACvB,CAAC;YACF,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF;;;;;;;;;;;;;;;;;;WAkBG;QACH,YAAO,GAAG,GAAS,EAAE;YACnB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAChC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,YAAY,CACpB,qDAAqD,CACtD,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QAgBF;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,wBAAmB,GAAG,GAAqB,EAAE;YAC3C,MAAM,SAAS,GAAG,MAAM,CACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAA0B,CAC9C,CAAC;YAEF,MAAM,SAAS,GAAG,WAAW,CAAC,CAAC,EAAY,EAAE,EAAE;gBAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,SAAS,EAAE,EAAE;oBACpE,IAAI,SAAS,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;wBACpC,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC;wBAC9B,EAAE,EAAE,CAAC;oBACP,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,OAAO,WAAW,CAAC;YACrB,CAAC,EAAE,EAAE,CAAC,CAAC;YAEP,MAAM,MAAM,GAAG,oBAAoB,CACjC,SAAS,EACT,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO;YACvB,2DAA2D;YAC3D,GAAG,EAAE,CAAC,YAAY,CACnB,CAAC;YAEF,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF;;;;;;;;;;;;WAYG;QACH,cAAS,GAAG,CACV,KAAQ,EACR,IAAqB,EAIpB,EAAE;YACH,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC1C,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,aAAQ,GAEH,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;YACpB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI;gBAAE,OAAO,IAAI,CAAC;YAE5D,OAAO,4BAAG,QAAQ,GAAI,CAAC;QACzB,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,cAAS,GAEJ,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;YACpB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI;gBAAE,OAAO,IAAI,CAAC;YAC3D,OAAO,4BAAG,QAAQ,GAAI,CAAC;QACzB,CAAC,CAAC;QArWA,IAAI,CAAC,IAAI,GAAG,SAAS,CACnB,MAAM;QACN,6DAA6D;QAC7D,IAAI,CAAC,WAAW,CAAC,OAAO;QACxB,6DAA6D;QAC7D,IAAI,CAAC,WAAW,CAAC,eAAe,EAChC,QAAQ;QACR,6DAA6D;QAC7D,IAAI,CAAC,WAAW,CAAC,eAAe,CACjC,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IACnC,CAAC;IA2CD;;;;;;;;;;;OAWG;IACH,IAAI,CACF,OAAiB,kBAA8B,EAC/C,KAAa,gBAAgB;QAE7B,OAAO,IAAI,gBAAgB,CAA0B,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAoKD;;;;;;;;;OASG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;CA6GF","sourcesContent":["import {\n  // types\n  Auth,\n  Storage,\n  txInit,\n  type AuthState,\n  type User,\n  type ConnectionStatus,\n  type TransactionChunk,\n  type RoomSchemaShape,\n  type InstaQLParams,\n  type InstaQLOptions,\n  type InstantConfig,\n  type PageInfoResponse,\n  InstantCoreDatabase,\n  init as core_init,\n  InstaQLLifecycleState,\n  InstaQLResponse,\n  RoomsOf,\n  InstantSchemaDef,\n  IInstantDatabase,\n  InstantError,\n  ValidQuery,\n} from '@instantdb/core';\nimport {\n  ReactNode,\n  useCallback,\n  useEffect,\n  useRef,\n  useState,\n  useSyncExternalStore,\n} from 'react';\nimport { useQueryInternal } from './useQuery.ts';\nimport { InstantReactRoom, rooms } from './InstantReactRoom.ts';\n\nconst defaultAuthState = {\n  isLoading: true,\n  user: undefined,\n  error: undefined,\n};\n\nexport default abstract class InstantReactAbstractDatabase<\n  // need to pull this schema out to another generic for query params, not sure why\n  Schema extends InstantSchemaDef<any, any, any>,\n  Config extends InstantConfig<Schema, boolean> = InstantConfig<Schema, false>,\n  Rooms extends RoomSchemaShape = RoomsOf<Schema>,\n> implements IInstantDatabase<Schema>\n{\n  public tx = txInit<Schema>();\n\n  public auth: Auth;\n  public storage: Storage;\n  public core: InstantCoreDatabase<Schema, Config['useDateObjects']>;\n\n  /** @deprecated use `core` instead */\n  public _core: InstantCoreDatabase<Schema, Config['useDateObjects']>;\n\n  static Storage?: any;\n  static NetworkListener?: any;\n  static EventSourceImpl?: any;\n\n  constructor(config: Config, versions?: { [key: string]: string }) {\n    this.core = core_init<Schema, Config['useDateObjects']>(\n      config,\n      // @ts-expect-error because TS can't resolve subclass statics\n      this.constructor.Storage,\n      // @ts-expect-error because TS can't resolve subclass statics\n      this.constructor.NetworkListener,\n      versions,\n      // @ts-expect-error because TS can't resolve subclass statics\n      this.constructor.EventSourceImpl,\n    );\n    this._core = this.core;\n    this.auth = this.core.auth;\n    this.storage = this.core.storage;\n  }\n\n  /**\n   * Returns a unique ID for a given `name`. It's stored in local storage,\n   * so you will get the same ID across sessions.\n   *\n   * This is useful for generating IDs that could identify a local device or user.\n   *\n   * @example\n   *  const deviceId = await db.getLocalId('device');\n   */\n  getLocalId = (name: string): Promise<string> => {\n    return this.core.getLocalId(name);\n  };\n\n  /**\n   * A hook that returns a unique ID for a given `name`. localIds are\n   * stored in local storage, so you will get the same ID across sessions.\n   *\n   * Initially returns `null`, and then loads the localId.\n   *\n   * @example\n   * const deviceId = db.useLocalId('device');\n   * if (!deviceId) return null; // loading\n   * console.log('Device ID:', deviceId)\n   */\n  useLocalId = (name: string): string | null => {\n    const [localId, setLocalId] = useState<string | null>(null);\n\n    useEffect(() => {\n      let mounted = true;\n      const f = async () => {\n        const id = await this.getLocalId(name);\n        if (!mounted) return;\n        setLocalId(id);\n      };\n      f();\n      return;\n    }, [name]);\n\n    return localId;\n  };\n\n  /**\n   * Obtain a handle to a room, which allows you to listen to topics and presence data\n   *\n   * If you don't provide a `type` or `id`, Instant will default to `_defaultRoomType` and `_defaultRoomId`\n   * as the room type and id, respectively.\n   *\n   * @see https://instantdb.com/docs/presence-and-topics\n   *\n   * @example\n   *  const room = db.room('chat', roomId);\n   *  const { peers } = db.rooms.usePresence(room);\n   */\n  room<RoomType extends keyof Rooms>(\n    type: RoomType = '_defaultRoomType' as RoomType,\n    id: string = '_defaultRoomId',\n  ) {\n    return new InstantReactRoom<Schema, Rooms, RoomType>(this.core, type, id);\n  }\n\n  /**\n   * Hooks for working with rooms\n   *\n   * @see https://instantdb.com/docs/presence-and-topics\n   *\n   * @example\n   *  const room = db.room('chat', roomId);\n   *  const { peers } = db.rooms.usePresence(room);\n   *  const publish = db.rooms.usePublishTopic(room, 'emoji');\n   *  // ...\n   */\n  rooms = rooms;\n\n  /**\n   * Use this to write data! You can create, update, delete, and link objects\n   *\n   * @see https://instantdb.com/docs/instaml\n   *\n   * @example\n   *   // Create a new object in the `goals` namespace\n   *   const goalId = id();\n   *   db.transact(db.tx.goals[goalId].update({title: \"Get fit\"}))\n   *\n   *   // Update the title\n   *   db.transact(db.tx.goals[goalId].update({title: \"Get super fit\"}))\n   *\n   *   // Delete it\n   *   db.transact(db.tx.goals[goalId].delete())\n   *\n   *   // Or create an association:\n   *   todoId = id();\n   *   db.transact([\n   *    db.tx.todos[todoId].update({ title: 'Go on a run' }),\n   *    db.tx.goals[goalId].link({todos: todoId}),\n   *  ])\n   */\n  transact = (\n    chunks: TransactionChunk<any, any> | TransactionChunk<any, any>[],\n  ) => {\n    return this.core.transact(chunks);\n  };\n\n  /**\n   * Use this to query your data!\n   *\n   * @see https://instantdb.com/docs/instaql\n   *\n   * @example\n   *   // listen to all goals\n   *   const { isLoading, error, data } = db.useQuery({ goals: {} });\n   *\n   *   // goals where the title is \"Get Fit\"\n   *   const { isLoading, error, data } = db.useQuery({\n   *     goals: { $: { where: { title: 'Get Fit' } } },\n   *   });\n   *\n   *   // all goals, _alongside_ their todos\n   *   const { isLoading, error, data } = db.useQuery({\n   *     goals: { todos: {} },\n   *   });\n   *\n   *   // skip if `user` is not logged in\n   *   const { isLoading, error, data } = db.useQuery(\n   *     auth.user ? { goals: {} } : null,\n   *   );\n   */\n  useQuery = <Q extends ValidQuery<Q, Schema>>(\n    query: null | Q,\n    opts?: InstaQLOptions,\n  ): InstaQLLifecycleState<\n    Schema,\n    Q,\n    NonNullable<Config['useDateObjects']>\n  > => {\n    return useQueryInternal<Q, Schema, Config['useDateObjects']>(\n      this.core,\n      query,\n      opts,\n    ).state;\n  };\n\n  /**\n   * Listen for the logged in state. This is useful\n   * for deciding when to show a login screen.\n   *\n   * Check out the docs for an example `Login` component too!\n   *\n   * @see https://instantdb.com/docs/auth\n   * @example\n   *  function App() {\n   *    const { isLoading, user, error } = db.useAuth()\n   *    if (isLoading) {\n   *      return <div>Loading...</div>\n   *    }\n   *    if (error) {\n   *      return <div>Uh oh! {error.message}</div>\n   *    }\n   *    if (user) {\n   *      return <Main user={user} />\n   *    }\n   *    return <Login />\n   *  }\n   *\n   */\n  useAuth = (): AuthState => {\n    // We use a ref to store the result of the query.\n    // This is becuase `useSyncExternalStore` uses `Object.is`\n    // to compare the previous and next state.\n    // If we don't use a ref, the state will always be considered different, so\n    // the component will always re-render.\n    const resultCacheRef = useRef<AuthState>(\n      this.core._reactor._currentUserCached,\n    );\n\n    // Similar to `resultCacheRef`, `useSyncExternalStore` will unsubscribe\n    // if `subscribe` changes, so we use `useCallback` to memoize the function.\n    const subscribe = useCallback((cb: Function) => {\n      const unsubscribe = this.core.subscribeAuth((auth) => {\n        resultCacheRef.current = { isLoading: false, ...auth };\n        cb();\n      });\n\n      return unsubscribe;\n    }, []);\n\n    const state = useSyncExternalStore<AuthState>(\n      subscribe,\n      () => resultCacheRef.current,\n      () => defaultAuthState,\n    );\n    return state;\n  };\n\n  /**\n   * Subscribe to the currently logged in user.\n   * If the user is not logged in, this hook with throw an Error.\n   * You will want to protect any calls of this hook with a\n   * <db.SignedIn> component, or your own logic based on db.useAuth()\n   *\n   * @see https://instantdb.com/docs/auth\n   * @throws Error indicating user not signed in\n   * @example\n   *  function UserDisplay() {\n   *    const user = db.useUser()\n   *    return <div>Logged in as: {user.email}</div>\n   *  }\n   *\n   *  <db.SignedIn>\n   *    <UserDisplay />\n   *  </db.SignedIn>\n   *\n   */\n  useUser = (): User => {\n    const { user } = this.useAuth();\n    if (!user) {\n      throw new InstantError(\n        'useUser must be used within an auth-protected route',\n      );\n    }\n    return user;\n  };\n\n  /**\n   * One time query for the logged in state. This is useful\n   * for scenarios where you want to know the current auth\n   * state without subscribing to changes.\n   *\n   * @see https://instantdb.com/docs/auth\n   * @example\n   *   const user = await db.getAuth();\n   *   console.log('logged in as', user.email)\n   */\n  getAuth(): Promise<User | null> {\n    return this.core.getAuth();\n  }\n\n  /**\n   * Listen for connection status changes to Instant. Use this for things like\n   * showing connection state to users\n   *\n   * @see https://www.instantdb.com/docs/patterns#connection-status\n   * @example\n   *  function App() {\n   *    const status = db.useConnectionStatus()\n   *    const connectionState =\n   *      status === 'connecting' || status === 'opened'\n   *        ? 'authenticating'\n   *      : status === 'authenticated'\n   *        ? 'connected'\n   *      : status === 'closed'\n   *        ? 'closed'\n   *      : status === 'errored'\n   *        ? 'errored'\n   *      : 'unexpected state';\n   *\n   *    return <div>Connection state: {connectionState}</div>\n   *  }\n   */\n  useConnectionStatus = (): ConnectionStatus => {\n    const statusRef = useRef<ConnectionStatus>(\n      this.core._reactor.status as ConnectionStatus,\n    );\n\n    const subscribe = useCallback((cb: Function) => {\n      const unsubscribe = this.core.subscribeConnectionStatus((newStatus) => {\n        if (newStatus !== statusRef.current) {\n          statusRef.current = newStatus;\n          cb();\n        }\n      });\n\n      return unsubscribe;\n    }, []);\n\n    const status = useSyncExternalStore<ConnectionStatus>(\n      subscribe,\n      () => statusRef.current,\n      // For SSR, always return 'connecting' as the initial state\n      () => 'connecting',\n    );\n\n    return status;\n  };\n\n  /**\n   * Use this for one-off queries.\n   * Returns local data if available, otherwise fetches from the server.\n   * Because we want to avoid stale data, this method will throw an error\n   * if the user is offline or there is no active connection to the server.\n   *\n   * @see https://instantdb.com/docs/instaql\n   *\n   * @example\n   *\n   *  const resp = await db.queryOnce({ goals: {} });\n   *  console.log(resp.data.goals)\n   */\n  queryOnce = <Q extends ValidQuery<Q, Schema>>(\n    query: Q,\n    opts?: InstaQLOptions,\n  ): Promise<{\n    data: InstaQLResponse<Schema, Q, Config['useDateObjects']>;\n    pageInfo: PageInfoResponse<Q>;\n  }> => {\n    return this.core.queryOnce(query, opts);\n  };\n\n  /**\n   * Only render children if the user is signed in.\n   * @see https://instantdb.com/docs/auth\n   *\n   * @example\n   *  <db.SignedIn>\n   *    <MyComponent />\n   *  </db.SignedIn>\n   *\n   */\n  SignedIn: React.FC<{\n    children: ReactNode;\n  }> = ({ children }) => {\n    const auth = this.useAuth();\n    if (auth.isLoading || auth.error || !auth.user) return null;\n\n    return <>{children}</>;\n  };\n\n  /**\n   * Only render children if the user is signed out.\n   * @see https://instantdb.com/docs/auth\n   *\n   * @example\n   *  <db.SignedOut>\n   *    <MyComponent />\n   *  </db.SignedOut>\n   *\n   */\n  SignedOut: React.FC<{\n    children: ReactNode;\n  }> = ({ children }) => {\n    const auth = this.useAuth();\n    if (auth.isLoading || auth.error || auth.user) return null;\n    return <>{children}</>;\n  };\n}\n"]}

package/dist/esm/InstantReactRoom.d.ts

@@ -0,0 +1,183 @@
+import { type PresenceOpts, type PresenceResponse, type RoomSchemaShape, InstantCoreDatabase, InstantSchemaDef } from '@instantdb/core';
+import { KeyboardEvent } from 'react';
+export type PresenceHandle<PresenceShape, Keys extends keyof PresenceShape> = PresenceResponse<PresenceShape, Keys> & {
+    publishPresence: (data: Partial<PresenceShape>) => void;
+};
+export type TypingIndicatorOpts = {
+    timeout?: number | null;
+    stopOnEnter?: boolean;
+    writeOnly?: boolean;
+};
+export type TypingIndicatorHandle<PresenceShape> = {
+    active: PresenceShape[];
+    setActive(active: boolean): void;
+    inputProps: {
+        onKeyDown: (e: KeyboardEvent) => void;
+        onBlur: () => void;
+    };
+};
+export declare const defaultActivityStopTimeout = 1000;
+/**
+ * Listen for broadcasted events given a room and topic.
+ *
+ * @see https://instantdb.com/docs/presence-and-topics
+ * @example
+ *  function App({ roomId }) {
+ *    const room = db.room('chats', roomId);
+ *    db.rooms.useTopicEffect(room, 'emoji', (message, peer) => {
+ *      console.log(peer.name, 'sent', message);
+ *    });
+ *    // ...
+ *  }
+ */
+export declare function useTopicEffect<RoomSchema extends RoomSchemaShape, RoomType extends keyof RoomSchema, TopicType extends keyof RoomSchema[RoomType]['topics']>(room: InstantReactRoom<any, RoomSchema, RoomType>, topic: TopicType, onEvent: (event: RoomSchema[RoomType]['topics'][TopicType], peer: RoomSchema[RoomType]['presence']) => any): void;
+/**
+ * Broadcast an event to a room.
+ *
+ * @see https://instantdb.com/docs/presence-and-topics
+ * @example
+ * function App({ roomId }) {
+ *   const room = db.room('chat', roomId);
+ *   const publishTopic = db.rooms.usePublishTopic(room, "emoji");
+ *
+ *   return (
+ *     <button onClick={() => publishTopic({ emoji: "🔥" })}>Send emoji</button>
+ *   );
+ * }
+ *
+ */
+export declare function usePublishTopic<RoomSchema extends RoomSchemaShape, RoomType extends keyof RoomSchema, TopicType extends keyof RoomSchema[RoomType]['topics']>(room: InstantReactRoom<any, RoomSchema, RoomType>, topic: TopicType): (data: RoomSchema[RoomType]['topics'][TopicType]) => void;
+/**
+ * Listen for peer's presence data in a room, and publish the current user's presence.
+ *
+ * @see https://instantdb.com/docs/presence-and-topics
+ * @example
+ *  function App({ roomId }) {
+ *    const {
+ *      peers,
+ *      publishPresence
+ *    } = db.room(roomType, roomId).usePresence({ keys: ["name", "avatar"] });
+ *
+ *    // ...
+ *  }
+ */
+export declare function usePresence<RoomSchema extends RoomSchemaShape, RoomType extends keyof RoomSchema, Keys extends keyof RoomSchema[RoomType]['presence']>(room: InstantReactRoom<any, RoomSchema, RoomType>, opts?: PresenceOpts<RoomSchema[RoomType]['presence'], Keys>): PresenceHandle<RoomSchema[RoomType]['presence'], Keys>;
+/**
+ * Publishes presence data to a room
+ *
+ * @see https://instantdb.com/docs/presence-and-topics
+ * @example
+ *  function App({ roomId, nickname }) {
+ *    const room = db.room('chat', roomId);
+ *    db.rooms.useSyncPresence(room, { nickname });
+ *  }
+ */
+export declare function useSyncPresence<RoomSchema extends RoomSchemaShape, RoomType extends keyof RoomSchema>(room: InstantReactRoom<any, RoomSchema, RoomType>, data: Partial<RoomSchema[RoomType]['presence']>, deps?: any[]): void;
+/**
+ * Manage typing indicator state
+ *
+ * @see https://instantdb.com/docs/presence-and-topics
+ * @example
+ *  function App({ roomId }) {
+ *    const room = db.room('chat', roomId);
+ *    const {
+ *      active,
+ *      setActive,
+ *      inputProps,
+ *    } = db.rooms.useTypingIndicator(room, "chat-input");
+ *
+ *    return <input {...inputProps} />;
+ *  }
+ */
+export declare function useTypingIndicator<RoomSchema extends RoomSchemaShape, RoomType extends keyof RoomSchema>(room: InstantReactRoom<any, RoomSchema, RoomType>, inputName: string, opts?: TypingIndicatorOpts): TypingIndicatorHandle<RoomSchema[RoomType]['presence']>;
+export declare const rooms: {
+    useTopicEffect: typeof useTopicEffect;
+    usePublishTopic: typeof usePublishTopic;
+    usePresence: typeof usePresence;
+    useSyncPresence: typeof useSyncPresence;
+    useTypingIndicator: typeof useTypingIndicator;
+};
+export declare class InstantReactRoom<Schema extends InstantSchemaDef<any, any, any>, RoomSchema extends RoomSchemaShape, RoomType extends keyof RoomSchema> {
+    core: InstantCoreDatabase<Schema, boolean>;
+    /** @deprecated use `core` instead */
+    _core: InstantCoreDatabase<Schema, boolean>;
+    type: RoomType;
+    id: string;
+    constructor(core: InstantCoreDatabase<Schema, boolean>, type: RoomType, id: string);
+    /**
+     * @deprecated
+     * `db.room(...).useTopicEffect` is deprecated. You can replace it with `db.rooms.useTopicEffect`.
+     *
+     * @example
+     *
+     * // Before
+     * const room = db.room('chat', 'room-id');
+     * room.useTopicEffect('emoji', (message, peer) => {  });
+     *
+     * // After
+     * const room = db.room('chat', 'room-id');
+     * db.rooms.useTopicEffect(room, 'emoji', (message, peer) => {  });
+     */
+    useTopicEffect: <TopicType extends keyof RoomSchema[RoomType]["topics"]>(topic: TopicType, onEvent: (event: RoomSchema[RoomType]["topics"][TopicType], peer: RoomSchema[RoomType]["presence"]) => any) => void;
+    /**
+     * @deprecated
+     * `db.room(...).usePublishTopic` is deprecated. You can replace it with `db.rooms.usePublishTopic`.
+     *
+     * @example
+     *
+     * // Before
+     * const room = db.room('chat', 'room-id');
+     * const publish = room.usePublishTopic('emoji');
+     *
+     * // After
+     * const room = db.room('chat', 'room-id');
+     * const publish = db.rooms.usePublishTopic(room, 'emoji');
+     */
+    usePublishTopic: <Topic extends keyof RoomSchema[RoomType]["topics"]>(topic: Topic) => ((data: RoomSchema[RoomType]["topics"][Topic]) => void);
+    /**
+     * @deprecated
+     * `db.room(...).usePresence` is deprecated. You can replace it with `db.rooms.usePresence`.
+     *
+     * @example
+     *
+     * // Before
+     * const room = db.room('chat', 'room-id');
+     * const { peers } = room.usePresence({ keys: ["name", "avatar"] });
+     *
+     * // After
+     * const room = db.room('chat', 'room-id');
+     * const { peers } = db.rooms.usePresence(room, { keys: ["name", "avatar"] });
+     */
+    usePresence: <Keys extends keyof RoomSchema[RoomType]["presence"]>(opts?: PresenceOpts<RoomSchema[RoomType]["presence"], Keys>) => PresenceHandle<RoomSchema[RoomType]["presence"], Keys>;
+    /**
+     * @deprecated
+     * `db.room(...).useSyncPresence` is deprecated. You can replace it with `db.rooms.useSyncPresence`.
+     *
+     * @example
+     *
+     * // Before
+     * const room = db.room('chat', 'room-id');
+     * room.useSyncPresence(room, { nickname });
+     *
+     * // After
+     * const room = db.room('chat', 'room-id');
+     * db.rooms.useSyncPresence(room, { nickname });
+     */
+    useSyncPresence: (data: Partial<RoomSchema[RoomType]["presence"]>, deps?: any[]) => void;
+    /**
+     * @deprecated
+     * `db.room(...).useTypingIndicator` is deprecated. You can replace it with `db.rooms.useTypingIndicator`.
+     *
+     * @example
+     *
+     * // Before
+     * const room = db.room('chat', 'room-id');
+     * const typing = room.useTypingIndiactor(room, 'chat-input');
+     *
+     * // After
+     * const room = db.room('chat', 'room-id');
+     * const typing = db.rooms.useTypingIndiactor(room, 'chat-input');
+     */
+    useTypingIndicator: (inputName: string, opts?: TypingIndicatorOpts) => TypingIndicatorHandle<RoomSchema[RoomType]["presence"]>;
+}
+//# sourceMappingURL=InstantReactRoom.d.ts.map

package/dist/esm/InstantReactRoom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstantReactRoom.d.ts","sourceRoot":"","sources":["../../src/InstantReactRoom.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,mBAAmB,EACnB,gBAAgB,EACjB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,aAAa,EAKd,MAAM,OAAO,CAAC;AAIf,MAAM,MAAM,cAAc,CACxB,aAAa,EACb,IAAI,SAAS,MAAM,aAAa,IAC9B,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG;IAC1C,eAAe,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,qBAAqB,CAAC,aAAa,IAAI;IACjD,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,UAAU,EAAE;QACV,SAAS,EAAE,CAAC,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;QACtC,MAAM,EAAE,MAAM,IAAI,CAAC;KACpB,CAAC;CACH,CAAC;AAEF,eAAO,MAAM,0BAA0B,OAAQ,CAAC;AAKhD;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAC5B,UAAU,SAAS,eAAe,EAClC,QAAQ,SAAS,MAAM,UAAU,EACjC,SAAS,SAAS,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAEtD,IAAI,EAAE,gBAAgB,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,EACjD,KAAK,EAAE,SAAS,EAChB,OAAO,EAAE,CACP,KAAK,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,EAChD,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,KACnC,GAAG,GACP,IAAI,CAYN;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAC7B,UAAU,SAAS,eAAe,EAClC,QAAQ,SAAS,MAAM,UAAU,EACjC,SAAS,SAAS,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAEtD,IAAI,EAAE,gBAAgB,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,EACjD,KAAK,EAAE,SAAS,GACf,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,CAgB3D;AAKD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CACzB,UAAU,SAAS,eAAe,EAClC,QAAQ,SAAS,MAAM,UAAU,EACjC,IAAI,SAAS,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,EAEnD,IAAI,EAAE,gBAAgB,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,EACjD,IAAI,GAAE,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,EAAE,IAAI,CAAM,GAC9D,cAAc,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,CAsCxD;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,UAAU,SAAS,eAAe,EAClC,QAAQ,SAAS,MAAM,UAAU,EAEjC,IAAI,EAAE,gBAAgB,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,EACjD,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC,EAC/C,IAAI,CAAC,EAAE,GAAG,EAAE,GACX,IAAI,CAKN;AAKD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,SAAS,eAAe,EAClC,QAAQ,SAAS,MAAM,UAAU,EAEjC,IAAI,EAAE,gBAAgB,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,EACjD,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,mBAAwB,GAC7B,qBAAqB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC,CA4DzD;AAKD,eAAO,MAAM,KAAK;;;;;;CAMjB,CAAC;AAKF,qBAAa,gBAAgB,CAC3B,MAAM,SAAS,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC9C,UAAU,SAAS,eAAe,EAClC,QAAQ,SAAS,MAAM,UAAU;IAEjC,IAAI,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3C,qCAAqC;IACrC,KAAK,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5C,IAAI,EAAE,QAAQ,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;gBAGT,IAAI,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,IAAI,EAAE,QAAQ,EACd,EAAE,EAAE,MAAM;IAQZ;;;;;;;;;;;;;OAaG;IACH,cAAc,GAAI,SAAS,SAAS,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EACtE,OAAO,SAAS,EAChB,SAAS,CACP,KAAK,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,EAChD,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,KACnC,GAAG,KACP,IAAI,CAEL;IAEF;;;;;;;;;;;;;OAaG;IACH,eAAe,GAAI,KAAK,SAAS,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EACnE,OAAO,KAAK,KACX,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAExD;IAEF;;;;;;;;;;;;;OAaG;IACH,WAAW,GAAI,IAAI,SAAS,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,EAChE,OAAM,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,EAAE,IAAI,CAAM,KAC9D,cAAc,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,CAEvD;IAEF;;;;;;;;;;;;;OAaG;IACH,eAAe,GACb,MAAM,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC,EAC/C,OAAO,GAAG,EAAE,KACX,IAAI,CAEL;IAEF;;;;;;;;;;;;;OAaG;IACH,kBAAkB,GAChB,WAAW,MAAM,EACjB,OAAM,mBAAwB,KAC7B,qBAAqB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC,CAExD;CACH"}

package/dist/esm/InstantReactRoom.js

@@ -0,0 +1,275 @@
+import { useCallback, useEffect, useMemo, useState, } from 'react';
+import { useTimeout } from "./useTimeout.js";
+export const defaultActivityStopTimeout = 1000;
+// ------
+// Topics
+/**
+ * Listen for broadcasted events given a room and topic.
+ *
+ * @see https://instantdb.com/docs/presence-and-topics
+ * @example
+ *  function App({ roomId }) {
+ *    const room = db.room('chats', roomId);
+ *    db.rooms.useTopicEffect(room, 'emoji', (message, peer) => {
+ *      console.log(peer.name, 'sent', message);
+ *    });
+ *    // ...
+ *  }
+ */
+export function useTopicEffect(room, topic, onEvent) {
+    useEffect(() => {
+        const unsub = room.core._reactor.subscribeTopic(room.id, topic, (event, peer) => {
+            onEvent(event, peer);
+        });
+        return unsub;
+    }, [room.id, topic]);
+}
+/**
+ * Broadcast an event to a room.
+ *
+ * @see https://instantdb.com/docs/presence-and-topics
+ * @example
+ * function App({ roomId }) {
+ *   const room = db.room('chat', roomId);
+ *   const publishTopic = db.rooms.usePublishTopic(room, "emoji");
+ *
+ *   return (
+ *     <button onClick={() => publishTopic({ emoji: "🔥" })}>Send emoji</button>
+ *   );
+ * }
+ *
+ */
+export function usePublishTopic(room, topic) {
+    useEffect(() => room.core._reactor.joinRoom(room.id), [room.id]);
+    const publishTopic = useCallback((data) => {
+        room.core._reactor.publishTopic({
+            roomType: room.type,
+            roomId: room.id,
+            topic,
+            data,
+        });
+    }, [room.id, topic]);
+    return publishTopic;
+}
+// ---------
+// Presence
+/**
+ * Listen for peer's presence data in a room, and publish the current user's presence.
+ *
+ * @see https://instantdb.com/docs/presence-and-topics
+ * @example
+ *  function App({ roomId }) {
+ *    const {
+ *      peers,
+ *      publishPresence
+ *    } = db.room(roomType, roomId).usePresence({ keys: ["name", "avatar"] });
+ *
+ *    // ...
+ *  }
+ */
+export function usePresence(room, opts = {}) {
+    var _a, _b;
+    const [state, setState] = useState(() => {
+        var _a;
+        return ((_a = room.core._reactor.getPresence(room.type, room.id, opts)) !== null && _a !== void 0 ? _a : {
+            peers: {},
+            isLoading: true,
+        });
+    });
+    useEffect(() => {
+        const unsub = room.core._reactor.subscribePresence(room.type, room.id, opts, (data) => {
+            setState(data);
+        });
+        return unsub;
+    }, [room.id, opts.user, (_a = opts.peers) === null || _a === void 0 ? void 0 : _a.join(), (_b = opts.keys) === null || _b === void 0 ? void 0 : _b.join()]);
+    const publishPresence = useCallback((data) => {
+        room.core._reactor.publishPresence(room.type, room.id, data);
+    }, [room.type, room.id]);
+    const ret = useMemo(() => {
+        return Object.assign(Object.assign({}, state), { publishPresence });
+    }, [state, publishPresence]);
+    return ret;
+}
+/**
+ * Publishes presence data to a room
+ *
+ * @see https://instantdb.com/docs/presence-and-topics
+ * @example
+ *  function App({ roomId, nickname }) {
+ *    const room = db.room('chat', roomId);
+ *    db.rooms.useSyncPresence(room, { nickname });
+ *  }
+ */
+export function useSyncPresence(room, data, deps) {
+    useEffect(() => room.core._reactor.joinRoom(room.id, data), [room.id]);
+    useEffect(() => {
+        return room.core._reactor.publishPresence(room.type, room.id, data);
+    }, [room.type, room.id, deps !== null && deps !== void 0 ? deps : JSON.stringify(data)]);
+}
+// -----------------
+// Typing Indicator
+/**
+ * Manage typing indicator state
+ *
+ * @see https://instantdb.com/docs/presence-and-topics
+ * @example
+ *  function App({ roomId }) {
+ *    const room = db.room('chat', roomId);
+ *    const {
+ *      active,
+ *      setActive,
+ *      inputProps,
+ *    } = db.rooms.useTypingIndicator(room, "chat-input");
+ *
+ *    return <input {...inputProps} />;
+ *  }
+ */
+export function useTypingIndicator(room, inputName, opts = {}) {
+    const timeout = useTimeout();
+    const observedPresence = rooms.usePresence(room, {
+        keys: [inputName],
+    });
+    const active = useMemo(() => {
+        var _a;
+        const presenceSnapshot = room._core._reactor.getPresence(room.type, room.id);
+        return (opts === null || opts === void 0 ? void 0 : opts.writeOnly)
+            ? []
+            : Object.values((_a = presenceSnapshot === null || presenceSnapshot === void 0 ? void 0 : presenceSnapshot.peers) !== null && _a !== void 0 ? _a : {}).filter((p) => p[inputName] === true);
+    }, [opts === null || opts === void 0 ? void 0 : opts.writeOnly, observedPresence]);
+    const setActive = useCallback((isActive) => {
+        var _a;
+        room.core._reactor.publishPresence(room.type, room.id, {
+            [inputName]: isActive,
+        });
+        if (!isActive)
+            return;
+        if ((opts === null || opts === void 0 ? void 0 : opts.timeout) === null || (opts === null || opts === void 0 ? void 0 : opts.timeout) === 0)
+            return;
+        timeout.set((_a = opts === null || opts === void 0 ? void 0 : opts.timeout) !== null && _a !== void 0 ? _a : defaultActivityStopTimeout, () => {
+            room.core._reactor.publishPresence(room.type, room.id, {
+                [inputName]: null,
+            });
+        });
+    }, [room.type, room.id, inputName, opts === null || opts === void 0 ? void 0 : opts.timeout, timeout]);
+    const onKeyDown = useCallback((e) => {
+        const isEnter = (opts === null || opts === void 0 ? void 0 : opts.stopOnEnter) && e.key === 'Enter';
+        const isActive = !isEnter;
+        setActive(isActive);
+    }, [opts.stopOnEnter, setActive]);
+    const onBlur = useCallback(() => {
+        setActive(false);
+    }, [setActive]);
+    const inputProps = useMemo(() => {
+        return { onKeyDown, onBlur };
+    }, [onKeyDown, onBlur]);
+    return {
+        active,
+        setActive,
+        inputProps,
+    };
+}
+// --------------
+// Hooks
+export const rooms = {
+    useTopicEffect,
+    usePublishTopic,
+    usePresence,
+    useSyncPresence,
+    useTypingIndicator,
+};
+// ------------
+// Class
+export class InstantReactRoom {
+    constructor(core, type, id) {
+        /**
+         * @deprecated
+         * `db.room(...).useTopicEffect` is deprecated. You can replace it with `db.rooms.useTopicEffect`.
+         *
+         * @example
+         *
+         * // Before
+         * const room = db.room('chat', 'room-id');
+         * room.useTopicEffect('emoji', (message, peer) => {  });
+         *
+         * // After
+         * const room = db.room('chat', 'room-id');
+         * db.rooms.useTopicEffect(room, 'emoji', (message, peer) => {  });
+         */
+        this.useTopicEffect = (topic, onEvent) => {
+            rooms.useTopicEffect(this, topic, onEvent);
+        };
+        /**
+         * @deprecated
+         * `db.room(...).usePublishTopic` is deprecated. You can replace it with `db.rooms.usePublishTopic`.
+         *
+         * @example
+         *
+         * // Before
+         * const room = db.room('chat', 'room-id');
+         * const publish = room.usePublishTopic('emoji');
+         *
+         * // After
+         * const room = db.room('chat', 'room-id');
+         * const publish = db.rooms.usePublishTopic(room, 'emoji');
+         */
+        this.usePublishTopic = (topic) => {
+            return rooms.usePublishTopic(this, topic);
+        };
+        /**
+         * @deprecated
+         * `db.room(...).usePresence` is deprecated. You can replace it with `db.rooms.usePresence`.
+         *
+         * @example
+         *
+         * // Before
+         * const room = db.room('chat', 'room-id');
+         * const { peers } = room.usePresence({ keys: ["name", "avatar"] });
+         *
+         * // After
+         * const room = db.room('chat', 'room-id');
+         * const { peers } = db.rooms.usePresence(room, { keys: ["name", "avatar"] });
+         */
+        this.usePresence = (opts = {}) => {
+            return rooms.usePresence(this, opts);
+        };
+        /**
+         * @deprecated
+         * `db.room(...).useSyncPresence` is deprecated. You can replace it with `db.rooms.useSyncPresence`.
+         *
+         * @example
+         *
+         * // Before
+         * const room = db.room('chat', 'room-id');
+         * room.useSyncPresence(room, { nickname });
+         *
+         * // After
+         * const room = db.room('chat', 'room-id');
+         * db.rooms.useSyncPresence(room, { nickname });
+         */
+        this.useSyncPresence = (data, deps) => {
+            return rooms.useSyncPresence(this, data, deps);
+        };
+        /**
+         * @deprecated
+         * `db.room(...).useTypingIndicator` is deprecated. You can replace it with `db.rooms.useTypingIndicator`.
+         *
+         * @example
+         *
+         * // Before
+         * const room = db.room('chat', 'room-id');
+         * const typing = room.useTypingIndiactor(room, 'chat-input');
+         *
+         * // After
+         * const room = db.room('chat', 'room-id');
+         * const typing = db.rooms.useTypingIndiactor(room, 'chat-input');
+         */
+        this.useTypingIndicator = (inputName, opts = {}) => {
+            return rooms.useTypingIndicator(this, inputName, opts);
+        };
+        this.core = core;
+        this._core = this.core;
+        this.type = type;
+        this.id = id;
+    }
+}
+//# sourceMappingURL=InstantReactRoom.js.map

package/dist/esm/InstantReactRoom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstantReactRoom.js","sourceRoot":"","sources":["../../src/InstantReactRoom.ts"],"names":[],"mappings":"AASA,OAAO,EAEL,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,GACT,MAAM,OAAO,CAAC;AAEf,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAyB7C,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAK,CAAC;AAEhD,SAAS;AACT,SAAS;AAET;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,cAAc,CAK5B,IAAiD,EACjD,KAAgB,EAChB,OAGQ;IAER,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAC7C,IAAI,CAAC,EAAE,EACP,KAAK,EACL,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACd,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACvB,CAAC,CACF,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,eAAe,CAK7B,IAAiD,EACjD,KAAgB;IAEhB,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAEjE,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,IAAI,EAAE,EAAE;QACP,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;YAC9B,QAAQ,EAAE,IAAI,CAAC,IAAI;YACnB,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,KAAK;YACL,IAAI;SACL,CAAC,CAAC;IACL,CAAC,EACD,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CACjB,CAAC;IAEF,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,YAAY;AACZ,WAAW;AAEX;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,WAAW,CAKzB,IAAiD,EACjD,OAA6D,EAAE;;IAE/D,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAEhC,GAAG,EAAE;;QACL,OAAO,CACL,MAAA,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,mCAAI;YAC1D,KAAK,EAAE,EAAE;YACT,SAAS,EAAE,IAAI;SAChB,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAChD,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,EAAE,EACP,IAAI,EACJ,CAAC,IAAI,EAAE,EAAE;YACP,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC,CACF,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,MAAA,IAAI,CAAC,KAAK,0CAAE,IAAI,EAAE,EAAE,MAAA,IAAI,CAAC,IAAI,0CAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAEhE,MAAM,eAAe,GAAG,WAAW,CACjC,CAAC,IAAI,EAAE,EAAE;QACP,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC,EACD,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CACrB,CAAC;IACF,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;QACvB,uCACK,KAAK,KACR,eAAe,IACf;IACJ,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC;IAC7B,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAI7B,IAAiD,EACjD,IAA+C,EAC/C,IAAY;IAEZ,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACvE,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,oBAAoB;AACpB,mBAAmB;AAEnB;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,kBAAkB,CAIhC,IAAiD,EACjD,SAAiB,EACjB,OAA4B,EAAE;IAE9B,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAE7B,MAAM,gBAAgB,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE;QAC/C,IAAI,EAAE,CAAC,SAAS,CAAC;KAClB,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE;;QAC1B,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CACtD,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,EAAE,CACR,CAAC;QAEF,OAAO,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS;YACpB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,KAAK,mCAAI,EAAE,CAAC,CAAC,MAAM,CACjD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,CAC7B,CAAC;IACR,CAAC,EAAE,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAExC,MAAM,SAAS,GAAG,WAAW,CAC3B,CAAC,QAAiB,EAAE,EAAE;;QACpB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACrD,CAAC,SAAS,CAAC,EAAE,QAAQ;SACsB,CAAC,CAAC;QAE/C,IAAI,CAAC,QAAQ;YAAE,OAAO;QAEtB,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,MAAK,IAAI,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,MAAK,CAAC;YAAE,OAAO;QAE1D,OAAO,CAAC,GAAG,CAAC,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,mCAAI,0BAA0B,EAAE,GAAG,EAAE;YAC5D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;gBACrD,CAAC,SAAS,CAAC,EAAE,IAAI;aACe,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC,EACD,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,OAAO,CAAC,CACxD,CAAC;IACF,MAAM,SAAS,GAAG,WAAW,CAC3B,CAAC,CAAgB,EAAE,EAAE;QACnB,MAAM,OAAO,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,KAAI,CAAC,CAAC,GAAG,KAAK,OAAO,CAAC;QACvD,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC;QAE1B,SAAS,CAAC,QAAQ,CAAC,CAAC;IACtB,CAAC,EACD,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAC9B,CAAC;IACF,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE;QAC9B,SAAS,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,EAAE;QAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;IAC/B,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IAExB,OAAO;QACL,MAAM;QACN,SAAS;QACT,UAAU;KACX,CAAC;AACJ,CAAC;AAED,iBAAiB;AACjB,QAAQ;AAER,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,cAAc;IACd,eAAe;IACf,WAAW;IACX,eAAe;IACf,kBAAkB;CACnB,CAAC;AAEF,eAAe;AACf,QAAQ;AAER,MAAM,OAAO,gBAAgB;IAW3B,YACE,IAA0C,EAC1C,IAAc,EACd,EAAU;QAQZ;;;;;;;;;;;;;WAaG;QACH,mBAAc,GAAG,CACf,KAAgB,EAChB,OAGQ,EACF,EAAE;YACR,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF;;;;;;;;;;;;;WAaG;QACH,oBAAe,GAAG,CAChB,KAAY,EAC6C,EAAE;YAC3D,OAAO,KAAK,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC,CAAC;QAEF;;;;;;;;;;;;;WAaG;QACH,gBAAW,GAAG,CACZ,OAA6D,EAAE,EACP,EAAE;YAC1D,OAAO,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC,CAAC;QAEF;;;;;;;;;;;;;WAaG;QACH,oBAAe,GAAG,CAChB,IAA+C,EAC/C,IAAY,EACN,EAAE;YACR,OAAO,KAAK,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF;;;;;;;;;;;;;WAaG;QACH,uBAAkB,GAAG,CACnB,SAAiB,EACjB,OAA4B,EAAE,EAC2B,EAAE;YAC3D,OAAO,KAAK,CAAC,kBAAkB,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QACzD,CAAC,CAAC;QA9GA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,CAAC;CA2GF","sourcesContent":["import {\n  // types\n  type PresenceOpts,\n  type PresenceResponse,\n  type RoomSchemaShape,\n  InstantCoreDatabase,\n  InstantSchemaDef,\n} from '@instantdb/core';\n\nimport {\n  KeyboardEvent,\n  useCallback,\n  useEffect,\n  useMemo,\n  useState,\n} from 'react';\n\nimport { useTimeout } from './useTimeout.ts';\n\nexport type PresenceHandle<\n  PresenceShape,\n  Keys extends keyof PresenceShape,\n> = PresenceResponse<PresenceShape, Keys> & {\n  publishPresence: (data: Partial<PresenceShape>) => void;\n};\n\nexport type TypingIndicatorOpts = {\n  timeout?: number | null;\n  stopOnEnter?: boolean;\n  // Perf opt - `active` will always be an empty array\n  writeOnly?: boolean;\n};\n\nexport type TypingIndicatorHandle<PresenceShape> = {\n  active: PresenceShape[];\n  setActive(active: boolean): void;\n  inputProps: {\n    onKeyDown: (e: KeyboardEvent) => void;\n    onBlur: () => void;\n  };\n};\n\nexport const defaultActivityStopTimeout = 1_000;\n\n// ------\n// Topics\n\n/**\n * Listen for broadcasted events given a room and topic.\n *\n * @see https://instantdb.com/docs/presence-and-topics\n * @example\n *  function App({ roomId }) {\n *    const room = db.room('chats', roomId);\n *    db.rooms.useTopicEffect(room, 'emoji', (message, peer) => {\n *      console.log(peer.name, 'sent', message);\n *    });\n *    // ...\n *  }\n */\nexport function useTopicEffect<\n  RoomSchema extends RoomSchemaShape,\n  RoomType extends keyof RoomSchema,\n  TopicType extends keyof RoomSchema[RoomType]['topics'],\n>(\n  room: InstantReactRoom<any, RoomSchema, RoomType>,\n  topic: TopicType,\n  onEvent: (\n    event: RoomSchema[RoomType]['topics'][TopicType],\n    peer: RoomSchema[RoomType]['presence'],\n  ) => any,\n): void {\n  useEffect(() => {\n    const unsub = room.core._reactor.subscribeTopic(\n      room.id,\n      topic,\n      (event, peer) => {\n        onEvent(event, peer);\n      },\n    );\n\n    return unsub;\n  }, [room.id, topic]);\n}\n\n/**\n * Broadcast an event to a room.\n *\n * @see https://instantdb.com/docs/presence-and-topics\n * @example\n * function App({ roomId }) {\n *   const room = db.room('chat', roomId);\n *   const publishTopic = db.rooms.usePublishTopic(room, \"emoji\");\n *\n *   return (\n *     <button onClick={() => publishTopic({ emoji: \"🔥\" })}>Send emoji</button>\n *   );\n * }\n *\n */\nexport function usePublishTopic<\n  RoomSchema extends RoomSchemaShape,\n  RoomType extends keyof RoomSchema,\n  TopicType extends keyof RoomSchema[RoomType]['topics'],\n>(\n  room: InstantReactRoom<any, RoomSchema, RoomType>,\n  topic: TopicType,\n): (data: RoomSchema[RoomType]['topics'][TopicType]) => void {\n  useEffect(() => room.core._reactor.joinRoom(room.id), [room.id]);\n\n  const publishTopic = useCallback(\n    (data) => {\n      room.core._reactor.publishTopic({\n        roomType: room.type,\n        roomId: room.id,\n        topic,\n        data,\n      });\n    },\n    [room.id, topic],\n  );\n\n  return publishTopic;\n}\n\n// ---------\n// Presence\n\n/**\n * Listen for peer's presence data in a room, and publish the current user's presence.\n *\n * @see https://instantdb.com/docs/presence-and-topics\n * @example\n *  function App({ roomId }) {\n *    const {\n *      peers,\n *      publishPresence\n *    } = db.room(roomType, roomId).usePresence({ keys: [\"name\", \"avatar\"] });\n *\n *    // ...\n *  }\n */\nexport function usePresence<\n  RoomSchema extends RoomSchemaShape,\n  RoomType extends keyof RoomSchema,\n  Keys extends keyof RoomSchema[RoomType]['presence'],\n>(\n  room: InstantReactRoom<any, RoomSchema, RoomType>,\n  opts: PresenceOpts<RoomSchema[RoomType]['presence'], Keys> = {},\n): PresenceHandle<RoomSchema[RoomType]['presence'], Keys> {\n  const [state, setState] = useState<\n    PresenceResponse<RoomSchema[RoomType]['presence'], Keys>\n  >(() => {\n    return (\n      room.core._reactor.getPresence(room.type, room.id, opts) ?? {\n        peers: {},\n        isLoading: true,\n      }\n    );\n  });\n\n  useEffect(() => {\n    const unsub = room.core._reactor.subscribePresence(\n      room.type,\n      room.id,\n      opts,\n      (data) => {\n        setState(data);\n      },\n    );\n\n    return unsub;\n  }, [room.id, opts.user, opts.peers?.join(), opts.keys?.join()]);\n\n  const publishPresence = useCallback(\n    (data) => {\n      room.core._reactor.publishPresence(room.type, room.id, data);\n    },\n    [room.type, room.id],\n  );\n  const ret = useMemo(() => {\n    return {\n      ...state,\n      publishPresence,\n    };\n  }, [state, publishPresence]);\n  return ret;\n}\n\n/**\n * Publishes presence data to a room\n *\n * @see https://instantdb.com/docs/presence-and-topics\n * @example\n *  function App({ roomId, nickname }) {\n *    const room = db.room('chat', roomId);\n *    db.rooms.useSyncPresence(room, { nickname });\n *  }\n */\nexport function useSyncPresence<\n  RoomSchema extends RoomSchemaShape,\n  RoomType extends keyof RoomSchema,\n>(\n  room: InstantReactRoom<any, RoomSchema, RoomType>,\n  data: Partial<RoomSchema[RoomType]['presence']>,\n  deps?: any[],\n): void {\n  useEffect(() => room.core._reactor.joinRoom(room.id, data), [room.id]);\n  useEffect(() => {\n    return room.core._reactor.publishPresence(room.type, room.id, data);\n  }, [room.type, room.id, deps ?? JSON.stringify(data)]);\n}\n\n// -----------------\n// Typing Indicator\n\n/**\n * Manage typing indicator state\n *\n * @see https://instantdb.com/docs/presence-and-topics\n * @example\n *  function App({ roomId }) {\n *    const room = db.room('chat', roomId);\n *    const {\n *      active,\n *      setActive,\n *      inputProps,\n *    } = db.rooms.useTypingIndicator(room, \"chat-input\");\n *\n *    return <input {...inputProps} />;\n *  }\n */\nexport function useTypingIndicator<\n  RoomSchema extends RoomSchemaShape,\n  RoomType extends keyof RoomSchema,\n>(\n  room: InstantReactRoom<any, RoomSchema, RoomType>,\n  inputName: string,\n  opts: TypingIndicatorOpts = {},\n): TypingIndicatorHandle<RoomSchema[RoomType]['presence']> {\n  const timeout = useTimeout();\n\n  const observedPresence = rooms.usePresence(room, {\n    keys: [inputName],\n  });\n\n  const active = useMemo(() => {\n    const presenceSnapshot = room._core._reactor.getPresence(\n      room.type,\n      room.id,\n    );\n\n    return opts?.writeOnly\n      ? []\n      : Object.values(presenceSnapshot?.peers ?? {}).filter(\n          (p) => p[inputName] === true,\n        );\n  }, [opts?.writeOnly, observedPresence]);\n\n  const setActive = useCallback(\n    (isActive: boolean) => {\n      room.core._reactor.publishPresence(room.type, room.id, {\n        [inputName]: isActive,\n      } as unknown as Partial<RoomSchema[RoomType]>);\n\n      if (!isActive) return;\n\n      if (opts?.timeout === null || opts?.timeout === 0) return;\n\n      timeout.set(opts?.timeout ?? defaultActivityStopTimeout, () => {\n        room.core._reactor.publishPresence(room.type, room.id, {\n          [inputName]: null,\n        } as Partial<RoomSchema[RoomType]>);\n      });\n    },\n    [room.type, room.id, inputName, opts?.timeout, timeout],\n  );\n  const onKeyDown = useCallback(\n    (e: KeyboardEvent) => {\n      const isEnter = opts?.stopOnEnter && e.key === 'Enter';\n      const isActive = !isEnter;\n\n      setActive(isActive);\n    },\n    [opts.stopOnEnter, setActive],\n  );\n  const onBlur = useCallback(() => {\n    setActive(false);\n  }, [setActive]);\n\n  const inputProps = useMemo(() => {\n    return { onKeyDown, onBlur };\n  }, [onKeyDown, onBlur]);\n\n  return {\n    active,\n    setActive,\n    inputProps,\n  };\n}\n\n// --------------\n// Hooks\n\nexport const rooms = {\n  useTopicEffect,\n  usePublishTopic,\n  usePresence,\n  useSyncPresence,\n  useTypingIndicator,\n};\n\n// ------------\n// Class\n\nexport class InstantReactRoom<\n  Schema extends InstantSchemaDef<any, any, any>,\n  RoomSchema extends RoomSchemaShape,\n  RoomType extends keyof RoomSchema,\n> {\n  core: InstantCoreDatabase<Schema, boolean>;\n  /** @deprecated use `core` instead */\n  _core: InstantCoreDatabase<Schema, boolean>;\n  type: RoomType;\n  id: string;\n\n  constructor(\n    core: InstantCoreDatabase<Schema, boolean>,\n    type: RoomType,\n    id: string,\n  ) {\n    this.core = core;\n    this._core = this.core;\n    this.type = type;\n    this.id = id;\n  }\n\n  /**\n   * @deprecated\n   * `db.room(...).useTopicEffect` is deprecated. You can replace it with `db.rooms.useTopicEffect`.\n   *\n   * @example\n   *\n   * // Before\n   * const room = db.room('chat', 'room-id');\n   * room.useTopicEffect('emoji', (message, peer) => {  });\n   *\n   * // After\n   * const room = db.room('chat', 'room-id');\n   * db.rooms.useTopicEffect(room, 'emoji', (message, peer) => {  });\n   */\n  useTopicEffect = <TopicType extends keyof RoomSchema[RoomType]['topics']>(\n    topic: TopicType,\n    onEvent: (\n      event: RoomSchema[RoomType]['topics'][TopicType],\n      peer: RoomSchema[RoomType]['presence'],\n    ) => any,\n  ): void => {\n    rooms.useTopicEffect(this, topic, onEvent);\n  };\n\n  /**\n   * @deprecated\n   * `db.room(...).usePublishTopic` is deprecated. You can replace it with `db.rooms.usePublishTopic`.\n   *\n   * @example\n   *\n   * // Before\n   * const room = db.room('chat', 'room-id');\n   * const publish = room.usePublishTopic('emoji');\n   *\n   * // After\n   * const room = db.room('chat', 'room-id');\n   * const publish = db.rooms.usePublishTopic(room, 'emoji');\n   */\n  usePublishTopic = <Topic extends keyof RoomSchema[RoomType]['topics']>(\n    topic: Topic,\n  ): ((data: RoomSchema[RoomType]['topics'][Topic]) => void) => {\n    return rooms.usePublishTopic(this, topic);\n  };\n\n  /**\n   * @deprecated\n   * `db.room(...).usePresence` is deprecated. You can replace it with `db.rooms.usePresence`.\n   *\n   * @example\n   *\n   * // Before\n   * const room = db.room('chat', 'room-id');\n   * const { peers } = room.usePresence({ keys: [\"name\", \"avatar\"] });\n   *\n   * // After\n   * const room = db.room('chat', 'room-id');\n   * const { peers } = db.rooms.usePresence(room, { keys: [\"name\", \"avatar\"] });\n   */\n  usePresence = <Keys extends keyof RoomSchema[RoomType]['presence']>(\n    opts: PresenceOpts<RoomSchema[RoomType]['presence'], Keys> = {},\n  ): PresenceHandle<RoomSchema[RoomType]['presence'], Keys> => {\n    return rooms.usePresence(this, opts);\n  };\n\n  /**\n   * @deprecated\n   * `db.room(...).useSyncPresence` is deprecated. You can replace it with `db.rooms.useSyncPresence`.\n   *\n   * @example\n   *\n   * // Before\n   * const room = db.room('chat', 'room-id');\n   * room.useSyncPresence(room, { nickname });\n   *\n   * // After\n   * const room = db.room('chat', 'room-id');\n   * db.rooms.useSyncPresence(room, { nickname });\n   */\n  useSyncPresence = (\n    data: Partial<RoomSchema[RoomType]['presence']>,\n    deps?: any[],\n  ): void => {\n    return rooms.useSyncPresence(this, data, deps);\n  };\n\n  /**\n   * @deprecated\n   * `db.room(...).useTypingIndicator` is deprecated. You can replace it with `db.rooms.useTypingIndicator`.\n   *\n   * @example\n   *\n   * // Before\n   * const room = db.room('chat', 'room-id');\n   * const typing = room.useTypingIndiactor(room, 'chat-input');\n   *\n   * // After\n   * const room = db.room('chat', 'room-id');\n   * const typing = db.rooms.useTypingIndiactor(room, 'chat-input');\n   */\n  useTypingIndicator = (\n    inputName: string,\n    opts: TypingIndicatorOpts = {},\n  ): TypingIndicatorHandle<RoomSchema[RoomType]['presence']> => {\n    return rooms.useTypingIndicator(this, inputName, opts);\n  };\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import InstantReactAbstractDatabase from './InstantReactAbstractDatabase.tsx';
+import type { InstantReactRoom } from './InstantReactRoom.ts';
+export { InstantReactAbstractDatabase, type InstantReactRoom };
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,4BAA4B,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D,OAAO,EAAE,4BAA4B,EAAE,KAAK,gBAAgB,EAAE,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+import InstantReactAbstractDatabase from "./InstantReactAbstractDatabase.js";
+export { InstantReactAbstractDatabase };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,4BAA4B,MAAM,mCAAoC,CAAC;AAG9E,OAAO,EAAE,4BAA4B,EAAyB,CAAC","sourcesContent":["import InstantReactAbstractDatabase from './InstantReactAbstractDatabase.tsx';\nimport type { InstantReactRoom } from './InstantReactRoom.ts';\n\nexport { InstantReactAbstractDatabase, type InstantReactRoom };\n"]}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/useQuery.d.ts

@@ -0,0 +1,6 @@
+import { type InstaQLOptions, InstantCoreDatabase, InstaQLLifecycleState, InstantSchemaDef, ValidQuery } from '@instantdb/core';
+export declare function useQueryInternal<Q extends ValidQuery<Q, Schema>, Schema extends InstantSchemaDef<any, any, any>, UseDates extends boolean>(_core: InstantCoreDatabase<Schema, UseDates>, _query: null | Q, _opts?: InstaQLOptions): {
+    state: InstaQLLifecycleState<Schema, Q, UseDates>;
+    query: any;
+};
+//# sourceMappingURL=useQuery.d.ts.map

package/dist/esm/useQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useQuery.d.ts","sourceRoot":"","sources":["../../src/useQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,cAAc,EAEnB,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,EAChB,UAAU,EACX,MAAM,iBAAiB,CAAC;AAoBzB,wBAAgB,gBAAgB,CAC9B,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,EAC/B,MAAM,SAAS,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC9C,QAAQ,SAAS,OAAO,EAExB,KAAK,EAAE,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC,EAC5C,MAAM,EAAE,IAAI,GAAG,CAAC,EAChB,KAAK,CAAC,EAAE,cAAc,GACrB;IACD,KAAK,EAAE,qBAAqB,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClD,KAAK,EAAE,GAAG,CAAC;CACZ,CAyDA"}

package/dist/esm/useQuery.js

@@ -0,0 +1,45 @@
+import { weakHash, coerceQuery, } from '@instantdb/core';
+import { useCallback, useRef, useSyncExternalStore } from 'react';
+const defaultState = {
+    isLoading: true,
+    data: undefined,
+    pageInfo: undefined,
+    error: undefined,
+};
+function stateForResult(result) {
+    return Object.assign({ isLoading: !Boolean(result), data: undefined, pageInfo: undefined, error: undefined }, (result ? result : {}));
+}
+export function useQueryInternal(_core, _query, _opts) {
+    if (_query && _opts && 'ruleParams' in _opts) {
+        _query = Object.assign({ $$ruleParams: _opts['ruleParams'] }, _query);
+    }
+    const query = _query ? coerceQuery(_query) : null;
+    const queryHash = weakHash(query);
+    // We use a ref to store the result of the query.
+    // This is becuase `useSyncExternalStore` uses `Object.is`
+    // to compare the previous and next state.
+    // If we don't use a ref, the state will always be considered different, so
+    // the component will always re-render.
+    const resultCacheRef = useRef(stateForResult(_core._reactor.getPreviousResult(query)));
+    // Similar to `resultCacheRef`, `useSyncExternalStore` will unsubscribe
+    // if `subscribe` changes, so we use `useCallback` to memoize the function.
+    const subscribe = useCallback((cb) => {
+        // Update the ref when the query changes to avoid showing stale data
+        resultCacheRef.current = stateForResult(_core._reactor.getPreviousResult(query));
+        // Don't subscribe if query is null
+        if (!query) {
+            const unsubscribe = () => { };
+            return unsubscribe;
+        }
+        const unsubscribe = _core.subscribeQuery(query, (result) => {
+            resultCacheRef.current = Object.assign({ isLoading: !Boolean(result), data: undefined, pageInfo: undefined, error: undefined }, result);
+            cb();
+        });
+        return unsubscribe;
+    }, 
+    // Build a new subscribe function if the query changes
+    [queryHash]);
+    const state = useSyncExternalStore(subscribe, () => resultCacheRef.current, () => defaultState);
+    return { state, query };
+}
+//# sourceMappingURL=useQuery.js.map

package/dist/esm/useQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useQuery.js","sourceRoot":"","sources":["../../src/useQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,WAAW,GAQZ,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAElE,MAAM,YAAY,GAAG;IACnB,SAAS,EAAE,IAAI;IACf,IAAI,EAAE,SAAS;IACf,QAAQ,EAAE,SAAS;IACnB,KAAK,EAAE,SAAS;CACjB,CAAC;AAEF,SAAS,cAAc,CAAC,MAAW;IACjC,uBACE,SAAS,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,EAC3B,IAAI,EAAE,SAAS,EACf,QAAQ,EAAE,SAAS,EACnB,KAAK,EAAE,SAAS,IACb,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EACzB;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAK9B,KAA4C,EAC5C,MAAgB,EAChB,KAAsB;IAKtB,IAAI,MAAM,IAAI,KAAK,IAAI,YAAY,IAAI,KAAK,EAAE,CAAC;QAC7C,MAAM,mBAAK,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,IAAK,MAAM,CAAE,CAAC;IAC5D,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAClD,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAElC,iDAAiD;IACjD,0DAA0D;IAC1D,0CAA0C;IAC1C,2EAA2E;IAC3E,uCAAuC;IACvC,MAAM,cAAc,GAAG,MAAM,CAC3B,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CACxD,CAAC;IAEF,uEAAuE;IACvE,2EAA2E;IAC3E,MAAM,SAAS,GAAG,WAAW,CAC3B,CAAC,EAAE,EAAE,EAAE;QACL,oEAAoE;QACpE,cAAc,CAAC,OAAO,GAAG,cAAc,CACrC,KAAK,CAAC,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CACxC,CAAC;QAEF,mCAAmC;QACnC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,WAAW,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;YAC7B,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,MAAM,WAAW,GAAG,KAAK,CAAC,cAAc,CAAc,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE;YACtE,cAAc,CAAC,OAAO,mBACpB,SAAS,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,EAC3B,IAAI,EAAE,SAAS,EACf,QAAQ,EAAE,SAAS,EACnB,KAAK,EAAE,SAAS,IACb,MAAM,CACV,CAAC;YAEF,EAAE,EAAE,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,sDAAsD;IACtD,CAAC,SAAS,CAAC,CACZ,CAAC;IAEF,MAAM,KAAK,GAAG,oBAAoB,CAGhC,SAAS,EACT,GAAG,EAAE,CAAC,cAAc,CAAC,OAAO,EAC5B,GAAG,EAAE,CAAC,YAAY,CACnB,CAAC;IACF,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAC1B,CAAC","sourcesContent":["import {\n  weakHash,\n  coerceQuery,\n  type InstaQLParams,\n  type InstaQLOptions,\n  type InstantGraph,\n  InstantCoreDatabase,\n  InstaQLLifecycleState,\n  InstantSchemaDef,\n  ValidQuery,\n} from '@instantdb/core';\nimport { useCallback, useRef, useSyncExternalStore } from 'react';\n\nconst defaultState = {\n  isLoading: true,\n  data: undefined,\n  pageInfo: undefined,\n  error: undefined,\n};\n\nfunction stateForResult(result: any) {\n  return {\n    isLoading: !Boolean(result),\n    data: undefined,\n    pageInfo: undefined,\n    error: undefined,\n    ...(result ? result : {}),\n  };\n}\n\nexport function useQueryInternal<\n  Q extends ValidQuery<Q, Schema>,\n  Schema extends InstantSchemaDef<any, any, any>,\n  UseDates extends boolean,\n>(\n  _core: InstantCoreDatabase<Schema, UseDates>,\n  _query: null | Q,\n  _opts?: InstaQLOptions,\n): {\n  state: InstaQLLifecycleState<Schema, Q, UseDates>;\n  query: any;\n} {\n  if (_query && _opts && 'ruleParams' in _opts) {\n    _query = { $$ruleParams: _opts['ruleParams'], ..._query };\n  }\n  const query = _query ? coerceQuery(_query) : null;\n  const queryHash = weakHash(query);\n\n  // We use a ref to store the result of the query.\n  // This is becuase `useSyncExternalStore` uses `Object.is`\n  // to compare the previous and next state.\n  // If we don't use a ref, the state will always be considered different, so\n  // the component will always re-render.\n  const resultCacheRef = useRef<InstaQLLifecycleState<Schema, Q, UseDates>>(\n    stateForResult(_core._reactor.getPreviousResult(query)),\n  );\n\n  // Similar to `resultCacheRef`, `useSyncExternalStore` will unsubscribe\n  // if `subscribe` changes, so we use `useCallback` to memoize the function.\n  const subscribe = useCallback(\n    (cb) => {\n      // Update the ref when the query changes to avoid showing stale data\n      resultCacheRef.current = stateForResult(\n        _core._reactor.getPreviousResult(query),\n      );\n\n      // Don't subscribe if query is null\n      if (!query) {\n        const unsubscribe = () => {};\n        return unsubscribe;\n      }\n\n      const unsubscribe = _core.subscribeQuery<Q, UseDates>(query, (result) => {\n        resultCacheRef.current = {\n          isLoading: !Boolean(result),\n          data: undefined,\n          pageInfo: undefined,\n          error: undefined,\n          ...result,\n        };\n\n        cb();\n      });\n\n      return unsubscribe;\n    },\n    // Build a new subscribe function if the query changes\n    [queryHash],\n  );\n\n  const state = useSyncExternalStore<\n    InstaQLLifecycleState<Schema, Q, UseDates>\n  >(\n    subscribe,\n    () => resultCacheRef.current,\n    () => defaultState,\n  );\n  return { state, query };\n}\n"]}

package/dist/esm/useTimeout.d.ts

@@ -0,0 +1,5 @@
+export declare function useTimeout(): {
+    set: (delay: number, fn: () => void) => void;
+    clear: () => void;
+};
+//# sourceMappingURL=useTimeout.d.ts.map