WorkspaceCompositionReferences · types

The following types define named objects and their relationships. Tables include inherited properties. Schema-derived types refer to their validated structures; a TypeScript declaration does not replace the compiler’s semantic checks.

WorkspaceCompositionReferenceScreen

Current POC screen facts come only from admitted native Model declarations, never instance authority.

export type WorkspaceCompositionReferenceScreen =
  | { readonly kind: 'home'; readonly references: SurfaceCompositionModelReferences }
  | { readonly kind: 'collection'; readonly destinationKey: string; readonly viewKey: string; readonly references: SurfaceCompositionModelReferences }
  | { readonly kind: 'record'; readonly recordProfileKey: string; readonly references: SurfaceCompositionModelReferences }
  | { readonly kind: 'work'; readonly experienceKey: string; readonly references: SurfaceCompositionModelReferences };

type WorkspaceCompositionReferenceScreen = { readonly kind: "home"; readonly references: SurfaceCompositionModelReferences; } | { readonly kind: "collection"; readonly destinationKey: string; readonly viewKey: string; readonly references: SurfaceCompositionModelReferences; } | { readonly kind: "record"; readonly recordProfileKey: string; readonly references: SurfaceCompositionModelReferences; } | { readonly kind: "work"; readonly experienceKey: string; readonly references: SurfaceCompositionModelReferences; };

WorkspaceCompositionReferences

One passive current envelope; every screen explicitly carries its actual Work capabilities, including an empty set.

Field	Options / expected values	Description
contract	"WorkspaceCompositionReferences@1"	Required. Exact discriminant of this contract variant. Match the literal value shown.
catalogue	{ contract: "SurfaceCompositionCatalogue@1"; version: "0.0.0.1"; hash: string; }	Required. Defines catalogue for this object. Observe the type, variants and bounds in the Options column.
screens	readonly WorkspaceCompositionReferenceScreen[]	Required. Defines screens for this object. Observe the type, variants and bounds in the Options column.

export interface WorkspaceCompositionReferences {
  readonly contract: 'WorkspaceCompositionReferences@1';
  readonly catalogue: SurfaceCompositionCatalogueIdentity;
  readonly screens: readonly WorkspaceCompositionReferenceScreen[];
}

All references

Applied examples : Compose a record and its relations

Two declared Stacks hold main content then relations without extra frames. The preset selects the right panel’s width.

Configuration

Component properties RecordLayout.props. Properties and accepted values.

{
  "asideWidth": "standard"
}

Variation and connection

Component properties RecordLayout.props. Properties and accepted values.

{
  "asideWidth": "compact"
}

UI layout example

The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.

1. Client identity
2. Notes and follow-up
3. Settings
4. Linked quotes

SurfaceClients / North StudioExample

WorkspaceCompositionReferences · typesCompose a record and its relations

Clients

NS

North StudioActive client · Professional services

StatusActive ⌄

Notes and follow-up

The client wants a proposal for a new project. Clarify requirements and confirm the budget before review.

Editable text on the Surface

Record settings