Class AbstractStorageAdapter`Abstract`

Base abstract class defining the contract for all storage adapters. Implements common logic for media thumbnailing and URL routing via gateways.

Hierarchy (View Summary)

AbstractStorageAdapter

Implements

StorageAdapterInterface

Constructors

constructor

new AbstractStorageAdapter(params?: StorageParameters): AbstractStorageAdapter
Parameters
- params: StorageParameters = {}
Returns AbstractStorageAdapter
- Defined in storage/src/AbstractStorageAdapter.ts:34

Properties

`Protected`_alias

_alias: string = ''

`Protected`_client

_client: any

`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 }>
- 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 }
- Defined in storage/src/AbstractStorageAdapter.ts:197

`Protected`_isDocumentType

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

`Protected`_setupThumbnailWorkspace

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

`Abstract`copy

copy(file: FileType, destFile: FileType): Promise<any>
Copies an existing file natively within the backend.
Parameters
- file: FileType
  Source footprint.
- destFile: FileType
  Destination footprint.
Returns Promise<any>
Implementation of StorageAdapterInterface.copy
- Defined in storage/src/AbstractStorageAdapter.ts:78

`Abstract`create

create(file: FileType, stream: Readable): Promise<FileType>
Uploads a file stream to the storage backend.
Parameters
- file: FileType
  Target file metadata.
- stream: Readable
  Readable data stream.
Returns Promise<FileType>
A promise resolving to the uploaded File footprint.
Implementation of StorageAdapterInterface.create
- Defined in storage/src/AbstractStorageAdapter.ts:61

`Abstract`delete

delete(file: FileType): Promise<boolean>
Deletes a file from the backend storage.
Parameters
- file: FileType
  The target file.
Returns Promise<boolean>
True if successful.
Implementation of StorageAdapterInterface.delete
- Defined in storage/src/AbstractStorageAdapter.ts:112

`Abstract`download

download(file: FileType, path: DownloadFileMetaType): Promise<any>
Downloads a remote file to a local destination.
Parameters
- file: FileType
  File footprint to download.
- path: DownloadFileMetaType
  Download configuration and destination path.
Returns Promise<any>
A promise resolving to the local file path or raw data.
Implementation of StorageAdapterInterface.download
- Defined in storage/src/AbstractStorageAdapter.ts:70

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.
- 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.
Implementation of StorageAdapterInterface.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.
Implementation of StorageAdapterInterface.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.
Implementation of StorageAdapterInterface.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.
Implementation of StorageAdapterInterface.getBucketStats
- Defined in storage/src/AbstractStorageAdapter.ts:153

`Abstract`getDriver

getDriver(): any
Returns the underlying SDK or driver instance.

Returns any
The raw storage client.
Implementation of StorageAdapterInterface.getDriver
- Defined in storage/src/AbstractStorageAdapter.ts:52

`Abstract`getMetaData

getMetaData(file: FileType): Promise<FileType>
Retrieves extended object metadata (like byte size and content-type) from the backend.
Parameters
- file: FileType
  Target footprint.
Returns Promise<FileType>
The augmented metadata block.
Implementation of StorageAdapterInterface.getMetaData
- Defined in storage/src/AbstractStorageAdapter.ts:144

`Abstract`getReadable

getReadable(file: FileType): Promise<Readable>
Connects to the backend and returns a Node Readable stream of the file content.
Parameters
- file: FileType
  Target file.
Returns Promise<Readable>
A promise resolving to the ReadStream.
Implementation of StorageAdapterInterface.getReadable
- Defined in storage/src/AbstractStorageAdapter.ts:136

`Abstract`getUploadUrl

getUploadUrl(filePath: FileType, expiresIn?: number): Promise<any>
Generates a direct-to-provider upload URL, bypassing the application server.
Parameters
- filePath: FileType
  The intended file footprint.
- OptionalexpiresIn: number
  Expiration of the upload link.
Returns Promise<any>
Implementation of StorageAdapterInterface.getUploadUrl
- Defined in storage/src/AbstractStorageAdapter.ts:128

`Abstract`getUrl

getUrl(
    file: FileType,
    expiresIn?: number,
    action?: string,
    extra?: any,
): Promise<any>
Generates a raw, natively routable provider URL (e.g., S3 presigned URL).
Parameters
- file: FileType
  The target file footprint.
- OptionalexpiresIn: number
  Signature expiration in seconds.
- Optionalaction: string
  Intended action ('read', 'write').
- Optionalextra: any
  Provider-specific overrides (e.g. { native: true }).
Returns Promise<any>
A promise resolving to the final native URL payload.
Implementation of StorageAdapterInterface.getUrl
- Defined in storage/src/AbstractStorageAdapter.ts:97

`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.
- Defined in storage/src/AbstractStorageAdapter.ts:485

`Abstract`move

move(file: FileType, destFile: FileType): Promise<any>
Moves/renames a file natively within the backend.
Parameters
- file: FileType
  Source footprint.
- destFile: FileType
  Destination footprint.
Returns Promise<any>
Implementation of StorageAdapterInterface.move
- Defined in storage/src/AbstractStorageAdapter.ts:86

`Abstract`stream

stream(file: FileType, res: any): Promise<any>
Directly pipes the remote file to a given local stream or HTTP response.
Parameters
- file: FileType
  File footprint.
- res: any
  Output writable stream.
Returns Promise<any>
Implementation of StorageAdapterInterface.stream
- Defined in storage/src/AbstractStorageAdapter.ts:120

Class AbstractStorageAdapterAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AbstractStorageAdapter

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>

Abstractcopy

Parameters

Returns Promise<any>

Abstractcreate

Parameters

Returns Promise<FileType>

Abstractdelete

Parameters

Returns Promise<boolean>

Abstractdownload

Parameters

Returns Promise<any>

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>

AbstractgetDriver

Returns any

AbstractgetMetaData

Parameters

Returns Promise<FileType>

AbstractgetReadable

Parameters

Returns Promise<Readable>

AbstractgetUploadUrl

Parameters

Returns Promise<any>

AbstractgetUrl

Parameters

Returns Promise<any>

ProtectedisVideoOrAudio

Parameters

Returns boolean

Abstractmove

Parameters

Returns Promise<any>

Abstractstream

Parameters

Returns Promise<any>

Settings

On This Page

Class AbstractStorageAdapter`Abstract`

`Protected`_alias

`Protected`_client

`Protected`_params

`Protected`_createAndUploadThumbnail

`Protected`_getFileInfo

`Protected`_isDocumentType

`Protected`_setupThumbnailWorkspace

`Abstract`copy

`Abstract`create

`Abstract`delete

`Abstract`download

`Abstract`getDriver

`Abstract`getMetaData

`Abstract`getReadable

`Abstract`getUploadUrl

`Abstract`getUrl

`Protected`isVideoOrAudio

`Abstract`move

`Abstract`stream