@oracle/react-native-pushiomanager - npm Package Compare versions

Comparing version 6.53.0 to 6.56.3

CONTRIBUTING.md

@@ -1,18 +0,55 @@
-# Contributing
+# Contributing to this repository
 
-We welcome your contributions! There are multiple ways to contribute. To get started, you will need to sign the [Oracle Contributor Agreement](https://oca.opensource.oracle.com/) (OCA).
+We welcome your contributions! There are multiple ways to contribute.
 
+## Opening issues
 
-## Issues
+For bugs or enhancement requests, please file a GitHub issue unless it's
+security related. When filing a bug remember that the better written the bug is,
+the more likely it is to be fixed. If you think you've found a security
+vulnerability, do not raise a GitHub issue and follow the instructions in our
+[security policy](./SECURITY.md).
 
-For bugs or enhancement requests, please file a GitHub issue unless it's security related. When filing a bug remember that the better written the bug is, the more likely it is to be fixed. If you think you've found a security vulnerability, do not raise a GitHub issue and follow the instructions on our [Security Policy](./SECURITY.md). 
+## Contributing code
 
+We welcome your code contributions. Before submitting code via a pull request,
+you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
+your commits need to include the following line using the name and e-mail
+address you used to sign the OCA:
 
-## Contributing Code
+```text
+Signed-off-by: Your Name <[e-mail]>
+```
 
-We are not currently accepting code contributions but plan to do so soon. If you are interested in contributing code, please raise an issue for now.
+This can be automatically added to pull requests by committing with `--sign-off`
+or `-s`, e.g.
 
+```text
+git commit --signoff
+```
 
-## Code of Conduct
+Only pull requests from committers that can be verified as having signed the OCA
+can be accepted.
 
-Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). More specific guidelines are in the [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md)
+## Pull request process
+
+1. Ensure there is an issue created to track and discuss the fix or enhancement
+   you intend to submit.
+1. Fork this repository.
+1. Create a branch in your fork to implement the changes. We recommend using
+   the issue number as part of your branch name, e.g. `1234-fixes`.
+1. Ensure that any documentation is updated with the changes that are required
+   by your change.
+1. Ensure that any samples are updated if the base image has been changed.
+1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
+   what your changes are meant to do and provide simple steps on how to validate.
+   your changes. Ensure that you reference the issue you created as well.
+1. We will assign the pull request to 2-3 people for review before it is merged.
+
+## Code of conduct
+
+Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
+like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
+
+[OCA]: https://oca.opensource.oracle.com
+[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

index.js

 /*
-* Copyright © 2022, Oracle and/or its affiliates. All rights reserved.
+* Copyright © 2024, Oracle and/or its affiliates. All rights reserved.
 *
@@ -175,3 +175,24 @@ * Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
 
+
     /**
+    * Registers this app installation with Responsys.
+    * 
+    * @param {boolean} enablePushNotification Whether to enable push notifications. Passing `true` will show the default system push notification permission dialog prompt.
+    * (Not available on iOS platform.)
+    * @param {boolean} useLocation Whether to send location data along with the registration request. Passing `true` will show the default system location permission dialog prompt.
+    * (User location is not available on iOS platform.)
+    * @param {callback} callback callback with boolean value TRUE if register event created and stored successfully, FALSE otherwise.
+    * @see {@tutorial Config}
+    */
+
+
+    static registerApp(enablePushNotification, useLocation, callback) {
+        if (Platform.OS === 'android') {
+            RCTPushIOManager.registerApp(enablePushNotification, useLocation, callback);
+        } else {
+            RCTPushIOManager.registerApp(callback);
+        }
+    }
+
+    /**
      * Unregister this app installation with Responsys. This will prevent the app from receiving push notifications.
@@ -1193,2 +1214,16 @@ * @see {@tutorial Config}
     }
+
+    /**
+     * customise in-app view close button with title, background color, title color and image.
+     *
+     */
+
+    static setInAppCustomCloseButton(closebutton) {
+        if (Platform.OS === 'ios') {
+            RCTPushIOManager.setInAppCustomCloseButton(closebutton)
+        }  else {
+            console.log("API not supported");
+        }
+    }
+
 }

iOS.Example.md

@@ -31,3 +31,3 @@ # Example React Native iOS Implementation for Responsys SDK
 
-Place the [latest iOS `PushIOManager.framework`](https://www.oracle.com/downloads/applications/cx/responsys-mobile-sdk.html) inside `ios/framework`
+Place the [latest iOS `PushIOManager.xcframework`](https://www.oracle.com/downloads/applications/cx/responsys-mobile-sdk.html) inside `ios/framework`
 
@@ -34,0 +34,0 @@ After above these steps your framework directory should look like this.

LICENSE.txt

@@ -1,2 +0,2 @@
-Copyright (c) 2022 Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2024 Oracle and/or its affiliates. All rights reserved.
 
@@ -3,0 +3,0 @@ The Universal Permissive License (UPL), Version 1.0

package.json

 {
   "name": "@oracle/react-native-pushiomanager",
-  "version": "6.53.0",
+  "version": "6.56.3",
   "description": "React Native Module for Responsys Mobile SDK",
@@ -24,6 +24,5 @@ "main": "index.js",
     "Neerhaj N Joshi <[e-mail]>",
-    "Sahil Wasan <[e-mail]>",
     "Poorna Rai <[e-mail]>",
-    "Lalitha R <[e-mail]>",
-    "Savitha Rudramuni <[e-mail]>"
+    "Savitha Rudramuni <[e-mail]>",
+    "Pallavi Krishnaiah Hebbar <[e-mail]>"
   ],
@@ -30,0 +29,0 @@ "licenseFilename": "LICENSE",

README.md

@@ -27,4 +27,5 @@ # React Native Module for Responsys SDK
   * [Changing Notification Icon and Color (Android Only)](#changing-notification-icon-and-color-android-only)
-  * [Handling Push Notifications (Android Only)](#handling-push-notifications-android-only)
+  * [Handling Push Notifications (Android Only)](https://github.com/oracle/pushiomanager-react-native/wiki/Android:-Handling-Push-Notifications-In-App-Background-or-Killed-State)
   * [Handling Deeplinks](#handling-deeplinks)
+  * [Reporting Revenue/Purchase Events](#reporting-revenuepurchase-events)
 - [Upgrades](#upgrades)
@@ -62,3 +63,3 @@ * [6.52.1](#6521)
 - Download the `pushio_config.json` file generated from your credentials.
-- ***Important:*** Copy  `PushIOManager.framework` and place it in `YOUR_APP_DIR/ios/framework/` folder **before adding plugin to project**. 
+- ***Important:*** Copy  `PushIOManager.xcframework` and place it in `YOUR_APP_DIR/ios/framework/` folder **before adding plugin to project**. 
 
@@ -82,3 +83,3 @@
 	configurations.maybeCreate("default")
-	artifacts.add("default", file('PushIOManager-6.52.1.aar'))
+	artifacts.add("default", file('PushIOManager-6.56.3.aar'))
 	```		
@@ -102,3 +103,3 @@
     
-***Note:*** This step will fail if `PushIOManager.framework` is not available in `YOUR_APP_DIR/ios/framework/` folder **before adding plugin to project with `npm` or `yarn`**. Copy the `PushIOManager.framework` to `YOUR_APP_DIR/ios/framework/` and perform `Installation` step again.
+***Note:*** This step will fail if `PushIOManager.xcframework` is not available in `YOUR_APP_DIR/ios/framework/` folder **before adding plugin to project with `npm` or `yarn`**. Copy the `PushIOManager.xcframework` to `YOUR_APP_DIR/ios/framework/` and perform `Installation` step again.
 
@@ -288,3 +289,3 @@
 	if (Platform.OS === 'android') {
-		PushIOManager.registerApp(true, (error, response) => {
+		PushIOManager.registerApp(true, true, (error, response) => {
                 
@@ -362,18 +363,16 @@ });
 - Get the Message Center messages list using,
-```
+
 Each Message Center message now supports an additional property called custom key-value pairs, it is a variable sized object with key value pairs and can be accessed like any other property of that message.
 
-```
 
 	```javascript
 	PushIOManager.fetchMessagesForMessageCenter(messageCenterName, (error, response) => {
-        if(error == null) {
-            for(message of response.messages){
-                console.log(message.messageID)
-                console.log(message.message)
-                console.log(message.customKeyValuePairs)
+	        if(error == null) {
+	            for(message of response.messages){
+	                console.log(message.messageID)
+	                console.log(message.message)
+	                console.log(message.customKeyValuePairs)
             
-            }
-        }
-	
+	            }
+	        }
 	});
@@ -402,3 +401,2 @@ ```
 }
-
 componentWillUnmount() {
@@ -679,4 +677,31 @@ if (this.messageCenterListener) {
 
+### Reporting Revenue/Purchase Events
+
+Responsys plugin version 6.48.0 and above supports reporting Revenue/Purchase events. These events attribute purchases to the push campaign that led the app user into the mobile app. This API accepts an event object which allows In-App Purchase (Digital Goods) or Retail Purchase (Physical Goods) conversion-type to be reported.
+
+```javascript
+var event = {};
+event['orderId'] = '1234';
+event['orderTotal'] = 50;
+event['orderQuantity'] = 5;
+event['conversionType'] = 3; // Possible values: 3 = In-App Purchase, 7 = Retail Purchase
+event['customProperties'] = {}; // optional
+
+PushIOManager.trackConversionEvent(event, (error, response) => {
+
+});
+```
+
+
 ## Upgrades
 
+### 6.56.3
+
+#### For Android
+
+With this release, we have made changes to our [Multiple SDK](https://docs.oracle.com/en/cloud/saas/marketing/responsys-develop-mobile/react/react-multiple-sdk.htm) guide after reports of duplicate notifications displayed due to a bug in `@react-native-firebase/messaging` plugin.
+
+Make sure you review the updated guide as you upgrade the app to v6.56.3. 
+
+
 ### 6.52.1
@@ -718,3 +743,3 @@
 - Create a `framework` directory inside `YOUR_APP_DIR/ios/` directory.
-- Copy the latest PushIOManager.framework inside `YOUR_APP_DIR/ios/framework/`
+- Copy the latest PushIOManager.xcframework inside `YOUR_APP_DIR/ios/framework/`
 - Install the latest plugin `yarn add @oracle/react-native-pushiomanager`
@@ -727,7 +752,14 @@
 
+## Contributing
 
+This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
+
+## Security
+
+Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
+
 ## License
 
-Copyright (c) 2022 Oracle and/or its affiliates and released under the Universal Permissive License (UPL), Version 1.0.
+Copyright (c) 2024 Oracle and/or its affiliates and released under the Universal Permissive License (UPL), Version 1.0.
 
 Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

SECURITY.md

@@ -1,17 +0,38 @@
-# Reporting Security Vulnerabilities
+# Reporting security vulnerabilities
 
-Oracle values the independent security research community and believes that responsible disclosure of security vulnerabilities helps us ensure the security and privacy of all our users.
+Oracle values the independent security research community and believes that
+responsible disclosure of security vulnerabilities helps us ensure the security
+and privacy of all our users.
 
-Please do NOT raise a GitHub Issue to report a security vulnerability. If you believe you have found a security vulnerability, please submit a report to [e-mail] preferably with a proof of concept. We provide additional information on [how to report security vulnerabilities to Oracle](https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html) which includes public encryption keys for secure email.
+Please do NOT raise a GitHub Issue to report a security vulnerability. If you
+believe you have found a security vulnerability, please submit a report to
+[[e-mail]][1] preferably with a proof of concept. Please review
+some additional information on [how to report security vulnerabilities to Oracle][2].
+We encourage people who contact Oracle Security to use email encryption using
+[our encryption key][3].
 
-We ask that you do not use other channels or contact project contributors directly. 
+We ask that you do not use other channels or contact the project maintainers
+directly.
 
-Non-vulnerability related security issues such as new great new ideas for security features are welcome on GitHub Issues. 
+Non-vulnerability related security issues including ideas for new or improved
+security features are welcome on GitHub Issues.
 
-## Security Updates, Alerts and Bulletins
+## Security updates, alerts and bulletins
 
-Security updates will be released on a regular cadence. Many of our projects will typically release security fixes in conjunction with the [Oracle Critical Patch Update](https://www.oracle.com/security-alerts/) program. Security updates are released on the Tuesday closest to the 17th day of January, April, July and October. A pre-release announcement will be published on the Thursday preceding each release. Additional information, including past advisories, is available on our [Security Alerts](https://www.oracle.com/security-alerts/) page.
+Security updates will be released on a regular cadence. Many of our projects
+will typically release security fixes in conjunction with the
+Oracle Critical Patch Update program. Additional
+information, including past advisories, is available on our [security alerts][4]
+page.
 
-## Security-Related Information
+## Security-related information
 
-We will provide security related information such as a threat model, considerations for secure use, or any known security issues in our documentation. Please note that labs and sample code are intended to demonstrate a concept and may not be sufficiently hardened for production use.
+We will provide security related information such as a threat model, considerations
+for secure use, or any known security issues in our documentation. Please note
+that labs and sample code are intended to demonstrate a concept and may not be
+sufficiently hardened for production use.
+
+[1]: mailto:[e-mail]
+[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
+[3]: https://www.oracle.com/security-alerts/encryptionkey.html
+[4]: https://www.oracle.com/security-alerts/

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 8 instances in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1310714

increased by2.07%

Number of package files

54

increased by38.46%

Lines of code

1055

increased by2.93%

Number of lines in readme file

756

increased by4.42%

Worsened metrics

Number of medium supply chain risk alerts

8

increased byInfinity%

No dependency changes