Add typedoc plugins and remove unused code

B3Pay · Feb 16, 2024 · 986bb95 · 986bb95
1 parent a6211a7
commit 986bb95
Show file tree

Hide file tree

Showing 110 changed files with 3,977 additions and 1,017 deletions.
diff --git a/docs/classes/_ic_reactor_store.ActorManager.html b/docs/classes/_ic_reactor_store.ActorManager.html
diff --git a/docs/classes/_ic_reactor_store.AgentManager.html b/docs/classes/_ic_reactor_store.AgentManager.html
diff --git a/docs/classes/_ic_reactor_store.AuthClient.html b/docs/classes/_ic_reactor_store.AuthClient.html
diff --git a/docs/classes/_ic_reactor_store.CandidManager.html b/docs/classes/_ic_reactor_store.CandidManager.html
diff --git a/docs/classes/_ic_reactor_store.HttpAgent.html b/docs/classes/_ic_reactor_store.HttpAgent.html
diff --git a/docs/classes/_ic_reactor_store.Principal.html b/docs/classes/_ic_reactor_store.Principal.html
diff --git a/docs/classes/_ic_reactor_visitor.VisitDetails.html b/docs/classes/_ic_reactor_visitor.VisitDetails.html
diff --git a/docs/classes/_ic_reactor_visitor.VisitFields.html b/docs/classes/_ic_reactor_visitor.VisitFields.html
diff --git a/docs/classes/_ic_reactor_visitor.VisitRandomArgs.html b/docs/classes/_ic_reactor_visitor.VisitRandomArgs.html
diff --git a/docs/classes/_ic_reactor_visitor.VisitRandomResponse.html b/docs/classes/_ic_reactor_visitor.VisitRandomResponse.html
diff --git a/docs/classes/_ic_reactor_visitor.VisitTransform.html b/docs/classes/_ic_reactor_visitor.VisitTransform.html
diff --git a/docs/classes/_ic_reactor_visitor.VisitTransformTable.html b/docs/classes/_ic_reactor_visitor.VisitTransformTable.html
diff --git a/docs/functions/_ic_reactor_store.createActorManager.html b/docs/functions/_ic_reactor_store.createActorManager.html
diff --git a/docs/functions/_ic_reactor_store.createAgentManager.html b/docs/functions/_ic_reactor_store.createAgentManager.html
diff --git a/docs/functions/_ic_reactor_store.createReActorStore.html b/docs/functions/_ic_reactor_store.createReActorStore.html
diff --git a/docs/functions/_ic_reactor_store.createStoreWithOptionalDevtools.html b/docs/functions/_ic_reactor_store.createStoreWithOptionalDevtools.html
diff --git a/docs/functions/_ic_reactor_store.generateActorHash.html b/docs/functions/_ic_reactor_store.generateActorHash.html
diff --git a/docs/functions/_ic_reactor_store.generateHash.html b/docs/functions/_ic_reactor_store.generateHash.html
diff --git a/docs/functions/_ic_reactor_store.generateRequestHash.html b/docs/functions/_ic_reactor_store.generateRequestHash.html
diff --git a/docs/functions/_ic_reactor_store.jsonToString.html b/docs/functions/_ic_reactor_store.jsonToString.html
diff --git a/docs/functions/_ic_reactor_store.stringToHash.html b/docs/functions/_ic_reactor_store.stringToHash.html
diff --git a/docs/functions/_ic_reactor_visitor.convertStringToNumber.html b/docs/functions/_ic_reactor_visitor.convertStringToNumber.html
diff --git a/docs/functions/_ic_reactor_visitor.extractAndSortArgs.html b/docs/functions/_ic_reactor_visitor.extractAndSortArgs.html
diff --git a/docs/functions/_ic_reactor_visitor.isImage.html b/docs/functions/_ic_reactor_visitor.isImage.html
diff --git a/docs/functions/_ic_reactor_visitor.isQuery.html b/docs/functions/_ic_reactor_visitor.isQuery.html
diff --git a/docs/functions/_ic_reactor_visitor.isUrl.html b/docs/functions/_ic_reactor_visitor.isUrl.html
diff --git a/docs/functions/_ic_reactor_visitor.validateError.html b/docs/functions/_ic_reactor_visitor.validateError.html
diff --git a/docs/functions/_ic_reactor_visitor.validateNumberError.html b/docs/functions/_ic_reactor_visitor.validateNumberError.html
diff --git a/docs/hierarchy.html b/docs/hierarchy.html
diff --git a/docs/ic-reactor.png b/docs/ic-reactor.png
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/_ic_reactor_store.ActorManagerOptions.html b/docs/interfaces/_ic_reactor_store.ActorManagerOptions.html
diff --git a/docs/interfaces/_ic_reactor_store.ActorMethod.html b/docs/interfaces/_ic_reactor_store.ActorMethod.html
diff --git a/docs/interfaces/_ic_reactor_store.ActorMethodState.html b/docs/interfaces/_ic_reactor_store.ActorMethodState.html
diff --git a/docs/interfaces/_ic_reactor_store.AgentAuthState.html b/docs/interfaces/_ic_reactor_store.AgentAuthState.html
diff --git a/docs/interfaces/_ic_reactor_store.AgentManagerOptions.html b/docs/interfaces/_ic_reactor_store.AgentManagerOptions.html
diff --git a/docs/interfaces/_ic_reactor_store.CreateReActorOptions.html b/docs/interfaces/_ic_reactor_store.CreateReActorOptions.html
diff --git a/docs/interfaces/_ic_reactor_store.DefaultActorType.html b/docs/interfaces/_ic_reactor_store.DefaultActorType.html
diff --git a/docs/interfaces/_ic_reactor_store.HttpAgentOptions.html b/docs/interfaces/_ic_reactor_store.HttpAgentOptions.html
diff --git a/docs/interfaces/_ic_reactor_store.Identity.html b/docs/interfaces/_ic_reactor_store.Identity.html
diff --git a/docs/interfaces/_ic_reactor_store.UpdateAgentOptions.html b/docs/interfaces/_ic_reactor_store.UpdateAgentOptions.html
diff --git a/docs/interfaces/_ic_reactor_visitor.DefaultField.html b/docs/interfaces/_ic_reactor_visitor.DefaultField.html
diff --git a/docs/interfaces/_ic_reactor_visitor.DynamicDataArgs.html b/docs/interfaces/_ic_reactor_visitor.DynamicDataArgs.html
diff --git a/docs/interfaces/_ic_reactor_visitor.ExtractedServiceDetails.html b/docs/interfaces/_ic_reactor_visitor.ExtractedServiceDetails.html
diff --git a/docs/interfaces/_ic_reactor_visitor.ExtractedServiceFields.html b/docs/interfaces/_ic_reactor_visitor.ExtractedServiceFields.html
diff --git a/docs/interfaces/_ic_reactor_visitor.FieldDetails.html b/docs/interfaces/_ic_reactor_visitor.FieldDetails.html
diff --git a/docs/interfaces/_ic_reactor_visitor.FieldDetailsWithChild.html b/docs/interfaces/_ic_reactor_visitor.FieldDetailsWithChild.html
diff --git a/docs/interfaces/_ic_reactor_visitor.InputDetails.html b/docs/interfaces/_ic_reactor_visitor.InputDetails.html
diff --git a/docs/interfaces/_ic_reactor_visitor.InputField.html b/docs/interfaces/_ic_reactor_visitor.InputField.html
diff --git a/docs/interfaces/_ic_reactor_visitor.MethodFields.html b/docs/interfaces/_ic_reactor_visitor.MethodFields.html
diff --git a/docs/interfaces/_ic_reactor_visitor.NumberField.html b/docs/interfaces/_ic_reactor_visitor.NumberField.html
diff --git a/docs/interfaces/_ic_reactor_visitor.OptionalFields.html b/docs/interfaces/_ic_reactor_visitor.OptionalFields.html
diff --git a/docs/interfaces/_ic_reactor_visitor.PrincipalField.html b/docs/interfaces/_ic_reactor_visitor.PrincipalField.html
diff --git a/docs/interfaces/_ic_reactor_visitor.RecordFields.html b/docs/interfaces/_ic_reactor_visitor.RecordFields.html
diff --git a/docs/interfaces/_ic_reactor_visitor.RecursiveFields.html b/docs/interfaces/_ic_reactor_visitor.RecursiveFields.html
diff --git a/docs/interfaces/_ic_reactor_visitor.ResultArrayData.html b/docs/interfaces/_ic_reactor_visitor.ResultArrayData.html
diff --git a/docs/interfaces/_ic_reactor_visitor.ResultRecordData.html b/docs/interfaces/_ic_reactor_visitor.ResultRecordData.html
diff --git a/docs/interfaces/_ic_reactor_visitor.TupleFields.html b/docs/interfaces/_ic_reactor_visitor.TupleFields.html
diff --git a/docs/interfaces/_ic_reactor_visitor.VariantFields.html b/docs/interfaces/_ic_reactor_visitor.VariantFields.html
diff --git a/docs/interfaces/_ic_reactor_visitor.VectorFields.html b/docs/interfaces/_ic_reactor_visitor.VectorFields.html
diff --git a/docs/modules/_ic_reactor_core.html b/docs/modules/_ic_reactor_core.html
diff --git a/docs/modules/_ic_reactor_react.html b/docs/modules/_ic_reactor_react.html
diff --git a/docs/modules/_ic_reactor_store.html b/docs/modules/_ic_reactor_store.html
diff --git a/docs/modules/_ic_reactor_svelte.html b/docs/modules/_ic_reactor_svelte.html
diff --git a/docs/modules/_ic_reactor_visitor.html b/docs/modules/_ic_reactor_visitor.html
diff --git a/docs/types/_ic_reactor_store.ActorMethodStates.html b/docs/types/_ic_reactor_store.ActorMethodStates.html
diff --git a/docs/types/_ic_reactor_store.ActorState.html b/docs/types/_ic_reactor_store.ActorState.html
diff --git a/docs/types/_ic_reactor_store.ActorStore.html b/docs/types/_ic_reactor_store.ActorStore.html
diff --git a/docs/types/_ic_reactor_store.ActorSubclass.html b/docs/types/_ic_reactor_store.ActorSubclass.html
diff --git a/docs/types/_ic_reactor_store.AgentAuthStore.html b/docs/types/_ic_reactor_store.AgentAuthStore.html
diff --git a/docs/types/_ic_reactor_store.CallActorMethod.html b/docs/types/_ic_reactor_store.CallActorMethod.html
diff --git a/docs/types/_ic_reactor_store.CanisterId.html b/docs/types/_ic_reactor_store.CanisterId.html
diff --git a/docs/types/_ic_reactor_store.ExtractActorMethodArgs.html b/docs/types/_ic_reactor_store.ExtractActorMethodArgs.html
diff --git a/docs/types/_ic_reactor_store.ExtractActorMethodReturnType.html b/docs/types/_ic_reactor_store.ExtractActorMethodReturnType.html
diff --git a/docs/types/_ic_reactor_store.ExtractVisitorType.html b/docs/types/_ic_reactor_store.ExtractVisitorType.html
diff --git a/docs/types/_ic_reactor_store.ExtractedService.html b/docs/types/_ic_reactor_store.ExtractedService.html
diff --git a/docs/types/_ic_reactor_store.FunctionName.html b/docs/types/_ic_reactor_store.FunctionName.html
diff --git a/docs/types/_ic_reactor_store.FunctionType.html b/docs/types/_ic_reactor_store.FunctionType.html
diff --git a/docs/types/_ic_reactor_visitor.AllFieldTypes.html b/docs/types/_ic_reactor_visitor.AllFieldTypes.html
diff --git a/docs/types/_ic_reactor_visitor.AllNumberTypes.html b/docs/types/_ic_reactor_visitor.AllNumberTypes.html
diff --git a/docs/types/_ic_reactor_visitor.DynamicFieldType.html b/docs/types/_ic_reactor_visitor.DynamicFieldType.html
diff --git a/docs/types/_ic_reactor_visitor.DynamicFieldTypeByClass.html b/docs/types/_ic_reactor_visitor.DynamicFieldTypeByClass.html
diff --git a/docs/types/_ic_reactor_visitor.ExtraInputFormFields.html b/docs/types/_ic_reactor_visitor.ExtraInputFormFields.html
diff --git a/docs/types/_ic_reactor_visitor.FieldTypeFromIDLType.html b/docs/types/_ic_reactor_visitor.FieldTypeFromIDLType.html
diff --git a/docs/types/_ic_reactor_visitor.FunctionCategory.html b/docs/types/_ic_reactor_visitor.FunctionCategory.html
diff --git a/docs/types/_ic_reactor_visitor.MethodDefaultValues.html b/docs/types/_ic_reactor_visitor.MethodDefaultValues.html
diff --git a/docs/types/_ic_reactor_visitor.MethodDetails.html b/docs/types/_ic_reactor_visitor.MethodDetails.html
diff --git a/docs/types/_ic_reactor_visitor.MethodResult.html b/docs/types/_ic_reactor_visitor.MethodResult.html
diff --git a/docs/types/_ic_reactor_visitor.MethodResultValue.html b/docs/types/_ic_reactor_visitor.MethodResultValue.html
diff --git a/docs/types/_ic_reactor_visitor.OtherDetails.html b/docs/types/_ic_reactor_visitor.OtherDetails.html
diff --git a/docs/types/_ic_reactor_visitor.ServiceDefaultValues.html b/docs/types/_ic_reactor_visitor.ServiceDefaultValues.html
diff --git a/docs/types/_ic_reactor_visitor.ServiceDetails.html b/docs/types/_ic_reactor_visitor.ServiceDetails.html
diff --git a/docs/types/_ic_reactor_visitor.ServiceFields.html b/docs/types/_ic_reactor_visitor.ServiceFields.html
diff --git a/docs/variables/_ic_reactor_store.IC_HOST_NETWORK_URI.html b/docs/variables/_ic_reactor_store.IC_HOST_NETWORK_URI.html
diff --git a/docs/variables/_ic_reactor_store.LOCAL_HOST_NETWORK_URI.html b/docs/variables/_ic_reactor_store.LOCAL_HOST_NETWORK_URI.html
diff --git a/ic-reactor.png b/ic-reactor.png
diff --git a/package.json b/package.json
@@ -58,6 +58,8 @@
     "text-encoding": "0.7.0",
     "ts-jest": "29.1",
     "typedoc": "^0.25.8",
+    "typedoc-plugin-extras": "^3.0.0",
+    "typedoc-plugin-include-example": "^1.2.0",
     "typedoc-plugin-mdn-links": "^3.1.16",
     "typescript": "^5.3",
     "whatwg-fetch": "3.6",

diff --git a/packages/react/src/index.ts b/packages/react/src/index.ts
@@ -1,33 +1,23 @@
-import {
-  createReActorStore,
-  type ActorSubclass,
-  type DefaultActorType,
-} from "@ic-reactor/store"
-import {
-  createReActorCandidStore,
-  CreateReActorCandidOptions,
-  ActorCandidManager,
-} from "@ic-reactor/candid"
+import { type ActorSubclass, type DefaultActorType } from "@ic-reactor/store"
+import { createReActorStore, CreateReActorOptions } from "@ic-reactor/store"
 import { getActorHooks } from "./hooks/actor"
 import { getAuthHooks } from "./hooks/auth"
 import { CreateReActor } from "./types"
 
-export * from "@ic-reactor/candid"
+export * from "@ic-reactor/store"
 
 export * from "./context/agent"
 export * from "./context/actor"
 
-export interface CreateReactActorOptions extends CreateReActorCandidOptions {
-  withServiceFields?: boolean
-  withServiceDetails?: boolean
+export interface CreateReactActorOptions extends CreateReActorOptions {
+  withVisitor?: boolean
 }
 
 export const createReActor: CreateReActor = <
   A extends ActorSubclass<any> = DefaultActorType
 >({
   isLocalEnv,
-  withServiceFields,
-  withServiceDetails,
+  withVisitor,
   ...options
 }: CreateReactActorOptions) => {
   isLocalEnv =
@@ -36,38 +26,19 @@ export const createReActor: CreateReActor = <
       (process.env.DFX_NETWORK === "local" ||
         process.env.NODE_ENV === "development"))
 
-  let actorManager: ActorCandidManager<A>
+  let actorManager = createReActorStore<A>({
+    isLocalEnv,
+    ...options,
+  })
 
-  if (withServiceFields || withServiceDetails) {
-    actorManager = createReActorCandidStore<A>({
-      isLocalEnv,
-      ...options,
-    })
-  } else {
-    actorManager = createReActorStore<A>({
-      isLocalEnv,
-      ...options,
-    }) as unknown as ActorCandidManager<A>
-  }
-
-  const getServiceFields = () => {
-    if (!withServiceFields || !actorManager.serviceFields) {
+  const getVisitFunction = () => {
+    if (!withVisitor) {
       throw new Error(
-        "Service fields not initialized. Pass `withServiceFields` to initialize service fields."
+        "Service fields not initialized. Pass `withVisitor` to initialize service fields."
       )
     }
 
-    return actorManager.serviceFields
-  }
-
-  const getServiceDetails = () => {
-    if (!withServiceDetails || !actorManager.serviceDetails) {
-      throw new Error(
-        "Service details not initialized. Pass `withServiceDetails` to initialize service details."
-      )
-    }
-
-    return actorManager.serviceDetails
+    return actorManager.visitFunction
   }
 
   const getAgent = () => {
@@ -79,9 +50,8 @@ export const createReActor: CreateReActor = <
 
   return {
     getAgent,
-    getServiceFields,
-    getServiceDetails,
+    getVisitFunction,
     ...actorHooks,
     ...authHooks,
-  } as any
+  }
 }
diff --git a/packages/react/src/types.ts b/packages/react/src/types.ts
@@ -5,7 +5,7 @@ import type {
   ServiceDetails,
   MethodDetails,
   MethodResult,
-} from "@ic-reactor/candid"
+} from "@ic-reactor/visitor"
 import type {
   ActorState,
   CanisterId,
@@ -17,6 +17,7 @@ import type {
   Principal,
   FunctionType,
   FunctionName,
+  ExtractedService,
 } from "@ic-reactor/store"
 import type { AuthHooks } from "./hooks/auth"
 
@@ -193,40 +194,21 @@ export interface ActorDefaultHooks<A, F extends boolean, D extends boolean> {
 
 export type GetFunctions<A> = {
   getAgent: () => HttpAgent
-  getServiceFields: () => ExtractedServiceFields<A>
-  getServiceDetails: () => ExtractedServiceDetails<A>
+  getVisitFunction: () => ExtractedService<A>
 }
 
 export type CreateReActor = {
-  // When withServiceFields is true and withServiceDetails is true
+  // When withVisitor is true
   <A>(
     options: CreateReActorOptions & {
-      withServiceFields: true
-      withServiceDetails: true
+      withVisitor: true
     }
   ): GetFunctions<A> & ActorHooks<A, true, true> & AuthHooks
 
-  // When withServiceFields is true and withServiceDetails is false or undefined
+  // When withVisitor are false or undefined
   <A>(
     options: CreateReActorOptions & {
-      withServiceFields: true
-      withServiceDetails?: false | undefined
-    }
-  ): GetFunctions<A> & ActorHooks<A, true, false> & AuthHooks
-
-  // When withServiceFields is false or undefined and withServiceDetails is true
-  <A>(
-    options: CreateReActorOptions & {
-      withServiceFields?: false | undefined
-      withServiceDetails: true
-    }
-  ): GetFunctions<A> & ActorHooks<A, false, true> & AuthHooks
-
-  // When both withServiceFields and withServiceDetails are false or undefined
-  <A>(
-    options: CreateReActorOptions & {
-      withServiceFields?: false | undefined
-      withServiceDetails?: false | undefined
+      withVisitor?: false | undefined
     }
   ): GetFunctions<A> & ActorHooks<A, false, false> & AuthHooks
 }
diff --git a/packages/store/README.md b/packages/store/README.md
@@ -26,77 +26,76 @@ yarn add @ic-reactor/store
 
 ## Usage
 
-To use `@ic-reactor/store`, start by creating a ReActor manager with your actor configurations:
+You can this packages in two ways:
+
+1. **Automatic Agent Creation**: You can use the `createReActorStore` factory function to create a new ReActor store instance. This will automatically create an agent and manage its state for you.
 
 ```ts
-import createReActorManager from "@ic-reactor/store"
-import { idlFactory, canisterId } from "./declarations/actor"
+import { createReActorStore } from "@ic-reactor/store"
+import { candid, canisterId, idlFactory } from "./candid"
 
-type Actor = typeof actor
+type Candid = typeof candid
 
-const { actorStore, authenticate, callMethod } = createReActorStore<Actor>({
+const { callMethod, agentManager } = createReActorStore<Candid>({
+  canisterId,
   idlFactory,
-  canisterId: "xeka7-ryaaa-aaaal-qb57a-cai",
-  host: "https://icp-api.io",
 })
+
+// later in your code
+const identity = await agentManager.authenticate()
+const data = await callMethod("version")
 ```
 
-### Managing Actor State
+2. **Manual Agent Creation**: You can use the `createAgentManager` to manually create and manage an agent instance.
 
-Utilize the ReActor manager to manage the state of your IC actors:
+- IC Agent
 
 ```ts
-// Access and update actor state
-const actorState = actorStore.getState()
-```
-
-### Handling Authentication
+// agent.ts
+import { createAgentManager } from "@ic-reactor/store"
 
-Manage authentication states and processes:
+export const agentManager = createAgentManager() // connect to the default ic network
 
-```javascript
-// Authenticate with the IC blockchain
-authenticate()
-  .then(() => {
-    // Handle successful authentication
-  })
-  .catch((error) => {
-    // Handle authentication errors
-  })
+// later in your code
+const identity = await agentManager.authenticate()
 ```
 
-### Calling Actor Methods
+- Local Agent
 
-Call actor methods and handle the results:
+```ts
+// agent.ts
+import { createAgentManager } from "@ic-reactor/store"
 
-```javascript
-// Call an actor method
-callMethod({
-  functionName: "get_balance",
-  args: [principal],
+export const agentManager = createAgentManager({
+  isLocalEnv: true,
+  port: 8000, // default port is 4943
 })
-  .then((result) => {
-    // Handle successful method call
-  })
-  .catch((error) => {
-    // Handle method call errors
-  })
 ```
 
-## API Reference
-
-`@ic-reactor/store` provides several key functionalities:
+- Or you can use the host option directly
 
-- `ReActorManager`: The main class to manage actor states and interactions.
-- `createReActorManager`: Factory function to create a new ReActor manager instance.
-- State management actions: Methods to initialize actors, handle authentication, and manage global state.
+```ts
+export const agentManager = createAgentManager({
+  host: "http://localhost:8000",
+})
+```
 
-For a detailed API reference, including the complete list of methods and their usage, please refer to the [documentation](#).
+then you can use the "createActorManager" to create an actor manager
 
-## Contributing
+```ts
+// actor.ts
+import { createActorManager } from "@ic-reactor/store"
+import { candid, canisterId, idlFactory } from "./candid"
+import { agentManager } from "./agent"
 
-Contributions to `@ic-reactor/store` are welcome! Please read our [contributing guidelines](#) for more information.
+type Candid = typeof candid
 
-## License
+const actorManager = createActorManager<Candid>({
+  agentManager,
+  canisterId,
+  idlFactory,
+})
 
-`@ic-reactor/store` is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
+// later in your code
+const data = await actorManager.callMethod("version")
+```