@osamash/floor-planner 1.2.5 → 1.2.6

package/dist/types/react-planner/constants.d.ts

@@ -220,6 +220,19 @@ export declare const MODE_FITTING_IMAGE = "MODE_FITTING_IMAGE";
 export declare const MODE_VIEWING_CATALOG = "MODE_VIEWING_CATALOG";
 export declare const MODE_CONFIGURING_PROJECT = "MODE_CONFIGURING_PROJECT";
 export declare const MODE_SNAPPING: string[];
+/**
+ * The modes in which `Content` mounts the 2D viewer — i.e. the plan `<svg>` is
+ * in the DOM. Every other mode shows the 3D viewer, the catalog list or
+ * nothing, so there is no plan to screenshot.
+ */
+export declare const MODE_2D_VIEWER: string[];
+/**
+ * The subset of `MODE_2D_VIEWER` where a gesture is mid-flight. The scene
+ * legitimately holds preview geometry in these — a wall that follows the
+ * cursor, an unfinished surface polygon, an item being dragged — so they're
+ * states to let settle rather than to capture as finished work.
+ */
+export declare const MODE_IN_PROGRESS: string[];
 export declare const UNIT_MILLIMETER = "mm";
 export declare const UNIT_CENTIMETER = "cm";
 export declare const UNIT_METER = "m";

package/dist/types/react-planner/hooks/usePlanThumbnail.d.ts

@@ -1,12 +1,21 @@
 /**
  * Keeps a plan thumbnail up to date, handing each new one to `onReady`.
  *
- * Capture is deliberately *ahead* of unload, not during it. `beforeunload`
+ * Every visual change to the 2D view schedules a capture — adding or removing a
+ * room, an item, a wall, a hole, toggling dimensions or the grid. A capture is
+ * only *taken* once the view is in a state worth keeping: not while the 3D
+ * viewer or the catalog is up (there's no plan SVG mounted at all then), and
+ * not mid-gesture, when the scene still holds preview geometry. When the moment
+ * is wrong the change stays pending and the mode change that makes it right
+ * re-arms it, so a room added and then admired in 3D still gets its screenshot.
+ *
+ * Capture is also deliberately *ahead* of unload, not during it. `beforeunload`
  * can't await anything, and a multi-hundred-KB data URI is far past what
  * sendBeacon or fetch({ keepalive: true }) will carry (~64KB), so there is no
  * way to both build and ship an image once the page is going away. Instead we
- * capture on an idle timer and again when the page is hidden — by the time the
- * tab actually closes, the server already has a current image.
+ * capture on a short settle timer, and flush anything still pending when the
+ * page is hidden or the planner unmounts — by the time the tab actually closes,
+ * the consumer already has a current image.
  */
 export declare function usePlanThumbnail(onReady?: (img: string) => void): {
     ensureScreenshot: (force?: boolean) => Promise<void>;

package/dist/types/react-planner/plugins/keyboard.d.ts

@@ -1,2 +1,2 @@
-import type { ReactPlannerStore } from "../../store/ReactPlannerStore";
+import { type ReactPlannerStore } from "../../store/ReactPlannerStore";
 export default function keyboard(): (store: ReactPlannerStore) => () => void;

package/dist/types/react-planner/utils/visual-change.d.ts

@@ -0,0 +1,12 @@
+import type { ReactPlannerStore } from "../../store/ReactPlannerStore";
+/**
+ * Did anything the 2D viewer paints change — and nothing that doesn't?
+ *
+ * Scene identity is too blunt to drive this. Selection is drawn, so it changes
+ * the pixels and the byte-comparison downstream won't filter it either: left
+ * alone, idly clicking around a finished plan re-uploads a thumbnail per click,
+ * each with a different element highlighted. Geometry, layer visibility, the
+ * viewport box and the view options that live outside the planner record are
+ * what count.
+ */
+export declare function hasVisualChange(next: ReactPlannerStore, prev: ReactPlannerStore): boolean;

package/package.json

@@ -11,7 +11,7 @@
   "files": [
     "dist"
   ],
-  "version": "1.2.5",
+  "version": "1.2.6",
   "type": "module",
   "scripts": {
     "dev": "vite",