pushwoosh-react-native-plugin 6.1.52 → 6.1.53

package/README.md

@@ -1,72 +1,340 @@
-React Native Pushwoosh Push Notifications module
-===================================================
+<h1 align="center">Pushwoosh React Native Plugin</h1>
 
-[![GitHub release](https://img.shields.io/github/release/Pushwoosh/pushwoosh-react-native-plugin.svg?style=flat-square)](https://github.com/Pushwoosh/pushwoosh-react-native-plugin/releases) 
-[![npm](https://img.shields.io/npm/v/pushwoosh-react-native-plugin.svg)](https://www.npmjs.com/package/pushwoosh-react-native-plugin)
-[![license](https://img.shields.io/npm/l/pushwoosh-react-native-plugin.svg)](https://www.npmjs.com/package/pushwoosh-react-native-plugin)
+<p align="center">
+  <a href="https://github.com/Pushwoosh/pushwoosh-react-native-plugin/releases"><img src="https://img.shields.io/github/release/Pushwoosh/pushwoosh-react-native-plugin.svg?style=flat-square" alt="GitHub release"></a>
+  <a href="https://www.npmjs.com/package/pushwoosh-react-native-plugin"><img src="https://img.shields.io/npm/v/pushwoosh-react-native-plugin.svg?style=flat-square" alt="npm"></a>
+  <a href="https://www.npmjs.com/package/pushwoosh-react-native-plugin"><img src="https://img.shields.io/npm/l/pushwoosh-react-native-plugin.svg?style=flat-square" alt="license"></a>
+</p>
 
-![platforms](https://img.shields.io/badge/platforms-Android%20%7C%20iOS-yellowgreen.svg)
+<p align="center">
+  Cross-platform push notifications, In-App messaging, and more for React Native applications.
+</p>
 
-| [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) |
-| ----------------------------------------------------------- | ------------------------------- | -------------------------------------------------------------------- |
+## Table of Contents
 
+- [Documentation](#documentation)
+- [Features](#features)
+- [Installation](#installation)
+- [AI-Assisted Integration](#ai-assisted-integration)
+- [Quick Start](#quick-start)
+- [API Reference](#api-reference)
+- [Support](#support)
+- [License](#license)
 
-### Installation
-```
+## Documentation
+
+- [Integration Guide](https://docs.pushwoosh.com/platform-docs/pushwoosh-sdk/cross-platform-frameworks/react-native/integrating-react-native-plugin) — step-by-step setup
+- [API Reference](docs/README.md) — full API documentation
+- [Sample Project](https://github.com/Pushwoosh/pushwoosh-react-native-sample) — ready-to-run demo app
+
+## Features
+
+- **Push Notifications** — register, receive, and handle push notifications on iOS and Android
+- **In-App Messages** — trigger and display in-app messages based on events
+- **Tags & Segmentation** — set and get user tags for targeted messaging
+- **User Identification** — associate devices with user IDs for cross-device tracking
+- **Message Inbox** — built-in UI for message inbox with customization options
+- **Badge Management** — set, get, and increment app icon badge numbers
+- **Local Notifications** — schedule and manage local notifications
+- **Rich Media** — modal and legacy Rich Media presentation styles
+- **Huawei Push** — HMS push notification support
+- **Multi-channel** — email, SMS, and WhatsApp registration
+- **TypeScript Support** — full TypeScript definitions included
+
+## Installation
+
+```bash
 npm install pushwoosh-react-native-plugin --save
-react-native link pushwoosh-react-native-plugin
 ```
 
-For Android platform, also add the following lines to your project's build.gradle:
+### iOS Setup
 
+```bash
+cd ios && pod install
 ```
-//you should already have buildscript and dependencies blocks in your project's build.gradle so just put the classpath line there
+
+### Android Setup
+
+Add to your project's `build.gradle`:
+
+```groovy
 buildscript {
- dependencies {
- classpath 'com.google.gms:google-services:4.3.3'
- }
+    dependencies {
+        classpath 'com.google.gms:google-services:4.3.15'
+    }
 }
+```
 
-//add these lines to the very end of your build.gradle
-apply {
- plugin com.google.gms.googleservices.GoogleServicesPlugin
-}
+## AI-Assisted Integration
+
+Integrate the Pushwoosh React Native plugin using AI coding assistants (Claude Code, Cursor, GitHub Copilot, etc.).
+
+> **Requirement:** Your AI assistant must have access to [Context7](https://context7.com/) MCP server or web search capabilities.
+
+### Quick Start Prompts
+
+Choose the prompt that matches your task:
+
+---
+
+#### 1. Basic Plugin Integration
+
+```
+Integrate Pushwoosh React Native plugin into my React Native project.
+
+Requirements:
+- Install pushwoosh-react-native-plugin via npm
+- Initialize Pushwoosh with my App ID in the app entry point
+- Register for push notifications and handle pushOpened events via DeviceEventEmitter
+
+Use Context7 MCP to fetch Pushwoosh React Native plugin documentation.
+```
+
+---
+
+#### 2. Tags and User Segmentation
+
+```
+Show me how to use Pushwoosh tags in a React Native app for user segmentation.
+I need to set tags, get tags, and set user ID for cross-device tracking.
+
+Use Context7 MCP to fetch Pushwoosh React Native plugin documentation for setTags and getTags.
+```
+
+---
+
+#### 3. Message Inbox Integration
+
+```
+Integrate Pushwoosh Message Inbox into my React Native app. Show me how to:
+- Display the inbox UI with custom styling
+- Load messages programmatically
+- Track unread message count
+
+Use Context7 MCP to fetch Pushwoosh React Native plugin documentation for presentInboxUI.
+```
+
+---
+
+## Quick Start
+
+### 1. Initialize the Plugin
+
+```javascript
+import Pushwoosh from 'pushwoosh-react-native-plugin';
+import { DeviceEventEmitter } from 'react-native';
+
+// Listen for push notification events
+DeviceEventEmitter.addListener('pushOpened', (e) => {
+    console.log("Push opened: " + JSON.stringify(e));
+});
+
+// Initialize Pushwoosh
+Pushwoosh.init({
+    pw_appid: "YOUR_PUSHWOOSH_APP_ID",
+    project_number: "YOUR_FCM_SENDER_ID"
+});
+
+// Register for push notifications
+Pushwoosh.register(
+    (token) => {
+        console.log("Registered with push token: " + token);
+    },
+    (error) => {
+        console.error("Failed to register: " + error);
+    }
+);
 ```
 
-### Usage
+### 2. Set User Tags
 
-```js
+```javascript
 import Pushwoosh from 'pushwoosh-react-native-plugin';
 
-Pushwoosh.init({ 
-    "pw_appid" : "YOUR_PUSHWOOSH_PROJECT_ID" , 
-    "project_number" : "YOUR_GCM_PROJECT_NUMBER" 
+Pushwoosh.setTags(
+    { username: "john_doe", age: 25, interests: ["sports", "tech"] },
+    () => console.log("Tags set successfully"),
+    (error) => console.error("Failed to set tags: " + error)
+);
+
+Pushwoosh.getTags(
+    (tags) => console.log("Tags: " + JSON.stringify(tags)),
+    (error) => console.error("Get tags error: " + error)
+);
+```
+
+### 3. Post Events for In-App Messages
+
+```javascript
+import Pushwoosh from 'pushwoosh-react-native-plugin';
+
+Pushwoosh.setUserId("user_12345");
+Pushwoosh.postEvent("purchase_complete", {
+    productName: "Premium Plan",
+    amount: "9.99"
 });
-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):
+### 4. Message Inbox
 
-```js
+```javascript
 import Pushwoosh from 'pushwoosh-react-native-plugin';
+import { processColor, Image } from 'react-native';
+
+// Open inbox UI with custom styling
+Pushwoosh.presentInboxUI({
+    dateFormat: "dd.MM.yyyy",
+    accentColor: processColor('#3498db'),
+    backgroundColor: processColor('#ffffff'),
+    titleColor: processColor('#333333'),
+    descriptionColor: processColor('#666666'),
+    listEmptyMessage: "No messages yet"
+});
+
+// Or load messages programmatically
+Pushwoosh.loadMessages(
+    (messages) => {
+        messages.forEach((msg) => {
+            console.log(msg.title + ": " + msg.message);
+        });
+    },
+    (error) => console.error("Failed to load: " + error)
+);
 
-Pushwoosh.init({ 
-    "pw_appid" : "YOUR_PUSHWOOSH_PROJECT_ID" , 
-    "project_number" : "YOUR_GCM_PROJECT_NUMBER",
-    "pw_notification_handling" : "CUSTOM"
+Pushwoosh.unreadMessagesCount((count) => {
+    console.log("Unread messages: " + count);
 });
-Pushwoosh.register();
 ```
 
-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:
+### 5. Multi-channel Communication
 
-```js
+```javascript
 import Pushwoosh from 'pushwoosh-react-native-plugin';
 
-Pushwoosh.init({ 
-    "pw_appid" : "YOUR_PUSHWOOSH_PROJECT_ID" , 
-    "project_number" : "YOUR_GCM_PROJECT_NUMBER",
-    "reverse_proxy_url" : "URL_TO_YOUR_REVERSE_PROXY"
+Pushwoosh.setEmails(
+    ["user@example.com"],
+    () => console.log("Email set"),
+    (error) => console.error(error)
+);
+
+Pushwoosh.registerSMSNumber("+1234567890");
+Pushwoosh.registerWhatsappNumber("+1234567890");
+```
+
+### 6. Custom Notification Handling (iOS)
+
+```javascript
+import Pushwoosh from 'pushwoosh-react-native-plugin';
+
+Pushwoosh.init({
+    pw_appid: "YOUR_PUSHWOOSH_APP_ID",
+    project_number: "YOUR_FCM_SENDER_ID",
+    pw_notification_handling: "CUSTOM"
 });
-Pushwoosh.register();
 ```
+
+## API Reference
+
+### Initialization & Registration
+
+| Method | Description |
+|--------|-------------|
+| `init(config, success?, fail?)` | Initialize the plugin. Call on every app launch |
+| `register(success?, fail?)` | Register for push notifications |
+| `unregister(success?, fail?)` | Unregister from push notifications |
+| `getPushToken(success)` | Get the push token |
+| `getHwid(success)` | Get Pushwoosh Hardware ID |
+| `getUserId(success)` | Get current user ID |
+
+### Tags & User Data
+
+| Method | Description |
+|--------|-------------|
+| `setTags(tags, success?, fail?)` | Set device tags |
+| `getTags(success, fail?)` | Get device tags |
+| `setUserId(userId, success?, fail?)` | Set user identifier for cross-device tracking |
+| `setLanguage(language)` | Set custom language for localized pushes |
+| `setEmails(emails, success?, fail?)` | Register emails for the user |
+| `setUserEmails(userId, emails, success?, fail?)` | Set user ID and register emails |
+| `registerSMSNumber(phoneNumber)` | Register SMS number (E.164 format) |
+| `registerWhatsappNumber(phoneNumber)` | Register WhatsApp number (E.164 format) |
+
+### Notifications
+
+| Method | Description |
+|--------|-------------|
+| `createLocalNotification(config)` | Schedule a local notification |
+| `clearLocalNotification()` | Clear all pending local notifications |
+| `clearNotificationCenter()` | Clear all notifications from notification center |
+
+### Badge Management
+
+| Method | Description |
+|--------|-------------|
+| `setApplicationIconBadgeNumber(badge)` | Set badge number |
+| `getApplicationIconBadgeNumber(callback)` | Get current badge number |
+| `addToApplicationIconBadgeNumber(badge)` | Increment/decrement badge |
+
+### In-App Messages & Events
+
+| Method | Description |
+|--------|-------------|
+| `postEvent(event, attributes?)` | Post event to trigger In-App Messages |
+| `setRichMediaType(type)` | Set Rich Media style (MODAL or LEGACY) |
+| `getRichMediaType(callback)` | Get current Rich Media style |
+
+### Message Inbox
+
+| Method | Description |
+|--------|-------------|
+| `presentInboxUI(style?)` | Open inbox UI with optional style customization |
+| `loadMessages(success, fail?)` | Load inbox messages programmatically |
+| `unreadMessagesCount(callback)` | Get unread message count |
+| `messagesCount(callback)` | Get total message count |
+| `messagesWithNoActionPerformedCount(callback)` | Get messages with no action count |
+| `readMessage(id)` | Mark message as read |
+| `readMessages(ids)` | Mark multiple messages as read |
+| `deleteMessage(id)` | Delete a message |
+| `deleteMessages(ids)` | Delete multiple messages |
+| `performAction(id)` | Perform the action associated with a message |
+
+### Android-specific
+
+| Method | Description |
+|--------|-------------|
+| `setMultiNotificationMode(on)` | Allow multiple notifications in notification center |
+| `setLightScreenOnNotification(on)` | Turn screen on when notification arrives |
+| `setEnableLED(on)` | Enable LED blinking on notification |
+| `setColorLED(color)` | Set LED color (ARGB integer) |
+| `setSoundType(type)` | Set sound type (0=default, 1=none, 2=always) |
+| `setVibrateType(type)` | Set vibration type (0=default, 1=none, 2=always) |
+| `setNotificationIconBackgroundColor(color)` | Set notification icon background color |
+| `enableHuaweiPushNotifications()` | Enable Huawei HMS push support |
+
+### Communication Control
+
+| Method | Description |
+|--------|-------------|
+| `setCommunicationEnabled(enable, success?, fail?)` | Enable/disable all Pushwoosh communication |
+| `isCommunicationEnabled(success)` | Check if communication is enabled |
+
+### Events (DeviceEventEmitter)
+
+| Event | Description |
+|-------|-------------|
+| `pushOpened` | Fired when a notification is opened by the user |
+| `pushReceived` | Fired when a notification is received |
+
+## Support
+
+- [Documentation](https://docs.pushwoosh.com/)
+- [Support Portal](https://support.pushwoosh.com/)
+- [Report Issues](https://github.com/Pushwoosh/pushwoosh-react-native-plugin/issues)
+
+## License
+
+Pushwoosh React Native Plugin is available under the MIT license. See [LICENSE](LICENSE) for details.
+
+---
+
+Made with ❤️ by [Pushwoosh](https://www.pushwoosh.com/)

package/index.js

@@ -1,5 +1,187 @@
 'use strict';
 
+/**
+ * @fileoverview Pushwoosh React Native Plugin - Integration Guide
+ *
+ * @description
+ * Pushwoosh is a customer engagement platform for push notifications, in-app messages,
+ * emails, SMS, and WhatsApp. This React Native plugin wraps native iOS and Android
+ * Pushwoosh SDKs and provides a JavaScript bridge for hybrid mobile applications.
+ *
+ * @section Installation
+ *
+ * ```bash
+ * npm install pushwoosh-react-native-plugin --save
+ * cd ios && pod install
+ * ```
+ *
+ * @section Quick Start
+ *
+ * Step 1: Initialize the plugin and register for push notifications
+ *
+ * ```javascript
+ * import Pushwoosh from 'pushwoosh-react-native-plugin';
+ * import { DeviceEventEmitter } from 'react-native';
+ *
+ * // Listen for push notification events
+ * DeviceEventEmitter.addListener('pushOpened', (e) => {
+ *     console.log("Push opened: " + JSON.stringify(e));
+ * });
+ *
+ * // Initialize Pushwoosh
+ * Pushwoosh.init({
+ *     pw_appid: "XXXXX-XXXXX",
+ *     project_number: "YOUR_FCM_SENDER_ID"
+ * });
+ *
+ * // Register for push notifications
+ * Pushwoosh.register(
+ *     (token) => {
+ *         console.log("Registered with push token: " + token);
+ *     },
+ *     (error) => {
+ *         console.error("Failed to register: " + error);
+ *     }
+ * );
+ * ```
+ *
+ * @section Common Use Cases
+ *
+ * User identification and cross-device tracking:
+ *
+ * ```javascript
+ * import Pushwoosh from 'pushwoosh-react-native-plugin';
+ *
+ * // After user login
+ * Pushwoosh.setUserId("user_12345");
+ * Pushwoosh.setEmails(["user@example.com"]);
+ * ```
+ *
+ * User segmentation with tags:
+ *
+ * ```javascript
+ * import Pushwoosh from 'pushwoosh-react-native-plugin';
+ *
+ * Pushwoosh.setTags(
+ *     { subscription: "premium", age: 25, interests: ["sports", "music"] },
+ *     () => console.log("Tags set successfully"),
+ *     (error) => console.error("Failed to set tags: " + error)
+ * );
+ *
+ * Pushwoosh.getTags(
+ *     (tags) => console.log("Tags: " + JSON.stringify(tags)),
+ *     (error) => console.error("Get tags error: " + error)
+ * );
+ * ```
+ *
+ * Trigger In-App Messages with events:
+ *
+ * ```javascript
+ * import Pushwoosh from 'pushwoosh-react-native-plugin';
+ *
+ * Pushwoosh.setUserId("user_12345");
+ * Pushwoosh.postEvent("purchase_complete", {
+ *     productName: "Premium Plan",
+ *     amount: "9.99"
+ * });
+ * ```
+ *
+ * Schedule a local notification:
+ *
+ * ```javascript
+ * import Pushwoosh from 'pushwoosh-react-native-plugin';
+ *
+ * Pushwoosh.createLocalNotification({
+ *     msg: "Your order is ready!",
+ *     seconds: 60,
+ *     userData: { orderId: "12345" }
+ * });
+ * ```
+ *
+ * Message Inbox with custom styling:
+ *
+ * ```javascript
+ * import Pushwoosh from 'pushwoosh-react-native-plugin';
+ * import { processColor } from 'react-native';
+ *
+ * Pushwoosh.presentInboxUI({
+ *     dateFormat: "dd.MM.yyyy",
+ *     accentColor: processColor('#3498db'),
+ *     backgroundColor: processColor('#ffffff'),
+ *     titleColor: processColor('#333333'),
+ *     descriptionColor: processColor('#666666'),
+ *     listEmptyMessage: "No messages yet"
+ * });
+ *
+ * // Or load messages programmatically
+ * Pushwoosh.loadMessages(
+ *     (messages) => {
+ *         messages.forEach((msg) => {
+ *             console.log(msg.title + ": " + msg.message);
+ *         });
+ *     },
+ *     (error) => console.error("Failed to load: " + error)
+ * );
+ *
+ * Pushwoosh.unreadMessagesCount((count) => {
+ *     console.log("Unread messages: " + count);
+ * });
+ * ```
+ *
+ * Multi-channel communication:
+ *
+ * ```javascript
+ * import Pushwoosh from 'pushwoosh-react-native-plugin';
+ *
+ * Pushwoosh.setEmails(["user@example.com"]);
+ * Pushwoosh.registerSMSNumber("+1234567890");
+ * Pushwoosh.registerWhatsappNumber("+1234567890");
+ * ```
+ *
+ * Enable/disable Pushwoosh communication (e.g. for GDPR):
+ *
+ * ```javascript
+ * import Pushwoosh from 'pushwoosh-react-native-plugin';
+ *
+ * // User opted out
+ * Pushwoosh.setCommunicationEnabled(false);
+ *
+ * // User opted in
+ * Pushwoosh.setCommunicationEnabled(true);
+ *
+ * // Check current status
+ * Pushwoosh.isCommunicationEnabled((enabled) => {
+ *     console.log("Communication enabled: " + enabled);
+ * });
+ * ```
+ *
+ * Custom notification handling on iOS:
+ *
+ * ```javascript
+ * import Pushwoosh from 'pushwoosh-react-native-plugin';
+ *
+ * Pushwoosh.init({
+ *     pw_appid: "XXXXX-XXXXX",
+ *     project_number: "YOUR_FCM_SENDER_ID",
+ *     pw_notification_handling: "CUSTOM"
+ * });
+ * ```
+ *
+ * @section Configuration Parameters
+ *
+ * - pw_appid (required) - Pushwoosh Application ID from Control Panel
+ * - project_number (required for Android) - FCM Sender ID
+ * - pw_notification_handling (optional, iOS) - Set to "CUSTOM" for custom notification handling
+ * - reverse_proxy_url (optional) - URL to reverse proxy for Pushwoosh server communication
+ *
+ * @section Events (DeviceEventEmitter)
+ *
+ * - "pushOpened" - Fired when a notification is opened by the user.
+ * - "pushReceived" - Fired when a notification is received.
+ *
+ * @module pushwoosh-react-native-plugin
+ */
+
 import { NativeModules } from 'react-native';
 
 const PushwooshModule = NativeModules.Pushwoosh;
@@ -20,29 +202,12 @@ const RichMediaStyle = {
 	LEGACY: 1
 };
 
-//Class: PushNotification
-//Use `PushNotification` to register device for push notifications on Pushwoosh and customize notification appearance.
-//
-//Example:
-//(start code)
-//DeviceEventEmitter.addListener('pushOpened', (e: Event) => {
-//  console.warn("pushOpened: " + JSON.stringify(e));
-//  alert(JSON.stringify(e));
-//});
-//
-//const Pushwoosh = require('pushwoosh-react-native-plugin');
-//
-//Pushwoosh.init({ "pw_appid" : "XXXX-XXXX", "project_number" : "XXXXXXXXXXXXX", "reverse_proxy_url" : "your_url_proxy" });
-//
-//Pushwoosh.register(
-//  (token) => {
-//    console.warn("Registered for pushes: " + token);
-//  },
-//  (error) => {
-//    console.warn("Failed to register: " + error);
-//  }
-//);
-//(end)
+/**
+ * PushNotification class provides the JavaScript API for interacting with the Pushwoosh SDK.
+ * Import it via: `import Pushwoosh from 'pushwoosh-react-native-plugin';`
+ *
+ * @class PushNotification
+ */
 class PushNotification {
 
 	//Function: init

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pushwoosh-react-native-plugin",
-  "version": "6.1.52",
+  "version": "6.1.53",
   "description": "This plugin allows you to send and receive push notifications. Powered by Pushwoosh (www.pushwoosh.com).",
   "main": "index.js",
   "types": "index.d.ts",

package/pushwoosh-react-native-plugin.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "pushwoosh-react-native-plugin"
-  s.version          = "6.1.52"
+  s.version          = "6.1.53"
   s.summary          = "React Native Pushwoosh Push Notifications module"
   s.requires_arc = true
   s.author       = 'Pushwoosh'
@@ -15,6 +15,6 @@ Pod::Spec.new do |s|
   s.static_framework = true
 
   s.dependency 'React'
-  s.dependency 'PushwooshXCFramework', '7.0.21'
+  s.dependency 'PushwooshXCFramework', '7.0.22'
   s.dependency 'PushwooshInboxUIXCFramework'
 end