Class: ArtifactType

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:107

An artifact type defined in a schema, describing one category of file that a change produces (e.g. proposal, specs, tasks).

Immutable value object — equality is by identity (same schema, same id).

Constructors

Constructor

new ArtifactType(props): ArtifactType

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:132

Creates a new ArtifactType from schema configuration.

Parameters

props

ArtifactTypeProps

Artifact type configuration

Returns

ArtifactType

Accessors

delta

Get Signature

get delta(): boolean

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:209

true if this artifact supports delta files.

Returns

boolean

---

deltaInstruction

Get Signature

get deltaInstruction(): string | undefined

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:214

Domain-specific delta guidance injected by CompileContext, or undefined.

Returns

string | undefined

---

deltaValidations

Get Signature

get deltaValidations(): readonly ValidationRule[]

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:224

Structural validation rules applied to the delta file before application.

Returns

readonly ValidationRule[]

---

description

Get Signature

get description(): string | undefined

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:169

Human-readable summary for tooling, or undefined if not set.

Returns

string | undefined

---

format

Get Signature

get format(): ArtifactFormat | undefined

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:204

The declared file format, or undefined if inferred from the output extension.

Returns

ArtifactFormat | undefined

---

hasTasks

Get Signature

get hasTasks(): boolean

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:199

true if the artifact is explicitly marked as containing trackable tasks.

Returns

boolean

---

id

Get Signature

get id(): string

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:154

Stable identifier for this artifact type (e.g. "specs", "tasks").

Returns

string

---

instruction

Get Signature

get instruction(): string | undefined

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:184

The LLM instruction text for generating this artifact, or undefined.

Returns

string | undefined

---

optional

Get Signature

get optional(): boolean

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:194

true if this artifact may be absent without failing validation.

Returns

boolean

---

output

Get Signature

get output(): string

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:164

Glob pattern for the artifact's output files.

Returns

string

---

preHashCleanup

Get Signature

get preHashCleanup(): readonly PreHashCleanup[]

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:229

Regex substitutions applied to artifact content before computing any hash.

Returns

readonly PreHashCleanup[]

---

requires

Get Signature

get requires(): readonly string[]

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:189

IDs of artifact types that must be resolved before this one.

Returns

readonly string[]

---

rules

Get Signature

get rules(): ArtifactRules | undefined

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:239

Pre- and post-instruction rules, or undefined if none declared.

Returns

ArtifactRules | undefined

---

scope

Get Signature

get scope(): ArtifactScope

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:159

Where this artifact lives after archiving: "spec" or "change".

Returns

ArtifactScope

---

taskCompletionCheck

Get Signature

get taskCompletionCheck(): TaskCompletionCheck | undefined

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:234

Task completion detection config, or undefined if using defaults.

Returns

TaskCompletionCheck | undefined

---

template

Get Signature

get template(): string | undefined

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:174

Resolved template file content, or undefined.

Returns

string | undefined

---

templateRef

Get Signature

get templateRef(): string | undefined

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:179

Original template path reference as declared in the schema YAML, or undefined.

Returns

string | undefined

---

validations

Get Signature

get validations(): readonly ValidationRule[]

Defined in: packages/core/src/domain/value-objects/artifact-type.ts:219

Structural validation rules applied to the base artifact after delta application.

Returns

readonly ValidationRule[]