@archilogic/extension-sdk 0.6.2 → 0.7.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @archilogic/extension-sdk
 
+## 0.7.1
+
+### Patch Changes
+
+- 9b06638: feat: add description to extension manifest
+
+## 0.7.0
+
+### Minor Changes
+
+- ee852f2: feat(extension-sdk): support floor plan theme filters via floor-plan-core update
+- 8b067d4: feat(extension-sdk): add hostApi.prompt and hostApi.confirm methods
+- f3ea834: feat(extension-sdk): upgrade to space-graph-sdk 0.3
+
+### Patch Changes
+
+- 0d96245: fix(extension-sdk): used mapped type instead of fragile type generation
+
 ## 0.6.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -85,21 +85,25 @@ declare interface BaseData {
         height: number;
     };
     /**
-     * dimensions in meters
+     * axis alignend bounding box in root space
      * @example
      * {
      *   min: [0, 0, 0],
-     *   max: [1, 2, 1],
-     *   transform: {
-     *     position: [0, 0, 0],
-     *     rotation: 0,
-     *     rotationAxis: [0, 1, 0]
-     *   }
+     *   max: [1, 2, 1]
      * }
      * */
-    boundingBox: TransformBoundingBox3d;
-    /**  */
-    boundingBoxContour: Vector2[];
+    boundingBox: BoundingBox3d;
+    /** contour of the object aligned bounding box in root space */
+    boundingBoxContour: Polygon;
+    labelPoint: Vector2;
+    contour: PolygonWithHoles;
+}
+
+declare interface BaseField {
+    label?: string;
+    type: FieldType;
+    default?: FieldValueType;
+    required?: boolean;
 }
 
 declare interface BaseFilter {
@@ -128,6 +132,8 @@ declare interface BaseSelect {
     };
     boundingBox?: boolean;
     boundingBoxContour?: boolean;
+    labelPoint?: boolean;
+    contour?: boolean;
 }
 
 declare interface BaseShape {
@@ -137,7 +143,7 @@ declare interface BaseShape {
 
 declare interface BezierCurve extends BaseShape {
     type: 'curve:quadraticBezier';
-    points: Polygon;
+    points: Polygon_2;
 }
 
 declare type BooleanComparator = boolean | {
@@ -146,6 +152,11 @@ declare type BooleanComparator = boolean | {
     neq: boolean;
 };
 
+declare interface BooleanField extends BaseField {
+    type: 'boolean';
+    default?: boolean;
+}
+
 declare type BoundingBox3d = {
     min: Vector3;
     max: Vector3;
@@ -251,6 +262,13 @@ declare type CompositeCurveType = typeof CompositeCurveTypeValue;
 
 declare const CompositeCurveTypeValue = "curve:composite";
 
+export declare interface ConfirmArgs {
+    title: string;
+    message?: string;
+    confirmLabel?: string;
+    cancelLabel?: string;
+}
+
 /**
  * An object representing the connection as a result of calling connect().
  */
@@ -399,7 +417,7 @@ declare type CustomStairsParametersJson = Partial<CustomStairsParameters>;
 
 declare type CustomStairsType = 'custom';
 
-declare type DefaultSelect = {
+export declare type DefaultSelect = {
     id: true;
     type: true;
 };
@@ -616,9 +634,14 @@ export declare interface ElementData extends BaseData {
     isExternal: boolean;
     parameters: LayoutElementJson['parameters'];
     product: ProductData;
-    position: Vector3;
-    rotation: number;
+    /** 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 {
@@ -648,8 +671,11 @@ declare const ElementRemoveTypeValue: "operation:elementRemove";
 export declare interface ElementSelect extends BaseSelect {
     product?: ProductSelect | boolean;
     isExternal?: boolean;
-    position?: boolean;
-    rotation?: boolean;
+    localBoundingBox?: boolean;
+    localTransform?: boolean;
+    transform?: boolean;
+    parent?: ElementSelect | boolean;
+    elements?: ElementQuery | boolean;
 }
 
 declare class ElementUpdate extends OperationBase {
@@ -724,10 +750,14 @@ declare type ExtrusionGeometryType = typeof ExtrusionGeometryTypeValue;
 
 declare const ExtrusionGeometryTypeValue = "geometry:extrusion";
 
+declare type FieldType = 'text' | 'number' | 'boolean' | 'select';
+
+declare type FieldValueType = string | number | boolean;
+
 /**
  * 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 */
@@ -735,43 +765,19 @@ 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'];
+    byType?: ThemeStyles['byType'];
 };
 
 declare class GeometryBase extends SpaceGraphNodeBase {
@@ -986,7 +992,12 @@ declare type HingeSide = 'left' | 'right';
 export declare type HostApi = {
     /**
      * @example
-     * const element = await hostApi.getElementsById({ id, select: { type: true, dimensions: { length: true }}})
+     * ```ts
+     * const element = await hostApi.getElementsById({
+     *  id,
+     *  select: { type: true, dimensions: { length: true }}
+     * })
+     * ```
      */
     getElementById: <S extends ElementSelect = DefaultSelect>(args: {
         id: string;
@@ -994,7 +1005,13 @@ export declare type HostApi = {
     }) => Promise<QueryPick<ElementData, S> | null>;
     /**
      * @example
-     * const elements = await hostApi.getElements({ where: { customAttributes: { broken: true }}})
+     * ```ts
+     * const elements = await hostApi.getElements({
+     *   where: {
+     *     customAttributes: { broken: true }
+     *   }
+     * })
+     * ```
      */
     getElements: <S extends ElementSelect = DefaultSelect>(args?: {
         select?: S;
@@ -1016,6 +1033,9 @@ export declare type HostApi = {
         select?: S;
         where?: ProductFilter;
     }) => Promise<QueryPick<ProductData, S>[]>;
+    getLayout: <S extends LayoutSelect = DefaultSelect>(args?: {
+        select?: S;
+    }) => Promise<QueryPick<LayoutData, S>>;
     runOperations: (args: {
         operations: OperationJson[];
     }) => Promise<OperationsResult>;
@@ -1049,77 +1069,27 @@ export declare type HostApi = {
     selectNodes: (args: {
         nodeIds: string[];
     }) => Promise<NodeResult[]>;
+    /**
+     * @example
+     * ```ts
+     * const layoutConfig = await hostApi.prompt({
+     *   title: 'Specify layout configuration',
+     *   fields: {
+     *     chairCount: { type: 'number', label: 'Chair count', min: 3, max: 20, step: 1, default: 5 },
+     *     radius: { type: 'number', min: 1, max: 10, step: 0.1 }
+     *   }
+     * })
+     * ```
+     */
+    prompt: (args: PromptArgs) => Promise<Record<string, FieldValueType> | false>;
+    confirm: (args: ConfirmArgs) => Promise<boolean>;
     on: <K extends ExtensionEventKey>(event: K, listener: ExtensionEventListener<K>, ctx?: unknown) => void;
     once: <K extends ExtensionEventKey>(event: K, listener: ExtensionEventListener<K>, ctx?: unknown) => void;
     off: <K extends ExtensionEventKey>(event: K, listener?: ExtensionEventListener<K>) => void;
 };
 
 export declare type HostApiSync = {
-    /**
-     * @example
-     * const element = await hostApi.getElementsById({ id, select: { type: true, dimensions: { length: true }}})
-     */
-    getElementById: <S extends ElementSelect = DefaultSelect>(args: {
-        id: string;
-        select?: S;
-    }) => QueryPick<ElementData, S> | null;
-    /**
-     * @example
-     * const elements = await hostApi.getElements({ where: { customAttributes: { broken: true }}})
-     */
-    getElements: <S extends ElementSelect = DefaultSelect>(args?: {
-        select?: S;
-        where?: ElementFilter;
-    }) => QueryPick<ElementData, S>[];
-    getSpaceById: <S extends SpaceSelect = DefaultSelect>(args: {
-        id: string;
-        select?: S;
-    }) => QueryPick<SpaceData, S> | null;
-    getSpaces: <S extends SpaceSelect = DefaultSelect>(args?: {
-        select?: S;
-        where?: SpaceFilter;
-    }) => QueryPick<SpaceData, S>[];
-    getProductById: <S extends ProductSelect = DefaultSelect>(args: {
-        id: string;
-        select?: S;
-    }) => QueryPick<ProductData, S> | null;
-    getProducts: <S extends ProductSelect = DefaultSelect>(args?: {
-        select?: S;
-        where?: ProductFilter;
-    }) => QueryPick<ProductData, S>[];
-    runOperations: (args: {
-        operations: OperationJson[];
-    }) => OperationsResult;
-    setPlanConfig: (config: {
-        theme: FloorPlanTheme;
-    }) => boolean;
-    addPlanLayer: (args: {
-        id?: string;
-        baseLayer?: string;
-    }) => EntityResult;
-    addPlanGraphic: (args: {
-        shapes: Shape[];
-        isHandler?: boolean;
-        layerId?: string;
-        id?: string;
-        clearLayer?: boolean;
-    }) => EntityResult;
-    zoomToNode: (args: {
-        nodeId: string;
-        margin?: number;
-        animate?: number | boolean;
-    }) => boolean;
-    zoomExtents: (args?: {
-        margin?: number;
-        animate?: number | boolean;
-    }) => boolean;
-    drawNodeUpdate: (args: {
-        nodeId: string;
-        style: 'selected' | ShapeStyle | false;
-    }) => boolean;
-    selectNodes: (args: {
-        nodeIds: string[];
-    }) => NodeResult[];
+    [K in Exclude<keyof HostApi, OmitKeys>]: K extends KeepAsync ? HostApi[K] : Sync<HostApi[K]>;
 };
 
 declare type IndexedNodeReference = {
@@ -1137,6 +1107,8 @@ declare type IndexRange = {
     end: number;
 };
 
+declare type KeepAsync = 'prompt' | 'confirm';
+
 declare class Layout2dView extends LayoutViewBase {
     type: Layout2dViewType;
     parameters: Layout2dViewParameters;
@@ -1521,6 +1493,10 @@ declare type LayoutCurtainWallType = typeof LayoutCurtainWallTypeValue;
 
 declare const LayoutCurtainWallTypeValue = "element:curtainWall";
 
+declare interface LayoutData extends BaseData {
+    type: SpaceGraphLayout['type'];
+}
+
 declare class LayoutDoor extends LayoutTransformElementBase {
     type: LayoutDoorType;
     parameters: LayoutDoorParameters;
@@ -1891,6 +1867,11 @@ declare type LayoutRoofType = typeof LayoutRoofTypeValue;
 
 declare const LayoutRoofTypeValue = "element:roof";
 
+declare interface LayoutSelect extends BaseSelect {
+    spaces?: SpaceQuery;
+    elements?: ElementQuery;
+}
+
 declare class LayoutSlab extends LayoutTransformElementBase {
     type: LayoutSlabType;
     parameters: LayoutSlabParameters;
@@ -2369,6 +2350,14 @@ declare type NumberComparator = number | {
     lte: number;
 };
 
+declare interface NumberField extends BaseField {
+    type: 'number';
+    min: number;
+    max: number;
+    step: number;
+    default?: number;
+}
+
 declare interface NumberList extends SpaceGraphTypedValueJson {
     type: 'number:list';
     list: number[];
@@ -2383,6 +2372,8 @@ declare interface NumberRange extends SpaceGraphTypedValueJson {
     };
 }
 
+declare type OmitKeys = 'on' | 'off' | 'once';
+
 declare type OpenCurve = LineCurve | PolylineCurve | ArcCurve;
 
 declare type OpenCurves = LineCurve_2 | ArcCurve_2 | PolylineCurve_2 | BezierCurve;
@@ -2470,7 +2461,9 @@ declare type PlaneGeometryType = typeof PlaneGeometryTypeValue;
 
 declare const PlaneGeometryTypeValue = "geometry:plane";
 
-declare type Polygon = Vector2_2[];
+declare type Polygon = Vector2[];
+
+declare type Polygon_2 = Vector2_2[];
 
 declare interface PolygonCurve extends CurveBase {
     type: PolygonCurveType;
@@ -2479,15 +2472,17 @@ declare interface PolygonCurve extends CurveBase {
 
 declare interface PolygonCurve_2 extends BaseShape {
     type: 'curve:polygon';
-    points: Polygon;
+    points: Polygon_2;
 }
 
 declare type PolygonCurveType = typeof PolygonCurveTypeValue;
 
 declare const PolygonCurveTypeValue = "curve:polygon";
 
+declare type PolygonWithHoles = Vector2[][];
+
 /** outer ring counter clockwise, inner rings ( holes ) clockwise */
-declare type PolygonWithHoles = Polygon[];
+declare type PolygonWithHoles_2 = Polygon_2[];
 
 declare interface PolygonWithHolesCurve extends CurveBase {
     type: PolygonWithHolesCurveType;
@@ -2496,7 +2491,7 @@ declare interface PolygonWithHolesCurve extends CurveBase {
 
 declare interface PolygonWithHolesCurve_2 extends BaseShape {
     type: 'curve:polygonWithHoles';
-    polygons: PolygonWithHoles;
+    polygons: PolygonWithHoles_2;
 }
 
 declare type PolygonWithHolesCurveType = typeof PolygonWithHolesCurveTypeValue;
@@ -2510,7 +2505,7 @@ declare interface PolylineCurve extends CurveBase {
 
 declare interface PolylineCurve_2 extends BaseShape {
     type: 'curve:polyline';
-    points: Polygon;
+    points: Polygon_2;
 }
 
 declare type PolylineCurveType = typeof PolylineCurveTypeValue;
@@ -2586,7 +2581,15 @@ declare const ProductUpdateTypeValue: "operation:productUpdate";
 
 declare type ProductUpdateValue = Partial<SpaceGraphProductJson>;
 
-declare type QueryPick<T, S> = {
+export declare interface PromptArgs extends ConfirmArgs {
+    fields: PromptFieldSet;
+}
+
+export declare type PromptField = TextField | BooleanField | SelectField | NumberField;
+
+export declare type PromptFieldSet = Record<string, PromptField>;
+
+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;
 };
 
@@ -2703,7 +2706,17 @@ declare type RgbA = [number, number, number, number];
 
 declare type RotationEntry = number | NumberList | NumberRange;
 
-declare type Shape = PolygonCurve_2 | PolygonWithHolesCurve_2 | PolylineCurve_2 | RectangleCurve_2 | CircleCurve_2 | LineCurve_2 | GroupShape | TextShape | ArcCurve_2 | BezierCurve | CompositeCurve_2;
+declare interface SelectField extends BaseField {
+    type: 'select';
+    options?: SelectOption[] | string[];
+}
+
+declare interface SelectOption {
+    value: string;
+    label: string;
+}
+
+export declare type Shape = PolygonCurve_2 | PolygonWithHolesCurve_2 | PolylineCurve_2 | RectangleCurve_2 | CircleCurve_2 | LineCurve_2 | GroupShape | TextShape | ArcCurve_2 | BezierCurve | CompositeCurve_2;
 
 declare interface ShapeStyle {
     stroke?: string | number | number[];
@@ -2715,6 +2728,11 @@ declare interface ShapeStyle {
     alignment?: 0 | 0.5 | 1;
 }
 
+declare type SimpleTransform3d = {
+    position: Vector3;
+    rotation: number;
+};
+
 declare class SpaceCreate extends OperationBase {
     type: typeof SpaceCreateTypeValue;
     value: SpaceCreateValue;
@@ -2736,8 +2754,6 @@ export declare interface SpaceData extends BaseData {
     subCategory: string;
     seatCapacity: number;
     area: number;
-    labelPoint: Vector2;
-    polygons: PolygonWithHoles;
     elements: ElementData[];
 }
 
@@ -3380,6 +3396,11 @@ declare interface SpaceGraphTypedValueJson {
     type: string;
 }
 
+declare type SpaceQuery = {
+    select?: SpaceSelect;
+    where?: SpaceFilter;
+};
+
 declare class SpaceRemove extends OperationBase {
     type: typeof SpaceRemoveTypeValue;
     previousValue: SpaceRemoveValue;
@@ -3399,19 +3420,8 @@ export declare interface SpaceSelect extends BaseSelect {
     subCategory?: boolean;
     isExternal?: boolean;
     area?: boolean;
-    labelPoint?: boolean;
     seatCapacity?: boolean;
-    polygons?: boolean;
-    elements?: ElementQuery;
-}
-
-declare interface SpaceShapeStyle extends ShapeStyle {
-    usage?: {
-        [key: string]: ShapeStyle;
-    };
-    program?: {
-        [key: string]: ShapeStyle;
-    };
+    elements?: ElementQuery | boolean;
 }
 
 declare class SpaceUpdate extends OperationBase {
@@ -3599,6 +3609,15 @@ declare type StringComparator = string | {
     in: 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;
 }
@@ -3611,6 +3630,13 @@ declare interface Surfaces {
     [surface: string]: GeometryFaceIndices;
 }
 
+declare type Sync<T> = T extends (...args: infer A) => Promise<infer R> ? (...args: A) => R : T;
+
+declare interface TextField extends BaseField {
+    type: 'text';
+    default?: string;
+}
+
 declare interface TextShape extends BaseShape {
     type: 'text';
     position: Vector2_2;
@@ -3621,6 +3647,39 @@ declare interface TextShape extends BaseShape {
     fontSize?: number;
 }
 
+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 type Transform3d = {
     position: Vector3;
     rotation: number;

package/dist/manifest-schema.json

@@ -6,6 +6,10 @@
       "type": "string",
       "description": "The name of the extension"
     },
+    "description": {
+      "type": "string",
+      "description": "A description of what the extension does"
+    },
     "id": {
       "type": "string",
       "format": "uuid",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@archilogic/extension-sdk",
   "description": "",
-  "version": "0.6.2",
+  "version": "0.7.1",
   "publishConfig": {
     "access": "public"
   },
@@ -11,14 +11,13 @@
   ],
   "scripts": {
     "dev": "vite",
-    "build": "npm run generate-types && vite build",
+    "build": "vite build",
     "lint": "eslint --ext .ts,.js,.vue --fix src",
     "serve": "vite preview",
     "test": "vitest --run",
     "typecheck": "tsc --noEmit",
     "format": "prettier . -w -u --log-level silent",
-    "codecheck": "npm run typecheck && npm run lint && npm run format",
-    "generate-types": "npx vite-node ./tasks/generate-types.ts"
+    "codecheck": "npm run typecheck && npm run lint && npm run format"
   },
   "type": "module",
   "main": "./dist/extension-sdk.cjs",
@@ -36,7 +35,8 @@
     "tiny-emitter": "^2.1.0"
   },
   "devDependencies": {
-    "@archilogic/space-graph-sdk": "^0.1.1",
+    "@archilogic/floor-plan-core": "^5.3.1",
+    "@archilogic/space-graph-sdk": "^0.3.1",
     "vite-plugin-static-copy": "^3.1.4"
   },
   "nx": {}