@cloudhal/core-contracts 0.3.4 → 0.3.5

package/schemas/.bundled/page.schema.json

@@ -1,738 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://cloudhal.dev/schemas/v1/page.schema.json",
-  "title": "Page",
-  "description": "A routable page of a site: a path, editorial status and an ordered list of sections. Sections are embedded (not separate nodes) so a page is the unit of locking, snapshotting and diffing.",
-  "type": "object",
-  "additionalProperties": false,
-  "required": [
-    "schemaVersion",
-    "id",
-    "siteId",
-    "path",
-    "title",
-    "locale",
-    "status",
-    "sections",
-    "rev",
-    "createdAt",
-    "updatedAt"
-  ],
-  "properties": {
-    "schemaVersion": {
-      "$ref": "#/$defs/SchemaVersion"
-    },
-    "id": {
-      "$ref": "#/$defs/Id"
-    },
-    "siteId": {
-      "$ref": "#/$defs/Id"
-    },
-    "path": {
-      "type": "string",
-      "description": "Absolute URL path, starting with '/', no trailing slash except root.",
-      "pattern": "^/(?:[a-z0-9]+(?:-[a-z0-9]+)*(?:/[a-z0-9]+(?:-[a-z0-9]+)*)*)?$",
-      "maxLength": 1024
-    },
-    "title": {
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 300
-    },
-    "locale": {
-      "$ref": "#/$defs/Locale"
-    },
-    "status": {
-      "$ref": "#/$defs/PublishStatus"
-    },
-    "sections": {
-      "type": "array",
-      "items": {
-        "$ref": "#/$defs/Section"
-      }
-    },
-    "seo": {
-      "$ref": "#/$defs/Seo"
-    },
-    "availability": {
-      "$ref": "#/$defs/Availability"
-    },
-    "chrome": {
-      "type": "object",
-      "description": "This page's own header and footer (RFC-0025 §1): a landing page without the menu, a checkout without the footer.",
-      "additionalProperties": false,
-      "properties": {
-        "header": {
-          "type": "string",
-          "enum": [
-            "default",
-            "transparent",
-            "hidden"
-          ]
-        },
-        "footer": {
-          "type": "string",
-          "enum": [
-            "default",
-            "minimal",
-            "hidden"
-          ]
-        }
-      }
-    },
-    "motion": {
-      "$ref": "#/$defs/MotionLevel",
-      "description": "Overrides the site's motion level for this page, up or down (RFC-0024 §1); absent follows the site."
-    },
-    "rev": {
-      "$ref": "#/$defs/Revision"
-    },
-    "createdAt": {
-      "$ref": "#/$defs/Timestamp"
-    },
-    "updatedAt": {
-      "$ref": "#/$defs/Timestamp"
-    },
-    "translation": {
-      "$ref": "#/$defs/Translation"
-    },
-    "metadata": {
-      "$ref": "#/$defs/Metadata"
-    }
-  },
-  "$defs": {
-    "Actor": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "kind",
-        "id"
-      ],
-      "properties": {
-        "kind": {
-          "$ref": "#/$defs/ActorKind"
-        },
-        "id": {
-          "$ref": "#/$defs/Id"
-        },
-        "name": {
-          "type": "string",
-          "maxLength": 200
-        }
-      }
-    },
-    "ActorKind": {
-      "type": "string",
-      "description": "Who performed an action. Humans and agents share one actor model so the policy engine treats them uniformly.",
-      "enum": [
-        "human",
-        "agent",
-        "system"
-      ]
-    },
-    "Availability": {
-      "type": "object",
-      "description": "Time gates of a page or content entry (RFC-0008): the published site shows the node only from `from` (inclusive: an embargo) until `until` (exclusive: an expiry), checked at render time, so the gates hold even when no scheduler runs. Before `from` and from `until` on, the node is absent from every public route, list, feed, sitemap and search output; previews still show it. At least one gate; writers check that `from` is before `until`.",
-      "additionalProperties": false,
-      "minProperties": 1,
-      "properties": {
-        "from": {
-          "$ref": "#/$defs/Timestamp"
-        },
-        "until": {
-          "$ref": "#/$defs/Timestamp"
-        }
-      }
-    },
-    "BodyBlock": {
-      "type": "object",
-      "description": "One top-level block of a markdown body in the store's index (RFC-0014 §3). Written by the store only: a client's values are replaced on every write. `by`, `via` and `at` say who last changed the block's content, through which channel and when; they are absent for content written before the index existed.",
-      "additionalProperties": false,
-      "required": [
-        "id",
-        "hash"
-      ],
-      "properties": {
-        "id": {
-          "type": "string",
-          "pattern": "^blk_[0-9A-Za-z]{8,24}$",
-          "description": "Stable across writes that keep the block's content or its place among unchanged blocks."
-        },
-        "hash": {
-          "type": "string",
-          "pattern": "^[0-9a-f]{64}$",
-          "description": "SHA-256 (hex) of the block's markdown without trailing whitespace."
-        },
-        "by": {
-          "$ref": "#/$defs/Actor"
-        },
-        "via": {
-          "type": "string",
-          "enum": [
-            "studio",
-            "mcp",
-            "api",
-            "import",
-            "ai-command",
-            "proposal"
-          ],
-          "description": "The channel of that change."
-        },
-        "at": {
-          "$ref": "#/$defs/Timestamp"
-        }
-      }
-    },
-    "BodyBlocks": {
-      "type": "array",
-      "description": "A markdown body's block index, in body order (RFC-0014 §3). Absent means not indexed (yet, or an HTML body), never empty.",
-      "maxItems": 5000,
-      "items": {
-        "$ref": "#/$defs/BodyBlock"
-      }
-    },
-    "BodyProfile": {
-      "type": "integer",
-      "enum": [
-        1
-      ],
-      "description": "The markdown dialect a body follows (RFC-0014 §1): 1 = Cloudhal Markdown v1 (CommonMark + GFM + `asset:` + directives; raw HTML escaped). Set by the store on markdown bodies."
-    },
-    "Id": {
-      "type": "string",
-      "description": "Prefixed, URL-safe identifier, e.g. site_01HZX8K3Q9. The prefix names the entity kind; agents and the MCP server pass these as opaque handles.",
-      "pattern": "^[a-z]+_[A-Za-z0-9]{6,32}$",
-      "minLength": 8,
-      "maxLength": 48
-    },
-    "ImageRef": {
-      "type": "object",
-      "description": "Reference to an image. With `assetId` the image is an Asset node (RFC-0004): the store writes its media URL into `src`, and its size into `width` and `height`, as a fallback for readers that do not resolve assets. Without it, `src` is a relative path or an absolute URL, as before.",
-      "additionalProperties": false,
-      "required": [
-        "src",
-        "alt"
-      ],
-      "properties": {
-        "assetId": {
-          "$ref": "#/$defs/Id",
-          "description": "The Asset node shown (RFC-0004). Renderers that know assets resolve it and ignore `src`."
-        },
-        "src": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 2048
-        },
-        "alt": {
-          "type": "string",
-          "maxLength": 500
-        },
-        "width": {
-          "type": "integer",
-          "minimum": 1
-        },
-        "height": {
-          "type": "integer",
-          "minimum": 1
-        }
-      }
-    },
-    "Link": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "label",
-        "href"
-      ],
-      "properties": {
-        "label": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 200
-        },
-        "href": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 2048
-        },
-        "external": {
-          "type": "boolean"
-        }
-      }
-    },
-    "Locale": {
-      "type": "string",
-      "description": "BCP 47 language tag, e.g. en, tr, en-US.",
-      "pattern": "^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
-    },
-    "Metadata": {
-      "type": "object",
-      "description": "Free-form string-to-string map for extensions. Keys should be namespaced (e.g. cloudhal.source).",
-      "additionalProperties": {
-        "type": "string"
-      }
-    },
-    "MotionLevel": {
-      "type": "string",
-      "description": "How much a page may move (RFC-0024 §1); the reader's reduced-motion preference and pause control can only lower it.",
-      "enum": [
-        "none",
-        "subtle",
-        "standard",
-        "expressive"
-      ]
-    },
-    "PublishStatus": {
-      "type": "string",
-      "description": "Editorial lifecycle of a page or content entry.",
-      "enum": [
-        "draft",
-        "review",
-        "published",
-        "archived"
-      ]
-    },
-    "Revision": {
-      "type": "integer",
-      "description": "Monotonic per-node revision used for optimistic locking (compare-and-swap on write).",
-      "minimum": 0
-    },
-    "SchemaVersion": {
-      "type": "integer",
-      "description": "Version of this contract. Readers reject unknown versions; migrations move documents forward one version at a time.",
-      "enum": [
-        1
-      ]
-    },
-    "Section": {
-      "title": "Section",
-      "description": "A block inside a page, discriminated by `kind`. Variants are written inline (not via $ref) and `kind` is a single-value string enum so that TypeScript gets a literal union and Rust gets a serde internally-tagged enum.",
-      "oneOf": [
-        {
-          "type": "object",
-          "title": "HeroSection",
-          "additionalProperties": false,
-          "required": [
-            "id",
-            "kind",
-            "heading"
-          ],
-          "properties": {
-            "id": {
-              "$ref": "#/$defs/Id"
-            },
-            "kind": {
-              "type": "string",
-              "enum": [
-                "hero"
-              ]
-            },
-            "heading": {
-              "type": "string",
-              "minLength": 1,
-              "maxLength": 300
-            },
-            "subheading": {
-              "type": "string",
-              "maxLength": 1000
-            },
-            "image": {
-              "$ref": "#/$defs/ImageRef"
-            },
-            "cta": {
-              "$ref": "#/$defs/Link"
-            }
-          }
-        },
-        {
-          "type": "object",
-          "title": "RichTextSection",
-          "additionalProperties": false,
-          "required": [
-            "id",
-            "kind",
-            "format",
-            "body"
-          ],
-          "properties": {
-            "id": {
-              "$ref": "#/$defs/Id"
-            },
-            "kind": {
-              "type": "string",
-              "enum": [
-                "richText"
-              ]
-            },
-            "format": {
-              "type": "string",
-              "enum": [
-                "markdown",
-                "html"
-              ]
-            },
-            "body": {
-              "type": "string",
-              "maxLength": 200000
-            },
-            "profile": {
-              "$ref": "#/$defs/BodyProfile"
-            },
-            "blocks": {
-              "$ref": "#/$defs/BodyBlocks"
-            }
-          }
-        },
-        {
-          "type": "object",
-          "title": "ImageSection",
-          "additionalProperties": false,
-          "required": [
-            "id",
-            "kind",
-            "image"
-          ],
-          "properties": {
-            "id": {
-              "$ref": "#/$defs/Id"
-            },
-            "kind": {
-              "type": "string",
-              "enum": [
-                "image"
-              ]
-            },
-            "image": {
-              "$ref": "#/$defs/ImageRef"
-            },
-            "caption": {
-              "type": "string",
-              "maxLength": 1000
-            }
-          }
-        },
-        {
-          "type": "object",
-          "title": "ContentListSection",
-          "description": "Renders the newest entries of a content collection (e.g. blog posts).",
-          "additionalProperties": false,
-          "required": [
-            "id",
-            "kind",
-            "collection",
-            "limit",
-            "sort"
-          ],
-          "properties": {
-            "id": {
-              "$ref": "#/$defs/Id"
-            },
-            "kind": {
-              "type": "string",
-              "enum": [
-                "contentList"
-              ]
-            },
-            "collection": {
-              "$ref": "#/$defs/Slug"
-            },
-            "limit": {
-              "type": "integer",
-              "minimum": 1,
-              "maximum": 100
-            },
-            "sort": {
-              "type": "string",
-              "enum": [
-                "newest",
-                "oldest",
-                "title"
-              ]
-            },
-            "filter": {
-              "type": "string",
-              "description": "Filter expression over term assignments (RFC-0002), e.g. 'category:news+tag:ai' or 'category:news>*'.",
-              "minLength": 1,
-              "maxLength": 512
-            }
-          }
-        },
-        {
-          "type": "object",
-          "title": "ComponentSection",
-          "description": "A typed block from the block registry (RFC-0015): `type` names a registered block type (one global namespace of English names), `props` follow that type's props schema, which the store validates.",
-          "additionalProperties": false,
-          "required": [
-            "id",
-            "kind",
-            "type",
-            "props"
-          ],
-          "properties": {
-            "id": {
-              "$ref": "#/$defs/Id"
-            },
-            "kind": {
-              "type": "string",
-              "enum": [
-                "component"
-              ]
-            },
-            "type": {
-              "type": "string",
-              "pattern": "^[a-z][a-z0-9-]{1,40}$"
-            },
-            "props": {
-              "type": "object",
-              "description": "Validated against the type's props schema by the store, not by this contract.",
-              "additionalProperties": true
-            }
-          }
-        },
-        {
-          "type": "object",
-          "title": "SurfaceSection",
-          "description": "A generative UI surface (RFC-0020): a flat list of catalog components with a `root`, plus a data model their props may bind to. Written and streamed by agents as data, never code; the store checks the tree, the catalog and the limits.",
-          "additionalProperties": false,
-          "required": [
-            "id",
-            "kind",
-            "catalog",
-            "components"
-          ],
-          "properties": {
-            "id": {
-              "$ref": "#/$defs/Id"
-            },
-            "kind": {
-              "type": "string",
-              "enum": [
-                "surface"
-              ]
-            },
-            "catalog": {
-              "type": "string",
-              "description": "The catalog the surface was written for: `<theme>@<major>` (RFC-0018 manifest).",
-              "pattern": "^[a-z][a-z0-9-]{0,40}@[0-9]{1,4}$"
-            },
-            "components": {
-              "type": "array",
-              "minItems": 1,
-              "maxItems": 200,
-              "items": {
-                "$ref": "#/$defs/SurfaceComponent"
-              }
-            },
-            "data": {
-              "type": "object",
-              "description": "The surface's data model: JSON its components bind to with `{path}` (at most 64 KB serialized; the store enforces the size).",
-              "additionalProperties": true
-            }
-          }
-        }
-      ]
-    },
-    "Seo": {
-      "type": "object",
-      "description": "Search and social metadata of a routable node (page, term archive).",
-      "additionalProperties": false,
-      "properties": {
-        "title": {
-          "type": "string",
-          "maxLength": 300
-        },
-        "description": {
-          "type": "string",
-          "maxLength": 500
-        },
-        "noindex": {
-          "type": "boolean"
-        },
-        "canonical": {
-          "type": "string",
-          "maxLength": 2048
-        },
-        "ogImage": {
-          "$ref": "#/$defs/ImageRef"
-        }
-      }
-    },
-    "Slug": {
-      "type": "string",
-      "description": "Lower-case URL segment.",
-      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
-      "minLength": 1,
-      "maxLength": 128
-    },
-    "SurfaceComponent": {
-      "type": "object",
-      "description": "One element of a generative UI surface (RFC-0020 §1), in a flat list: `component` names a catalog entry (a PascalCase built-in primitive such as `Stack`, or a registry block type such as `callout`), `children` refer to other ids of the same surface, and `props` follow the entry's schema, which the store checks. Field names follow A2UI v0.9.",
-      "additionalProperties": false,
-      "required": [
-        "id",
-        "component"
-      ],
-      "properties": {
-        "id": {
-          "$ref": "#/$defs/SurfaceComponentId"
-        },
-        "component": {
-          "type": "string",
-          "pattern": "^(?:[A-Z][A-Za-z0-9]{1,40}|[a-z][a-z0-9-]{1,40})$"
-        },
-        "children": {
-          "type": "array",
-          "maxItems": 200,
-          "items": {
-            "$ref": "#/$defs/SurfaceComponentId"
-          }
-        },
-        "props": {
-          "type": "object",
-          "description": "Literal values, `{path}` bindings into the surface's data, or `{call}` named functions; validated by the store against the catalog, not by this contract.",
-          "additionalProperties": true
-        },
-        "visible": {
-          "type": "object",
-          "description": "A visibility condition over the surface's data (`eq`, `ne`, `gt`, `lt`, `and`, `or`, `not`); validated by the store.",
-          "additionalProperties": true
-        },
-        "motion": {
-          "type": "object",
-          "description": "Motion presets for this component (RFC-0024 §2): `reveal`, `hover`, `speed`, `delay`, `stagger`, `replay` and later `scroll`, `loop`; enums and clamped numbers only, validated by the store against the catalog. The renderer turns them into CSS; agents never write CSS.",
-          "additionalProperties": true
-        }
-      }
-    },
-    "SurfaceComponentId": {
-      "type": "string",
-      "description": "A component's id, unique within its surface; `root` is the tree's root (RFC-0020 §1).",
-      "pattern": "^[a-z][a-z0-9-]{0,40}$"
-    },
-    "Timestamp": {
-      "type": "string",
-      "description": "RFC 3339 / ISO 8601 instant in UTC.",
-      "format": "date-time"
-    },
-    "Translation": {
-      "type": "object",
-      "description": "Links a page or entry to the other language versions of the same work (RFC-0033 §2). Staleness is computed: the source's current hash differs from source.hash.",
-      "additionalProperties": false,
-      "required": [
-        "group",
-        "method"
-      ],
-      "properties": {
-        "group": {
-          "$ref": "#/$defs/Id",
-          "description": "The group's id: the original node's id, shared by every translation. May cross sites in one project."
-        },
-        "method": {
-          "$ref": "#/$defs/TranslationMethod"
-        },
-        "layout": {
-          "type": "string",
-          "description": "linked: the original's structural changes propagate to this translation as drafts (RFC-0033 §4a); independent: nothing propagates. Absent means linked.",
-          "enum": [
-            "linked",
-            "independent"
-          ]
-        },
-        "source": {
-          "type": "object",
-          "description": "The node and revision this translation was made from. Absent on the original.",
-          "additionalProperties": false,
-          "required": [
-            "id",
-            "locale",
-            "rev",
-            "hash"
-          ],
-          "properties": {
-            "id": {
-              "$ref": "#/$defs/Id"
-            },
-            "siteId": {
-              "$ref": "#/$defs/Id",
-              "description": "The source's site when it is another site of the same project (a language edition). Absent means this site."
-            },
-            "locale": {
-              "$ref": "#/$defs/Locale"
-            },
-            "rev": {
-              "$ref": "#/$defs/Revision"
-            },
-            "hash": {
-              "type": "string",
-              "description": "Lower-case hex SHA-256 of the source node's canonical JSON at that revision.",
-              "pattern": "^[0-9a-f]{64}$"
-            }
-          }
-        },
-        "provenance": {
-          "type": "object",
-          "description": "The machine-translation record: engine, glossary revision, checks run, quality score. Required when method is machine or machine-reviewed.",
-          "additionalProperties": false,
-          "required": [
-            "engine",
-            "at"
-          ],
-          "properties": {
-            "engine": {
-              "type": "string",
-              "minLength": 1,
-              "maxLength": 200
-            },
-            "glossaryRev": {
-              "$ref": "#/$defs/Revision"
-            },
-            "score": {
-              "type": "number",
-              "minimum": 0,
-              "maximum": 100
-            },
-            "checks": {
-              "type": "array",
-              "items": {
-                "type": "string",
-                "minLength": 1,
-                "maxLength": 100
-              },
-              "maxItems": 50
-            },
-            "at": {
-              "$ref": "#/$defs/Timestamp"
-            }
-          }
-        },
-        "review": {
-          "type": "object",
-          "description": "The person who reviewed this translation and when. Only humans set it.",
-          "additionalProperties": false,
-          "required": [
-            "by",
-            "at"
-          ],
-          "properties": {
-            "by": {
-              "$ref": "#/$defs/Actor"
-            },
-            "at": {
-              "$ref": "#/$defs/Timestamp"
-            }
-          }
-        }
-      }
-    },
-    "TranslationMethod": {
-      "type": "string",
-      "description": "How a page's or entry's text came to be (RFC-0033). 'original' marks the source of a translation group; 'machine-reviewed' is machine output a person has reviewed.",
-      "enum": [
-        "original",
-        "human",
-        "machine",
-        "machine-reviewed"
-      ]
-    }
-  }
-}