@jxsuite/schema 0.0.1 → 0.1.0

package/class-schema.json

@@ -4,7 +4,10 @@
   "title": "Jx Class Definition",
   "description": "Schema for Jx .class.json files. A class definition describes a schema-defined class with fields, constructor, methods, and type parameters. Optionally points to a JS module via $implementation for hybrid execution.",
   "type": "object",
-  "required": ["$prototype", "title"],
+  "required": [
+    "$prototype",
+    "title"
+  ],
   "properties": {
     "$schema": {
       "type": "string"
@@ -20,7 +23,11 @@
     "title": {
       "description": "PascalCase class name, used as the export name.",
       "type": "string",
-      "examples": ["MarkdownFile", "DataSource", "Calculator"]
+      "examples": [
+        "MarkdownFile",
+        "DataSource",
+        "Calculator"
+      ]
     },
     "description": {
       "type": "string"
@@ -33,7 +40,9 @@
         },
         {
           "type": "object",
-          "required": ["$ref"],
+          "required": [
+            "$ref"
+          ],
           "properties": {
             "$ref": {
               "type": "string"
@@ -46,7 +55,10 @@
     "$implementation": {
       "description": "Relative path to a JS module containing the actual class implementation.",
       "type": "string",
-      "examples": ["./md.js", "./lib/calculator.js"]
+      "examples": [
+        "./md.js",
+        "./lib/calculator.js"
+      ]
     },
     "$defs": {
       "description": "Class members: parameters, returnTypes, fields, constructor, methods.",
@@ -91,7 +103,9 @@
     "ClassParameterDef": {
       "description": "A typed parameter definition for a class.",
       "type": "object",
-      "required": ["identifier"],
+      "required": [
+        "identifier"
+      ],
       "properties": {
         "identifier": {
           "type": "string"
@@ -120,11 +134,18 @@
         },
         "access": {
           "type": "string",
-          "enum": ["public", "private", "protected"]
+          "enum": [
+            "public",
+            "private",
+            "protected"
+          ]
         },
         "scope": {
           "type": "string",
-          "enum": ["instance", "static"]
+          "enum": [
+            "instance",
+            "static"
+          ]
         },
         "identifier": {
           "type": "string"
@@ -162,7 +183,9 @@
             "oneOf": [
               {
                 "type": "object",
-                "required": ["$ref"],
+                "required": [
+                  "$ref"
+                ],
                 "properties": {
                   "$ref": {
                     "type": "string"
@@ -211,7 +234,10 @@
       "properties": {
         "role": {
           "type": "string",
-          "enum": ["method", "accessor"]
+          "enum": [
+            "method",
+            "accessor"
+          ]
         },
         "$prototype": {
           "type": "string",
@@ -219,11 +245,18 @@
         },
         "access": {
           "type": "string",
-          "enum": ["public", "private", "protected"]
+          "enum": [
+            "public",
+            "private",
+            "protected"
+          ]
         },
         "scope": {
           "type": "string",
-          "enum": ["instance", "static"]
+          "enum": [
+            "instance",
+            "static"
+          ]
         },
         "identifier": {
           "type": "string"
@@ -234,7 +267,9 @@
             "oneOf": [
               {
                 "type": "object",
-                "required": ["$ref"],
+                "required": [
+                  "$ref"
+                ],
                 "properties": {
                   "$ref": {
                     "type": "string"
@@ -287,4 +322,4 @@
       }
     }
   }
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jxsuite/schema",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "JSON Schema 2020-12 meta-schema generator for Jx documents",
   "license": "MIT",
   "files": [

package/project-schema.json

@@ -9,12 +9,18 @@
       "description": "Human-readable project name.",
       "type": "string",
       "default": "Jx Site",
-      "examples": ["My Portfolio", "Jx Example Site"]
+      "examples": [
+        "My Portfolio",
+        "Jx Example Site"
+      ]
     },
     "url": {
       "description": "Production URL of the deployed site.",
       "type": "string",
-      "examples": ["https://example.com", "https://jxsuite.com"]
+      "examples": [
+        "https://example.com",
+        "https://jxsuite.com"
+      ]
     },
     "defaults": {
       "description": "Default settings applied to all pages unless overridden.",
@@ -31,7 +37,9 @@
             }
           ],
           "default": null,
-          "examples": ["./layouts/base.json"]
+          "examples": [
+            "./layouts/base.json"
+          ]
         },
         "lang": {
           "description": "Default lang attribute for the <html> element.",
@@ -88,7 +96,9 @@
         "oneOf": [
           {
             "type": "object",
-            "required": ["$ref"],
+            "required": [
+              "$ref"
+            ],
             "properties": {
               "$ref": {
                 "type": "string"
@@ -159,7 +169,10 @@
           "source": {
             "description": "Glob pattern for content files relative to the content directory.",
             "type": "string",
-            "examples": ["./blog/**/*.md", "./docs/**/*.md"]
+            "examples": [
+              "./blog/**/*.md",
+              "./docs/**/*.md"
+            ]
           },
           "schema": {
             "description": "JSON Schema for validating frontmatter of collection entries.",
@@ -172,7 +185,9 @@
               "oneOf": [
                 {
                   "type": "object",
-                  "required": ["$ref"],
+                  "required": [
+                    "$ref"
+                  ],
                   "properties": {
                     "$ref": {
                       "type": "string"
@@ -219,19 +234,30 @@
         "format": {
           "description": "Output format.",
           "type": "string",
-          "enum": ["directory", "single"],
+          "enum": [
+            "directory",
+            "single"
+          ],
           "default": "directory"
         },
         "trailingSlash": {
           "description": "Trailing slash behavior for generated URLs.",
           "type": "string",
-          "enum": ["always", "never", "ignore"],
+          "enum": [
+            "always",
+            "never",
+            "ignore"
+          ],
           "default": "always"
         },
         "adapter": {
           "description": "Platform adapter for deployment-specific output.",
           "type": "string",
-          "enum": ["netlify", "vercel", "cloudflare"]
+          "enum": [
+            "netlify",
+            "vercel",
+            "cloudflare"
+          ]
         }
       }
     },
@@ -242,7 +268,9 @@
         "defaultLocale": {
           "description": "Default locale code.",
           "type": "string",
-          "examples": ["en"]
+          "examples": [
+            "en"
+          ]
         },
         "locales": {
           "description": "Available locale codes.",
@@ -250,15 +278,24 @@
           "items": {
             "type": "string"
           },
-          "examples": [["en", "fr", "de"]]
+          "examples": [
+            [
+              "en",
+              "fr",
+              "de"
+            ]
+          ]
         },
         "routing": {
           "description": "Locale routing strategy.",
           "type": "string",
-          "enum": ["prefix-except-default", "prefix-always"]
+          "enum": [
+            "prefix-except-default",
+            "prefix-always"
+          ]
         }
       }
     }
   },
   "additionalProperties": false
-}
+}

package/schema.json

@@ -8,12 +8,18 @@
     "$schema": {
       "description": "URI identifying the Jx dialect version. Enables schema-aware IDE tooling.",
       "type": "string",
-      "examples": ["https://jxsuite.com/schema/v1"]
+      "examples": [
+        "https://jxsuite.com/schema/v1"
+      ]
     },
     "$id": {
       "description": "Component identifier string. Used by tooling and the builder.",
       "type": "string",
-      "examples": ["Counter", "TodoApp", "UserCard"]
+      "examples": [
+        "Counter",
+        "TodoApp",
+        "UserCard"
+      ]
     },
     "$defs": {
       "description": "Pure JSON Schema type definitions for this component. All entries are reusable type schemas — no runtime artifacts are produced. Referenced from state entries via $ref. Naming convention: PascalCase.",
@@ -44,7 +50,9 @@
         "oneOf": [
           {
             "type": "object",
-            "required": ["$ref"],
+            "required": [
+              "$ref"
+            ],
             "properties": {
               "$ref": {
                 "type": "string"
@@ -77,7 +85,9 @@
           "const": false
         }
       ],
-      "examples": ["./layouts/base.json"]
+      "examples": [
+        "./layouts/base.json"
+      ]
     },
     "$paths": {
       "description": "Dynamic route parameters. Maps parameter names to data sources for generating one page per entry at build time.",
@@ -189,13 +199,19 @@
           "not": {
             "anyOf": [
               {
-                "required": ["$prototype"]
+                "required": [
+                  "$prototype"
+                ]
               },
               {
-                "required": ["default"]
+                "required": [
+                  "default"
+                ]
               },
               {
-                "required": ["type"]
+                "required": [
+                  "type"
+                ]
               }
             ]
           }
@@ -205,7 +221,9 @@
     "TypedStateDef": {
       "description": "A typed reactive state variable with explicit type and default value. The type property is a JSON Schema or $ref to a $defs type definition. The default property is the initial runtime value.",
       "type": "object",
-      "required": ["default"],
+      "required": [
+        "default"
+      ],
       "properties": {
         "default": {
           "description": "Initial state value."
@@ -252,13 +270,17 @@
         }
       },
       "not": {
-        "required": ["$prototype"]
+        "required": [
+          "$prototype"
+        ]
       }
     },
     "PureTypeDef": {
       "description": "A reusable JSON Schema type definition for tooling only. No function, no runtime artifact. Referenced from state entries via $ref. Naming convention: PascalCase.",
       "type": "object",
-      "required": ["type"],
+      "required": [
+        "type"
+      ],
       "properties": {
         "type": {
           "$ref": "#/$defs/JsonSchemaType"
@@ -303,10 +325,14 @@
       "not": {
         "anyOf": [
           {
-            "required": ["default"]
+            "required": [
+              "default"
+            ]
           },
           {
-            "required": ["$prototype"]
+            "required": [
+              "$prototype"
+            ]
           }
         ]
       }
@@ -314,7 +340,9 @@
     "FunctionDef": {
       "description": "A function declaration. $prototype must be \"Function\". body (inline) and $src (external) are mutually exclusive. First parameter is always state (the reactive scope).",
       "type": "object",
-      "required": ["$prototype"],
+      "required": [
+        "$prototype"
+      ],
       "properties": {
         "$prototype": {
           "type": "string",
@@ -343,7 +371,9 @@
             ]
           },
           "examples": [
-            ["event"],
+            [
+              "event"
+            ],
             [
               {
                 "name": "event",
@@ -370,7 +400,10 @@
         "$src": {
           "description": "External module specifier. Mutually exclusive with body.",
           "type": "string",
-          "examples": ["./counter.js", "npm:@myorg/validators"]
+          "examples": [
+            "./counter.js",
+            "npm:@myorg/validators"
+          ]
         },
         "$export": {
           "description": "Named export in $src module. Defaults to the state key name.",
@@ -395,7 +428,10 @@
     "ClassDef": {
       "description": "A .class.json schema-defined class. $prototype must be \"Class\". Defines fields, constructor, methods, and type parameters via $defs. Optionally points to a JS module via $implementation for hybrid execution.",
       "type": "object",
-      "required": ["$prototype", "title"],
+      "required": [
+        "$prototype",
+        "title"
+      ],
       "properties": {
         "$schema": {
           "type": "string"
@@ -422,7 +458,9 @@
             },
             {
               "type": "object",
-              "required": ["$ref"],
+              "required": [
+                "$ref"
+              ],
               "properties": {
                 "$ref": {
                   "type": "string"
@@ -478,7 +516,9 @@
     "ClassParameterDef": {
       "description": "A typed parameter definition for a class.",
       "type": "object",
-      "required": ["identifier"],
+      "required": [
+        "identifier"
+      ],
       "properties": {
         "identifier": {
           "type": "string"
@@ -507,11 +547,18 @@
         },
         "access": {
           "type": "string",
-          "enum": ["public", "private", "protected"]
+          "enum": [
+            "public",
+            "private",
+            "protected"
+          ]
         },
         "scope": {
           "type": "string",
-          "enum": ["instance", "static"]
+          "enum": [
+            "instance",
+            "static"
+          ]
         },
         "identifier": {
           "type": "string"
@@ -549,7 +596,9 @@
             "oneOf": [
               {
                 "type": "object",
-                "required": ["$ref"],
+                "required": [
+                  "$ref"
+                ],
                 "properties": {
                   "$ref": {
                     "type": "string"
@@ -595,7 +644,10 @@
       "properties": {
         "role": {
           "type": "string",
-          "enum": ["method", "accessor"]
+          "enum": [
+            "method",
+            "accessor"
+          ]
         },
         "$prototype": {
           "type": "string",
@@ -603,11 +655,18 @@
         },
         "access": {
           "type": "string",
-          "enum": ["public", "private", "protected"]
+          "enum": [
+            "public",
+            "private",
+            "protected"
+          ]
         },
         "scope": {
           "type": "string",
-          "enum": ["instance", "static"]
+          "enum": [
+            "instance",
+            "static"
+          ]
         },
         "identifier": {
           "type": "string"
@@ -618,7 +677,9 @@
             "oneOf": [
               {
                 "type": "object",
-                "required": ["$ref"],
+                "required": [
+                  "$ref"
+                ],
                 "properties": {
                   "$ref": {
                     "type": "string"
@@ -673,7 +734,9 @@
     "ExternalClassDef": {
       "description": "An external class / data source. $prototype is a constructor name (not \"Function\"). When $prototype is not in the built-in registry, $src is required. All state entries are reactive by default.",
       "type": "object",
-      "required": ["$prototype"],
+      "required": [
+        "$prototype"
+      ],
       "properties": {
         "$prototype": {
           "description": "Constructor name — built-in Web API class or external class name.",
@@ -701,7 +764,11 @@
         "$src": {
           "description": "External module specifier. Required when $prototype is not a built-in.",
           "type": "string",
-          "examples": ["@jxplatform/md", "./lib/my-parser.js", "npm:@myorg/data"]
+          "examples": [
+            "@jxplatform/md",
+            "./lib/my-parser.js",
+            "npm:@myorg/data"
+          ]
         },
         "$export": {
           "description": "Named export in $src module. Defaults to the $prototype value.",
@@ -709,7 +776,11 @@
         },
         "timing": {
           "type": "string",
-          "enum": ["compiler", "server", "client"]
+          "enum": [
+            "compiler",
+            "server",
+            "client"
+          ]
         },
         "manual": {
           "type": "boolean"
@@ -723,7 +794,15 @@
         },
         "method": {
           "type": "string",
-          "enum": ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]
+          "enum": [
+            "GET",
+            "POST",
+            "PUT",
+            "PATCH",
+            "DELETE",
+            "HEAD",
+            "OPTIONS"
+          ]
         },
         "headers": {
           "type": "object",
@@ -734,7 +813,14 @@
         "body": {},
         "responseType": {
           "type": "string",
-          "enum": ["json", "text", "blob", "arraybuffer", "document", ""]
+          "enum": [
+            "json",
+            "text",
+            "blob",
+            "arraybuffer",
+            "document",
+            ""
+          ]
         },
         "key": {
           "type": "string"
@@ -759,7 +845,11 @@
         },
         "sameSite": {
           "type": "string",
-          "enum": ["strict", "lax", "none"]
+          "enum": [
+            "strict",
+            "lax",
+            "none"
+          ]
         },
         "database": {
           "type": "string"
@@ -781,7 +871,10 @@
           "type": "array",
           "items": {
             "type": "object",
-            "required": ["name", "keyPath"],
+            "required": [
+              "name",
+              "keyPath"
+            ],
             "properties": {
               "name": {
                 "type": "string"
@@ -828,7 +921,9 @@
     "ElementDef": {
       "description": "A Jx element definition. Maps directly to a DOM element.",
       "type": "object",
-      "required": ["tagName"],
+      "required": [
+        "tagName"
+      ],
       "properties": {
         "tagName": {
           "$ref": "#/$defs/TagName"
@@ -862,7 +957,11 @@
         },
         "dir": {
           "type": "string",
-          "enum": ["ltr", "rtl", "auto"]
+          "enum": [
+            "ltr",
+            "rtl",
+            "auto"
+          ]
         },
         "value": {
           "$ref": "#/$defs/StringOrRef"
@@ -2130,7 +2229,11 @@
     "ArrayNamespace": {
       "description": "Dynamic mapped list. Re-renders when the items state entry changes.",
       "type": "object",
-      "required": ["$prototype", "items", "map"],
+      "required": [
+        "$prototype",
+        "items",
+        "map"
+      ],
       "properties": {
         "$prototype": {
           "type": "string",
@@ -2161,7 +2264,9 @@
     "SwitchDef": {
       "description": "Reactive $ref that drives which case to render.",
       "type": "object",
-      "required": ["$ref"],
+      "required": [
+        "$ref"
+      ],
       "properties": {
         "$ref": {
           "$ref": "#/$defs/InternalRef"
@@ -2171,7 +2276,10 @@
     },
     "SwitchNode": {
       "type": "object",
-      "required": ["$switch", "cases"],
+      "required": [
+        "$switch",
+        "cases"
+      ],
       "properties": {
         "tagName": {
           "$ref": "#/$defs/TagName"
@@ -18483,7 +18591,9 @@
     "RefObject": {
       "description": "A $ref binding. Resolves to a state entry (reactive) or plain value (static).",
       "type": "object",
-      "required": ["$ref"],
+      "required": [
+        "$ref"
+      ],
       "properties": {
         "$ref": {
           "$ref": "#/$defs/AnyRef"
@@ -18518,23 +18628,36 @@
       "description": "Reference to a $defs type definition in the current component.",
       "type": "string",
       "pattern": "^#/\\$defs/",
-      "examples": ["#/$defs/Count", "#/$defs/TodoItem", "#/$defs/Status"]
+      "examples": [
+        "#/$defs/Count",
+        "#/$defs/TodoItem",
+        "#/$defs/Status"
+      ]
     },
     "StateRef": {
       "description": "Reference to a state entry (runtime variable) in the current component.",
       "type": "string",
       "pattern": "^#/state/",
-      "examples": ["#/state/count", "#/state/addTask", "#/state/items"]
+      "examples": [
+        "#/state/count",
+        "#/state/addTask",
+        "#/state/items"
+      ]
     },
     "ExternalRef": {
       "description": "Reference to an external Jx component file.",
       "type": "string",
       "pattern": "^(\\./|\\.\\./).*\\.json$|^https?://",
-      "examples": ["./card.json", "https://cdn.example.com/button.json"]
+      "examples": [
+        "./card.json",
+        "https://cdn.example.com/button.json"
+      ]
     },
     "ExternalComponentRef": {
       "type": "object",
-      "required": ["$ref"],
+      "required": [
+        "$ref"
+      ],
       "properties": {
         "$ref": {
           "$ref": "#/$defs/ExternalRef"
@@ -18548,19 +18671,30 @@
       "description": "Reference to a window or document global.",
       "type": "string",
       "pattern": "^(window|document)#/",
-      "examples": ["window#/currentUser", "document#/appConfig"]
+      "examples": [
+        "window#/currentUser",
+        "document#/appConfig"
+      ]
     },
     "ParentRef": {
       "description": "Reference to a named state entry passed via $props from a parent component.",
       "type": "string",
       "pattern": "^parent#/",
-      "examples": ["parent#/sharedState", "parent#/theme"]
+      "examples": [
+        "parent#/sharedState",
+        "parent#/theme"
+      ]
     },
     "MapRef": {
       "description": "Reference to the current Array map iteration context.",
       "type": "string",
       "pattern": "^\\$map/(item|index)(/.*)?$",
-      "examples": ["$map/item", "$map/index", "$map/item/text", "$map/item/done"]
+      "examples": [
+        "$map/item",
+        "$map/index",
+        "$map/item/text",
+        "$map/item/done"
+      ]
     },
     "ElementPropertyValue": {
       "oneOf": [
@@ -18614,7 +18748,9 @@
     "CemParameter": {
       "description": "A CEM-compatible parameter definition for a function. Follows the Custom Elements Manifest Parameter shape.",
       "type": "object",
-      "required": ["name"],
+      "required": [
+        "name"
+      ],
       "properties": {
         "name": {
           "description": "Parameter name.",
@@ -18639,7 +18775,9 @@
     "CemEvent": {
       "description": "A CEM-compatible event definition. Describes a CustomEvent the function dispatches.",
       "type": "object",
-      "required": ["name"],
+      "required": [
+        "name"
+      ],
       "properties": {
         "name": {
           "description": "Event name (e.g. 'task-toggled').",
@@ -18885,7 +19023,15 @@
     },
     "JsonSchemaType": {
       "type": "string",
-      "enum": ["string", "number", "integer", "boolean", "array", "object", "null"]
+      "enum": [
+        "string",
+        "number",
+        "integer",
+        "boolean",
+        "array",
+        "object",
+        "null"
+      ]
     }
   }
-}
+}