@jxsuite/schema 0.35.0 → 1.0.0

package/schemas/project.core.schema.json

@@ -0,0 +1,441 @@
+{
+  "$defs": {
+    "ImageConfig": {
+      "description": "Image optimization configuration for the project.",
+      "properties": {
+        "formats": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "lazyLoad": {
+          "type": "boolean"
+        },
+        "optimize": {
+          "type": "boolean"
+        },
+        "quality": {
+          "properties": {
+            "avif": {
+              "type": "number"
+            },
+            "jpeg": {
+              "type": "number"
+            },
+            "png": {
+              "type": "number"
+            },
+            "webp": {
+              "type": "number"
+            }
+          },
+          "type": "object"
+        },
+        "remoteDomains": {
+          "description": "Hostnames whose remote (https) images are optimized through /cdn-cgi/image transform URLs (cloudflare service only), e.g. [\"drive.usercontent.google.com\"]. Remote sources from other hosts are left untouched.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "service": {
+          "description": "How images are optimized: \"build\" runs Sharp at build time; \"cloudflare\" emits /cdn-cgi/image transform URLs served by Cloudflare Image Transformations (requires the feature to be enabled on the serving zone).",
+          "enum": [
+            "build",
+            "cloudflare"
+          ],
+          "type": "string"
+        },
+        "sizes": {
+          "type": "string"
+        },
+        "widths": {
+          "items": {
+            "type": "number"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "JxFieldSchema": {
+      "description": "A single field definition inside a section entry schema — a small, recursive subset of JSON Schema. Recursive positions reference the effective field union via the well-known fields resource $id.",
+      "properties": {
+        "default": {},
+        "description": {
+          "type": "string"
+        },
+        "enum": {
+          "type": "array"
+        },
+        "format": {
+          "type": "string"
+        },
+        "items": {
+          "$ref": "https://jxsuite.com/schema/project/fields/v2"
+        },
+        "properties": {
+          "additionalProperties": {
+            "$ref": "https://jxsuite.com/schema/project/fields/v2"
+          },
+          "type": "object"
+        },
+        "required": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "type": {
+          "enum": [
+            "string",
+            "number",
+            "integer",
+            "boolean",
+            "array",
+            "object"
+          ],
+          "type": "string"
+        }
+      },
+      "required": [
+        "type"
+      ],
+      "type": "object"
+    },
+    "RelationshipRef": {
+      "description": "Relationship reference field: points at a named entry of a referenceable section via \"#/<sectionKey>/<name>\" (specs/relationships.md). A bare reference is to-one; wrap in an array field's items for to-many.",
+      "properties": {
+        "$ref": {
+          "pattern": "^#/[A-Za-z][A-Za-z0-9_-]*/[A-Za-z0-9._-]+$",
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "$ref"
+      ],
+      "type": "object"
+    }
+  },
+  "$id": "https://jxsuite.com/schema/project/core/v2",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Core fragment of the Jx project.json schema. Open by design: extension fragments contribute their own top-level sections and the generated per-project entry document (project.schema.json) closes the composition. See specs/extensions.md §5.",
+  "properties": {
+    "$defs": {
+      "description": "Global type definitions available to all pages.",
+      "type": "object"
+    },
+    "$elements": {
+      "description": "Global custom element dependencies available to all pages. Items are $ref objects or npm package specifier strings.",
+      "items": {
+        "oneOf": [
+          {
+            "additionalProperties": false,
+            "properties": {
+              "$ref": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "$ref"
+            ],
+            "type": "object"
+          },
+          {
+            "type": "string"
+          }
+        ]
+      },
+      "type": "array"
+    },
+    "$head": {
+      "description": "Global <head> entries applied to all pages. Array of element definitions for meta tags, link tags, script tags, etc.",
+      "examples": [
+        [
+          {
+            "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.",
+      "examples": [
+        {
+          "--lg": "(min-width: 1024px)",
+          "--md": "(min-width: 768px)",
+          "--sm": "(min-width: 640px)"
+        }
+      ],
+      "type": "object"
+    },
+    "$schema": {
+      "description": "Relative path to the generated per-project schema (conventionally ./project.schema.json, written by `jx schema`).",
+      "type": "string"
+    },
+    "build": {
+      "description": "Build configuration.",
+      "properties": {
+        "adapter": {
+          "description": "Platform adapter for deployment-specific output.",
+          "enum": [
+            "static",
+            "cloudflare-pages",
+            "cloudflare-workers",
+            "node",
+            "bun"
+          ],
+          "type": "string"
+        },
+        "deploy": {
+          "additionalProperties": false,
+          "description": "Deployment tracking: the hosting project this repo publishes to. Identifiers only (no secrets) — safe to commit; Studio uses it to tell whether the publish workflow already exists. `adapter` says how the build is packaged; `deploy` says where it ships.",
+          "properties": {
+            "accountId": {
+              "description": "Hosting account id (e.g. the Cloudflare account id).",
+              "type": "string"
+            },
+            "productionUrl": {
+              "description": "Production URL of the connected hosting project.",
+              "type": "string"
+            },
+            "projectName": {
+              "description": "Hosting project name (e.g. the Cloudflare Pages project).",
+              "pattern": "^[a-z0-9][a-z0-9-]*$",
+              "type": "string"
+            },
+            "provider": {
+              "description": "Hosting provider the project is connected to.",
+              "enum": [
+                "cloudflare-pages"
+              ],
+              "type": "string"
+            }
+          },
+          "required": [
+            "provider",
+            "accountId",
+            "projectName"
+          ],
+          "type": "object"
+        },
+        "format": {
+          "default": "directory",
+          "description": "Output format.",
+          "enum": [
+            "directory",
+            "single"
+          ],
+          "type": "string"
+        },
+        "outDir": {
+          "default": "./dist",
+          "description": "Output directory for compiled site.",
+          "type": "string"
+        },
+        "sitemap": {
+          "default": true,
+          "description": "Generate sitemap.xml from the route table (requires `url`). Set false to disable.",
+          "type": "boolean"
+        },
+        "trailingSlash": {
+          "default": "always",
+          "description": "Trailing slash behavior for generated URLs.",
+          "enum": [
+            "always",
+            "never",
+            "ignore"
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "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"
+    },
+    "defaults": {
+      "description": "Default settings applied to all pages unless overridden.",
+      "properties": {
+        "charset": {
+          "default": "utf8",
+          "description": "Default charset for the page.",
+          "type": "string"
+        },
+        "lang": {
+          "default": "en",
+          "description": "Default lang attribute for the <html> element.",
+          "type": "string"
+        },
+        "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"
+    },
+    "extensions": {
+      "description": "Extension packages: bare package names (resolved project-first through the package exports map) or relative paths. Each must export jx-extension.json.",
+      "examples": [
+        [
+          "@jxsuite/parser"
+        ]
+      ],
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "i18n": {
+      "description": "Internationalization configuration.",
+      "properties": {
+        "defaultLocale": {
+          "description": "Default locale code.",
+          "examples": [
+            "en"
+          ],
+          "type": "string"
+        },
+        "locales": {
+          "description": "Available locale codes.",
+          "examples": [
+            [
+              "en",
+              "fr",
+              "de"
+            ]
+          ],
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "routing": {
+          "description": "Locale routing strategy.",
+          "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"
+    }
+  },
+  "title": "Jx Project Core",
+  "type": "object"
+}

package/schemas/project.fields.schema.json

@@ -0,0 +1,14 @@
+{
+  "$id": "https://jxsuite.com/schema/project/fields/v2",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "anyOf": [
+    {
+      "$ref": "https://jxsuite.com/schema/project/core/v2#/$defs/JxFieldSchema"
+    },
+    {
+      "$ref": "https://jxsuite.com/schema/project/core/v2#/$defs/RelationshipRef"
+    }
+  ],
+  "description": "Default field-schema union for section entry schemas: the core field shape plus relationship references. Per-project entry documents override this resource with the effective union. See specs/extensions.md §5.3.",
+  "title": "Jx Project Field Union"
+}