Components

Brand Requirements Schema

Machine-validatable JSON Schema for the brand token contract. Install with npx shadcn@latest add @vandoko/brand-requirements.

Brand Requirements Schema

A draft-07 JSON Schema describing the brand token contract — the exact set of CSS custom properties every {namespace}-brand-system instance must define, plus the profile envelope (namespace, contractVersion, tokens). It is the machine-readable counterpart of @vandoko/vandoko-brand-system.

Generated artifact — do not edit by hand. The canonical source is lib/brand-contract-tokens.json; pnpm brand:lint -- --write regenerates this schema and pnpm brand:lint fails on drift.

Installation

npx shadcn@latest add @vandoko/brand-requirements

Installs brand-requirements.schema.json at your project root.

Consumers

  • Registry lintpnpm brand:lint (its own gate, separate from registry:build) validates every brand-system CSS instance against the contract (exact token match).
  • Portal onboarding — tenant brand profiles are validated against this schema at import/export (contractVersion is pinned, currently 2026.06.04).
  • Agents/tooling — a constrained schema for client brand intake.

Profile shape

{
  "namespace": "acme",
  "contractVersion": "2026.06.04",
  "tokens": {
    "--brand-cyan": "oklch(0.7 0.12 230)",
    "--background": "oklch(0.13 0 0)",
    "…": "all 67 contract tokens, no extras"
  }
}

additionalProperties: false at both levels — a profile with a missing or off-contract token is rejected.

On this page