@adobe/uix-core 0.7.0 → 0.7.1-nightly.20230114

package/src/tunnel/tunnel.ts

@@ -1,11 +1,6 @@
 import EventEmitter from "eventemitter3";
-import { isIframe, isTunnelSource } from "../value-assertions";
-import {
-  isHandshakeAccepting,
-  isHandshakeOffer,
-  makeAccepted,
-  makeOffered,
-} from "./tunnel-message";
+import { isIframe } from "../value-assertions";
+import { TunnelMessenger } from "./tunnel-messenger";
 import { unwrap } from "../message-wrapper";
 
 /**
@@ -46,6 +41,10 @@ export interface TunnelConfig {
    * @defaultValue 4000
    */
   timeout: number;
+  /**
+   * Logger instance to use for debugging tunnel connection.
+   */
+  logger: Console;
 
   // #endregion Properties
 }
@@ -120,17 +119,23 @@ export class Tunnel extends EventEmitter {
         )}`
       );
     }
+
     const source = target.contentWindow;
     const config = Tunnel._normalizeConfig(options);
     const tunnel = new Tunnel(config);
+    const messenger = new TunnelMessenger({
+      myOrigin: window.location.origin,
+      targetOrigin: options.targetOrigin,
+      logger: options.logger || console,
+    });
     let frameStatusCheck: number;
     let timeout: number;
     const offerListener = (event: MessageEvent) => {
       if (
         isFromOrigin(event, source, config.targetOrigin) &&
-        isHandshakeOffer(event.data)
+        messenger.isHandshakeOffer(event.data)
       ) {
-        const accepted = makeAccepted(unwrap(event.data).offers);
+        const accepted = messenger.makeAccepted(unwrap(event.data).offers);
         const channel = new MessageChannel();
         source.postMessage(accepted, config.targetOrigin, [channel.port1]);
         tunnel.connect(channel.port2);
@@ -187,11 +192,16 @@ export class Tunnel extends EventEmitter {
     const key = makeKey();
     const config = Tunnel._normalizeConfig(opts);
     const tunnel = new Tunnel(config);
+    const messenger = new TunnelMessenger({
+      myOrigin: window.location.origin,
+      targetOrigin: config.targetOrigin,
+      logger: config.logger,
+    });
     const acceptListener = (event: MessageEvent) => {
       if (
         !timedOut &&
         isFromOrigin(event, source, config.targetOrigin) &&
-        isHandshakeAccepting(event.data, key)
+        messenger.isHandshakeAccepting(event.data, key)
       ) {
         cleanup();
         if (!event.ports || !event.ports.length) {
@@ -225,7 +235,7 @@ export class Tunnel extends EventEmitter {
     tunnel.on("connected", cleanup);
 
     const sendOffer = () =>
-      source.postMessage(makeOffered(key), config.targetOrigin);
+      source.postMessage(messenger.makeOffered(key), config.targetOrigin);
     retrying = window.setInterval(sendOffer, RETRY_MS);
     sendOffer();
 
@@ -279,6 +289,7 @@ export class Tunnel extends EventEmitter {
     let errorMessage = "";
     const config: Partial<TunnelConfig> = {
       timeout: 4000,
+      logger: console,
       ...options,
     };
 

package/src/value-assertions.ts

@@ -46,3 +46,13 @@ export function isIframe(value: unknown): value is HTMLIFrameElement {
   const { nodeName } = value as HTMLIFrameElement;
   return typeof nodeName === "string" && nodeName.toLowerCase() === "iframe";
 }
+
+export function isObjectWithPrototype<T>(
+  value: unknown
+): value is T & { [key: string | symbol]: unknown } {
+  if (!value || typeof value !== "object") {
+    return false;
+  }
+  const proto = Reflect.getPrototypeOf(value);
+  return proto !== Object.prototype;
+}

package/dist/tunnel/tunnel-message.d.ts

@@ -1,19 +0,0 @@
-import { WrappedMessage } from "../message-wrapper";
-import { HandshakeAcceptedTicket, HandshakeOfferedTicket } from "../tickets";
-declare type HandshakeAccepted = WrappedMessage<HandshakeAcceptedTicket>;
-declare type HandshakeOffered = WrappedMessage<HandshakeOfferedTicket>;
-declare type HandshakeMessage = HandshakeAccepted | HandshakeOffered;
-export declare function resetWarnings(): void;
-export declare function makeAccepted(id: string): HandshakeAccepted;
-export declare function makeOffered(id: string): HandshakeOffered;
-export declare function isHandshakeAccepting(message: unknown, id: string): message is HandshakeAccepted;
-export declare function isHandshakeOffer(message: unknown): message is HandshakeOffered;
-export declare function isHandshake(message: unknown): message is HandshakeMessage;
-declare const _default: {
-    makeOffered: typeof makeOffered;
-    makeAccepted: typeof makeAccepted;
-    isHandshake: typeof isHandshake;
-    resetWarnings: typeof resetWarnings;
-};
-export default _default;
-//# sourceMappingURL=tunnel-message.d.ts.map

package/dist/tunnel/tunnel-message.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tunnel-message.d.ts","sourceRoot":"","sources":["../../src/tunnel/tunnel-message.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAA2B,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAG7E,aAAK,iBAAiB,GAAG,cAAc,CAAC,uBAAuB,CAAC,CAAC;AACjE,aAAK,gBAAgB,GAAG,cAAc,CAAC,sBAAsB,CAAC,CAAC;AAC/D,aAAK,gBAAgB,GAAG,iBAAiB,GAAG,gBAAgB,CAAC;AAI7D,wBAAgB,aAAa,SAE5B;AAED,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB,CAK1D;AACD,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,gBAAgB,CAKxD;AACD,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,OAAO,EAChB,EAAE,EAAE,MAAM,GACT,OAAO,IAAI,iBAAiB,CAI9B;AACD,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,OAAO,GACf,OAAO,IAAI,gBAAgB,CAK7B;AACD,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,gBAAgB,CAuBzE;;;;;;;AAED,wBAKE"}

package/src/tunnel/tunnel-message.ts

@@ -1,75 +0,0 @@
-import { NS_ROOT, VERSION } from "../constants";
-import { isPlainObject } from "../value-assertions";
-import { WrappedMessage, isWrapped, wrap, unwrap } from "../message-wrapper";
-import { HandshakeAcceptedTicket, HandshakeOfferedTicket } from "../tickets";
-
-type Handshake = HandshakeAcceptedTicket | HandshakeOfferedTicket;
-type HandshakeAccepted = WrappedMessage<HandshakeAcceptedTicket>;
-type HandshakeOffered = WrappedMessage<HandshakeOfferedTicket>;
-type HandshakeMessage = HandshakeAccepted | HandshakeOffered;
-
-const VERSION_WARNINGS = new Set();
-
-export function resetWarnings() {
-  VERSION_WARNINGS.clear();
-}
-
-export function makeAccepted(id: string): HandshakeAccepted {
-  return wrap({
-    accepts: id,
-    version: VERSION,
-  });
-}
-export function makeOffered(id: string): HandshakeOffered {
-  return wrap({
-    offers: id,
-    version: VERSION,
-  });
-}
-export function isHandshakeAccepting(
-  message: unknown,
-  id: string
-): message is HandshakeAccepted {
-  return (
-    isHandshake(message) && unwrap(message as HandshakeAccepted).accepts === id
-  );
-}
-export function isHandshakeOffer(
-  message: unknown
-): message is HandshakeOffered {
-  return (
-    isHandshake(message) &&
-    typeof unwrap(message as HandshakeOffered).offers === "string"
-  );
-}
-export function isHandshake(message: unknown): message is HandshakeMessage {
-  if (!isWrapped(message)) {
-    return false;
-  }
-  const tunnelData: Handshake = unwrap<Handshake>(message as HandshakeMessage);
-  if (
-    !isPlainObject(tunnelData) ||
-    typeof tunnelData.version !== "string" ||
-    !(Reflect.has(tunnelData, "accepts") || Reflect.has(tunnelData, "offers"))
-  ) {
-    console.error(
-      `malformed tunnel message, message.${NS_ROOT} must be an object with a "version" string and an either an "accepts" or "offers" property containing an ID string.`
-    );
-    return false;
-  }
-  const { version } = tunnelData;
-  if (version !== VERSION && !VERSION_WARNINGS.has(version)) {
-    VERSION_WARNINGS.add(version);
-    console.warn(
-      `Version mismatch: current Tunnel is ${VERSION} and remote Tunnel is ${version}. May cause problems.`
-    );
-  }
-  return true;
-}
-
-export default {
-  makeOffered,
-  makeAccepted,
-  isHandshake,
-  resetWarnings,
-};