@ic-reactor/core 3.5.1 → 3.7.0

package/README.md

@@ -3,10 +3,10 @@
 <div align="center">
   <strong>The Core Library for Internet Computer Applications</strong>
   <br><br>
-  
-  [![npm version](https://img.shields.io/npm/v/@ic-reactor/core.svg)](https://www.npmjs.com/package/@ic-reactor/core)
-  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-  [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
+
+[![npm version](https://img.shields.io/npm/v/@ic-reactor/core.svg)](https://www.npmjs.com/package/@ic-reactor/core)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
 </div>
 
 ---
@@ -160,15 +160,12 @@ const identity = await clientManager.authenticate()
 
 ### Identity Attributes / OpenID email and profile values
 
-`ClientManager` uses the `@icp-sdk/auth` v6 `signIn()` / `requestAttributes()`
+`ClientManager` uses the `@icp-sdk/auth` v7 `signIn()` / `requestAttributes()`
 API. Apps can request signed identity attributes directly, without adding a
 local compatibility shim.
 
 ```typescript
-import {
-  IDENTITY_ATTRIBUTES_BETA_PROVIDER,
-  identityAttributeKeys,
-} from "@ic-reactor/core"
+import { identityAttributeKeys } from "@ic-reactor/core"
 
 const nonce = await backend.registerBegin()
 
@@ -176,7 +173,6 @@ const result = await clientManager.requestOpenIdIdentityAttributes({
   nonce,
   openIdProvider: "microsoft",
   keys: ["email", "name"],
-  identityProvider: IDENTITY_ATTRIBUTES_BETA_PROVIDER,
   windowOpenerFeatures: popupCenter(),
 })
 
@@ -209,7 +205,6 @@ const result = await clientManager.requestIdentityAttributes({
     openIdProvider: "https://issuer.example.com",
     keys: ["sub", "email"],
   }),
-  identityProvider: "https://beta.id.ai/authorize",
 })
 ```
 

package/dist/client.d.ts

@@ -1,27 +1,35 @@
 import type { Identity } from "@icp-sdk/core/agent";
-import type { ClientManagerParameters, AgentState, AuthState, AuthClientLike, ClientManagerAuthClientOptions, ClientManagerSignInOptions, IdentityAttributeResult, RequestIdentityAttributesParameters, RequestOpenIdIdentityAttributesParameters } from "./types/client";
+import type { ClientManagerParameters, AgentState } from "./types/client";
 import type { Principal } from "@icp-sdk/core/principal";
-import type { QueryClient } from "@tanstack/react-query";
+import type { QueryClient } from "@tanstack/query-core";
 import { HttpAgent } from "@icp-sdk/core/agent";
 /**
- * ClientManager is a central class for managing the Internet Computer (IC) agent and authentication state.
+ * ClientManager is a central class for managing the Internet Computer (IC) agent.
  *
- * It initializes the agent (connecting to local or mainnet), handles authentication via AuthClient,
- * and integrates with TanStack Query's QueryClient for state management.
+ * It initializes the agent (connecting to local or mainnet) and integrates
+ * with TanStack Query's QueryClient for state management.
+ * Use this as a singleton shared by all reactors in an app.
  *
  * @example
  * ```typescript
  * import { ClientManager } from "@ic-reactor/core";
- * import { QueryClient } from "@tanstack/react-query";
+ * import { QueryClient } from "@tanstack/query-core";
  *
  * const queryClient = new QueryClient();
  * const clientManager = new ClientManager({
  *   queryClient,
- *   withLocalEnv: true, // Use local replica
+ *   agentOptions: { host: "http://127.0.0.1:4943" },
  * });
  *
  * await clientManager.initialize();
  * ```
+ *
+ * @example
+ * ```typescript
+ * // Reuse the same ClientManager across multiple canisters
+ * const backend = new Reactor<BackendService>({ clientManager, idlFactory: backendIdl, name: "backend" })
+ * const ledger = new Reactor<LedgerService>({ clientManager, idlFactory: ledgerIdl, name: "ledger" })
+ * ```
  */
 export declare class ClientManager {
     #private;
@@ -33,41 +41,21 @@ export declare class ClientManager {
      * Current state of the HttpAgent, including initialization status, network, and error information.
      */
     agentState: AgentState;
-    /**
-     * Current authentication state, including the active identity, authentication progress, and errors.
-     */
-    authState: AuthState;
     private initPromise?;
-    private authPromise?;
-    private authClientConstructor?;
-    private authClientConstructorPromise?;
-    private authStateRevision;
-    private authClientWasProvided;
-    private port;
-    private internetIdentityId?;
     /**
      * Creates a new instance of ClientManager.
      *
      * @param parameters - Configuration options for the agent and network environment.
      */
-    constructor({ port, withLocalEnv, withProcessEnv, withCanisterEnv, agentOptions, queryClient, authClient, }: ClientManagerParameters);
+    constructor({ agentOptions, queryClient }: ClientManagerParameters);
     /**
      * Orchestrates the complete initialization of the ClientManager.
      * This method awaits the agent's core initialization (e.g., fetching root keys)
-     * and triggers the authentication (session restoration) in the background.
+     * Authentication session restoration is handled by AuthenticationManager.
      *
      * @returns A promise that resolves to the ClientManager instance when core initialization is complete.
      */
     initialize(): Promise<this>;
-    /**
-     * Preloads and creates an AuthClient before a user gesture is needed.
-     *
-     * Browser signer transports must open their channel directly from a click
-     * handler. Apps that pass dynamic auth options, such as OpenID provider
-     * aliases, can call this from hover/focus/effect code so the later click path
-     * can call signIn/requestAttributes without first awaiting a dynamic import.
-     */
-    prepareAuthClient(options?: ClientManagerAuthClientOptions): Promise<AuthClientLike | undefined>;
     /**
      * Specifically initializes the HttpAgent.
      * On local networks, this includes fetching the root key for certificate verification.
@@ -75,51 +63,10 @@ export declare class ClientManager {
      * @returns A promise that resolves when the agent is fully initialized.
      */
     initializeAgent(): Promise<void>;
-    private authModuleMissing;
-    /**
-     * Attempts to initialize the authentication client and restore a previous session.
-     *
-     * If an `AuthClient` is already initialized (passed in constructor or previously created),
-     * it uses that instance. Otherwise, it dynamically imports the `@icp-sdk/auth` module
-     * and creates a new AuthClient.
-     *
-     * If the module is missing and no client is provided, it fails gracefully by marking authentication as unavailable.
-     *
-     * @returns A promise that resolves to the restored Identity, or undefined if auth fails or is unavailable.
-     */
-    authenticate: () => Promise<Identity | undefined>;
-    /**
-     * Triggers the login flow using the Internet Identity provider.
-     *
-     * @param loginOptions - Options for the login flow, including identity provider and callbacks.
-     * @throws An error if the authentication module is not installed.
-     */
-    login: (loginOptions?: ClientManagerSignInOptions) => Promise<void>;
-    /**
-     * Logs out the user and reverts the agent to an anonymous identity.
-     *
-     * @throws An error if the authentication module is not installed.
-     */
-    logout: (options?: {
-        returnTo?: string;
-    }) => Promise<void>;
-    requestIdentityAttributes: ({ keys, nonce, identityProvider, openIdProvider, windowOpenerFeatures, signIn, maxTimeToLive, targets, }: RequestIdentityAttributesParameters) => Promise<IdentityAttributeResult>;
-    requestOpenIdIdentityAttributes: ({ nonce, openIdProvider, keys, identityProvider, windowOpenerFeatures, signIn, maxTimeToLive, targets, }: RequestOpenIdIdentityAttributesParameters) => Promise<IdentityAttributeResult>;
     /**
      * The underlying HttpAgent managed by this class.
      */
     get agent(): HttpAgent;
-    /**
-     * The AuthClient instance used for authentication, if available.
-     */
-    get authClient(): AuthClientLike | undefined;
-    private initializeAuthClient;
-    private signInOrRecoverAuthenticatedIdentity;
-    private loadAuthClientConstructor;
-    private createAuthClient;
-    private ensurePreparedAuthClient;
-    private shouldRecreateAuthClient;
-    private syncAuthStateFromClient;
     /**
      * The host URL of the current IC agent.
      */
@@ -157,7 +104,6 @@ export declare class ClientManager {
      * Sync time with a specific subnet.
      */
     syncTimeWithSubnet(subnetId: Principal): Promise<void>;
-    private getDefaultIdentityProvider;
     /**
      * Subscribes to identity changes (e.g., after login/logout).
      * @param callback - Function called with the new identity.
@@ -170,12 +116,6 @@ export declare class ClientManager {
      * @returns An unsubscribe function.
      */
     subscribeAgentState(callback: (state: AgentState) => void): () => void;
-    /**
-     * Subscribes to changes in the authentication state.
-     * @param callback - Function called with the updated authentication state.
-     * @returns An unsubscribe function.
-     */
-    subscribeAuthState(callback: (state: AuthState) => void): () => void;
     /**
      * Replaces the current agent's identity and invalidates TanStack queries.
      * @param identity - The new identity to use.
@@ -183,8 +123,6 @@ export declare class ClientManager {
     updateAgent(identity: Identity): void;
     private notifySubscribers;
     private notifyAgentStateSubscribers;
-    private notifyAuthStateSubscribers;
     private updateAgentState;
-    private updateAuthState;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,KAAK,EACV,uBAAuB,EACvB,UAAU,EACV,SAAS,EAET,cAAc,EACd,8BAA8B,EAC9B,0BAA0B,EAC1B,uBAAuB,EACvB,mCAAmC,EACnC,yCAAyC,EAC1C,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAuB/C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,aAAa;;IAQxB;;OAEG;IACI,WAAW,EAAE,WAAW,CAAA;IAC/B;;OAEG;IACI,UAAU,EAAE,UAAU,CAAA;IAC7B;;OAEG;IACI,SAAS,EAAE,SAAS,CAAA;IAE3B,OAAO,CAAC,WAAW,CAAC,CAAe;IACnC,OAAO,CAAC,WAAW,CAAC,CAA+B;IACnD,OAAO,CAAC,qBAAqB,CAAC,CAAuB;IACrD,OAAO,CAAC,4BAA4B,CAAC,CAEpC;IACD,OAAO,CAAC,iBAAiB,CAAI;IAC7B,OAAO,CAAC,qBAAqB,CAAQ;IACrC,OAAO,CAAC,IAAI,CAAQ;IACpB,OAAO,CAAC,kBAAkB,CAAC,CAAQ;IAEnC;;;;OAIG;gBACS,EACV,IAAW,EACX,YAAY,EACZ,cAAc,EACd,eAAe,EACf,YAAiB,EACjB,WAAW,EACX,UAAU,GACX,EAAE,uBAAuB;IAgG1B;;;;;;OAMG;IACU,UAAU;IAMvB;;;;;;;OAOG;IACU,iBAAiB,CAAC,OAAO,CAAC,EAAE,8BAA8B;IAWvE;;;;;OAKG;IACU,eAAe;IAuC5B,OAAO,CAAC,iBAAiB,CAAQ;IAEjC;;;;;;;;;;OAUG;IACI,YAAY,QAAa,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAoD5D;IAED;;;;;OAKG;IACI,KAAK,GAAU,eAAe,0BAA0B,mBA8D9D;IAED;;;;OAIG;IACI,MAAM,GAAU,UAAU;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,mBAerD;IAEM,yBAAyB,GAAU,0GASvC,mCAAmC,KAAG,OAAO,CAAC,uBAAuB,CAAC,CAqExE;IAEM,+BAA+B,GAAU,0GAS7C,yCAAyC,KAAG,OAAO,CAAC,uBAAuB,CAAC,CAW9E;IAED;;OAEG;IACH,IAAI,KAAK,cAER;IAED;;OAEG;IACH,IAAI,UAAU,+BAEb;YAEa,oBAAoB;YAapB,oCAAoC;YA2BpC,yBAAyB;IAqCvC,OAAO,CAAC,gBAAgB;IAOxB,OAAO,CAAC,wBAAwB;IAqBhC,OAAO,CAAC,wBAAwB;YAMlB,uBAAuB;IAmBrC;;OAEG;IACH,IAAI,SAAS,IAAI,GAAG,GAAG,SAAS,CAE/B;IAED;;OAEG;IACH,IAAI,aAAa,WAEhB;IAED;;OAEG;IACH,IAAI,OAAO,YAEV;IAED;;OAEG;IACH,IAAI,OAAO,8BAGV;IAED;;OAEG;IACI,gBAAgB;IAIvB;;;OAGG;IACI,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAiBlE;;OAEG;IACI,oBAAoB,IAAI,MAAM,EAAE;IAIvC;;OAEG;IACI,uBAAuB,CAAC,UAAU,EAAE,MAAM;IAIjD;;OAEG;IACI,kBAAkB,CAAC,QAAQ,EAAE,SAAS;IAI7C,OAAO,CAAC,0BAA0B;IAWlC;;;;OAIG;IACI,SAAS,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI;IASvD;;;;OAIG;IACI,mBAAmB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI;IAShE;;;;OAIG;IACI,kBAAkB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI;IAS9D;;;OAGG;IACI,WAAW,CAAC,QAAQ,EAAE,QAAQ;IAwBrC,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,2BAA2B;IAInC,OAAO,CAAC,0BAA0B;IAIlC,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,eAAe;CAMxB"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,KAAK,EAAE,uBAAuB,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AACzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAEvD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAU/C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,aAAa;;IAMxB;;OAEG;IACI,WAAW,EAAE,WAAW,CAAA;IAC/B;;OAEG;IACI,UAAU,EAAE,UAAU,CAAA;IAC7B,OAAO,CAAC,WAAW,CAAC,CAAe;IAEnC;;;;OAIG;gBACS,EAAE,YAAiB,EAAE,WAAW,EAAE,EAAE,uBAAuB;IA+DvE;;;;;;OAMG;IACU,UAAU;IAKvB;;;;;OAKG;IACU,eAAe;IAuC5B;;OAEG;IACH,IAAI,KAAK,cAER;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,GAAG,GAAG,SAAS,CAE/B;IAED;;OAEG;IACH,IAAI,aAAa,WAEhB;IAED;;OAEG;IACH,IAAI,OAAO,YAEV;IAED;;OAEG;IACH,IAAI,OAAO,8BAGV;IAED;;OAEG;IACI,gBAAgB;IAIvB;;;OAGG;IACI,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAiBlE;;OAEG;IACI,oBAAoB,IAAI,MAAM,EAAE;IAIvC;;OAEG;IACI,uBAAuB,CAAC,UAAU,EAAE,MAAM;IAIjD;;OAEG;IACI,kBAAkB,CAAC,QAAQ,EAAE,SAAS;IAI7C;;;;OAIG;IACI,SAAS,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI;IASvD;;;;OAIG;IACI,mBAAmB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI;IAShE;;;OAGG;IACI,WAAW,CAAC,QAAQ,EAAE,QAAQ;IAwBrC,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,2BAA2B;IAInC,OAAO,CAAC,gBAAgB;CAIzB"}