@farcaster/frame-host 0.0.7 → 0.0.9

package/src/comlink/protocol.ts

@@ -0,0 +1,111 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export interface EventSource {
+  addEventListener(
+    type: string,
+    listener: EventListenerOrEventListenerObject,
+    options?: {}
+  ): void;
+
+  removeEventListener(
+    type: string,
+    listener: EventListenerOrEventListenerObject,
+    options?: {}
+  ): void;
+}
+
+export interface PostMessageWithOrigin {
+  postMessage(
+    message: any,
+    targetOrigin: string,
+    transfer?: Transferable[]
+  ): void;
+}
+
+export interface Endpoint extends EventSource {
+  postMessage(message: any, transfer?: Transferable[]): void;
+
+  start?: () => void;
+}
+
+export const enum WireValueType {
+  RAW = "RAW",
+  PROXY = "PROXY",
+  THROW = "THROW",
+  HANDLER = "HANDLER",
+}
+
+export interface RawWireValue {
+  id?: string;
+  type: WireValueType.RAW;
+  value: {};
+}
+
+export interface HandlerWireValue {
+  id?: string;
+  type: WireValueType.HANDLER;
+  name: string;
+  value: unknown;
+}
+
+export type WireValue = RawWireValue | HandlerWireValue;
+
+export type MessageID = string;
+
+export const enum MessageType {
+  GET = "GET",
+  SET = "SET",
+  APPLY = "APPLY",
+  CONSTRUCT = "CONSTRUCT",
+  ENDPOINT = "ENDPOINT",
+  RELEASE = "RELEASE",
+}
+
+export interface GetMessage {
+  id?: MessageID;
+  type: MessageType.GET;
+  path: string[];
+}
+
+export interface SetMessage {
+  id?: MessageID;
+  type: MessageType.SET;
+  path: string[];
+  value: WireValue;
+}
+
+export interface ApplyMessage {
+  id?: MessageID;
+  type: MessageType.APPLY;
+  path: string[];
+  argumentList: WireValue[];
+}
+
+export interface ConstructMessage {
+  id?: MessageID;
+  type: MessageType.CONSTRUCT;
+  path: string[];
+  argumentList: WireValue[];
+}
+
+export interface EndpointMessage {
+  id?: MessageID;
+  type: MessageType.ENDPOINT;
+}
+
+export interface ReleaseMessage {
+  id?: MessageID;
+  type: MessageType.RELEASE;
+}
+
+export type Message =
+  | GetMessage
+  | SetMessage
+  | ApplyMessage
+  | ConstructMessage
+  | EndpointMessage
+  | ReleaseMessage;

package/src/helpers/endpoint.ts

@@ -1,4 +1,4 @@
-import * as Comlink from "comlink";
+import * as Comlink from "../comlink";
 import { FrameHost } from "@farcaster/frame-core";
 import { Provider } from "ox";
 import { forwardProviderEvents, wrapProviderRequest } from "./provider";
@@ -7,22 +7,29 @@ import { HostEndpoint } from "../types";
 /**
   * @returns function to cleanup provider listeners
   */
-export function exposeToEndpoint(
+export function exposeToEndpoint({ 
+  endpoint,
+  sdk, 
+  frameOrigin,
+  ethProvider, 
+}: {
   endpoint: HostEndpoint,
   sdk: Omit<FrameHost, 'ethProviderRequestV2'>,
-  provider?: Provider.Provider,
-) {
+  frameOrigin: string;
+  ethProvider?: Provider.Provider,
+}) {
   const extendedSdk = sdk as FrameHost;
 
   let cleanup: () => void | undefined;
-  if (provider) {
-    extendedSdk.ethProviderRequestV2 = wrapProviderRequest(provider);
-    cleanup = forwardProviderEvents(provider, endpoint);
+  if (ethProvider) {
+    extendedSdk.ethProviderRequestV2 = wrapProviderRequest(ethProvider);
+    cleanup = forwardProviderEvents(ethProvider, endpoint);
   }
 
-  Comlink.expose(extendedSdk, endpoint);
+  const unexpose = Comlink.expose(extendedSdk, endpoint, [frameOrigin]);
 
   return () => {
     cleanup?.();
+    unexpose();
   }
 }

package/src/iframe.ts

@@ -1,4 +1,4 @@
-import * as Comlink from "comlink";
+import * as Comlink from "./comlink";
 import type { Provider } from "ox";
 import { FrameHost } from "@farcaster/frame-core";
 import { HostEndpoint } from "./types";
@@ -7,10 +7,15 @@ import { exposeToEndpoint } from "./helpers/endpoint";
 /**
  * An endpoint of communicating with an iFrame
  */
-export function createIframeEndpoint(
-  iframe: HTMLIFrameElement,
+export function createIframeEndpoint({
+  iframe,
+  targetOrigin,
   debug = true
-): HostEndpoint {
+}: {
+  iframe: HTMLIFrameElement;
+  targetOrigin: string;
+  debug?: boolean;
+}): HostEndpoint {
   return {
     // when is contentWindow null
     ...Comlink.windowEndpoint(iframe.contentWindow!),
@@ -24,7 +29,7 @@ export function createIframeEndpoint(
         event
       };
 
-      iframe.contentWindow?.postMessage(wireEvent, '*');
+      iframe.contentWindow?.postMessage(wireEvent, targetOrigin);
     },
     emitEthProvider: (event, params) => {
       if (debug) {
@@ -37,18 +42,29 @@ export function createIframeEndpoint(
         params 
       };
 
-      iframe.contentWindow?.postMessage(wireEvent, '*')
+      iframe.contentWindow?.postMessage(wireEvent, targetOrigin)
     },
   };
 }
 
-export function exposeToIframe(
-  iframe: HTMLIFrameElement,
-  sdk: Omit<FrameHost, 'ethProviderRequestV2'>,
-  provider?: Provider.Provider,
-) {
-  const endpoint = createIframeEndpoint(iframe);
-  const cleanup = exposeToEndpoint(endpoint, sdk, provider);
+export function exposeToIframe({
+  iframe,
+  sdk,
+  ethProvider,
+  frameOrigin, 
+}: {
+  iframe: HTMLIFrameElement;
+  sdk: Omit<FrameHost, 'ethProviderRequestV2'>;
+  frameOrigin: string;
+  ethProvider?: Provider.Provider;
+}) {
+  const endpoint = createIframeEndpoint({ iframe, targetOrigin: frameOrigin });
+  const cleanup = exposeToEndpoint({
+    endpoint, 
+    sdk, 
+    ethProvider,
+    frameOrigin
+  });
 
   return {
     endpoint,

package/src/types.ts

@@ -1,7 +1,7 @@
-import type * as Comlink from "comlink";
+import type { Endpoint } from "./comlink";
 import type { EmitEthProvider } from "@farcaster/frame-core";
 
-export type HostEndpoint = Comlink.Endpoint & {
+export type HostEndpoint = Endpoint & {
   emit: (data: any) => void;
   emitEthProvider: EmitEthProvider;
 };