@ic-reactor/react 2.0.0 → 3.0.0-beta.1

package/dist/context/adapter/create.js

@@ -1,102 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAdapterContext = createAdapterContext;
-const react_1 = __importDefault(require("react"));
-const agent_1 = require("../agent");
-const core_1 = require("@ic-reactor/core");
-function createAdapterContext(config = {}) {
-    const { withParser: _withParser, didjsCanisterId: _didjsCanisterId, ...defaultConfig } = config;
-    const CandidAdapterContext = react_1.default.createContext(null);
-    const useCandidAdapter = () => {
-        const context = react_1.default.useContext(CandidAdapterContext);
-        if (!context) {
-            throw new Error("Actor hooks must be used within a ActorProvider");
-        }
-        return context;
-    };
-    const useCandidEvaluation = () => {
-        const [state, setState] = react_1.default.useState({
-            fetching: true,
-            isFetching: true,
-            fetchError: null,
-        });
-        const candidAdapter = useCandidAdapter();
-        const validateCandid = react_1.default.useCallback((candidString) => {
-            setState({
-                fetchError: null,
-                fetching: false,
-                isFetching: false,
-            });
-            try {
-                return candidAdapter.validateIDL(candidString);
-            }
-            catch (err) {
-                setState({
-                    fetchError: `Error validating Candid definition, ${err}`,
-                    fetching: false,
-                    isFetching: false,
-                });
-                return false;
-            }
-        }, []);
-        const isCandidValid = react_1.default.useCallback((candidString) => {
-            return validateCandid(candidString) !== false;
-        }, [validateCandid]);
-        const evaluateCandid = react_1.default.useCallback(async (candidString) => {
-            setState({
-                fetchError: null,
-                fetching: true,
-                isFetching: true,
-            });
-            try {
-                const definition = await candidAdapter.evaluateCandidDefinition(candidString);
-                if (typeof definition?.idlFactory !== "function") {
-                    throw new Error("No Function found in Candid definition!");
-                }
-                setState({
-                    fetchError: null,
-                    fetching: false,
-                    isFetching: false,
-                });
-                return definition.idlFactory;
-            }
-            catch (err) {
-                setState({
-                    fetchError: `Error evaluating Candid definition, ${err}`,
-                    fetching: false,
-                    isFetching: false,
-                });
-                return undefined;
-            }
-        }, []);
-        return { evaluateCandid, isCandidValid, validateCandid, ...state };
-    };
-    const CandidAdapterProvider = ({ children, withParser = _withParser, loadingComponent = react_1.default.createElement("div", null, "Loading Parser..."), didjsCanisterId = _didjsCanisterId, ...restConfig }) => {
-        const config = react_1.default.useMemo(() => ({
-            ...defaultConfig,
-            ...restConfig,
-        }), [defaultConfig, restConfig]);
-        const [initalized, setInitialized] = react_1.default.useState(false);
-        const agentManager = (0, agent_1.useAgentManager)();
-        const candidAdapter = react_1.default.useMemo(() => (0, core_1.createCandidAdapter)({ agentManager, didjsCanisterId, ...config }), [didjsCanisterId, agentManager]);
-        react_1.default.useEffect(() => {
-            if (withParser) {
-                candidAdapter.initializeParser().then(() => setInitialized(true));
-            }
-            else {
-                setInitialized(true);
-            }
-        }, []);
-        return (react_1.default.createElement(CandidAdapterContext.Provider, { value: candidAdapter }, initalized ? children : loadingComponent));
-    };
-    CandidAdapterProvider.displayName = "CandidAdapterProvider";
-    return {
-        CandidAdapterContext,
-        CandidAdapterProvider,
-        useCandidEvaluation,
-        useCandidAdapter,
-    };
-}

package/dist/context/adapter/hooks/useCandidAdapter.d.ts

@@ -1,23 +0,0 @@
-/**
- * Accesses the `CandidAdapter` to download the actor's Candid interface.
- *
- * @param config - `UseCandidAdapterParams` The configuration object.
- * @returns The `CandidAdapter` instance.
- *
- * @example
- * ```jsx
- * function CandidAdapterComponent() {
- *   const candidAdapter = useCandidAdapter();
- *
- *   const getActor = async () => {
- *      const { idlFactory } = await candidAdapter.getCandidDefinition(canisterId)
- *      console.log(idlFactory)
- *   }
- *
- *   return (
- *       <button onClick={getActor}>Get Actor</button>
- *   );
- * }
- *```
- */
-export declare const useCandidAdapter: () => import("@ic-reactor/core/dist/classes").CandidAdapter;

package/dist/context/adapter/hooks/useCandidAdapter.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useCandidAdapter = void 0;
-const __1 = require("..");
-/**
- * Accesses the `CandidAdapter` to download the actor's Candid interface.
- *
- * @param config - `UseCandidAdapterParams` The configuration object.
- * @returns The `CandidAdapter` instance.
- *
- * @example
- * ```jsx
- * function CandidAdapterComponent() {
- *   const candidAdapter = useCandidAdapter();
- *
- *   const getActor = async () => {
- *      const { idlFactory } = await candidAdapter.getCandidDefinition(canisterId)
- *      console.log(idlFactory)
- *   }
- *
- *   return (
- *       <button onClick={getActor}>Get Actor</button>
- *   );
- * }
- *```
- */
-exports.useCandidAdapter = __1.AdapterHooks.useCandidAdapter;

package/dist/context/adapter/hooks/useCandidEvaluation.d.ts

@@ -1,5 +0,0 @@
-/**
- * Accesses the `CandidEvaluation` function to evaluate the actor's Candid interface from a string
- * into an `idlFactory`.
- */
-export declare const useCandidEvaluation: () => import("../types").UseCandidEvaluationReturnType;

package/dist/context/adapter/hooks/useCandidEvaluation.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useCandidEvaluation = void 0;
-const __1 = require("..");
-/**
- * Accesses the `CandidEvaluation` function to evaluate the actor's Candid interface from a string
- * into an `idlFactory`.
- */
-exports.useCandidEvaluation = __1.AdapterHooks.useCandidEvaluation;

package/dist/context/adapter/index.d.ts

@@ -1,6 +0,0 @@
-/** @ignore */
-export declare const AdapterHooks: import("./types").CreateCandidAdapterContextReturnType;
-export declare const CandidAdapterContext: import("react").Context<import("@ic-reactor/core/dist/classes").CandidAdapter | null>;
-export * from "./provider";
-export * from "./hooks/useCandidAdapter";
-export * from "./hooks/useCandidEvaluation";

package/dist/context/adapter/index.js

@@ -1,24 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CandidAdapterContext = exports.AdapterHooks = void 0;
-const create_1 = require("./create");
-/** @ignore */
-exports.AdapterHooks = (0, create_1.createAdapterContext)();
-exports.CandidAdapterContext = exports.AdapterHooks.CandidAdapterContext;
-__exportStar(require("./provider"), exports);
-__exportStar(require("./hooks/useCandidAdapter"), exports);
-__exportStar(require("./hooks/useCandidEvaluation"), exports);

package/dist/context/adapter/provider.d.ts

@@ -1,23 +0,0 @@
-/**
- * `CandidAdapterProvider` is a React component that provides the CandidAdapter to its children.
- * It initializes the CandidAdapter with the provided options and makes it available to all children.
- *
- * @example
- * ```tsx
- * import { AgentProvider, CandidAdapterProvider, ActorProvider } from "@ic-reactor/react"
- *
- * const App = () => (
- *  <AgentProvider>
- *    <CandidAdapterProvider>
- *       Your Actors here, it will able to fetch the Candid interface
- *       you dont need to pass the idlFactory to the Actor component
- *       e.g.
- *      <ActorProvider canisterId="ryjl3-tyaaa-aaaaa-aaaba-cai" />
- *    </CandidAdapterProvider>
- *  </AgentProvider>
- * )
- *
- * export default App
- * ```
- */
-export declare const CandidAdapterProvider: import("react").FC<import("./types").CandidAdapterProviderProps>;

package/dist/context/adapter/provider.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CandidAdapterProvider = void 0;
-const _1 = require(".");
-/**
- * `CandidAdapterProvider` is a React component that provides the CandidAdapter to its children.
- * It initializes the CandidAdapter with the provided options and makes it available to all children.
- *
- * @example
- * ```tsx
- * import { AgentProvider, CandidAdapterProvider, ActorProvider } from "@ic-reactor/react"
- *
- * const App = () => (
- *  <AgentProvider>
- *    <CandidAdapterProvider>
- *       Your Actors here, it will able to fetch the Candid interface
- *       you dont need to pass the idlFactory to the Actor component
- *       e.g.
- *      <ActorProvider canisterId="ryjl3-tyaaa-aaaaa-aaaba-cai" />
- *    </CandidAdapterProvider>
- *  </AgentProvider>
- * )
- *
- * export default App
- * ```
- */
-exports.CandidAdapterProvider = _1.AdapterHooks.CandidAdapterProvider;

package/dist/context/adapter/types.d.ts

@@ -1,52 +0,0 @@
-import type { PropsWithChildren } from "react";
-import type { IDL } from "@dfinity/candid";
-import { CandidAdapter } from "@ic-reactor/core/dist/classes";
-import { CandidAdapterParameters } from "../../types";
-export type CandidAdapterContextType = CandidAdapter;
-export interface CandidAdapterProviderProps extends PropsWithChildren, CandidAdapterParameters {
-    withParser?: boolean;
-    loadingComponent?: React.ReactNode;
-}
-export interface CreateCandidAdapterContextParameters extends CandidAdapterParameters {
-    withParser?: boolean;
-}
-export interface UseCandidEvaluationReturnType {
-    /**
-     * The error message encountered during the fetch operation, or `null` if no error occurred.
-     */
-    fetchError: string | null;
-    /**
-     * @deprecated Use `isFetching` instead.
-     * Indicates whether a fetch operation is currently in progress.
-     */
-    fetching: boolean;
-    /**
-     * Indicates whether a fetch operation is currently in progress.
-     */
-    isFetching: boolean;
-    /**
-     * @deprecated Use `isCandidValid` instead.
-     * Validates the provided Candid interface definition string.
-     * @param candidString - The Candid definition to validate.
-     * @returns `true` if the string is valid, `false` otherwise.
-     */
-    validateCandid: (candidString: string) => boolean | undefined;
-    /**
-     * Validates the provided Candid interface definition string.
-     * @param candidString - The Candid definition to validate.
-     * @returns `true` if valid, `false` otherwise.
-     */
-    isCandidValid: (candidString: string) => boolean | undefined;
-    /**
-     * Evaluates the provided Candid interface definition string.
-     * @param candidString - The Candid definition to evaluate.
-     * @returns A promise resolving to the corresponding InterfaceFactory if the evaluation succeeds, otherwise `undefined`.
-     */
-    evaluateCandid: (candidString: string) => Promise<IDL.InterfaceFactory | undefined>;
-}
-export interface CreateCandidAdapterContextReturnType {
-    CandidAdapterContext: React.Context<CandidAdapterContextType | null>;
-    CandidAdapterProvider: React.FC<CandidAdapterProviderProps>;
-    useCandidEvaluation: () => UseCandidEvaluationReturnType;
-    useCandidAdapter: () => CandidAdapter;
-}

package/dist/context/adapter/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/context/agent/create.d.ts

@@ -1,74 +0,0 @@
-import type { CreateAgentContextReturnType, CreateAgentCotextParameters } from "./types";
-/**
- * Creates a React context for managing IC agent and authentication states, providing hooks for interacting with the IC blockchain.
- * This function initializes an `AgentContext` with a set of utilities and hooks based on the provided agent configuration.
- *
- * @param config A partial configuration object {@link CreateAgentCotextParameters}, allowing customization of the agent's behavior.
- *
- * @returns
- * An object containing the {@link AgentProvider} component and various hooks for interacting with the agent and authentication state.
- * The {@link AgentProvider} component is a React context provider that should wrap your app or components needing access to agent functionalities.
- *
- * Usage:
- * - {@link AgentProvider}: React component to provide agent context to your application.
- * - {@link useAgent}, {@link useAuth}, {@link useAuthState},
- *   {@link useAgentState}, {@link useAgentManager}, {@link useUserPrincipal}:
- *  Hooks extracted from the created context for managing agent and authentication state within components.
- *
- * @example
- * ```tsx
- * // agent.ts
- * import { createAgentContext } from "@ic-reactor/react";
- * import { CreateAgentCotextParameters } from "@ic-reactor/react/dist/types";
- *
- * // Optional: Define custom agent configuration
- * const agentConfig: CreateAgentCotextParameters = {
- *   host: "https://localhost:8000",
- *   // or
- *   // withLocalEnv: true,
- *   // port: 8000,
- * };
- *
- * export const {
- *   AgentProvider,
- *   useAgent,
- *   useAuth,
- *   useAuthState,
- *   useAgentState,
- *   useAgentManager,
- *   useUserPrincipal,
- * } = createAgentContext(agentConfig);
- *```
- * Now you can use the returned hooks in your React components
- *
- * ```tsx
- * // App.tsx
- * import React from 'react';
- * import { AgentProvider } from './agent';
- *
- * const App = () => (
- *   <AgentProvider>
- *     <Login />
- *     <YourActor />
- *   </AgentProvider>
- * );
- *
- * const Login = () => {
- *  const { login } = useAuth()
- *  const principal = useUserPrincipal()
- *
- *  return (
- *    <div>
- *      <button onClick={() => login()}>Login</button>
- *      <p>User: {principal?.toText()}</p>
- *    </div>
- *  )
- * };
- *
- * ```
- *
- * This setup allows you to use the agent and authentication hooks within
- * the components wrapped by {@link AgentProvider}, facilitating interaction
- * with the Internet Computer blockchain.
- */
-export declare function createAgentContext(config?: CreateAgentCotextParameters): CreateAgentContextReturnType;

package/dist/context/agent/create.js

@@ -1,104 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAgentContext = createAgentContext;
-const react_1 = __importDefault(require("react"));
-const core_1 = require("@ic-reactor/core");
-const agentHooks_1 = require("../../helpers/agentHooks");
-const authHooks_1 = require("../../helpers/authHooks");
-const extractAgentContext_1 = require("../../helpers/extractAgentContext");
-/**
- * Creates a React context for managing IC agent and authentication states, providing hooks for interacting with the IC blockchain.
- * This function initializes an `AgentContext` with a set of utilities and hooks based on the provided agent configuration.
- *
- * @param config A partial configuration object {@link CreateAgentCotextParameters}, allowing customization of the agent's behavior.
- *
- * @returns
- * An object containing the {@link AgentProvider} component and various hooks for interacting with the agent and authentication state.
- * The {@link AgentProvider} component is a React context provider that should wrap your app or components needing access to agent functionalities.
- *
- * Usage:
- * - {@link AgentProvider}: React component to provide agent context to your application.
- * - {@link useAgent}, {@link useAuth}, {@link useAuthState},
- *   {@link useAgentState}, {@link useAgentManager}, {@link useUserPrincipal}:
- *  Hooks extracted from the created context for managing agent and authentication state within components.
- *
- * @example
- * ```tsx
- * // agent.ts
- * import { createAgentContext } from "@ic-reactor/react";
- * import { CreateAgentCotextParameters } from "@ic-reactor/react/dist/types";
- *
- * // Optional: Define custom agent configuration
- * const agentConfig: CreateAgentCotextParameters = {
- *   host: "https://localhost:8000",
- *   // or
- *   // withLocalEnv: true,
- *   // port: 8000,
- * };
- *
- * export const {
- *   AgentProvider,
- *   useAgent,
- *   useAuth,
- *   useAuthState,
- *   useAgentState,
- *   useAgentManager,
- *   useUserPrincipal,
- * } = createAgentContext(agentConfig);
- *```
- * Now you can use the returned hooks in your React components
- *
- * ```tsx
- * // App.tsx
- * import React from 'react';
- * import { AgentProvider } from './agent';
- *
- * const App = () => (
- *   <AgentProvider>
- *     <Login />
- *     <YourActor />
- *   </AgentProvider>
- * );
- *
- * const Login = () => {
- *  const { login } = useAuth()
- *  const principal = useUserPrincipal()
- *
- *  return (
- *    <div>
- *      <button onClick={() => login()}>Login</button>
- *      <p>User: {principal?.toText()}</p>
- *    </div>
- *  )
- * };
- *
- * ```
- *
- * This setup allows you to use the agent and authentication hooks within
- * the components wrapped by {@link AgentProvider}, facilitating interaction
- * with the Internet Computer blockchain.
- */
-function createAgentContext(config = {}) {
-    const { disableAuthenticateOnMount: defaultDisable, ...contextOptions } = config;
-    const AgentContext = react_1.default.createContext(null);
-    const AgentProvider = ({ children, agentManager: mybeAgentManager, disableAuthenticateOnMount = defaultDisable ?? false, ...options }) => {
-        const hooks = react_1.default.useMemo(() => {
-            const agentManager = mybeAgentManager ??
-                (0, core_1.createAgentManager)({ ...options, ...contextOptions });
-            if (!disableAuthenticateOnMount) {
-                agentManager.authenticate();
-            }
-            return {
-                ...(0, agentHooks_1.agentHooks)(agentManager),
-                ...(0, authHooks_1.authHooks)(agentManager),
-                agentManager,
-            };
-        }, []);
-        return (react_1.default.createElement(AgentContext.Provider, { value: hooks }, children));
-    };
-    AgentProvider.displayName = "AgentProvider";
-    return { AgentContext, AgentProvider, ...(0, extractAgentContext_1.extractAgentContext)(AgentContext) };
-}

package/dist/context/agent/hooks/useAgent.d.ts

@@ -1,14 +0,0 @@
-/**
- * Accesses the current agent instance.
- *
- * @example
- *```jsx
- *  function AgentComponent() {
- *    const agent = useAgent();
- *
- *    // Use agent for interacting with the Internet Computer.
- *    return <div>{agent.isLocal() ? 'Local' : 'Remote'}</div>;
- *  }
- *```
- */
-export declare const useAgent: () => import("@dfinity/agent").HttpAgent | undefined;

package/dist/context/agent/hooks/useAgent.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useAgent = void 0;
-const __1 = require("..");
-/**
- * Accesses the current agent instance.
- *
- * @example
- *```jsx
- *  function AgentComponent() {
- *    const agent = useAgent();
- *
- *    // Use agent for interacting with the Internet Computer.
- *    return <div>{agent.isLocal() ? 'Local' : 'Remote'}</div>;
- *  }
- *```
- */
-exports.useAgent = __1.AgentHooks.useAgent;

package/dist/context/agent/hooks/useAgentManager.d.ts

@@ -1,14 +0,0 @@
-/**
- * Accesses the `AgentManager` instance for managing agent configurations and state.
- *
- * @example
- *```jsx
- *  function AgentManagerComponent() {
- *    const agentManager = useAgentManager();
- *
- *    // Use agentManager for managing agent configurations, etc.
- *    return <div>Agent Manager ready.</div>;
- *  }
- *```
- */
-export declare const useAgentManager: () => import("@ic-reactor/core/dist/types").AgentManager;

package/dist/context/agent/hooks/useAgentManager.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useAgentManager = void 0;
-const __1 = require("..");
-/**
- * Accesses the `AgentManager` instance for managing agent configurations and state.
- *
- * @example
- *```jsx
- *  function AgentManagerComponent() {
- *    const agentManager = useAgentManager();
- *
- *    // Use agentManager for managing agent configurations, etc.
- *    return <div>Agent Manager ready.</div>;
- *  }
- *```
- */
-exports.useAgentManager = __1.AgentHooks.useAgentManager;

package/dist/context/agent/hooks/useAgentState.d.ts

@@ -1,21 +0,0 @@
-/**
- * Accesses the current state of the agent.
- *
- * @example
- * ```jsx
- * function AgentStateComponent() {
- *  const { initialized, initializing } = useAgentState();
- *
- *  return (
- *   <div>
- *    {initialized
- *      ? 'Agent is initialized.'
- *        : initializing
- *        ? 'Agent is initializing...'
- *        : 'Agent is not initialized.'}
- *   </div>
- *  );
- * }
- * ```
- */
-export declare const useAgentState: () => import("@ic-reactor/core/dist/types").AgentState;

package/dist/context/agent/hooks/useAgentState.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useAgentState = void 0;
-const __1 = require("..");
-/**
- * Accesses the current state of the agent.
- *
- * @example
- * ```jsx
- * function AgentStateComponent() {
- *  const { initialized, initializing } = useAgentState();
- *
- *  return (
- *   <div>
- *    {initialized
- *      ? 'Agent is initialized.'
- *        : initializing
- *        ? 'Agent is initializing...'
- *        : 'Agent is not initialized.'}
- *   </div>
- *  );
- * }
- * ```
- */
-exports.useAgentState = __1.AgentHooks.useAgentState;

package/dist/context/agent/hooks/useAuth.d.ts

@@ -1,57 +0,0 @@
-/**
- * `useAuth` is a custom React hook designed to manage authentication processes in applications interacting with the Internet Computer (IC).
- * It encapsulates the logic for logging in, logging out, and maintaining the authentication state, leveraging an authentication client.
- *
- * @param options - An optional object containing the following properties:
- * - `onAuthentication`: Callback function triggered before authentication starts.
- * - `onAuthenticationSuccess`: Callback function triggered on successful authentication, receives the authenticated `Identity`.
- * - `onAuthenticationFailure`: Callback function triggered on authentication failure, receives the error.
- * - `onLogin`: Callback function triggered before the login process starts.
- * - `onLoginSuccess`: Callback function triggered on successful login, receives the user's `Principal`.
- * - `onLoginError`: Callback function triggered on login error, receives the error.
- * - `onLoggedOut`: Callback function triggered after logging out.
- *
- * @returns An object containing the following properties:
- * - `authenticated`: Boolean indicating if the user is currently authenticated.
- * - `authenticating`: Boolean indicating if an authentication process is currently underway.
- * - `identity`: The authenticated user's `Identity`, if available.
- * - `error`: Any error that occurred during the authentication process.
- * - `login`: Function to initiate the login process, optionally accepting `LoginParameters`.
- * - `logout`: Function to log the user out, optionally accepting `LogoutParameters`.
- * - `authenticate`: Function to authenticate the user, internally used by `login` and `logout`.
- * - `loginLoading`: Boolean indicating if a login operation is in progress.
- * - `loginError`: Error object if an error occurred during the login process.
- *
- * Usage:
- * This hook can be used to add authentication functionality to your IC application components, handling user login, logout, and authentication state management seamlessly.
- *
- * Example:
- * ```jsx
- * const YourComponent = () => {
- *   const { login, logout, authenticated, identity, loginError } = useAuth({
- *     onLoginSuccess: (principal) => console.log(`Logged in as ${principal}`),
- *     onLoginError: (error) => console.error(`Login failed: ${error.message}`),
- *   });
- *
- *   if (loginError) {
- *     return <div>Error logging in: {loginError.message}</div>;
- *   }
- *
- *   return (
- *     <div>
- *       {authenticated ? (
- *         <>
- *           <div>Authenticated as {identity.getPrincipal().toText()}</div>
- *           <button onClick={() => logout()}>Logout</button>
- *         </>
- *       ) : (
- *         <button onClick={() => login()}>Login</button>
- *       )}
- *     </div>
- *   );
- * };
- * ```
- *
- * This hook simplifies integrating authentication flows into your IC application, providing hooks for various stages of the authentication process.
- */
-export declare const useAuth: (options?: import("../../../types").UseAuthParameters) => import("../../../types").UseAuthReturnType;