@ic-reactor/react 3.13.0 → 4.0.0-beta.2

package/src/hooks/useActorSuspenseQuery.ts

@@ -1,147 +0,0 @@
-import { useMemo } from "react"
-import {
-  QueryKey,
-  useSuspenseQuery,
-  QueryObserverOptions,
-  UseSuspenseQueryResult,
-  QueryFunction,
-} from "@tanstack/react-query"
-import {
-  FunctionName,
-  Reactor,
-  TransformKey,
-  ReactorArgs,
-  ReactorReturnOk,
-  ReactorQueryData,
-  ReactorReturnErr,
-} from "@ic-reactor/core"
-import { CallConfig } from "@icp-sdk/core/agent"
-import {
-  mountWhileSuspended,
-  retryOption,
-  useMountQueryClient,
-} from "../utils.js"
-
-export interface UseActorSuspenseQueryParameters<
-  Service,
-  Method extends FunctionName<Service>,
-  Transform extends TransformKey = "candid",
-  Selected = ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-> extends Omit<
-  QueryObserverOptions<
-    ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-    ReactorReturnErr<Service, Method, Transform>,
-    Selected,
-    ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-    QueryKey
-  >,
-  "queryKey" | "queryFn"
-> {
-  reactor: Reactor<Service, Transform>
-  functionName: Method
-  args?: ReactorArgs<Service, Method, Transform>
-  callConfig?: CallConfig
-  queryKey?: QueryKey
-}
-
-export type UseActorSuspenseQueryConfig<
-  Service,
-  Method extends FunctionName<Service>,
-  Transform extends TransformKey = "candid",
-  Selected = ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-> = Omit<
-  UseActorSuspenseQueryParameters<Service, Method, Transform, Selected>,
-  "reactor"
->
-
-export type UseActorSuspenseQueryResult<
-  Service,
-  Method extends FunctionName<Service>,
-  Transform extends TransformKey = "candid",
-  Selected = ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-> = UseSuspenseQueryResult<
-  Selected,
-  ReactorReturnErr<Service, Method, Transform>
->
-
-/**
- * Hook for executing suspense-enabled query calls on a canister.
- *
- * @example
- * const { data } = useReactorSuspenseQuery({
- *   reactor,
- *   functionName: "getUser",
- *   args: ["user-123"],
- * })
- *
- * // With select transformation
- * const { data } = useReactorSuspenseQuery({
- *   reactor,
- *   functionName: "getUser",
- *   args: ["user-123"],
- *   select: (user) => user.name,
- * })
- */
-export const useActorSuspenseQuery = <
-  Service,
-  Method extends FunctionName<Service>,
-  Transform extends TransformKey = "candid",
-  Selected = ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
->({
-  reactor,
-  functionName,
-  args,
-  callConfig,
-  queryKey: defaultQueryKey,
-  ...options
-}: UseActorSuspenseQueryParameters<
-  Service,
-  Method,
-  Transform,
-  Selected
->): UseActorSuspenseQueryResult<Service, Method, Transform, Selected> => {
-  useMountQueryClient(reactor.queryClient)
-
-  // Memoize query options to prevent unnecessary re-computations
-  // For an update method, the options also carry its default `retry`; see
-  // `Reactor.getQueryRetry`.
-  const { queryKey, queryFn, retry } = useMemo(
-    () =>
-      reactor.getQueryOptions<Method>({
-        callConfig,
-        functionName,
-        args,
-        queryKey: defaultQueryKey,
-      }),
-    // `canisterId` is mutable reactor state that `setCanisterId` can change,
-    // while `reactor` itself stays the same object — so it has to be a
-    // dependency in its own right or the key stays pinned to the old canister.
-    [
-      reactor,
-      reactor.canisterId?.toString(),
-      callConfig,
-      functionName,
-      args,
-      defaultQueryKey,
-    ]
-  )
-
-  try {
-    return useSuspenseQuery(
-      {
-        // Suspense queries don't support skipToken, so cast the queryFn
-        queryFn: queryFn as QueryFunction<
-          ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-          QueryKey
-        >,
-        ...options,
-        queryKey,
-        ...retryOption(options.retry, retry),
-      },
-      reactor.queryClient
-    )
-  } catch (thrown) {
-    mountWhileSuspended(reactor.queryClient, thrown)
-    throw thrown
-  }
-}

package/src/index.ts

@@ -1,31 +0,0 @@
-// Re-export core (following TanStack Query's pattern)
-// Users can import everything from @ic-reactor/react without needing @ic-reactor/core
-export * from "@ic-reactor/core"
-
-// Re-export hooks
-export * from "./hooks/index.js"
-
-// Validation utilities for React
-export * from "./validation.js"
-
-// React-specific exports
-export * from "./createActorHooks.js"
-export * from "./defineReactor.js"
-export * from "./defineDisplayReactor.js"
-export * from "./createReactorProvider.js"
-
-export * from "./createQuery.js"
-export * from "./createSuspenseQuery.js"
-export * from "./createInfiniteQuery.js"
-export * from "./createSuspenseInfiniteQuery.js"
-export * from "./createMutation.js"
-
-export * from "./auth/index.js"
-
-export * from "./types.js"
-
-// TanStack Query's marker for a query whose args are not known yet, which the
-// non-suspense query hooks and createQueryFactory take in place of args. It is
-// the same symbol as @tanstack/react-query's, so either import works.
-export { skipToken } from "@tanstack/react-query"
-export type { SkipToken } from "@tanstack/react-query"

package/src/ownedAuthentication.ts

@@ -1,81 +0,0 @@
-/**
- * Which `AuthenticationManager`s a `createReactorProvider` value owns, for the
- * provider to dispose when its tree unmounts. Not part of the public API.
- *
- * A value owns the managers built for it: those constructed while its factory
- * ran, and those a `defineReactor` or `defineDisplayReactor` result in it
- * builds later, on first use. A manager built elsewhere and handed in, such as
- * an app-wide one every provider shares, belongs to whoever built it, and
- * disposing it on each remount would stop its client following the session.
- *
- * A result's `authentication` is a getter that builds the manager on first
- * read, and building one loads the optional `@icp-sdk/auth` peer in a browser.
- * A provider that read it to release the manager would build one only to
- * dispose it, for every reactor whose tree never signed in. Each result
- * registers a reader here instead, which answers without building anything.
- *
- * Kept apart from `defineReactorShared.ts` so that the provider does not pull
- * that module's reactor setup into an app that builds its reactors by hand.
- */
-import type { AuthenticationManager } from "./auth/authentication-manager.js"
-
-const readers = new WeakMap<object, () => AuthenticationManager | undefined>()
-
-/** The managers constructed during a running {@link collectAuthentication}. */
-let collecting: Set<AuthenticationManager> | undefined
-
-/**
- * Records how to read the manager `owner` built, once it has built one.
- *
- * @internal
- */
-export function registerAuthentication(
-  owner: object,
-  read: () => AuthenticationManager | undefined
-): void {
-  readers.set(owner, read)
-}
-
-/**
- * The manager a registered result built, or `undefined` for one that has not
- * built one yet, for one that was handed a manager, and for anything that was
- * never registered.
- *
- * @internal
- */
-export function authenticationOf(
-  owner: object
-): AuthenticationManager | undefined {
-  return readers.get(owner)?.()
-}
-
-/**
- * Called by each `AuthenticationManager` as it is constructed.
- *
- * @internal
- */
-export function recordAuthentication(manager: AuthenticationManager): void {
-  collecting?.add(manager)
-}
-
-/**
- * Runs `build` and returns what it returned, with every manager constructed
- * while it ran. `build` runs synchronously, so a server rendering several
- * requests at once cannot interleave another request's managers.
- *
- * @internal
- */
-export function collectAuthentication<T>(build: () => T): {
-  value: T
-  built: AuthenticationManager[]
-} {
-  const outer = collecting
-  const built = new Set<AuthenticationManager>()
-  collecting = built
-  try {
-    const value = build()
-    return { value, built: [...built] }
-  } finally {
-    collecting = outer
-  }
-}

package/src/server.ts

@@ -1,23 +0,0 @@
-/**
- * The `react-server` entry of `@ic-reactor/react`.
- *
- * React Server Components are bundled with the `react-server` export
- * condition, and `package.json` routes that condition here instead of to
- * `index.ts`. The main entry also loads every hook, and a bundler rejects a
- * hook import anywhere in the server graph, so a server component that
- * imported only `Reactor` from it failed to build.
- *
- * This entry carries the core runtime (`Reactor`, `DisplayReactor`,
- * `ClientManager`, the error classes and utilities) and the framework-free
- * validation helpers, and nothing that imports React. A hook or a hook factory
- * imported in a server component is therefore a missing export at build time,
- * which is the error to get: those only run in a `"use client"` module.
- *
- * TypeScript does not read the `react-server` condition, so types still come
- * from the main entry.
- */
-export * from "@ic-reactor/core"
-
-// Plain functions over `ValidationError`, useful in a server action that maps
-// a rejected call onto form field errors.
-export * from "./validation.js"

package/src/testing.ts

@@ -1,18 +0,0 @@
-/**
- * `@ic-reactor/react/testing`: the testing utilities of
- * `@ic-reactor/core/testing`, re-exported for an app that depends on
- * `@ic-reactor/react` alone. The main entry re-exports `@ic-reactor/core` the
- * same way, but a package manager that installs strictly does not let such an
- * app import `@ic-reactor/core/testing` itself.
- *
- * Nothing here imports React, and neither the main entry nor the
- * `react-server` entry imports this one, so none of it reaches an app bundle.
- *
- * @example
- * ```typescript
- * import { createTestCanister, installFakeReplica } from "@ic-reactor/react/testing"
- * ```
- *
- * @packageDocumentation
- */
-export * from "@ic-reactor/core/testing"