canvu-react 0.4.67 → 0.4.68

package/dist/{asset-store-35ysK28r.d.cts → raster-image-canvas-BZh73aoc.d.ts}

@@ -1,4 +1,4 @@
-import { V as VectorSceneItem } from './types-fJNwEnHf.cjs';
+import { V as VectorSceneItem, R as Rect } from './types-fJNwEnHf.js';
 
 /**
  * Kind of binary selected through the built-in canvu asset ingestion flow.
@@ -110,4 +110,72 @@ type VectorViewportAssetStore = {
     getHydrationRequest?: (item: VectorSceneItem) => VectorViewportAssetHydrationRequest | null;
 };
 
-export type { VectorViewportAssetKind as V, VectorViewportAssetStore as a, VectorViewportAssetHydrationRequest as b, VectorViewportAssetResolveRequest as c, VectorViewportAssetResolveResult as d, VectorViewportAssetUploadRequest as e, VectorViewportAssetUploadResult as f };
+/**
+ * Input passed to `imageCanvasRendering.resolveRenderTarget`.
+ *
+ * Use it to map the current image item and zoom-derived bitmap size to the best
+ * available resized URL from your image service. Apps that do not provide a
+ * resolver still get canvas drawing from the original `imageRasterHref`.
+ *
+ * @example
+ * ```ts
+ * const resolveRenderTarget = ({ href, targetSize }) =>
+ *   `${href}&w=${targetSize.width}`;
+ * ```
+ */
+type RasterImageCanvasRenderRequest = {
+    item: VectorSceneItem;
+    href: string;
+    intrinsicSize: {
+        width: number;
+        height: number;
+    };
+    contentRect: Rect;
+    targetSize: {
+        width: number;
+        height: number;
+    };
+    viewportSize: {
+        width: number;
+        height: number;
+    };
+    cameraZoom: number;
+    devicePixelRatio: number;
+};
+/**
+ * Resolved raster source for a zoom-aware canvas redraw.
+ *
+ * Return a stable `sourceKey` when multiple URLs may represent the same bitmap
+ * quality tier. Canvu uses it to avoid redundant redraws and to keep the
+ * previous canvas visible until a sharper target has decoded.
+ */
+type RasterImageCanvasRenderTarget = {
+    href: string;
+    sourceKey?: string;
+};
+/**
+ * Maps an image item plus requested bitmap size to the URL that should be
+ * decoded into the canvas overlay.
+ *
+ * Return a string for simple URL rewriting, an object when you need a custom
+ * `sourceKey`, or `null`/`undefined` to keep using the item's `imageRasterHref`.
+ */
+type RasterImageCanvasRenderTargetResolver = (request: RasterImageCanvasRenderRequest) => string | RasterImageCanvasRenderTarget | null | undefined;
+/**
+ * Enables zoom-aware canvas rendering for image items in `VectorViewport`.
+ *
+ * This is intended for large raster pages such as PDFs. The original SVG image
+ * remains mounted as a fallback, while Canvu decodes and draws a canvas bitmap
+ * sized for the current zoom. On zoom out, Canvu keeps the sharper bitmap
+ * already drawn instead of downgrading immediately.
+ */
+type RasterImageCanvasRenderingOptions = {
+    resolveRenderTarget?: RasterImageCanvasRenderTargetResolver;
+    devicePixelRatio?: number;
+    pixelHeadroom?: number;
+    maxPixelCount?: number;
+    maxDimension?: number;
+    upscaleRedrawRatio?: number;
+};
+
+export type { RasterImageCanvasRenderingOptions as R, VectorViewportAssetKind as V, VectorViewportAssetStore as a, RasterImageCanvasRenderRequest as b, RasterImageCanvasRenderTarget as c, RasterImageCanvasRenderTargetResolver as d, VectorViewportAssetHydrationRequest as e, VectorViewportAssetResolveRequest as f, VectorViewportAssetResolveResult as g, VectorViewportAssetUploadRequest as h, VectorViewportAssetUploadResult as i };

package/dist/{asset-store-D_FjW_CN.d.ts → raster-image-canvas-zerVYllB.d.cts}

@@ -1,4 +1,4 @@
-import { V as VectorSceneItem } from './types-fJNwEnHf.js';
+import { V as VectorSceneItem, R as Rect } from './types-fJNwEnHf.cjs';
 
 /**
  * Kind of binary selected through the built-in canvu asset ingestion flow.
@@ -110,4 +110,72 @@ type VectorViewportAssetStore = {
     getHydrationRequest?: (item: VectorSceneItem) => VectorViewportAssetHydrationRequest | null;
 };
 
-export type { VectorViewportAssetKind as V, VectorViewportAssetStore as a, VectorViewportAssetHydrationRequest as b, VectorViewportAssetResolveRequest as c, VectorViewportAssetResolveResult as d, VectorViewportAssetUploadRequest as e, VectorViewportAssetUploadResult as f };
+/**
+ * Input passed to `imageCanvasRendering.resolveRenderTarget`.
+ *
+ * Use it to map the current image item and zoom-derived bitmap size to the best
+ * available resized URL from your image service. Apps that do not provide a
+ * resolver still get canvas drawing from the original `imageRasterHref`.
+ *
+ * @example
+ * ```ts
+ * const resolveRenderTarget = ({ href, targetSize }) =>
+ *   `${href}&w=${targetSize.width}`;
+ * ```
+ */
+type RasterImageCanvasRenderRequest = {
+    item: VectorSceneItem;
+    href: string;
+    intrinsicSize: {
+        width: number;
+        height: number;
+    };
+    contentRect: Rect;
+    targetSize: {
+        width: number;
+        height: number;
+    };
+    viewportSize: {
+        width: number;
+        height: number;
+    };
+    cameraZoom: number;
+    devicePixelRatio: number;
+};
+/**
+ * Resolved raster source for a zoom-aware canvas redraw.
+ *
+ * Return a stable `sourceKey` when multiple URLs may represent the same bitmap
+ * quality tier. Canvu uses it to avoid redundant redraws and to keep the
+ * previous canvas visible until a sharper target has decoded.
+ */
+type RasterImageCanvasRenderTarget = {
+    href: string;
+    sourceKey?: string;
+};
+/**
+ * Maps an image item plus requested bitmap size to the URL that should be
+ * decoded into the canvas overlay.
+ *
+ * Return a string for simple URL rewriting, an object when you need a custom
+ * `sourceKey`, or `null`/`undefined` to keep using the item's `imageRasterHref`.
+ */
+type RasterImageCanvasRenderTargetResolver = (request: RasterImageCanvasRenderRequest) => string | RasterImageCanvasRenderTarget | null | undefined;
+/**
+ * Enables zoom-aware canvas rendering for image items in `VectorViewport`.
+ *
+ * This is intended for large raster pages such as PDFs. The original SVG image
+ * remains mounted as a fallback, while Canvu decodes and draws a canvas bitmap
+ * sized for the current zoom. On zoom out, Canvu keeps the sharper bitmap
+ * already drawn instead of downgrading immediately.
+ */
+type RasterImageCanvasRenderingOptions = {
+    resolveRenderTarget?: RasterImageCanvasRenderTargetResolver;
+    devicePixelRatio?: number;
+    pixelHeadroom?: number;
+    maxPixelCount?: number;
+    maxDimension?: number;
+    upscaleRedrawRatio?: number;
+};
+
+export type { RasterImageCanvasRenderingOptions as R, VectorViewportAssetKind as V, VectorViewportAssetStore as a, RasterImageCanvasRenderRequest as b, RasterImageCanvasRenderTarget as c, RasterImageCanvasRenderTargetResolver as d, VectorViewportAssetHydrationRequest as e, VectorViewportAssetResolveRequest as f, VectorViewportAssetResolveResult as g, VectorViewportAssetUploadRequest as h, VectorViewportAssetUploadResult as i };