@adobe/spectrum-component-api-schemas 2.0.0 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,76 @@
 # @adobe/spectrum-component-api-schemas
 
+## 3.0.0
+
+### Major Changes
+
+- [#610](https://github.com/adobe/spectrum-tokens/pull/610) [`13d9202`](https://github.com/adobe/spectrum-tokens/commit/13d920273c02c78d3748522de6a7c7ee39b39814) Thanks [@GarthDB](https://github.com/GarthDB)! - Component schema improvements for Batch 1 components
+
+  Quality control pass on the Design API table for v0, ensuring schema consistency and completeness across S2 components.
+
+  ## Component Schemas Changed (0 added, 0 deleted, 11 updated)
+
+  **Original Branch:** `main`
+  **New Branch:** `component-schema-batch1-fixes`
+
+  ### 🚨 Breaking Changes Detected (5)
+
+  This release introduces **5 breaking change(s)** to component schemas. Please review carefully and ensure proper versioning.
+
+  <details open><summary><strong>💥 Breaking Updates</strong></summary>
+
+  **popover**
+  - Added: `hideTip` (boolean, default: false) - replaces removed `showTip`
+
+  **rating**
+  - Added: `value.minimum` (0), `value.maximum` (5), `value.multipleOf` (0.5)
+  - Updated: `value.description` - "From 0 to 5, can be a decimal to represent half stars"
+
+  **select-box**
+  - Added: `hideIllustration` (boolean, default: false) - replaces removed `showIllustration`
+  - Added: `isDisabled` (boolean, default: false)
+  - Added: `multiple` (boolean, default: false) - "Set to true to allow multiple selections"
+  - Updated: `orientation.default` changed to "vertical"
+
+  **status-light**
+  - Added: Colors to `variant.enum`: "gray", "red", "orange", "green", "cyan"
+  - Added: `required` - ["label"] - label is now required
+  - Removed: `isDisabled` property
+
+  **tooltip**
+  - Removed: "positive" from `variant.enum`
+  - Updated: `hasIcon.description` - "If the neutral variant, there is never an icon"
+
+  </details>
+
+  ### ✅ Non-Breaking Updates (6)
+
+  <details><summary><strong>🔄 Compatible Changes</strong></summary>
+
+  **help-text**
+  - Added: "negative" to `variant.enum`
+  - Added: `isDisabled.description` - "Help text cannot be both disabled and negative variant"
+
+  **meter**
+  - Added: `hideLabel` (boolean, default: false)
+
+  **progress-bar**
+  - Added: `staticColor` (string, enum: ["white"]) - "Static color can only be white, otherwise it is default"
+  - Added: `labelPosition` (string, enum: ["top", "side"], default: "top")
+  - Added: `hideLabel` (boolean, default: false)
+
+  **search-field**
+  - Added: `hideLabel` (boolean, default: false)
+  - Added: `icon` ($ref: workflow-icon.json) - "Icon must be present if the label is not defined"
+
+  **text-area**
+  - Added: `hideLabel` (boolean, default: false)
+
+  **text-field**
+  - Added: `hideLabel` (boolean, default: false)
+
+  </details>
+
 ## 2.0.0
 
 ### Major Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spectrum-component-api-schemas",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "",
   "type": "module",
   "main": "index.js",

package/schemas/components/help-text.json

@@ -14,7 +14,7 @@
     },
     "variant": {
       "type": "string",
-      "enum": ["neutral"],
+      "enum": ["neutral", "negative"],
       "default": "neutral"
     },
     "hideIcon": {
@@ -29,7 +29,8 @@
     },
     "isDisabled": {
       "type": "boolean",
-      "default": false
+      "default": false,
+      "description": "Help text cannot be both disabled and negative variant."
     }
   }
 }

package/schemas/components/meter.json

@@ -17,6 +17,10 @@
     "label": {
       "type": "string"
     },
+    "hideLabel": {
+      "type": "boolean",
+      "default": false
+    },
     "valueLabel": {
       "type": "string"
     },

package/schemas/components/popover.json

@@ -15,9 +15,9 @@
     "height": {
       "type": "number"
     },
-    "showTip": {
+    "hideTip": {
       "type": "boolean",
-      "default": true
+      "default": false
     },
     "placement": {
       "type": "string",

package/schemas/components/progress-bar.json

@@ -14,9 +14,23 @@
       "enum": ["default", "over background"],
       "default": "default"
     },
+    "staticColor": {
+      "type": "string",
+      "enum": ["white"],
+      "description": "Static color can only be white, otherwise it is default."
+    },
     "label": {
       "type": "string"
     },
+    "labelPosition": {
+      "type": "string",
+      "enum": ["top", "side"],
+      "default": "top"
+    },
+    "hideLabel": {
+      "type": "boolean",
+      "default": false
+    },
     "value": {
       "type": "number",
       "description": "Not applicable when indeterminate."

package/schemas/components/rating.json

@@ -11,9 +11,11 @@
   "properties": {
     "value": {
       "type": "number",
-      "enum": [0, 1, 2, 3, 4, 5],
+      "minimum": 0,
+      "maximum": 5,
       "default": 0,
-      "description": "From 0 to 5"
+      "multipleOf": 0.5,
+      "description": "From 0 to 5, can be a decimal to represent half stars"
     },
     "isEmphasized": {
       "type": "boolean",

package/schemas/components/search-field.json

@@ -12,6 +12,14 @@
     "label": {
       "type": "string"
     },
+    "hideLabel": {
+      "type": "boolean",
+      "default": false
+    },
+    "icon": {
+      "$ref": "https://opensource.adobe.com/spectrum-tokens/schemas/types/workflow-icon.json",
+      "description": "Icon must be present if the label is not defined."
+    },
     "value": {
       "type": "string"
     },

package/schemas/components/select-box.json

@@ -15,7 +15,7 @@
     "orientation": {
       "type": "string",
       "enum": ["horizontal", "vertical"],
-      "default": "horizontal"
+      "default": "vertical"
     },
     "body": {
       "type": "string"
@@ -24,7 +24,7 @@
       "type": "boolean",
       "default": false
     },
-    "showIllustration": {
+    "hideIllustration": {
       "type": "boolean",
       "default": false
     },
@@ -32,10 +32,19 @@
       "type": "boolean",
       "default": false
     },
+    "isDisabled": {
+      "type": "boolean",
+      "default": false
+    },
     "state": {
       "type": "string",
       "enum": ["default", "down", "hover", "keyboard focus"],
       "default": "default"
+    },
+    "multiple": {
+      "type": "boolean",
+      "default": false,
+      "description": "Set to true to allow multiple selections."
     }
   }
 }

package/schemas/components/status-light.json

@@ -32,7 +32,12 @@
         "turquoise",
         "cinnamon",
         "brown",
-        "silver"
+        "silver",
+        "gray",
+        "red",
+        "orange",
+        "green",
+        "cyan"
       ],
       "default": "informative"
     },
@@ -40,10 +45,7 @@
       "type": "string",
       "enum": ["s", "m", "l", "xl"],
       "default": "m"
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
     }
-  }
+  },
+  "required": ["label"]
 }

package/schemas/components/text-area.json

@@ -17,6 +17,10 @@
       "default": "top",
       "enum": ["top", "side"]
     },
+    "hideLabel": {
+      "type": "boolean",
+      "default": false
+    },
     "value": {
       "type": "string",
       "description": "from minValue to maxValue"

package/schemas/components/text-field.json

@@ -17,6 +17,10 @@
       "default": "top",
       "enum": ["top", "side"]
     },
+    "hideLabel": {
+      "type": "boolean",
+      "default": false
+    },
     "value": {
       "type": "string",
       "description": "from minValue to maxValue"

package/schemas/components/tooltip.json

@@ -14,12 +14,12 @@
     },
     "variant": {
       "type": "string",
-      "enum": ["neutral", "informative", "positive", "negative"],
+      "enum": ["neutral", "informative", "negative"],
       "default": "neutral"
     },
     "hasIcon": {
       "type": "boolean",
-      "description": "If the neutral variant, there’s never an icon.",
+      "description": "If the neutral variant, there is never an icon.",
       "default": false
     },
     "maxWidth": {