@jxsuite/schema 0.28.0 → 0.28.3

package/defs/project-config.schema.ts

@@ -1,199 +1,199 @@
 export const projectConfigSchema = {
+  additionalProperties: false,
   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: {
-      description: "Human-readable project name.",
-      type: "string",
-      default: "Jx Site",
-      examples: ["My Portfolio", "Jx Example Site"],
-    },
-    url: {
-      description: "Production URL of the deployed site.",
-      type: "string",
-      examples: ["https://example.com", "https://jxsuite.com"],
-    },
-    defaults: {
-      description: "Default settings applied to all pages unless overridden.",
+    $defs: {
+      description: "Global type definitions available to all pages.",
       type: "object",
-      properties: {
-        layout: {
-          description:
-            "Default layout file path applied to all pages. " +
-            "Set to null to render pages without a layout.",
-          oneOf: [{ type: "string" }, { type: "null" }],
-          default: null,
-          examples: ["./layouts/base.json"],
-        },
-        lang: {
-          description: "Default lang attribute for the <html> element.",
-          type: "string",
-          default: "en",
-        },
-        charset: {
-          description: "Default charset for the page.",
-          type: "string",
-          default: "utf-8",
-        },
-      },
-    },
-    $head: {
-      description:
-        "Global <head> entries applied to all pages. " +
-        "Array of element definitions for meta tags, link tags, script tags, etc.",
-      type: "array",
-      items: {
-        type: "object",
-        properties: {
-          tagName: { type: "string" },
-          attributes: {
-            type: "object",
-            additionalProperties: { type: "string" },
-          },
-        },
-      },
-      examples: [
-        [
-          { tagName: "link", attributes: { rel: "icon", href: "/favicon.svg" } },
-          { tagName: "meta", attributes: { name: "generator", content: "Jx" } },
-        ],
-      ],
     },
     $elements: {
       description:
         "Global custom element dependencies available to all pages. " +
         "Items are $ref objects or npm package specifier strings.",
-      type: "array",
       items: {
         oneOf: [
           {
-            type: "object",
-            required: ["$ref"],
-            properties: { $ref: { type: "string" } },
             additionalProperties: false,
+            properties: { $ref: { type: "string" } },
+            required: ["$ref"],
+            type: "object",
           },
           { type: "string" },
         ],
       },
+      type: "array",
     },
-    imports: {
+    $head: {
       description:
-        "Global import map: $prototype names to .class.json file paths. " +
-        "Makes external classes available by name in all pages.",
-      type: "object",
-      additionalProperties: { type: "string" },
+        "Global <head> entries applied to all pages. " +
+        "Array of element definitions for meta tags, link tags, script tags, etc.",
       examples: [
-        {
-          Markdown: "@jxsuite/parser/Markdown.class.json",
-          MarkdownCollection: "@jxsuite/parser/MarkdownCollection.class.json",
-        },
+        [
+          { attributes: { href: "/favicon.svg", rel: "icon" }, tagName: "link" },
+          { attributes: { content: "Jx", name: "generator" }, tagName: "meta" },
+        ],
       ],
+      items: {
+        properties: {
+          attributes: {
+            additionalProperties: { type: "string" },
+            type: "object",
+          },
+          tagName: { type: "string" },
+        },
+        type: "object",
+      },
+      type: "array",
     },
     $media: {
+      additionalProperties: { type: "string" },
       description:
         "Named media breakpoints following CSS @custom-media convention. " +
         "Available in all component style objects.",
-      type: "object",
-      additionalProperties: { type: "string" },
       examples: [
         {
-          "--sm": "(min-width: 640px)",
-          "--md": "(min-width: 768px)",
           "--lg": "(min-width: 1024px)",
+          "--md": "(min-width: 768px)",
+          "--sm": "(min-width: 640px)",
         },
       ],
-    },
-    style: {
-      description:
-        "Global CSS styles applied to the <body> element. " +
-        "Uses the same camelCase CSSOM convention as component styles.",
       type: "object",
-      additionalProperties: {
-        oneOf: [{ type: "string" }, { type: "number" }, { type: "object" }],
-      },
     },
-    state: {
-      description: "Site-wide reactive state available to all pages.",
-      type: "object",
-    },
-    $defs: {
-      description: "Global type definitions available to all pages.",
+    build: {
+      description: "Build configuration.",
+      properties: {
+        adapter: {
+          description: "Platform adapter for deployment-specific output.",
+          enum: ["netlify", "vercel", "cloudflare"],
+          type: "string",
+        },
+        format: {
+          default: "directory",
+          description: "Output format.",
+          enum: ["directory", "single"],
+          type: "string",
+        },
+        outDir: {
+          default: "./dist",
+          description: "Output directory for compiled site.",
+          type: "string",
+        },
+        trailingSlash: {
+          default: "always",
+          description: "Trailing slash behavior for generated URLs.",
+          enum: ["always", "never", "ignore"],
+          type: "string",
+        },
+      },
       type: "object",
     },
     contentTypes: {
+      additionalProperties: { $ref: "#/$defs/ContentTypeDef" },
       description:
         "Content type definitions. Each key is a content type name; " +
         "the value defines the source directory, frontmatter schema, and element dependencies.",
       type: "object",
-      additionalProperties: { $ref: "#/$defs/ContentTypeDef" },
-    },
-    redirects: {
-      description: "Static redirect rules. Maps source paths to destination paths.",
-      type: "object",
-      additionalProperties: { type: "string" },
-      examples: [{ "/old-about": "/about" }],
     },
     copy: {
+      additionalProperties: { type: "string" },
       description:
         "Declarative file copy map. Keys are source paths (relative to project root), values are destination paths (relative to outDir).",
       type: "object",
-      additionalProperties: { type: "string" },
     },
-    build: {
-      description: "Build configuration.",
-      type: "object",
+    defaults: {
+      description: "Default settings applied to all pages unless overridden.",
       properties: {
-        outDir: {
-          description: "Output directory for compiled site.",
-          type: "string",
-          default: "./dist",
-        },
-        format: {
-          description: "Output format.",
+        charset: {
+          default: "utf8",
+          description: "Default charset for the page.",
           type: "string",
-          enum: ["directory", "single"],
-          default: "directory",
         },
-        trailingSlash: {
-          description: "Trailing slash behavior for generated URLs.",
+        lang: {
+          default: "en",
+          description: "Default lang attribute for the <html> element.",
           type: "string",
-          enum: ["always", "never", "ignore"],
-          default: "always",
         },
-        adapter: {
-          description: "Platform adapter for deployment-specific output.",
-          type: "string",
-          enum: ["netlify", "vercel", "cloudflare"],
+        layout: {
+          default: null,
+          description:
+            "Default layout file path applied to all pages. " +
+            "Set to null to render pages without a layout.",
+          examples: ["./layouts/base.json"],
+          oneOf: [{ type: "string" }, { type: "null" }],
         },
       },
+      type: "object",
     },
-    images: { $ref: "#/$defs/ImageConfig" },
     i18n: {
       description: "Internationalization configuration.",
-      type: "object",
       properties: {
         defaultLocale: {
           description: "Default locale code.",
-          type: "string",
           examples: ["en"],
+          type: "string",
         },
         locales: {
           description: "Available locale codes.",
-          type: "array",
-          items: { type: "string" },
           examples: [["en", "fr", "de"]],
+          items: { type: "string" },
+          type: "array",
         },
         routing: {
           description: "Locale routing strategy.",
-          type: "string",
           enum: ["prefix-except-default", "prefix-always"],
+          type: "string",
         },
       },
+      type: "object",
+    },
+    images: { $ref: "#/$defs/ImageConfig" },
+    imports: {
+      additionalProperties: { type: "string" },
+      description:
+        "Global import map: $prototype names to .class.json file paths. " +
+        "Makes external classes available by name in all pages.",
+      examples: [
+        {
+          Markdown: "@jxsuite/parser/Markdown.class.json",
+          MarkdownCollection: "@jxsuite/parser/MarkdownCollection.class.json",
+        },
+      ],
+      type: "object",
+    },
+    name: {
+      default: "Jx Site",
+      description: "Human-readable project name.",
+      examples: ["My Portfolio", "Jx Example Site"],
+      type: "string",
+    },
+    redirects: {
+      additionalProperties: { type: "string" },
+      description: "Static redirect rules. Maps source paths to destination paths.",
+      examples: [{ "/old-about": "/about" }],
+      type: "object",
+    },
+    state: {
+      description: "Site-wide reactive state available to all pages.",
+      type: "object",
+    },
+    style: {
+      additionalProperties: {
+        oneOf: [{ type: "string" }, { type: "number" }, { type: "object" }],
+      },
+      description:
+        "Global CSS styles applied to the <body> element. " +
+        "Uses the same camelCase CSSOM convention as component styles.",
+      type: "object",
+    },
+    url: {
+      description: "Production URL of the deployed site.",
+      examples: ["https://example.com", "https://jxsuite.com"],
+      type: "string",
     },
   },
-  additionalProperties: false,
+  type: "object",
 } as const;

package/defs/pure-type-def.schema.ts

@@ -4,23 +4,23 @@ export const pureTypeDefSchema = {
     "No function, no runtime artifact. " +
     "Referenced from state entries via $ref. " +
     "Naming convention: PascalCase.",
-  type: "object",
-  required: ["type"],
+  not: {
+    anyOf: [{ required: ["default"] }, { required: ["$prototype"] }],
+  },
   properties: {
-    type: { $ref: "#/$defs/JsonSchemaType" },
     description: { type: "string" },
     enum: { type: "array" },
-    minimum: { type: "number" },
+    examples: { type: "array" },
+    items: {},
+    maxLength: { minimum: 0, type: "integer" },
     maximum: { type: "number" },
-    minLength: { type: "integer", minimum: 0 },
-    maxLength: { type: "integer", minimum: 0 },
+    minLength: { minimum: 0, type: "integer" },
+    minimum: { type: "number" },
     pattern: { type: "string" },
-    items: {},
     properties: { type: "object" },
-    required: { type: "array", items: { type: "string" } },
-    examples: { type: "array" },
-  },
-  not: {
-    anyOf: [{ required: ["default"] }, { required: ["$prototype"] }],
+    required: { items: { type: "string" }, type: "array" },
+    type: { $ref: "#/$defs/JsonSchemaType" },
   },
+  required: ["type"],
+  type: "object",
 } as const;

package/defs/ref-object.schema.ts

@@ -1,47 +1,46 @@
 export const internalRefSchema = {
   description: "Reference to a $defs type definition in the current component.",
-  type: "string",
-  pattern: "^#/\\$defs/",
   examples: ["#/$defs/Count", "#/$defs/TodoItem", "#/$defs/Status"],
+  pattern: "^#/\\$defs/",
+  type: "string",
 } as const;
 
 export const stateRefSchema = {
   description: "Reference to a state entry (runtime variable) in the current component.",
-  type: "string",
-  pattern: "^#/state/",
   examples: ["#/state/count", "#/state/addTask", "#/state/items"],
+  pattern: "^#/state/",
+  type: "string",
 } as const;
 
 export const externalRefSchema = {
   description: "Reference to an external Jx component file.",
-  type: "string",
-  pattern: "^(\\./|\\.\\./).*\\.json$|^https?://",
   examples: ["./card.json", "https://cdn.example.com/button.json"],
+  pattern: "^(\\./|\\.\\./).*\\.json$|^https?://",
+  type: "string",
 } as const;
 
 export const globalRefSchema = {
   description: "Reference to a window or document global.",
-  type: "string",
-  pattern: "^(window|document)#/",
   examples: ["window#/currentUser", "document#/appConfig"],
+  pattern: "^(window|document)#/",
+  type: "string",
 } as const;
 
 export const parentRefSchema = {
   description: "Reference to a named state entry passed via $props from a parent component.",
-  type: "string",
-  pattern: "^parent#/",
   examples: ["parent#/sharedState", "parent#/theme"],
+  pattern: "^parent#/",
+  type: "string",
 } as const;
 
 export const mapRefSchema = {
   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"],
+  pattern: "^\\$map/(item|index)(/.*)?$",
+  type: "string",
 } as const;
 
 export const anyRefSchema = {
-  type: "string",
   oneOf: [
     { $ref: "#/$defs/InternalRef" },
     { $ref: "#/$defs/StateRef" },
@@ -50,21 +49,22 @@ export const anyRefSchema = {
     { $ref: "#/$defs/ParentRef" },
     { $ref: "#/$defs/MapRef" },
   ],
+  type: "string",
 } as const;
 
 export const refObjectSchema = {
+  additionalProperties: false,
   description: "A $ref binding. Resolves to a state entry (reactive) or plain value (static).",
-  type: "object",
-  required: ["$ref"],
   properties: { $ref: { $ref: "#/$defs/AnyRef" } },
-  additionalProperties: false,
+  required: ["$ref"],
+  type: "object",
 } as const;
 
 export const externalComponentRefSchema = {
-  type: "object",
-  required: ["$ref"],
   properties: {
-    $ref: { $ref: "#/$defs/ExternalRef" },
     $props: { $ref: "#/$defs/PropsObject" },
+    $ref: { $ref: "#/$defs/ExternalRef" },
   },
+  required: ["$ref"],
+  type: "object",
 } as const;

package/defs/state-entry.schema.ts

@@ -17,7 +17,6 @@ export const stateEntrySchema = {
     { $ref: "#/$defs/ExternalClassDef" },
     { $ref: "#/$defs/ExpressionEntry" },
     {
-      type: "object",
       not: {
         anyOf: [
           { required: ["$prototype"] },
@@ -26,24 +25,25 @@ export const stateEntrySchema = {
           { required: ["$expression"] },
         ],
       },
+      type: "object",
     },
   ],
 } as const;
 
 export const stateMapSchema = {
+  additionalProperties: { $ref: "#/$defs/StateEntry" },
   description:
     "Map of runtime variables. Keys are camelCase (public) or #-prefixed (private). " +
     "All entries are reactive by default.",
   type: "object",
-  additionalProperties: { $ref: "#/$defs/StateEntry" },
 } as const;
 
 export const defsMapSchema = {
+  additionalProperties: { $ref: "#/$defs/TypeDefEntry" },
   description:
     "Map of reusable JSON Schema type definitions. " +
     "Keys are PascalCase type names. No runtime artifacts are produced.",
   type: "object",
-  additionalProperties: { $ref: "#/$defs/TypeDefEntry" },
 } as const;
 
 export const typeDefEntrySchema = {

package/defs/style-object.schema.ts

@@ -1,19 +1,19 @@
 export const styleObjectSchema = {
-  description:
-    "CSS style definition. camelCase property names follow CSSOM convention. " +
-    "Keys starting with :, ., &, or [ are treated as nested CSS selectors. " +
-    "Keys matching $media breakpoint names are treated as responsive rules.",
-  type: "object",
-  properties: {},
   additionalProperties: {
     oneOf: [
       { type: "string" },
       { type: "number" },
       {
+        additionalProperties: { oneOf: [{ type: "string" }, { type: "number" }] },
         description: "Nested CSS selector or media breakpoint rules.",
         type: "object",
-        additionalProperties: { oneOf: [{ type: "string" }, { type: "number" }] },
       },
     ],
   },
+  description:
+    "CSS style definition. camelCase property names follow CSSOM convention. " +
+    "Keys starting with :, ., &, or [ are treated as nested CSS selectors. " +
+    "Keys matching $media breakpoint names are treated as responsive rules.",
+  properties: {},
+  type: "object",
 } as const;

package/defs/tag-name.schema.ts

@@ -1,6 +1,6 @@
 export const tagNameSchema = {
   description:
     "HTML element tag name or custom element name (must contain a hyphen per Web Components spec).",
-  type: "string",
   minLength: 1,
+  type: "string",
 } as const;

package/defs/typed-state-def.schema.ts

@@ -3,29 +3,29 @@ export const typedStateDefSchema = {
     "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"],
+  not: { required: ["$prototype"] },
   properties: {
-    default: { description: "Initial state value." },
-    type: {
-      description: "JSON Schema type definition, $ref to a $defs type, or JSON Schema type string.",
-      oneOf: [{ type: "string" }, { type: "object" }],
-    },
-    description: { type: "string" },
+    $ref: { description: "Reference to a shared type definition.", type: "string" },
     attribute: {
       description: "Linked HTML attribute name for CEM extraction.",
       type: "string",
     },
-    reflects: {
-      description: "Whether property changes reflect back to the HTML attribute.",
-      type: "boolean",
-    },
+    default: { description: "Initial state value." },
     deprecated: {
       description: "Deprecation notice for CEM extraction.",
       oneOf: [{ type: "boolean" }, { type: "string" }],
     },
+    description: { type: "string" },
     examples: { type: "array" },
-    $ref: { description: "Reference to a shared type definition.", type: "string" },
+    reflects: {
+      description: "Whether property changes reflect back to the HTML attribute.",
+      type: "boolean",
+    },
+    type: {
+      description: "JSON Schema type definition, $ref to a $defs type, or JSON Schema type string.",
+      oneOf: [{ type: "string" }, { type: "object" }],
+    },
   },
-  not: { required: ["$prototype"] },
+  required: ["default"],
+  type: "object",
 } as const;

package/package.json

@@ -9,6 +9,8 @@
     ".": "./src/schema.ts",
     "./format-registry": "./src/format-registry.ts",
     "./types": "./types.ts",
+    "./guards": "./src/guards.ts",
+    "./parse": "./src/parse.ts",
     "./defs": "./defs/index.ts",
     "./schema.json": "./schema.json",
     "./project-schema.json": "./project-schema.json"
@@ -37,7 +39,7 @@
     "upgrade": "bunx npm-check-updates -u && bun install"
   },
   "type": "module",
-  "version": "0.28.0",
+  "version": "0.28.3",
   "devDependencies": {
     "json-schema-to-ts": "^3.1.1"
   }