Re export agora-rtc-sdk-ng methods from the React SDK

[EkaanshArora]

What kind of problem does this feature solve?

Since we're positioning the React SDK as a standalone product. We should re-export all the exports from the web sdk. This is important as while using the React SDK the devs also need to access exports from Web like types, default export, enums etc.

What does the proposed API look like?

import AgoraRTC from 'agora-rtc-sdk-ng'

export default AgoraRTC;
export * from 'agora-rtc-sdk-ng';

Open to discuss if we should avoid a default export.

[guoxianzhe]

It may be achieved though, but there are 3 potential problems:

1. agora-rtc-sdk-ng size is very large, and the way of export * will have a relatively large impact on the agora-rtc-react size
2. The independence between packages may be destroyed, and the documentation and unit testing cannot be well maintained
   such as .d.ts should include all agora-rtc-sdk-ng?
3. This is not conducive to tree-shaking

[EkaanshArora]

I agree with the problems you mentioned but we're targeting to release this is as a standalone SDK, we can't position this as a dependency on the Web SDK or a wrapper. So even though the concerns you mentioned are valid, we'll have to find the best course for release

1. This is minor as if you're using this project you'd need the Web SDK installed and the bundle size would be identical in a real-life example.
2. We need to figure out what we can do here.
   Yes, typings should contain all of Web SDK.
3. We can try our best here, but tree-shaking would depend on the Web SDK team to implement for us to leverage.

[guoxianzhe]

OK, please confirm is this you want?
for example ,

old:

import AgoraRTC from "agora-rtc-sdk-ng"

new:

import AgoraRTC from "agora-rtc-react"

package.json will be:

Are you sure our users can accept this? Looks like a big change so we need to be careful.

[EkaanshArora]

Hey sorry for the wait on this. Discussing internally if we should mix both named exports and default export in the same package. This isn't considered a good practice as of late, but it follows more of the Web SDK pattern of exports so I'm torn. Which do you think is better?

import AgoraRTC, {useClientHook, ...} from "agora-rtc-react"

vs.

import {AgoraRTC, useClientHook, ...} from "agora-rtc-react"

[guoxianzhe]

I think we should use

import {AgoraRTC, useClientHook, ...} from "agora-rtc-react"

In case of export the default class AgoraRTCReact in the future, or we should consider (need websdk help here)

export class AgoraRTCReact extends AgoraRTC {}

usage:

import AgoraRTCReact from "agora-rtc-react"

And there is more thing, CDN is umd package , window is prefer to export AgoraRTCReact instead of AgoraRTC

[EkaanshArora]

If we re-export Web SDK from React, another detail to discuss would be how we keep the Web SDK peer dependency up to date. We'll need to make sure that minor updates to the Web SDK don't require an update to the React SDK. New installs of the React SDK should get the latest releases of both (as long as Web SDK follows semantic versioning/backwards compatibility). This shouldn't be difficult to do, just something to keep in mind when we make this change.

[EkaanshArora]

Argument against default exports: https://x.com/kentcdodds/status/1702339919438627290

[guoxianzhe]

@EkaanshArora I did some for this feature, #163

import type { ILocalAudioTrack, ILocalTrack, ILocalVideoTrack } from "agora-rtc-react";
import AgoraRTC, {
  AgoraRTCScreenShareProvider,
  LocalAudioTrack,
  LocalVideoTrack,
  useJoin,
  usePublish,
  useTrackEvent,
} from "agora-rtc-react";

And window object (only in umd/iife)

Let me know if you have another ideas.

[EkaanshArora]

Hey this looks good, let me give it a try and get back to you!

[guoxianzhe]

completed in #163