@openpresentation/opf 0.2.2 → 0.4.0

package/dist/spec/schemas/layout-preview-index.schema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openpresentation.org/schema/opf-layout-preview-index/v1",
+  "title": "Layout Preview Index",
+  "description": "Shape of `spec/previews/layouts/index.json`, the manifest for the vendored slide-archetype preview gallery under `spec/previews/layouts/`. Each record names a preview id, its self-contained HTML file, and the file's exact UTF-8 byte length. These preview ids are an archetype taxonomy (e.g. 'swot-analysis', 'org-chart') distinct from the structural layout catalog at spec/catalogs/layouts/ (e.g. 'title', 'chart-2x') — see spec/README.md. This schema describes a repo-internal index file, not an OPF document or a catalog record; it is intentionally excluded from the package's published/typed schema surface.",
+  "type": "object",
+  "required": ["$schema", "version", "description", "records"],
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "const": "https://openpresentation.org/schema/opf-layout-preview-index/v1"
+    },
+    "version": {
+      "type": "string",
+      "description": "Index format version, as a string.",
+      "examples": ["1"]
+    },
+    "description": {
+      "type": "string",
+      "description": "Human-readable description of the preview gallery and its rendering conventions."
+    },
+    "records": {
+      "type": "array",
+      "description": "One entry per vendored preview HTML file.",
+      "items": { "$ref": "#/$defs/PreviewRecord" }
+    }
+  },
+  "$defs": {
+    "PreviewRecord": {
+      "type": "object",
+      "description": "Summary of one vendored preview HTML file.",
+      "required": ["id", "file", "bytes"],
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Slide-archetype preview id (e.g. 'swot-analysis', 'agenda', 'org-chart'). Does not correspond to a spec/catalogs/layouts/ record id.",
+          "pattern": "^[a-z][a-z0-9-]*$"
+        },
+        "file": {
+          "type": "string",
+          "description": "HTML filename, relative to this index file's directory.",
+          "pattern": "^[^/]+\\.html$"
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Exact UTF-8 byte length of the referenced HTML file's contents."
+        }
+      }
+    }
+  }
+}

package/dist/spec/schemas/layout.schema.json

@@ -247,6 +247,9 @@
           ]
         }
       }
+    },
+    "composition": {
+      "$ref": "#/$defs/Composition"
     }
   },
   "$defs": {
@@ -275,6 +278,66 @@
           "description": "OPF placeholder kind. 'text' and 'list' are flexible textual content regions. The named kinds describe a specific content role used by pickers, AI generation, and engine defaulting."
         }
       }
+    },
+    "Composition": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Portable dynamic composition. Slide fields override the resolved layout. Nested groups arrange their children independently, inheriting only minFontSize and overflow. Explicit promoted regions retain their positions.",
+      "properties": {
+        "mode": {
+          "type": "string",
+          "enum": [
+            "auto",
+            "grid",
+            "row",
+            "column"
+          ],
+          "description": "auto chooses a grid from available space and content; grid uses columns; row and column use one horizontal or vertical track."
+        },
+        "columns": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 12,
+          "description": "Column count for grid. In auto mode this caps the number of columns."
+        },
+        "gap": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 0.1,
+          "description": "Space between cells as a fraction of the container short edge (canvas at slide root). Default 0.03333333333333333."
+        },
+        "padding": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 0.2,
+          "description": "Inset as a fraction of the container short edge. Default 0.08 on a slide, 0 inside a group."
+        },
+        "weights": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 12,
+          "items": {
+            "type": "number",
+            "exclusiveMinimum": 0,
+            "maximum": 100
+          },
+          "description": "Relative track sizes: columns for row/grid/auto, rows for column. Omitted tracks have weight 1; extra weights are ignored."
+        },
+        "minFontSize": {
+          "type": "number",
+          "minimum": 8,
+          "maximum": 32,
+          "description": "Minimum readable text size in reference pixels at a 720-pixel canvas short edge. Default 16. Overflow is diagnosed when text cannot fit at this size."
+        },
+        "overflow": {
+          "type": "string",
+          "enum": [
+            "warn",
+            "error"
+          ],
+          "description": "warn returns diagnostics for content that does not fit; error rejects layout. Content is never silently removed. Default warn."
+        }
+      }
     }
   }
 }

package/dist/spec/schemas/opf.schema.json

@@ -1808,17 +1808,21 @@
         "hidden": {
           "type": "boolean",
           "description": "Whether the slide is hidden from the presented sequence."
+        },
+        "composition": {
+          "$ref": "#/$defs/Composition"
         }
       }
     },
     "ContentPayload": {
       "type": "object",
-      "description": "A single content payload. The optional 'type' discriminator can make intent explicit, but validators and engines infer it from fields such as text, bullets, items, image, video, chart, table, code, metric, quote, or timeline.",
+      "description": "A content leaf or recursively composed group. A group contains blocks and optional composition; it cannot mix blocks with leaf payload fields. Groups may nest up to 32 levels.",
       "additionalProperties": false,
       "properties": {
         "type": {
           "type": "string",
-          "enum": ["text", "list", "image", "chart", "table", "video", "code", "metric", "quote", "timeline"],
+          "enum": ["text", "list", "image", "chart", "table", "video", "code", "metric", "quote", "timeline",
+            "group"],
           "description": "Optional content kind. When omitted, engines infer the kind from the fields present."
         },
         "text": {
@@ -1950,6 +1954,18 @@
               ]
             }
           ]
+        },
+        "blocks": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/ContentPayload"
+          },
+          "description": "Ordered children of a group. Each child is a leaf or another group."
+        },
+        "composition": {
+          "$ref": "#/$defs/Composition",
+          "description": "Arrangement within this group. Only minFontSize and overflow inherit from the parent; strict overflow cannot be weakened."
         }
       },
       "allOf": [
@@ -2033,6 +2049,108 @@
           "then": {
             "required": ["timeline"]
           }
+        },
+        {
+          "if": {
+            "required": [
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "const": "group"
+              }
+            }
+          },
+          "then": {
+            "required": [
+              "blocks"
+            ]
+          }
+        },
+        {
+          "if": {
+            "required": [
+              "composition"
+            ]
+          },
+          "then": {
+            "required": [
+              "blocks"
+            ]
+          }
+        },
+        {
+          "if": {
+            "required": [
+              "blocks"
+            ]
+          },
+          "then": {
+            "properties": {
+              "type": {
+                "const": "group"
+              }
+            },
+            "not": {
+              "anyOf": [
+                {
+                  "required": [
+                    "text"
+                  ]
+                },
+                {
+                  "required": [
+                    "items"
+                  ]
+                },
+                {
+                  "required": [
+                    "bullets"
+                  ]
+                },
+                {
+                  "required": [
+                    "image"
+                  ]
+                },
+                {
+                  "required": [
+                    "video"
+                  ]
+                },
+                {
+                  "required": [
+                    "chart"
+                  ]
+                },
+                {
+                  "required": [
+                    "table"
+                  ]
+                },
+                {
+                  "required": [
+                    "code"
+                  ]
+                },
+                {
+                  "required": [
+                    "metric"
+                  ]
+                },
+                {
+                  "required": [
+                    "quote"
+                  ]
+                },
+                {
+                  "required": [
+                    "timeline"
+                  ]
+                }
+              ]
+            }
+          }
         }
       ]
     },
@@ -2314,7 +2432,8 @@
             },
             "fontSize": {
               "type": "number",
-              "description": "Run font size in points."
+              "exclusiveMinimum": 0,
+              "description": "Requested run font size in points."
             },
             "fontFamily": {
               "type": "string",
@@ -2538,6 +2657,66 @@
         "pkg:@acme/decks/narratives",
         "pkg:pptx-gallery"
       ]
+    },
+    "Composition": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Portable dynamic composition. Slide fields override the resolved layout. Nested groups arrange their children independently, inheriting only minFontSize and overflow. Explicit promoted regions retain their positions.",
+      "properties": {
+        "mode": {
+          "type": "string",
+          "enum": [
+            "auto",
+            "grid",
+            "row",
+            "column"
+          ],
+          "description": "auto chooses a grid from available space and content; grid uses columns; row and column use one horizontal or vertical track."
+        },
+        "columns": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 12,
+          "description": "Column count for grid. In auto mode this caps the number of columns."
+        },
+        "gap": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 0.1,
+          "description": "Space between cells as a fraction of the container short edge (canvas at slide root). Default 0.03333333333333333."
+        },
+        "padding": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 0.2,
+          "description": "Inset as a fraction of the container short edge. Default 0.08 on a slide, 0 inside a group."
+        },
+        "weights": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 12,
+          "items": {
+            "type": "number",
+            "exclusiveMinimum": 0,
+            "maximum": 100
+          },
+          "description": "Relative track sizes: columns for row/grid/auto, rows for column. Omitted tracks have weight 1; extra weights are ignored."
+        },
+        "minFontSize": {
+          "type": "number",
+          "minimum": 8,
+          "maximum": 32,
+          "description": "Minimum readable text size in reference pixels at a 720-pixel canvas short edge. Default 16. Overflow is diagnosed when text cannot fit at this size."
+        },
+        "overflow": {
+          "type": "string",
+          "enum": [
+            "warn",
+            "error"
+          ],
+          "description": "warn returns diagnostics for content that does not fit; error rejects layout. Content is never silently removed. Default warn."
+        }
+      }
     }
   }
 }