@confect/react 10.0.0-next.20 → 10.0.0-next.22

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["useConvexQuery","QueryResult.load","QueryResult.succeed","QueryResult.fail","convexVersion","PaginatedQueryResult.failure","PaginatedQueryResult.loadingFirstPage","PaginatedQueryResult.loadingMore","PaginatedQueryResult.canLoadMore","PaginatedQueryResult.exhausted","OptimisticLocalStore.make","useConvexMutation","useConvexAction"],"sources":["../src/index.ts"],"sourcesContent":["import { Ref } from \"@confect/core\";\nimport { version as convexVersion } from \"convex\";\nimport type { OptimisticUpdate as ConvexOptimisticUpdate } from \"convex/browser\";\nimport * as ConvexReact from \"convex/react\";\nimport type { usePaginatedQuery as useConvexPaginatedQuery } from \"convex/react\";\nimport {\n  useAction as useConvexAction,\n  useMutation as useConvexMutation,\n  useQuery as useConvexQuery,\n  type ReactMutation as ConvexReactMutation,\n} from \"convex/react\";\nimport type { FunctionReference } from \"convex/server\";\nimport type { Value } from \"convex/values\";\nimport * as Cause from \"effect/Cause\";\nimport * as Effect from \"effect/Effect\";\nimport * as Result from \"effect/Result\";\nimport * as Exit from \"effect/Exit\";\nimport * as Match from \"effect/Match\";\nimport * as Option from \"effect/Option\";\nimport { useCallback, useMemo } from \"react\";\n\nimport * as OptimisticLocalStore from \"./OptimisticLocalStore\";\nimport * as PaginatedQueryResult from \"./PaginatedQueryResult\";\nimport * as QueryResult from \"./QueryResult\";\n\nexport { OptimisticLocalStore, PaginatedQueryResult, QueryResult };\n\nexport type InvokeReturn<Ref_ extends Ref.Any> = [Ref.Error<Ref_>] extends [\n  never,\n]\n  ? Promise<Ref.Returns<Ref_>>\n  : Promise<Result.Result<Ref.Returns<Ref_>, Ref.Error<Ref_>>>;\n\ntype UseQueryArgs<Query extends Ref.AnyPublicQuery> =\n  keyof Ref.Args<Query> extends never\n    ? [args?: Ref.Args<Query> | \"skip\"]\n    : [args: Ref.Args<Query> | \"skip\"];\n\nexport const useQuery = <Query extends Ref.AnyPublicQuery>(\n  ref: Query,\n  ...rest: UseQueryArgs<Query>\n): QueryResult.QueryResult<Ref.Returns<Query>, Ref.Error<Query>> => {\n  const functionReference = Ref.getFunctionReference(ref);\n  const args = rest[0];\n  const skipped = args === \"skip\";\n  const encodedArgs = skipped\n    ? \"skip\"\n    : Ref.encodeArgsSync(ref, (args ?? {}) as Ref.Args<Query>);\n\n  // `useConvexQuery` returns a referentially stable value while the underlying\n  // Convex result is unchanged, and throws a stable error when the query\n  // fails. We capture either outcome as a `Result` and decode/wrap it inside\n  // `useMemo` so that the returned `QueryResult` keeps a stable identity across\n  // renders when nothing has actually changed. Decoding on every render would\n  // hand consumers a fresh object each time, breaking effects and memoization\n  // that depend on the result's identity.\n  const encodedReturnsOrError: Result.Result<unknown, unknown> = Result.try(\n    () => useConvexQuery(functionReference, encodedArgs),\n  );\n\n  return useMemo(\n    () =>\n      Result.match(encodedReturnsOrError, {\n        onSuccess: (encodedReturnsOrUndefined) =>\n          encodedReturnsOrUndefined === undefined\n            ? QueryResult.load(skipped)\n            : QueryResult.succeed(\n                Ref.decodeReturnsSync(ref, encodedReturnsOrUndefined),\n              ),\n        onFailure: (error) => {\n          if (Ref.isConvexError(error)) {\n            const decoded = Ref.decodeErrorOption(ref, error.data);\n            if (Option.isSome(decoded)) {\n              return QueryResult.fail(decoded.value);\n            }\n          }\n          throw error;\n        },\n      }),\n    // `Result.try` allocates a fresh wrapper each render, so we key the memo on\n    // the stable value it carries (the Convex result or thrown error) rather\n    // than the wrapper itself; the decoded result is a function of that value,\n    // `ref`, and `skipped`.\n    [ref, skipped, Result.merge(encodedReturnsOrError)],\n  );\n};\n\n/**\n * Like `Omit`, but implemented with key remapping so that optional modifiers\n * are preserved and index signatures don't reintroduce the omitted key's\n * literal type. Mirrors `BetterOmit` from `convex/server`.\n */\ntype OmitKey<T, K extends PropertyKey> = {\n  [P in keyof T as P extends K ? never : P]: T[P];\n};\n\n/**\n * The args accepted by {@link usePaginatedQuery}: the ref's args without\n * `paginationOpts`, which the underlying Convex hook manages itself. When no\n * args remain, resolves to `Record<string, never>` (only the empty object is\n * accepted) rather than `{}`, which would accept any non-nullish value.\n */\nexport type PaginatedQueryArgs<Query extends Ref.AnyPublicPaginatedQuery> =\n  OmitKey<Ref.Args<Query>, \"paginationOpts\"> extends infer Args_\n    ? keyof Args_ extends never\n      ? Record<string, never>\n      : Args_\n    : never;\n\n/**\n * The item type for a paginated query: the element type of the `page` field\n * of the ref's returns.\n */\nexport type PaginatedQueryItem<Query extends Ref.AnyPublicPaginatedQuery> =\n  Ref.Returns<Query>[\"page\"][number];\n\n/**\n * The args parameter of {@link usePaginatedQuery}: the ref's args without\n * `paginationOpts`, or `\"skip\"` to skip the query.\n */\nexport type UsePaginatedQueryArgs<Query extends Ref.AnyPublicPaginatedQuery> =\n  | PaginatedQueryArgs<Query>\n  | \"skip\";\n\nexport type PaginatedQueryOptions = Parameters<\n  typeof useConvexPaginatedQuery\n>[2];\n\n/**\n * The `user`-facing result of `usePaginatedQueryInternal` from `convex/react`,\n * including the `\"Error\"` status its non-throwing mode can return.\n */\ninterface ConvexPaginatedQueryInternalUser {\n  readonly results: ReadonlyArray<unknown>;\n  readonly status:\n    | \"LoadingFirstPage\"\n    | \"LoadingMore\"\n    | \"CanLoadMore\"\n    | \"Exhausted\"\n    | \"Error\";\n  readonly isLoading: boolean;\n  readonly loadMore: (numItems: number) => void;\n  readonly error?: unknown;\n}\n\ntype UseConvexPaginatedQueryInternal = (\n  query: FunctionReference<\"query\">,\n  args: Record<string, Value> | \"skip\",\n  options: PaginatedQueryOptions,\n  throwOnError: boolean,\n) => { user: ConvexPaginatedQueryInternalUser };\n\n// `usePaginatedQueryInternal` is runtime-exported by convex/react but absent\n// from its public type declarations. It is the only way to observe query\n// errors as values: the public positional `usePaginatedQuery` hard-codes\n// throwOnError and throws mid-hook-sequence, which cannot be caught without\n// breaking React's hook-order invariant.\nconst useConvexPaginatedQueryInternal = (\n  ConvexReact as unknown as Record<string, unknown>\n).usePaginatedQueryInternal as UseConvexPaginatedQueryInternal | undefined;\n\nconst MINIMUM_CONVEX_VERSION = \"1.36.0\";\n\n/**\n * The non-throwing mode of `usePaginatedQueryInternal` — its fourth,\n * `throwOnError` parameter — arrived in convex 1.36.0. Convex 1.32 through\n * 1.35 export the same symbol taking only three parameters, where a fourth\n * argument is silently ignored and errors are always thrown.\n *\n * The function itself cannot be interrogated for this: `Function.length`\n * counts parameters up to the first one with a default, and 1.36.0 declares\n * `throwOnError = true`, so both shapes report an arity of 3. The package\n * version is the only reliable signal.\n */\nconst supportsErrorsAsValues = ((): boolean => {\n  const [major, minor] = String(convexVersion).split(\".\").map(Number);\n  if (\n    major === undefined ||\n    minor === undefined ||\n    Number.isNaN(major) ||\n    Number.isNaN(minor)\n  ) {\n    return false;\n  }\n  const [minimumMajor, minimumMinor] = MINIMUM_CONVEX_VERSION.split(\".\").map(\n    Number,\n  ) as [number, number];\n  return (\n    major > minimumMajor || (major === minimumMajor && minor >= minimumMinor)\n  );\n})();\n\n/**\n * Load data reactively from a paginated query defined with\n * `FunctionSpec.publicPaginatedQuery`, mirroring the ergonomics of\n * `usePaginatedQuery` from `convex/react`.\n *\n * Args are encoded via the ref's user-args schema (`paginationOpts` is managed\n * by the Convex hook, not the caller), and each loaded page is decoded via the\n * ref's item schema.\n *\n * Returns a {@link PaginatedQueryResult.PaginatedQueryResult}: the loaded\n * variants carry `results` and `isLoading`, and `CanLoadMore` additionally\n * carries `loadMore`; if the `Ref` declares an `error` schema and the query\n * fails with that typed error, the decoded error is returned as the `Failure`\n * variant, which also carries the pages loaded before the failure. Unknown\n * errors are thrown, to be caught by an error boundary.\n */\nexport const usePaginatedQuery = <Query extends Ref.AnyPublicPaginatedQuery>(\n  ref: Query,\n  args: UsePaginatedQueryArgs<Query>,\n  options: PaginatedQueryOptions,\n): PaginatedQueryResult.PaginatedQueryResult<\n  PaginatedQueryItem<Query>,\n  Ref.Error<Query>\n> => {\n  if (\n    useConvexPaginatedQueryInternal === undefined ||\n    !supportsErrorsAsValues\n  ) {\n    throw new Error(\n      `usePaginatedQuery requires convex >= ${MINIMUM_CONVEX_VERSION}, but found ` +\n        `${convexVersion}. Earlier versions always throw paginated query errors ` +\n        \"instead of returning them, so a declared `error` schema cannot be \" +\n        \"surfaced as a `Failure` — upgrade the `convex` package.\",\n    );\n  }\n\n  const functionReference = Ref.getFunctionReference(ref);\n  const skipped = args === \"skip\";\n\n  // The encoded output is the wire form Convex's hook forwards verbatim, not\n  // the ref's decoded args type.\n  const encodedArgs = useMemo(\n    () =>\n      args === \"skip\"\n        ? (\"skip\" as const)\n        : (Ref.encodePaginatedQueryArgsSync(\n            ref,\n            args as unknown as Omit<Ref.Args<Query>, \"paginationOpts\">,\n          ) as Record<string, Value>),\n    [ref, args],\n  );\n\n  const { user: convexResult } = useConvexPaginatedQueryInternal(\n    functionReference,\n    encodedArgs,\n    options,\n    false,\n  );\n\n  // The Convex hook carries the pages loaded so far on every status,\n  // failures included, so results are decoded unconditionally.\n  //\n  // Decoding allocates fresh items, so key on the referentially stable\n  // `results` the Convex hook provides — the same identity-preservation\n  // rationale as in `useQuery` above.\n  const { results: encodedResults } = convexResult;\n  const decodedResults = useMemo(\n    () => Ref.decodePaginationPageSync(ref, encodedResults),\n    [ref, encodedResults],\n  );\n\n  const { status, loadMore } = convexResult;\n  const error = status === \"Error\" ? convexResult.error : undefined;\n\n  return useMemo(\n    (): PaginatedQueryResult.Variants<\n      PaginatedQueryItem<Query>,\n      Ref.Error<Query>\n    > =>\n      // `status` is a bare string union rather than a tagged one, so the arms\n      // match on literals.\n      Match.value(status).pipe(\n        Match.when(\"Error\", () => {\n          if (Ref.isConvexError(error)) {\n            const decoded = Ref.decodeErrorOption(ref, error.data);\n            if (Option.isSome(decoded)) {\n              return PaginatedQueryResult.failure({\n                error: decoded.value,\n                results: decodedResults,\n              });\n            }\n          }\n          // Unknown errors still throw. All hooks have run by this point, so\n          // an aborted render here is hook-order-safe.\n          throw error;\n        }),\n        Match.when(\"LoadingFirstPage\", () =>\n          PaginatedQueryResult.loadingFirstPage({ skipped }),\n        ),\n        Match.when(\"LoadingMore\", () =>\n          PaginatedQueryResult.loadingMore({ results: decodedResults }),\n        ),\n        // `CanLoadMore` is the only status whose `loadMore` does anything —\n        // the Convex hook returns an intentional no-op for all the others, so\n        // they carry no callback at all.\n        Match.when(\"CanLoadMore\", () =>\n          PaginatedQueryResult.canLoadMore({\n            results: decodedResults,\n            loadMore,\n          }),\n        ),\n        Match.when(\"Exhausted\", () =>\n          PaginatedQueryResult.exhausted({ results: decodedResults }),\n        ),\n        Match.exhaustive,\n      ),\n    // The memo produces `Variants`, the conditional return type's superset —\n    // when `E` is `never` the `Failure` arm is unreachable at runtime, which\n    // is exactly what the conditional encodes.\n    [ref, skipped, decodedResults, status, loadMore, error],\n  ) as PaginatedQueryResult.PaginatedQueryResult<\n    PaginatedQueryItem<Query>,\n    Ref.Error<Query>\n  >;\n};\n\n/**\n * An optimistic update for a Confect mutation. Mirrors Convex's\n * `OptimisticUpdate`, but receives a Confect {@link OptimisticLocalStore} and\n * the decoded mutation `args`.\n */\nexport type OptimisticUpdate<Mutation extends Ref.AnyPublicMutation> = (\n  localStore: OptimisticLocalStore.OptimisticLocalStore,\n  args: Ref.Args<Mutation>,\n) => void;\n\n/**\n * The handle returned by {@link useMutation}. It is callable like the function\n * returned by Convex's `useMutation`, and additionally exposes\n * `withOptimisticUpdate` for attaching an optimistic update. Mirrors the\n * `ReactMutation` type from `convex/react`.\n */\nexport interface ReactMutation<Mutation extends Ref.AnyPublicMutation> {\n  (...args: Ref.OptionalArgs<Mutation>): InvokeReturn<Mutation>;\n  withOptimisticUpdate(\n    optimisticUpdate: OptimisticUpdate<Mutation>,\n  ): ReactMutation<Mutation>;\n}\n\nconst makeReactMutation = <Mutation extends Ref.AnyPublicMutation>(\n  ref: Mutation,\n  convexReactMutation: ConvexReactMutation<\n    Ref.FunctionReference<Mutation> & FunctionReference<\"mutation\">\n  >,\n): ReactMutation<Mutation> => {\n  const callable = ((...args: Ref.OptionalArgs<Mutation>) =>\n    invokeAsResult(\n      ref,\n      (_, encodedArgs) => convexReactMutation(encodedArgs as never),\n      args,\n    ).then((result) =>\n      Ref.hasErrorSchema(ref) ? result : Result.getOrThrow(result),\n    )) as (...args: Ref.OptionalArgs<Mutation>) => InvokeReturn<Mutation>;\n\n  const withOptimisticUpdate = (\n    optimisticUpdate: OptimisticUpdate<Mutation>,\n  ): ReactMutation<Mutation> => {\n    const wrappedUpdate: ConvexOptimisticUpdate<Record<string, Value>> = (\n      convexLocalStore,\n      encodedArgs,\n    ) => {\n      const decodedArgs = Ref.decodeArgsSync(ref, encodedArgs);\n      optimisticUpdate(\n        OptimisticLocalStore.make(convexLocalStore),\n        decodedArgs,\n      );\n    };\n    const nextConvexReactMutation =\n      convexReactMutation.withOptimisticUpdate(wrappedUpdate);\n    return makeReactMutation(ref, nextConvexReactMutation);\n  };\n\n  return Object.assign(callable, { withOptimisticUpdate });\n};\n\n/**\n * Returns a {@link ReactMutation} handle for the provided `Ref`'s mutation. The\n * handle is callable to invoke the mutation, and exposes `withOptimisticUpdate`\n * for attaching an optimistic update, mirroring `useMutation` from\n * `convex/react`.\n *\n * If the `Ref` declares an `error` schema, the returned promise resolves to a\n * `Result` with the decoded `returns` value in the `Success` and the decoded\n * error in the `Failure`.\n *\n * If the `Ref` does not declare an `error` schema, the promise resolves\n * directly to the decoded `returns` value, matching the behavior of\n * `useMutation` from `convex/react`.\n *\n * Any other failure rejects the promise.\n */\nexport const useMutation = <Mutation extends Ref.AnyPublicMutation>(\n  ref: Mutation,\n): ReactMutation<Mutation> => {\n  const functionReference = Ref.getFunctionReference(ref);\n  const convexReactMutation = useConvexMutation(functionReference);\n\n  return useMemo(\n    () =>\n      makeReactMutation(\n        ref,\n        convexReactMutation as ConvexReactMutation<\n          Ref.FunctionReference<Mutation> & FunctionReference<\"mutation\">\n        >,\n      ),\n    [ref, convexReactMutation],\n  );\n};\n\n/**\n * Returns a function that invokes the provided `Ref`'s action.\n *\n * If the `Ref` declares an `error` schema, the returned promise resolves to a\n * `Result` with the decoded `returns` value in the `Success` and the decoded\n * error in the `Failure`.\n *\n * If the `Ref` does not declare an `error` schema, the promise resolves\n * directly to the decoded `returns` value, matching the behavior of\n * `useMutation` from `convex/react`.\n *\n * Any other failure rejects the promise.\n */\nexport const useAction = <Action extends Ref.AnyPublicAction>(\n  ref: Action,\n): ((...args: Ref.OptionalArgs<Action>) => InvokeReturn<Action>) => {\n  const functionReference = Ref.getFunctionReference(ref);\n  const actualAction = useConvexAction(functionReference);\n\n  return useCallback(\n    ((...args: Ref.OptionalArgs<Action>) =>\n      invokeAsResult(\n        ref,\n        (_, encodedArgs) => actualAction(encodedArgs),\n        args,\n      ).then((result) =>\n        Ref.hasErrorSchema(ref) ? result : Result.getOrThrow(result),\n      )) as (...args: Ref.OptionalArgs<Action>) => InvokeReturn<Action>,\n    [ref, actualAction],\n  );\n};\n\nconst invokeAsResult = async <Ref_ extends Ref.Any>(\n  ref: Ref_,\n  invoke: (\n    fnRef: Ref.FunctionReference<Ref_>,\n    encodedArgs: unknown,\n  ) => PromiseLike<unknown>,\n  args: Ref.OptionalArgs<Ref_>,\n): Promise<Result.Result<Ref.Returns<Ref_>, Ref.Error<Ref_>>> => {\n  const exit = await Effect.runPromiseExit(\n    Ref.runWithCodec(ref, (args[0] ?? {}) as Ref.Args<Ref_>, invoke).pipe(\n      Effect.catchTag(\"SchemaError\", Effect.die),\n      Effect.result,\n    ),\n  );\n  if (Exit.isSuccess(exit)) return exit.value;\n  throw Cause.squash(exit.cause);\n};\n"],"mappings":";;;;;;;;;;;;;;;AAsCA,MAAa,YACX,KACA,GAAG,SAC+D;CAClE,MAAM,oBAAoB,IAAI,qBAAqB,GAAG;CACtD,MAAM,OAAO,KAAK;CAClB,MAAM,UAAU,SAAS;CACzB,MAAM,cAAc,UAChB,SACA,IAAI,eAAe,KAAM,QAAQ,CAAC,CAAqB;CAS3D,MAAM,wBAAyD,OAAO,UAC9DA,WAAe,mBAAmB,WAAW,CACrD;CAEA,OAAO,cAEH,OAAO,MAAM,uBAAuB;EAClC,YAAY,8BACV,8BAA8B,KAAA,IAC1BC,KAAiB,OAAO,IACxBC,QACE,IAAI,kBAAkB,KAAK,yBAAyB,CACtD;EACN,YAAY,UAAU;GACpB,IAAI,IAAI,cAAc,KAAK,GAAG;IAC5B,MAAM,UAAU,IAAI,kBAAkB,KAAK,MAAM,IAAI;IACrD,IAAI,OAAO,OAAO,OAAO,GACvB,OAAOC,KAAiB,QAAQ,KAAK;GAEzC;GACA,MAAM;EACR;CACF,CAAC,GAKH;EAAC;EAAK;EAAS,OAAO,MAAM,qBAAqB;CAAC,CACpD;AACF;AAwEA,MAAM,kCACJ,YACA;AAEF,MAAM,yBAAyB;;;;;;;;;;;;AAa/B,MAAM,gCAAyC;CAC7C,MAAM,CAAC,OAAO,SAAS,OAAOC,OAAa,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,MAAM;CAClE,IACE,UAAU,KAAA,KACV,UAAU,KAAA,KACV,OAAO,MAAM,KAAK,KAClB,OAAO,MAAM,KAAK,GAElB,OAAO;CAET,MAAM,CAAC,cAAc,gBAAgB,uBAAuB,MAAM,GAAG,CAAC,CAAC,IACrE,MACF;CACA,OACE,QAAQ,gBAAiB,UAAU,gBAAgB,SAAS;AAEhE,EAAA,CAAG;;;;;;;;;;;;;;;;;AAkBH,MAAa,qBACX,KACA,MACA,YAIG;CACH,IACE,oCAAoC,KAAA,KACpC,CAAC,wBAED,MAAM,IAAI,MACR,wCAAwC,uBAAuB,cAC1DA,QAAc,uLAGrB;CAGF,MAAM,oBAAoB,IAAI,qBAAqB,GAAG;CACtD,MAAM,UAAU,SAAS;CAIzB,MAAM,cAAc,cAEhB,SAAS,SACJ,SACA,IAAI,6BACH,KACA,IACF,GACN,CAAC,KAAK,IAAI,CACZ;CAEA,MAAM,EAAE,MAAM,iBAAiB,gCAC7B,mBACA,aACA,SACA,KACF;CAQA,MAAM,EAAE,SAAS,mBAAmB;CACpC,MAAM,iBAAiB,cACf,IAAI,yBAAyB,KAAK,cAAc,GACtD,CAAC,KAAK,cAAc,CACtB;CAEA,MAAM,EAAE,QAAQ,aAAa;CAC7B,MAAM,QAAQ,WAAW,UAAU,aAAa,QAAQ,KAAA;CAExD,OAAO,cAOH,MAAM,MAAM,MAAM,CAAC,CAAC,KAClB,MAAM,KAAK,eAAe;EACxB,IAAI,IAAI,cAAc,KAAK,GAAG;GAC5B,MAAM,UAAU,IAAI,kBAAkB,KAAK,MAAM,IAAI;GACrD,IAAI,OAAO,OAAO,OAAO,GACvB,OAAOC,QAA6B;IAClC,OAAO,QAAQ;IACf,SAAS;GACX,CAAC;EAEL;EAGA,MAAM;CACR,CAAC,GACD,MAAM,KAAK,0BACTC,iBAAsC,EAAE,QAAQ,CAAC,CACnD,GACA,MAAM,KAAK,qBACTC,YAAiC,EAAE,SAAS,eAAe,CAAC,CAC9D,GAIA,MAAM,KAAK,qBACTC,YAAiC;EAC/B,SAAS;EACT;CACF,CAAC,CACH,GACA,MAAM,KAAK,mBACTC,UAA+B,EAAE,SAAS,eAAe,CAAC,CAC5D,GACA,MAAM,UACR,GAIF;EAAC;EAAK;EAAS;EAAgB;EAAQ;EAAU;CAAK,CACxD;AAIF;AAyBA,MAAM,qBACJ,KACA,wBAG4B;CAC5B,MAAM,aAAa,GAAG,SACpB,eACE,MACC,GAAG,gBAAgB,oBAAoB,WAAoB,GAC5D,IACF,CAAC,CAAC,MAAM,WACN,IAAI,eAAe,GAAG,IAAI,SAAS,OAAO,WAAW,MAAM,CAC7D;CAEF,MAAM,wBACJ,qBAC4B;EAC5B,MAAM,iBACJ,kBACA,gBACG;GACH,MAAM,cAAc,IAAI,eAAe,KAAK,WAAW;GACvD,iBACEC,KAA0B,gBAAgB,GAC1C,WACF;EACF;EACA,MAAM,0BACJ,oBAAoB,qBAAqB,aAAa;EACxD,OAAO,kBAAkB,KAAK,uBAAuB;CACvD;CAEA,OAAO,OAAO,OAAO,UAAU,EAAE,qBAAqB,CAAC;AACzD;;;;;;;;;;;;;;;;;AAkBA,MAAa,eACX,QAC4B;CAE5B,MAAM,sBAAsBC,cADF,IAAI,qBAAqB,GACW,CAAC;CAE/D,OAAO,cAEH,kBACE,KACA,mBAGF,GACF,CAAC,KAAK,mBAAmB,CAC3B;AACF;;;;;;;;;;;;;;AAeA,MAAa,aACX,QACkE;CAElE,MAAM,eAAeC,YADK,IAAI,qBAAqB,GACE,CAAC;CAEtD,OAAO,cACH,GAAG,SACH,eACE,MACC,GAAG,gBAAgB,aAAa,WAAW,GAC5C,IACF,CAAC,CAAC,MAAM,WACN,IAAI,eAAe,GAAG,IAAI,SAAS,OAAO,WAAW,MAAM,CAC7D,IACF,CAAC,KAAK,YAAY,CACpB;AACF;AAEA,MAAM,iBAAiB,OACrB,KACA,QAIA,SAC+D;CAC/D,MAAM,OAAO,MAAM,OAAO,eACxB,IAAI,aAAa,KAAM,KAAK,MAAM,CAAC,GAAsB,MAAM,CAAC,CAAC,KAC/D,OAAO,SAAS,eAAe,OAAO,GAAG,GACzC,OAAO,MACT,CACF;CACA,IAAI,KAAK,UAAU,IAAI,GAAG,OAAO,KAAK;CACtC,MAAM,MAAM,OAAO,KAAK,KAAK;AAC/B"}
+{"version":3,"file":"index.js","names":["useConvexQuery","QueryResult.load","QueryResult.succeed","QueryResult.fail","convexVersion","PaginatedQueryResult.failure","PaginatedQueryResult.loadingFirstPage","PaginatedQueryResult.loadingMore","PaginatedQueryResult.canLoadMore","PaginatedQueryResult.exhausted","StreamPagination.empty","StreamPagination.initial","StreamPagination.pageRequests","useConvexQueries","StreamPagination.interpret","StreamPagination.isLastPageSplitting","StreamPagination.loadMore","OptimisticLocalStore.make","useConvexMutation","useConvexAction"],"sources":["../src/index.ts"],"sourcesContent":["import { Ref } from \"@confect/core\";\nimport { version as convexVersion } from \"convex\";\nimport type { OptimisticUpdate as ConvexOptimisticUpdate } from \"convex/browser\";\nimport * as ConvexReact from \"convex/react\";\nimport type { usePaginatedQuery as useConvexPaginatedQuery } from \"convex/react\";\nimport {\n  useAction as useConvexAction,\n  useMutation as useConvexMutation,\n  useQueries as useConvexQueries,\n  useQuery as useConvexQuery,\n  type ReactMutation as ConvexReactMutation,\n} from \"convex/react\";\nimport { getFunctionName, type FunctionReference } from \"convex/server\";\nimport { ConvexError, convexToJson, type Value } from \"convex/values\";\nimport * as Cause from \"effect/Cause\";\nimport * as Effect from \"effect/Effect\";\nimport * as Result from \"effect/Result\";\nimport * as Exit from \"effect/Exit\";\nimport * as Match from \"effect/Match\";\nimport * as Option from \"effect/Option\";\nimport { useCallback, useMemo, useState } from \"react\";\n\nimport * as OptimisticLocalStore from \"./OptimisticLocalStore\";\nimport * as PaginatedQueryResult from \"./PaginatedQueryResult\";\nimport * as QueryResult from \"./QueryResult\";\nimport * as StreamPagination from \"./StreamPagination\";\n\nexport {\n  OptimisticLocalStore,\n  PaginatedQueryResult,\n  QueryResult,\n  StreamPagination,\n};\n\nexport type InvokeReturn<Ref_ extends Ref.Any> = [Ref.Error<Ref_>] extends [\n  never,\n]\n  ? Promise<Ref.Returns<Ref_>>\n  : Promise<Result.Result<Ref.Returns<Ref_>, Ref.Error<Ref_>>>;\n\ntype UseQueryArgs<Query extends Ref.AnyPublicQuery> =\n  keyof Ref.Args<Query> extends never\n    ? [args?: Ref.Args<Query> | \"skip\"]\n    : [args: Ref.Args<Query> | \"skip\"];\n\nexport const useQuery = <Query extends Ref.AnyPublicQuery>(\n  ref: Query,\n  ...rest: UseQueryArgs<Query>\n): QueryResult.QueryResult<Ref.Returns<Query>, Ref.Error<Query>> => {\n  const functionReference = Ref.getFunctionReference(ref);\n  const args = rest[0];\n  const skipped = args === \"skip\";\n  const encodedArgs = skipped\n    ? \"skip\"\n    : Ref.encodeArgsSync(ref, (args ?? {}) as Ref.Args<Query>);\n\n  // `useConvexQuery` returns a referentially stable value while the underlying\n  // Convex result is unchanged, and throws a stable error when the query\n  // fails. We capture either outcome as a `Result` and decode/wrap it inside\n  // `useMemo` so that the returned `QueryResult` keeps a stable identity across\n  // renders when nothing has actually changed. Decoding on every render would\n  // hand consumers a fresh object each time, breaking effects and memoization\n  // that depend on the result's identity.\n  const encodedReturnsOrError: Result.Result<unknown, unknown> = Result.try(\n    () => useConvexQuery(functionReference, encodedArgs),\n  );\n\n  return useMemo(\n    () =>\n      Result.match(encodedReturnsOrError, {\n        onSuccess: (encodedReturnsOrUndefined) =>\n          encodedReturnsOrUndefined === undefined\n            ? QueryResult.load(skipped)\n            : QueryResult.succeed(\n                Ref.decodeReturnsSync(ref, encodedReturnsOrUndefined),\n              ),\n        onFailure: (error) => {\n          if (Ref.isConvexError(error)) {\n            const decoded = Ref.decodeErrorOption(ref, error.data);\n            if (Option.isSome(decoded)) {\n              return QueryResult.fail(decoded.value);\n            }\n          }\n          throw error;\n        },\n      }),\n    // `Result.try` allocates a fresh wrapper each render, so we key the memo on\n    // the stable value it carries (the Convex result or thrown error) rather\n    // than the wrapper itself; the decoded result is a function of that value,\n    // `ref`, and `skipped`.\n    [ref, skipped, Result.merge(encodedReturnsOrError)],\n  );\n};\n\n/**\n * Like `Omit`, but implemented with key remapping so that optional modifiers\n * are preserved and index signatures don't reintroduce the omitted key's\n * literal type. Mirrors `BetterOmit` from `convex/server`.\n */\ntype OmitKey<T, K extends PropertyKey> = {\n  [P in keyof T as P extends K ? never : P]: T[P];\n};\n\n/**\n * The args accepted by {@link usePaginatedQuery}: the ref's args without\n * `paginationOpts`, which the underlying Convex hook manages itself. When no\n * args remain, resolves to `Record<string, never>` (only the empty object is\n * accepted) rather than `{}`, which would accept any non-nullish value.\n */\nexport type PaginatedQueryArgs<Query extends Ref.AnyPublicPaginatedQuery> =\n  OmitKey<Ref.Args<Query>, \"paginationOpts\"> extends infer Args_\n    ? keyof Args_ extends never\n      ? Record<string, never>\n      : Args_\n    : never;\n\n/**\n * The item type for a paginated query: the element type of the `page` field\n * of the ref's returns.\n */\nexport type PaginatedQueryItem<Query extends Ref.AnyPublicPaginatedQuery> =\n  Ref.Returns<Query>[\"page\"][number];\n\n/**\n * The args parameter of {@link usePaginatedQuery}: the ref's args without\n * `paginationOpts`, or `\"skip\"` to skip the query.\n */\nexport type UsePaginatedQueryArgs<Query extends Ref.AnyPublicPaginatedQuery> =\n  | PaginatedQueryArgs<Query>\n  | \"skip\";\n\nexport type PaginatedQueryOptions = Parameters<\n  typeof useConvexPaginatedQuery\n>[2];\n\n/**\n * The `user`-facing result of `usePaginatedQueryInternal` from `convex/react`,\n * including the `\"Error\"` status its non-throwing mode can return.\n */\ninterface ConvexPaginatedQueryInternalUser {\n  readonly results: ReadonlyArray<unknown>;\n  readonly status:\n    | \"LoadingFirstPage\"\n    | \"LoadingMore\"\n    | \"CanLoadMore\"\n    | \"Exhausted\"\n    | \"Error\";\n  readonly isLoading: boolean;\n  readonly loadMore: (numItems: number) => void;\n  readonly error?: unknown;\n}\n\ntype UseConvexPaginatedQueryInternal = (\n  query: FunctionReference<\"query\">,\n  args: Record<string, Value> | \"skip\",\n  options: PaginatedQueryOptions,\n  throwOnError: boolean,\n) => { user: ConvexPaginatedQueryInternalUser };\n\n// `usePaginatedQueryInternal` is runtime-exported by convex/react but absent\n// from its public type declarations. It is the only way to observe query\n// errors as values: the public positional `usePaginatedQuery` hard-codes\n// throwOnError and throws mid-hook-sequence, which cannot be caught without\n// breaking React's hook-order invariant.\nconst useConvexPaginatedQueryInternal = (\n  ConvexReact as unknown as Record<string, unknown>\n).usePaginatedQueryInternal as UseConvexPaginatedQueryInternal | undefined;\n\nconst MINIMUM_CONVEX_VERSION = \"1.36.0\";\n\n/**\n * The non-throwing mode of `usePaginatedQueryInternal`—its fourth,\n * `throwOnError` parameter—arrived in convex 1.36.0. Convex 1.32 through\n * 1.35 export the same symbol taking only three parameters, where a fourth\n * argument is silently ignored and errors are always thrown.\n *\n * The function itself cannot be interrogated for this: `Function.length`\n * counts parameters up to the first one with a default, and 1.36.0 declares\n * `throwOnError = true`, so both shapes report an arity of 3. The package\n * version is the only reliable signal.\n */\nconst supportsErrorsAsValues = ((): boolean => {\n  const [major, minor] = convexVersion.split(\".\").map(Number);\n  if (\n    major === undefined ||\n    minor === undefined ||\n    Number.isNaN(major) ||\n    Number.isNaN(minor)\n  ) {\n    return false;\n  }\n  const [minimumMajor, minimumMinor] = MINIMUM_CONVEX_VERSION.split(\".\").map(\n    Number,\n  ) as [number, number];\n  return (\n    major > minimumMajor || (major === minimumMajor && minor >= minimumMinor)\n  );\n})();\n\n/**\n * Load data reactively from a paginated query defined with\n * `FunctionSpec.publicPaginatedQuery`, mirroring the ergonomics of\n * `usePaginatedQuery` from `convex/react`.\n *\n * Args are encoded via the ref's user-args schema (`paginationOpts` is managed\n * by the Convex hook, not the caller), and each loaded page is decoded via the\n * ref's item schema.\n *\n * Returns a {@link PaginatedQueryResult.PaginatedQueryResult}: the loaded\n * variants carry `results` and `isLoading`, and `CanLoadMore` additionally\n * carries `loadMore`; if the `Ref` declares an `error` schema and the query\n * fails with that typed error, the decoded error is returned as the `Failure`\n * variant, which also carries the pages loaded before the failure. Unknown\n * errors are thrown, to be caught by an error boundary.\n */\nexport const usePaginatedQuery = <Query extends Ref.AnyPublicPaginatedQuery>(\n  ref: Query,\n  args: UsePaginatedQueryArgs<Query>,\n  options: PaginatedQueryOptions,\n): PaginatedQueryResult.PaginatedQueryResult<\n  PaginatedQueryItem<Query>,\n  Ref.Error<Query>\n> => {\n  if (\n    useConvexPaginatedQueryInternal === undefined ||\n    !supportsErrorsAsValues\n  ) {\n    throw new Error(\n      `usePaginatedQuery requires convex >= ${MINIMUM_CONVEX_VERSION}, but found ` +\n        `${convexVersion}. Earlier versions always throw paginated query errors ` +\n        \"instead of returning them, so a declared `error` schema cannot be \" +\n        \"surfaced as a `Failure`—upgrade the `convex` package.\",\n    );\n  }\n\n  const functionReference = Ref.getFunctionReference(ref);\n  const skipped = args === \"skip\";\n\n  // The encoded output is the wire form Convex's hook forwards verbatim, not\n  // the ref's decoded args type.\n  const encodedArgs = useMemo(\n    () =>\n      args === \"skip\"\n        ? (\"skip\" as const)\n        : (Ref.encodePaginatedQueryArgsSync(\n            ref,\n            args as unknown as Omit<Ref.Args<Query>, \"paginationOpts\">,\n          ) as Record<string, Value>),\n    [ref, args],\n  );\n\n  const { user: convexResult } = useConvexPaginatedQueryInternal(\n    functionReference,\n    encodedArgs,\n    options,\n    false,\n  );\n\n  // The Convex hook carries the pages loaded so far on every status,\n  // failures included, so results are decoded unconditionally.\n  //\n  // Decoding allocates fresh items, so key on the referentially stable\n  // `results` the Convex hook provides—the same identity-preservation\n  // rationale as in `useQuery` above.\n  const { results: encodedResults } = convexResult;\n  const decodedResults = useMemo(\n    () => Ref.decodePaginationPageSync(ref, encodedResults),\n    [ref, encodedResults],\n  );\n\n  const { status, loadMore } = convexResult;\n  const error = status === \"Error\" ? convexResult.error : undefined;\n\n  return useMemo(\n    (): PaginatedQueryResult.Variants<\n      PaginatedQueryItem<Query>,\n      Ref.Error<Query>\n    > =>\n      // `status` is a bare string union rather than a tagged one, so the arms\n      // match on literals.\n      Match.value(status).pipe(\n        Match.when(\"Error\", () => {\n          if (Ref.isConvexError(error)) {\n            const decoded = Ref.decodeErrorOption(ref, error.data);\n            if (Option.isSome(decoded)) {\n              return PaginatedQueryResult.failure({\n                error: decoded.value,\n                results: decodedResults,\n              });\n            }\n          }\n          // Unknown errors still throw. All hooks have run by this point, so\n          // an aborted render here is hook-order-safe.\n          throw error;\n        }),\n        Match.when(\"LoadingFirstPage\", () =>\n          PaginatedQueryResult.loadingFirstPage({ skipped }),\n        ),\n        Match.when(\"LoadingMore\", () =>\n          PaginatedQueryResult.loadingMore({ results: decodedResults }),\n        ),\n        // `CanLoadMore` is the only status whose `loadMore` does anything—the Convex hook returns an intentional no-op for all the others, so\n        // they carry no callback at all.\n        Match.when(\"CanLoadMore\", () =>\n          PaginatedQueryResult.canLoadMore({\n            results: decodedResults,\n            loadMore,\n          }),\n        ),\n        Match.when(\"Exhausted\", () =>\n          PaginatedQueryResult.exhausted({ results: decodedResults }),\n        ),\n        Match.exhaustive,\n      ),\n    // The memo produces `Variants`, the conditional return type's superset—when `E` is `never` the `Failure` arm is unreachable at runtime, which\n    // is exactly what the conditional encodes.\n    [ref, skipped, decodedResults, status, loadMore, error],\n  ) as PaginatedQueryResult.PaginatedQueryResult<\n    PaginatedQueryItem<Query>,\n    Ref.Error<Query>\n  >;\n};\n\n/**\n * Whether a paginated query error means the stored cursors no longer match\n * the query (a data-dependent query changed underneath us), calling for a\n * full pagination reset rather than a failure.\n */\nconst isInvalidCursorError = (error: Error): boolean =>\n  error.message.includes(\"InvalidCursor\") ||\n  (error instanceof ConvexError &&\n    typeof error.data === \"object\" &&\n    error.data !== null &&\n    // Both Convex's built-in pagination (which also sets\n    // `isConvexSystemError`) and `QueryStream.paginate` signal an invalid\n    // cursor with this data shape—the same check `convex/react` performs.\n    (error.data as { paginationError?: unknown }).paginationError ===\n      \"InvalidCursor\");\n\nconst NO_ITEMS: ReadonlyArray<unknown> = [];\n\n/**\n * EXPERIMENTAL—endCursor-pinned reactive pagination (see\n * `notes/stream-based-querying.md`). Use it with paginated queries whose\n * handlers paginate via `QueryStream.paginate`: those don't write the query\n * journal that {@link usePaginatedQuery}'s built-in reactivity relies on,\n * so gap-free pages must be maintained by the client instead. (It works\n * with any paginated query honoring the `endCursor` protocol field,\n * including the built-in `paginate`.)\n *\n * Each loaded page is pinned to a fixed index range by re-subscribing it\n * with its `continueCursor` echoed back as `endCursor`—pages then grow\n * and shrink reactively but always meet exactly, and a page that outgrows\n * `initialNumItems` is split in two. This is the mechanism of\n * `convex-helpers/react`'s `usePaginatedQuery`, re-expressed over the pure\n * {@link StreamPagination} state machine, with args/items/errors codec'd\n * through the ref's schemas exactly like {@link usePaginatedQuery}.\n */\nexport const useStreamPaginatedQuery = <\n  Query extends Ref.AnyPublicPaginatedQuery,\n>(\n  ref: Query,\n  args: UsePaginatedQueryArgs<Query>,\n  options: {\n    readonly initialNumItems: number;\n    /**\n     * Per-page read budgets forwarded as `paginationOpts.maximumRowsRead`\n     * and `paginationOpts.maximumBytesRead`: a page that would scan more\n     * rows, or read more bytes, than these returns truncated with\n     * `SplitRequired` (and the hook splits it) instead of exceeding\n     * Convex's query limits on a filter-heavy stream.\n     */\n    readonly maximumRowsRead?: number;\n    readonly maximumBytesRead?: number;\n  },\n): PaginatedQueryResult.PaginatedQueryResult<\n  PaginatedQueryItem<Query>,\n  Ref.Error<Query>\n> => {\n  // `useQueries` requires a *referentially stable* queries object while\n  // nothing has changed: its subscription memo keys on identity, and its\n  // `useSubscription` re-runs a render-phase state update whenever the\n  // subscription changes—an unstable input loops the render. Callers\n  // typically pass a fresh `args` literal each render, so everything that\n  // feeds the queries object is stabilized by *value* here: the function\n  // reference by `ref`, and the encoded args by their serialized form (as\n  // `convex/react`'s own paginated hook does).\n  const functionReference = useMemo(() => Ref.getFunctionReference(ref), [ref]);\n  const skipped = args === \"skip\";\n\n  const rawEncodedArgs =\n    args === \"skip\"\n      ? undefined\n      : (Ref.encodePaginatedQueryArgsSync(\n          ref,\n          args as unknown as Omit<Ref.Args<Query>, \"paginationOpts\">,\n        ) as Record<string, Value>);\n  const encodedArgsKey =\n    rawEncodedArgs === undefined\n      ? \"skip\"\n      : JSON.stringify(convexToJson(rawEncodedArgs));\n  const encodedArgs = useMemo(\n    () => rawEncodedArgs,\n    // The serialized form stands in for the freshly allocated object.\n    [ref, encodedArgsKey],\n  );\n\n  // A change of query, args, skippedness, or page size restarts pagination\n  // from scratch.\n  const resetKey = useMemo(\n    () =>\n      JSON.stringify([\n        getFunctionName(functionReference),\n        encodedArgsKey,\n        options.initialNumItems,\n        options.maximumRowsRead ?? null,\n        options.maximumBytesRead ?? null,\n      ]),\n    [\n      functionReference,\n      encodedArgsKey,\n      options.initialNumItems,\n      options.maximumRowsRead,\n      options.maximumBytesRead,\n    ],\n  );\n\n  const freshState = () =>\n    skipped\n      ? StreamPagination.empty\n      : StreamPagination.initial(options.initialNumItems, options);\n\n  const [tracked, setTracked] = useState(() => ({\n    resetKey,\n    state: freshState(),\n  }));\n  // Render-phase reset—the React-sanctioned derived-state-from-props\n  // pattern, also how `convex/react`'s own paginated hook resets.\n  let current = tracked;\n  if (current.resetKey !== resetKey) {\n    current = { resetKey, state: freshState() };\n    setTracked(current);\n  }\n\n  const applyTransitions = useCallback(\n    (\n      transitions: ReadonlyArray<\n        (state: StreamPagination.State) => StreamPagination.State\n      >,\n    ) =>\n      setTracked((previous) => ({\n        resetKey: previous.resetKey,\n        state: transitions.reduce(\n          (state, transition) => transition(state),\n          previous.state,\n        ),\n      })),\n    [],\n  );\n\n  const queries = useMemo(\n    () =>\n      StreamPagination.pageRequests(current.state, (page) => ({\n        query: functionReference,\n        args: { ...encodedArgs, paginationOpts: page },\n      })),\n    [current.state, functionReference, encodedArgs],\n  );\n\n  const resultsObject = useConvexQueries(\n    queries as unknown as Parameters<typeof useConvexQueries>[0],\n  );\n\n  const interpretation = useMemo(\n    () =>\n      StreamPagination.interpret(\n        current.state,\n        resultsObject as StreamPagination.Results,\n        { initialNumItems: options.initialNumItems, isInvalidCursorError },\n      ),\n    [current.state, resultsObject, options.initialNumItems],\n  );\n\n  // Apply the transitions this render discovered (completed split swaps,\n  // new splits of overgrown pages) or restart after an invalid cursor—render-phase state updates, as in `convex-helpers`' hook. Both settle:\n  // the updated state no longer produces the same discovery.\n  if (interpretation._tag === \"ResetRequired\") {\n    setTracked((previous) => ({\n      resetKey: previous.resetKey,\n      state: freshState(),\n    }));\n  } else if (\n    interpretation._tag === \"Interpreted\" &&\n    interpretation.transitions.length > 0\n  ) {\n    applyTransitions(interpretation.transitions);\n  }\n\n  const encodedItems =\n    interpretation._tag === \"ResetRequired\" ? NO_ITEMS : interpretation.items;\n  // Page results keep their identity while unchanged (only the page that\n  // actually updated is a fresh object), so caching decodes per encoded\n  // item makes a single-page update decode only that page's items rather\n  // than every loaded page's.\n  const decodeCache = useMemo(\n    () => new WeakMap<object, PaginatedQueryItem<Query>>(),\n    [ref],\n  );\n  const decodedResults = useMemo(\n    () =>\n      encodedItems.map((item): PaginatedQueryItem<Query> => {\n        if (typeof item !== \"object\" || item === null) {\n          return Ref.decodePaginationPageSync(ref, [\n            item,\n          ])[0] as PaginatedQueryItem<Query>;\n        }\n        const cached = decodeCache.get(item);\n        if (cached !== undefined) {\n          return cached;\n        }\n        const decoded = Ref.decodePaginationPageSync(ref, [\n          item,\n        ])[0] as PaginatedQueryItem<Query>;\n        decodeCache.set(item, decoded);\n        return decoded;\n      }),\n    [ref, encodedItems, decodeCache],\n  );\n\n  return useMemo((): PaginatedQueryResult.Variants<\n    PaginatedQueryItem<Query>,\n    Ref.Error<Query>\n  > => {\n    if (interpretation._tag === \"ResetRequired\") {\n      return PaginatedQueryResult.loadingFirstPage({ skipped });\n    }\n    if (interpretation._tag === \"Failed\") {\n      const error = interpretation.error;\n      if (Ref.isConvexError(error)) {\n        const decoded = Ref.decodeErrorOption(ref, error.data);\n        if (Option.isSome(decoded)) {\n          return PaginatedQueryResult.failure({\n            error: decoded.value,\n            results: decodedResults,\n          });\n        }\n      }\n      // Unknown errors still throw, to be caught by an error boundary.\n      throw error;\n    }\n\n    const { lastResult } = interpretation;\n    if (Option.isNone(lastResult) && current.state.pageKeys.length <= 1) {\n      return PaginatedQueryResult.loadingFirstPage({ skipped });\n    }\n    if (\n      Option.isNone(lastResult) ||\n      StreamPagination.isLastPageSplitting(current.state)\n    ) {\n      return PaginatedQueryResult.loadingMore({ results: decodedResults });\n    }\n    if (lastResult.value.isDone) {\n      return PaginatedQueryResult.exhausted({ results: decodedResults });\n    }\n\n    const continueCursor = lastResult.value.continueCursor;\n    // A per-result guard, as in `convex-helpers`: calling `loadMore`\n    // repeatedly before the next render is a single load.\n    let alreadyLoadingMore = false;\n    return PaginatedQueryResult.canLoadMore({\n      results: decodedResults,\n      loadMore: (numItems: number) => {\n        if (!alreadyLoadingMore) {\n          alreadyLoadingMore = true;\n          applyTransitions([\n            StreamPagination.loadMore(continueCursor, numItems, options),\n          ]);\n        }\n      },\n    });\n  }, [\n    interpretation,\n    decodedResults,\n    current.state,\n    skipped,\n    ref,\n    applyTransitions,\n  ]) as PaginatedQueryResult.PaginatedQueryResult<\n    PaginatedQueryItem<Query>,\n    Ref.Error<Query>\n  >;\n};\n\n/**\n * An optimistic update for a Confect mutation. Mirrors Convex's\n * `OptimisticUpdate`, but receives a Confect {@link OptimisticLocalStore} and\n * the decoded mutation `args`.\n */\nexport type OptimisticUpdate<Mutation extends Ref.AnyPublicMutation> = (\n  localStore: OptimisticLocalStore.OptimisticLocalStore,\n  args: Ref.Args<Mutation>,\n) => void;\n\n/**\n * The handle returned by {@link useMutation}. It is callable like the function\n * returned by Convex's `useMutation`, and additionally exposes\n * `withOptimisticUpdate` for attaching an optimistic update. Mirrors the\n * `ReactMutation` type from `convex/react`.\n */\nexport interface ReactMutation<Mutation extends Ref.AnyPublicMutation> {\n  (...args: Ref.OptionalArgs<Mutation>): InvokeReturn<Mutation>;\n  withOptimisticUpdate(\n    optimisticUpdate: OptimisticUpdate<Mutation>,\n  ): ReactMutation<Mutation>;\n}\n\nconst makeReactMutation = <Mutation extends Ref.AnyPublicMutation>(\n  ref: Mutation,\n  convexReactMutation: ConvexReactMutation<\n    Ref.FunctionReference<Mutation> & FunctionReference<\"mutation\">\n  >,\n): ReactMutation<Mutation> => {\n  const callable = ((...args: Ref.OptionalArgs<Mutation>) =>\n    invokeAsResult(\n      ref,\n      (_, encodedArgs) => convexReactMutation(encodedArgs as never),\n      args,\n    ).then((result) =>\n      Ref.hasErrorSchema(ref) ? result : Result.getOrThrow(result),\n    )) as (...args: Ref.OptionalArgs<Mutation>) => InvokeReturn<Mutation>;\n\n  const withOptimisticUpdate = (\n    optimisticUpdate: OptimisticUpdate<Mutation>,\n  ): ReactMutation<Mutation> => {\n    const wrappedUpdate: ConvexOptimisticUpdate<Record<string, Value>> = (\n      convexLocalStore,\n      encodedArgs,\n    ) => {\n      const decodedArgs = Ref.decodeArgsSync(ref, encodedArgs);\n      optimisticUpdate(\n        OptimisticLocalStore.make(convexLocalStore),\n        decodedArgs,\n      );\n    };\n    const nextConvexReactMutation =\n      convexReactMutation.withOptimisticUpdate(wrappedUpdate);\n    return makeReactMutation(ref, nextConvexReactMutation);\n  };\n\n  return Object.assign(callable, { withOptimisticUpdate });\n};\n\n/**\n * Returns a {@link ReactMutation} handle for the provided `Ref`'s mutation. The\n * handle is callable to invoke the mutation, and exposes `withOptimisticUpdate`\n * for attaching an optimistic update, mirroring `useMutation` from\n * `convex/react`.\n *\n * If the `Ref` declares an `error` schema, the returned promise resolves to a\n * `Result` with the decoded `returns` value in the `Success` and the decoded\n * error in the `Failure`.\n *\n * If the `Ref` does not declare an `error` schema, the promise resolves\n * directly to the decoded `returns` value, matching the behavior of\n * `useMutation` from `convex/react`.\n *\n * Any other failure rejects the promise.\n */\nexport const useMutation = <Mutation extends Ref.AnyPublicMutation>(\n  ref: Mutation,\n): ReactMutation<Mutation> => {\n  const functionReference = Ref.getFunctionReference(ref);\n  const convexReactMutation = useConvexMutation(functionReference);\n\n  return useMemo(\n    () =>\n      makeReactMutation(\n        ref,\n        convexReactMutation as ConvexReactMutation<\n          Ref.FunctionReference<Mutation> & FunctionReference<\"mutation\">\n        >,\n      ),\n    [ref, convexReactMutation],\n  );\n};\n\n/**\n * Returns a function that invokes the provided `Ref`'s action.\n *\n * If the `Ref` declares an `error` schema, the returned promise resolves to a\n * `Result` with the decoded `returns` value in the `Success` and the decoded\n * error in the `Failure`.\n *\n * If the `Ref` does not declare an `error` schema, the promise resolves\n * directly to the decoded `returns` value, matching the behavior of\n * `useMutation` from `convex/react`.\n *\n * Any other failure rejects the promise.\n */\nexport const useAction = <Action extends Ref.AnyPublicAction>(\n  ref: Action,\n): ((...args: Ref.OptionalArgs<Action>) => InvokeReturn<Action>) => {\n  const functionReference = Ref.getFunctionReference(ref);\n  const actualAction = useConvexAction(functionReference);\n\n  return useCallback(\n    ((...args: Ref.OptionalArgs<Action>) =>\n      invokeAsResult(\n        ref,\n        (_, encodedArgs) => actualAction(encodedArgs),\n        args,\n      ).then((result) =>\n        Ref.hasErrorSchema(ref) ? result : Result.getOrThrow(result),\n      )) as (...args: Ref.OptionalArgs<Action>) => InvokeReturn<Action>,\n    [ref, actualAction],\n  );\n};\n\nconst invokeAsResult = <Ref_ extends Ref.Any>(\n  ref: Ref_,\n  invoke: (\n    fnRef: Ref.FunctionReference<Ref_>,\n    encodedArgs: unknown,\n  ) => PromiseLike<unknown>,\n  args: Ref.OptionalArgs<Ref_>,\n): Promise<Result.Result<Ref.Returns<Ref_>, Ref.Error<Ref_>>> => {\n  const exitPromise = Effect.runPromiseExit(\n    Ref.runWithCodec(ref, (args[0] ?? {}) as Ref.Args<Ref_>, invoke).pipe(\n      Effect.catchTag(\"SchemaError\", Effect.die),\n      Effect.result,\n    ),\n  );\n  return exitPromise.then((exit) => {\n    if (Exit.isSuccess(exit)) return exit.value;\n    throw Cause.squash(exit.cause);\n  });\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AA6CA,MAAa,YACX,KACA,GAAG,SAC+D;CAClE,MAAM,oBAAoB,IAAI,qBAAqB,GAAG;CACtD,MAAM,OAAO,KAAK;CAClB,MAAM,UAAU,SAAS;CACzB,MAAM,cAAc,UAChB,SACA,IAAI,eAAe,KAAM,QAAQ,CAAC,CAAqB;CAS3D,MAAM,wBAAyD,OAAO,UAC9DA,WAAe,mBAAmB,WAAW,CACrD;CAEA,OAAO,cAEH,OAAO,MAAM,uBAAuB;EAClC,YAAY,8BACV,8BAA8B,KAAA,IAC1BC,KAAiB,OAAO,IACxBC,QACE,IAAI,kBAAkB,KAAK,yBAAyB,CACtD;EACN,YAAY,UAAU;GACpB,IAAI,IAAI,cAAc,KAAK,GAAG;IAC5B,MAAM,UAAU,IAAI,kBAAkB,KAAK,MAAM,IAAI;IACrD,IAAI,OAAO,OAAO,OAAO,GACvB,OAAOC,KAAiB,QAAQ,KAAK;GAEzC;GACA,MAAM;EACR;CACF,CAAC,GAKH;EAAC;EAAK;EAAS,OAAO,MAAM,qBAAqB;CAAC,CACpD;AACF;AAwEA,MAAM,kCACJ,YACA;AAEF,MAAM,yBAAyB;;;;;;;;;;;;AAa/B,MAAM,gCAAyC;CAC7C,MAAM,CAAC,OAAO,SAASC,QAAc,MAAM,GAAG,CAAC,CAAC,IAAI,MAAM;CAC1D,IACE,UAAU,KAAA,KACV,UAAU,KAAA,KACV,OAAO,MAAM,KAAK,KAClB,OAAO,MAAM,KAAK,GAElB,OAAO;CAET,MAAM,CAAC,cAAc,gBAAgB,uBAAuB,MAAM,GAAG,CAAC,CAAC,IACrE,MACF;CACA,OACE,QAAQ,gBAAiB,UAAU,gBAAgB,SAAS;AAEhE,EAAA,CAAG;;;;;;;;;;;;;;;;;AAkBH,MAAa,qBACX,KACA,MACA,YAIG;CACH,IACE,oCAAoC,KAAA,KACpC,CAAC,wBAED,MAAM,IAAI,MACR,wCAAwC,uBAAuB,cAC1DA,QAAc,qLAGrB;CAGF,MAAM,oBAAoB,IAAI,qBAAqB,GAAG;CACtD,MAAM,UAAU,SAAS;CAIzB,MAAM,cAAc,cAEhB,SAAS,SACJ,SACA,IAAI,6BACH,KACA,IACF,GACN,CAAC,KAAK,IAAI,CACZ;CAEA,MAAM,EAAE,MAAM,iBAAiB,gCAC7B,mBACA,aACA,SACA,KACF;CAQA,MAAM,EAAE,SAAS,mBAAmB;CACpC,MAAM,iBAAiB,cACf,IAAI,yBAAyB,KAAK,cAAc,GACtD,CAAC,KAAK,cAAc,CACtB;CAEA,MAAM,EAAE,QAAQ,aAAa;CAC7B,MAAM,QAAQ,WAAW,UAAU,aAAa,QAAQ,KAAA;CAExD,OAAO,cAOH,MAAM,MAAM,MAAM,CAAC,CAAC,KAClB,MAAM,KAAK,eAAe;EACxB,IAAI,IAAI,cAAc,KAAK,GAAG;GAC5B,MAAM,UAAU,IAAI,kBAAkB,KAAK,MAAM,IAAI;GACrD,IAAI,OAAO,OAAO,OAAO,GACvB,OAAOC,QAA6B;IAClC,OAAO,QAAQ;IACf,SAAS;GACX,CAAC;EAEL;EAGA,MAAM;CACR,CAAC,GACD,MAAM,KAAK,0BACTC,iBAAsC,EAAE,QAAQ,CAAC,CACnD,GACA,MAAM,KAAK,qBACTC,YAAiC,EAAE,SAAS,eAAe,CAAC,CAC9D,GAGA,MAAM,KAAK,qBACTC,YAAiC;EAC/B,SAAS;EACT;CACF,CAAC,CACH,GACA,MAAM,KAAK,mBACTC,UAA+B,EAAE,SAAS,eAAe,CAAC,CAC5D,GACA,MAAM,UACR,GAGF;EAAC;EAAK;EAAS;EAAgB;EAAQ;EAAU;CAAK,CACxD;AAIF;;;;;;AAOA,MAAM,wBAAwB,UAC5B,MAAM,QAAQ,SAAS,eAAe,KACrC,iBAAiB,eAChB,OAAO,MAAM,SAAS,YACtB,MAAM,SAAS,QAId,MAAM,KAAuC,oBAC5C;AAEN,MAAM,WAAmC,CAAC;;;;;;;;;;;;;;;;;;AAmB1C,MAAa,2BAGX,KACA,MACA,YAeG;CASH,MAAM,oBAAoB,cAAc,IAAI,qBAAqB,GAAG,GAAG,CAAC,GAAG,CAAC;CAC5E,MAAM,UAAU,SAAS;CAEzB,MAAM,iBACJ,SAAS,SACL,KAAA,IACC,IAAI,6BACH,KACA,IACF;CACN,MAAM,iBACJ,mBAAmB,KAAA,IACf,SACA,KAAK,UAAU,aAAa,cAAc,CAAC;CACjD,MAAM,cAAc,cACZ,gBAEN,CAAC,KAAK,cAAc,CACtB;CAIA,MAAM,WAAW,cAEb,KAAK,UAAU;EACb,gBAAgB,iBAAiB;EACjC;EACA,QAAQ;EACR,QAAQ,mBAAmB;EAC3B,QAAQ,oBAAoB;CAC9B,CAAC,GACH;EACE;EACA;EACA,QAAQ;EACR,QAAQ;EACR,QAAQ;CACV,CACF;CAEA,MAAM,mBACJ,UACIC,QACAC,QAAyB,QAAQ,iBAAiB,OAAO;CAE/D,MAAM,CAAC,SAAS,cAAc,gBAAgB;EAC5C;EACA,OAAO,WAAW;CACpB,EAAE;CAGF,IAAI,UAAU;CACd,IAAI,QAAQ,aAAa,UAAU;EACjC,UAAU;GAAE;GAAU,OAAO,WAAW;EAAE;EAC1C,WAAW,OAAO;CACpB;CAEA,MAAM,mBAAmB,aAErB,gBAIA,YAAY,cAAc;EACxB,UAAU,SAAS;EACnB,OAAO,YAAY,QAChB,OAAO,eAAe,WAAW,KAAK,GACvC,SAAS,KACX;CACF,EAAE,GACJ,CAAC,CACH;CAEA,MAAM,UAAU,cAEZC,aAA8B,QAAQ,QAAQ,UAAU;EACtD,OAAO;EACP,MAAM;GAAE,GAAG;GAAa,gBAAgB;EAAK;CAC/C,EAAE,GACJ;EAAC,QAAQ;EAAO;EAAmB;CAAW,CAChD;CAEA,MAAM,gBAAgBC,WACpB,OACF;CAEA,MAAM,iBAAiB,cAEnBC,UACE,QAAQ,OACR,eACA;EAAE,iBAAiB,QAAQ;EAAiB;CAAqB,CACnE,GACF;EAAC,QAAQ;EAAO;EAAe,QAAQ;CAAe,CACxD;CAKA,IAAI,eAAe,SAAS,iBAC1B,YAAY,cAAc;EACxB,UAAU,SAAS;EACnB,OAAO,WAAW;CACpB,EAAE;MACG,IACL,eAAe,SAAS,iBACxB,eAAe,YAAY,SAAS,GAEpC,iBAAiB,eAAe,WAAW;CAG7C,MAAM,eACJ,eAAe,SAAS,kBAAkB,WAAW,eAAe;CAKtE,MAAM,cAAc,8BACZ,IAAI,QAA2C,GACrD,CAAC,GAAG,CACN;CACA,MAAM,iBAAiB,cAEnB,aAAa,KAAK,SAAoC;EACpD,IAAI,OAAO,SAAS,YAAY,SAAS,MACvC,OAAO,IAAI,yBAAyB,KAAK,CACvC,IACF,CAAC,CAAC,CAAC;EAEL,MAAM,SAAS,YAAY,IAAI,IAAI;EACnC,IAAI,WAAW,KAAA,GACb,OAAO;EAET,MAAM,UAAU,IAAI,yBAAyB,KAAK,CAChD,IACF,CAAC,CAAC,CAAC;EACH,YAAY,IAAI,MAAM,OAAO;EAC7B,OAAO;CACT,CAAC,GACH;EAAC;EAAK;EAAc;CAAW,CACjC;CAEA,OAAO,cAGF;EACH,IAAI,eAAe,SAAS,iBAC1B,OAAOR,iBAAsC,EAAE,QAAQ,CAAC;EAE1D,IAAI,eAAe,SAAS,UAAU;GACpC,MAAM,QAAQ,eAAe;GAC7B,IAAI,IAAI,cAAc,KAAK,GAAG;IAC5B,MAAM,UAAU,IAAI,kBAAkB,KAAK,MAAM,IAAI;IACrD,IAAI,OAAO,OAAO,OAAO,GACvB,OAAOD,QAA6B;KAClC,OAAO,QAAQ;KACf,SAAS;IACX,CAAC;GAEL;GAEA,MAAM;EACR;EAEA,MAAM,EAAE,eAAe;EACvB,IAAI,OAAO,OAAO,UAAU,KAAK,QAAQ,MAAM,SAAS,UAAU,GAChE,OAAOC,iBAAsC,EAAE,QAAQ,CAAC;EAE1D,IACE,OAAO,OAAO,UAAU,KACxBS,oBAAqC,QAAQ,KAAK,GAElD,OAAOR,YAAiC,EAAE,SAAS,eAAe,CAAC;EAErE,IAAI,WAAW,MAAM,QACnB,OAAOE,UAA+B,EAAE,SAAS,eAAe,CAAC;EAGnE,MAAM,iBAAiB,WAAW,MAAM;EAGxC,IAAI,qBAAqB;EACzB,OAAOD,YAAiC;GACtC,SAAS;GACT,WAAW,aAAqB;IAC9B,IAAI,CAAC,oBAAoB;KACvB,qBAAqB;KACrB,iBAAiB,CACfQ,SAA0B,gBAAgB,UAAU,OAAO,CAC7D,CAAC;IACH;GACF;EACF,CAAC;CACH,GAAG;EACD;EACA;EACA,QAAQ;EACR;EACA;EACA;CACF,CAAC;AAIH;AAyBA,MAAM,qBACJ,KACA,wBAG4B;CAC5B,MAAM,aAAa,GAAG,SACpB,eACE,MACC,GAAG,gBAAgB,oBAAoB,WAAoB,GAC5D,IACF,CAAC,CAAC,MAAM,WACN,IAAI,eAAe,GAAG,IAAI,SAAS,OAAO,WAAW,MAAM,CAC7D;CAEF,MAAM,wBACJ,qBAC4B;EAC5B,MAAM,iBACJ,kBACA,gBACG;GACH,MAAM,cAAc,IAAI,eAAe,KAAK,WAAW;GACvD,iBACEC,KAA0B,gBAAgB,GAC1C,WACF;EACF;EACA,MAAM,0BACJ,oBAAoB,qBAAqB,aAAa;EACxD,OAAO,kBAAkB,KAAK,uBAAuB;CACvD;CAEA,OAAO,OAAO,OAAO,UAAU,EAAE,qBAAqB,CAAC;AACzD;;;;;;;;;;;;;;;;;AAkBA,MAAa,eACX,QAC4B;CAC5B,MAAM,oBAAoB,IAAI,qBAAqB,GAAG;CACtD,MAAM,sBAAsBC,cAAkB,iBAAiB;CAE/D,OAAO,cAEH,kBACE,KACA,mBAGF,GACF,CAAC,KAAK,mBAAmB,CAC3B;AACF;;;;;;;;;;;;;;AAeA,MAAa,aACX,QACkE;CAClE,MAAM,oBAAoB,IAAI,qBAAqB,GAAG;CACtD,MAAM,eAAeC,YAAgB,iBAAiB;CAEtD,OAAO,cACH,GAAG,SACH,eACE,MACC,GAAG,gBAAgB,aAAa,WAAW,GAC5C,IACF,CAAC,CAAC,MAAM,WACN,IAAI,eAAe,GAAG,IAAI,SAAS,OAAO,WAAW,MAAM,CAC7D,IACF,CAAC,KAAK,YAAY,CACpB;AACF;AAEA,MAAM,kBACJ,KACA,QAIA,SAC+D;CAO/D,OANoB,OAAO,eACzB,IAAI,aAAa,KAAM,KAAK,MAAM,CAAC,GAAsB,MAAM,CAAC,CAAC,KAC/D,OAAO,SAAS,eAAe,OAAO,GAAG,GACzC,OAAO,MACT,CAEe,CAAC,CAAC,MAAM,SAAS;EAChC,IAAI,KAAK,UAAU,IAAI,GAAG,OAAO,KAAK;EACtC,MAAM,MAAM,OAAO,KAAK,KAAK;CAC/B,CAAC;AACH"}

package/package.json

@@ -1,30 +1,30 @@
 {
   "name": "@confect/react",
   "description": "Client-side bindings for React apps",
-  "version": "10.0.0-next.20",
+  "version": "10.0.0-next.22",
   "author": "RJ Dellecese",
   "bugs": {
     "url": "https://github.com/rjdellecese/confect/issues"
   },
   "devDependencies": {
-    "@effect/vitest": "4.0.0-rc.112",
-    "@testing-library/react": "16.3.2",
-    "@types/node": "22.20.1",
-    "@types/react": "19.2.18",
-    "@types/react-dom": "19.2.4",
+    "@effect/vitest": "4.0.0-rc.115",
+    "@testing-library/react": "16.3.3",
+    "@types/node": "24.13.3",
+    "@types/react": "19.3.0",
+    "@types/react-dom": "19.3.0",
     "convex": "1.45.0",
-    "effect": "4.0.0-rc.112",
-    "happy-dom": "20.11.2",
-    "react": "19.2.8",
-    "react-dom": "19.2.8",
-    "tsdown": "0.22.14",
+    "effect": "4.0.0-rc.115",
+    "happy-dom": "20.14.3",
+    "react": "19.3.0",
+    "react-dom": "19.3.0",
+    "tsdown": "0.23.0",
     "typescript": "7.0.2",
     "unrun": "0.3.1",
-    "vite": "8.2.1",
-    "vitest": "4.1.10"
+    "vite": "8.2.2",
+    "vitest": "5.0.0"
   },
   "engines": {
-    "node": ">=22"
+    "node": ">=24"
   },
   "exports": {
     ".": {
@@ -56,10 +56,10 @@
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "peerDependencies": {
+    "@confect/core": "^10.0.0-next.22",
     "convex": "^1.36.0",
-    "effect": "^4.0.0-rc.112",
-    "react": "^18.0.0 || ^19.0.0",
-    "@confect/core": "^10.0.0-next.20"
+    "effect": "^4.0.0-rc.115",
+    "react": "^18.0.0 || ^19.0.0"
   },
   "repository": {
     "type": "git",

package/src/PaginatedQueryResult.ts

@@ -12,7 +12,7 @@ type TypeId = typeof TypeId;
  * A `PaginatedQueryResult` represents the result of a Confect paginated query.
  * The non-`Failure` variants mirror the statuses of `usePaginatedQuery` from
  * `convex/react` and all carry `results` and `isLoading`, so the common UI
- * shape — render the list, show a spinner while loading — needs only an
+ * shape—render the list, show a spinner while loading—needs only an
  * {@link isFailure} early-out and plain field access.
  *
  * Every variant carries `results`, including `Failure`: when a later page
@@ -23,8 +23,8 @@ type TypeId = typeof TypeId;
  * `loadMore` appears only on `CanLoadMore`, the one state it can make
  * progress from. The underlying Convex hook exposes it on every status, but
  * calling it while a page is in flight, once the list is exhausted, or after
- * a failure is an intentional no-op there; narrowing to `CanLoadMore` — via
- * {@link isCanLoadMore} or {@link match} — makes that statically apparent
+ * a failure is an intentional no-op there; narrowing to `CanLoadMore`—via
+ * {@link isCanLoadMore} or {@link match}—makes that statically apparent
  * instead of silently dropping the call.
  *
  * When the query declares no `error` schema (`E` is `never`), the `Failure`
@@ -48,7 +48,7 @@ export type PaginatedQueryResult<Item, E = never> = [E] extends [never]
       | Failure<Item, E>;
 
 /**
- * Every variant regardless of `E` — the parameter type for guards and
+ * Every variant regardless of `E`—the parameter type for guards and
  * {@link match}, since `PaginatedQueryResult` itself excludes `Failure` when
  * `E` is `never`.
  */
@@ -60,7 +60,7 @@ export type Variants<Item, E = never> =
   | Failure<Item, E>;
 
 export declare namespace PaginatedQueryResult {
-  // eslint-disable-next-line @typescript-eslint/no-shadow, import/namespace -- oxlint's namespace resolution misses type-only exports, and `Pipeable` is an interface
+  // eslint-disable-next-line @typescript-eslint/no-shadow
   export interface Proto<out Item, out E> extends Pipeable.Pipeable {
     readonly [TypeId]: TypeId;
     readonly "~Item": Item;

package/src/QueryResult.ts

@@ -20,7 +20,6 @@ export type QueryResult<A, E = never> =
   | Failure<A, E>;
 
 export declare namespace QueryResult {
-  // eslint-disable-next-line import/namespace -- oxlint's namespace resolution misses type-only exports, and `Pipeable` is an interface
   export interface Proto<out A, out E> extends Pipeable.Pipeable {
     readonly [TypeId]: TypeId;
     readonly "~A": A;

package/src/StreamPagination.ts

@@ -0,0 +1,369 @@
+/**
+ * EXPERIMENTAL—the pure state machine behind {@link useStreamPaginatedQuery}
+ * (see `notes/stream-based-querying.md` in the repo root).
+ *
+ * Reactive pagination without the query journal: every loaded page—including the first—is pinned to a fixed index range by echoing its
+ * `continueCursor` back as the next subscription's `endCursor` (the last
+ * page pins to the end-of-stream sentinel once exhausted), so adjacent
+ * pages stay exactly contiguous and pages never shed items as data changes—the "range-defined pages" the Fully Reactive Pagination article calls
+ * for, and the mechanism of `convex-helpers/react`'s `usePaginatedQuery`.
+ *
+ * Pinning a freshly loaded page, loading more, and splitting an overgrown
+ * page are the same transition shape: the affected page keeps rendering
+ * while its replacement subscriptions ("ongoing split") load, and is
+ * swapped out once all of them have results.
+ *
+ * This module is framework-free (it imports only `effect/*` and a type
+ * from `convex/server`); it lives here for now because the React hook is
+ * its only consumer—a second client (e.g. `@confect/foldkit`) should
+ * prompt a move down to `@confect/js`.
+ */
+import type { PaginationResult } from "convex/server";
+import * as Array from "effect/Array";
+import * as Option from "effect/Option";
+import { pipe } from "effect/Function";
+import * as Record from "effect/Record";
+
+/** The `paginationOpts` one subscribed page queries with. */
+export interface PageRequest {
+  readonly numItems: number;
+  readonly cursor: string | null;
+  /** Present once the page is pinned to a fixed range. */
+  readonly endCursor?: string;
+  /**
+   * Per-page read budgets, forwarded to the server so a scan-heavy page
+   * fails over to `SplitRequired` instead of exceeding query limits.
+   */
+  readonly maximumRowsRead?: number;
+  readonly maximumBytesRead?: number;
+}
+
+/** The per-page read budgets every growing page is requested with. */
+export interface ReadBudget {
+  readonly maximumRowsRead?: number | undefined;
+  readonly maximumBytesRead?: number | undefined;
+}
+
+/** A fresh growing-page request (no `endCursor`). */
+const growingRequest = (
+  numItems: number,
+  cursor: string | null,
+  budget: ReadBudget,
+): PageRequest => ({
+  numItems,
+  cursor,
+  ...(budget.maximumRowsRead === undefined
+    ? {}
+    : { maximumRowsRead: budget.maximumRowsRead }),
+  ...(budget.maximumBytesRead === undefined
+    ? {}
+    : { maximumBytesRead: budget.maximumBytesRead }),
+});
+
+export interface State {
+  readonly nextPageKey: number;
+  /** Page keys in display order. */
+  readonly pageKeys: ReadonlyArray<string>;
+  /** The request each subscribed page queries with, by page key. */
+  readonly pages: Record.ReadonlyRecord<string, PageRequest>;
+  /**
+   * Pages being replaced by one (a pin) or two (a split) narrower
+   * subscriptions: the original stays subscribed (and rendered) until every
+   * replacement has a result.
+   */
+  readonly ongoingSplits: Record.ReadonlyRecord<string, ReadonlyArray<string>>;
+}
+
+/** The skipped state: nothing subscribed. */
+export const empty: State = {
+  nextPageKey: 0,
+  pageKeys: [],
+  pages: Record.empty(),
+  ongoingSplits: Record.empty(),
+};
+
+/** One growing (unpinned) page from the start of the stream. */
+export const initial = (
+  initialNumItems: number,
+  budget: ReadBudget = {},
+): State => ({
+  nextPageKey: 1,
+  pageKeys: ["0"],
+  pages: Record.singleton("0", growingRequest(initialNumItems, null, budget)),
+  ongoingSplits: Record.empty(),
+});
+
+/**
+ * Pin a freshly loaded growing page at its `continueCursor` (or, once
+ * exhausted, at the end-of-stream sentinel), so it stops being a sliding
+ * window: a pinned page grows and shrinks with the data in its range but
+ * never sheds items past its edges. Modeled as a one-replacement split so
+ * the original keeps rendering until the pinned twin has a result.
+ */
+export const pin =
+  (key: string, endCursor: string): ((state: State) => State) =>
+  (state) =>
+    Option.match(Record.get(state.pages, key), {
+      onNone: () => state,
+      onSome: (page) => {
+        if (
+          page.endCursor !== undefined ||
+          Record.has(state.ongoingSplits, key)
+        ) {
+          return state;
+        }
+        const pinnedKey = String(state.nextPageKey);
+        return {
+          nextPageKey: state.nextPageKey + 1,
+          pageKeys: state.pageKeys,
+          pages: Record.set(state.pages, pinnedKey, { ...page, endCursor }),
+          ongoingSplits: Record.set(state.ongoingSplits, key, [pinnedKey]),
+        };
+      },
+    });
+
+/**
+ * Pin the growing last page at `continueCursor` and start a new growing
+ * page from there. Modeled as a split of the last page into its pinned
+ * replacement and the new page, so the swap waits for both.
+ */
+export const loadMore =
+  (
+    continueCursor: string,
+    numItems: number,
+    budget: ReadBudget = {},
+  ): ((state: State) => State) =>
+  (state) =>
+    pipe(
+      Option.Do,
+      Option.bind("lastKey", () => Array.last(state.pageKeys)),
+      Option.bind("lastPage", ({ lastKey }) =>
+        Record.get(state.pages, lastKey),
+      ),
+      Option.match({
+        onNone: () => state,
+        onSome: ({ lastKey, lastPage }) => {
+          if (lastPage.endCursor !== undefined) {
+            // The last page is already pinned (the usual case, since pages
+            // pin themselves on first load): just append a new growing page.
+            const nextKey = String(state.nextPageKey);
+            return {
+              nextPageKey: state.nextPageKey + 1,
+              pageKeys: Array.append(state.pageKeys, nextKey),
+              pages: Record.set(
+                state.pages,
+                nextKey,
+                growingRequest(numItems, continueCursor, budget),
+              ),
+              ongoingSplits: state.ongoingSplits,
+            };
+          }
+          const pinnedKey = String(state.nextPageKey);
+          const nextKey = String(state.nextPageKey + 1);
+          return {
+            nextPageKey: state.nextPageKey + 2,
+            pageKeys: state.pageKeys,
+            pages: pipe(
+              state.pages,
+              Record.set(pinnedKey, { ...lastPage, endCursor: continueCursor }),
+              Record.set(
+                nextKey,
+                growingRequest(numItems, continueCursor, budget),
+              ),
+            ),
+            ongoingSplits: Record.set(state.ongoingSplits, lastKey, [
+              pinnedKey,
+              nextKey,
+            ]),
+          };
+        },
+      }),
+    );
+
+/**
+ * Split the page at `key` in two at `splitCursor`. The first replacement
+ * pins at the split point; the second keeps the page's own `endCursor`—for a pinned page its original end (so a truncated `SplitRequired` page
+ * loses none of its range), and for a growing page no end at all (it keeps
+ * growing).
+ */
+export const split =
+  (key: string, splitCursor: string): ((state: State) => State) =>
+  (state) =>
+    Option.match(Record.get(state.pages, key), {
+      onNone: () => state,
+      onSome: (page) => {
+        const firstKey = String(state.nextPageKey);
+        const secondKey = String(state.nextPageKey + 1);
+        return {
+          nextPageKey: state.nextPageKey + 2,
+          pageKeys: state.pageKeys,
+          pages: pipe(
+            state.pages,
+            Record.set(firstKey, { ...page, endCursor: splitCursor }),
+            Record.set(secondKey, { ...page, cursor: splitCursor }),
+          ),
+          ongoingSplits: Record.set(state.ongoingSplits, key, [
+            firstKey,
+            secondKey,
+          ]),
+        };
+      },
+    });
+
+/** Swap a completed split's replacements in for the original page. */
+export const completeSplit =
+  (key: string): ((state: State) => State) =>
+  (state) =>
+    Option.match(Record.get(state.ongoingSplits, key), {
+      onNone: () => state,
+      onSome: (replacements) => ({
+        nextPageKey: state.nextPageKey,
+        pageKeys: Array.flatMap(state.pageKeys, (pageKey) =>
+          pageKey === key ? replacements : [pageKey],
+        ),
+        pages: Record.remove(state.pages, key),
+        ongoingSplits: Record.remove(state.ongoingSplits, key),
+      }),
+    });
+
+/** Whether the last (rendered) page is currently being split or pinned. */
+export const isLastPageSplitting = (state: State): boolean =>
+  Option.exists(Array.last(state.pageKeys), (lastKey) =>
+    Record.has(state.ongoingSplits, lastKey),
+  );
+
+/** Build one subscription request per subscribed page. */
+export const pageRequests = <A>(
+  state: State,
+  f: (page: PageRequest) => A,
+): Record.ReadonlyRecord<string, A> => Record.map(state.pages, f);
+
+/** The per-page results a render observes, keyed like {@link pageRequests}. */
+export type Results = Record.ReadonlyRecord<
+  string,
+  PageResult | Error | undefined
+>;
+
+// -----------------------------------------------------------------------------
+// Interpretation
+// -----------------------------------------------------------------------------
+
+/**
+ * The wire shape of one loaded page—`PaginationResult` from
+ * `convex/server`, so the protocol has a single source of truth.
+ */
+export type PageResult = PaginationResult<unknown>;
+
+/**
+ * What one render pass derives from the subscribed pages' results: the
+ * items to show, the trailing complete result (absent while the tail is
+ * loading or force-splitting), state transitions to apply, and whether a
+ * failure or an invalid cursor was hit.
+ */
+export type Interpretation =
+  | { readonly _tag: "ResetRequired" }
+  | {
+      readonly _tag: "Failed";
+      readonly error: unknown;
+      /** Encoded items loaded before the failing page. */
+      readonly items: ReadonlyArray<unknown>;
+    }
+  | {
+      readonly _tag: "Interpreted";
+      /** Encoded items across the loaded pages, in order. */
+      readonly items: ReadonlyArray<unknown>;
+      /** The last page's result, when every page has loaded completely. */
+      readonly lastResult: Option.Option<PageResult>;
+      /** Split/swap transitions this render discovered. */
+      readonly transitions: ReadonlyArray<(state: State) => State>;
+    };
+
+const interpreted = (
+  items: ReadonlyArray<unknown>,
+  lastResult: Option.Option<PageResult>,
+  transitions: ReadonlyArray<(state: State) => State>,
+): Interpretation => ({ _tag: "Interpreted", items, lastResult, transitions });
+
+/**
+ * Walk the pages in display order, concatenating their items and
+ * collecting the transitions to apply (completed split swaps, recommended
+ * splits, eager splits of pages that outgrew `initialNumItems`).
+ *
+ * `isInvalidCursorError` marks errors that call for a full pagination
+ * reset rather than a failure (the cursor no longer matches the query).
+ */
+export const interpret = (
+  state: State,
+  results: Record.ReadonlyRecord<string, PageResult | Error | undefined>,
+  options: {
+    readonly initialNumItems: number;
+    readonly isInvalidCursorError: (error: Error) => boolean;
+  },
+): Interpretation => {
+  const go = (
+    remaining: ReadonlyArray<string>,
+    items: ReadonlyArray<unknown>,
+    transitions: ReadonlyArray<(s: State) => State>,
+    lastResult: Option.Option<PageResult>,
+  ): Interpretation =>
+    Option.match(Array.head(remaining), {
+      onNone: () => interpreted(items, lastResult, transitions),
+      onSome: (pageKey) => {
+        const result = Record.get(results, pageKey).pipe(
+          Option.flatMap(Option.fromNullishOr),
+          Option.getOrUndefined,
+        );
+        if (result === undefined) {
+          // The trailing pages are still loading.
+          return interpreted(items, Option.none(), transitions);
+        }
+        if (result instanceof Error) {
+          return options.isInvalidCursorError(result)
+            ? { _tag: "ResetRequired" }
+            : { _tag: "Failed", error: result, items };
+        }
+
+        const hasResult = (key: string) =>
+          Record.get(results, key).pipe(
+            Option.flatMap(Option.fromNullishOr),
+            Option.isSome,
+          );
+        const ongoingSplit = Record.get(state.ongoingSplits, pageKey);
+        const nextTransitions = Option.match(ongoingSplit, {
+          onSome: (replacements) =>
+            // Swap the replacements in once all of them have results.
+            Array.every(replacements, hasResult)
+              ? Array.append(transitions, completeSplit(pageKey))
+              : transitions,
+          onNone: () =>
+            typeof result.splitCursor === "string" &&
+            (result.pageStatus === "SplitRecommended" ||
+              result.pageStatus === "SplitRequired" ||
+              result.page.length > options.initialNumItems)
+              ? Array.append(transitions, split(pageKey, result.splitCursor))
+              : // A loaded growing page pins itself to the range it just
+                // served (`END_CURSOR` once exhausted), so it stops being a
+                // sliding window that sheds items as new documents arrive.
+                Option.exists(
+                    Record.get(state.pages, pageKey),
+                    (request) => request.endCursor === undefined,
+                  ) && result.pageStatus !== "SplitRequired"
+                ? Array.append(transitions, pin(pageKey, result.continueCursor))
+                : transitions,
+        });
+
+        // A force-split page couldn't be fetched in full: show the items
+        // before it and report the tail as still loading.
+        return result.pageStatus === "SplitRequired"
+          ? interpreted(items, Option.none(), nextTransitions)
+          : go(
+              Array.drop(remaining, 1),
+              Array.appendAll(items, result.page),
+              nextTransitions,
+              Option.some(result),
+            );
+      },
+    });
+
+  return go(state.pageKeys, [], [], Option.none());
+};