@instantdb/vue 0.0.0

package/README.md

@@ -0,0 +1,62 @@
+<p align="center">
+  <a href="https://instantdb.com">
+    <img alt="Shows the Instant logo" src="https://instantdb.com/img/icon/android-chrome-512x512.png" width="10%">
+  </a>
+  <h1 align="center">@instantdb/vue</h1>
+</p>
+
+<p align="center">
+  <a 
+    href="https://discord.com/invite/VU53p7uQcE" >
+    <img height=20 src="https://img.shields.io/discord/1031957483243188235" />
+  </a>
+  <img src="https://img.shields.io/github/stars/instantdb/instant" alt="stars">
+</p>
+
+<p align="center">
+   <a href="https://instantdb.com/dash">Get Started</a> ·
+   <a href="https://instantdb.com/examples">Examples</a> ·
+   <a href="https://instantdb.com/docs">Docs</a> ·
+   <a href="https://discord.com/invite/VU53p7uQcE">Discord</a>
+<p>
+
+Welcome to [Instant's](http://instantdb.com) Vue SDK.
+
+```vue
+<!-- ༼ つ ◕_◕ ༽つ Real-time Chat -->
+<!-- ---------------------------------- -->
+<!-- * Updates instantly -->
+<!-- * Multiplayer -->
+<!-- * Works offline -->
+
+<script setup>
+import { init, id } from '@instantdb/vue';
+
+const db = init({
+  appId: import.meta.env.VITE_INSTANT_APP_ID,
+});
+
+// 1. Read
+const { isLoading, error, data } = db.useQuery({
+  messages: {},
+});
+
+// 2. Write
+const addMessage = (message) => {
+  db.transact(db.tx.messages[id()].update(message));
+};
+</script>
+
+<template>
+  <!-- 3. Render! -->
+  <UI :data="data" @add="addMessage" />
+</template>
+```
+
+# Get Started
+
+Follow the [getting started](https://www.instantdb.com/docs/start-vue) tutorial to set up a live Vue app in under 5 minutes!
+
+# Questions?
+
+If you have any questions, feel free to drop us a line on our [Discord](https://discord.com/invite/VU53p7uQcE)

package/dist/InstantVueDatabase.d.ts

@@ -0,0 +1,189 @@
+import { type User, type ConnectionStatus, type TransactionChunk, type RoomSchemaShape, type InstaQLOptions, type InstantConfig, type PageInfoResponse, type InstaQLResponse, type ValidQuery, Auth, Storage, InstantCoreDatabase, InstantSchemaDef, RoomsOf, IInstantDatabase } from '@instantdb/core';
+import type { Ref, ShallowRef, ComputedRef, MaybeRefOrGetter } from 'vue';
+import { InstantVueRoom } from './InstantVueRoom.js';
+import type { InfiniteQueryResult } from './useInfiniteQuery.js';
+export type UseQueryReturn<Schema extends InstantSchemaDef<any, any, any>, Q extends ValidQuery<Q, Schema>, UseDates extends boolean> = {
+    isLoading: Ref<boolean>;
+    data: ShallowRef<InstaQLResponse<Schema, Q, UseDates> | undefined>;
+    pageInfo: ShallowRef<PageInfoResponse<Q> | undefined>;
+    error: ShallowRef<{
+        message: string;
+    } | undefined>;
+};
+export type UseAuthReturn = {
+    isLoading: Ref<boolean>;
+    user: ShallowRef<User | null | undefined>;
+    error: ShallowRef<{
+        message: string;
+    } | undefined>;
+};
+export declare class InstantVueDatabase<Schema extends InstantSchemaDef<any, any, any>, UseDates extends boolean = false, Rooms extends RoomSchemaShape = RoomsOf<Schema>> implements IInstantDatabase<Schema> {
+    tx: import("@instantdb/core").TxChunk<Schema>;
+    auth: Auth;
+    storage: Storage;
+    core: InstantCoreDatabase<Schema, UseDates>;
+    constructor(core: InstantCoreDatabase<Schema, UseDates>);
+    /**
+     * Returns a unique ID for a given `name`. It's stored in local storage,
+     * so you will get the same ID across sessions.
+     *
+     * @example
+     *  const deviceId = await db.getLocalId('device');
+     */
+    getLocalId: (name: string) => Promise<string>;
+    /**
+     * Use this to write data! You can create, update, delete, and link objects
+     *
+     * @see https://instantdb.com/docs/instaml
+     *
+     * @example
+     *   const goalId = id();
+     *   db.transact(db.tx.goals[goalId].update({title: "Get fit"}))
+     */
+    transact: (chunks: TransactionChunk<any, any> | TransactionChunk<any, any>[]) => Promise<import("@instantdb/core").TransactionResult>;
+    /**
+     * One time query for the logged in state.
+     *
+     * @see https://instantdb.com/docs/auth
+     * @example
+     *   const user = await db.getAuth();
+     *   console.log('logged in as', user.email)
+     */
+    getAuth(): Promise<User | null>;
+    /**
+     * Use this for one-off queries.
+     * Returns local data if available, otherwise fetches from the server.
+     *
+     * @see https://instantdb.com/docs/instaql
+     *
+     * @example
+     *  const resp = await db.queryOnce({ goals: {} });
+     *  console.log(resp.data.goals)
+     */
+    queryOnce: <Q extends ValidQuery<Q, Schema>>(query: Q, opts?: InstaQLOptions) => Promise<{
+        data: InstaQLResponse<Schema, Q, UseDates>;
+        pageInfo: PageInfoResponse<Q>;
+    }>;
+    /**
+     * Use this to query your data!
+     *
+     * @see https://instantdb.com/docs/instaql
+     *
+     * @example
+     *   // basic query — refs auto-unwrap in templates
+     *   const { isLoading, error, data } = db.useQuery({ goals: {} });
+     *
+     * @example
+     *   // reactive query — pass a getter that returns null to skip
+     *   const { user } = db.useAuth();
+     *   const { data } = db.useQuery(() =>
+     *     user.value ? { todos: { $: { where: { 'owner.id': user.value.id } } } } : null,
+     *   );
+     *
+     * @example
+     *   // pass a ref directly
+     *   const query = ref<{ todos: {} } | null>({ todos: {} });
+     *   const { data } = db.useQuery(query);
+     */
+    useQuery: <Q extends ValidQuery<Q, Schema>>(query: MaybeRefOrGetter<Q | null>, opts?: MaybeRefOrGetter<InstaQLOptions | null | undefined>) => UseQueryReturn<Schema, Q, UseDates>;
+    /**
+     * Subscribe to a query and incrementally load more items.
+     *
+     * Only one top-level namespace in the query is allowed.
+     *
+     * @example
+     *  const { data, isLoading, error, loadNextPage, canLoadNextPage } =
+     *    db.useInfiniteQuery({
+     *      posts: { $: { limit: 20, order: { createdAt: 'desc' } } },
+     *    });
+     */
+    useInfiniteQuery: <Q extends ValidQuery<Q, Schema>>(query: MaybeRefOrGetter<Q | null>, opts?: MaybeRefOrGetter<InstaQLOptions | undefined>) => InfiniteQueryResult<Schema, Q, UseDates>;
+    /**
+     * Listen for the logged in state. This is useful
+     * for deciding when to show a login screen.
+     *
+     * @see https://instantdb.com/docs/auth
+     * @example
+     *  const { isLoading, user, error } = db.useAuth();
+     */
+    useAuth: () => UseAuthReturn;
+    /**
+     * Subscribe to the currently logged in user. Throws if the user isn't
+     * signed in when `.value` is accessed — wrap callers with `<SignedIn>` or
+     * a `useAuth` check.
+     *
+     * @see https://instantdb.com/docs/auth
+     * @example
+     *  const user = db.useUser();
+     *  // user.value.email
+     */
+    useUser: () => ComputedRef<User>;
+    /**
+     * Listen for connection status changes to Instant.
+     *
+     * @see https://www.instantdb.com/docs/patterns#connection-status
+     * @example
+     *  const status = db.useConnectionStatus();
+     *  // status.value
+     */
+    useConnectionStatus: () => Ref<ConnectionStatus>;
+    /**
+     * A hook that returns a unique ID for a given `name`. localIds are stored in
+     * local storage, so you get the same ID across sessions.
+     *
+     * Returns `null` initially, then the loaded ID.
+     *
+     * @example
+     *  const deviceId = db.useLocalId('device');
+     *  // deviceId.value is null initially, then the ID string
+     */
+    useLocalId: (name: MaybeRefOrGetter<string>) => Ref<string | null>;
+    /**
+     * Obtain a handle to a room, which allows you to listen to topics and presence data
+     *
+     * @see https://instantdb.com/docs/presence-and-topics
+     *
+     * @example
+     *  const room = db.room('chat', roomId);
+     *  const { peers } = db.rooms.usePresence(room);
+     */
+    room<RoomType extends string & keyof Rooms>(type?: MaybeRefOrGetter<RoomType | undefined>, id?: MaybeRefOrGetter<string | undefined>): InstantVueRoom<Schema, Rooms, RoomType>;
+    /**
+     * Hooks for working with rooms
+     *
+     * @see https://instantdb.com/docs/presence-and-topics
+     *
+     * @example
+     *  const room = db.room('chat', roomId);
+     *  const { peers } = db.rooms.usePresence(room);
+     *  const publish = db.rooms.usePublishTopic(room, 'emoji');
+     */
+    rooms: {
+        useTopicEffect: typeof import("./InstantVueRoom.js").useTopicEffect;
+        usePublishTopic: typeof import("./InstantVueRoom.js").usePublishTopic;
+        usePresence: typeof import("./InstantVueRoom.js").usePresence;
+        useSyncPresence: typeof import("./InstantVueRoom.js").useSyncPresence;
+        useTypingIndicator: typeof import("./InstantVueRoom.js").useTypingIndicator;
+    };
+}
+/**
+ * The first step: init your application!
+ *
+ * Visit https://instantdb.com/dash to get your `appId` :)
+ *
+ * @example
+ *  import { init } from "@instantdb/vue"
+ *
+ *  const db = init({ appId: "my-app-id" })
+ *
+ *  // You can also provide a schema for type safety and editor autocomplete!
+ *
+ *  import { init } from "@instantdb/vue"
+ *  import schema from "../instant.schema.ts";
+ *
+ *  const db = init({ appId: "my-app-id", schema })
+ */
+export declare function init<Schema extends InstantSchemaDef<any, any, any>, UseDates extends boolean = false>(config: Omit<InstantConfig<Schema, UseDates>, 'useDateObjects'> & {
+    useDateObjects?: UseDates;
+}): InstantVueDatabase<Schema, UseDates>;
+//# sourceMappingURL=InstantVueDatabase.d.ts.map

package/dist/InstantVueDatabase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstantVueDatabase.d.ts","sourceRoot":"","sources":["../src/InstantVueDatabase.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,IAAI,EACT,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,UAAU,EAEf,IAAI,EACJ,OAAO,EAEP,mBAAmB,EAInB,gBAAgB,EAChB,OAAO,EAEP,gBAAgB,EACjB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,KAAK,CAAC;AAE1E,OAAO,EAAE,cAAc,EAAS,MAAM,qBAAqB,CAAC;AAG5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAMjE,MAAM,MAAM,cAAc,CACxB,MAAM,SAAS,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC9C,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,EAC/B,QAAQ,SAAS,OAAO,IACtB;IACF,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACxB,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,GAAG,SAAS,CAAC,CAAC;IACnE,QAAQ,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IACtD,KAAK,EAAE,UAAU,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC,CAAC;CACpD,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACxB,IAAI,EAAE,UAAU,CAAC,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;IAC1C,KAAK,EAAE,UAAU,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC,CAAC;CACpD,CAAC;AAEF,qBAAa,kBAAkB,CAC7B,MAAM,SAAS,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC9C,QAAQ,SAAS,OAAO,GAAG,KAAK,EAChC,KAAK,SAAS,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAC/C,YAAW,gBAAgB,CAAC,MAAM,CAAC;IAE5B,EAAE,4CAAoB;IAEtB,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;gBAEvC,IAAI,EAAE,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC;IAMvD;;;;;;OAMG;IACH,UAAU,GAAI,MAAM,MAAM,KAAG,OAAO,CAAC,MAAM,CAAC,CAE1C;IAEF;;;;;;;;OAQG;IACH,QAAQ,GACN,QAAQ,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,0DAGjE;IAEF;;;;;;;OAOG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAI/B;;;;;;;;;OASG;IACH,SAAS,GAAI,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,EAC1C,OAAO,CAAC,EACR,OAAO,cAAc,KACpB,OAAO,CAAC;QACT,IAAI,EAAE,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC3C,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;KAC/B,CAAC,CAEA;IAKF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,GAAI,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,EACzC,OAAO,gBAAgB,CAAC,CAAC,GAAG,IAAI,CAAC,EACjC,OAAO,gBAAgB,CAAC,cAAc,GAAG,IAAI,GAAG,SAAS,CAAC,KACzD,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,CAmDpC;IAEF;;;;;;;;;;OAUG;IACH,gBAAgB,GAAI,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,EACjD,OAAO,gBAAgB,CAAC,CAAC,GAAG,IAAI,CAAC,EACjC,OAAO,gBAAgB,CAAC,cAAc,GAAG,SAAS,CAAC,KAClD,mBAAmB,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,CAEzC;IAEF;;;;;;;OAOG;IACH,OAAO,QAAO,aAAa,CAkBzB;IAEF;;;;;;;;;OASG;IACH,OAAO,QAAO,WAAW,CAAC,IAAI,CAAC,CAU7B;IAEF;;;;;;;OAOG;IACH,mBAAmB,QAAO,GAAG,CAAC,gBAAgB,CAAC,CAY7C;IAEF;;;;;;;;;OASG;IACH,UAAU,GAAI,MAAM,gBAAgB,CAAC,MAAM,CAAC,KAAG,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,CAkB/D;IAEF;;;;;;;;OAQG;IACH,IAAI,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM,KAAK,EACxC,IAAI,CAAC,EAAE,gBAAgB,CAAC,QAAQ,GAAG,SAAS,CAAC,EAC7C,EAAE,CAAC,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC;IAS3C;;;;;;;;;OASG;IACH,KAAK;;;;;;MAAS;CACf;AAKD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAClB,MAAM,SAAS,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC9C,QAAQ,SAAS,OAAO,GAAG,KAAK,EAEhC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,gBAAgB,CAAC,GAAG;IAChE,cAAc,CAAC,EAAE,QAAQ,CAAC;CAC3B,GACA,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAKtC"}

package/dist/InstantVueDatabase.js

@@ -0,0 +1,265 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+import { init as init$1, txInit, coerceQuery, weakHash, InstantError } from "@instantdb/core";
+import { ref, shallowRef, computed, toValue, watch } from "vue";
+import { InstantVueRoom, rooms } from "./InstantVueRoom.js";
+import { tryOnScopeDispose } from "./utils.js";
+import { useInfiniteQuery } from "./useInfiniteQuery.js";
+import { version } from "@instantdb/version";
+class InstantVueDatabase {
+  constructor(core) {
+    __publicField(this, "tx", txInit());
+    __publicField(this, "auth");
+    __publicField(this, "storage");
+    __publicField(this, "core");
+    /**
+     * Returns a unique ID for a given `name`. It's stored in local storage,
+     * so you will get the same ID across sessions.
+     *
+     * @example
+     *  const deviceId = await db.getLocalId('device');
+     */
+    __publicField(this, "getLocalId", (name) => {
+      return this.core.getLocalId(name);
+    });
+    /**
+     * Use this to write data! You can create, update, delete, and link objects
+     *
+     * @see https://instantdb.com/docs/instaml
+     *
+     * @example
+     *   const goalId = id();
+     *   db.transact(db.tx.goals[goalId].update({title: "Get fit"}))
+     */
+    __publicField(this, "transact", (chunks) => {
+      return this.core.transact(chunks);
+    });
+    /**
+     * Use this for one-off queries.
+     * Returns local data if available, otherwise fetches from the server.
+     *
+     * @see https://instantdb.com/docs/instaql
+     *
+     * @example
+     *  const resp = await db.queryOnce({ goals: {} });
+     *  console.log(resp.data.goals)
+     */
+    __publicField(this, "queryOnce", (query, opts) => {
+      return this.core.queryOnce(query, opts);
+    });
+    // -----------
+    // Vue reactive hooks
+    /**
+     * Use this to query your data!
+     *
+     * @see https://instantdb.com/docs/instaql
+     *
+     * @example
+     *   // basic query — refs auto-unwrap in templates
+     *   const { isLoading, error, data } = db.useQuery({ goals: {} });
+     *
+     * @example
+     *   // reactive query — pass a getter that returns null to skip
+     *   const { user } = db.useAuth();
+     *   const { data } = db.useQuery(() =>
+     *     user.value ? { todos: { $: { where: { 'owner.id': user.value.id } } } } : null,
+     *   );
+     *
+     * @example
+     *   // pass a ref directly
+     *   const query = ref<{ todos: {} } | null>({ todos: {} });
+     *   const { data } = db.useQuery(query);
+     */
+    __publicField(this, "useQuery", (query, opts) => {
+      const isLoading = ref(true);
+      const data = shallowRef(
+        void 0
+      );
+      const pageInfo = shallowRef(void 0);
+      const error = shallowRef(void 0);
+      const resolvedQuery = computed(() => {
+        const q = toValue(query);
+        if (!q) return null;
+        const o = toValue(opts);
+        const withParams = o && "ruleParams" in o ? { $$ruleParams: o.ruleParams, ...q } : q;
+        return coerceQuery(withParams);
+      });
+      const queryHash = computed(() => weakHash(resolvedQuery.value));
+      const stop = watch(
+        queryHash,
+        (_, __, onCleanup) => {
+          const q = resolvedQuery.value;
+          const cached = q ? this.core._reactor.getPreviousResult(q) : null;
+          isLoading.value = !cached;
+          data.value = cached == null ? void 0 : cached.data;
+          pageInfo.value = cached == null ? void 0 : cached.pageInfo;
+          error.value = cached == null ? void 0 : cached.error;
+          if (!q) return;
+          const unsub = this.core.subscribeQuery(q, (r) => {
+            isLoading.value = false;
+            data.value = r.data;
+            pageInfo.value = r.pageInfo;
+            error.value = r.error;
+          });
+          onCleanup(unsub);
+        },
+        { immediate: true }
+      );
+      tryOnScopeDispose(stop);
+      return { isLoading, data, pageInfo, error };
+    });
+    /**
+     * Subscribe to a query and incrementally load more items.
+     *
+     * Only one top-level namespace in the query is allowed.
+     *
+     * @example
+     *  const { data, isLoading, error, loadNextPage, canLoadNextPage } =
+     *    db.useInfiniteQuery({
+     *      posts: { $: { limit: 20, order: { createdAt: 'desc' } } },
+     *    });
+     */
+    __publicField(this, "useInfiniteQuery", (query, opts) => {
+      return useInfiniteQuery(this.core, query, opts);
+    });
+    /**
+     * Listen for the logged in state. This is useful
+     * for deciding when to show a login screen.
+     *
+     * @see https://instantdb.com/docs/auth
+     * @example
+     *  const { isLoading, user, error } = db.useAuth();
+     */
+    __publicField(this, "useAuth", () => {
+      const cached = this.core._reactor._currentUserCached;
+      const isLoading = ref((cached == null ? void 0 : cached.isLoading) ?? true);
+      const user = shallowRef(cached == null ? void 0 : cached.user);
+      const error = shallowRef(cached == null ? void 0 : cached.error);
+      const unsub = this.core.subscribeAuth((auth) => {
+        isLoading.value = false;
+        user.value = auth.user ?? null;
+        error.value = auth.error;
+      });
+      tryOnScopeDispose(unsub);
+      return { isLoading, user, error };
+    });
+    /**
+     * Subscribe to the currently logged in user. Throws if the user isn't
+     * signed in when `.value` is accessed — wrap callers with `<SignedIn>` or
+     * a `useAuth` check.
+     *
+     * @see https://instantdb.com/docs/auth
+     * @example
+     *  const user = db.useUser();
+     *  // user.value.email
+     */
+    __publicField(this, "useUser", () => {
+      const { user } = this.useAuth();
+      return computed(() => {
+        if (!user.value) {
+          throw new InstantError(
+            "useUser must be used within an auth-protected route"
+          );
+        }
+        return user.value;
+      });
+    });
+    /**
+     * Listen for connection status changes to Instant.
+     *
+     * @see https://www.instantdb.com/docs/patterns#connection-status
+     * @example
+     *  const status = db.useConnectionStatus();
+     *  // status.value
+     */
+    __publicField(this, "useConnectionStatus", () => {
+      const status = ref(
+        this.core._reactor.status
+      );
+      const unsub = this.core.subscribeConnectionStatus((newStatus) => {
+        status.value = newStatus;
+      });
+      tryOnScopeDispose(unsub);
+      return status;
+    });
+    /**
+     * A hook that returns a unique ID for a given `name`. localIds are stored in
+     * local storage, so you get the same ID across sessions.
+     *
+     * Returns `null` initially, then the loaded ID.
+     *
+     * @example
+     *  const deviceId = db.useLocalId('device');
+     *  // deviceId.value is null initially, then the ID string
+     */
+    __publicField(this, "useLocalId", (name) => {
+      const localId = ref(null);
+      const stop = watch(
+        () => toValue(name),
+        (currentName) => {
+          this.getLocalId(currentName).then((id) => {
+            if (toValue(name) === currentName) {
+              localId.value = id;
+            }
+          });
+        },
+        { immediate: true }
+      );
+      tryOnScopeDispose(stop);
+      return localId;
+    });
+    /**
+     * Hooks for working with rooms
+     *
+     * @see https://instantdb.com/docs/presence-and-topics
+     *
+     * @example
+     *  const room = db.room('chat', roomId);
+     *  const { peers } = db.rooms.usePresence(room);
+     *  const publish = db.rooms.usePublishTopic(room, 'emoji');
+     */
+    __publicField(this, "rooms", rooms);
+    this.core = core;
+    this.auth = this.core.auth;
+    this.storage = this.core.storage;
+  }
+  /**
+   * One time query for the logged in state.
+   *
+   * @see https://instantdb.com/docs/auth
+   * @example
+   *   const user = await db.getAuth();
+   *   console.log('logged in as', user.email)
+   */
+  getAuth() {
+    return this.core.getAuth();
+  }
+  /**
+   * Obtain a handle to a room, which allows you to listen to topics and presence data
+   *
+   * @see https://instantdb.com/docs/presence-and-topics
+   *
+   * @example
+   *  const room = db.room('chat', roomId);
+   *  const { peers } = db.rooms.usePresence(room);
+   */
+  room(type, id) {
+    const _type = computed(
+      () => toValue(type) ?? "_defaultRoomType"
+    );
+    const _id = computed(() => toValue(id) ?? "_defaultRoomId");
+    return new InstantVueRoom(this.core, _type, _id);
+  }
+}
+function init(config) {
+  const coreDb = init$1(config, void 0, void 0, {
+    "@instantdb/vue": version
+  });
+  return new InstantVueDatabase(coreDb);
+}
+export {
+  InstantVueDatabase,
+  init
+};
+//# sourceMappingURL=InstantVueDatabase.js.map

package/dist/InstantVueDatabase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstantVueDatabase.js","sources":["../src/InstantVueDatabase.ts"],"sourcesContent":["import {\n  // types\n  type AuthState,\n  type User,\n  type ConnectionStatus,\n  type TransactionChunk,\n  type RoomSchemaShape,\n  type InstaQLOptions,\n  type InstantConfig,\n  type PageInfoResponse,\n  type InstaQLResponse,\n  type ValidQuery,\n  // classes\n  Auth,\n  Storage,\n  txInit,\n  InstantCoreDatabase,\n  init as core_init,\n  coerceQuery,\n  weakHash,\n  InstantSchemaDef,\n  RoomsOf,\n  InstantError,\n  IInstantDatabase,\n} from '@instantdb/core';\n\nimport { ref, shallowRef, computed, watch, toValue } from 'vue';\nimport type { Ref, ShallowRef, ComputedRef, MaybeRefOrGetter } from 'vue';\n\nimport { InstantVueRoom, rooms } from './InstantVueRoom.js';\nimport { tryOnScopeDispose } from './utils.js';\nimport { useInfiniteQuery } from './useInfiniteQuery.js';\nimport type { InfiniteQueryResult } from './useInfiniteQuery.js';\nimport version from './version.js';\n\n// ------\n// Types\n\nexport type UseQueryReturn<\n  Schema extends InstantSchemaDef<any, any, any>,\n  Q extends ValidQuery<Q, Schema>,\n  UseDates extends boolean,\n> = {\n  isLoading: Ref<boolean>;\n  data: ShallowRef<InstaQLResponse<Schema, Q, UseDates> | undefined>;\n  pageInfo: ShallowRef<PageInfoResponse<Q> | undefined>;\n  error: ShallowRef<{ message: string } | undefined>;\n};\n\nexport type UseAuthReturn = {\n  isLoading: Ref<boolean>;\n  user: ShallowRef<User | null | undefined>;\n  error: ShallowRef<{ message: string } | undefined>;\n};\n\nexport class InstantVueDatabase<\n  Schema extends InstantSchemaDef<any, any, any>,\n  UseDates extends boolean = 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, UseDates>;\n\n  constructor(core: InstantCoreDatabase<Schema, UseDates>) {\n    this.core = 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   * @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   * 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   *   const goalId = id();\n   *   db.transact(db.tx.goals[goalId].update({title: \"Get fit\"}))\n   */\n  transact = (\n    chunks: TransactionChunk<any, any> | TransactionChunk<any, any>[],\n  ) => {\n    return this.core.transact(chunks);\n  };\n\n  /**\n   * One time query for the logged in state.\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   * Use this for one-off queries.\n   * Returns local data if available, otherwise fetches from the server.\n   *\n   * @see https://instantdb.com/docs/instaql\n   *\n   * @example\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, UseDates>;\n    pageInfo: PageInfoResponse<Q>;\n  }> => {\n    return this.core.queryOnce(query, opts);\n  };\n\n  // -----------\n  // Vue reactive hooks\n\n  /**\n   * Use this to query your data!\n   *\n   * @see https://instantdb.com/docs/instaql\n   *\n   * @example\n   *   // basic query — refs auto-unwrap in templates\n   *   const { isLoading, error, data } = db.useQuery({ goals: {} });\n   *\n   * @example\n   *   // reactive query — pass a getter that returns null to skip\n   *   const { user } = db.useAuth();\n   *   const { data } = db.useQuery(() =>\n   *     user.value ? { todos: { $: { where: { 'owner.id': user.value.id } } } } : null,\n   *   );\n   *\n   * @example\n   *   // pass a ref directly\n   *   const query = ref<{ todos: {} } | null>({ todos: {} });\n   *   const { data } = db.useQuery(query);\n   */\n  useQuery = <Q extends ValidQuery<Q, Schema>>(\n    query: MaybeRefOrGetter<Q | null>,\n    opts?: MaybeRefOrGetter<InstaQLOptions | null | undefined>,\n  ): UseQueryReturn<Schema, Q, UseDates> => {\n    const isLoading = ref(true);\n    const data = shallowRef<InstaQLResponse<Schema, Q, UseDates> | undefined>(\n      undefined,\n    );\n    const pageInfo = shallowRef<PageInfoResponse<Q> | undefined>(undefined);\n    const error = shallowRef<{ message: string } | undefined>(undefined);\n\n    const resolvedQuery = computed(() => {\n      const q = toValue(query);\n      if (!q) return null;\n      const o = toValue(opts);\n      const withParams =\n        o && 'ruleParams' in o\n          ? ({ $$ruleParams: (o as any).ruleParams, ...q } as Q)\n          : q;\n      return coerceQuery(withParams);\n    });\n\n    const queryHash = computed(() => weakHash(resolvedQuery.value));\n\n    const stop = watch(\n      queryHash,\n      (_, __, onCleanup) => {\n        const q = resolvedQuery.value;\n        const cached: any = q ? this.core._reactor.getPreviousResult(q) : null;\n        isLoading.value = !cached;\n        data.value = cached?.data;\n        pageInfo.value = cached?.pageInfo;\n        error.value = cached?.error;\n\n        if (!q) return;\n\n        const unsub = this.core.subscribeQuery<Q, UseDates>(q, (r: any) => {\n          isLoading.value = false;\n          data.value = r.data;\n          pageInfo.value = r.pageInfo;\n          error.value = r.error;\n        });\n        onCleanup(unsub);\n      },\n      { immediate: true },\n    );\n\n    tryOnScopeDispose(stop);\n\n    return { isLoading, data, pageInfo, error } as UseQueryReturn<\n      Schema,\n      Q,\n      UseDates\n    >;\n  };\n\n  /**\n   * Subscribe to a query and incrementally load more items.\n   *\n   * Only one top-level namespace in the query is allowed.\n   *\n   * @example\n   *  const { data, isLoading, error, loadNextPage, canLoadNextPage } =\n   *    db.useInfiniteQuery({\n   *      posts: { $: { limit: 20, order: { createdAt: 'desc' } } },\n   *    });\n   */\n  useInfiniteQuery = <Q extends ValidQuery<Q, Schema>>(\n    query: MaybeRefOrGetter<Q | null>,\n    opts?: MaybeRefOrGetter<InstaQLOptions | undefined>,\n  ): InfiniteQueryResult<Schema, Q, UseDates> => {\n    return useInfiniteQuery<Schema, Q, UseDates>(this.core, query, opts);\n  };\n\n  /**\n   * Listen for the logged in state. This is useful\n   * for deciding when to show a login screen.\n   *\n   * @see https://instantdb.com/docs/auth\n   * @example\n   *  const { isLoading, user, error } = db.useAuth();\n   */\n  useAuth = (): UseAuthReturn => {\n    const cached = this.core._reactor._currentUserCached as\n      | AuthState\n      | undefined;\n\n    const isLoading = ref(cached?.isLoading ?? true);\n    const user = shallowRef<User | null | undefined>(cached?.user);\n    const error = shallowRef<{ message: string } | undefined>(cached?.error);\n\n    const unsub = this.core.subscribeAuth((auth: any) => {\n      isLoading.value = false;\n      user.value = auth.user ?? null;\n      error.value = auth.error;\n    });\n\n    tryOnScopeDispose(unsub);\n\n    return { isLoading, user, error };\n  };\n\n  /**\n   * Subscribe to the currently logged in user. Throws if the user isn't\n   * signed in when `.value` is accessed — wrap callers with `<SignedIn>` or\n   * a `useAuth` check.\n   *\n   * @see https://instantdb.com/docs/auth\n   * @example\n   *  const user = db.useUser();\n   *  // user.value.email\n   */\n  useUser = (): ComputedRef<User> => {\n    const { user } = this.useAuth();\n    return computed(() => {\n      if (!user.value) {\n        throw new InstantError(\n          'useUser must be used within an auth-protected route',\n        );\n      }\n      return user.value;\n    });\n  };\n\n  /**\n   * Listen for connection status changes to Instant.\n   *\n   * @see https://www.instantdb.com/docs/patterns#connection-status\n   * @example\n   *  const status = db.useConnectionStatus();\n   *  // status.value\n   */\n  useConnectionStatus = (): Ref<ConnectionStatus> => {\n    const status = ref<ConnectionStatus>(\n      this.core._reactor.status as ConnectionStatus,\n    );\n\n    const unsub = this.core.subscribeConnectionStatus((newStatus) => {\n      status.value = newStatus;\n    });\n\n    tryOnScopeDispose(unsub);\n\n    return status;\n  };\n\n  /**\n   * A hook that returns a unique ID for a given `name`. localIds are stored in\n   * local storage, so you get the same ID across sessions.\n   *\n   * Returns `null` initially, then the loaded ID.\n   *\n   * @example\n   *  const deviceId = db.useLocalId('device');\n   *  // deviceId.value is null initially, then the ID string\n   */\n  useLocalId = (name: MaybeRefOrGetter<string>): Ref<string | null> => {\n    const localId = ref<string | null>(null);\n\n    const stop = watch(\n      () => toValue(name),\n      (currentName) => {\n        this.getLocalId(currentName).then((id) => {\n          // Drop a late resolve if `name` has since changed.\n          if (toValue(name) === currentName) {\n            localId.value = id;\n          }\n        });\n      },\n      { immediate: true },\n    );\n\n    tryOnScopeDispose(stop);\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   * @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 string & keyof Rooms>(\n    type?: MaybeRefOrGetter<RoomType | undefined>,\n    id?: MaybeRefOrGetter<string | undefined>,\n  ) {\n    const _type = computed(\n      () => (toValue(type) ?? '_defaultRoomType') as RoomType,\n    );\n    const _id = computed(() => toValue(id) ?? '_defaultRoomId');\n    return new InstantVueRoom<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  rooms = rooms;\n}\n\n// -----------\n// init\n\n/**\n * The first step: init your application!\n *\n * Visit https://instantdb.com/dash to get your `appId` :)\n *\n * @example\n *  import { init } from \"@instantdb/vue\"\n *\n *  const db = init({ appId: \"my-app-id\" })\n *\n *  // You can also provide a schema for type safety and editor autocomplete!\n *\n *  import { init } from \"@instantdb/vue\"\n *  import schema from \"../instant.schema.ts\";\n *\n *  const db = init({ appId: \"my-app-id\", schema })\n */\nexport function init<\n  Schema extends InstantSchemaDef<any, any, any>,\n  UseDates extends boolean = false,\n>(\n  config: Omit<InstantConfig<Schema, UseDates>, 'useDateObjects'> & {\n    useDateObjects?: UseDates;\n  },\n): InstantVueDatabase<Schema, UseDates> {\n  const coreDb = core_init<Schema, UseDates>(config, undefined, undefined, {\n    '@instantdb/vue': version,\n  });\n  return new InstantVueDatabase<Schema, UseDates>(coreDb);\n}\n"],"names":["core_init"],"mappings":";;;;;;;;;AAuDO,MAAM,mBAKb;AAAA,EAOE,YAAY,MAA6C;AANlD,8BAAK,OAAe;AAEpB;AACA;AACA;AAeP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sCAAa,CAAC,SAAkC;AACvC,aAAA,KAAK,KAAK,WAAW,IAAI;AAAA,IAClC;AAWA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oCAAW,CACT,WACG;AACI,aAAA,KAAK,KAAK,SAAS,MAAM;AAAA,IAClC;AAwBA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qCAAY,CACV,OACA,SAII;AACJ,aAAO,KAAK,KAAK,UAAU,OAAO,IAAI;AAAA,IACxC;AA0BA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oCAAW,CACT,OACA,SACwC;AAClC,YAAA,YAAY,IAAI,IAAI;AAC1B,YAAM,OAAO;AAAA,QACX;AAAA,MACF;AACM,YAAA,WAAW,WAA4C,MAAS;AAChE,YAAA,QAAQ,WAA4C,MAAS;AAE7D,YAAA,gBAAgB,SAAS,MAAM;AAC7B,cAAA,IAAI,QAAQ,KAAK;AACnB,YAAA,CAAC,EAAU,QAAA;AACT,cAAA,IAAI,QAAQ,IAAI;AAChB,cAAA,aACJ,KAAK,gBAAgB,IAChB,EAAE,cAAe,EAAU,YAAY,GAAG,EAAA,IAC3C;AACN,eAAO,YAAY,UAAU;AAAA,MAAA,CAC9B;AAED,YAAM,YAAY,SAAS,MAAM,SAAS,cAAc,KAAK,CAAC;AAE9D,YAAM,OAAO;AAAA,QACX;AAAA,QACA,CAAC,GAAG,IAAI,cAAc;AACpB,gBAAM,IAAI,cAAc;AACxB,gBAAM,SAAc,IAAI,KAAK,KAAK,SAAS,kBAAkB,CAAC,IAAI;AAClE,oBAAU,QAAQ,CAAC;AACnB,eAAK,QAAQ,iCAAQ;AACrB,mBAAS,QAAQ,iCAAQ;AACzB,gBAAM,QAAQ,iCAAQ;AAEtB,cAAI,CAAC,EAAG;AAER,gBAAM,QAAQ,KAAK,KAAK,eAA4B,GAAG,CAAC,MAAW;AACjE,sBAAU,QAAQ;AAClB,iBAAK,QAAQ,EAAE;AACf,qBAAS,QAAQ,EAAE;AACnB,kBAAM,QAAQ,EAAE;AAAA,UAAA,CACjB;AACD,oBAAU,KAAK;AAAA,QACjB;AAAA,QACA,EAAE,WAAW,KAAK;AAAA,MACpB;AAEA,wBAAkB,IAAI;AAEtB,aAAO,EAAE,WAAW,MAAM,UAAU,MAAM;AAAA,IAK5C;AAaA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,4CAAmB,CACjB,OACA,SAC6C;AAC7C,aAAO,iBAAsC,KAAK,MAAM,OAAO,IAAI;AAAA,IACrE;AAUA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mCAAU,MAAqB;AACvB,YAAA,SAAS,KAAK,KAAK,SAAS;AAIlC,YAAM,YAAY,KAAI,iCAAQ,cAAa,IAAI;AACzC,YAAA,OAAO,WAAoC,iCAAQ,IAAI;AACvD,YAAA,QAAQ,WAA4C,iCAAQ,KAAK;AAEvE,YAAM,QAAQ,KAAK,KAAK,cAAc,CAAC,SAAc;AACnD,kBAAU,QAAQ;AACb,aAAA,QAAQ,KAAK,QAAQ;AAC1B,cAAM,QAAQ,KAAK;AAAA,MAAA,CACpB;AAED,wBAAkB,KAAK;AAEhB,aAAA,EAAE,WAAW,MAAM,MAAM;AAAA,IAClC;AAYA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mCAAU,MAAyB;AACjC,YAAM,EAAE,KAAA,IAAS,KAAK,QAAQ;AAC9B,aAAO,SAAS,MAAM;AAChB,YAAA,CAAC,KAAK,OAAO;AACf,gBAAM,IAAI;AAAA,YACR;AAAA,UACF;AAAA,QAAA;AAEF,eAAO,KAAK;AAAA,MAAA,CACb;AAAA,IACH;AAUA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,+CAAsB,MAA6B;AACjD,YAAM,SAAS;AAAA,QACb,KAAK,KAAK,SAAS;AAAA,MACrB;AAEA,YAAM,QAAQ,KAAK,KAAK,0BAA0B,CAAC,cAAc;AAC/D,eAAO,QAAQ;AAAA,MAAA,CAChB;AAED,wBAAkB,KAAK;AAEhB,aAAA;AAAA,IACT;AAYA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sCAAa,CAAC,SAAuD;AAC7D,YAAA,UAAU,IAAmB,IAAI;AAEvC,YAAM,OAAO;AAAA,QACX,MAAM,QAAQ,IAAI;AAAA,QAClB,CAAC,gBAAgB;AACf,eAAK,WAAW,WAAW,EAAE,KAAK,CAAC,OAAO;AAEpC,gBAAA,QAAQ,IAAI,MAAM,aAAa;AACjC,sBAAQ,QAAQ;AAAA,YAAA;AAAA,UAClB,CACD;AAAA,QACH;AAAA,QACA,EAAE,WAAW,KAAK;AAAA,MACpB;AAEA,wBAAkB,IAAI;AACf,aAAA;AAAA,IACT;AAgCA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,iCAAQ;AArSN,SAAK,OAAO;AACP,SAAA,OAAO,KAAK,KAAK;AACjB,SAAA,UAAU,KAAK,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqC3B,UAAgC;AACvB,WAAA,KAAK,KAAK,QAAQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwO3B,KACE,MACA,IACA;AACA,UAAM,QAAQ;AAAA,MACZ,MAAO,QAAQ,IAAI,KAAK;AAAA,IAC1B;AACA,UAAM,MAAM,SAAS,MAAM,QAAQ,EAAE,KAAK,gBAAgB;AAC1D,WAAO,IAAI,eAAwC,KAAK,MAAM,OAAO,GAAG;AAAA,EAAA;AAc5E;AAsBO,SAAS,KAId,QAGsC;AACtC,QAAM,SAASA,OAA4B,QAAQ,QAAW,QAAW;AAAA,IACvE,kBAAkB;AAAA,EAAA,CACnB;AACM,SAAA,IAAI,mBAAqC,MAAM;AACxD;"}

package/dist/InstantVueRoom.d.ts

@@ -0,0 +1,84 @@
+import { type PresenceOpts, type PresenceResponse, type RoomSchemaShape, InstantCoreDatabase, InstantSchemaDef } from '@instantdb/core';
+import type { Ref, ShallowRef, MaybeRefOrGetter, ComputedRef } from 'vue';
+export type PresenceHandle<PresenceShape, Keys extends keyof PresenceShape> = {
+    [K in keyof PresenceResponse<PresenceShape, Keys>]: ShallowRef<PresenceResponse<PresenceShape, Keys>[K]>;
+} & {
+    publishPresence: (data: Partial<PresenceShape>) => void;
+};
+export type TypingIndicatorOpts = {
+    timeout?: number | null;
+    stopOnEnter?: boolean;
+    writeOnly?: boolean;
+};
+export type TypingIndicatorHandle<PresenceShape> = {
+    active: Ref<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
+ *  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: InstantVueRoom<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
+ *  const room = db.room('chat', roomId);
+ *  const publishTopic = db.rooms.usePublishTopic(room, 'emoji');
+ *  publishTopic({ emoji: "🔥" });
+ */
+export declare function usePublishTopic<RoomSchema extends RoomSchemaShape, RoomType extends keyof RoomSchema, TopicType extends keyof RoomSchema[RoomType]['topics']>(room: InstantVueRoom<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
+ *  const room = db.room('chat', roomId);
+ *  const { peers, isLoading, publishPresence } = db.rooms.usePresence(room, { keys: ["name", "avatar"] });
+ */
+export declare function usePresence<RoomSchema extends RoomSchemaShape, RoomType extends keyof RoomSchema, Keys extends keyof RoomSchema[RoomType]['presence']>(room: InstantVueRoom<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
+ *  const room = db.room('chat', roomId);
+ *  db.rooms.useSyncPresence(room, { nickname });
+ */
+export declare function useSyncPresence<RoomSchema extends RoomSchemaShape, RoomType extends keyof RoomSchema>(room: InstantVueRoom<any, RoomSchema, RoomType>, data: MaybeRefOrGetter<Partial<RoomSchema[RoomType]['presence']>>): void;
+/**
+ * Manage typing indicator state
+ *
+ * @see https://instantdb.com/docs/presence-and-topics
+ * @example
+ *  const room = db.room('chat', roomId);
+ *  const typing = db.rooms.useTypingIndicator(room, 'chat-input');
+ *  // typing.active.value, typing.setActive(bool), typing.inputProps
+ */
+export declare function useTypingIndicator<RoomSchema extends RoomSchemaShape, RoomType extends keyof RoomSchema>(room: InstantVueRoom<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 InstantVueRoom<Schema extends InstantSchemaDef<any, any, any>, RoomSchema extends RoomSchemaShape, RoomType extends keyof RoomSchema> {
+    core: InstantCoreDatabase<Schema, boolean>;
+    type: ComputedRef<RoomType> | RoomType;
+    id: ComputedRef<string> | string;
+    constructor(core: InstantCoreDatabase<Schema, boolean>, type: ComputedRef<RoomType> | RoomType, id: ComputedRef<string> | string);
+}
+//# sourceMappingURL=InstantVueRoom.d.ts.map

package/dist/InstantVueRoom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstantVueRoom.d.ts","sourceRoot":"","sources":["../src/InstantVueRoom.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,mBAAmB,EACnB,gBAAgB,EACjB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AAO1E,MAAM,MAAM,cAAc,CAAC,aAAa,EAAE,IAAI,SAAS,MAAM,aAAa,IAAI;KAC3E,CAAC,IAAI,MAAM,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG,UAAU,CAC5D,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CACzC;CACF,GAAG;IACF,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,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;IAC7B,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;;;;;;;;;GASG;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,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,EAC/C,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,CAcN;AAED;;;;;;;;GAQG;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,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,EAC/C,KAAK,EAAE,SAAS,GACf,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,CAgB3D;AAKD;;;;;;;GAOG;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,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,EAC/C,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,CA6CxD;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,UAAU,SAAS,eAAe,EAClC,QAAQ,SAAS,MAAM,UAAU,EAEjC,IAAI,EAAE,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,EAC/C,IAAI,EAAE,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAChE,IAAI,CAeN;AAKD;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,SAAS,eAAe,EAClC,QAAQ,SAAS,MAAM,UAAU,EAEjC,IAAI,EAAE,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,EAC/C,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,mBAAwB,GAC7B,qBAAqB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC,CAqEzD;AAKD,eAAO,MAAM,KAAK;;;;;;CAMjB,CAAC;AAKF,qBAAa,cAAc,CACzB,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,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;IACvC,EAAE,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;gBAG/B,IAAI,EAAE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,QAAQ,EACtC,EAAE,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM;CAMnC"}