@astrogate/sdk 0.0.0-stage → 0.1.0

package/node_modules/@instantdb/react-common/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

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

@@ -0,0 +1,282 @@
+import { Auth, Storage, type AuthState, type User, type ConnectionStatus, type AppStatusState, type TransactionChunk, type RoomSchemaShape, type InstaQLOptions, type InstantConfig, type PageInfoResponse, InstantCoreDatabase, InstaQLLifecycleState, InstaQLResponse, RoomsOf, InstantSchemaDef, IInstantDatabase, ValidQuery, Streams } from '@instantdb/core';
+import { ReactNode } from 'react';
+import { type InfiniteQueryResult } from './useInfiniteQuerySubscription.ts';
+import { InstantReactRoom } from './InstantReactRoom.ts';
+export default abstract class InstantReactAbstractDatabase<Schema extends InstantSchemaDef<any, any, any>, UseDates extends boolean = false, Config extends InstantConfig<Schema, boolean> = InstantConfig<Schema, UseDates>, Rooms extends RoomSchemaShape = RoomsOf<Schema>> implements IInstantDatabase<Schema> {
+    tx: import("@instantdb/core").TxChunk<Schema>;
+    auth: Auth;
+    storage: Storage;
+    streams: Streams;
+    core: InstantCoreDatabase<Schema, UseDates>;
+    /** @deprecated use `core` instead */
+    _core: InstantCoreDatabase<Schema, UseDates>;
+    static Store?: any;
+    static NetworkListener?: any;
+    static EventSourceImpl?: any;
+    constructor(config: Omit<InstantConfig<Schema, UseDates>, 'useDateObjects'> & {
+        useDateObjects?: UseDates;
+    }, versions?: {
+        [key: string]: string;
+    });
+    /**
+     * 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: string) => Promise<string>;
+    /**
+     * 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: string) => string | null;
+    /**
+     * 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<RoomType extends string & keyof Rooms>(type?: RoomType, id?: string): InstantReactRoom<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("./InstantReactRoom.ts").useTopicEffect;
+        usePublishTopic: typeof import("./InstantReactRoom.ts").usePublishTopic;
+        usePresence: typeof import("./InstantReactRoom.ts").usePresence;
+        useSyncPresence: typeof import("./InstantReactRoom.ts").useSyncPresence;
+        useTypingIndicator: typeof import("./InstantReactRoom.ts").useTypingIndicator;
+    };
+    /**
+     * 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: TransactionChunk<any, any> | TransactionChunk<any, any>[]) => Promise<import("@instantdb/core").TransactionResult>;
+    /**
+     * 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: <Q extends ValidQuery<Q, Schema>>(query: null | Q, opts?: InstaQLOptions) => InstaQLLifecycleState<Schema, Q, UseDates>;
+    /**
+     * 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: () => AuthState;
+    protected _useAuth(): AuthState;
+    /**
+     * 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: () => 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(): Promise<User | null>;
+    /**
+     * 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: () => ConnectionStatus;
+    /**
+     * 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: () => AppStatusState;
+    /**
+     * 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: <Q extends ValidQuery<Q, Schema>>(query: Q, opts?: InstaQLOptions) => Promise<{
+        data: InstaQLResponse<Schema, Q, UseDates>;
+        pageInfo: PageInfoResponse<Q>;
+    }>;
+    /**
+     * 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: <Q extends ValidQuery<Q, Schema>>(query: Q, opts?: InstaQLOptions) => InfiniteQueryResult<Schema, Q, UseDates>;
+    /**
+     * Only render children if the user is signed in.
+     * @see https://instantdb.com/docs/auth
+     *
+     * @example
+     *  <db.SignedIn>
+     *    <MyComponent />
+     *  </db.SignedIn>
+     *
+     */
+    SignedIn: React.FC<{
+        children: ReactNode;
+    }>;
+    /**
+     * Only render children if the user is signed out.
+     * @see https://instantdb.com/docs/auth
+     *
+     * @example
+     *  <db.SignedOut>
+     *    <MyComponent />
+     *  </db.SignedOut>
+     *
+     */
+    SignedOut: React.FC<{
+        children: ReactNode;
+    }>;
+}