opentok-react-native - npm Package Compare versions

Comparing version 0.13.0 to 0.14.0

CHANGELOG.md

@@ -0,1 +1,6 @@
+# 0.14.0 (May 22, 2020)
+
+- **[Feature]**: Update of iOS SDK to `2.17.0` and Android SDK to `2.17.1`
+- OTSessionManager.java#248 mSubscriber.destroy() removed as from 2.17.x, resources will be automatically released by the garbage collector.
+
 # 0.13.0 (Mar 23, 2020)
@@ -31,4 +36,4 @@
 -  iOS SDK updated to `2.16.1`
--   Android SDK updated to `2.16.1`
+-  Android SDK updated to `2.16.1`
   
 # 0.x.x (todo)

CONTRIBUTING.md

@@ -5,16 +5,16 @@ # Contributing Guidelines
 
-*  Bug fixes
-    -  If you find a bug, please first report it using Github Issues.
-    -  Issues that have already been identified as a bug will be labelled `bug`.
-    -  If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number.
-        +  Include a test that isolates the bug and verifies that it was fixed.
-*  New Features
-    -  If you'd like to add a feature to the library that doesn't already exist, feel free to describe the feature in a new Github Issue.
-    -  Issues that have been identified as a feature request will be labelled `enhancement`.
-    -  If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, `enhancement`s may not align well with the project objectives at the time.
-*  Documentation & Miscellaneous
-    -  If you think the documentation could be clearer, or you have an alternative
-       implementation of something that may have more advantages, we would love to hear it.
-       -  If its a trivial change, go ahead and send a Pull Request with the changes you have in mind
-       -  If not, open a Github Issue to discuss the idea first.
+- Bug fixes
+  - If you find a bug, please first report it using Github Issues.
+  - Issues that have already been identified as a bug will be labelled `bug`.
+  - If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number.
+    - Include a test that isolates the bug and verifies that it was fixed.
+- New Features
+  - If you'd like to add a feature to the library that doesn't already exist, feel free to describe the feature in a new Github Issue.
+  - Issues that have been identified as a feature request will be labelled `enhancement`.
+  - If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, `enhancement`s may not align well with the project objectives at the time.
+- Documentation & Miscellaneous
+  - If you think the documentation could be clearer, or you have an alternative
+    implementation of something that may have more advantages, we would love to hear it.
+    - If its a trivial change, go ahead and send a Pull Request with the changes you have in mind
+    - If not, open a Github Issue to discuss the idea first.
 
@@ -25,4 +25,4 @@ ## Requirements
 
-*  Code must follow existing styling conventions
-*  Commit messages must be descriptive. Related issues should be mentioned by number.
+- Code must follow existing styling conventions
+- Commit messages must be descriptive. Related issues should be mentioned by number.
 
@@ -45,2 +45,2 @@ If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the Issue. You can still continue to add more commits to the branch you have sent the Pull Request from.
 3. Modify iOS components in `ios/`.
-4. Modify Android components in `android/`.
+4. Modify Android components in `android/`.

package.json

 {
   "name": "opentok-react-native",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "React Native components for OpenTok iOS and Android SDKs",
@@ -5,0 +5,0 @@ "main": "src/index.js",

README.md

 # opentok-react-native
-![OpenTok Labs](https://d26dzxoao6i3hh.cloudfront.net/items/0U1R0a0e2g1E361H0x3c/Image%202017-11-22%20at%2012.16.38%20PM.png?v=2507a2df)
 
+<img src="https://assets.tokbox.com/img/vonage/Vonage_VideoAPI_black.svg" height="48px" alt="Tokbox is now known as Vonage" />
+
 React Native library for OpenTok iOS and Android SDKs
 
-- [Pre-Requisites](#pre-requisites)
-- [Installation](#installation)
-  - [iOS Installation](#ios-installation)
-  - [Android Installation](#android-installation)
-- API Reference
-  - [OTSession Component](https://github.com/opentok/opentok-react-native/tree/master/docs/OTSession.md)
-  - [OTPublisher Component](https://github.com/opentok/opentok-react-native/tree/master/docs/OTPublisher.md)
-  - [OTSubscriber Component](https://github.com/opentok/opentok-react-native/tree/master/docs/OTSubscriber.md)
-  - [Event Data](https://github.com/opentok/opentok-react-native/tree/master/docs/EventData.md)
-- [Samples](#samples)
-- [Contributing](#contributing)
+- [opentok-react-native](#opentok-react-native)
+    - [In this repo, you'll find the OpenTok React Native library:](#in-this-repo-youll-find-the-opentok-react-native-library)
+  - [Pre-Requisites:](#pre-requisites)
+  - [Installation:](#installation)
+    - [iOS Installation](#ios-installation)
+    - [Android Installation](#android-installation)
+  - [Samples](#samples)
+  - [Development and Contributing](#development-and-contributing)
+  - [Getting Help](#getting-help)
 
@@ -25,7 +24,9 @@ ### In this repo, you'll find the OpenTok React Native library:
 2. Install and update [Xcode](https://developer.apple.com/xcode/) (you will need a Mac)
-* React Native iOS installation [instructions](https://facebook.github.io/react-native/docs/getting-started.html)
 
+- React Native iOS installation [instructions](https://facebook.github.io/react-native/docs/getting-started.html)
+
 3. Install and update [Android Studio](https://developer.android.com/studio/index.html)
-* React Native Android installation [instructions](https://facebook.github.io/react-native/docs/getting-started.html)
 
+- React Native Android installation [instructions](https://facebook.github.io/react-native/docs/getting-started.html)
+
 ## Installation:
@@ -36,5 +37,6 @@
 2. Add the library using `npm` or `yarn`.
-* `npm install opentok-react-native`
-* `yarn add opentok-react-native`
 
+- `npm install opentok-react-native`
+- `yarn add opentok-react-native`
+
 ### iOS Installation
@@ -44,2 +46,3 @@
 If you've installed this package before, you may need to edit your `Podfile` and project structure because the installation process has changed.
+
 1. In you terminal, change into the `ios` directory of your React Native project.
@@ -55,3 +58,3 @@
       # Pods for <YourProject>
-        pod 'OpenTok', '2.16.3'
+        pod 'OpenTok', '2.17.0'
     end
@@ -72,4 +75,5 @@
 7. Add an empty swift file to your project:
-    * You can name this file anything i.e: `OTInstall.swift`. This is done to set some flags in XCode so the Swift code can be used.
 
+   - You can name this file anything i.e: `OTInstall.swift`. This is done to set some flags in XCode so the Swift code can be used.
+
 8. Click `Create Bridging Header` when you're prompted with the following modal: `Would you like to configure an Objective-C bridging header?`
@@ -97,4 +101,5 @@
 2. If you have already run `react-native link opentok-react-native` for the iOS installation, please skip this step.
-    *  Run `react-native link opentok-react-native`
 
+   - Run `react-native link opentok-react-native`
+
 3. Open your Android project in Android Studio.
@@ -131,4 +136,14 @@
 
-## Contributing
+## Development and Contributing
 
-If you make changes to the project that you would like to contribute back then please follow the [contributing guidelines](CONTRIBUTING.md). All contributions are greatly appreciated!
+Interested in contributing? We :heart: pull requests! See the
+[Contribution](CONTRIBUTING.md) guidelines.
+
+## Getting Help
+
+We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:
+
+- Open an issue on this repository
+- See <https://support.tokbox.com/> for support options
+- Tweet at us! We're [@VonageDev](https://twitter.com/VonageDev) on Twitter
+- Or [join the Vonage Developer Community Slack](https://developer.nexmo.com/community/slack)

src/OTSubscriber.js

@@ -60,3 +60,3 @@ import React, { Component } from 'react';
     const { streamProperties, properties } = this.props;
-    const { sessionInfo } = this.context;
+    const { sessionId, sessionInfo } = this.context;
     const subscriberProperties = isNull(streamProperties[stream.streamId]) ?
@@ -67,3 +67,3 @@ sanitizeProperties(properties) : sanitizeProperties(streamProperties[stream.streamId]);
     if (subscribeToSelf || (sessionInfoConnectionId !== stream.connectionId)){
-      OT.subscribeToStream(stream.streamId, subscriberProperties, (error) => {
+      OT.subscribeToStream(stream.streamId, sessionId, subscriberProperties, (error) => {
         if (error) {
@@ -70,0 +70,0 @@ this.otrnEventHandler(error);

No alert changes

Improved metrics

Number of lines in readme file

143

increased by11.72%

Worsened metrics

Total package byte prevSize

233309

decreased by-4.11%

No dependency changes