@ic-reactor/core 0.0.1

package/LICENSE.md

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2023 B3Pay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,93 @@
+# IC-ReActor - Core
+
+ReActor is a JavaScript utility designed to streamline state management and interaction with actors in the Internet Computer (IC) blockchain environment. It provides a simple and effective way to handle asynchronous calls, state updates, and subscriptions, making it easier to build responsive and data-driven applications.
+
+## Features
+
+- **State Management**: Efficiently manage the state of your application with actor-based interactions.
+- **Asynchronous Handling**: Simplify asynchronous calls and data handling with built-in methods.
+- **Subscription Mechanism**: Subscribe to state changes and update your UI in real-time.
+- **Auto-Refresh Capability**: Automatically refresh data at specified intervals.
+- **Customizable**: Easily adaptable to various use cases within the IC ecosystem.
+
+## Installation
+
+```bash
+npm install @ic-reactor/core
+```
+
+or
+
+```bash
+yarn add @ic-reactor/core
+```
+
+## Usage
+
+To get started with ReActor, you'll need to initialize it with your actor configurations. Here's a basic example:
+
+```javascript
+import createReActor from "@ic-reactor/core"
+
+const { store, actions, initializeActor, queryCall, updateCall } =
+  createReActor(
+    (agent) =>
+      createActor("bd3sg-teaaa-aaaaa-qaaba-cai", {
+        agent,
+      }),
+    {
+      host: "https://localhost:4943",
+    }
+  )
+```
+
+### Querying Data
+
+```javascript
+const { recall, subscribe, getState } = queryCall({
+  functionName: "yourFunctionName",
+  args: ["arg1", "arg2"],
+  autoRefresh: true,
+  refreshInterval: 3000,
+})
+
+// Subscribe to changes
+const unsubscribe = subscribe((newState) => {
+  // Handle new state
+})
+
+// Fetch data
+recall().then((data) => {
+  // Handle initial data
+})
+```
+
+### Updating Data
+
+```javascript
+const { call } = updateCall({
+  functionName: "yourUpdateFunction",
+  args: ["arg1", "arg2"],
+})
+
+call().then((result) => {
+  // Handle result
+})
+```
+
+## API Reference
+
+- `queryCall`: Fetches and subscribes to data from an actor method.
+- `updateCall`: Updates data and handles state changes for an actor method.
+- `getState`: Retrieves the current state based on the request hash.
+- `subscribe`: Allows subscription to state changes.
+
+For more detailed API usage and options, please refer to the [documentation](#).
+
+## Contributing
+
+Contributions are welcome! Please read our [contributing guidelines](#) to get started.
+
+## License
+
+This project is licensed under [MIT License](LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import type { HttpAgent, HttpAgentOptions } from "@dfinity/agent";
+import type { ActorSubclass, ReActorStore } from "@ic-reactor/store";
+import { ReActorQuery, ReActorUpdate } from "./types";
+export type ReActorContextType<A = ActorSubclass<any>> = ReActorStore<A>;
+export interface CreateReActorOptions extends HttpAgentOptions {
+    initializeOnMount?: boolean;
+}
+declare const createReActor: <A extends unknown>(actorInitializer: (agent: HttpAgent) => A, options?: CreateReActorOptions) => {
+    store: ReActorStore<A>;
+    actions: import("@ic-reactor/store").ReActorStoreActions<A>;
+    initializeActor: (agentOptions?: HttpAgentOptions | undefined, identity?: import("@dfinity/agent").Identity | undefined) => void;
+    queryCall: ReActorQuery<A>;
+    updateCall: ReActorUpdate<A>;
+};
+export default createReActor;

package/dist/index.js

@@ -0,0 +1,154 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const store_1 = __importStar(require("@ic-reactor/store"));
+const defaultCreateReActorOptions = {
+    initializeOnMount: true,
+    host: process.env.NODE_ENV === "production"
+        ? "https://icp-api.io"
+        : "http://localhost:4943",
+};
+const createReActor = (actorInitializer, options = {}) => {
+    const optionsWithDefaults = Object.assign(Object.assign({}, defaultCreateReActorOptions), options);
+    const { actions, initializeActor, store } = (0, store_1.default)((agent) => actorInitializer(agent), optionsWithDefaults);
+    if (optionsWithDefaults.initializeOnMount) {
+        try {
+            initializeActor();
+        }
+        catch (e) {
+            console.error(e);
+        }
+    }
+    const updateMethodState = (method, args = [], newState) => {
+        const hash = (0, store_1.generateRequestHash)(args);
+        store.setState((state) => {
+            if (!state.actorState) {
+                console.error("Actor not initialized");
+                return state;
+            }
+            const methodState = state.actorState[method] || { states: {} };
+            const currentMethodState = methodState.states[hash] || {};
+            const updatedStates = Object.assign(Object.assign({}, methodState.states), { [hash]: Object.assign(Object.assign({}, currentMethodState), newState) });
+            return Object.assign(Object.assign({}, state), { actorState: Object.assign(Object.assign({}, state.actorState), { [method]: Object.assign(Object.assign({}, methodState), { states: updatedStates }) }) });
+        });
+        return hash;
+    };
+    const reActorMethod = (functionName, ...args) => {
+        try {
+            const requestHash = updateMethodState(functionName, args);
+            const getState = (key) => {
+                const state = store.getState().actorState[functionName].states[requestHash];
+                if (key === "data") {
+                    return state.data;
+                }
+                else if (key === "loading") {
+                    return state.loading;
+                }
+                else if (key === "error") {
+                    return state.error;
+                }
+                else {
+                    return state;
+                }
+            };
+            const subscribe = (callback) => {
+                const unsubscribe = store.subscribe((state) => {
+                    const methodState = state.actorState[functionName];
+                    const methodStateHash = methodState.states[requestHash];
+                    if (methodStateHash) {
+                        callback(methodStateHash);
+                    }
+                });
+                return unsubscribe;
+            };
+            const call = (replaceArgs) => __awaiter(void 0, void 0, void 0, function* () {
+                updateMethodState(functionName, args, {
+                    loading: true,
+                    error: undefined,
+                });
+                const data = yield actions.callMethod(functionName, ...(replaceArgs !== null && replaceArgs !== void 0 ? replaceArgs : args));
+                updateMethodState(functionName, args, { data, loading: false });
+                return data;
+            });
+            return {
+                requestHash,
+                subscribe,
+                getState,
+                call,
+            };
+        }
+        catch (error) {
+            updateMethodState(functionName, args, {
+                error: error,
+                loading: false,
+            });
+            throw error;
+        }
+    };
+    const queryCall = ({ functionName, args = [], disableInitialCall = false, autoRefresh = false, refreshInterval = 5000, }) => {
+        let intervalId = null;
+        const _a = reActorMethod(functionName, ...args), { call } = _a, rest = __rest(_a, ["call"]);
+        if (autoRefresh) {
+            intervalId = setInterval(() => {
+                call();
+            }, refreshInterval);
+        }
+        let initialData = Promise.resolve();
+        if (!disableInitialCall)
+            initialData = call();
+        return Object.assign(Object.assign({}, rest), { recall: call, initialData, intervalId });
+    };
+    const updateCall = ({ functionName, args = [] }) => {
+        return reActorMethod(functionName, ...args);
+    };
+    return {
+        store,
+        actions,
+        initializeActor,
+        queryCall,
+        updateCall,
+    };
+};
+exports.default = createReActor;

package/dist/types.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="node" />
+import { ActorMethod, ActorSubclass, ExtractReActorMethodArgs, ExtractReActorMethodReturnType, ReActorMethodState } from "@ic-reactor/store";
+export type ReActorGetStateFunction<A, M extends keyof A> = (key?: keyof ReActorMethodState<A, M>["states"][string]) => ReActorMethodState<A, M>["states"][string] | ExtractReActorMethodReturnType<A[M]> | boolean | Error | undefined;
+export type ReActorSubscribeFunction<A, M extends keyof A> = (callback: (state: ReActorMethodState<A, M>["states"][string]) => void) => () => void;
+export type ReActorCallFunction<A, M extends keyof A> = (replaceArgs?: ExtractReActorMethodArgs<A[M]>) => Promise<ExtractReActorMethodReturnType<A[M]>>;
+export type ReActorQueryReturn<A, M extends keyof A> = {
+    intervalId: NodeJS.Timeout | null;
+    requestHash: string;
+    getState: ReActorGetStateFunction<A, M>;
+    subscribe: ReActorSubscribeFunction<A, M>;
+    recall: ReActorCallFunction<A, M>;
+    initialData: Promise<ExtractReActorMethodReturnType<A[M]>>;
+};
+export type ReActorUpdateReturn<A, M extends keyof A> = {
+    requestHash: string;
+    getState: ReActorGetStateFunction<A, M>;
+    subscribe: ReActorSubscribeFunction<A, M>;
+    call: ReActorCallFunction<A, M>;
+};
+export type ReActorQueryArgs<A, M extends keyof A> = {
+    functionName: M;
+    args?: ExtractReActorMethodArgs<A[M]>;
+    disableInitialCall?: boolean;
+    autoRefresh?: boolean;
+    refreshInterval?: number;
+};
+export type ReActorUpdateArgs<A, M extends keyof A> = {
+    functionName: M;
+    args?: ExtractReActorMethodArgs<A[M]>;
+};
+export type ReActorMethod<A = Record<string, ActorMethod>> = <M extends keyof A>(functionName: M, ...args: ExtractReActorMethodArgs<A[M]>) => ReActorUpdateReturn<A, M>;
+export type ReActorQuery<A = Record<string, ActorMethod>> = <M extends keyof A>(options: ReActorQueryArgs<A, M>) => ReActorQueryReturn<A, M>;
+export type ReActorUpdate<A = Record<string, ActorMethod>> = <M extends keyof A>(options: ReActorUpdateArgs<A, M>) => ReActorUpdateReturn<A, M>;
+export interface ReActorCoreActions<A extends ActorSubclass<any>> {
+    queryCall: ReActorQuery<A>;
+    updateCall: ReActorUpdate<A>;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@ic-reactor/core",
+  "version": "0.0.1",
+  "description": "A React library for interacting with Dfinity actors",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:b3hr4d/ic-reactor.git"
+  },
+  "keywords": [
+    "actor",
+    "react",
+    "candid",
+    "dfinity",
+    "web3",
+    "dapp"
+  ],
+  "author": "b3hr4d",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/b3hr4d/ic-reactor/issues"
+  },
+  "homepage": "https://github.com/b3hr4d/ic-reactor/tree/main/packages/core#readme",
+  "scripts": {
+    "test": "npx jest",
+    "start": "tsc watch",
+    "build": "npx tsc",
+    "clean": "rimraf dist"
+  },
+  "engines": {
+    "node": ">=10"
+  },
+  "dependencies": {
+    "@dfinity/agent": "^0.20",
+    "@dfinity/auth-client": "^0.20",
+    "@dfinity/candid": "0.20",
+    "@dfinity/identity": "^0.20",
+    "@dfinity/principal": "^0.20",
+    "@ic-reactor/store": "^0.0.1",
+    "zustand": "4.4"
+  },
+  "peerDependencies": {
+    "@peculiar/webcrypto": "1.4"
+  },
+  "gitHead": "b1f673a150b591ad3cfbb8964794e4ea9b0ff1c2"
+}