Add communication with Webnative about odd-devtools HOT 1 CLOSED

The message protocol has changed to send Webnative state on connect and disconnect messages. In addition, data messages have been have been broken into filesystem and session messages.

Messages

Messages are sent from Webnative to the extension as window post messages. When the extension initially connects, it configures Webnative with an extension ID which is used to tag all messages sent to the extension. The tag lets the extension filter window post messages to only receive messages intended for it.

State

Each message includes some information about the state of Webnative:

type State = {
  app: {
    namespace: AppInfo | string
    capabilities?: Permissions
  }
  fileSystem: {
    dataRootCID: string | null
  }
  user: {
    username: string | null
    accountDID: string | null
    agentDID: string
  }
  odd: {
    version: string
  }
}

Updated on April 21st, 2023.

Connect message

The extension calls a connect function that is added to the global object (e.g. window) by Webnative. When the connect function is called, Webnative sends a connect message to the extension:

globalThis.postMessage({
  id: extensionId,
  type: "connect",
  timestamp: 1678487975,
  state
})

Disconnect message

The extension calls a disconnect function when it does not need messages to be sent from Webnative:

globalThis.postMessage({
  id: extensionId,
  type: "disconnect",
  timestamp: 1678487975,
  state
})

Session messages

Webnative sends session create and destroy messages to the extension. Each message contains a detail field that includes the username and indicates the message type:

globalThis.postMessage({
  id: extensionId,
  type: "session",
  timestamp: 1678487975,
  state,
  detail: {
    type: "create",
    username
  }
})

globalThis.postMessage({
  id: extensionId,
  type: "session",
  timestamp: 1678487975,
  state,
  detail: {
    type: "destroy",
    username
  }
})

File system messages

Webnative sends filesystem local-change and publish messages to the extension. Each message contains a detail field that includes the root CID, path on local-change, and indicates the message type:

globalThis.postMessage({
  id: extensionId,
  type: "filesystem",
  timestamp: 1678487975,
  state,
  detail: {
    type: "local-change",
    root: "<root-cid>",
    path
  }
})

globalThis.postMessage({
  id: extensionId,
  type: "filesystem",
  timestamp: 1678487975,
  state,
  detail: {
    type: "publish",
    root: "<root-cid>"
  }
})

from odd-devtools.