ConvexStorageAdapter

Defined in: packages/file-storage-convex/src/adapter/index.ts:32

Convex storage adapter class — extends BaseStorageAdapter.

All adapter methods accept the Convex ctx as the first parameter, allowing access to ctx.db, ctx.storage, and other context methods.

Example

import { ConvexStorageAdapter } from "@vexcms/file-storage-convex/adapter";

const adapter = new ConvexStorageAdapter({ mediaCollections: [images] });
return <AdminPanel adapterClient={adapter}>{children}</AdminPanel>;

Extends

StorageAdapterPresignedUrl

Constructors

Constructor

new ConvexStorageAdapter(options): ConvexStorageAdapter

Defined in: packages/file-storage-convex/src/adapter/index.ts:43

Creates a new ConvexStorageAdapter instance.

Parameters

options

ConvexFileStorageOptions

Adapter configuration including media collections and soft-delete behaviour.

Returns

ConvexStorageAdapter

Overrides

StorageAdapterPresignedUrl.constructor

Properties

admin

admin: object

Defined in: packages/file-storage-convex/src/adapter/index.ts:36

softDelete

softDelete: boolean = false

Overrides

StorageAdapterPresignedUrl.admin

mediaCollections

readonly mediaCollections: MediaCollectionConfig[]

Defined in: packages/file-storage-convex/src/adapter/index.ts:35

Processed media collections ready for schema generation and admin panel.

The adapter validates, augments, and returns these collections. Each collection is tagged with meta.storageAdapterName equal to this adapter’s name. Core merges all collections from all adapters into VexConfig.mediaCollections — separate from user-defined collections.

Overrides

StorageAdapterPresignedUrl.mediaCollections

name

readonly name: "convex" = "convex"

Defined in: packages/file-storage-convex/src/adapter/index.ts:33

Protocol name — tells the admin panel what the identifier of this storage adapter is.

Overrides

StorageAdapterPresignedUrl.name

type

readonly type: "presigned-url" = STORAGE_ADAPTER_PROTOCOLS.presignedUrl

Defined in: packages/file-storage-convex/src/adapter/index.ts:34

Protocol type — tells the admin panel how to upload files.

Overrides

StorageAdapterPresignedUrl.type

Methods

createMediaDocument()

createMediaDocument<TDataModel>(ctx, args): Promise<string>

Defined in: packages/file-storage-convex/src/adapter/index.ts:74

Inserts a media document into the target collection table after a file upload completes.

Type Parameters

TDataModel

TDataModel extends GenericDataModel = GenericDataModel

Parameters

ctx

GenericMutationCtx<TDataModel>

Convex mutation context.

args

Document fields: collectionSlug, storageId, filename, mimeType, size, optional alt and adapterFields.

adapterFields?

Record<string, unknown>

alt?

string

collectionSlug

string

filename

string

mimeType

string

size

number

storageId

string

Returns

Promise<string>

Promise resolving to the new media document ID as a string.

Overrides

StorageAdapterPresignedUrl.createMediaDocument

deleteMedia()

deleteMedia<TDataModel>(ctx, args): Promise<boolean>

Defined in: packages/file-storage-convex/src/adapter/index.ts:98

Deletes a media document — physically removes the file from Convex storage unless softDelete (or this.admin.softDelete) is true, in which case the document is patched with { deleted: true }.

Type Parameters

TDataModel

TDataModel extends GenericDataModel = GenericDataModel

Parameters

ctx

GenericMutationCtx<TDataModel>

Convex mutation context.

args

collectionSlug, mediaId, and optional softDelete override.

collectionSlug

string

mediaId

string

softDelete?

boolean

Returns

Promise<boolean>

Promise resolving to true if the document was found and processed.

Overrides

StorageAdapterPresignedUrl.deleteMedia

generateUploadUrl()

generateUploadUrl<TDataModel>(ctx): Promise<GenerateUploadUrlReturn>

Defined in: packages/file-storage-convex/src/adapter/index.ts:61

Generates a presigned upload URL via ctx.storage.generateUploadUrl().

Type Parameters

TDataModel

TDataModel extends GenericDataModel = GenericDataModel

Parameters

ctx

GenericMutationCtx<TDataModel>

Convex mutation context.

Returns

Promise<GenerateUploadUrlReturn>

Promise resolving to { url: string } — POST the file body to this URL.

Overrides

StorageAdapterPresignedUrl.generateUploadUrl

getUrl()

getUrl<TDataModel>(ctx, args): Promise<GetUrlReturn>

Defined in: packages/file-storage-convex/src/adapter/index.ts:120

Resolves a serving URL for a media document by looking up its storageId and calling ctx.storage.getUrl().

Type Parameters

TDataModel

TDataModel extends GenericDataModel = GenericDataModel

Parameters

ctx

GenericQueryCtx<TDataModel>

Convex query context.

args

collectionSlug and mediaId of the target media document.

collectionSlug

string

mediaId

string

Returns

Promise<GetUrlReturn>

Promise resolving to { url } on success or { error } if the document or file is not found.

Overrides

StorageAdapterPresignedUrl.getUrl

uploadFile()

uploadFile(file, uploadUrl): Promise<UploadFileReturn>

Defined in: packages/file-storage-convex/src/adapter/index.ts:139

POSTs a file to the presigned upload URL returned by generateUploadUrl.

Runs in the browser — no Convex context required.

Parameters

file

File

The File object to upload.

uploadUrl

string

Presigned URL from generateUploadUrl.

Returns

Promise<UploadFileReturn>

Promise resolving to { storageId } assigned by Convex storage.

Overrides

StorageAdapterPresignedUrl.uploadFile