@ic-reactor/react 1.3.2 → 1.3.3

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

@@ -4,3 +4,4 @@ export * from "./useAgentManager";
 export * from "./useAuth";
 export * from "./useAuthState";
 export * from "./useUserPrincipal";
+export * from "./useCandidAdapter";

package/dist/hooks/agent/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./useAgentManager"), exports);
 __exportStar(require("./useAuth"), exports);
 __exportStar(require("./useAuthState"), exports);
 __exportStar(require("./useUserPrincipal"), exports);
+__exportStar(require("./useCandidAdapter"), exports);

package/dist/hooks/agent/useCandidAdapter.d.ts

@@ -6,16 +6,25 @@ export interface UseCandidAdapterParams {
     didjsCanisterId?: string;
 }
 /**
- * Accesses the `AgentManager` instance for managing agent configurations and state.
+ * Accesses the `CandidAdapter` to download the actor's Candid interface.
+ *
+ * @param config - `UseCandidAdapterParams` The configuration object.
+ * @returns The `CandidAdapter` instance.
  *
  * @example
- *```jsx
- *  function AgentManagerComponent() {
- *    const agentManager = useAgentManager();
+ * ```jsx
+ * function CandidAdapterComponent() {
+ *   const candidAdapter = useCandidAdapter();
+ *
+ *   const getActor = async () => {
+ *      const { idlFactory } = await candidAdapter.getCandidDefinition(canisterId)
+ *      console.log(idlFactory)
+ *   }
  *
- *    // Use agentManager for managing agent configurations, etc.
- *    return <div>Agent Manager ready.</div>;
- *  }
+ *   return (
+ *       <button onClick={getActor}>Get Actor</button>
+ *   );
+ * }
  *```
  */
 export declare const useCandidAdapter: (config: UseCandidAdapterParams) => CandidAdapter | undefined;

package/dist/hooks/agent/useCandidAdapter.js

@@ -5,16 +5,25 @@ const useAgentManager_1 = require("./useAgentManager");
 const react_1 = require("react");
 const core_1 = require("@ic-reactor/core");
 /**
- * Accesses the `AgentManager` instance for managing agent configurations and state.
+ * Accesses the `CandidAdapter` to download the actor's Candid interface.
+ *
+ * @param config - `UseCandidAdapterParams` The configuration object.
+ * @returns The `CandidAdapter` instance.
  *
  * @example
- *```jsx
- *  function AgentManagerComponent() {
- *    const agentManager = useAgentManager();
+ * ```jsx
+ * function CandidAdapterComponent() {
+ *   const candidAdapter = useCandidAdapter();
+ *
+ *   const getActor = async () => {
+ *      const { idlFactory } = await candidAdapter.getCandidDefinition(canisterId)
+ *      console.log(idlFactory)
+ *   }
  *
- *    // Use agentManager for managing agent configurations, etc.
- *    return <div>Agent Manager ready.</div>;
- *  }
+ *   return (
+ *       <button onClick={getActor}>Get Actor</button>
+ *   );
+ * }
  *```
  */
 const useCandidAdapter = (config) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ic-reactor/react",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "A React library for interacting with Internet Computer canisters",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -47,5 +47,5 @@
     "react": ">=16.8",
     "zustand": "4.5"
   },
-  "gitHead": "02ebf0dfbd01792ded00b91a69b4196aab018285"
+  "gitHead": "a471daafc519bd06902e773058748241c1f0331b"
 }