@cloudhal/core-contracts 0.3.4 → 0.3.5

package/schemas/.bundled/content-entry.schema.json

@@ -1,514 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://cloudhal.dev/schemas/v1/content-entry.schema.json",
-  "title": "ContentEntry",
-  "description": "A structured content item in a named collection (e.g. collection 'posts'). Core fields are typed; collection-specific fields live in `fields` and are validated by the collection's own schema in a later phase.",
-  "type": "object",
-  "additionalProperties": false,
-  "required": [
-    "schemaVersion",
-    "id",
-    "siteId",
-    "collection",
-    "slug",
-    "locale",
-    "status",
-    "title",
-    "body",
-    "fields",
-    "tags",
-    "author",
-    "rev",
-    "createdAt",
-    "updatedAt"
-  ],
-  "properties": {
-    "schemaVersion": {
-      "$ref": "#/$defs/SchemaVersion"
-    },
-    "id": {
-      "$ref": "#/$defs/Id"
-    },
-    "siteId": {
-      "$ref": "#/$defs/Id"
-    },
-    "collection": {
-      "$ref": "#/$defs/Slug"
-    },
-    "slug": {
-      "$ref": "#/$defs/Slug"
-    },
-    "locale": {
-      "$ref": "#/$defs/Locale"
-    },
-    "status": {
-      "$ref": "#/$defs/PublishStatus"
-    },
-    "title": {
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 300
-    },
-    "summary": {
-      "type": "string",
-      "maxLength": 2000
-    },
-    "body": {
-      "$ref": "#/$defs/Body"
-    },
-    "fields": {
-      "type": "object",
-      "description": "Collection-specific values; any JSON.",
-      "additionalProperties": true
-    },
-    "tags": {
-      "type": "array",
-      "description": "Deprecated by RFC-0002: use `terms.tag`. Still accepted on input for one release and translated into terms; the store then writes []. Removed in schemaVersion 2.",
-      "deprecated": true,
-      "items": {
-        "$ref": "#/$defs/Slug"
-      },
-      "uniqueItems": true,
-      "maxItems": 50
-    },
-    "terms": {
-      "type": "object",
-      "description": "Term assignments by taxonomy key (e.g. 'category', 'tag'). Terms are referenced by id, independent of locale. A taxonomy without terms is omitted, never an empty object.",
-      "propertyNames": {
-        "$ref": "#/$defs/Slug"
-      },
-      "minProperties": 1,
-      "maxProperties": 10,
-      "additionalProperties": {
-        "$ref": "#/$defs/TermAssignment"
-      }
-    },
-    "author": {
-      "$ref": "#/$defs/Actor"
-    },
-    "coverImage": {
-      "$ref": "#/$defs/ImageRef"
-    },
-    "publishedAt": {
-      "$ref": "#/$defs/Timestamp"
-    },
-    "availability": {
-      "$ref": "#/$defs/Availability"
-    },
-    "rev": {
-      "$ref": "#/$defs/Revision"
-    },
-    "createdAt": {
-      "$ref": "#/$defs/Timestamp"
-    },
-    "updatedAt": {
-      "$ref": "#/$defs/Timestamp"
-    },
-    "translation": {
-      "$ref": "#/$defs/Translation"
-    },
-    "metadata": {
-      "$ref": "#/$defs/Metadata"
-    },
-    "corrections": {
-      "type": "array",
-      "description": "Corrections, clarifications and updates appended to the entry, oldest first (RFC-0019 §2). The store stamps `at`; an item that has been live can no longer be removed, and only a person may edit its note.",
-      "items": {
-        "$ref": "#/$defs/Correction"
-      },
-      "maxItems": 100
-    }
-  },
-  "$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"
-        }
-      }
-    },
-    "Body": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "format",
-        "value"
-      ],
-      "properties": {
-        "format": {
-          "type": "string",
-          "enum": [
-            "markdown",
-            "html"
-          ]
-        },
-        "value": {
-          "type": "string",
-          "maxLength": 1000000
-        },
-        "profile": {
-          "$ref": "#/$defs/BodyProfile"
-        },
-        "blocks": {
-          "$ref": "#/$defs/BodyBlocks"
-        }
-      }
-    },
-    "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."
-    },
-    "Correction": {
-      "type": "object",
-      "description": "One correction notice (RFC-0019 §2).",
-      "additionalProperties": false,
-      "required": [
-        "id",
-        "kind",
-        "at",
-        "note"
-      ],
-      "properties": {
-        "id": {
-          "$ref": "#/$defs/Id"
-        },
-        "kind": {
-          "type": "string",
-          "enum": [
-            "correction",
-            "clarification",
-            "update"
-          ]
-        },
-        "at": {
-          "$ref": "#/$defs/Timestamp",
-          "description": "When it was written; set by the store, never by the caller."
-        },
-        "note": {
-          "type": "string",
-          "description": "What changed, in markdown (inline).",
-          "minLength": 1,
-          "maxLength": 2000
-        },
-        "snapshotId": {
-          "$ref": "#/$defs/Id",
-          "description": "The snapshot it was first published in."
-        }
-      }
-    },
-    "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
-        }
-      }
-    },
-    "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"
-      }
-    },
-    "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
-      ]
-    },
-    "Slug": {
-      "type": "string",
-      "description": "Lower-case URL segment.",
-      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
-      "minLength": 1,
-      "maxLength": 128
-    },
-    "TermAssignment": {
-      "type": "object",
-      "description": "Terms of one taxonomy on one entry, in display order. The primary term is explicit and never derived from the order.",
-      "additionalProperties": false,
-      "required": [
-        "ids"
-      ],
-      "properties": {
-        "ids": {
-          "type": "array",
-          "items": {
-            "$ref": "#/$defs/Id"
-          },
-          "minItems": 1,
-          "maxItems": 50,
-          "uniqueItems": true
-        },
-        "primary": {
-          "$ref": "#/$defs/Id",
-          "description": "The entry's main term in this taxonomy (breadcrumbs, articleSection, later permalinks). Must be one of `ids`."
-        }
-      }
-    },
-    "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"
-      ]
-    }
-  }
-}

package/schemas/.bundled/glossary.schema.json

@@ -1,139 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://cloudhal.dev/schemas/v1/glossary.schema.json",
-  "title": "Glossary",
-  "description": "A site's translation glossary (RFC-0033 §2): terms with their approved translation per locale, and terms never to translate (brand and product names). Agents translating content read it as hard constraints; the checks flag drafts that break it. One per site, snapshotted like every node.",
-  "type": "object",
-  "additionalProperties": false,
-  "required": [
-    "schemaVersion",
-    "id",
-    "siteId",
-    "entries",
-    "rev",
-    "createdAt",
-    "updatedAt"
-  ],
-  "properties": {
-    "schemaVersion": {
-      "$ref": "#/$defs/SchemaVersion"
-    },
-    "id": {
-      "$ref": "#/$defs/Id"
-    },
-    "siteId": {
-      "$ref": "#/$defs/Id"
-    },
-    "entries": {
-      "type": "array",
-      "description": "Unique by term (case-insensitive); order is the editor's.",
-      "items": {
-        "$ref": "#/$defs/GlossaryEntry"
-      },
-      "maxItems": 2000
-    },
-    "rev": {
-      "$ref": "#/$defs/Revision"
-    },
-    "createdAt": {
-      "$ref": "#/$defs/Timestamp"
-    },
-    "updatedAt": {
-      "$ref": "#/$defs/Timestamp"
-    },
-    "metadata": {
-      "$ref": "#/$defs/Metadata"
-    }
-  },
-  "$defs": {
-    "GlossaryEntry": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "term"
-      ],
-      "properties": {
-        "term": {
-          "type": "string",
-          "description": "The term as written in the site's default locale.",
-          "minLength": 1,
-          "maxLength": 200
-        },
-        "note": {
-          "type": "string",
-          "description": "Context for translators and agents: meaning, part of speech, where it appears.",
-          "maxLength": 500
-        },
-        "doNotTranslate": {
-          "type": "boolean",
-          "description": "Keep the term as written in every locale (brand, product or proper names). Such an entry has no translations."
-        },
-        "caseSensitive": {
-          "type": "boolean",
-          "description": "Match the term only with this exact capitalisation."
-        },
-        "translations": {
-          "type": "object",
-          "description": "The approved translation per locale (never the default locale).",
-          "propertyNames": {
-            "$ref": "#/$defs/Locale"
-          },
-          "additionalProperties": {
-            "type": "object",
-            "additionalProperties": false,
-            "required": [
-              "text"
-            ],
-            "properties": {
-              "text": {
-                "type": "string",
-                "minLength": 1,
-                "maxLength": 200
-              },
-              "note": {
-                "type": "string",
-                "maxLength": 500
-              }
-            }
-          }
-        }
-      }
-    },
-    "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
-    },
-    "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"
-      }
-    },
-    "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
-      ]
-    },
-    "Timestamp": {
-      "type": "string",
-      "description": "RFC 3339 / ISO 8601 instant in UTC.",
-      "format": "date-time"
-    }
-  }
-}