protocol.ts

/**
 * @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 V430WireValueType {
  RAW,
  HANDLER = 3,
}

export const enum WireValueType {
  RAW = "RAW",
  PROXY = "PROXY",
  THROW = "THROW",
  HANDLER = "HANDLER",
}

export interface RawWireValue {
  id?: string;
  type: WireValueType.RAW | V430WireValueType.RAW;
  value: {};
}

export interface HandlerWireValue {
  id?: string;
  type: WireValueType.HANDLER | V430WireValueType.HANDLER;
  name: string;
  value: unknown;
}

export type WireValue = RawWireValue | HandlerWireValue;

export type MessageID = string;

export const enum V430MessageType {
  GET,
  SET,
  APPLY,
  CONSTRUCT,
  ENDPOINT,
  RELEASE,
}

export interface MessageTypeMap {
  [MessageType.GET]: V430MessageType.GET;
  [MessageType.SET]: V430MessageType.SET;
  [MessageType.APPLY]: V430MessageType.APPLY;
  [MessageType.CONSTRUCT]: V430MessageType.CONSTRUCT;
  [MessageType.ENDPOINT]: V430MessageType.ENDPOINT;
  [MessageType.RELEASE]: V430MessageType.RELEASE;
}

export const enum MessageType {
  GET = "GET",
  SET = "SET",
  APPLY = "APPLY",
  CONSTRUCT = "CONSTRUCT",
  ENDPOINT = "ENDPOINT",
  RELEASE = "RELEASE",
}

interface BaseMessage {
  id?: MessageID;
}

export interface GetMessage extends BaseMessage {
  type: MessageType.GET | V430MessageType.GET;
  path: string[];
}

export interface SetMessage extends BaseMessage {
  type: MessageType.SET | V430MessageType.SET;
  path: string[];
  value: WireValue;
}

export interface ApplyMessage extends BaseMessage {
  type: MessageType.APPLY | V430MessageType.APPLY;
  path: string[];
  argumentList: WireValue[];
}

export interface ConstructMessage extends BaseMessage {
  type: MessageType.CONSTRUCT | V430MessageType.CONSTRUCT;
  path: string[];
  argumentList: WireValue[];
}

export interface EndpointMessage extends BaseMessage {
  type: MessageType.ENDPOINT | V430MessageType.ENDPOINT;
}

export interface ReleaseMessage extends BaseMessage {
  type: MessageType.RELEASE | V430MessageType.RELEASE;
}

export type Message =
  | GetMessage
  | SetMessage
  | ApplyMessage
  | ConstructMessage
  | EndpointMessage
  | ReleaseMessage;