@jxsuite/schema 0.10.1 → 0.11.0

package/README.md

@@ -0,0 +1,72 @@
+# `@jxsuite/schema`
+
+> JSON Schema 2020-12 meta-schema generator for Jx documents.
+
+## Overview
+
+`@jxsuite/schema` generates three validator schemas that cover every Jx source file type. The component schema is derived at generation time from web standards data, ensuring it stays current with browser capabilities.
+
+## Installation
+
+```bash
+bun add @jxsuite/schema
+```
+
+## Generated schemas
+
+| File                  | `$id`                                   | Validates                       |
+| --------------------- | --------------------------------------- | ------------------------------- |
+| `schema.json`         | `https://jxsuite.com/schema/v1`         | Components, pages, and layouts  |
+| `project-schema.json` | `https://jxsuite.com/schema/project/v1` | `project.json` config files     |
+| `class-schema.json`   | `https://jxsuite.com/schema/class/v1`   | `.class.json` class definitions |
+
+## Regenerating schemas
+
+```bash
+bun run schema
+```
+
+This re-fetches the latest `@webref/css`, `@webref/elements`, and `@webref/idl` data and writes all three files.
+
+## API
+
+```js
+import {
+  generateSchema,
+  generateProjectSchema,
+  generateClassSchema,
+  validateDocument,
+} from "@jxsuite/schema";
+
+const schema = await generateSchema(); // component meta-schema object
+const valid = await validateDocument(doc); // validate a Jx document
+```
+
+## Component schema coverage
+
+- **`tagName`** — all standard HTML element names from `@webref/elements`
+- **Element properties** — all DOM IDL properties from `@webref/idl`
+- **`style`** — all CSSOM camelCase properties from `@webref/css`
+- **Event handlers** — all `EventHandler` names (`onclick`, `oninput`, …)
+- **`state` shapes** — naked value, typed value, computed, function, external class
+- **Built-in `$prototype` values** — `Request`, `LocalStorage`, `SessionStorage`, `Cookie`, `IndexedDB`, `Array`, `Set`, `Map`, `Blob`, `ReadableStream`, `URLSearchParams`, `FormData`
+
+## VSCode / editor integration
+
+Add the `$schema` field to any Jx file to get autocomplete and validation in any JSON Schema-aware editor:
+
+```json
+{ "$schema": "https://jxsuite.com/schema/v1" }
+```
+
+## Dependencies
+
+| Package            | Purpose                       |
+| ------------------ | ----------------------------- |
+| `@webref/css`      | CSS property definitions      |
+| `@webref/elements` | HTML element definitions      |
+| `@webref/idl`      | Web IDL interface definitions |
+
+## License
+
+MIT

package/package.json

@@ -29,5 +29,5 @@
     "upgrade": "bunx npm-check-updates -u && bun install"
   },
   "type": "module",
-  "version": "0.10.1"
+  "version": "0.11.0"
 }

package/project-schema.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://jxsuite.com/schema/project/v1",
   "title": "Jx Project",
-  "description": "Schema for Jx project.json files. A project.json file is the root anchor file for a Jx project, declaring site metadata, default settings, global styles, content collections, and build configuration.",
+  "description": "Schema for Jx project.json files. A project.json file is the root anchor file for a Jx project, declaring site metadata, default settings, global styles, content types, and build configuration.",
   "type": "object",
   "properties": {
     "name": {
@@ -160,8 +160,8 @@
       "description": "Site-wide reactive state available to all pages.",
       "type": "object"
     },
-    "collections": {
-      "description": "Content collection definitions. Each key is a collection name; the value defines the source glob, frontmatter schema, and element dependencies.",
+    "contentTypes": {
+      "description": "Content type definitions. Each key is a content type name; the value defines the source glob, frontmatter schema, and element dependencies.",
       "type": "object",
       "additionalProperties": {
         "type": "object",
@@ -175,11 +175,11 @@
             ]
           },
           "schema": {
-            "description": "JSON Schema for validating frontmatter of collection entries.",
+            "description": "JSON Schema for validating frontmatter of content type entries.",
             "type": "object"
           },
           "$elements": {
-            "description": "Custom elements available in markdown directives for this collection.",
+            "description": "Custom elements available in markdown directives for this content type.",
             "type": "array",
             "items": {
               "oneOf": [

package/src/schema.js

@@ -1022,7 +1022,7 @@ export function generateProjectSchema() {
     description:
       "Schema for Jx project.json files. " +
       "A project.json file is the root anchor file for a Jx project, " +
-      "declaring site metadata, default settings, global styles, content collections, " +
+      "declaring site metadata, default settings, global styles, content types, " +
       "and build configuration.",
     type: "object",
 
@@ -1141,9 +1141,9 @@ export function generateProjectSchema() {
         description: "Site-wide reactive state available to all pages.",
         type: "object",
       },
-      collections: {
+      contentTypes: {
         description:
-          "Content collection definitions. Each key is a collection name; " +
+          "Content type definitions. Each key is a content type name; " +
           "the value defines the source glob, frontmatter schema, and element dependencies.",
         type: "object",
         additionalProperties: {
@@ -1155,11 +1155,12 @@ export function generateProjectSchema() {
               examples: ["./blog/**/*.md", "./docs/**/*.md"],
             },
             schema: {
-              description: "JSON Schema for validating frontmatter of collection entries.",
+              description: "JSON Schema for validating frontmatter of content type entries.",
               type: "object",
             },
             $elements: {
-              description: "Custom elements available in markdown directives for this collection.",
+              description:
+                "Custom elements available in markdown directives for this content type.",
               type: "array",
               items: {
                 oneOf: [