IConfigurator ​

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 { IConfigurator } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 21. Stored data (vendored; replaces @holo/interfaces)

The stored configurator document.

Members ​

Member Kind Summary
_id? property The backend's id: the saved configuration's identity.
accountId property The owning account.
name property The configurator's name.
type property The backend's document type.
version property The backend's document version.
hdrUrl? property Stored environment HDR, storage only: the runtime never reads it, as 1.4 didn't.
hdrName? property The stored HDR's name, storage only, as hdrUrl.
thumbnailUrl? property
toneMapping? property Stored tone-mapping name, storage only: the runtime never reads it, as 1.4 didn't, and maps no name.
backgroundColor? property The stored backdrop: the runtime draws a non-null value as the scene model's background layer (BackgroundValue).
status property The backend's publication state.
defaultView property The initial camera view, which the app converts with cameraViewFromStored, then applies with camera.set: the runtime never reads it (see IDefaultView).
defaultCurrency property The default ISO 4217 currency for prices.
createdAt? property
updatedAt? property
root property The node tree.
defaultNodeId? property Stored for editors; the runtime never reads it: every enabled root node is placed (spec section 6.9, ID10).
connections? property Top level, never inside viewerDocument.
connectionsBasis? property The basis fingerprint of connections: store connectionsBasis(model, connections) with every save.
attributes property Your own data.
parameters property Your own parameters.
presets? property
isUserConfiguration? property True for a shopper's saved design (not the configurator itself).
viewerDocument? property The stored viewer-document layer; only the admin route writes it.

Declaration ​

ts
export interface IConfigurator {
  _id?: string;
  accountId: number;
  name: string;
  type: string;
  version: string;
  hdrUrl?: string;
  hdrName?: string;
  thumbnailUrl?: string;
  toneMapping?: string;
  backgroundColor?: BackgroundValue;
  status: 'active' | 'inactive' | 'archived';
  defaultView: IDefaultView;
  defaultCurrency: string;
  createdAt?: Date | string;
  updatedAt?: Date | string;
  root: ConfiguratorNode[];
  defaultNodeId?: string;
  connections?: Connection[];
  connectionsBasis?: string;
  attributes: Record<string, unknown>;
  parameters: Record<string, unknown>;
  presets?: IPreset[];
  isUserConfiguration?: boolean;
  viewerDocument?: Record<string, unknown>;
}

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: IConfigurator 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: 20 apps (fleet cross-check: app-04c2774145, app-0c773a4ee3, app-37356bf09f, app-4762caacdc, app-4fd23bc869, app-822bb9d6aa, app-8675b3225c, app-b362a81c85 and 12 more)
4. The cheaper fix first not recorded per member (Appendix B decides it per need)