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

package/dist/classes/agent/index.js

@@ -1,218 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AgentManager = void 0;
-/* eslint-disable no-console */
-const agent_1 = require("@dfinity/agent");
-const helper_1 = require("../../utils/helper");
-const auth_client_1 = require("@dfinity/auth-client");
-const constants_1 = require("../../utils/constants");
-const AGENT_INITIAL_STATE = {
-    initialized: false,
-    isInitialized: false,
-    initializing: false,
-    isInitializing: false,
-    error: undefined,
-    network: undefined,
-};
-const AUTH_INITIAL_STATE = {
-    identity: null,
-    authenticating: false,
-    isAuthenticating: false,
-    authenticated: false,
-    isAuthenticated: false,
-    error: undefined,
-};
-class AgentManager {
-    _agent;
-    _auth = null;
-    _subscribers = [];
-    agentStore;
-    authStore;
-    updateAgentState = (newState, action) => {
-        this.agentStore.setState((state) => ({ ...state, ...newState }), false, action);
-    };
-    updateAuthState = (newState, action) => {
-        this.authStore.setState((state) => ({ ...state, ...newState }), false, action);
-    };
-    constructor(options) {
-        const { withDevtools, port = 4943, withLocalEnv, withProcessEnv, initializeOnCreate = true, ...agentOptions } = options || {};
-        if (withProcessEnv) {
-            const processNetwork = (0, helper_1.getProcessEnvNetwork)();
-            agentOptions.host =
-                processNetwork === "ic" ? constants_1.IC_HOST_NETWORK_URI : undefined;
-        }
-        else if (withLocalEnv) {
-            agentOptions.host = `http://127.0.0.1:${port}`;
-        }
-        else {
-            agentOptions.host = agentOptions.host ?? constants_1.IC_HOST_NETWORK_URI;
-        }
-        this.agentStore = (0, helper_1.createStoreWithOptionalDevtools)(AGENT_INITIAL_STATE, {
-            withDevtools,
-            name: "reactor-agent",
-            store: "agent",
-        });
-        this.authStore = (0, helper_1.createStoreWithOptionalDevtools)(AUTH_INITIAL_STATE, {
-            withDevtools,
-            name: "reactor-agent",
-            store: "auth",
-        });
-        this._agent = agent_1.HttpAgent.createSync(agentOptions);
-        if (initializeOnCreate) {
-            this.initializeAgent();
-        }
-    }
-    initializeAgent = async () => {
-        const network = this.getNetwork();
-        this.updateAgentState({
-            initializing: true,
-            isInitializing: true,
-            error: undefined,
-            network,
-        }, "initializing");
-        if (network !== "ic") {
-            try {
-                await this._agent.fetchRootKey();
-            }
-            catch (error) {
-                this.updateAgentState({
-                    error: error,
-                    initializing: false,
-                    isInitializing: false,
-                }, "error");
-            }
-        }
-        this.updateAgentState({
-            initialized: true,
-            isInitialized: true,
-            initializing: false,
-            isInitializing: false,
-        }, "initialized");
-    };
-    subscribeAgent = (callback, initialize = true) => {
-        if (initialize) {
-            callback(this._agent);
-        }
-        this._subscribers.push(callback);
-        return () => this.unsubscribeAgent(callback);
-    };
-    unsubscribeAgent = (callback) => {
-        this._subscribers = this._subscribers.filter((sub) => sub !== callback);
-    };
-    notifySubscribers = async () => {
-        await Promise.all(this._subscribers.map(async (callback) => callback(this._agent)));
-    };
-    updateAgent = async (options) => {
-        const { agent } = options || {};
-        if (agent) {
-            this._agent = agent;
-        }
-        else if (options) {
-            this._agent = agent_1.HttpAgent.createSync(options);
-            await this.initializeAgent();
-        }
-        await this.notifySubscribers();
-    };
-    authenticate = async () => {
-        console.log(`Authenticating on ${this.getNetwork()} network`);
-        this.updateAuthState({ isAuthenticating: true, authenticating: true }, "authenticating");
-        try {
-            this._auth = await auth_client_1.AuthClient.create();
-            const isAuthenticated = await this._auth.isAuthenticated();
-            const identity = this._auth.getIdentity();
-            this._agent.replaceIdentity(identity);
-            this.notifySubscribers();
-            this.updateAuthState({
-                authenticated: isAuthenticated,
-                isAuthenticated,
-                identity,
-                authenticating: false,
-                isAuthenticating: false,
-            }, "authenticated");
-            return identity;
-        }
-        catch (error) {
-            this.updateAuthState({
-                error: error,
-                isAuthenticating: false,
-                authenticating: false,
-            }, "error");
-            throw error;
-        }
-    };
-    login = async (options) => {
-        this.updateAuthState({ isAuthenticating: true, authenticating: true }, "login");
-        if (!this._auth) {
-            await this.authenticate();
-        }
-        if (!this._auth) {
-            throw new Error("Auth client not initialized");
-        }
-        await this._auth.login({
-            identityProvider: this.getIsLocal()
-                ? constants_1.LOCAL_INTERNET_IDENTITY_PROVIDER
-                : constants_1.IC_INTERNET_IDENTITY_PROVIDER,
-            ...options,
-            onSuccess: async (msg) => {
-                await this.authenticate();
-                options?.onSuccess?.(msg);
-            },
-        });
-    };
-    logout = async (options) => {
-        if (!this._auth) {
-            throw new Error("Auth client not initialized");
-        }
-        await this._auth.logout(options);
-        await this.authenticate();
-    };
-    // agent store
-    getAgent = () => {
-        return this._agent;
-    };
-    getAgentHost = () => {
-        return this._agent.host;
-    };
-    getAgentHostName = () => {
-        return this.getAgentHost()?.hostname || "";
-    };
-    getIsLocal = () => {
-        return this.getNetwork() !== "ic";
-    };
-    getNetwork = () => {
-        const hostname = this.getAgentHostName();
-        return (0, helper_1.getNetworkByHostname)(hostname);
-    };
-    getAgentState = () => {
-        return this.agentStore.getState();
-    };
-    // @ts-expect-error: Overrides subscribe method signature
-    subscribeAgentState = (selectorOrListener, listener, options) => {
-        if (listener) {
-            return this.agentStore.subscribe(selectorOrListener, listener, options);
-        }
-        return this.agentStore.subscribe(selectorOrListener);
-    };
-    // auth store
-    getAuthState = () => {
-        return this.authStore.getState();
-    };
-    // @ts-expect-error: Overrides subscribe method signature
-    subscribeAuthState = (selectorOrListener, listener, options) => {
-        if (listener) {
-            return this.authStore.subscribe(selectorOrListener, listener, options);
-        }
-        return this.authStore.subscribe(selectorOrListener);
-    };
-    getAuth = () => {
-        return this._auth;
-    };
-    getIdentity = () => {
-        return this.authStore.getState().identity;
-    };
-    getPrincipal = () => {
-        const identity = this.authStore.getState().identity;
-        return identity ? identity.getPrincipal() : null;
-    };
-}
-exports.AgentManager = AgentManager;

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

@@ -1,87 +0,0 @@
-import type { AgentError, HttpAgent, HttpAgentOptions, Identity } from "@dfinity/agent";
-import type { AuthClient } from "@dfinity/auth-client";
-import type { StoreWithAllMiddleware } from "../../types";
-export { HttpAgentOptions, AuthClient, Identity };
-/**
- * Parameters for configuring an AgentManager instance.
- * Extends the options available in `HttpAgentOptions`.
- *
- * @extends HttpAgentOptions
- *
- * @property {number} [port] - The port number to be used by the agent.
- * @property {boolean} [withLocalEnv] - Whether to include local environment variables.
- * @property {boolean} [withDevtools] - Whether to enable developer tools integration.
- * @property {boolean} [withProcessEnv] - Whether to include process environment variables.
- * @property {boolean} [initializeOnCreate] - Whether to initialize the agent upon creation.
- */
-export interface AgentManagerParameters extends HttpAgentOptions {
-    port?: number;
-    withLocalEnv?: boolean;
-    withDevtools?: boolean;
-    withProcessEnv?: boolean;
-    initializeOnCreate?: boolean;
-}
-/**
- * Represents the state of an agent.
- */
-export interface AgentState {
-    /**
-     * @deprecated Use `isInitialized` instead.
-     * Indicates whether the agent has been initialized.
-     */
-    initialized: boolean;
-    /**
-     * Indicates whether the agent has been initialized.
-     */
-    isInitialized: boolean;
-    /**
-     * @deprecated Use `isInitializing` instead.
-     * Indicates whether the agent is in the process of initializing.
-     */
-    initializing: boolean;
-    /**
-     * Indicates whether the agent is in the process of initializing.
-     */
-    isInitializing: boolean;
-    /**
-     * Represents an error associated with the agent, if any.
-     */
-    error: AgentError | undefined;
-    /**
-     * Represents the network associated with the agent, if any.
-     */
-    network: string | undefined;
-}
-/**
- * Represents the authentication state of an agent.
- */
-export interface AuthState {
-    identity: Identity | null;
-    /**
-     * @deprecated Use `isAuthenticating` instead.
-     * Indicates whether the authentication process is ongoing.
-     */
-    authenticating: boolean;
-    /**
-     * Indicates whether the authentication process is ongoing.
-     */
-    isAuthenticating: boolean;
-    /**
-     * @deprecated Use `isAuthenticated` instead.
-     * Indicates whether the agent is authenticated.
-     */
-    authenticated: boolean;
-    /**
-     * Indicates whether the agent is authenticated.
-     */
-    isAuthenticated: boolean;
-    /**
-     * Represents any error that occurred during authentication.
-     */
-    error: Error | undefined;
-}
-export interface UpdateAgentParameters extends HttpAgentOptions {
-    agent?: HttpAgent;
-}
-export type AgentStore = StoreWithAllMiddleware<AgentState>;
-export type AuthStore = StoreWithAllMiddleware<AuthState>;

package/dist/classes/agent/types.js

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

package/dist/classes/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./actor";
-export * from "./agent";
-export * from "./adapter";

package/dist/classes/index.js

@@ -1,19 +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 });
-__exportStar(require("./actor"), exports);
-__exportStar(require("./agent"), exports);
-__exportStar(require("./adapter"), exports);

package/dist/classes/types.d.ts

@@ -1,15 +0,0 @@
-export * from "./agent/types";
-export * from "./actor/types";
-export * from "./adapter/types";
-import { type StateCreator, type StoreApi, type StoreMutatorIdentifier, type Mutate } from "zustand";
-export type StoreWithMiddleware<T, Mis extends [StoreMutatorIdentifier, unknown][] = [], Mos extends [StoreMutatorIdentifier, unknown][] = []> = StateCreator<T, Mis, Mos>;
-export type StoreApiWithMiddleware<T, Mos extends [StoreMutatorIdentifier, unknown][] = []> = Mutate<StoreApi<T>, Mos>;
-export type WithDevtools = ["zustand/devtools", never];
-export type WithSubscribeSelector = ["zustand/subscribeWithSelector", never];
-export type StoreWithAllMiddleware<T> = StoreApiWithMiddleware<T, [
-    WithDevtools,
-    WithSubscribeSelector
-]>;
-export type StoreWithSubscribeOnly<T> = StoreApiWithMiddleware<T, [
-    WithSubscribeSelector
-]>;

package/dist/classes/types.js

@@ -1,20 +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 });
-// Re-export existing types
-__exportStar(require("./agent/types"), exports);
-__exportStar(require("./actor/types"), exports);
-__exportStar(require("./adapter/types"), exports);

package/dist/createActorManager.d.ts

@@ -1,12 +0,0 @@
-import { ActorManager } from "./classes/actor";
-import type { ActorManagerParameters, BaseActor } from "./types";
-/**
- * Actor manager handles the lifecycle of the actors.
- * It is responsible for creating and managing the actors.
- * You can use it to call and visit the actor's methods.
- * It also provides a way to interact with the actor's state.
- *
- * @category Main
- * @includeExample ./packages/core/README.md:268-283
- */
-export declare const createActorManager: <A = BaseActor>(config: ActorManagerParameters) => ActorManager<A>;

package/dist/createActorManager.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createActorManager = void 0;
-const actor_1 = require("./classes/actor");
-/**
- * Actor manager handles the lifecycle of the actors.
- * It is responsible for creating and managing the actors.
- * You can use it to call and visit the actor's methods.
- * It also provides a way to interact with the actor's state.
- *
- * @category Main
- * @includeExample ./packages/core/README.md:268-283
- */
-const createActorManager = (config) => {
-    return new actor_1.ActorManager(config);
-};
-exports.createActorManager = createActorManager;

package/dist/createAgentManager.d.ts

@@ -1,12 +0,0 @@
-import { AgentManager } from "./classes/agent";
-import type { AgentManagerParameters } from "./types";
-/**
- * Agent manager handles the lifecycle of the `@dfinity/agent`.
- * It is responsible for creating agent and managing the agent's state.
- * You can use it to subscribe to the agent changes.
- * login and logout to the internet identity.
- *
- * @category Main
- * @includeExample ./packages/core/README.md:232-260
- */
-export declare const createAgentManager: (config?: AgentManagerParameters) => AgentManager;

package/dist/createAgentManager.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAgentManager = void 0;
-const agent_1 = require("./classes/agent");
-/**
- * Agent manager handles the lifecycle of the `@dfinity/agent`.
- * It is responsible for creating agent and managing the agent's state.
- * You can use it to subscribe to the agent changes.
- * login and logout to the internet identity.
- *
- * @category Main
- * @includeExample ./packages/core/README.md:232-260
- */
-const createAgentManager = (config) => {
-    return new agent_1.AgentManager(config);
-};
-exports.createAgentManager = createAgentManager;

package/dist/createCandidAdapter.d.ts

@@ -1,11 +0,0 @@
-import { CandidAdapter } from "./classes/adapter";
-import type { CandidAdapterParameters } from "./types";
-/**
- * The `CandidAdapter` class is used to interact with a canister and retrieve its Candid interface definition.
- * It provides methods to fetch the Candid definition either from the canister's metadata or by using a temporary hack method.
- * If both methods fail, it throws an error.
- *
- * @category Main
- * @includeExample ./packages/core/README.md:151-192
- */
-export declare const createCandidAdapter: (config: CandidAdapterParameters) => CandidAdapter;

package/dist/createCandidAdapter.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCandidAdapter = void 0;
-const adapter_1 = require("./classes/adapter");
-/**
- * The `CandidAdapter` class is used to interact with a canister and retrieve its Candid interface definition.
- * It provides methods to fetch the Candid definition either from the canister's metadata or by using a temporary hack method.
- * If both methods fail, it throws an error.
- *
- * @category Main
- * @includeExample ./packages/core/README.md:151-192
- */
-const createCandidAdapter = (config) => {
-    return new adapter_1.CandidAdapter(config);
-};
-exports.createCandidAdapter = createCandidAdapter;

package/dist/createReactorCore.d.ts

@@ -1,10 +0,0 @@
-import type { BaseActor, CreateReactorCoreParameters, CreateReactorCoreReturnType } from "./types";
-/**
- * The Core module is the main entry point for the library.
- * Create a new actor manager with the given options.
- * Its create a new agent manager if not provided.
- *
- * @category Main
- * @includeExample ./packages/core/README.md:32-86
- */
-export declare const createReactorCore: <A = BaseActor>(config: CreateReactorCoreParameters) => CreateReactorCoreReturnType<A>;

package/dist/createReactorCore.js

@@ -1,112 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createReactorCore = void 0;
-const createReactorStore_1 = require("./createReactorStore");
-const utils_1 = require("./utils");
-/**
- * The Core module is the main entry point for the library.
- * Create a new actor manager with the given options.
- * Its create a new agent manager if not provided.
- *
- * @category Main
- * @includeExample ./packages/core/README.md:32-86
- */
-const createReactorCore = (config) => {
-    const { subscribeActorState, updateMethodState, callMethodWithOptions, callMethod, getState, agentManager, ...rest } = (0, createReactorStore_1.createReactorStore)(config);
-    const actorMethod = (functionName, args, options = {}) => {
-        const requestHash = (0, utils_1.generateRequestHash)(args);
-        const updateState = (newState = {}) => {
-            updateMethodState(functionName, requestHash, newState);
-        };
-        updateState();
-        try {
-            const methodState = ((key) => {
-                const state = getState().methodState[functionName][requestHash];
-                switch (key) {
-                    case "data":
-                        return state.data;
-                    case "loading":
-                        return state.loading;
-                    case "error":
-                        return state.error;
-                    default:
-                        return state;
-                }
-            });
-            const subscribe = (callback) => {
-                callback(methodState());
-                const unsubscribe = subscribeActorState((state) => {
-                    const methodState = state.methodState[functionName];
-                    const methodStateHash = methodState[requestHash];
-                    if (methodStateHash) {
-                        callback(methodStateHash);
-                    }
-                });
-                return unsubscribe;
-            };
-            const call = async (replaceArgs) => {
-                updateState({
-                    loading: true,
-                    error: undefined,
-                });
-                try {
-                    const data = await callMethodWithOptions(options)(functionName, ...(replaceArgs ?? args));
-                    updateState({ data, loading: false });
-                    return data;
-                }
-                catch (error) {
-                    updateState({
-                        error: error,
-                        loading: false,
-                    });
-                    throw error;
-                }
-            };
-            return {
-                requestHash,
-                subscribe,
-                getState: methodState,
-                call,
-            };
-        }
-        catch (error) {
-            updateState({
-                error: error,
-                loading: false,
-            });
-            throw error;
-        }
-    };
-    const queryCall = ({ functionName, args = [], refetchOnMount = true, refetchInterval = false, ...options }) => {
-        let intervalId = null;
-        const { call, ...rest } = actorMethod(functionName, args, options);
-        if (refetchInterval) {
-            intervalId = setInterval(() => {
-                call();
-            }, refetchInterval);
-        }
-        const clearRefetchInterval = () => {
-            if (intervalId) {
-                clearInterval(intervalId);
-            }
-        };
-        let dataPromise = Promise.resolve();
-        if (refetchOnMount)
-            dataPromise = call();
-        return { ...rest, call, dataPromise, intervalId, clearRefetchInterval };
-    };
-    const updateCall = ({ functionName, args = [], ...options }) => {
-        return actorMethod(functionName, args, options);
-    };
-    return {
-        getState,
-        queryCall,
-        updateCall,
-        callMethod,
-        callMethodWithOptions,
-        subscribeActorState,
-        ...agentManager,
-        ...rest,
-    };
-};
-exports.createReactorCore = createReactorCore;

package/dist/createReactorStore.d.ts

@@ -1,11 +0,0 @@
-import { ActorManager } from "./classes/actor";
-import type { BaseActor, CreateReactorStoreParameters } from "./types";
-/**
- * Create a new actor manager with the given options.
- * Its create a new agent manager if not provided.
- * It also creates a new actor manager with the given options.
- *
- * @category Main
- * @includeExample ./packages/core/README.md:200-225
- */
-export declare const createReactorStore: <A = BaseActor>(config: CreateReactorStoreParameters) => ActorManager<A>;

package/dist/createReactorStore.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createReactorStore = void 0;
-const createActorManager_1 = require("./createActorManager");
-const createAgentManager_1 = require("./createAgentManager");
-/**
- * Create a new actor manager with the given options.
- * Its create a new agent manager if not provided.
- * It also creates a new actor manager with the given options.
- *
- * @category Main
- * @includeExample ./packages/core/README.md:200-225
- */
-const createReactorStore = (config) => {
-    const { idlFactory, canisterId, withDevtools = false, initializeOnCreate = true, withVisitor = false, agentManager: maybeAgentManager, ...agentParameters } = config;
-    const agentManager = maybeAgentManager ||
-        (0, createAgentManager_1.createAgentManager)({
-            withDevtools,
-            ...agentParameters,
-        });
-    const actorManager = (0, createActorManager_1.createActorManager)({
-        idlFactory,
-        canisterId,
-        agentManager,
-        withVisitor,
-        withDevtools,
-        initializeOnCreate,
-    });
-    return actorManager;
-};
-exports.createReactorStore = createReactorStore;