@archilogic/floor-plan-sdk 5.0.0 → 5.0.1

package/README.md

@@ -10,7 +10,7 @@ npm i @archilogic/floor-plan-sdk
 
 ## API Extractor
 
-This package uses [API Extractor](https://api-extractor.com/) to generate [API report](./api.md) and [doc model](https://api-extractor.com/pages/overview/demo_docs/#whats-in-the-json-file) files 
+This package uses [API Extractor](https://api-extractor.com/) to generate [API report](./api.md) and [doc model](https://api-extractor.com/pages/overview/demo_docs/#whats-in-the-json-file) files
 
 - The API report is used to track changes to the public API. This file is internal and tracked by git
 - The doc model file is distributed with the npm package, and is used to generate the public documentation
@@ -20,23 +20,26 @@ Both files are generated by the `npm run build:api` command
 ## Usage
 
 ### npm package
+
 ```bash
 npm i @archilogic/floor-plan-sdk
 ```
+
 ```js
 import { FloorPlanEngine } from '@archilogic/floor-plan-sdk'
 ```
 
 ### es module import via CDN
+
 ```js
 import { FloorPlanEngine } from 'https://esm.sh/@archilogic/floor-plan-sdk'
 ```
 
 ### umd module import via CDN
+
 ```html
 <script src="https://unpkg.com/@archilogic/floor-plan-sdk"></script>
 <script>
-    const { FloorPlanEngine } = FloorPlanSdk
+  const { FloorPlanEngine } = FloorPlanSdk
 </script>
 ```
-

package/dist/fpe.d.ts

@@ -1326,7 +1326,7 @@ declare const LayoutColumnTypeValue = "element:column";
 declare class LayoutCurtainWall extends LayoutEdgeElementBase {
     type: LayoutCurtainWallType;
     parameters: LayoutCurtainWallParameters;
-    constructor(id: string, edge: SpatialGraphEdge);
+    constructor(id: string, edges: SpatialGraphEdge[]);
     setParameters(parameters: RecursivePartial<LayoutCurtainWallParameters>): void;
 }
 
@@ -1379,10 +1379,24 @@ declare type LayoutEdgeElement = LayoutCurtainWall | LayoutSpaceDivider | Layout
 declare class LayoutEdgeElementBase extends LayoutElementBase {
     type: LayoutEdgeElementType;
     parameters: LayoutEdgeElementParameters;
-    edge: SpatialGraphEdge;
-    constructor(id: string, type: LayoutEdgeElementType, edge: SpatialGraphEdge);
-    getVertices(): SpatialGraphVertex[];
+    private edges;
+    private vertices;
+    edgesChanged: boolean;
+    constructor(id: string, type: LayoutEdgeElementType, edges: SpatialGraphEdge[]);
+    setEdges(edges: SpatialGraphEdge[]): void;
+    private verifyEdges;
     getEdges(): SpatialGraphEdge[];
+    getVertices(): SpatialGraphVertex[];
+    getStartVertex(): SpatialGraphVertex;
+    getEndVertex(): SpatialGraphVertex;
+    getAxisPoints(): [Vector2, Vector2];
+    getAxisLength(): number;
+    getEdgeAtLinearPosition(u: number): SpatialGraphEdge | undefined;
+    getEdgesAtLinearSegment(u: number, v: number): SpatialGraphEdge[];
+    /**
+     * @deprecated Use getEdges() instead of edge
+     */
+    get edge(): SpatialGraphEdge;
     getAdjacentElementsByVertex(): [LayoutEdgeElement[], LayoutEdgeElement[]];
     getAdjacentSpacesBySide(): [LayoutSpace[], LayoutSpace[]];
     getSpaces(): LayoutSpace[];
@@ -1391,7 +1405,7 @@ declare class LayoutEdgeElementBase extends LayoutElementBase {
 
 declare interface LayoutEdgeElementBaseJson extends LayoutElementBaseJson {
     type: LayoutEdgeElementType;
-    edge: string;
+    edge: string | string[];
     parameters?: LayoutEdgeElementParametersJson;
 }
 
@@ -1568,6 +1582,11 @@ declare class LayoutOpening extends LayoutOpeningElementBase {
     get position(): Vector3;
     get rotation(): number;
     setParameters(parameters: RecursivePartial<LayoutOpeningParameters>): void;
+    getBoundingBox(localTransform?: boolean): {
+        min: Vector3;
+        max: Vector3;
+        transform: Transform3d;
+    };
     getSpaces(): LayoutSpace[];
 }
 
@@ -1761,7 +1780,7 @@ declare interface LayoutSpaceAttributesJson {
 declare class LayoutSpaceDivider extends LayoutEdgeElementBase {
     type: LayoutSpaceDividerType;
     parameters: LayoutSpaceDividerParameters;
-    constructor(id: string, edge: SpatialGraphEdge);
+    constructor(id: string, edges: SpatialGraphEdge[]);
     setParameters(parameters: RecursivePartial<LayoutSpaceDividerParameters>): void;
     getBoundingBox(): {
         min: Vector3;
@@ -1959,7 +1978,7 @@ declare class LayoutWall extends LayoutEdgeElementBase {
     type: LayoutWallType;
     parameters: LayoutWallParameters;
     geometryProfile: LayoutWallGeometryProfile;
-    constructor(id: string, edge: SpatialGraphEdge);
+    constructor(id: string, edges: SpatialGraphEdge[]);
     copyForClone(wall: LayoutWall): void;
     setParameters(parameters: RecursivePartial<LayoutWallParameters>): void;
     getBoundingBox(): {
@@ -2107,6 +2126,12 @@ declare type MeshGeometryType = typeof MeshGeometryTypeValue;
 
 declare const MeshGeometryTypeValue = "geometry:mesh";
 
+declare type NodesByType<NodeMap extends NodeTypeMap = {}> = {
+    -readonly [K in keyof NodeMap]: InstanceType<NodeMap[K]>[];
+};
+
+declare type NodeTypeMap = Record<string, any>;
+
 declare interface NumberList extends SpaceGraphTypedValueJson {
     type: 'number:list';
     list: number[];
@@ -2364,26 +2389,86 @@ declare class SpaceGraph {
     spatialStructure: SpaceGraphSpatialStructure;
     products: SpaceGraphProduct[];
     productsById: Record<string, SpaceGraphProduct>;
-    productsByType: Record<string, SpaceGraphProduct[]>;
+    productsByType: NodesByType<{
+        readonly 'product:static': typeof SpaceGraphProduct;
+    }>;
     geometries: SpaceGraphGeometryJson[];
     geometriesById: Record<string, SpaceGraphGeometryJson>;
-    geometriesByType: Record<string, SpaceGraphGeometryJson[]>;
+    geometriesByType: NodesByType<{
+        readonly 'geometry:plane': typeof PlaneGeometry;
+        readonly 'geometry:cuboid': typeof CuboidGeometry;
+        readonly 'geometry:sphere': typeof SphereGeometry;
+        readonly 'geometry:extrusion': typeof ExtrusionGeometry;
+        readonly 'geometry:mesh': typeof MeshGeometry;
+        readonly 'geometry:uri': typeof UriGeometry;
+    }>;
     materials: SpaceGraphMaterial[];
     materialsById: Record<string, SpaceGraphMaterial>;
-    materialsByType: Record<string, SpaceGraphMaterial[]>;
+    materialsByType: NodesByType<{
+        readonly 'material:embedded': typeof SpaceGraphEmbeddedMaterial;
+        readonly 'material:basic': typeof SpaceGraphBasicMaterial;
+        readonly 'material:color': typeof SpaceGraphColorMaterial;
+        readonly 'material:standard': typeof SpaceGraphStandardMaterial;
+    }>;
     relations: SpaceGraphRelation[];
     relationsById: Record<string, SpaceGraphRelation>;
-    relationsByType: Record<string, SpaceGraphRelation[]>;
+    relationsByType: NodesByType<{
+        readonly 'relation:group': typeof GroupRelation;
+    }>;
     nodes: SpaceGraphNode[];
     nodesById: Record<string, SpaceGraphNode>;
-    nodesByType: Record<string, SpaceGraphNode[]>;
+    nodesByType: NodesByType<{
+        readonly 'spatialStructure:building': typeof SpaceGraphBuilding;
+        readonly 'spatialStructure:floor': typeof SpaceGraphFloor;
+        readonly 'spatialStructure:layout': typeof SpaceGraphLayout;
+        readonly 'relation:group': typeof GroupRelation;
+        readonly 'product:static': typeof SpaceGraphProduct;
+        readonly 'material:embedded': typeof SpaceGraphEmbeddedMaterial;
+        readonly 'material:basic': typeof SpaceGraphBasicMaterial;
+        readonly 'material:color': typeof SpaceGraphColorMaterial;
+        readonly 'material:standard': typeof SpaceGraphStandardMaterial;
+        readonly 'geometry:plane': typeof PlaneGeometry;
+        readonly 'geometry:cuboid': typeof CuboidGeometry;
+        readonly 'geometry:sphere': typeof SphereGeometry;
+        readonly 'geometry:extrusion': typeof ExtrusionGeometry;
+        readonly 'geometry:mesh': typeof MeshGeometry;
+        readonly 'geometry:uri': typeof UriGeometry;
+        readonly 'spatialGraph:edge': typeof SpatialGraphEdge;
+        readonly 'spatialGraph:vertex': typeof SpatialGraphVertex;
+        readonly 'layout:space': typeof LayoutSpace;
+        readonly 'view:2d': typeof Layout2dView;
+        readonly 'view:3d': typeof Layout3dView;
+        readonly 'annotation:floorPlanDxf': typeof LayoutFloorPlanDxfAnnotation;
+        readonly 'annotation:floorPlanImage': typeof LayoutFloorPlanImageAnnotation;
+        readonly 'element:ceiling': typeof LayoutBoundarySlab;
+        readonly 'element:floor': typeof LayoutBoundarySlab;
+        readonly 'element:boundaryWall': typeof LayoutBoundaryWall;
+        readonly 'element:curtainWall': typeof LayoutCurtainWall;
+        readonly 'element:spaceDivider': typeof LayoutSpaceDivider;
+        readonly 'element:wall': typeof LayoutWall;
+        readonly 'element:opening': typeof LayoutOpening;
+        readonly 'element:asset': typeof LayoutAsset;
+        readonly 'element:beam': typeof LayoutBeam;
+        readonly 'element:casework': typeof LayoutCasework;
+        readonly 'element:column': typeof LayoutColumn;
+        readonly 'element:door': typeof LayoutDoor;
+        readonly 'element:generic': typeof LayoutGeneric;
+        readonly 'element:kitchen': typeof LayoutKitchen;
+        readonly 'element:railing': typeof LayoutRailing;
+        readonly 'element:ramp': typeof LayoutRamp;
+        readonly 'element:roof': typeof LayoutRoof;
+        readonly 'element:slab': typeof LayoutSlab;
+        readonly 'element:stairs': typeof LayoutStairs;
+        readonly 'element:stairFlight': typeof LayoutStairFlight;
+        readonly 'element:window': typeof LayoutWindow;
+    }>;
     private emitter;
     constructor();
     getEvents(): Record<string, Function>;
     copyEvents(spaceGraph: SpaceGraph): void;
-    deleteNodeAtIndex(nodeIndex: number, nodes: SpaceGraphNode[], nodesById: Record<string, SpaceGraphNode>, nodesByType: Record<string, SpaceGraphNode[]>): SpaceGraphNode | undefined;
-    insertNode(node: SpaceGraphNode, nodes: SpaceGraphNode[], nodesById: Record<string, SpaceGraphNode>, nodesByType: Record<string, SpaceGraphNode[]>): void;
-    removeNode(node: SpaceGraphNode, nodes: SpaceGraphNode[], nodesById: Record<string, SpaceGraphNode>, nodesByType: Record<string, SpaceGraphNode[]>): SpaceGraphNode | undefined;
+    deleteNodeAtIndex(nodeIndex: number, nodes: SpaceGraphNode[], nodesById: Record<string, SpaceGraphNode>, nodesByType: NodesByType<Record<string, SpaceGraphNode>>): SpaceGraphNode | undefined;
+    insertNode(node: SpaceGraphNode, nodes: SpaceGraphNode[], nodesById: Record<string, SpaceGraphNode>, nodesByType: NodesByType<Record<string, SpaceGraphNode>>): void;
+    removeNode(node: SpaceGraphNode, nodes: SpaceGraphNode[], nodesById: Record<string, SpaceGraphNode>, nodesByType: NodesByType<Record<string, SpaceGraphNode>>): SpaceGraphNode | undefined;
     registerNode(node: SpaceGraphNode): void;
     unregisterNode(node: SpaceGraphNode): void;
     insertSpatialStructure(spatialStructure: SpaceGraphSpatialStructure): void;
@@ -2569,13 +2654,41 @@ declare class SpaceGraphLayout extends SpaceGraphSpatialStructureBase {
     spacesById: Record<string, LayoutSpace>;
     elements: LayoutElement[];
     elementsById: Record<string, LayoutElement>;
-    elementsByType: Record<string, LayoutElement[]>;
+    elementsByType: NodesByType<{
+        readonly 'element:ceiling': typeof LayoutBoundarySlab;
+        readonly 'element:floor': typeof LayoutBoundarySlab;
+        readonly 'element:boundaryWall': typeof LayoutBoundaryWall;
+        readonly 'element:curtainWall': typeof LayoutCurtainWall;
+        readonly 'element:spaceDivider': typeof LayoutSpaceDivider;
+        readonly 'element:wall': typeof LayoutWall;
+        readonly 'element:opening': typeof LayoutOpening;
+        readonly 'element:asset': typeof LayoutAsset;
+        readonly 'element:beam': typeof LayoutBeam;
+        readonly 'element:casework': typeof LayoutCasework;
+        readonly 'element:column': typeof LayoutColumn;
+        readonly 'element:door': typeof LayoutDoor;
+        readonly 'element:generic': typeof LayoutGeneric;
+        readonly 'element:kitchen': typeof LayoutKitchen;
+        readonly 'element:railing': typeof LayoutRailing;
+        readonly 'element:ramp': typeof LayoutRamp;
+        readonly 'element:roof': typeof LayoutRoof;
+        readonly 'element:slab': typeof LayoutSlab;
+        readonly 'element:stairs': typeof LayoutStairs;
+        readonly 'element:stairFlight': typeof LayoutStairFlight;
+        readonly 'element:window': typeof LayoutWindow;
+    }>;
     annotations: LayoutAnnotation[];
     annotationsById: Record<string, LayoutAnnotation>;
-    annotationsByType: Record<string, LayoutAnnotation[]>;
+    annotationsByType: NodesByType<{
+        readonly 'annotation:floorPlanDxf': typeof LayoutFloorPlanDxfAnnotation;
+        readonly 'annotation:floorPlanImage': typeof LayoutFloorPlanImageAnnotation;
+    }>;
     views: LayoutView[];
     viewsById: Record<string, LayoutView>;
-    viewsByType: Record<string, LayoutView[]>;
+    viewsByType: NodesByType<{
+        readonly 'view:2d': typeof Layout2dView;
+        readonly 'view:3d': typeof Layout3dView;
+    }>;
     debugIds: boolean;
     suggestedIds: Record<string, boolean>;
     constructor(id: string);
@@ -2588,7 +2701,7 @@ declare class SpaceGraphLayout extends SpaceGraphSpatialStructureBase {
     createElement(type: LayoutOpeningType, id: string): LayoutOpening;
     createElement(type: LayoutBoundarySlabType, id: string, boundaries: LayoutBoundary[]): LayoutBoundarySlab;
     createElement(type: LayoutBoundaryWallType, id: string, boundaries: LayoutBoundary[]): LayoutBoundaryWall;
-    createElement<T extends LayoutEdgeElementType>(type: T, id: string, edge: SpatialGraphEdge): EdgeElementMap[T];
+    createElement<T extends LayoutEdgeElementType>(type: T, id: string, edges: SpatialGraphEdge[]): EdgeElementMap[T];
     createElement<T extends LayoutTransformElementType>(type: T, id: string): TransformElementMap[T];
     insertNode(node: LayoutAnnotation | LayoutView): void;
     removeNode(node: LayoutAnnotation | LayoutView): void;
@@ -2610,6 +2723,7 @@ declare class SpaceGraphLayout extends SpaceGraphSpatialStructureBase {
     getUniqueId(prefix: string, nodesById: Record<string, SpaceGraphNode>): string;
     getSpaceId(prefix?: string): string;
     getElementId(element: LayoutElement, prefix?: string): string;
+    getBoundingBox(): TransformBoundingBox3d;
 }
 
 declare interface SpaceGraphLayoutJson extends SpaceGraphSpatialStructureBaseJson {
@@ -2636,7 +2750,7 @@ declare type SpaceGraphMaterialJson = Rgb | RgbA | string | SpaceGraphMaterialRe
 
 declare type SpaceGraphMaterialResourceJson = SpaceGraphColorMaterialJson | SpaceGraphStandardMaterialJson | SpaceGraphBasicMaterialJson;
 
-declare type SpaceGraphNode = SpaceGraphProduct | SpaceGraphGeometry | SpaceGraphMaterial | SpaceGraphRelation | SpaceGraphBuilding | SpaceGraphFloor | LayoutNode | SpaceGraphLayout;
+declare type SpaceGraphNode = SpaceGraphProduct | SpaceGraphGeometry | SpaceGraphMaterial | SpaceGraphRelation | SpaceGraphBuilding | SpaceGraphFloor | LayoutNode | SpaceGraphLayout | LayoutAnnotation;
 
 declare class SpaceGraphNodeBase extends SpaceGraphTypedValue {
     id: string;