@onodocs/canvas 0.3.0 → 0.5.0

package/types/canvas/index.d.ts

@@ -1,3 +1,4 @@
+/** Spec: pipeline.sdk.pdf-export */
 /** Spec: pipeline.sdk.page-source */
 import { type PageInteraction } from "../foundation/index.js";
 import type { DocumentSource, PageSize } from "../render-api/index.js";
@@ -5,6 +6,7 @@ import type { DocumentView, ViewOptions } from "./presentation.js";
 export { materializePageDisplayListToCanvas } from "./canvas-materializer.js";
 export { encode, decode } from "./transport.js";
 export type * from "../render-api/index.js";
+export type { SelectionOverlay } from "./text-selection.js";
 export type { DocumentView, ViewOptions, ViewAnchor, DocumentAttachment, AttachmentOptions, AttachmentPlacement } from "./presentation.js";
 export interface DocumentPage {
     readonly index: number;
@@ -12,6 +14,7 @@ export interface DocumentPage {
     readonly interaction: PageInteraction;
     render(canvas: HTMLCanvasElement, options?: Readonly<{
         dpi?: number;
+        background?: "white" | "transparent";
         signal?: AbortSignal;
     }>): Promise<void>;
 }

package/types/canvas/presentation.d.ts

@@ -2,6 +2,7 @@
 /** Spec: pipeline.sdk.presentation */
 import type { DocumentFragment, DocumentHit, DocumentPoint, DocumentSelection } from "../render-api/index.js";
 import type { DocumentPage, PageSize } from "./index.js";
+import { type SelectionOverlay } from "./text-selection.js";
 export interface ViewOptions {
     readonly zoom?: number | "fit-width";
     readonly gap?: number;
@@ -20,6 +21,7 @@ export type AttachmentOptions = Readonly<{
     anchor: ViewAnchor;
     offset?: DocumentPoint;
     size?: PageSize;
+    interactive?: boolean;
 }> & (Readonly<{
     placement?: "overlay";
     inset?: never;
@@ -46,6 +48,7 @@ export interface DocumentView {
     hitTest(point: DocumentPoint): DocumentHit | undefined;
     readonly selection: DocumentSelection | undefined;
     setSelection(selection: DocumentSelection): void;
+    setSelectionOverlays(selections: readonly SelectionOverlay[]): void;
     scrollTo(anchor: ViewAnchor, options?: ScrollIntoViewOptions): boolean;
     attach(element: HTMLElement, options: AttachmentOptions): DocumentAttachment;
     dispose(): void;

package/types/canvas/text-selection.d.ts

@@ -1,8 +1,14 @@
 import type { DocumentSelection, PageTextLine } from "../render-api/index.js";
 import type { DocumentPage } from "./index.js";
+export interface SelectionOverlay {
+    readonly selection: DocumentSelection;
+    readonly label: string;
+    readonly color: string;
+}
 /** Spec: pipeline.sdk.presentation */
 export declare function mountTextSelection(pageText: readonly PageTextLine[], viewport: HTMLElement, shells: readonly HTMLElement[], pageBounds: readonly DocumentPage["size"][], nearby: ReadonlySet<number>, signal: AbortSignal, input?: HTMLTextAreaElement, onSelectionChange?: (selection: DocumentSelection | undefined) => void): {
     paint: () => void;
+    setSelectionOverlays(values: readonly SelectionOverlay[]): void;
     readonly selection: DocumentSelection | undefined;
     setSelection(value: DocumentSelection): void;
 };

package/types/foundation/page-interaction.d.ts

@@ -43,6 +43,7 @@ export interface DocumentHit {
     }>;
 }
 export interface PageTextLine {
+    readonly ink?: PageRectangle;
     readonly pageIndex: number;
     readonly order: number;
     readonly clip: PageRectangle | null;
@@ -52,6 +53,12 @@ export interface PageTextLine {
         transform?: PageTransform;
     }>[];
     readonly selection: Readonly<{
+        storyId?: string;
+        generated?: readonly Readonly<{
+            text: string;
+            x: number;
+            width: number;
+        }>[];
         transform?: PageTransform;
         paragraphId: string;
         sourceOrder?: bigint;
@@ -86,9 +93,19 @@ export interface PageHitLine {
     readonly emptyParagraph: boolean;
 }
 export interface PageInteraction {
+    readonly readingOrder: readonly Readonly<{
+        text: string;
+        headingLevel?: number;
+    }>[];
+    /** Spec: pipeline.sdk.pdf-export */
+    readonly figures?: readonly Readonly<{
+        elementId: string;
+        fragment: DocumentFragment;
+    }>[];
     readonly text: readonly PageTextLine[];
     readonly lines: readonly PageHitLine[];
     readonly areas: readonly Readonly<{
+        kind?: "image";
         elementId: string;
         fragment: DocumentFragment;
     }>[];

package/types/render-api/page-display-list.d.ts

@@ -7,6 +7,10 @@ import type { GeometryPathOperation } from "../foundation/index.js";
 /** Spec: spec/document/body/drawing/vml/gradient-fills.md */
 /** Spec: `spec/pipeline/render/page-display-list/_index.md`; `spec/pipeline/render/page-display-list/positioned-text/shading.md#positioned-text-shading-compilation`; `spec/pipeline/render/page-display-list/positioned-text/highlight.md#highlight-command-compilation`; `spec/pipeline/render/page-display-list/positioned-text/decoration.md#strike-command-compilation`. */
 import type { RasterColorEffectPlan, RasterSourceRectangle, VectorShapeFill, VectorShapePath } from "../foundation/index.js";
+/** Spec: pipeline.render.page-display-list.comment-projection */
+export interface PageDisplayListOptions {
+    readonly commentDisplay?: "markers" | "hidden";
+}
 export interface PaintRectangle {
     readonly x: bigint;
     readonly y: bigint;