StorageAdapterBaseInterface

Defined in: packages/core/src/media/types.ts:113

Shared interface implemented by all storage adapters.

Defines the minimum contract — name, type, mediaCollections, and the four lifecycle methods (createMediaDocument, deleteMedia, getUrl, uploadFile) — that every adapter must satisfy regardless of protocol.

See

• StorageAdapterPresignedUrlInterface for the presigned-URL sub-interface
• StorageAdapterPresignedUrl for the abstract base class

Extended by

• StorageAdapterPresignedUrlInterface

Properties

admin

admin: object

Defined in: packages/core/src/media/types.ts:129

softDelete

softDelete: boolean

When true, delete operations set deleted: true on the media document instead of physically removing the file. The file remains in storage until a scheduled cleanup job purges it.

Default

false

---

mediaCollections

mediaCollections: MediaCollectionConfig<BaseFieldMeta, MediaCollectionMeta, string, string, ComponentHKT>[]

Defined in: packages/core/src/media/types.ts:127

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.

---

name

readonly name: string

Defined in: packages/core/src/media/types.ts:115

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

---

type

readonly type: "presigned-url"

Defined in: packages/core/src/media/types.ts:117

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

Methods

createMediaDocument()

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

Defined in: packages/core/src/media/types.ts:144

Creates a media document in Convex after the file is uploaded. All adapters must use this exact signature.

Type Parameters

TDataModel

TDataModel extends GenericDataModel = GenericDataModel

Parameters

ctx

GenericMutationCtx<TDataModel>

args

adapterFields?

Record<string, unknown>

alt?

string

collectionSlug

string

filename

string

mimeType

string

size

number

storageId

string

Returns

Promise<string>

---

deleteMedia()

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

Defined in: packages/core/src/media/types.ts:161

Deletes a media document and its file from storage. All adapters must use this exact signature.

Type Parameters

TDataModel

TDataModel extends GenericDataModel = GenericDataModel

Parameters

ctx

GenericMutationCtx<TDataModel>

args

collectionSlug

string

mediaId

string

softDelete?

boolean

Returns

Promise<boolean>

---

getUrl()

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

Defined in: packages/core/src/media/types.ts:170

Returns a URL for a media file. All adapters must use this exact signature.

Type Parameters

TDataModel

TDataModel extends GenericDataModel = GenericDataModel

Parameters

ctx

GenericQueryCtx<TDataModel>

args

collectionSlug

string

mediaId

string

Returns

Promise<GetUrlReturn>

---

uploadFile()

uploadFile(file, uploadUrl): Promise<{[key: string]: unknown; storageId: string; url?: string; }>

Defined in: packages/core/src/media/types.ts:192

Uploads a file to the storage backend and returns the storage ID.

This is a pure JS function that can be called from any framework (React, Next.js, Svelte, etc.) or even directly in the browser.

Parameters

file

any

The file to upload

uploadUrl

string

The presigned URL from generateUploadUrl

Returns

Promise<{[key: string]: unknown; storageId: string; url?: string; }>

Promise resolving to { storageId, url, … } with adapter-specific fields

Example

// React component
const { storageId } = await adapter.uploadFile(file, uploadUrl);
await createMediaDocument({ storageId, ... });