@planningcenter/jolt-client

Jolt client-side library

This is a Typescript implementation of a Jolt client. It is suitable for use in client-side browser environments.

If you're new to Jolt, we recommend starting with the Jolt Documentation. It covers the fundamental concepts and usage.

Usage

// Configure a new Jolt Client
const client = new JoltClient("wss://example.com/socket", {
  fetchAuthTokenFn: async () => "auth-token",
  fetchSubscribeTokenFn: async (channel, connectionId) => "subscribe-token",
}, clientConfig);

// Subscribe to a channel.
// Note: The subscription token must have access to this channel, you can't just bind to any channel.
const subscription = client.subscribe("channel-name");

// Bind as my event handlers as you need to the channel.
subscription.bind("person.created", ({ event, data, channel }) => {})
subscription.bind("person.deleted", ({ event, data, channel }) => {})
subscription.bind("person.*", ({ event, data, channel }) => {})
subscription.bind("*", ({ event, data, channel }) => {})

// Unbind event handlers when you are done with them
// The most convenient way is to call the function that `bind` returned
const unbindSubscription = subscription.bind("person.edited", ({ event, data, channel }) => {})
unbindSubscription()

// Or unbind all and unsubscribe from the channel
subscription.unsubscribe()

// You can also unsubscribe from the client
client.unsubscribe("channel-name");

// And disconnect all-together if needed
client.disconnect();

Configuration Options

JoltClient Constructor Parameters

• wssEndpoint: The WebSocket server endpoint.
• authorizationConfig: Configuration for authorization tokens.
  • fetchAuthTokenFn: Function to fetch the authentication token.
  • fetchSubscribeTokenFn: Optional function to fetch the subscription token. If you don't define it here, you will need to define it when subscribing to a channel.
• clientConfig: Optional configuration for the client.
  • logToConsole: Whether to log messages to the console. Default is false.
  • logLevel: The log level. Can be "none", "debug", "info", "warn", or "error". Default is "error" if logToConsole is false, otherwise "info".
  • pingInterval: Interval in milliseconds to send ping messages. Default is 240000 (4 minutes).
  • pingTimeout: Timeout in milliseconds for ping responses. Default is 2000 (2 seconds).
  • retryTimeout: Function to calculate the retry timeout based on the previous timeout and retry count. Default is an exponential backoff starting at 3000ms.

React Example

This client is not tied to React in any way. So, the following is just an example of how you could use this library with React hooks.

// Maybe you want some kind of useJoltChannel.js hook
import { useEffect, useState } from "react";
import Jolt from "@planningcenter/jolt-client";

function useJoltChannel(channelName) {
  const [joltChannel, setJoltChannel] = useState();

  useEffect(() => {
    const jolt = new Jolt("wss://your.endpoint.here", {
      authToken: "your:auth:token:or:whatever",
      fetchSubscribeTokenFn: async (channel, connectionId, { claims }) =>
        "your:subscribe:token",
    });
    setJoltChannel(jolt.subscribe(channelName));
    return () => jolt.unsubscribe(channelName);
  }, [channelName]);

  return joltChannel;
}

// Elsewhere...

function ComponentCommunicatingWithJolt() {
  const channel = useJoltChannel("someChannel");
  useEffect(() => {
    if (!channel) return;

    const handleMessage = ({ event, data, channel }) => doSomething(data);
    return channel.bind("someEvent", handleMessage);
  }, [channel]);
}

Additional Options

Auto Subscription

const client = new JoltClient("wss://your.endpoint.here", {
  autosubscribe: true
  ...
})

// and/or

client.subcribe("channelName", { autosubscribe: true })

By default, WebSocket subscriptions are established when you call subscribe and remain active until you explicitly call unsubscribe.

However, if you set autosubscribe: true in your JoltClient configuration or when using JoltClient#subscribe, subscriptions will automatically unsubscribe when all listeners are removed. If a listener is later added to a closed subscription, it will automatically resubscribe.

This feature is particularly useful for managing multiple subscriptions across different parts of your application. When listeners for a specific context are removed, the subscription will intelligently unsubscribe—either keeping it active if there are other active listeners or closing it entirely if no listeners remain.

Development

Dev dependencies and scripts are definined in package.json.

Getting Started

Install development dependencies:

npm ci

Run jest watch to run specs on changes:

npm run watch

Test

Aside from npm run watch, you can run the tests on demand with:

npm run test

Build

When you're ready to compile the Javascript module:

npm run build

This will also run tests as part of the preBuild phase.

Release

Time for a new release? First check these things:

1. npm run build succeeds.
2. You've updated the CHANGELOG heading and package.json version.

Then, follow this notion document