vexConvexApi

const vexConvexApi: object

Defined in: packages/core/src/vexConvexApi.ts:64

Typed anyApi references to the VexCMS generic Convex collection functions.

These point to functions that users copy into convex/vex/collections.ts in their project. All paths are fixed under vex.collections.*.

Required: copy convex/vex/collections.ts from the VexCMS template into your project before these references will resolve at runtime.

Used internally by view components in @vexcms/react. Framework adapter authors do not need to import this directly unless building custom views.

Type Declaration

create

readonly create: FunctionReference<"mutation", "public", VexCreateArgs, string>

Creates a new document. Returns the new document’s ID as a string.

find

readonly find: FunctionReference<"query", "public", VexFindArgs, VexDocument[] | PaginationResult<VexDocument>>

Finds documents in a collection. Called by react/src!CollectionListView in @vexcms/react.

findPaginated

readonly findPaginated: FunctionReference<"query", "public", VexFindPaginatedArgs, PaginationResult<VexDocument>>

Finds documents in a collection with cursor pagination. Called by react/src!CollectionListView in @vexcms/react.

get

readonly get: FunctionReference<"query", "public", VexGetArgs, VexDocument | null>

Fetches a single document by ID. Called by react/src!CollectionEditView in @vexcms/react when editing.

globals

readonly globals: object

globals.find

readonly find: FunctionReference<"query", "public", VexGlobalsFindArgs, VexDocumentGlobal<string>[]>

globals.get

readonly get: FunctionReference<"query", "public", VexGlobalsGetArgs, VexDocumentGlobal<string> | null>

globals.upsert

readonly upsert: FunctionReference<"mutation", "public", VexGlobalsUpdateArgs, string>

listViews

readonly listViews: FunctionReference<"query", "public", VexListViewsArgs, VexStoredView[]>

Lists every shared vex_views row for a collection the caller may see. Gated on readViews (decision 13) — resolves to [], not a thrown error, when denied.

livePreviewUrl

readonly livePreviewUrl: FunctionReference<"query", "public", { collection: string; documentId?: string; kind?: "collection" | "global"; values?: Record<string, unknown>; }, string | null>

Resolves a { server } live-preview URL with a real Convex ctx. Called by useLivePreviewServerUrl in @vexcms/react, and only for that url form — string and client resolvers never reach the server.

media

readonly media: object

media.createMediaDocument

readonly createMediaDocument: FunctionReference<"mutation", "public", VexMediaCreateMediaDocumentArgs, string>

Creates a media document in Convex after the file is uploaded. Called by MediaUploadDropzone in @vexcms/react.

media.deleteMedia

readonly deleteMedia: FunctionReference<"mutation", "public", VexMediaDeleteMediaArgs, boolean>

Deletes a media document and its file from storage. Called by MediaLibrary in @vexcms/react.

media.generateUploadUrl

readonly generateUploadUrl: FunctionReference<"mutation", "public", VexMediaGenerateUploadUrlArgs, VexMediaGenerateUploadUrlReturn>

Generates a URL to upload a file to. Called by MediaUploadDropzone in @vexcms/react.

media.getUrl

readonly getUrl: FunctionReference<"query", "public", VexMediaGetUrlArgs, VexMediaGetUrlReturn>

Returns a URL for a media file. Called by UploadFieldCell in @vexcms/react.

remove

readonly remove: FunctionReference<"mutation", "public", VexRemoveArgs, void>

Permanently deletes a document.

removeView

readonly removeView: FunctionReference<"mutation", "public", VexRemoveViewArgs, void>

Permanently deletes a shared view. Requires deleteView.

saveView

readonly saveView: FunctionReference<"mutation", "public", VexSaveViewArgs, string>

Creates or patches a shared view, keyed by viewId. An insert requires createView, a patch requires updateView (decision 13), and the server rejects a where referencing a field the caller can’t read (decision 26).

search

readonly search: FunctionReference<"query", "public", VexSearchArgs, VexDocument[] | PaginationResult<VexDocument>>

Searches documents in a collection by a search index.

Used by RelationshipFieldInput in @vexcms/react to populate the relationship picker combobox. The searchIndexName must match the .searchIndex() name in the Convex schema — VexCMS auto-generates search_<useAsTitle> when another collection has a relationship here. Pass query: "" to list recent documents when no search term is entered.

See

https://docs.convex.dev/text-search for Convex search docs

update

readonly update: FunctionReference<"mutation", "public", VexUpdateArgs, void>

Patches an existing document — unspecified fields are left unchanged.

versions

readonly versions: object

versions.deleteVersion

readonly deleteVersion: FunctionReference<"mutation", "public", VexDeleteVersionArgs, void>

versions.getVersionSnapshot

readonly getVersionSnapshot: FunctionReference<"query", "public", VexGetVersionSnapshotArgs, VersionSnapshotResult>

versions.listVersions

readonly listVersions: FunctionReference<"query", "public", VexListVersionsArgs, VersionSummary[]>

versions.publish

readonly publish: FunctionReference<"mutation", "public", VexPublishArgs, string>

versions.saveDraft

readonly saveDraft: FunctionReference<"mutation", "public", VexSaveDraftArgs, string>

versions.unpublish

readonly unpublish: FunctionReference<"mutation", "public", VexUnpublishArgs, string>

Example

import { convexQuery } from "@convex-dev/react-query";
import { useQuery } from "@tanstack/react-query";
import { vexConvexApi } from "@vexcms/core";

const { data } = useQuery({
  ...convexQuery(vexConvexApi.list, { collection: "posts" }),
});