[DX-631] Pub/Sub JavaScript SDK API references (realtime interface)

[m-hulbert]

Description

This PR proposes a new format for the Pub/Sub JavaScript SDK (realtime interface) API references.

It uses the new components and design for API references introduced for the Chat API refs, updates the content to the latest SDK version (2.22.1) and tidies up anything that was legacy.

It also introduces a slightly new IA to better group like APIs, and ensures a better blend between the actual interface names used by the SDK (e.g. RealtimeChannel) and the concepts themselves (e.g. 'Channels').

For now, this doesn't update any links or remove the existing API references. This will follow once REST is complete for JavaScript, as we'll need to update the query param behaviour for API reference links. 1

Checklist

• Commits have been rebased.
• Linting has been run against the changed file(s).
• The PR adheres to the writing style guide and contribution guide.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 80c84e1b-d12d-4eb7-acef-5fbc2953411f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch dx-631-pubsub-js

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[umair-ably]

Just read through the auth page, it's infinitely better than what we originally had! The default values and even some side effects are way easier to understand.

Just a couple of notes that are probably only relevant for this page... "Auth" is both a concept and an interface, so I think we need to be stronger in the intro when framing what is and isn't on this page i.e. I think we should lead with JWTs more strongly and then highlight this page is largely only relevant if you're using the other auth types

[umair-ably]

TokenRequests formats weirdly... the old prose of "TokenRequest objects" reads nicer

[umair-ably]

I think the aside is too low down and also doesn't necessarily highlight that this page is largely irrelevant if you do use JWTs...

I think the intro itself could be reframed to something like:

The principal use of Auth is to issue short-lived credentials to less-trusted clients without sharing your private API key. The recommended approach for most applications is Ably JWTs, which let your server mint tokens using standard JWT libraries - examples can be seen here.

Ably also supports signed TokenRequests... blah blah blah... details below

[umair-ably]

The ordering on this page is a little strange imo... I'd expect to see all the channel-centric operations first e.g. attaching, listeners, etc.. first, followed by all the message operations e.g. history, append, etc...