@ic-reactor/core 1.2.2 → 1.3.0

package/README.md

@@ -19,7 +19,7 @@ yarn add @ic-reactor/core
 or you can use the UMD version:
 
 ```html
-<script src="https://github.com/B3Pay/ic-reactor/releases/download/v1.2.1/ic-reactor-core.min.js"></script>
+<script src="https://github.com/B3Pay/ic-reactor/releases/download/v1.2.3/ic-reactor-core.min.js"></script>
 ```
 
 ### Using `createReactorCore`
@@ -42,7 +42,7 @@ const { queryCall, updateCall, getPrincipal, login } =
   })
 ```
 
-You can find All available methods are returned from the `createReactorCore` function here: [ReactorCore](https://b3pay.github.io/ic-reactor/interfaces/core.types.ReactorCore.html)
+You can find All available methods are returned from the `createReactorCore` function [here](https://b3pay.github.io/ic-reactor/interfaces/core.types.CreateReactorCoreReturnType.html).
 
 ```typescript
 // later in your code

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

@@ -1,4 +1,4 @@
-import type { CanisterId, ActorMethodParameters, ActorMethodReturnType, ActorStore, ActorManagerParameters, FunctionName, VisitService, BaseActor, ActorMethodState } from "./types";
+import type { CanisterId, ActorMethodParameters, ActorMethodReturnType, ActorStore, ActorManagerParameters, FunctionName, VisitService, BaseActor, ActorMethodState, MethodAttributes } from "./types";
 import { IDL } from "@dfinity/candid";
 import type { AgentManager } from "../agent";
 import type { UpdateAgentParameters } from "../../types";
@@ -8,10 +8,10 @@ export declare class ActorManager<A = BaseActor> {
     private _agentManager;
     private _unsubscribeAgent;
     private _subscribers;
-    methods: Array<FunctionName<A>>;
     canisterId: CanisterId;
     actorStore: ActorStore<A>;
     visitFunction: VisitService<A>;
+    methodAttributes: MethodAttributes<A>;
     private initialState;
     private updateState;
     updateMethodState: (method: FunctionName<A>, hash: string, newState: Partial<{
@@ -21,9 +21,9 @@ export declare class ActorManager<A = BaseActor> {
     }>) => void;
     constructor(actorConfig: ActorManagerParameters);
     initialize: (options?: UpdateAgentParameters) => Promise<void>;
-    extractMethodNames: () => Array<FunctionName<A>>;
-    extractService: () => VisitService<A>;
     extractInterface: () => IDL.ServiceClass;
+    extractMethodAttributes: () => MethodAttributes<A>;
+    extractVisitor: () => VisitService<A>;
     private initializeActor;
     callMethod: <M extends FunctionName<A>>(functionName: M, ...args: ActorMethodParameters<A[M]>) => Promise<ActorMethodReturnType<A[M]>>;
     get agentManager(): AgentManager;

package/dist/classes/actor/index.js

@@ -13,11 +13,11 @@ exports.ActorManager = void 0;
 /* eslint-disable no-console */
 const agent_1 = require("@dfinity/agent");
 const helper_1 = require("../../utils/helper");
+const candid_1 = require("@dfinity/candid");
 class ActorManager {
     constructor(actorConfig) {
         this._actor = null;
         this._subscribers = [];
-        this.methods = [];
         this.initialState = {
             methodState: {},
             initializing: false,
@@ -38,11 +38,31 @@ class ActorManager {
         this.initialize = (options) => __awaiter(this, void 0, void 0, function* () {
             yield this._agentManager.updateAgent(options);
         });
-        this.extractMethodNames = () => {
+        this.extractInterface = () => {
+            return this._idlFactory({ IDL: candid_1.IDL });
+        };
+        this.extractMethodAttributes = () => {
             const iface = this.extractInterface();
-            return iface._fields.map((service) => service[0]);
+            const methodAttributesArray = iface._fields.map(([name, func]) => ({
+                name: name,
+                attributes: {
+                    numberOfArgs: func.argTypes.length,
+                    type: ((0, helper_1.isQuery)(func) ? "query" : "update"),
+                    validate: (arg) => func.argTypes.some((t, i) => t.covariant(arg[i])),
+                },
+            }));
+            methodAttributesArray.sort((a, b) => {
+                if (a.attributes.type === b.attributes.type) {
+                    return a.attributes.numberOfArgs - b.attributes.numberOfArgs;
+                }
+                return a.attributes.type === "query" ? -1 : 1;
+            });
+            return methodAttributesArray.reduce((acc, { name, attributes }) => {
+                acc[name] = attributes;
+                return acc;
+            }, {});
         };
-        this.extractService = () => {
+        this.extractVisitor = () => {
             const iface = this.extractInterface();
             return iface._fields.reduce((acc, service) => {
                 const functionName = service[0];
@@ -54,12 +74,6 @@ class ActorManager {
                 return acc;
             }, {});
         };
-        this.extractInterface = () => {
-            if (this._actor === null) {
-                throw new Error("For extracting interface, actor must be initialized");
-            }
-            return agent_1.Actor.interfaceOf(this._actor);
-        };
         this.initializeActor = (agent) => {
             console.info(`Initializing actor ${this.canisterId} on ${agent.isLocal() ? "local" : "ic"} network`);
             const { _idlFactory, canisterId } = this;
@@ -79,7 +93,6 @@ class ActorManager {
                 if (!this._actor) {
                     throw new Error("Failed to initialize actor");
                 }
-                this.methods = this.extractMethodNames();
                 this.updateState({
                     initializing: false,
                     initialized: true,
@@ -125,9 +138,16 @@ class ActorManager {
         if (!canisterId) {
             throw new Error("CanisterId is required!");
         }
-        this._agentManager = agentManager;
         this.canisterId = canisterId;
+        if (!idlFactory) {
+            throw new Error("IDL factory is required!");
+        }
         this._idlFactory = idlFactory;
+        this.methodAttributes = this.extractMethodAttributes();
+        if (!agentManager) {
+            throw new Error("Agent manager is required!");
+        }
+        this._agentManager = agentManager;
         // Initialize stores
         this.actorStore = (0, helper_1.createStoreWithOptionalDevtools)(this.initialState, {
             withDevtools,
@@ -136,7 +156,7 @@ class ActorManager {
         });
         this._unsubscribeAgent = this._agentManager.subscribeAgent(this.initializeActor, initializeOnCreate);
         if (withVisitor) {
-            this.visitFunction = this.extractService();
+            this.visitFunction = this.extractVisitor();
         }
         else {
             this.visitFunction = emptyVisitor;

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

@@ -44,3 +44,8 @@ export type ActorState<A = BaseActor> = {
 };
 export type ActorStore<A = BaseActor> = StoreApiWithDevtools<ActorState<A>>;
 export type CallActorMethod<A = BaseActor> = <M extends FunctionName<A> = FunctionName<A>>(functionName: M, ...args: ActorMethodParameters<A[M]>) => Promise<ActorMethodReturnType<A[M]>>;
+export type MethodAttributes<A = BaseActor> = Record<FunctionName<A>, {
+    type: FunctionType;
+    numberOfArgs: number;
+    validate: (arg: never) => boolean;
+}>;

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

@@ -8,7 +8,6 @@ export declare class AgentManager {
     private _subscribers;
     agentStore: AgentStore;
     authStore: AuthStore;
-    isLocalEnv: boolean;
     private initialAgentState;
     private initialAuthState;
     private updateAgentState;
@@ -25,6 +24,7 @@ export declare class AgentManager {
         returnTo?: string;
     }) => Promise<void>;
     getAgent: () => HttpAgent;
+    getIsLocal: () => boolean;
     getAgentState: AgentStore["getState"];
     subscribeAgentState: AgentStore["subscribe"];
     getAuthState: AuthStore["getState"];

package/dist/classes/agent/index.js

@@ -48,12 +48,13 @@ class AgentManager {
             this.authStore.setState((state) => (Object.assign(Object.assign({}, state), newState)), false, action);
         };
         this.initializeAgent = () => __awaiter(this, void 0, void 0, function* () {
+            const isLocalEnv = this.getIsLocal();
             this.updateAgentState({
                 initializing: true,
                 error: undefined,
-                network: this.isLocalEnv ? "local" : "ic",
+                network: isLocalEnv ? "local" : "ic",
             }, "initializing");
-            if (this.isLocalEnv) {
+            if (isLocalEnv) {
                 try {
                     yield this._agent.fetchRootKey();
                 }
@@ -83,7 +84,6 @@ class AgentManager {
             }
             else if (options) {
                 this._agent = new agent_1.HttpAgent(options);
-                this.isLocalEnv = this._agent.isLocal();
                 yield this.initializeAgent();
             }
             yield this.notifySubscribers();
@@ -116,7 +116,7 @@ class AgentManager {
             if (!this._auth) {
                 throw new Error("Auth client not initialized");
             }
-            yield this._auth.login(Object.assign(Object.assign({ identityProvider: this.isLocalEnv
+            yield this._auth.login(Object.assign(Object.assign({ identityProvider: this.getIsLocal()
                     ? constants_1.LOCAL_INTERNET_IDENTITY_PROVIDER
                     : constants_1.IC_INTERNET_IDENTITY_PROVIDER }, options), { onSuccess: () => __awaiter(this, void 0, void 0, function* () {
                     var _b;
@@ -135,6 +135,9 @@ class AgentManager {
         this.getAgent = () => {
             return this._agent;
         };
+        this.getIsLocal = () => {
+            return this._agent.isLocal();
+        };
         this.getAgentState = () => {
             return this.agentStore.getState();
         };
@@ -177,7 +180,6 @@ class AgentManager {
             store: "auth",
         });
         this._agent = new agent_1.HttpAgent(Object.assign(Object.assign({}, agentOptions), { host }));
-        this.isLocalEnv = this._agent.isLocal();
         this.initializeAgent();
     }
 }

package/dist/createActorManager.d.ts

@@ -7,6 +7,6 @@ import { ActorManagerParameters, BaseActor } from "./types";
  * It also provides a way to interact with the actor's state.
  *
  * @category Main
- * @includeExample ./packages/core/README.md:262-277
+ * @includeExample ./packages/core/README.md:268-283
  */
 export declare const createActorManager: <A = BaseActor>(config: ActorManagerParameters) => ActorManager<A>;

package/dist/createActorManager.js

@@ -9,7 +9,7 @@ const actor_1 = require("./classes/actor");
  * It also provides a way to interact with the actor's state.
  *
  * @category Main
- * @includeExample ./packages/core/README.md:262-277
+ * @includeExample ./packages/core/README.md:268-283
  */
 const createActorManager = (config) => {
     return new actor_1.ActorManager(config);

package/dist/createAgentManager.d.ts

@@ -7,6 +7,6 @@ import { AgentManagerParameters } from "./types";
  * login and logout to the internet identity.
  *
  * @category Main
- * @includeExample ./packages/core/README.md:226-254
+ * @includeExample ./packages/core/README.md:232-260
  */
 export declare const createAgentManager: (config?: AgentManagerParameters) => AgentManager;

package/dist/createAgentManager.js

@@ -9,7 +9,7 @@ const agent_1 = require("./classes/agent");
  * login and logout to the internet identity.
  *
  * @category Main
- * @includeExample ./packages/core/README.md:226-254
+ * @includeExample ./packages/core/README.md:232-260
  */
 const createAgentManager = (config) => {
     return new agent_1.AgentManager(config);

package/dist/createCandidAdapter.d.ts

@@ -6,6 +6,6 @@ import { CandidAdapterParameters } from "./types";
  * If both methods fail, it throws an error.
  *
  * @category Main
- * @includeExample ./packages/core/README.md:145-186
+ * @includeExample ./packages/core/README.md:151-192
  */
 export declare const createCandidAdapter: (config: CandidAdapterParameters) => CandidAdapter;

package/dist/createCandidAdapter.js

@@ -8,7 +8,7 @@ const candid_1 = require("./classes/candid");
  * If both methods fail, it throws an error.
  *
  * @category Main
- * @includeExample ./packages/core/README.md:145-186
+ * @includeExample ./packages/core/README.md:151-192
  */
 const createCandidAdapter = (config) => {
     return new candid_1.CandidAdapter(config);

package/dist/createReactorCore.d.ts

@@ -5,6 +5,6 @@ import type { BaseActor, CreateReactorCoreParameters, CreateReactorCoreReturnTyp
  * Its create a new agent manager if not provided.
  *
  * @category Main
- * @includeExample ./packages/core/README.md:26-80
+ * @includeExample ./packages/core/README.md:32-86
  */
 export declare const createReactorCore: <A = BaseActor>(config: CreateReactorCoreParameters) => CreateReactorCoreReturnType<A>;

package/dist/createReactorCore.js

@@ -29,7 +29,7 @@ const createReactorStore_1 = require("./createReactorStore");
  * Its create a new agent manager if not provided.
  *
  * @category Main
- * @includeExample ./packages/core/README.md:26-80
+ * @includeExample ./packages/core/README.md:32-86
  */
 const createReactorCore = (config) => {
     const _a = (0, createReactorStore_1.createReactorStore)(config), { subscribeActorState, updateMethodState, callMethod, getState, agentManager } = _a, rest = __rest(_a, ["subscribeActorState", "updateMethodState", "callMethod", "getState", "agentManager"]);

package/dist/createReactorStore.d.ts

@@ -6,6 +6,6 @@ import type { BaseActor, CreateReactorStoreParameters } from "./types";
  * It also creates a new actor manager with the given options.
  *
  * @category Main
- * @includeExample ./packages/core/README.md:194-220
+ * @includeExample ./packages/core/README.md:200-226
  */
 export declare const createReactorStore: <A = BaseActor>(config: CreateReactorStoreParameters) => ActorManager<A>;

package/dist/createReactorStore.js

@@ -21,7 +21,7 @@ const createAgentManager_1 = require("./createAgentManager");
  * It also creates a new actor manager with the given options.
  *
  * @category Main
- * @includeExample ./packages/core/README.md:194-220
+ * @includeExample ./packages/core/README.md:200-226
  */
 const createReactorStore = (config) => {
     const withLocalEnv = config.withProcessEnv

package/dist/utils/helper.d.ts

@@ -1,11 +1,12 @@
 import { DevtoolsOptions } from "zustand/middleware";
-import type { BaseActor } from "../types";
+import type { BaseActor, IDL } from "../types";
 export declare function createStoreWithOptionalDevtools<T>(initialState: T, config: DevtoolsOptions): Omit<import("zustand/vanilla").StoreApi<T>, "setState"> & {
     setState<A extends string | {
         type: string;
     }>(partial: T | Partial<T> | ((state: T) => T | Partial<T>), replace?: boolean | undefined, action?: A | undefined): void;
 };
 export declare const isInLocalOrDevelopment: () => boolean;
+export declare function isQuery(func: IDL.FuncClass): boolean;
 export declare const jsonToString: (json: unknown, space?: number) => string;
 export declare const generateRequestHash: (args?: unknown[]) => `0x${string}`;
 export declare const generateHash: (field?: unknown) => `0x${string}`;

package/dist/utils/helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringToHash = exports.generateActorHash = exports.generateHash = exports.generateRequestHash = exports.jsonToString = exports.isInLocalOrDevelopment = exports.createStoreWithOptionalDevtools = void 0;
+exports.stringToHash = exports.generateActorHash = exports.generateHash = exports.generateRequestHash = exports.jsonToString = exports.isQuery = exports.isInLocalOrDevelopment = exports.createStoreWithOptionalDevtools = void 0;
 const agent_1 = require("@dfinity/agent");
 const middleware_1 = require("zustand/middleware");
 const vanilla_1 = require("zustand/vanilla");
@@ -21,6 +21,11 @@ const isInLocalOrDevelopment = () => {
             process.env.NODE_ENV === "development"));
 };
 exports.isInLocalOrDevelopment = isInLocalOrDevelopment;
+function isQuery(func) {
+    return (func.annotations.includes("query") ||
+        func.annotations.includes("composite_query"));
+}
+exports.isQuery = isQuery;
 const jsonToString = (json, space = 2) => {
     return JSON.stringify(json, (_, value) => (typeof value === "bigint" ? `BigInt(${value})` : value), space);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ic-reactor/core",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "A library for intracting with the Internet Computer canisters",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -52,5 +52,5 @@
   "engines": {
     "node": ">=10"
   },
-  "gitHead": "9d79b40cd3306d2f363ac7ab3a6b9815300648d6"
+  "gitHead": "25043c2d1a78b97e327995abaf13835ac511e5d6"
 }