@ic-reactor/react 3.12.5 → 3.13.0

package/dist/defineReactor.js

@@ -1,180 +1,15 @@
-/**
- * defineReactor - One-call bootstrap for a canister reactor + its React hooks.
- *
- * Collapses the four manual steps (QueryClient → ClientManager → Reactor →
- * createActorHooks) into a single call, and turns the Reactor / DisplayReactor
- * choice into a `display` flag.
- * Use this when one-call bootstrap is enough. If you need reusable
- * method-specific operations outside React, compose with query/mutation
- * factories after setup.
- *
- * @example
- * ```typescript
- * import { defineReactor } from "@ic-reactor/react"
- * import { idlFactory, type _SERVICE } from "./declarations/backend"
- *
- * const { reactor, useActorQuery, useActorMutation } = defineReactor<_SERVICE>({
- *   name: "backend",
- *   idlFactory,
- *   canisterId: "rrkah-fqaaa-aaaaa-aaaaq-cai",
- *   display: true, // ⇒ DisplayReactor (string principals/bigints)
- * })
- *
- * function Profile() {
- *   const { data } = useActorQuery({ functionName: "get_profile" })
- *   return <div>{data?.name}</div>
- * }
- * ```
- *
- * @example Reuse an existing ClientManager (multiple canisters share one agent)
- * ```typescript
- * const ledger = defineReactor<_LEDGER>({ name: "ledger", idlFactory: ledgerIdl })
- * const index = defineReactor<_INDEX>({
- *   name: "index",
- *   idlFactory: indexIdl,
- *   clientManager: ledger.clientManager,
- *   authentication: ledger.authentication, // one Internet Identity session
- * })
- * ```
- *
- * @example Internet Identity is wired up out of the box
- * ```typescript
- * const { useAuth, useIdentityAttributes } = defineReactor<_SERVICE>({
- *   name: "backend",
- *   idlFactory,
- *   // Needed when the app is served from more than one origin.
- *   auth: { derivationOrigin: "https://app.example.com" },
- * })
- *
- * function LoginButton() {
- *   const { login, logout, isAuthenticated, principal } = useAuth()
- *   return isAuthenticated
- *     ? <button onClick={() => logout()}>{principal?.toText()}</button>
- *     : <button onClick={() => login()}>Sign in</button>
- * }
- * ```
- */
-import { ClientManager, Reactor, DisplayReactor, reactorRetry, } from "@ic-reactor/core";
-import { QueryClient } from "@tanstack/react-query";
-import { createActorHooks } from "./createActorHooks.js";
-import { AuthenticationManager } from "./auth/authentication-manager.js";
-import { IdentityAttributesManager } from "./auth/identity-attributes-manager.js";
-import { createIdentityAttributeHooks } from "./auth/createIdentityAttributeHooks.js";
-import { createAuthHooks } from "./hooks/createAuthHooks.js";
-/**
- * The QueryClient this module creates when the caller does not supply one.
- *
- * React Query retries every failure three times by default, which for canister
- * calls means four attempts and several seconds of backoff on outcomes that
- * cannot change — a canister `Err`, a validation failure, a Candid encode
- * error that never reached the network. `reactorRetry` keeps the same three
- * attempts for transport failures and stops immediately on the rest.
- *
- * A caller-supplied `queryClient` is left exactly as given; opt in there with
- * `defaultOptions: { queries: { retry: reactorRetry } }`.
- */
-const createDefaultQueryClient = () => new QueryClient({
-    defaultOptions: { queries: { retry: reactorRetry } },
-});
+// DisplayReactor is only for the deprecated `display: true` path. It is what
+// puts DisplayReactor and zod in every bundle that uses defineReactor; drop it
+// with that path.
+import { DisplayReactor, Reactor } from "@ic-reactor/core";
+import { defineReactorWith } from "./defineReactorShared.js";
 export function defineReactor(params) {
-    const { clientManager: providedClientManager, queryClient: providedQueryClient, authentication: providedAuthentication, auth, display, agentOptions, allowEnvConfig, allowEnvRootKey, name, idlFactory, canisterId, pollingOptions, } = params;
-    // A shared AuthenticationManager updates the identity on its own
-    // ClientManager. Giving this reactor a different one would leave its calls
-    // anonymous after sign-in, so adopt the manager's rather than building a new
-    // one, and refuse an explicit mismatch instead of splitting them silently.
-    if (providedClientManager &&
-        providedAuthentication &&
-        providedAuthentication.clientManager !== providedClientManager) {
-        throw new Error(`[ic-reactor] defineReactor("${name}") received an \`authentication\` manager bound to a different \`clientManager\`. ` +
-            `Sign-in would update the authentication manager's agent while this reactor calls through another one, ` +
-            `leaving its calls anonymous. Pass \`clientManager: authentication.clientManager\`, or omit \`clientManager\` to adopt it.`);
+    if (params.display) {
+        // What defineDisplayReactor builds, but under this function's name, so an
+        // error names the call the app actually made.
+        const { validators } = params;
+        return defineReactorWith("defineReactor", params, (config) => new DisplayReactor({ ...config, validators }));
     }
-    // `auth` configures a manager this call would build; an existing one is
-    // already constructed, so these options could only be dropped on the floor.
-    if (providedAuthentication && auth) {
-        throw new Error(`[ic-reactor] defineReactor("${name}") received both \`authentication\` and \`auth\`. ` +
-            `The supplied manager is already configured, so \`auth\` (${Object.keys(auth).join(", ")}) would be ignored. ` +
-            `Pass those options where that AuthenticationManager is created, or drop \`authentication\` to build one here.`);
-    }
-    // Same reasoning as `auth`, and it matters more here: an ignored
-    // `allowEnvConfig: false` reads as "I locked the cookie out" while the
-    // supplied manager carries whatever decision it was built with.
-    if ((providedClientManager || providedAuthentication) &&
-        (allowEnvConfig !== undefined || allowEnvRootKey !== undefined)) {
-        const passed = [
-            allowEnvConfig !== undefined && "allowEnvConfig",
-            allowEnvRootKey !== undefined && "allowEnvRootKey",
-        ]
-            .filter(Boolean)
-            .join(", ");
-        throw new Error(`[ic-reactor] defineReactor("${name}") received both a ClientManager and \`${passed}\`. ` +
-            `That option is resolved when a ClientManager is constructed, so the supplied one already carries its own ` +
-            `decision and this would be ignored — silently changing nothing about whether the ic_env cookie is trusted. ` +
-            `Pass it where that ClientManager is created, or drop \`clientManager\` to build one here.`);
-    }
-    const clientManager = providedClientManager ??
-        providedAuthentication?.clientManager ??
-        new ClientManager({
-            queryClient: providedQueryClient ?? createDefaultQueryClient(),
-            agentOptions,
-            // Forwarded, not dropped: the type has always accepted these (it extends
-            // ClientManagerParameters) while the call ignored them, so the one
-            // documented setup path silently discarded the ic_env opt-in it advertised.
-            allowEnvConfig,
-            allowEnvRootKey,
-        });
-    // Always report the QueryClient actually in use: when a ClientManager is
-    // supplied or adopted, its own QueryClient is the one queries run against.
-    const queryClient = clientManager.queryClient;
-    const reactorConfig = {
-        clientManager,
-        name,
-        idlFactory,
-        canisterId,
-        pollingOptions,
-    };
-    // The Reactor / DisplayReactor union cannot be expressed through the shared
-    // implementation signature, so the body is intentionally untyped here; the
-    // public overloads above carry the precise types for callers.
-    const reactor = display
-        ? new DisplayReactor({
-            ...reactorConfig,
-            validators: params
-                .validators,
-        })
-        : new Reactor(reactorConfig);
-    // `reactor` is `any` above, which would let the overloads infer `Service`
-    // as `unknown` and type every hook's arguments as `never`.
-    const hooks = createActorHooks(reactor);
-    // Auth is built on first use. `AuthenticationManager` dynamically imports the
-    // optional `@icp-sdk/auth` peer as soon as it is constructed, and reactors
-    // that never touch authentication should not pay for that.
-    let authenticationInstance;
-    const getAuthentication = () => (authenticationInstance ?? (authenticationInstance = providedAuthentication ??
-        new AuthenticationManager({ ...auth, clientManager })));
-    let identityAttributesInstance;
-    const getIdentityAttributes = () => (identityAttributesInstance ?? (identityAttributesInstance = new IdentityAttributesManager(getAuthentication())));
-    let authHooks;
-    const getAuthHooks = () => (authHooks ?? (authHooks = createAuthHooks(getAuthentication())));
-    let attributeHooks;
-    const getAttributeHooks = () => (attributeHooks ?? (attributeHooks = createIdentityAttributeHooks(getIdentityAttributes())));
-    return {
-        ...hooks,
-        reactor,
-        clientManager,
-        queryClient,
-        // Stable wrappers: the hook call order inside them never changes, so the
-        // rules of hooks still hold.
-        useAuth: () => getAuthHooks().useAuth(),
-        useAgentState: () => getAuthHooks().useAgentState(),
-        useUserPrincipal: () => getAuthHooks().useUserPrincipal(),
-        useIdentityAttributes: () => getAttributeHooks().useIdentityAttributes(),
-        get authentication() {
-            return getAuthentication();
-        },
-        get identityAttributes() {
-            return getIdentityAttributes();
-        },
-    };
+    return defineReactorWith("defineReactor", params, (config) => new Reactor(config));
 }
 //# sourceMappingURL=defineReactor.js.map

package/dist/defineReactor.js.map

@@ -1 +1 @@
-{"version":3,"file":"defineReactor.js","sourceRoot":"","sources":["../src/defineReactor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,OAAO,EACL,aAAa,EACb,OAAO,EACP,cAAc,EACd,YAAY,GACb,MAAM,kBAAkB,CAAA;AAQzB,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,gBAAgB,EAAc,MAAM,uBAAuB,CAAA;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAA;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAA;AACjF,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAA;AAErF,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AA2E5D;;;;;;;;;;;GAWG;AACH,MAAM,wBAAwB,GAAG,GAAG,EAAE,CACpC,IAAI,WAAW,CAAC;IACd,cAAc,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;CACrD,CAAC,CAAA;AAUJ,MAAM,UAAU,aAAa,CAC3B,MAAyE;IAEzE,MAAM,EACJ,aAAa,EAAE,qBAAqB,EACpC,WAAW,EAAE,mBAAmB,EAChC,cAAc,EAAE,sBAAsB,EACtC,IAAI,EACJ,OAAO,EACP,YAAY,EACZ,cAAc,EACd,eAAe,EACf,IAAI,EACJ,UAAU,EACV,UAAU,EACV,cAAc,GACf,GAAG,MAAiD,CAAA;IAErD,iEAAiE;IACjE,2EAA2E;IAC3E,6EAA6E;IAC7E,2EAA2E;IAC3E,IACE,qBAAqB;QACrB,sBAAsB;QACtB,sBAAsB,CAAC,aAAa,KAAK,qBAAqB,EAC9D,CAAC;QACD,MAAM,IAAI,KAAK,CACb,+BAA+B,IAAI,oFAAoF;YACrH,wGAAwG;YACxG,2HAA2H,CAC9H,CAAA;IACH,CAAC;IAED,wEAAwE;IACxE,4EAA4E;IAC5E,IAAI,sBAAsB,IAAI,IAAI,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,+BAA+B,IAAI,oDAAoD;YACrF,4DAA4D,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB;YAC9G,+GAA+G,CAClH,CAAA;IACH,CAAC;IAED,iEAAiE;IACjE,uEAAuE;IACvE,gEAAgE;IAChE,IACE,CAAC,qBAAqB,IAAI,sBAAsB,CAAC;QACjD,CAAC,cAAc,KAAK,SAAS,IAAI,eAAe,KAAK,SAAS,CAAC,EAC/D,CAAC;QACD,MAAM,MAAM,GAAG;YACb,cAAc,KAAK,SAAS,IAAI,gBAAgB;YAChD,eAAe,KAAK,SAAS,IAAI,iBAAiB;SACnD;aACE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,IAAI,CAAC,CAAA;QACb,MAAM,IAAI,KAAK,CACb,+BAA+B,IAAI,0CAA0C,MAAM,MAAM;YACvF,2GAA2G;YAC3G,6GAA6G;YAC7G,2FAA2F,CAC9F,CAAA;IACH,CAAC;IAED,MAAM,aAAa,GACjB,qBAAqB;QACrB,sBAAsB,EAAE,aAAa;QACrC,IAAI,aAAa,CAAC;YAChB,WAAW,EAAE,mBAAmB,IAAI,wBAAwB,EAAE;YAC9D,YAAY;YACZ,yEAAyE;YACzE,mEAAmE;YACnE,4EAA4E;YAC5E,cAAc;YACd,eAAe;SAChB,CAAC,CAAA;IAEJ,yEAAyE;IACzE,2EAA2E;IAC3E,MAAM,WAAW,GAAG,aAAa,CAAC,WAAW,CAAA;IAE7C,MAAM,aAAa,GAAG;QACpB,aAAa;QACb,IAAI;QACJ,UAAU;QACV,UAAU;QACV,cAAc;KACf,CAAA;IAED,4EAA4E;IAC5E,2EAA2E;IAC3E,8DAA8D;IAE9D,MAAM,OAAO,GAAQ,OAAO;QAC1B,CAAC,CAAC,IAAI,cAAc,CAAU;YAC1B,GAAG,aAAa;YAChB,UAAU,EAAG,MAAkD;iBAC5D,UAAU;SACd,CAAC;QACJ,CAAC,CAAC,IAAI,OAAO,CAAU,aAAa,CAAC,CAAA;IAEvC,0EAA0E;IAC1E,2DAA2D;IAC3D,MAAM,KAAK,GAAG,gBAAgB,CAAe,OAAO,CAAC,CAAA;IAErD,8EAA8E;IAC9E,2EAA2E;IAC3E,2DAA2D;IAC3D,IAAI,sBAAyD,CAAA;IAC7D,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAC7B,CAAC,sBAAsB,KAAtB,sBAAsB,GACrB,sBAAsB;QACtB,IAAI,qBAAqB,CAAC,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,CAAC,EAAC,CAAA;IAE1D,IAAI,0BAAiE,CAAA;IACrE,MAAM,qBAAqB,GAAG,GAAG,EAAE,CACjC,CAAC,0BAA0B,KAA1B,0BAA0B,GAAK,IAAI,yBAAyB,CAC3D,iBAAiB,EAAE,CACpB,EAAC,CAAA;IAEJ,IAAI,SAA4C,CAAA;IAChD,MAAM,YAAY,GAAG,GAAG,EAAE,CACxB,CAAC,SAAS,KAAT,SAAS,GAAK,eAAe,CAAC,iBAAiB,EAAE,CAAC,EAAC,CAAA;IAEtD,IAAI,cACyD,CAAA;IAC7D,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAC7B,CAAC,cAAc,KAAd,cAAc,GAAK,4BAA4B,CAAC,qBAAqB,EAAE,CAAC,EAAC,CAAA;IAE5E,OAAO;QACL,GAAG,KAAK;QACR,OAAO;QACP,aAAa;QACb,WAAW;QACX,yEAAyE;QACzE,6BAA6B;QAC7B,OAAO,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE;QACvC,aAAa,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC,aAAa,EAAE;QACnD,gBAAgB,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC,gBAAgB,EAAE;QACzD,qBAAqB,EAAE,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC,qBAAqB,EAAE;QACxE,IAAI,cAAc;YAChB,OAAO,iBAAiB,EAAE,CAAA;QAC5B,CAAC;QACD,IAAI,kBAAkB;YACpB,OAAO,qBAAqB,EAAE,CAAA;QAChC,CAAC;KACF,CAAA;AACH,CAAC"}
+{"version":3,"file":"defineReactor.js","sourceRoot":"","sources":["../src/defineReactor.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,+EAA+E;AAC/E,kBAAkB;AAClB,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAE1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAmH5D,MAAM,UAAU,aAAa,CAC3B,MAAyE;IAIzE,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,0EAA0E;QAC1E,8CAA8C;QAC9C,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAA;QAC7B,OAAO,iBAAiB,CACtB,eAAe,EACf,MAAM,EACN,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,cAAc,CAAU,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,CACnE,CAAA;IACH,CAAC;IAED,OAAO,iBAAiB,CACtB,eAAe,EACf,MAAM,EACN,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,OAAO,CAAU,MAAM,CAAC,CACzC,CAAA;AACH,CAAC"}

package/dist/defineReactorShared.d.ts

@@ -0,0 +1,84 @@
+/**
+ * The body `defineReactor` and `defineDisplayReactor` share.
+ *
+ * It takes the reactor's construction as a callback, so this module imports
+ * neither reactor class. That matters for bundle size: `DisplayReactor` builds
+ * its codecs on zod, and a module that imported it here would put zod in every
+ * app that calls `defineReactor`, whether or not it ever builds a
+ * DisplayReactor. Keep it that way — no `DisplayReactor` import in this file.
+ */
+import { ClientManager } from "@ic-reactor/core";
+import type { Reactor, TransformKey, ReactorParameters, ClientManagerParameters } from "@ic-reactor/core";
+import { QueryClient } from "@tanstack/react-query";
+import { ActorHooks } from "./createActorHooks.js";
+import { AuthenticationManager } from "./auth/authentication-manager.js";
+import { IdentityAttributesManager } from "./auth/identity-attributes-manager.js";
+import type { UseIdentityAttributesReturn } from "./auth/createIdentityAttributeHooks.js";
+import type { CreateAuthHooksReturn } from "./hooks/createAuthHooks.js";
+import type { AuthenticationManagerParameters } from "./auth/authentication-manager.js";
+/** Options shared by both the standard and display variants of defineReactor. */
+export interface DefineReactorSharedParameters extends Omit<ReactorParameters, "clientManager">, Omit<ClientManagerParameters, "queryClient"> {
+    /**
+     * Reuse an existing ClientManager (e.g. to share one agent across canisters).
+     * When omitted, a ClientManager is created from the agent options below.
+     *
+     * A supplied or adopted manager brings its own agent and QueryClient, so
+     * `agentOptions`, `queryClient` and `allowEnvConfig` apply only when this
+     * call creates one.
+     */
+    clientManager?: ClientManager;
+    /**
+     * QueryClient for a ClientManager created by this call.
+     *
+     * Ignored when `clientManager` or `authentication` is supplied — queries run
+     * against that manager's own QueryClient, which is what is returned.
+     */
+    queryClient?: QueryClient;
+    /**
+     * Reuse an existing AuthenticationManager, so several reactors share one
+     * Internet Identity session. When omitted, one is created for this reactor.
+     *
+     * Its `clientManager` is adopted for this reactor, so sign-in updates the
+     * same agent the reactor calls through. Supplying a different `clientManager`
+     * alongside it is rejected.
+     */
+    authentication?: AuthenticationManager;
+    /**
+     * Internet Identity options forwarded to the AuthenticationManager
+     * (`identityProvider`, `derivationOrigin`, `idleOptions`, `storage`, …).
+     *
+     * Not every option reaches both `@icp-sdk/auth` majors. `idleOptions`,
+     * `storage`, `keyType` and `identity` are honoured only by v8: v10 has no
+     * equivalent, so IC Reactor drops each with a one-time warning. For idle
+     * handling on v10, pass `maxTimeToIdle` to `login()` and set
+     * `disableBrowserActivity` here. `disableBrowserActivity` is v10-only.
+     *
+     * Mutually exclusive with `authentication`: a manager built elsewhere is
+     * already configured, so these could not be applied to it.
+     */
+    auth?: Omit<AuthenticationManagerParameters, "clientManager">;
+}
+/** The reactor instance plus its bound hooks and shared infrastructure. */
+export type DefineReactorResult<Service, Transform extends TransformKey, R extends Reactor<Service, Transform>> = ActorHooks<Service, Transform> & CreateAuthHooksReturn & {
+    reactor: R;
+    clientManager: ClientManager;
+    queryClient: QueryClient;
+    /** Internet Identity session manager backing `useAuth`. */
+    authentication: AuthenticationManager;
+    /** Signed identity attribute requests backing `useIdentityAttributes`. */
+    identityAttributes: IdentityAttributesManager;
+    useIdentityAttributes: () => UseIdentityAttributesReturn;
+};
+/**
+ * Builds the ClientManager, the reactor `createReactor` returns, its hooks and
+ * the lazily created auth managers, for `defineReactor` and
+ * `defineDisplayReactor`. Not part of the public API.
+ *
+ * `caller` is the function the app called; the errors below name it, so an
+ * app that called `defineDisplayReactor` is not sent looking for a
+ * `defineReactor` call it never made.
+ *
+ * @internal
+ */
+export declare function defineReactorWith<Service, Transform extends TransformKey, R extends Reactor<Service, Transform>>(caller: "defineReactor" | "defineDisplayReactor", params: DefineReactorSharedParameters, createReactor: (config: ReactorParameters) => R): DefineReactorResult<Service, Transform, R>;
+//# sourceMappingURL=defineReactorShared.d.ts.map

package/dist/defineReactorShared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineReactorShared.d.ts","sourceRoot":"","sources":["../src/defineReactorShared.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,aAAa,EAAgB,MAAM,kBAAkB,CAAA;AAC9D,OAAO,KAAK,EACV,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAoB,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAA;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAA;AAEjF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,wCAAwC,CAAA;AAEzF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAA;AAGvF,iFAAiF;AACjF,MAAM,WAAW,6BACf,SACE,IAAI,CAAC,iBAAiB,EAAE,eAAe,CAAC,EACxC,IAAI,CAAC,uBAAuB,EAAE,aAAa,CAAC;IAC9C;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,qBAAqB,CAAA;IACtC;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,eAAe,CAAC,CAAA;CAC9D;AAED,2EAA2E;AAC3E,MAAM,MAAM,mBAAmB,CAC7B,OAAO,EACP,SAAS,SAAS,YAAY,EAC9B,CAAC,SAAS,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,IACnC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,GAChC,qBAAqB,GAAG;IACtB,OAAO,EAAE,CAAC,CAAA;IACV,aAAa,EAAE,aAAa,CAAA;IAC5B,WAAW,EAAE,WAAW,CAAA;IACxB,2DAA2D;IAC3D,cAAc,EAAE,qBAAqB,CAAA;IACrC,0EAA0E;IAC1E,kBAAkB,EAAE,yBAAyB,CAAA;IAC7C,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;CACzD,CAAA;AAmBH;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,EACP,SAAS,SAAS,YAAY,EAC9B,CAAC,SAAS,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,EAErC,MAAM,EAAE,eAAe,GAAG,sBAAsB,EAChD,MAAM,EAAE,6BAA6B,EACrC,aAAa,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,CAAC,GAC9C,mBAAmB,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CA6I5C"}

package/dist/defineReactorShared.js

@@ -0,0 +1,139 @@
+/**
+ * The body `defineReactor` and `defineDisplayReactor` share.
+ *
+ * It takes the reactor's construction as a callback, so this module imports
+ * neither reactor class. That matters for bundle size: `DisplayReactor` builds
+ * its codecs on zod, and a module that imported it here would put zod in every
+ * app that calls `defineReactor`, whether or not it ever builds a
+ * DisplayReactor. Keep it that way — no `DisplayReactor` import in this file.
+ */
+import { ClientManager, reactorRetry } from "@ic-reactor/core";
+import { QueryClient } from "@tanstack/react-query";
+import { createActorHooks } from "./createActorHooks.js";
+import { AuthenticationManager } from "./auth/authentication-manager.js";
+import { IdentityAttributesManager } from "./auth/identity-attributes-manager.js";
+import { createIdentityAttributeHooks } from "./auth/createIdentityAttributeHooks.js";
+import { createAuthHooks } from "./hooks/createAuthHooks.js";
+import { registerAuthentication } from "./ownedAuthentication.js";
+/**
+ * The QueryClient this module creates when the caller does not supply one.
+ *
+ * React Query retries every failure three times by default, which for canister
+ * calls means four attempts and several seconds of backoff on outcomes that
+ * cannot change — a canister `Err`, a validation failure, a Candid encode
+ * error that never reached the network. `reactorRetry` keeps the same three
+ * attempts for transport failures and stops immediately on the rest.
+ *
+ * A caller-supplied `queryClient` is left exactly as given; opt in there with
+ * `defaultOptions: { queries: { retry: reactorRetry } }`.
+ */
+const createDefaultQueryClient = () => new QueryClient({
+    defaultOptions: { queries: { retry: reactorRetry } },
+});
+/**
+ * Builds the ClientManager, the reactor `createReactor` returns, its hooks and
+ * the lazily created auth managers, for `defineReactor` and
+ * `defineDisplayReactor`. Not part of the public API.
+ *
+ * `caller` is the function the app called; the errors below name it, so an
+ * app that called `defineDisplayReactor` is not sent looking for a
+ * `defineReactor` call it never made.
+ *
+ * @internal
+ */
+export function defineReactorWith(caller, params, createReactor) {
+    const { clientManager: providedClientManager, queryClient: providedQueryClient, authentication: providedAuthentication, auth, agentOptions, allowEnvConfig, allowEnvRootKey, name, idlFactory, canisterId, pollingOptions, } = params;
+    // A shared AuthenticationManager updates the identity on its own
+    // ClientManager. Giving this reactor a different one would leave its calls
+    // anonymous after sign-in, so adopt the manager's rather than building a new
+    // one, and refuse an explicit mismatch instead of splitting them silently.
+    if (providedClientManager &&
+        providedAuthentication &&
+        providedAuthentication.clientManager !== providedClientManager) {
+        throw new Error(`[ic-reactor] ${caller}("${name}") received an \`authentication\` manager bound to a different \`clientManager\`. ` +
+            `Sign-in would update the authentication manager's agent while this reactor calls through another one, ` +
+            `leaving its calls anonymous. Pass \`clientManager: authentication.clientManager\`, or omit \`clientManager\` to adopt it.`);
+    }
+    // `auth` configures a manager this call would build; an existing one is
+    // already constructed, so these options could only be dropped on the floor.
+    if (providedAuthentication && auth) {
+        throw new Error(`[ic-reactor] ${caller}("${name}") received both \`authentication\` and \`auth\`. ` +
+            `The supplied manager is already configured, so \`auth\` (${Object.keys(auth).join(", ")}) would be ignored. ` +
+            `Pass those options where that AuthenticationManager is created, or drop \`authentication\` to build one here.`);
+    }
+    // Same reasoning as `auth`, and it matters more here: an ignored
+    // `allowEnvConfig: false` reads as "I locked the cookie out" while the
+    // supplied manager carries whatever decision it was built with.
+    if ((providedClientManager || providedAuthentication) &&
+        (allowEnvConfig !== undefined || allowEnvRootKey !== undefined)) {
+        const passed = [
+            allowEnvConfig !== undefined && "allowEnvConfig",
+            allowEnvRootKey !== undefined && "allowEnvRootKey",
+        ]
+            .filter(Boolean)
+            .join(", ");
+        throw new Error(`[ic-reactor] ${caller}("${name}") received both a ClientManager and \`${passed}\`. ` +
+            `That option is resolved when a ClientManager is constructed, so the supplied one already carries its own ` +
+            `decision and this would be ignored — silently changing nothing about whether the ic_env cookie is trusted. ` +
+            `Pass it where that ClientManager is created, or drop \`clientManager\` to build one here.`);
+    }
+    const clientManager = providedClientManager ??
+        providedAuthentication?.clientManager ??
+        new ClientManager({
+            queryClient: providedQueryClient ?? createDefaultQueryClient(),
+            agentOptions,
+            // Forwarded, not dropped: the type has always accepted these (it extends
+            // ClientManagerParameters) while the call ignored them, so the one
+            // documented setup path silently discarded the ic_env opt-in it advertised.
+            allowEnvConfig,
+            allowEnvRootKey,
+        });
+    // Always report the QueryClient actually in use: when a ClientManager is
+    // supplied or adopted, its own QueryClient is the one queries run against.
+    const queryClient = clientManager.queryClient;
+    const reactor = createReactor({
+        clientManager,
+        name,
+        idlFactory,
+        canisterId,
+        pollingOptions,
+    });
+    const hooks = createActorHooks(reactor);
+    // Auth is built on first use. `AuthenticationManager` dynamically imports the
+    // optional `@icp-sdk/auth` peer as soon as it is constructed, and reactors
+    // that never touch authentication should not pay for that.
+    let authenticationInstance;
+    const getAuthentication = () => (authenticationInstance ?? (authenticationInstance = providedAuthentication ??
+        new AuthenticationManager({ ...auth, clientManager })));
+    let identityAttributesInstance;
+    const getIdentityAttributes = () => (identityAttributesInstance ?? (identityAttributesInstance = new IdentityAttributesManager(getAuthentication())));
+    let authHooks;
+    const getAuthHooks = () => (authHooks ?? (authHooks = createAuthHooks(getAuthentication())));
+    let attributeHooks;
+    const getAttributeHooks = () => (attributeHooks ?? (attributeHooks = createIdentityAttributeHooks(getIdentityAttributes())));
+    const result = {
+        ...hooks,
+        reactor,
+        clientManager,
+        queryClient,
+        // Stable wrappers: the hook call order inside them never changes, so the
+        // rules of hooks still hold.
+        useAuth: () => getAuthHooks().useAuth(),
+        useAgentState: () => getAuthHooks().useAgentState(),
+        useUserPrincipal: () => getAuthHooks().useUserPrincipal(),
+        useIdentityAttributes: () => getAttributeHooks().useIdentityAttributes(),
+        get authentication() {
+            return getAuthentication();
+        },
+        get identityAttributes() {
+            return getIdentityAttributes();
+        },
+    };
+    // For `createReactorProvider`, which disposes the manager this result
+    // builds when its tree unmounts. It reads the manager without the getter
+    // above, so a tree that never touched authentication does not build one
+    // just to release it. A supplied manager is not this result's to release.
+    registerAuthentication(result, () => providedAuthentication ? undefined : authenticationInstance);
+    return result;
+}
+//# sourceMappingURL=defineReactorShared.js.map

package/dist/defineReactorShared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineReactorShared.js","sourceRoot":"","sources":["../src/defineReactorShared.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAO9D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,gBAAgB,EAAc,MAAM,uBAAuB,CAAA;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAA;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAA;AACjF,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAA;AAErF,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAG5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AAiEjE;;;;;;;;;;;GAWG;AACH,MAAM,wBAAwB,GAAG,GAAG,EAAE,CACpC,IAAI,WAAW,CAAC;IACd,cAAc,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;CACrD,CAAC,CAAA;AAEJ;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAK/B,MAAgD,EAChD,MAAqC,EACrC,aAA+C;IAE/C,MAAM,EACJ,aAAa,EAAE,qBAAqB,EACpC,WAAW,EAAE,mBAAmB,EAChC,cAAc,EAAE,sBAAsB,EACtC,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,eAAe,EACf,IAAI,EACJ,UAAU,EACV,UAAU,EACV,cAAc,GACf,GAAG,MAAM,CAAA;IAEV,iEAAiE;IACjE,2EAA2E;IAC3E,6EAA6E;IAC7E,2EAA2E;IAC3E,IACE,qBAAqB;QACrB,sBAAsB;QACtB,sBAAsB,CAAC,aAAa,KAAK,qBAAqB,EAC9D,CAAC;QACD,MAAM,IAAI,KAAK,CACb,gBAAgB,MAAM,KAAK,IAAI,oFAAoF;YACjH,wGAAwG;YACxG,2HAA2H,CAC9H,CAAA;IACH,CAAC;IAED,wEAAwE;IACxE,4EAA4E;IAC5E,IAAI,sBAAsB,IAAI,IAAI,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,gBAAgB,MAAM,KAAK,IAAI,oDAAoD;YACjF,4DAA4D,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB;YAC9G,+GAA+G,CAClH,CAAA;IACH,CAAC;IAED,iEAAiE;IACjE,uEAAuE;IACvE,gEAAgE;IAChE,IACE,CAAC,qBAAqB,IAAI,sBAAsB,CAAC;QACjD,CAAC,cAAc,KAAK,SAAS,IAAI,eAAe,KAAK,SAAS,CAAC,EAC/D,CAAC;QACD,MAAM,MAAM,GAAG;YACb,cAAc,KAAK,SAAS,IAAI,gBAAgB;YAChD,eAAe,KAAK,SAAS,IAAI,iBAAiB;SACnD;aACE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,IAAI,CAAC,CAAA;QACb,MAAM,IAAI,KAAK,CACb,gBAAgB,MAAM,KAAK,IAAI,0CAA0C,MAAM,MAAM;YACnF,2GAA2G;YAC3G,6GAA6G;YAC7G,2FAA2F,CAC9F,CAAA;IACH,CAAC;IAED,MAAM,aAAa,GACjB,qBAAqB;QACrB,sBAAsB,EAAE,aAAa;QACrC,IAAI,aAAa,CAAC;YAChB,WAAW,EAAE,mBAAmB,IAAI,wBAAwB,EAAE;YAC9D,YAAY;YACZ,yEAAyE;YACzE,mEAAmE;YACnE,4EAA4E;YAC5E,cAAc;YACd,eAAe;SAChB,CAAC,CAAA;IAEJ,yEAAyE;IACzE,2EAA2E;IAC3E,MAAM,WAAW,GAAG,aAAa,CAAC,WAAW,CAAA;IAE7C,MAAM,OAAO,GAAG,aAAa,CAAC;QAC5B,aAAa;QACb,IAAI;QACJ,UAAU;QACV,UAAU;QACV,cAAc;KACf,CAAC,CAAA;IAEF,MAAM,KAAK,GAAG,gBAAgB,CAAqB,OAAO,CAAC,CAAA;IAE3D,8EAA8E;IAC9E,2EAA2E;IAC3E,2DAA2D;IAC3D,IAAI,sBAAyD,CAAA;IAC7D,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAC7B,CAAC,sBAAsB,KAAtB,sBAAsB,GACrB,sBAAsB;QACtB,IAAI,qBAAqB,CAAC,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,CAAC,EAAC,CAAA;IAE1D,IAAI,0BAAiE,CAAA;IACrE,MAAM,qBAAqB,GAAG,GAAG,EAAE,CACjC,CAAC,0BAA0B,KAA1B,0BAA0B,GAAK,IAAI,yBAAyB,CAC3D,iBAAiB,EAAE,CACpB,EAAC,CAAA;IAEJ,IAAI,SAA4C,CAAA;IAChD,MAAM,YAAY,GAAG,GAAG,EAAE,CACxB,CAAC,SAAS,KAAT,SAAS,GAAK,eAAe,CAAC,iBAAiB,EAAE,CAAC,EAAC,CAAA;IAEtD,IAAI,cACyD,CAAA;IAC7D,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAC7B,CAAC,cAAc,KAAd,cAAc,GAAK,4BAA4B,CAAC,qBAAqB,EAAE,CAAC,EAAC,CAAA;IAE5E,MAAM,MAAM,GAA+C;QACzD,GAAG,KAAK;QACR,OAAO;QACP,aAAa;QACb,WAAW;QACX,yEAAyE;QACzE,6BAA6B;QAC7B,OAAO,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE;QACvC,aAAa,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC,aAAa,EAAE;QACnD,gBAAgB,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC,gBAAgB,EAAE;QACzD,qBAAqB,EAAE,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC,qBAAqB,EAAE;QACxE,IAAI,cAAc;YAChB,OAAO,iBAAiB,EAAE,CAAA;QAC5B,CAAC;QACD,IAAI,kBAAkB;YACpB,OAAO,qBAAqB,EAAE,CAAA;QAChC,CAAC;KACF,CAAA;IAED,sEAAsE;IACtE,yEAAyE;IACzE,wEAAwE;IACxE,0EAA0E;IAC1E,sBAAsB,CAAC,MAAM,EAAE,GAAG,EAAE,CAClC,sBAAsB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAC5D,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/hooks/createAuthHooks.d.ts

@@ -10,6 +10,13 @@ export interface UseAuthReturn {
         returnTo?: string;
     }) => Promise<void>;
     isAuthenticated: boolean;
+    /**
+     * `true` while a sign-in or sign-out is in progress, and until the session
+     * restore the first `useAuth()` starts has settled: on the first render, in
+     * a server render and while the stored session is read. A restore that fails
+     * settles it too. Show a loading state while it is `true` rather than
+     * treating `isAuthenticated: false` as signed out.
+     */
     isAuthenticating: boolean;
     /**
      * The signed-in user's principal, or `null` while signed out. A signed-out

package/dist/hooks/createAuthHooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createAuthHooks.d.ts","sourceRoot":"","sources":["../../src/hooks/createAuthHooks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AAC9E,OAAO,KAAK,EAAa,2BAA2B,EAAE,MAAM,kBAAkB,CAAA;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,MAAM,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAA;IACjD,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,2BAA2B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/D,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1D,eAAe,EAAE,OAAO,CAAA;IACxB,gBAAgB,EAAE,OAAO,CAAA;IACzB;;;;OAIG;IACH,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;IAC3B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IACzB,KAAK,EAAE,KAAK,GAAG,SAAS,CAAA;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC,aAAa,EAAE,MAAM,UAAU,CAAA;IAC/B,gBAAgB,EAAE,MAAM,SAAS,GAAG,IAAI,CAAA;IACxC,OAAO,EAAE,MAAM,aAAa,CAAA;CAC7B;AAsBD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe,GAC1B,gBAAgB,qBAAqB,KACpC,qBA2HF,CAAA"}
+{"version":3,"file":"createAuthHooks.d.ts","sourceRoot":"","sources":["../../src/hooks/createAuthHooks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AAC9E,OAAO,KAAK,EAAa,2BAA2B,EAAE,MAAM,kBAAkB,CAAA;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,MAAM,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAA;IACjD,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,2BAA2B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/D,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1D,eAAe,EAAE,OAAO,CAAA;IACxB;;;;;;OAMG;IACH,gBAAgB,EAAE,OAAO,CAAA;IACzB;;;;OAIG;IACH,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;IAC3B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IACzB,KAAK,EAAE,KAAK,GAAG,SAAS,CAAA;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC,aAAa,EAAE,MAAM,UAAU,CAAA;IAC/B,gBAAgB,EAAE,MAAM,SAAS,GAAG,IAAI,CAAA;IACxC,OAAO,EAAE,MAAM,aAAa,CAAA;CAC7B;AAwED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe,GAC1B,gBAAgB,qBAAqB,KACpC,qBAwPF,CAAA"}