clevertap-react-native 3.1.1 → 3.3.0

package/CHANGELOG.md

@@ -1,6 +1,49 @@
 Change Log
 ==========
 
+Version 3.3.0 *(17 March 2025)*
+-------------------------------------------
+Refer to the [troubleshoot guide](docs/install.md#troubleshooting) if you encounter any errors while upgrading to this version.
+
+**What's new**
+
+* **[Android Platform]**
+  * Supports [CleverTap Android SDK v7.2.2](https://github.com/CleverTap/clevertap-android-sdk/blob/master/docs/CTCORECHANGELOG.md#version-722-january-21-2025).
+  * Adds support for Android 15, making it compliant with Android 15 requirements. Details [here](https://developer.android.com/about/versions/15/summary).
+  * Upgrades the algorithm used for encryption of PII data, making it compliant with [OWASP](https://mas.owasp.org/MASTG/0x04g-Testing-Cryptography/). Uses `AndroidKeyStore` for securely backing up encryption key on API levels 23+.
+  * Updates `minSdkVersion` to API 21 (Android 5.0).
+
+Version 3.2.0 *(5 February 2025)*
+-------------------------------------------
+**What's new**
+
+* **[Android Platform]**
+  * Supports [CleverTap Android SDK v7.1.2](https://github.com/CleverTap/clevertap-android-sdk/blob/develop/docs/CTCORECHANGELOG.md#version-712-january-29-2025).
+  * Adds support to hide large icon in android notifications by sending `wzrk_hide_large_icon` key in notification payload.
+  
+* **[iOS Platform]**
+  * Supports [CleverTap iOS SDK v7.1.0](https://github.com/CleverTap/clevertap-ios-sdk/blob/master/CHANGELOG.md#version-710-january-21-2024).
+
+* **[Android and iOS Platform]**
+- Adds support for triggering InApps based on first-time event filtering in multiple triggers. Now you can create campaign triggers that combine recurring and first-time events. For example: Trigger a campaign when "Charged" occurs (every time) OR "App Launched" occurs (first time only).
+- Adds new user-level event log tracking system to store and manage user event history. New APIs include:
+  - `getUserEventLog(<eventName>)`: Get details about a specific event
+  - `getUserEventLogCount(<eventName>)`: Get count of times an event occurred
+  - `getUserLastVisitTs()`: Get timestamp of user's last app visit
+  - `getUserAppLaunchCount()`: Get total number of times user has launched the app
+  - `getUserEventLogHistory()`: Get full event history for current user
+
+#### API Changes
+
+- **Deprecates:**  The old event tracking APIs tracked events at the device level rather than the user level, making it difficult to maintain accurate user-specific event histories, especially in multi-user scenarios. The following methods have been deprecated in favor of new user-specific event tracking APIs that provide more accurate, user-level analytics. These deprecated methods will be removed in future versions with prior notice:
+  - `eventGetDetail()`: Use `getUserEventLog()` instead for user-specific event details
+  - `eventGetOccurrences()`: Use `getUserEventLogCount()` instead for user-specific event counts
+  - `eventGetFirstTime()`: Use `getUserEventLog()` instead for user-specific first occurrence timestamp
+  - `eventGetLastTime()`: Use `getUserEventLog()` instead for user-specific last occurrence timestamp
+  - `sessionGetPreviousVisitTime()`: Use `getUserLastVisitTs()` instead for user-specific last visit timestamp
+  - `sessionGetTotalVisits()`: Use `getUserAppLaunchCount()` instead for user-specific app launch count
+  - `getEventHistory()`: Use `getUserEventLogHistory()` instead for user-specific event history
+
 Version 3.1.1 *(6 November 2024)*
 -------------------------------------------
 **Bug Fixes**

package/README.md

@@ -22,8 +22,8 @@ To get started, sign up [here](https://clevertap.com/live-product-demo/).
 3. Follow the [integration instructions](./docs/integration.md)
 
 ## 📚 Additional Resources
-- [CleverTap iOS SDK Integration guide](https://support.clevertap.com/docs/ios/getting-started.html)
-- [CleverTap Android SDK Integration guide](https://support.clevertap.com/docs/android/getting-started.html)
+- [CleverTap iOS SDK Integration guide](https://developer.clevertap.com/docs/ios)
+- [CleverTap Android SDK Integration guide](https://developer.clevertap.com/docs/android)
 
 ## 📲 CleverTap iOS Push Templates SDK
 

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -0,0 +1,2 @@
+#Tue Mar 05 15:27:26 IST 2024
+gradle.version=8.2

package/android/.gradle/config.properties

@@ -0,0 +1,2 @@
+#Mon Sep 02 11:39:00 IST 2024
+java.home=/Applications/Android Studio.app/Contents/jbr/Contents/Home

package/android/.settings/org.eclipse.buildship.core.prefs

@@ -0,0 +1,2 @@
+connection.project.dir=../../../android
+eclipse.preferences.version=1

package/android/build/generated/source/buildConfig/debug/com/clevertap/react/BuildConfig.java

@@ -0,0 +1,12 @@
+/**
+ * Automatically generated file. DO NOT MODIFY
+ */
+package com.clevertap.react;
+
+public final class BuildConfig {
+  public static final boolean DEBUG = Boolean.parseBoolean("true");
+  public static final String LIBRARY_PACKAGE_NAME = "com.clevertap.react";
+  public static final String BUILD_TYPE = "debug";
+  // Field from default config.
+  public static final boolean IS_NEW_ARCHITECTURE_ENABLED = true;
+}

package/android/build/generated/source/codegen/java/com/clevertap/react/NativeCleverTapModuleSpec.java

@@ -0,0 +1,556 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GenerateModuleJavaSpec.js
+ *
+ * @nolint
+ */
+
+package com.clevertap.react;
+
+import com.facebook.proguard.annotations.DoNotStrip;
+import com.facebook.react.bridge.Callback;
+import com.facebook.react.bridge.Promise;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactContextBaseJavaModule;
+import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.ReadableArray;
+import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.common.build.ReactBuildConfig;
+import com.facebook.react.turbomodule.core.interfaces.TurboModule;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+public abstract class NativeCleverTapModuleSpec extends ReactContextBaseJavaModule implements TurboModule {
+  public static final String NAME = "CleverTapReact";
+
+  public NativeCleverTapModuleSpec(ReactApplicationContext reactContext) {
+    super(reactContext);
+  }
+
+  @Override
+  public @Nonnull String getName() {
+    return NAME;
+  }
+
+  protected abstract Map<String, Object> getTypedExportedConstants();
+
+  @Override
+  @DoNotStrip
+  public final @Nullable Map<String, Object> getConstants() {
+    Map<String, Object> constants = getTypedExportedConstants();
+    if (ReactBuildConfig.DEBUG || ReactBuildConfig.IS_INTERNAL_BUILD) {
+      Set<String> obligatoryFlowConstants = new HashSet<>(Arrays.asList(
+          "BPS",
+          "CleverTapCustomFunctionPresent",
+          "CleverTapCustomTemplateClose",
+          "CleverTapCustomTemplatePresent",
+          "CleverTapDisplayUnitsLoaded",
+          "CleverTapFeatureFlagsDidUpdate",
+          "CleverTapInAppNotificationButtonTapped",
+          "CleverTapInAppNotificationDismissed",
+          "CleverTapInAppNotificationShowed",
+          "CleverTapInboxDidInitialize",
+          "CleverTapInboxMessageButtonTapped",
+          "CleverTapInboxMessageTapped",
+          "CleverTapInboxMessagesDidUpdate",
+          "CleverTapOnFileValueChanged",
+          "CleverTapOnOneTimeVariablesChanged",
+          "CleverTapOnValueChanged",
+          "CleverTapOnVariablesChanged",
+          "CleverTapOnVariablesChangedAndNoDownloadsPending",
+          "CleverTapOnceVariablesChangedAndNoDownloadsPending",
+          "CleverTapProductConfigDidActivate",
+          "CleverTapProductConfigDidFetch",
+          "CleverTapProductConfigDidInitialize",
+          "CleverTapProfileDidInitialize",
+          "CleverTapProfileSync",
+          "CleverTapPushNotificationClicked",
+          "CleverTapPushPermissionResponseReceived",
+          "FCM",
+          "HPS"
+      ));
+      Set<String> optionalFlowConstants = new HashSet<>();
+      Set<String> undeclaredConstants = new HashSet<>(constants.keySet());
+      undeclaredConstants.removeAll(obligatoryFlowConstants);
+      undeclaredConstants.removeAll(optionalFlowConstants);
+      if (!undeclaredConstants.isEmpty()) {
+        throw new IllegalStateException(String.format("Native Module Flow doesn't declare constants: %s", undeclaredConstants));
+      }
+      undeclaredConstants = obligatoryFlowConstants;
+      undeclaredConstants.removeAll(constants.keySet());
+      if (!undeclaredConstants.isEmpty()) {
+        throw new IllegalStateException(String.format("Native Module doesn't fill in constants: %s", undeclaredConstants));
+      }
+    }
+    return constants;
+  }
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setInstanceWithAccountId(String accountId);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getInitialUrl(Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setLibrary(String name, double andVersion);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setLocale(String locale);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void registerForPush();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setPushTokenAsString(String token, String withType);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setPushTokenAsStringWithRegion(String token, String withType, String withRegion);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void enablePersonalization();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void disablePersonalization();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setOffline(boolean enabled);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setOptOut(boolean enabled);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void enableDeviceNetworkInfoReporting(boolean enabled);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void recordScreenView(String screenName);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void recordEvent(String eventName, @Nullable ReadableMap withProps);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void recordChargedEvent(@Nullable ReadableMap details, ReadableArray andItems);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void eventGetFirstTime(String eventName, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void eventGetLastTime(String eventName, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void eventGetOccurrences(String eventName, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void eventGetDetail(String eventName, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getEventHistory(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setLocation(double location, double longitude);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileGetCleverTapAttributionIdentifier(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileGetCleverTapID(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getCleverTapID(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void onUserLogin(@Nullable ReadableMap profile);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileSet(@Nullable ReadableMap profile);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileGetProperty(String propertyName, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileRemoveValueForKey(String key);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileSetMultiValues(ReadableArray values, String forKey);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileAddMultiValue(String value, String forKey);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileAddMultiValues(ReadableArray values, String forKey);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileRemoveMultiValue(String value, String forKey);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileRemoveMultiValues(ReadableArray values, String forKey);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileIncrementValueForKey(@Nullable Double value, String forKey);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void profileDecrementValueForKey(@Nullable Double value, String forKey);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void pushInstallReferrer(String source, String medium, String campaign);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void sessionGetTimeElapsed(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void sessionGetTotalVisits(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void sessionGetScreenCount(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void sessionGetPreviousVisitTime(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void sessionGetUTMDetails(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void createNotificationChannel(String channelId, String withChannelName, String withChannelDescription, double withImportance, boolean withShowBadge);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void createNotificationChannelWithSound(String channelId, String withChannelName, String withChannelDescription, double withImportance, boolean withShowBadge, String withSound);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void createNotificationChannelWithGroupId(String channelId, String withChannelName, String withChannelDescription, double withImportance, String withGroupId, boolean withShowBadge);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void createNotificationChannelWithGroupIdAndSound(String channelId, String withChannelName, String withChannelDescription, double withImportance, String withGroupId, boolean withShowBadge, String withSound);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void createNotificationChannelGroup(String groupId, String withGroupName);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void deleteNotificationChannel(String channelId);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void deleteNotificationChannelGroup(String groupId);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void createNotification(@Nullable ReadableMap extras);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setDebugLevel(double level);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getInboxMessageCount(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getInboxMessageUnreadCount(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getAllInboxMessages(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getUnreadInboxMessages(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getInboxMessageForId(String messageId, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void pushInboxNotificationViewedEventForId(String messageId);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void pushInboxNotificationClickedEventForId(String messageId);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void markReadInboxMessageForId(String messageId);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void deleteInboxMessageForId(String messageId);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void markReadInboxMessagesForIDs(ReadableArray messageIds);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void deleteInboxMessagesForIDs(ReadableArray messageIds);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void dismissInbox();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void initializeInbox();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void showInbox(@Nullable ReadableMap styleConfig);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getAllDisplayUnits(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getDisplayUnitForId(String unitId, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void pushDisplayUnitViewedEventForID(String unitId);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void pushDisplayUnitClickedEventForID(String unitId);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getFeatureFlag(String flag, boolean withdefaultValue, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setDefaultsMap(@Nullable ReadableMap jsonDict);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void fetch();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void fetchWithMinimumFetchIntervalInSeconds(double time);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void activate();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void fetchAndActivate();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setMinimumFetchIntervalInSeconds(double time);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getLastFetchTimeStampInMillis(Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getString(String key, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getBoolean(String key, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getDouble(String key, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void reset();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void suspendInAppNotifications();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void discardInAppNotifications();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void resumeInAppNotifications();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void fetchInApps(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void clearInAppResources(boolean expiredOnly);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void customTemplateSetDismissed(String templateName, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void customTemplateSetPresented(String templateName, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void customTemplateRunAction(String templateName, String argName, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void customTemplateGetStringArg(String templateName, String argName, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void customTemplateGetNumberArg(String templateName, String argName, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void customTemplateGetBooleanArg(String templateName, String argName, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void customTemplateGetFileArg(String templateName, String argName, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void customTemplateGetObjectArg(String templateName, String argName, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void customTemplateContextToString(String templateName, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void syncCustomTemplates();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void syncCustomTemplatesInProd(boolean isProduction);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void promptForPushPermission(boolean showFallbackSettings);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void promptPushPrimer(ReadableMap json);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void isPushPermissionGranted(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void syncVariables();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void syncVariablesinProd(boolean isProduction);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getVariable(String name, @Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void fetchVariables(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getVariables(@Nullable Callback callback);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void defineVariables(@Nullable ReadableMap variables);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void defineFileVariable(String name);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void onVariablesChanged();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void onOneTimeVariablesChanged();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void onValueChanged(String name);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void onVariablesChangedAndNoDownloadsPending();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void onceVariablesChangedAndNoDownloadsPending();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void onFileValueChanged(String name);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void onEventListenerAdded(String eventType);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void addListener(String eventType);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void removeListeners(double count);
+}