banhaten 0.3.0 → 0.5.0

package/schema/registry.schema.json

@@ -1,190 +1,194 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "urn:banhaten:schema:registry",
-  "title": "Banhaten registry index",
-  "type": "object",
-  "required": ["name", "base", "components"],
-  "additionalProperties": false,
-  "properties": {
-    "$schema": { "type": "string" },
-    "name": { "type": "string", "minLength": 1 },
-    "base": { "$ref": "#/$defs/baseEntry" },
-    "components": {
-      "type": "object",
-      "minProperties": 1,
-      "additionalProperties": { "$ref": "#/$defs/componentEntry" }
-    }
-  },
-  "$defs": {
-    "baseEntry": {
-      "type": "object",
-      "required": ["dependencies", "files"],
-      "additionalProperties": false,
-      "properties": {
-        "dependencies": { "$ref": "#/$defs/dependencies" },
-        "files": {
-          "type": "array",
-          "minItems": 1,
-          "items": { "$ref": "#/$defs/registryFile" }
-        }
-      }
-    },
-    "componentEntry": {
-      "type": "object",
-      "required": [
-        "description",
-        "dependencies",
-        "parts",
-        "supportedExports",
-        "files",
-        "examples"
-      ],
-      "additionalProperties": false,
-      "properties": {
-        "description": { "type": "string", "minLength": 1 },
-        "status": { "enum": ["expanded"] },
-        "dependencies": { "$ref": "#/$defs/dependencies" },
-        "registryDependencies": { "$ref": "#/$defs/stringArray" },
-        "parts": {
-          "description": "Ordered, non-exhaustive component anatomy. The first value is the primary renderable part; every value must also appear in supportedExports.",
-          "type": "array",
-          "minItems": 1,
-          "uniqueItems": true,
-          "items": { "$ref": "#/$defs/componentPartName" }
-        },
-        "supportedExports": {
-          "description": "Exhaustive runtime value exports, grouped by the installed source module that owns each import path. Type-only exports are intentionally excluded.",
-          "type": "array",
-          "minItems": 1,
-          "uniqueItems": true,
-          "items": { "$ref": "#/$defs/supportedExportModule" }
-        },
-        "files": {
-          "type": "array",
-          "minItems": 1,
-          "items": { "$ref": "#/$defs/registryFile" }
-        },
-        "examples": {
-          "type": "array",
-          "minItems": 1,
-          "items": { "type": "string", "minLength": 1 }
-        },
-        "props": {
-          "description": "Machine-readable public prop behavior, including rendered defaults for optional visual slots.",
-          "type": "object",
-          "minProperties": 1,
-          "additionalProperties": { "$ref": "#/$defs/componentProp" }
-        },
-        "defaults": {
-          "description": "Explicit defaults for array-valued capabilities. Keys must name a capability on the same component and values must belong to that capability list.",
-          "type": "object",
-          "minProperties": 1,
-          "additionalProperties": {
-            "type": ["string", "number", "boolean", "null"]
-          }
-        },
-        "recommendedFor": { "$ref": "#/$defs/stringArray" },
-        "avoidWhen": { "$ref": "#/$defs/stringArray" },
-        "recipes": { "$ref": "#/$defs/stringArray" },
-        "rtl": {
-          "type": "object",
-          "minProperties": 1,
-          "additionalProperties": { "type": ["string", "boolean"] }
-        },
-        "actions": { "$ref": "#/$defs/stringArray" },
-        "alignments": { "$ref": "#/$defs/stringArray" },
-        "breakpoints": { "$ref": "#/$defs/stringArray" },
-        "cardPositions": { "$ref": "#/$defs/stringArray" },
-        "colors": { "$ref": "#/$defs/stringArray" },
-        "controlPositions": { "$ref": "#/$defs/stringArray" },
-        "densities": { "$ref": "#/$defs/stringArray" },
-        "directions": { "$ref": "#/$defs/stringArray" },
-        "features": { "$ref": "#/$defs/stringArray" },
-        "forms": { "$ref": "#/$defs/stringArray" },
-        "indicators": { "$ref": "#/$defs/stringArray" },
-        "intents": { "$ref": "#/$defs/stringArray" },
-        "itemKinds": { "$ref": "#/$defs/stringArray" },
-        "itemTypes": { "$ref": "#/$defs/stringArray" },
-        "kinds": { "$ref": "#/$defs/stringArray" },
-        "labelPositions": { "$ref": "#/$defs/stringArray" },
-        "layouts": { "$ref": "#/$defs/stringArray" },
-        "modes": { "$ref": "#/$defs/stringArray" },
-        "offsets": { "$ref": "#/$defs/stringArray" },
-        "options": { "$ref": "#/$defs/stringArray" },
-        "orientations": { "$ref": "#/$defs/stringArray" },
-        "platforms": { "$ref": "#/$defs/stringArray" },
-        "pointerPositions": { "$ref": "#/$defs/stringArray" },
-        "selectionTypes": { "$ref": "#/$defs/stringArray" },
-        "shapes": { "$ref": "#/$defs/stringArray" },
-        "sides": { "$ref": "#/$defs/stringArray" },
-        "sizes": { "$ref": "#/$defs/stringArray" },
-        "states": { "$ref": "#/$defs/stringArray" },
-        "statusColors": { "$ref": "#/$defs/stringArray" },
-        "styles": { "$ref": "#/$defs/stringArray" },
-        "tokens": { "$ref": "#/$defs/stringArray" },
-        "tones": { "$ref": "#/$defs/stringArray" },
-        "types": { "$ref": "#/$defs/stringArray" },
-        "valueModes": { "$ref": "#/$defs/stringArray" },
-        "variants": { "$ref": "#/$defs/stringArray" },
-        "widths": { "$ref": "#/$defs/stringArray" }
-      }
-    },
-    "dependencies": {
-      "type": "object",
-      "additionalProperties": { "type": "string", "minLength": 1 }
-    },
-    "stringArray": {
-      "type": "array",
-      "uniqueItems": true,
-      "items": { "type": "string", "minLength": 1 }
-    },
-    "exportName": {
-      "type": "string",
-      "pattern": "^[A-Za-z_$][A-Za-z0-9_$]*$"
-    },
-    "componentPartName": {
-      "type": "string",
-      "pattern": "^[A-Z][A-Za-z0-9_$]*$"
-    },
-    "componentProp": {
-      "type": "object",
-      "required": ["type", "default", "description"],
-      "additionalProperties": false,
-      "properties": {
-        "type": { "type": "string", "minLength": 1 },
-        "default": {
-          "type": ["string", "number", "boolean", "null"]
-        },
-        "description": { "type": "string", "minLength": 1 },
-        "deprecated": { "type": "boolean" }
-      }
-    },
-    "supportedExportModule": {
-      "type": "object",
-      "required": ["source", "values"],
-      "additionalProperties": false,
-      "properties": {
-        "source": {
-          "description": "Exact TypeScript source path from this component's files array.",
-          "type": "string",
-          "pattern": "^(?!.*\\.d\\.[cm]?[jt]sx?$).+\\.[cm]?[jt]sx?$"
-        },
-        "values": {
-          "type": "array",
-          "minItems": 1,
-          "uniqueItems": true,
-          "items": { "$ref": "#/$defs/exportName" }
-        }
-      }
-    },
-    "registryFile": {
-      "type": "object",
-      "required": ["source", "target"],
-      "additionalProperties": false,
-      "properties": {
-        "source": { "type": "string", "minLength": 1 },
-        "target": { "type": "string", "minLength": 1 }
-      }
-    }
-  }
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "urn:banhaten:schema:registry",
+  "title": "Banhaten registry index",
+  "type": "object",
+  "required": ["name", "base", "components"],
+  "additionalProperties": false,
+  "properties": {
+    "$schema": { "type": "string" },
+    "name": { "type": "string", "minLength": 1 },
+    "base": { "$ref": "#/$defs/baseEntry" },
+    "components": {
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": { "$ref": "#/$defs/componentEntry" }
+    }
+  },
+  "$defs": {
+    "baseEntry": {
+      "type": "object",
+      "required": ["dependencies", "files"],
+      "additionalProperties": false,
+      "properties": {
+        "dependencies": { "$ref": "#/$defs/dependencies" },
+        "files": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/registryFile" }
+        }
+      }
+    },
+    "componentEntry": {
+      "type": "object",
+      "required": [
+        "description",
+        "dependencies",
+        "parts",
+        "supportedExports",
+        "files",
+        "examples"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "description": { "type": "string", "minLength": 1 },
+        "status": { "enum": ["expanded"] },
+        "dependencies": { "$ref": "#/$defs/dependencies" },
+        "registryDependencies": { "$ref": "#/$defs/stringArray" },
+        "parts": {
+          "description": "Ordered, non-exhaustive component anatomy. The first value is the primary renderable part; every value must also appear in supportedExports.",
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/componentPartName" }
+        },
+        "supportedExports": {
+          "description": "Exhaustive runtime value exports, grouped by the installed source module that owns each import path. Type-only exports are intentionally excluded.",
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/supportedExportModule" }
+        },
+        "files": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/registryFile" }
+        },
+        "examples": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "props": {
+          "description": "Machine-readable public prop behavior, including rendered defaults for optional visual slots.",
+          "type": "object",
+          "minProperties": 1,
+          "additionalProperties": { "$ref": "#/$defs/componentProp" }
+        },
+        "defaults": {
+          "description": "Explicit defaults for array-valued capabilities. Keys must name a capability on the same component and values must belong to that capability list.",
+          "type": "object",
+          "minProperties": 1,
+          "additionalProperties": {
+            "type": ["string", "number", "boolean", "null"]
+          }
+        },
+        "recommendedFor": { "$ref": "#/$defs/stringArray" },
+        "avoidWhen": { "$ref": "#/$defs/stringArray" },
+        "recipes": { "$ref": "#/$defs/stringArray" },
+        "rtl": {
+          "type": "object",
+          "minProperties": 1,
+          "additionalProperties": { "type": ["string", "boolean"] }
+        },
+        "actions": { "$ref": "#/$defs/stringArray" },
+        "alignments": { "$ref": "#/$defs/stringArray" },
+        "breakpoints": { "$ref": "#/$defs/stringArray" },
+        "cardPositions": { "$ref": "#/$defs/stringArray" },
+        "colors": { "$ref": "#/$defs/stringArray" },
+        "controlPositions": { "$ref": "#/$defs/stringArray" },
+        "densities": { "$ref": "#/$defs/stringArray" },
+        "directions": { "$ref": "#/$defs/stringArray" },
+        "features": { "$ref": "#/$defs/stringArray" },
+        "forms": { "$ref": "#/$defs/stringArray" },
+        "indicators": { "$ref": "#/$defs/stringArray" },
+        "intents": { "$ref": "#/$defs/stringArray" },
+        "itemKinds": { "$ref": "#/$defs/stringArray" },
+        "itemTypes": { "$ref": "#/$defs/stringArray" },
+        "kinds": { "$ref": "#/$defs/stringArray" },
+        "labelPositions": { "$ref": "#/$defs/stringArray" },
+        "layouts": { "$ref": "#/$defs/stringArray" },
+        "modes": { "$ref": "#/$defs/stringArray" },
+        "offsets": { "$ref": "#/$defs/stringArray" },
+        "options": { "$ref": "#/$defs/stringArray" },
+        "orientations": { "$ref": "#/$defs/stringArray" },
+        "platforms": { "$ref": "#/$defs/stringArray" },
+        "pointerPositions": { "$ref": "#/$defs/stringArray" },
+        "selectionTypes": { "$ref": "#/$defs/stringArray" },
+        "shapes": { "$ref": "#/$defs/stringArray" },
+        "sides": { "$ref": "#/$defs/stringArray" },
+        "sizes": { "$ref": "#/$defs/stringArray" },
+        "states": { "$ref": "#/$defs/stringArray" },
+        "statusColors": { "$ref": "#/$defs/stringArray" },
+        "styles": { "$ref": "#/$defs/stringArray" },
+        "tokens": { "$ref": "#/$defs/stringArray" },
+        "tones": { "$ref": "#/$defs/stringArray" },
+        "types": { "$ref": "#/$defs/stringArray" },
+        "valueModes": { "$ref": "#/$defs/stringArray" },
+        "variants": { "$ref": "#/$defs/stringArray" },
+        "widths": { "$ref": "#/$defs/stringArray" }
+      }
+    },
+    "dependencies": {
+      "type": "object",
+      "additionalProperties": { "type": "string", "minLength": 1 }
+    },
+    "stringArray": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": { "type": "string", "minLength": 1 }
+    },
+    "exportName": {
+      "type": "string",
+      "pattern": "^[A-Za-z_$][A-Za-z0-9_$]*$"
+    },
+    "componentPartName": {
+      "type": "string",
+      "pattern": "^[A-Z][A-Za-z0-9_$]*$"
+    },
+    "componentProp": {
+      "type": "object",
+      "required": ["type", "default", "description"],
+      "additionalProperties": false,
+      "properties": {
+        "type": { "type": "string", "minLength": 1 },
+        "default": {
+          "type": ["string", "number", "boolean", "null"]
+        },
+        "description": { "type": "string", "minLength": 1 },
+        "deprecated": { "type": "boolean" }
+      }
+    },
+    "supportedExportModule": {
+      "type": "object",
+      "required": ["source", "values"],
+      "additionalProperties": false,
+      "properties": {
+        "source": {
+          "description": "Exact TypeScript source path from this component's files array.",
+          "type": "string",
+          "pattern": "^(?!.*\\.d\\.[cm]?[jt]sx?$).+\\.[cm]?[jt]sx?$"
+        },
+        "values": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/exportName" }
+        }
+      }
+    },
+    "registryFile": {
+      "type": "object",
+      "required": ["source", "target"],
+      "additionalProperties": false,
+      "properties": {
+        "source": { "type": "string", "minLength": 1 },
+        "target": { "type": "string", "minLength": 1 },
+        "internal": {
+          "type": "boolean",
+          "description": "Installed and compiled with the component, but its exports are not part of the supported import contract. A public module of the same component imports it."
+        }
+      }
+    }
+  }
+}