@archilogic/extension-sdk 0.2.5 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @archilogic/extension-sdk
 
+## 0.4.0
+
+### Minor Changes
+
+- 8532ccf: feat: rename onPluginConnect / Destroy to onConnect / Destroy
+
+## 0.3.0
+
+### Minor Changes
+
+- 52c9e56: feat(sdk): use space-graph-core query method types
+
 ## 0.2.5
 
 ### Patch Changes

package/dist/extension-sdk.js

@@ -3,15 +3,15 @@ var Q = (e) => {
   throw TypeError(e);
 };
 var Ee = (e, t, r) => t in e ? we(e, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[t] = r;
-var P = (e, t, r) => Ee(e, typeof t != "symbol" ? t + "" : t, r), Z = (e, t, r) => t.has(e) || Q("Cannot " + r);
-var s = (e, t, r) => (Z(e, t, "read from private field"), r ? r.call(e) : t.get(e)), f = (e, t, r) => t.has(e) ? Q("Cannot add the same private member more than once") : t instanceof WeakSet ? t.add(e) : t.set(e, r), I = (e, t, r, a) => (Z(e, t, "write to private field"), a ? a.call(e, r) : t.set(e, r), r);
-var Pe = class extends Error {
+var I = (e, t, r) => Ee(e, typeof t != "symbol" ? t + "" : t, r), Z = (e, t, r) => t.has(e) || Q("Cannot " + r);
+var s = (e, t, r) => (Z(e, t, "read from private field"), r ? r.call(e) : t.get(e)), f = (e, t, r) => t.has(e) ? Q("Cannot add the same private member more than once") : t instanceof WeakSet ? t.add(e) : t.set(e, r), P = (e, t, r, a) => (Z(e, t, "write to private field"), a ? a.call(e, r) : t.set(e, r), r);
+var Ie = class extends Error {
   constructor(t, r) {
     super(r);
-    P(this, "code");
+    I(this, "code");
     this.name = "PenpalError", this.code = t;
   }
-}, w = Pe, Ie = (e) => ({
+}, w = Ie, Pe = (e) => ({
   name: e.name,
   message: e.message,
   stack: e.stack,
@@ -26,19 +26,19 @@ var Pe = class extends Error {
   return n.name = e, n.stack = r, n;
 }, Se = Symbol("Reply"), B, ae, Ce = (ae = class {
   constructor(e, t) {
-    P(this, "value");
-    P(this, "transferables");
+    I(this, "value");
+    I(this, "transferables");
     // Allows TypeScript to distinguish between an actual instance of this
     // class versus an object that looks structurally similar.
     // eslint-disable-next-line no-unused-private-class-members
     f(this, B, Se);
     this.value = e, this.transferables = t == null ? void 0 : t.transferables;
   }
-}, B = new WeakMap(), ae), me = Ce, M = "penpal", W = (e) => typeof e == "object" && e !== null, de = (e) => typeof e == "function", Re = (e) => W(e) && e.namespace === M, j = (e) => e.type === "SYN", X = (e) => e.type === "ACK1", g = (e) => e.type === "ACK2", ce = (e) => e.type === "CALL", le = (e) => e.type === "REPLY", Ne = (e) => e.type === "DESTROY", ue = (e, t = []) => {
+}, B = new WeakMap(), ae), me = Ce, M = "penpal", W = (e) => typeof e == "object" && e !== null, ce = (e) => typeof e == "function", Re = (e) => W(e) && e.namespace === M, j = (e) => e.type === "SYN", X = (e) => e.type === "ACK1", g = (e) => e.type === "ACK2", de = (e) => e.type === "CALL", le = (e) => e.type === "REPLY", Ne = (e) => e.type === "DESTROY", ue = (e, t = []) => {
   const r = [];
   for (const a of Object.keys(e)) {
     const n = e[a];
-    de(n) ? r.push([...t, a]) : W(n) && r.push(
+    ce(n) ? r.push([...t, a]) : W(n) && r.push(
       ...ue(n, [...t, a])
     );
   }
@@ -48,18 +48,18 @@ var Pe = class extends Error {
     (a, n) => W(a) ? a[n] : void 0,
     t
   );
-  return de(r) ? r : void 0;
+  return ce(r) ? r : void 0;
 }, C = (e) => e.join("."), ee = (e, t, r) => ({
   namespace: M,
   channel: e,
   type: "REPLY",
   callId: t,
   isError: !0,
-  ...r instanceof Error ? { value: Ie(r), isSerializedErrorInstance: !0 } : { value: r }
+  ...r instanceof Error ? { value: Pe(r), isSerializedErrorInstance: !0 } : { value: r }
 }), Te = (e, t, r, a) => {
   let n = !1;
-  const c = async (l) => {
-    if (n || !ce(l))
+  const d = async (l) => {
+    if (n || !de(l))
       return;
     a == null || a(`Received ${C(l.methodPath)}() call`, l);
     const { methodPath: v, args: h, id: o } = l;
@@ -89,15 +89,15 @@ var Pe = class extends Error {
         throw u.name === "DataCloneError" && (i = ee(r, o, u), a == null || a(`Sending ${C(v)}() reply`, i), e.sendMessage(i)), u;
       }
   };
-  return e.addMessageHandler(c), () => {
-    n = !0, e.removeMessageHandler(c);
+  return e.addMessageHandler(d), () => {
+    n = !0, e.removeMessageHandler(d);
   };
 }, De = Te, se, he = ((se = crypto.randomUUID) == null ? void 0 : se.bind(crypto)) ?? (() => new Array(4).fill(0).map(
   () => Math.floor(Math.random() * Number.MAX_SAFE_INTEGER).toString(16)
 ).join("-")), Le = Symbol("CallOptions"), J, ie, ke = (ie = class {
   constructor(e) {
-    P(this, "transferables");
-    P(this, "timeout");
+    I(this, "transferables");
+    I(this, "timeout");
     // Allows TypeScript to distinguish between an actual instance of this
     // class versus an object that looks structurally similar.
     // eslint-disable-next-line no-unused-private-class-members
@@ -112,8 +112,8 @@ var Pe = class extends Error {
       if (n !== "then")
         return r.length && Oe.has(n) ? Reflect.get(a, n) : pe(e, t, [...r, n]);
     },
-    apply(a, n, c) {
-      return e(r, c);
+    apply(a, n, d) {
+      return e(r, d);
     }
   }
 ), te = (e) => new w(
@@ -123,7 +123,7 @@ var Pe = class extends Error {
   )}() failed due to destroyed connection`
 ), He = (e, t, r) => {
   let a = !1;
-  const n = /* @__PURE__ */ new Map(), c = (h) => {
+  const n = /* @__PURE__ */ new Map(), d = (h) => {
     if (!le(h))
       return;
     const { callId: o, value: i, isError: E, isSerializedErrorInstance: u } = h, p = n.get(o);
@@ -134,7 +134,7 @@ var Pe = class extends Error {
       u ? Ae(i) : i
     ) : p.resolve(i));
   };
-  return e.addMessageHandler(c), {
+  return e.addMessageHandler(d), {
     remoteProxy: pe((h, o) => {
       if (a)
         throw te(h);
@@ -169,7 +169,7 @@ var Pe = class extends Error {
       });
     }, r),
     destroy: () => {
-      a = !0, e.removeMessageHandler(c);
+      a = !0, e.removeMessageHandler(d);
       for (const { methodPath: h, reject: o, timeoutId: i } of n.values())
         clearTimeout(i), o(te(h));
       n.clear();
@@ -245,7 +245,7 @@ var Pe = class extends Error {
       penpal: "synAck",
       methodNames: e.methodPaths.map(re)
     };
-  if (ce(e))
+  if (de(e))
     return {
       penpal: "call",
       // Actually converting the ID to a number would break communication.
@@ -278,7 +278,7 @@ var Pe = class extends Error {
   channel: a,
   log: n
 }) => {
-  const c = he();
+  const d = he();
   let l;
   const v = [];
   let h = !1;
@@ -290,33 +290,33 @@ var Pe = class extends Error {
       )
     );
   }, r) : void 0, K = () => {
-    for (const d of v)
-      d();
+    for (const c of v)
+      c();
   }, F = () => {
     if (h)
       return;
     v.push(De(e, t, a, n));
-    const { remoteProxy: d, destroy: m } = xe(e, a, n);
+    const { remoteProxy: c, destroy: m } = xe(e, a, n);
     v.push(m), clearTimeout(p), h = !0, E({
-      remoteProxy: d,
+      remoteProxy: c,
       destroy: K
     });
   }, Y = () => {
-    const d = {
+    const c = {
       namespace: M,
       type: "SYN",
       channel: a,
-      participantId: c
+      participantId: d
     };
-    n == null || n("Sending handshake SYN", d);
+    n == null || n("Sending handshake SYN", c);
     try {
-      e.sendMessage(d);
+      e.sendMessage(c);
     } catch (m) {
       u(new w("TRANSMISSION_FAILED", m.message));
     }
-  }, O = (d) => {
-    if (n == null || n("Received handshake SYN", d), d.participantId === l && // TODO: Used for backward-compatibility. Remove in next major version.
-    l !== G || (l = d.participantId, Y(), !(c > l || // TODO: Used for backward-compatibility. Remove in next major version.
+  }, O = (c) => {
+    if (n == null || n("Received handshake SYN", c), c.participantId === l && // TODO: Used for backward-compatibility. Remove in next major version.
+    l !== G || (l = c.participantId, Y(), !(d > l || // TODO: Used for backward-compatibility. Remove in next major version.
     l === G)))
       return;
     const $ = {
@@ -332,8 +332,8 @@ var Pe = class extends Error {
       u(new w("TRANSMISSION_FAILED", Me.message));
       return;
     }
-  }, z = (d) => {
-    n == null || n("Received handshake ACK1", d);
+  }, z = (c) => {
+    n == null || n("Received handshake ACK1", c);
     const m = {
       namespace: M,
       channel: a,
@@ -347,10 +347,10 @@ var Pe = class extends Error {
       return;
     }
     F();
-  }, T = (d) => {
-    n == null || n("Received handshake ACK2", d), F();
-  }, q = (d) => {
-    j(d) && O(d), X(d) && z(d), g(d) && T(d);
+  }, T = (c) => {
+    n == null || n("Received handshake ACK2", c), F();
+  }, q = (c) => {
+    j(c) && O(c), X(c) && z(c), g(c) && T(c);
   };
   return e.addMessageHandler(q), v.push(() => e.removeMessageHandler(q)), Y(), i;
 }, ze = Ke, ge = (e) => {
@@ -371,7 +371,7 @@ var Pe = class extends Error {
       "A messenger can only be used for a single connection"
     );
   ne.add(e);
-  const c = [e.destroy], l = Ge((o) => {
+  const d = [e.destroy], l = Ge((o) => {
     if (o) {
       const i = {
         namespace: M,
@@ -383,7 +383,7 @@ var Pe = class extends Error {
       } catch {
       }
     }
-    for (const i of c)
+    for (const i of d)
       i();
     n == null || n("Connection destroyed");
   }), v = (o) => Re(o) && o.channel === a;
@@ -400,7 +400,7 @@ var Pe = class extends Error {
           channel: a,
           log: n
         });
-        return c.push(i), o;
+        return d.push(i), o;
       } catch (o) {
         throw l(!0), o;
       }
@@ -422,13 +422,13 @@ var Pe = class extends Error {
     f(this, y);
     // TODO: Used for backward-compatibility. Remove in next major version.
     f(this, _, !1);
-    P(this, "initialize", ({
+    I(this, "initialize", ({
       log: e,
       validateReceivedMessage: t
     }) => {
-      I(this, D, e), I(this, L, t), window.addEventListener("message", s(this, x));
+      P(this, D, e), P(this, L, t), window.addEventListener("message", s(this, x));
     });
-    P(this, "sendMessage", (e, t) => {
+    I(this, "sendMessage", (e, t) => {
       if (j(e)) {
         const r = s(this, k).call(this, e);
         s(this, A).postMessage(e, {
@@ -450,10 +450,10 @@ var Pe = class extends Error {
       }
       if (g(e)) {
         const { port1: r, port2: a } = new MessageChannel();
-        I(this, y, r), r.addEventListener("message", s(this, b)), r.start();
-        const n = [a, ...t || []], c = s(this, k).call(this, e);
+        P(this, y, r), r.addEventListener("message", s(this, b)), r.start();
+        const n = [a, ...t || []], d = s(this, k).call(this, e);
         s(this, A).postMessage(e, {
-          targetOrigin: c,
+          targetOrigin: d,
           transfer: n
         });
         return;
@@ -466,13 +466,13 @@ var Pe = class extends Error {
       }
       throw new U("Port is undefined");
     });
-    P(this, "addMessageHandler", (e) => {
+    I(this, "addMessageHandler", (e) => {
       s(this, S).add(e);
     });
-    P(this, "removeMessageHandler", (e) => {
+    I(this, "removeMessageHandler", (e) => {
       s(this, S).delete(e);
     });
-    P(this, "destroy", () => {
+    I(this, "destroy", () => {
       window.removeEventListener("message", s(this, x)), s(this, H).call(this), s(this, S).clear();
     });
     f(this, V, (e) => s(this, R).some(
@@ -487,7 +487,7 @@ var Pe = class extends Error {
     });
     f(this, H, () => {
       var e, t;
-      (e = s(this, y)) == null || e.removeEventListener("message", s(this, b)), (t = s(this, y)) == null || t.close(), I(this, y, void 0);
+      (e = s(this, y)) == null || e.removeEventListener("message", s(this, b)), (t = s(this, y)) == null || t.close(), P(this, y, void 0);
     });
     f(this, x, ({
       source: e,
@@ -495,11 +495,11 @@ var Pe = class extends Error {
       ports: r,
       data: a
     }) => {
-      var n, c, l;
+      var n, d, l;
       if (e === s(this, A) && (je(a) && ((n = s(this, D)) == null || n.call(
         this,
         "Please upgrade the child window to the latest version of Penpal."
-      ), I(this, _, !0), a = Ve(a)), !!((c = s(this, L)) != null && c.call(this, a)))) {
+      ), P(this, _, !0), a = Ve(a)), !!((d = s(this, L)) != null && d.call(this, a)))) {
         if (!s(this, V).call(this, t)) {
           (l = s(this, D)) == null || l.call(
             this,
@@ -507,10 +507,10 @@ var Pe = class extends Error {
           );
           return;
         }
-        if (j(a) && (s(this, H).call(this), I(this, N, t)), g(a) && // Previous versions of Penpal don't use MessagePorts and do all
+        if (j(a) && (s(this, H).call(this), P(this, N, t)), g(a) && // Previous versions of Penpal don't use MessagePorts and do all
         // communication through the window.
         !s(this, _)) {
-          if (I(this, y, r[0]), !s(this, y))
+          if (P(this, y, r[0]), !s(this, y))
             throw new U("No port received on ACK2");
           s(this, y).addEventListener("message", s(this, b)), s(this, y).start();
         }
@@ -526,14 +526,18 @@ var Pe = class extends Error {
     });
     if (!e)
       throw new w("INVALID_ARGUMENT", "remoteWindow must be defined");
-    I(this, A, e), I(this, R, t != null && t.length ? t : [window.origin]);
+    P(this, A, e), P(this, R, t != null && t.length ? t : [window.origin]);
   }
 }, A = new WeakMap(), R = new WeakMap(), D = new WeakMap(), L = new WeakMap(), N = new WeakMap(), S = new WeakMap(), y = new WeakMap(), _ = new WeakMap(), V = new WeakMap(), k = new WeakMap(), H = new WeakMap(), x = new WeakMap(), b = new WeakMap(), oe), ye = Je;
 const Qe = (e, t) => {
   const r = new ye({
     remoteWindow: e.contentWindow,
     // Defaults to the current origin.
-    allowedOrigins: [/^http:\/\/localhost(:\d+)/, "https://extensions.archilogic.io"]
+    allowedOrigins: [
+      /^http:\/\/localhost(:\d+)/,
+      "https://extensions.archilogic.io",
+      "https://testing-extensions.archilogic.io"
+    ]
     // Alternatively,
     // allowedOrigins: [new Url(iframe.src).origin]
   });
@@ -543,9 +547,13 @@ const Qe = (e, t) => {
     methods: t
   });
 }, Xe = {
-  onPluginConnect: () => {
+  /**
+   * event handler for initial connection of the extension
+   * for a headless extension ( without UI ) the host will await this method before it terminates the extension
+   */
+  onConnect: () => {
   },
-  onPluginDestroy: () => {
+  onDestroy: () => {
   },
   onLayoutChange: () => {
   },
@@ -572,8 +580,8 @@ const Qe = (e, t) => {
   return new Proxy(
     {},
     {
-      get(n, c) {
-        return async (...l) => (await r.promise)[c](...l);
+      get(n, d) {
+        return async (...l) => (await r.promise)[d](...l);
       }
     }
   );

package/dist/index.d.ts

@@ -74,7 +74,7 @@ declare interface BaseData {
     name: string;
     type: string;
     customId: string;
-    customAttributes: Record<string, string | number | boolean>;
+    customAttributes: SpaceGraphCustomAttributeValue;
     /** dimensions in meters */
     dimensions: {
         width: number;
@@ -99,6 +99,34 @@ declare interface BaseData {
     boundingBoxContour: Vector2[];
 }
 
+declare interface BaseFilter {
+    id?: StringComparator;
+    type?: StringComparator;
+    name?: StringComparator;
+    customId?: StringComparator;
+    customAttributes?: Record<string, StringComparator | NumberComparator | BooleanComparator>;
+    dimensions?: {
+        width?: NumberComparator;
+        length?: NumberComparator;
+        height?: NumberComparator;
+    };
+}
+
+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;
+}
+
 declare interface BaseShape {
     type: string;
     style?: ShapeStyle;
@@ -109,6 +137,12 @@ declare interface BezierCurve extends BaseShape {
     points: Polygon;
 }
 
+declare type BooleanComparator = boolean | {
+    eq: boolean;
+} | {
+    neq: boolean;
+};
+
 declare type BoundingBox3d = {
     min: Vector3;
     max: Vector3;
@@ -231,19 +265,20 @@ export declare type Connection<TMethods extends Methods = Methods> = {
 
 /**
  * @example
- * const pluginConnection = createPluginConnection(methods)
- * const pluginApi = await pluginConnection.promise
- * await pluginApi.onPluginConnect({ floorMetaData })
- * pluginConnection.destroy()
+ * const connection = createExtensionConnection(methods)
+ * const extension = await connection.promise
+ * // dispatch onConnect event
+ * await extension.onConnect({ floorMetaData })
+ * connection.destroy()
  */
 export declare const createExtensionConnection: (iframe: HTMLIFrameElement, methods: any) => Connection<ExtensionApi>;
 
 /**
  * @example
  * const hostApi = createHostConnection({
- *   onPluginConnect: () => {}
+ *   onConnect: () => {}
  * })
- * const spaceResponse = await hostApi.getSpaces()
+ * const spaces = await hostApi.getSpaces()
  */
 export declare const createHostConnection: (methods?: Partial<ExtensionApi>) => HostApi;
 
@@ -354,6 +389,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;
@@ -552,7 +592,7 @@ declare class ElementCreate extends OperationBase {
     type: typeof ElementCreateTypeValue;
     value: LayoutElementJson;
     parentId?: string;
-    constructor(value: LayoutElementJson, parentId?: string);
+    constructor(value: Partial<LayoutElementJson>, parentId?: string);
     do(layout: SpaceGraphLayout): void;
     undo(layout: SpaceGraphLayout): void;
 }
@@ -563,11 +603,24 @@ declare const ElementCreateTypeValue: "operation:elementCreate";
 
 export declare interface ElementData extends BaseData {
     type: LayoutElementJson['type'];
+    isExternal: boolean;
     parameters: LayoutElementJson['parameters'];
     product: ProductData;
+    position: Vector3;
+    rotation: number;
     elements: ElementData[];
 }
 
+export declare interface ElementFilter extends BaseFilter {
+    product?: ProductFilter;
+    isExternal?: BooleanComparator;
+}
+
+declare type ElementQuery = {
+    select?: ElementSelect;
+    where?: ElementFilter;
+};
+
 declare class ElementRemove extends OperationBase {
     type: typeof ElementRemoveTypeValue;
     previousValue: LayoutElementJson;
@@ -582,6 +635,13 @@ declare type ElementRemoveOperationJson = Pick<ElementRemove, 'nodeId' | 'type'>
 
 declare const ElementRemoveTypeValue: "operation:elementRemove";
 
+export declare interface ElementSelect extends BaseSelect {
+    product?: ProductSelect | boolean;
+    isExternal?: boolean;
+    position?: boolean;
+    rotation?: boolean;
+}
+
 declare class ElementUpdate extends OperationBase {
     type: typeof ElementUpdateTypeValue;
     value: ElementUpdateValue;
@@ -600,17 +660,15 @@ declare type ElementUpdateValue = Partial<LayoutElementJson> & {
     parameters?: Partial<LayoutElementJson['parameters']>;
 };
 
-declare interface EntityResponse extends HostResponse {
-    data: {
-        id: string;
-    };
-}
+declare type EntityResult = {
+    id: string;
+};
 
 export declare type ExtensionApi = {
-    onPluginConnect({ floorMetaData }: {
+    onConnect({ floorMetaData }: {
         floorMetaData: any;
     }): void;
-    onPluginDestroy(): void;
+    onDestroy(): void;
     onLayoutChange(args: any): void;
     onSelectionChange({ selectedNodes }: {
         selectedNodes: {
@@ -667,7 +725,7 @@ declare type FloorPlanTheme = {
             /** show the area information in room stamps */
             roomStampDisplay?: ('usage' | 'area' | 'customId' | 'name' | 'id' | ['customAttribute', string])[];
             /** text color for room stamps */
-            text?: Rgb;
+            text?: Rgb_2;
             /** whether the room stamp text should have an outline to assist with contrast issues */
             textOutline?: boolean;
         };
@@ -909,189 +967,139 @@ declare type HingeSide = 'left' | 'right';
 export declare type HostApi = {
     /**
      * @example
-     * const { data: element } = await hostApi.getElementsById({ id, include: ['name', 'type', 'dimensions']})
+     * const element = await hostApi.getElementsById({ id, select: { type: true, dimensions: { length: true }}})
      */
-    getElementById: <K extends keyof ElementData>(args: {
+    getElementById: <S extends ElementSelect = DefaultSelect>(args: {
         id: string;
-        include: K[];
-    }) => Promise<{
-        data?: Pick<ElementData, K>;
-        error?: string;
-        ok: boolean;
-    }>;
-    /**
-     * @example
-     * const { data: elements } = await hostApi.getElements({ include: ['id', 'name', 'type']})
-     */
-    getElements: <K extends keyof ElementData>(args: {
-        include: K[];
-    }) => Promise<{
-        data: Pick<ElementData, K>[];
-        error?: string;
-        ok: boolean;
-    }>;
+        select?: S;
+    }) => Promise<QueryPick<ElementData, S> | null>;
     /**
      * @example
-     * const { data: elementsByType } = await hostApi.getElementsByType({ type, include: ['id', 'name', 'dimensions']})
+     * const elements = await hostApi.getElements({ where: { customAttributes: { broken: true }}})
      */
-    getElementsByType: <K extends keyof ElementData>(args: {
-        type: LayoutElementJson['type'];
-        include: K[];
-    }) => Promise<{
-        data: Pick<ElementData, K>[];
-        error?: string;
-        ok: boolean;
-    }>;
-    getSpaceById: <K extends keyof SpaceData>(args: {
+    getElements: <S extends ElementSelect = DefaultSelect>(args?: {
+        select?: S;
+        where?: ElementFilter;
+    }) => Promise<QueryPick<ElementData, S>[]>;
+    getSpaceById: <S extends SpaceSelect = DefaultSelect>(args: {
         id: string;
-        include: K[];
-    }) => Promise<{
-        data?: Pick<SpaceData, K>;
-        error?: string;
-        ok: boolean;
-    }>;
-    getSpaces: <K extends keyof SpaceData>(args: {
-        include: K[];
-    }) => Promise<{
-        data: Pick<SpaceData, K>[];
-        error?: string;
-        ok: boolean;
-    }>;
-    getSpaceGraphJson: () => Promise<{
-        data: SpaceGraphJson;
-        error?: string;
-    }>;
+        select?: S;
+    }) => Promise<QueryPick<SpaceData, S> | null>;
+    getSpaces: <S extends SpaceSelect = DefaultSelect>(args?: {
+        select?: S;
+        where?: SpaceFilter;
+    }) => Promise<QueryPick<SpaceData, S>[]>;
+    getProductById: <S extends ProductSelect = DefaultSelect>(args: {
+        id: string;
+        select?: S;
+    }) => Promise<QueryPick<ProductData, S> | null>;
+    getProducts: <S extends ProductSelect = DefaultSelect>(args?: {
+        select?: S;
+        where?: ProductFilter;
+    }) => Promise<QueryPick<ProductData, S>[]>;
     runOperations: (args: {
         operations: OperationJson[];
-    }) => Promise<HostResponse>;
+    }) => Promise<OperationsResult>;
     setPlanConfig: (config: {
         theme: FloorPlanTheme;
-    }) => Promise<HostResponse>;
+    }) => Promise<boolean>;
     addPlanLayer: (args: {
         id?: string;
         baseLayer?: string;
-    }) => Promise<EntityResponse>;
+    }) => Promise<EntityResult>;
     addPlanGraphic: (args: {
         shapes: Shape[];
         isHandler?: boolean;
         layerId?: string;
         id?: string;
         clearLayer?: boolean;
-    }) => Promise<EntityResponse>;
+    }) => Promise<EntityResult>;
     zoomToNode: (args: {
         nodeId: string;
         margin?: number;
         animate?: number | boolean;
-    }) => Promise<HostResponse>;
+    }) => Promise<boolean>;
     zoomExtents: (args?: {
         margin?: number;
         animate?: number | boolean;
-    }) => Promise<HostResponse>;
+    }) => Promise<boolean>;
     drawNodeUpdate: (args: {
         nodeId: string;
         style: 'selected' | ShapeStyle | false;
-    }) => Promise<HostResponse>;
+    }) => Promise<boolean>;
     selectNodes: (args: {
         nodeIds: string[];
-    }) => Promise<SelectionResponse>;
+    }) => Promise<NodeResult[]>;
 };
 
 export declare type HostApiSync = {
     /**
      * @example
-     * const { data: element } = await hostApi.getElementsById({ id, include: ['name', 'type', 'dimensions']})
+     * const element = await hostApi.getElementsById({ id, select: { type: true, dimensions: { length: true }}})
      */
-    getElementById: <K extends keyof ElementData>(args: {
+    getElementById: <S extends ElementSelect = DefaultSelect>(args: {
         id: string;
-        include: K[];
-    }) => {
-        data?: Pick<ElementData, K>;
-        error?: string;
-        ok: boolean;
-    };
+        select?: S;
+    }) => QueryPick<ElementData, S> | null;
     /**
      * @example
-     * const { data: elements } = await hostApi.getElements({ include: ['id', 'name', 'type']})
+     * const elements = await hostApi.getElements({ where: { customAttributes: { broken: true }}})
      */
-    getElements: <K extends keyof ElementData>(args: {
-        include: K[];
-    }) => {
-        data: Pick<ElementData, K>[];
-        error?: string;
-        ok: boolean;
-    };
-    /**
-     * @example
-     * const { data: elementsByType } = await hostApi.getElementsByType({ type, include: ['id', 'name', 'dimensions']})
-     */
-    getElementsByType: <K extends keyof ElementData>(args: {
-        type: LayoutElementJson['type'];
-        include: K[];
-    }) => {
-        data: Pick<ElementData, K>[];
-        error?: string;
-        ok: boolean;
-    };
-    getSpaceById: <K extends keyof SpaceData>(args: {
+    getElements: <S extends ElementSelect = DefaultSelect>(args?: {
+        select?: S;
+        where?: ElementFilter;
+    }) => QueryPick<ElementData, S>[];
+    getSpaceById: <S extends SpaceSelect = DefaultSelect>(args: {
         id: string;
-        include: K[];
-    }) => {
-        data?: Pick<SpaceData, K>;
-        error?: string;
-        ok: boolean;
-    };
-    getSpaces: <K extends keyof SpaceData>(args: {
-        include: K[];
-    }) => {
-        data: Pick<SpaceData, K>[];
-        error?: string;
-        ok: boolean;
-    };
-    getSpaceGraphJson: () => {
-        data: SpaceGraphJson;
-        error?: 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[];
-    }) => HostResponse;
+    }) => OperationsResult;
     setPlanConfig: (config: {
         theme: FloorPlanTheme;
-    }) => HostResponse;
+    }) => boolean;
     addPlanLayer: (args: {
         id?: string;
         baseLayer?: string;
-    }) => EntityResponse;
+    }) => EntityResult;
     addPlanGraphic: (args: {
         shapes: Shape[];
         isHandler?: boolean;
         layerId?: string;
         id?: string;
         clearLayer?: boolean;
-    }) => EntityResponse;
+    }) => EntityResult;
     zoomToNode: (args: {
         nodeId: string;
         margin?: number;
         animate?: number | boolean;
-    }) => HostResponse;
+    }) => boolean;
     zoomExtents: (args?: {
         margin?: number;
         animate?: number | boolean;
-    }) => HostResponse;
+    }) => boolean;
     drawNodeUpdate: (args: {
         nodeId: string;
         style: 'selected' | ShapeStyle | false;
-    }) => HostResponse;
+    }) => boolean;
     selectNodes: (args: {
         nodeIds: string[];
-    }) => SelectionResponse;
+    }) => NodeResult[];
 };
 
-export declare interface HostResponse {
-    ok: boolean;
-    data?: unknown;
-    error?: string;
-}
-
 declare type IndexRange = {
     type: 'index:range';
     start: number;
@@ -2281,17 +2289,33 @@ declare type Methods = {
     [index: string]: Methods | Function;
 };
 
+declare type NodeResult = {
+    id: string;
+    type: string;
+};
+
 declare type NodesByType<NodeMap extends NodeTypeMap = {}> = {
     -readonly [K in keyof NodeMap]: InstanceType<NodeMap[K]>[];
 };
 
-declare type NodeSelection = {
-    id: string;
-    type: string;
-}[];
-
 declare type NodeTypeMap = Record<string, any>;
 
+declare type NumberComparator = number | {
+    eq: number;
+} | {
+    neq: number;
+} | {
+    in: number[];
+} | {
+    gt: number;
+} | {
+    gte: number;
+} | {
+    lt: number;
+} | {
+    lte: number;
+};
+
 declare interface NumberList extends SpaceGraphTypedValueJson {
     type: 'number:list';
     list: number[];
@@ -2328,6 +2352,13 @@ declare class OperationBase {
  */
 declare type OperationJson = VertexCreateOperationJson | EdgeCreateOperationJson | SpaceCreateOperationJson | ElementCreateOperationJson | AnnotationCreateOperationJson | ViewCreateOperationJson | ProductCreateOperationJson | RelationCreateOperationJson | MaterialCreateOperationJson | CustomAttributeCreateOperationJson | VertexRemoveOperationJson | VertexUpdateOperationJson | VertexReplaceOperationJson | EdgeConnectOperationJson | EdgeRemoveOperationJson | EdgeReplaceOperationJson | EdgeMergeOperationJson | EdgeSplitOperationJson | EdgeUpdateOperationJson | SpaceUpdateOperationJson | SpaceRemoveOperationJson | ElementUpdateOperationJson | ElementRemoveOperationJson | AnnotationUpdateOperationJson | AnnotationRemoveOperationJson | ViewUpdateOperationJson | ViewRemoveOperationJson | ProductUpdateOperationJson | ProductRemoveOperationJson | RelationUpdateOperationJson | RelationRemoveOperationJson | RelationInsertNodesOperationJson | RelationRemoveNodesOperationJson | MaterialUpdateOperationJson | MaterialRemoveOperationJson | LayoutUpdateOperationJson | CustomAttributeUpdateOperationJson | CustomAttributeRemoveOperationJson;
 
+declare type OperationsResult = {
+    created: NodeResult[];
+    removed: NodeResult[];
+    updated: NodeResult[];
+    errors: string[];
+};
+
 declare type OrthogonalStairsParameters = {
     stairsType: OrthogonalStairsType;
     /** @minimum 0.01 */
@@ -2455,10 +2486,13 @@ declare type ProductCreateValue = SpaceGraphProductJson;
 
 export declare interface ProductData extends BaseData {
     type: SpaceGraphProduct['type'];
-    attributes: {
-        category: string;
-        subCategory: string;
-    };
+    category: string;
+    subCategory: string;
+}
+
+declare interface ProductFilter extends BaseFilter {
+    category?: StringComparator;
+    subCategory?: StringComparator;
 }
 
 declare class ProductRemove extends OperationBase {
@@ -2476,6 +2510,11 @@ declare const ProductRemoveTypeValue: "operation:productRemove";
 
 declare type ProductRemoveValue = SpaceGraphProductJson;
 
+declare interface ProductSelect extends BaseSelect {
+    category?: boolean;
+    subCategory?: boolean;
+}
+
 declare class ProductUpdate extends OperationBase {
     type: typeof ProductUpdateTypeValue;
     value: ProductUpdateValue;
@@ -2491,6 +2530,10 @@ declare const ProductUpdateTypeValue: "operation:productUpdate";
 
 declare type ProductUpdateValue = Partial<SpaceGraphProductJson>;
 
+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;
+};
+
 declare interface RectangleCurve extends CurveBase {
     type: RectangleCurveType;
     dimensions: Vector2;
@@ -2600,16 +2643,12 @@ declare class Reply<T = unknown> {
 
 declare type Rgb = [number, number, number];
 
+declare type Rgb_2 = [number, number, number];
+
 declare type RgbA = [number, number, number, number];
 
 declare type RotationEntry = number | NumberList | NumberRange;
 
-declare interface SelectionResponse extends HostResponse {
-    data: {
-        selectedNodes: NodeSelection;
-    };
-}
-
 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 {
@@ -2638,16 +2677,22 @@ declare type SpaceCreateValue = LayoutSpaceJson;
 
 export declare interface SpaceData extends BaseData {
     type: LayoutSpaceJson['type'];
-    attributes: {
-        category: string;
-        subCategory: string;
-    };
+    isExternal: boolean;
+    category: string;
+    subCategory: string;
     area: number;
     labelPoint: Vector2;
     polygons: PolygonWithHoles;
     elements: ElementData[];
 }
 
+export declare interface SpaceFilter extends BaseFilter {
+    category?: StringComparator;
+    subCategory?: StringComparator;
+    isExternal?: BooleanComparator;
+    area?: NumberComparator;
+}
+
 declare class SpaceGraph {
     spatialStructure: SpaceGraphSpatialStructure;
     products: SpaceGraphProduct[];
@@ -3142,6 +3187,7 @@ declare class SpaceGraphProductBase extends SpaceGraphNodeWithCustomAttributesBa
     constructor(id: string, type: SpaceGraphProductType);
     copyForClone(product: SpaceGraphProductStatic | SpaceGraphProductComponent): void;
     setAttributes(attributesJson: SpaceGraphProductAttributesJson): void;
+    getBoundingBox(): BoundingBox3d;
     toJSON(): SpaceGraphProductJson;
 }
 
@@ -3271,6 +3317,16 @@ declare const SpaceRemoveTypeValue: "operation:spaceRemove";
 
 declare type SpaceRemoveValue = LayoutSpaceJson;
 
+export declare interface SpaceSelect extends BaseSelect {
+    category?: boolean;
+    subCategory?: boolean;
+    isExternal?: boolean;
+    area?: boolean;
+    labelPoint?: boolean;
+    polygons?: boolean;
+    elements?: ElementQuery;
+}
+
 declare interface SpaceShapeStyle extends ShapeStyle {
     usage?: {
         [key: string]: ShapeStyle;
@@ -3414,6 +3470,14 @@ declare type StraightStairsParametersJson = Partial<StraightStairsParameters>;
 
 declare type StraightStairsType = 'straight' | 'straightLanding';
 
+declare type StringComparator = string | {
+    eq: string;
+} | {
+    neq: string;
+} | {
+    in: string[];
+};
+
 declare interface SurfaceMaterials {
     [surface: string]: SpaceGraphMaterial;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@archilogic/extension-sdk",
   "description": "",
-  "version": "0.2.5",
+  "version": "0.4.0",
   "publishConfig": {
     "access": "public"
   },
@@ -32,7 +32,7 @@
     "penpal": "^7.0.4"
   },
   "devDependencies": {
-    "@archilogic/space-graph-core": "^0.22.6"
+    "@archilogic/space-graph-core": "^0.23.0"
   },
   "nx": {}
 }