@openpresentation/opf 0.2.2 → 0.4.0

package/dist/composition.d.ts

@@ -0,0 +1,190 @@
+/** Portable layout geometry. No fonts, DOM, renderer, or network dependencies. */
+interface Composition {
+    mode?: "auto" | "grid" | "row" | "column";
+    columns?: number;
+    gap?: number;
+    padding?: number;
+    weights?: number[];
+    minFontSize?: number;
+    overflow?: "warn" | "error";
+}
+declare const MAX_COMPOSITION_DEPTH = 32;
+interface LayoutBox {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface LayoutDiagnostic {
+    code: "text-overflow" | "small-cell";
+    path: string;
+    message: string;
+}
+interface TextStyle {
+    fontFamily: string;
+    fontWeight: number;
+    italic?: boolean;
+    path?: string;
+}
+interface FontFamilies {
+    heading: string;
+    body: string;
+    code: string;
+}
+declare function resolveFontFamilies(input: unknown): FontFamilies;
+interface TextMeasurement {
+    measure: (text: string, fontSize: number, style: TextStyle) => number;
+    resolveStyle?: (style: TextStyle) => TextStyle;
+}
+type MeasureTextWidth = (text: string, fontSize: number) => number;
+declare function resolveTextStyle(style: TextStyle, measurement?: TextMeasurement): TextStyle;
+declare function textWidthMeasurer(style: TextStyle, measurement?: TextMeasurement): MeasureTextWidth;
+interface TextFit {
+    lines: string[];
+    fontSize: number;
+    lineHeight: number;
+    overflow: boolean;
+}
+interface ComposedItem {
+    path: string;
+    field: string;
+    type: string;
+    value: unknown;
+    payload: Record<string, unknown>;
+    box: LayoutBox;
+    text?: TextFit | RichTextFit | ListFit;
+    textStyle?: TextStyle;
+    /** Effective container settings, including inherited readability constraints. */
+    composition: Composition;
+}
+interface ComposedGroup {
+    path: string;
+    box: LayoutBox;
+    contentBox: LayoutBox;
+    composition: Composition;
+}
+interface CompositionTrack {
+    offset: number;
+    size: number;
+}
+/** Resolved flow geometry, including empty reserved slots. Promoted regions are not flows. */
+interface ComposedFlow {
+    path: string;
+    box: LayoutBox;
+    composition: Composition;
+    columns: CompositionTrack[];
+    rows: CompositionTrack[];
+    gap: number;
+    itemCount: number;
+    slotCount: number;
+}
+interface SlideComposition {
+    width: number;
+    height: number;
+    contentBox: LayoutBox;
+    items: ComposedItem[];
+    groups: ComposedGroup[];
+    flows: ComposedFlow[];
+    diagnostics: LayoutDiagnostic[];
+    composition: Composition;
+}
+interface ComposeSlideOptions {
+    fonts?: Partial<FontFamilies>;
+    textMeasurement?: TextMeasurement;
+    width?: number;
+    height?: number;
+    slideIndex?: number;
+    layout?: Record<string, unknown>;
+}
+declare class OPFCompositionError extends Error {
+    readonly diagnostics: LayoutDiagnostic[];
+    readonly code = "layout-overflow";
+    constructor(diagnostics: LayoutDiagnostic[]);
+}
+/** Deterministic estimate, not a font shaping engine. Preserves explicit line breaks. */
+declare function measureText(text: string, fontSize: number): number;
+declare function wrapText(text: string, width: number, fontSize: number, measure?: MeasureTextWidth): string[];
+declare function fitText(text: string, box: LayoutBox, requestedSize?: number, minFontSize?: number, measure?: MeasureTextWidth): TextFit;
+interface RichTextRun {
+    text: string;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strikethrough?: boolean;
+    color?: string;
+    fontSize?: number;
+    fontFamily?: string;
+    link?: string;
+    superscript?: boolean;
+    subscript?: boolean;
+}
+interface RichTextFragment {
+    text: string;
+    runIndex: number;
+    start: number;
+    end: number;
+    x: number;
+    width: number;
+    fontSize: number;
+    baselineShift: number;
+    style: TextStyle;
+    run: RichTextRun;
+}
+interface RichTextLine {
+    fragments: RichTextFragment[];
+    width: number;
+    y: number;
+    baseline: number;
+    height: number;
+}
+interface RichTextFit extends TextFit {
+    richLines: RichTextLine[];
+    height: number;
+}
+interface RichTextOptions {
+    style: TextStyle;
+    textMeasurement?: TextMeasurement;
+}
+/** Fit mixed styles without flattening font metrics. Run fontSize is in points. */
+declare function fitRichText(input: readonly (string | RichTextRun)[], box: LayoutBox, requestedSize?: number, minFontSize?: number, options?: RichTextOptions): RichTextFit;
+type ListText = string | readonly (string | RichTextRun)[];
+type ListValue = ListText | {
+    text: ListText;
+    description?: ListText;
+    level?: number;
+};
+interface ListEntryLayout {
+    index: number;
+    level: number;
+    textPath?: string;
+    descriptionPath?: string;
+    value: ListText;
+    descriptionValue?: ListText;
+    text: RichTextFit;
+    description?: RichTextFit;
+    textBox: LayoutBox;
+    descriptionBox?: LayoutBox;
+    marker: {
+        text: string;
+        x: number;
+        y: number;
+        fontSize: number;
+        style: TextStyle;
+        indent: number;
+    };
+}
+interface ListFit extends TextFit {
+    listEntries: ListEntryLayout[];
+    height: number;
+}
+/** Shared hanging indents, mixed-run fitting and description spacing for list payloads. */
+declare function fitList(input: readonly ListValue[], box: LayoutBox, requestedSize?: number, minFontSize?: number, options?: RichTextOptions): ListFit;
+/** Compose a validated Slide. Layout resolution remains the caller's responsibility. */
+declare function composeSlide(input: unknown, options?: ComposeSlideOptions): SlideComposition;
+/** Canonical physical slide size, converted to reference pixels at 96 pixels/inch. */
+declare function resolveCanvasDimensions(input: unknown): {
+    width: number;
+    height: number;
+};
+
+export { type ComposeSlideOptions, type ComposedFlow, type ComposedGroup, type ComposedItem, type Composition, type CompositionTrack, type FontFamilies, type LayoutBox, type LayoutDiagnostic, type ListEntryLayout, type ListFit, type ListText, type ListValue, MAX_COMPOSITION_DEPTH, type MeasureTextWidth, OPFCompositionError, type RichTextFit, type RichTextFragment, type RichTextLine, type RichTextOptions, type RichTextRun, type SlideComposition, type TextFit, type TextMeasurement, type TextStyle, composeSlide, fitList, fitRichText, fitText, measureText, resolveCanvasDimensions, resolveFontFamilies, resolveTextStyle, textWidthMeasurer, wrapText };

package/dist/composition.js

@@ -0,0 +1 @@
+export { MAX_COMPOSITION_DEPTH, OPFCompositionError, composeSlide, fitList, fitRichText, fitText, measureText, resolveCanvasDimensions, resolveFontFamilies, resolveTextStyle, textWidthMeasurer, wrapText } from './chunk-HJNJHB5H.js';

package/dist/data.d.ts

@@ -0,0 +1,32 @@
+/** Local CSV/TSV/JSON ingestion. No file access or network requests. */
+type DataCell = string | number | boolean | null;
+interface TabularData {
+    columns: string[];
+    rows: DataCell[][];
+}
+interface DataImportOptions {
+    format?: 'csv' | 'tsv' | 'json';
+    delimiter?: string;
+    header?: boolean;
+    columns?: string[];
+}
+interface DataContentOptions extends DataImportOptions {
+    as: 'table' | 'chart';
+    chartType?: string;
+    category?: string;
+    series?: string[];
+}
+declare class OPFDataImportError extends Error {
+    constructor(message: string);
+}
+declare function parseTabularData(input: unknown, options?: DataImportOptions): TabularData;
+declare function createDataContent(input: unknown, options: DataContentOptions): {
+    table: TabularData;
+} | {
+    chart: {
+        type: string;
+        data: TabularData;
+    };
+};
+
+export { type DataCell, type DataContentOptions, type DataImportOptions, OPFDataImportError, type TabularData, createDataContent, parseTabularData };

package/dist/data.js

@@ -0,0 +1 @@
+export { OPFDataImportError, createDataContent, parseTabularData } from './chunk-SOSOBKQ2.js';

package/dist/docs.d.ts

@@ -0,0 +1,17 @@
+interface DocRecord {
+    /** Filename slug, without the `.md` suffix. */
+    readonly slug: string;
+    /** Path relative to the repo root, with forward slashes. */
+    readonly file: string;
+    /** First-level heading from the markdown, falling back to a slug-derived title. */
+    readonly title: string;
+    /** Raw markdown content. */
+    readonly markdown: string;
+}
+
+/** Every documentation page shipped with this release, sorted by slug. */
+declare const docs: readonly DocRecord[];
+/** Look up a documentation page by slug (the filename without `.md`). */
+declare function getDoc(slug: string): DocRecord | undefined;
+
+export { type DocRecord, docs, getDoc };