@adobe/design-system-registry 3.3.0 → 5.0.1

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @adobe/design-system-registry
 
+## 5.0.1
+
+### Patch Changes
+
+- Updated dependencies [[`60a4835`](https://github.com/adobe/spectrum-design-data/commit/60a4835e245965639a4ac89b41d2884dd63a0bbb)]:
+  - @adobe/spectrum-design-data@0.3.0
+
+## 5.0.0
+
+### Major Changes
+
+- [#1113](https://github.com/adobe/spectrum-design-data/pull/1113) [`e23264e`](https://github.com/adobe/spectrum-design-data/commit/e23264e681c56077b5582bf019123b941862779a) Thanks [@GarthDB](https://github.com/GarthDB)! - Move Spectrum registry vocabulary into spectrum-design-data; deprecate design-system-registry.
+  - **@adobe/spectrum-design-data**: gains `registry/` (27 vocabulary files) with
+    subpath exports (`./registry/*.json`); now the single source of truth for all Spectrum data.
+  - **@adobe/design-system-registry**: reduced to a compatibility shim. Migrate imports to
+    `@adobe/spectrum-design-data` — this shim will be removed in a future major version.
+  - **@adobe/design-data-spec**: gains `registry-value.json` and `platform-extension.json`
+    schema exports; `manifest.schema.json` `conceptOrder` enum relaxed to open `string` type
+    (no longer hardcodes Spectrum's field names — configurable per field catalog).
+
+### Patch Changes
+
+- Updated dependencies [[`073c22a`](https://github.com/adobe/spectrum-design-data/commit/073c22a75c27fbb44eb57eb6cb7311e294066d76), [`e23264e`](https://github.com/adobe/spectrum-design-data/commit/e23264e681c56077b5582bf019123b941862779a), [`e23264e`](https://github.com/adobe/spectrum-design-data/commit/e23264e681c56077b5582bf019123b941862779a), [`e23264e`](https://github.com/adobe/spectrum-design-data/commit/e23264e681c56077b5582bf019123b941862779a)]:
+  - @adobe/spectrum-design-data@0.2.0
+
 ## 3.3.0
 
 ### Minor Changes

package/index.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2025 Adobe. All rights reserved.
+Copyright 2026 Adobe. All rights reserved.
 This file is licensed to you 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
@@ -10,170 +10,83 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
+/**
+ * @deprecated This package is deprecated. The registry data and API have moved to
+ * @adobe/spectrum-design-data. Update your imports:
+ *
+ *   import { sizes, getValues } from "@adobe/spectrum-design-data";
+ *   import sizesJson from "@adobe/spectrum-design-data/registry/sizes.json" with { type: "json" };
+ *
+ * This shim will be removed in a future major version.
+ */
+
 import { readFileSync, readdirSync } from "node:fs";
-import { fileURLToPath } from "node:url";
+import { fileURLToPath, resolve as resolveUrl } from "node:url";
 import { dirname, join } from "node:path";
+import { createRequire } from "node:module";
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-// Load registry files
-export const sizes = JSON.parse(
-  readFileSync(join(__dirname, "registry", "sizes.json"), "utf-8"),
-);
-
-export const states = JSON.parse(
-  readFileSync(join(__dirname, "registry", "states.json"), "utf-8"),
-);
-
-export const variants = JSON.parse(
-  readFileSync(join(__dirname, "registry", "variants.json"), "utf-8"),
-);
-
-export const anatomyTerms = JSON.parse(
-  readFileSync(join(__dirname, "registry", "anatomy-terms.json"), "utf-8"),
-);
-
-export const propertyTerms = JSON.parse(
-  readFileSync(join(__dirname, "registry", "property-terms.json"), "utf-8"),
-);
-
-export const components = JSON.parse(
-  readFileSync(join(__dirname, "registry", "components.json"), "utf-8"),
-);
-
-export const scaleValues = JSON.parse(
-  readFileSync(join(__dirname, "registry", "scale-values.json"), "utf-8"),
-);
-
-export const categories = JSON.parse(
-  readFileSync(join(__dirname, "registry", "categories.json"), "utf-8"),
-);
-
-export const platforms = JSON.parse(
-  readFileSync(join(__dirname, "registry", "platforms.json"), "utf-8"),
-);
-
-export const navigationTerms = JSON.parse(
-  readFileSync(join(__dirname, "registry", "navigation-terms.json"), "utf-8"),
-);
-
-export const tokenTerminology = JSON.parse(
-  readFileSync(join(__dirname, "registry", "token-terminology.json"), "utf-8"),
-);
-
-export const glossary = JSON.parse(
-  readFileSync(join(__dirname, "registry", "glossary.json"), "utf-8"),
-);
-
-export const tokenObjects = JSON.parse(
-  readFileSync(join(__dirname, "registry", "token-objects.json"), "utf-8"),
-);
-
-export const structures = JSON.parse(
-  readFileSync(join(__dirname, "registry", "structures.json"), "utf-8"),
-);
-
-export const substructures = JSON.parse(
-  readFileSync(join(__dirname, "registry", "substructures.json"), "utf-8"),
-);
-
-export const orientations = JSON.parse(
-  readFileSync(join(__dirname, "registry", "orientations.json"), "utf-8"),
-);
-
-export const positions = JSON.parse(
-  readFileSync(join(__dirname, "registry", "positions.json"), "utf-8"),
-);
+const require = createRequire(import.meta.url);
+const registryPkg = require.resolve("@adobe/spectrum-design-data/package.json");
+const registryDir = join(dirname(registryPkg), "registry");
 
-export const densities = JSON.parse(
-  readFileSync(join(__dirname, "registry", "densities.json"), "utf-8"),
-);
+function load(name) {
+  return JSON.parse(readFileSync(join(registryDir, name), "utf-8"));
+}
 
-export const shapes = JSON.parse(
-  readFileSync(join(__dirname, "registry", "shapes.json"), "utf-8"),
-);
+export const sizes = load("sizes.json");
+export const states = load("states.json");
+export const variants = load("variants.json");
+export const anatomyTerms = load("anatomy-terms.json");
+export const propertyTerms = load("property-terms.json");
+export const components = load("components.json");
+export const scaleValues = load("scale-values.json");
+export const categories = load("categories.json");
+export const platforms = load("platforms.json");
+export const navigationTerms = load("navigation-terms.json");
+export const tokenTerminology = load("token-terminology.json");
+export const glossary = load("glossary.json");
+export const tokenObjects = load("token-objects.json");
+export const structures = load("structures.json");
+export const substructures = load("substructures.json");
+export const orientations = load("orientations.json");
+export const positions = load("positions.json");
+export const densities = load("densities.json");
+export const shapes = load("shapes.json");
 
-/**
- * Get all values from a registry by ID
- * @param {object} registry - The registry object
- * @returns {string[]} Array of value IDs
- */
 export function getValues(registry) {
   return registry.values.map((v) => v.id);
 }
 
-/**
- * Find a registry value by ID or alias
- * @param {object} registry - The registry object
- * @param {string} searchTerm - The ID or alias to search for
- * @returns {object|undefined} The matching value or undefined
- */
 export function findValue(registry, searchTerm) {
   return registry.values.find(
     (v) => v.id === searchTerm || v.aliases?.includes(searchTerm),
   );
 }
 
-/**
- * Check if a value exists in a registry
- * @param {object} registry - The registry object
- * @param {string} searchTerm - The ID or alias to search for
- * @returns {boolean} True if the value exists
- */
 export function hasValue(registry, searchTerm) {
   return findValue(registry, searchTerm) !== undefined;
 }
 
-/**
- * Get the default value from a registry
- * @param {object} registry - The registry object
- * @returns {object|undefined} The default value or undefined
- */
 export function getDefault(registry) {
   return registry.values.find((v) => v.default === true);
 }
 
-/**
- * Get all non-deprecated values from a registry
- * @param {object} registry - The registry object
- * @returns {array} Array of non-deprecated values
- */
 export function getActiveValues(registry) {
   return registry.values.filter((v) => !v.deprecated);
 }
 
-/**
- * Load a platform extension file
- * @param {string} extensionPath - Path to the extension JSON file
- * @returns {object} The extension object
- */
 export function loadPlatformExtension(extensionPath) {
   return JSON.parse(readFileSync(extensionPath, "utf-8"));
 }
 
-/**
- * Get platform-specific term for a registry value
- * @param {object} registry - The base registry object
- * @param {string} termId - The term ID to look up
- * @param {string} platform - The platform name
- * @param {object} extension - Optional: The platform extension object
- * @returns {object|undefined} Platform-specific term info or undefined
- */
 export function getTermForPlatform(registry, termId, platform, extension) {
-  // First, find the base term
   const baseTerm = findValue(registry, termId);
   if (!baseTerm) return undefined;
 
-  // Check if the term has platform-specific info in its platforms property
   if (baseTerm.platforms && baseTerm.platforms[platform]) {
-    return {
-      ...baseTerm,
-      platform: baseTerm.platforms[platform],
-    };
+    return { ...baseTerm, platform: baseTerm.platforms[platform] };
   }
 
-  // If extension is provided, check for platform-specific overrides
   if (extension && extension.platform === platform) {
     const ext = extension.extensions.find((e) => e.termId === termId);
     if (ext) {
@@ -191,30 +104,17 @@ export function getTermForPlatform(registry, termId, platform, extension) {
     }
   }
 
-  // Return base term if no platform-specific info found
   return baseTerm;
 }
 
-/**
- * Get all extensions for a specific platform
- * @param {array} extensions - Array of extension objects
- * @param {string} platform - The platform name
- * @returns {array} Array of extensions for the platform
- */
 export function getPlatformExtensions(extensions, platform) {
   return extensions.filter((ext) => ext.platform === platform);
 }
 
-/**
- * Load all platform extensions from a directory
- * @param {string} extensionsDir - Path to the extensions directory
- * @returns {array} Array of loaded extension objects
- */
 export function loadAllPlatformExtensions(extensionsDir) {
   const extensionFiles = readdirSync(extensionsDir).filter((f) =>
     f.endsWith(".json"),
   );
-
   return extensionFiles.map((file) =>
     loadPlatformExtension(join(extensionsDir, file)),
   );

package/moon.yml

@@ -1,4 +1,4 @@
-# Copyright 2025 Adobe. All rights reserved.
+# Copyright 2026 Adobe. All rights reserved.
 # This file is licensed to you 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
@@ -8,33 +8,6 @@
 # OF ANY KIND, either express or implied. See the License for the specific language
 # governing permissions and limitations under the License.
 
+# Deprecated shim — no tasks. Registry data, tests, and validation have moved to design-data.
 $schema: "https://moonrepo.dev/schemas/project.json"
 layer: library
-fileGroups:
-  registry:
-    - "registry/**/*.json"
-  schemas:
-    - "schemas/**/*.json"
-  tests:
-    - "test/**/*"
-tasks:
-  test:
-    command:
-      - pnpm
-      - ava
-    inputs:
-      - "@globs(registry)"
-      - "@globs(schemas)"
-      - "@globs(tests)"
-      - "index.js"
-      - "ava.config.js"
-    platform: node
-  validate:
-    command:
-      - node
-      - scripts/validate-registry.js
-    inputs:
-      - "@globs(registry)"
-      - "@globs(schemas)"
-      - "scripts/validate-registry.js"
-    platform: node

package/package.json

@@ -1,33 +1,11 @@
 {
   "name": "@adobe/design-system-registry",
-  "version": "3.3.0",
-  "description": "A single source of truth for design system terminology used across Spectrum tokens, component schemas, and anatomy",
+  "version": "5.0.1",
+  "description": "DEPRECATED — registry data and API have moved to @adobe/spectrum-design-data. This package is a thin compatibility shim.",
   "type": "module",
   "main": "index.js",
   "exports": {
-    ".": "./index.js",
-    "./registry/sizes.json": "./registry/sizes.json",
-    "./registry/states.json": "./registry/states.json",
-    "./registry/variants.json": "./registry/variants.json",
-    "./registry/anatomy-terms.json": "./registry/anatomy-terms.json",
-    "./registry/components.json": "./registry/components.json",
-    "./registry/scale-values.json": "./registry/scale-values.json",
-    "./registry/categories.json": "./registry/categories.json",
-    "./registry/platforms.json": "./registry/platforms.json",
-    "./registry/token-objects.json": "./registry/token-objects.json",
-    "./registry/structures.json": "./registry/structures.json",
-    "./registry/substructures.json": "./registry/substructures.json",
-    "./registry/orientations.json": "./registry/orientations.json",
-    "./registry/positions.json": "./registry/positions.json",
-    "./registry/densities.json": "./registry/densities.json",
-    "./registry/shapes.json": "./registry/shapes.json",
-    "./registry/color-families.json": "./registry/color-families.json",
-    "./registry/alignments.json": "./registry/alignments.json",
-    "./registry/typography-families.json": "./registry/typography-families.json",
-    "./registry/typography-weights.json": "./registry/typography-weights.json",
-    "./registry/typography-styles.json": "./registry/typography-styles.json",
-    "./registry/motion-roles.json": "./registry/motion-roles.json",
-    "./registry/easing-curves.json": "./registry/easing-curves.json"
+    ".": "./index.js"
   },
   "repository": {
     "type": "git",
@@ -47,14 +25,7 @@
     "node": ">=20.12.0",
     "pnpm": ">=10.17.1"
   },
-  "devDependencies": {
-    "ajv": "^8.17.1",
-    "ajv-formats": "^3.0.1",
-    "ava": "^6.0.1",
-    "@adobe/spectrum-component-api-schemas": "6.1.17"
-  },
-  "scripts": {
-    "validate": "node scripts/validate-registry.js",
-    "test": "ava"
+  "dependencies": {
+    "@adobe/spectrum-design-data": "0.3.0"
   }
 }

package/AUTHORING.md

@@ -1,290 +0,0 @@
-# Authoring Guide: Spectrum Design System Glossary
-
-This guide explains how to author and maintain glossary terms in the Spectrum Design System Registry.
-
-## Overview
-
-The Design System Registry serves as the single source of truth for Spectrum design terminology. Each term includes:
-
-* **Basic Information**: ID, label, description
-* **Definition**: Structured definition following Spectrum's naming methodology
-* **Platform Variations**: How the term differs across platforms (web, iOS, Android, etc.)
-* **Terminology Metadata**: Classification and naming rationale
-* **Sources**: References to documentation and standards
-* **Governance**: Ownership and review information
-* **Related Terms**: Cross-references to related concepts
-
-## File Structure
-
-Registry files are located in `registry/` and organized by type:
-
-* `sizes.json` - Size scale values (xs, s, m, l, xl, etc.)
-* `states.json` - Interaction states (default, hover, focus, etc.)
-* `variants.json` - Color and style variants (accent, negative, primary, etc.)
-* `anatomy-terms.json` - Component anatomy parts (edge, visual, text, icon, etc.)
-* `components.json` - Spectrum component names
-* `scale-values.json` - Numeric scale values (50, 75, 100, 200, etc.)
-* `categories.json` - Component categories
-* `platforms.json` - Platform names (desktop, mobile, web, iOS, Android)
-
-## Writing Definitions
-
-Follow the [Spectrum Naming and Definition Writing Guide](https://wiki.corp.adobe.com/display/AdobeDesign/Spectrum+Design+System%3A+Naming+and+definition+writing+guide) methodology:
-
-### 1. Superordinate
-
-The higher-level category or class this term belongs to. This provides context for the reader.
-
-**Examples**:
-
-* "interaction state" for states like hover or focus
-* "size value" for size scales
-* "user interface component" for components
-* "design token" for token-related terms
-
-### 2. Description
-
-A clear, concise explanation of what the term is and how it differs from related concepts.
-
-**Good example**:
-
-> "The state when a component receives focus through keyboard navigation, indicating it will respond to keyboard input"
-
-**Bad example**:
-
-> "When you tab to something"
-
-### 3. Essential Characteristics
-
-Key features that distinguish this term from similar concepts. Use bullet points for clarity.
-
-**Example for "keyboard-focus"**:
-
-* Specifically indicates focus achieved through keyboard interaction (Tab, arrow keys)
-* Requires prominent visual indicator for accessibility (WCAG 2.4.7)
-* Different from generic focus to support :focus-visible patterns
-* Critical for keyboard-only users to understand their current position
-
-## JSON Structure
-
-### Basic Entry (Minimum Required)
-
-```json
-{
-  "id": "unique-identifier",
-  "label": "Human Readable Label",
-  "description": "Brief description of the term",
-  "usedIn": ["tokens", "component-schemas"]
-}
-```
-
-### Enhanced Entry (Full Glossary)
-
-```json
-{
-  "id": "keyboard-focus",
-  "label": "Keyboard Focus",
-  "aliases": ["keyboard focus"],
-  "description": "Focused via keyboard navigation",
-  "usedIn": ["tokens", "component-options", "component-schemas"],
-  
-  "definition": {
-    "superordinate": "interaction state",
-    "description": "The state when a component receives focus through keyboard navigation",
-    "essentialCharacteristics": [
-      "Specifically indicates focus achieved through keyboard interaction",
-      "Requires prominent visual indicator for accessibility",
-      "Different from generic focus to support :focus-visible patterns"
-    ]
-  },
-  
-  "platforms": {
-    "web": {
-      "term": "keyboard-focus",
-      "notes": "Often implemented with :focus-visible pseudo-class",
-      "reference": "https://developer.mozilla.org/en-US/docs/Web/CSS/:focus-visible"
-    },
-    "iOS": {
-      "term": "focused",
-      "notes": "UIFocusSystem for keyboard and pointer navigation",
-      "reference": "UIFocusSystem"
-    }
-  },
-  
-  "terminology": {
-    "conceptType": "term",
-    "namingRationale": "Distinguishes keyboard-based focus from programmatic focus",
-    "alternatives": ["tab-focus", "keyboard-navigated"]
-  },
-  
-  "sources": [
-    {
-      "type": "industry-standard",
-      "reference": "WCAG 2.4.7 Focus Visible",
-      "url": "https://www.w3.org/WAI/WCAG21/Understanding/focus-visible.html",
-      "date": "2025-01-12"
-    }
-  ],
-  
-  "governance": {
-    "owner": "Spectrum Core Team",
-    "reviewDate": "2025-01-12",
-    "status": "approved"
-  },
-  
-  "relatedTerms": ["focus", "default", "hover"]
-}
-```
-
-## Field Reference
-
-### Required Fields
-
-| Field   | Type   | Description                    |
-| ------- | ------ | ------------------------------ |
-| `id`    | string | Unique identifier (kebab-case) |
-| `label` | string | Human-readable label           |
-
-### Optional Fields
-
-| Field              | Type                  | Description                                                |
-| ------------------ | --------------------- | ---------------------------------------------------------- |
-| `aliases`          | array                 | Alternative names or spellings                             |
-| `description`      | string                | Brief description                                          |
-| `default`          | boolean               | Whether this is the default value                          |
-| `deprecated`       | boolean               | Whether this value is deprecated                           |
-| `usedIn`           | array                 | Where this value is used (tokens, component-schemas, etc.) |
-| `category`         | string                | Category or grouping                                       |
-| `value`            | string/number/boolean | Actual value (if different from id)                        |
-| `documentationUrl` | string                | URL to documentation                                       |
-
-### Enhanced Fields (Glossary)
-
-| Field          | Type   | Description                                                                  |
-| -------------- | ------ | ---------------------------------------------------------------------------- |
-| `definition`   | object | Structured definition (superordinate, description, essentialCharacteristics) |
-| `platforms`    | object | Platform-specific terminology and notes                                      |
-| `terminology`  | object | Classification and naming rationale                                          |
-| `sources`      | array  | References to source documentation                                           |
-| `governance`   | object | Ownership and review metadata                                                |
-| `relatedTerms` | array  | IDs of related terms                                                         |
-
-## Concept Types
-
-From the Spectrum Naming Guide:
-
-* **word**: Fundamental building block with multiple possible meanings
-* **term**: Word or phrase with precise meaning in a specific domain
-* **name**: Identifier that distinguishes one thing from another (proper noun)
-* **concept**: Abstract idea that words/terms/names represent
-
-## Source Types
-
-* **wiki**: Internal Spectrum wiki pages
-* **industry-standard**: W3C, WCAG, platform specifications
-* **platform-standard**: Apple HIG, Material Design, etc.
-* **internal-doc**: Internal Adobe documentation
-* **research**: User research or design research
-
-## Governance Status
-
-* **draft**: Work in progress, not yet reviewed
-* **review**: Under review by stakeholders
-* **approved**: Reviewed and approved for use
-* **deprecated**: No longer recommended (use `replacedBy` field)
-
-## Workflow
-
-### Adding a New Term
-
-1. **Research**: Understand the concept thoroughly
-2. **Write Definition**: Follow the naming guide methodology
-3. **Check References**: Validate against industry standards and platform docs
-4. **Add Entry**: Create JSON entry with all required fields
-5. **Validate**: Run `pnpm validate` to check schema compliance
-6. **Test**: Run `pnpm test` to ensure no regressions
-7. **Create PR**: Submit for review with changeset
-
-### Updating an Existing Term
-
-1. **Load Term**: Find the term in the appropriate registry file
-2. **Update Fields**: Make necessary changes
-3. **Update Governance**: Update `reviewDate` and `owner` if needed
-4. **Validate**: Run validation and tests
-5. **Create PR**: Submit for review with changeset explaining changes
-
-### Deprecating a Term
-
-1. **Set Deprecated**: Add `"deprecated": true`
-2. **Add Replacement**: Set `governance.replacedBy` to new term ID
-3. **Update Status**: Set `governance.status` to `"deprecated"`
-4. **Document Reason**: Add note in PR description
-5. **Create Changeset**: Document the deprecation
-
-## Best Practices
-
-### Naming
-
-* Use kebab-case for IDs
-* Be descriptive but concise
-* Follow industry standards when they exist
-* Avoid metaphorical or fanciful names
-* Name for the action, not the appearance
-
-### Definitions
-
-* Start with the superordinate to set context
-* Explain what it is AND how it differs from similar concepts
-* Use essential characteristics to highlight unique features
-* Write for both humans and AI systems
-* Avoid circular definitions
-
-### Platform Variations
-
-* Document when platforms use different terminology
-* Include platform-specific implementation notes
-* Link to official platform documentation
-* Help designers understand cross-platform differences
-
-### Cross-References
-
-* Link to related terms with `relatedTerms` array
-* Use term IDs, not labels
-* Bi-directional relationships are ideal but not required
-* Help users discover related concepts
-
-## Validation
-
-Run validation before submitting:
-
-```bash
-# Validate all registry files
-pnpm validate
-
-# Run test suite
-pnpm test
-```
-
-The validation script checks:
-
-* JSON schema compliance
-* No duplicate IDs
-* No duplicate aliases
-* Only one default value per registry
-* Valid relatedTerms references
-* Valid governance.replacedBy references
-
-## Questions?
-
-For questions or feedback:
-
-* Slack: #spectrum\_dna
-* Content Strategists: Jess Sattell, Kari Brookmyer
-* GitHub: [Spectrum Design Data Discussions](https://github.com/adobe/spectrum-design-data/discussions)
-
-## Related Resources
-
-* [Spectrum Naming and Definition Writing Guide](https://wiki.corp.adobe.com/display/AdobeDesign/Spectrum+Design+System%3A+Naming+and+definition+writing+guide)
-* [Spectrum Tokens Wiki](https://wiki.corp.adobe.com/display/AdobeDesign/Spectrum+tokens)
-* [Design System Registry Package README](README.md)
-* [RFC: Spectrum Design System Glossary](https://github.com/adobe/spectrum-design-data/discussions/661)