clevertap-react-native 3.0.0 → 3.1.1

package/src/NativeCleverTapModule.ts

@@ -7,12 +7,15 @@ export interface Spec extends TurboModule {
     CleverTapProfileSync: string;
     CleverTapInAppNotificationDismissed: string;
     CleverTapInAppNotificationShowed: string;
+    CleverTapInAppNotificationButtonTapped: string;
+    CleverTapCustomTemplatePresent: string;
+    CleverTapCustomTemplateClose: string;
+    CleverTapCustomFunctionPresent: string;
     CleverTapInboxDidInitialize: string;
     CleverTapInboxMessagesDidUpdate: string;
     CleverTapInboxMessageButtonTapped: string;
     CleverTapInboxMessageTapped: string;
     CleverTapDisplayUnitsLoaded: string;
-    CleverTapInAppNotificationButtonTapped: string;
     CleverTapFeatureFlagsDidUpdate: string;
     CleverTapProductConfigDidInitialize: string;
     CleverTapProductConfigDidFetch: string;
@@ -20,7 +23,11 @@ export interface Spec extends TurboModule {
     CleverTapPushNotificationClicked: string;
     CleverTapPushPermissionResponseReceived: string;
     CleverTapOnVariablesChanged: string;
+    CleverTapOnOneTimeVariablesChanged: string;
     CleverTapOnValueChanged: string;
+    CleverTapOnVariablesChangedAndNoDownloadsPending: string;
+    CleverTapOnceVariablesChangedAndNoDownloadsPending: string;
+    CleverTapOnFileValueChanged: string;
     HPS: string;
     FCM: string;
     BPS: string;
@@ -191,6 +198,17 @@ export interface Spec extends TurboModule {
   resumeInAppNotifications(): void;
   fetchInApps(callback: ((error: Object, result: boolean) => void) | null): void;
   clearInAppResources(expiredOnly: boolean): void;
+  customTemplateSetDismissed(templateName: string): Promise<void>;
+  customTemplateSetPresented(templateName: string): Promise<void>;
+  customTemplateRunAction(templateName: string, argName: string): Promise<void>;
+  customTemplateGetStringArg(templateName: string, argName: string): Promise<string>;
+  customTemplateGetNumberArg(templateName: string, argName: string): Promise<number>;
+  customTemplateGetBooleanArg(templateName: string, argName: string): Promise<boolean>;
+  customTemplateGetFileArg(templateName: string, argName: string): Promise<string>;
+  customTemplateGetObjectArg(templateName: string, argName: string): Promise<any>;
+  customTemplateContextToString(templateName: string): Promise<string>;
+  syncCustomTemplates(): void;
+  syncCustomTemplatesInProd(isProduction: boolean): void;
   promptForPushPermission(showFallbackSettings: boolean): void;
   promptPushPrimer(json: Object): void;
   isPushPermissionGranted(callback: ((error: Object, result: boolean) => void) | null): void;
@@ -205,8 +223,13 @@ export interface Spec extends TurboModule {
   defineVariables(
     variables: Object | null
   ): void;
+  defineFileVariable(name: string): void;
   onVariablesChanged(): void;
+  onOneTimeVariablesChanged(): void;
   onValueChanged(name: string): void;
+  onVariablesChangedAndNoDownloadsPending(): void;
+  onceVariablesChangedAndNoDownloadsPending(): void;
+  onFileValueChanged(name: string): void;
 
   onEventListenerAdded(eventType: string): void;
   // NativeEventEmitter methods for the New Architecture.

package/src/index.d.ts

@@ -4,9 +4,8 @@
 
    /**
     * Add a CleverTap event listener
-    * supported events are CleverTap.CleverTapProfileDidInitialize, CleverTap.CleverTapProfileSync and CleverTap.CleverTapInAppNotificationDismissed
     * @param {string} eventName - the CleverTap event name
-    * @param {function(event)} your event handler
+    * @param {function(event)} handler - Event handler
     */
    export function addListener(
    eventName: string,
@@ -685,6 +684,20 @@ export function isPushPermissionGranted(callback: CallbackString): void;
    */
   export function resumeInAppNotifications(): void;
 
+  /**
+   * Fetches In Apps from server.
+   *
+   * @param {function(err, res)} callback a callback with a boolean flag whether the fetching was successful
+   */
+  export function fetchInApps(callback: Callback): void;
+
+  /**
+   * Deletes all images and gifs which are preloaded for inapps in cs mode
+   *
+   * @param {boolean} expiredOnly to clear only assets which will not be needed further for inapps
+   */
+  export function clearInAppResources(expiredOnly: boolean): void;
+
   /*******************
    * Instances
    ******************/
@@ -727,6 +740,13 @@ export function isPushPermissionGranted(callback: CallbackString): void;
    */
   export function defineVariables(variables: object): void;
   
+  /**
+   *  Create File variables. 
+   * 
+   * @param {string} fileVariable - the file variable string.
+   */
+  export function defineFileVariable(fileVariable: string): void;
+
   /**
    * Get all variables via a JSON object.
    * 
@@ -747,6 +767,13 @@ export function isPushPermissionGranted(callback: CallbackString): void;
     */
   export function onVariablesChanged(handler: Function): void;
 
+  /**
+    *  Adds a callback to be invoked only once on app start, or when added if server values are already received
+    *
+    * @param {function} handler The callback to add
+    */
+  export function onOneTimeVariablesChanged(handler: Function): void;
+
   /**
     * Called when the value of the variable changes.
     * 
@@ -755,20 +782,126 @@ export function isPushPermissionGranted(callback: CallbackString): void;
     */
   export function onValueChanged(name: string, handler: Function): void;
 
+  /**
+    * Adds a callback to be invoked when no files need to be downloaded or all downloads have been completed. It is called each time new values are fetched and downloads are completed.    * 
+    *   
+    * @param {function} handler The callback to add
+    */
+  export function onVariablesChangedAndNoDownloadsPending(handler: Function): void;
 
   /**
-   * Fetches In Apps from server.
+    * Adds a callback to be invoked only once for when new values are fetched and downloaded
+    *
+    * @param {function} handler The callback to add
+    */
+  export function onceVariablesChangedAndNoDownloadsPending(handler: Function): void;
+
+  /**
+    * Called when the value of the file variable is downloaded and ready. This is only available for File variables.
+    * 
+    * @param {name} string the name of the file variable
+    * @param {function} handler The callback to add
+    */
+  export function onFileValueChanged(name: string, handler: Function): void;
+
+  /**
+  /*******************
+   * Custom Templates
+   ******************/
+
+  /**
+  * Uploads Custom in-app templates and app functions to the server.
+  * Requires Development/Debug build/configuration.
+  */
+  export function syncCustomTemplates(): void;
+
+  /**
+   * Uploads Custom in-app templates and app functions to the server.
+   * 
+   * @param isProduction Provide `true` if templates must be sync in Productuon build/configuration.
+   */
+  export function syncCustomTemplatesInProd(isProduction: boolean): void;
+
+  /**
+   * Notify the SDK that an active custom template is dismissed. The active custom template is considered to be
+   * visible to the user until this method is called. Since the SDK can show only one InApp message at a time, all
+   * other messages will be queued until the current one is dismissed.
+   * 
+   * @param templateName The name of the active template
+   */
+  export function customTemplateSetDismissed(templateName: string): Promise<void>;
+
+  /**
+   * Notify the SDK that an active custom template is presented to the user
+   * 
+   * @param templateName The name of the active template
+   */
+  export function customTemplateSetPresented(templateName: string): Promise<void>;
+
+  /**
+   * Trigger a custom template action argument by name.
+   * 
+   * @param templateName The name of an active template for which the action is defined
+   * @param argName The action argument name
+   */
+  export function customTemplateRunAction(templateName: string, argName: string): Promise<void>;
+
+  /**
+   * Retrieve a string argument by name.
    *
-   * @param {function(err, res)} callback a callback with a boolean flag whether the fetching was successful
+   * @param templateName The name of an active template for which the argument is defined
+   * @param argName The action argument name
+   * 
+   * @returns The argument value or null if no such argument is defined for the template.
    */
-  export function fetchInApps(callback: Callback): void;
+  export function customTemplateGetStringArg(templateName: string, argName: string): Promise<string>;
 
   /**
-   * Deletes all images and gifs which are preloaded for inapps in cs mode
+   * Retrieve a number argument by name.
    *
-   * @param {boolean} expiredOnly to clear only assets which will not be needed further for inapps
+   * @param templateName The name of an active template for which the argument is defined
+   * @param argName The action argument name
+   * 
+   * @returns The argument value or null if no such argument is defined for the template.
    */
-  export function clearInAppResources(expiredOnly: boolean): void;
+  export function customTemplateGetNumberArg(templateName: string, argName: string): Promise<number>;
+
+  /**
+   * Retrieve a boolean argument by name.
+   *
+   * @param templateName The name of an active template for which the argument is defined
+   * @param argName The action argument name
+   * 
+   * @returns The argument value or null if no such argument is defined for the template.
+   */
+  export function customTemplateGetBooleanArg(templateName: string, argName: string): Promise<boolean>;
+
+  /**
+   * Retrieve a file argument by name.
+   *
+   * @param templateName The name of an active template for which the argument is defined
+   * @param argName The action argument name
+   * 
+   * @returns The file path to the file or null if no such argument is defined for the template.
+   */
+  export function customTemplateGetFileArg(templateName: string, argName: string): Promise<string>;
+
+  /**
+   * Retrieve an object argument by name.
+   *
+   * @param templateName The name of an active template for which the argument is defined
+   * @param argName The action argument name
+   * 
+   * @returns The argument value or null if no such argument is defined for the template.
+   */
+  export function customTemplateGetObjectArg(templateName: string, argName: string): Promise<any>;
+
+  /**
+   * Get a string representation of an active's template context with information about all arguments. 
+   * 
+   * @param templateName The name of an active template
+   */
+  export function customTemplateContextToString(templateName: string): Promise<string>;
 
   /*******************
    * Developer Options
@@ -789,12 +922,15 @@ export function isPushPermissionGranted(callback: CallbackString): void;
   export const CleverTapProfileSync: string;
   export const CleverTapInAppNotificationDismissed: string;
   export const CleverTapInAppNotificationShowed: string;
+  export const CleverTapInAppNotificationButtonTapped: string;
+  export const CleverTapCustomTemplatePresent: string;
+  export const CleverTapCustomTemplateClose: string;
+  export const CleverTapCustomFunctionPresent: string;
   export const CleverTapInboxDidInitialize: string;
   export const CleverTapInboxMessagesDidUpdate: string;
   export const CleverTapInboxMessageButtonTapped: string;
   export const CleverTapInboxMessageTapped: string;
   export const CleverTapDisplayUnitsLoaded: string;
-  export const CleverTapInAppNotificationButtonTapped: string;
   export const CleverTapFeatureFlagsDidUpdate: string;
   export const CleverTapProductConfigDidInitialize: string;
   export const CleverTapProductConfigDidFetch: string;
@@ -802,4 +938,8 @@ export function isPushPermissionGranted(callback: CallbackString): void;
   export const CleverTapPushNotificationClicked: string;
   export const CleverTapPushPermissionResponseReceived: string;
   export const CleverTapOnVariablesChanged: string;
-  export const CleverTapOnValueChanged: string;
+  export const CleverTapOnOneTimeVariablesChanged: string;
+  export const CleverTapOnValueChanged: string;
+  export const CleverTapOnVariablesChangedAndNoDownloadsPending: string;
+  export const CleverTapOnceVariablesChangedAndNoDownloadsPending: string;
+  export const CleverTapOnFileValueChanged: string;

package/src/index.js

@@ -1,4 +1,5 @@
-import { DeviceEventEmitter, NativeEventEmitter, NativeModules } from 'react-native';
+import { DeviceEventEmitter, NativeEventEmitter, NativeModules, Platform } from 'react-native';
+
 const CleverTapReact = require('./NativeCleverTapModule').default;
 const EventEmitter = Platform.select({
     ios: new NativeEventEmitter(CleverTapReact),
@@ -11,7 +12,7 @@ const EventEmitter = Platform.select({
 * @param {int} libVersion - The updated library version. If current version is 1.1.0 then pass as 10100  
 */
 const libName = 'React-Native';
-const libVersion = 30000;
+const libVersion = 30101;
 CleverTapReact.setLibrary(libName,libVersion);
 
 function defaultCallback(method, err, res) {
@@ -49,6 +50,10 @@ var CleverTap = {
     CleverTapProfileSync: CleverTapReact.getConstants().CleverTapProfileSync,
     CleverTapInAppNotificationDismissed: CleverTapReact.getConstants().CleverTapInAppNotificationDismissed,
     CleverTapInAppNotificationShowed: CleverTapReact.getConstants().CleverTapInAppNotificationShowed,
+    CleverTapInAppNotificationButtonTapped: CleverTapReact.getConstants().CleverTapInAppNotificationButtonTapped,
+    CleverTapCustomTemplatePresent: CleverTapReact.getConstants().CleverTapCustomTemplatePresent,
+    CleverTapCustomFunctionPresent: CleverTapReact.getConstants().CleverTapCustomFunctionPresent,
+    CleverTapCustomTemplateClose: CleverTapReact.getConstants().CleverTapCustomTemplateClose,
     FCM: CleverTapReact.getConstants().FCM,
     BPS: CleverTapReact.getConstants().BPS,
     HPS: CleverTapReact.getConstants().HPS,
@@ -57,7 +62,6 @@ var CleverTap = {
     CleverTapInboxMessageButtonTapped: CleverTapReact.getConstants().CleverTapInboxMessageButtonTapped,
     CleverTapInboxMessageTapped: CleverTapReact.getConstants().CleverTapInboxMessageTapped,
     CleverTapDisplayUnitsLoaded: CleverTapReact.getConstants().CleverTapDisplayUnitsLoaded,
-    CleverTapInAppNotificationButtonTapped: CleverTapReact.getConstants().CleverTapInAppNotificationButtonTapped,
     CleverTapFeatureFlagsDidUpdate: CleverTapReact.getConstants().CleverTapFeatureFlagsDidUpdate, // @deprecated - Since version 1.1.0 and will be removed in the future versions of this SDK.
     CleverTapProductConfigDidInitialize: CleverTapReact.getConstants().CleverTapProductConfigDidInitialize, // @deprecated - Since version 1.1.0 and will be removed in the future versions of this SDK.
     CleverTapProductConfigDidFetch: CleverTapReact.getConstants().CleverTapProductConfigDidFetch, // @deprecated - Since version 1.1.0 and will be removed in the future versions of this SDK.
@@ -65,7 +69,11 @@ var CleverTap = {
     CleverTapPushNotificationClicked: CleverTapReact.getConstants().CleverTapPushNotificationClicked,
     CleverTapPushPermissionResponseReceived: CleverTapReact.getConstants().CleverTapPushPermissionResponseReceived,
     CleverTapOnVariablesChanged: CleverTapReact.getConstants().CleverTapOnVariablesChanged,
+    CleverTapOnOneTimeVariablesChanged: CleverTapReact.getConstants().CleverTapOnOneTimeVariablesChanged,
     CleverTapOnValueChanged: CleverTapReact.getConstants().CleverTapOnValueChanged,
+    CleverTapOnVariablesChangedAndNoDownloadsPending: CleverTapReact.getConstants().CleverTapOnVariablesChangedAndNoDownloadsPending,
+    CleverTapOnceVariablesChangedAndNoDownloadsPending: CleverTapReact.getConstants().CleverTapOnceVariablesChangedAndNoDownloadsPending,
+    CleverTapOnFileValueChanged: CleverTapReact.getConstants().CleverTapOnFileValueChanged,
 
     /**
     * Add a CleverTap event listener
@@ -80,6 +88,16 @@ var CleverTap = {
             CleverTapReact.onEventListenerAdded(eventName);
         }
     },
+    addOneTimeListener: function (eventName, handler) {
+        if (EventEmitter) {
+            const subscription = EventEmitter.addListener(eventName, (args) =>
+             {
+              handler(args);
+              subscription.remove();
+              });
+            CleverTapReact.onEventListenerAdded(eventName);
+        }
+    },
 
     /**
     * Removes all of the registered listeners for given eventName.
@@ -908,6 +926,14 @@ var CleverTap = {
         CleverTapReact.defineVariables(variables);
     },
 
+    /**
+    * Create File Variable
+    * @param {string} fileVariable - the file variable string
+    */
+    defineFileVariable: function (fileVariable) {
+        CleverTapReact.defineFileVariable(fileVariable)
+    },
+    
     /**
      * Get a variable or a group for the specified name.
      * 
@@ -935,6 +961,16 @@ var CleverTap = {
         this.addListener(CleverTapReact.getConstants().CleverTapOnVariablesChanged, handler);
     },
 
+    /**
+     *  Adds a callback to be invoked only once on app start, or when added if server values are already received
+     *
+     * @param {function} handler The callback to add
+     */
+    onOneTimeVariablesChanged: function (handler) {
+        this.addOneTimeListener(CleverTapReact.getConstants().CleverTapOnOneTimeVariablesChanged, handler);
+        CleverTapReact.onOneTimeVariablesChanged();
+    },
+
     /**
      * Called when the value of the variable changes.
      * 
@@ -946,6 +982,37 @@ var CleverTap = {
         this.addListener(CleverTapReact.getConstants().CleverTapOnValueChanged, handler);
     },
 
+    /**
+     *  Adds a callback to be invoked when variables are initialised with server values. Will be called each time new values are fetched.
+     * 
+     * @param {function} handler The callback to add
+     */
+    onVariablesChangedAndNoDownloadsPending: function (handler) {
+        this.addListener(CleverTapReact.getConstants().CleverTapOnVariablesChangedAndNoDownloadsPending, handler);
+        CleverTapReact.onVariablesChangedAndNoDownloadsPending();
+    },
+
+    /**
+     *  Adds a callback to be invoked only once for when new values are fetched and downloaded
+     *
+     * @param {function} handler The callback to add
+     */
+    onceVariablesChangedAndNoDownloadsPending: function (handler) {
+        this.addOneTimeListener(CleverTapReact.getConstants().CleverTapOnceVariablesChangedAndNoDownloadsPending, handler);
+        CleverTapReact.onceVariablesChangedAndNoDownloadsPending();
+    },
+
+    /**
+     * Called when the value of the file variable is downloaded and ready.
+     * 
+     * @param {name} string the name of the file variable
+     * @param {function} handler The callback to add
+     */
+    onFileValueChanged: function (name, handler) {
+        this.addListener(CleverTapReact.getConstants().CleverTapOnFileValueChanged, handler);
+        CleverTapReact.onFileValueChanged(name);
+    },
+
     /**
      * Fetches In Apps from server.
      *
@@ -962,6 +1029,123 @@ var CleverTap = {
      */
     clearInAppResources: function (expiredOnly) {
         CleverTapReact.clearInAppResources(expiredOnly);
+    },
+
+    /**
+     * Uploads Custom in-app templates and app functions to the server.
+     * Requires Development/Debug build/configuration.
+     */
+    syncCustomTemplates: function () {
+        CleverTapReact.syncCustomTemplates();
+    },
+
+    /**
+     * Uploads Custom in-app templates and app functions to the server.
+     *
+     * @param {boolean} isProduction Provide `true` if templates must be sync in Productuon build/configuration.
+     */
+    syncCustomTemplatesInProd: function (isProduction) {
+        CleverTapReact.syncCustomTemplatesInProd(isProduction)
+    },
+
+    /**
+     * Notify the SDK that an active custom template is dismissed. The active custom template is considered to be
+     * visible to the user until this method is called. Since the SDK can show only one InApp message at a time, all
+     * other messages will be queued until the current one is dismissed.
+     * 
+     * @param {string} templateName The name of the active template
+     */
+    customTemplateSetDismissed: function (templateName) {
+        return CleverTapReact.customTemplateSetDismissed(templateName);
+    },
+
+    /**
+     * Notify the SDK that an active custom template is presented to the user
+     * 
+     * @param {string} templateName The name of the active template
+     */
+    customTemplateSetPresented: function (templateName) {
+        return CleverTapReact.customTemplateSetPresented(templateName);
+    },
+
+    /**
+     * Trigger a custom template action argument by name.
+     * 
+     * @param {string} templateName The name of an active template for which the action is defined
+     * @param {string} argName The action argument name
+     */
+    customTemplateRunAction: function (templateName, argName) {
+        return CleverTapReact.customTemplateRunAction(templateName, argName);
+    },
+
+    /**
+     * Retrieve a string argument by name.
+     *
+     * @param {string} templateName The name of an active template for which the argument is defined
+     * @param {string} argName The action argument name
+     * 
+     * @returns {string} The argument value or null if no such argument is defined for the template.
+     */
+    customTemplateGetStringArg: function (templateName, argName) {
+       return CleverTapReact.customTemplateGetStringArg(templateName, argName);
+    },
+
+    /**
+     * Retrieve a number argument by name.
+     *
+     * @param {string} templateName The name of an active template for which the argument is defined
+     * @param {string} argName The action argument name
+     * 
+     * @returns {number} The argument value or null if no such argument is defined for the template.
+     */
+    customTemplateGetNumberArg: function (templateName, argName) {
+        return CleverTapReact.customTemplateGetNumberArg(templateName, argName);
+    },
+
+    /**
+     * Retrieve a boolean argument by name.
+     *
+     * @param {string} templateName The name of an active template for which the argument is defined
+     * @param {stirng} argName The action argument name
+     * 
+     * @returns {boolean} The argument value or null if no such argument is defined for the template.
+     */
+    customTemplateGetBooleanArg: function (templateName, argName) {
+        return CleverTapReact.customTemplateGetBooleanArg(templateName, argName);
+    },
+
+    /**
+     * Retrieve a file argument by name.
+     *
+     * @param {string} templateName The name of an active template for which the argument is defined
+     * @param {string} argName The action argument name
+     * 
+     * @returns {string} The file path to the file or null if no such argument is defined for the template.
+     */
+    customTemplateGetFileArg: function (templateName, argName) {
+        return CleverTapReact.customTemplateGetFileArg(templateName, argName);
+    },
+
+    /**
+     * Retrieve an object argument by name.
+     *
+     * @param {string} templateName The name of an active template for which the argument is defined
+     * @param {string} argName The action argument name
+     * 
+     * @returns {any} The argument value or null if no such argument is defined for the template.
+     */
+    customTemplateGetObjectArg: function (templateName, argName) {
+        return CleverTapReact.customTemplateGetObjectArg(templateName, argName);
+    },
+
+    /**
+     * Get a string representation of an active's template context with information about all arguments. 
+     * 
+     * @param {string} templateName The name of an active template
+     * @returns {string}
+     */
+    customTemplateContextToString: function (templateName) {
+        return CleverTapReact.customTemplateContextToString(templateName);
     }
 };
 

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

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

package/android/.gradle/config.properties

@@ -1,2 +0,0 @@
-#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

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

package/android/local.properties

@@ -1,8 +0,0 @@
-## This file must *NOT* be checked into Version Control Systems,
-# as it contains information specific to your local configuration.
-#
-# Location of the SDK. This is only used by Gradle.
-# For customization when using a Version Control System, please read the
-# header note.
-#Tue Mar 05 15:18:18 IST 2024
-sdk.dir=/Users/anush/Library/Android/sdk