Static ReadonlyAA_Static ReadonlyDEFAULTSStatic ReadonlyLAYOUTSStatic ReadonlyPATHSStaticauditedThe audit row of a logo's upload or removal.
what happened
Optionalactor: string
who did it
StaticchannelsA #rrggbb colour's channels, 0–255.
the colour
[r, g, b], or null when it is not one
StaticcontrastThe contrast ratio of two colours.
#rrggbb
#rrggbb
1 to 21
StaticcontrastWhat is wrong with a set of colours under AA (D3), each a sentence; none when it passes.
accent, card and text
the problems
StaticdescribeThe ambient realm's appearance as the console and GET /admin-api/branding show it: the settings, the derived tones, the
contrast results and the logo.
the description
StaticdescribeA stored logo as an answer shows it: never the bytes.
the stored record
its type, sides, size, digest, address and when it was set
StaticheaderThe brand header's markup: the logo (a link where one is set) and the
name, each escaped; empty where there is neither. The runtime draws the
same markup from the shell's attributes (web_surface.ts).
name, logo (an address), alt and link
the markup
StatichttpsWhether a text is an absolute https URL.
the text
true when it is
StaticjpegA JPEG's width and height, from its first start-of-frame segment.
the bytes, starting with the SOI marker
[width, height], [0, 0] where none was found
StaticlogoThe ambient realm's stored logo, or null.
the record
StaticluminanceA colour's relative luminance.
#rrggbb
0 (black) to 1 (white)
StaticmixTwo colours mixed: t of the way from a to b.
#rrggbb
#rrggbb
0 (all a) to 1 (all b)
#rrggbb
StaticpaletteEvery colour a page reads, the four set and the ten derived.
accent, page, card and text
the fourteen, by custom property name without its --sts- prefix
StaticpreviewThe preview page's markup.
the checked pending values
the document
StaticpreviewChecks a preview's values as the settings would, without writing them.
accent, page, card, text and layout, each
optional
{ ok, errors, pending }
StaticquieterThe text colour mixed toward the card as far as t goes while it keeps
AA contrast against the card — a quieter tone that is still readable.
the text colour
the card colour
how far toward the card it would like to go
#rrggbb
StaticreadableOf several colours, the first with AA contrast against a background, or the one with the most where none has it.
#rrggbb colours, preferred first
the background
the chosen colour
StaticregisterRegisters GET /web/theme.css, GET /web/branding/logo and GET /web/branding/preview; common/protocol_stack.ts calls it.
the shared express app
StaticremoveRemoves the ambient realm's logo. Its alternative text stays, so a logo uploaded again needs none sent.
Optionalactor: string
who removed it, for the audit row
{ ok, removed }
StaticsaveSets several appearance settings at once, judged together so that a
pair of colours that is legal only together is (withWriteBatch()).
Only branding.* keys are taken.
raw values by setting key
{ ok, errors }; nothing is written when any is refused
StaticsetChecks and stores the ambient realm's logo, and its alternative text when one is given.
the image
Optionaloptions: any
alt (written to branding.logoAlt when given) and
actor, for the audit row
{ ok, errors, status, logo }, a refusal marked with its code
StaticsettingA setting's value in the ambient realm, or fallback where it cannot be
read (a process loading this file before the rows exist).
the setting
what to answer instead
the value
StaticshellThe <html> attributes a shell carries for the ambient realm's
appearance, and the stylesheet it links after the card's: nothing at all
for a realm that has set nothing, so its shell is the one it always was.
{ attributes, stylesheet }
StaticsniffWhat an image's bytes are and how large it draws: PNG, JPEG or WebP, read from the bytes alone, whatever was declared.
the image
{ type, width, height }; type empty when it is none of the
three, the sides 0 when they could not be read
StaticthemeThe ambient realm's appearance, or the one given by pending (a
preview's values, already checked) over it.
Optionalpending: Record<string, string>
colours and a layout to use in place of the realm's
the theme
StaticwriteRefuses a colour that would leave the text or the accent below AA against the card (STS-AUTHN-0544), a logo's alternative text emptied while a logo is held (STS-AUTHN-0548), and a logo link that is not an absolute https URL (STS-AUTHN-0551).
the setting being written
its parsed value
OptionalinRealm: boolean
unused; the rules hold in a realm as in the process
Optionalbeside: (key: string) => unknown
another setting's value as this write leaves it
{ problem, code }, or null
StaticwriteWrites one setting in the ambient realm: the process's override in the default realm, the realm's own elsewhere — the choice every console page that writes a setting makes.
the setting
its value as text
{ ok, errors }, a refusal marked with its code
A realm's sign-in appearance. A static utility class; its one store is declared above.