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

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

@@ -1,61 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useAuth = void 0;
-const __1 = require("..");
-/**
- * `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.
- */
-exports.useAuth = __1.AgentHooks.useAuth;

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

@@ -1,19 +0,0 @@
-/**
- * Accesses the current authentication state.
- *
- * @example
- * ```jsx
- * function AuthStateComponent() {
- *   const { authenticated, authenticating, identity, error } = useAuthState();
- *
- *   return (
- *     <div>
- *       {authenticating ? 'Authenticating...' : ''}
- *       {error ? `Error: ${error.message}` : ''}
- *       {authenticated ? `User ${identity?.getPrincipal()} is authenticated.` : 'User is not authenticated.'}
- *     </div>
- *   );
- * }
- * ```
- */
-export declare const useAuthState: () => import("@ic-reactor/core/dist/types").AuthState;

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

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useAuthState = void 0;
-const __1 = require("..");
-/**
- * Accesses the current authentication state.
- *
- * @example
- * ```jsx
- * function AuthStateComponent() {
- *   const { authenticated, authenticating, identity, error } = useAuthState();
- *
- *   return (
- *     <div>
- *       {authenticating ? 'Authenticating...' : ''}
- *       {error ? `Error: ${error.message}` : ''}
- *       {authenticated ? `User ${identity?.getPrincipal()} is authenticated.` : 'User is not authenticated.'}
- *     </div>
- *   );
- * }
- * ```
- */
-exports.useAuthState = __1.AgentHooks.useAuthState;

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

@@ -1,17 +0,0 @@
-/**
- * Accesses the user's principal.
- *
- * @example
- * ```jsx
- * function UserPrincipalComponent() {
- *   const userPrincipal = useUserPrincipal();
- *
- *   return (
- *     <div>
- *       {userPrincipal ? `User principal: ${userPrincipal}` : 'User principal not found.'}
- *     </div>
- *   );
- * }
- * ```
- */
-export declare const useUserPrincipal: () => import("@dfinity/principal").Principal | undefined;

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

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useUserPrincipal = void 0;
-const __1 = require("..");
-/**
- * Accesses the user's principal.
- *
- * @example
- * ```jsx
- * function UserPrincipalComponent() {
- *   const userPrincipal = useUserPrincipal();
- *
- *   return (
- *     <div>
- *       {userPrincipal ? `User principal: ${userPrincipal}` : 'User principal not found.'}
- *     </div>
- *   );
- * }
- * ```
- */
-exports.useUserPrincipal = __1.AgentHooks.useUserPrincipal;

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

@@ -1,12 +0,0 @@
-import { createAgentContext } from "./create";
-export { createAgentContext };
-/** @ignore */
-export declare const AgentHooks: import("./types").CreateAgentContextReturnType;
-export declare const AgentContext: import("react").Context<import("./types").AgentContext | null>;
-export * from "./provider";
-export * from "./hooks/useAgent";
-export * from "./hooks/useAgentState";
-export * from "./hooks/useAgentManager";
-export * from "./hooks/useAuth";
-export * from "./hooks/useAuthState";
-export * from "./hooks/useUserPrincipal";

package/dist/context/agent/index.js

@@ -1,29 +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.AgentContext = exports.AgentHooks = exports.createAgentContext = void 0;
-const create_1 = require("./create");
-Object.defineProperty(exports, "createAgentContext", { enumerable: true, get: function () { return create_1.createAgentContext; } });
-/** @ignore */
-exports.AgentHooks = (0, create_1.createAgentContext)();
-exports.AgentContext = exports.AgentHooks.AgentContext;
-__exportStar(require("./provider"), exports);
-__exportStar(require("./hooks/useAgent"), exports);
-__exportStar(require("./hooks/useAgentState"), exports);
-__exportStar(require("./hooks/useAgentManager"), exports);
-__exportStar(require("./hooks/useAuth"), exports);
-__exportStar(require("./hooks/useAuthState"), exports);
-__exportStar(require("./hooks/useUserPrincipal"), exports);

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

@@ -1,28 +0,0 @@
-/**
- * `AgentProvider` is a React functional component that serves as a context provider for IC agent and authentication hooks.
- * It enables any child components to access and use the agent and authentication functionalities seamlessly.
- *
- * The provider encapsulates the logic for initializing and managing an agent manager instance, which is then used to
- * create various hooks related to agent operations and authentication processes. These hooks are made available to all
- * child components through the context, facilitating a centralized and efficient way to interact with the Internet Computer (IC) blockchain.
- *
- * @param children - Child components that can consume the context.
- * @param agentManager - An optional `AgentManager` instance to be used by the provider. If not provided, a new instance
- *                       will be created based on the provided options combined with default configuration.
- * @param options - Configuration options for the `AgentManager`. These options are merged with any default configurations
- *                  specified during the context creation and can include custom settings for the agent, such as identity,
- *                  host URL, etc.
- *
- * @example
- * Wrap your App with `AgentProvider` to provide all child components access to IC agent and authentication hooks.
- *
- * ```jsx
- * <AgentProvider>
- *   <App />
- * </AgentProvider>
- * ```
- *
- * Inside `App` or any of its children, you can use the hooks provided through the context to interact with the IC,
- * manage authentication, and perform other agent-related tasks.
- */
-export declare const AgentProvider: import("react").FC<import("./types").AgentProviderProps>;

package/dist/context/agent/provider.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AgentProvider = void 0;
-const _1 = require(".");
-/**
- * `AgentProvider` is a React functional component that serves as a context provider for IC agent and authentication hooks.
- * It enables any child components to access and use the agent and authentication functionalities seamlessly.
- *
- * The provider encapsulates the logic for initializing and managing an agent manager instance, which is then used to
- * create various hooks related to agent operations and authentication processes. These hooks are made available to all
- * child components through the context, facilitating a centralized and efficient way to interact with the Internet Computer (IC) blockchain.
- *
- * @param children - Child components that can consume the context.
- * @param agentManager - An optional `AgentManager` instance to be used by the provider. If not provided, a new instance
- *                       will be created based on the provided options combined with default configuration.
- * @param options - Configuration options for the `AgentManager`. These options are merged with any default configurations
- *                  specified during the context creation and can include custom settings for the agent, such as identity,
- *                  host URL, etc.
- *
- * @example
- * Wrap your App with `AgentProvider` to provide all child components access to IC agent and authentication hooks.
- *
- * ```jsx
- * <AgentProvider>
- *   <App />
- * </AgentProvider>
- * ```
- *
- * Inside `App` or any of its children, you can use the hooks provided through the context to interact with the IC,
- * manage authentication, and perform other agent-related tasks.
- */
-exports.AgentProvider = _1.AgentHooks.AgentProvider;

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

@@ -1,17 +0,0 @@
-import type { PropsWithChildren } from "react";
-import type { AgentHooksReturnType, AuthHooksReturnType, AgentManager, AgentManagerParameters } from "../../types";
-export interface AgentContext extends AgentHooksReturnType, AuthHooksReturnType {
-    agentManager: AgentManager;
-}
-export interface CreateAgentCotextParameters extends AgentManagerParameters {
-    withProcessEnv?: boolean;
-    disableAuthenticateOnMount?: boolean;
-}
-export interface CreateAgentContextReturnType extends AgentHooksReturnType, AuthHooksReturnType {
-    useAgentManager: () => AgentManager;
-    AgentProvider: React.FC<AgentProviderProps>;
-    AgentContext: React.Context<AgentContext | null>;
-}
-export interface AgentProviderProps extends PropsWithChildren, CreateAgentCotextParameters {
-    agentManager?: AgentManager;
-}

package/dist/context/agent/types.js

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

package/dist/core.d.ts

@@ -1 +0,0 @@
-export { createReactorStore, createActorManager, createAgentManager, createCandidAdapter, createReactorCore, } from "@ic-reactor/core";

package/dist/core.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createReactorCore = exports.createCandidAdapter = exports.createAgentManager = exports.createActorManager = exports.createReactorStore = void 0;
-var core_1 = require("@ic-reactor/core");
-Object.defineProperty(exports, "createReactorStore", { enumerable: true, get: function () { return core_1.createReactorStore; } });
-Object.defineProperty(exports, "createActorManager", { enumerable: true, get: function () { return core_1.createActorManager; } });
-Object.defineProperty(exports, "createAgentManager", { enumerable: true, get: function () { return core_1.createAgentManager; } });
-Object.defineProperty(exports, "createCandidAdapter", { enumerable: true, get: function () { return core_1.createCandidAdapter; } });
-Object.defineProperty(exports, "createReactorCore", { enumerable: true, get: function () { return core_1.createReactorCore; } });

package/dist/createReactor.d.ts

@@ -1,49 +0,0 @@
-import type { BaseActor, CreateReactorParameters, CreateReactorReturnType } from "./types";
-/**
- * Initializes and configures the reactor environment for interacting with the Internet Computer (IC) blockchain within a React application.
- * It encapsulates the creation of actors, authentication, and agent management, offering a streamlined interface for blockchain interactions.
- *
- * @param config Configuration {@link CreateReactorParameters} for the reactor, including:
- *  - `withProcessEnv` (optional): Specifies whether to use process environment variables to determine if the environment is local or development. Defaults to false.
- *  - `withLocalEnv` (optional): Indicates if the current environment is local or development, influencing the agent and actor behavior. Useful for testing or development.
- *  - `port` (optional): Port number for the local or development environment.
- *
- * @returns An object containing {@link CreateReactorReturnType} hooks and utilities:
- *  - {@link getAgent} - Returns the current agent instance.
- *  - {@link getVisitFunction} - Returns the visit function for the actor.
- *  - {@link useQueryCall} - A hook for querying actor methods.
- *  - {@link useUpdateCall} - A hook for updating actor methods.
- *  - {@link useAuth} - A hook for managing authentication and user principal.
- *  - {@link useActor} - A hook for managing actors and their methods.
- *  - {@link useActorManager} - A hook for managing actor manager and its methods.
- *  - {@link useAgentManager} - A hook for managing agent manager and its methods.
- *  - {@link initialize} - A function to initialize the actor manager if not initialized.
- *  - {@link useActorState} - A hook for managing actor state.
- *  - {@link useAgent} - A hook for managing agent and its methods.
- *  - {@link useAuthState} - A hook for managing authentication state.
- *  - {@link useAgentState} - A hook for managing agent state.
- *  - {@link useUserPrincipal} - A hook for managing user principal.
- *  - {@link useVisitMethod} - A hook for visiting actor methods.
- *
- * @example
- * ```typescript
- * import { createReactor } from "@ic-reactor/react";
- * import type { CreateReactorParameters } from "@ic-reactor/react/dist/types";
- * import { canisterId, idlFactory, yourActor } from "./declaration/yourActor"
- *
- * const config: CreateReactorParameters = {
- *   canisterId,
- *   idlFactory,
- *   host: "https://localhost:8000", // IC network host         |
- *   withLocalEnv: true, // Set true for local network          | one of these
- *   withProcessEnv: true, // Use process.env to determine host |
- *   port: 8000, // Port number for local network
- * };
- *
- * export type YourActor = typeof yourActor;
- *
- * export const { useAuth, useQueryCall, useUpdateCall } = createReactor<YourActor>(config);
- * // Now you can use the returned hooks in your React components
- * ```
- */
-export declare const createReactor: <A = BaseActor>(config: CreateReactorParameters) => CreateReactorReturnType<A>;

package/dist/createReactor.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createReactor = void 0;
-const core_1 = require("@ic-reactor/core");
-const helpers_1 = require("./helpers");
-/**
- * Initializes and configures the reactor environment for interacting with the Internet Computer (IC) blockchain within a React application.
- * It encapsulates the creation of actors, authentication, and agent management, offering a streamlined interface for blockchain interactions.
- *
- * @param config Configuration {@link CreateReactorParameters} for the reactor, including:
- *  - `withProcessEnv` (optional): Specifies whether to use process environment variables to determine if the environment is local or development. Defaults to false.
- *  - `withLocalEnv` (optional): Indicates if the current environment is local or development, influencing the agent and actor behavior. Useful for testing or development.
- *  - `port` (optional): Port number for the local or development environment.
- *
- * @returns An object containing {@link CreateReactorReturnType} hooks and utilities:
- *  - {@link getAgent} - Returns the current agent instance.
- *  - {@link getVisitFunction} - Returns the visit function for the actor.
- *  - {@link useQueryCall} - A hook for querying actor methods.
- *  - {@link useUpdateCall} - A hook for updating actor methods.
- *  - {@link useAuth} - A hook for managing authentication and user principal.
- *  - {@link useActor} - A hook for managing actors and their methods.
- *  - {@link useActorManager} - A hook for managing actor manager and its methods.
- *  - {@link useAgentManager} - A hook for managing agent manager and its methods.
- *  - {@link initialize} - A function to initialize the actor manager if not initialized.
- *  - {@link useActorState} - A hook for managing actor state.
- *  - {@link useAgent} - A hook for managing agent and its methods.
- *  - {@link useAuthState} - A hook for managing authentication state.
- *  - {@link useAgentState} - A hook for managing agent state.
- *  - {@link useUserPrincipal} - A hook for managing user principal.
- *  - {@link useVisitMethod} - A hook for visiting actor methods.
- *
- * @example
- * ```typescript
- * import { createReactor } from "@ic-reactor/react";
- * import type { CreateReactorParameters } from "@ic-reactor/react/dist/types";
- * import { canisterId, idlFactory, yourActor } from "./declaration/yourActor"
- *
- * const config: CreateReactorParameters = {
- *   canisterId,
- *   idlFactory,
- *   host: "https://localhost:8000", // IC network host         |
- *   withLocalEnv: true, // Set true for local network          | one of these
- *   withProcessEnv: true, // Use process.env to determine host |
- *   port: 8000, // Port number for local network
- * };
- *
- * export type YourActor = typeof yourActor;
- *
- * export const { useAuth, useQueryCall, useUpdateCall } = createReactor<YourActor>(config);
- * // Now you can use the returned hooks in your React components
- * ```
- */
-const createReactor = (config) => {
-    const actorManager = (0, core_1.createReactorStore)(config);
-    const getVisitFunction = () => {
-        return actorManager.visitFunction;
-    };
-    const getAgent = () => {
-        return actorManager.agentManager.getAgent();
-    };
-    return {
-        getAgent,
-        getVisitFunction,
-        ...(0, helpers_1.actorHooks)(actorManager),
-        ...(0, helpers_1.authHooks)(actorManager.agentManager),
-        ...(0, helpers_1.agentHooks)(actorManager.agentManager),
-    };
-};
-exports.createReactor = createReactor;

package/dist/helpers/actorHooks.d.ts

@@ -1,18 +0,0 @@
-import type { ActorHooksReturnType } from "../types";
-import { type ActorManager, type BaseActor } from "@ic-reactor/core/dist/types";
-/**
- * Provides a set of React hooks designed for interacting with actors in an Internet Computer (IC) project using the React framework and Zustand for state management.
- *
- * @param actorManager An instance of ActorManager containing methods and properties to manage actors, including the actorStore, canisterId, visitFunction, callMethod, and initialize function.
- * @returns An object containing several hooks and utility functions for interacting with actors, managing state, and invoking actor methods.
- *
- * Hooks included:
- * - initialize: Function to initialize actor management.
- * - useActorState: Hook for accessing the actor's state including the canister ID.
- * - useVisitMethod: Hook for memoizing a method visit service for a given actor method name.
- * - useQueryCall: Hook specifically designed for query calls to actors with features such as automatic refetching on mount and at specified intervals.
- * - useUpdateCall: Hook specifically designed for update calls to actors with features such as error handling and loading state management.
- *
- * Each hook is designed to simplify the process of interacting with actors in IC projects by abstracting away the complexity of state management, error handling, and method invocation.
- */
-export declare const actorHooks: <A = BaseActor>(actorManager: ActorManager<A>) => ActorHooksReturnType<A>;