@embedpdf/plugin-selection 1.0.5 → 1.0.7

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { BasePluginConfig, Action, BasePlugin, PluginRegistry, PluginManifest, PluginPackage } from '@embedpdf/core';
-import { PdfPageGeometry, Rect, PdfEngine } from '@embedpdf/models';
+import { BasePluginConfig, EventHook, Action, BasePlugin, PluginRegistry, PluginManifest, PluginPackage } from '@embedpdf/core';
+import { PdfTask, PdfPageGeometry, Rect, PdfEngine } from '@embedpdf/models';
 
 interface SelectionPluginConfig extends BasePluginConfig {
 }
@@ -17,22 +17,48 @@ interface SelectionState {
     /** current selection or null */
     rects: Record<number, Rect[]>;
     selection: SelectionRangeX | null;
+    slices: Record<number, {
+        start: number;
+        count: number;
+    }>;
     active: boolean;
     selecting: boolean;
 }
+interface FormattedSelection {
+    pageIndex: number;
+    rect: Rect;
+    segmentRects: Rect[];
+}
 interface SelectionCapability {
-    getGeometry(page: number): Promise<PdfPageGeometry>;
-    getHighlightRects(page: number): Rect[];
-    getBoundingRect(page: number): Rect | null;
+    getGeometry(page: number): PdfTask<PdfPageGeometry>;
+    getFormattedSelection(): FormattedSelection[];
+    getFormattedSelectionForPage(page: number): FormattedSelection | null;
+    getHighlightRectsForPage(page: number): Rect[];
+    getHighlightRects(): Record<number, Rect[]>;
+    getBoundingRectForPage(page: number): Rect | null;
     getBoundingRects(): {
         page: number;
         rect: Rect;
     }[];
+    getSelectedText(): PdfTask<string[]>;
+    copyToClipboard(): void;
     begin(page: number, glyphIdx: number): void;
     update(page: number, glyphIdx: number): void;
     end(): void;
     clear(): void;
-    onSelectionChange(cb: (r: SelectionRangeX | null) => void): () => void;
+    onSelectionChange: EventHook<SelectionRangeX | null>;
+    onTextRetrieved: EventHook<string[]>;
+    onCopyToClipboard: EventHook<string>;
+    onBeginSelection: EventHook<{
+        page: number;
+        index: number;
+    }>;
+    onEndSelection: EventHook<void>;
+    /** Tell the selection plugin that text selection should stay
+        enabled while <modeId> is active.                    */
+    enableForMode(modeId: string): void;
+    /** Quick check used by SelectionLayer during pointer events. */
+    isEnabledForMode(modeId: string): boolean;
 }
 
 declare const CACHE_PAGE_GEOMETRY = "CACHE_PAGE_GEOMETRY";
@@ -41,6 +67,7 @@ declare const START_SELECTION = "START_SELECTION";
 declare const END_SELECTION = "END_SELECTION";
 declare const CLEAR_SELECTION = "CLEAR_SELECTION";
 declare const SET_RECTS = "SET_RECTS";
+declare const SET_SLICES = "SET_SLICES";
 declare const RESET = "RESET";
 interface CachePageGeometryAction extends Action {
     type: typeof CACHE_PAGE_GEOMETRY;
@@ -64,23 +91,33 @@ interface ClearSelectionAction extends Action {
 }
 interface SetRectsAction extends Action {
     type: typeof SET_RECTS;
-    payload: {
-        page: number;
-        rects: Rect[];
-    };
+    payload: Record<number, Rect[]>;
+}
+interface SetSlicesAction extends Action {
+    type: typeof SET_SLICES;
+    payload: Record<number, {
+        start: number;
+        count: number;
+    }>;
 }
 interface ResetAction extends Action {
     type: typeof RESET;
 }
-type SelectionAction = CachePageGeometryAction | SetSelectionAction | StartSelectionAction | EndSelectionAction | ClearSelectionAction | SetRectsAction | ResetAction;
+type SelectionAction = CachePageGeometryAction | SetSelectionAction | StartSelectionAction | EndSelectionAction | ClearSelectionAction | SetRectsAction | SetSlicesAction | ResetAction;
 
 declare class SelectionPlugin extends BasePlugin<SelectionPluginConfig, SelectionCapability, SelectionState, SelectionAction> {
     private engine;
     static readonly id: "selection";
     private doc?;
+    /** Modes that should trigger text-selection logic */
+    private enabledModes;
     private selecting;
     private anchor?;
     private readonly selChange$;
+    private readonly textRetrieved$;
+    private readonly copyToClipboard$;
+    private readonly beginSelection$;
+    private readonly endSelection$;
     constructor(id: string, registry: PluginRegistry, engine: PdfEngine);
     initialize(): Promise<void>;
     destroy(): Promise<void>;
@@ -89,9 +126,10 @@ declare class SelectionPlugin extends BasePlugin<SelectionPluginConfig, Selectio
     private beginSelection;
     private endSelection;
     private clearSelection;
-    private updateRectsForRange;
     private updateSelection;
-    private buildRectsForPage;
+    private updateRectsAndSlices;
+    private getSelectedText;
+    private copyToClipboard;
 }
 
 declare const SELECTION_PLUGIN_ID = "selection";
@@ -107,7 +145,68 @@ declare function glyphAt(geo: PdfPageGeometry, pt: {
     x: number;
     y: number;
 }): number;
+/**
+ * Helper: min/max glyph indices on `page` for current sel
+ * @param sel - selection range
+ * @param geo - page geometry
+ * @param page - page index
+ * @returns { from: number; to: number } | null
+ */
+declare function sliceBounds(sel: SelectionRangeX | null, geo: PdfPageGeometry | undefined, page: number): {
+    from: number;
+    to: number;
+} | null;
+/**
+ * Helper: build rects for a slice of the page
+ * @param geo - page geometry
+ * @param from - from index
+ * @param to - to index
+ * @param merge - whether to merge adjacent rects (default: true)
+ * @returns rects
+ */
+declare function rectsWithinSlice(geo: PdfPageGeometry, from: number, to: number, merge?: boolean): Rect[];
+/**
+ * ============================================================================
+ * Rectangle Merging Algorithm
+ * ============================================================================
+ *
+ * The following code is adapted from Chromium's PDF text selection implementation.
+ *
+ * Copyright 2010 The Chromium Authors
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file: https://source.chromium.org/chromium/chromium/src/+/main:LICENSE
+ *
+ * Original source:
+ * https://source.chromium.org/chromium/chromium/src/+/main:pdf/pdfium/pdfium_range.cc
+ *
+ * Adapted for TypeScript and this project's Rect/geometry types.
+ */
+/**
+ * Text run info for rect merging (similar to Chromium's ScreenRectTextRunInfo)
+ */
+interface TextRunInfo {
+    rect: Rect;
+    charCount: number;
+}
+/**
+ * Helper functions for Rect operations
+ */
+declare function rectUnion(rect1: Rect, rect2: Rect): Rect;
+declare function rectIntersect(rect1: Rect, rect2: Rect): Rect;
+declare function rectIsEmpty(rect: Rect): boolean;
+/**
+ * Returns a ratio between [0, 1] representing vertical overlap
+ */
+declare function getVerticalOverlap(rect1: Rect, rect2: Rect): number;
+/**
+ * Returns true if there is sufficient horizontal and vertical overlap
+ */
+declare function shouldMergeHorizontalRects(textRun1: TextRunInfo, textRun2: TextRunInfo): boolean;
+/**
+ * Merge adjacent rectangles based on proximity and overlap (similar to Chromium's algorithm)
+ */
+declare function mergeAdjacentRects(textRuns: TextRunInfo[]): Rect[];
 
 declare const SelectionPluginPackage: PluginPackage<SelectionPlugin, SelectionPluginConfig, SelectionState, SelectionAction>;
 
-export { type GlyphPointer, SELECTION_PLUGIN_ID, type SelectionCapability, SelectionPlugin, type SelectionPluginConfig, SelectionPluginPackage, type SelectionRangeX, type SelectionState, glyphAt, manifest };
+export { type FormattedSelection, type GlyphPointer, SELECTION_PLUGIN_ID, type SelectionCapability, SelectionPlugin, type SelectionPluginConfig, SelectionPluginPackage, type SelectionRangeX, type SelectionState, type TextRunInfo, getVerticalOverlap, glyphAt, manifest, mergeAdjacentRects, rectIntersect, rectIsEmpty, rectUnion, rectsWithinSlice, shouldMergeHorizontalRects, sliceBounds };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { BasePluginConfig, Action, BasePlugin, PluginRegistry, PluginManifest, PluginPackage } from '@embedpdf/core';
-import { PdfPageGeometry, Rect, PdfEngine } from '@embedpdf/models';
+import { BasePluginConfig, EventHook, Action, BasePlugin, PluginRegistry, PluginManifest, PluginPackage } from '@embedpdf/core';
+import { PdfTask, PdfPageGeometry, Rect, PdfEngine } from '@embedpdf/models';
 
 interface SelectionPluginConfig extends BasePluginConfig {
 }
@@ -17,22 +17,48 @@ interface SelectionState {
     /** current selection or null */
     rects: Record<number, Rect[]>;
     selection: SelectionRangeX | null;
+    slices: Record<number, {
+        start: number;
+        count: number;
+    }>;
     active: boolean;
     selecting: boolean;
 }
+interface FormattedSelection {
+    pageIndex: number;
+    rect: Rect;
+    segmentRects: Rect[];
+}
 interface SelectionCapability {
-    getGeometry(page: number): Promise<PdfPageGeometry>;
-    getHighlightRects(page: number): Rect[];
-    getBoundingRect(page: number): Rect | null;
+    getGeometry(page: number): PdfTask<PdfPageGeometry>;
+    getFormattedSelection(): FormattedSelection[];
+    getFormattedSelectionForPage(page: number): FormattedSelection | null;
+    getHighlightRectsForPage(page: number): Rect[];
+    getHighlightRects(): Record<number, Rect[]>;
+    getBoundingRectForPage(page: number): Rect | null;
     getBoundingRects(): {
         page: number;
         rect: Rect;
     }[];
+    getSelectedText(): PdfTask<string[]>;
+    copyToClipboard(): void;
     begin(page: number, glyphIdx: number): void;
     update(page: number, glyphIdx: number): void;
     end(): void;
     clear(): void;
-    onSelectionChange(cb: (r: SelectionRangeX | null) => void): () => void;
+    onSelectionChange: EventHook<SelectionRangeX | null>;
+    onTextRetrieved: EventHook<string[]>;
+    onCopyToClipboard: EventHook<string>;
+    onBeginSelection: EventHook<{
+        page: number;
+        index: number;
+    }>;
+    onEndSelection: EventHook<void>;
+    /** Tell the selection plugin that text selection should stay
+        enabled while <modeId> is active.                    */
+    enableForMode(modeId: string): void;
+    /** Quick check used by SelectionLayer during pointer events. */
+    isEnabledForMode(modeId: string): boolean;
 }
 
 declare const CACHE_PAGE_GEOMETRY = "CACHE_PAGE_GEOMETRY";
@@ -41,6 +67,7 @@ declare const START_SELECTION = "START_SELECTION";
 declare const END_SELECTION = "END_SELECTION";
 declare const CLEAR_SELECTION = "CLEAR_SELECTION";
 declare const SET_RECTS = "SET_RECTS";
+declare const SET_SLICES = "SET_SLICES";
 declare const RESET = "RESET";
 interface CachePageGeometryAction extends Action {
     type: typeof CACHE_PAGE_GEOMETRY;
@@ -64,23 +91,33 @@ interface ClearSelectionAction extends Action {
 }
 interface SetRectsAction extends Action {
     type: typeof SET_RECTS;
-    payload: {
-        page: number;
-        rects: Rect[];
-    };
+    payload: Record<number, Rect[]>;
+}
+interface SetSlicesAction extends Action {
+    type: typeof SET_SLICES;
+    payload: Record<number, {
+        start: number;
+        count: number;
+    }>;
 }
 interface ResetAction extends Action {
     type: typeof RESET;
 }
-type SelectionAction = CachePageGeometryAction | SetSelectionAction | StartSelectionAction | EndSelectionAction | ClearSelectionAction | SetRectsAction | ResetAction;
+type SelectionAction = CachePageGeometryAction | SetSelectionAction | StartSelectionAction | EndSelectionAction | ClearSelectionAction | SetRectsAction | SetSlicesAction | ResetAction;
 
 declare class SelectionPlugin extends BasePlugin<SelectionPluginConfig, SelectionCapability, SelectionState, SelectionAction> {
     private engine;
     static readonly id: "selection";
     private doc?;
+    /** Modes that should trigger text-selection logic */
+    private enabledModes;
     private selecting;
     private anchor?;
     private readonly selChange$;
+    private readonly textRetrieved$;
+    private readonly copyToClipboard$;
+    private readonly beginSelection$;
+    private readonly endSelection$;
     constructor(id: string, registry: PluginRegistry, engine: PdfEngine);
     initialize(): Promise<void>;
     destroy(): Promise<void>;
@@ -89,9 +126,10 @@ declare class SelectionPlugin extends BasePlugin<SelectionPluginConfig, Selectio
     private beginSelection;
     private endSelection;
     private clearSelection;
-    private updateRectsForRange;
     private updateSelection;
-    private buildRectsForPage;
+    private updateRectsAndSlices;
+    private getSelectedText;
+    private copyToClipboard;
 }
 
 declare const SELECTION_PLUGIN_ID = "selection";
@@ -107,7 +145,68 @@ declare function glyphAt(geo: PdfPageGeometry, pt: {
     x: number;
     y: number;
 }): number;
+/**
+ * Helper: min/max glyph indices on `page` for current sel
+ * @param sel - selection range
+ * @param geo - page geometry
+ * @param page - page index
+ * @returns { from: number; to: number } | null
+ */
+declare function sliceBounds(sel: SelectionRangeX | null, geo: PdfPageGeometry | undefined, page: number): {
+    from: number;
+    to: number;
+} | null;
+/**
+ * Helper: build rects for a slice of the page
+ * @param geo - page geometry
+ * @param from - from index
+ * @param to - to index
+ * @param merge - whether to merge adjacent rects (default: true)
+ * @returns rects
+ */
+declare function rectsWithinSlice(geo: PdfPageGeometry, from: number, to: number, merge?: boolean): Rect[];
+/**
+ * ============================================================================
+ * Rectangle Merging Algorithm
+ * ============================================================================
+ *
+ * The following code is adapted from Chromium's PDF text selection implementation.
+ *
+ * Copyright 2010 The Chromium Authors
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file: https://source.chromium.org/chromium/chromium/src/+/main:LICENSE
+ *
+ * Original source:
+ * https://source.chromium.org/chromium/chromium/src/+/main:pdf/pdfium/pdfium_range.cc
+ *
+ * Adapted for TypeScript and this project's Rect/geometry types.
+ */
+/**
+ * Text run info for rect merging (similar to Chromium's ScreenRectTextRunInfo)
+ */
+interface TextRunInfo {
+    rect: Rect;
+    charCount: number;
+}
+/**
+ * Helper functions for Rect operations
+ */
+declare function rectUnion(rect1: Rect, rect2: Rect): Rect;
+declare function rectIntersect(rect1: Rect, rect2: Rect): Rect;
+declare function rectIsEmpty(rect: Rect): boolean;
+/**
+ * Returns a ratio between [0, 1] representing vertical overlap
+ */
+declare function getVerticalOverlap(rect1: Rect, rect2: Rect): number;
+/**
+ * Returns true if there is sufficient horizontal and vertical overlap
+ */
+declare function shouldMergeHorizontalRects(textRun1: TextRunInfo, textRun2: TextRunInfo): boolean;
+/**
+ * Merge adjacent rectangles based on proximity and overlap (similar to Chromium's algorithm)
+ */
+declare function mergeAdjacentRects(textRuns: TextRunInfo[]): Rect[];
 
 declare const SelectionPluginPackage: PluginPackage<SelectionPlugin, SelectionPluginConfig, SelectionState, SelectionAction>;
 
-export { type GlyphPointer, SELECTION_PLUGIN_ID, type SelectionCapability, SelectionPlugin, type SelectionPluginConfig, SelectionPluginPackage, type SelectionRangeX, type SelectionState, glyphAt, manifest };
+export { type FormattedSelection, type GlyphPointer, SELECTION_PLUGIN_ID, type SelectionCapability, SelectionPlugin, type SelectionPluginConfig, SelectionPluginPackage, type SelectionRangeX, type SelectionState, type TextRunInfo, getVerticalOverlap, glyphAt, manifest, mergeAdjacentRects, rectIntersect, rectIsEmpty, rectUnion, rectsWithinSlice, shouldMergeHorizontalRects, sliceBounds };