Skip to main content

ArtifactExport

@forge/monorepo


@forge/monorepo / backend/src / ArtifactExport

Type Alias: ArtifactExport

ArtifactExport = object

Defined in: backend/src/persistence/index.ts:975

Properties

artifactId

readonly artifactId: ArtifactId

Defined in: backend/src/persistence/index.ts:977


byteSize?

readonly optional byteSize?: number

Defined in: backend/src/persistence/index.ts:990


checksum?

readonly optional checksum?: string

Defined in: backend/src/persistence/index.ts:991


createdAt

readonly createdAt: string

Defined in: backend/src/persistence/index.ts:995


failureMessage?

readonly optional failureMessage?: string

Defined in: backend/src/persistence/index.ts:993


failureReason?

readonly optional failureReason?: string

Defined in: backend/src/persistence/index.ts:992


fileId?

readonly optional fileId?: FileId

Defined in: backend/src/persistence/index.ts:989

The rendered bytes, as a file.

A FileId rather than a BlobRef: BlobStore holds JSON and a PDF is bytes, and going through the file ports means the export inherits #129's entitlement check and short-lived signed URLs rather than needing a second mediated-download path.


format

readonly format: ExportFormat

Defined in: backend/src/persistence/index.ts:980


id

readonly id: string

Defined in: backend/src/persistence/index.ts:976


renderedAt?

readonly optional renderedAt?: string

Defined in: backend/src/persistence/index.ts:996


requestedBy

readonly requestedBy: PrincipalId

Defined in: backend/src/persistence/index.ts:994


state

readonly state: ExportState

Defined in: backend/src/persistence/index.ts:981


version

readonly version: number

Defined in: backend/src/persistence/index.ts:979

The content version this rendered. An export is of a version, never of "the artifact".