How does the consuming app import the realtime surface?

Open
#236 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
68/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
api

Research direction

Start with lib/drivers/ddp.ts and the RocketChatClient.socket declaration, then search the consuming app for Socket, ISocket, IDriver, and emitted event names. Record each call site and whether imports are type-only; done means the blast radius of both renames is documented.

Written by the indexing model from the issue text.

Description

wayfinder:research

Question

Which realtime names does Rocket.Chat.ReactNative actually import, and how?

The SDK ships TypeScript source with no build step, so every exported name is public API to that app. Two renames hinge on this:

  • the exported Socket class in lib/drivers/ddp.ts
  • the RocketChatClient.socket property, typed Promise<ISocket | IDriver>

Find every reference in the consuming app to those two, to ISocket/IDriver, and to the emitted event names. Report call sites and whether each is a type-only import.

Resolved when the blast radius of both renames is known, rather than assumed.

Dominant language
TypeScript
Stars
146
Forks
101
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from RocketChat/Rocket.Chat.js.SDK

All issues in RocketChat/Rocket.Chat.js.SDK

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.