IConfiguratorNode ​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.
Interface · import type { IConfiguratorNode } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 21. Stored data (vendored; replaces @holo/interfaces)
The fields every stored node has. Fields not declared, and attributes values of any JSON type,
pass through: the runtime checks a stored node only for nodeId and the fields it reads, and
every output carries the rest unchanged (key material excepted, section 8.5). An applyPatch
field path writes an undeclared field only when the node already carries it ('unknown-field'
otherwise; section 8.1).
| Member | Kind | Summary |
|---|---|---|
_id? |
property | The backend's id; the runtime ignores it. |
type |
property | Which node type. |
nodeId |
property | The placed-node id. |
label? |
property | A name for editors and shoppers. |
order? |
property | Sort order among siblings in editors. |
enabled |
property | Recorded and priced: false takes the node (and its connections) out of the scene. |
expanded? |
property | Editor state only. |
createdAt? |
property | |
updatedAt? |
property | |
children? |
property | |
thumbnailUrl? |
property | |
attributes? |
property | Your own key-value data. |
export interface IConfiguratorNode {
_id?: string;
type: 'ModelNode' | 'MaterialNode' | 'GroupNode';
nodeId: string;
label?: string;
order?: number;
enabled: boolean;
expanded?: boolean;
createdAt?: Date | string;
updatedAt?: Date | string;
children?: ConfiguratorNode[];
thumbnailUrl?: string;
attributes?: Record<string, string>;
}
| Rule | Result |
|---|---|
| 1. Neutral name | pass: IConfiguratorNode 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) |