StorageAdapterPresignedUrl

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

Base class for storage adapters.

All file storage adapters must extend this class to ensure consistent behavior in the admin panel. Adapters override methods to implement adapter-specific logic (e.g., different storage backends).

Example

// In file-storage-convex/src/adapter/index.ts
import { BaseStorageAdapter } from "@vexcms/core";

export class ConvexStorageAdapter extends BaseStorageAdapter {
  readonly name = "convex";

  async generateUploadUrl(ctx) {
    const url = await ctx.storage.generateUploadUrl();
    return { url };
  }

  // Override other methods as needed...
}

Extended by

• ConvexStorageAdapter

Implements

• StorageAdapterPresignedUrlInterface

Constructors

Constructor

new StorageAdapterPresignedUrl(): StorageAdapterPresignedUrl

Returns

StorageAdapterPresignedUrl

Properties

admin

abstract admin: object

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

softDelete

softDelete: boolean

Implementation of

StorageAdapterPresignedUrlInterface.admin

---

mediaCollections

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

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

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.

Implementation of

StorageAdapterPresignedUrlInterface.mediaCollections

---

name

abstract readonly name: string

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

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

Implementation of

StorageAdapterPresignedUrlInterface.name

---

type

abstract readonly type: "presigned-url"

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

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

Implementation of

StorageAdapterPresignedUrlInterface.type

Methods

createMediaDocument()

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

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

Creates a media document in Convex after the file is uploaded. Override in subclass for adapter-specific implementation.

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>

Implementation of

StorageAdapterPresignedUrlInterface.createMediaDocument

---

deleteMedia()

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

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

Deletes a media document and its file from storage. Override in subclass for adapter-specific implementation.

Type Parameters

TDataModel

TDataModel extends GenericDataModel = GenericDataModel

Parameters

ctx

GenericMutationCtx<TDataModel>

args

collectionSlug

string

mediaId

string

softDelete?

boolean

Returns

Promise<boolean>

Implementation of

StorageAdapterPresignedUrlInterface.deleteMedia

---

generateUploadUrl()

abstract generateUploadUrl<TDataModel>(ctx): Promise<{ storageId?: string; url: string; }>

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

Generates a URL to upload a file to. Override in subclass for adapter-specific implementation.

Type Parameters

TDataModel

TDataModel extends GenericDataModel = GenericDataModel

Parameters

ctx

GenericMutationCtx<TDataModel>

Returns

Promise<{ storageId?: string; url: string; }>

Implementation of

StorageAdapterPresignedUrlInterface.generateUploadUrl

---

getUrl()

abstract getUrl<TDataModel>(ctx, args): Promise<{ error?: undefined; url: string; } | { error: string; url?: undefined; }>

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

Returns a URL for a media file. Override in subclass for adapter-specific implementation.

Type Parameters

TDataModel

TDataModel extends GenericDataModel = GenericDataModel

Parameters

ctx

GenericQueryCtx<TDataModel>

args

collectionSlug

string

mediaId

string

Returns

Promise<{ error?: undefined; url: string; } | { error: string; url?: undefined; }>

Implementation of

StorageAdapterPresignedUrlInterface.getUrl

---

uploadFile()

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

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

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, ... });

Implementation of

StorageAdapterPresignedUrlInterface.uploadFile