Class S3StorageAdapter

Storage adapter implementation for AWS S3 compatible services. Implements direct stream uploads, presigned URLs, and multipart handling.

Hierarchy (View Summary)

AbstractStorageAdapter
- S3StorageAdapter

Constructors

constructor

new S3StorageAdapter(params: StorageParameters): S3StorageAdapter
Parameters
- params: StorageParameters
Returns S3StorageAdapter
Overrides AbstractStorageAdapter.constructor
- Defined in storage-s3/src/S3StorageAdapter.ts:33

Properties

`Protected`_alias

_alias: string = ''

`Protected`_client

_client: S3Client

`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 an existing object within S3 to a new destination key or bucket.
Parameters
- file: FileType
  Source file.
- destFile: FileType
  Destination file.
Returns Promise<void>
Overrides AbstractStorageAdapter.copy
- Defined in storage-s3/src/S3StorageAdapter.ts:146

create

create(file: FileType, stream: Readable): Promise<FileType>
Uploads a file stream directly into an S3 Bucket.
Parameters
- file: FileType
  Target file metadata.
- stream: Readable
  The content readable stream.
Returns Promise<FileType>
A promise resolving to the uploaded FileType metadata.

Throws
If the upload fails.
Overrides AbstractStorageAdapter.create
- Defined in storage-s3/src/S3StorageAdapter.ts:112

delete

delete(file: FileType): Promise<boolean>
Deletes an object from the S3 Bucket.
Parameters
- file: FileType
  The file to remove.
Returns Promise<boolean>
A promise resolving to true on success.
Overrides AbstractStorageAdapter.delete
- Defined in storage-s3/src/S3StorageAdapter.ts:222

download

download(file: FileType, meta: DownloadFileMetaType): Promise<string>
Downloads an S3 object and writes it directly to the local filesystem.
Parameters
- file: FileType
  The remote file.
- meta: DownloadFileMetaType
  Local download path instructions.
Returns Promise<string>
A promise resolving to the local file path.
Overrides AbstractStorageAdapter.download
- Defined in storage-s3/src/S3StorageAdapter.ts:309

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 in S3. Iterates over all objects in the bucket to compute total count and size.
Parameters
- Optionalbucket: string
  Target bucket name.
- Optionalprefix: string
Returns Promise<BucketStatsType>
A promise resolving to bucket statistics.
Overrides AbstractStorageAdapter.getBucketStats
- Defined in storage-s3/src/S3StorageAdapter.ts:352

getDriver

getDriver(): S3Client
Exposes the underlying AWS S3 Client instance.

Returns S3Client
The S3Client instance.
Overrides AbstractStorageAdapter.getDriver
- Defined in storage-s3/src/S3StorageAdapter.ts:77

getMetaData

getMetaData(file: FileType): Promise<FileType>
Issues a HEAD request to fetch S3 object metadata like size and content-type without downloading the actual payload.
Parameters
- file: FileType
  The file footprint.
Returns Promise<FileType>
A promise resolving to the augmented metadata.
Overrides AbstractStorageAdapter.getMetaData
- Defined in storage-s3/src/S3StorageAdapter.ts:264

getReadable

getReadable(file: FileType): Promise<Readable>
Downloads an S3 object and returns it as a Node.js Readable stream.
Parameters
- file: FileType
  The target file.
Returns Promise<Readable>
A promise resolving to the ReadStream.
Overrides AbstractStorageAdapter.getReadable
- Defined in storage-s3/src/S3StorageAdapter.ts:241

getUploadUrl

getUploadUrl(file: FileType, expiresIn?: number): Promise<FileResponseLinkType>
Generates a presigned PUT URL allowing clients to upload directly to S3, bypassing the backend.
Parameters
- file: FileType
  The requested upload file destination.
- expiresIn: number = 3600
  Token expiration in seconds.
Returns Promise<FileResponseLinkType>
A promise resolving to the upload URL instructions.
Overrides AbstractStorageAdapter.getUploadUrl
- Defined in storage-s3/src/S3StorageAdapter.ts:325

getUrl

getUrl(
    file: FileType,
    expiresIn?: number,
    action?: any,
    extra?: any,
): Promise<{ expiresIn: number; url: string }>
Generates a temporary, presigned GET URL for public or secure access.
Parameters
- file: FileType
  Target file.
- expiresIn: number = 3600
  URL expiration time in seconds.
- action: any = 'read'
  The requested action ('read', etc.).
- extra: any = {}
  Extra parameters such as 'cacheControl'.
Returns Promise<{ expiresIn: number; url: string }>
A promise resolving to the generated URL and expiration payload.
Overrides AbstractStorageAdapter.getUrl
- Defined in storage-s3/src/S3StorageAdapter.ts:198

`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>
Move file to given destination There is no native command in AWS SDK for this, we need to copy then delete source media
Parameters
- file: FileType
- destFile: FileType
Returns Promise<FileType>
Overrides AbstractStorageAdapter.move
- Defined in storage-s3/src/S3StorageAdapter.ts:170

stream

stream(file: FileType, res: any): Promise<any>
Directly pipes an S3 object to an external HTTP response or stream.
Parameters
- file: FileType
  Target file.
- res: any
  The response or writable stream.
Returns Promise<any>
The piped stream instance.
Overrides AbstractStorageAdapter.stream
- Defined in storage-s3/src/S3StorageAdapter.ts:287

streamToBuffer

streamToBuffer(stream: Stream): Promise<Buffer<ArrayBufferLike>>
Helper utility converting a Node.js Stream into a raw Buffer. Required for S3 payloads when streaming sizes are indeterminate.
Parameters
- stream: Stream
  The input stream.
Returns Promise<Buffer<ArrayBufferLike>>
A promise resolving to the concatenated Buffer.
- Defined in storage-s3/src/S3StorageAdapter.ts:88

test

test(): Promise<boolean>
Validates the connection to the configured S3 endpoint by attempting to list buckets.

Returns Promise<boolean>
True if the connection succeeds and buckets are accessible.
- Defined in storage-s3/src/S3StorageAdapter.ts:60

Class S3StorageAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns S3StorageAdapter

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>

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 S3Client

getMetaData

Parameters

Returns Promise<FileType>

getReadable

Parameters

Returns Promise<Readable>

getUploadUrl

Parameters

Returns Promise<FileResponseLinkType>

getUrl

Parameters

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

ProtectedisVideoOrAudio

Parameters

Returns boolean

move

Parameters

Returns Promise<FileType>

stream

Parameters

Returns Promise<any>

streamToBuffer

Parameters

`Protected`_alias

`Protected`_client

`Protected`_params

`Protected`_createAndUploadThumbnail

`Protected`_getFileInfo

`Protected`_isDocumentType

`Protected`_setupThumbnailWorkspace

`Protected`isVideoOrAudio