seed/plan
seed/plan
Type Aliases
CompiledSeedPlan
type CompiledSeedPlan = object;Defined in: platform-utils/src/seed/plan.ts:19
Flat execution plan derived from a SeedManifest at bootstrap time.
Properties
SeedInsertRecord
type SeedInsertRecord<TRecord> = TRecord & SeedSystemFields;Defined in: platform-utils/src/seed/plan.ts:197
Seed insert row — workspace record shape plus required system columns.
Type Parameters
| Type Parameter | Default type |
|---|---|
TRecord extends Record<string, unknown> |
Record<string, unknown> |
SeedMutationStep
type SeedMutationStep = object;Defined in: platform-utils/src/seed/plan.ts:11
One seed batch: a collection insert with optional ordering constraints.
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
collection |
readonly |
string |
platform-utils/src/seed/plan.ts:13 |
dependsOn? |
readonly |
ReadonlyArray<SeedStepId> |
platform-utils/src/seed/plan.ts:15 |
id |
readonly |
SeedStepId |
platform-utils/src/seed/plan.ts:12 |
records |
readonly |
ReadonlyArray<Record<string, unknown>> |
platform-utils/src/seed/plan.ts:14 |
SeedRecordRef
type SeedRecordRef = object;Defined in: platform-utils/src/seed/plan.ts:45
Opaque ref resolved at compile time to a seeded record id.
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
__seedRef |
readonly |
SeedStepId |
platform-utils/src/seed/plan.ts:46 |
recordId? |
readonly |
string |
platform-utils/src/seed/plan.ts:47 |
SeedRelationRow
type SeedRelationRow = object;Defined in: platform-utils/src/seed/plan.ts:212
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
from_id |
readonly |
string |
platform-utils/src/seed/plan.ts:213 |
to_id |
readonly |
string |
platform-utils/src/seed/plan.ts:214 |
SeedStepId
type SeedStepId = string;Defined in: platform-utils/src/seed/plan.ts:8
SeedSystemFields
type SeedSystemFields = Pick<SystemRecordFields, "norbital_id" | "norbital_created_at" | "norbital_updated_at">;Defined in: platform-utils/src/seed/plan.ts:191
System columns required on every seed insert row.
WorkspaceSeedDefinition
type WorkspaceSeedDefinition = object;Defined in: platform-utils/src/seed/plan.ts:29
Author-time seed definition exported from the optional src/+seed.ts role.
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
manifest |
readonly |
SeedManifest |
platform-utils/src/seed/plan.ts:31 |
steps |
readonly |
readonly SeedMutationStep[] |
platform-utils/src/seed/plan.ts:30 |
Functions
compiledSeedPlanFromManifest()
function compiledSeedPlanFromManifest(manifest): CompiledSeedPlan;Defined in: platform-utils/src/seed/plan.ts:177
Flatten a seed manifest into ordered createMany mutation batches for runtime seeding.
Parameters
| Parameter | Type |
|---|---|
manifest |
SeedManifest |
Returns
compileSeedManifest()
function compileSeedManifest(steps, options?): SeedManifest;Defined in: platform-utils/src/seed/plan.ts:144
Compile DAG seed manifest; resolves seedRef markers while preserving step metadata.
Parameters
| Parameter | Type |
|---|---|
steps |
readonly SeedMutationStep[] |
options? |
{ clearBefore?: readonly string[]; } |
options.clearBefore? |
readonly string[] |
Returns
defineSeed()
function defineSeed(steps, options?): WorkspaceSeedDefinition;Defined in: platform-utils/src/seed/plan.ts:34
Parameters
| Parameter | Type |
|---|---|
steps |
readonly SeedMutationStep[] |
options? |
{ clearBefore?: readonly string[]; } |
options.clearBefore? |
readonly string[] |
Returns
seedRef()
function seedRef(stepId, recordId?): SeedRecordRef;Defined in: platform-utils/src/seed/plan.ts:55
Reference a record id from another seed step (defaults to that step's first record).
Parameters
| Parameter | Type |
|---|---|
stepId |
string |
recordId? |
string |
Returns
seedRow()
function seedRow<TRecord>(row): SeedInsertRecord<TRecord>;Defined in: platform-utils/src/seed/plan.ts:200
Type Parameters
| Type Parameter |
|---|
TRecord extends Record<string, unknown> |
Parameters
| Parameter | Type |
|---|---|
row |
SeedInsertRecord<TRecord> |
Returns
SeedInsertRecord<TRecord>
seedRows()
function seedRows<TRecord>(rows): readonly SeedInsertRecord<TRecord>[];Defined in: platform-utils/src/seed/plan.ts:206
Type Parameters
| Type Parameter |
|---|
TRecord extends Record<string, unknown> |
Parameters
| Parameter | Type |
|---|---|
rows |
readonly SeedInsertRecord<TRecord>[] |
Returns
readonly SeedInsertRecord<TRecord>[]
seedStep()
function seedStep<T>(step): T;Defined in: platform-utils/src/seed/plan.ts:50
Type Parameters
| Type Parameter |
|---|
T extends SeedMutationStep |
Parameters
| Parameter | Type |
|---|---|
step |
T |
Returns
T
sortSeedSteps()
function sortSeedSteps(steps): SeedMutationStep[];Defined in: platform-utils/src/seed/plan.ts:109
Topological sort of seed steps; throws on unknown deps or cycles.
Parameters
| Parameter | Type |
|---|---|
steps |
readonly SeedMutationStep[] |