[RFE] Support WebSocket Delivery

[mitchwadair]

[RFE] Support WebSocket Delivery

[mitchwadair]

May also want to change how webhooks are configured in the config object. Maybe have all relevant properties in their own object (which puts related params together)

const TES = require('tesjs');
const express = require('express');

// basic express app for example
const app = express();
app.get('/', (req, res) => {
  res.send('OK')
});
app.listen(8080);

// initialize TESjs
const tes = new TES({
    identity: YOUR_CLIENT_ID, // now not an obj as only client id is relevant to ALL cases of ID
    listener: {
        webhook: {
            baseURL: "https://example.com",
            secret: YOUR_SECRET,  // secret is now only useful for webhooks so it moves here
            port: 8080,
            server: app
        },
        ignoreDuplicateMessages: true,
        ignoreOldMessages: true,
    }
});

This would be a breaking change, and require a version number upgrade (v0.5.0 or would it be v1.0.0??), but would also make it so omitting the webhook param would be what implies websocket usage.

[mitchwadair]

Another alternative (that I am now leaning towards) is moving ignoreDuplicateMessages and ignoreOldMessages to options and making listener become webhook:

const TES = require('tesjs');
const express = require('express');

// basic express app for example
const app = express();
app.get('/', (req, res) => {
  res.send('OK')
});
app.listen(8080);

// initialize TESjs
const tes = new TES({
    identity: YOUR_CLIENT_ID, // now not an obj as only client id is relevant to ALL cases of ID
    options: {
        debug: true,
        ignoreDuplicateMessages: true,
        ignoreOldMessages: true,
    },
    webhook: {
        baseURL: "https://example.com",
        secret: YOUR_SECRET,  // secret is now only useful for webhooks so it moves here
        port: 8080,
        server: app
    }
});

This is also a breaking change, and will require a version number upgrade

[mitchwadair]

In the interest of allowing Websocket connections on serverside applications as well, we should also allow client secrets to be specified for app access token use in config.

const config = {
    identity: {
        client_id,
        client_secret, // used only in server-side apps
        user_access_token, // used only in client-side apps
    },
    options: {
        debug,
        ignoreDuplicateMessages,
        ignoreOldMessages,
    },
    webhook: {
        baseURL,
        secret, // required
        port,
        server
    }
}

[mitchwadair]

I've about hit what I can do based on the RFC. Will have to wait until general availability so I can test then PR the changes.

[mitchwadair]

EventSub WebSockets open beta is finally out! My work on this is so stale, I'll be starting mostly fresh.