@archilogic/floor-plan-sdk 5.0.1 → 5.0.2

package/README.md

@@ -8,15 +8,6 @@ The @archilogic/floor-plan-sdk package enables you to create and embed interacti
 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
-
-- 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
-
-Both files are generated by the `npm run build:api` command
-
 ## Usage
 
 ### npm package
@@ -43,3 +34,5 @@ import { FloorPlanEngine } from 'https://esm.sh/@archilogic/floor-plan-sdk'
   const { FloorPlanEngine } = FloorPlanSdk
 </script>
 ```
+
+Check the detailed [documentation](https://developers.archilogic.com/floor-plan-engine/guide).

package/dist/fpe.d.ts

@@ -36,16 +36,16 @@ declare interface ApiUrls {
     apiProductDataPath?: string;
 }
 
-declare interface ArcCurve extends CurveBase {
-    type: ArcCurveType;
+export declare interface ArcCurve extends BaseShape {
+    type: 'curve:arc';
+    position: Vector2;
     radius: number;
     startAngle: number;
     endAngle: number;
 }
 
-declare interface ArcCurve_2 extends BaseShape {
-    type: 'curve:arc';
-    position: Vector2_2;
+declare interface ArcCurve_2 extends CurveBase {
+    type: ArcCurveType;
     radius: number;
     startAngle: number;
     endAngle: number;
@@ -72,14 +72,14 @@ declare interface BaseShape {
     style?: ShapeStyle;
 }
 
-declare interface BezierCurve extends BaseShape {
+export declare interface BezierCurve extends BaseShape {
     type: 'curve:quadraticBezier';
     points: Polygon;
 }
 
 declare type BoundingBox2d = {
-    min: Vector2_2;
-    max: Vector2_2;
+    min: Vector2;
+    max: Vector2;
 };
 
 declare type BoundingBox3d = {
@@ -87,14 +87,14 @@ declare type BoundingBox3d = {
     max: Vector3;
 };
 
-declare interface CircleCurve extends CurveBase {
-    type: CircleCurveType;
+export declare interface CircleCurve extends BaseShape {
+    type: 'curve:circle';
+    position: Vector2;
     radius: number;
 }
 
-declare interface CircleCurve_2 extends BaseShape {
-    type: 'curve:circle';
-    position: Vector2_2;
+declare interface CircleCurve_2 extends CurveBase {
+    type: CircleCurveType;
     radius: number;
 }
 
@@ -102,9 +102,9 @@ declare type CircleCurveType = typeof CircleCurveTypeValue;
 
 declare const CircleCurveTypeValue = "curve:circle";
 
-declare type ClosedCurve = RectangleCurve | PolygonCurve | CircleCurve | CompositeCurve;
+declare type ClosedCurve = RectangleCurve_2 | PolygonCurve_2 | PolygonWithHolesCurve_2 | CircleCurve_2 | CompositeCurve_2;
 
-declare type ClosedCurveType = RectangleCurveType | PolygonCurveType | CircleCurveType | CompositeCurveType;
+declare type ClosedCurveType = RectangleCurveType | PolygonCurveType | PolygonWithHolesCurveType | CircleCurveType | CompositeCurveType;
 
 declare interface CommonParameters$1 {
     materials: LayoutRampMaterials;
@@ -154,16 +154,16 @@ declare interface CommonParameters {
     materials: LayoutWindowMaterials;
 }
 
-declare interface CompositeCurve extends CurveBase {
-    type: CompositeCurveType;
-    segments: OpenCurve[];
-}
-
-declare interface CompositeCurve_2 extends BaseShape {
+export declare interface CompositeCurve extends BaseShape {
     type: 'curve:composite';
     segments: OpenCurves[];
 }
 
+declare interface CompositeCurve_2 extends CurveBase {
+    type: CompositeCurveType;
+    segments: OpenCurve[];
+}
+
 declare type CompositeCurveType = typeof CompositeCurveTypeValue;
 
 declare const CompositeCurveTypeValue = "curve:composite";
@@ -337,7 +337,7 @@ declare class FloorPlanCore {
      * @param {*} position - plan position
      * @returns {Object} - list of spaces and assets
      */
-    getResourcesFromPosition(position: Vector2_2): {
+    getResourcesFromPosition(position: Vector2): {
         spaces: LayoutSpace[];
         assets: LayoutAsset[];
     };
@@ -453,11 +453,11 @@ export declare class FloorPlanEngine extends FloorPlanCore {
     /**
      * Convert screen coordinates to plan coordinates
      */
-    getPlanPosition(point: Vector2_2): Vector2_2;
+    getPlanPosition(point: Vector2): Vector2;
     /**
      * Convert plan coordinates to screen coordinates
      */
-    getScreenPosition(point: Vector2_2): Vector2_2;
+    getScreenPosition(point: Vector2): Vector2;
     /**
      * create plan layer or return existing by id
      */
@@ -546,11 +546,11 @@ declare type FloorPlanTheme = {
 
 declare type FpeComputed = {
     wallContours: PolygonWithHoles[];
-    snapPoints: Vector2_2[];
+    snapPoints: Vector2[];
     snapMargin: number;
 };
 
-declare interface FpeConfig extends StartupOptions {
+export declare interface FpeConfig extends StartupOptions {
     api?: {
         productDataCacheAge?: number;
         productContourCacheAge?: number;
@@ -575,14 +575,14 @@ declare type FpeCoreEventMap = {
 };
 
 export declare type FpeDragEvent = {
-    position: Vector2_2;
-    screenPos: Vector2_2;
+    position: Vector2;
+    screenPos: Vector2;
     sourceEvent: FpeInteractionEvent;
 };
 
 export declare type FpeDropEvent = {
-    position: Vector2_2;
-    screenPos: Vector2_2;
+    position: Vector2;
+    screenPos: Vector2;
     verticalPos: number;
     sourceEvent: DragEvent;
 };
@@ -617,8 +617,8 @@ export declare type FpeEventMap = FpeCoreEventMap & {
 };
 
 declare interface FpeInteraction {
-    lastSceneClick: Vector2_2;
-    cursor: Vector2_2;
+    lastSceneClick: Vector2;
+    cursor: Vector2;
     cursorTarget: LayoutElement | LayoutSpace;
     isDragging: boolean;
     isPanning: boolean;
@@ -630,7 +630,7 @@ declare interface FpeInteraction {
     ctrlKey: boolean;
     altKey: boolean;
     shiftKey: boolean;
-    dragOffset: Vector2_2;
+    dragOffset: Vector2;
     cursorAction: 'split-wall' | 'duplicate' | 'move' | 'select' | 'none';
     _dragStart: ScreenPosition;
     preventFocusoutOnAltKeyup: boolean;
@@ -682,7 +682,7 @@ declare class FpeLoader extends TinyEmitter {
 
 export declare type FpePointerEvent = {
     nodeId?: string;
-    position: Vector2_2;
+    position: Vector2;
     isDoubleClick?: boolean;
     sourceEvent: FpeInteractionEvent;
 };
@@ -853,7 +853,7 @@ declare class Graph {
 
 export declare interface GraphicArgs {
     shapes: Shape[];
-    position?: Vector2_2;
+    position?: Vector2;
     alpha?: number;
     clearLayer?: boolean;
     scale?: number;
@@ -865,7 +865,7 @@ export declare interface GraphicArgs {
 }
 
 declare type GraphicUpdate = {
-    position?: Vector2_2;
+    position?: Vector2;
     style?: ShapeStyle;
     shapes?: Shape[];
 };
@@ -888,9 +888,9 @@ declare type GroupRelationType = typeof GroupRelationTypeValue;
 
 declare const GroupRelationTypeValue = "relation:group";
 
-declare interface GroupShape extends BaseShape {
+export declare interface GroupShape extends BaseShape {
     type: 'group';
-    position?: Vector2_2;
+    position?: Vector2;
     rotation?: number;
     children: Shape[];
 }
@@ -913,9 +913,9 @@ declare type HideableElement = LayoutElement['type'] | LayoutSpace['type'] | Spa
 declare type HingeSide = 'left' | 'right';
 
 declare class HtmlMarker {
-    position: Vector2_2;
-    size: Vector2_2;
-    offset: Vector2_2;
+    position: Vector2;
+    size: Vector2;
+    offset: Vector2;
     isHidden: boolean;
     id: string;
     el: HTMLElement;
@@ -930,12 +930,10 @@ declare class HtmlMarker {
 
 declare interface HtmlMarkerArgs {
     /** coordinates of the window in meters */
-    position?: Vector2_2;
-    offset?: Vector2_2;
+    position?: Vector2;
+    offset?: Vector2;
     /** html string as content of the info window */
     el?: HTMLElement;
-    /** If true , a close button will appear in the top right corner of the info window. */
-    closeButton?: boolean;
 }
 
 declare interface HtmlMarkerState extends HtmlMarkerArgs {
@@ -950,7 +948,7 @@ declare type IndexRange = {
 
 declare class InfoWindow {
     private _floorPlan;
-    position: Vector2_2;
+    position: Vector2;
     height: number;
     width: number;
     closeButton: any;
@@ -978,7 +976,7 @@ declare interface InfoWindowArgs {
     /** pixel height of the window - default 80 */
     height?: number;
     /** coordinates of the window in meters */
-    position?: Vector2_2;
+    position?: Vector2;
     /** html string as content of the info window */
     html?: string;
     /** If true , a close button will appear in the top right corner of the info window. */
@@ -1161,7 +1159,7 @@ declare const LayoutBeamTypeValue = "element:beam";
 declare class LayoutBoundary {
     vertices: SpatialGraphVertex[];
     edges: SpatialGraphEdge[];
-    geometryProfile: Vector2[];
+    geometryProfile: Vector2_2[];
 }
 
 declare type LayoutBoundaryElement = LayoutBoundarySlab | LayoutBoundaryWall;
@@ -1317,7 +1315,7 @@ declare interface LayoutColumnParameters {
 
 declare type LayoutColumnParametersJson = Partial<LayoutColumnParameters>;
 
-declare type LayoutColumnProfile = RectangleCurve | CircleCurve | PolygonCurve;
+declare type LayoutColumnProfile = RectangleCurve_2 | CircleCurve_2 | PolygonCurve_2 | PolygonWithHolesCurve_2;
 
 declare type LayoutColumnType = typeof LayoutColumnTypeValue;
 
@@ -1389,7 +1387,7 @@ declare class LayoutEdgeElementBase extends LayoutElementBase {
     getVertices(): SpatialGraphVertex[];
     getStartVertex(): SpatialGraphVertex;
     getEndVertex(): SpatialGraphVertex;
-    getAxisPoints(): [Vector2, Vector2];
+    getAxisPoints(): [Vector2_2, Vector2_2];
     getAxisLength(): number;
     getEdgeAtLinearPosition(u: number): SpatialGraphEdge | undefined;
     getEdgesAtLinearSegment(u: number, v: number): SpatialGraphEdge[];
@@ -1464,7 +1462,7 @@ declare interface LayoutFloorPlanDxfAnnotationJson extends LayoutAnnotationBaseJ
 
 declare interface LayoutFloorPlanDxfParameters {
     uri: string;
-    drawingOrigin: Vector2;
+    drawingOrigin: Vector2_2;
     hiddenLayers: string[];
 }
 
@@ -1528,7 +1526,7 @@ declare interface LayoutGenericParameters {
 
 declare type LayoutGenericParametersJson = Partial<LayoutGenericParameters>;
 
-declare type LayoutGenericProfile = 'none' | RectangleCurve | CircleCurve | PolygonCurve;
+declare type LayoutGenericProfile = 'none' | RectangleCurve_2 | CircleCurve_2 | PolygonCurve_2 | PolygonWithHolesCurve_2;
 
 declare type LayoutGenericType = typeof LayoutGenericTypeValue;
 
@@ -1623,8 +1621,8 @@ declare interface LayoutOpeningMaterials {
 }
 
 declare interface LayoutOpeningParameters {
-    position: Vector2;
-    dimensions: Vector2;
+    position: Vector2_2;
+    dimensions: Vector2_2;
     materials: LayoutOpeningMaterials;
 }
 
@@ -1733,7 +1731,7 @@ declare interface LayoutSlabParameters {
 
 declare type LayoutSlabParametersJson = Partial<LayoutSlabParameters>;
 
-declare type LayoutSlabProfile = RectangleCurve | CircleCurve | PolygonCurve;
+declare type LayoutSlabProfile = RectangleCurve_2 | CircleCurve_2 | PolygonCurve_2 | PolygonWithHolesCurve_2;
 
 declare type LayoutSlabType = typeof LayoutSlabTypeValue;
 
@@ -1804,7 +1802,7 @@ declare type LayoutSpaceDividerType = typeof LayoutSpaceDividerTypeValue;
 declare const LayoutSpaceDividerTypeValue = "element:spaceDivider";
 
 declare interface LayoutSpaceGeometry {
-    polygons: Vector2[][];
+    polygons: Vector2_2[][];
 }
 
 declare interface LayoutSpaceJson extends LayoutNodeBaseJson {
@@ -1992,11 +1990,11 @@ declare interface LayoutWallGeometryProfile {
     valid: boolean;
     skipped: boolean;
     selfIntersecting: boolean;
-    sidePoints1: Vector2[];
-    sidePoints2: Vector2[];
-    joinPoints1: Vector2[];
-    joinPoints2: Vector2[];
-    points: Vector2[];
+    sidePoints1: Vector2_2[];
+    sidePoints2: Vector2_2[];
+    joinPoints1: Vector2_2[];
+    joinPoints2: Vector2_2[];
+    points: Vector2_2[];
 }
 
 declare interface LayoutWallJson extends LayoutEdgeElementBaseJson {
@@ -2052,14 +2050,14 @@ declare type LayoutWindowType = typeof LayoutWindowTypeValue;
 
 declare const LayoutWindowTypeValue = "element:window";
 
-declare interface LineCurve extends CurveBase {
-    type: LineCurveType;
+export declare interface LineCurve extends BaseShape {
+    type: 'curve:line';
     start: Vector2;
     end: Vector2;
 }
 
-declare interface LineCurve_2 extends BaseShape {
-    type: 'curve:line';
+declare interface LineCurve_2 extends CurveBase {
+    type: LineCurveType;
     start: Vector2_2;
     end: Vector2_2;
 }
@@ -2072,7 +2070,7 @@ declare type LoadingEvent = 'loading-done' | 'loading-status' | 'resource-loaded
 
 declare interface MarkerArgs {
     /** coordinates of the marker in meters */
-    position?: Vector2_2;
+    position?: Vector2;
     /** color of the marker, hex code */
     color?: string;
     /** size in pixels */
@@ -2081,7 +2079,7 @@ declare interface MarkerArgs {
 }
 
 declare class MarkerPin {
-    position: Vector2_2;
+    position: Vector2;
     color: string;
     size: number;
     id: string;
@@ -2146,9 +2144,9 @@ declare interface NumberRange extends SpaceGraphTypedValueJson {
     };
 }
 
-declare type OpenCurve = LineCurve | PolylineCurve | ArcCurve;
+declare type OpenCurve = LineCurve_2 | PolylineCurve_2 | ArcCurve_2;
 
-declare type OpenCurves = LineCurve_2 | ArcCurve_2 | PolylineCurve_2 | BezierCurve;
+declare type OpenCurves = LineCurve | ArcCurve | PolylineCurve | BezierCurve;
 
 declare type OpenCurveType = LineCurveType | PolylineCurveType | ArcCurveType;
 
@@ -2257,40 +2255,49 @@ declare class PlanLayer {
     destroy(): void;
 }
 
-declare type Polygon = Vector2_2[];
+export declare type Polygon = Vector2[];
 
-declare interface PolygonCurve extends CurveBase {
-    type: PolygonCurveType;
-    points: Vector2[];
-}
-
-declare interface PolygonCurve_2 extends BaseShape {
+export declare interface PolygonCurve extends BaseShape {
     type: 'curve:polygon';
     points: Polygon;
 }
 
+declare interface PolygonCurve_2 extends CurveBase {
+    type: PolygonCurveType;
+    points: Vector2_2[];
+}
+
 declare type PolygonCurveType = typeof PolygonCurveTypeValue;
 
 declare const PolygonCurveTypeValue = "curve:polygon";
 
 /** outer ring counter clockwise, inner rings ( holes ) clockwise */
-declare type PolygonWithHoles = Polygon[];
+export declare type PolygonWithHoles = Polygon[];
 
-declare interface PolygonWithHolesCurve extends BaseShape {
+export declare interface PolygonWithHolesCurve extends BaseShape {
     type: 'curve:polygonWithHoles';
     polygons: PolygonWithHoles;
 }
 
-declare interface PolylineCurve extends CurveBase {
-    type: PolylineCurveType;
-    points: Vector2[];
+declare interface PolygonWithHolesCurve_2 extends CurveBase {
+    type: PolygonWithHolesCurveType;
+    polygons: Vector2_2[][];
 }
 
-declare interface PolylineCurve_2 extends BaseShape {
+declare type PolygonWithHolesCurveType = typeof PolygonWithHolesCurveTypeValue;
+
+declare const PolygonWithHolesCurveTypeValue = "curve:polygonWithHoles";
+
+export declare interface PolylineCurve extends BaseShape {
     type: 'curve:polyline';
     points: Polygon;
 }
 
+declare interface PolylineCurve_2 extends CurveBase {
+    type: PolylineCurveType;
+    points: Vector2_2[];
+}
+
 declare type PolylineCurveType = typeof PolylineCurveTypeValue;
 
 declare const PolylineCurveTypeValue = "curve:polyline";
@@ -2299,17 +2306,17 @@ declare type PositionEntry = Vector3 | Vector3List | Vector3Range;
 
 declare type ProductAttributes = SpaceGraphProduct['attributes'];
 
-declare interface RectangleCurve extends CurveBase {
-    type: RectangleCurveType;
-    dimensions: Vector2;
-}
-
-declare interface RectangleCurve_2 extends BaseShape {
+export declare interface RectangleCurve extends BaseShape {
     type: 'curve:rectangle';
-    position: Vector2_2;
+    position: Vector2;
     dimensions: [number, number];
 }
 
+declare interface RectangleCurve_2 extends CurveBase {
+    type: RectangleCurveType;
+    dimensions: Vector2_2;
+}
+
 declare type RectangleCurveType = typeof RectangleCurveTypeValue;
 
 declare const RectangleCurveTypeValue = "curve:rectangle";
@@ -2372,7 +2379,7 @@ declare type ScreenPosition = {
 
 export declare const setApiUrls: ({ apiStorageUrl: newApiStorageUrl, spaceApiUrl, apiProductDataPath: newApiProductDataPath }?: ApiUrls) => void;
 
-export declare type Shape = PolygonCurve_2 | PolygonWithHolesCurve | PolylineCurve_2 | RectangleCurve_2 | CircleCurve_2 | LineCurve_2 | GroupShape | TextShape | ArcCurve_2 | BezierCurve | CompositeCurve_2;
+export declare type Shape = PolygonCurve | PolygonWithHolesCurve | PolylineCurve | RectangleCurve | CircleCurve | LineCurve | GroupShape | TextShape | ArcCurve | BezierCurve | CompositeCurve;
 
 declare type ShapeLayers = Record<string, Shape[]>;
 
@@ -2736,7 +2743,7 @@ declare interface SpaceGraphLayoutJson extends SpaceGraphSpatialStructureBaseJso
 }
 
 declare type SpaceGraphLocation = {
-    latLong: Vector2;
+    latLong: Vector2_2;
     rotation: number;
 };
 
@@ -2886,7 +2893,7 @@ declare class SpatialGraphEdge extends SpatialGraphNodeBase {
     boundaryWalls: [LayoutBoundaryWall | null, LayoutBoundaryWall | null];
     element: LayoutEdgeElement | null;
     constructor(id: string, vertex1: SpatialGraphVertex, vertex2: SpatialGraphVertex);
-    getPoints(): [Vector2_2, Vector2_2];
+    getPoints(): [Vector2, Vector2];
     setVertices(vertex1: SpatialGraphVertex, vertex2: SpatialGraphVertex): void;
     setVerticesByIds(vertexId1: string, vertexId2: string): void;
     canSplit(u: number, options?: EdgeCanSplitOptions): boolean;
@@ -2916,7 +2923,7 @@ declare type SpatialGraphNodeType = SpatialGraphVertexType | SpatialGraphEdgeTyp
 
 declare class SpatialGraphVertex extends SpatialGraphNodeBase {
     type: SpatialGraphVertexType;
-    position: Vector2;
+    position: Vector2_2;
     edges: SpatialGraphEdge[];
     constructor(id: string, x: number, y: number);
     sortVertexEdges(): void;
@@ -2927,7 +2934,7 @@ declare class SpatialGraphVertex extends SpatialGraphNodeBase {
 
 declare interface SpatialGraphVertexJson extends SpatialGraphNodeBaseJson {
     type: SpatialGraphVertexType;
-    position: Vector2;
+    position: Vector2_2;
 }
 
 declare type SpatialGraphVertexType = typeof SpatialGraphVertexTypeValue;
@@ -3046,9 +3053,9 @@ declare interface TemporaryAccessToken {
 
 declare type TemporaryAccessTokenFunction = (args: CreateTemporaryAccessToken) => Promise<TemporaryAccessToken>;
 
-declare interface TextShape extends BaseShape {
+export declare interface TextShape extends BaseShape {
     type: 'text';
-    position: Vector2_2;
+    position: Vector2;
     text: string;
     rotation?: number;
     alignV?: 'center' | 'bottom' | 'top';
@@ -3183,7 +3190,7 @@ declare type UriGeometryType = typeof UriGeometryTypeValue;
 
 declare const UriGeometryTypeValue = "geometry:uri";
 
-declare type Vector2 = [number, number];
+export declare type Vector2 = [number, number];
 
 declare type Vector2_2 = [number, number];
 
@@ -3206,9 +3213,9 @@ declare interface Vector3Range extends SpaceGraphTypedValueJson {
 declare type ViewEvent = 'pan' | 'zoom' | 'viewbox' | 'resize-canvas' | 'scene-rendered' | 'focus';
 
 declare class WebGlView extends TinyEmitter {
-    windowPos: Vector2_2;
+    windowPos: Vector2;
     zoom: number;
-    client: Vector2_2;
+    client: Vector2;
     layers: Map<string, PlanLayer>;
     viewbox: BoundingBox2d;
     styleCache: Record<string, ShapeStyle | 'selected'>;