@sorb/core 0.1.1 → 0.3.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sorb/core",
-  "version": "0.1.1",
-  "description": "Shared Sorb contract: JSDoc typedefs for the resolved bindable token map and capture schemas, plus the canonical tier ordering. One home so the contract can't drift across the Sorb polyrepo.",
+  "version": "0.3.0",
+  "description": "Shared contract for Sorb, the design-token bridge for your running app — typedefs + tier ordering so the contract can't drift. (Core.)",
   "license": "MIT",
   "type": "module",
   "keywords": [

package/src/connectors.test.js

@@ -0,0 +1,131 @@
+// Contract test for the connector registry — proves dispatch is REAL (a
+// registered impl round-trips through get*), not just JSDoc types.
+import test from 'node:test'
+import assert from 'node:assert/strict'
+import {
+  connectors,
+  registerSource,
+  registerCodeSource,
+  registerTarget,
+  getSource,
+  getCodeSource,
+  getTarget,
+  resolveConnectorIds,
+  DEFAULT_SOURCE_ID,
+  DEFAULT_CODE_SOURCE_ID,
+  DEFAULT_TARGET_ID,
+} from './index.js'
+
+test('source connector registers and round-trips via getSource', () => {
+  const dummy = {
+    id: 'dummy-source',
+    async listUnits() {
+      return [{ id: 'u1', name: 'Unit 1' }]
+    },
+    async captureGeometry() {
+      return { type: 'FRAME' }
+    },
+    async readTokens() {
+      return { 'color.bg': '#fff' }
+    },
+  }
+  const returned = registerSource(dummy)
+  assert.equal(returned, dummy)
+  assert.equal(getSource('dummy-source'), dummy)
+  assert.equal(connectors.source.get('dummy-source'), dummy)
+})
+
+test('codeSource connector registers and round-trips via getCodeSource', () => {
+  const dummy = {
+    id: 'dummy-code',
+    async resolveAppUrl() {
+      return 'http://localhost:5173'
+    },
+    resolveProjectRoot() {
+      return '/tmp/proj'
+    },
+  }
+  registerCodeSource(dummy)
+  assert.equal(getCodeSource('dummy-code'), dummy)
+})
+
+test('target adapter registers and round-trips via getTarget', () => {
+  const dummy = {
+    id: 'dummy-target',
+    emitFormat: 'SORB_TOKENSET',
+    expectPrefixes: ['bs-'],
+  }
+  registerTarget(dummy)
+  assert.equal(getTarget('dummy-target'), dummy)
+})
+
+test('target adapter darkMode field is optional — undefined ⇒ single-mode', () => {
+  const dummy = {
+    id: 'dummy-target-no-dark',
+    emitFormat: 'SORB_TOKENSET',
+    expectPrefixes: ['bs-'],
+  }
+  registerTarget(dummy)
+  assert.equal(getTarget('dummy-target-no-dark').darkMode, undefined)
+})
+
+test('target adapter round-trips a darkMode convention (attribute strategy)', () => {
+  const dummy = {
+    id: 'dummy-target-dark',
+    emitFormat: 'SORB_TOKENSET',
+    expectPrefixes: ['bs-'],
+    darkMode: {
+      strategy: 'attribute',
+      attribute: 'data-bs-theme',
+      darkSelector: '[data-bs-theme="dark"]',
+      lightSelector: '[data-bs-theme="light"]',
+    },
+  }
+  registerTarget(dummy)
+  const got = getTarget('dummy-target-dark')
+  assert.equal(got.darkMode.strategy, 'attribute')
+  assert.equal(got.darkMode.attribute, 'data-bs-theme')
+  assert.equal(got.darkMode.darkSelector, '[data-bs-theme="dark"]')
+  assert.equal(got.darkMode.lightSelector, '[data-bs-theme="light"]')
+})
+
+test('get* throws a clear error on unknown id', () => {
+  assert.throws(() => getSource('nope'), /Unknown source connector: "nope"/)
+  assert.throws(() => getCodeSource('nope'), /Unknown codeSource connector: "nope"/)
+  assert.throws(() => getTarget('nope'), /Unknown target adapter: "nope"/)
+})
+
+test('resolveConnectorIds returns all three defaults for empty config', () => {
+  assert.deepEqual(resolveConnectorIds({}), {
+    source: DEFAULT_SOURCE_ID,
+    codeSource: DEFAULT_CODE_SOURCE_ID,
+    target: DEFAULT_TARGET_ID,
+  })
+  // Same with no argument at all.
+  assert.deepEqual(resolveConnectorIds(), {
+    source: DEFAULT_SOURCE_ID,
+    codeSource: DEFAULT_CODE_SOURCE_ID,
+    target: DEFAULT_TARGET_ID,
+  })
+})
+
+test('resolveConnectorIds overrides only the provided axis', () => {
+  assert.deepEqual(resolveConnectorIds({ source: 'x' }), {
+    source: 'x',
+    codeSource: DEFAULT_CODE_SOURCE_ID,
+    target: DEFAULT_TARGET_ID,
+  })
+})
+
+test('default ids match the frozen contract', () => {
+  assert.equal(DEFAULT_SOURCE_ID, 'storybook-dom')
+  assert.equal(DEFAULT_CODE_SOURCE_ID, 'local')
+  assert.equal(DEFAULT_TARGET_ID, 'react-bootstrap')
+})
+
+test('connectors container is frozen; its axis Maps are mutable', () => {
+  assert.ok(Object.isFrozen(connectors))
+  assert.ok(connectors.source instanceof Map)
+  assert.ok(connectors.codeSource instanceof Map)
+  assert.ok(connectors.target instanceof Map)
+})

package/src/index.js

@@ -98,4 +98,292 @@ export const TIER_RANK = Object.freeze({ component: 0, semantic: 1, primitive: 2
  * @property {Object.<string, StoryEntry>} stories  storyId → entry.
  */
 
+/**
+ * Identifies a component variant by its dot-path prefix.
+ * e.g. "button.tertiary" covers all tokens whose id starts with "button.tertiary."
+ * @typedef {Object} VariantSpec
+ * @property {string} componentId  Top-level component key, e.g. "button".
+ * @property {string} variantId    Full dot-path of the variant, e.g. "button.tertiary".
+ * @property {string} [fromVariant] Dot-path of the source variant to clone from (addVariant only).
+ * @property {string} [replacedBy]  Dot-path that replaces this variant (deprecateVariant only).
+ */
+
+/**
+ * The result of a lifecycle action — what changed.
+ * @typedef {Object} VariantChangeset
+ * @property {'add'|'deprecate'} action
+ * @property {string} variantId    The variant that was added or deprecated.
+ * @property {string[]} tokenIds   All token ids affected (added or deprecated).
+ * @property {string} newVersion   The component set's new $version after the change.
+ */
+
+// ─── Connector contract (v1: additive) ─────────────────────────────────────────
+//
+// Three pluggable axes — SOURCE (where tokens + geometry come IN), CODE-SOURCE
+// (where the running app / codebase lives), and TARGET (how tokens bind into the
+// app) — plus a runtime registry that dispatches by `id`. Core only defines the
+// contract + registry + default ids; the default implementations are registered
+// by sorb-seed / sorb-juice / sorb-leaf in later phases. See
+// spec/sorb/connectors-architecture.md. `config` everywhere below is the app's
+// `sorb.config.json`-shaped object.
+
+/**
+ * A design unit to capture — one addressable thing a SourceConnector can turn
+ * into geometry (today's Storybook "story entry" is one). Opaque-ish: only `id`
+ * is guaranteed; connectors carry whatever extra metadata they need.
+ * @typedef {Object} DesignUnit
+ * @property {string} id     Stable unit id (e.g. a Storybook story id).
+ * @property {string} [name] Human-readable label.
+ */
+
+/**
+ * SOURCE axis — where design tokens + geometry come IN. A real source pulls BOTH
+ * tokens and geometry from the tool (founder decision 2026-08-28).
+ * @typedef {Object} SourceConnector
+ * @property {string} id  Registry key (default `'storybook-dom'`).
+ * @property {(config: Object) => Promise<DesignUnit[]>} listUnits
+ *   Discover the design units to capture.
+ * @property {(unit: DesignUnit, config: Object) => Promise<LayerNode>} captureGeometry
+ *   Capture one unit as a raw (un-annotated) LayerNode tree.
+ * @property {(config: Object) => Promise<TokenSet>} readTokens
+ *   Read the DTCG token set for this source.
+ */
+
+/**
+ * CODE-SOURCE axis — where the running app / codebase lives.
+ * @typedef {Object} CodeSourceConnector
+ * @property {string} id  Registry key (default `'local'`).
+ * @property {(config: Object) => Promise<string|null>} resolveAppUrl
+ *   Resolve the running app's URL (today = `appUrl` / `localhost:5173`).
+ * @property {(config: Object) => string} resolveProjectRoot
+ *   Resolve the project root dir (today = `process.cwd()`).
+ * @property {(config: Object) => Promise<void>} [provision]
+ *   Optional: clone/build a repo → hosted preview (future code sources).
+ */
+
+/**
+ * TARGET axis — how tokens bind into the running app (the component-compat seam).
+ * @typedef {Object} TargetAdapter
+ * @property {string} id  Registry key (default `'react-bootstrap'`).
+ * @property {string} emitFormat  A Style-Dictionary format id (e.g. `SORB_TOKENSET`).
+ * @property {string[]} expectPrefixes  Vocab-guard namespace(s), e.g. `['bs-']`.
+ * @property {(tokens: TokenSet, config: Object) => void} [inject]
+ *   Optional: bind tokens into non-React hosts (the `sorbInit` seam).
+ * @property {DarkModeConvention} [darkMode]
+ *   Optional: this target's dark-mode convention (real-dark-mode spec D1).
+ *   Undefined ⇒ single-mode (no dark) — the target has no notion of a dark
+ *   variant and mode-aware emit/inject should fall back to flat `:root` output.
+ */
+
+/**
+ * How a TargetAdapter's host framework expresses light/dark mode. v1 only
+ * ships `'attribute'` (Bootstrap 5.3's `[data-bs-theme]`); `'class'`
+ * (Tailwind's `.dark`) and `'media'` (OS-only, no manual override) are named
+ * here for forward-compat but not yet implemented by any shipped adapter —
+ * see real-dark-mode-implementation spec §3 "Deferred to phase 2".
+ * @typedef {Object} DarkModeConvention
+ * @property {'attribute'|'class'|'media'} strategy
+ *   How the manual override is expressed. `'attribute'` sets/reads a DOM
+ *   attribute (e.g. `data-bs-theme`); `'class'` toggles a class on
+ *   `documentElement`; `'media'` means OS-only, no manual override.
+ * @property {string} [attribute]
+ *   The attribute name for `strategy: 'attribute'` (e.g. `'data-bs-theme'`).
+ * @property {string} darkSelector
+ *   The CSS selector matching the dark-mode override (e.g.
+ *   `'[data-bs-theme="dark"]'`).
+ * @property {string} [lightSelector]
+ *   The CSS selector matching an explicit light-mode override (e.g.
+ *   `'[data-bs-theme="light"]'`) — lets a manual "light" choice beat an OS
+ *   `prefers-color-scheme: dark` setting.
+ */
+
+/**
+ * SEMANTIC-ROLE CONTRACT (framework-targets-productization, T0).
+ *
+ * The canonical set of role ids a token kit MUST expose for the framework
+ * TargetAdapter emit formats (`sorb/mantine-vars`, `sorb/mui-vars`,
+ * `sorb/mat-sys-vars`, `sorb/shadcn-theme`, `sorb/primevue-preset`) to emit
+ * correctly. Each format maps its framework's own vars (`--mantine-*`, `--mui-*`,
+ * `--mat-sys-*`, shadcn vars, PrimeVue preset roots) ONTO these role ids.
+ *
+ * These are DTCG dot-path ids (→ CSS var `--<kebab>` → preview-payload key
+ * `<kebab>`). The Janes Jeans kit (`@metatoy/janes-jeans`) is the reference
+ * implementation. A kit using different names supplies `options.roleMap`
+ * (role-id → its-own-token-id) to a format rather than forking it.
+ *
+ * SEMVER: adding a role id here is a MINOR bump; renaming or removing one is a
+ * MAJOR bump for @sorb/core AND @sorb/seed — every format consumer depends on
+ * this set. Scope = the UNION of the target maps' role columns, not a kit's full
+ * token tree; anything beyond this list is kit-private.
+ *
+ * @typedef {Object} SemanticRoles
+ * @property {string[]} color   surface/ink/brand/accent/danger/success/border/focus roles.
+ * @property {string[]} radius  control/card/pill.
+ * @property {string[]} shadow  raised/overlay.
+ * @property {string[]} typography  display/heading/body/caption × fontSize/Weight/lineHeight.
+ */
+
+/**
+ * The canonical role-id list (T0 reference = the JJ kit's semantic tier).
+ * @type {Readonly<{color: string[], radius: string[], shadow: string[], typography: string[]}>}
+ */
+export const DEFAULT_ROLE_IDS = Object.freeze({
+  color: Object.freeze([
+    'color.surface', 'color.surface-raised', 'color.surface-sunken',
+    'color.ink', 'color.ink-muted', 'color.ink-on-brand',
+    'color.brand', 'color.brand-hover', 'color.brand-contrast',
+    'color.accent', 'color.accent-hover', 'color.accent-contrast',
+    'color.danger', 'color.danger-hover', 'color.success', 'color.success-hover',
+    'color.focus-ring', 'color.border', 'color.border-subtle', 'color.border-strong',
+  ]),
+  radius: Object.freeze(['radius.control', 'radius.card', 'radius.pill']),
+  shadow: Object.freeze(['shadow.raised', 'shadow.overlay']),
+  typography: Object.freeze([
+    'typography.display.fontSize', 'typography.display.fontWeight', 'typography.display.lineHeight',
+    'typography.heading.fontSize', 'typography.heading.fontWeight', 'typography.heading.lineHeight',
+    'typography.body.fontSize', 'typography.body.fontWeight', 'typography.body.lineHeight',
+    'typography.caption.fontSize', 'typography.caption.fontWeight', 'typography.caption.lineHeight',
+  ]),
+})
+
+/**
+ * Flat list of every canonical role id (all tiers), for iteration/validation.
+ * @type {readonly string[]}
+ */
+export const ALL_ROLE_IDS = Object.freeze([
+  ...DEFAULT_ROLE_IDS.color, ...DEFAULT_ROLE_IDS.radius,
+  ...DEFAULT_ROLE_IDS.shadow, ...DEFAULT_ROLE_IDS.typography,
+])
+
+/**
+ * Resolve a role id to the kit's actual token id via an optional override map.
+ * A format calls `resolveRole('color.brand', options.roleMap)` → the kit's token
+ * id (identity when the kit uses canonical ids, i.e. the JJ reference).
+ * @param {string} roleId  A canonical role id from {@link ALL_ROLE_IDS}.
+ * @param {Record<string,string>} [roleMap]  role-id → kit-token-id overrides.
+ * @returns {string} the kit token id to reference (`var(--<kebab>)`).
+ */
+export function resolveRole(roleId, roleMap) {
+  return (roleMap && roleMap[roleId]) || roleId
+}
+
+/** Default SOURCE connector id (registered by sorb-seed). @type {string} */
+export const DEFAULT_SOURCE_ID = 'storybook-dom'
+
+/** Default CODE-SOURCE connector id (registered by sorb-juice). @type {string} */
+export const DEFAULT_CODE_SOURCE_ID = 'local'
+
+/** Default TARGET adapter id (registered by sorb-leaf). @type {string} */
+export const DEFAULT_TARGET_ID = 'react-bootstrap'
+
+/**
+ * The runtime connector registry — id → impl per axis. The Maps are mutable by
+ * design so consumer packages register their defaults into them; the container
+ * itself is frozen so the axis set can't drift.
+ * @typedef {Object} ConnectorRegistry
+ * @property {Map<string, SourceConnector>} source
+ * @property {Map<string, CodeSourceConnector>} codeSource
+ * @property {Map<string, TargetAdapter>} target
+ * @type {ConnectorRegistry}
+ */
+export const connectors = Object.freeze({
+  source: new Map(),
+  codeSource: new Map(),
+  target: new Map(),
+})
+
+/**
+ * Register a SOURCE connector by its `id`.
+ * @param {SourceConnector} conn
+ * @returns {SourceConnector} the registered connector.
+ */
+export function registerSource(conn) {
+  connectors.source.set(conn.id, conn)
+  return conn
+}
+
+/**
+ * Register a CODE-SOURCE connector by its `id`.
+ * @param {CodeSourceConnector} conn
+ * @returns {CodeSourceConnector} the registered connector.
+ */
+export function registerCodeSource(conn) {
+  connectors.codeSource.set(conn.id, conn)
+  return conn
+}
+
+/**
+ * Register a TARGET adapter by its `id`. Minimal shape validation (T0b) — with
+ * seven+ adapters registering into one Map, a typo'd `id` or missing
+ * `emitFormat` would fail silently at query time; catch it at register time.
+ * Throws on a malformed adapter; `console.warn`s (does not throw) on a
+ * duplicate-id overwrite so a legitimate re-register in tests/HMR still works.
+ * @param {TargetAdapter} adapter
+ * @returns {TargetAdapter} the registered adapter.
+ */
+export function registerTarget(adapter) {
+  if (!adapter || typeof adapter.id !== 'string' || !adapter.id) {
+    throw new Error('registerTarget: adapter.id must be a non-empty string')
+  }
+  if (typeof adapter.emitFormat !== 'string' || !adapter.emitFormat) {
+    throw new Error(`registerTarget(${JSON.stringify(adapter.id)}): emitFormat must be a non-empty string`)
+  }
+  if (!Array.isArray(adapter.expectPrefixes)) {
+    throw new Error(`registerTarget(${JSON.stringify(adapter.id)}): expectPrefixes must be an array`)
+  }
+  if (connectors.target.has(adapter.id)) {
+    // eslint-disable-next-line no-console
+    console.warn(`registerTarget: overwriting existing target adapter ${JSON.stringify(adapter.id)}`)
+  }
+  connectors.target.set(adapter.id, adapter)
+  return adapter
+}
+
+/**
+ * Look up a registered SOURCE connector; throws on unknown id.
+ * @param {string} id
+ * @returns {SourceConnector}
+ */
+export function getSource(id) {
+  const conn = connectors.source.get(id)
+  if (!conn) throw new Error(`Unknown source connector: ${JSON.stringify(id)}`)
+  return conn
+}
+
+/**
+ * Look up a registered CODE-SOURCE connector; throws on unknown id.
+ * @param {string} id
+ * @returns {CodeSourceConnector}
+ */
+export function getCodeSource(id) {
+  const conn = connectors.codeSource.get(id)
+  if (!conn) throw new Error(`Unknown codeSource connector: ${JSON.stringify(id)}`)
+  return conn
+}
+
+/**
+ * Look up a registered TARGET adapter; throws on unknown id.
+ * @param {string} id
+ * @returns {TargetAdapter}
+ */
+export function getTarget(id) {
+  const adapter = connectors.target.get(id)
+  if (!adapter) throw new Error(`Unknown target adapter: ${JSON.stringify(id)}`)
+  return adapter
+}
+
+/**
+ * Resolve the three connector ids from a config, falling back to the defaults
+ * when a key is absent (back-compat = today's behavior).
+ * @param {{ source?: string, codeSource?: string, target?: string }} [config]
+ * @returns {{ source: string, codeSource: string, target: string }}
+ */
+export function resolveConnectorIds(config = {}) {
+  return {
+    source: config.source || DEFAULT_SOURCE_ID,
+    codeSource: config.codeSource || DEFAULT_CODE_SOURCE_ID,
+    target: config.target || DEFAULT_TARGET_ID,
+  }
+}
+
 export {}