add new custom example

.github/workflows/deploy-test.yml

@@ -0,0 +1,34 @@
+name: Test and Deploy Docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "14" # Update the Node.js version as needed
+          cache: "yarn"
+
+      - name: Install Yarn
+        run: npm install -g yarn
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build
+        run: yarn build
+
+      - name: Run Tests
+        run: |
+          yarn test
+          yarn e2e

README.md

@@ -44,6 +44,7 @@ IC-Reactor is heavily typed and provides type safety, ensuring that your code is
 ## Key Features
 
 - **React Context Integration**: Utilizes React Context for managing global state related to IC actors.
+- **Type-Safe Actor Interactions**: Type-safe interaction with IC actors using the provided actor declaration file.
 - **Custom React Hooks**: Provides custom hooks (`useQueryCall`, `useUpdateCall`, `useAuth`) for easy interaction with IC actors.
 - **Simplified Actor Interaction**: Streamlines the process of querying and updating data from IC actors.
 - **Efficient State Management**: Manages loading, error, and data states efficiently within React components.

examples/candid-react/package.json

@@ -4,6 +4,7 @@
   "private": true,
   "dependencies": {
     "@ic-reactor/react": "^*",
+    "@ic-reactor/visitor": "^*",
     "@types/node": "^16.18.68",
     "@types/react": "^18.2.45",
     "@types/react-dom": "^18.2.18",

examples/candid-react/src/components/Candid/MethodCall.tsx

@@ -8,7 +8,7 @@ export interface FormFieldsProps {
 }
 
 const MethodCall: React.FC<FormFieldsProps> = ({ functionName }) => {
-  const { call, data, loading, error, visit } = useMethodCall({
+  const { call, data, loading, error } = useMethodCall({
     functionName,
   })
 

examples/candid-react/src/components/Candid/MethodForm.tsx

@@ -2,11 +2,7 @@ import { useCallback, useState } from "react"
 import Button from "../Button"
 import Route from "./Routes"
 import { FormProvider, useForm } from "react-hook-form"
-import {
-  MethodFields,
-  ServiceDefaultValues,
-  extractAndSortArgs,
-} from "@ic-reactor/core"
+import { MethodFields } from "@ic-reactor/visitor/dist/types"
 
 interface FormProps extends MethodFields {
   callHandler: (args: never) => Promise<any>

examples/candid-react/src/components/Candid/Routes/index.tsx

@@ -6,13 +6,13 @@ import Variant, { VariantProps } from "./Variant"
 import Optional, { OptionalProps } from "./Optional"
 import Recursive, { RecursiveProps } from "./Recursive"
 import { FieldError, FieldErrorsImpl, Merge } from "react-hook-form"
-import { DynamicFieldType, FieldType } from "@ic-reactor/react"
 
 import Principal, { PrincipalProps } from "../Inputs/Principal"
 import Boolean, { BooleanProps } from "../Inputs/Boolean"
 import Number, { NumberProps } from "../Inputs/Number"
 import NullINput, { NullProps } from "../Inputs/Null"
 import Text, { TextProps } from "../Inputs/Text"
+import { DynamicFieldType, FieldType } from "@ic-reactor/visitor/dist/types"
 
 export interface RouteProps<T extends FieldType = any> {
   extractedField: DynamicFieldType<T>

examples/candid-react/src/components/CandidViewer.tsx

@@ -1,11 +1,15 @@
-import { AgentProvider, extractActorHooks, useActor } from "@ic-reactor/react"
+import { AgentProvider, useActor } from "@ic-reactor/react"
 import { createContext } from "react"
-import type { ActorHooks } from "@ic-reactor/react/dist/types"
 import type { Ledger } from "../declarations/ledger"
+import { extractActorContext } from "@ic-reactor/react/dist/helpers"
+import { ActorHooksReturnType } from "@ic-reactor/react/dist/types"
 
-const ActorContext = createContext<ActorHooks<Ledger> | null>(null)
+const ActorContext = createContext<ActorHooksReturnType<Ledger> | null>(null)
 
-export const { useQueryCall, useUpdateCall } = extractActorHooks(ActorContext)
+export const {
+  useLedgerQueryCall: useQueryCall,
+  useLedgerUpdateCall: useUpdateCall,
+} = extractActorContext(ActorContext)
 
 const Reactor = () => {
   const { hooks, fetching, fetchError } = useActor<Ledger>({

examples/custom-provider/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

examples/custom-provider/README.md

@@ -0,0 +1,46 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).

examples/custom-provider/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "custom-provider",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@ic-reactor/react": "^*",
+    "@ic-reactor/visitor": "^*",
+    "@types/node": "^16.18.68",
+    "@types/react": "^18.2.45",
+    "@types/react-dom": "^18.2.18",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-hook-form": "^7.49.2",
+    "react-scripts": "5.0.1",
+    "typescript": "^5.3"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  }
+}

examples/custom-provider/public/index.html

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="utf-8" />
+  <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <meta name="theme-color" content="#000000" />
+  <meta name="description" content="Candid React Demo" />
+  <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+  <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+  <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+  <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+  <title>
+    Candid React Demo
+  </title>
+</head>
+
+<body>
+  <noscript>You need to enable JavaScript to run this app.</noscript>
+  <div id="root"></div>
+  <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+</body>
+
+</html>

examples/custom-provider/public/manifest.json

@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

examples/custom-provider/public/robots.txt

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:

examples/custom-provider/src/App.tsx

@@ -0,0 +1,78 @@
+import { useAgentManager } from "@ic-reactor/react"
+import LedgerProvider from "./ICRC1Provider"
+import ICRC1Call from "./ICRC1Call"
+import { FunctionName } from "@ic-reactor/react/dist/types"
+import { ICRC1 } from "./declarations/icrc1"
+import { Principal } from "@dfinity/principal"
+import { useRef, useState, useEffect } from "react"
+import {
+  IC_HOST_NETWORK_URI,
+  LOCAL_HOST_NETWORK_URI,
+} from "@ic-reactor/core/dist/tools"
+
+interface AppProps {}
+
+const functionNames: FunctionName<ICRC1>[] = [
+  "icrc1_name",
+  "icrc1_symbol",
+  "icrc1_fee",
+  "icrc1_decimals",
+  "icrc1_metadata",
+  "icrc1_total_supply",
+  "icrc1_minting_account",
+]
+
+const App: React.FC<AppProps> = () => {
+  const inputRef = useRef<HTMLInputElement>(null)
+  const [canisterId, setCanisterId] = useState<string>(
+    "ryjl3-tyaaa-aaaaa-aaaba-cai"
+  )
+  const [network, setNetwork] = useState<string>("ic")
+  const agentManager = useAgentManager()
+
+  const onSubmit = (event: React.FormEvent) => {
+    event.preventDefault()
+    try {
+      const principal = Principal.fromText(inputRef.current?.value || "")
+      setCanisterId(principal.toText())
+      localStorage.setItem("dynamicCanisterId", principal.toText())
+    } catch (e) {
+      console.error(e)
+    }
+  }
+
+  useEffect(() => {
+    console.log("updating agent", network)
+    agentManager.updateAgent({
+      host: network === "local" ? LOCAL_HOST_NETWORK_URI : IC_HOST_NETWORK_URI,
+    })
+  }, [agentManager, network])
+
+  return (
+    <div>
+      <h1>ICRC Token</h1>
+      <form onSubmit={onSubmit}>
+        <input
+          id="canisterId"
+          required
+          ref={inputRef}
+          defaultValue={canisterId}
+        />
+        <button type="submit">Fetch</button>
+      </form>
+      <select value={network} onChange={(e) => setNetwork(e.target.value)}>
+        <option value="ic">IC</option>
+        <option value="local">Local</option>
+      </select>
+      {canisterId && (
+        <LedgerProvider canisterId={canisterId}>
+          {functionNames.map((functionName) => (
+            <ICRC1Call key={functionName} functionName={functionName} />
+          ))}
+        </LedgerProvider>
+      )}
+    </div>
+  )
+}
+
+export default App