@sorb/core 0.1.0 → 0.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sorb/core",
-  "version": "0.1.0",
-  "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.2.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,205 @@ 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.
+ */
+
+/** 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`.
+ * @param {TargetAdapter} adapter
+ * @returns {TargetAdapter} the registered adapter.
+ */
+export function registerTarget(adapter) {
+  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 {}