IssueCode Contract 2.0.0 · package sha256
a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e· generated fromconfigurator-runtime.d.tsbyservices/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.
Type · import type { IssueCode } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 17. Assets: describe, manifest, validation
What an Issue reports: an InputErrorCode, a checkAsset check, or a value the stored format
can't hold. A code newer than the page's contract reaches it as 'other' (spec section 3.6).
| Code | Summary |
|---|---|
'element' |
checkAsset: the manifest's element matches none of the contract's globs. |
'part' |
checkAsset: a contract part is missing where required, or has another tag, or a slot that is neither its slot nor one of its slots. |
'slot' |
checkAsset: a contract slot the manifest lacks, or one without uvMetres where realSize asks for it. |
'connector' |
checkAsset: fewer connectors of a type than the contract's count. |
'animation' |
checkAsset: a contract clip name the asset lacks. |
'connector-name-collision' |
checkAsset: two connector planes whose authored names clean to the same name (spec section 6.9, ID1). |
'connector-id' |
checkAsset: an extras.holostep.connector.id that contains ':' (ID1). |
'not-storable' |
validate: a value the stored format can't hold. |
'space-not-storable' |
validate('configurator'): space: 'parent' in a document meant to be saved. |
Also every code of InputErrorCode.
The set is open: a code newer than your declared contract arrives as 'other'.
export type IssueCode = InputErrorCode | 'element' | 'part' | 'slot' | 'connector' | 'animation' | 'connector-name-collision' | 'connector-id' | 'not-storable' | 'space-not-storable' | 'other';| Rule | Result |
|---|---|
| 1. Neutral name | pass: IssueCode names no product |
| 2. A precedent | not recorded: no ledger row (coverage.json) names this member or its owner |
| 3. Two apps, or labs | not recorded: no ledger row names this member or its owner |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |