Merge branch 'staging' of github.com:Countly/countly-sdk-react-native-bridge into staging-np

Author: turtledreams

CHANGELOG.md

@@ -1,3 +1,53 @@
+## 25.1.0-np
+* ! Minor breaking change ! `Countly.userDataBulk.save()` method is now optional. SDK will save the cached data with internal triggers regularly.
+
+* Added Content feature methods:
+  * `enterContentZone`, to start Content checks (Experimental!)
+  * `exitContentZone`, to stop Content checks (Experimental!)
+* Added feedback widget convenience methods to display the first available widget or the one meets the criteria:
+  * `Countly.feedback.showNPS(nameIDorTag?: string, widgetClosedCallback?: WidgetCallback): void`
+  * `Countly.feedback.showSurvey(nameIDorTag?: string, widgetClosedCallback?: WidgetCallback): void`
+  * `Countly.feedback.showRating(nameIDorTag?: string, widgetClosedCallback?: WidgetCallback): void`
+* Added config interface `experimental` that provides experimental config options:
+  * `.experimental.enablePreviousNameRecording()` for reporting previous event/view names
+  * `.experimental.enableVisibilityTracking()` for reporting app visibility with events
+* Added `Countly.deviceId.setID` method for changing device ID based on the device ID type
+* Added support for Arrays of primitive types in event segmentation
+
+* Deprecated following SDK calls:
+  * `Countly.getCurrentDeviceId` (replaced with: `Countly.deviceId.getID`)
+  * `Countly.getDeviceIDType` (replaced with: `Countly.deviceId.getType`)
+  * `Countly.changeDeviceId` (replaced with: `Countly.deviceId.setID`)
+
+* Mitigated an issue where a session could have started while the app was in the background when the device ID was changed (non-merge).
+* Mitigated an issue where intent redirection checks were disabled by default
+* Mitigated an issue crash tracking was not enabled with init config
+* Mitigated an issue where app start time tracking was on by default
+
+* Android Specific Changes:
+  * ! Minor breaking change ! Unsupported types for user properties will now be omitted, they won't be converted to strings.
+  * Disabled caching for webviews.
+  * Mitigated an issue in the upload plugin that prevented the upload of a symbol file
+  * Resolved a problem where revoked consents were sent after changes without merging.
+  * Mitigated an issue that caused the device ID to be incorrectly set after changes with merging.
+  * Mitigated an issue where on consent revoke, remote config values were cleared, not anymore.
+
+* iOS Specific Changes:
+  * Orientation info is now also sent during initialization
+  * Added visionOS build support
+  * Updated the SDK to ensure compatibility with the latest server response models
+  * Improved view tracking capabilities
+  * Mitigated an issue with the feedback widget URL encoding on iOS 16 and earlier, which prevented the widget from displaying
+  * Mitigated an issue with content fetch URL encoding on iOS 16 and earlier, which caused the request to fail
+  * Mitigated an issue where the terms and conditions URL (`tc` key) was sent without double quotes
+  * Mitigated an issue where consent information was not sent when no consent was given during initialization
+  * Mitigated an issue where a session did not end when session consent was removed
+  * Mitigated an issue where pausing a view resulted in a '0' view duration.
+  * Mitigated an issue where the user provided URLSessionConfiguration was not applied to direct requests
+
+* Updated the underlying Android SDK version to 24.7.8
+* Updated the underlying iOS SDK version to 24.7.9
+
 ## 24.4.1-np
 * Added support for Feedback Widget terms and conditions
 * Added six new configuration options under the 'sdkInternalLimits' interface of 'CountlyConfig':

Countly.d.ts

@@ -1,5 +1,5 @@
 interface Segmentation {
-  [key: string]: number | string | boolean;
+  [key: string]: number | string | boolean | (number | string | boolean)[];
 }
 
 interface CountlyEventOptions {
@@ -89,6 +89,29 @@ declare module "countly-sdk-react-native-bridge-np" {
      * Countly Feedback Module
      */
     namespace feedback {
+
+      /**
+       * Shows the first available NPS widget that meets the criteria.
+       * @param {String} [nameIDorTag] - name, id, or tag of the widget to show (optional)
+       * @param {callback} [widgetClosedCallback] - called when the widget is closed (optional)
+       */
+      export function showNPS(nameIDorTag?: string, widgetClosedCallback?: WidgetCallback): void;
+
+      /**
+       * Shows the first available survey widget that meets the criteria.
+       * @param {String} [nameIDorTag] - name, id, or tag of the widget to show (optional)
+       * @param {callback} [widgetClosedCallback] - called when the widget is closed (optional)
+       */
+      export function showSurvey(nameIDorTag?: string, widgetClosedCallback?: WidgetCallback): void;
+
+      /**
+       * Shows the first available rating widget that meets the criteria.
+       * @param {String} [nameIDorTag] - name, id, or tag of the widget to show (optional)
+       * @param {callback} [widgetClosedCallback] - called when the widget is closed (optional)
+       */
+      export function showRating(nameIDorTag?: string, widgetClosedCallback?: WidgetCallback): void;
+
+
       /**
        * Get a list of available feedback widgets as an array of objects.
        * @param {FeedbackWidgetCallback} [onFinished] - returns (retrievedWidgets, error). This parameter is optional.
@@ -106,7 +129,7 @@ declare module "countly-sdk-react-native-bridge-np" {
        *
        * @return {ErrorObject} object {error: string or null}
        */
-      export function presentFeedbackWidget(feedbackWidget: FeedbackWidget, closeButtonText: string, widgetShownCallback: callback, widgetClosedCallback: callback): ErrorObject;
+      export function presentFeedbackWidget(feedbackWidget: FeedbackWidget, closeButtonText: string, widgetShownCallback: WidgetCallback, widgetClosedCallback: WidgetCallback): ErrorObject;
 
       /**
        * Get a feedback widget's data as an object.
@@ -176,6 +199,21 @@ declare module "countly-sdk-react-native-bridge-np" {
       export function cancelEvent(eventName: string): void;
     }
 
+    /**
+     * Countly Content Module
+     */
+    namespace content {
+      /**
+       * Opt in user for the content fetching and updates
+       */
+      export function enterContentZone(): void;
+
+      /**
+       * Opt out user from the content fetching and updates
+       */
+      export function exitContentZone(): void;
+    }
+
     /**
      * Initialize Countly
      *
@@ -391,7 +429,8 @@ declare module "countly-sdk-react-native-bridge-np" {
     export function disableLocation(): string | void;
 
     /**
-     *
+     * @deprecated use 'Countly.deviceId.getID' instead of 'Countly.getCurrentDeviceId'
+     * 
      * Get currently used device Id.
      * Should be called after Countly init
      *
@@ -400,6 +439,8 @@ declare module "countly-sdk-react-native-bridge-np" {
     export function getCurrentDeviceId(): Promise<string> | string;
 
     /**
+     * @deprecated use 'Countly.deviceId.getType' instead of 'Countly.getDeviceIDType'
+     * 
      * Get currently used device Id type.
      * Should be called after Countly init
      *
@@ -408,6 +449,8 @@ declare module "countly-sdk-react-native-bridge-np" {
     export function getDeviceIDType(): Promise<DeviceIdType> | null;
 
     /**
+     * @deprecated use 'Countly.deviceId.setID' instead of 'Countly.changeDeviceId'
+     * 
      * Change the current device id
      *
      * @param {string} newDeviceID id new device id
@@ -416,6 +459,34 @@ declare module "countly-sdk-react-native-bridge-np" {
      */
     export function changeDeviceId(newDeviceID: string, onServer: boolean): string | void;
 
+    namespace deviceId {
+      /**
+       * 
+       * Get currently used device ID.
+       * Should be called after Countly init
+       *
+       * @returns {string | null} device ID or null
+       */
+      export function getID(): Promise<string> | string;
+
+      /**
+       * 
+       * Get currently used device ID type.
+       * Should be called after Countly init
+       *
+       * @return {DeviceIdType | null} deviceIdType or null
+       */
+      export function getType(): Promise<DeviceIdType> | null;
+
+      /**
+       * Sets device ID according to the device ID Type.
+       * If previous ID was Developer Supplied sets it without merge, otherwise with merge.
+       *
+       * @param {string} newDeviceID device ID to set
+       */
+      export function setID(newDeviceID: string): void;
+    }
+
     /**
      *
      * Set to "true" if you want HTTP POST to be used for all requests
@@ -1101,6 +1172,18 @@ declare module "countly-sdk-react-native-bridge-np" {
 }
 
 declare module "countly-sdk-react-native-bridge-np/CountlyConfig" {
+  interface experimental {
+    /**
+     * Enables previous name recording for views and events
+     */
+    enablePreviousNameRecording(): this;
+
+    /**
+     * Enables app visibility tracking with events.
+     */
+    enableVisibilityTracking(): this;
+  }
+
   /**
    *
    * This class holds APM specific configurations to be used with 
@@ -1193,6 +1276,11 @@ declare module "countly-sdk-react-native-bridge-np/CountlyConfig" {
      */
       sdkInternalLimits: CountlyConfigSDKInternalLimits;
 
+      /**
+       * getter for experimental features
+       */
+      experimental: experimental;
+
       /**
      * Method to set the server url
      *

Countly.js

@@ -10,6 +10,7 @@ import CountlyConfig from "./CountlyConfig.js";
 import CountlyState from "./CountlyState.js";
 import Feedback from "./Feedback.js";
 import Event from "./Event.js";
+import DeviceId from "./DeviceId.js";
 import * as L from "./Logger.js";
 import * as Utils from "./Utils.js";
 import * as Validate from "./Validators.js";
@@ -26,12 +27,15 @@ CountlyState.eventEmitter = eventEmitter;
 
 Countly.feedback = new Feedback(CountlyState);
 Countly.events = new Event(CountlyState);
+Countly.deviceId = new DeviceId(CountlyState);
 
 let _isCrashReportingEnabled = false;
 
 Countly.userData = {}; // userData interface
 Countly.userDataBulk = {}; // userDataBulk interface
 
+Countly.content = {}; // content interface
+
 let _isPushInitialized = false;
 
 const BUILDING_WITH_PUSH_DISABLED = true;
@@ -479,7 +483,8 @@ Countly.disableLocation = function () {
 };
 
 /**
- *
+ * @deprecated use 'Countly.deviceId.getID' instead of 'Countly.getCurrentDeviceId'
+ * 
  * Get currently used device Id.
  * Should be called after Countly init
  *
@@ -497,6 +502,8 @@ Countly.getCurrentDeviceId = async function () {
 };
 
 /**
+ * @deprecated use 'Countly.deviceId.getType' instead of 'Countly.getDeviceIDType'
+ * 
  * Get currently used device Id type.
  * Should be called after Countly init
  *
@@ -513,7 +520,9 @@ Countly.getDeviceIDType = async function () {
 };
 
 /**
- * Change the current device id
+ * @deprecated use 'Countly.deviceId.setID' instead of 'Countly.changeDeviceId' for setting device ID.
+ * 
+ * Change the current device ID
  *
  * @param {string} newDeviceID id new device id
  * @param {boolean} onServer merge device id
@@ -2201,4 +2210,34 @@ Countly.setCustomMetrics = async function (customMetric) {
     }
 };
 
+/**
+ * Opt in user for the content fetching and updates
+ * 
+ * NOTE: This is an EXPERIMENTAL feature, and it can have breaking changes
+ */
+Countly.content.enterContentZone = function() {
+    L.i("enterContentZone, opting for content fetching.");
+    if (!_state.isInitialized) {
+        const message = "'init' must be called before 'enterContentZone'";
+        L.e(`enterContentZone, ${message}`);
+        return;
+    }
+    CountlyReactNative.enterContentZone();
+};
+
+/**
+ * Opt out user from the content fetching and updates
+ * 
+ * NOTE: This is an EXPERIMENTAL feature, and it can have breaking changes
+ */
+Countly.content.exitContentZone = function() {
+    L.i("exitContentZone, opting out from content fetching.");
+    if (!_state.isInitialized) {
+        const message = "'init' must be called before 'exitContentZone'";
+        L.e(`exitContentZone, ${message}`);
+        return;
+    }
+    CountlyReactNative.exitContentZone();
+};
+
 export default Countly;

CountlyConfig.js

@@ -1,9 +1,8 @@
 import { initialize } from "./Logger.js";
 import CountlyConfigApm from "./lib/configuration_interfaces/countly_config_apm.js";
 import CountlyConfigSDKInternalLimits from "./lib/configuration_interfaces/countly_config_limits.js";
-
+import CountlyConfigExp from "./lib/configuration_interfaces/countly_config_experimental.js";
 const BUILDING_WITH_PUSH_DISABLED = true;
-
 /**
  * Countly SDK React Native Bridge
  * https://github.com/Countly/countly-sdk-react-native-bridge
@@ -17,11 +16,15 @@ const BUILDING_WITH_PUSH_DISABLED = true;
  * @param {String} appKey application key
  */
 class CountlyConfig {
+    #crashReporting = false;
+    #apmLegacy = false;
+    #disableIntentRedirectionCheck = false;
     constructor(serverURL, appKey) {
         this.serverURL = serverURL;
         this.appKey = appKey;
         this._countlyConfigApmInstance = new CountlyConfigApm();
         this._countlyConfigSDKLimitsInstance = new CountlyConfigSDKInternalLimits();
+        this._countlyConfigExpInstance = new CountlyConfigExp();
     }
 
     /**
@@ -35,6 +38,32 @@ class CountlyConfig {
         return this._countlyConfigSDKLimitsInstance;
     }
 
+    /**
+     * Getter to get the SDK internal limits
+     */
+    get sdkInternalLimits() {
+        return this._countlyConfigSDKLimitsInstance;
+    }
+
+    /**
+     * Getter to get the experimental configurations
+     */
+    get experimental() {
+        return this._countlyConfigExpInstance;
+    }
+
+    get _crashReporting() {
+        return this.#crashReporting;
+    }
+
+    get _apmLegacy() {
+        return this.#apmLegacy;
+    }
+
+    get _disableIntentRedirectionCheck() {
+        return this.#disableIntentRedirectionCheck;
+    }
+
     /**
      * Method to set the server url
      *
@@ -81,7 +110,7 @@ class CountlyConfig {
      * Method to enable crash reporting to report unhandled crashes to Countly
      */
     enableCrashReporting() {
-        this.crashReporting = true;
+        this.#crashReporting = true;
         return this;
     }
 
@@ -144,7 +173,7 @@ class CountlyConfig {
      * Method to enable application performance monitoring which includes the recording of app start time.
      */
     enableApm() {
-        this.enableApm = true;
+        this.#apmLegacy = true;
         return this;
     }
 
@@ -156,7 +185,7 @@ class CountlyConfig {
         if (BUILDING_WITH_PUSH_DISABLED) {
             return this;
         }
-        this.disableAdditionalIntentRedirectionChecks = true;
+        this.#disableIntentRedirectionCheck = true;
         return this;
     }
 

CountlyReactNative.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'CountlyReactNative'
-  s.version = '24.4.1'
+  s.version = '25.1.0'
   s.license = {
     :type => 'COMMUNITY',
     :text => <<-LICENSE