@fishjam-cloud/react-native-client

React Native client library for Fishjam.

Installation

npm install @fishjam-cloud/react-native-client
# or
yarn add @fishjam-cloud/react-native-client

Android VoIP setup

Incoming calls on Android are delivered over Firebase Cloud Messaging, so Firebase is only pulled into your build when you opt in. iOS uses PushKit/APNs and needs none of this.

Expo

Enable VoIP in the config plugin and point Expo at your google-services.json:

{
  "expo": {
    "android": { "googleServicesFile": "./google-services.json" },
    "plugins": [["@fishjam-cloud/react-native-client", { "android": { "enableVoIP": true } }]]
  }
}

Prebuild does the rest. android.googleServicesFile makes Expo add the com.google.gms:google-services classpath, apply the Gradle plugin, and copy the file into android/app/. Omitting it while enableVoIP is on is a prebuild error.

Call timeouts

The plugin can set native timeouts in seconds. An unanswered incoming call defaults to 45 seconds, an unconnected outgoing call defaults to 60 seconds, and the answer-fulfillment handshake defaults to 10 seconds:

{
  "expo": {
    "plugins": [
      [
        "@fishjam-cloud/react-native-client",
        {
          "android": { "enableVoIP": true },
          "voip": {
            "incomingCallTimeout": 45,
            "outgoingCallTimeout": 60,
            "fulfillAnswerCallTimeout": 10
          }
        }
      ]
    ]
  }
}

All timeout properties are optional and must be positive finite numbers. Omit a property to use its native default.

Bare React Native

Config plugins do not run, and the google-services Gradle plugin must be applied to the application module — a library cannot do it for you. Follow the Firebase Android setup guide to add google-services.json and apply the plugin.

You must also declare by hand what the config plugin would otherwise inject into AndroidManifest.xml — the MANAGE_OWN_CALLS, POST_NOTIFICATIONS, USE_FULL_SCREEN_INTENT and VIBRATE permissions, the IncomingCallActivity, the EndCallNotificationReceiver, and the PushNotificationService with its com.google.firebase.MESSAGING_EVENT intent filter. See plugin/src/withFishjamVoIPAndroid.ts for the exact entries.

Set timeout metadata manually when using bare React Native:

<application>
  <meta-data android:name="VoIPIncomingCallTimeout" android:value="45" />
  <meta-data android:name="VoIPOutgoingCallTimeout" android:value="60" />
  <meta-data android:name="VoIPFulfillAnswerTimeout" android:value="10" />
</application>

For iOS, add the same timeout values as numeric Info.plist keys: VoIPIncomingCallTimeout, VoIPOutgoingCallTimeout, and VoIPFulfillAnswerTimeout.

Local Development with WebRTC Fork

This package depends on @fishjam-cloud/react-native-webrtc, a fork of react-native-webrtc. The fork lives in its own GitHub repo and is included in this monorepo as a git submodule at packages/react-native-webrtc/, wired up as a yarn workspace. No manual linking is required.

Setup

Clone the repository with submodules:

git clone --recurse-submodules https://github.com/fishjam-cloud/web-client-sdk.git

If you already cloned without --recurse-submodules, initialize the submodules from inside the repo:

git submodule update --init --recursive

Then install dependencies from the repo root:

yarn install

Yarn resolves @fishjam-cloud/react-native-webrtc to the workspace at packages/react-native-webrtc/, and React Native autolinking picks up the native iOS and Android code automatically through the symlinked package.

Development Workflow

No pod install or yarn install is needed after native code changes — just rebuild the app.

Updating the Submodule

The submodule tracks the fork's master branch but is pinned to a specific commit. To update to the latest upstream:

git submodule update --remote packages/react-native-webrtc
git add packages/react-native-webrtc
git commit -m "Bump react-native-webrtc submodule"

To check out a specific tag or commit:

git -C packages/react-native-webrtc fetch
git -C packages/react-native-webrtc checkout <tag-or-sha>
git add packages/react-native-webrtc
git commit -m "Pin react-native-webrtc to <tag-or-sha>"

When bumping the submodule across a version boundary, also update peerDependencies.@fishjam-cloud/react-native-webrtc in this package's package.json so external consumers see the correct range.

Contributing Changes to the Fork

Changes inside packages/react-native-webrtc/ belong to the fork's own repo, not this one. To push them upstream:

cd packages/react-native-webrtc
git checkout -b your-feature-branch
# commit your changes
git push origin your-feature-branch
# open a PR against fishjam-cloud/fishjam-react-native-webrtc

Once the upstream PR is merged, bump the submodule sha here (see "Updating the Submodule" above).