@ic-reactor/react 1.6.6 → 1.7.1

package/dist/helpers/actorHooks.js

@@ -69,7 +69,7 @@ const DEFAULT_STATE = {
  * 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.
  */
 const actorHooks = (actorManager) => {
-    const { actorStore, canisterId, visitFunction, methodAttributes, updateMethodState, extractMethodAttributes, extractInterface, callMethod, initialize, } = actorManager;
+    const { actorStore, canisterId, visitFunction, methodAttributes, updateMethodState, extractMethodAttributes, extractInterface, callMethodWithOptions, initialize, } = actorManager;
     const useActorState = () => (0, zustand_1.useStore)(actorStore, (0, shallow_1.useShallow)((state) => ({
         error: state.error,
         initialized: state.initialized,
@@ -104,20 +104,19 @@ const actorHooks = (actorManager) => {
         }, [functionName]);
     };
     const useSharedCall = (_a) => {
-        var { args = [], functionName, throwOnError = false } = _a, events = __rest(_a, ["args", "functionName", "throwOnError"]);
+        var { args = [], functionName, throwOnError = false, onError, onLoading, onSuccess } = _a, options = __rest(_a, ["args", "functionName", "throwOnError", "onError", "onLoading", "onSuccess"]);
         const requestKey = React.useMemo(() => (0, utils_1.generateRequestHash)(args), [args]);
         const [sharedState, setSharedState] = useMethodState(functionName, requestKey);
         const reset = React.useCallback(() => updateMethodState(functionName, requestKey, DEFAULT_STATE), [functionName, requestKey]);
         const call = React.useCallback((eventOrReplaceArgs) => __awaiter(void 0, void 0, void 0, function* () {
-            var _b, _c, _d, _e, _f;
             setSharedState({ error: undefined, loading: true });
-            (_b = events === null || events === void 0 ? void 0 : events.onLoading) === null || _b === void 0 ? void 0 : _b.call(events, true);
+            onLoading === null || onLoading === void 0 ? void 0 : onLoading(true);
             try {
                 const replaceArgs = eventOrReplaceArgs instanceof Array ? eventOrReplaceArgs : args;
-                const data = yield callMethod(functionName, ...replaceArgs);
+                const data = yield callMethodWithOptions(options)(functionName, ...(replaceArgs !== null && replaceArgs !== void 0 ? replaceArgs : args));
                 setSharedState({ data, error: undefined, loading: false });
-                (_c = events === null || events === void 0 ? void 0 : events.onSuccess) === null || _c === void 0 ? void 0 : _c.call(events, data);
-                (_d = events === null || events === void 0 ? void 0 : events.onLoading) === null || _d === void 0 ? void 0 : _d.call(events, false);
+                onSuccess === null || onSuccess === void 0 ? void 0 : onSuccess(data);
+                onLoading === null || onLoading === void 0 ? void 0 : onLoading(false);
                 return data;
             }
             catch (error) {
@@ -127,12 +126,12 @@ const actorHooks = (actorManager) => {
                     error: error,
                     loading: false,
                 });
-                (_e = events === null || events === void 0 ? void 0 : events.onError) === null || _e === void 0 ? void 0 : _e.call(events, error);
-                (_f = events === null || events === void 0 ? void 0 : events.onLoading) === null || _f === void 0 ? void 0 : _f.call(events, false);
+                onError === null || onError === void 0 ? void 0 : onError(error);
+                onLoading === null || onLoading === void 0 ? void 0 : onLoading(false);
                 if (throwOnError)
                     throw error;
             }
-        }), [args, functionName, events]);
+        }), [args, functionName, options, onError, onLoading, onSuccess, throwOnError]);
         return Object.assign({ call, reset, requestKey }, sharedState);
     };
     const useQueryCall = (_a) => {
@@ -140,25 +139,29 @@ const actorHooks = (actorManager) => {
         const _b = useSharedCall(rest), { call } = _b, state = __rest(_b, ["call"]);
         const intervalId = React.useRef();
         React.useEffect(() => {
+            var _a;
             if (refetchInterval) {
                 intervalId.current = setInterval(call, refetchInterval);
             }
             if (refetchOnMount && state.data === undefined) {
                 call();
             }
+            else if (refetchOnMount && state.data !== undefined) {
+                (_a = rest.onSuccess) === null || _a === void 0 ? void 0 : _a.call(rest, state.data);
+            }
             return () => clearInterval(intervalId.current);
         }, [refetchInterval, refetchOnMount]);
         return Object.assign({ call }, state);
     };
     const useUpdateCall = useSharedCall;
     const useMethod = (params) => {
-        const visit = React.useCallback((extractorClass, data) => {
-            if (!visitFunction[params.functionName]) {
+        const attributes = React.useMemo(() => {
+            if (!methodAttributes[params.functionName]) {
                 throw new Error(`Method ${params.functionName} not found`);
             }
-            return visitFunction[params.functionName](extractorClass, data);
+            return methodAttributes[params.functionName];
         }, [params.functionName]);
-        const attributes = React.useMemo(() => methodAttributes[params.functionName], [params.functionName]);
+        const visit = React.useCallback((extractorClass, data) => visitFunction[params.functionName](extractorClass, data), [params.functionName]);
         const validateArgs = React.useCallback((args, throwOnError = false) => {
             if (attributes.numberOfArgs > 0) {
                 if (args === undefined || args.length === 0) {

package/dist/helpers/types.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="react" />
+import { CallConfig } from "@dfinity/agent";
 import type { IDL, ActorState, AuthClientLoginOptions, ActorMethodParameters, ActorMethodReturnType, Identity, Principal, FunctionName, VisitService, AuthState, HttpAgent, AgentState, BaseActor, MethodAttributes } from "../types";
 export interface AgentHooksReturnType {
     useAgent: () => HttpAgent | undefined;
@@ -40,14 +41,14 @@ export type LogoutParameters = {
 export interface UseActorState extends Omit<ActorState, "methodState"> {
     canisterId: string;
 }
-export type UseSharedCallParameters<A, M extends FunctionName<A>> = {
+export interface UseSharedCallParameters<A, M extends FunctionName<A>> extends CallConfig {
     functionName: M;
     args?: ActorMethodParameters<A[M]>;
     onLoading?: (loading: boolean) => void;
     onError?: (error: Error | undefined) => void;
     onSuccess?: (data: ActorMethodReturnType<A[M]> | undefined) => void;
     throwOnError?: boolean;
-};
+}
 export type UseSharedCallState<A, M extends FunctionName<A>> = {
     data: ActorMethodReturnType<A[M]> | undefined;
     error: Error | undefined;
@@ -58,15 +59,15 @@ export interface UseSharedCallReturnType<A, M extends FunctionName<A> = Function
     reset: () => void;
     call: (eventOrReplaceArgs?: React.MouseEvent | ActorMethodParameters<A[M]>) => Promise<ActorMethodReturnType<A[M]> | undefined>;
 }
-export type UseSharedCall<A> = <M extends FunctionName<A>>(args: UseSharedCallParameters<A, M>) => UseSharedCallReturnType<A, M>;
+export type UseSharedCall<A> = <M extends FunctionName<A>>(params: UseSharedCallParameters<A, M>) => UseSharedCallReturnType<A, M>;
 export interface UseQueryCallParameters<A, M extends FunctionName<A>> extends UseSharedCallParameters<A, M> {
     refetchOnMount?: boolean;
     refetchInterval?: number | false;
 }
-export type UseQueryCall<A> = <M extends FunctionName<A>>(args: UseQueryCallParameters<A, M>) => UseSharedCallReturnType<A, M>;
+export type UseQueryCall<A> = <M extends FunctionName<A>>(params: UseQueryCallParameters<A, M>) => UseSharedCallReturnType<A, M>;
 export interface UseUpdateCallParameters<A, M extends FunctionName<A>> extends UseSharedCallParameters<A, M> {
 }
-export type UseUpdateCall<A> = <M extends FunctionName<A>>(args: UseUpdateCallParameters<A, M>) => UseSharedCallReturnType<A, M>;
+export type UseUpdateCall<A> = <M extends FunctionName<A>>(params: UseUpdateCallParameters<A, M>) => UseSharedCallReturnType<A, M>;
 export interface DynamicDataArgs<V = unknown> {
     label: string;
     value: V;

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

@@ -1,9 +1,9 @@
-import { BaseActor, FunctionName, UseMethodParameters } from "../../types";
+import { BaseActor, FunctionName, UseMethodParameters, UseMethodReturnType } from "../../types";
 /**
  * Hook for making dynamically update or query calls to actors, handling loading states, and managing errors. It supports custom event handlers for loading, success, and error events.
  *
- * @param options Configuration object for the actor method call, including the method name, arguments, and event handlers.
- * @returns An object containing the method call function, a reset function to reset the call state to its default, and the current call state (data, error, loading, call, reset).
+ * @param args {@link UseMethodParameters}.
+ * @returns object {@link UseMethodReturnType}.
  * @example
  * ```tsx
  * function MethodCallComponent() {
@@ -26,4 +26,4 @@ import { BaseActor, FunctionName, UseMethodParameters } from "../../types";
  * }
  * ```
  */
-export declare function useMethod<A = BaseActor, M extends FunctionName<A> = FunctionName<A>>(args: UseMethodParameters<A, M>): import("../../types").UseMethodReturnType<A, M>;
+export declare function useMethod<A = BaseActor, M extends FunctionName<A> = FunctionName<A>>(args: UseMethodParameters<A, M>): UseMethodReturnType<A, M>;

package/dist/hooks/actor/useMethod.js

@@ -8,8 +8,8 @@ const hooks_1 = __importDefault(require("./hooks"));
 /**
  * Hook for making dynamically update or query calls to actors, handling loading states, and managing errors. It supports custom event handlers for loading, success, and error events.
  *
- * @param options Configuration object for the actor method call, including the method name, arguments, and event handlers.
- * @returns An object containing the method call function, a reset function to reset the call state to its default, and the current call state (data, error, loading, call, reset).
+ * @param args {@link UseMethodParameters}.
+ * @returns object {@link UseMethodReturnType}.
  * @example
  * ```tsx
  * function MethodCallComponent() {

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

@@ -1,9 +1,9 @@
-import { BaseActor, FunctionName, UseQueryCallParameters } from "../../types";
+import { BaseActor, FunctionName, UseQueryCallParameters, UseSharedCallReturnType } from "../../types";
 /**
  * Hook for making query calls to actors. It supports automatic refetching on component mount and at specified intervals.
  *
- * @param options Configuration object for the query call, including refetching options and other configurations passed to useReactorCall.
- * @returns An object containing the query call function and the current call state (data, error, loading, call, reset).
+ * @param args {@link UseQueryCallParameters}.
+ * @returns object {@link UseSharedCallReturnType}.
  * @example
  * ```tsx
  * function QueryCallComponent() {
@@ -25,4 +25,4 @@ import { BaseActor, FunctionName, UseQueryCallParameters } from "../../types";
  * }
  * ```
  */
-export declare function useQueryCall<A = BaseActor, M extends FunctionName<A> = FunctionName<A>>(args: UseQueryCallParameters<A, M>): import("../../types").UseSharedCallReturnType<A, M>;
+export declare function useQueryCall<A = BaseActor, M extends FunctionName<A> = FunctionName<A>>(args: UseQueryCallParameters<A, M>): UseSharedCallReturnType<A, M>;

package/dist/hooks/actor/useQueryCall.js

@@ -8,8 +8,8 @@ const hooks_1 = __importDefault(require("./hooks"));
 /**
  * Hook for making query calls to actors. It supports automatic refetching on component mount and at specified intervals.
  *
- * @param options Configuration object for the query call, including refetching options and other configurations passed to useReactorCall.
- * @returns An object containing the query call function and the current call state (data, error, loading, call, reset).
+ * @param args {@link UseQueryCallParameters}.
+ * @returns object {@link UseSharedCallReturnType}.
  * @example
  * ```tsx
  * function QueryCallComponent() {

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

@@ -1,9 +1,9 @@
-import type { BaseActor, FunctionName, UseUpdateCallParameters } from "../../types";
+import type { BaseActor, FunctionName, UseUpdateCallParameters, UseSharedCallReturnType } from "../../types";
 /**
  * Hook for making update calls to actors, handling loading states, and managing errors. It supports custom event handlers for loading, success, and error events.
  *
- * @param options Configuration object for the actor method call, including the method name, arguments, and event handlers.
- * @returns An object containing the method call function, a reset function to reset the call state to its default, and the current call state (data, error, loading, call, reset).
+ * @param args {@link UseUpdateCallParameters}.
+ * @returns object {@link UseSharedCallReturnType}.
  * @example
  * ```tsx
  * function UpdateCallComponent() {
@@ -26,4 +26,4 @@ import type { BaseActor, FunctionName, UseUpdateCallParameters } from "../../typ
  * }
  * ```
  */
-export declare function useUpdateCall<A = BaseActor, M extends FunctionName<A> = FunctionName<A>>(args: UseUpdateCallParameters<A, M>): import("../../types").UseSharedCallReturnType<A, M>;
+export declare function useUpdateCall<A = BaseActor, M extends FunctionName<A> = FunctionName<A>>(args: UseUpdateCallParameters<A, M>): UseSharedCallReturnType<A, M>;

package/dist/hooks/actor/useUpdateCall.js

@@ -8,8 +8,8 @@ const hooks_1 = __importDefault(require("./hooks"));
 /**
  * Hook for making update calls to actors, handling loading states, and managing errors. It supports custom event handlers for loading, success, and error events.
  *
- * @param options Configuration object for the actor method call, including the method name, arguments, and event handlers.
- * @returns An object containing the method call function, a reset function to reset the call state to its default, and the current call state (data, error, loading, call, reset).
+ * @param args {@link UseUpdateCallParameters}.
+ * @returns object {@link UseSharedCallReturnType}.
  * @example
  * ```tsx
  * function UpdateCallComponent() {

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

@@ -5,4 +5,4 @@ import type { BaseActor, FunctionName } from "../../types";
  * @param functionName The name of the actor method to visit.
  * @returns The visit service function for the specified method.
  */
-export declare function useVisitMethod<A = BaseActor>(functionName: FunctionName<A>): <V extends import("@dfinity/candid/lib/cjs/idl").Visitor<unknown, unknown>>(extractorClass: V, data?: import("@ic-reactor/core/dist/classes/actor/types").VisitorType<V>["data"] | undefined) => ReturnType<V["visitFunc"]>;
+export declare function useVisitMethod<A = BaseActor>(functionName: FunctionName<A>): <V extends import("@dfinity/candid/lib/cjs/idl").Visitor<unknown, unknown>>(extractorClass: V, data: import("@ic-reactor/core/dist/classes/actor/types").VisitorType<V>["data"]) => ReturnType<V["visitFunc"]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ic-reactor/react",
-  "version": "1.6.6",
+  "version": "1.7.1",
   "description": "A React library for interacting with Internet Computer canisters",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -35,17 +35,17 @@
     "node": ">=10"
   },
   "dependencies": {
-    "@ic-reactor/core": "^1.6.5",
+    "@ic-reactor/core": "^1.7.1",
     "zustand-utils": "^1.3"
   },
   "peerDependencies": {
-    "@dfinity/agent": "^1.2",
-    "@dfinity/auth-client": "^1.2",
-    "@dfinity/candid": "^1.2",
-    "@dfinity/identity": "^1.2",
-    "@dfinity/principal": "^1.2",
+    "@dfinity/agent": "^1.3",
+    "@dfinity/auth-client": "^1.3",
+    "@dfinity/candid": "^1.3",
+    "@dfinity/identity": "^1.3",
+    "@dfinity/principal": "^1.3",
     "react": ">=16.8",
     "zustand": "4.5"
   },
-  "gitHead": "20057283d6df8537997dc03927e3886b9d560c19"
+  "gitHead": "d4013e2399602abb8646efad8bb564934a254b23"
 }