@docvyu/sdk 0.0.5 → 0.1.0

package/dist/types/core/DocvyuEditor.d.ts

@@ -6,63 +6,15 @@
  */
 import { type LicenseConfig, type LicenseInfo } from '../license';
 import { type Locale, type I18nConfig } from '../i18n';
-export interface WasmEditor {
-    free(): void;
-    load_docx_and_render(data: Uint8Array): void;
-    save_document(): Uint8Array;
-    on_mouse_click(x: number, y: number): void;
-    on_mouse_drag(x: number, y: number): void;
-    on_key_down(key: string): void;
-    set_cursor_visible(visible: boolean): void;
-    set_bold(enable: boolean): void;
-    set_italic(enable: boolean): void;
-    set_underline(enable: boolean): void;
-    set_font_size(size: number): void;
-    reset_font_size(): void;
-    set_font_family(family: string): void;
-    reset_font_family(): void;
-    set_font_color(color: string): void;
-    reset_font_color(): void;
-    set_paragraph_alignment(alignment: string): void;
-    set_bullet_list(enable: boolean): void;
-    set_numbered_list(enable: boolean): void;
-    set_numbered_list_format(format: string): void;
-    remove_numbering(): void;
-    has_bullet_list(): boolean;
-    has_numbered_list(): boolean;
-    has_numbering(): boolean;
-    get_numbering_format_id(): number | undefined;
-    set_page_margins(left: number, right: number, top: number, bottom: number): void;
-    set_page_size(size: string): void;
-    get_page_size(): string;
-    get_zoom(): number;
-    set_zoom(zoom: number): void;
-    zoom_in(): void;
-    zoom_out(): void;
-    get_ruler_unit(): number;
-    set_ruler_unit(unit: number): void;
-    toggle_ruler_unit(): void;
-    select_word(): void;
-    select_paragraph(): void;
-    select_document(): void;
-    selection_style_state(): SelectionStyleState;
-}
-export interface SelectionStyleState {
-    bold_all(): boolean;
-    bold_any(): boolean;
-    italic_all(): boolean;
-    italic_any(): boolean;
-    underline_all(): boolean;
-    underline_any(): boolean;
-    font_size(): number | undefined;
-    font_family(): string | undefined;
-    font_color(): string | undefined;
-    paragraph_alignment(): string | undefined;
-}
 export type Alignment = 'left' | 'center' | 'right' | 'justify';
-export type NumberingFormat = 'decimal' | 'decimal-paren' | 'decimal-paren-both' | 'upper-letter' | 'lower-letter' | 'upper-roman' | 'lower-roman';
+export type NumberingFormat = 'decimal' | 'decimal-paren' | 'decimal-paren-both' | 'upper-letter' | 'lower-letter' | 'upper-roman' | 'lower-roman' | 'outline' | 'outline-decimal' | 'outline-mixed' | 'outline-alpha' | 'outline-legal';
 export type RulerUnit = 'centimeters' | 'inches';
 export type PageSize = 'letter' | 'legal' | 'a4' | 'a5' | 'b5' | 'custom';
+/** Style information for UI display */
+export interface StyleInfo {
+    id: string;
+    name: string;
+}
 export interface EditorConfig extends LicenseConfig {
     /** Canvas element ID or HTMLCanvasElement */
     canvas: string | HTMLCanvasElement;
@@ -93,13 +45,42 @@ export interface SelectionState {
     bold: boolean;
     italic: boolean;
     underline: boolean;
+    strikethrough: boolean;
     fontSize?: number;
     fontFamily?: string;
     fontColor?: string;
     alignment?: Alignment;
     hasBulletList: boolean;
     hasNumberedList: boolean;
+    hasOutlineList: boolean;
     numberingFormatId?: number;
+    /** List level: -1 = not a list, 0-8 = list level */
+    listLevel: number;
+}
+/**
+ * Search state returned by find operations
+ */
+export interface SearchState {
+    /** The current search query */
+    query: string;
+    /** Total number of matches found */
+    matchCount: number;
+    /** Current match index (1-based), 0 if no matches */
+    currentIndex: number;
+    /** Whether search is active */
+    isActive: boolean;
+}
+/**
+ * Format copied from cursor position for copy/paste format functionality
+ */
+export interface CopiedFormat {
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    fontSize?: number;
+    fontFamily?: string;
+    fontColor?: string;
+    alignment?: Alignment;
 }
 export interface EditorMargins {
     left: number;
@@ -107,10 +88,11 @@ export interface EditorMargins {
     top: number;
     bottom: number;
 }
-type WasmInit = (module?: any) => Promise<any>;
-type WasmEditorConstructor = new (canvasId: string) => WasmEditor;
 /**
  * DocvyuEditor - The main editor class
+ *
+ * IMPORTANT: License validation is MANDATORY. The editor will not function
+ * without successful license validation from the server.
  */
 export declare class DocvyuEditor {
     private wasmEditor;
@@ -119,14 +101,17 @@ export declare class DocvyuEditor {
     private canvas;
     private canvasId;
     private isInitialized;
+    private licenseValidated;
     private cursorBlinkInterval;
     private cursorVisible;
     private localeUnsubscribe;
     constructor(config: EditorConfig);
     /**
      * Initialize the editor with WASM module
+     * License validation with the server is MANDATORY - the editor will not
+     * function without successful validation.
      */
-    initialize(wasmInit: WasmInit, EditorClass: WasmEditorConstructor): Promise<LicenseInfo>;
+    initialize(wasmInit: (module?: any) => Promise<any>, EditorClass: new (canvasId: string) => any): Promise<LicenseInfo>;
     /**
      * Load a DOCX file into the editor
      * Now async because usage tracking requires server validation
@@ -153,7 +138,75 @@ export declare class DocvyuEditor {
     setBulletList(enable: boolean): void;
     setNumberedList(enable: boolean): void;
     setNumberedListFormat(format: NumberingFormat): void;
+    /**
+     * Set outline list for the current selection or cursor position
+     * Uses outline numbering format (1. → 1.1. → 1.1.1.)
+     * @param enable - Whether to enable or disable outline list
+     */
+    setOutlineList(enable: boolean): void;
+    /**
+     * Check if the current paragraph has outline list numbering
+     * @returns true if paragraph has outline list (IDs 109-111)
+     */
+    hasOutlineList(): boolean;
+    /**
+     * Get available list formats as JSON
+     * @returns Array of list format info objects
+     */
+    getListFormats(): Array<{
+        id: number;
+        name: string;
+        example: string;
+        type: string;
+    }>;
+    /**
+     * Apply numbering by format ID (102-111)
+     * @param formatId - The numbering format ID
+     */
+    applyNumbering(formatId: number): void;
     removeNumbering(): void;
+    /**
+     * Get available paragraph styles for the UI dropdown
+     * @returns Array of style info objects with id and display name
+     */
+    getAvailableStyles(): StyleInfo[];
+    /**
+     * Apply a paragraph style to the current paragraph or selection
+     * @param styleId - The style ID (e.g., "Normal", "Heading1")
+     */
+    applyParagraphStyle(styleId: string): void;
+    /**
+     * Get the current paragraph's style ID
+     * @returns Style ID or undefined if no style applied
+     */
+    getCurrentParagraphStyle(): string | undefined;
+    /**
+     * Remove the paragraph style from the current paragraph or selection
+     */
+    removeParagraphStyle(): void;
+    /**
+     * Insert a table at the current cursor position
+     * @param rows - Number of rows (1-50)
+     * @param cols - Number of columns (1-20)
+     */
+    insertTable(rows: number, cols: number): void;
+    /**
+     * Get the current list level of the paragraph at cursor.
+     * @returns -1 if not a list, 0-8 for list level
+     */
+    getListLevel(): number;
+    /**
+     * Increase the list level (indent) of the current paragraph.
+     * Only works if the paragraph is already a list item.
+     * Maximum level is 8.
+     */
+    increaseListLevel(): void;
+    /**
+     * Decrease the list level (outdent) of the current paragraph.
+     * Only works if the paragraph is already a list item.
+     * Minimum level is 0.
+     */
+    decreaseListLevel(): void;
     setMargins(margins: EditorMargins): void;
     setPageSize(size: PageSize): void;
     getPageSize(): PageSize;
@@ -161,16 +214,250 @@ export declare class DocvyuEditor {
     getZoom(): number;
     zoomIn(): void;
     zoomOut(): void;
+    /**
+     * Set the visible viewport for rendering optimization.
+     * Call this when the scroll container scrolls.
+     * @param y Scroll position (pixels from top)
+     * @param height Visible viewport height (pixels)
+     */
+    setViewport(y: number, height: number): void;
+    /**
+     * Get paragraph Y positions for hit-testing optimization.
+     * @returns JSON array of [start_y, end_y, page_index] for each paragraph
+     */
+    getParagraphPositions(): string;
     setRulerUnit(unit: RulerUnit): void;
     getRulerUnit(): RulerUnit;
     toggleRulerUnit(): void;
     selectWord(): void;
     selectParagraph(): void;
     selectAll(): void;
+    /**
+     * Get the text content of the current selection
+     * @returns The selected text as a string, or empty string if no selection
+     */
+    getSelectedText(): string;
+    /**
+     * Copy selected text to internal clipboard
+     * @returns The copied text
+     */
+    copyText(): string;
+    /**
+     * Cut selected text (copy to internal clipboard and delete)
+     * @returns The cut text
+     */
+    cutText(): string;
+    /**
+     * Paste text at cursor position
+     * @param text The text to paste
+     */
+    pasteText(text: string): void;
+    /**
+     * Start a new search with the given query
+     * @param query The text to search for
+     * @param caseSensitive Whether to match case (default: false)
+     * @returns Search state with match count and current index
+     */
+    find(query: string, caseSensitive?: boolean): SearchState;
+    /**
+     * Navigate to the next search match
+     * @returns Updated search state
+     */
+    findNext(): SearchState;
+    /**
+     * Navigate to the previous search match
+     * @returns Updated search state
+     */
+    findPrevious(): SearchState;
+    /**
+     * Clear the current search and highlights
+     */
+    clearSearch(): void;
+    /**
+     * Get the current search state
+     * @returns Current search state
+     */
+    getSearchState(): SearchState;
+    /**
+     * Replace the current search match with the given text
+     * @param replacement The replacement text
+     * @returns Number of remaining matches
+     */
+    replaceCurrent(replacement: string): number;
+    /**
+     * Replace all search matches with the given text
+     * @param replacement The replacement text
+     * @returns Number of replacements made
+     */
+    replaceAll(replacement: string): number;
+    /**
+     * Undo the last operation
+     * @returns true if an operation was undone, false if nothing to undo
+     */
+    undo(): boolean;
+    /**
+     * Redo the last undone operation
+     * @returns true if an operation was redone, false if nothing to redo
+     */
+    redo(): boolean;
+    /**
+     * Check if there are operations that can be undone
+     * @returns true if undo is available
+     */
+    canUndo(): boolean;
+    /**
+     * Check if there are operations that can be redone
+     * @returns true if redo is available
+     */
+    canRedo(): boolean;
+    /**
+     * Insert an image at the current cursor position
+     * @param data - Image data as Uint8Array
+     * @param width - Image width in pixels
+     * @param height - Image height in pixels
+     * @param name - Image file name
+     */
+    insertImage(data: Uint8Array, width: number, height: number, name: string): void;
+    /**
+     * Force a re-render of the document
+     * Useful after async operations like image loading
+     */
+    render(): void;
+    /**
+     * Check if cursor is currently on an image
+     * @returns true if cursor is on an image
+     */
+    isCursorOnImage(): boolean;
+    /**
+     * Get dimensions of image at cursor
+     * @returns {width, height} or null if not on image
+     */
+    getImageDimensions(): {
+        width: number;
+        height: number;
+    } | null;
+    /**
+     * Resize image at cursor to specific dimensions
+     * @param width - New width in pixels
+     * @param height - New height in pixels
+     * @returns true if image was resized
+     */
+    resizeImage(width: number, height: number): boolean;
+    /**
+     * Scale image at cursor by a factor
+     * @param scale - Scale factor (e.g., 0.5 for 50%, 2.0 for 200%)
+     * @returns true if image was scaled
+     */
+    scaleImage(scale: number): boolean;
+    /**
+     * Get the wrap mode of the image at cursor
+     * @returns "inline", "square", "inFrontOfText", "behindText", or empty string
+     */
+    getImageWrapMode(): string;
+    /**
+     * Set the wrap mode of the image at cursor
+     * @param mode - "inline", "square", "inFrontOfText", "behindText"
+     * @returns true if mode was set
+     */
+    setImageWrapMode(mode: string): boolean;
+    /**
+     * Check if the image at cursor is in floating mode
+     * @returns true if image is floating
+     */
+    isImageFloating(): boolean;
+    /**
+     * Get the floating position of the image
+     * @returns {x, y} or null if not floating
+     */
+    getImageFloatPosition(): {
+        x: number;
+        y: number;
+    } | null;
+    /**
+     * Set the floating position of the image
+     * @param x - X position
+     * @param y - Y position
+     * @returns true if position was set
+     */
+    setImageFloatPosition(x: number, y: number): boolean;
+    /**
+     * Start dragging a floating image
+     * @param x - Mouse X coordinate
+     * @param y - Mouse Y coordinate
+     * @returns true if drag started (clicked on a floating image)
+     */
+    startImageDrag(x: number, y: number): boolean;
+    /**
+     * Move the dragged image
+     * @param x - Mouse X coordinate
+     * @param y - Mouse Y coordinate
+     */
+    moveImageDrag(x: number, y: number): void;
+    /**
+     * End the image drag operation
+     */
+    endImageDrag(): void;
+    /**
+     * Check if currently dragging an image
+     * @returns true if dragging
+     */
+    isDraggingImage(): boolean;
+    /**
+     * Insert a comment at the current selection
+     * @param author - Comment author name
+     * @param text - Comment text content
+     */
+    insertComment(author: string, text: string): void;
+    /**
+     * Get the number of comments in the document
+     * @returns Number of comments
+     */
+    getCommentCount(): number;
+    /**
+     * Get the author of a comment by index
+     * @param index - Comment index (0-based)
+     * @returns Author name
+     */
+    getCommentAuthor(index: number): string;
+    /**
+     * Get the initials of a comment author by index
+     * @param index - Comment index (0-based)
+     * @returns Author initials
+     */
+    getCommentInitials(index: number): string;
+    /**
+     * Get the date of a comment by index
+     * @param index - Comment index (0-based)
+     * @returns Comment date in ISO format
+     */
+    getCommentDate(index: number): string;
+    /**
+     * Get the text of a comment by index
+     * @param index - Comment index (0-based)
+     * @returns Comment text content
+     */
+    getCommentText(index: number): string;
+    /**
+     * Get the ID of a comment by index
+     * @param index - Comment index (0-based)
+     * @returns Comment ID
+     */
+    getCommentId(index: number): number;
+    /**
+     * Get comment IDs at the current cursor position
+     * @returns Array of comment IDs at cursor
+     */
+    getCommentsAtCursor(): number[];
     /**
      * Get current selection state
      */
     getSelectionState(): SelectionState;
+    /**
+     * Get the format at the cursor position or the start of the selection.
+     * This returns the actual format of a single run, not the consensus of the selection.
+     * Used for copy/paste format functionality.
+     */
+    getCursorFormat(): CopiedFormat;
     /**
      * Handle mouse click on canvas
      */
@@ -179,6 +466,16 @@ export declare class DocvyuEditor {
      * Handle mouse drag on canvas
      */
     handleMouseDrag(x: number, y: number): void;
+    /**
+     * Get hyperlink URL at the given screen coordinates
+     * Returns empty string if no hyperlink at that position
+     */
+    getHyperlinkAtPosition(x: number, y: number): string;
+    /**
+     * Navigate to an internal bookmark by name
+     * Returns the Y scroll position if found, -1 if not found
+     */
+    navigateToBookmark(name: string): number;
     /**
      * Handle keyboard input
      */
@@ -207,16 +504,71 @@ export declare class DocvyuEditor {
      * Translate a key with optional parameters
      */
     translate(key: string, params?: Record<string, string | number>): string;
+    /**
+     * Insert a header (or enter editing if one exists)
+     */
+    insertHeader(): void;
+    /**
+     * Insert a footer (or enter editing if one exists)
+     */
+    insertFooter(): void;
+    /**
+     * Enter header editing mode (only if header exists)
+     */
+    enterHeaderEditing(): void;
+    /**
+     * Enter footer editing mode (only if footer exists)
+     */
+    enterFooterEditing(): void;
+    /**
+     * Get the current edit context (body, header, footer)
+     */
+    getEditContext(): string;
     /**
      * Destroy the editor and free resources
      */
     destroy(): void;
     private ensureInitialized;
+    private ensureLicenseValid;
     private ensureFeature;
     private notifySelectionChange;
     private startCursorBlink;
     private stopCursorBlink;
     private resetCursorBlink;
+    setStrikethrough(enable: boolean): void;
+    getRevisionCount(): number;
+    getRevisionsJson(): string;
+    acceptRevision(revisionId: number): void;
+    rejectRevision(revisionId: number): void;
+    acceptAllRevisions(): void;
+    rejectAllRevisions(): void;
+    insertPageNumberField(fieldType: string): void;
+    insertPageXOfY(): void;
+    getPageOrientation(): string;
+    setPageOrientation(orient: string): void;
+    getColumnCount(): number;
+    setColumnCount(count: number): void;
+    hasColumns(): boolean;
+    insertSectionBreak(breakType: string): void;
+    getSectionBreakType(): string;
+    getBookmarkCount(): number;
+    getBookmarksJson(): string;
+    getBookmarkNames(): string;
+    hasBookmark(name: string): boolean;
+    selectBookmark(name: string): boolean;
+    insertBookmark(name: string): void;
+    generateTocJson(): string;
+    getTocEntryCount(): number;
+    navigateToTocEntry(index: number): boolean;
+    getDocumentPropertiesJson(): string;
+    getDocumentTitle(): string | undefined;
+    setDocumentTitle(title: string): void;
+    getDocumentCreator(): string | undefined;
+    setDocumentCreator(creator: string): void;
+    calculateWordCount(): number;
+    calculateCharacterCount(): number;
+    getPageCount(): number;
+    getCurrentPage(): number;
 }
 /**
  * Create a new DocVyu editor instance

package/dist/types/core/index.d.ts

@@ -1 +1 @@
-export { DocvyuEditor, createEditor, type EditorConfig, type SelectionState, type EditorMargins, type Alignment, type NumberingFormat, type RulerUnit, type PageSize, } from './DocvyuEditor';
+export { DocvyuEditor, createEditor, type EditorConfig, type SelectionState, type CopiedFormat, type EditorMargins, type Alignment, type NumberingFormat, type RulerUnit, type PageSize, } from './DocvyuEditor';