Interface BaseArtifactService

Interface for artifact services.

interface BaseArtifactService {
    deleteArtifact(request: DeleteArtifactRequest): Promise<void>;
    listArtifactKeys(request: ListArtifactKeysRequest): Promise<string[]>;
    listVersions(request: ListVersionsRequest): Promise<number[]>;
    loadArtifact(request: LoadArtifactRequest): Promise<Part | undefined>;
    saveArtifact(request: SaveArtifactRequest): Promise<number>;
}

Implemented by

Methods

deleteArtifact

deleteArtifact(request: DeleteArtifactRequest): Promise<void>
Deletes an artifact.
Parameters
- request: DeleteArtifactRequest
  The request to delete an artifact.
Returns Promise<void>
A promise that resolves when the artifact is deleted.
- Defined in core/src/artifacts/base_artifact_service.ts:128

listArtifactKeys

listArtifactKeys(request: ListArtifactKeysRequest): Promise<string[]>
Lists all the artifact filenames within a session.
Parameters
- request: ListArtifactKeysRequest
  The request to list artifact keys.
Returns Promise<string[]>
A promise that resolves to a list of all artifact filenames within a session.
- Defined in core/src/artifacts/base_artifact_service.ts:120

listVersions

listVersions(request: ListVersionsRequest): Promise<number[]>
Lists all versions of an artifact.
Parameters
- request: ListVersionsRequest
  The request to list versions.
Returns Promise<number[]>
A promise that resolves to a list of all available versions of the artifact.
- Defined in core/src/artifacts/base_artifact_service.ts:137

loadArtifact

loadArtifact(request: LoadArtifactRequest): Promise<Part | undefined>
Gets an artifact from the artifact service storage.

The artifact is a file identified by the app name, user ID, session ID, and filename.
Parameters
- request: LoadArtifactRequest
  The request to load an artifact.
Returns Promise<Part | undefined>
A promise that resolves to the artifact or undefined if not found.
- Defined in core/src/artifacts/base_artifact_service.ts:111

saveArtifact

saveArtifact(request: SaveArtifactRequest): Promise<number>
Saves an artifact to the artifact service storage.

The artifact is a file identified by the app name, user ID, session ID, and filename. After saving the artifact, a revision ID is returned to identify the artifact version.
Parameters
- request: SaveArtifactRequest
  The request to save an artifact.
Returns Promise<number>
A promise that resolves to The revision ID. The first version of the artifact has a revision ID of 0. This is incremented by 1 after each successful save.
- Defined in core/src/artifacts/base_artifact_service.ts:100