bvandeusen
03b3998585
CI & Build / Python lint (push) Successful in 3s
CI & Build / Plugin hooks (push) Successful in 7s
CI & Build / integration (push) Successful in 18s
CI & Build / TypeScript typecheck (push) Successful in 20s
CI & Build / Python tests (push) Successful in 42s
CI & Build / Build & push image (push) Successful in 27s
Milestone #254 step 1 (#2286). A design system becomes a record Scribe holds rather than prose in a rulebook: a named set of tokens with an OPTIONAL parent, so a family system carries the house style and an app system carries only what it changes. Answering "what does this app alter?" is then `list its tokens` — nothing to compute. `parent_id` is the whole model. It replaces both an `always_on` flag (a family system is one with no parent) and a subscription join table (a project points at ONE system; the chain supplies the rest) — less schema than the rulebook shape it mirrors. Two decisions the task left open, settled here: - **Token values are JSONB keyed by mode**, not `value_light`/`value_dark` columns. The deciding argument was not flexibility, it was ambiguity: in a child system an unset mode means "inherit", in a root it means "not mode-dependent", and as columns both are NULL and the resolver cannot tell them apart. As a map, resolution is `{**parent, **child}` at every level with no special case for roots. Against it: queryability — but nothing filters tokens by value in SQL, so that buys a query no caller makes. - **`group_name` is free text, no CHECK enum.** Groupings are each design system's own vocabulary; a whitelist would bake one install's kit into the schema. No CHECK is introduced anywhere, so rule #36 does not fire. The cascade lives in `services/design_cascade.py` as pure functions over a `{id: parent_id}` map, importing nothing — which is what lets both the service and `access.py` use it without a cycle, and lets a test state a whole hierarchy in one literal. Cycles are refused on WRITE by walking up from the proposed parent (the cheap direction), and survived on READ by a visited-set, because a loop from a direct DB edit must truncate rather than hang. ACL (rule #78) is deliberately asymmetric: owning a system grants write, reaching one through a project you can see grants READ ONLY. An editor on a shared project must not be able to rewrite the family system every other project in that family resolves through. Also renames `services/design_system.py` -> `design_rulebook_import.py`. It is the #251 prose extractor, whose role is already scheduled to become a one-shot importer (#2288), and leaving it one character away from the new `design_systems.py` was a trap for every later session. Rule #115 throughout: nothing seeds a system or implies a default. An install with zero design systems is ordinary, not degraded.
30 lines
1.2 KiB
Python
30 lines
1.2 KiB
Python
"""Design-system surface — what the rulebook expects of the stylesheet.
|
|
|
|
The client owns the other half of the comparison: it reads live token values from
|
|
the browser (see `utils/designTokens.ts`), which is the only place they exist
|
|
resolved. This endpoint supplies the claims to check them against.
|
|
"""
|
|
from quart import Blueprint, jsonify
|
|
|
|
from scribe.auth import get_current_user_id, login_required
|
|
from scribe.services import design_rulebook_import as design_svc
|
|
|
|
design_bp = Blueprint("design", __name__, url_prefix="/api/design")
|
|
|
|
|
|
@design_bp.get("/expectations")
|
|
@login_required
|
|
async def get_expectations():
|
|
"""Checkable claims from the rulebook this install designated as its design system.
|
|
|
|
Returns `{"rulebook_id": int|null, "expectations": [...]}`.
|
|
|
|
`rulebook_id: null` is the NORMAL case, not an error — an install that has
|
|
not designated a design rulebook has nothing to compare against, and the
|
|
client shows an explanatory empty state (rule #115). Distinguishing it from
|
|
"designated but empty" is why the id is returned alongside the list.
|
|
"""
|
|
uid = get_current_user_id()
|
|
result = await design_svc.design_expectations(uid)
|
|
return jsonify(result.as_dict())
|