Class SupabaseStorageAdapter

Storage adapter implementation targeting Supabase Storage. Interfaces with the @supabase/storage-js client to manage buckets, secure signed URLs, and file uploads.

Hierarchy (View Summary)

AbstractStorageAdapter
- SupabaseStorageAdapter

Constructors

constructor

new SupabaseStorageAdapter(params: StorageParameters): SupabaseStorageAdapter
Parameters
- params: StorageParameters
Returns SupabaseStorageAdapter
Overrides AbstractStorageAdapter.constructor
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:23

Properties

`Protected`_alias

_alias: string = ''

`Protected`_client

_client: StorageClient

`Protected`_params

_params: StorageParameters = {}

Methods

`Protected`_createAndUploadThumbnail

_createAndUploadThumbnail(
    file: FileType,
    size: number,
    workingDir: string,
    bucketDir: string,
    thumbnailExtension: string,
    imagePath: string,
): Promise<{ [key: string]: string }>
Parameters
- file: FileType
- size: number
- workingDir: string
- bucketDir: string
- thumbnailExtension: string
- imagePath: string
Returns Promise<{ [key: string]: string }>
Inherited from AbstractStorageAdapter._createAndUploadThumbnail
- Defined in storage/src/AbstractStorageAdapter.ts:165

`Protected`_getFileInfo

_getFileInfo(file: FileType): { bucketDir: any; extension: any; name: any }
Parameters
- file: FileType
Returns { bucketDir: any; extension: any; name: any }
Inherited from AbstractStorageAdapter._getFileInfo
- Defined in storage/src/AbstractStorageAdapter.ts:197

`Protected`_isDocumentType

_isDocumentType(file: FileType, extension: string): boolean
Parameters
- file: FileType
- extension: string
Returns boolean
Inherited from AbstractStorageAdapter._isDocumentType
- Defined in storage/src/AbstractStorageAdapter.ts:204

`Protected`_setupThumbnailWorkspace

_setupThumbnailWorkspace(workingDirName: string): Promise<string>
Parameters
- workingDirName: string
Returns Promise<string>
Inherited from AbstractStorageAdapter._setupThumbnailWorkspace
- Defined in storage/src/AbstractStorageAdapter.ts:157

copy

copy(file: FileType, destFile: FileType): Promise<void>
Copies a file to a new destination key natively on the Supabase backend.
Parameters
- file: FileType
  Original file.
- destFile: FileType
  Target destination.
Returns Promise<void>
Overrides AbstractStorageAdapter.copy
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:158

create

create(file: FileType, stream: string | Readable): Promise<FileType>
Uploads a local file path or stream to the Supabase storage bucket.
Parameters
- file: FileType
  Target file schema.
- stream: string | Readable
  Readable stream or string path to the file.
Returns Promise<FileType>
A promise resolving to the created file footprint.

Throws
If upload is rejected.
Overrides AbstractStorageAdapter.create
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:116

delete

delete(file: FileType): Promise<boolean>
Permanently removes the file from the Supabase bucket.
Parameters
- file: FileType
  Target file.
Returns Promise<boolean>
True upon success.
Overrides AbstractStorageAdapter.delete
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:258

download

download(file: FileType, meta: DownloadFileMetaType): Promise<string | Blob>
Downloads the file directly, either returning the blob content or saving it locally.
Parameters
- file: FileType
  File footprint.
- meta: DownloadFileMetaType
  Options dictating save path or return format.
Returns Promise<string | Blob>
A promise resolving to the blob or local file path.
Overrides AbstractStorageAdapter.download
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:319

generateDocumentThumbnail

generateDocumentThumbnail(file: FileType, sizes: number[]): Promise<any>
Extracts the first page of a document (e.g. PDF) via ImageMagick, resizes it, and uploads it as a thumbnail.
Parameters
- file: FileType
  Original document footprint.
- sizes: number[]
  Array of desired thumbnail dimensions (px).
Returns Promise<any>
A mapping of generated thumbnail identifiers to their respective storage refs.
Inherited from AbstractStorageAdapter.generateDocumentThumbnail
- Defined in storage/src/AbstractStorageAdapter.ts:355

generateImageThumbnail

generateImageThumbnail(file: FileType, sizes: number[]): Promise<any>
Downloads an image, generates resized thumbnails via sharp, and uploads them back.
Parameters
- file: FileType
  Original image footprint.
- sizes: number[]
  Array of desired thumbnail dimensions (px).
Returns Promise<any>
A mapping of generated thumbnail identifiers to their respective storage refs.
Inherited from AbstractStorageAdapter.generateImageThumbnail
- Defined in storage/src/AbstractStorageAdapter.ts:237

generateThumbnail

generateThumbnail(file: FileType, sizes: number[]): Promise<any>
Entry point for thumbnail generation. Analyzes the content type and automatically delegates to the appropriate generation strategy (Image, Video, or Document).
Parameters
- file: FileType
  Target file footprint.
- sizes: number[]
  Desired dimensions.
Returns Promise<any>
The generated thumbnail map, or an empty object if unsupported/failed.
Inherited from AbstractStorageAdapter.generateThumbnail
- Defined in storage/src/AbstractStorageAdapter.ts:430

generateVideoThumbnail

generateVideoThumbnail(file: FileType, sizes: number[]): Promise<any>
Extracts a single frame from a remote video via ffmpeg, resizes it, and uploads the frame as an image thumbnail.
Parameters
- file: FileType
  Original video footprint.
- sizes: number[]
  Array of desired thumbnail dimensions (px).
Returns Promise<any>
A mapping of generated thumbnail identifiers to their respective storage refs.
Inherited from AbstractStorageAdapter.generateVideoThumbnail
- Defined in storage/src/AbstractStorageAdapter.ts:285

getBucketStats

getBucketStats(bucket?: string, prefix?: string): Promise<BucketStatsType>
Computes statistics for a given bucket.
Parameters
- Optionalbucket: string
  Target bucket name.
- Optionalprefix: string
  Optional directory prefix.
Returns Promise<BucketStatsType>
A promise resolving to bucket statistics.
Inherited from AbstractStorageAdapter.getBucketStats
- Defined in storage/src/AbstractStorageAdapter.ts:153

getDriver

getDriver(): StorageClient
Exposes the underlying Supabase StorageClient instance.

Returns StorageClient
The storage client.
Overrides AbstractStorageAdapter.getDriver
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:38

getMetaData

getMetaData(file: FileType): Promise<FileType>
Retrieves file metadata. Currently acts as a passthrough for Supabase.
Parameters
- file: FileType
  Target file footprint.
Returns Promise<FileType>
The file metadata.
Overrides AbstractStorageAdapter.getMetaData
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:48

getReadable

getReadable(file: FileType): Promise<Readable>
Downloads the file content to a temporary location and returns a Readable stream.
Parameters
- file: FileType
  File to read.
Returns Promise<Readable>
The content as a stream.
Overrides AbstractStorageAdapter.getReadable
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:277

getUploadUrl

getUploadUrl(file: FileType, _expiresIn?: number): Promise<FileResponseLinkType>
Get signed upload url for file Careful, on docker the time to live for JWT signature is defaulted to 60 sec Add SIGNED_UPLOAD_URL_EXPIRATION_TIME env variable to fix TTL
Parameters
- file: FileType
  FileType
- _expiresIn: number = 7200
  actually ignored
Returns Promise<FileResponseLinkType>
Overrides AbstractStorageAdapter.getUploadUrl
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:351

getUrl

getUrl(
    file: FileType,
    expiresIn?: number,
    action?: any,
    extra?: any,
): Promise<{ expiresIn: number; url: string }>
Generates a secure, temporary GET link to access the object remotely.
Parameters
- file: FileType
  The file footprint.
- expiresIn: number = 3600
  URL expiration in seconds.
- action: any = 'read'
  Intended action context.
- extra: any = {}
  Optional parameters (e.g. cache configurations).
Returns Promise<{ expiresIn: number; url: string }>
A promise resolving to the signed URL payload.

Throws
If signature creation fails.
Overrides AbstractStorageAdapter.getUrl
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:206

`Protected`isVideoOrAudio

isVideoOrAudio(file: FileType): boolean
Checks if the file is a video or audio stream based on its MIME type or file extension.
Parameters
- file: FileType
  Target file.
Returns boolean
True if the file represents a video or audio asset.
Inherited from AbstractStorageAdapter.isVideoOrAudio
- Defined in storage/src/AbstractStorageAdapter.ts:485

move

move(file: FileType, destFile: FileType): Promise<FileType>
Moves/Renames an existing file natively within Supabase Storage.
Parameters
- file: FileType
  The source file.
- destFile: FileType
  The target file.
Returns Promise<FileType>
A promise resolving to the newly placed destination file.

Throws
If the move operation fails.
Overrides AbstractStorageAdapter.move
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:178

stream

stream(file: FileType, res: any): Promise<any>
Fetches and pipes the file content into the given response stream.
Parameters
- file: FileType
  File to stream.
- res: any
  Writable stream or HTTP response object.
Returns Promise<any>
The piped stream instance.
Overrides AbstractStorageAdapter.stream
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:298

streamToBuffer

streamToBuffer(stream: Stream): Promise<Buffer<ArrayBufferLike>>
Helper converting a node stream to a Buffer, essential for Blob creation.
Parameters
- stream: Stream
  The input stream.
Returns Promise<Buffer<ArrayBufferLike>>
A promise resolving to the concatenated Buffer.
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:83

test

test(): Promise<boolean>
Validates backend connectivity by listing available buckets in the Supabase project.

Returns Promise<boolean>
True if connected.
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:57

toArrayBuffer

toArrayBuffer(buffer: Buffer): ArrayBuffer
Internal helper to convert a Buffer into a native ArrayBuffer.
Parameters
- buffer: Buffer
  The raw Buffer.
Returns ArrayBuffer
The ArrayBuffer representation.
- Defined in storage-supabase/src/SupabaseStorageAdapter.ts:99

Class SupabaseStorageAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SupabaseStorageAdapter

Properties

Protected_alias

Protected_client

Protected_params

Methods

Protected_createAndUploadThumbnail

Parameters

Returns Promise<{ [key: string]: string }>

Protected_getFileInfo

Parameters

Returns { bucketDir: any; extension: any; name: any }

Protected_isDocumentType

Parameters

Returns boolean

Protected_setupThumbnailWorkspace

Parameters

Returns Promise<string>

copy

Parameters

Returns Promise<void>

create

Parameters

Returns Promise<FileType>

Throws

delete

Parameters

Returns Promise<boolean>

download

Parameters

Returns Promise<string | Blob>

generateDocumentThumbnail

Parameters

Returns Promise<any>

generateImageThumbnail

Parameters

Returns Promise<any>

generateThumbnail

Parameters

Returns Promise<any>

generateVideoThumbnail

Parameters

Returns Promise<any>

getBucketStats

Parameters

Returns Promise<BucketStatsType>

getDriver

Returns StorageClient

getMetaData

Parameters

Returns Promise<FileType>

getReadable

Parameters

Returns Promise<Readable>

getUploadUrl

Parameters

Returns Promise<FileResponseLinkType>

getUrl

Parameters

Returns Promise<{ expiresIn: number; url: string }>

Throws

ProtectedisVideoOrAudio

Parameters

Returns boolean

move

Parameters

Returns Promise<FileType>

Throws

stream

Parameters

Returns Promise<any>

`Protected`_alias

`Protected`_client

`Protected`_params

`Protected`_createAndUploadThumbnail

`Protected`_getFileInfo

`Protected`_isDocumentType

`Protected`_setupThumbnailWorkspace

`Protected`isVideoOrAudio