@ic-reactor/react 1.1.2 → 1.1.4

package/dist/context/actor.js

@@ -83,13 +83,17 @@ function createActorContext(config = {}) {
     const { canisterId: defaultCanisterId } = config, defaultConfig = __rest(config, ["canisterId"]);
     const ActorContext = react_1.default.createContext(null);
     const ActorProvider = (_a) => {
-        var { children, canisterId = defaultCanisterId, loadingComponent = react_1.default.createElement("div", null, "Fetching canister...") } = _a, restConfig = __rest(_a, ["children", "canisterId", "loadingComponent"]);
+        var { children, canisterId = defaultCanisterId, loadingComponent = react_1.default.createElement("div", null, "Fetching canister..."), authenticatingComponent = react_1.default.createElement("div", null, "Authenticating...") } = _a, restConfig = __rest(_a, ["children", "canisterId", "loadingComponent", "authenticatingComponent"]);
         if (!canisterId) {
             throw new Error("canisterId is required");
         }
         const config = react_1.default.useMemo(() => (Object.assign(Object.assign({}, defaultConfig), restConfig)), [defaultConfig, restConfig]);
-        const { fetchError, fetching, hooks } = (0, useActor_1.useActor)(Object.assign({ canisterId }, config));
-        return (react_1.default.createElement(ActorContext.Provider, { value: hooks }, fetching || hooks === null ? fetchError !== null && fetchError !== void 0 ? fetchError : loadingComponent : children));
+        const { fetchError, authenticating, hooks } = (0, useActor_1.useActor)(Object.assign({ canisterId, fetchOnMount: false }, config));
+        return (react_1.default.createElement(ActorContext.Provider, { value: hooks }, hooks === null
+            ? (fetchError !== null && fetchError !== void 0 ? fetchError : authenticating)
+                ? authenticatingComponent
+                : loadingComponent
+            : children));
     };
     ActorProvider.displayName = "ActorProvider";
     return Object.assign({ ActorProvider }, (0, extractActorContext_1.extractActorContext)(ActorContext));

package/dist/context/agent.js

@@ -93,11 +93,15 @@ const extractAgentContext_1 = require("../helpers/extractAgentContext");
  * with the Internet Computer blockchain.
  */
 const createAgentContext = (config = {}) => {
+    const { disableAuthenticateOnMount: defaultDisable } = config, contextOptions = __rest(config, ["disableAuthenticateOnMount"]);
     const AgentContext = react_1.default.createContext(null);
     const AgentProvider = (_a) => {
-        var { children, agentManager: mybeAgentManager } = _a, options = __rest(_a, ["children", "agentManager"]);
+        var { children, agentManager: mybeAgentManager, disableAuthenticateOnMount = defaultDisable !== null && defaultDisable !== void 0 ? defaultDisable : false } = _a, options = __rest(_a, ["children", "agentManager", "disableAuthenticateOnMount"]);
         const hooks = react_1.default.useMemo(() => {
-            const agentManager = mybeAgentManager !== null && mybeAgentManager !== void 0 ? mybeAgentManager : (0, core_1.createAgentManager)(Object.assign(Object.assign({}, options), config));
+            const agentManager = mybeAgentManager !== null && mybeAgentManager !== void 0 ? mybeAgentManager : (0, core_1.createAgentManager)(Object.assign(Object.assign({}, options), contextOptions));
+            if (!disableAuthenticateOnMount) {
+                agentManager.authenticate();
+            }
             return Object.assign(Object.assign(Object.assign({}, (0, agentHooks_1.agentHooks)(agentManager)), (0, authHooks_1.authHooks)(agentManager)), { agentManager });
         }, [options]);
         return (react_1.default.createElement(AgentContext.Provider, { value: hooks }, children));

package/dist/context/types.d.ts

@@ -4,12 +4,13 @@ export interface AgentContext extends AgentHooksReturnType, AuthHooksReturnType
     agentManager: AgentManager;
 }
 export interface CreateAgentCotextParameters extends AgentManagerParameters {
+    disableAuthenticateOnMount?: boolean;
 }
 export interface CreateAgentContextReturnType extends AgentHooksReturnType, AuthHooksReturnType {
     useAgentManager: (agentContext?: React.Context<AgentContext | null>) => AgentManager;
     AgentProvider: React.FC<AgentProviderProps>;
 }
-export interface AgentProviderProps extends PropsWithChildren, AgentManagerParameters {
+export interface AgentProviderProps extends PropsWithChildren, CreateAgentCotextParameters {
     agentManager?: AgentManager;
 }
 export interface CreateActorContextReturnType<A = BaseActor> extends ActorHooksReturnType<A> {
@@ -18,6 +19,7 @@ export interface CreateActorContextReturnType<A = BaseActor> extends ActorHooksR
 export interface ActorProviderProps extends CreateActorContextParameters {
     children?: React.ReactNode | undefined;
     loadingComponent?: React.ReactNode;
+    authenticatingComponent?: React.ReactNode;
 }
 export interface CreateActorContextParameters extends Omit<ActorManagerParameters, "idlFactory" | "agentManager" | "canisterId"> {
     didjsId?: string;

package/dist/helpers/actorHooks.js

@@ -49,6 +49,9 @@ const DEFAULT_STATE = {
 const actorHooks = (actorManager) => {
     const { actorStore, canisterId, visitFunction, callMethod, initialize } = actorManager;
     const useActorState = () => (Object.assign(Object.assign({}, (0, zustand_1.useStore)(actorStore)), { canisterId }));
+    const useVisitService = () => {
+        return visitFunction;
+    };
     const useVisitMethod = (functionName) => {
         return react_1.default.useMemo(() => visitFunction[functionName], [functionName]);
     };
@@ -102,6 +105,7 @@ const actorHooks = (actorManager) => {
         useUpdateCall,
         useActorState,
         useVisitMethod,
+        useVisitService,
     };
 };
 exports.actorHooks = actorHooks;

package/dist/helpers/extractActorContext.js

@@ -43,11 +43,13 @@ function extractActorContext(actorContext) {
     const useQueryCall = (args) => useActorContext().useQueryCall(args);
     const useUpdateCall = (args) => useActorContext().useUpdateCall(args);
     const useVisitMethod = (functionName) => useActorContext().useVisitMethod(functionName);
+    const useVisitService = () => useActorContext().useVisitService();
     return {
         useActorState,
         useQueryCall,
         useUpdateCall,
         useVisitMethod,
+        useVisitService,
         initialize,
     };
 }

package/dist/helpers/extractAgentContext.js

@@ -51,7 +51,7 @@ const extractAgentContext = (agentContext) => {
         useAgent,
         useAuthState,
         useAgentState,
-        useAuth: useAuth,
+        useAuth,
         useAgentManager,
         useUserPrincipal,
     };

package/dist/helpers/types.d.ts

@@ -67,10 +67,12 @@ export type UseMethodCall<A> = <M extends FunctionName<A>>(args: UseMethodCallPa
 export type UseQueryCall<A> = <M extends FunctionName<A>>(args: UseQueryCallParameters<A, M>) => UseMethodCallReturnType<A, M>;
 export type UseUpdateCall<A> = <M extends FunctionName<A>>(args: UseUpdateCallParameters<A, M>) => UseMethodCallReturnType<A, M>;
 export type UseVisitMethod<A> = <M extends FunctionName<A>>(functionName: M) => VisitService<A>[M];
+export type UseVisitService<A> = () => VisitService<A>;
 export interface ActorHooksReturnType<A = BaseActor> {
     initialize: () => Promise<void>;
     useActorState: () => UseActorState;
     useQueryCall: UseQueryCall<A>;
     useUpdateCall: UseUpdateCall<A>;
     useVisitMethod: UseVisitMethod<A>;
+    useVisitService: UseVisitService<A>;
 }

package/dist/hooks/actor/index.d.ts

@@ -2,3 +2,4 @@ export * from "./useActorState";
 export * from "./useQueryCall";
 export * from "./useUpdateCall";
 export * from "./useVisitMethod";
+export * from "./useVisitService";

package/dist/hooks/actor/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./useActorState"), exports);
 __exportStar(require("./useQueryCall"), exports);
 __exportStar(require("./useUpdateCall"), exports);
 __exportStar(require("./useVisitMethod"), exports);
+__exportStar(require("./useVisitService"), exports);

package/dist/hooks/actor/useVisitService.d.ts

@@ -0,0 +1,8 @@
+import { BaseActor } from "../../types";
+/**
+ * Memoizes and returns a visit service function for a specific actor method.
+ *
+ * @param functionName The name of the actor method to visit.
+ * @returns The visit service function for the specified method.
+ */
+export declare function useVisitService<A = BaseActor>(): import("@ic-reactor/core/dist/classes/actor/types").VisitService<A>;

package/dist/hooks/actor/useVisitService.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useVisitService = void 0;
+const hooks_1 = require("./hooks");
+/**
+ * Memoizes and returns a visit service function for a specific actor method.
+ *
+ * @param functionName The name of the actor method to visit.
+ * @returns The visit service function for the specified method.
+ */
+function useVisitService() {
+    return hooks_1.ActorHooks.useVisitService();
+}
+exports.useVisitService = useVisitService;

package/dist/hooks/types.d.ts

@@ -6,10 +6,12 @@ export interface UseActorParameters extends Omit<ActorManagerParameters, "idlFac
     canisterId: string;
     idlFactory?: IDL.InterfaceFactory;
     agentContext?: React.Context<AgentContext | null>;
+    fetchOnMount?: boolean;
     didjsCanisterId?: string;
 }
 export interface UseActorReturn<A = BaseActor> {
     hooks: ActorHooksReturnType<A> | null;
     fetching: boolean;
     fetchError: string | null;
+    authenticating: boolean;
 }

package/dist/hooks/useActor.js

@@ -25,6 +25,7 @@ const core_1 = require("@ic-reactor/core");
 const react_1 = require("react");
 const useAgentManager_1 = require("./agent/useAgentManager");
 const helpers_1 = require("../helpers");
+const agent_1 = require("./agent");
 /**
  * A comprehensive hook that manages both the fetching of Candid interfaces
  * and the initialization of actor stores for Internet Computer (IC) canisters.
@@ -88,7 +89,7 @@ const helpers_1 = require("../helpers");
  * ```
  */
 const useActor = (config) => {
-    const { canisterId, idlFactory: maybeIdlFactory, agentContext, didjsCanisterId } = config, actorConfig = __rest(config, ["canisterId", "idlFactory", "agentContext", "didjsCanisterId"]);
+    const { canisterId, idlFactory: maybeIdlFactory, agentContext, fetchOnMount = true, didjsCanisterId } = config, actorConfig = __rest(config, ["canisterId", "idlFactory", "agentContext", "fetchOnMount", "didjsCanisterId"]);
     const [{ idlFactory, fetching, fetchError }, setState] = (0, react_1.useState)({
         idlFactory: maybeIdlFactory,
         fetching: false,
@@ -126,16 +127,29 @@ const useActor = (config) => {
             });
         }
     }), [canisterId, didjsCanisterId]);
-    // Automatically fetch Candid if not already fetched or provided.
-    (0, react_1.useEffect)(() => agentManager.subscribeAgent(fetchCandid, !maybeIdlFactory), [fetchCandid, agentManager]);
+    (0, react_1.useEffect)(() => {
+        if (maybeIdlFactory) {
+            setState(() => ({
+                idlFactory: maybeIdlFactory,
+                fetching: false,
+                fetchError: null,
+            }));
+            return;
+        }
+        const unsubscribe = agentManager.subscribeAgent(fetchCandid, fetchOnMount);
+        return unsubscribe;
+    }, [agentManager, fetchOnMount]);
+    const authenticating = (0, agent_1.useAuthState)().authenticating;
     const hooks = (0, react_1.useMemo)(() => {
         if (!idlFactory)
             return null;
+        if (authenticating)
+            return null;
         const actorManager = (0, core_1.createActorManager)(Object.assign({ agentManager,
             idlFactory,
             canisterId }, actorConfig));
         return (0, helpers_1.actorHooks)(actorManager);
-    }, [canisterId, idlFactory]);
-    return { hooks, fetching, fetchError };
+    }, [canisterId, authenticating, idlFactory]);
+    return { hooks, authenticating, fetching, fetchError };
 };
 exports.useActor = useActor;

package/dist/index.d.ts

@@ -7,4 +7,4 @@ export * from "./hooks";
 export * as helpers from "./helpers";
 export * as types from "./types";
 export * as core from "./core";
-export * as utils from "@ic-reactor/core/dist/utils";
+export * as utils from "./utils";

package/dist/index.js

@@ -36,4 +36,4 @@ __exportStar(require("./hooks"), exports);
 exports.helpers = __importStar(require("./helpers"));
 exports.types = __importStar(require("./types"));
 exports.core = __importStar(require("./core"));
-exports.utils = __importStar(require("@ic-reactor/core/dist/utils"));
+exports.utils = __importStar(require("./utils"));

package/dist/utils.d.ts

@@ -0,0 +1 @@
+export * from "@ic-reactor/core/dist/utils";

package/dist/utils.js

@@ -0,0 +1,17 @@
+"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("@ic-reactor/core/dist/utils"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ic-reactor/react",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "A React library for interacting with Internet Computer canisters",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,7 +26,7 @@
   },
   "homepage": "https://b3pay.github.io/ic-reactor/modules/react.html",
   "scripts": {
-    "test": "npx jest",
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest",
     "start": "tsc watch",
     "build": "npx tsc",
     "clean": "npx rimraf dist && npx rimraf umd"
@@ -47,5 +47,5 @@
     "react": ">=16.8",
     "zustand": "4.5"
   },
-  "gitHead": "036b4b03b8cc9b1e40ece8f8b16d9ce084634192"
+  "gitHead": "0055703885730f86a837f2e2f3f6b6f49bb3cc68"
 }