pushwoosh-react-native-plugin 1.2.5 → 2.2.17

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,135 @@
+name: "🐞 Bug Report"
+description: "Report us a bug"
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to create this issue.
+
+        The more detailed information filled below will help us to investigate the root cause of the issue faster and fix it.
+        This form is for React Native Plugin only. If this is a bug for another platform or framework — please create the issue in the corresponded [repository](https://github.com/orgs/Pushwoosh/repositories). We appreciate your cooperation!
+  - type: checkboxes
+    id: rtfm
+    attributes:
+      label: Documentation
+      description: "Have you checked the relevant integration guide: [Integrating React Native Plugin](https://docs.pushwoosh.com/platform-docs/pushwoosh-sdk/cross-platform-frameworks/react-native/integrating-react-native-plugin) which describes implementation process of the Pushwoosh SDK to your app and follow all the necessary steps?"
+      options:
+        - label: I've checked the guide, but it doesn't help me to resolve the issue.
+          required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Short description of the issue. You can add screenshots and screencast to illustrate it.
+      placeholder: "Example: When receiving a push with Rich Media in a closed app, Rich Media is not shown."
+    validations:
+      required: true
+  - type: dropdown
+    id: severity
+    attributes:
+      label: Bug severity
+      description: |
+        How do you rate the severity of this bug?
+        For an objective assessment, please take into account how often this bug occurs in everyday app interaction, how serious the consequences of its occurrence (crash, warning, etc.), number of affected users, enviroment where it occurs (stage, production. etc.).
+      options:
+        - Low
+        - Normal
+        - High
+        - Urgent
+    validations:
+      required: true
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: Steps to Reproduce
+      description: Describe all the steps needed to reproduce the issue. If an issue is only reproducible under particular circumstances, put all required details here. E.g., if a push is not shown only for a specific API request, provide the full request body. Or, if an issue is reproducible with a particular Rich Media, deep link, etc. — specify it.
+      placeholder: |
+        1. Open the app;
+        2. Switch it to the background;
+        3. Received notification with "root_params" causes the app to crash.
+        This happens only if dependency XYZ v.1.2.3 is installed
+    validations:
+      required: true
+  - type: dropdown
+    id: affected-version
+    attributes:
+      label: Your Pushwoosh React Native Plugin version
+      description: Your React Native Plugin version which was integrated to the app. You may find it on the [releases page](https://github.com/Pushwoosh/pushwoosh-react-native-plugin/releases)
+      options:
+        - 6.1.25
+        - 6.1.23
+        - 6.1.22
+        - 6.1.21
+        - 6.1.20
+        - 6.1.19
+        - 6.1.18
+        - 6.1.17
+        - 6.1.16
+        - 6.1.15
+        - 6.1.14
+        - 6.1.13
+        - 6.1.12
+        - 6.1.11
+        - 6.1.10
+        - 6.1.9
+        - 6.1.8
+        - 6.1.7
+        - 6.1.6
+        - 6.1.5
+        - 6.1.4
+        - 6.1.3
+        - 6.1.2
+        - 6.1.1
+        - 6.0.10
+        - 6.0.9
+        - 6.0.8
+        - 6.0.7
+        - 6.0.6
+        - 6.0.5
+        - 6.0.4
+        - 6.0.3
+        - 6.0.2
+        - 6.0.1
+        - 6.0.0
+        - Other — specify it in the description
+    validations:
+      required: true
+  - type: input
+    id: last-worked
+    attributes:
+      label: Last worked Pushwoosh React Native Plugin version (if any)
+      description: Is there a version that worked well? If so, please specify.
+  - type: checkboxes
+    id: platforms-affected
+    attributes:
+      label: Affected platforms
+      description: Select the platforms on which the issue occurs. This helps us determine whether the root cause is core plugin or platform specific.
+      options:
+        - label: Android
+        - label: iOS
+    validations:
+      required: true
+  - type: textarea
+    id: platform-versions
+    attributes:
+      label: Affected OS versions and/or devices
+      description: Please specify device models and custom distributions (if any) on which this issue occurs. If the issue occurs when building, then specify the target platform.
+      placeholder: |
+        E.g. Android 13 on a Google Pixel 3a XL,
+        iOS 17.0.3 on an iPhone 14
+        MIUI 14.0.8.0 on Xiaomi 13 Ultra, etc.
+    validations:
+      required: true
+  - type: textarea
+    id: workaround
+    attributes:
+      label: Workaround
+      description: Have you found a workaround for this issue? Please tell us — this may help other people to continue their work while waiting for this issue to be resolved.
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: After reproducing the issue, copy device console logs and paste them here "as is". This code block will be formatted automatically, so no additional formatting is needed. If the issue occurs when building, then provide us building logs here.
+      render: shell

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,31 @@
+name: "💡 Feature request"
+description: "Suggest us a good idea or improvement"
+title: "[Feature]: "
+labels: ["feature"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to create this request.
+        
+        This form is for React Native Plugin only. If this is a feature for another platform or framework — please create it in the corresponded [repository](https://github.com/orgs/Pushwoosh/repositories). We appreciate your cooperation!
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Please tell us what's on your mind. You can add screenshots and screencast to illustrate your request.
+    validations:
+      required: true
+
+  - type: textarea
+    id: suggestions
+    attributes:
+      label: Sugeestions
+      description: |
+        If you know how you can achieve what you want or you have any information that may help us to achieve this, you can add it here.
+        For example, links to repositories, discussion threads, documentation, code samples, etc.
+
+  - type: markdown
+    attributes:
+      value: Thank you for your feedback!

package/.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,28 @@
+name: "❓ Question"
+description: "Ask us a question"
+title: "[Question]: "
+labels: ["question"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for your question!
+        
+        This form is for React Native Plugin only. If this is a question for another platform or framework — please create it in the corresponded [repository](https://github.com/orgs/Pushwoosh/repositories). We appreciate your cooperation!
+
+  - type: checkboxes
+    id: rtfm
+    attributes:
+      label: Documentation
+      description: "Have you checked the relevant integration guide: [Integrating React Native Plugin](https://docs.pushwoosh.com/platform-docs/pushwoosh-sdk/cross-platform-frameworks/react-native/integrating-react-native-plugin) which describes implementation process of the Pushwoosh SDK to your app and follow all the necessary steps?"
+      options:
+        - label: I've checked the guide, but I didn't find the information I needed there.
+          required: true
+
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: How can we help you? Do you have any questions about the integration of the SDK or how it works? You can add screenshots and screencast to illustrate your request.
+    validations:
+      required: true

package/InlineInApp.js

@@ -0,0 +1,71 @@
+import PropTypes from 'prop-types';
+import React from 'react';
+import {requireNativeComponent} from 'react-native';
+
+class InlineInAppView extends React.Component {
+	_onLoaded = (event) => {
+		if (!this.props.onLoaded) {
+			return;
+		}
+
+		// process raw event...
+		this.props.onLoaded(event.nativeEvent);
+	}
+
+	_onClosed = (event) => {
+		if (!this.props.onClosed) {
+			return;
+		}
+
+		// process raw event...
+		this.props.onClosed(event.nativeEvent);
+	}
+
+	_onSizeChanged = (event) => {
+		if (!this.props.onSizeChanged) {
+			return;
+		}
+
+		// process raw event...
+		this.props.onSizeChanged(event.nativeEvent);
+	}
+
+	render() {
+		return (
+			<PWInlineInAppView 
+				{...this.props} 
+				onLoaded = {this._onLoaded}
+				onClosed = {this._onClosed}
+				onSizeChanged = {this._onSizeChanged}
+			/>
+		);
+	}
+}
+
+InlineInAppView.propTypes = {
+	/**
+	 * Value of the identifier property must be equal to the 
+	 * identifier attribute value of the in-app message you've 
+	 * created in Pushwoosh Control Panel
+	 */
+	identifier: PropTypes.string,
+	/**
+     * This event is called to notify you that an inline in-app
+     * was loaded and has been added to the view
+     */
+	onLoaded: PropTypes.func,
+	 /**
+     * This event is called to notify you that an inline in-app
+     * view has been closed by the user
+     */
+	onClosed: PropTypes.func,
+	/**
+     * This event is called to notify you that an inline in-app
+     * view size has been changed
+     */
+	onSizeChanged: PropTypes.func,
+};
+
+var PWInlineInAppView = requireNativeComponent('PWInlineInAppView', InlineInAppView)
+
+export default InlineInAppView

package/README.md

@@ -7,116 +7,66 @@ React Native Pushwoosh Push Notifications module
 
 ![platforms](https://img.shields.io/badge/platforms-Android%20%7C%20iOS-yellowgreen.svg)
 
-| [Guide](http://docs.pushwoosh.com/docs/react-native-pushwoosh-push-notifications-module-for-android) | [Documentation](docs/README.md) | [Sample](https://github.com/Pushwoosh/pushwoosh-react-native-sample) |
-| ------------------------------------------------------------- | ---------------------------------------- | ------------------------------------- |
+| [Guide](https://www.pushwoosh.com/platform-docs/pushwoosh-sdk/cross-platform-frameworks/react-native/integrating-react-native-plugin) | [Documentation](docs/README.md) | [Sample](https://github.com/Pushwoosh/pushwoosh-react-native-sample) |
+| ----------------------------------------------------------- | ------------------------------- | -------------------------------------------------------------------- |
 
 
-## Android Setup
-
-### Step 1 - Install plugin
-
+### Installation
 ```
 npm install pushwoosh-react-native-plugin --save
+react-native link pushwoosh-react-native-plugin
 ```
 
-### Step 2 - Include pushwooshplugin library project
-
-In **android/settings.gradle** file, make the following changes:
+For Android platform, also add the following lines to your project's build.gradle:
 
-```gradle
-...
-include ':pushwooshplugin'
-project(':pushwooshplugin').projectDir = new File(rootProject.projectDir, '../node_modules/pushwoosh-react-native-plugin/src/android')
 ```
-
-In **android/app/build.gradle** add pushwooshplugin dependency:
-
-```gradle
-dependencies {
-    ...
-    compile project(':pushwooshplugin')
+//you should already have buildscript and dependencies blocks in your project's build.gradle so just put the classpath line there
+buildscript {
+ dependencies {
+ classpath 'com.google.gms:google-services:4.3.3'
+ }
 }
-```
 
-Optional: To use non-default `play-service-gcm` version (the plugin uses 8.4.0), modify your `android/app/build.gradle` dependencies.
-This might be required in case of conflicts with other react-native plugins.
-```gradle
-...
-
-dependencies {
-    ...
-    compile project(':pushwooshplugin')
-    compile ('com.google.android.gms:play-services-gcm:9.+') {force = true;}
-    compile ('com.google.android.gms:play-services-location:9.+') {force = true;}
+//add these lines to the very end of your build.gradle
+apply {
+ plugin com.google.gms.googleservices.GoogleServicesPlugin
 }
 ```
 
-For RN < v.0.29.0 In **MainActivity.java** add:
-
-```java
-...
-import com.pushwoosh.reactnativeplugin.PushwooshPackage;
-
-public class MainActivity extends ReactActivity {
-
-    ...
-
-    @Override
-    protected List<ReactPackage> getPackages() {
-        return Arrays.<ReactPackage>asList(
-            new MainReactPackage(),
-            new PushwooshPackage() // register Pushwoosh plugin here
-        );
-    }
-}
-```
-For RN >= v.0.29.0 In **MainApplication.java** add:
-
-```java
-...
-import com.pushwoosh.reactnativeplugin.PushwooshPackage;
-
-public class MainApplication extends Application implements ReactApplication {
-    ...
-
-    @Override
-    protected List<ReactPackage> getPackages() {
-        return Arrays.<ReactPackage>asList(
-            new MainReactPackage(),
-            new PushwooshPackage() // register Pushwoosh plugin here
-        );
-    }
-}
-```
-
-### Step 3 - Use module
+### Usage
 
 ```js
-var Pushwoosh = require('pushwoosh-react-native-plugin');
+import Pushwoosh from 'pushwoosh-react-native-plugin';
 
-Pushwoosh.init({ "pw_appid" : "YOUR_PUSHWOOSH_PROJECT_ID" , "project_number" : "YOUR_GCM_PROJECT_NUMBER" });
+Pushwoosh.init({ 
+    "pw_appid" : "YOUR_PUSHWOOSH_PROJECT_ID" , 
+    "project_number" : "YOUR_GCM_PROJECT_NUMBER" 
+});
 Pushwoosh.register();
 ```
 
+In order to use custom notification handling on iOS specify the parameter "pw_notification_handling" to "CUSTOM" when initializing the plugin(If no value specified Pushwoosh notification handler is used):
 
-## iOS Setup
-
-### Step 1 - Install plugin
+```js
+import Pushwoosh from 'pushwoosh-react-native-plugin';
 
+Pushwoosh.init({ 
+    "pw_appid" : "YOUR_PUSHWOOSH_PROJECT_ID" , 
+    "project_number" : "YOUR_GCM_PROJECT_NUMBER",
+    "pw_notification_handling" : "CUSTOM"
+});
+Pushwoosh.register();
 ```
-npm install pushwoosh-react-native-plugin --save
-```
-
-### Step 2 - Include PushwooshPlugin project
-
-Drag the **PushwooshPlugin.xcodeproj** (located in **node_modules/pushwoosh-react-native-plugin/src/ios**) as a dependency project into your React Native XCode project.
-Link your project with **libPushwooshPlugin.a**, **libstdc++** and **libz** libraries.
 
-### Step 3 - Use module
+In order to use reverse proxy to connect to pushwoosh servers specify the parameter "reverse_proxy_url" with the url to your reverse proxy when initializing the plugin:
 
 ```js
-var Pushwoosh = require('pushwoosh-react-native-plugin');
+import Pushwoosh from 'pushwoosh-react-native-plugin';
 
-Pushwoosh.init({ "pw_appid" : "YOUR_PUSHWOOSH_PROJECT_ID" });
+Pushwoosh.init({ 
+    "pw_appid" : "YOUR_PUSHWOOSH_PROJECT_ID" , 
+    "project_number" : "YOUR_GCM_PROJECT_NUMBER",
+    "reverse_proxy_url" : "URL_TO_YOUR_REVERSE_PROXY"
+});
 Pushwoosh.register();
 ```