@oim-media/spec 1.27.9 → 1.27.10

package/CANONICAL_SPEC.md

@@ -1,6 +1,6 @@
 # OIM (Object Interactive Media) Canonical Metadata Specification
 
-**Contract version:** 1.27.9  
+**Contract version:** 1.27.10  
 **Date:** 2026-11-02 (reviewed against `packages/core/src/schema.ts`; the source of truth is the schema, this document summarises it)  
 **Status:** Normative / In force  
 **License:** Apache-2.0  
@@ -333,7 +333,7 @@ Top-level structure carried in the `OIM_Data` payload:
 
 | Key | Type | Description |
 |---|---|---|
-| `oim` | `string` | Format version of the document (e.g. `"1.27.9"`), the contract version the backend signs against. |
+| `oim` | `string` | Format version of the document (e.g. `"1.27.10"`), the contract version the backend signs against. |
 | `min_player` | `string` | Minimum player version required to rebuild the document (`minVersionFor`). |
 | `oim_id` | `string` | Unique document identifier for re-editing and registry checks (max 128 chars). |
 | `media_type` | `"image" \| "video"` | Media type of the OIM document. |
@@ -346,7 +346,7 @@ Top-level structure carried in the `OIM_Data` payload:
 | `palettes` | `Record<string, Partial<Record<DynamicColorRole, string>>>` | Up to 6 named colour palettes mapping semantic roles to CSS colours (1.20.0). |
 | `defaultPalette` | `string` | Name of the active palette in `palettes` (1.20.0). |
 | `slots` | `OimSlot[]` | Array of interactive layers (maximum `MAX_SLOTS` = 150). |
-| `zones` | `OimZone[]` | Optional catalogue of named bounding box zones. |
+| `zones` | `OimZone[]` | Optional catalogue of named bounding box zones. A zone paints its background, corners and backdrop blur; its layers keep their own position. Flow properties in its style (`display`, `flexDirection`, `justifyContent`, `alignItems`, `gap`, `padding`) are not applied. |
 | `capabilities` | `("vector_parallax" \| "infinite_parallax" \| "text_marks" \| "image_fill" \| "media_filters" \| "frame_shapes")[]` | Capabilities used by the document. |
 | `capabilities_required` | same as `capabilities` | Capabilities the reader **must** implement to paint with fidelity (glTF pattern). |
 | `fonts` | `EmbeddedFont[]` | Font variants embedded in base64 for offline rendering (1.3.0): subset, static (no `fvar`, `gvar`, `avar`, `HVAR`, `MVAR`; `STAT` may stay) WOFF, `format: "woff"`, written since 1.27.0; WOFF2 (`format: "woff2"`) is read forever. The content starts with the magic of its format (`wOFF` / `wOF2`). |

package/README.md

@@ -11,7 +11,8 @@ schema/             oim.schema.json and ovm.schema.json: JSON Schema, generated
 keys.json           Public keys every player embeds (kid, jwk and key dates). Public parts only.
 marks-cases.json    Known-answer cases for text marks, shared with the backend's validator tests.
 canonical-cases.json  Known-answer case for the canonical form, checked by the TypeScript, Rust and Dart implementations.
-vectors/            37 signed .oim files, each with <name>.expected.json.
+schema/oim2.schema.json  Draft of the 2.0 document, generated from @oim-media/core/v2. Not the published format.
+vectors/            39 signed .oim files, each with <name>.expected.json.
 tools/              Read-only checks: contract-summary.mjs, canonical-check.mjs, style-usage.mjs.
 ```
 
@@ -268,9 +269,20 @@ overrides all of them.
 A 1.20.0 file read by an earlier player is shown with each layer's fixed
 colours. Nothing breaks.
 
+## The 2.0 draft
+
+`schema/oim2.schema.json` is the next version of the document, still a draft: no player reads it and
+it can change. `@oim-media/core/v2` exports `upgrade`, which reads any 1.x document as 2.0, and the
+conformance gate checks that every vector upgrades to a valid 2.0 document with no key left behind.
+
+```
+node tools/upgrade-report.mjs --vectors   # the same check, as a report
+node tools/upgrade-report.mjs <folder>    # over any other folder of .oim files
+```
+
 ## Conformance vectors
 
-`vectors/` holds 37 signed `.oim` files and their expected reads. They are
+`vectors/` holds 39 signed `.oim` files and their expected reads. They are
 generated by Xue Studios' signing service through the production pipeline and
 committed to this repository; the generator itself is not part of it. See
 [`vectors/README.md`](vectors/README.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oim-media/spec",
-  "version": "1.27.9",
+  "version": "1.27.10",
   "description": "OIM format contract: JSON Schema, normative specification and conformance vectors that every OIM player must pass.",
   "keywords": [
     "oim",

package/schema/oim.schema.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://oim.media/spec/1.27.9/oim.schema.json",
+  "$id": "https://oim.media/spec/1.27.10/oim.schema.json",
   "title": "OIM document metadata",
-  "specVersion": "1.27.9",
+  "specVersion": "1.27.10",
   "type": "object",
   "properties": {
     "description": {