@openpresentation/opf 0.2.2 → 0.4.0

package/dist/pagination.d.ts

@@ -0,0 +1,52 @@
+import { LayoutDiagnostic, ComposeSlideOptions, TextMeasurement } from './composition.js';
+
+interface PaginationOptions extends ComposeSlideOptions {
+    /** Readability floor used while choosing page breaks. Default 24 reference pixels. */
+    minFontSize?: number;
+    /** All-or-nothing resource limit. Defaults to 100 output slides. */
+    maxSlides?: number;
+    /** Existing deck IDs to avoid when generating continuation IDs. */
+    reservedIds?: string[];
+}
+interface PaginationMapping {
+    sourcePath: string;
+    outputPath: string;
+    /** Half-open offsets into the original leaf; text offsets use UTF-16. */
+    range?: {
+        unit: 'utf16' | 'items';
+        start: number;
+        end: number;
+    };
+}
+interface PaginatedPage {
+    slideIndex: number;
+    mappings: PaginationMapping[];
+}
+interface PaginationResult {
+    slides: Record<string, any>[];
+    pages: PaginatedPage[];
+}
+declare class OPFPaginationError extends Error {
+    readonly diagnostics: LayoutDiagnostic[];
+    readonly code = "pagination-unresolved";
+    constructor(message: string, diagnostics?: LayoutDiagnostic[]);
+}
+/** Explicit, lossless authoring transform. It never changes slide count during rendering. */
+declare function paginateSlide(input: unknown, options?: PaginationOptions): PaginationResult;
+interface PresentationPaginationOptions {
+    textMeasurement?: TextMeasurement;
+    minFontSize?: number;
+    maxSlides?: number;
+    /** Optional host-resolved layout/canvas overrides for each source slide. */
+    slideOptions?: (slide: Record<string, any>, index: number) => ComposeSlideOptions;
+}
+interface PresentationPaginationResult {
+    presentation: Record<string, any>;
+    pages: (PaginatedPage & {
+        sourceSlideIndex: number;
+    })[];
+}
+/** Resolve local catalogs and paginate a complete presentation without mutating it. */
+declare function paginatePresentation(input: unknown, options?: PresentationPaginationOptions): PresentationPaginationResult;
+
+export { OPFPaginationError, type PaginatedPage, type PaginationMapping, type PaginationOptions, type PaginationResult, type PresentationPaginationOptions, type PresentationPaginationResult, paginatePresentation, paginateSlide };

package/dist/pagination.js

@@ -0,0 +1,5 @@
+export { OPFPaginationError, paginatePresentation, paginateSlide } from './chunk-75N5I6M4.js';
+import './chunk-EMTMQRX4.js';
+import './chunk-HJNJHB5H.js';
+import './chunk-GCXOU5MZ.js';
+import './chunk-TWMRZ43O.js';

package/dist/{validator-MwlR2F56.d.ts → presentation-BjP4yTQ1.d.ts}

@@ -1,13 +1,3 @@
-import { CatalogKind } from './catalogs.js';
-import { SchemaName } from './schemas.js';
-
-type JsonPrimitive = string | number | boolean | null;
-type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
-interface JsonObject {
-    readonly [key: string]: JsonValue;
-}
-type JsonSchema = JsonObject;
-
 /**
  * Inline audience metadata for the presentation. Use 'id' to reference an audiences catalog record and override selected fields, or use 'name' for a custom inline audience.
  *
@@ -315,7 +305,7 @@ type TextRun = (string | {
      */
     color?: string;
     /**
-     * Run font size in points.
+     * Requested run font size in points.
      */
     fontSize?: number;
     /**
@@ -387,7 +377,7 @@ type ChartDataCell = (string | number | boolean | null);
  */
 type TableCell = (string | number | boolean | null);
 /**
- * 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.
+ * 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.
  *
  * This interface was referenced by `Presentation`'s JSON-Schema
  * via the `definition` "ContentPayload".
@@ -398,7 +388,7 @@ type ContentPayload = ({
     /**
      * Optional content kind. When omitted, engines infer the kind from the fields present.
      */
-    type?: ("text" | "list" | "image" | "chart" | "table" | "video" | "code" | "metric" | "quote" | "timeline");
+    type?: ("text" | "list" | "image" | "chart" | "table" | "video" | "code" | "metric" | "quote" | "timeline" | "group");
     /**
      * Text payload. Use a string for plain text or TextRun[] for inline rich text. TextRun items may be plain strings or formatted run objects.
      */
@@ -502,6 +492,13 @@ type ContentPayload = ({
          */
         events: [TimelineEvent, ...(TimelineEvent)[]];
     });
+    /**
+     * Ordered children of a group. Each child is a leaf or another group.
+     *
+     * @minItems 1
+     */
+    blocks?: [ContentPayload, ...(ContentPayload)[]];
+    composition?: Composition;
 });
 /**
  * Catalog source location. Accepts:
@@ -2183,6 +2180,7 @@ interface Slide {
      * Whether the slide is hidden from the presented sequence.
      */
     hidden?: boolean;
+    composition?: Composition1;
 }
 /**
  * Full-slide chart payload. Presence of this field infers type 'chart'.
@@ -2372,6 +2370,42 @@ interface Table1 {
      */
     rows: TableCell[][];
 }
+/**
+ * Arrangement within this group. Only minFontSize and overflow inherit from the parent; strict overflow cannot be weakened.
+ */
+interface Composition {
+    /**
+     * auto chooses a grid from available space and content; grid uses columns; row and column use one horizontal or vertical track.
+     */
+    mode?: ("auto" | "grid" | "row" | "column");
+    /**
+     * Column count for grid. In auto mode this caps the number of columns.
+     */
+    columns?: number;
+    /**
+     * Space between cells as a fraction of the container short edge (canvas at slide root). Default 0.03333333333333333.
+     */
+    gap?: number;
+    /**
+     * Inset as a fraction of the container short edge. Default 0.08 on a slide, 0 inside a group.
+     */
+    padding?: number;
+    /**
+     * Relative track sizes: columns for row/grid/auto, rows for column. Omitted tracks have weight 1; extra weights are ignored.
+     *
+     * @minItems 1
+     * @maxItems 12
+     */
+    weights?: [number] | [number, number] | [number, number, number] | [number, number, number, number] | [number, number, number, number, number] | [number, number, number, number, number, number] | [number, number, number, number, number, number, number] | [number, number, number, number, number, number, number, number] | [number, number, number, number, number, number, number, number, number] | [number, number, number, number, number, number, number, number, number, number] | [number, number, number, number, number, number, number, number, number, number, number] | [number, number, number, number, number, number, number, number, number, number, number, number];
+    /**
+     * 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.
+     */
+    minFontSize?: number;
+    /**
+     * warn returns diagnostics for content that does not fit; error rejects layout. Content is never silently removed. Default warn.
+     */
+    overflow?: ("warn" | "error");
+}
 /**
  * Slide-level design applied on top of the deck-wide design.
  */
@@ -2469,6 +2503,45 @@ interface Design1 {
     listBullet?: ("character" | "image");
     [k: string]: unknown;
 }
+/**
+ * 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.
+ *
+ * This interface was referenced by `Presentation`'s JSON-Schema
+ * via the `definition` "Composition".
+ */
+interface Composition1 {
+    /**
+     * auto chooses a grid from available space and content; grid uses columns; row and column use one horizontal or vertical track.
+     */
+    mode?: ("auto" | "grid" | "row" | "column");
+    /**
+     * Column count for grid. In auto mode this caps the number of columns.
+     */
+    columns?: number;
+    /**
+     * Space between cells as a fraction of the container short edge (canvas at slide root). Default 0.03333333333333333.
+     */
+    gap?: number;
+    /**
+     * Inset as a fraction of the container short edge. Default 0.08 on a slide, 0 inside a group.
+     */
+    padding?: number;
+    /**
+     * Relative track sizes: columns for row/grid/auto, rows for column. Omitted tracks have weight 1; extra weights are ignored.
+     *
+     * @minItems 1
+     * @maxItems 12
+     */
+    weights?: [number] | [number, number] | [number, number, number] | [number, number, number, number] | [number, number, number, number, number] | [number, number, number, number, number, number] | [number, number, number, number, number, number, number] | [number, number, number, number, number, number, number, number] | [number, number, number, number, number, number, number, number, number] | [number, number, number, number, number, number, number, number, number, number] | [number, number, number, number, number, number, number, number, number, number, number] | [number, number, number, number, number, number, number, number, number, number, number, number];
+    /**
+     * 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.
+     */
+    minFontSize?: number;
+    /**
+     * warn returns diagnostics for content that does not fit; error rejects layout. Content is never silently removed. Default warn.
+     */
+    overflow?: ("warn" | "error");
+}
 /**
  * Optional reusable asset registry for images, data files, videos, documents, fonts, and other resources referenced elsewhere in the deck via 'asset:<id>' strings.
  */
@@ -2669,30 +2742,4 @@ interface CatalogEntry10 {
     [k: string]: unknown;
 }
 
-interface ValidationIssue {
-    path: string;
-    message: string;
-    keyword: string;
-    schemaPath: string;
-    params: Record<string, unknown>;
-}
-interface ValidationResult {
-    valid: boolean;
-    errors: ValidationIssue[];
-    schemaName?: SchemaName;
-    catalogKind?: CatalogKind;
-}
-type SchemaOrKind = SchemaName | CatalogKind | JsonSchema;
-declare class OPFValidationError extends Error {
-    readonly issues: ValidationIssue[];
-    readonly result: ValidationResult;
-    constructor(result: ValidationResult);
-}
-declare function validate(value: unknown, schemaOrKind?: SchemaOrKind): ValidationResult;
-declare function assertValid<T = unknown>(value: T, schemaOrKind?: SchemaOrKind): T;
-declare function validatePresentation(value: unknown): ValidationResult;
-declare function assertValidPresentation(value: unknown): asserts value is Presentation;
-declare function validateCatalogRecord(kind: CatalogKind, value: unknown): ValidationResult;
-declare function assertValidCatalogRecord(kind: CatalogKind, value: unknown): void;
-
-export { OPFValidationError as O, type Presentation as P, type SchemaOrKind as S, type ValidationIssue as V, type ValidationResult as a, assertValid as b, assertValidCatalogRecord as c, assertValidPresentation as d, validateCatalogRecord as e, validatePresentation as f, validate as v };
+export type { Presentation as P };