twntyx-css 1.0.0

package/llm/schema.json

@@ -0,0 +1,804 @@
+{
+  "$id": "https://twntyx.dev/schemas/llm-kit.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "twntyX LLM kit schema bundle",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schemaVersion",
+    "$defs"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "string",
+      "const": "1.0.0"
+    },
+    "$defs": {
+      "type": "object"
+    }
+  },
+  "schemaVersion": "1.0.0",
+  "$defs": {
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+    },
+    "path": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[a-zA-Z0-9._/-]+$"
+    },
+    "nonEmptyString": {
+      "type": "string",
+      "minLength": 1
+    },
+    "stringList": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "uniqueItems": true
+    },
+    "componentClassEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "className",
+        "description"
+      ],
+      "properties": {
+        "name": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "className": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "description": {
+          "$ref": "#/$defs/nonEmptyString"
+        }
+      }
+    },
+    "component": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "status",
+        "summary",
+        "keywords",
+        "sourcePaths",
+        "apiModel",
+        "baseClass",
+        "variants",
+        "sizes",
+        "states",
+        "structure",
+        "attributes",
+        "a11y",
+        "dos",
+        "donts",
+        "tokenUsage",
+        "examples",
+        "composition",
+        "breakingChangePolicy"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "name": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "stable",
+            "preview",
+            "experimental",
+            "deprecated"
+          ]
+        },
+        "summary": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "keywords": {
+          "$ref": "#/$defs/stringList"
+        },
+        "sourcePaths": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/path"
+          },
+          "minItems": 1,
+          "uniqueItems": true
+        },
+        "apiModel": {
+          "type": "string",
+          "const": "html-class"
+        },
+        "baseClass": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "variants": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/componentClassEntry"
+          }
+        },
+        "sizes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/componentClassEntry"
+          }
+        },
+        "states": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/componentClassEntry"
+          }
+        },
+        "structure": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "rootElement",
+            "requiredClasses",
+            "optionalClasses",
+            "requiredChildren",
+            "optionalChildren"
+          ],
+          "properties": {
+            "rootElement": {
+              "$ref": "#/$defs/nonEmptyString"
+            },
+            "requiredClasses": {
+              "$ref": "#/$defs/stringList"
+            },
+            "optionalClasses": {
+              "$ref": "#/$defs/stringList"
+            },
+            "requiredChildren": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "optionalChildren": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "attributes": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "allowed",
+            "required",
+            "dataAttributes",
+            "roles",
+            "aria"
+          ],
+          "properties": {
+            "allowed": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "uniqueItems": true
+            },
+            "required": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "uniqueItems": true
+            },
+            "dataAttributes": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "uniqueItems": true
+            },
+            "roles": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "uniqueItems": true
+            },
+            "aria": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "uniqueItems": true
+            }
+          }
+        },
+        "a11y": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "interactive",
+            "requiredRoles",
+            "requiredAria",
+            "keyboardSupport",
+            "focusBehavior"
+          ],
+          "properties": {
+            "interactive": {
+              "type": "boolean"
+            },
+            "requiredRoles": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "uniqueItems": true
+            },
+            "requiredAria": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "uniqueItems": true
+            },
+            "keyboardSupport": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "uniqueItems": true
+            },
+            "focusBehavior": {
+              "$ref": "#/$defs/nonEmptyString"
+            }
+          }
+        },
+        "dos": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1
+        },
+        "donts": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1
+        },
+        "tokenUsage": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/id"
+          },
+          "uniqueItems": true
+        },
+        "examples": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "id",
+              "file",
+              "description"
+            ],
+            "properties": {
+              "id": {
+                "$ref": "#/$defs/id"
+              },
+              "file": {
+                "$ref": "#/$defs/path"
+              },
+              "description": {
+                "$ref": "#/$defs/nonEmptyString"
+              }
+            }
+          }
+        },
+        "composition": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "patterns",
+            "relatedComponents",
+            "notes"
+          ],
+          "properties": {
+            "patterns": {
+              "type": "array",
+              "items": {
+                "$ref": "#/$defs/id"
+              },
+              "uniqueItems": true
+            },
+            "relatedComponents": {
+              "type": "array",
+              "items": {
+                "$ref": "#/$defs/id"
+              },
+              "uniqueItems": true
+            },
+            "notes": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "breakingChangePolicy": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "classContract",
+            "a11yContract"
+          ],
+          "properties": {
+            "classContract": {
+              "$ref": "#/$defs/nonEmptyString"
+            },
+            "a11yContract": {
+              "$ref": "#/$defs/nonEmptyString"
+            }
+          }
+        }
+      }
+    },
+    "tokenEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "cssVariable",
+        "category",
+        "semanticIntent",
+        "values",
+        "resolvedValues",
+        "sourcePaths"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "cssVariable": {
+          "type": "string",
+          "pattern": "^--[a-z0-9-]+$"
+        },
+        "category": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "semanticIntent": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "name",
+            "path",
+            "reference"
+          ],
+          "properties": {
+            "name": {
+              "$ref": "#/$defs/nonEmptyString"
+            },
+            "path": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 1
+              },
+              "minItems": 1
+            },
+            "reference": {
+              "type": [
+                "string",
+                "object",
+                "null"
+              ]
+            }
+          }
+        },
+        "values": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "light",
+            "dark"
+          ],
+          "properties": {
+            "light": {
+              "$ref": "#/$defs/nonEmptyString"
+            },
+            "dark": {
+              "$ref": "#/$defs/nonEmptyString"
+            }
+          }
+        },
+        "resolvedValues": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "light",
+            "dark"
+          ],
+          "properties": {
+            "light": {
+              "$ref": "#/$defs/nonEmptyString"
+            },
+            "dark": {
+              "$ref": "#/$defs/nonEmptyString"
+            }
+          }
+        },
+        "sourcePaths": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/path"
+          },
+          "minItems": 1,
+          "uniqueItems": true
+        }
+      }
+    },
+    "tokens": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "llmSchemaVersion",
+        "generatedFrom",
+        "items"
+      ],
+      "properties": {
+        "llmSchemaVersion": {
+          "type": "string",
+          "const": "1.0.0"
+        },
+        "generatedFrom": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/path"
+          },
+          "minItems": 1,
+          "uniqueItems": true
+        },
+        "items": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/tokenEntry"
+          }
+        }
+      }
+    },
+    "patternEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "summary",
+        "components",
+        "template",
+        "dos",
+        "donts"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "name": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "summary": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "components": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/id"
+          },
+          "minItems": 1,
+          "uniqueItems": true
+        },
+        "template": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "dos": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1
+        },
+        "donts": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1
+        }
+      }
+    },
+    "patterns": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "llmSchemaVersion",
+        "patterns"
+      ],
+      "properties": {
+        "llmSchemaVersion": {
+          "type": "string",
+          "const": "1.0.0"
+        },
+        "patterns": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/patternEntry"
+          }
+        }
+      }
+    },
+    "rules": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "llmSchemaVersion",
+        "apiModel",
+        "dos",
+        "donts",
+        "accessibility",
+        "namingConventions",
+        "responseContract"
+      ],
+      "properties": {
+        "llmSchemaVersion": {
+          "type": "string",
+          "const": "1.0.0"
+        },
+        "apiModel": {
+          "type": "string",
+          "const": "html-class"
+        },
+        "dos": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1
+        },
+        "donts": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1
+        },
+        "accessibility": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1
+        },
+        "namingConventions": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "classPrefixes",
+            "statePrefixes",
+            "sizeMarkers"
+          ],
+          "properties": {
+            "classPrefixes": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "minItems": 1
+            },
+            "statePrefixes": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "minItems": 1
+            },
+            "sizeMarkers": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "minItems": 1
+            }
+          }
+        },
+        "responseContract": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "whenUnknown",
+            "whenAmbiguous"
+          ],
+          "properties": {
+            "whenUnknown": {
+              "$ref": "#/$defs/nonEmptyString"
+            },
+            "whenAmbiguous": {
+              "$ref": "#/$defs/nonEmptyString"
+            }
+          }
+        }
+      }
+    },
+    "indexComponentEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "file",
+        "status",
+        "summary",
+        "keywords"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "name": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "file": {
+          "$ref": "#/$defs/path"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "stable",
+            "preview",
+            "experimental",
+            "deprecated"
+          ]
+        },
+        "summary": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "keywords": {
+          "$ref": "#/$defs/stringList"
+        }
+      }
+    },
+    "index": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "llmSchemaVersion",
+        "designSystemVersion",
+        "packageName",
+        "apiModel",
+        "sourceFingerprint",
+        "files",
+        "components",
+        "queryBehavior"
+      ],
+      "properties": {
+        "llmSchemaVersion": {
+          "type": "string",
+          "const": "1.0.0"
+        },
+        "designSystemVersion": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "packageName": {
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "apiModel": {
+          "type": "string",
+          "const": "html-class"
+        },
+        "sourceFingerprint": {
+          "type": "string",
+          "pattern": "^[a-f0-9]{64}$"
+        },
+        "files": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "schema",
+            "tokens",
+            "patterns",
+            "rules",
+            "componentsDir",
+            "examplesDir",
+            "llms"
+          ],
+          "properties": {
+            "schema": {
+              "$ref": "#/$defs/path"
+            },
+            "tokens": {
+              "$ref": "#/$defs/path"
+            },
+            "patterns": {
+              "$ref": "#/$defs/path"
+            },
+            "rules": {
+              "$ref": "#/$defs/path"
+            },
+            "componentsDir": {
+              "$ref": "#/$defs/path"
+            },
+            "examplesDir": {
+              "$ref": "#/$defs/path"
+            },
+            "llms": {
+              "$ref": "#/$defs/path"
+            }
+          }
+        },
+        "components": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/indexComponentEntry"
+          }
+        },
+        "queryBehavior": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "lookupPriority",
+            "unsupportedComponent"
+          ],
+          "properties": {
+            "lookupPriority": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "minItems": 1
+            },
+            "unsupportedComponent": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "code",
+                "message",
+                "suggestedActions"
+              ],
+              "properties": {
+                "code": {
+                  "type": "string",
+                  "const": "UNSUPPORTED_COMPONENT"
+                },
+                "message": {
+                  "$ref": "#/$defs/nonEmptyString"
+                },
+                "suggestedActions": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "minItems": 1
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}