Docs / The model / BrandDesignSystem

BrandDesignSystem.

The brand's visual system made from its pages held whole: every value with its basis and the artefacts it was read from, and the same values in the platform's token shape

Figure 1BrandDesignSystemspecified

BrandDesignSystem is a definition at brand scope. The drawing shows its fields and the objects that they point at.

kind: definition
scope: brand
key: the brand and its version
store: postgres
family: market

Fields#

field	type	required	note
`brand`	`id`	yes
`website`	`address`	yes	the site the pages were captured from
`pages_read`	`[hash]`	yes	the captures whose documents were read whole
`site_tokens`	BrandSiteToken	yes	the custom properties the site declares on its root
`colours`	BrandColour	yes	every colour declared, with its count, and the roles
`modes`	`[text]`	yes	the colour modes measured: light, and dark where the site declares one
`faces`	BrandFace	yes	the body, heading and fixed-width faces
`type_scale`	BrandTypeStep	yes
`scale_ratio`	BrandRatio	no	the ratio between consecutive sizes when the scale is modular, inferred by the named rule
`hierarchy`	BrandHierarchyLevel	yes	the visual hierarchy and what makes it up: each level’s size, line, weight, colour and the space below it, from the rules on the heading elements, the body and the small text
`spacing`	BrandStep	yes
`spacing_unit`	BrandStep	no	inferred by the named rule from the most used steps
`rhythm`	BrandRhythm	no	the vertical rhythm: the baseline and the share of vertical steps on it, inferred by the named rule
`radii`	BrandStep	yes
`borders`	BrandBorder	yes	every border width and style declared
`shadows`	BrandShadow	yes
`gradients`	BrandGradient	yes	every gradient declared, with its colours
`durations`	BrandDuration	yes	every transition and animation duration declared
`easings`	BrandEasing	yes	every timing function declared
`keyframes`	BrandKeyframes	yes	every keyframes block declared: the site’s own animations
`breakpoints`	BrandBreakpoint	yes	every width the media queries turn on
`z_layers`	BrandLayer	yes	every z-index declared: the site’s stacking layers
`grid`	BrandGrid	no	the layout grid: container widths, column counts and gutters
`icons`	BrandIconography	no	the icon system the pages use and the sizes drawn
`components`	BrandComponent	yes	the recurring parts of the pages: a class the stylesheet styles as a surface, used on the pages, with its declarations
`elements`	BrandElement	yes	the brand’s elements by kind: logo, icon, mark, texture, illustration, imagery, photo, shape; the held file of each where one is held
`assets`	BrandAsset	yes	every file the pages load that is held: images, animated images, icons, fonts and media, each by its bytes
`traits`	BrandTrait	yes	the motifs read from the measured values by named rules: the palette’s shape, the corners, the depth, the type, the grid, the buttons, the cards, the fields, the badges, the iconography; imagery and composition come from the rendered pass
`frameworks`	`[text]`	yes	the style frameworks the pages show signs of (Tailwind, Bootstrap), measured from the class names and the compiled stylesheet
`variants`	BrandVariant	yes	the base and every variant: the dark mode measured or derived, the densities, the high contrast, and the media, each a sparse delta over its parent with its derivation and its rules; the resolver reads the effective system at any coordinate
`templates`	BrandTemplate	yes	the templates of every format on the base variant, derived by rule: the frames, their scaffolds and their CSS
`logo`	BrandLogo	no
`gaps`	CoverageGap	yes	what was not measured and what would measure it
`platform_tokens`	`json`	yes	the measured values in the DesignSystem row’s token shape, generated from the typed values and nowhere else
`exports`	BrandExports	yes	the same values as CSS custom properties, a Tailwind theme extension, Figma variables with modes and a design-tokens (DTCG) file, generated from the typed values and nowhere else

Routes that use it#

/v1/read/brand_design_system returns it
/v1/act/make_brand_design_system returns it