@archilogic/floor-plan-sdk 5.1.17 → 5.2.0

package/README.md

@@ -2,6 +2,10 @@
 
 The @archilogic/floor-plan-sdk package enables you to create and embed interactive, customizable floor plans in the browser
 
+> **Note:** The SDK uses ES 2022 features and may require transpilation for older browser support.
+
+Check the detailed [documentation](https://developers.archilogic.com/floor-plan-engine/guide).
+
 ## Install
 
 ```bash
@@ -34,5 +38,3 @@ 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

@@ -1,4 +1,3 @@
-import { Container } from '@pixi/display';
 import { default as default_2 } from 'rbush';
 
 /**
@@ -68,8 +67,65 @@ declare type BackgroundOptions = {
     showGrid?: boolean;
 };
 
+declare interface BaseData {
+    id: string;
+    name: string;
+    type: string;
+    customId: string;
+    customAttributes: SpaceGraphCustomAttributeValue;
+    /** dimensions in meters */
+    dimensions: {
+        width: number;
+        length: number;
+        height: number;
+    };
+    /**
+     * axis alignend bounding box in root space
+     * @example
+     * {
+     *   min: [0, 0, 0],
+     *   max: [1, 2, 1]
+     * }
+     * */
+    boundingBox: BoundingBox3d;
+    /** contour of the object aligned bounding box in root space */
+    boundingBoxContour: Polygon_2;
+    labelPoint: Vector2_2;
+    contour: PolygonWithHoles_2;
+}
+
+declare interface BaseFilter {
+    id?: StringComparator;
+    type?: StringComparator;
+    name?: StringComparator | NullComparator;
+    customId?: StringComparator | NullComparator;
+    customAttributes?: Record<string, StringComparator | NumberComparator | BooleanComparator | NullComparator>;
+    dimensions?: {
+        width?: NumberComparator;
+        length?: NumberComparator;
+        height?: NumberComparator;
+    };
+}
+
 declare type BaseLayers = 'base' | 'scene' | 'preview' | 'annotation' | 'helper';
 
+declare interface BaseSelect {
+    id?: boolean;
+    type?: boolean;
+    name?: boolean;
+    customId?: boolean;
+    customAttributes?: boolean | Record<string, boolean>;
+    dimensions?: boolean | {
+        width?: boolean;
+        length?: boolean;
+        height?: boolean;
+    };
+    boundingBox?: boolean;
+    boundingBoxContour?: boolean;
+    labelPoint?: boolean;
+    contour?: boolean;
+}
+
 declare interface BaseShape {
     type: string;
     style?: ShapeStyle;
@@ -80,6 +136,12 @@ export declare interface BezierCurve extends BaseShape {
     points: Polygon;
 }
 
+declare type BooleanComparator = boolean | {
+    eq: boolean;
+} | {
+    neq: boolean;
+};
+
 export declare type BoundingBox2d = {
     min: Vector2;
     max: Vector2;
@@ -252,6 +314,11 @@ declare type CustomStairsParametersJson = Partial<CustomStairsParameters>;
 
 declare type CustomStairsType = 'custom';
 
+declare type DefaultSelect = {
+    id: true;
+    type: true;
+};
+
 declare type DimensionParameters = {
     /** @minimum 0.01 */
     length: number;
@@ -314,6 +381,54 @@ declare interface EdgeSplitReturnValue {
     element?: LayoutEdgeElement;
 }
 
+export declare interface ElementData extends BaseData {
+    type: LayoutElementJson['type'];
+    isExternal: boolean;
+    parameters: LayoutElementJson['parameters'];
+    category: string;
+    subCategory: string;
+    product: ProductData;
+    /** local transform for nested elements like openings, windows */
+    localTransform: SimpleTransform3d;
+    /** transform in root space */
+    transform: SimpleTransform3d;
+    /** local object aligned bounding box */
+    localBoundingBox: BoundingBox3d;
+    elements: ElementData[];
+    parent: ElementData;
+}
+
+export declare interface ElementFilter extends BaseFilter {
+    product?: ProductFilter;
+    category?: StringComparator;
+    subCategory?: StringComparator;
+    /** point query */
+    at?: Vector2_2;
+    /** 2d bounding box intersection */
+    within?: {
+        min: Vector2_2;
+        max: Vector2_2;
+    };
+    isExternal?: BooleanComparator;
+}
+
+declare type ElementQuery = {
+    select?: ElementSelect;
+    where?: ElementFilter;
+};
+
+export declare interface ElementSelect extends BaseSelect {
+    product?: ProductSelect | boolean;
+    category?: boolean;
+    subCategory?: boolean;
+    isExternal?: boolean;
+    localBoundingBox?: boolean;
+    localTransform?: boolean;
+    transform?: boolean;
+    parent?: ElementSelect | boolean;
+    elements?: ElementQuery | boolean;
+}
+
 declare interface ExportImage {
     /** output format: png, jpg */
     format?: 'png' | 'jpg';
@@ -356,10 +471,9 @@ declare class FloorPlanCore {
     computed: FpeComputed;
     loader: FpeLoader;
     layout: SpaceGraphLayout;
-    spaceGraph: SpaceGraph;
-    building: SpaceGraphBuilding;
+    /* Excluded from this release type: spaceGraph */
+    /* Excluded from this release type: building */
     isBrowser: boolean;
-    utils: any;
     location: {
         latitude: number;
         longitude: number;
@@ -389,15 +503,37 @@ declare class FloorPlanCore {
      * @returns {Promise.<Boolean, Error>} returns promise which resolves when loading is done
      */
     loadFloorById(floorId: string, accessTokenOptions?: TokenOptions): Promise<boolean | Error>;
+    /**
+     * Load a layout with its unique identifier the layoutId
+     * @param {string} layoutId id of the floor to load
+     * @param {AccessToken} accessTokenOptions Space API v2 [publishable](../space-api/v2/introduction.md#publishable-access-token) or [temporary](../space-api/v2/introduction.md#temporary-access-token) access token
+     * @returns {Promise.<Boolean, Error>} returns promise which resolves when loading is done
+     */
+    loadLayoutById(layoutId: string, accessTokenOptions?: TokenOptions): Promise<boolean | Error>;
     /**
      * Change options after the floor plan engine instance has been created
      */
     set(args?: FpeConfig): void;
+    /* Excluded from this release type: updateThemeFilter */
     getBoundingBox(margin?: number): BoundingBox2d;
+    getElements<S extends ElementSelect = DefaultSelect>(args?: {
+        select?: S;
+        where?: ElementFilter;
+    }): QueryPick<ElementData, S>[];
+    getElementsById<S extends ElementSelect = DefaultSelect>(args: {
+        select?: S;
+        id: string;
+    }): QueryPick<ElementData, S>;
+    getSpaces<S extends SpaceSelect = DefaultSelect>(args?: {
+        select?: S;
+        where?: SpaceFilter;
+    }): QueryPick<SpaceData, S>[];
+    getSpacesById<S extends SpaceSelect = DefaultSelect>(args: {
+        select?: S;
+        id: string;
+    }): QueryPick<SpaceData, S>;
     /**
-     * Get a list of spaces and assets for a specific plan position
-     * @param {*} position - plan position
-     * @returns {Object} - list of spaces and assets
+     * @deprecated getResourcesFromPosition is deprecated and will be removed in the next version. use `floorPlan.getElements({ where: { at: [1, 4 ]}})`
      */
     getResourcesFromPosition(position: Vector2): {
         spaces: LayoutSpace[];
@@ -417,13 +553,15 @@ export declare class FloorPlanEngine extends FloorPlanCore {
     fpeNode?: HTMLElement;
     view: WebGlView;
     interaction: FpeInteraction;
+    /** @deprecated the layout property is deprecated and will be removed in the next version. use `floorPlan.getElements()` or `floorPlan.getSpaces()` */
+    layout: SpaceGraphLayout;
     availableHelpers: {
         [name: string]: typeof Helper;
     };
     helper: {
         [name: string]: Helper;
     };
-    preventUpdateOnSpaceGraphEvent: boolean;
+    /* Excluded from this release type: preventUpdateOnSpaceGraphEvent */
     constructor({ container, options }?: {
         container?: Element;
         options?: FpeConfig;
@@ -442,7 +580,7 @@ export declare class FloorPlanEngine extends FloorPlanCore {
      */
     off<EventType extends FpeEvent, Context>(event: EventType, handler?: FpeEventHandler<EventType>, ctx?: Context): this;
     emit<EventType extends FpeEvent>(event: EventType, ...args: FpeEventMap[EventType]): this;
-    handleDrop(evt: DragEvent): void;
+    /* Excluded from this release type: handleDrop */
     /**
      * Change options after the floor plan engine instance has been created
      * @param args - Startup options
@@ -450,14 +588,12 @@ export declare class FloorPlanEngine extends FloorPlanCore {
     set(args: FpeConfig): void;
     drawNodePreview(id: string, layout: SpaceGraphLayout, layer: PlanLayer, style?: ShapeStyle): void;
     drawNodeUpdate(id: string, style?: 'selected' | ShapeStyle | false): void;
-    drawResourceUpdate({ resourceId }: {
-        resourceId: string;
-    }): void;
-    mountFloorPlan(root: Element): void;
-    initDrawing(): void;
-    initDrawingEvents(): void;
-    freeDrawingEvents(): void;
-    generateUi(): void;
+    /* Excluded from this release type: drawResourceUpdate */
+    /* Excluded from this release type: mountFloorPlan */
+    /* Excluded from this release type: initDrawing */
+    /* Excluded from this release type: initDrawingEvents */
+    /* Excluded from this release type: freeDrawingEvents */
+    /* Excluded from this release type: generateUi */
     /**
      * Get a bounding box containing the layout, with some padding
      * @param layoutBoundingBox - bounding box of the layout, in meters.
@@ -531,12 +667,6 @@ export declare class FloorPlanEngine extends FloorPlanCore {
      * get plan layer by name
      */
     getLayer(id: any): PlanLayer;
-    /**
-     * create plan graphic
-     * @deprecated use floorPlan.addLayer(<name>)
-     * @returns
-     */
-    addPlanGraphic(): PlanLayer;
     /**
      * Adds a helper and removes previous instances of it
      */
@@ -555,7 +685,7 @@ export declare class FloorPlanEngine extends FloorPlanCore {
 /**
  * This is the place to give the floor plan your own style
  */
-declare type FloorPlanTheme = {
+export declare type FloorPlanTheme = {
     /** define the background */
     background?: BackgroundOptions;
     /** wall contours are merged to one continuous outline, needed if you want white walls */
@@ -563,43 +693,20 @@ declare type FloorPlanTheme = {
     /** render assets with textures rather than solid colors */
     showAssetTextures?: boolean;
     fontFamily?: string;
-    elements?: {
-        byId?: Record<string, ShapeStyle>;
-        floorPlan?: {
-            grayscale: boolean;
-        };
-        roomStamp?: {
-            /** show the area information in room stamps */
-            roomStampDisplay?: ('usage' | 'area' | 'customId' | 'name' | 'id' | ['customAttribute', string])[];
-            /** text color for room stamps */
-            text?: Rgb;
-            /** whether the room stamp text should have an outline to assist with contrast issues */
-            textOutline?: boolean;
-        };
-        'element:asset'?: ShapeStyle;
-        'element:beam'?: ShapeStyle;
-        'element:boundaryWall'?: ShapeStyle;
-        'element:casework'?: ShapeStyle;
-        'element:ceiling'?: ShapeStyle;
-        'element:column'?: ShapeStyle;
-        'element:curtainWall'?: ShapeStyle;
-        'element:door'?: ShapeStyle;
-        'element:floor'?: ShapeStyle;
-        'element:generic'?: ShapeStyle;
-        'element:kitchen'?: ShapeStyle;
-        'element:opening'?: ShapeStyle;
-        'element:railing'?: ShapeStyle;
-        'element:ramp'?: ShapeStyle;
-        'element:roof'?: ShapeStyle;
-        'element:slab'?: ShapeStyle;
-        'element:spaceDivider'?: ShapeStyle;
-        'element:stairFlight'?: ShapeStyle;
-        'element:stairs'?: ShapeStyle;
-        'element:wall'?: ShapeStyle;
-        'element:window'?: ShapeStyle;
-        'layout:space'?: SpaceShapeStyle;
-        'spatialGraph:edge'?: ShapeStyle;
+    roomStamps?: {
+        /** show the area information in room stamps */
+        roomStampDisplay?: ('usage' | 'area' | 'customId' | 'name' | 'id' | ['customAttribute', string])[];
+        /** text color for room stamps */
+        text?: Rgb;
+        /** whether the room stamp text should have an outline to assist with contrast issues */
+        textOutline?: boolean;
+        /** if set room stamps have a fixed size - otherwise they adapt to the zoom level */
+        fontSize?: number;
     };
+    byId?: StyleByKey;
+    byFilter?: ThemeStyles['byFilter'];
+    /* Excluded from this release type: byResolvedFilter */
+    byType?: ThemeStyles['byType'];
 };
 
 declare type FpeComputed = {
@@ -2254,6 +2361,28 @@ declare type NodesByType<NodeMap extends NodeTypeMap = {}> = {
 
 declare type NodeTypeMap = Record<string, any>;
 
+declare type NullComparator = {
+    null: boolean;
+};
+
+declare type NumberComparator = number | {
+    eq: number;
+} | {
+    neq: number;
+} | {
+    in: number[];
+} | {
+    nin: number[];
+} | {
+    gt: number;
+} | {
+    gte: number;
+} | {
+    lt: number;
+} | {
+    lte: number;
+};
+
 declare interface NumberList extends SpaceGraphTypedValueJson {
     type: 'number:list';
     list: number[];
@@ -2378,6 +2507,8 @@ declare class PlanLayer {
 
 export declare type Polygon = Vector2[];
 
+declare type Polygon_2 = Vector2_2[];
+
 export declare interface PolygonCurve extends BaseShape {
     type: 'curve:polygon';
     points: Polygon;
@@ -2395,6 +2526,8 @@ declare const PolygonCurveTypeValue = "curve:polygon";
 /** outer ring counter clockwise, inner rings ( holes ) clockwise */
 export declare type PolygonWithHoles = Polygon[];
 
+declare type PolygonWithHoles_2 = Vector2_2[][];
+
 export declare interface PolygonWithHolesCurve extends BaseShape {
     type: 'curve:polygonWithHoles';
     polygons: PolygonWithHoles;
@@ -2425,8 +2558,33 @@ declare const PolylineCurveTypeValue = "curve:polyline";
 
 declare type PositionEntry = Vector3 | Vector3List | Vector3Range;
 
+export declare type PreserveViewbox = 'left-top' | 'left-center' | 'left-bottom' | 'center-top' | 'center-center' | 'center-bottom' | 'right-top' | 'right-center' | 'right-bottom' | 'screen-space';
+
 declare type ProductAttributes = SpaceGraphProduct['attributes'];
 
+declare interface ProductData extends BaseData {
+    type: SpaceGraphProduct['type'];
+    category: string;
+    subCategory: string;
+    seatCapacity: number;
+}
+
+declare interface ProductFilter extends BaseFilter {
+    category?: StringComparator;
+    subCategory?: StringComparator;
+    seatCapacity?: NumberComparator;
+}
+
+declare interface ProductSelect extends BaseSelect {
+    category?: boolean;
+    subCategory?: boolean;
+    seatCapacity?: boolean;
+}
+
+export declare type QueryPick<T, S> = {
+    [K in keyof S as S[K] extends false | undefined ? never : K]: K extends keyof T ? S[K] extends true ? T[K] : S[K] extends ElementQuery ? QueryPick<ElementData, S[K]['select'] extends undefined ? DefaultSelect : NonNullable<S[K]['select']>>[] : S[K] extends object ? T[K] extends any[] ? QueryPick<T[K][number], S[K]>[] : QueryPick<T[K], S[K]> : never : never;
+};
+
 export declare interface RectangleCurve extends BaseShape {
     type: 'curve:rectangle';
     position: Vector2;
@@ -2515,6 +2673,36 @@ declare interface ShapeStyle {
     alignment?: 0 | 0.5 | 1;
 }
 
+declare type SimpleTransform3d = {
+    position: Vector3;
+    rotation: number;
+};
+
+export declare interface SpaceData extends BaseData {
+    type: LayoutSpaceJson['type'];
+    isExternal: boolean;
+    category: string;
+    subCategory: string;
+    seatCapacity: number;
+    area: number;
+    elements: ElementData[];
+}
+
+export declare interface SpaceFilter extends BaseFilter {
+    category?: StringComparator;
+    subCategory?: StringComparator;
+    seatCapacity?: NumberComparator;
+    isExternal?: BooleanComparator;
+    area?: NumberComparator;
+    /** point query */
+    at?: Vector2_2;
+    /** 2d bounding box intersection */
+    within?: {
+        min: Vector2_2;
+        max: Vector2_2;
+    };
+}
+
 declare class SpaceGraph {
     spatialStructure: SpaceGraphSpatialStructure;
     products: SpaceGraphProduct[];
@@ -3154,13 +3342,13 @@ declare type SpaceLabelMapping = {
     [label: string]: string;
 };
 
-declare interface SpaceShapeStyle extends ShapeStyle {
-    usage?: {
-        [key: string]: ShapeStyle;
-    };
-    program?: {
-        [key: string]: ShapeStyle;
-    };
+export declare interface SpaceSelect extends BaseSelect {
+    category?: boolean;
+    subCategory?: boolean;
+    isExternal?: boolean;
+    area?: boolean;
+    seatCapacity?: boolean;
+    elements?: ElementQuery | boolean;
 }
 
 declare class SpatialGraphEdge extends SpatialGraphNodeBase {
@@ -3312,13 +3500,21 @@ declare type SpiralStairsType = 'spiral';
 declare interface StartupOptions {
     /** do not render elements of given types (e.g. 'element:asset', 'element:door', …), or 'roomStamp' */
     hideElements?: HideableElement[];
-    preserveViewbox?: string;
+    /**
+     * Controls how the viewport adjusts when the canvas container is resized.
+     *
+     * Alignment pairs anchor the viewport to a fixed point within the canvas:
+     * - `'center-center'` (default), `'left-top'`, `'right-top'`, `'left-bottom'`, `'right-bottom'`
+     *
+     * Screen-space mode keeps the floor plan at the same absolute screen position:
+     * - `'screen-space'` – compensates for the canvas element moving on screen
+     *   (e.g. when a sidebar opens/closes) so the plan stays visually stationary.
+     */
+    preserveViewbox?: PreserveViewbox;
     /** option to disable panning and zooming */
     panZoom?: boolean;
     /** if set, panning and zooming is restricted to the scene boundingbox plus the margin */
     panZoomMargin?: number;
-    /** if set room stamps have a fixed size - otherwise they adapt to the zoom level */
-    roomStampSize?: number;
     /** toggle overlaying UI elements */
     ui?: UI;
     /** floor plan theming */
@@ -3348,6 +3544,27 @@ declare type StraightStairsParametersJson = Partial<StraightStairsParameters>;
 
 declare type StraightStairsType = 'straight' | 'straightLanding';
 
+declare type StringComparator = string | {
+    eq: string;
+} | {
+    neq: string;
+} | {
+    in: string[];
+} | {
+    nin: string[];
+} | {
+    contains: string;
+};
+
+declare type StyleByKey = Record<string, ShapeStyle>;
+
+declare type StyledFilter = {
+    where: ElementFilter | SpaceFilter;
+    style: ShapeStyle;
+};
+
+declare type StyleFilter = StyledFilter;
+
 declare interface SurfaceMaterials {
     [surface: string]: SpaceGraphMaterial;
 }
@@ -3410,6 +3627,39 @@ declare enum TextureFilter {
     Grayscale = 2
 }
 
+declare type ThemeStyles = {
+    byId?: StyleByKey;
+    byType?: {
+        'element:asset'?: ShapeStyle;
+        'element:beam'?: ShapeStyle;
+        'element:boundaryWall'?: ShapeStyle;
+        'element:casework'?: ShapeStyle;
+        'element:ceiling'?: ShapeStyle;
+        'element:column'?: ShapeStyle;
+        'element:curtainWall'?: ShapeStyle;
+        'element:door'?: ShapeStyle;
+        'element:floor'?: ShapeStyle;
+        'element:generic'?: ShapeStyle;
+        'element:kitchen'?: ShapeStyle;
+        'element:opening'?: ShapeStyle;
+        'element:railing'?: ShapeStyle;
+        'element:ramp'?: ShapeStyle;
+        'element:roof'?: ShapeStyle;
+        'element:slab'?: ShapeStyle;
+        'element:spaceDivider'?: ShapeStyle;
+        'element:stairFlight'?: ShapeStyle;
+        'element:stairs'?: ShapeStyle;
+        'element:wall'?: ShapeStyle;
+        'element:window'?: ShapeStyle;
+        'layout:space'?: ShapeStyle;
+        'spatialGraph:edge'?: ShapeStyle;
+        'annotation:floorPlanImage'?: ShapeStyle & {
+            grayscale?: boolean;
+        };
+    };
+    byFilter?: StyleFilter[];
+};
+
 declare class Ticker {
     methods: {
         [name: string]: {
@@ -3512,7 +3762,7 @@ export declare type Vector2 = [number, number];
 
 declare type Vector2_2 = [number, number];
 
-declare type Vector3 = [number, number, number];
+export declare type Vector3 = [number, number, number];
 
 declare interface Vector3List extends SpaceGraphTypedValueJson {
     type: 'vector3:list';
@@ -3542,10 +3792,10 @@ declare class WebGlView extends TinyEmitter {
     viewportInFocus: boolean;
     wallNodesToUpdate: any[];
     wallNodeUpdateInProgress: boolean;
-    floorContainers: Map<string, Container>;
+    /* Excluded from this release type: floorContainers */
     roomStampLayers: Map<string, PlanLayer>;
     parentEl: HTMLElement;
-    _settings: FpeConfig;
+    /* Excluded from this release type: _settings */
     /* Excluded from this release type: gfxLayers */
     redrawScene: () => void;
     /* Excluded from this release type: gfxNodes */
@@ -3557,7 +3807,9 @@ declare class WebGlView extends TinyEmitter {
     /* Excluded from this release type: _zoomTarget */
     _oldTime: number;
     ticker?: Ticker;
+    _lastCanvasRect?: DOMRect;
     _resizeObserver?: ResizeObserver;
+    _resizeRafId: number | null;
     on: (event: ViewEvent, callback: Function, ctx?: any) => this;
     once: (event: ViewEvent, callback: Function, ctx?: any) => this;
     off: (event: ViewEvent, callback?: Function) => this;