@rbbn/distant

Distant

The Distant library is used to control a remote browser-type application via an arbitrary channel.

Features

• Create remote sessions
• Monitor remote sessions
• Send and receive custom user defined messages from the remote session.

Installation

Install using npm:

npm install @distant/distant

or yarn:

yarn add @distant/distant

Basic Usage

To get started, you need to create a controller that is connected to a remote agent.

import { createController } from '@distant/distant'
import { createConnection } from '@distant/distant-web'

const distantWebConnection = createConnection()

const controller = createController(distantWebConnection)

// ... Use the controller

Note that the connection and the controller are maintained separately, it is up to the application to monitor the connection and re-establish the connection if it goes down or fails.

Once we have created the controller we can start by creating a session.

async function startSession(sessionId) {
  try {
    const session = await controller.createSession({
      id: sessionId, // Session id must be an integer
      url: 'https://remoteapp.url',
      timeout: 2000
    })

    // Session is created.
    return session
  } catch (err) {
    console.error(err)
  }
}

With the session we can then start sending and receiving messages. First though we need to register some event listeners in order to get notified of the status of the session as well as messages.

function registerSession(session) {
  session.on('changed', event => {
    // Handle session changed events
  })

  session.on('closed', event => {
    // Handle session closed events
  })

  session.on('message', event => {
    // Handle session message events
  })
}

Now to send a message to the session we simply call session.sendMessage.

function sendMessage(session, message) {
  // In order to send a message we must first encode into a byte array.
  const encoder = new TextEncoder()
  const encodedMessage = encoder.encode(JSON.stringify(message))

  session.sendMessage(encodedMessage)
}

Note: Encoding and decoding is application specific. Distant only deals with Uint8Array (Byte arrays) for messages. Here we use JSON messages encoded with the TextEncoder for example.

Receiving messages works much the same way.

session.on('message', payload => {
  const decoder = new TextDecoder()
  const message = JSON.parse(decoder.decode(payload))

  // Application specific message handling goes here.
})

Changelog

1.2.0 - 2023-09-13

Added

• distant-remote
  • MacOS: "requestDeviceAuth" method added to remote controller object will check microphone and camera permissions and request them from the user if they've never been prompted or if they were previously denied. The results will be emitted as a "deviceAuth" event which can be listened to using the remote controller's "on" method. KAJ-1638
  • "openBrowser" method added to the remote controller object takes an argument of a URL as a string, launches the user's system web browser and opens that URL. KAJ-1644

Changed

• First release of DistantJS published in NPM
• Branding change from @distant to @rbbn
• distant-vchannel
  • Bump protobufjs to 7.2.5