@osamash/floor-planner 1.2.3 → 1.2.5

package/dist/types/store/ReactPlannerStore.d.ts

@@ -1,5 +1,32 @@
 import { State } from "../react-planner/models";
 import { ReactSVGPanZoom } from "react-svg-pan-zoom";
+export type PlannerSelectionKind = "item" | "hole" | "surface" | "wall";
+export interface PlannerSelection {
+    layerID: string;
+    kind: PlannerSelectionKind;
+    id: string;
+}
+/** The camera moves the toolbar can ask the 3D viewer to make. Structural on
+ *  purpose — the store stays free of three.js. */
+export interface Viewer3DHandle {
+    /** > 1 moves the camera closer to what it is orbiting, < 1 pulls it back. */
+    zoomBy: (factor: number) => void;
+    fitToScene: () => void;
+}
+/** What the pointer is currently over in the 2D viewer while idle. */
+export interface HoveredElement {
+    layerID: string;
+    /** "lines" | "vertices" | "items" | "holes" */
+    prototype: string;
+    id: string;
+    /** Sub-part of the element (rotation-anchor, resize-anchor…). */
+    part?: string;
+    /** The wall this node belongs to. Set both for the wall itself and for the
+     *  endpoint handles it draws, so the wall keeps its highlight while the
+     *  pointer sits on one of its handles. */
+    lineID?: string;
+}
+export declare const getSelectedElement: (planner: any) => PlannerSelection | null;
 interface Floor {
     floorID: number;
     floorTitle: string;
@@ -26,12 +53,55 @@ export interface ReactPlannerStore {
     remove: () => void;
     showDimensions: boolean;
     setShowDimensions: (showDimensions: boolean) => void;
+    showGrid: boolean;
+    setShowGrid: (showGrid: boolean) => void;
+    theme: "light" | "dark";
+    setTheme: (theme: "light" | "dark") => void;
+    /** Returns the new wall's line ID (or undefined if nothing got created). */
+    addWallByCoords: (x0: number, y0: number, x1: number, y1: number) => string | undefined;
+    addSurfaceByPoints: (points: {
+        x: number;
+        y: number;
+    }[], surfaceType?: string) => void;
+    addRoom: (x0: number, y0: number, x1: number, y1: number, options?: {
+        thickness?: number;
+        height?: number;
+    }) => void;
+    selectToolDrawingRoom: (options?: {
+        thickness?: number;
+        height?: number;
+    }) => void;
+    updateRoomDrawingProperties: (options: {
+        thickness?: number;
+        height?: number;
+    }) => void;
+    beginDrawingRoom: (layerID: string, x: number, y: number) => void;
+    updateDrawingRoom: (x: number, y: number) => void;
+    endDrawingRoom: (x: number, y: number) => void;
+    /** Returns the new item's ID (or undefined if nothing got created). */
+    addItemByCoords: (itemType: string, x: number, y: number, width?: number, height?: number, rotation?: number) => string | undefined;
+    /** Returns the new hole's ID (or undefined if nothing got created). */
+    addHoleOnLine: (lineID: string, holeType: string, offset: number) => string | undefined;
+    setAreaProperties: (areaID: string, properties: any) => void;
+    setLineProperties: (lineID: string, properties: any) => void;
+    moveVertex: (vertexID: string, x: number, y: number) => void;
+    removeLine: (lineID: string) => void;
+    removeArea: (areaID: string) => void;
+    removeItem: (itemID: string) => void;
+    removeHole: (holeID: string) => void;
+    fitViewerToScene: (options?: {
+        animate?: boolean;
+    }) => void;
+    focusOnArea: (layerID: string, areaID: string) => void;
     setToast: (toast: {
         text: string;
     } | null) => void;
     setPlan: (plan: Plan) => void;
     setAlterateState: () => void;
-    selectToolDrawingLine: (sceneComponentType: any) => void;
+    selectToolDrawingLine: (sceneComponentType: any, options?: {
+        thickness?: number;
+        height?: number;
+    }) => void;
     selectToolDrawingSurface: (sceneComponentType: any) => void;
     selectToolDrawingItem: (sceneComponentType: any) => void;
     selectToolDrawingHole: (sceneComponentType: any) => void;
@@ -43,6 +113,33 @@ export interface ReactPlannerStore {
     unselectAll: () => void;
     beginDraggingVertex: (layerID: string, vertexID: string, x: number, y: number, snapMask: any) => void;
     endDraggingVertex: (x: number, y: number, snapMask: any) => void;
+    duplicateSelected: () => void;
+    duplicateItem: (itemID: string) => void;
+    duplicateHole: (holeID: string) => void;
+    duplicateSurface: (areaID: string) => void;
+    /** Positive turns counter-clockwise as seen in the 2D view. */
+    rotateSelected: (degrees: number) => void;
+    flipSelected: (axis: "x" | "y") => void;
+    /** Rotate one surface polygon about its own center, addressed by ID rather
+     *  than via the selection. Same sign convention as `rotateSelected`. */
+    rotateArea: (areaID: string, degrees: number) => void;
+    /** Mirror one surface polygon about its own center — "x" flips it
+     *  left-right, "y" top-bottom. */
+    mirrorArea: (areaID: string, axis: "x" | "y") => void;
+    setItemAttributes: (itemID: string, attributes: Record<string, any>) => void;
+    setHoleProperties: (holeID: string, properties: Record<string, any>) => void;
+    setHoleAttributes: (holeID: string, attributes: Record<string, any>) => void;
+    moveHole: (holeID: string, offset: number) => void;
+    resizeHandlesFor: string | null;
+    setResizeHandlesFor: (itemID: string | null) => void;
+    /** Drives the hover affordances in the 2D viewer (wall highlight + endpoint
+     *  handles) so elements can be dragged/resized without selecting them
+     *  first. Only ever set while the planner is idle. */
+    hoveredElement: HoveredElement | null;
+    setHoveredElement: (hovered: HoveredElement | null) => void;
+    beginResizingItem: (layerID: string, itemID: string, x: number, y: number) => void;
+    updateResizingItem: (x: number, y: number) => void;
+    endResizingItem: (x: number, y: number) => void;
     beginRotatingItem: (layerID: string, itemID: string, x: number, y: number) => void;
     endRotatingItem: (x: number, y: number) => void;
     beginDraggingItem: (layerID: string, itemID: string, x: number, y: number) => void;
@@ -117,6 +214,10 @@ export interface ReactPlannerStore {
     undo: () => void;
     viewer: ReactSVGPanZoom | null;
     setViewer: (viewer: ReactSVGPanZoom) => void;
+    /** The mounted 3D viewer, or null when the 3D view isn't on screen. Lets
+     *  the toolbar drive the camera without knowing anything about three.js. */
+    viewer3D: Viewer3DHandle | null;
+    setViewer3D: (viewer: Viewer3DHandle | null) => void;
     plan: Plan | null;
     initCatalog: (catalog: any) => void;
 }

package/package.json

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

package/dist/types/react-planner/components/PropertyString.d.ts

@@ -1,10 +0,0 @@
-interface PropertyStringProps {
-    value: any;
-    onUpdate: (v: any) => void;
-    onValid?: (event: Event) => void;
-    configs: Record<string, any>;
-    sourceElement?: any;
-    internalState?: any;
-}
-declare const PropertyString: ({ value, onUpdate, configs, sourceElement, internalState, }: PropertyStringProps) => import("react/jsx-runtime").JSX.Element;
-export default PropertyString;

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

@@ -1,4 +0,0 @@
-export declare function useScreenshotBeforeUnload(onReady?: (img: string) => void): {
-    ensureScreenshot: () => Promise<void>;
-    screenshotDone: import("react").RefObject<boolean>;
-};

package/dist/types/react-planner/toolbar/Popup.d.ts

@@ -1,11 +0,0 @@
-import Catalog from "../catalog/catalog";
-interface PopupProps {
-    onClose: () => void;
-    catalog: Catalog;
-    popupEvent: {
-        rect: DOMRect;
-        page: string;
-    } | null;
-}
-declare const Popup: ({ catalog, popupEvent, onClose: handleClose }: PopupProps) => import("react/jsx-runtime").JSX.Element;
-export default Popup;

package/dist/types/react-planner/viewer2d/GridHorizontalStreak.d.ts

@@ -1,7 +0,0 @@
-interface GridHorizontalStreakProps {
-    width: number;
-    height: number;
-    grid: any;
-}
-export default function GridHorizontalStreak({ width, height, grid, }: GridHorizontalStreakProps): import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/types/react-planner/viewer2d/GridVerticalStreak.d.ts

@@ -1,7 +0,0 @@
-interface GridVerticalStreakProps {
-    width: number;
-    height: number;
-    grid: any;
-}
-export default function GridVerticalStreak({ width, height, grid, }: GridVerticalStreakProps): import("react/jsx-runtime").JSX.Element;
-export {};