@archilogic/extension-sdk 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @archilogic/extension-sdk
 
+## 0.4.0
+
+### Minor Changes
+
+- 8532ccf: feat: rename onPluginConnect / Destroy to onConnect / Destroy
+
 ## 0.3.0
 
 ### Minor 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,15 +26,15 @@ 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, ce = (e) => typeof e == "function", Re = (e) => W(e) && e.namespace === M, j = (e) => e.type === "SYN", X = (e) => e.type === "ACK1", z = (e) => e.type === "ACK2", de = (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];
@@ -55,7 +55,7 @@ var Pe = class extends Error {
   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 d = async (l) => {
@@ -96,8 +96,8 @@ var Pe = class extends Error {
   () => 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
@@ -138,9 +138,9 @@ var Pe = class extends Error {
     remoteProxy: pe((h, o) => {
       if (a)
         throw te(h);
-      const i = he(), E = o[o.length - 1], u = E instanceof be, { timeout: p, transferables: g } = u ? E : {}, F = u ? o.slice(0, -1) : o;
+      const i = he(), E = o[o.length - 1], u = E instanceof be, { timeout: p, transferables: K } = u ? E : {}, F = u ? o.slice(0, -1) : o;
       return new Promise((Y, O) => {
-        const K = p !== void 0 ? window.setTimeout(() => {
+        const z = p !== void 0 ? window.setTimeout(() => {
           n.delete(i), O(
             new w(
               "METHOD_CALL_TIMEOUT",
@@ -150,7 +150,7 @@ var Pe = class extends Error {
             )
           );
         }, p) : void 0;
-        n.set(i, { methodPath: h, resolve: Y, reject: O, timeoutId: K });
+        n.set(i, { methodPath: h, resolve: Y, reject: O, timeoutId: z });
         try {
           const T = {
             namespace: M,
@@ -160,7 +160,7 @@ var Pe = class extends Error {
             methodPath: h,
             args: F
           };
-          r == null || r(`Sending ${C(h)}() call`, T), e.sendMessage(T, g);
+          r == null || r(`Sending ${C(h)}() call`, T), e.sendMessage(T, K);
         } catch (T) {
           O(
             new w("TRANSMISSION_FAILED", T.message)
@@ -271,7 +271,7 @@ var Pe = class extends Error {
       returnValue: e.value
     };
   throw fe(e);
-}, ge = ({
+}, Ke = ({
   messenger: e,
   methods: t,
   timeout: r,
@@ -289,7 +289,7 @@ var Pe = class extends Error {
         `Connection timed out after ${r}ms`
       )
     );
-  }, r) : void 0, g = () => {
+  }, r) : void 0, K = () => {
     for (const c of v)
       c();
   }, F = () => {
@@ -299,7 +299,7 @@ var Pe = class extends Error {
     const { remoteProxy: c, destroy: m } = xe(e, a, n);
     v.push(m), clearTimeout(p), h = !0, E({
       remoteProxy: c,
-      destroy: g
+      destroy: K
     });
   }, Y = () => {
     const c = {
@@ -332,7 +332,7 @@ var Pe = class extends Error {
       u(new w("TRANSMISSION_FAILED", Me.message));
       return;
     }
-  }, K = (c) => {
+  }, z = (c) => {
     n == null || n("Received handshake ACK1", c);
     const m = {
       namespace: M,
@@ -350,13 +350,13 @@ var Pe = class extends Error {
   }, T = (c) => {
     n == null || n("Received handshake ACK2", c), F();
   }, q = (c) => {
-    j(c) && O(c), X(c) && K(c), z(c) && T(c);
+    j(c) && O(c), X(c) && z(c), g(c) && T(c);
   };
   return e.addMessageHandler(q), v.push(() => e.removeMessageHandler(q)), Y(), i;
-}, Ke = ge, ze = (e) => {
+}, ze = Ke, ge = (e) => {
   let t = !1, r;
   return (...a) => (t || (t = !0, r = e(...a)), r);
-}, Ge = ze, ne = /* @__PURE__ */ new WeakSet(), Be = ({
+}, Ge = ge, ne = /* @__PURE__ */ new WeakSet(), Be = ({
   messenger: e,
   methods: t = {},
   timeout: r,
@@ -393,7 +393,7 @@ var Pe = class extends Error {
         e.initialize({ log: n, validateReceivedMessage: v }), e.addMessageHandler((E) => {
           Ne(E) && l(!1);
         });
-        const { remoteProxy: o, destroy: i } = await Ke({
+        const { remoteProxy: o, destroy: i } = await ze({
           messenger: e,
           methods: t,
           timeout: r,
@@ -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, {
@@ -448,9 +448,9 @@ var Pe = class extends Error {
         });
         return;
       }
-      if (z(e)) {
+      if (g(e)) {
         const { port1: r, port2: a } = new MessageChannel();
-        I(this, y, r), r.addEventListener("message", s(this, b)), r.start();
+        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: d,
@@ -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,
@@ -499,7 +499,7 @@ var Pe = class extends Error {
       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)), !!((d = s(this, L)) != null && d.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)), z(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,7 +526,7 @@ 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) => {
@@ -547,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: () => {
   },

package/dist/index.d.ts

@@ -265,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;
 
@@ -664,10 +665,10 @@ declare type EntityResult = {
 };
 
 export declare type ExtensionApi = {
-    onPluginConnect({ floorMetaData }: {
+    onConnect({ floorMetaData }: {
         floorMetaData: any;
     }): void;
-    onPluginDestroy(): void;
+    onDestroy(): void;
     onLayoutChange(args: any): void;
     onSelectionChange({ selectedNodes }: {
         selectedNodes: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@archilogic/extension-sdk",
   "description": "",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "publishConfig": {
     "access": "public"
   },