@ic-reactor/core 3.3.0 → 3.4.0

package/src/types/client.ts

@@ -1,5 +1,5 @@
 import type { HttpAgent, HttpAgentOptions, Identity } from "@icp-sdk/core/agent"
-import type { AuthClient } from "@icp-sdk/auth/client"
+import type { Principal } from "@icp-sdk/core/principal"
 import type { QueryClient } from "@tanstack/query-core"
 
 /**
@@ -11,6 +11,86 @@ import type { QueryClient } from "@tanstack/query-core"
  * @property {boolean} [withLocalEnv] - If true, configures the agent for a local environment.
  * @property {boolean} [withProcessEnv] - If true, auto-configures the agent based on process.env settings.
  */
+export interface SignedIdentityAttributes {
+  data: Uint8Array
+  signature: Uint8Array
+}
+
+export interface IdentityAttributeRequest {
+  keys: string[]
+  nonce: Uint8Array
+}
+
+export interface IdentityAttributeValues {
+  email?: string
+  name?: string
+  verified_email?: string
+  [key: string]: string | undefined
+}
+
+export interface IdentityAttributeResult {
+  principal: string
+  requestedKeys: string[]
+  signedAttributes: SignedIdentityAttributes
+  decodedAttributes: IdentityAttributeValues
+  completedAt: string
+}
+
+type IdentityAttributeOpenIdProviderAlias = "google" | "apple" | "microsoft"
+
+export type IdentityAttributeOpenIdProvider =
+  | IdentityAttributeOpenIdProviderAlias
+  | (string & {})
+
+export interface ClientManagerAuthClientOptions {
+  identityProvider?: string | URL
+  windowOpenerFeatures?: string
+  openIdProvider?: IdentityAttributeOpenIdProvider
+}
+
+export interface AuthClientSignInOptions {
+  maxTimeToLive?: bigint
+  targets?: Principal[]
+}
+
+export interface ClientManagerSignInOptions
+  extends AuthClientSignInOptions, ClientManagerAuthClientOptions {
+  onSuccess?: () => void | Promise<void>
+  onError?: (error?: string) => void | Promise<void>
+}
+
+export interface RequestIdentityAttributesParameters {
+  keys: string[]
+  nonce: Uint8Array
+  identityProvider?: string | URL
+  openIdProvider?: IdentityAttributeOpenIdProvider
+  windowOpenerFeatures?: string
+  signIn?: boolean
+  maxTimeToLive?: bigint
+  targets?: Principal[]
+}
+
+export interface RequestOpenIdIdentityAttributesParameters {
+  nonce: Uint8Array
+  openIdProvider: IdentityAttributeOpenIdProvider
+  keys: string[]
+  identityProvider?: string | URL
+  windowOpenerFeatures?: string
+  signIn?: boolean
+  maxTimeToLive?: bigint
+  targets?: Principal[]
+}
+
+export interface AuthClientLike {
+  getIdentity(): Promise<Identity> | Identity
+  isAuthenticated(): Promise<boolean> | boolean
+  signIn(options?: AuthClientSignInOptions): Promise<Identity>
+  logout(options?: { returnTo?: string }): Promise<void>
+  requestAttributes(
+    params: IdentityAttributeRequest
+  ): Promise<SignedIdentityAttributes>
+}
+
 export interface ClientManagerParameters {
   /**
    * The TanStack QueryClient used for caching and state management.
@@ -39,7 +119,7 @@ export interface ClientManagerParameters {
    * This is useful for environments where dynamic imports are not supported or
    * when you want to share an AuthClient instance across multiple managers.
    */
-  authClient?: AuthClient
+  authClient?: AuthClientLike
   /**
    * **EXPERIMENTAL** - If true, uses the canister environment from `@icp-sdk/core/agent/canister-env`
    * to automatically configure the agent host and root key based on the `ic_env` cookie.