@sqsoffice/slide 0.0.0-stage → 0.1.0

package/dist/types/app/lib/engine/grid.d.ts

@@ -0,0 +1,330 @@
+/** Spreadsheet geometry is computed by Rust; row/column and visible sheet indices are zero-based. */
+import type { Json } from './protocol';
+export interface GridCell {
+    row: number;
+    column: number;
+}
+export interface GridSelection {
+    sheet: number;
+    anchor: GridCell;
+    focus: GridCell;
+    active?: GridCell;
+    additional_ranges?: GridRange[];
+}
+export interface GridRange {
+    first_row: number;
+    last_row: number;
+    first_column: number;
+    last_column: number;
+}
+export interface GridRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface GridAxisSpan {
+    index: number;
+    start: number;
+    size: number;
+}
+export interface GridSheet {
+    index: number;
+    id: number;
+    name: string;
+    width: number;
+    height: number;
+    rows: number;
+    columns: number;
+    frozen_rows: number;
+    frozen_columns: number;
+    frozen_width: number;
+    frozen_height: number;
+    view: {
+        zeros: boolean;
+        grid_lines: boolean;
+        headings: boolean;
+        formulas: boolean;
+    };
+    protected: boolean;
+    tab_color: string | null;
+}
+export interface GridChange {
+    revision: number;
+    generation: number;
+    full: boolean;
+    /** Stable sheet IDs whose geometry or structure invalidates all of their tiles. */
+    sheet_ids: number[];
+    ranges: {
+        sheet_id: number;
+        rect: GridRect;
+    }[];
+}
+export interface GridSemantics {
+    cells: {
+        row: number;
+        column: number;
+        address: string;
+        text: string;
+        formula: boolean;
+        row_span: number;
+        column_span: number;
+    }[];
+    truncated: boolean;
+}
+export interface GridLayout {
+    revision: number;
+    font_epoch: number;
+    generation: number;
+    change: GridChange;
+    sheet: number;
+    sheets: GridSheet[];
+    rows: GridAxisSpan[];
+    columns: GridAxisSpan[];
+    frozen_row_spans: GridAxisSpan[];
+    frozen_column_spans: GridAxisSpan[];
+    semantics: GridSemantics;
+    diagnostics: string[];
+}
+export interface GridHitResult {
+    revision: number;
+    cell: GridCell | null;
+    drawing?: GridDrawing | null;
+}
+export interface GridDrawing {
+    kind: 'image' | 'shape' | 'chart' | 'slicer';
+    index: number;
+    rect: GridRect;
+}
+/** Same field names as the shared xlsx batch_update set_format operation. */
+export interface GridCellFormat {
+    [key: string]: Json | undefined;
+    number_format?: string;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: 'none' | 'single' | 'double' | 'single_accounting' | 'double_accounting';
+    strikethrough?: boolean;
+    background?: string;
+    font_color?: string;
+    font_family?: string;
+    font_size?: number;
+    automatic_font_color?: boolean;
+    horizontal_alignment?: 'general' | 'left' | 'center' | 'center_across' | 'right';
+    vertical_alignment?: 'top' | 'center' | 'bottom';
+    wrap_text?: boolean;
+    shrink_to_fit?: boolean;
+    indent?: number;
+    text_rotation?: number;
+    locked?: boolean;
+    checkbox?: boolean;
+}
+export interface GridStatistics {
+    count: number;
+    numeric_count: number;
+    sum: number | null;
+    average: number | null;
+    minimum: number | null;
+    maximum: number | null;
+    pending: number;
+}
+export interface GridContext {
+    hyperlink?: {
+        target: string | null;
+        location: string;
+        display: string | null;
+        tooltip: string;
+    } | null;
+    note?: {
+        author: string;
+        text: string;
+        truncated: boolean;
+    } | null;
+    validation?: {
+        dropdown: boolean;
+        title: string;
+        prompt: string;
+        truncated: boolean;
+    } | null;
+    sheet_id: number;
+    format: GridCellFormat;
+    mixed: string[];
+    format_error?: string | null;
+    merged: boolean;
+    frozen_rows: number;
+    frozen_columns: number;
+    read_only_reason: string | null;
+    statistics: GridStatistics | null;
+    statistics_error?: string | null;
+}
+export interface GridFunctionInfo {
+    name: string;
+    category: string;
+    arguments: string;
+    description: string;
+}
+export interface GridForestryEntry {
+    id: string;
+    title: string;
+    category: string;
+    section: string;
+    latex: string;
+    variables: string;
+    context: string;
+    review: string;
+    correction: string;
+    calculation: {
+        parameters: {
+            label: string;
+            series: boolean;
+        }[];
+        expression: string;
+        notes: string;
+        checks: string[];
+    };
+}
+export interface GridForestryCatalog {
+    source: string;
+    entries: GridForestryEntry[];
+}
+export interface GridFormulaPreview {
+    src: string;
+    width: number;
+    height: number;
+}
+export interface GridFormulaAssistance {
+    completion: {
+        start: number;
+        end: number;
+        items: GridFunctionInfo[];
+    } | null;
+    function: (GridFunctionInfo & {
+        argument: number;
+    }) | null;
+    references: {
+        start: number;
+        end: number;
+        reference: string;
+    }[];
+    cycled: {
+        text: string;
+        start: number;
+        end: number;
+    } | null;
+    pick_span: {
+        start: number;
+        end: number;
+    } | null;
+    completed: string | null;
+    reference: string;
+    highlights?: {
+        rect: GridRect;
+        index: number;
+    }[];
+}
+export interface GridSelectionResult {
+    revision: number;
+    selection: GridSelection;
+    /** A1 with the escaped sheet name, ready for the shared xlsx_write protocol. */
+    range: string;
+    ranges: string[];
+    cell: string;
+    rect: GridRect;
+    active_rect: GridRect;
+    rects: GridRect[];
+    input: string;
+    display: string;
+    read_only: boolean;
+    context: GridContext;
+    formula?: GridFormulaAssistance | null;
+    catalog?: GridFunctionInfo[] | null;
+    aggregate?: {
+        selection: GridSelection;
+        text: string;
+        start: number;
+        end: number;
+    } | null;
+    forestry_catalog?: GridForestryCatalog | null;
+    forestry_formula?: string | null;
+    forestry_preview?: GridFormulaPreview | null;
+    parsed_input?: {
+        value: Json;
+        number_format: string | null;
+    } | null;
+    pivot_source?: Json;
+    object_preview?: Json;
+    data_range?: {
+        range: string;
+        has_header: boolean;
+        column: number;
+    } | null;
+    drawing_positions?: {
+        anchor: string;
+        offset_x: number;
+        offset_y: number;
+    }[] | null;
+    clipboard?: string | null;
+}
+export interface GridTileRequest {
+    sheet: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    scale: number;
+}
+export type GridDirection = 'left' | 'right' | 'up' | 'down' | 'home' | 'end' | 'tab' | 'enter';
+export type GridViewRequest = ({
+    kind: 'grid_layout';
+    sheet: number;
+} & GridRect) | {
+    kind: 'grid_tile';
+    tile: GridTileRequest;
+} | {
+    kind: 'grid_hit';
+    sheet: number;
+    x: number;
+    y: number;
+} | {
+    kind: 'grid_selection';
+    selection: GridSelection;
+    direction?: GridDirection;
+    extend?: boolean;
+    target?: string;
+    data_edge?: boolean;
+    sheet_start?: boolean;
+    reverse?: boolean;
+    include_clipboard?: boolean;
+    formula_catalog?: boolean;
+    forestry_catalog?: boolean;
+    forestry_preview?: string;
+    parse_input?: {
+        text: string;
+    };
+    pivot_source?: Record<string, Json>;
+    object_preview?: Record<string, Json>;
+    data_range?: {
+        kind: 'sort' | 'filter' | 'advanced';
+    };
+    drawing_positions?: {
+        anchor: string;
+        offsets: {
+            x: number;
+            y: number;
+        }[];
+    };
+    forestry?: {
+        id: string;
+        values: string[];
+        expression?: string;
+    };
+    aggregate?: 'SUM' | 'AVERAGE' | 'COUNT' | 'MAX' | 'MIN';
+    /** DOM selection positions, measured in UTF-16 code units. */
+    draft?: {
+        text: string;
+        cursor: number;
+        start?: number;
+        cycle_references?: boolean;
+        target_sheet?: number;
+    };
+};
+export type GridViewResult = GridLayout | GridHitResult | GridSelectionResult;

package/dist/types/app/lib/engine/image.d.ts

@@ -0,0 +1,15 @@
+export interface ImageInfo {
+    kind: 'svg' | 'image';
+    format: string;
+    width: number;
+    height: number;
+    width_points: number;
+    height_points: number;
+    source_bytes: number;
+    read_only: true;
+    diagnostics: string[];
+    text?: string;
+}
+export type ImageViewRequest = {
+    kind: 'image_info';
+};

package/dist/types/app/lib/engine/markdown.d.ts

@@ -0,0 +1,220 @@
+import type { PageInfo } from './view';
+import type { Json } from './protocol';
+export type SourceMode = 'source' | 'visual';
+export type MarkdownMode = SourceMode | 'preview';
+/** Source and projection coordinates are UTF-16 offsets, as used by browser inputs. */
+export interface SourceSelection {
+    anchor: number;
+    head: number;
+}
+export interface SourceInputResult extends SourceSelection {
+    selections?: SourceSelection[];
+}
+/** Stored source offsets are UTF-8 bytes, independent of a browser projection. */
+export interface SourceSelectionHistory {
+    before: SourceSelection;
+    after: SourceSelection;
+}
+export interface SourceParagraphStyle {
+    align: number;
+    indent: number;
+    first_indent: number;
+    line_height: number;
+    before: number;
+    after: number;
+}
+export interface SourceStyle {
+    strong?: boolean;
+    emphasis?: boolean;
+    strike?: boolean;
+    code?: boolean;
+    heading?: number;
+    link?: boolean;
+    underline?: boolean;
+    color?: [number, number, number] | null;
+    background?: [number, number, number] | null;
+    size?: number | null;
+    monospace?: boolean;
+    serif?: boolean;
+    superscript?: boolean;
+    subscript?: boolean;
+    html?: boolean;
+    task?: boolean | null;
+    paragraph?: SourceParagraphStyle | null;
+}
+export interface SourceSpan {
+    start: number;
+    end: number;
+    style: SourceStyle;
+    source_start: number;
+    source_end: number;
+    task_source?: number;
+    radio?: boolean;
+}
+export interface SourceObject {
+    kind: 'table' | 'image' | 'formula' | 'diagram' | 'html' | 'rule';
+    start: number;
+    end: number;
+    source_start: number;
+    source_end: number;
+    text: string;
+}
+export interface SourceState {
+    revision: number;
+    format: 'markdown' | 'text';
+    mode: SourceMode;
+    folded?: boolean;
+    text: string;
+    start: number;
+    end: number;
+    total: number;
+    selection: SourceSelection;
+    line_count: number;
+    characters: number;
+    encoding: string;
+    can_undo: boolean;
+    can_redo: boolean;
+    spans?: SourceSpan[];
+    objects?: SourceObject[];
+    paragraph_ranges?: {
+        start: number;
+        end: number;
+        style: SourceParagraphStyle;
+    }[];
+}
+export interface SourcePreview {
+    revision: number;
+    font_epoch: number;
+    pages: PageInfo[];
+    known_pages: number;
+    complete: boolean;
+    diagnostics: string[];
+    remote?: SourceRemoteState;
+}
+export interface SourceRemoteState {
+    enabled: boolean;
+    epoch: number;
+    pending: string[];
+}
+export interface SourceContext {
+    revision: number;
+    style: SourceStyle | null;
+    mixed: string[];
+    paragraph: SourceParagraphStyle | null;
+    paragraph_mixed: string[];
+    heading: number | null;
+}
+export interface SourceSelectionResult {
+    revision: number;
+    mode: SourceMode;
+    selection: SourceSelection;
+}
+export interface SourceHit {
+    source: number | null;
+}
+export type SourceViewRequest = {
+    kind: 'source_state';
+    start?: number;
+    length?: number;
+    mode?: SourceMode;
+    folded?: boolean;
+    line?: number;
+} | {
+    kind: 'source_selection';
+    mode: SourceMode;
+    folded?: boolean;
+    selection: SourceSelection;
+} | {
+    kind: 'source_context' | 'source_copy' | 'source_footnote';
+    mode: SourceMode;
+    folded?: boolean;
+    selection: SourceSelection;
+} | {
+    kind: 'source_multi_next';
+    mode: 'source';
+    selections: SourceSelection[];
+    window: {
+        start: number;
+        end: number;
+    };
+} | {
+    kind: 'source_objects';
+    request: Json;
+} | {
+    kind: 'source_remote_config';
+    enabled: boolean;
+} | {
+    kind: 'source_remote_resource';
+    epoch: number;
+    url: string;
+    bytes?: ArrayBuffer;
+    error?: string;
+} | {
+    kind: 'source_preview';
+    from?: number;
+    budget?: number;
+    width?: number;
+    refresh?: boolean;
+} | {
+    kind: 'source_hit';
+    page: number;
+    x: number;
+    y: number;
+};
+export type SourceViewResult = SourceState | SourcePreview | SourceSelectionResult | SourceHit | SourceContext | SourceRemoteState | SourceInputResult | {
+    revision: number;
+    text: string;
+} | {
+    revision: number;
+    selection: SourceSelection | null;
+} | Json;
+export type SourceCommandName = 'bold' | 'italic' | 'underline' | 'strike' | 'code' | 'clear_format' | 'heading' | 'bullet_list' | 'ordered_list' | 'task_list' | 'quote' | 'code_block' | 'link' | 'image' | 'formula' | 'diagram' | 'table' | 'rule' | 'superscript' | 'subscript' | 'inline_style' | 'apply_format' | 'paragraph' | 'radio_list' | 'task_toggle' | 'radio_clear' | 'radio_split' | 'footnote' | 'paste_rich' | 'insert_markdown';
+export interface SourceCommand {
+    command: SourceCommandName;
+    level?: number;
+    url?: string;
+    label?: string;
+    text?: string;
+    language?: string;
+    rows?: number;
+    columns?: number;
+    inline?: boolean;
+    display?: boolean;
+    style?: Partial<SourceStyle> | Partial<SourceParagraphStyle>;
+    source?: number;
+    html?: string;
+}
+export type SourceInput = {
+    kind: 'source_edit';
+    mode: SourceMode;
+    folded?: boolean;
+    start: number;
+    end: number;
+    text: string;
+    selection?: SourceSelection;
+} | ({
+    kind: 'source_command';
+    mode: SourceMode;
+    folded?: boolean;
+    selection: SourceSelection;
+} & SourceCommand) | {
+    kind: 'source_smart';
+    mode: SourceMode;
+    folded?: boolean;
+    selection: SourceSelection;
+    action: 'enter' | 'indent' | 'outdent' | 'pair';
+    text?: string;
+} | {
+    kind: 'source_multi_edit';
+    mode: 'source';
+    selections: SourceSelection[];
+    action: 'insert' | 'backspace' | 'delete';
+    text?: string;
+};
+/** A toolbar dialog stays attached to the selection and revision at opening. */
+export interface SourceTarget {
+    mode: SourceMode;
+    folded?: boolean;
+    selection: SourceSelection;
+    revision: number;
+}

package/dist/types/app/lib/engine/pdf-import.d.ts

@@ -0,0 +1,18 @@
+export interface PdfImportRequest {
+    at: number;
+    sources: {
+        name: string;
+        bytes: ArrayBuffer;
+        password?: string;
+        pages?: number[];
+    }[];
+}
+export interface PdfImportResult {
+    at: number;
+    imported: number;
+    page_count: number;
+    source_page_counts: number[];
+}
+export declare function pdfImportBytes(request: PdfImportRequest): number;
+export declare function pdfImportMetadata(request: PdfImportRequest): string;
+export declare function validatePdfImport(value: PdfImportRequest, recovery?: boolean): void;

package/dist/types/app/lib/engine/pdf-ocr.d.ts

@@ -0,0 +1,70 @@
+import type { BrowserFileSession } from '../files/session';
+import { type Json } from './protocol';
+export interface PdfOcrSettings {
+    pages: number[] | null;
+    backend: string;
+    language: string;
+    dpi: number;
+    skip_text_pages: boolean;
+}
+export interface PdfOcrCapabilities {
+    loaded: boolean;
+    backend: string;
+    languages: string[];
+    model: string;
+    model_bytes: number;
+    engine_license: string;
+    cancellation: string;
+}
+export interface PdfOcrWord {
+    line: number;
+    text: string;
+    origin: [number, number];
+    across: [number, number];
+    up: [number, number];
+    confidence: number | null;
+}
+export interface PdfOcrPagePreview {
+    page: number;
+    page_id: [number, number];
+    status: 'ready' | 'skipped' | 'error';
+    reason: string | null;
+    dpi: number;
+    pixel_size: [number, number];
+    model: Json;
+    existing_text_coverage: number;
+    words: PdfOcrWord[];
+}
+export interface PdfOcrPreview {
+    source_revision: number;
+    source_hash: string;
+    view_fingerprint: string;
+    settings: PdfOcrSettings;
+    pages: PdfOcrPagePreview[];
+}
+export type PdfOcrViewRequest = {
+    kind: 'pdf_ocr_capabilities';
+} | {
+    kind: 'pdf_ocr_load';
+    detection: ArrayBuffer;
+    recognition: ArrayBuffer;
+    dictionary: ArrayBuffer;
+} | {
+    kind: 'pdf_ocr_preview';
+    settings: PdfOcrSettings;
+};
+export type PdfOcrViewResult = PdfOcrCapabilities | PdfOcrPreview;
+export interface PdfOcrProgress {
+    phase: string;
+    completed: number;
+    total: number;
+}
+/** Only public model weights are fetched; document bytes never leave the local worker. */
+export declare function loadPdfOcrModels(signal: AbortSignal, progress: (value: PdfOcrProgress) => void, resourceBase?: string): Promise<{
+    detection: ArrayBuffer;
+    recognition: ArrayBuffer;
+    dictionary: ArrayBuffer;
+}>;
+export declare function clearPdfOcrCache(): Promise<void>;
+export declare function parsePdfOcrPages(value: string, count: number): number[];
+export declare function previewPdfOcr(session: BrowserFileSession, settings: PdfOcrSettings, signal: AbortSignal, progress: (value: PdfOcrProgress) => void): Promise<PdfOcrPreview>;

package/dist/types/app/lib/engine/pdf-output.d.ts

@@ -0,0 +1,22 @@
+import type { CopyExport, Json } from './protocol';
+export type PdfOutputViewRequest = {
+    kind: 'pdf_output';
+    spec: Record<string, Json>;
+} | {
+    kind: 'pdf_merge_copy';
+    sources: ArrayBuffer[];
+    passwords?: string[];
+} | {
+    kind: 'pdf_signed_output';
+    certificate: ArrayBuffer;
+    privateKey: ArrayBuffer;
+    options: Record<string, Json>;
+} | {
+    kind: 'pdf_authenticate';
+    password: string;
+};
+export type PdfOutputViewResult = CopyExport | {
+    authenticated: boolean;
+};
+export declare function pdfOutputName(source: string, spec: Record<string, Json>, report: Json): string;
+export declare function downloadPdfOutput(output: CopyExport, name: string): void;