@ic-reactor/react 1.0.2 → 1.0.4

package/dist/types.d.ts

@@ -1,76 +1,11 @@
-/// <reference types="react" />
-import type { ActorState, CanisterId, CreateReactorOptions, ActorMethodArgs, ActorMethodReturnType, HttpAgent, Identity, Principal, FunctionName, VisitService } from "@ic-reactor/core/dist/types";
-import type { AgentHooks, AuthHooks } from "./helpers/types";
+import type { HttpAgent, VisitService } from "@ic-reactor/core/dist/types";
+import type { ActorHooks, AgentHooks, AuthHooks } from "./helpers/types";
 export * from "@ic-reactor/core/dist/types";
-export * from "./context/agent/types";
-export * from "./context/actor/types";
+export * from "./provider/agent/types";
+export * from "./provider/actor/types";
+export * from "./hooks/types";
 export * from "./helpers/types";
-export type AuthArgs = {
-    onAuthentication?: (promise: () => Promise<Identity>) => void;
-    onAuthenticationSuccess?: (identity: Identity) => void;
-    onAuthenticationFailure?: (error: Error) => void;
-    onLoginSuccess?: (principal: Principal) => void;
-    onLoginError?: (error: Error) => void;
-    onLogin?: (promise: () => Promise<Principal>) => void;
-    onLoggedOut?: () => void;
-};
-export type ActorCallArgs<A, M extends FunctionName<A>> = {
-    functionName: M;
-    args?: ActorMethodArgs<A[M]>;
-    onLoading?: (loading: boolean) => void;
-    onError?: (error: Error | undefined) => void;
-    onSuccess?: (data: ActorMethodReturnType<A[M]> | undefined) => void;
-    throwOnError?: boolean;
-};
-export type ActorHookState<A, M extends FunctionName<A>> = {
-    data: ActorMethodReturnType<A[M]> | undefined;
-    error: Error | undefined;
-    loading: boolean;
-};
-export interface ActorUseQueryArgs<A, M extends FunctionName<A>> extends ActorCallArgs<A, M> {
-    refetchOnMount?: boolean;
-    refetchInterval?: number | false;
-}
-export interface ActorUseUpdateArgs<A, M extends FunctionName<A>> extends ActorCallArgs<A, M> {
-}
-export type ActorCallReturn<A, M extends FunctionName<A>> = ActorHookState<A, M> & {
-    reset: () => void;
-    call: (eventOrReplaceArgs?: React.MouseEvent | ActorMethodArgs<A[M]>) => Promise<ActorMethodReturnType<A[M]> | undefined>;
-};
-export type ActorCall<A> = <M extends FunctionName<A>>(args: ActorCallArgs<A, M>) => ActorCallReturn<A, M>;
-export type ActorQueryCall<A> = <M extends FunctionName<A>>(args: ActorUseQueryArgs<A, M>) => ActorCallReturn<A, M>;
-export type ActorUpdateCall<A> = <M extends FunctionName<A>>(args: ActorUseUpdateArgs<A, M>) => ActorCallReturn<A, M>;
-export type ActorMethodCall<A, M extends FunctionName<A>> = (args: ActorUseMethodCallArg<A, M>) => ActorUseMethodCallReturn<A, M>;
-export interface ActorUseMethodCallReturn<A, M extends FunctionName<A>, F extends boolean = false> extends ActorCallReturn<A, M> {
-    visit: F extends true ? VisitService<A>[M] : undefined;
-    reset: () => void;
-    error: Error | undefined;
-    loading: boolean;
-}
-export type ActorUseMethodCallArg<A, M extends FunctionName<A>> = ActorCallArgs<A, M>;
-export type ActorHooks<A, F extends boolean = false> = ActorDefaultHooks<A, F> & (F extends true ? ActorFieldHooks<A> : object);
-export interface ActorFieldHooks<A> {
-    useVisitMethod: <M extends FunctionName<A>>(functionName: M) => VisitService<A>[M];
-}
-export type UseActorStoreReturn<A> = ActorState<A> & {
-    canisterId: CanisterId;
-};
-export interface ActorDefaultHooks<A, F extends boolean> {
-    initialize: () => Promise<void>;
-    useActorState: () => UseActorStoreReturn<A>;
-    useQueryCall: ActorQueryCall<A>;
-    useUpdateCall: ActorUpdateCall<A>;
-    useMethodCall: <M extends FunctionName<A>>(args: ActorUseMethodCallArg<A, M>) => ActorUseMethodCallReturn<A, M, F>;
-}
-export type GetFunctions<A> = {
+export interface CreateReactorReturn<A> extends ActorHooks<A>, AuthHooks, AgentHooks {
     getAgent: () => HttpAgent;
     getVisitFunction: () => VisitService<A>;
-};
-export type CreateReactor = {
-    <A>(options: CreateReactorOptions & {
-        withVisitor: true;
-    }): GetFunctions<A> & ActorHooks<A, true> & AuthHooks & AgentHooks;
-    <A>(options: CreateReactorOptions & {
-        withVisitor?: false | undefined;
-    }): GetFunctions<A> & ActorHooks<A, false> & AuthHooks & AgentHooks;
-};
+}

package/dist/types.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("@ic-reactor/core/dist/types"), exports);
-__exportStar(require("./context/agent/types"), exports);
-__exportStar(require("./context/actor/types"), exports);
+__exportStar(require("./provider/agent/types"), exports);
+__exportStar(require("./provider/actor/types"), exports);
+__exportStar(require("./hooks/types"), exports);
 __exportStar(require("./helpers/types"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ic-reactor/react",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "A React library for interacting with Internet Computer canisters",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -35,7 +35,7 @@
     "node": ">=10"
   },
   "dependencies": {
-    "@ic-reactor/core": "^1.0.2",
+    "@ic-reactor/core": "^1.0.3",
     "zustand-utils": "^1.3"
   },
   "peerDependencies": {
@@ -48,5 +48,5 @@
     "react": ">=16.8",
     "zustand": "4.5"
   },
-  "gitHead": "4d19bef671056c8046ec64037f51d85380ff5bae"
+  "gitHead": "031413fceeddbdac2fa281e1e07940182ac1e1ef"
 }

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

@@ -1,16 +0,0 @@
-import React from "react";
-import { ActorUseMethodCallArg, ActorUseQueryArgs, ActorUseUpdateArgs } from "../../types";
-import { CreateActorOptions, ActorContextType, ActorProviderProps } from "./types";
-import type { ActorSubclass } from "@dfinity/agent";
-export declare const ActorContext: React.Context<ActorContextType | null>, ActorProvider: React.FC<ActorProviderProps>, useActorContext: <A extends unknown = unknown>() => ActorContextType<A>, useActorState: () => import("../../types").UseActorStoreReturn<unknown>, useQueryCall: <M extends never>(args: ActorUseQueryArgs<unknown, M>) => import("../../types").ActorCallReturn<unknown, M>, useUpdateCall: <M extends never>(args: ActorUseUpdateArgs<unknown, M>) => import("../../types").ActorCallReturn<unknown, M>, useMethodCall: <M extends never>(args: ActorUseMethodCallArg<unknown, M>) => import("../../types").ActorUseMethodCallReturn<unknown, M, true>, useVisitMethod: (functionName: never) => never;
-export declare function createReactorContext<Actor extends ActorSubclass<any>>({ canisterId: defaultCanisterId, ...defaultConfig }?: Partial<CreateActorOptions>): {
-    ActorContext: React.Context<ActorContextType | null>;
-    ActorProvider: React.FC<ActorProviderProps>;
-    useActorContext: <A extends unknown = Actor>() => ActorContextType<A>;
-    useActorState: () => import("../../types").UseActorStoreReturn<Actor>;
-    useQueryCall: <M extends keyof Actor & string>(args: ActorUseQueryArgs<Actor, M>) => import("../../types").ActorCallReturn<Actor, M>;
-    useUpdateCall: <M_1 extends keyof Actor & string>(args: ActorUseUpdateArgs<Actor, M_1>) => import("../../types").ActorCallReturn<Actor, M_1>;
-    useMethodCall: <M_2 extends keyof Actor & string>(args: ActorUseMethodCallArg<Actor, M_2>) => import("../../types").ActorUseMethodCallReturn<Actor, M_2, true>;
-    useVisitMethod: (functionName: keyof Actor & string) => import("@ic-reactor/core/dist/actor/types").VisitService<Actor>[keyof Actor & string];
-    initialize: () => Promise<void>;
-};

package/dist/context/actor/index.js

@@ -1,88 +0,0 @@
-"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 __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;
-};
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createReactorContext = exports.useVisitMethod = exports.useMethodCall = exports.useUpdateCall = exports.useQueryCall = exports.useActorState = exports.useActorContext = exports.ActorProvider = exports.ActorContext = void 0;
-/* eslint-disable @typescript-eslint/no-explicit-any */
-const react_1 = __importStar(require("react"));
-const actor_1 = require("../../helpers/actor");
-const useActor_1 = require("../../hooks/useActor");
-_a = createReactorContext(), exports.ActorContext = _a.ActorContext, exports.ActorProvider = _a.ActorProvider, exports.useActorContext = _a.useActorContext, exports.useActorState = _a.useActorState, exports.useQueryCall = _a.useQueryCall, exports.useUpdateCall = _a.useUpdateCall, exports.useMethodCall = _a.useMethodCall, exports.useVisitMethod = _a.useVisitMethod;
-function createReactorContext(_a = {}) {
-    var { canisterId: defaultCanisterId } = _a, defaultConfig = __rest(_a, ["canisterId"]);
-    const ActorContext = (0, react_1.createContext)(null);
-    const ActorProvider = (_a) => {
-        var { children, canisterId = defaultCanisterId, loadingComponent = react_1.default.createElement("div", null, "Fetching canister...") } = _a, restConfig = __rest(_a, ["children", "canisterId", "loadingComponent"]);
-        if (!canisterId) {
-            throw new Error("canisterId is required");
-        }
-        const config = (0, react_1.useMemo)(() => (Object.assign(Object.assign({}, defaultConfig), restConfig)), [defaultConfig, restConfig]);
-        const { actorManager, fetchError, fetching } = (0, useActor_1.useActor)(Object.assign({ canisterId }, config));
-        const hooks = (0, react_1.useMemo)(() => {
-            if (actorManager) {
-                return (0, actor_1.getActorHooks)(actorManager);
-            }
-            return null;
-        }, [actorManager === null || actorManager === void 0 ? void 0 : actorManager.canisterId]);
-        return (react_1.default.createElement(ActorContext.Provider, { value: hooks }, fetching || hooks === null ? fetchError !== null && fetchError !== void 0 ? fetchError : loadingComponent : children));
-    };
-    ActorProvider.displayName = "ActorProvider";
-    const useActorContext = () => {
-        const context = (0, react_1.useContext)(ActorContext);
-        if (!context) {
-            throw new Error("useActor must be used within a ActorProvider");
-        }
-        return context;
-    };
-    const initialize = () => useActorContext().initialize();
-    const useActorState = () => useActorContext().useActorState();
-    const useQueryCall = (args) => useActorContext().useQueryCall(args);
-    const useUpdateCall = (args) => useActorContext().useUpdateCall(args);
-    const useMethodCall = (args) => useActorContext().useMethodCall(args);
-    const useVisitMethod = (functionName) => useActorContext().useVisitMethod(functionName);
-    return {
-        ActorContext,
-        ActorProvider,
-        useActorContext,
-        useActorState,
-        useQueryCall,
-        useUpdateCall,
-        useMethodCall,
-        useVisitMethod,
-        initialize,
-    };
-}
-exports.createReactorContext = createReactorContext;

package/dist/hooks/useActor.d.ts

@@ -1,21 +0,0 @@
-import { IDL } from "@dfinity/candid";
-import { ActorManagerOptions, BaseActor } from "@ic-reactor/core/dist/types";
-import { AgentContextType } from "../types";
-interface DynamicActorArgs extends Omit<ActorManagerOptions, "idlFactory" | "agentManager" | "canisterId"> {
-    canisterId: string;
-    idlFactory?: IDL.InterfaceFactory;
-    agentContext?: AgentContextType;
-    didjsCanisterId?: string;
-}
-/**
- * A hook to create an actor manager and fetch the actor's candid interface.
- *
- * @category Hooks
- */
-export declare const useActor: <A = BaseActor>({ canisterId, agentContext, idlFactory: maybeIdlFactory, didjsCanisterId, ...config }: DynamicActorArgs) => {
-    fetchCandid: () => Promise<import("@ic-reactor/core/dist/types").CandidDefenition | undefined>;
-    fetching: boolean;
-    fetchError: string | null;
-    actorManager: import("@ic-reactor/core").ActorManager<A> | null;
-};
-export {};

package/dist/hooks/useActor.js

@@ -1,48 +0,0 @@
-"use strict";
-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 });
-exports.useActor = void 0;
-const core_1 = require("@ic-reactor/core");
-const react_1 = require("react");
-const agent_1 = require("../context/agent");
-const useCandid_1 = require("./useCandid");
-/**
- * A hook to create an actor manager and fetch the actor's candid interface.
- *
- * @category Hooks
- */
-const useActor = (_a) => {
-    var { canisterId, agentContext, idlFactory: maybeIdlFactory, didjsCanisterId } = _a, config = __rest(_a, ["canisterId", "agentContext", "idlFactory", "didjsCanisterId"]);
-    const agentManager = (0, agent_1.useAgentManager)(agentContext);
-    const _b = (0, useCandid_1.useCandid)({
-        canisterId,
-        didjsCanisterId,
-        idlFactory: maybeIdlFactory,
-    }), { candid: { idlFactory } } = _b, rest = __rest(_b, ["candid"]);
-    const actorManager = (0, react_1.useMemo)(() => {
-        if (!idlFactory) {
-            return null;
-        }
-        else {
-            const manager = (0, core_1.createReactorStore)({
-                agentManager,
-                idlFactory,
-                canisterId,
-                withDevtools: config.withDevtools,
-            });
-            return manager;
-        }
-    }, [idlFactory]);
-    return Object.assign({ actorManager }, rest);
-};
-exports.useActor = useActor;

package/dist/hooks/useCandid.d.ts

@@ -1,18 +0,0 @@
-import type { IDL } from "@dfinity/candid";
-interface UseIDLFactoryArgs {
-    canisterId: string;
-    didjsCanisterId?: string;
-    idlFactory?: IDL.InterfaceFactory;
-}
-export declare const useCandid: ({ canisterId, didjsCanisterId, idlFactory, }: UseIDLFactoryArgs) => {
-    fetchCandid: () => Promise<import("@ic-reactor/core/dist/types").CandidDefenition | undefined>;
-    candid: {
-        idlFactory?: IDL.InterfaceFactory | undefined;
-        init: ({ idl }: {
-            idl: typeof IDL;
-        }) => never[];
-    };
-    fetching: boolean;
-    fetchError: string | null;
-};
-export {};

package/dist/hooks/useCandid.js

@@ -1,54 +0,0 @@
-"use strict";
-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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useCandid = void 0;
-const react_1 = require("react");
-const core_1 = require("@ic-reactor/core");
-const agent_1 = require("../context/agent");
-const DEFAULT_STATE = {
-    candid: { idlFactory: undefined, init: () => [] },
-    fetching: false,
-    fetchError: null,
-};
-const useCandid = ({ canisterId, didjsCanisterId, idlFactory, }) => {
-    const [{ candid, fetchError, fetching }, setCandid] = (0, react_1.useState)(Object.assign(Object.assign({}, DEFAULT_STATE), { candid: {
-            idlFactory,
-            init: () => [],
-        } }));
-    const agent = (0, agent_1.useAgent)();
-    const fetchCandid = (0, react_1.useCallback)(() => __awaiter(void 0, void 0, void 0, function* () {
-        if (!canisterId || !agent)
-            return;
-        setCandid((prevState) => (Object.assign(Object.assign({}, prevState), { candid: DEFAULT_STATE.candid, fetching: true, fetchError: null })));
-        try {
-            const candidManager = (0, core_1.createCandidAdapter)({ agent, didjsCanisterId });
-            const fetchedCandid = yield candidManager.getCandidDefinition(canisterId);
-            setCandid({
-                candid: fetchedCandid,
-                fetching: false,
-                fetchError: null,
-            });
-            return fetchedCandid;
-        }
-        catch (err) {
-            // eslint-disable-next-line no-console
-            console.error(err);
-            setCandid((prevState) => (Object.assign(Object.assign({}, prevState), { fetchError: `Error fetching canister ${canisterId}`, fetching: false })));
-        }
-    }), [canisterId, didjsCanisterId, agent]);
-    (0, react_1.useEffect)(() => {
-        if (!fetching && !idlFactory) {
-            fetchCandid();
-        }
-    }, [fetchCandid]);
-    return { fetchCandid, candid, fetching, fetchError };
-};
-exports.useCandid = useCandid;