Class GitStorageAdapter

Git and GitHub Storage Adapter for Quatrain Core. Manages files locally via Git shell execution, or remotely via the GitHub REST API.

Hierarchy (View Summary)

AbstractStorageAdapter
- GitStorageAdapter

Constructors

constructor

new GitStorageAdapter(parameters?: StorageParameters): GitStorageAdapter
Parameters
- parameters: StorageParameters = {}
Returns GitStorageAdapter
Overrides AbstractStorageAdapter.constructor
- Defined in packages/storage-git/src/GitStorageAdapter.ts:35

Properties

`Protected`_alias

_alias: string = ''

`Protected`_client

_client: any

`Protected`_params

_params: StorageParameters = {}

`Protected`config

config: GitStorageConfig

`Protected`octokit

octokit:
| Octokit & { paginate: PaginateInterface } & RestEndpointMethods & Api
| null = null

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 packages/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 packages/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 packages/storage/src/AbstractStorageAdapter.ts:204

`Protected`_setupThumbnailWorkspace

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

copy

copy(file: FileType, destFile: FileType): Promise<any>
Copies a file from one repository location to another.
Parameters
- file: FileType
  Source file footprint.
- destFile: FileType
  Destination file footprint.
Returns Promise<any>
A promise resolving to the copied file metadata.
Overrides AbstractStorageAdapter.copy
- Defined in packages/storage-git/src/GitStorageAdapter.ts:287

create

create(file: FileType, stream: Readable): Promise<FileType>
Creates a new file or updates an existing one in the git repository or GitHub.
Parameters
- file: FileType
  Target file metadata.
- stream: Readable
  Readable stream containing the file content.
Returns Promise<FileType>
A promise resolving to the created file's metadata footprint.
Overrides AbstractStorageAdapter.create
- Defined in packages/storage-git/src/GitStorageAdapter.ts:92

delete

delete(file: FileType): Promise<boolean>
Deletes a file from the repository and commits/pushes the change.
Parameters
- file: FileType
  Target file footprint.
Returns Promise<boolean>
A promise resolving to true if the file was deleted, false otherwise.
Overrides AbstractStorageAdapter.delete
- Defined in packages/storage-git/src/GitStorageAdapter.ts:173

download

download(file: FileType, destMeta: DownloadFileMetaType): Promise<any>
Downloads a stored file to a specific local path.
Parameters
- file: FileType
  Target file footprint.
- destMeta: DownloadFileMetaType
  Destination file path configuration.
Returns Promise<any>
A promise resolving to the final local destination path.
Overrides AbstractStorageAdapter.download
- Defined in packages/storage-git/src/GitStorageAdapter.ts:271

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 packages/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 packages/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 packages/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 packages/storage/src/AbstractStorageAdapter.ts:285

getBucketStats

getBucketStats(bucket?: string, prefix?: string): Promise<BucketStatsType>
Computes statistics for the Git repository storage.
Parameters
- Optionalbucket: string
  Optional bucket name (defaults to 'default').
- Optionalprefix: string
  Optional directory prefix to scan.
Returns Promise<BucketStatsType>
A promise resolving to the bucket statistics.
Overrides AbstractStorageAdapter.getBucketStats
- Defined in packages/storage-git/src/GitStorageAdapter.ts:384

getDriver

getDriver(): any
Returns the underlying SDK or driver instance (Octokit for GitHub, fs-extra for local).

Returns any
The raw storage client or file system module.
Overrides AbstractStorageAdapter.getDriver
- Defined in packages/storage-git/src/GitStorageAdapter.ts:60

getMetaData

getMetaData(file: FileType): Promise<FileType>
Retrieves file metadata, specifically augmenting it with byte size.
Parameters
- file: FileType
  Target file footprint.
Returns Promise<FileType>
A promise resolving to the file footprint containing sizes.
Overrides AbstractStorageAdapter.getMetaData
- Defined in packages/storage-git/src/GitStorageAdapter.ts:350

getReadable

getReadable(file: FileType): Promise<Readable>
Retrieves the file content as a Readable stream.
Parameters
- file: FileType
  Target file footprint.
Returns Promise<Readable>
A promise resolving to a Node Readable stream.
Overrides AbstractStorageAdapter.getReadable
- Defined in packages/storage-git/src/GitStorageAdapter.ts:144

getUploadUrl

getUploadUrl(filePath: FileType, expiresIn?: number): Promise<any>
Generates a direct upload URL (returns the read URL since git upload is committed directly).
Parameters
- filePath: FileType
  Target file footprint.
- OptionalexpiresIn: number
  Expiry window in seconds (ignored).
Returns Promise<any>
A promise resolving to the raw URL string.
Overrides AbstractStorageAdapter.getUploadUrl
- Defined in packages/storage-git/src/GitStorageAdapter.ts:329

getUrl

getUrl(
    file: FileType,
    expiresIn?: number,
    action?: string,
    extra?: any,
): Promise<any>
Generates a raw URL pointing to the raw file content in Git/GitHub.
Parameters
- file: FileType
  Target file footprint.
- OptionalexpiresIn: number
  Expiry window in seconds (ignored).
- Optionalaction: string
  Action intent (ignored).
- Optionalextra: any
  Provider specific overrides (ignored).
Returns Promise<any>
A promise resolving to the final raw public URL string.
Overrides AbstractStorageAdapter.getUrl
- Defined in packages/storage-git/src/GitStorageAdapter.ts:315

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

list

list(prefixOrOptions?: any): Promise<string[]>
Lists all files within the repository that match the prefix.
Parameters
- prefixOrOptions: any = ''
  Root prefix directory or options object.
Returns Promise<string[]>
A promise resolving to a list of matching file reference paths.
- Defined in packages/storage-git/src/GitStorageAdapter.ts:218

move

move(file: FileType, destFile: FileType): Promise<any>
Moves/renames a file natively in the repository.
Parameters
- file: FileType
  Source file footprint.
- destFile: FileType
  Destination file footprint.
Returns Promise<any>
A promise resolving to the relocated file footprint.
Overrides AbstractStorageAdapter.move
- Defined in packages/storage-git/src/GitStorageAdapter.ts:300

`Protected`runGit

runGit(cmd: string): Promise<void>
Parameters
- cmd: string
Returns Promise<void>
- Defined in packages/storage-git/src/GitStorageAdapter.ts:64

stream

stream(file: FileType, res: any): Promise<any>
Pipes the file content directly into a writable stream.
Parameters
- file: FileType
  Target file footprint.
- res: any
  Target writable stream.
Returns Promise<any>
Overrides AbstractStorageAdapter.stream
- Defined in packages/storage-git/src/GitStorageAdapter.ts:339

`Protected`streamToString

streamToString(stream: Readable): Promise<string>
Parameters
- stream: Readable
Returns Promise<string>
- Defined in packages/storage-git/src/GitStorageAdapter.ts:77

Class GitStorageAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GitStorageAdapter

Properties

Protected_alias

Protected_client

Protected_params

Protectedconfig

Protectedoctokit

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>

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 any

getMetaData

Parameters

Returns Promise<FileType>

getReadable

Parameters

Returns Promise<Readable>

getUploadUrl

Parameters

Returns Promise<any>

getUrl

Parameters

Returns Promise<any>

ProtectedisVideoOrAudio

Parameters

Returns boolean

list

Parameters

Returns Promise<string[]>

move

Parameters

Returns Promise<any>

ProtectedrunGit

`Protected`_alias

`Protected`_client

`Protected`_params

`Protected`config

`Protected`octokit

`Protected`_createAndUploadThumbnail

`Protected`_getFileInfo

`Protected`_isDocumentType

`Protected`_setupThumbnailWorkspace

`Protected`isVideoOrAudio

`Protected`runGit

`Protected`streamToString