@archilogic/floor-plan-sdk 5.1.8 → 5.1.10

package/dist/fpe.d.ts

@@ -311,8 +311,6 @@ declare interface EdgeSplitReturnValue {
     element?: LayoutEdgeElement;
 }
 
-declare type EdgeType = 'graph:adjacentTo' | 'graph:connectedTo';
-
 declare interface ExportImage {
     /** output format: png, jpg */
     format?: 'png' | 'jpg';
@@ -892,21 +890,33 @@ declare const GeometryUnionTypeValue = "csg:union";
 /**
  * undirected graph for traversal without edge weights
  */
-declare class Graph {
-    nodeMap: Map<LayoutNode, Map<EdgeType, Set<LayoutNode>>>;
-    addNode(node: LayoutNode): Map<EdgeType, Set<LayoutNode>>;
-    addEdge(type: EdgeType, source: LayoutNode, destination: LayoutNode): void;
-    removeNode(node: LayoutNode): void;
-    removeEdge(type: EdgeType, source: LayoutNode, destination: LayoutNode): void;
+declare class Graph<T extends GraphNodeType = GraphNodeType, K extends string = GraphEdgeType> {
+    nodeMap: Map<T, Map<K, Set<T>>>;
+    addNode(node: T): Map<K, Set<T>>;
+    addEdge(type: K, source: T, destination: T): void;
+    removeNode(node: T): void;
+    removeEdge(type: K, source: T, destination: T): void;
     /**
      * Breadth-First Search
      * if edges have weights this needs to be replaces with dijkstra algorithm
      */
-    findShortestPath(edgeType: EdgeType, start: LayoutNode, end: LayoutNode, options?: {
+    findShortestPath(edgeType: K, start: T, end: T, options?: {
         depthLimit?: number;
-    }): LayoutNode[] | null;
+    }): T[] | null;
+    toJSON(): {
+        nodes: {
+            id: string;
+            type: string;
+        }[];
+        edges: {
+            type: string;
+            nodes: string[];
+        }[];
+    };
 }
 
+declare type GraphEdgeType = 'graph:adjacentTo' | 'graph:connectedTo';
+
 export declare interface GraphicArgs {
     shapes: Shape[];
     position?: Vector2;
@@ -927,6 +937,11 @@ declare type GraphicUpdate = {
     shapes?: Shape[];
 };
 
+declare type GraphNodeType = {
+    id: string;
+    type: string;
+};
+
 declare class GroupRelation extends SpaceGraphNodeBase {
     type: GroupRelationType;
     elements: Set<LayoutElement>;
@@ -1164,6 +1179,8 @@ declare class LayoutAsset extends LayoutTransformElementBase {
     parameters: LayoutAssetParameters;
     product: SpaceGraphProduct | null;
     constructor(id: string);
+    get isComponentInstance(): boolean;
+    get isComponentInstanceChild(): boolean;
     setParameters(parameters: RecursivePartial<LayoutAssetParameters>): void;
     setProduct(product: SpaceGraphProduct): void;
     getBoundingBox(localTransform?: boolean): {
@@ -2416,7 +2433,8 @@ declare type ResourceScope =
 | "superadmin"
 | "token"
 | "subscription"
-| "graphql";
+| "graphql"
+| "extension";
 
 declare type Rgb = [number, number, number];
 
@@ -2466,7 +2484,8 @@ declare class SpaceGraph {
     products: SpaceGraphProduct[];
     productsById: Record<string, SpaceGraphProduct>;
     productsByType: NodesByType<{
-        readonly 'product:static': typeof SpaceGraphProduct;
+        readonly 'product:static': typeof SpaceGraphProductStatic;
+        readonly 'product:component': typeof SpaceGraphProductComponent;
     }>;
     customAttributes: SpaceGraphCustomAttribute[];
     customAttributesById: Record<string, SpaceGraphCustomAttribute>;
@@ -2503,7 +2522,8 @@ declare class SpaceGraph {
         readonly 'spatialStructure:floor': typeof SpaceGraphFloor;
         readonly 'spatialStructure:layout': typeof SpaceGraphLayout;
         readonly 'relation:group': typeof GroupRelation;
-        readonly 'product:static': typeof SpaceGraphProduct;
+        readonly 'product:static': typeof SpaceGraphProductStatic;
+        readonly 'product:component': typeof SpaceGraphProductComponent;
         readonly 'material:embedded': typeof SpaceGraphEmbeddedMaterial;
         readonly 'material:basic': typeof SpaceGraphBasicMaterial;
         readonly 'material:color': typeof SpaceGraphColorMaterial;
@@ -2561,7 +2581,7 @@ declare class SpaceGraph {
     createSpatialStructure(type: SpaceGraphSpatialStructureType, id: string): SpaceGraphSpatialStructure;
     insertProduct(product: SpaceGraphProduct): void;
     removeProduct(product: SpaceGraphProduct): void;
-    createProduct(id: string): SpaceGraphProduct;
+    createProduct(id: string, type: SpaceGraphProductType): SpaceGraphProduct;
     insertGeometry(geometryJson: SpaceGraphGeometryJson): void;
     removeGeometry(geometryJson: SpaceGraphGeometryJson): void;
     insertMaterial(material: SpaceGraphMaterial): void;
@@ -2856,7 +2876,7 @@ declare class SpaceGraphLayout extends SpaceGraphSpatialStructureBase {
             include?: string[];
         };
     }): number;
-    getLayoutGraph(): Graph;
+    getLayoutGraph(): Graph<LayoutNode>;
     getUniqueId(prefix: string, nodesById: Record<string, SpaceGraphNode>): string;
     getSpaceId(prefix?: string): string;
     getElementId(element: LayoutElement, prefix?: string): string;
@@ -2923,15 +2943,7 @@ declare interface SpaceGraphNodeWithCustomAttributesBaseJson extends SpaceGraphN
     customAttributes?: SpaceGraphCustomAttributeValueJson | null;
 }
 
-declare class SpaceGraphProduct extends SpaceGraphNodeWithCustomAttributesBase {
-    type: SpaceGraphProductType;
-    attributes: SpaceGraphProductAttributes;
-    geometries: GeometryOperationJson[];
-    constructor(id: string);
-    copyForClone(product: SpaceGraphProduct): void;
-    setAttributes(attributesJson: SpaceGraphProductAttributesJson): void;
-    toJSON(): SpaceGraphProductJson;
-}
+declare type SpaceGraphProduct = SpaceGraphProductStatic | SpaceGraphProductComponent;
 
 declare type SpaceGraphProductAttributes = {
     manufacturer: string;
@@ -2953,15 +2965,73 @@ declare type SpaceGraphProductAttributesJson = {
     updatedAt?: string;
 };
 
-declare interface SpaceGraphProductJson extends SpaceGraphNodeWithCustomAttributesBaseJson {
+declare class SpaceGraphProductBase extends SpaceGraphNodeWithCustomAttributesBase {
+    #private;
     type: SpaceGraphProductType;
+    attributes: SpaceGraphProductAttributes;
+    instances: Set<LayoutAsset>;
+    constructor(id: string, type: SpaceGraphProductType);
+    copyForClone(product: SpaceGraphProductStatic | SpaceGraphProductComponent): void;
+    setAttributes(attributesJson: SpaceGraphProductAttributesJson): void;
+    toJSON(): SpaceGraphProductJson;
+}
+
+declare class SpaceGraphProductComponent extends SpaceGraphProductBase {
+    type: SpaceGraphProductComponentType;
+    attributes: SpaceGraphProductAttributes;
+    products: {
+        position: PositionEntry;
+        rotation: RotationEntry;
+        product: string;
+    }[];
+    geometries: GeometryOperationJson[];
+    constructor(id: string);
+    copyForClone(product: SpaceGraphProductComponent): void;
+    toJSON(): SpaceGraphProductComponentJson;
+    setProducts(products: {
+        position: PositionEntry;
+        rotation: RotationEntry;
+        product: string;
+    }[]): void;
+    setInstances(): void;
+}
+
+declare interface SpaceGraphProductComponentJson extends SpaceGraphNodeWithCustomAttributesBaseJson {
+    type: SpaceGraphProductComponentType;
     attributes?: SpaceGraphProductAttributesJson;
+    products: {
+        position: PositionEntry;
+        rotation: RotationEntry;
+        product: string;
+    }[];
     geometries: GeometryOperationJson[];
 }
 
-declare type SpaceGraphProductType = typeof SpaceGraphProductTypeValue;
+declare type SpaceGraphProductComponentType = typeof SpaceGraphProductComponentTypeValue;
+
+declare const SpaceGraphProductComponentTypeValue = "product:component";
+
+declare type SpaceGraphProductJson = SpaceGraphProductStaticJson | SpaceGraphProductComponentJson;
+
+declare class SpaceGraphProductStatic extends SpaceGraphProductBase {
+    type: SpaceGraphProductStaticType;
+    geometries: GeometryOperationJson[];
+    constructor(id: string);
+    copyForClone(product: SpaceGraphProductStatic): void;
+    toJSON(): SpaceGraphProductStaticJson;
+}
+
+declare interface SpaceGraphProductStaticJson extends SpaceGraphNodeWithCustomAttributesBaseJson {
+    type: SpaceGraphProductStaticType;
+    attributes?: SpaceGraphProductAttributesJson;
+    geometries: GeometryOperationJson[];
+}
+
+declare type SpaceGraphProductStaticType = typeof SpaceGraphProductStaticTypeValue;
+
+declare const SpaceGraphProductStaticTypeValue = "product:static";
 
-declare const SpaceGraphProductTypeValue = "product:static";
+declare type SpaceGraphProductType = SpaceGraphProductStaticType | SpaceGraphProductComponentType;
 
 declare type SpaceGraphRelation = GroupRelation;