@kerros/editor 0.0.0-stage → 0.1.0-rc.1

package/dist/types/planner/MapSettings.d.ts

@@ -0,0 +1,16 @@
+import type { BasemapConfig } from '../model/host';
+import type { ProjectDocument } from '../model/types';
+import type { CommitProject } from './types';
+import type { useMapDisplay } from './useMapDisplay';
+interface MapSettingsProps {
+    display: ReturnType<typeof useMapDisplay>;
+    project: ProjectDocument;
+    floorId: string | null;
+    editing: boolean;
+    hostBasemap?: BasemapConfig;
+    commit: CommitProject;
+    snapping: boolean;
+    setSnapping: (enabled: boolean) => void;
+}
+export declare function MapSettings({ display, project, floorId, editing, hostBasemap, commit, snapping, setSnapping, }: MapSettingsProps): import("react").JSX.Element;
+export {};

package/dist/types/planner/PlannerHelp.d.ts

@@ -0,0 +1,3 @@
+export declare function PlannerHelp({ onClose }: {
+    onClose: () => void;
+}): import("react").JSX.Element;

package/dist/types/planner/ProjectSidebar.d.ts

@@ -0,0 +1,32 @@
+import type { PlannerMode } from '../model/host';
+import type { StatusReading } from '../model/live';
+import type { ProjectDocument } from '../model/types';
+interface ProjectSidebarProps {
+    state: ReturnType<typeof useProjectSidebar>;
+    project: ProjectDocument;
+    floorId: string | null;
+    selected: string | null;
+    mode: PlannerMode;
+    editing: boolean;
+    readOnly: boolean;
+    statuses: Map<string, StatusReading>;
+    alarmFloors: Set<string | null>;
+    activeTab: 'structure' | 'objects';
+    setActiveTab: (tab: 'structure' | 'objects') => void;
+    leave: () => void;
+    select: (id: string | null, focus?: boolean) => void;
+    changeFloor: (id: string | null) => void;
+    onAnchor: () => void;
+    onAddFloor: () => void;
+    onDuplicateFloor: () => void;
+    onImportReference: () => void;
+}
+export declare function useProjectSidebar(): {
+    search: string;
+    setSearch: import("react").Dispatch<import("react").SetStateAction<string>>;
+    collapsedBuildings: Set<string>;
+    setCollapsedBuildings: import("react").Dispatch<import("react").SetStateAction<Set<string>>>;
+};
+/** Project browsing chrome, with search and collapsed groups local to the sidebar. */
+export declare function ProjectSidebar({ state, project, floorId, selected, mode, editing, readOnly, statuses, alarmFloors, activeTab, setActiveTab, leave, select, changeFloor, onAnchor, onAddFloor, onDuplicateFloor, onImportReference, }: ProjectSidebarProps): import("react").JSX.Element;
+export {};

package/dist/types/planner/floors.d.ts

@@ -0,0 +1,3 @@
+import type { Floor, ProjectDocument } from '../model/types';
+export declare function floorCode(project: ProjectDocument, f: Floor): string;
+export declare function floorBand(project: ProjectDocument, floorId: string | null): Floor[];

package/dist/types/planner/types.d.ts

@@ -0,0 +1,3 @@
+import type { ProjectDocument } from '../model/types';
+/** The single validated, undoable mutation path shared by planner features. */
+export type CommitProject = (change: (draft: ProjectDocument) => void) => boolean;

package/dist/types/planner/useDrawingTools.d.ts

@@ -0,0 +1,52 @@
+import { type GeometryDrag } from '../model/authoring';
+import type { Point, ProjectDocument, SiteObject, Tool } from '../model/types';
+import { type WallProposal } from '../model/walls';
+import type { CommitProject } from './types';
+interface DrawingToolsOptions {
+    project: ProjectDocument;
+    floorId: string | null;
+    selected: string | null;
+    editing: boolean;
+    threeD: boolean;
+    commit: CommitProject;
+    notify: (message: string) => void;
+    setSelected: (id: string | null) => void;
+    onSelect: (id: string | null) => void;
+    onFloorChange: (id: string | null) => void;
+    onChooseTool: () => void;
+}
+/**
+ * Owns in-progress drawing and handle gestures. Previews only calculate geometry;
+ * completed edits go through the planner's validated history transaction.
+ */
+export declare function useDrawingTools({ project, floorId, selected, editing, threeD, commit, notify, setSelected, onSelect, onFloorChange, onChooseTool, }: DrawingToolsOptions): {
+    tool: Tool;
+    setTool: import("react").Dispatch<import("react").SetStateAction<Tool>>;
+    draft: Point[];
+    setDraft: import("react").Dispatch<import("react").SetStateAction<Point[]>>;
+    hover: Point | null;
+    proposal: WallProposal | null;
+    snapLabel: string;
+    snapping: boolean;
+    setSnapping: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    routeAnchor: string | null;
+    setRouteAnchor: import("react").Dispatch<import("react").SetStateAction<string | null>>;
+    chooseTool: (next: Tool) => void;
+    finish: () => void;
+    mapClick: (raw: Point, id: string | null) => void;
+    adoptBuilding: ({ rings, sourceId, storeys, name, }: {
+        rings: Point[][];
+        sourceId: string | number;
+        storeys: number;
+        name: string;
+    }) => void;
+    onHover: (point: Point, tolerance: number) => void;
+    guides: {
+        line: [Point, Point];
+        role: "guide" | "proposal";
+    }[];
+    geometryPreview: (kind: GeometryDrag["kind"], id: string, raw: Point, free?: boolean, ringIndex?: number, index?: number) => Point;
+    vertexMove: (kind: "junction" | "ring" | "object" | "barrier" | "node" | "opening" | "rotate" | "coverage", id: string, raw: Point, ringIndex?: number, index?: number, free?: boolean) => void;
+    updateObject: (id: string, patch: Partial<SiteObject>) => void;
+};
+export {};

package/dist/types/planner/useMapDisplay.d.ts

@@ -0,0 +1,29 @@
+import type { BasemapConfig, ViewState } from '../model/host';
+import type { ProjectDocument } from '../model/types';
+/** Display preferences survive switching between the map, graph, viewer and editor. */
+export declare function useMapDisplay(project: ProjectDocument, hostBasemap?: BasemapConfig, initialView?: ViewState): {
+    coverage: boolean;
+    setCoverage: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    showLabels: boolean;
+    setShowLabels: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    basemapMode: "plan" | "host";
+    setBasemapMode: import("react").Dispatch<import("react").SetStateAction<"plan" | "host">>;
+    settings: boolean;
+    setSettings: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    showPlan: boolean;
+    setShowPlan: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    lighting: "auto" | "day" | "evening";
+    setLighting: import("react").Dispatch<import("react").SetStateAction<"auto" | "day" | "evening">>;
+    excavation: boolean;
+    setExcavation: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    cityBuildings: boolean;
+    setCityBuildings: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    cadastre: boolean;
+    setCadastre: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    sun: import("../map/lighting").Sun;
+    sunNote: string;
+    basemap: BasemapConfig;
+    surveyed: boolean;
+    canAdopt: boolean;
+    hasCadastre: boolean;
+};

package/dist/types/planner/usePlannerKeyboard.d.ts

@@ -0,0 +1,18 @@
+import type { Map as GLMap } from 'maplibre-gl';
+import { type RefObject } from 'react';
+import type { Tool } from '../model/types';
+interface PlannerKeyboardOptions {
+    graphView: boolean;
+    editing: boolean;
+    threeD: boolean;
+    walk: boolean;
+    hasDraft: boolean;
+    hasSelection: boolean;
+    mapRef: RefObject<GLMap | null>;
+    chooseTool: (tool: Tool) => void;
+    stepFloor: (direction: 1 | -1) => void;
+    commands: Record<'undo' | 'redo' | 'undoPoint' | 'export' | 'cancel' | 'finish' | 'help' | 'view' | 'edit' | 'walk' | 'live' | 'cycleView' | 'toggleStack' | 'toggleSidebar' | 'toggleInspector' | 'toggleFullscreen' | 'toggleNavigation' | 'toggleTheme' | 'deleteSelection' | 'duplicate', () => void>;
+}
+/** Routes chrome shortcuts without taking movement keys from the map or walker. */
+export declare function usePlannerKeyboard({ graphView, editing, threeD, walk, hasDraft, hasSelection, mapRef, chooseTool, stepFloor, commands, }: PlannerKeyboardOptions): boolean;
+export {};

package/dist/types/planner/useReferenceAlignment.d.ts

@@ -0,0 +1,30 @@
+import { type PreparedDrawing } from '../components/ImportDialog';
+import type { AssetRepository, Drawing, Point, ProjectDocument } from '../model/types';
+import type { CommitProject } from './types';
+interface Alignment {
+    prepared: PreparedDrawing;
+    imagePoints: Point[];
+    mapPoints: Point[];
+    drawing: Drawing;
+    preview: boolean;
+}
+interface ReferenceAlignmentOptions {
+    project: ProjectDocument;
+    floorId: string | null;
+    assets: AssetRepository;
+    commit: CommitProject;
+    notify: (message: string) => void;
+    setSelected: (id: string | null) => void;
+    onStart: () => void;
+}
+/** A reference drawing stays provisional until its alignment or scale is accepted. */
+export declare function useReferenceAlignment({ project, floorId, assets, commit, notify, setSelected, onStart, }: ReferenceAlignmentOptions): {
+    alignment: Alignment | null;
+    setAlignment: import("react").Dispatch<import("react").SetStateAction<Alignment | null>>;
+    startAlignment: (prepared: PreparedDrawing) => Promise<void>;
+    previewAlignment: () => void;
+    confirmAlignment: () => void;
+    calibrate: (metres: number) => void;
+    displayProject: ProjectDocument;
+};
+export {};

package/dist/types/schema/index.d.ts

@@ -0,0 +1,25 @@
+export type { ProjectDocument, ProjectSummary, Building, BuildingRoof, RoofSection, Floor, InteriorLight, LightFixture, Junction, VirtualBoundary, BoundaryUse, SpaceGeometry, Barrier, SiteObject, Drawing, Origin, Point, Ring, ObjectKind, Slope, MaterialKind, ModelKind, AssetRepository, NavNode, NavEdge, NavEdgeKind, Zone, Portal, PortalGroup, } from '../model/types';
+export { spaces, spaceAt, spacePoint, inSpace } from '../model/spaces';
+export { entryInto, perimeter, captive, zoneSpaces, addZone, removeZone, setZoneMembers, nestZone, addPortalGroup, removePortalGroup, setPortalGroupMembers, pruneOntology, } from '../model/ontology';
+export { inferPortals, inferOpenBoundaries, refreshPortals, divideSpaces, spacesDividedBy, spacesRejoinedBy, mergeSpaces, } from '../model/inference';
+export { derivedGraph } from '../model/topology';
+export { sharedBoundaryPortals, effectivePortals } from '../model/portals';
+export { isArea, isDevice, isOpening, isSpace, uid, OBJECT_KINDS } from '../model/types';
+export { createObject, emptyProject } from '../model/factory';
+export { enclosedRegion, enclosedRegions, refitEnclosedRooms } from '../model/spaces';
+export { boundaryEdges, boundaryRegions, boundaryRegionAt, boundaryRings, derivedSpaceRings, bindSpaceToRegion, followsBoundaries, connectSpace, disconnectSpace, addVirtualBoundary, drawVirtualBoundary, addBoundaryHole, normalizeBoundaries, refreshBoundarySpaces, } from '../model/boundaries';
+export type { BoundaryEdge, BoundaryRegion } from '../model/boundaries';
+export { coverageOf, DEFAULT_RANGE, DEFAULT_FOV } from '../model/coverage';
+export { copyProject, openingFloorId } from '../model/project';
+export { MIN_SEGMENT, OPENING_MIN_SEGMENT, geoOrigin, moveOrigin, segmentsCross, toLngLat, toLocal, addBarrier, duplicateFloor, removeFloor, rectangle, rotate, centroid, distance, footprint, closeRing, openRing, ringArea, objectArea, pointInRing, objectPosition, objectRotation, barrierEnds, segmentProjection, slopeElevation, } from '../model/geometry';
+export { exportProject, importProject, parseExport, blobDataUrl } from '../model/document';
+export { validateProject, validateRelationships, validateRings, validateNavigation, transact, freezeProject, COORD_LIMIT, } from '../model/validate';
+export type { TransactResult } from '../model/validate';
+export { applyMutation, applyMutations } from '../model/mutations';
+export type { Mutation, MutationOutcome, MutationResult } from '../model/mutations';
+export { findRoute, navNodes, navEdges, HERE, routeSteps, routeAnchors, floorPhrase, addNavNode, addNavEdge, navPath, chainVertical, edgeCost, edgeLength, ELEVATOR_BASE, ELEVATOR_PER_METRE, STAIR_CLIMB_FACTOR, DOOR_COST, NAV_WELD, } from '../model/navigation';
+export type { Route, RouteStep, RouteLeg, RouteOptions, RouteEnd, RoutePlace } from '../model/navigation';
+export { EXTERIOR_PRESETS, type ExteriorPreset } from '../model/materials';
+export { flights, flightsAt, isVertical, passesThrough, PITCH, pitchOf, primaryShafts, reaches, runFor, servedFloors, shaftKey, shaftVoids, span, type Flight, } from '../model/vertical';
+export { buildRoomNavigation } from '../model/roomNavigation';
+export type { RoomAccess, RoomNavigationGraph } from '../model/roomNavigation';

package/dist/types/theme/index.d.ts

@@ -0,0 +1,55 @@
+import { type ComponentType, type ReactNode } from 'react';
+import type { SiteObject } from '../model/types';
+import type { StatusTone } from '../model/live';
+import { type En } from '../i18n';
+type DeepPartial<T> = {
+    [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
+};
+/** App-wide dark mode: a `dark` class on the root element, remembered per browser. */
+export declare function useDarkMode(): [boolean, () => void];
+export interface ConfirmOptions {
+    title: string;
+    body?: string;
+    danger?: boolean;
+    confirmLabel?: string;
+}
+/** Plan/route/device rendering colours, per deployment ("operation model"). Basemap is separate (BasemapConfig). */
+export interface MapStyleOptions {
+    /** Plan area fill and wall colour (top-down 2D). */
+    room?: string;
+    wall?: string;
+    route?: string;
+    routeActive?: string;
+    /** Selection/hover/draft highlight colours, applied on both the 2D plan and the 3D scene. */
+    selection?: string;
+    /** Soft (translucent) selection fill for areas; defaults to a light tint of the selection colour. */
+    selectionFill?: string;
+    hover?: string;
+    draft?: string;
+    statusTones?: Partial<Record<StatusTone, string>>;
+    /** Last-word override for any area/object fill and marker accent; return undefined to fall through. */
+    objectColor?: (object: SiteObject) => string | undefined;
+}
+export interface KerrosTheme {
+    /** CSS custom-property overrides (e.g. { '--accent': '#e8562f' }); applied to the theme wrapper. */
+    tokens?: Record<string, string>;
+    /** Per kind/tool/POI-symbol icon overrides; keys match EntityIcon's `kind`/`symbol`. */
+    icons?: Record<string, ComponentType<{
+        size?: number;
+    }>>;
+    /** Show a transient notification. Unset → the built-in toast. */
+    notify?: (message: string, tone?: 'info' | 'error') => void;
+    /** Ask the user to confirm a destructive action. Unset → the built-in dialog. */
+    confirm?: (options: ConfirmOptions) => Promise<boolean>;
+    /** Plan/route/device rendering colours. */
+    mapStyle?: MapStyleOptions;
+    /** Override any library UI strings (deep-merged over the built-in English); read via useStrings(). */
+    strings?: DeepPartial<En>;
+}
+export declare function KerrosThemeProvider({ theme, children }: {
+    theme?: KerrosTheme;
+    children: ReactNode;
+}): import("react").JSX.Element;
+export declare const useKerrosTheme: () => KerrosTheme;
+export declare function useStrings(): En;
+export {};

package/package.json

@@ -1,6 +1,54 @@
 {
   "name": "@kerros/editor",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0-rc.1",
+  "description": "Kerros React floor-plan editor, browser-safe CAD conversion, SVG output and host adapters for persistence, maps and server-backed drawing imports.",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kherrala/kerros.git",
+    "directory": "packages/editor"
+  },
+  "homepage": "https://github.com/kherrala/kerros#readme",
+  "bugs": "https://github.com/kherrala/kerros/issues",
+  "keywords": ["floor-plan", "indoor-mapping", "maplibre", "react", "editor"],
+  "module": "./dist/index.js",
+  "types": "./dist/types/editor/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/types/editor/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./host": {
+      "types": "./dist/types/editor/host.d.ts",
+      "import": "./dist/host.js"
+    },
+    "./styles.css": "./dist/styles.css"
+  },
+  "scripts": {
+    "build": "vite build && tsc -p tsconfig.dts.json && cat ../../node_modules/maplibre-gl/dist/maplibre-gl.css ../../src/styles.css > dist/styles.css",
+    "prepack": "npm run build"
+  },
+  "sideEffects": [
+    "*.css"
+  ],
+  "peerDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "maplibre-gl": "^6.4.1",
+    "three": ">=0.170.0 <1.0.0"
+  },
+  "dependencies": {
+    "lucide-react": "^0.468.0",
+    "polygon-clipping": "^0.15.7"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}