KayKitGuideScenario
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:455
Decomposed scenario contract for one extracted KayKit guide page. Scenarios connect the image page to assets, public APIs, visual artifacts, and docs.
Properties
Section titled “Properties”assetIds
Section titled “assetIds”assetIds: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:469
Asset ids that must be exercised for this page/use case.
docs: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:477
Documentation pages that explain the public contract.
edition
Section titled “edition”edition:
KayKitGuideScenarioEdition
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:465
Edition scope for the use case shown by the page.
id:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:457
Stable scenario id derived from the guide page and use case.
page:
number
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:459
One-based extracted guide page number.
publicApi
Section titled “publicApi”publicApi: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:471
Public helper surfaces that express this guide page.
sourceImage
Section titled “sourceImage”sourceImage:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:463
Extracted PNG page used as source material.
summary
Section titled “summary”summary:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:467
Concise implementation intent for humans, tests, and agents.
title:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:461
Human-readable guide page title.
treatmentRoles
Section titled “treatmentRoles”treatmentRoles: readonly
KayKitAssetPublicRole[]
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:473
Public treatment roles represented by this page.
visualArtifacts
Section titled “visualArtifacts”visualArtifacts: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:475
Screenshot or docs artifacts that should be reviewed for this page.