@ulms/messenger v2.6.15-rc.4

@ulms/messenger service

Usage

Dependencies

Messenger relies on dependencies described at peerDependencies#l73-l77 section.

They shoud be included like this#l10-l25 or according your pipeline.

Initialization

Messenger service can be accessed like this:

var Chat = window.WCChat.chat.default
var Account = window.Account.Account
var TokenProvider = window.Account.TokenProvider
var MessengerService = window.UlmsMessenger.MessengerService;

window.customElements.define('ulms-messenger', Chat)

var config = {
  api_version: "<api_version>"
  audience: "<audience>"
  auth_endpoint: "<auth_endpoint>"
  events_endpoint: "<events_endpoint>"
  notifications_endpoint: "<notifications_endpoint>"
  profile_endpoint: "<profile_endpoint>"
  profile_gateway: "<profile_gateway>"
  refresh_token: "<refresh_token>"
  room_id: "<room_id>"
  scope: "<scope>"
}

var messenger = window.document.getElementById('messenger');

var account = new Account(/* your configuration */)
var tokenProvider = new TokenProvider({ "refresh_token": "<token>" }, account)

Self-contained messenger

Messenger service manages and stores all the data itself.

new MessengerService(
  config,
  [ "<room_id>", messenger ],
  tokenProvider
)

Messenger with external storage

Messenger service uses external Redux storage. All the needed processing must be done externally.

new MessengerService(
  config, 
  [ "<room_id>", messenger ], 
  tokenProvider,
  redux.createStore(/* your implementation */)
)

Proxy-store

Messenger service may use some kind of proxy store which just emits events. All the needed processing must be done externally.

var proxyStore = window.UlmsMessenger.ProxyStore;

new MessengerService(
  config, 
  [ "<room_id>", messenger ], 
  tokenProvider,
  proxyStore.createStore()
)

Debug

npm start
# one shell

chokidar ./src -pc "npm run build/umd/min"
# another shell

# HINT: pre run `npm i -g chokidar-cli` to install `chokidar`