@adobe/design-data-spec 0.1.1 → 0.3.0

package/README.md

@@ -16,9 +16,9 @@ Normative **Design Data Specification** artifacts for Spectrum: human-readable s
 
 ## Tasks
 
-- `moon run designDataSpec:check` — verify required paths exist (layout guard).
+* `moon run design-data-spec:check` — verify required paths exist (layout guard).
 
 ## References
 
-- [Design Data Specification project](https://github.com/orgs/adobe/projects/89)
-- Discussion [#714](https://github.com/adobe/spectrum-design-data/discussions/714) — umbrella spec
+* [Design Data Specification project](https://github.com/orgs/adobe/projects/89)
+* Discussion [#714](https://github.com/adobe/spectrum-design-data/discussions/714) — umbrella spec

package/components/button.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/component.schema.json",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/button.json",
+  "specVersion": "1.0.0-draft",
+  "name": "button",
+  "displayName": "Button",
+  "description": "Buttons allow users to perform an action or to navigate to another page.",
+  "meta": {
+    "category": "actions",
+    "documentationUrl": "https://spectrum.adobe.com/page/button/"
+  },
+  "options": {
+    "variant": {
+      "type": "string",
+      "enum": ["accent", "negative", "primary", "secondary"],
+      "default": "accent",
+      "description": "Visual emphasis level."
+    },
+    "style": {
+      "type": "string",
+      "enum": ["fill", "outline"],
+      "default": "fill"
+    },
+    "size": {
+      "type": "string",
+      "enum": ["s", "m", "l", "xl"],
+      "default": "m"
+    },
+    "isDisabled": { "type": "boolean", "default": false },
+    "isPending": { "type": "boolean", "default": false },
+    "isLabelHidden": { "type": "boolean", "default": false },
+    "icon": {
+      "$ref": "https://opensource.adobe.com/spectrum-design-data/schemas/types/workflow-icon.json",
+      "description": "Icon placed at the start of the button. Required when isLabelHidden is true."
+    },
+    "staticColor": {
+      "type": "string",
+      "enum": ["white", "black"],
+      "description": "Static color for use on colored backgrounds."
+    }
+  },
+  "slots": [
+    {
+      "name": "default",
+      "description": "Text label of the button.",
+      "required": false
+    },
+    {
+      "name": "icon",
+      "description": "Icon placed at the start of the button."
+    }
+  ],
+  "anatomy": [
+    { "name": "icon", "description": "Leading icon." },
+    { "name": "label", "description": "Button text.", "required": true }
+  ],
+  "states": [
+    { "name": "hover", "trigger": "interaction", "precedence": 50 },
+    {
+      "name": "focus",
+      "trigger": "interaction",
+      "precedence": 60,
+      "layered": true
+    },
+    { "name": "disabled", "trigger": "prop", "precedence": 100 }
+  ],
+  "lifecycle": {
+    "introduced": "1.0.0-draft"
+  }
+}

package/conformance/README.md

@@ -16,7 +16,6 @@ Each **invalid** case lives under `invalid/<RULE_ID>/` with:
 | `invalid/SPEC-005` | SPEC-005 | Dimension `default` not in `modes`.                     |
 | `invalid/SPEC-006` | SPEC-006 | Ambiguous resolution / specificity tie (warning).       |
 | `invalid/SPEC-008` | SPEC-008 | Non-default mode variants with no base/default variant. |
-| `invalid/SPEC-014` | SPEC-014 | `lastModified` semver precedes `introduced`.            |
 
 Implementors SHOULD run these fixtures once the Rust validator exposes rule IDs ([#724](https://github.com/adobe/spectrum-design-data/issues/724), [#725](https://github.com/adobe/spectrum-design-data/issues/725)).
 

package/conformance/invalid/SPEC-016/expected-errors.json

@@ -0,0 +1,10 @@
+{
+  "layer": 2,
+  "errors": [
+    {
+      "rule_id": "SPEC-016",
+      "severity": "error",
+      "message_pattern": "value does not validate against declared $valueType schema"
+    }
+  ]
+}

package/conformance/invalid/SPEC-016/tokens.tokens.json

@@ -0,0 +1,8 @@
+[
+  {
+    "name": { "property": "bad-typography" },
+    "$valueType": "value-types/typography.schema.json",
+    "value": "not-an-object",
+    "uuid": "aaaaaaaa-0016-4000-8000-000000000001"
+  }
+]

package/conformance/invalid/SPEC-017/expected-errors.json

@@ -0,0 +1,10 @@
+{
+  "layer": 2,
+  "errors": [
+    {
+      "rule_id": "SPEC-017",
+      "severity": "warning",
+      "message_pattern": "string name instead of a name object"
+    }
+  ]
+}

package/conformance/invalid/SPEC-017/tokens.tokens.json

@@ -0,0 +1,7 @@
+[
+  {
+    "name": "focus-ring-color-key-focus",
+    "value": "#0265dc",
+    "uuid": "aaaaaaaa-0017-4000-8000-000000000002"
+  }
+]

package/conformance/invalid/SPEC-018/dataset.json

@@ -0,0 +1,9 @@
+{
+  "tokens": [
+    {
+      "name": { "component": "nonexistent", "property": "background-color" },
+      "value": "#ff0000"
+    }
+  ],
+  "components": []
+}

package/conformance/invalid/SPEC-018/expected-errors.json

@@ -0,0 +1,10 @@
+{
+  "layer": 2,
+  "errors": [
+    {
+      "rule_id": "SPEC-018",
+      "severity": "error",
+      "message_pattern": ".*undeclared component.*"
+    }
+  ]
+}

package/conformance/invalid/SPEC-019/dataset.json

@@ -0,0 +1,29 @@
+{
+  "tokens": [
+    {
+      "name": {
+        "component": "button",
+        "variant": "electric",
+        "property": "background-color"
+      },
+      "value": "#0000ff"
+    }
+  ],
+  "components": [
+    {
+      "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/button.json",
+      "name": "button",
+      "displayName": "Button",
+      "meta": {
+        "category": "actions",
+        "documentationUrl": "https://spectrum.adobe.com/page/button/"
+      },
+      "options": {
+        "variant": {
+          "type": "string",
+          "enum": ["accent", "negative", "primary", "secondary"]
+        }
+      }
+    }
+  ]
+}

package/conformance/invalid/SPEC-019/expected-errors.json

@@ -0,0 +1,10 @@
+{
+  "layer": 2,
+  "errors": [
+    {
+      "rule_id": "SPEC-019",
+      "severity": "error",
+      "message_pattern": ".*variant.*electric.*not declared.*"
+    }
+  ]
+}

package/conformance/invalid/SPEC-020/dataset.json

@@ -0,0 +1,27 @@
+{
+  "tokens": [
+    {
+      "name": {
+        "component": "button",
+        "anatomy": "capsule",
+        "property": "background-color"
+      },
+      "value": "#ff0000"
+    }
+  ],
+  "components": [
+    {
+      "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/button.json",
+      "name": "button",
+      "displayName": "Button",
+      "meta": {
+        "category": "actions",
+        "documentationUrl": "https://spectrum.adobe.com/page/button/"
+      },
+      "anatomy": [
+        { "name": "icon", "description": "Leading icon." },
+        { "name": "label", "description": "Button text.", "required": true }
+      ]
+    }
+  ]
+}

package/conformance/invalid/SPEC-020/expected-errors.json

@@ -0,0 +1,10 @@
+{
+  "layer": 2,
+  "errors": [
+    {
+      "rule_id": "SPEC-020",
+      "severity": "error",
+      "message_pattern": ".*undeclared anatomy part.*capsule.*"
+    }
+  ]
+}

package/conformance/invalid/SPEC-021/dataset.json

@@ -0,0 +1,18 @@
+{
+  "tokens": [],
+  "components": [
+    {
+      "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/button.json",
+      "name": "button",
+      "displayName": "Button",
+      "meta": {
+        "category": "actions",
+        "documentationUrl": "https://spectrum.adobe.com/page/button/"
+      },
+      "slots": [
+        { "name": "default", "description": "Text label of the button." },
+        { "name": "badge" }
+      ]
+    }
+  ]
+}

package/conformance/invalid/SPEC-021/expected-errors.json

@@ -0,0 +1,10 @@
+{
+  "layer": 2,
+  "errors": [
+    {
+      "rule_id": "SPEC-021",
+      "severity": "warning",
+      "message_pattern": ".*custom slot.*badge.*no description.*"
+    }
+  ]
+}

package/conformance/invalid/SPEC-022/dataset.json

@@ -0,0 +1,33 @@
+{
+  "tokens": [
+    {
+      "name": {
+        "component": "button",
+        "state": "jello",
+        "property": "background-color"
+      },
+      "value": "#ff0000"
+    }
+  ],
+  "components": [
+    {
+      "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/button.json",
+      "name": "button",
+      "displayName": "Button",
+      "meta": {
+        "category": "actions",
+        "documentationUrl": "https://spectrum.adobe.com/page/button/"
+      },
+      "states": [
+        { "name": "hover", "trigger": "interaction", "precedence": 50 },
+        {
+          "name": "focus",
+          "trigger": "interaction",
+          "precedence": 60,
+          "layered": true
+        },
+        { "name": "disabled", "trigger": "prop", "precedence": 100 }
+      ]
+    }
+  ]
+}

package/conformance/invalid/SPEC-022/expected-errors.json

@@ -0,0 +1,10 @@
+{
+  "layer": 2,
+  "errors": [
+    {
+      "rule_id": "SPEC-022",
+      "severity": "error",
+      "message_pattern": ".*undeclared state.*jello.*"
+    }
+  ]
+}

package/conformance/invalid/SPEC-023/dataset.json

@@ -0,0 +1,18 @@
+{
+  "tokens": [],
+  "components": [
+    {
+      "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/button.json",
+      "name": "button",
+      "displayName": "Button",
+      "meta": {
+        "category": "actions",
+        "documentationUrl": "https://spectrum.adobe.com/page/button/"
+      },
+      "anatomy": [
+        { "name": "label", "description": "Button text.", "required": true },
+        { "name": "shimmer" }
+      ]
+    }
+  ]
+}

package/conformance/invalid/SPEC-023/expected-errors.json

@@ -0,0 +1,10 @@
+{
+  "layer": 2,
+  "errors": [
+    {
+      "rule_id": "SPEC-023",
+      "severity": "warning",
+      "message_pattern": ".*custom anatomy part.*shimmer.*no description.*"
+    }
+  ]
+}

package/conformance/invalid/SPEC-024/dataset.json

@@ -0,0 +1,18 @@
+{
+  "tokens": [],
+  "components": [
+    {
+      "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/button.json",
+      "name": "button",
+      "displayName": "Button",
+      "meta": {
+        "category": "actions",
+        "documentationUrl": "https://spectrum.adobe.com/page/button/"
+      },
+      "states": [
+        { "name": "hover", "trigger": "interaction", "precedence": 50 },
+        { "name": "wobble" }
+      ]
+    }
+  ]
+}

package/conformance/invalid/SPEC-024/expected-errors.json

@@ -0,0 +1,10 @@
+{
+  "layer": 2,
+  "errors": [
+    {
+      "rule_id": "SPEC-024",
+      "severity": "warning",
+      "message_pattern": ".*custom state.*wobble.*no description.*"
+    }
+  ]
+}

package/conformance/valid/component-refs/dataset.json

@@ -0,0 +1,63 @@
+{
+  "tokens": [
+    {
+      "name": {
+        "component": "button",
+        "variant": "accent",
+        "property": "background-color"
+      },
+      "value": "#0265dc"
+    },
+    {
+      "name": {
+        "component": "button",
+        "anatomy": "label",
+        "property": "color"
+      },
+      "value": "#ffffff"
+    },
+    {
+      "name": {
+        "component": "button",
+        "state": "hover",
+        "property": "background-color"
+      },
+      "value": "#0255be"
+    }
+  ],
+  "components": [
+    {
+      "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/button.json",
+      "name": "button",
+      "displayName": "Button",
+      "meta": {
+        "category": "actions",
+        "documentationUrl": "https://spectrum.adobe.com/page/button/"
+      },
+      "options": {
+        "variant": {
+          "type": "string",
+          "enum": ["accent", "negative", "primary", "secondary"]
+        }
+      },
+      "slots": [
+        { "name": "default", "description": "Text label of the button." },
+        { "name": "icon", "description": "Leading icon." }
+      ],
+      "anatomy": [
+        { "name": "icon", "description": "Leading icon." },
+        { "name": "label", "description": "Button text.", "required": true }
+      ],
+      "states": [
+        { "name": "hover", "trigger": "interaction", "precedence": 50 },
+        {
+          "name": "focus",
+          "trigger": "interaction",
+          "precedence": 60,
+          "layered": true
+        },
+        { "name": "disabled", "trigger": "prop", "precedence": 100 }
+      ]
+    }
+  ]
+}

package/conformance/valid/composite-drop-shadow.json

@@ -0,0 +1,14 @@
+{
+  "name": { "property": "drop-shadow-default" },
+  "$valueType": "value-types/drop-shadow.schema.json",
+  "value": [
+    {
+      "x": "0px",
+      "y": "1px",
+      "blur": "4px",
+      "spread": "0px",
+      "color": "rgba(0, 0, 0, 0.16)"
+    }
+  ],
+  "uuid": "aaaaaaaa-0010-4000-8000-000000000002"
+}

package/conformance/valid/composite-typography-scale.json

@@ -0,0 +1,6 @@
+{
+  "name": { "property": "typography-scale", "scale": "desktop" },
+  "$valueType": "value-types/typography-scale.schema.json",
+  "value": { "fontSize": "14px", "lineHeight": "18px" },
+  "uuid": "aaaaaaaa-0010-4000-8000-000000000003"
+}

package/conformance/valid/composite-typography.json

@@ -0,0 +1,12 @@
+{
+  "name": { "property": "component-m-regular" },
+  "$valueType": "value-types/typography.schema.json",
+  "value": {
+    "fontFamily": "{sans-serif-font-family}",
+    "fontSize": "{font-size-100}",
+    "fontWeight": "{regular-font-weight}",
+    "letterSpacing": "{letter-spacing}",
+    "lineHeight": "{line-height-font-size-100}"
+  },
+  "uuid": "aaaaaaaa-0010-4000-8000-000000000001"
+}

package/conformance/valid/string-name-escape-hatch.json

@@ -0,0 +1,7 @@
+[
+  {
+    "name": "focus-ring-color-key-focus",
+    "value": "#0265dc",
+    "uuid": "aaaaaaaa-0017-4000-8000-000000000001"
+  }
+]

package/fields/scaleIndex.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/field.schema.json",
+  "specVersion": "1.0.0-draft",
+  "name": "scaleIndex",
+  "description": "Numeric scale index appended at the end of the serialized name (e.g., 100, 200, 900). Used by foundational scale tokens for spacing, color palette, font sizes, border widths, corner radii, and drop-shadow values.",
+  "kind": "numeric",
+  "registry": null,
+  "validation": "none",
+  "serialization": {
+    "position": 16
+  },
+  "scope": null,
+  "required": false,
+  "valueType": "integer"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/design-data-spec",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Design Data Specification — prose, JSON Schemas, rule catalog, and conformance fixtures for Spectrum design data",
   "type": "module",
   "repository": {
@@ -25,15 +25,27 @@
     "./schemas/field.schema.json": "./schemas/field.schema.json",
     "./schemas/manifest.schema.json": "./schemas/manifest.schema.json",
     "./schemas/value-types/color.schema.json": "./schemas/value-types/color.schema.json",
-    "./rules/rules.yaml": "./rules/rules.yaml"
+    "./schemas/component.schema.json": "./schemas/component.schema.json",
+    "./schemas/anatomy-part.schema.json": "./schemas/anatomy-part.schema.json",
+    "./schemas/state-declaration.schema.json": "./schemas/state-declaration.schema.json",
+    "./rules/rules.yaml": "./rules/rules.yaml",
+    "./src/validate.js": "./src/validate.js",
+    "./src/canonical.js": "./src/canonical.js"
   },
   "files": [
-    "spec",
-    "schemas",
+    "components",
+    "conformance",
     "fields",
     "rules",
-    "conformance",
+    "schemas",
+    "spec",
+    "src",
     "README.md"
   ],
-  "scripts": {}
+  "devDependencies": {
+    "ava": "^6.0.1"
+  },
+  "scripts": {
+    "test": "ava"
+  }
 }