AeontelAeontel Docs

React hooks

Every hook in `@aeontel/react`. Hooks wrap the SDK with TanStack Query for caching, mutations, and real-time invalidation.

Every hook in @aeontel/react. Hooks wrap the SDK with TanStack Query for caching, mutations, and real-time invalidation.

All

  • Agent Versions hooks — Hand-written shim. Generated CRUD hooks via ./agent-versions.gen. useForkAgentVersion + useSetDefaultAgentVersion stay hand-written.
  • Agents hooks — Hand-written shim. Generated CRUD hooks via ./agents.gen. useSyncAgent{Tools,Skills,McpServers} stay hand-written — they target the surviving sub-resource sync classes on client.agents.
  • API Keys hooks — React hooks for API keys — list, get, create, delete.
  • Apis hooks — Hand-written shim. Implementation is generated; see ./apis.gen.
  • App Domains hooks — Hand-written shim. Implementation is generated; see ./app-domains.gen.
  • App Versions hooks — Hand-written shim. Implementation is generated; see ./app-versions.gen.
  • Apps hooks — Hand-written shim. Generated CRUD hooks via ./apps.gen (useListApps, useCreateApp, useRetrieveApp, useUpdateApp, useDeleteApp, useRestoreApp). Hooks below cover the build/deploy mutations, the preview-session lifecycle, the live R2 file ops, version-scoped REST file ops, env vars, and the custom domain — none of which fit the manifest's standard CRUD kinds.
  • Builds hooks — Hand-written shim. Generated list+get via ./builds.gen. useCancelBuild stays hand-written.
  • Chats hooks — React hooks for Aeontel chats.
  • Cleanup Tasks hooks — Hand-written shim. Generated list+get via ./cleanup-tasks.gen. useGetCleanupTaskTree + useRetryCleanupTask stay hand-written.
  • Connectors hooks — React hooks for connectors — list, get, and connect (to spawn an MCP server).
  • Databases hooks — React hooks for databases. Standard CRUD (useListDatabases, useRetrieveDatabase, useCreateDatabase, useUpdateDatabase, useDeleteDatabase, useRestoreDatabase) is generated; see ./databases.gen. Hooks for SQL execution and D1 introspection (list tables, describe table, browse rows) are hand-written below.
  • Deploys hooks — Hand-written shim. Generated list+get via ./deploys.gen. useCancelDeploy stays hand-written.
  • Directories hooks — Hand-written shim. Implementation is generated; see ./directories.gen.
  • Element Versions hooks — Hand-written shim. Implementation is generated; see ./element-versions.gen.
  • Elements hooks — Hand-written shim. Generated CRUD hooks via ./elements.gen (useListElements, useCreateElement, useRetrieveElement, useUpdateElement, useDeleteElement, useRestoreElement). Hooks below cover the build action, the preview-session lifecycle, and the per-version file ops — none of which fit the manifest's standard CRUD kinds.
  • Emails hooks — Hand-written shim. Implementation is generated; see ./emails.gen.
  • Endpoints hooks — Hand-written shim. Implementation is generated; see ./endpoints.gen.
  • Event Stream hooks — React hooks for Aeontel event stream.
  • Events hooks — Hand-written shim. Generated list+get via ./events.gen. (Stream lives in apps/platform/src/hooks/use-event-stream.ts.)
  • Files hooks — React hooks for files. Standard CRUD (useListFiles, useRetrieveFile, useCreateFile, useUpdateFile, useDeleteFile, useRestoreFile) is generated; see ./files.gen. Hooks for the multipart upload lifecycle (sign parts, complete, abort), the presigned download URL, and the convert-from-URL family are hand-written below.
  • Function Files hooks — @aeontel-generated by packages/react/scripts/gen.ts DO NOT EDIT BY HAND. Run pnpm gen to regenerate. Source: packages/shared/src/manifest/function-file.ts
  • Function Versions hooks — Hand-written shim. Generated CRUD hooks via ./function-versions.gen. useForkFunctionVersion + useSetDefaultFunctionVersion stay hand-written (the codegen skips custom ops).
  • Functions hooks — Hand-written hooks for Function. CRUD comes from functions.gen.ts; this file adds the custom invoke op which the generator skips.

Mirror to docs/client-functions.md / Worker Loader pattern: invokeFunction fires off the function as a Cloudflare Dynamic Worker and returns { ok, result, error, durationMs }.

  • Graph Definitions hooks — Hand-written shim. Generated CRUD hooks via ./graph-definitions.gen (useListGraphDefinitions, useCreateGraphDefinition, useRetrieveGraphDefinition, useUpdateGraphDefinition, useDeleteGraphDefinition, useRestoreGraphDefinition). Hooks below cover the node-definition / edge-definition sub-resources, the graphs-of-definition sub-resource, and the extract / save-instance ops — none of which fit the manifest's standard CRUD kinds.
  • Graph Edges hooks — Hand-written shim. Implementation is generated; see ./graph-edges.gen.
  • Graph Nodes hooks — Hand-written shim. Implementation is generated; see ./graph-nodes.gen.
  • Graphs hooks — Hand-written shim. Generated graph CRUD via ./graphs.gen. The hooks below cover (a) the data query — full graph load (instance + nodes + edges) — and (b) graph-node / graph-edge composite hooks that don't fit the standard CRUD kinds.

GraphDefinition hooks (CRUD + node/edge definition helpers) live in ./graph-definitions.ts.

  • Images hooks — Hand-written shim. Generated CRUD via ./images.gen. useGetImageByFile stays hand-written.

  • Integration Installs hooks — React hooks for Aeontel integration installs.

  • Integration Versions hooks — Hand-written shim. Implementation is generated; see ./integration-versions.gen.

  • Integrations hooks — Hand-written shim. Generated CRUD hooks via ./integrations.gen. Custom-op hooks (publish, listVersions, install) stay hand-written until the React gen learns to emit kind: "custom" ops.

  • Logs hooks — Hand-written shim. Implementation is generated; see ./logs.gen.

  • MCP Servers hooks — Hand-written shim. Implementation is generated; see ./mcp-servers.gen.

  • Messages hooks — Hand-written shim. Implementation is generated; see ./messages.gen.

  • Notifications hooks — Hand-written shim. Generated list/delete/restore via ./notifications.gen. useGetNotificationUnreadCount, useMarkNotificationRead, useMarkAllNotificationsRead stay hand-written (custom ops + raw fetch).

  • Oauth Applications hooks — Hand-written shim. Generated CRUD hooks via ./oauth-applications.gen. useRotateOAuthApplicationSecret + useDisableOAuthApplication stay hand-written.

  • Organization Members hooks — Hand-written shim. Implementation is generated; see ./organization-members.gen.

  • Organizations hooks — Hand-written shim. Generated CRUD via ./organizations.gen. useGetOrganizationByHandle stays hand-written (custom op).

  • Pages hooks — Hand-written shim. Generated CRUD via ./pages.gen. The hooks below cover move (positional swap) and resolve (slug-path lookup) — neither fits the manifest's standard CRUD kinds.

  • Permissions hooks — Hand-written shim. Generated CRUD hooks via ./permissions.gen. useGrantPermission + useRevokePermission stay hand-written.

  • Polling tiers — Polling tiers for refetchInterval. Pick a tier that matches how fresh the data needs to feel — pages can mix tiers across queries.

  • {@link POLL_CRITICAL} (2s) — pages where stale data is misleading (run details while a run is in progress, live status indicators).

  • {@link POLL_ACTIVE} (5s) — list views the user is actively watching (runs list, recent events, dashboards).

  • {@link POLL_AMBIENT} (30s) — background freshness for detail views that don't need second-by-second updates (settings, overviews).

  • {@link POLL_FALLBACK} (60s) — safety-net interval used when a real-time event stream is connected; see {@link getRefetchInterval}.

  • {@link POLL_IDLE} (5m) — cold data that only changes on explicit user action (database table browser, static reference lists). Events and mutations still invalidate the cache normally; this is just the ambient safety-net rate.

  • Runs hooks — React hooks for runs — list, get, cancel, plus the high-level {@link useExecuteRun} hook for executing any runnable entity (agent, swarm, workflow) and tracking its status.

  • Schedules hooks — Hand-written shim. Generated CRUD hooks via ./schedules.gen. useFireSchedule stays hand-written.

  • Schemas hooks — Hand-written shim. Implementation is generated; see ./schemas.gen.

Custom hook: useListSchemaFields uses raw _fetch and is not yet in the manifest (no fields sub-resource on the SDK).

  • Secrets hooks — Hand-written shim. Implementation is generated; see ./secrets.gen.
  • Skills hooks — Hand-written shim. Implementation is generated; see ./skills.gen.
  • Solution Members hooks — Hand-written shim. CRUD hooks (list / add / remove) are generated; see ./solution-members.gen. The custom addBulk op hook stays hand-written until the React gen learns to emit kind: "custom" ops.
  • Solutions hooks — Hand-written shim. Generated CRUD hooks via ./solutions.gen. The graph custom-op hook stays hand-written until the React gen learns to emit kind: "custom" ops. Solution members are their own generated top-level entity (see ./solution-members).
  • Spec Members hooks — Hand-written shim. Implementation is generated; see ./spec-members.gen.
  • Specs hooks — Hand-written shim. Generated CRUD hooks via ./specs.gen. The refresh custom-op hook stays hand-written until the React gen learns to emit kind: "custom" ops. Spec members are their own generated top-level entity (useListSpecMembers from spec-members.gen).
  • Swarm Edges hooks — Hand-written shim. Implementation is generated; see ./swarm-edges.gen.
  • Swarm Nodes hooks — Hand-written shim. Implementation is generated; see ./swarm-nodes.gen.
  • Swarm Versions hooks — Hand-written shim. Generated CRUD hooks via ./swarm-versions.gen. useForkSwarmVersion + useSetDefaultSwarmVersion stay hand-written.
  • Swarms hooks — Hand-written shim. Implementation is generated; see ./swarms.gen.
  • Team Members hooks — Hand-written shim. Implementation is generated; see ./team-members.gen.
  • Teams hooks — Hand-written shim. Implementation is generated; see ./teams.gen.
  • Thread Participants hooks — Hand-written shim. Implementation is generated; see ./thread-participants.gen.
  • Threads hooks — Hand-written shim. Generated CRUD hooks via ./threads.gen. useMarkThreadRead stays hand-written (custom op).
  • Tokens hooks — @aeontel-generated by packages/react/scripts/gen.ts DO NOT EDIT BY HAND. Run pnpm gen to regenerate. Source: packages/shared/src/manifest/token.ts
  • Tools hooks — @aeontel-generated by packages/react/scripts/gen.ts DO NOT EDIT BY HAND. Run pnpm gen to regenerate. Source: packages/shared/src/manifest/tool.ts
  • Trash hooks — Hand-written shim. CRUD methods are generated; see ./trash.gen.

Adds a hand-written useEmptyTrash because the trash.empty op is a bulk operation that doesn't fit the generated mutation shape — we want it to invalidate everything (the trash list AND every touched entity's own cache, which we can't enumerate ahead of time, so we settle for invalidating trashKeys.all() plus letting consumers attach extra invalidations via options).

  • Triggers hooks — Hand-written shim. Implementation is generated; see ./triggers.gen.
  • Users hooks — React hooks for users — list, get, update, delete. Admin only.
  • Utilities — Shared utilities — query-key factories, cache-invalidation helper, and the generic useSdkQuery / useSdkMutation escape hatches.
  • Videos hooks — Hand-written shim. Generated CRUD via ./videos.gen. useGetVideoByFile stays hand-written.
  • Webhook Calls hooks — Hand-written shim. Implementation is generated; see ./webhook-calls.gen.
  • Webhook Deliveries hooks — Hand-written shim. Generated list+get via ./webhook-deliveries.gen. useListWebhookDeliveryAttempts + useRetryWebhookDelivery + useCancelWebhookDelivery stay hand-written.
  • Webhook Delivery Attempts hooks — Hand-written shim. Implementation is generated; see ./webhook-delivery-attempts.gen.
  • Webhook Endpoints hooks — Hand-written shim. Implementation is generated; see ./webhook-endpoints.gen.
  • Webhook Subscriptions hooks — Hand-written shim. Implementation is generated; see ./webhook-subscriptions.gen.
  • Webhooks hooks — React hooks for webhooks — webhook endpoints (inbound HTTP targets) and webhook subscriptions (event → endpoint mappings).
  • Workflow Edges hooks — Hand-written shim. Implementation is generated; see ./workflow-edges.gen.
  • Workflow Nodes hooks — Hand-written shim. Implementation is generated; see ./workflow-nodes.gen.
  • Workflows hooks — Hand-written shim. Generated CRUD via ./workflows.gen. The hooks below cover the workflow-run sub-resource and graph-replace mutation that the manifest pipeline doesn't model.
  • Workspace Members hooks — Hand-written shim. Implementation is generated; see ./workspace-members.gen.
  • Workspaces hooks — Hand-written shim. Generated CRUD via ./workspaces.gen. The hooks below cover (a) the org-scoped handle lookup that composes two requests (useGetWorkspaceByHandle) and (b) the email-settings sub-resource (useGetWorkspaceEmail, useUpdateWorkspaceEmail) which the manifest pipeline doesn't model yet.