Types - Conventions#

API reference for ./model/conventions on @huukhanhnguyen/types.

See the Guide for the package's role.

API reference#

Signatures are generated from the live package .d.ts - not hand-written.

Convention#

interface

interface Convention

ConventionFinding#

interface

One deterministic, in-engine finding — a MEASURABLE defect read off an evaluated inspect report ("title block has no Scale field", "content fills < 20% of the usable area"). Facts only; anything needing eyes is a snapshot.

interface ConventionFinding

ConventionLane#

type

A ModelJSON lane key a convention governs ("sheets", "views", "materials", "lights", …). A string, not ModelLane — that type names the fold ROLE (parameters/scene/component/flat), a different axis.

type ConventionLane
// = string

ConventionSnapshot#

interface

The mandatory LOOK, declared not executed. The engine is dependency-free and never opens a browser; it names the surface to render and the single yes/no question a vision-judge answers. The verify harness renders + judges.

interface ConventionSnapshot

ConventionTier#

type

Ontology tier (IFC/bSDD/USD applied-schema precedent). T0 core is engine-hard and never appears here. T1 STANDARD ships with the product, versioned. T2 DOMAIN is an opt-in pack (arch Psets, CNC tags). T3 MODEL is the author's own and is never a convention. Everything in this package is T1; a pack registers T2 via mergeConventions.

type ConventionTier
// = "T1" | "T2"

DrawingStandard#

interface

interface DrawingStandard

LightingStandard#

interface

interface LightingStandard

MaterialStandard#

interface

interface MaterialStandard

TitleBlockField#

interface

One title-block cell. width is a fraction of the block width; source says where the value comes from so the composer + the AI grammar agree on it.

interface TitleBlockField