@taladb/react 0.9.3 → 0.10.0

package/LICENSE

@@ -1,21 +1,202 @@
-MIT License
-
-Copyright (c) 2025 thinkgrid-labs
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+
+                                 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 2025-2026 thinkgrid-labs
+
+   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/dist/index.d.mts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode } from 'react';
-import { CollectionOptions, Document, TalaDB, OpenDBOptions, Collection, Filter } from 'taladb';
+import { CollectionOptions, Document, TalaDB, OpenDBOptions, Collection, Filter, AggregatePipeline, RestSourceOptions, ReplicationSource, CoverageState } from 'taladb';
 
 /**
  * Per-collection options (`schema`, `syncSchema`, `migrateDocument`, …), keyed by
@@ -163,6 +163,40 @@ interface FindOneResult<T> {
  */
 declare function useFindOne<T extends Document>(collection: Collection<T>, filter: Filter<T>): FindOneResult<T>;
 
+interface AggregateResult<R> {
+    /** The current pipeline results. Empty while loading. */
+    data: R[];
+    /** True until the first snapshot has been delivered. */
+    loading: boolean;
+    /** Most recent subscription error, cleared by the next successful snapshot. */
+    error: unknown | null;
+}
+/**
+ * Subscribe to a **live aggregation**. Re-renders whenever the results change.
+ *
+ * This is the paging primitive. `find()` has no sort/skip/limit — only `aggregate`
+ * does — but `aggregate` on its own returns a *dead snapshot*: call it in an effect
+ * and the page sits frozen while a background hydration fills the collection
+ * underneath it. The user watches a spinner finish and the rows never arrive.
+ *
+ * So anything that pages locally subscribes here rather than calling `aggregate`
+ * directly.
+ *
+ * @param collection A `Collection<T>` (memoize it, or take it from `useCollection`).
+ * @param pipeline   Inline arrays are safe — the pipeline is serialised for
+ *                   subscription identity, so a fresh array each render does not
+ *                   re-subscribe.
+ *
+ * @example
+ * const page = useAggregate<Product, Product>(products, [
+ *   { $match: { category: 'kitchen' } },
+ *   { $sort: { price: 1 } },
+ *   { $skip: 100 },
+ *   { $limit: 100 },
+ * ])
+ */
+declare function useAggregate<T extends Document, R extends Document = T>(collection: Collection<T>, pipeline: AggregatePipeline<T>): AggregateResult<R>;
+
 /** Resolved network configuration for one replicated slice. */
 interface ResolvedReplicationConfig {
     /** Base URL; `/push` and `/pull` are appended by {@link HttpSyncAdapter}. */
@@ -183,6 +217,37 @@ interface ResolvedReplicationConfig {
     };
 }
 
+/** When the background hydration walk is allowed to start. */
+type HydrateMode = 
+/** Immediately on mount. */
+'eager'
+/** When the browser is idle (default). Keeps first paint responsive. */
+ | 'idle'
+/** Never automatically — the app calls `hydrate()` itself. */
+ | 'manual';
+interface ReplicateScope<RemoteRow = any, T extends Document = Document> extends Omit<RestSourceOptions<RemoteRow, T>, 'collection'> {
+    /**
+     * Provide a fully custom source instead of the REST defaults. When present,
+     * every other field here is ignored.
+     */
+    source?: ReplicationSource<RemoteRow, T>;
+    hydrate?: HydrateMode;
+    /** Rows per bootstrap page. Default 500. */
+    pageSize?: number;
+    /** Re-check the origin for changes on this interval. `0` disables. */
+    refreshMs?: number;
+    /**
+     * Fetch the current query directly when coverage isn't ready yet, so a cold
+     * start paints immediately. Default `true`.
+     *
+     * Mandatory in practice for a Vite SPA or React Native, which have no server
+     * render to paint behind while the replica fills.
+     */
+    bridge?: boolean;
+}
+/** One entry per local collection. */
+type ReplicateRegistry = Record<string, ReplicateScope<any, any>>;
+
 /** A slice to warm on first run — a collection, optionally on a specific endpoint. */
 type PrefetchSlice = {
     collection: string;
@@ -236,7 +301,15 @@ interface ReplicationConfig {
     /** Max concurrent prefetch pulls — keeps the active page from starving. Default `2`. */
     prefetchConcurrency?: number;
 }
-interface ReplicationProviderProps extends ReplicationConfig {
+interface ReplicationProviderProps extends Partial<ReplicationConfig> {
+    /**
+     * Collections to replicate from a remote origin, keyed by local collection name.
+     *
+     * This is what makes `useQuery` a local read: once a collection is fully
+     * hydrated for its scope, filtering, sorting and paging never touch the network.
+     * See {@link ReplicateRegistry}.
+     */
+    replicate?: ReplicateRegistry;
     children: ReactNode;
 }
 /**
@@ -257,7 +330,7 @@ interface ReplicationProviderProps extends ReplicationConfig {
  * </TalaDBProvider>
  * ```
  */
-declare function ReplicationProvider({ children, ...config }: ReplicationProviderProps): react_jsx_runtime.JSX.Element;
+declare function ReplicationProvider({ children, replicate, ...config }: ReplicationProviderProps): react_jsx_runtime.JSX.Element;
 /**
  * Read the nearest replication config, merged with per-hook overrides.
  * Non-throwing: `config` is `null` when no endpoint is resolvable (valid for
@@ -268,73 +341,134 @@ declare function useReplicationConfig(overrides?: Partial<ReplicationConfig>): {
     pollMs: number;
 };
 
+interface Coverage {
+    /** The raw state machine value. */
+    status: CoverageState['status'];
+    /**
+     * Whether a purely local read is authorized.
+     *
+     * True **only** for `complete`. Notably *not* for `best-effort`, which means we
+     * applied every row the origin gave us but the origin could not pin a snapshot —
+     * so a row that shifted between pages during the walk may never have been seen,
+     * and we cannot prove the replica is whole. Serving that as authoritative would
+     * silently return incomplete results, which is worse than going to the network.
+     */
+    ready: boolean;
+    /** Rows hydrated so far. */
+    rows: number;
+    /** Total rows in scope when supplied by the origin. */
+    total?: number;
+    /** 0–1 when the origin reported a total; otherwise undefined. */
+    progress?: number;
+    /** Present on `error`, `stale` and `best-effort`. */
+    reason?: string;
+}
 /**
- * How a `useQuery` combines the local replica with the remote origin.
- * *(`remote-only` is a planned addition; the durable-replica model makes it a
- * rare escape hatch.)*
+ * How much of a collection is local, and whether it can be trusted for a
+ * network-free read.
+ *
+ * @example
+ * const { ready, progress } = useCoverage('products')
+ * if (!ready) return <ProgressBar value={progress} />
  */
+declare function useCoverage(collection: string): Coverage;
+/** Semantic alias for progress-oriented UIs. */
+declare const useHydrationProgress: typeof useCoverage;
+
 type ReadSource = 'local-first' | 'remote-first' | 'local-only';
 interface UseQueryOptions<T extends Document> extends Partial<Pick<ReplicationConfig, 'endpoint' | 'getAuth' | 'fetch' | 'paths' | 'pollMs'>> {
-    /** Collection name — replicated as a whole; the `filter` narrows locally. */
+    /** The local collection to read. */
     collection: string;
-    /** Live filter over the local collection. Inline objects are safe. */
+    /** Mongo-style filter, applied **locally**. */
     filter?: Filter<T>;
-    /**
-     * - `local-first` *(default)* — serve local immediately; refresh in the
-     *   background, and the live query re-renders when the pull lands.
-     * - `remote-first` — stay `loading` until the first pull completes, then serve.
-     * - `local-only` — never touch the network (no endpoint required).
-     */
+    /** Sort, applied locally. `1` ascending, `-1` descending. */
+    sort?: Partial<Record<keyof T & string, 1 | -1>>;
+    /** 1-based page number. Requires `limit`. */
+    page?: number;
+    /** Rows per page. */
+    limit?: number;
+    /** Skip N rows. Ignored when `page` is set. */
+    skip?: number;
+    /** Skip the query entirely (e.g. while a route param is undefined). */
+    enabled?: boolean;
+    /** Legacy sync-contract read policy. Used when no full-replication scope exists. */
     source?: ReadSource;
 }
 interface QueryResult<T> {
-    /** Current matching documents from the local replica. Reactive. */
+    /** The current page. Reactive: re-renders as rows land. */
     data: T[];
-    /** First local snapshot pending — plus the first pull, for `remote-first`. */
+    /** Total rows in the replicated scope when reported by the origin. */
+    total?: number;
+    /** True until the first local snapshot arrives. */
     loading: boolean;
-    /** Most recent local-read error. */
+    /** Most recent local read error. */
     error: unknown | null;
-    /** A background replication pass is in flight. */
+    /** Most recent cold-start bridge error. */
+    fetchError: unknown | null;
+    /** How much of the collection is local, and whether it is trustworthy. */
+    coverage: Coverage;
+    /**
+     * A cold-start bridge fetch is in flight — we are serving the network because
+     * the replica isn't complete yet.
+     */
+    fetching: boolean;
+    /** Legacy sync-contract pull in progress. */
     syncing: boolean;
-    /** Most recent replication error (the local data is still served). */
+    /** Legacy sync-contract pull error. */
     syncError: unknown | null;
-    /** Trigger a pull now. No-op for `local-only`. */
+    /** Force a delta refresh from the origin. */
     refetch: () => Promise<void>;
 }
 /**
- * Bind a component to a slice of a remote origin, backed by the local replica.
+ * Read a page of a collection.
+ *
+ * ## The point
+ *
+ * Once the collection is **covered** — fully replicated for this scope — this hook
+ * touches the network **zero times**. Filtering, sorting and paging are local
+ * queries against the on-device database. Page 1 → page 2 → a new filter → page 47
+ * → back to page 1: every one is a local read, instant and offline-capable.
+ * Pagination stops being a network concern at all.
+ *
+ * That is the whole reason to put a real database on the device. A cache of API
+ * pages could only ever answer the queries you already asked; a *covered replica*
+ * answers queries nobody has asked yet.
+ *
+ * ## Before coverage lands
  *
- * The read is a live query over the local collection (`useFind`); the network
- * pull writes into that same collection, so the live query re-renders on its
- * own — one-way data flow, no `queryKey`, no `invalidateQueries`. See
- * `docs/scoped-replication.md`.
+ * On a cold start the replica is empty, and a SPA or React Native app has no server
+ * render to paint behind. So the hook **bridges**: it fetches exactly the rows this
+ * query needs and writes them into the same collection, under the same derived ids
+ * the background walk will use. Those rows are not a cache entry to be reconciled
+ * later — they are the replica, arriving early. When the walk reaches them it
+ * overwrites them in place.
  *
  * @example
- * const { data, loading, syncing } = useQuery<Product>({
+ * const { data, coverage } = useQuery<Product>({
  *   collection: 'products',
- *   filter: { category: 'kitchen' },
- *   pollMs: 30_000,
+ *   filter: { category: 'kitchen', price: { $lt: 500 } },
+ *   sort: { price: 1 },
+ *   page: 2,
+ *   limit: 100,
  * })
  */
 declare function useQuery<T extends Document>(options: UseQueryOptions<T>): QueryResult<T>;
 
 /**
- * Run several scoped queries at once — one replication + live query per entry,
- * in parallel. The result array is index-aligned with `queries`.
+ * Several pages at once, from several collections. Index-aligned with `queries`.
  *
- * Each entry is an independent `useQuery`: its own collection, filter, source,
- * and (optionally) endpoint. This is the multi-slice page case — e.g. a
- * dashboard that needs `orders` and `products` from the same origin. There are
- * no cross-collection joins (TalaDB is a document store); compose in the
- * component.
+ * Hooks can't be called in a variable-length loop, so this manages its own
+ * subscriptions rather than calling `useQuery` N times. Behaviour is otherwise
+ * identical: once a collection is covered, its read is purely local.
  *
- * v1 note: entries are typed as `Document`. For a strictly-typed single slice
- * use `useQuery<T>`; per-entry generics (tuple typing) are a follow-up.
+ * TalaDB is a document store with no cross-collection joins, so a page needing
+ * several collections composes them in the component (or denormalises at the
+ * origin). This is the hook for that.
  *
  * @example
- * const [orders, products] = useQueries([
- *   { collection: 'orders', filter: { open: true } },
- *   { collection: 'products' },
+ * const [products, categories] = useQueries([
+ *   { collection: 'products', filter: { category }, sort: { price: 1 }, page, limit: 50 },
+ *   { collection: 'categories' },
  * ])
  */
 declare function useQueries(queries: UseQueryOptions<Document>[]): QueryResult<Document>[];
@@ -392,4 +526,4 @@ interface MutationResult<T extends Document> {
  */
 declare function useMutation<T extends Document>(options: UseMutationOptions): MutationResult<T>;
 
-export { type CollectionRegistry, type CollectionResolver, type FindOneResult, type FindResult, type MutationResult, type PrefetchEntry, type PrefetchMode, type PrefetchSlice, type QueryResult, type ReadSource, type ReplicationConfig, ReplicationProvider, type ReplicationProviderProps, TalaDBProvider, type TalaDBProviderProps, type UseMutationOptions, type UseQueryOptions, type WriteOp, useCollection, useCollectionOptions, useFind, useFindOne, useMutation, useQueries, useQuery, useReplicationConfig, useTalaDB };
+export { type AggregateResult, type CollectionRegistry, type CollectionResolver, type Coverage, type FindOneResult, type FindResult, type HydrateMode, type MutationResult, type PrefetchEntry, type PrefetchMode, type PrefetchSlice, type QueryResult, type ReplicateRegistry, type ReplicateScope, type ReplicationConfig, ReplicationProvider, type ReplicationProviderProps, TalaDBProvider, type TalaDBProviderProps, type UseMutationOptions, type UseQueryOptions, type WriteOp, useAggregate, useCollection, useCollectionOptions, useCoverage, useFind, useFindOne, useHydrationProgress, useMutation, useQueries, useQuery, useReplicationConfig, useTalaDB };