Interface IAttachmentBlobStore

Blob operations an attachment needs, behind a seam so attachment policy does not depend on any particular storage implementation — or on there being one.

Implementations are responsible for the MJ: Files record alongside the bytes, because the two must not diverge: a catalog row without content, or content without a row, is worse than a failed upload.

interface IAttachmentBlobStore {
    Delete(
        fileId: string,
        contextUser: UserInfo,
        provider?: IMetadataProvider,
    ): Promise<boolean>;
    Download(
        fileId: string,
        contextUser: UserInfo,
        provider?: IMetadataProvider,
    ): Promise<string>;
    GetDownloadUrl(
        fileId: string,
        contextUser: UserInfo,
        provider?: IMetadataProvider,
    ): Promise<string>;
    Upload(
        input: AttachmentBlobUploadInput,
        contextUser: UserInfo,
        provider?: IMetadataProvider,
    ): Promise<AttachmentBlobUploadResult>;
}

Implemented by

GraphQLAttachmentBlobStore

Index

Methods

Delete Download GetDownloadUrl Upload

Methods

Delete

Delete(
    fileId: string,
    contextUser: UserInfo,
    provider?: IMetadataProvider,
): Promise<boolean>
Deletes both the stored bytes and the MJ: Files record.
Parameters
- fileId: string
- contextUser: UserInfo
- Optionalprovider: IMetadataProvider
Returns Promise<boolean>
true when the blob was deleted. A false here means the caller should leave the attachment row alone rather than orphan it.
- Defined in packages/AI/CorePlus/src/attachment-blob-store.ts:144

Download

Download(
    fileId: string,
    contextUser: UserInfo,
    provider?: IMetadataProvider,
): Promise<string>
Reads a stored file's content.
Parameters
- fileId: string
- contextUser: UserInfo
- Optionalprovider: IMetadataProvider
Returns Promise<string>
Base64-encoded content, or null when the file or its storage cannot be resolved.
- Defined in packages/AI/CorePlus/src/attachment-blob-store.ts:126

GetDownloadUrl

GetDownloadUrl(
    fileId: string,
    contextUser: UserInfo,
    provider?: IMetadataProvider,
): Promise<string>
Mints a pre-authenticated download URL for a stored file.

Preferred over Download when the consumer can fetch the URL itself — it avoids moving the bytes through this process.
Parameters
- fileId: string
- contextUser: UserInfo
- Optionalprovider: IMetadataProvider
Returns Promise<string>
The URL, or null when one cannot be produced.
- Defined in packages/AI/CorePlus/src/attachment-blob-store.ts:136

Upload

Upload(
    input: AttachmentBlobUploadInput,
    contextUser: UserInfo,
    provider?: IMetadataProvider,
): Promise<AttachmentBlobUploadResult>
Stores bytes and creates the corresponding MJ: Files record.
Parameters
- input: AttachmentBlobUploadInput
- contextUser: UserInfo
- Optionalprovider: IMetadataProvider
Returns Promise<AttachmentBlobUploadResult>
The created file id, or a structured failure. Never throws for an expected condition such as a missing storage configuration.
- Defined in packages/AI/CorePlus/src/attachment-blob-store.ts:115

Interface IAttachmentBlobStore

Implemented by

Index

Methods

Methods

Delete

Parameters

Returns Promise<boolean>

Download

Parameters

Returns Promise<string>

GetDownloadUrl

Parameters

Returns Promise<string>

Upload

Parameters

Returns Promise<AttachmentBlobUploadResult>

Settings

On This Page