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

package/dist/createQuery.js

@@ -1,204 +0,0 @@
-/**
- * Query Factory - Generic wrapper for React Query-based canister data
- *
- * Creates unified fetch/hook/invalidate functions for any canister method.
- * Works with any Reactor instance.
- * Use this when the same read operation must work both inside React components
- * and outside React (loaders, actions, services, tests).
- *
- * @example
- * const userQuery = createQuery(todoManager, {
- *   functionName: "get_user",
- *   select: (result) => result.user,
- * })
- *
- * // In component
- * const { data: user } = userQuery.useQuery()
- *
- * @example
- * const userQuery = createQuery(todoManager, { functionName: "get_user", args: ["alice"] })
- *
- * // Outside React (loader/service/script)
- * await userQuery.fetch()
- * const cached = userQuery.getCacheData()
- * await userQuery.invalidate()
- */
-import { useMemo } from "react";
-import { useQuery, skipToken, } from "@tanstack/react-query";
-import { buildChainedSelect, createBoundedCache, pickFetchOptions, queryCacheControls, retryOption, skippedQueryKey, useMountQueryClient, withQueryFactoryMethods, } from "./utils.js";
-// ============================================================================
-// Internal Implementation
-// ============================================================================
-const createQueryImpl = (reactor, 
-// `args` is `skipToken` only for a factory's skipped query, which exposes
-// nothing but `useQuery`; see createQueryFactory.
-config) => {
-    const { functionName, args, callConfig, staleTime = 5 * 60 * 1000, select, queryKey: customQueryKey, ...rest } = config;
-    const skipped = args === skipToken;
-    // `callConfig` goes wherever the hooks send it: to the call and into the
-    // key, so a query of another canister or agent has an entry of its own.
-    const params = {
-        functionName,
-        args: skipped ? undefined : args,
-        queryKey: customQueryKey,
-        callConfig,
-    };
-    // What the hook observes: the call, or for a query still waiting for its
-    // args, an entry of its own under the method's key, with nothing to run;
-    // see skippedQueryKey.
-    const queryOptions = () => skipped
-        ? {
-            queryKey: skippedQueryKey(reactor.generateQueryKey({ functionName }, callConfig), "query"),
-            // Kept as the unique symbol, which an object literal widens.
-            queryFn: skipToken,
-            retry: undefined,
-        }
-        : reactor.getQueryOptions(params);
-    const getQueryKey = () => reactor.generateQueryKey(params, callConfig);
-    // Apply config.select to raw data (shared by fetch, getCacheData, and the hook)
-    const applySelect = (raw) => select ? select(raw) : raw;
-    // How the query function runs, shared with the hook; see pickFetchOptions.
-    const fetchOptions = pickFetchOptions(rest);
-    /** Cache-first fetch for use in loaders / route preloading. */
-    const fetch = async () => {
-        // Through the reactor rather than straight to the QueryClient: overriding
-        // `fetchQuery` in a Reactor subclass is a documented way to add logic to
-        // every factory fetch.
-        const result = await reactor.fetchQuery(params, fetchOptions);
-        return applySelect(result);
-    };
-    /** Fire-and-forget prefetch — warms the cache without blocking. */
-    const prefetch = () => {
-        const baseOptions = reactor.getQueryOptions(params);
-        // A sign-in or sign-out cancels a prefetch in flight, and TanStack
-        // resolves it all the same: an entry nothing observes was left empty, and
-        // one a mounted query shows still held the previous principal's data
-        // until that query's refetch landed. It now runs again for the principal
-        // signed in, as `fetch()` does. Like `prefetchQuery` it never rejects, so
-        // the CallError for a principal that keeps switching is dropped too.
-        return reactor.clientManager
-            .fetchAcrossIdentitySwitch(() => reactor.queryClient.prefetchQuery({
-            ...fetchOptions,
-            // An update method's default `retry`; see `Reactor.getQueryRetry`.
-            ...retryOption(fetchOptions.retry, baseOptions.retry),
-            queryKey: baseOptions.queryKey,
-            queryFn: baseOptions.queryFn,
-            staleTime,
-        }))
-            .catch(() => undefined);
-    };
-    const useQueryHook = ((options) => {
-        useMountQueryClient(reactor.queryClient);
-        const baseOptions = queryOptions();
-        // Memoized so the observer's select-result cache can hit; see
-        // buildChainedSelect. `select` comes from the factory config and is stable.
-        const chainedSelect = useMemo(() => buildChainedSelect(select, options?.select), [options?.select]);
-        return useQuery({
-            queryKey: baseOptions.queryKey,
-            staleTime,
-            ...rest,
-            ...options,
-            queryFn: baseOptions.queryFn,
-            select: chainedSelect,
-            // The hook's `retry`, else the config's, else an update method's
-            // default; see `Reactor.getQueryRetry`.
-            ...retryOption(options?.retry ?? rest.retry, baseOptions.retry),
-        }, reactor.queryClient);
-    });
-    const invalidate = async () => {
-        await reactor.queryClient.invalidateQueries({ queryKey: getQueryKey() });
-    };
-    const getCacheData = ((selectFn) => {
-        const raw = reactor.getQueryData(params, callConfig);
-        if (raw === undefined)
-            return undefined;
-        const selected = applySelect(raw);
-        return selectFn ? selectFn(selected) : selected;
-    });
-    const setData = (updater) => {
-        return reactor.queryClient.setQueryData(getQueryKey(), updater);
-    };
-    return {
-        fetch,
-        prefetch,
-        useQuery: useQueryHook,
-        invalidate,
-        getQueryKey,
-        getCacheData,
-        setData,
-        ...queryCacheControls(reactor, getQueryKey),
-    };
-};
-// ============================================================================
-// Public Factory Function
-// ============================================================================
-export function createQuery(reactor, config) {
-    return createQueryImpl(reactor, config);
-}
-// ============================================================================
-// Convenience: Create query with dynamic args
-// ============================================================================
-/**
- * Create a query factory: a function that takes the method's args and returns
- * the query object for them, the same object for the same args.
- *
- * The function also has `getQueryKey()`, the key prefix every query it
- * returns shares, and `invalidate()`, which invalidates all of them whatever
- * their args. Pass the function itself to a mutation's `invalidateQueries` to
- * refresh every instance after the mutation.
- *
- * It also takes TanStack Query's `skipToken` in place of args, for a
- * component whose args are not known yet, and returns a query with only
- * `useQuery()`, which waits without fetching; see
- * {@link SkippableQueryFactoryFn}.
- *
- * @example
- * const getBalance = createQueryFactory(ledger, {
- *   functionName: "icrc1_balance_of",
- * })
- *
- * // In a component
- * const { data } = getBalance([{ owner, subaccount: [] }]).useQuery()
- *
- * // In a component whose owner may not be known yet
- * const { data: maybe } = getBalance(
- *   owner ? [{ owner, subaccount: [] }] : skipToken
- * ).useQuery()
- *
- * // Refetch every account's balance after a transfer
- * const transfer = createMutation(ledger, {
- *   functionName: "icrc1_transfer",
- *   invalidateQueries: [getBalance],
- * })
- */
-export function createQueryFactory(reactor, config) {
-    const cache = createBoundedCache();
-    // One skipped query per factory, built on first use. Only its hook is
-    // handed out: until the args are known there is no call to make and no
-    // entry of their own to read or write.
-    let skippedQuery;
-    function factory(args) {
-        if (args === skipToken) {
-            skippedQuery ?? (skippedQuery = {
-                useQuery: createQueryImpl(reactor, { ...config, args: skipToken }).useQuery,
-            });
-            return skippedQuery;
-        }
-        const key = reactor.generateQueryKey({ functionName: config.functionName, args }, config.callConfig);
-        const cacheKey = JSON.stringify(key);
-        const existing = cache.get(cacheKey);
-        if (existing)
-            return existing;
-        const result = createQueryImpl(reactor, {
-            ...config,
-            args,
-        });
-        cache.set(cacheKey, result);
-        return result;
-    }
-    // The method's own prefix, at the canister and agent the config's
-    // `callConfig` names. A config `queryKey` follows the args segment in every
-    // instance's key, so it cannot narrow the prefix.
-    return withQueryFactoryMethods(factory, reactor, () => reactor.generateQueryKey({ functionName: config.functionName }, config.callConfig));
-}
-//# sourceMappingURL=createQuery.js.map

package/dist/createQuery.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createQuery.js","sourceRoot":"","sources":["../src/createQuery.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAQH,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAA;AAC/B,OAAO,EAEL,QAAQ,EACR,SAAS,GAIV,MAAM,uBAAuB,CAAA;AAa9B,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,WAAW,EACX,eAAe,EACf,mBAAmB,EACnB,uBAAuB,GACxB,MAAM,YAAY,CAAA;AAEnB,+EAA+E;AAC/E,0BAA0B;AAC1B,+EAA+E;AAE/E,MAAM,eAAe,GAAG,CAMtB,OAAoC;AACpC,0EAA0E;AAC1E,kDAAkD;AAClD,MAAkE,EAKlE,EAAE;IAIF,MAAM,EACJ,YAAY,EACZ,IAAI,EACJ,UAAU,EACV,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,EACzB,MAAM,EACN,QAAQ,EAAE,cAAc,EACxB,GAAG,IAAI,EACR,GAAG,MAAM,CAAA;IAEV,MAAM,OAAO,GAAG,IAAI,KAAK,SAAS,CAAA;IAElC,yEAAyE;IACzE,wEAAwE;IACxE,MAAM,MAAM,GAAG;QACb,YAAY;QACZ,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI;QAChC,QAAQ,EAAE,cAAc;QACxB,UAAU;KACX,CAAA;IAED,yEAAyE;IACzE,yEAAyE;IACzE,uBAAuB;IACvB,MAAM,YAAY,GAAG,GAAG,EAAE,CACxB,OAAO;QACL,CAAC,CAAC;YACE,QAAQ,EAAE,eAAe,CACvB,OAAO,CAAC,gBAAgB,CAAC,EAAE,YAAY,EAAE,EAAE,UAAU,CAAC,EACtD,OAAO,CACR;YACD,6DAA6D;YAC7D,OAAO,EAAE,SAAsB;YAC/B,KAAK,EAAE,SAAS;SACjB;QACH,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;IAErC,MAAM,WAAW,GAAG,GAAa,EAAE,CACjC,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IAE9C,gFAAgF;IAChF,MAAM,WAAW,GAAG,CAAC,GAAU,EAAY,EAAE,CAC3C,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,GAA2B,CAAA;IAErD,2EAA2E;IAC3E,MAAM,YAAY,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAE3C,+DAA+D;IAC/D,MAAM,KAAK,GAAG,KAAK,IAAuB,EAAE;QAC1C,0EAA0E;QAC1E,yEAAyE;QACzE,uBAAuB;QACvB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;QAC7D,OAAO,WAAW,CAAC,MAAM,CAAC,CAAA;IAC5B,CAAC,CAAA;IAED,mEAAmE;IACnE,MAAM,QAAQ,GAAG,GAAkB,EAAE;QACnC,MAAM,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;QACnD,mEAAmE;QACnE,0EAA0E;QAC1E,qEAAqE;QACrE,yEAAyE;QACzE,0EAA0E;QAC1E,qEAAqE;QACrE,OAAO,OAAO,CAAC,aAAa;aACzB,yBAAyB,CAAC,GAAG,EAAE,CAC9B,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC;YAChC,GAAG,YAAY;YACf,mEAAmE;YACnE,GAAG,WAAW,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC;YACrD,QAAQ,EAAE,WAAW,CAAC,QAAQ;YAC9B,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,SAAS;SACV,CAAC,CACH;aACA,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAA;IAC3B,CAAC,CAAA;IAUD,MAAM,YAAY,GAAG,CAAC,CAAC,OAA6B,EAAE,EAAE;QACtD,mBAAmB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QACxC,MAAM,WAAW,GAAG,YAAY,EAAE,CAAA;QAClC,8DAA8D;QAC9D,4EAA4E;QAC5E,MAAM,aAAa,GAAG,OAAO,CAC3B,GAAG,EAAE,CAAC,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EACjD,CAAC,OAAO,EAAE,MAAM,CAAC,CAClB,CAAA;QACD,OAAO,QAAQ,CACb;YACE,QAAQ,EAAE,WAAW,CAAC,QAAQ;YAC9B,SAAS;YACT,GAAG,IAAI;YACP,GAAG,OAAO;YACV,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,MAAM,EAAE,aAAa;YACrB,iEAAiE;YACjE,wCAAwC;YACxC,GAAG,WAAW,CAAC,OAAO,EAAE,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC;SAChE,EACD,OAAO,CAAC,WAAW,CACpB,CAAA;IACH,CAAC,CAAgD,CAAA;IAEjD,MAAM,UAAU,GAAG,KAAK,IAAmB,EAAE;QAC3C,MAAM,OAAO,CAAC,WAAW,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,CAAC,CAAA;IAC1E,CAAC,CAAA;IAED,MAAM,YAAY,GAAG,CAAC,CACpB,QAAsC,EAClB,EAAE;QACtB,MAAM,GAAG,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;QACpD,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO,SAAS,CAAA;QACvC,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;QACjC,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAA;IACjD,CAAC,CAAyD,CAAA;IAE1D,MAAM,OAAO,GAAoD,CAC/D,OAAO,EACP,EAAE;QACF,OAAO,OAAO,CAAC,WAAW,CAAC,YAAY,CACrC,WAAW,EAAE,EACb,OAAwD,CACpC,CAAA;IACxB,CAAC,CAAA;IAED,OAAO;QACL,KAAK;QACL,QAAQ;QACR,QAAQ,EAAE,YAAY;QACtB,UAAU;QACV,WAAW;QACX,YAAY;QACZ,OAAO;QACP,GAAG,kBAAkB,CAAQ,OAAO,EAAE,WAAW,CAAC;KACnD,CAAA;AACH,CAAC,CAAA;AAED,+EAA+E;AAC/E,0BAA0B;AAC1B,+EAA+E;AAE/E,MAAM,UAAU,WAAW,CAMzB,OAAoC,EACpC,MAAkE;IAMlE,OAAO,eAAe,CACpB,OAAO,EACP,MAA2D,CAC5D,CAAA;AACH,CAAC;AAED,+EAA+E;AAC/E,8CAA8C;AAC9C,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,UAAU,kBAAkB,CAMhC,OAAoC,EACpC,MAAyE;IAezE,MAAM,KAAK,GAAG,kBAAkB,EAAS,CAAA;IAEzC,sEAAsE;IACtE,uEAAuE;IACvE,uCAAuC;IACvC,IAAI,YAA6C,CAAA;IAOjD,SAAS,OAAO,CACd,IAAyD;QAEzD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,YAAY,KAAZ,YAAY,GAAK;gBACf,QAAQ,EAAE,eAAe,CACvB,OAAO,EACP,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAC/B,CAAC,QAAQ;aACX,EAAA;YACD,OAAO,YAAY,CAAA;QACrB,CAAC;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAClC,EAAE,YAAY,EAAE,MAAM,CAAC,YAAsB,EAAE,IAAI,EAAE,EACrD,MAAM,CAAC,UAAU,CAClB,CAAA;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;QAEpC,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACpC,IAAI,QAAQ;YAAE,OAAO,QAAQ,CAAA;QAE7B,MAAM,MAAM,GAAG,eAAe,CAC5B,OAAO,EACP;YACE,GAAG,MAAM;YACT,IAAI;SACL,CACF,CAAA;QACD,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QAC3B,OAAO,MAAM,CAAA;IACf,CAAC;IAED,kEAAkE;IAClE,4EAA4E;IAC5E,kDAAkD;IAClD,OAAO,uBAAuB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CACpD,OAAO,CAAC,gBAAgB,CACtB,EAAE,YAAY,EAAE,MAAM,CAAC,YAAsB,EAAE,EAC/C,MAAM,CAAC,UAAU,CAClB,CACF,CAAA;AACH,CAAC"}

package/dist/createReactorProvider.d.ts

@@ -1,158 +0,0 @@
-import type { ReactElement, ReactNode } from "react";
-/**
- * Props of the provider {@link createReactorProvider} returns: `children`, and
- * the props its factory takes.
- */
-export type ReactorProviderProps<TProps extends object = {}> = TProps & {
-    children?: ReactNode;
-};
-/** Options for {@link createReactorProvider}. */
-export interface CreateReactorProviderOptions {
-    /**
-     * Render a `QueryClientProvider` for the QueryClient the built value uses,
-     * so that `useQueryClient()`, React Query Devtools and `HydrationBoundary`
-     * below the provider read the cache the reactor hooks fill. The reactor
-     * hooks do not need it: each binds to its reactor's own QueryClient.
-     *
-     * Rendered only when the value holds exactly one QueryClient, found on the
-     * value and on its own properties: a `defineReactor` result, a reactor or a
-     * `ClientManager` brings its manager's, and a `QueryClient` counts as
-     * itself. Below the provider it takes the place of an outer
-     * `QueryClientProvider`, so a plain `useQuery` there caches in the
-     * reactors' QueryClient too. Pass `false` to leave that context to a
-     * provider of your own.
-     *
-     * @default true
-     */
-    queryClientProvider?: boolean;
-}
-/** What {@link createReactorProvider} returns. */
-export interface CreateReactorProviderReturn<TValue extends object, TProps extends object = {}> {
-    /**
-     * Builds the value once per mount and provides it to `useReactor`.
-     *
-     * Its props, other than `children`, are passed to the factory when it
-     * mounts and are not read again. To build a new value, give the provider a
-     * new `key`: React then unmounts the old tree, which releases the old value,
-     * and mounts a new one.
-     */
-    ReactorProvider: (props: ReactorProviderProps<TProps>) => ReactElement;
-    /**
-     * The value the nearest `ReactorProvider` built, or one of its properties
-     * when given that property's name. A hook: call it in a component or a
-     * custom hook below the provider. It throws when there is none.
-     */
-    useReactor: {
-        <TKey extends keyof TValue>(key: TKey): TValue[TKey];
-        (): TValue;
-    };
-}
-/**
- * Creates a provider that builds an app's reactors once per mounted tree, and
- * a `useReactor()` hook that returns what it built, fully typed.
- *
- * This is the setup a server-rendered app needs. The factory runs in a
- * `useState` initializer, once per mounted tree, and a server render is a tree
- * of its own: each request builds its own `ClientManager`, `QueryClient`,
- * reactors and `AuthenticationManager`, so no cache or identity is shared
- * between visitors. The first render needs no effect, so the server's HTML is
- * complete, and the browser builds a fresh value from the same props to
- * hydrate it. In a client-only app it works the same, one value per mount.
- *
- * The factory returns anything: a `defineReactor` or `defineDisplayReactor`
- * result, a record of them, reactors and managers built by hand, query and
- * mutation objects from `createQuery` or `createMutation`. `useReactor()`
- * returns it with the factory's own return type, so its hooks keep their
- * generic signatures. `useReactor("todo")` returns one property of it.
- *
- * When the tree unmounts, the provider disposes each `AuthenticationManager`
- * built for the value, releasing the Internet Identity client it built: those
- * constructed while the factory ran, and the one a `defineReactor` result in
- * the value, or among its own properties, builds on first use (a result that
- * never used authentication builds none). A manager built elsewhere and
- * handed in, such as an app-wide one passed as `authentication` or as a
- * prop, is left to whoever built it. `dispose()` only forgets the client, and
- * the next sign-in builds a new one, so this is safe under StrictMode, which
- * runs the cleanup and then the effect again on the same value.
- *
- * It also renders a `QueryClientProvider` for the value's QueryClient; see
- * {@link CreateReactorProviderOptions.queryClientProvider}.
- *
- * A suspense hook below the provider may suspend its first render: React
- * renders the same element again when the data arrives, and the provider
- * reuses the value that first render built, whether the Suspense boundary
- * sits above the provider or, while hydrating, there is none. A provider that
- * a transition mounts (`startTransition`, a client-side navigation) can be
- * rendered from a new element on each retry and build a new value each time,
- * so give its suspending components a `<Suspense>` boundary inside it.
- *
- * Call `createReactorProvider` at module scope: it builds nothing itself,
- * only the context, and every mounted provider builds its own value. In the
- * Next.js App Router that module needs `"use client"`, like any module with
- * hooks; a server component renders the provider from there.
- *
- * @param factory - Builds the value. It receives the provider's props other
- * than `children`, and runs once per mounted provider.
- * @param options - See {@link CreateReactorProviderOptions}.
- *
- * @example One canister, with Internet Identity
- * ```tsx
- * "use client"
- * import { createReactorProvider, defineReactor } from "@ic-reactor/react"
- * import { canisterId, idlFactory, type _SERVICE } from "./declarations/todo"
- *
- * export const { ReactorProvider, useReactor } = createReactorProvider(() =>
- *   defineReactor<_SERVICE>({ name: "todo", idlFactory, canisterId })
- * )
- *
- * function Todos() {
- *   const { useActorQuery, useAuth } = useReactor()
- *   const { isAuthenticated } = useAuth()
- *   const { data } = useActorQuery({ functionName: "getAllTodos" })
- *   return <p>{isAuthenticated ? data?.length : "Sign in"}</p>
- * }
- *
- * // app/layout.tsx (a server component)
- * // <ReactorProvider>{children}</ReactorProvider>
- * ```
- *
- * @example Several canisters sharing one agent and one sign-in
- * ```tsx
- * export const { ReactorProvider, useReactor } = createReactorProvider(() => {
- *   const backend = defineReactor<Backend>({
- *     name: "backend",
- *     idlFactory: backendIdl,
- *     canisterId: backendId,
- *   })
- *   const ledger = defineDisplayReactor<Ledger>({
- *     name: "ledger",
- *     idlFactory: ledgerIdl,
- *     canisterId: ledgerId,
- *     authentication: backend.authentication,
- *   })
- *   return { backend, ledger }
- * })
- *
- * function Balance() {
- *   const { data } = useReactor("ledger").useActorQuery({
- *     functionName: "icrc1_total_supply",
- *   })
- *   return <span>{data}</span>
- * }
- * ```
- *
- * @example Props for the factory, and a new key to build again
- * ```tsx
- * export const { ReactorProvider: LedgerProvider, useReactor: useLedger } =
- *   createReactorProvider(({ canisterId }: { canisterId: string }) =>
- *     defineDisplayReactor<Ledger>({ name: "ledger", idlFactory, canisterId })
- *   )
- *
- * // Read once per mount: the key makes a new canister a new tree.
- * <LedgerProvider key={canisterId} canisterId={canisterId}>
- *   <TokenPage />
- * </LedgerProvider>
- * ```
- */
-export declare function createReactorProvider<TValue extends object, TProps extends object | undefined = {}>(factory: (props: TProps) => TValue, options?: CreateReactorProviderOptions): CreateReactorProviderReturn<TValue, NonNullable<TProps>>;
-//# sourceMappingURL=createReactorProvider.d.ts.map

package/dist/createReactorProvider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createReactorProvider.d.ts","sourceRoot":"","sources":["../src/createReactorProvider.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AASpD;;;GAGG;AACH,MAAM,MAAM,oBAAoB,CAAC,MAAM,SAAS,MAAM,GAAG,EAAE,IAAI,MAAM,GAAG;IACtE,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB,CAAA;AAED,iDAAiD;AACjD,MAAM,WAAW,4BAA4B;IAC3C;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,kDAAkD;AAClD,MAAM,WAAW,2BAA2B,CAC1C,MAAM,SAAS,MAAM,EACrB,MAAM,SAAS,MAAM,GAAG,EAAE;IAE1B;;;;;;;OAOG;IACH,eAAe,EAAE,CAAC,KAAK,EAAE,oBAAoB,CAAC,MAAM,CAAC,KAAK,YAAY,CAAA;IACtE;;;;OAIG;IACH,UAAU,EAAE;QACV,CAAC,IAAI,SAAS,MAAM,MAAM,EAAE,GAAG,EAAE,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;QAEpD,IAAI,MAAM,CAAA;KACX,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0GG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,SAAS,MAAM,EAGrB,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,EAAE,EAEtC,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EAClC,OAAO,GAAE,4BAAiC,GACzC,2BAA2B,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAwF1D"}

package/dist/createReactorProvider.js

@@ -1,256 +0,0 @@
-/**
- * Reactor Provider Factory - builds an app's reactors once per mounted tree.
- *
- * A server renders every request through the same module graph, so a reactor
- * built at module scope is one cache shared by every visitor: query keys carry
- * no caller principal, and one request's caller-scoped result can be served to
- * the next. The setup belongs inside the render tree instead, built in a
- * `useState` initializer and handed down through context. Apps wrote that
- * provider by hand (examples/nextjs had one of 93 lines) and then forwarded
- * each hook out of the context with an `as any` cast, because a hook that is
- * generic over the method name has no parameter tuple a typed wrapper could
- * name.
- *
- * `createReactorProvider` is that provider. `useReactor()` returns what the
- * factory built, typed as the factory's return, so every hook on it keeps its
- * own generic signature and needs no forwarder.
- */
-import { createContext, createElement, useContext, useEffect, useState, } from "react";
-import { QueryClientProvider } from "@tanstack/react-query";
-import { authenticationOf, collectAuthentication, } from "./ownedAuthentication.js";
-/**
- * Creates a provider that builds an app's reactors once per mounted tree, and
- * a `useReactor()` hook that returns what it built, fully typed.
- *
- * This is the setup a server-rendered app needs. The factory runs in a
- * `useState` initializer, once per mounted tree, and a server render is a tree
- * of its own: each request builds its own `ClientManager`, `QueryClient`,
- * reactors and `AuthenticationManager`, so no cache or identity is shared
- * between visitors. The first render needs no effect, so the server's HTML is
- * complete, and the browser builds a fresh value from the same props to
- * hydrate it. In a client-only app it works the same, one value per mount.
- *
- * The factory returns anything: a `defineReactor` or `defineDisplayReactor`
- * result, a record of them, reactors and managers built by hand, query and
- * mutation objects from `createQuery` or `createMutation`. `useReactor()`
- * returns it with the factory's own return type, so its hooks keep their
- * generic signatures. `useReactor("todo")` returns one property of it.
- *
- * When the tree unmounts, the provider disposes each `AuthenticationManager`
- * built for the value, releasing the Internet Identity client it built: those
- * constructed while the factory ran, and the one a `defineReactor` result in
- * the value, or among its own properties, builds on first use (a result that
- * never used authentication builds none). A manager built elsewhere and
- * handed in, such as an app-wide one passed as `authentication` or as a
- * prop, is left to whoever built it. `dispose()` only forgets the client, and
- * the next sign-in builds a new one, so this is safe under StrictMode, which
- * runs the cleanup and then the effect again on the same value.
- *
- * It also renders a `QueryClientProvider` for the value's QueryClient; see
- * {@link CreateReactorProviderOptions.queryClientProvider}.
- *
- * A suspense hook below the provider may suspend its first render: React
- * renders the same element again when the data arrives, and the provider
- * reuses the value that first render built, whether the Suspense boundary
- * sits above the provider or, while hydrating, there is none. A provider that
- * a transition mounts (`startTransition`, a client-side navigation) can be
- * rendered from a new element on each retry and build a new value each time,
- * so give its suspending components a `<Suspense>` boundary inside it.
- *
- * Call `createReactorProvider` at module scope: it builds nothing itself,
- * only the context, and every mounted provider builds its own value. In the
- * Next.js App Router that module needs `"use client"`, like any module with
- * hooks; a server component renders the provider from there.
- *
- * @param factory - Builds the value. It receives the provider's props other
- * than `children`, and runs once per mounted provider.
- * @param options - See {@link CreateReactorProviderOptions}.
- *
- * @example One canister, with Internet Identity
- * ```tsx
- * "use client"
- * import { createReactorProvider, defineReactor } from "@ic-reactor/react"
- * import { canisterId, idlFactory, type _SERVICE } from "./declarations/todo"
- *
- * export const { ReactorProvider, useReactor } = createReactorProvider(() =>
- *   defineReactor<_SERVICE>({ name: "todo", idlFactory, canisterId })
- * )
- *
- * function Todos() {
- *   const { useActorQuery, useAuth } = useReactor()
- *   const { isAuthenticated } = useAuth()
- *   const { data } = useActorQuery({ functionName: "getAllTodos" })
- *   return <p>{isAuthenticated ? data?.length : "Sign in"}</p>
- * }
- *
- * // app/layout.tsx (a server component)
- * // <ReactorProvider>{children}</ReactorProvider>
- * ```
- *
- * @example Several canisters sharing one agent and one sign-in
- * ```tsx
- * export const { ReactorProvider, useReactor } = createReactorProvider(() => {
- *   const backend = defineReactor<Backend>({
- *     name: "backend",
- *     idlFactory: backendIdl,
- *     canisterId: backendId,
- *   })
- *   const ledger = defineDisplayReactor<Ledger>({
- *     name: "ledger",
- *     idlFactory: ledgerIdl,
- *     canisterId: ledgerId,
- *     authentication: backend.authentication,
- *   })
- *   return { backend, ledger }
- * })
- *
- * function Balance() {
- *   const { data } = useReactor("ledger").useActorQuery({
- *     functionName: "icrc1_total_supply",
- *   })
- *   return <span>{data}</span>
- * }
- * ```
- *
- * @example Props for the factory, and a new key to build again
- * ```tsx
- * export const { ReactorProvider: LedgerProvider, useReactor: useLedger } =
- *   createReactorProvider(({ canisterId }: { canisterId: string }) =>
- *     defineDisplayReactor<Ledger>({ name: "ledger", idlFactory, canisterId })
- *   )
- *
- * // Read once per mount: the key makes a new canister a new tree.
- * <LedgerProvider key={canisterId} canisterId={canisterId}>
- *   <TokenPage />
- * </LedgerProvider>
- * ```
- */
-export function createReactorProvider(factory, options = {}) {
-    const { queryClientProvider = true } = options;
-    const ReactorContext = createContext(null);
-    // What a browser render built and has not committed yet, by the props
-    // object that render received. React throws away the state of a tree that
-    // suspends before it first commits, and renders it again, from the same
-    // element, once the promise settles. A value built afresh for that render
-    // came with an empty QueryClient, so a suspense query below, with no
-    // Suspense boundary between it and this provider, fetched again, suspended
-    // again and rebuilt the value in an endless loop of canister calls. The
-    // render that follows reuses the value instead, and so does StrictMode's
-    // second call of the initializer, which would otherwise build a value only
-    // to drop it. A server keeps nothing here: it never commits, and a
-    // module-scope element rendered for each request would hand one request's
-    // value to the next.
-    const uncommitted = new WeakMap();
-    function ReactorProvider(providerProps) {
-        // Once per mounted tree. A server renders each request as a tree of its
-        // own, so each request builds its own value and nothing it caches is seen
-        // by another. The props are read here only; a new `key` builds again.
-        const [built] = useState(() => {
-            const pending = uncommitted.get(providerProps);
-            if (pending)
-                return pending;
-            const { children: _children, ...props } = providerProps;
-            const { value, built: authentication } = collectAuthentication(() => factory(props));
-            const next = {
-                value,
-                authentication,
-                queryClient: queryClientProvider ? soleQueryClient(value) : undefined,
-            };
-            if (!isServer()) {
-                next.pendingProps = providerProps;
-                uncommitted.set(providerProps, next);
-            }
-            return next;
-        });
-        // Releases the Internet Identity clients of the managers built for this
-        // value once this tree unmounts. A v10 client listens to the page until
-        // it is disposed, so each remount would otherwise leave one behind.
-        // dispose() only forgets the client: StrictMode runs this cleanup and then
-        // the effect again on the same value, and the next sign-in builds a new
-        // one. A server runs no effects, and its managers build no client.
-        useEffect(() => {
-            // Committed: the value is this mount's, and a later mount of the same
-            // element builds its own.
-            if (built.pendingProps) {
-                uncommitted.delete(built.pendingProps);
-                built.pendingProps = undefined;
-            }
-            return () => disposeAuthentication(built);
-        }, [built]);
-        const provided = createElement(ReactorContext.Provider, { value: built.value }, providerProps.children);
-        return built.queryClient
-            ? createElement(QueryClientProvider, { client: built.queryClient }, provided)
-            : provided;
-    }
-    function useReactor(key) {
-        const value = useContext(ReactorContext);
-        if (value === null) {
-            throw new Error("[ic-reactor] useReactor() was called outside its <ReactorProvider>. " +
-                "Render the component below the ReactorProvider returned by the " +
-                "same createReactorProvider() call: each call has a context of its own.");
-        }
-        return key === undefined ? value : value[key];
-    }
-    return { ReactorProvider, useReactor };
-}
-/**
- * Whether this render runs on a server, as TanStack Query decides it: Deno
- * defines `window` without being a browser.
- */
-const isServer = () => typeof window === "undefined" || "Deno" in globalThis;
-/**
- * The value and each of its own data properties: where a built value keeps
- * what it built. Accessors are skipped rather than read, because reading
- * one can build what it returns: a `defineReactor` result's `authentication`
- * builds the manager on first read.
- */
-function partsOf(value) {
-    const parts = [value];
-    for (const descriptor of Object.values(Object.getOwnPropertyDescriptors(value))) {
-        const part = descriptor.value;
-        if (typeof part === "object" && part !== null)
-            parts.push(part);
-    }
-    return parts;
-}
-function isQueryClient(candidate) {
-    const client = candidate;
-    return (typeof client?.getQueryCache === "function" &&
-        typeof client.mount === "function");
-}
-/**
- * The QueryClient the value uses, when it uses exactly one. A reactor, a
- * `ClientManager` and a `defineReactor` result each bring theirs as
- * `queryClient`.
- */
-function soleQueryClient(value) {
-    const clients = new Set();
-    for (const part of partsOf(value)) {
-        const client = isQueryClient(part)
-            ? part
-            : part.queryClient;
-        if (isQueryClient(client))
-            clients.add(client);
-    }
-    if (clients.size !== 1)
-        return undefined;
-    const [client] = clients;
-    return client;
-}
-/**
- * Disposes each `AuthenticationManager` built for the value, once each: those
- * constructed while the factory ran, and the one each `defineReactor` result
- * in the value or among its own properties has built since. A manager built
- * elsewhere and handed in is left to whoever built it.
- */
-function disposeAuthentication({ value, authentication }) {
-    const managers = new Set(authentication);
-    for (const part of partsOf(value)) {
-        const owned = authenticationOf(part);
-        if (owned)
-            managers.add(owned);
-    }
-    for (const manager of managers)
-        manager.dispose();
-}
-//# sourceMappingURL=createReactorProvider.js.map

package/dist/createReactorProvider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createReactorProvider.js","sourceRoot":"","sources":["../src/createReactorProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EACL,aAAa,EACb,aAAa,EACb,UAAU,EACV,SAAS,EACT,QAAQ,GACT,MAAM,OAAO,CAAA;AAEd,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAG3D,OAAO,EACL,gBAAgB,EAChB,qBAAqB,GACtB,MAAM,0BAA0B,CAAA;AAyDjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0GG;AACH,MAAM,UAAU,qBAAqB,CAMnC,OAAkC,EAClC,UAAwC,EAAE;IAE1C,MAAM,EAAE,mBAAmB,GAAG,IAAI,EAAE,GAAG,OAAO,CAAA;IAC9C,MAAM,cAAc,GAAG,aAAa,CAAgB,IAAI,CAAC,CAAA;IAEzD,sEAAsE;IACtE,0EAA0E;IAC1E,wEAAwE;IACxE,0EAA0E;IAC1E,qEAAqE;IACrE,2EAA2E;IAC3E,wEAAwE;IACxE,yEAAyE;IACzE,2EAA2E;IAC3E,mEAAmE;IACnE,0EAA0E;IAC1E,qBAAqB;IACrB,MAAM,WAAW,GAAG,IAAI,OAAO,EAAyB,CAAA;IAExD,SAAS,eAAe,CACtB,aAAwD;QAExD,wEAAwE;QACxE,0EAA0E;QAC1E,sEAAsE;QACtE,MAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE;YAC5B,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;YAC9C,IAAI,OAAO;gBAAE,OAAO,OAAO,CAAA;YAC3B,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,aAAa,CAAA;YACvD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,qBAAqB,CAAC,GAAG,EAAE,CAClE,OAAO,CAAC,KAA0B,CAAC,CACpC,CAAA;YACD,MAAM,IAAI,GAAkB;gBAC1B,KAAK;gBACL,cAAc;gBACd,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;aACtE,CAAA;YACD,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;gBAChB,IAAI,CAAC,YAAY,GAAG,aAAa,CAAA;gBACjC,WAAW,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,CAAA;YACtC,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;QAEF,wEAAwE;QACxE,wEAAwE;QACxE,oEAAoE;QACpE,2EAA2E;QAC3E,wEAAwE;QACxE,mEAAmE;QACnE,SAAS,CAAC,GAAG,EAAE;YACb,sEAAsE;YACtE,0BAA0B;YAC1B,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;gBACvB,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;gBACtC,KAAK,CAAC,YAAY,GAAG,SAAS,CAAA;YAChC,CAAC;YACD,OAAO,GAAG,EAAE,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAA;QAC3C,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAA;QAEX,MAAM,QAAQ,GAAG,aAAa,CAC5B,cAAc,CAAC,QAAQ,EACvB,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EACtB,aAAa,CAAC,QAAQ,CACvB,CAAA;QACD,OAAO,KAAK,CAAC,WAAW;YACtB,CAAC,CAAC,aAAa,CACX,mBAAmB,EACnB,EAAE,MAAM,EAAE,KAAK,CAAC,WAAW,EAAE,EAC7B,QAAQ,CACT;YACH,CAAC,CAAC,QAAQ,CAAA;IACd,CAAC;IAID,SAAS,UAAU,CAAC,GAAkB;QACpC,MAAM,KAAK,GAAG,UAAU,CAAC,cAAc,CAAC,CAAA;QACxC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,sEAAsE;gBACpE,iEAAiE;gBACjE,wEAAwE,CAC3E,CAAA;QACH,CAAC;QACD,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC/C,CAAC;IAED,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,CAAA;AACxC,CAAC;AAWD;;;GAGG;AACH,MAAM,QAAQ,GAAG,GAAG,EAAE,CAAC,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,IAAI,UAAU,CAAA;AAE5E;;;;;GAKG;AACH,SAAS,OAAO,CAAC,KAAa;IAC5B,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,CAAA;IACrB,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CACpC,MAAM,CAAC,yBAAyB,CAAC,KAAK,CAAC,CACxC,EAAE,CAAC;QACF,MAAM,IAAI,GAAY,UAAU,CAAC,KAAK,CAAA;QACtC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACjE,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,aAAa,CAAC,SAAkB;IACvC,MAAM,MAAM,GAAG,SAAoD,CAAA;IACnE,OAAO,CACL,OAAO,MAAM,EAAE,aAAa,KAAK,UAAU;QAC3C,OAAO,MAAM,CAAC,KAAK,KAAK,UAAU,CACnC,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,KAAa;IACpC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAe,CAAA;IACtC,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC;YAChC,CAAC,CAAC,IAAI;YACN,CAAC,CAAE,IAAkC,CAAC,WAAW,CAAA;QACnD,IAAI,aAAa,CAAC,MAAM,CAAC;YAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAChD,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,SAAS,CAAA;IACxC,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAA;IACxB,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,EAAE,KAAK,EAAE,cAAc,EAAiB;IACrE,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAA;IACxC,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAA;QACpC,IAAI,KAAK;YAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IAChC,CAAC;IACD,KAAK,MAAM,OAAO,IAAI,QAAQ;QAAE,OAAO,CAAC,OAAO,EAAE,CAAA;AACnD,CAAC"}