@ic-reactor/core 1.14.2 → 1.15.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.14.0/ic-reactor-core.min.js"></script>
+<script src="https://github.com/B3Pay/ic-reactor/releases/download/v1.14.2/ic-reactor-core.min.js"></script>
 ```
 
 ### Using `createReactorCore`

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

@@ -24,6 +24,7 @@ export declare class ActorManager<A = BaseActor> {
     private _getActorMethod;
     callMethod: <M extends FunctionName<A>>(functionName: M, ...args: ActorMethodParameters<A[M]>) => Promise<ActorMethodReturnType<A[M]>>;
     callMethodWithOptions: (options: CallConfig) => <M extends FunctionName<A>>(functionName: M, ...args: ActorMethodParameters<A[M]>) => Promise<ActorMethodReturnType<A[M]>>;
+    call: <M extends FunctionName<A>>(functionName: M, ...args: ActorMethodParameters<A[M]>) => Promise<ActorMethodReturnType<A[M]>>;
     get agentManager(): AgentManager;
     getActor: () => A | null;
     getState: ActorStore<A>["getState"];

package/dist/classes/actor/index.js

@@ -122,6 +122,29 @@ class ActorManager {
                 return data;
             });
         };
+        this.call = (functionName, ...args) => __awaiter(this, void 0, void 0, function* () {
+            const requestHash = (0, helper_1.generateRequestHash)(args);
+            try {
+                this.updateMethodState(functionName, requestHash, {
+                    loading: true,
+                    error: undefined,
+                });
+                const data = yield this.callMethod(functionName, ...args);
+                this.updateMethodState(functionName, requestHash, {
+                    loading: false,
+                    data,
+                });
+                return data;
+            }
+            catch (error) {
+                this.updateMethodState(functionName, requestHash, {
+                    loading: false,
+                    error: error,
+                    data: undefined,
+                });
+                throw error;
+            }
+        });
         // actor store
         this.getActor = () => {
             return this._actor;

package/dist/classes/types.d.ts

@@ -1,7 +1,7 @@
 export * from "./agent/types";
 export * from "./actor/types";
 export * from "./adapter/types";
-import { NamedSet } from "zustand/middleware";
+import type { NamedSet } from "zustand/middleware";
 import type { StoreApi } from "zustand";
 export interface StoreApiWithDevtools<T> extends StoreApi<T> {
     setState: NamedSet<T>;

package/dist/types.d.ts

@@ -79,17 +79,19 @@ export type ExtractOk<T> = T extends {
 export type ExtractErr<T> = T extends {
     Err: infer E;
 } ? E : never;
-export type CompiledResult<T> = ExtractOkErr<T> extends {
-    OkType: infer U;
-    ErrType: infer E;
-} ? {
+export type CompiledOkResult<U> = {
     isOk: true;
     isErr: false;
     value: U;
     error: null;
-} | {
+};
+export type CompiledErrResult<E> = {
     isOk: false;
     isErr: true;
     value: null;
     error: E;
-} : never;
+};
+export type CompiledResult<T> = ExtractOkErr<T> extends {
+    OkType: infer U;
+    ErrType: infer E;
+} ? CompiledOkResult<U> | CompiledErrResult<E> : never;

package/dist/utils/helper.d.ts

@@ -1,18 +1,58 @@
 import { DevtoolsOptions } from "zustand/middleware";
-import type { CompiledResult, BaseActor, CandidDefenition, 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;
-};
+import { StoreApi } from "zustand";
+import type { CompiledResult, BaseActor, CandidDefenition, IDL, StoreApiWithDevtools, ExtractOk } from "../types";
+/**
+ * Creates a Zustand store with optional DevTools middleware.
+ *
+ * @param initialState - The initial state of the store.
+ * @param config - Configuration options for DevTools.
+ * @returns A Zustand store with DevTools enabled if configured, otherwise a standard store.
+ */
+export declare function createStoreWithOptionalDevtools<T>(initialState: T, config: DevtoolsOptions): StoreApiWithDevtools<T> | StoreApi<T>;
 export declare const importCandidDefinition: (candidDef: string) => Promise<CandidDefenition>;
+/**
+ * Checks if the current environment is local or development.
+ *
+ * @returns `true` if running in a local or development environment, otherwise `false`.
+ */
 export declare const isInLocalOrDevelopment: () => boolean;
+/**
+ * Retrieves the network from the process environment variables.
+ *
+ * @returns The network name, defaulting to "ic" if not specified.
+ */
 export declare const getProcessEnvNetwork: () => string;
+/**
+ * Determines the network type based on the provided hostname.
+ *
+ * @param hostname - The hostname to evaluate.
+ * @returns A string indicating the network type: "local", "remote", or "ic".
+ */
 export declare function getNetworkByHostname(hostname: string): "local" | "remote" | "ic";
+/**
+ * Checks if a given IDL function is a query.
+ *
+ * @param func - The IDL function to check.
+ * @returns `true` if the function is a query or composite query, otherwise `false`.
+ */
 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}`;
 export declare const generateActorHash: (actor: BaseActor) => `0x${string}`;
 export declare const stringToHash: (str: string) => `0x${string}`;
+/**
+ * Helper function for extracting the value from a compiled result { Ok: T } or { Err: E }
+ *
+ * @param result - The compiled result to extract from.
+ * @returns A `CompiledResult` object indicating success or failure.
+ */
 export declare function createCompiledResult<T>(result: T): CompiledResult<T>;
+/**
+ * Helper function for extracting the value from a compiled result { Ok: T } or throw the error if { Err: E }
+ *
+ * @param result - The compiled result to extract from.
+ * @returns The extracted value from the compiled result.
+ * @throws The error from the compiled result.
+ */
+export declare function extractOkResult<T>(result: T): ExtractOk<T>;

package/dist/utils/helper.js

@@ -14,19 +14,27 @@ exports.createStoreWithOptionalDevtools = createStoreWithOptionalDevtools;
 exports.getNetworkByHostname = getNetworkByHostname;
 exports.isQuery = isQuery;
 exports.createCompiledResult = createCompiledResult;
+exports.extractOkResult = extractOkResult;
 const agent_1 = require("@dfinity/agent");
 const middleware_1 = require("zustand/middleware");
-const vanilla_1 = require("zustand/vanilla");
+const zustand_1 = require("zustand");
 const hash_1 = require("./hash");
 const constants_1 = require("./constants");
+/**
+ * Creates a Zustand store with optional DevTools middleware.
+ *
+ * @param initialState - The initial state of the store.
+ * @param config - Configuration options for DevTools.
+ * @returns A Zustand store with DevTools enabled if configured, otherwise a standard store.
+ */
 function createStoreWithOptionalDevtools(initialState, config) {
     if (config.withDevtools) {
-        return (0, vanilla_1.createStore)((0, middleware_1.devtools)(() => initialState, Object.assign({ serialize: {
+        return (0, zustand_1.createStore)((0, middleware_1.devtools)(() => initialState, Object.assign({ serialize: {
                 replacer: (_, value) => typeof value === "bigint" ? value.toString() : value,
             } }, config)));
     }
     else {
-        return (0, vanilla_1.createStore)(() => initialState);
+        return (0, zustand_1.createStore)(() => initialState);
     }
 }
 const importCandidDefinition = (candidDef) => __awaiter(void 0, void 0, void 0, function* () {
@@ -58,10 +66,20 @@ const importCandidDefinition = (candidDef) => __awaiter(void 0, void 0, void 0,
     }
 });
 exports.importCandidDefinition = importCandidDefinition;
+/**
+ * Checks if the current environment is local or development.
+ *
+ * @returns `true` if running in a local or development environment, otherwise `false`.
+ */
 const isInLocalOrDevelopment = () => {
     return typeof process !== "undefined" && process.env.DFX_NETWORK === "local";
 };
 exports.isInLocalOrDevelopment = isInLocalOrDevelopment;
+/**
+ * Retrieves the network from the process environment variables.
+ *
+ * @returns The network name, defaulting to "ic" if not specified.
+ */
 const getProcessEnvNetwork = () => {
     var _a;
     if (typeof process === "undefined")
@@ -70,6 +88,12 @@ const getProcessEnvNetwork = () => {
         return (_a = process.env.DFX_NETWORK) !== null && _a !== void 0 ? _a : "ic";
 };
 exports.getProcessEnvNetwork = getProcessEnvNetwork;
+/**
+ * Determines the network type based on the provided hostname.
+ *
+ * @param hostname - The hostname to evaluate.
+ * @returns A string indicating the network type: "local", "remote", or "ic".
+ */
 function getNetworkByHostname(hostname) {
     if (constants_1.LOCAL_HOSTS.some((host) => hostname.endsWith(host))) {
         return "local";
@@ -81,6 +105,12 @@ function getNetworkByHostname(hostname) {
         return "ic";
     }
 }
+/**
+ * Checks if a given IDL function is a query.
+ *
+ * @param func - The IDL function to check.
+ * @returns `true` if the function is a query or composite query, otherwise `false`.
+ */
 function isQuery(func) {
     return (func.annotations.includes("query") ||
         func.annotations.includes("composite_query"));
@@ -112,7 +142,12 @@ exports.stringToHash = stringToHash;
 function toHexString(bytes) {
     return (0, agent_1.toHex)(bytes);
 }
-/// Helper function for extracting the value from a compiled result { Ok: T } or { Err: E }
+/**
+ * Helper function for extracting the value from a compiled result { Ok: T } or { Err: E }
+ *
+ * @param result - The compiled result to extract from.
+ * @returns A `CompiledResult` object indicating success or failure.
+ */
 function createCompiledResult(result) {
     if (result && typeof result === "object" && "Ok" in result) {
         return {
@@ -140,3 +175,17 @@ function createCompiledResult(result) {
         };
     }
 }
+/**
+ * Helper function for extracting the value from a compiled result { Ok: T } or throw the error if { Err: E }
+ *
+ * @param result - The compiled result to extract from.
+ * @returns The extracted value from the compiled result.
+ * @throws The error from the compiled result.
+ */
+function extractOkResult(result) {
+    const compiledResult = createCompiledResult(result);
+    if (compiledResult.isErr) {
+        throw compiledResult.error;
+    }
+    return compiledResult.value;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ic-reactor/core",
-  "version": "1.14.2",
+  "version": "1.15.0",
   "description": "A library for intracting with the Internet Computer canisters",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -32,7 +32,7 @@
     "@dfinity/identity": ">=2.1",
     "@dfinity/principal": ">=2.1",
     "simple-cbor": "^0.4.1",
-    "zustand": "4.5.5"
+    "zustand": "5.0.2"
   },
   "peerDependencies": {
     "@dfinity/agent": ">=2.1",
@@ -48,7 +48,7 @@
     "webpack": "^5.96.1"
   },
   "scripts": {
-    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest",
+    "test": "NODE_OPTIONS=\"--experimental-vm-modules\" npx jest",
     "start": "tsc watch",
     "bundle": "yarn bundle:dev && yarn bundle:prod",
     "bundle:dev": "npx webpack-cli --mode development",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=10"
   },
-  "gitHead": "77d882f8af5d203240e82350171a57185df38e35"
+  "gitHead": "4c6badf97d6d2845f6bed00bf21274a72dc68134"
 }