AeontelAeontel Docs

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.

Usage

TSX
import Aeontel from "@aeontel/sdk";
import { AeontelProvider, useListElements } from "@aeontel/react";

const client = new Aeontel(import.meta.env.VITE_AEONTEL_API_KEY);

function App() {
  return (
    <AeontelProvider client={client}>
      <ElementsList workspaceId="wsp_abc123" />
    </AeontelProvider>
  );
}

function ElementsList({ workspaceId }: { workspaceId: string }) {
  const { data, isLoading } = useListElements({ workspace_id: workspaceId });
  if (isLoading) return <p>Loading…</p>;
  return (
    <ul>
      {data?.data.map((e) => (
        <li key={e.id}>{e.name}</li>
      ))}
    </ul>
  );
}

Hooks

useBuildElement composite

Trigger a build for an element version.

TypeScript
useBuildElement(options?: MutationOpts<Build, BuildElementParams>)

Types: Build · BuildElementParams

useCreateElement mutation

Create a new element.

TypeScript
useCreateElement(options?: MutationOpts<Element, CreateElementParams>)

Types: Element · CreateElementParams

useCreateElementVersionFile mutation

Create a file in a specific element version.

TypeScript
useCreateElementVersionFile(options?: MutationOpts<SuccessResponse, CreateElementVersionFileParams>)

Types: SuccessResponse · CreateElementVersionFileParams

useDeleteElement mutation

Soft-delete an element.

TypeScript
useDeleteElement(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useDeleteElementVersionFile mutation

Delete a file from a specific element version.

TypeScript
useDeleteElementVersionFile(options?: MutationOpts<SuccessResponse, DeleteElementVersionFileParams>)

Types: SuccessResponse · DeleteElementVersionFileParams

useGetElementPreview query

Poll a preview session by id. Pass a null id to pause.

TypeScript
useGetElementPreview(sessionId: string | null, options?: QueryOpts<ElementPreviewSession>)

useKeepaliveElementPreview composite

Heartbeat a preview session so the idle reaper doesn't tear it down.

TypeScript
useKeepaliveElementPreview(options?: MutationOpts<{ id: string; status: string; }, { sessionId: string; }>)

useListElementFiles query

List files in an element's default version (default-version shortcut).

TypeScript
useListElementFiles(elementId: string, params?: { path?: string; }, options?: QueryOpts<AppFileListResponse>)

Types: AppFileListResponse

TypeScript
const { data } = useListElementFiles("elm_abc123", { path: "src" });

useListElements query

List elements.

TypeScript
useListElements(params?: Omit<ListElementsParams, | > & { filter?: ElementFilter; orderBy?: ElementOrderBy[]; } & ElementShorthands, options?: QueryOpts<Page<Element>>)

Types: ListElementsParams · ElementFilter · ElementOrderBy · ElementShorthands · Page · Element

useListElementVersionFiles query

List files in a specific element version. Manifest-driven SDK method.

TypeScript
useListElementVersionFiles(versionId: string, params?: { path?: string; }, options?: QueryOpts<AppFileListResponse>)

Types: AppFileListResponse

TypeScript
const { data } = useListElementVersionFiles("elmver_def456");

usePurgeElement composite

Permanently delete a soft-deleted element.

TypeScript
usePurgeElement(options?: MutationOpts<SuccessResponse, PurgeElementParams>)

Types: SuccessResponse · PurgeElementParams

useRestoreElement composite

Restore a soft-deleted element.

TypeScript
useRestoreElement(options?: MutationOpts<Element, string>)

Types: Element

useRetrieveElement query

Get a single element.

TypeScript
useRetrieveElement(id: string, options?: QueryOpts<Element>)

Types: Element

useStartElementPreview composite

Start a preview session for an element version.

TypeScript
useStartElementPreview(options?: MutationOpts<ElementPreviewSession, { id: string; versionId: string; }>)

useStopElementPreview composite

Stop a preview session.

TypeScript
useStopElementPreview(options?: MutationOpts<SuccessResponse, { sessionId: string; }>)

Types: SuccessResponse

useUpdateElement mutation

Update an element.

TypeScript
useUpdateElement(options?: MutationOpts<Element, UpdateElementParams>)

Types: Element · UpdateElementParams

useUpdateElementVersionFile mutation

Update a file in a specific element version.

TypeScript
useUpdateElementVersionFile(options?: MutationOpts<SuccessResponse, UpdateElementVersionFileParams>)

Types: SuccessResponse · UpdateElementVersionFileParams