@pipecat-ai/react-native-small-webrtc-transport 1.4.0

package/LICENSE.md

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2024, Daily
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,114 @@
+<h1><div align="center">
+ <img alt="pipecat client react native" width="500px" height="auto" src="https://github.com/pipecat-ai/pipecat-client-react-native-transports/blob/main/pipecat-react-native.png">
+</div></h1>
+
+[![Docs](https://img.shields.io/badge/documentation-blue)](https://docs.pipecat.ai/client/introduction)
+![NPM Version](https://img.shields.io/npm/v/@pipecat-ai/react-native-daily-transport)
+
+The Pipecat client React Native Transport library exports a `RNSmallWebRTCTransport` that has the [SmallWebRTCTransport](https://docs.pipecat.ai/client/js/transports/small-webrtc) transport associated.
+
+## Minimum OS/SDK versions
+
+This package introduces some constraints on what OS/SDK versions your project can support:
+
+- **iOS**: Deployment target >= 15
+- **Android**: `minSdkVersion` >= 24
+
+## Installation
+
+Install `@pipecat-ai/react-native-small-webrtc-transport`.
+
+```bash
+npm i @pipecat-ai/react-native-small-webrtc-transport
+```
+
+If you are using the [DailyMediaManager](../../libs/daily-media-manager/README.md), you will also need to install it along with its peer dependencies:
+
+```bash
+npm i @pipecat-ai/react-native-daily-media-manager
+npm i @daily-co/react-native-daily-js@^0.82.0
+npm i @daily-co/react-native-webrtc@^124.0.6-daily.1
+npm i @react-native-async-storage/async-storage@^1.24.0
+npm i react-native-background-timer@^2.4.1
+npm i react-native-get-random-values@^1.11.0
+```
+
+If you are using Expo, you will also need to add the following dependencies:
+
+```bash
+npm i @daily-co/config-plugin-rn-daily-js@0.0.10
+```
+
+All the details about Expo can be found [here](https://github.com/daily-co/rn-daily-js-expo-config-plugin).
+
+A full demo can be found [here](https://github.com/pipecat-ai/pipecat-examples/tree/main/p2p-webrtc/video-transform/client/react-native)
+
+## Quick Start
+
+Instantiate an `RTVIClient` instance, wire up the bot's audio, and start the conversation:
+
+```typescript
+const options: SmallWebRTCTransportConstructorOptions = {
+  mediaManager: new DailyMediaManager(),
+};
+let pipecatClient = new PipecatClient({
+  transport: new RNSmallWebRTCTransport(options),
+  enableMic: true,
+  enableCam: false,
+  callbacks: {
+    onConnected: () => {
+      setInCall(true);
+    },
+    onDisconnected: () => {
+      setInCall(false);
+    },
+    onTransportStateChanged: (state) => {
+      console.log(`Transport state changed: ${state}`);
+      setCurrentState(state);
+    },
+    onError: (error) => {
+      console.log('Error:', JSON.stringify(error));
+    },
+  },
+});
+
+await client?.startBotAndConnect({
+  endpoint: baseUrl + '/start',
+});
+```
+
+> Note: To enable screen sharing on iOS, follow the instructions in the [Daily Framework RN Screen Share extension](https://github.com/daily-co/rn-screen-share-extension/).
+
+## Documentation
+
+Pipecat Client React Native implements a client instance that:
+
+- Facilitates requests to an endpoint you create.
+- Dispatches single-turn actions to a HTTP bot service when disconnected.
+- Provides methods that handle the connectivity state and realtime interaction with your bot service.
+- Manages media transport (such as audio and video).
+- Provides callbacks and events for handling bot messages and actions.
+- Optionally configures your AI services and pipeline.
+
+Docs and API reference can be found at https://docs.pipecat.ai/client/introduction.
+
+## Contributing
+
+We welcome contributions from the community! Whether you're fixing bugs, improving documentation, or adding new features, here's how you can help:
+
+- **Found a bug?** Open an [issue](https://github.com/pipecat-ai/pipecat-client-react-native-transports/issues)
+- **Have a feature idea?** Start a [discussion](https://discord.gg/pipecat)
+- **Want to contribute code?** Check our [CONTRIBUTING.md](CONTRIBUTING.md) guide
+- **Documentation improvements?** [Docs](https://github.com/pipecat-ai/docs) PRs are always welcome
+
+Before submitting a pull request, please check existing issues and PRs to avoid duplicates.
+
+We aim to review all contributions promptly and provide constructive feedback to help get your changes merged.
+
+## Getting help
+
+➡️ [Join our Discord](https://discord.gg/pipecat)
+
+➡️ [Read the docs](https://docs.pipecat.ai)
+
+➡️ [Reach us on X](https://x.com/pipecat_ai)

package/lib/commonjs/index.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "MediaManager", {
+  enumerable: true,
+  get: function () {
+    return _mediaManager.MediaManager;
+  }
+});
+Object.defineProperty(exports, "PipecatClientVideoView", {
+  enumerable: true,
+  get: function () {
+    return _PipecatClientVideoView.default;
+  }
+});
+Object.defineProperty(exports, "RNSmallWebRTCTransport", {
+  enumerable: true,
+  get: function () {
+    return _transport.RNSmallWebRTCTransport;
+  }
+});
+Object.defineProperty(exports, "SmallWebRTCTransportConstructorOptions", {
+  enumerable: true,
+  get: function () {
+    return _transport.SmallWebRTCTransportConstructorOptions;
+  }
+});
+Object.defineProperty(exports, "TrackEvent", {
+  enumerable: true,
+  get: function () {
+    return _mediaManager.TrackEvent;
+  }
+});
+var _transport = require("./transport.js");
+var _mediaManager = require("./media-manager/mediaManager.js");
+var _PipecatClientVideoView = _interopRequireDefault(require("./view/PipecatClientVideoView.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+//# sourceMappingURL=index.js.map

package/lib/commonjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_transport","require","_mediaManager","_PipecatClientVideoView","_interopRequireDefault","e","__esModule","default"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,UAAA,GAAAC,OAAA;AAIA,IAAAC,aAAA,GAAAD,OAAA;AACA,IAAAE,uBAAA,GAAAC,sBAAA,CAAAH,OAAA;AAAmE,SAAAG,uBAAAC,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA","ignoreList":[]}

package/lib/commonjs/media-manager/mediaManager.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.MediaManager = void 0;
+class MediaManager {
+  _callbacks = {};
+  constructor() {
+    this._micEnabled = true;
+    this._camEnabled = false;
+    this._supportsScreenShare = false;
+  }
+  setClientOptions(options, override = false) {
+    if (this._options && !override) return;
+    this._options = options;
+    this._callbacks = options.callbacks ?? {};
+    this._micEnabled = options.enableMic ?? true;
+    this._camEnabled = options.enableCam ?? false;
+  }
+  get supportsScreenShare() {
+    return this._supportsScreenShare;
+  }
+  get onTrackStarted() {
+    return this._onTrackStartedCallback;
+  }
+  set onTrackStarted(callback) {
+    this._onTrackStartedCallback = callback;
+  }
+  get onTrackStopped() {
+    return this._onTrackStoppedCallback;
+  }
+  set onTrackStopped(callback) {
+    this._onTrackStoppedCallback = callback;
+  }
+}
+exports.MediaManager = MediaManager;
+//# sourceMappingURL=mediaManager.js.map

package/lib/commonjs/media-manager/mediaManager.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["MediaManager","_callbacks","constructor","_micEnabled","_camEnabled","_supportsScreenShare","setClientOptions","options","override","_options","callbacks","enableMic","enableCam","supportsScreenShare","onTrackStarted","_onTrackStartedCallback","callback","onTrackStopped","_onTrackStoppedCallback","exports"],"sourceRoot":"../../../src","sources":["media-manager/mediaManager.ts"],"mappings":";;;;;;AAeO,MAAeA,YAAY,CAAC;EAEvBC,UAAU,GAAuB,CAAC,CAAC;EAU7CC,WAAWA,CAAA,EAAG;IACZ,IAAI,CAACC,WAAW,GAAG,IAAI;IACvB,IAAI,CAACC,WAAW,GAAG,KAAK;IACxB,IAAI,CAACC,oBAAoB,GAAG,KAAK;EACnC;EAEAC,gBAAgBA,CAACC,OAA6B,EAAEC,QAAiB,GAAG,KAAK,EAAE;IACzE,IAAI,IAAI,CAACC,QAAQ,IAAI,CAACD,QAAQ,EAAE;IAChC,IAAI,CAACC,QAAQ,GAAGF,OAAO;IACvB,IAAI,CAACN,UAAU,GAAGM,OAAO,CAACG,SAAS,IAAI,CAAC,CAAC;IACzC,IAAI,CAACP,WAAW,GAAGI,OAAO,CAACI,SAAS,IAAI,IAAI;IAC5C,IAAI,CAACP,WAAW,GAAGG,OAAO,CAACK,SAAS,IAAI,KAAK;EAC/C;EA4BA,IAAIC,mBAAmBA,CAAA,EAAY;IACjC,OAAO,IAAI,CAACR,oBAAoB;EAClC;EAEA,IAAIS,cAAcA,CAAA,EAA8C;IAC9D,OAAO,IAAI,CAACC,uBAAuB;EACrC;EAEA,IAAID,cAAcA,CAACE,QAAmD,EAAE;IACtE,IAAI,CAACD,uBAAuB,GAAGC,QAAQ;EACzC;EAEA,IAAIC,cAAcA,CAAA,EAA8C;IAC9D,OAAO,IAAI,CAACC,uBAAuB;EACrC;EAEA,IAAID,cAAcA,CAACD,QAAmD,EAAE;IACtE,IAAI,CAACE,uBAAuB,GAAGF,QAAQ;EACzC;AACF;AAACG,OAAA,CAAAnB,YAAA,GAAAA,YAAA","ignoreList":[]}

package/lib/commonjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}