@astrogate/sdk 0.0.0-stage → 0.1.0

package/node_modules/@instantdb/react-common/dist/esm/InstantReactAbstractDatabase.js

@@ -0,0 +1,386 @@
+'use client';
+import { Fragment as _Fragment, jsx as _jsx } from "react/jsx-runtime";
+import { txInit, init as core_init, InstantError, } from '@instantdb/core';
+import { useCallback, useEffect, useRef, useState, useSyncExternalStore, } from 'react';
+import { useQueryInternal } from './useQuery.js';
+import { useInfiniteQuerySubscription, } from './useInfiniteQuerySubscription.js';
+import { InstantReactRoom, rooms } from './InstantReactRoom.js';
+const defaultAuthState = {
+    isLoading: true,
+    user: undefined,
+    error: undefined,
+};
+const defaultAppStatusState = {
+    isLoading: true,
+    isReadOnly: undefined,
+};
+export default class InstantReactAbstractDatabase {
+    tx = txInit();
+    auth;
+    storage;
+    streams;
+    core;
+    /** @deprecated use `core` instead */
+    _core;
+    static Store;
+    static NetworkListener;
+    static EventSourceImpl;
+    constructor(config, versions) {
+        this.core = core_init(config, 
+        // @ts-expect-error because TS can't resolve subclass statics
+        config.Store || this.constructor.Store, 
+        // @ts-expect-error because TS can't resolve subclass statics
+        this.constructor.NetworkListener, versions, 
+        // @ts-expect-error because TS can't resolve subclass statics
+        this.constructor.EventSourceImpl);
+        this._core = this.core;
+        this.auth = this.core.auth;
+        this.storage = this.core.storage;
+        this.streams = this.core.streams;
+    }
+    /**
+     * Returns a unique ID for a given `name`. It's stored in local storage,
+     * so you will get the same ID across sessions.
+     *
+     * This is useful for generating IDs that could identify a local device or user.
+     *
+     * @example
+     *  const deviceId = await db.getLocalId('device');
+     */
+    getLocalId = (name) => {
+        return this.core.getLocalId(name);
+    };
+    /**
+     * A hook that returns a unique ID for a given `name`. localIds are
+     * stored in local storage, so you will get the same ID across sessions.
+     *
+     * Initially returns `null`, and then loads the localId.
+     *
+     * @example
+     * const deviceId = db.useLocalId('device');
+     * if (!deviceId) return null; // loading
+     * console.log('Device ID:', deviceId)
+     */
+    useLocalId = (name) => {
+        const [localId, setLocalId] = useState(null);
+        useEffect(() => {
+            let mounted = true;
+            const f = async () => {
+                const id = await this.getLocalId(name);
+                if (!mounted)
+                    return;
+                setLocalId(id);
+            };
+            f();
+            return;
+        }, [name]);
+        return localId;
+    };
+    /**
+     * Obtain a handle to a room, which allows you to listen to topics and presence data
+     *
+     * If you don't provide a `type` or `id`, Instant will default to `_defaultRoomType` and `_defaultRoomId`
+     * as the room type and id, respectively.
+     *
+     * @see https://instantdb.com/docs/presence-and-topics
+     *
+     * @example
+     *  const room = db.room('chat', roomId);
+     *  const { peers } = db.rooms.usePresence(room);
+     */
+    room(type = '_defaultRoomType', id = '_defaultRoomId') {
+        return new InstantReactRoom(this.core, type, id);
+    }
+    /**
+     * 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 = rooms;
+    /**
+     * Use this to write data! You can create, update, delete, and link objects
+     *
+     * @see https://instantdb.com/docs/instaml
+     *
+     * @example
+     *   // Create a new object in the `goals` namespace
+     *   const goalId = id();
+     *   db.transact(db.tx.goals[goalId].update({title: "Get fit"}))
+     *
+     *   // Update the title
+     *   db.transact(db.tx.goals[goalId].update({title: "Get super fit"}))
+     *
+     *   // Delete it
+     *   db.transact(db.tx.goals[goalId].delete())
+     *
+     *   // Or create an association:
+     *   todoId = id();
+     *   db.transact([
+     *    db.tx.todos[todoId].update({ title: 'Go on a run' }),
+     *    db.tx.goals[goalId].link({todos: todoId}),
+     *  ])
+     */
+    transact = (chunks) => {
+        return this.core.transact(chunks);
+    };
+    /**
+     * Use this to query your data!
+     *
+     * @see https://instantdb.com/docs/instaql
+     *
+     * @example
+     *   // listen to all goals
+     *   const { isLoading, error, data } = db.useQuery({ goals: {} });
+     *
+     *   // goals where the title is "Get Fit"
+     *   const { isLoading, error, data } = db.useQuery({
+     *     goals: { $: { where: { title: 'Get Fit' } } },
+     *   });
+     *
+     *   // all goals, _alongside_ their todos
+     *   const { isLoading, error, data } = db.useQuery({
+     *     goals: { todos: {} },
+     *   });
+     *
+     *   // skip if `user` is not logged in
+     *   const { isLoading, error, data } = db.useQuery(
+     *     auth.user ? { goals: {} } : null,
+     *   );
+     */
+    useQuery = (query, opts) => {
+        return useQueryInternal(this.core, query, opts).state;
+    };
+    /**
+     * Listen for the logged in state. This is useful
+     * for deciding when to show a login screen.
+     *
+     * Check out the docs for an example `Login` component too!
+     *
+     * @see https://instantdb.com/docs/auth
+     * @example
+     *  function App() {
+     *    const { isLoading, user, error } = db.useAuth()
+     *    if (isLoading) {
+     *      return <div>Loading...</div>
+     *    }
+     *    if (error) {
+     *      return <div>Uh oh! {error.message}</div>
+     *    }
+     *    if (user) {
+     *      return <Main user={user} />
+     *    }
+     *    return <Login />
+     *  }
+     *
+     */
+    useAuth = () => {
+        return this._useAuth();
+    };
+    _useAuth() {
+        // 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(this.core._reactor._currentUserCached);
+        // Similar to `resultCacheRef`, `useSyncExternalStore` will unsubscribe
+        // if `subscribe` changes, so we use `useCallback` to memoize the function.
+        const subscribe = useCallback((cb) => {
+            const unsubscribe = this.core.subscribeAuth((auth) => {
+                resultCacheRef.current = { isLoading: false, ...auth };
+                cb();
+            });
+            return unsubscribe;
+        }, []);
+        const state = useSyncExternalStore(subscribe, () => resultCacheRef.current, () => defaultAuthState);
+        return state;
+    }
+    /**
+     * Subscribe to the currently logged in user.
+     * If the user is not logged in, this hook with throw an Error.
+     * You will want to protect any calls of this hook with a
+     * <db.SignedIn> component, or your own logic based on db.useAuth()
+     *
+     * @see https://instantdb.com/docs/auth
+     * @throws Error indicating user not signed in
+     * @example
+     *  function UserDisplay() {
+     *    const user = db.useUser()
+     *    return <div>Logged in as: {user.email}</div>
+     *  }
+     *
+     *  <db.SignedIn>
+     *    <UserDisplay />
+     *  </db.SignedIn>
+     *
+     */
+    useUser = () => {
+        const { user } = this.useAuth();
+        if (!user) {
+            throw new InstantError('useUser must be used within an auth-protected route');
+        }
+        return user;
+    };
+    /**
+     * One time query for the logged in state. This is useful
+     * for scenarios where you want to know the current auth
+     * state without subscribing to changes.
+     *
+     * @see https://instantdb.com/docs/auth
+     * @example
+     *   const user = await db.getAuth();
+     *   console.log('logged in as', user.email)
+     */
+    getAuth() {
+        return this.core.getAuth();
+    }
+    /**
+     * Listen for connection status changes to Instant. Use this for things like
+     * showing connection state to users
+     *
+     * @see https://www.instantdb.com/docs/patterns#connection-status
+     * @example
+     *  function App() {
+     *    const status = db.useConnectionStatus()
+     *    const connectionState =
+     *      status === 'connecting' || status === 'opened'
+     *        ? 'authenticating'
+     *      : status === 'authenticated'
+     *        ? 'connected'
+     *      : status === 'closed'
+     *        ? 'closed'
+     *      : status === 'errored'
+     *        ? 'errored'
+     *      : 'unexpected state';
+     *
+     *    return <div>Connection state: {connectionState}</div>
+     *  }
+     */
+    useConnectionStatus = () => {
+        const statusRef = useRef(this.core._reactor.status);
+        const subscribe = useCallback((cb) => {
+            const unsubscribe = this.core.subscribeConnectionStatus((newStatus) => {
+                if (newStatus !== statusRef.current) {
+                    statusRef.current = newStatus;
+                    cb();
+                }
+            });
+            return unsubscribe;
+        }, []);
+        const status = useSyncExternalStore(subscribe, () => statusRef.current, 
+        // For SSR, always return 'connecting' as the initial state
+        () => 'connecting');
+        return status;
+    };
+    /**
+     * Observe the app's maintenance-mode state. While read-only, reads and
+     * live queries keep working but writes are rejected.
+     *
+     * @example
+     *  function App() {
+     *    const { isLoading, isReadOnly } = db.useAppStatus()
+     *    if (isLoading) return null
+     *    if (isReadOnly) return <MaintenanceBanner />
+     *    // ...
+     *  }
+     */
+    useAppStatus = () => {
+        const stateRef = useRef(this.core._reactor._appStatusState);
+        const subscribe = useCallback((cb) => {
+            return this.core.subscribeAppStatus((state) => {
+                if (state.isLoading !== stateRef.current.isLoading ||
+                    state.isReadOnly !== stateRef.current.isReadOnly) {
+                    stateRef.current = state;
+                    cb();
+                }
+            });
+        }, []);
+        const state = useSyncExternalStore(subscribe, () => stateRef.current, () => defaultAppStatusState);
+        return state;
+    };
+    /**
+     * Use this for one-off queries.
+     * Returns local data if available, otherwise fetches from the server.
+     * Because we want to avoid stale data, this method will throw an error
+     * if the user is offline or there is no active connection to the server.
+     *
+     * @see https://instantdb.com/docs/instaql
+     *
+     * @example
+     *
+     *  const resp = await db.queryOnce({ goals: {} });
+     *  console.log(resp.data.goals)
+     */
+    queryOnce = (query, opts) => {
+        return this.core.queryOnce(query, opts);
+    };
+    /**
+     * Subscribe to a query and incrementally load more items
+     *
+     * Only one top level namespace in the query is allowed.
+     *
+     * Changing the query or options while the subscription is active will
+     * reset the subscription and start over with new data.
+     * @example
+     * const {
+     *   data,
+     *   loadNextPage,
+     *   canLoadNextPage,
+     * } = db.useInfiniteQuery({
+     *   posts: {
+     *     $: {
+     *       limit: 20,   // Load 20 posts at a time
+     *       order: {
+     *         createdAt: 'desc',
+     *       },
+     *     },
+     *   },
+     * });
+     */
+    useInfiniteQuery = (query, opts) => {
+        const result = useInfiniteQuerySubscription({
+            core: this.core,
+            query: query,
+            opts,
+        });
+        return result;
+    };
+    /**
+     * Only render children if the user is signed in.
+     * @see https://instantdb.com/docs/auth
+     *
+     * @example
+     *  <db.SignedIn>
+     *    <MyComponent />
+     *  </db.SignedIn>
+     *
+     */
+    SignedIn = ({ children }) => {
+        const auth = this.useAuth();
+        if (auth.isLoading || auth.error || !auth.user)
+            return null;
+        return _jsx(_Fragment, { children: children });
+    };
+    /**
+     * Only render children if the user is signed out.
+     * @see https://instantdb.com/docs/auth
+     *
+     * @example
+     *  <db.SignedOut>
+     *    <MyComponent />
+     *  </db.SignedOut>
+     *
+     */
+    SignedOut = ({ children }) => {
+        const auth = this.useAuth();
+        if (auth.isLoading || auth.error || auth.user)
+            return null;
+        return _jsx(_Fragment, { children: children });
+    };
+}

package/node_modules/@instantdb/react-common/dist/esm/InstantReactRoom.d.ts

@@ -0,0 +1,182 @@
+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 string & 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 string & 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 string & 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 string & 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 string & 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 string & 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']>;
+}