@onodocs/canvas 0.2.0

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

@@ -0,0 +1,508 @@
+import type { GeometryPathOperation } from "../foundation/index.js";
+/** Spec: document.body.table.fixed-grid.border.patterned#dash-endpoint-coverage */
+/** Spec: document.body.drawing.picture-soft-edges */
+/** Spec: document.body.drawing.vector-image.ordinary-emf */
+/** Spec: document.body.drawing.shape.outer-shadow */
+/** Spec: document.body.drawing.shape.alpha */
+/** 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";
+export interface PaintRectangle {
+    readonly x: bigint;
+    readonly y: bigint;
+    readonly width: bigint;
+    readonly height: bigint;
+}
+export interface PaintFillRectangleCommand {
+    readonly kind: "fillRectangle";
+    readonly order: number;
+    readonly color: string;
+    readonly rectangle: PaintRectangle;
+    /** Spec: `spec/pipeline/render/page-display-list/_index.md#target-pixel-aligned-rectangle-marker-copying`. */
+    readonly targetPixelAligned?: true;
+    /** Spec: `spec/document/body/table/fixed-grid/border/device-replay.md#device-minimum-representation-and-replay`; `spec/pipeline/render/page-display-list/_index.md#fixed-grid-compound-border-marker-copying`; `spec/pipeline/render/canvas/table-border-device-minimum-replay.md#table-border-device-minimum-replay`. */
+    readonly tableBorderDeviceMinimum?: Readonly<{
+        readonly endExclusive?: true;
+        readonly startJunction?: Readonly<{
+            readonly numerator: bigint;
+            readonly denominator: bigint;
+        }>;
+        readonly endJunction?: Readonly<{
+            readonly numerator: bigint;
+            readonly denominator: bigint;
+        }>;
+        readonly orientation: "horizontal" | "vertical";
+        readonly authoredThickness: Readonly<{
+            readonly numerator: bigint;
+            readonly denominator: bigint;
+        }>;
+        readonly compound?: Readonly<{
+            readonly outer: Readonly<{
+                readonly numerator: bigint;
+                readonly denominator: bigint;
+            }>;
+            readonly gap: Readonly<{
+                readonly numerator: bigint;
+                readonly denominator: bigint;
+            }>;
+            readonly inner: Readonly<{
+                readonly numerator: bigint;
+                readonly denominator: bigint;
+            }>;
+            readonly stripe: "outer" | "inner";
+            readonly mirrored: boolean;
+        }>;
+    }>;
+    /** Spec: `spec/pipeline/render/page-display-list/_index.md#section-column-separator-marker-copying`. */
+    readonly sectionColumnSeparatorDeviceMinimum?: Readonly<{
+        readonly authoredThickness: Readonly<{
+            readonly numerator: bigint;
+            readonly denominator: bigint;
+        }>;
+    }>;
+}
+/** Spec: `spec/pipeline/render/canvas/paragraph-border-paint-replay.md#mechanical-display-list-and-canvas-replay`. */
+/** Spec: `spec/pipeline/layout/header-footer/paragraph-boxes.md#shared-table-geometry-and-clipping`. */
+export interface PaintFillPolygonCommand {
+    readonly clip?: Readonly<{
+        readonly x: bigint;
+        readonly y: bigint;
+        readonly width: bigint;
+        readonly height: bigint;
+    }>;
+    readonly kind: "fillPolygon";
+    readonly order: number;
+    readonly color: string;
+    readonly points: readonly [Readonly<{
+        readonly x: bigint;
+        readonly y: bigint;
+    }>, Readonly<{
+        readonly x: bigint;
+        readonly y: bigint;
+    }>, Readonly<{
+        readonly x: bigint;
+        readonly y: bigint;
+    }>, Readonly<{
+        readonly x: bigint;
+        readonly y: bigint;
+    }>];
+}
+/** Spec: `spec/pipeline/render/page-display-list/positioned-text/_index.md#positioned-text-command`. */
+export interface PaintPositionedGlyph {
+    readonly glyphId: string;
+    readonly path: readonly import("../foundation/index.js").BrowserTextOperation[];
+}
+/** Spec: `spec/pipeline/render/page-display-list/positioned-text/_index.md#positioned-text-command`. */
+export interface PaintVerticalPlacement {
+    readonly alignment: "baseline" | "superscript" | "subscript";
+    readonly scale: Readonly<{
+        readonly numerator: bigint;
+        readonly denominator: bigint;
+    }>;
+    readonly baselineShift: Readonly<{
+        readonly numerator: bigint;
+        readonly denominator: bigint;
+    }>;
+}
+/** Spec: `spec/pipeline/render/page-display-list/positioned-text/_index.md#effective-positioned-glyph-color-projection`; `spec/pipeline/render/page-display-list/positioned-text/_index.md#positioned-text-command`. */
+export interface PaintPositionedTextRun {
+    readonly faceId: string;
+    readonly fontSize: number;
+    readonly textScalePercent: number;
+    readonly direction: "ltr" | "rtl";
+    readonly placement: PaintVerticalPlacement;
+    readonly color: string;
+    readonly glyphs: readonly PaintPositionedGlyph[];
+}
+/** Spec: `spec/pipeline/render/page-display-list/positioned-text/run-effects.md#explicit-pass-copying`. */
+export interface PaintPositionedTextEffectPass {
+    readonly kind: "shadow" | "outline" | "face" | "relief";
+    readonly color: string;
+    readonly deviceOffset: Readonly<{
+        readonly x: number;
+        readonly y: number;
+    }>;
+    readonly layoutOffset: Readonly<{
+        readonly x: number;
+        readonly y: number;
+    }>;
+    readonly clip?: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+    readonly glyphRun: PaintPositionedTextRun;
+    readonly underlines: readonly PaintPositionedUnderline[];
+    readonly strikes: readonly PaintPositionedStrike[];
+}
+/** Spec: `spec/pipeline/render/page-display-list/positioned-text/_index.md#positioned-text-command`. */
+export interface PaintPositionedTextClip {
+    readonly x: number;
+    readonly y: number;
+    readonly width: number;
+    readonly height: number;
+}
+/** Spec: `spec/pipeline/render/page-display-list/positioned-text/shading.md#positioned-text-shading-compilation`. */
+export interface PaintPositionedShading {
+    readonly color: string;
+    readonly rectangle: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+}
+/** Spec: `spec/pipeline/render/page-display-list/positioned-text/highlight.md#highlight-command-compilation`. */
+export interface PaintPositionedHighlight {
+    readonly color: string;
+    readonly rectangle: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+    readonly deviceCoverage: "targetPixelAligned";
+}
+/** Spec: `spec/document/body/text/run/border/paint-publication.md#sealed-display-list-and-canvas-replay`. */
+export interface PaintPositionedBorder {
+    readonly side: "top" | "right" | "bottom" | "left";
+    readonly color: string;
+    readonly rectangle: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+}
+/** Spec: `spec/pipeline/render/page-display-list/positioned-text/decoration.md#underline-command-compilation`; `spec/pipeline/layout/text/decoration/pattern-realization.md#final-pattern-geometry`. */
+export interface PaintPositionedUnderline {
+    readonly style: "single" | "double" | "thick" | "dotted" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dotDash" | "dashDotHeavy" | "dotDotDash" | "dashDotDotHeavy" | "wave" | "wavyHeavy" | "wavyDouble";
+    readonly color: string;
+    readonly rectangle: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+    readonly path?: readonly GeometryPathOperation[];
+    readonly strokeWidth?: number;
+}
+/** Spec: `spec/pipeline/render/page-display-list/positioned-text/decoration.md#strike-command-compilation`. */
+export interface PaintPositionedStrike {
+    readonly style: "single" | "double";
+    readonly color: string;
+    readonly rectangle: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+}
+/** Spec: `spec/pipeline/render/page-display-list/positioned-text/emphasis-marks.md#mechanical-final-path-copying`. */
+export interface PaintPositionedEmphasisMark {
+    readonly color: string;
+    readonly path: readonly GeometryPathOperation[];
+}
+/** Spec: `spec/pipeline/render/page-display-list/positioned-text/authored-bar-tab.md#mechanical-authored-bar-replay`. */
+/**
+ * Spec: `spec/pipeline/render/page-display-list/positioned-text/_index.md#positioned-text-command`; `spec/pipeline/render/page-display-list/positioned-text/run-effects.md#explicit-pass-copying`; `spec/pipeline/render/page-display-list/positioned-text/authored-bar-tab.md#mechanical-authored-bar-replay`; `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#underline-command-compilation`; `spec/pipeline/render/page-display-list/positioned-text/decoration.md#strike-command-compilation`.
+ */
+export interface PaintPositionedTextCommand {
+    /** Spec: document.body.drawing.vml.textboxes */
+    readonly transform?: PaintRasterImageTransform;
+    readonly physicalClips?: readonly Readonly<{
+        rectangle: PaintPositionedTextClip;
+        transform?: PaintRasterImageTransform;
+    }>[];
+    readonly kind: "positionedText";
+    readonly order: number;
+    readonly clip: PaintPositionedTextClip | null;
+    readonly shadings: readonly PaintPositionedShading[];
+    readonly highlights: readonly PaintPositionedHighlight[];
+    readonly shadows?: readonly PaintPositionedBorder[];
+    readonly borders: readonly PaintPositionedBorder[];
+    readonly glyphRuns: readonly PaintPositionedTextRun[];
+    readonly underlines: readonly PaintPositionedUnderline[];
+    readonly strikes: readonly PaintPositionedStrike[];
+    readonly emphasisMarks: readonly PaintPositionedEmphasisMark[];
+    readonly effectPasses?: readonly PaintPositionedTextEffectPass[];
+}
+/** Spec: `spec/pipeline/render/page-display-list/inline-raster-image.md#inline-raster-image-command`. */
+export type PaintInlineRasterImageResourceReference = import("../foundation/index.js").ImageResourceId;
+/** Spec: document.body.drawing.vector-image */
+export type PaintInlineSvgImageResourceChoice = Exclude<import("../foundation/index.js").ImageResourceReference, PaintInlineRasterImageResourceReference>;
+/** Spec: document.body.drawing.vector-image */
+export type PaintInlineImageResourceReference = import("../foundation/index.js").ImageResourceReference;
+/** Spec: `spec/pipeline/render/page-display-list/inline-raster-image.md#inline-raster-image-command`. */
+export interface PaintInlineRasterImageSampling {
+    readonly type: "intrinsicPixelGrid";
+    /** Spec: spec/document/body/drawing/group/wordprocessing-group.md */
+    readonly shapeFill?: true;
+    readonly intrinsicPixelSize: Readonly<{
+        readonly width: number;
+        readonly height: number;
+    }>;
+    /** Spec: `spec/pipeline/render/page-display-list/inline-raster-image.md#reduced-bitmap-sampling-facts`. */
+    readonly verticalOriginOffset?: number;
+    readonly clipToRectangle?: boolean;
+}
+/** Spec: `spec/pipeline/render/page-display-list/inline-raster-image.md#inline-raster-image-command`. */
+export interface PaintInlineRasterImageClip {
+    readonly x: number;
+    readonly y: number;
+    readonly width: number;
+    readonly height: number;
+}
+/** Spec: `spec/pipeline/render/page-display-list/inline-raster-image.md#page-anchored-final-transform-copying`. */
+export interface PaintRasterImageTransform {
+    readonly a: number;
+    readonly b: number;
+    readonly c: number;
+    readonly d: number;
+    readonly e: number;
+    readonly f: number;
+}
+/** Spec: `spec/pipeline/render/page-display-list/inline-raster-image.md#inline-raster-image-command`. */
+export interface PaintInlineRasterImageCommand {
+    readonly shadow?: import("../foundation/index.js").PositionedVectorShapeShadow;
+    readonly softEdgeRadius?: number;
+    /** Spec: spec/document/body/drawing/group/wordprocessing-group.md */
+    readonly physicalClips?: PaintPositionedTextCommand["physicalClips"];
+    readonly kind: "inlineRasterImage";
+    readonly order: number;
+    readonly resource: PaintInlineImageResourceReference;
+    readonly opacity: number;
+    readonly colorEffect?: RasterColorEffectPlan;
+    readonly sourceCrop?: RasterSourceRectangle;
+    readonly clip: PaintInlineRasterImageClip | null;
+    readonly rectangle: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+    readonly transform?: PaintRasterImageTransform;
+    readonly sampling?: PaintInlineRasterImageSampling;
+}
+/** Specs: `spec/pipeline/render/vector-graphics/preset-shape/transport-and-publication.md#direct-preset-shape-display-list-command`; `spec/pipeline/render/vector-graphics/preset-shape/contours-and-record-order.md#ordered-records-with-independent-paint-gates`; `spec/pipeline/render/vector-graphics/preset-shape/path-local-fill-effects.md#final-path-fill-resolution`. */
+/** Spec: document.body.drawing.shape.direct-gradients */
+export type PaintVectorShapeFill = Readonly<{
+    kind: "radialGradient";
+    center: Readonly<{
+        x: number;
+        y: number;
+    }>;
+    radius: number;
+    stops: readonly import("../foundation/index.js").VectorGradientStop[];
+}> | Exclude<VectorShapeFill, {
+    kind: "linearGradient" | "rectangularGradient" | "radialGradient";
+}> | Readonly<{
+    kind: "linearGradient";
+    start: Readonly<{
+        x: number;
+        y: number;
+    }>;
+    end: Readonly<{
+        x: number;
+        y: number;
+    }>;
+    stops: readonly import("../foundation/index.js").VectorGradientStop[];
+}> | Readonly<{
+    kind: "gradientPolygons";
+    polygons: readonly Readonly<{
+        points: readonly Readonly<{
+            x: number;
+            y: number;
+        }>[];
+        start: Readonly<{
+            x: number;
+            y: number;
+        }>;
+        end: Readonly<{
+            x: number;
+            y: number;
+        }>;
+        stops: readonly import("../foundation/index.js").VectorGradientStop[];
+    }>[];
+}>;
+/** Spec: pipeline.render.vector-graphics.preset-shape.transport-and-publication */
+export interface PaintVectorShapePathRecord {
+    readonly operations: VectorShapePath;
+    readonly fill: PaintVectorShapeFill;
+    readonly stroke: boolean;
+    readonly fillRule?: "evenodd" | "nonzero";
+}
+/** Spec: pipeline.render.vector-graphics.preset-shape.transport-and-publication */
+export interface PaintVectorShapeCommand {
+    readonly kind: "vectorShape";
+    readonly order: number;
+    readonly paths: readonly PaintVectorShapePathRecord[];
+    readonly clip: PaintPositionedTextClip | null;
+    readonly shadow?: import("../foundation/index.js").PositionedVectorShapeShadow;
+    readonly stroke?: Readonly<{
+        readonly color: `#${string}`;
+        readonly opacity?: number;
+        readonly width: number;
+        readonly deviceHairline?: true;
+        readonly cap: "butt";
+        readonly join: "round" | "bevel" | "miter";
+    }>;
+    readonly transform?: PaintRasterImageTransform;
+}
+/** Spec: `spec/pipeline/render/page-display-list/comment-projection.md#mechanical-main-document-comment-annotation-projection`. */
+export interface PaintCommentAnnotationCommand {
+    readonly kind: "commentAnnotation";
+    readonly order: number;
+    readonly commentId: string;
+    readonly color: string;
+    readonly rectangle: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+    readonly indicator: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+    readonly indicatorParts: readonly Readonly<{
+        readonly color: string;
+        readonly rectangle: Readonly<{
+            readonly x: number;
+            readonly y: number;
+            readonly width: number;
+            readonly height: number;
+        }>;
+    }>[];
+    readonly accessibility: Readonly<{
+        readonly role: "comment";
+        readonly label: string;
+    }>;
+    readonly selection: Readonly<{
+        readonly kind: "comment";
+        readonly commentId: string;
+    }>;
+}
+export type PaintCommand = PaintFillRectangleCommand | PaintFillPolygonCommand | PaintPositionedTextCommand | PaintInlineRasterImageCommand | PaintVectorShapeCommand | PaintCommentAnnotationCommand;
+/** Spec: `spec/document/body/text/paragraph/hyperlink/external.md#hit-region-contract`. */
+export interface ExternalHyperlinkHitRegion {
+    readonly kind: "externalHyperlink";
+    readonly target: string;
+    readonly tooltip: string | null;
+    readonly rectangle: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+}
+/** Spec: `spec/document/body/text/paragraph/hyperlink/internal.md#hit-region-contract`. */
+export interface InternalHyperlinkHitRegion {
+    readonly kind: "internalHyperlink";
+    readonly destination: Readonly<{
+        readonly pageIndex: number;
+        readonly x: number;
+        readonly y: number;
+    }>;
+    readonly rectangle: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+}
+/** Spec: `spec/pipeline/render/page-display-list/comment-projection.md#mechanical-main-document-comment-annotation-projection`. */
+export interface CommentHitRegion {
+    readonly kind: "comment";
+    readonly commentId: string;
+    readonly rectangle: Readonly<{
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    }>;
+}
+export interface PageDisplayList {
+    readonly fonts?: readonly import("../foundation/index.js").FontFaceResource[];
+    readonly images?: import("../foundation/index.js").ImageResourceData;
+    readonly evaluation?: boolean;
+    readonly pageIndex: number;
+    readonly pageBounds: PaintRectangle | null;
+    readonly commands: readonly PaintCommand[];
+    readonly hitRegions: readonly (ExternalHyperlinkHitRegion | InternalHyperlinkHitRegion | CommentHitRegion)[];
+}
+export interface CanvasPaintTarget {
+    font: string;
+    direction: CanvasDirection;
+    textAlign: CanvasTextAlign;
+    textBaseline: CanvasTextBaseline;
+    fontKerning: CanvasFontKerning;
+    letterSpacing: string;
+    canvas?: {
+        lang: string;
+    };
+    fillText(text: string, x: number, y: number): void;
+    fillStyle: string | CanvasPattern | CanvasGradient;
+    strokeStyle: string | CanvasGradient | CanvasPattern;
+    lineWidth: number;
+    lineCap: CanvasLineCap;
+    lineJoin: CanvasLineJoin;
+    globalAlpha: number;
+    shadowColor?: string;
+    shadowBlur?: number;
+    shadowOffsetX?: number;
+    shadowOffsetY?: number;
+    imageSmoothingEnabled: boolean;
+    /** Spec: `spec/pipeline/render/canvas/raster-sampling/minification.md`. */
+    imageSmoothingQuality?: ImageSmoothingQuality;
+    /** Spec: `spec/pipeline/render/canvas/_index.md#target-pixel-aligned-rectangle-replay`. */
+    getTransform(): Readonly<{
+        readonly a: number;
+        readonly b: number;
+        readonly c: number;
+        readonly d: number;
+        readonly e: number;
+        readonly f: number;
+    }>;
+    save(): void;
+    restore(): void;
+    transform(a: number, b: number, c: number, d: number, e: number, f: number): void;
+    fillRect(x: number, y: number, width: number, height: number): void;
+    beginPath(): void;
+    rect(x: number, y: number, width: number, height: number): void;
+    clip(fillRule?: "evenodd" | "nonzero"): void;
+    moveTo(x: number, y: number): void;
+    lineTo(x: number, y: number): void;
+    quadraticCurveTo(controlX: number, controlY: number, x: number, y: number): void;
+    bezierCurveTo(control1X: number, control1Y: number, control2X: number, control2Y: number, x: number, y: number): void;
+    closePath(): void;
+    fill(fillRule?: "evenodd" | "nonzero"): void;
+    createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, r1: number): CanvasGradient;
+    createLinearGradient(x0: number, y0: number, x1: number, y1: number): CanvasGradient;
+    stroke(): void;
+    drawImage(image: CanvasImageSource, x: number, y: number, width: number, height: number): void;
+    drawImage(image: CanvasImageSource, sx: number, sy: number, sw: number, sh: number, dx: number, dy: number, dw: number, dh: number): void;
+}
+/** Spec: `spec/pipeline/render/canvas/_index.md#canvas-materialization`. */
+export interface CanvasImageResourceMaterializer {
+    resolveRasterImage(resource: PaintInlineImageResourceReference, colorEffect?: RasterColorEffectPlan): CanvasImageSource | undefined;
+    resolvePreparedRasterImage(resource: PaintInlineImageResourceReference, devicePixelSize: Readonly<{
+        readonly width: number;
+        readonly height: number;
+    }>, colorEffect?: RasterColorEffectPlan, flipHorizontal?: boolean, flipVertical?: boolean): CanvasImageSource | undefined;
+    resolveRasterImageIntrinsicPixelSize?(resource: PaintInlineImageResourceReference, colorEffect?: RasterColorEffectPlan): Readonly<{
+        readonly width: number;
+        readonly height: number;
+    }> | undefined;
+}
+/** Spec: `spec/pipeline/render/page-display-list/inline-raster-image.md#inline-raster-image-command`. */
+export interface InlineRasterImagePaintFactResolver {
+    resolveRasterImageIntrinsicPixelSize(resource: PaintInlineImageResourceReference, colorEffect?: RasterColorEffectPlan): Readonly<{
+        readonly width: number;
+        readonly height: number;
+    }> | undefined;
+}
+//# sourceMappingURL=page-display-list.d.ts.map

package/types/render-api/page-source.d.ts

@@ -0,0 +1,23 @@
+/** Spec: pipeline.sdk.page-source */
+import type { PageDisplayList } from "./page-display-list.js";
+export interface PageSize {
+    readonly width: number;
+    readonly height: number;
+}
+export interface PageDescriptor {
+    readonly interaction: import("../foundation/index.js").PageInteraction;
+    readonly index: number;
+    readonly size: PageSize;
+}
+export interface DocumentSource {
+    readonly disposed?: boolean;
+    readonly pages: readonly PageSource[];
+    subscribe?(listener: () => void): () => void;
+}
+export interface PageSource extends PageDescriptor {
+    load(signal?: AbortSignal): Promise<PageDisplayList>;
+}
+export interface DocumentManifest {
+    readonly pages: readonly PageDescriptor[];
+}
+//# sourceMappingURL=page-source.d.ts.map