Merge pull request #20 from SourcePointUSA/DIA-4960_add_language_param

DIA-4960 / DIA-4474 add language and messageTimeoutInSeconds build options

Author: andresilveirah

README.md

@@ -47,7 +47,8 @@ useEffect(() => {
     config.accountId,
     config.propertyId,
     config.propertyName,
-    config.campaigns
+    config.campaigns,
+    config.buildOptions
   );
 
   return () => {
@@ -64,6 +65,7 @@ The following attributes should be replaced with your organization's details:
 | `config.propertyId`   | Number        | ID for property found in the Sourcepoint portal                                                                                                                                                   |
 | `config.propertyName` | String        | Name of property found in the Sourcepoint portal                                                                                                                                                  |
 | `config.campaigns`    | Object        | Campaigns launched on the property through the Sourcepoint portal. Accepts `gdpr: {}`, `usnat: {}`, `preferences: {}` and `globalcmp: {}`. See table below for information on each campaign type. |
+| `config.buildOptions` | Object?       | Check `SPBuildOptions` type for more information. |
 
 Refer to the table below regarding the different campaigns that can be implemented:
 
@@ -210,7 +212,7 @@ In the example below, you can find a fully configured example in React:
 
 ```jsx
 import React, { useState, useEffect, useRef } from 'react';
-import { View, Text, SafeAreaView } from 'react-native';
+import { View, Text, SafeAreaView, SPMessageLanguage } from 'react-native';
 
 import SPConsentManager, { SPCampaignEnvironment, SPUserData } from '@sourcepoint/react-native-cmp';
 
@@ -231,6 +233,12 @@ export default function App() {
         // usnat: {},
         // preferences: {},
         // globalcmp: {}
+      },
+      {
+        // in order to override the message language, make sure the option "Use Browser Default"
+        // is disabled in the Sourcepoint dashboard
+        language: SPMessageLanguage.ENGLISH,
+        messageTimeoutInSeconds: 20,
       }
     );
 

android/src/main/java/com/sourcepoint/reactnativecmp/ReactNativeCmpModule.kt

@@ -19,6 +19,7 @@ import com.sourcepoint.cmplibrary.model.ConsentAction
 import com.sourcepoint.cmplibrary.model.exposed.SPConsents
 import com.sourcepoint.cmplibrary.util.clearAllData
 import com.sourcepoint.cmplibrary.util.userConsents
+import com.sourcepoint.reactnativecmp.arguments.BuildOptions
 import com.sourcepoint.reactnativecmp.consents.RNSPUserData
 import org.json.JSONObject
 
@@ -38,14 +39,17 @@ class ReactNativeCmpModule(reactContext: ReactApplicationContext) : NativeReactN
     accountId: Double,
     propertyId: Double,
     propertyName: String,
-    campaigns: ReadableMap
+    campaigns: ReadableMap,
+    options: ReadableMap?,
   ) {
     val convertedCampaigns = campaigns.SPCampaigns()
+    val parsedOptions = BuildOptions(options)
     val config = SpConfigDataBuilder().apply {
       addAccountId(accountId.toInt())
       addPropertyName(propertyName)
       addPropertyId(propertyId.toInt())
-      addMessageTimeout(30000)
+      addMessageTimeout(parsedOptions.messageTimeoutInSeconds)
+      addMessageLanguage(parsedOptions.language)
       convertedCampaigns.gdpr?.let {
         addCampaign(campaignType = GDPR, params = it.targetingParams, groupPmId = it.groupPmId)
       }

android/src/main/java/com/sourcepoint/reactnativecmp/arguments/Arguments.kt

@@ -1,6 +1,7 @@
 package com.sourcepoint.reactnativecmp.arguments
 
 import com.facebook.react.bridge.Arguments
+import com.facebook.react.bridge.ReadableMap
 import com.facebook.react.bridge.WritableArray
 import com.facebook.react.bridge.WritableMap
 import kotlinx.serialization.json.JsonArray
@@ -158,3 +159,10 @@ fun WritableMap.putArray(name: String, value: Iterable<*>) {
     value.forEach { this.pushAny(it) }
   })
 }
+
+fun ReadableMap.getLongOrNull(name: String) =
+  if (hasKey(name) && !isNull(name)) {
+    getLong(name)
+  } else {
+    null
+  }

android/src/main/java/com/sourcepoint/reactnativecmp/arguments/BuildOptions.kt

@@ -0,0 +1,15 @@
+package com.sourcepoint.reactnativecmp.arguments
+
+import com.facebook.react.bridge.ReadableMap
+import com.sourcepoint.cmplibrary.model.MessageLanguage
+import com.sourcepoint.cmplibrary.model.MessageLanguage.ENGLISH
+
+data class BuildOptions(
+  val language: MessageLanguage,
+  val messageTimeoutInSeconds: Long,
+) {
+  constructor(options: ReadableMap?) : this(
+    language = MessageLanguage.entries.find { it.value == options?.getString("language") } ?: ENGLISH,
+    messageTimeoutInSeconds = options?.getLongOrNull("messageTimeoutInSeconds") ?: 30000
+  )
+}

example/src/App.tsx

@@ -11,6 +11,7 @@ import { LaunchArguments } from 'react-native-launch-arguments';
 
 import SPConsentManager, {
   SPCampaignEnvironment,
+  SPMessageLanguage,
 } from '@sourcepoint/react-native-cmp';
 import type { SPCampaigns, SPUserData } from '@sourcepoint/react-native-cmp';
 import type { LaunchArgs } from './LaunchArgs';
@@ -31,6 +32,12 @@ const config = {
   accountId: 22,
   propertyId: 16893,
   propertyName: 'mobile.multicampaign.demo',
+  buildOptions: {
+    // in order to override the message language, make sure the option "Use Browser Default"
+    // is disabled in the Sourcepoint dashboard
+    language: SPMessageLanguage.ENGLISH,
+    messageTimeoutInSeconds: 20,
+  },
   gdprPMId: '488393',
   usnatPMId: '988851',
   globalCmpPMId: '1323762',
@@ -58,7 +65,8 @@ export default function App() {
       config.accountId,
       config.propertyId,
       config.propertyName,
-      config.campaigns
+      config.campaigns,
+      config.buildOptions
     );
 
     if (launchArgs.clearData === true) {
@@ -127,7 +135,8 @@ export default function App() {
       config.accountId,
       config.propertyId,
       config.propertyName,
-      config.campaigns
+      config.campaigns,
+      config.buildOptions
     );
     setUserData({});
   }, []);
@@ -159,22 +168,22 @@ export default function App() {
         <Button
           title="Load GDPR PM"
           onPress={onGDPRPMPress}
-          disabled={disable || config.campaigns.gdpr == undefined}
+          disabled={disable || config.campaigns.gdpr === undefined}
         />
         <Button
           title="Load USNAT PM"
           onPress={onUSNATPMPress}
-          disabled={disable || config.campaigns.usnat == undefined}
+          disabled={disable || config.campaigns.usnat === undefined}
         />
         <Button
           title="Load GlobalCMP PM"
           onPress={onGlobalCMPPress}
-          disabled={disable || config.campaigns.globalcmp == undefined}
+          disabled={disable || config.campaigns.globalcmp === undefined}
         />
         <Button
           title="Load Preferences Center"
           onPress={onPreferencesPress}
-          disabled={disable || config.campaigns.preferences == undefined}
+          disabled={disable || config.campaigns.preferences === undefined}
         />
         <Button title="Clear All" onPress={onClearDataPress} />
         <Text testID="sdkStatus" style={styles.status}>

example/src/LaunchArgs.ts

@@ -1,4 +1,7 @@
-import type { SPCampaigns } from '@sourcepoint/react-native-cmp';
+import type {
+  SPCampaigns,
+  SPBuildOptions
+} from '@sourcepoint/react-native-cmp';
 
 export type LaunchArgs = {
   config?: {
@@ -8,6 +11,7 @@ export type LaunchArgs = {
     gdprPMId?: string;
     usnatPMId?: string;
     campaigns?: SPCampaigns;
+    buildOptions?: SPBuildOptions;
   };
   authId?: string;
   clearData?: boolean;

ios/RNSourcepointCmp.swift

@@ -9,6 +9,16 @@ import ConsentViewController
 import Foundation
 import React
 
+@objcMembers public class RNBuildOptions: NSObject {
+  public let language: String
+  public let messageTimeout: Int
+
+  @objc public init(language: String, messageTimeout: Int) {
+    self.language = language
+    self.messageTimeout = messageTimeout
+  }
+}
+
 @objcMembers public class RNAction: NSObject {
   public let type: RNSourcepointActionType
   public let customActionId: String?
@@ -80,7 +90,14 @@ import React
     UIApplication.shared.delegate?.window??.rootViewController
   }
 
-  public func build(_ accountId: Int, propertyId: Int, propertyName: String, campaigns: RNSPCampaigns, delegate: ReactNativeCmpImplDelegate?) {
+  public func build(
+    accountId: Int,
+    propertyId: Int,
+    propertyName: String,
+    campaigns: RNSPCampaigns,
+    options: RNBuildOptions,
+    delegate: ReactNativeCmpImplDelegate?
+  ) {
     let manager = SPConsentManager(
       accountId: accountId,
       propertyId: propertyId,
@@ -89,7 +106,8 @@ import React
       delegate: Self.objcDelegate
     )
     self.delegate = delegate
-    manager.messageTimeoutInSeconds = 10
+    manager.messageLanguage = SPMessageLanguage.init(rawValue: options.language) ?? .English
+    manager.messageTimeoutInSeconds = TimeInterval(options.messageTimeout)
     Self.shared?.consentManager = manager
   }
 

ios/ReactNativeCmp.mm

@@ -6,7 +6,7 @@ @implementation ReactNativeCmp {
 }
 RCT_EXPORT_MODULE(ReactNativeCmpImpl)
 
-- (void)build:(double)accountId propertyId:(double)propertyId propertyName:(nonnull NSString *)propertyName campaigns:(JS::NativeReactNativeCmp::SPCampaigns &)campaigns {
+- (void)build:(double)accountId propertyId:(double)propertyId propertyName:(nonnull NSString *)propertyName campaigns:(JS::NativeReactNativeCmp::SPCampaigns &)campaigns options:(JS::NativeReactNativeCmp::SPBuildOptions &)options {
   if (sdk == nil) {
     sdk = [[ReactNativeCmpImpl alloc] init];
   }
@@ -61,11 +61,18 @@ - (void)build:(double)accountId propertyId:(double)propertyId propertyName:(nonn
                                                              globalcmp: globalcmp
                                                              environment:RNSPCampaignEnvPublic];
 
+  RNBuildOptions *buildOptions = [
+    [RNBuildOptions alloc]
+      initWithLanguage: options.language()
+      messageTimeout: options.messageTimeoutInSeconds().has_value() ? (NSInteger)options.messageTimeoutInSeconds().value(): 30
+  ];
+
   [sdk
-   build:(NSInteger)accountId
+   buildWithAccountId:(NSInteger)accountId
    propertyId:(NSInteger)propertyId
    propertyName:propertyName
    campaigns: internalCampaigns
+   options: buildOptions
    delegate: self
   ];
 }

lefthook.yml

@@ -74,7 +74,6 @@
     "@eslint/compat": "^1.2.7",
     "@eslint/eslintrc": "^3.3.0",
     "@eslint/js": "^9.22.0",
-    "@evilmartians/lefthook": "^1.5.0",
     "@react-native-community/cli": "15.0.0-alpha.2",
     "@react-native/babel-preset": "0.79.2",
     "@react-native/eslint-config": "^0.78.0",