chrome/README.md
Michał Kopeć f6c8fe3d36 chrome: the shared shell, extracted from four copies
One page frame, one palette, one set of components, one implementation of
config readers, proxy auth, /healthz, i18n and cache-busted asset URLs.

The design tokens had been copied into homepage, marketplace, agent-bridge
and scribe and had started to drift; so had theme.js and the asset() helper,
which existed in two incompatible versions. board.css carried the instruction
"Copy the values from homepage's style.css when they change there", which is
the problem stated as a procedure.

Components come from Web Awesome 3.14.0 (MIT), vendored under static/wa by
vendor-webawesome.sh - curl and tar against the npm registry, so there is no
node_modules, no lockfile and nothing for CI or a Containerfile to run. The
script prunes type definitions and IDE metadata, 13M down to 3.4M, and keeps
only the en and pl translations. Components style themselves inside a shadow
root, so a page rule cannot reach into one: "this input is the wrong width"
stops being a thing that can happen rather than a thing to be careful about.

Two decisions worth recording here:

- Asset versioning is a content digest over the whole static tree, not each
  file's mtime. mtime is wrong in a container, where every COPY'd file
  carries the build timestamp, so every asset appeared to change on every
  build. A single tree-wide token also means a cached page can never pair
  itself with a newer script.
- Pages keep the data-theme="light|dark|system" attribute the services have
  always used. Web Awesome drives light/dark from a wa-light/wa-dark class
  instead; base.html and theme.js own that mapping so nothing else learns it.

The compatibility aliases in tokens.css (--bg, --surface, --accent, ...) are
deliberate: they let a service move page by page instead of all at once.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-10-04 12:34:13 +02:00

3.1 KiB

chrome

The shared shell for the internal services: one page frame, one palette, one set of components, one implementation of the handful of things every service needs (config readers, proxy auth, /healthz, i18n, cache-busted assets).

It exists because the same stylesheet had been copied into four repositories and had started to drift — along with theme.js, the asset() helper and the error pages. A token change should be one commit here and a version bump there, not four hand-edits with one forgotten.

What's in it

Module Replaces
chrome.app.Chrome per-service app factory boilerplate, error pages, static mounts
chrome.config three near-identical _bool/_int/_list env readers
chrome.auth agent-bridge's Remote-User + proxy-key check
chrome.health four copies of /healthz
chrome.i18n homepage's pl/en machinery, which nothing else could reuse
chrome.assets two different cache-busting strategies, one of them broken in containers
templates/base.html four page shells
static/tokens.css four copies of the design tokens

UI components

Web Awesome (MIT, Fonticons) is vendored under chrome/static/wa/. The autoloader registers each <wa-*> element the first time it appears, so there is no per-component import list.

Components are styled inside a shadow root, which means a page rule cannot reach into one. That is the point: "this input is the wrong width" stops being a thing that can happen. Customise through --wa-* tokens and ::part().

Note that Combobox, Date Picker, File Input and the chart components are Web Awesome Pro, and are not vendored here. Use a native control or a different component.

Upgrading Web Awesome

./vendor-webawesome.sh 3.15.0   # then commit the diff

Plain curl and tar against the npm registry — no npm install, no node_modules, no lockfile, nothing for CI or a Containerfile to run. The script prunes type definitions and IDE metadata (~13M down to ~3.4M) and keeps only the en and pl translations.

Using it

from fastapi import FastAPI
from chrome.app import Chrome

app = FastAPI()
ui = Chrome(
    app,
    service="marketplace",
    version="0.2.0",
    title="Skills Marketplace",
    templates_dir=HERE / "templates",
    static_dir=HERE / "static",
    locales_dir=HERE / "locales",
)

@app.get("/")
def index(request: Request):
    return ui.render(request, "index.html", things=[...])

Templates {% extends "base.html" %} and fill content. Service templates and chrome's are both on the loader path, service first.

Depending on it

Pin a tag, not a branch:

dependencies = [
  "chrome @ git+https://git.wierzbowa.cloud/michal/chrome@v0.1.0",
]

For the edit loop, install it editable alongside the service: pip install -e ../chrome.

Theme convention

Pages use data-theme="light|dark|system" on <html>, which is what the services have always used. Web Awesome drives light/dark from a wa-light / wa-dark class instead; base.html and theme.js own that mapping, so no service or stylesheet needs to know about it.