@adobe/design-data-spec 4.5.0 → 4.7.0

package/schemas/token-types/color-set.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/color-set.json",
+  "title": "Color set",
+  "description": "A set that contains color values that change based on color theme.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "set.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/color-set.json"
+    },
+    "sets": {
+      "type": "object",
+      "anyOf": [
+        {
+          "properties": {
+            "light": {
+              "$ref": "color.json"
+            },
+            "dark": {
+              "$ref": "color.json"
+            },
+            "wireframe": {
+              "$ref": "color.json"
+            }
+          },
+          "required": ["light", "dark", "wireframe"]
+        },
+        {
+          "properties": {
+            "light": {
+              "$ref": "alias.json"
+            },
+            "dark": {
+              "$ref": "alias.json"
+            },
+            "wireframe": {
+              "$ref": "alias.json"
+            }
+          },
+          "required": ["light", "dark", "wireframe"]
+        },
+        {
+          "properties": {
+            "light": {
+              "$ref": "opacity.json"
+            },
+            "dark": {
+              "$ref": "opacity.json"
+            },
+            "wireframe": {
+              "$ref": "opacity.json"
+            }
+          },
+          "required": ["light", "dark", "wireframe"]
+        }
+      ]
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "renamed": {},
+    "uuid": {},
+    "conceptId": {}
+  },
+  "required": ["sets", "uuid"]
+}

package/schemas/token-types/color.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/color.json",
+  "title": "Color",
+  "description": "Color token schema.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "token.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/color.json"
+    },
+    "value": {
+      "type": "string",
+      "pattern": "^rgba\\((([0-1]?[0-9]?[0-9]?|2[0-4][0-9]|25[0-5]),\\s?){3}(0|1|0?\\.\\d+)\\)|rgb\\(([0-1]?[0-9]?[0-9]?|2[0-4][0-9]|25[0-5]){1,3}(,\\s?\\d{1,3}%?){2}\\)$"
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "uuid": {}
+  }
+}

package/schemas/token-types/dimension.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/dimension.json",
+  "title": "Dimension",
+  "description": "Pixel or relative dimension.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "token.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/dimension.json"
+    },
+    "value": {
+      "type": "string",
+      "pattern": "^(?:-?((?:\\d+\\.?\\d*)|(?:\\.?\\d+))(px|rem|em|%))|0|\\d+dp$"
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "uuid": {}
+  }
+}

package/schemas/token-types/drop-shadow.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/drop-shadow.json",
+  "title": "Drop Shadow",
+  "description": "A composite token that defines a drop shadow.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "token.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/drop-shadow.json"
+    },
+    "value": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "x": {
+            "type": "string",
+            "pattern": "^(?:-?((?:\\d+\\.?\\d*)|(?:\\.?\\d+))(px|rem|em|%))|0|\\d+dp$"
+          },
+          "y": {
+            "type": "string",
+            "pattern": "^(?:-?((?:\\d+\\.?\\d*)|(?:\\.?\\d+))(px|rem|em|%))|0|\\d+dp$"
+          },
+          "blur": {
+            "type": "string",
+            "pattern": "^(?:-?((?:\\d+\\.?\\d*)|(?:\\.?\\d+))(px|rem|em|%))|0|\\d+dp$"
+          },
+          "spread": {
+            "type": "string",
+            "pattern": "^(?:-?((?:\\d+\\.?\\d*)|(?:\\.?\\d+))(px|rem|em|%))|0|\\d+dp$"
+          },
+          "color": {
+            "type": "string"
+          }
+        },
+        "required": ["x", "y", "blur", "spread", "color"]
+      },
+      "minItems": 1
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "uuid": {}
+  }
+}

package/schemas/token-types/font-family.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/font-family.json",
+  "title": "Font family",
+  "description": "A font family token defines a font family that can be used in a component.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "token.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/font-family.json"
+    },
+    "value": {
+      "type": "string",
+      "pattern": "^(?:\"?\\w+\"? ?,? ?)*\"?\\w+\"?$"
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "uuid": {}
+  }
+}

package/schemas/token-types/font-size.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/font-size.json",
+  "title": "Dimension",
+  "description": "Pixel, rem, and em font sizes dimension.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "token.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/font-size.json"
+    },
+    "value": {
+      "type": "string",
+      "pattern": "^(?:-?((?:\\d+\\.?\\d*)|(?:\\.?\\d+))(px|rem|em))$"
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "uuid": {}
+  }
+}

package/schemas/token-types/font-style.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/font-style.json",
+  "title": "Font style",
+  "description": "Sets whether a font should be styled with a normal, italic, or oblique face from its font-family",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "token.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/font-style.json"
+    },
+    "value": {
+      "type": "string",
+      "enum": ["italic", "normal"]
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "uuid": {}
+  }
+}

package/schemas/token-types/font-weight.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/font-weight.json",
+  "title": "Font weight",
+  "description": "Defines sets the weight (or boldness) of the font",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "token.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/font-weight.json"
+    },
+    "value": {
+      "type": "string",
+      "enum": ["light", "regular", "medium", "bold", "extra-bold", "black"]
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "uuid": {}
+  }
+}

package/schemas/token-types/gradient-stop.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/gradient-stop.json",
+  "title": "Color Stop",
+  "description": "Gradient stop positions, being a ratio along the gradient's axis. Start is 0, end is 1.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "token.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/gradient-stop.json"
+    },
+    "value": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 1
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "uuid": {}
+  }
+}

package/schemas/token-types/multiplier.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/multiplier.json",
+  "title": "Multiplier",
+  "description": "A float used to multiply a value by a given amount. Used for line-height, margin, and width/height (dimension) multipliers.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "token.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/multiplier.json"
+    },
+    "value": {
+      "type": "number"
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "uuid": {}
+  }
+}

package/schemas/token-types/opacity.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/opacity.json",
+  "title": "Opacity",
+  "description": "A percentage measurement of the opacity.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "token.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/opacity.json"
+    },
+    "value": {
+      "type": "string",
+      "pattern": "^(?:\\d+(?:\\.\\d)+%)|(?:1|0)(?:\\.0)?|0?\\.\\d*$"
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "uuid": {}
+  }
+}

package/schemas/token-types/scale-set.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/scale-set.json",
+  "title": "Scale set",
+  "description": "A set that contains dimension values that change based on platform scale.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "set.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/scale-set.json"
+    },
+    "sets": {
+      "type": "object",
+      "properties": {
+        "mobile": {
+          "anyOf": [
+            {
+              "$ref": "dimension.json"
+            },
+            {
+              "$ref": "font-size.json"
+            },
+            {
+              "$ref": "alias.json"
+            },
+            {
+              "$ref": "multiplier.json"
+            }
+          ]
+        },
+        "desktop": {
+          "anyOf": [
+            {
+              "$ref": "dimension.json"
+            },
+            {
+              "$ref": "font-size.json"
+            },
+            {
+              "$ref": "alias.json"
+            },
+            {
+              "$ref": "multiplier.json"
+            }
+          ]
+        }
+      },
+      "required": ["mobile", "desktop"]
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "renamed": {},
+    "uuid": {},
+    "conceptId": {}
+  },
+  "required": ["sets", "uuid"]
+}

package/schemas/token-types/set.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/set.json",
+  "title": "sets",
+  "description": "A generic token set.",
+  "type": "object",
+  "properties": {
+    "sets": {
+      "type": "object"
+    },
+    "component": {
+      "type": "string"
+    },
+    "deprecated": {
+      "type": "boolean"
+    },
+    "deprecated_comment": {
+      "type": "string"
+    },
+    "renamed": {
+      "type": "string",
+      "description": "New token name if this token has been renamed. Use for 1:1 complete replacements."
+    },
+    "description": {
+      "type": "string",
+      "description": "Plain text describing the token's purpose (aligns with DTCG $description)."
+    }
+  },
+  "required": ["sets"]
+}

package/schemas/token-types/system-set.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/system-set.json",
+  "title": "System set",
+  "description": "A set that contains tokens that change based on system.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "set.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/system-set.json"
+    },
+    "sets": {
+      "type": "object",
+      "anyOf": [
+        {
+          "properties": {
+            "spectrum": {
+              "$ref": "token.json"
+            },
+            "express": {
+              "$ref": "token.json"
+            }
+          },
+          "required": ["spectrum", "express"]
+        },
+        {
+          "properties": {
+            "spectrum": {
+              "$ref": "alias.json"
+            },
+            "express": {
+              "$ref": "alias.json"
+            }
+          },
+          "required": ["spectrum", "express"]
+        },
+        {
+          "properties": {
+            "spectrum": {
+              "$ref": "color-set.json"
+            },
+            "express": {
+              "$ref": "color-set.json"
+            }
+          },
+          "required": ["spectrum", "express"]
+        },
+        {
+          "properties": {
+            "spectrum": {
+              "$ref": "scale-set.json"
+            },
+            "express": {
+              "$ref": "scale-set.json"
+            }
+          },
+          "required": ["spectrum", "express"]
+        },
+        {
+          "properties": {
+            "spectrum": {
+              "$ref": "dimension.json"
+            },
+            "express": {
+              "$ref": "scale-set.json"
+            }
+          },
+          "required": ["spectrum", "express"]
+        }
+      ]
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "renamed": {},
+    "uuid": {},
+    "conceptId": {}
+  },
+  "required": ["sets"]
+}

package/schemas/token-types/text-transform.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/text-transform.json",
+  "title": "Text transform",
+  "description": "A token that specifies how to capitalize an element's text.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "token.json"
+    }
+  ],
+  "properties": {
+    "$schema": {
+      "const": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/text-transform.json"
+    },
+    "value": {
+      "type": "string",
+      "enum": ["uppercase", "lowercase", "capitalize", "none"]
+    },
+    "component": {},
+    "private": {},
+    "deprecated": {},
+    "deprecated_comment": {},
+    "description": {},
+    "uuid": {}
+  }
+}

package/schemas/token-types/token.json

@@ -0,0 +1,75 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/token-types/token.json",
+  "title": "Token",
+  "description": "A general token.",
+  "type": "object",
+  "properties": {
+    "value": {
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "string"
+        },
+        {
+          "type": "object"
+        },
+        {
+          "type": "array"
+        }
+      ]
+    },
+    "component": {
+      "type": "string"
+    },
+    "private": {
+      "type": "boolean",
+      "default": false
+    },
+    "deprecated": {
+      "type": ["boolean", "string"],
+      "default": false,
+      "description": "Boolean (legacy) or version string (cascade). Truthy = deprecated."
+    },
+    "deprecated_comment": {
+      "type": "string"
+    },
+    "renamed": {
+      "type": "string",
+      "description": "Legacy format: new token name. Use replaced_by (UUID) in cascade format instead."
+    },
+    "replaced_by": {
+      "oneOf": [
+        { "type": "string", "format": "uuid" },
+        {
+          "type": "array",
+          "items": { "type": "string", "format": "uuid" },
+          "minItems": 1
+        }
+      ],
+      "description": "UUID(s) of the replacement token(s). Array form requires deprecated_comment."
+    },
+    "plannedRemoval": {
+      "type": "string",
+      "description": "Spec version when token will be removed."
+    },
+    "description": {
+      "type": "string",
+      "description": "Plain text describing the token's purpose (aligns with DTCG $description)."
+    },
+    "uuid": {
+      "type": "string",
+      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
+      "format": "uuid"
+    },
+    "conceptId": {
+      "type": "string",
+      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
+      "format": "uuid",
+      "description": "Canonical concept-level UUID shared by every mode row of this design concept. Additive to the per-value uuid (which remains the $ref/diff/replacedBy/sync anchor)."
+    }
+  },
+  "required": ["value", "uuid"]
+}