Assembly ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Interface · import type { Assembly } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 12. Assembly

Connectors and connections between placed models (spec section 6.12).

Members ​

Member Kind Summary
connectors method Read class: derived (world positions computed on read).
candidates method The pairs attach would accept, measured as attach measures them: at each node's scene-model pose (spec section 6.12, A5), never over connectors(), which adds pose rules and a held drag pose on top of the…
attach method Attaches node by its connectors (recorded; merging; in the write queue): moves its model root and records the connection.
detach method Removes a node's connections, or a connector's: all of them for a multi connector (recorded; merging; in the write queue).
connections method Intent read.

Declaration ​

ts
export interface Assembly<C extends object = NoCommitOptions> {
  connectors(node: string): Connector[];
  candidates(node: string, options?: {
    from?: string;
    near?: Point3;
    to?: ConnectorRef | {
      node: string;
    };
  }): Array<{
    readonly from: ConnectorRef;
    readonly to: ConnectorRef;
    readonly score: number;
  }>;
  attach(node: string, options?: RecordedOptions<C> & AttachOptions): Promise<AttachReport>;
  detach(target: string | ConnectorRef, options?: RecordedOptions<C> & SignalOption): Promise<Report>;
  connections(): Connection[];
}

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: Assembly names no product
2. A precedent not recorded: no ledger row (coverage.json) names this member or its owner
3. Two apps, or labs pass: 14 apps (fleet cross-check: app-04c2774145, app-37356bf09f, app-4762caacdc, app-510d750508, app-b362a81c85, app-bcb7ef21da, app-c1384707fc, app-ceb4eccc72 and 6 more)
4. The cheaper fix first not recorded per member (Appendix B decides it per need)