Class FirebaseStorageAdapter

Storage adapter implementing Google Firebase Storage integration. Uses firebase-admin to manage files, metadata, and signed URLs seamlessly across Firebase buckets.

Hierarchy (View Summary)

AbstractStorageAdapter
- FirebaseStorageAdapter

Constructors

constructor

new FirebaseStorageAdapter(params?: StorageParameters): FirebaseStorageAdapter
Parameters
- params: StorageParameters = {}
Returns FirebaseStorageAdapter
Overrides AbstractStorageAdapter.constructor
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:20

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 }>
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 internally across or within Firebase buckets.
Parameters
- file: FileType
  Original file.
- destFile: FileType
  Destination file footprint.
Returns Promise<void>
Overrides AbstractStorageAdapter.copy
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:85

create

create(File: FileType, stream: Readable): Promise<FileType>
Uploads a local file stream to a designated Firebase Storage bucket.
Parameters
- File: FileType
  Target file configuration.
- stream: Readable
  Readable stream containing file data.
Returns Promise<FileType>
A promise resolving to the saved File footprint.
Overrides AbstractStorageAdapter.create
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:112

delete

delete(file: FileType): Promise<boolean>
Deletes a file permanently from Firebase Storage.
Parameters
- file: FileType
  Target file footprint.
Returns Promise<boolean>
True if deleted successfully.
Overrides AbstractStorageAdapter.delete
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:169

download

download(
file: FileType,
meta: DownloadFileMetaType,
): Promise<string | Buffer<ArrayBufferLike>>
Downloads a file from Firebase storage locally.
Parameters
- file: FileType
  File footprint.
- meta: DownloadFileMetaType
  Options containing the local path or instructing a content buffer return.
Returns Promise<string | Buffer<ArrayBufferLike>>
A promise resolving to the local file path or raw buffer data.
Overrides AbstractStorageAdapter.download
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:69

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(): Storage
Provides access to the initialized Firebase getStorage() driver.

Returns Storage
The Firebase Storage instance.
Overrides AbstractStorageAdapter.getDriver
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:38

getMetaData

getMetaData(file: FileType): Promise<FileType>
Fetches explicit file metadata from Firebase, appending it to the footprint.
Parameters
- file: FileType
  Target file footprint.
Returns Promise<FileType>
A promise resolving to the file augmented with Firebase metadata.
Overrides AbstractStorageAdapter.getMetaData
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:48

getReadable

getReadable(file: FileType): Promise<Readable>
Downloads the file content locally into memory and wraps it in a Readable stream. Use carefully on large files to prevent buffer overflow.
Parameters
- file: FileType
  Target file footprint.
Returns Promise<Readable>
A promise resolving to a Readable buffer stream.

Throws
If the file doesn't exist on the remote bucket.
Overrides AbstractStorageAdapter.getReadable
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:230

getUploadUrl

getUploadUrl(file: FileType, duration?: number): Promise<FileResponseLinkType>
Generates a secure PUT/Write URL allowing direct Firebase uploads from the client.
Parameters
- file: FileType
  Upload target.
- duration: number = 3600
  Token lifetime in seconds.
Returns Promise<FileResponseLinkType>
A promise resolving to the upload instructions.
Overrides AbstractStorageAdapter.getUploadUrl
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:205

getUrl

getUrl(
    fileData: FileType,
    expiresIn?: number,
    action?: string,
    extra?: any,
): Promise<FileResponseUrlType>
Generates a signed access URL using firebase-admin.
Parameters
- fileData: FileType
  The file to expose.
- expiresIn: number = 7200
  Expiration in seconds.
- Optionalaction: string
  The requested action (e.g. 'read', 'write').
- Optionalextra: any
  Optional Firebase signed URL overrides.
Returns Promise<FileResponseUrlType>
A promise resolving to the signed URL payload.
Overrides AbstractStorageAdapter.getUrl
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:139

`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<void>
Moves a file internally across or within Firebase buckets.
Parameters
- file: FileType
  Source file.
- destFile: FileType
  Target destination.
Returns Promise<void>
Overrides AbstractStorageAdapter.move
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:98

stream

stream(file: FileType, res: any): Promise<any>
Creates a readable stream and directly pipes it into an active response.
Parameters
- file: FileType
  Target file.
- res: any
  Output writable stream.
Returns Promise<any>
The piped stream instance.
Overrides AbstractStorageAdapter.stream
- Defined in storage-firebase/src/FirebaseStorageAdapter.ts:193

Class FirebaseStorageAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FirebaseStorageAdapter

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>

delete

Parameters

Returns Promise<boolean>

download

Parameters

Returns Promise<string | Buffer<ArrayBufferLike>>

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 Storage

getMetaData

Parameters

Returns Promise<FileType>

getReadable

Parameters

Returns Promise<Readable>

Throws

getUploadUrl

Parameters

Returns Promise<FileResponseLinkType>

getUrl

Parameters

Returns Promise<FileResponseUrlType>

ProtectedisVideoOrAudio

Parameters

Returns boolean

move

Parameters

Returns Promise<void>

stream

Parameters

Returns Promise<any>

Settings

On This Page

`Protected`_alias

`Protected`_client

`Protected`_params

`Protected`_createAndUploadThumbnail

`Protected`_getFileInfo

`Protected`_isDocumentType

`Protected`_setupThumbnailWorkspace

`Protected`isVideoOrAudio