@adobe/design-system-registry 0.0.0-layout-20260209174611

package/index.js

@@ -0,0 +1,189 @@
+/*
+Copyright 2025 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
+
+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 REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { readFileSync, readdirSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+import { dirname, join } from "node:path";
+
+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 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"),
+);
+
+/**
+ * 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],
+    };
+  }
+
+  // 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) {
+      return {
+        ...baseTerm,
+        platform: {
+          term: ext.platformTerm || baseTerm.label,
+          aliases: ext.platformAliases,
+          notes: ext.notes,
+          reference: ext.reference,
+          codeExample: ext.codeExample,
+          differences: ext.differences,
+        },
+      };
+    }
+  }
+
+  // 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

@@ -0,0 +1,40 @@
+# Copyright 2025 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
+
+# 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 REPRESENTATIONS
+# OF ANY KIND, either express or implied. See the License for the specific language
+# governing permissions and limitations under the License.
+
+$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

@@ -0,0 +1,46 @@
+{
+  "name": "@adobe/design-system-registry",
+  "version": "0.0.0-layout-20260209174611",
+  "description": "A single source of truth for design system terminology used across Spectrum tokens, component schemas, and anatomy",
+  "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"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adobe/spectrum-design-data.git",
+    "directory": "packages/design-system-registry"
+  },
+  "author": "Garth Braithwaite <garthdb@gmail.com> (https://garthdb.com/)",
+  "bugs": {
+    "url": "https://github.com/adobe/spectrum-design-data/issues"
+  },
+  "publishConfig": {
+    "provenance": false
+  },
+  "homepage": "https://github.com/adobe/spectrum-design-data/tree/main/packages/design-system-registry#readme",
+  "license": "Apache-2.0",
+  "engines": {
+    "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.0.0"
+  },
+  "scripts": {
+    "validate": "node scripts/validate-registry.js",
+    "test": "ava"
+  }
+}

package/registry/anatomy-terms.json

@@ -0,0 +1,151 @@
+{
+  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/registry-value.json",
+  "type": "anatomy-term",
+  "description": "Anatomical part names used in design tokens and component structures",
+  "values": [
+    {
+      "id": "edge",
+      "label": "Edge",
+      "description": "The outer boundary or border of a component",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "visual",
+      "label": "Visual",
+      "description": "Visual elements like icons, images, or decorative elements",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "text",
+      "label": "Text",
+      "description": "Text content or labels",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "control",
+      "label": "Control",
+      "description": "Interactive control elements like checkboxes or radio buttons",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "border",
+      "label": "Border",
+      "description": "Border or outline of a component",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "background",
+      "label": "Background",
+      "description": "Background surface or fill",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "icon",
+      "label": "Icon",
+      "description": "Icon elements",
+      "usedIn": ["tokens", "component-schemas"]
+    },
+    {
+      "id": "label",
+      "label": "Label",
+      "description": "Text labels",
+      "usedIn": ["tokens", "component-schemas"]
+    },
+    {
+      "id": "content",
+      "label": "Content",
+      "description": "Main content area",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "top",
+      "label": "Top",
+      "description": "Top edge or boundary",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "bottom",
+      "label": "Bottom",
+      "description": "Bottom edge or boundary",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "start",
+      "label": "Start",
+      "description": "Start edge (left in LTR, right in RTL)",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "end",
+      "label": "End",
+      "description": "End edge (right in LTR, left in RTL)",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "body",
+      "label": "Body",
+      "description": "Main body or content container",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "header",
+      "label": "Header",
+      "description": "Header section",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "footer",
+      "label": "Footer",
+      "description": "Footer section",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "divider",
+      "label": "Divider",
+      "description": "Dividing line or separator",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "handle",
+      "label": "Handle",
+      "description": "Draggable handle element",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "indicator",
+      "label": "Indicator",
+      "description": "Visual indicator or marker",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "track",
+      "label": "Track",
+      "description": "Track or rail element (e.g., in sliders)",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "thumb",
+      "label": "Thumb",
+      "description": "Draggable thumb element (e.g., in sliders)",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "avatar",
+      "label": "Avatar",
+      "description": "User avatar or profile image",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "badge",
+      "label": "Badge",
+      "description": "Badge or notification indicator",
+      "usedIn": ["tokens"]
+    },
+    {
+      "id": "pill",
+      "label": "Pill",
+      "description": "Pill-shaped element",
+      "usedIn": ["tokens"]
+    }
+  ]
+}

package/registry/categories.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/registry-value.json",
+  "type": "category",
+  "description": "Component categories for organization and discovery",
+  "values": [
+    {
+      "id": "actions",
+      "label": "Actions",
+      "description": "Components that allow users to perform actions",
+      "usedIn": ["component-schemas"]
+    },
+    {
+      "id": "containers",
+      "label": "Containers",
+      "description": "Components that contain or organize other content",
+      "usedIn": ["component-schemas"]
+    },
+    {
+      "id": "data-visualization",
+      "label": "Data Visualization",
+      "aliases": ["data visualization"],
+      "description": "Components for displaying data and charts",
+      "usedIn": ["component-schemas"]
+    },
+    {
+      "id": "feedback",
+      "label": "Feedback",
+      "description": "Components that provide feedback to users",
+      "usedIn": ["component-schemas"]
+    },
+    {
+      "id": "inputs",
+      "label": "Inputs",
+      "description": "Components for user input and data entry",
+      "usedIn": ["component-schemas"]
+    },
+    {
+      "id": "navigation",
+      "label": "Navigation",
+      "description": "Components for navigation and wayfinding",
+      "usedIn": ["component-schemas"]
+    },
+    {
+      "id": "status",
+      "label": "Status",
+      "description": "Components that indicate status or state",
+      "usedIn": ["component-schemas"]
+    },
+    {
+      "id": "typography",
+      "label": "Typography",
+      "description": "Text and typography components",
+      "usedIn": ["component-schemas"]
+    }
+  ]
+}