@taladb/react 0.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+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.

package/dist/index.d.mts

@@ -0,0 +1,92 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { TalaDB, Document, Collection, Filter } from 'taladb';
+
+interface TalaDBProviderProps {
+    /** The TalaDB instance returned by `openDB()`. */
+    db: TalaDB;
+    children: ReactNode;
+}
+/**
+ * Provides a TalaDB instance to all child hooks.
+ *
+ * @example
+ * const db = await openDB('myapp.db')
+ *
+ * function App() {
+ *   return (
+ *     <TalaDBProvider db={db}>
+ *       <MyComponent />
+ *     </TalaDBProvider>
+ *   )
+ * }
+ */
+declare function TalaDBProvider({ db, children }: TalaDBProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Returns the TalaDB instance from the nearest `<TalaDBProvider>`.
+ *
+ * @throws If called outside of a `<TalaDBProvider>`.
+ */
+declare function useTalaDB(): TalaDB;
+
+/**
+ * Returns a stable `Collection<T>` handle from the nearest `<TalaDBProvider>`.
+ *
+ * The returned collection is memoised — the same object reference is returned
+ * on every render unless the db instance or collection name changes. Pass it
+ * directly to `useFind` or `useFindOne` without wrapping in `useMemo`.
+ *
+ * @param name  The collection name (e.g. `'articles'`).
+ *
+ * @example
+ * const articles = useCollection<Article>('articles')
+ * const { data, loading } = useFind(articles, { locale: 'en' })
+ */
+declare function useCollection<T extends Document>(name: string): Collection<T>;
+
+interface FindResult<T> {
+    /** The current matching documents. Empty array while loading. */
+    data: T[];
+    /** True until the first snapshot has been delivered from the database. */
+    loading: boolean;
+}
+/**
+ * Subscribe to a live query. Re-renders whenever the matching documents change.
+ *
+ * Backed by `useSyncExternalStore` for zero-tearing snapshots in concurrent React.
+ * Works in both React (browser / Node.js) and React Native.
+ *
+ * @param collection  A `Collection<T>` instance (memoize or store outside the component).
+ * @param filter      Optional filter. Inline objects are safe — the filter is
+ *                    serialised to a string for subscription identity checks so
+ *                    `{ active: true }` on every render does not re-subscribe.
+ *
+ * @example
+ * const articles = useMemo(() => db.collection<Article>('articles'), [db])
+ * const { data, loading } = useFind(articles, { locale: 'en' })
+ */
+declare function useFind<T extends Document>(collection: Collection<T>, filter?: Filter<T>): FindResult<T>;
+
+interface FindOneResult<T> {
+    /** The first matching document, or `null` when none matched or still loading. */
+    data: T | null;
+    /** True until the first snapshot has been delivered from the database. */
+    loading: boolean;
+}
+/**
+ * Subscribe to a single document live query. Re-renders when the matching
+ * document changes.
+ *
+ * Internally subscribes with the same filter as `useFind` and returns the
+ * first result. If you need all matching documents use `useFind` instead.
+ *
+ * @param collection  A `Collection<T>` instance.
+ * @param filter      Filter to identify the document. Inline objects are safe.
+ *
+ * @example
+ * const users = useMemo(() => db.collection<User>('users'), [db])
+ * const { data: user, loading } = useFindOne(users, { _id: userId })
+ */
+declare function useFindOne<T extends Document>(collection: Collection<T>, filter: Filter<T>): FindOneResult<T>;
+
+export { type FindOneResult, type FindResult, TalaDBProvider, type TalaDBProviderProps, useCollection, useFind, useFindOne, useTalaDB };

package/dist/index.d.ts

@@ -0,0 +1,92 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { TalaDB, Document, Collection, Filter } from 'taladb';
+
+interface TalaDBProviderProps {
+    /** The TalaDB instance returned by `openDB()`. */
+    db: TalaDB;
+    children: ReactNode;
+}
+/**
+ * Provides a TalaDB instance to all child hooks.
+ *
+ * @example
+ * const db = await openDB('myapp.db')
+ *
+ * function App() {
+ *   return (
+ *     <TalaDBProvider db={db}>
+ *       <MyComponent />
+ *     </TalaDBProvider>
+ *   )
+ * }
+ */
+declare function TalaDBProvider({ db, children }: TalaDBProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Returns the TalaDB instance from the nearest `<TalaDBProvider>`.
+ *
+ * @throws If called outside of a `<TalaDBProvider>`.
+ */
+declare function useTalaDB(): TalaDB;
+
+/**
+ * Returns a stable `Collection<T>` handle from the nearest `<TalaDBProvider>`.
+ *
+ * The returned collection is memoised — the same object reference is returned
+ * on every render unless the db instance or collection name changes. Pass it
+ * directly to `useFind` or `useFindOne` without wrapping in `useMemo`.
+ *
+ * @param name  The collection name (e.g. `'articles'`).
+ *
+ * @example
+ * const articles = useCollection<Article>('articles')
+ * const { data, loading } = useFind(articles, { locale: 'en' })
+ */
+declare function useCollection<T extends Document>(name: string): Collection<T>;
+
+interface FindResult<T> {
+    /** The current matching documents. Empty array while loading. */
+    data: T[];
+    /** True until the first snapshot has been delivered from the database. */
+    loading: boolean;
+}
+/**
+ * Subscribe to a live query. Re-renders whenever the matching documents change.
+ *
+ * Backed by `useSyncExternalStore` for zero-tearing snapshots in concurrent React.
+ * Works in both React (browser / Node.js) and React Native.
+ *
+ * @param collection  A `Collection<T>` instance (memoize or store outside the component).
+ * @param filter      Optional filter. Inline objects are safe — the filter is
+ *                    serialised to a string for subscription identity checks so
+ *                    `{ active: true }` on every render does not re-subscribe.
+ *
+ * @example
+ * const articles = useMemo(() => db.collection<Article>('articles'), [db])
+ * const { data, loading } = useFind(articles, { locale: 'en' })
+ */
+declare function useFind<T extends Document>(collection: Collection<T>, filter?: Filter<T>): FindResult<T>;
+
+interface FindOneResult<T> {
+    /** The first matching document, or `null` when none matched or still loading. */
+    data: T | null;
+    /** True until the first snapshot has been delivered from the database. */
+    loading: boolean;
+}
+/**
+ * Subscribe to a single document live query. Re-renders when the matching
+ * document changes.
+ *
+ * Internally subscribes with the same filter as `useFind` and returns the
+ * first result. If you need all matching documents use `useFind` instead.
+ *
+ * @param collection  A `Collection<T>` instance.
+ * @param filter      Filter to identify the document. Inline objects are safe.
+ *
+ * @example
+ * const users = useMemo(() => db.collection<User>('users'), [db])
+ * const { data: user, loading } = useFindOne(users, { _id: userId })
+ */
+declare function useFindOne<T extends Document>(collection: Collection<T>, filter: Filter<T>): FindOneResult<T>;
+
+export { type FindOneResult, type FindResult, TalaDBProvider, type TalaDBProviderProps, useCollection, useFind, useFindOne, useTalaDB };

package/dist/index.js

@@ -0,0 +1,100 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  TalaDBProvider: () => TalaDBProvider,
+  useCollection: () => useCollection,
+  useFind: () => useFind,
+  useFindOne: () => useFindOne,
+  useTalaDB: () => useTalaDB
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/context.tsx
+var import_react = require("react");
+var import_jsx_runtime = require("react/jsx-runtime");
+var TalaDBContext = (0, import_react.createContext)(null);
+function TalaDBProvider({ db, children }) {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(TalaDBContext.Provider, { value: db, children });
+}
+function useTalaDB() {
+  const db = (0, import_react.useContext)(TalaDBContext);
+  if (db === null) {
+    throw new Error("useTalaDB must be used inside <TalaDBProvider db={...}>");
+  }
+  return db;
+}
+
+// src/useCollection.ts
+var import_react2 = require("react");
+function useCollection(name) {
+  const db = useTalaDB();
+  return (0, import_react2.useMemo)(() => db.collection(name), [db, name]);
+}
+
+// src/useFind.ts
+var import_react3 = require("react");
+function useFind(collection, filter) {
+  const snapshotRef = (0, import_react3.useRef)({ data: [], loading: true });
+  const filterKey = JSON.stringify(filter ?? null);
+  const subscribe = (0, import_react3.useCallback)(
+    (notify) => {
+      snapshotRef.current = { data: snapshotRef.current.data, loading: true };
+      return collection.subscribe(filter, (docs) => {
+        snapshotRef.current = { data: docs, loading: false };
+        notify();
+      });
+    },
+    // filterKey captures the serialised filter; collection is the identity dep.
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [collection, filterKey]
+  );
+  const getSnapshot = (0, import_react3.useCallback)(() => snapshotRef.current, []);
+  return (0, import_react3.useSyncExternalStore)(subscribe, getSnapshot, getSnapshot);
+}
+
+// src/useFindOne.ts
+var import_react4 = require("react");
+function useFindOne(collection, filter) {
+  const snapshotRef = (0, import_react4.useRef)({ data: null, loading: true });
+  const filterKey = JSON.stringify(filter);
+  const subscribe = (0, import_react4.useCallback)(
+    (notify) => {
+      snapshotRef.current = { data: snapshotRef.current.data, loading: true };
+      return collection.subscribe(filter, (docs) => {
+        snapshotRef.current = { data: docs[0] ?? null, loading: false };
+        notify();
+      });
+    },
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [collection, filterKey]
+  );
+  const getSnapshot = (0, import_react4.useCallback)(() => snapshotRef.current, []);
+  return (0, import_react4.useSyncExternalStore)(subscribe, getSnapshot, getSnapshot);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TalaDBProvider,
+  useCollection,
+  useFind,
+  useFindOne,
+  useTalaDB
+});

package/dist/index.mjs

@@ -0,0 +1,69 @@
+// src/context.tsx
+import { createContext, useContext } from "react";
+import { jsx } from "react/jsx-runtime";
+var TalaDBContext = createContext(null);
+function TalaDBProvider({ db, children }) {
+  return /* @__PURE__ */ jsx(TalaDBContext.Provider, { value: db, children });
+}
+function useTalaDB() {
+  const db = useContext(TalaDBContext);
+  if (db === null) {
+    throw new Error("useTalaDB must be used inside <TalaDBProvider db={...}>");
+  }
+  return db;
+}
+
+// src/useCollection.ts
+import { useMemo } from "react";
+function useCollection(name) {
+  const db = useTalaDB();
+  return useMemo(() => db.collection(name), [db, name]);
+}
+
+// src/useFind.ts
+import { useCallback, useRef, useSyncExternalStore } from "react";
+function useFind(collection, filter) {
+  const snapshotRef = useRef({ data: [], loading: true });
+  const filterKey = JSON.stringify(filter ?? null);
+  const subscribe = useCallback(
+    (notify) => {
+      snapshotRef.current = { data: snapshotRef.current.data, loading: true };
+      return collection.subscribe(filter, (docs) => {
+        snapshotRef.current = { data: docs, loading: false };
+        notify();
+      });
+    },
+    // filterKey captures the serialised filter; collection is the identity dep.
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [collection, filterKey]
+  );
+  const getSnapshot = useCallback(() => snapshotRef.current, []);
+  return useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
+}
+
+// src/useFindOne.ts
+import { useCallback as useCallback2, useRef as useRef2, useSyncExternalStore as useSyncExternalStore2 } from "react";
+function useFindOne(collection, filter) {
+  const snapshotRef = useRef2({ data: null, loading: true });
+  const filterKey = JSON.stringify(filter);
+  const subscribe = useCallback2(
+    (notify) => {
+      snapshotRef.current = { data: snapshotRef.current.data, loading: true };
+      return collection.subscribe(filter, (docs) => {
+        snapshotRef.current = { data: docs[0] ?? null, loading: false };
+        notify();
+      });
+    },
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [collection, filterKey]
+  );
+  const getSnapshot = useCallback2(() => snapshotRef.current, []);
+  return useSyncExternalStore2(subscribe, getSnapshot, getSnapshot);
+}
+export {
+  TalaDBProvider,
+  useCollection,
+  useFind,
+  useFindOne,
+  useTalaDB
+};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@taladb/react",
+  "version": "0.5.0",
+  "description": "React hooks for TalaDB — useFind, useFindOne, and useCollection for React and React Native",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "database",
+    "local-first",
+    "react",
+    "react-native",
+    "hooks",
+    "offline",
+    "vector",
+    "live-queries"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/thinkgrid-labs/taladb.git",
+    "directory": "packages/taladb-react"
+  },
+  "homepage": "https://thinkgrid-labs.github.io/taladb/guide/react",
+  "bugs": {
+    "url": "https://github.com/thinkgrid-labs/taladb/issues"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "taladb": "0.5.0"
+  },
+  "devDependencies": {
+    "@testing-library/react": "^16.0.0",
+    "@types/react": "^18.0.0",
+    "jsdom": "^26.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.0",
+    "taladb": "0.5.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}