@reekon-tools/boldr-utils 1.24.0 → 1.25.0

package/dist/annotation/canvas/useAnnotationCanvasState.d.ts

@@ -23,6 +23,17 @@ export interface AnnotationCanvasHandle {
         animated?: boolean;
         durationMs?: number;
     }): void;
+    fitDocRect(rect: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }, opts?: {
+        animated?: boolean;
+        durationMs?: number;
+        paddingPx?: number;
+        maxZoom?: number;
+    }): void;
     getTileScaleFactor(): number;
     getHeaderTileScaleFactor(): number;
     getFileTileScaleFactor(): number;

package/dist/annotation/canvas/useAnnotationCanvasState.js

@@ -2,7 +2,7 @@ import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
 import { applyPatch, invertPatch, DEFAULT_LAYER_ID, } from '../../types/annotation.js';
 import { resolveHeaderTileScaleFactor, resolveFileTileScaleFactor, resolveTileScaleFactor, stampTileDims, STAMP_TILE_SIZE, tileDocSizeForFactor, tileScaleFromDocSize, } from './stampLayout.js';
 import { SNAP_RADIUS_PX } from './snapGeometry.js';
-import { createViewportApi, fitRectToScreen, panBy, zoomAt, DEFAULT_VIEWPORT, DEFAULT_ZOOM_LIMITS, } from './viewport.js';
+import { createViewportApi, fitDocRectViewport, fitRectToScreen, panBy, zoomAt, DEFAULT_VIEWPORT, DEFAULT_ZOOM_LIMITS, } from './viewport.js';
 import { computeZoomFloor, pdfFirstPageDocRect } from './pdfDocument.js';
 import { backgroundLayerDocRect, backgroundLayersOf, backgroundLayersUnionRect, } from './backgroundLayers.js';
 import { buildRemoveMeasurementOps, recomputeAnchor, rectCenter, DEFAULT_LINE_POS, } from './measurementGeometry.js';
@@ -555,6 +555,22 @@ export const useAnnotationCanvasState = (props) => {
                     setViewport(target);
                 }
             },
+            fitDocRect(rect, opts) {
+                if (!(width > 0) || !(height > 0))
+                    return;
+                const limits = zoomLimitsRef.current;
+                const target = fitDocRectViewport(rect, width, height, {
+                    paddingPx: opts?.paddingPx,
+                    minZoom: limits.min,
+                    maxZoom: Math.min(opts?.maxZoom ?? limits.max, limits.max),
+                });
+                if (opts?.animated && animateViewport) {
+                    animateViewport(target, opts.durationMs ?? 450);
+                }
+                else {
+                    setViewport(target);
+                }
+            },
             getTileScaleFactor() {
                 return ctxRef.current.tileScaleFactor;
             },

package/dist/annotation/canvas/viewport.d.ts

@@ -24,6 +24,16 @@ export declare const fitRectToScreen: (rect: {
     width: number;
     height: number;
 }, screenWidth: number, screenHeight: number, padding?: number) => ViewportState;
+export declare const fitDocRectViewport: (rect: {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}, screenWidth: number, screenHeight: number, limits?: {
+    paddingPx?: number;
+    minZoom?: number;
+    maxZoom?: number;
+}) => ViewportState;
 export declare const DEFAULT_ZOOM_LIMITS: {
     readonly min: 0.05;
     readonly max: 50;

package/dist/annotation/canvas/viewport.js

@@ -62,6 +62,32 @@ export const fitRectToScreen = (rect, screenWidth, screenHeight, padding = 0) =>
         pan: { x: rect.x - offsetX / zoom, y: rect.y - offsetY / zoom },
     };
 };
+// Frame a DOC-space rect (a text-search hit, a tile) centred in the screen:
+// zoom so the rect plus `paddingPx` of screen padding fits, clamped to
+// [minZoom, maxZoom] — so a two-word hit does not zoom to 50× and a whole-page
+// rect cannot go below the document's floor — then centre the rect at that
+// zoom (screen = (world − pan) · zoom, so pan = centre − half-screen / zoom).
+export const fitDocRectViewport = (rect, screenWidth, screenHeight, limits = {}) => {
+    const safe = {
+        x: rect.x,
+        y: rect.y,
+        width: Math.max(1, rect.width),
+        height: Math.max(1, rect.height),
+    };
+    const fit = fitRectToScreen(safe, screenWidth, screenHeight, limits.paddingPx ?? 0);
+    const upper = limits.maxZoom ?? Number.POSITIVE_INFINITY;
+    const lower = limits.minZoom ?? 0;
+    const zoom = Math.max(lower, Math.min(fit.zoom, upper));
+    const cx = safe.x + safe.width / 2;
+    const cy = safe.y + safe.height / 2;
+    return {
+        zoom,
+        pan: {
+            x: cx - screenWidth / (2 * zoom),
+            y: cy - screenHeight / (2 * zoom),
+        },
+    };
+};
 // Zoom toward a focal screen point so the world point under the cursor stays
 // fixed. Used for wheel-zoom on web and pinch on native.
 //

package/dist/annotation/data/hooks/usePdfCanvasDoc.js

@@ -23,14 +23,17 @@ export const usePdfCanvasDoc = (options) => {
     const provider = useAnnotationData();
     const { data: file, loading: fileLoading, error: fileError, } = useAnnotationDoc(scope, fileId);
     const pdfCanvas = file?.fileData.pdfCanvas ?? null;
-    const [pageDoc, setPageDoc] = useState(null);
+    // The current page's doc, TAGGED with the page it answers for. On a page
+    // turn the previous page's doc is still in state until the new subscription
+    // reports, and hydrating the new page from it is exactly how annotations
+    // land on the wrong page. `state` null = the page has no doc yet.
+    const [pageSnapshot, setPageSnapshot] = useState(null);
     const [pageLoading, setPageLoading] = useState(true);
     const [pageError, setPageError] = useState(null);
     const [working, setWorking] = useState(null);
     const [saveStatus, setSaveStatus] = useState('idle');
     const workingRef = useRef(null);
     const pdfCanvasRef = useRef(null);
-    const pageDocRef = useRef(null);
     const statusRef = useRef('idle');
     const pageIndexRef = useRef(pageIndex);
     const scopeRef = useRef(scope);
@@ -48,10 +51,9 @@ export const usePdfCanvasDoc = (options) => {
     const thumbnailPromiseRef = useRef(undefined);
     // A page whose edits must be persisted although it is no longer the current
     // page (the user turned the page with unsaved edits).
-    const outgoingRef = useRef(null);
+    const outgoingRef = useRef([]);
     workingRef.current = working;
     pdfCanvasRef.current = pdfCanvas;
-    pageDocRef.current = pageDoc;
     statusRef.current = saveStatus;
     scopeRef.current = scope;
     fileIdRef.current = fileId;
@@ -65,14 +67,17 @@ export const usePdfCanvasDoc = (options) => {
     // Subscribe to the current page's doc.
     useEffect(() => {
         if (!scope || !fileId) {
-            setPageDoc(null);
+            setPageSnapshot(null);
             setPageLoading(false);
             return;
         }
+        // Drop the previous page's snapshot synchronously so nothing can read it
+        // as this page's while the subscription is still connecting.
+        setPageSnapshot(null);
         setPageLoading(true);
         setPageError(null);
         const unsubscribe = provider.subscribePage(scope, fileId, pageIndex, (doc) => {
-            setPageDoc(doc);
+            setPageSnapshot({ pageIndex, state: doc });
             setPageLoading(false);
         }, (err) => {
             setPageError(err);
@@ -154,10 +159,10 @@ export const usePdfCanvasDoc = (options) => {
     // One flush pass: an outgoing page first (if a page turn left one behind),
     // then the current page when it is dirty.
     const runFlush = useCallback(async () => {
-        const outgoing = outgoingRef.current;
-        if (outgoing) {
-            outgoingRef.current = null;
-            await persist(outgoing);
+        // Every page left behind with unsaved edits, in the order they were
+        // left: two quick turns must not lose the middle page.
+        while (outgoingRef.current.length > 0) {
+            await persist(outgoingRef.current.shift());
         }
         const canvas = workingRef.current;
         const data = pdfCanvasRef.current;
@@ -200,11 +205,11 @@ export const usePdfCanvasDoc = (options) => {
         if (previous &&
             data &&
             (statusRef.current === 'dirty' || statusRef.current === 'error')) {
-            outgoingRef.current = {
+            outgoingRef.current.push({
                 pageIndex: pageIndexRef.current,
                 canvas: previous,
                 pdfCanvas: data,
-            };
+            });
             void flush();
         }
         pageIndexRef.current = pageIndex;
@@ -225,6 +230,10 @@ export const usePdfCanvasDoc = (options) => {
             return;
         if (pageIndex >= pdfCanvas.document.pages.length)
             return;
+        // Only a snapshot for THIS page counts (see pageSnapshot).
+        if (!pageSnapshot || pageSnapshot.pageIndex !== pageIndex)
+            return;
+        const pageDoc = pageSnapshot.state;
         if (workingRef.current === null) {
             const next = pageStateToCanvasState(pdfCanvas, pageDoc, pageIndex);
             workingRef.current = next;
@@ -241,7 +250,7 @@ export const usePdfCanvasDoc = (options) => {
         workingRef.current = next;
         setWorking(next);
         // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, [pdfCanvas, pageDoc, pageLoading, pageIndex]);
+    }, [pdfCanvas, pageSnapshot, pageLoading, pageIndex]);
     const onCommit = useCallback((patch) => {
         editSeqRef.current += 1;
         setWorking((prev) => {

package/dist/exports.d.ts

@@ -37,7 +37,7 @@ export type { MeasurementStampRenderArgs, RenderMeasurementStamp, } from './anno
 export type { CanvasBackgroundSlotArgs, RenderCanvasBackground, } from './annotation/canvas/backgroundSlot.js';
 export { STAMP_TILE_SIZE, GROUP_HEADER_TILE_WIDTH, GROUP_HEADER_TILE_HEIGHT, GROUP_HEADER_COLLAPSED_WIDTH, GROUP_HEADER_COLLAPSED_HEIGHT, GROUP_HEADER_DESIGN, groupHeaderBaseDims, DEFAULT_TILE_SCALE, TILE_SCALE_MIN, TILE_SCALE_MAX, clampTileScale, resolveTileScaleFactor, resolveHeaderTileScaleFactor, resolveFileTileScaleFactor, tileDocSizeForFactor, tileScaleFromDocSize, stampTileSize, stampTileDims, isUnassociatedStamp, isFileStamp, type StampTileDims, } from './annotation/canvas/stampLayout.js';
 export { GROUP_HEADER_STYLE, describeGroupHeader, groupHeaderSignature, type GroupHeaderBadge, type GroupHeaderDescriptor, } from './annotation/canvas/groupHeaderLayout.js';
-export { createViewportApi, fitToScreen, fitRectToScreen, imageDocRect, panBy, zoomAt, DEFAULT_VIEWPORT, DEFAULT_ZOOM_LIMITS, type ViewportApi, type ViewportState, type ZoomLimits, } from './annotation/canvas/viewport.js';
+export { createViewportApi, fitToScreen, fitRectToScreen, fitDocRectViewport, imageDocRect, panBy, zoomAt, DEFAULT_VIEWPORT, DEFAULT_ZOOM_LIMITS, type ViewportApi, type ViewportState, type ZoomLimits, } from './annotation/canvas/viewport.js';
 export { DEFAULT_PDF_PAGE_GAP, DEFAULT_MIN_ZOOM, DEFAULT_MAX_ZOOM, makePdfDocumentId, createPdfDocument, pdfPageDocRects, pdfDocumentExtent, pdfFirstPageDocRect, computeZoomFloor, type PdfDocRect, } from './annotation/canvas/pdfDocument.js';
 export { normalizePdfRotation, effectivePageRotation, pdfPageDisplaySize, pdfCanvasPageDocId, emptyPdfCanvasPageState, pdfCanvasPageDocument, pdfCanvasKnobsOf, pdfCanvasKnobsEqual, pageStateToCanvasState, canvasStateToPageState, rotatePointInPage, rotatePageState, rotatePdfCanvasPage, type PdfPageDisplaySize, type PdfRotationDelta, } from './annotation/canvas/pdfCanvasPages.js';
 export { LEGACY_BACKGROUND_LAYER_ID, BACKGROUND_PLACEMENT_GAP_RATIO, backgroundLayersOf, backgroundLayerIsLocked, isBackgroundLayerLocked, defaultBackgroundLayerLocked, backgroundLayerDocRect, backgroundLayersUnionRect, placeNewBackgroundLayer, } from './annotation/canvas/backgroundLayers.js';

package/dist/exports.js

@@ -43,7 +43,7 @@ export { hydrateCanvasState } from './annotation/data/canvasPersistence.js';
 export { InMemoryAnnotationProvider } from './annotation/data/InMemoryAnnotationProvider.js';
 export { STAMP_TILE_SIZE, GROUP_HEADER_TILE_WIDTH, GROUP_HEADER_TILE_HEIGHT, GROUP_HEADER_COLLAPSED_WIDTH, GROUP_HEADER_COLLAPSED_HEIGHT, GROUP_HEADER_DESIGN, groupHeaderBaseDims, DEFAULT_TILE_SCALE, TILE_SCALE_MIN, TILE_SCALE_MAX, clampTileScale, resolveTileScaleFactor, resolveHeaderTileScaleFactor, resolveFileTileScaleFactor, tileDocSizeForFactor, tileScaleFromDocSize, stampTileSize, stampTileDims, isUnassociatedStamp, isFileStamp, } from './annotation/canvas/stampLayout.js';
 export { GROUP_HEADER_STYLE, describeGroupHeader, groupHeaderSignature, } from './annotation/canvas/groupHeaderLayout.js';
-export { createViewportApi, fitToScreen, fitRectToScreen, imageDocRect, panBy, zoomAt, DEFAULT_VIEWPORT, DEFAULT_ZOOM_LIMITS, } from './annotation/canvas/viewport.js';
+export { createViewportApi, fitToScreen, fitRectToScreen, fitDocRectViewport, imageDocRect, panBy, zoomAt, DEFAULT_VIEWPORT, DEFAULT_ZOOM_LIMITS, } from './annotation/canvas/viewport.js';
 export { DEFAULT_PDF_PAGE_GAP, DEFAULT_MIN_ZOOM, DEFAULT_MAX_ZOOM, makePdfDocumentId, createPdfDocument, pdfPageDocRects, pdfDocumentExtent, pdfFirstPageDocRect, computeZoomFloor, } from './annotation/canvas/pdfDocument.js';
 export { normalizePdfRotation, effectivePageRotation, pdfPageDisplaySize, pdfCanvasPageDocId, emptyPdfCanvasPageState, pdfCanvasPageDocument, pdfCanvasKnobsOf, pdfCanvasKnobsEqual, pageStateToCanvasState, canvasStateToPageState, rotatePointInPage, rotatePageState, rotatePdfCanvasPage, } from './annotation/canvas/pdfCanvasPages.js';
 export { LEGACY_BACKGROUND_LAYER_ID, BACKGROUND_PLACEMENT_GAP_RATIO, backgroundLayersOf, backgroundLayerIsLocked, isBackgroundLayerLocked, defaultBackgroundLayerLocked, backgroundLayerDocRect, backgroundLayersUnionRect, placeNewBackgroundLayer, } from './annotation/canvas/backgroundLayers.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reekon-tools/boldr-utils",
-  "version": "1.24.0",
+  "version": "1.25.0",
   "description": "Shared utilities for formulas and measurement conversion used in Reekon apps",
   "author": "REEKON Tools",
   "license": "MIT",