@sqsoffice/slide 0.0.0-stage → 0.1.0

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

@@ -0,0 +1,191 @@
+import type { Json } from './protocol';
+export type PdfData = Record<string, Json>;
+export type PdfOperation = PdfData & {
+    op: string;
+};
+export type PdfPanel = 'object' | 'pages' | 'forms' | 'search' | 'navigation' | 'marks' | 'attachments' | 'layers' | 'protection' | 'document' | 'measure' | 'redaction';
+export type PdfMode = 'read' | 'select' | 'text';
+export type PdfReadingMode = 'continuous' | 'single_page' | 'two_pages';
+export interface PdfPagePlacement {
+    index: number;
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    source_width: number;
+    source_height: number;
+    page_to_view: PdfMatrix;
+    view_to_page: PdfMatrix;
+}
+export interface PdfReadingLayout {
+    width: number;
+    height: number;
+    pages: PdfPagePlacement[];
+    active: PdfPagePlacement;
+    active_spread: {
+        width: number;
+        height: number;
+    };
+    dominant_page: number | null;
+    next_offset: number | null;
+}
+export type PdfMatrix = [number, number, number, number, number, number];
+export type PdfRect = [number, number, number, number];
+export type PdfTarget = {
+    revision: number;
+    page: number;
+    page_id: [number, number];
+    stream_id: [number, number];
+    stream_index: number;
+    operation_index: number;
+    source_hash: string;
+};
+export interface PdfPermissions {
+    copy: boolean;
+    print: boolean;
+    print_high_quality: boolean;
+    export: boolean;
+    assemble: boolean;
+    fill_forms: boolean;
+    modify_contents: boolean;
+}
+export interface PdfSecurity {
+    signature_read_only: boolean;
+    encrypted: boolean;
+    identity: 'none' | 'user' | 'owner';
+    revision: number;
+    permissions: PdfPermissions;
+    user_permissions: PdfPermissions;
+}
+export interface PdfPage {
+    index: number;
+    width: number;
+    height: number;
+    label: string;
+}
+export interface PdfPageGeometry extends PdfPage {
+    pdf_to_page: PdfMatrix;
+    page_to_pdf: PdfMatrix;
+}
+export interface PdfState {
+    revision: number;
+    font_epoch: number;
+    page_count: number;
+    offset: number;
+    next_offset: number | null;
+    pages: PdfPage[];
+    page: PdfPageGeometry | null;
+    selection: {
+        page: number;
+        target: PdfTarget | null;
+    };
+    security: PdfSecurity;
+    read_only: boolean;
+    recovery_allowed: boolean;
+}
+export type PdfTextStyle = {
+    font_family: string | null;
+    font_size: number;
+    color: [number, number, number];
+    bold: boolean;
+    italic: boolean;
+    alignment: number;
+    line_height: number;
+};
+export interface PdfObject {
+    target: PdfTarget;
+    kind: 'text' | 'image';
+    rect: PdfRect | null;
+    matrix: number[];
+    text: string | null;
+    font_name: string | null;
+    font_size: number | null;
+    image_size: [number, number] | null;
+    image_crop: PdfRect | null;
+    properties: {
+        text: string | null;
+        rect: PdfRect | null;
+        rotation: number | null;
+        opacity: number | null;
+        style: PdfTextStyle | null;
+    } | null;
+    capabilities: {
+        update: boolean;
+        replace_text: boolean;
+        replace_image: boolean;
+        move: boolean;
+        crop: boolean;
+        delete: boolean;
+    };
+    read_only_reason: string | null;
+}
+export interface PdfInventory {
+    revision: number;
+    page: number;
+    page_id: [number, number];
+    elements: PdfObject[];
+    text_blocks: PdfObject[];
+    warnings: string[];
+}
+export type PdfViewRequest = {
+    kind: 'pdf_reading';
+    request: PdfData;
+} | {
+    kind: 'pdf_tools';
+    request: PdfData;
+} | {
+    kind: 'pdf_state';
+    from?: number;
+    limit?: number;
+    page?: number;
+} | {
+    kind: 'pdf_selection';
+    page: number;
+    target?: PdfTarget | null;
+} | {
+    kind: 'pdf_hit';
+    page: number;
+    x: number;
+    y: number;
+    prefer_text?: boolean;
+} | {
+    kind: 'pdf_text_selection';
+    page: number;
+    rect: PdfRect;
+};
+export type PdfViewResult = PdfReadingLayout | PdfState | {
+    revision: number;
+    selection: {
+        page: number;
+        target: PdfTarget | null;
+    };
+} | {
+    revision: number;
+    page: number;
+    target: PdfTarget | null;
+    kind: 'text' | 'image' | null;
+    rect: PdfRect | null;
+} | {
+    revision: number;
+    page: number;
+    text: string;
+    rects: PdfRect[];
+};
+export declare const pdfObjectKey: (target: PdfTarget) => string;
+export declare const pdfObjectLabel: (object: PdfObject, index?: number) => string;
+export declare function pdfPoint(matrix: PdfMatrix, x: number, y: number): [number, number];
+export declare function pdfInverse(matrix: number[]): PdfMatrix;
+/** Transform all four corners; both input and result use x0/y0/x1/y1. */
+export declare function pdfTransformRect(matrix: PdfMatrix, rect: PdfRect): PdfRect;
+export declare function pdfPageRect(page: PdfPageGeometry, left: number, top: number, width: number, height: number): PdfRect;
+/** Content dimensions are defined before page rotation, unlike crop/link bounds. */
+export declare function pdfPlacement(page: PdfPageGeometry, left: number, top: number, width: number, height: number, rotation?: number): {
+    rect: PdfRect;
+    rotation: number;
+    scale: number;
+};
+export declare const pdfDefaultStyle: () => PdfTextStyle;
+export declare function pdfColorHex(rgb: number[] | null | undefined): string;
+export declare function pdfColorRgb(hex: string): [number, number, number];
+export declare function pdfPageRange(text: string, count: number): number[];
+export declare function pdfInlineFile(file: File, maximum?: number): Promise<string>;

package/dist/types/app/lib/engine/presentation-clipboard.d.ts

@@ -0,0 +1,26 @@
+/** Immutable native object captures are restored in order with the editing log. */
+export type PresentationClipboardRequest = {
+    action: 'inspect';
+} | {
+    action: 'capture';
+    id: string;
+    source: {
+        slide_id: number;
+        shape_ids: number[];
+    };
+} | {
+    action: 'paste';
+    id: string;
+    destination: {
+        slide_id: number;
+    };
+    dx?: number;
+    dy?: number;
+};
+export interface PresentationClipboardResult {
+    id: string;
+    slide_id: number;
+    shape_ids: number[];
+    count: number;
+    text?: string;
+}

package/dist/types/app/lib/engine/presentation-media.d.ts

@@ -0,0 +1,156 @@
+import type { BrowserFileSession } from '../files/session';
+import type { RenderedTile } from './view';
+export interface PresentationShowRequest {
+    slide: number;
+    fromStart?: boolean;
+    showId?: number;
+    rehearsal?: boolean;
+    revision: number;
+}
+export interface PresentationMediaInfo {
+    slide_id: number;
+    shape_id: number;
+    kind: 'audio' | 'video';
+    source: 'embedded' | 'external' | 'unavailable';
+    content_type: string | null;
+    playback: {
+        trim_start_ms: number;
+        trim_end_ms: number;
+        volume: number;
+        muted: boolean;
+        looping: boolean;
+        start: 'on_click' | 'automatic' | 'unsupported';
+        hide_when_stopped: boolean;
+    };
+    diagnostics: string[];
+}
+export interface PresentationPlaybackState {
+    revision: number;
+    slide: number;
+    slide_id: number;
+    total: number;
+    show_id: number | null;
+    show_position: number | null;
+    show_count: number | null;
+    first_slide: number | null;
+    last_slide: number | null;
+    width: number;
+    height: number;
+    state: 'ready' | 'transitioning' | 'running' | 'awaiting_click' | 'paused' | 'finished' | 'stopped';
+    position_ms: number;
+    frame_revision: number;
+    next_wakeup_ms: number | null;
+    advance: boolean;
+    next_slide: number | null;
+    previous_slide: number | null;
+    following_slide: number | null;
+    transitioning: boolean;
+    notes?: string;
+    media?: PresentationMediaInfo[];
+    diagnostics?: string[];
+    action?: {
+        kind: 'media' | 'slide' | 'jump' | 'custom_show' | 'external_url' | 'unsupported';
+        shape_id?: number;
+        slide_id?: number;
+        destination?: string;
+        url?: string;
+        id?: number;
+        return_after?: boolean;
+    };
+}
+export interface PresentationVideoFrame {
+    shape_id: number;
+    width: number;
+    height: number;
+    pixels: ArrayBuffer;
+}
+export type PresentationMediaViewRequest = {
+    kind: 'presentation_playback';
+    op: 'start' | 'tick' | 'click' | 'hover' | 'pause' | 'resume' | 'seek' | 'stop';
+    now_ms: number;
+    slide?: number;
+    position_ms?: number;
+    x?: number;
+    y?: number;
+    reduced_motion?: boolean;
+    show_id?: number;
+    show_position?: number;
+    from_start?: boolean;
+    rehearsal?: boolean;
+} | {
+    kind: 'presentation_frame';
+    width: number;
+    height: number;
+    hidden_media?: number[];
+    video?: PresentationVideoFrame;
+} | {
+    kind: 'presentation_media';
+    slide_id: number;
+    shape_id: number;
+};
+export type PresentationMediaViewResult = PresentationPlaybackState | RenderedTile | {
+    bytes: ArrayBuffer;
+};
+export interface MediaPlaybackState {
+    loading: boolean;
+    playing: boolean;
+    ended: boolean;
+    position: number;
+    duration: number;
+    shapeId?: number;
+    error?: string;
+}
+/** One media timeline is shared by the audience, presenter and recording output. */
+export declare class PresentationMediaController {
+    private readonly session;
+    private readonly notify;
+    private element?;
+    private info?;
+    private url?;
+    private request?;
+    private events?;
+    private sample;
+    private state;
+    private audio?;
+    private audioSource?;
+    private audioDestination?;
+    private stopped;
+    private disposed;
+    constructor(session: BrowserFileSession, notify: (state: MediaPlaybackState) => void);
+    private emit;
+    get active(): PresentationMediaInfo | undefined;
+    get video(): HTMLVideoElement | undefined;
+    private range;
+    private update;
+    open(info: PresentationMediaInfo, autoplay?: boolean): Promise<void>;
+    play(): Promise<void>;
+    pause(): void;
+    seek(seconds: number): void;
+    setVolume(value: number): void;
+    /** Uses the same browser video element clock as its audio output. */
+    sampleFrame(): PresentationVideoFrame | undefined;
+    private connectAudio;
+    recordingAudio(): Promise<MediaStream>;
+    stop(): void;
+    dispose(): Promise<void>;
+}
+export declare class PresentationRecorder {
+    private recorder?;
+    private stream?;
+    private microphone?;
+    private mixer?;
+    private timer?;
+    private done?;
+    private disposed;
+    get active(): boolean;
+    start(canvas: HTMLCanvasElement, media: PresentationMediaController, microphone: boolean): Promise<void>;
+    stop(): Promise<Blob | undefined>;
+    private release;
+    dispose(): Promise<void>;
+}
+/** Extract a local video poster without uploading the selected file. */
+export declare function createMediaPoster(file: File): Promise<{
+    data: string;
+    width: number;
+    height: number;
+}>;

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

@@ -0,0 +1,145 @@
+import type { Json } from './protocol';
+export type PresentationOperation = Record<string, Json> & {
+    op: string;
+};
+export type PresentationPanel = 'object' | 'search' | 'design' | 'motion' | 'organize' | 'notes';
+export interface PresentationSelection {
+    slide: number;
+    slide_id: number;
+    shape_ids: number[];
+}
+export interface PresentationSlideSummary {
+    index: number;
+    id: number;
+    title: string;
+    hidden: boolean;
+}
+export interface PresentationObject {
+    id: number | null;
+    name: string;
+    title?: string | null;
+    description?: string | null;
+    kind: string;
+    hidden: boolean;
+    parent_group: number | null;
+    text_box: boolean;
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    transform?: {
+        left: number;
+        top: number;
+        width: number;
+        height: number;
+        rotation: number;
+        flip_horizontal: boolean;
+        flip_vertical: boolean;
+    } | null;
+    text: string | null;
+    table: string[][] | null;
+    capabilities: {
+        transform: boolean;
+        appearance: boolean;
+        copy: boolean;
+        delete: boolean;
+        group: boolean;
+        ungroup: boolean;
+    };
+    disabled_reason?: string | null;
+    connection_sites?: {
+        shape_id: number;
+        index: number;
+        x: number;
+        y: number;
+    }[];
+}
+export interface PresentationSlide extends PresentationSlideSummary {
+    layout?: string | null;
+    notes?: string | null;
+    shapes: PresentationObject[];
+    background: Json;
+}
+export interface PresentationState {
+    revision: number;
+    font_epoch: number;
+    format: 'pptx' | 'ppt';
+    read_only: boolean;
+    slide_count: number;
+    width: number;
+    height: number;
+    offset: number;
+    next_offset: number | null;
+    slides: PresentationSlideSummary[];
+    selection: PresentationSelection;
+    slide: PresentationSlide | null;
+}
+export type PresentationViewRequest = {
+    kind: 'presentation_state';
+    from?: number;
+    limit?: number;
+    slide?: number;
+} | {
+    kind: 'presentation_selection';
+    slide: number;
+    shape_ids: number[];
+} | {
+    kind: 'presentation_hit';
+    slide: number;
+    x: number;
+    y: number;
+} | {
+    kind: 'presentation_tools';
+    request: Record<string, Json>;
+};
+export type PresentationViewResult = PresentationState | {
+    revision: number;
+    selection: PresentationSelection;
+} | {
+    revision: number;
+    slide: number;
+    shape_id: number | null;
+};
+export interface PresentationTextTarget {
+    slide_id: number;
+    shape_id: number;
+    cell?: {
+        row: number;
+        column: number;
+    };
+}
+export interface PresentationTextContent {
+    text: string;
+    editable: boolean;
+    disabled_reason?: string | null;
+    paragraphs?: Json[];
+}
+export interface PresentationTextSelection {
+    target: PresentationTextTarget;
+    byte_range?: {
+        start: number;
+        end: number;
+    };
+}
+export interface PresentationTextFormat {
+    characters: Record<string, Json>;
+    paragraphs: Record<string, Json>;
+    frame: Record<string, Json>;
+    font_family_is_mixed?: boolean;
+}
+export interface PresentationTextPatch {
+    characters?: Record<string, Json>;
+    paragraphs?: Record<string, Json>;
+    frame?: Record<string, Json>;
+}
+export interface PresentationViewTools {
+    rulers: boolean;
+    grid: boolean;
+    guides: boolean;
+    snap: boolean;
+    keepRatio: boolean;
+    spacing: number;
+}
+/** Pending input formatting follows the native editor's override rules. */
+export declare function mergePresentationCharacters(current: Record<string, Json>, patch: Record<string, Json>): Record<string, Json>;
+export declare const presentationObjectLabel: (object: PresentationObject) => string;

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

@@ -0,0 +1,91 @@
+import type { CopyExport, Json } from './protocol';
+export type PrintLayout = {
+    kind: 'single';
+} | {
+    kind: 'multiple';
+    columns: number;
+    rows: number;
+    pages_per_sheet: number;
+    order: 'horizontal' | 'horizontal_reversed' | 'vertical' | 'vertical_reversed' | 'cut_stack';
+    border: boolean;
+    auto_rotate: boolean;
+    gap_pt: number;
+} | {
+    kind: 'booklet';
+    subset: 'both_sides' | 'front_only' | 'back_only';
+    binding: 'left' | 'right';
+} | {
+    kind: 'poster';
+    scale_percent: number;
+    overlap_pt: number;
+    cut_marks: boolean;
+};
+export interface DocumentPrintOptions {
+    settings: {
+        page_range: string;
+        paper: 'document' | 'a4' | 'a3' | 'letter' | 'legal';
+        orientation: 'document' | 'portrait' | 'landscape';
+        scaling: 'actual_size' | 'fit' | 'shrink' | 'custom';
+        scale_percent?: number | null;
+        content: 'document' | 'document_and_markups' | 'form_fields_only';
+        layout: PrintLayout;
+        margin_pt: number;
+    };
+    dpi: number;
+    spreadsheet: {
+        kind: 'workbook';
+    } | {
+        kind: 'sheet';
+        sheet_id: number;
+    } | {
+        kind: 'selection';
+        sheet_id: number;
+        ranges: string[];
+    };
+}
+export interface PrintPreview {
+    revision: number;
+    sourcePages: number[];
+    sheetCount: number;
+    requestedDpi: number;
+    warnings: string[];
+    sheets: {
+        index: number;
+        paperSize: [number, number];
+        sourcePages: number[];
+    }[];
+}
+export interface PrintSheetReport {
+    index: number;
+    width: number;
+    height: number;
+    paperSize: [number, number];
+    paperDpi: number;
+    sourceDpi: number | null;
+    warnings: string[];
+}
+export type PrintViewRequest = {
+    kind: 'print_preview';
+    options: DocumentPrintOptions;
+} | {
+    kind: 'print_sheet';
+    options: DocumentPrintOptions;
+    index: number;
+    dpi: number;
+} | {
+    kind: 'print_pdf';
+    options: DocumentPrintOptions;
+} | {
+    kind: 'print_release';
+};
+export type PrintViewResult = PrintPreview | CopyExport;
+export declare const defaultPrintOptions: () => DocumentPrintOptions;
+export declare function printOptionsSnapshot(value: DocumentPrintOptions): DocumentPrintOptions;
+export declare function printWarnings(report: Json): string[];
+export declare const printFileName: (name: string, suffix: string, extension: string) => string;
+/** A real physical-sheet image document; the browser owns device settings and completion. */
+export declare function createBrowserPrintWindow(name: string): {
+    append(output: CopyExport, index: number, total: number): Promise<void>;
+    ready(): void;
+    close(): void;
+};