Class MockAdapter

A purely in-memory storage adapter designed for unit tests and local mock integrations. Files are temporarily stored in a Node.js Map<string, Buffer>.

Hierarchy (View Summary)

AbstractStorageAdapter
- MockAdapter

Constructors

constructor

new MockAdapter(params?: StorageParameters): MockAdapter
Parameters
- params: StorageParameters = {}
Returns MockAdapter
Inherited from AbstractStorageAdapter.constructor
- 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 }>
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<any>
Duplicates a buffer map entry to a new key.
Parameters
- file: FileType
  Source footprint.
- destFile: FileType
  Target footprint.
Returns Promise<any>
True upon success.
Overrides AbstractStorageAdapter.copy
- Defined in storage/src/MockAdapter.ts:65

create

create(file: FileType, stream: Readable): Promise<FileType>
Concatenates the readable stream into a buffer and stores it in memory.
Parameters
- file: FileType
  Target footprint.
- stream: Readable
  Data stream.
Returns Promise<FileType>
A promise resolving to the saved footprint.
Overrides AbstractStorageAdapter.create
- Defined in storage/src/MockAdapter.ts:31

delete

delete(file: FileType): Promise<boolean>
Erases the file from the memory map.
Parameters
- file: FileType
  Target footprint.
Returns Promise<boolean>
True if an element was removed.
Overrides AbstractStorageAdapter.delete
- Defined in storage/src/MockAdapter.ts:103

download

download(file: FileType, path: DownloadFileMetaType): Promise<any>
Writes an in-memory buffer to a localized test output directory.
Parameters
- file: FileType
  Target footprint.
- path: DownloadFileMetaType
  Destination metadata.
Returns Promise<any>
A promise resolving to the physical path written.

Throws
If the file doesn't exist in memory.
Overrides AbstractStorageAdapter.download
- Defined in storage/src/MockAdapter.ts:48

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 (mock implementation).
Parameters
- Optionalbucket: string
  Target bucket name.
- Optionalprefix: string
  Optional directory prefix.
Returns Promise<BucketStatsType>
A promise resolving to bucket statistics.
Overrides AbstractStorageAdapter.getBucketStats
- Defined in storage/src/MockAdapter.ts:171

getDriver

getDriver(): Map<string, Buffer<ArrayBufferLike>>
Returns the in-memory Map acting as the driver.

Returns Map<string, Buffer<ArrayBufferLike>>
The map containing buffered files.
Overrides AbstractStorageAdapter.getDriver
- Defined in storage/src/MockAdapter.ts:20

getMetaData

getMetaData(file: FileType): Promise<FileType>
Extrapolates basic metadata, such as byte size, directly from the buffer.
Parameters
- file: FileType
  Target footprint.
Returns Promise<FileType>
The file appended with memory metadata.
Overrides AbstractStorageAdapter.getMetaData
- Defined in storage/src/MockAdapter.ts:153

getReadable

getReadable(file: FileType): Promise<Readable>
Creates a readable stream from the memory buffer.
Parameters
- file: FileType
  Target footprint.
Returns Promise<Readable>
The generated stream.

Throws
If the buffer doesn't exist.
Overrides AbstractStorageAdapter.getReadable
- Defined in storage/src/MockAdapter.ts:139

getUploadUrl

getUploadUrl(filePath: FileType): Promise<any>
Returns a mock upload endpoint URL.
Parameters
- filePath: FileType
  Target footprint.
Returns Promise<any>
A mock string upload URL.
Overrides AbstractStorageAdapter.getUploadUrl
- Defined in storage/src/MockAdapter.ts:128

getUrl

getUrl(file: FileType): Promise<any>
Returns a mock URL pointing to a fictitious test domain.
Parameters
- file: FileType
  Target footprint.
Returns Promise<any>
A mock string URL.
Overrides AbstractStorageAdapter.getUrl
- Defined in storage/src/MockAdapter.ts:93

`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<any>
Moves a buffer map entry to a new key.
Parameters
- file: FileType
  Source footprint.
- destFile: FileType
  Target footprint.
Returns Promise<any>
True upon success.
Overrides AbstractStorageAdapter.move
- Defined in storage/src/MockAdapter.ts:81

stream

stream(file: FileType, res: any): Promise<any>
Pipes the buffered memory content directly into an output response.
Parameters
- file: FileType
  Target footprint.
- res: any
  Output writable stream.
Returns Promise<any>
Throws
If the file is missing from memory.
Overrides AbstractStorageAdapter.stream
- Defined in storage/src/MockAdapter.ts:114

Class MockAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MockAdapter

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<any>

create

Parameters

Returns Promise<FileType>

delete

Parameters

Returns Promise<boolean>

download

Parameters

Returns Promise<any>

Throws

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 Map<string, Buffer<ArrayBufferLike>>

getMetaData

Parameters

Returns Promise<FileType>

getReadable

Parameters

Returns Promise<Readable>

Throws

getUploadUrl

Parameters

Returns Promise<any>

getUrl

Parameters

Returns Promise<any>

ProtectedisVideoOrAudio

Parameters

Returns boolean

move

Parameters

Returns Promise<any>

stream

Parameters

Returns Promise<any>

Throws

`Protected`_alias

`Protected`_client

`Protected`_params

`Protected`_createAndUploadThumbnail

`Protected`_getFileInfo

`Protected`_isDocumentType

`Protected`_setupThumbnailWorkspace

`Protected`isVideoOrAudio