@ic-reactor/react 3.12.5 → 4.0.0-beta.1

package/src/hooks/useActorQuery.ts

@@ -1,124 +0,0 @@
-import { useMemo } from "react"
-import {
-  QueryKey,
-  useQuery,
-  QueryObserverOptions,
-  UseQueryResult,
-} from "@tanstack/react-query"
-import {
-  FunctionName,
-  Reactor,
-  TransformKey,
-  ReactorArgs,
-  ReactorReturnOk,
-  ReactorQueryData,
-  ReactorReturnErr,
-} from "@ic-reactor/core"
-import { CallConfig } from "@icp-sdk/core/agent"
-
-export interface UseActorQueryParameters<
-  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 UseActorQueryConfig<
-  Service,
-  Method extends FunctionName<Service>,
-  Transform extends TransformKey = "candid",
-  Selected = ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-> = Omit<
-  UseActorQueryParameters<Service, Method, Transform, Selected>,
-  "reactor"
->
-
-export type UseActorQueryResult<
-  Service,
-  Method extends FunctionName<Service>,
-  Transform extends TransformKey = "candid",
-  Selected = ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-> = UseQueryResult<Selected, ReactorReturnErr<Service, Method, Transform>>
-
-/**
- * Hook for executing query calls on a canister.
- *
- * @example
- * const { data, isLoading } = useActorQuery({
- *   reactor,
- *   functionName: "getUser",
- *   args: ["user-123"],
- * })
- *
- * // With select transformation
- * const { data } = useActorQuery({
- *   reactor,
- *   functionName: "getUser",
- *   args: ["user-123"],
- *   select: (user) => user.name,
- * })
- */
-export const useActorQuery = <
-  Service,
-  Method extends FunctionName<Service>,
-  Transform extends TransformKey = "candid",
-  Selected = ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
->({
-  reactor,
-  functionName,
-  args,
-  callConfig,
-  queryKey: defaultQueryKey,
-  ...options
-}: UseActorQueryParameters<
-  Service,
-  Method,
-  Transform,
-  Selected
->): UseActorQueryResult<Service, Method, Transform, Selected> => {
-  // Memoize query options to prevent unnecessary re-computations
-  const { queryKey, queryFn } = 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,
-    ]
-  )
-
-  return useQuery(
-    {
-      queryFn,
-      ...options,
-      queryKey,
-    },
-    reactor.queryClient
-  )
-}

package/src/hooks/useActorSuspenseInfiniteQuery.ts

@@ -1,205 +0,0 @@
-import { useMemo, useCallback } from "react"
-import {
-  QueryKey,
-  useSuspenseInfiniteQuery,
-  UseSuspenseInfiniteQueryResult,
-  UseSuspenseInfiniteQueryOptions,
-  InfiniteData,
-} from "@tanstack/react-query"
-import {
-  FunctionName,
-  Reactor,
-  TransformKey,
-  ReactorArgs,
-  ReactorReturnOk,
-  ReactorQueryData,
-  ReactorReturnErr,
-} from "@ic-reactor/core"
-import { CallConfig } from "@icp-sdk/core/agent"
-import { mergeFactoryQueryKey, normalizeQueryData } from "../utils.js"
-
-/**
- * Parameters for useActorSuspenseInfiniteQuery hook.
- * Extends react-query's UseSuspenseInfiniteQueryOptions with custom reactor params.
- */
-export interface UseActorSuspenseInfiniteQueryParameters<
-  Service,
-  Method extends FunctionName<Service>,
-  Transform extends TransformKey = "candid",
-  TPageParam = unknown,
-  Selected = InfiniteData<
-    ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-    TPageParam
-  >,
-> extends Omit<
-  UseSuspenseInfiniteQueryOptions<
-    ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-    ReactorReturnErr<Service, Method, Transform>,
-    Selected,
-    QueryKey,
-    TPageParam
-  >,
-  "queryKey" | "queryFn" | "getNextPageParam" | "initialPageParam"
-> {
-  /** The reactor instance to use for method calls */
-  reactor: Reactor<Service, Transform>
-  /** The method name to call on the canister */
-  functionName: Method
-  /** Function to get args from page parameter */
-  getArgs: (pageParam: TPageParam) => ReactorArgs<Service, Method, Transform>
-  /** Agent call configuration (effectiveCanisterId, etc.) */
-  callConfig?: CallConfig
-  /** Custom query key (auto-generated if not provided) */
-  queryKey?: QueryKey
-  /** Initial page parameter */
-  initialPageParam: TPageParam
-  /** Function to determine next page parameter */
-  getNextPageParam: (
-    lastPage: ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-    allPages: ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>[],
-    lastPageParam: TPageParam,
-    allPageParams: TPageParam[]
-  ) => TPageParam | undefined | null
-}
-
-export type UseActorSuspenseInfiniteQueryConfig<
-  Service,
-  Method extends FunctionName<Service>,
-  Transform extends TransformKey = "candid",
-  TPageParam = unknown,
-  Selected = InfiniteData<
-    ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-    TPageParam
-  >,
-> = Omit<
-  UseActorSuspenseInfiniteQueryParameters<
-    Service,
-    Method,
-    Transform,
-    TPageParam,
-    Selected
-  >,
-  "reactor"
->
-
-export type UseActorSuspenseInfiniteQueryResult<
-  Service,
-  Method extends FunctionName<Service>,
-  Transform extends TransformKey = "candid",
-  TPageParam = unknown,
-  Selected = InfiniteData<
-    ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-    TPageParam
-  >,
-> = UseSuspenseInfiniteQueryResult<
-  Selected,
-  ReactorReturnErr<Service, Method, Transform>
->
-
-/**
- * Hook for executing suspense-enabled infinite/paginated query calls on a canister.
- *
- * @example
- * const { data, fetchNextPage, hasNextPage } = useActorSuspenseInfiniteQuery({
- *   reactor,
- *   functionName: "getItems",
- *   getArgs: (pageParam) => [{ offset: pageParam, limit: 10 }],
- *   initialPageParam: 0,
- *   getNextPageParam: (lastPage) => lastPage.nextOffset,
- * })
- */
-export const useActorSuspenseInfiniteQuery = <
-  Service,
-  Method extends FunctionName<Service>,
-  Transform extends TransformKey = "candid",
-  TPageParam = unknown,
-  Selected = InfiniteData<
-    ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-    TPageParam
-  >,
->({
-  reactor,
-  functionName,
-  getArgs,
-  callConfig,
-  queryKey,
-  ...options
-}: UseActorSuspenseInfiniteQueryParameters<
-  Service,
-  Method,
-  Transform,
-  TPageParam,
-  Selected
->): UseActorSuspenseInfiniteQueryResult<
-  Service,
-  Method,
-  Transform,
-  TPageParam,
-  Selected
-> => {
-  // Always pass queryKey through generateQueryKey so it is merged with the
-  // reactor/function identity. Using the custom key verbatim would cause cache
-  // collisions if two different actors or methods share the same key string.
-  const baseQueryKey = useMemo(
-    () =>
-      reactor.generateQueryKey(
-        {
-          functionName,
-          // Fold the call arguments into the key. They live in the `getArgs`
-          // closure rather than in the config, so without this two hooks on the
-          // same method with different arguments share one cache entry and
-          // serve each other's pages.
-          queryKey: mergeFactoryQueryKey(
-            queryKey,
-            undefined,
-            getArgs(options.initialPageParam)
-          ),
-        },
-        callConfig
-      ),
-    [
-      queryKey,
-      reactor,
-      // `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
-      // while the queryFn already calls the new one.
-      reactor.canisterId?.toString(),
-      functionName,
-      callConfig,
-      getArgs,
-      options.initialPageParam,
-    ]
-  )
-
-  // Memoize queryFn to prevent recreation on every render
-  const queryFn = useCallback(
-    async ({ pageParam }: { pageParam: TPageParam }) => {
-      const args = getArgs(pageParam)
-      const result = await reactor.callMethod({
-        functionName,
-        args,
-        callConfig,
-      })
-      return normalizeQueryData<ReactorReturnOk<Service, Method, Transform>>(
-        result as ReactorReturnOk<Service, Method, Transform>
-      )
-    },
-    [reactor, functionName, getArgs, callConfig]
-  )
-
-  return useSuspenseInfiniteQuery(
-    {
-      queryKey: baseQueryKey,
-      queryFn,
-      ...options,
-    } as any,
-    reactor.queryClient
-  ) as UseActorSuspenseInfiniteQueryResult<
-    Service,
-    Method,
-    Transform,
-    TPageParam,
-    Selected
-  >
-}

package/src/hooks/useActorSuspenseQuery.ts

@@ -1,132 +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"
-
-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 } = useActorSuspenseQuery({
- *   reactor,
- *   functionName: "getUser",
- *   args: ["user-123"],
- * })
- *
- * // With select transformation
- * const { data } = useActorSuspenseQuery({
- *   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> => {
-  // Memoize query options to prevent unnecessary re-computations
-  const { queryKey, queryFn } = 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,
-    ]
-  )
-
-  return useSuspenseQuery(
-    {
-      // Suspense queries don't support skipToken, so cast the queryFn
-      queryFn: queryFn as QueryFunction<
-        ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>,
-        QueryKey
-      >,
-      ...options,
-      queryKey,
-    },
-    reactor.queryClient
-  )
-}

package/src/index.ts

@@ -1,23 +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 "./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"