BuildModel
Defined in: packages/core/src/models/build.ts:19
Data operations for build records.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BuildModel(
db,tables?,logger?):BuildModel
Defined in: packages/core/src/models/build.ts:25
logger only reports a status write refused by a cancelled build, at debug.
Parameters
Section titled “Parameters”tables?
Section titled “tables?”BuildTables
logger?
Section titled “logger?”Returns
Section titled “Returns”BuildModel
Methods
Section titled “Methods”create()
Section titled “create()”create(
projectId,input):Promise<Build>
Defined in: packages/core/src/models/build.ts:35
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
Returns
Section titled “Returns”Promise<Build>
get(
id):Promise<Build|null>
Defined in: packages/core/src/models/build.ts:57
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Build | null>
latestApprovedDefault()
Section titled “latestApprovedDefault()”latestApprovedDefault(
project):Promise<Build|null>
Defined in: packages/core/src/models/build.ts:97
Return the build a project-slug Storybook link resolves to: the most recent
approved build on the project’s default branch. Approved builds on other
branches never qualify (their PR can still be dismissed), and neither do
pending, failed, or unreviewed default-branch builds. Visibility (public or
authenticated) is checked separately by the caller.
Parameters
Section titled “Parameters”project
Section titled “project”gitDefaultBranch
Section titled “gitDefaultBranch”string
string
Returns
Section titled “Returns”Promise<Build | null>
list()
Section titled “list()”list(
projectId,filter?):Promise<Build[]>
Defined in: packages/core/src/models/build.ts:61
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
filter?
Section titled “filter?”BuildListFilter = {}
Returns
Section titled “Returns”Promise<Build[]>
remove()
Section titled “remove()”remove(
id):Promise<void>
Defined in: packages/core/src/models/build.ts:199
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
resetStatus()
Section titled “resetStatus()”resetStatus(
id,status):Promise<Build>
Defined in: packages/core/src/models/build.ts:142
Put a finished build back to status for a retry. The one write that leaves cancelled
(a user chose it), so it skips the terminal guard of BuildModel.update.
Parameters
Section titled “Parameters”string
status
Section titled “status”"failed" | "cancelled" | "pending" | "capturing" | "comparing" | "reviewing" | "approved" | "rejected"
Returns
Section titled “Returns”Promise<Build>
setAffected()
Section titled “setAffected()”setAffected(
id,input):Promise<Build>
Defined in: packages/core/src/models/build.ts:150
Record the affected-capture computation for a build. Idempotent: the CLI posts this once after creating the build and before uploading the bundle.
Parameters
Section titled “Parameters”string
AffectedComputation
Returns
Section titled “Returns”Promise<Build>
setStatus()
Section titled “setStatus()”setStatus(
id,status):Promise<Build>
Defined in: packages/core/src/models/build.ts:134
Parameters
Section titled “Parameters”string
status
Section titled “status”"failed" | "cancelled" | "pending" | "capturing" | "comparing" | "reviewing" | "approved" | "rejected"
Returns
Section titled “Returns”Promise<Build>
setTestResults()
Section titled “setTestResults()”setTestResults(
id,results):Promise<Build>
Defined in: packages/core/src/models/build.ts:163
Store the results of the build’s .test() entries (TestResult[], as JSON), or clear them
with null. Written once per capture run, by the run that ran the tests.
Parameters
Section titled “Parameters”string
results
Section titled “results”readonly unknown[] | null
Returns
Section titled “Returns”Promise<Build>
update()
Section titled “update()”update(
id,patch,options?):Promise<Build>
Defined in: packages/core/src/models/build.ts:113
Patch a build. A cancelled build is terminal (ADR 0006): a patch that carries another status
is refused, the row is returned as it is, so a capture that ends after a cancel cannot move
the build. Only BuildModel.resetStatus leaves cancelled.
Parameters
Section titled “Parameters”string
Partial<Pick<Build, "status" | "public" | "message" | "authorEmail" | "authorName">>
options?
Section titled “options?”reset?
Section titled “reset?”boolean
Returns
Section titled “Returns”Promise<Build>
updateCounts()
Section titled “updateCounts()”updateCounts(
id):Promise<Build>
Defined in: packages/core/src/models/build.ts:178
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Build>
affectedPaths()
Section titled “affectedPaths()”
staticaffectedPaths(build):string[] |null
Defined in: packages/core/src/models/build.ts:174
Parse a build’s affected import paths. Returns null for full capture
(no computation, or an unreadable payload) — callers render everything.
Parameters
Section titled “Parameters”Pick<Build, "affectedImportPaths">
Returns
Section titled “Returns”string[] | null