convex-helpers 0.1.47 → 0.1.48

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "convex-helpers",
-  "version": "0.1.47",
+  "version": "0.1.48",
   "description": "A collection of useful code to complement the official convex package.",
   "type": "module",
   "exports": {
@@ -105,7 +105,7 @@
     "test:debug": "vitest --inspect-brk --no-file-parallelism",
     "test:coverage": "vitest run --coverage --coverage.reporter=text",
     "clean": "rm -rf dist",
-    "dev": "chokidar '*.ts' 'server/*.ts' 'react/*.ts' 'react/cache/*.ts' 'tsconfig*.json' 'package.json' -c 'npm run build' --initial",
+    "dev": "chokidar '*.ts' 'server/**/*.ts' 'react/**/*.ts*' 'tsconfig*.json' 'package.json' -c 'npm run build' --initial",
     "arethetypeswrong": "attw $(npm pack)"
   },
   "repository": {
@@ -146,10 +146,10 @@
     "@edge-runtime/vm": "3.2.0",
     "@types/node": "20.14.9",
     "@types/react": "18.3.3",
-    "@vitest/coverage-v8": "2.0.2",
+    "@vitest/coverage-v8": "2.0.3",
     "chokidar-cli": "3.0.0",
     "convex-test": "0.0.23",
     "typescript": "5.5.3",
-    "vitest": "2.0.2"
+    "vitest": "2.0.3"
   }
 }

package/react/cache/provider.d.ts

@@ -52,7 +52,6 @@ type SubEntry<Query extends FunctionReference<"query">> = {
     setter: (v?: FunctionReturnType<Query>) => void;
 };
 declare class CacheRegistry {
-    #private;
     queries: Map<QueryKey, CachedQuery<FunctionReference<"query">>>;
     subs: Map<SubKey, SubEntry<FunctionReference<"query">>>;
     convex: ConvexReactClient;

package/react/cache/provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["provider.tsx"],"names":[],"mappings":"AACA,OAAO,EAAa,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAiB,EAAE,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE7D,eAAO,MAAM,uBAAuB;cAChB,aAAa,GAAG,IAAI;EACtC,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,EAAE,EAAE,CACvC,iBAAiB,CAAC,uBAAuB,CAAC,CAgB3C,CAAC;AAKF,MAAM,MAAM,uBAAuB,GAAG;IACpC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;GAEG;AAEH,KAAK,MAAM,GAAG,MAAM,CAAC;AACrB,KAAK,QAAQ,GAAG,MAAM,CAAC;AACvB,KAAK,WAAW,CAAC,KAAK,SAAS,iBAAiB,CAAC,OAAO,CAAC,IAAI;IAC3D,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;IACnB,KAAK,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;CAC3C,CAAC;AACF,KAAK,QAAQ,CAAC,KAAK,SAAS,iBAAiB,CAAC,OAAO,CAAC,IAAI;IACxD,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC;CACjD,CAAC;AAGF,cAAM,aAAa;;IACjB,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAChE,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACxD,MAAM,EAAE,iBAAiB,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;gBAED,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,uBAAuB;IA0BvE,KAAK,CAAC,KAAK,SAAS,iBAAiB,CAAC,OAAO,CAAC,EAC5C,QAAQ,EAAE,QAAQ,GACjB,kBAAkB,CAAC,KAAK,CAAC,GAAG,SAAS;IAMxC,KAAK,CAAC,KAAK,SAAS,iBAAiB,CAAC,OAAO,CAAC,EAC5C,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,EACzB,MAAM,EAAE,CAAC,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,KAAK,IAAI,GAC7C,IAAI;IAoCP,GAAG,CAAC,EAAE,EAAE,MAAM;IA0Bd,KAAK;CAeN"}
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["provider.tsx"],"names":[],"mappings":"AACA,OAAO,EAAa,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAiB,EAAE,EAAE,iBAAiB,EAAW,MAAM,OAAO,CAAC;AAEtE,eAAO,MAAM,uBAAuB;cAChB,aAAa,GAAG,IAAI;EACtC,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,EAAE,EAAE,CACvC,iBAAiB,CAAC,uBAAuB,CAAC,CAmB3C,CAAC;AAKF,MAAM,MAAM,uBAAuB,GAAG;IACpC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;GAEG;AAEH,KAAK,MAAM,GAAG,MAAM,CAAC;AACrB,KAAK,QAAQ,GAAG,MAAM,CAAC;AACvB,KAAK,WAAW,CAAC,KAAK,SAAS,iBAAiB,CAAC,OAAO,CAAC,IAAI;IAC3D,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;IACnB,KAAK,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;CAC3C,CAAC;AACF,KAAK,QAAQ,CAAC,KAAK,SAAS,iBAAiB,CAAC,OAAO,CAAC,IAAI;IACxD,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC;CACjD,CAAC;AAGF,cAAM,aAAa;IACjB,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAChE,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACxD,MAAM,EAAE,iBAAiB,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;gBAED,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,uBAAuB;IAoBvE,KAAK,CAAC,KAAK,SAAS,iBAAiB,CAAC,OAAO,CAAC,EAC5C,QAAQ,EAAE,QAAQ,GACjB,kBAAkB,CAAC,KAAK,CAAC,GAAG,SAAS;IAMxC,KAAK,CAAC,KAAK,SAAS,iBAAiB,CAAC,OAAO,CAAC,EAC5C,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,EACzB,MAAM,EAAE,CAAC,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,KAAK,IAAI,GAC7C,IAAI;IAwCP,GAAG,CAAC,EAAE,EAAE,MAAM;IA0Bd,KAAK;CAeN"}

package/react/cache/provider.js

@@ -1,7 +1,7 @@
 "use client";
 import { jsx as _jsx } from "react/jsx-runtime";
 import { useConvex } from "convex/react";
-import { createContext } from "react";
+import { createContext, useMemo } from "react";
 export const ConvexQueryCacheContext = createContext({
     registry: null,
 });
@@ -13,14 +13,14 @@ export const ConvexQueryCacheContext = createContext({
  * @param {ConvexQueryCacheOptions} props.options - Options for the query cache
  * @returns {Element}
  */
-export const ConvexQueryCacheProvider = ({ children, ...options }) => {
+export const ConvexQueryCacheProvider = ({ children, debug, expiration, maxIdleEntries }) => {
     const convex = useConvex();
     if (convex === undefined) {
         throw new Error("Could not find Convex client! `ConvexQueryCacheProvider` must be used in the React component " +
             "tree under `ConvexProvider`. Did you forget it? " +
             "See https://docs.convex.dev/quick-start#set-up-convex-in-your-react-app");
     }
-    const registry = new CacheRegistry(convex, options);
+    const registry = useMemo(() => new CacheRegistry(convex, { debug, expiration, maxIdleEntries }), [convex, debug, expiration, maxIdleEntries]);
     return (_jsx(ConvexQueryCacheContext.Provider, { value: { registry }, children: children }));
 };
 const DEFAULT_EXPIRATION_MS = 300_000; // 5 minutes
@@ -53,27 +53,27 @@ class CacheRegistry {
             }, 3000);
         }
     }
-    #getQueryEntry(queryKey) {
-        const entry = this.queries.get(queryKey);
-        return entry;
-    }
     probe(queryKey) {
-        const entry = this.#getQueryEntry(queryKey);
+        const entry = this.queries.get(queryKey);
         return entry === undefined ? undefined : entry.value;
     }
     // Enable a new subscription.
     start(id, queryKey, query, args, setter) {
-        let entry = this.#getQueryEntry(queryKey);
+        let entry = this.queries.get(queryKey);
         this.subs.set(id, {
             queryKey,
             setter,
         });
         if (entry === undefined) {
+            const w = this.convex.watchQuery(query, args);
             entry = {
                 refs: new Set(),
                 evictTimer: null,
+                // On the first pass, it might already have a result,
+                // either if there are queries not managed by the cache previously,
+                // or if the registry is hot-reloaded.
+                value: w.localQueryResult(),
             };
-            const w = this.convex.watchQuery(query, args);
             const unsub = w.onUpdate(() => {
                 const e = entry;
                 try {

package/react/cache/provider.tsx

@@ -5,7 +5,7 @@ import {
   FunctionReference,
   FunctionReturnType,
 } from "convex/server";
-import { createContext, FC, PropsWithChildren } from "react";
+import { createContext, FC, PropsWithChildren, useMemo } from "react";
 
 export const ConvexQueryCacheContext = createContext({
   registry: null as CacheRegistry | null,
@@ -21,7 +21,7 @@ export const ConvexQueryCacheContext = createContext({
  */
 export const ConvexQueryCacheProvider: FC<
   PropsWithChildren<ConvexQueryCacheOptions>
-> = ({ children, ...options }) => {
+> = ({ children, debug, expiration, maxIdleEntries }) => {
   const convex = useConvex();
   if (convex === undefined) {
     throw new Error(
@@ -30,7 +30,10 @@ export const ConvexQueryCacheProvider: FC<
         "See https://docs.convex.dev/quick-start#set-up-convex-in-your-react-app",
     );
   }
-  const registry = new CacheRegistry(convex, options);
+  const registry = useMemo(
+    () => new CacheRegistry(convex, { debug, expiration, maxIdleEntries }),
+    [convex, debug, expiration, maxIdleEntries],
+  );
   return (
     <ConvexQueryCacheContext.Provider value={{ registry }}>
       {children}
@@ -112,17 +115,11 @@ class CacheRegistry {
       }, 3000);
     }
   }
-  #getQueryEntry(
-    queryKey: QueryKey,
-  ): CachedQuery<FunctionReference<"query">> | undefined {
-    const entry = this.queries.get(queryKey);
-    return entry;
-  }
 
   probe<Query extends FunctionReference<"query">>(
     queryKey: QueryKey,
   ): FunctionReturnType<Query> | undefined {
-    const entry = this.#getQueryEntry(queryKey);
+    const entry = this.queries.get(queryKey);
     return entry === undefined ? undefined : entry.value;
   }
 
@@ -134,17 +131,21 @@ class CacheRegistry {
     args: FunctionArgs<Query>,
     setter: (v: FunctionReturnType<Query>) => void,
   ): void {
-    let entry = this.#getQueryEntry(queryKey);
+    let entry = this.queries.get(queryKey);
     this.subs.set(id, {
       queryKey,
       setter,
     });
     if (entry === undefined) {
+      const w = this.convex.watchQuery(query, args);
       entry = {
         refs: new Set(),
         evictTimer: null,
+        // On the first pass, it might already have a result,
+        // either if there are queries not managed by the cache previously,
+        // or if the registry is hot-reloaded.
+        value: w.localQueryResult(),
       };
-      const w = this.convex.watchQuery(query, args);
       const unsub = w.onUpdate(() => {
         const e = entry!;
         try {