Merge pull request #40 from Usercentrics/create-property-disable-back-button

uc-diogo · web-flow · commit 0bfc47c8f77c · 2022-12-22T15:35:43.000Z
2.7.9
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,9 @@
 [Release Notes](https://docs.usercentrics.com/cmp_in_app_sdk/latest/about/history/)
+### 2.7.9
+
+## Features
+
+* Add a property to disable the system back button in the first layer
 
 ### 2.7.8
 
diff --git a/android/build.gradle b/android/build.gradle
@@ -1,4 +1,4 @@
-def usercentrics_version = "2.7.8"
+def usercentrics_version = "2.7.9"
 
 group 'com.usercentrics.sdk.flutter'
 version usercentrics_version
diff --git a/android/src/main/kotlin/com/usercentrics/sdk/flutter/serializer/GeneralStyleSettingsSerializer.kt b/android/src/main/kotlin/com/usercentrics/sdk/flutter/serializer/GeneralStyleSettingsSerializer.kt
@@ -22,5 +22,6 @@ internal fun Any?.deserializeGeneralStyleSettings(
         logo = this["logo"].deserializeImage(assetsProvider, activityProvider),
         font = this["font"].deserializeBannerFont(assetsProvider, activityProvider),
         links = this["links"].deserializeLegalLinksSettings(),
+        disableSystemBackButton = this["disableSystemBackButton"] as? Boolean,
     )
 }
diff --git a/example/ios/Podfile.lock b/example/ios/Podfile.lock
@@ -1,11 +1,11 @@
 PODS:
   - Flutter (1.0.0)
-  - Usercentrics (2.7.8)
-  - usercentrics_sdk (2.7.8):
+  - Usercentrics (2.7.9)
+  - usercentrics_sdk (2.7.9):
     - Flutter
-    - UsercentricsUI (= 2.7.8)
-  - UsercentricsUI (2.7.8):
-    - Usercentrics (= 2.7.8)
+    - UsercentricsUI (= 2.7.9)
+  - UsercentricsUI (2.7.9):
+    - Usercentrics (= 2.7.9)
   - webview_flutter_wkwebview (0.0.1):
     - Flutter
 
diff --git a/example/ios/RunnerTests/Bridge/ShowSecondLayerBridgeTest.swift b/example/ios/RunnerTests/Bridge/ShowSecondLayerBridgeTest.swift
@@ -68,7 +68,7 @@ class ShowSecondLayerBridgeTest: XCTestCase, BaseBridgeTestProtocol {
             XCTAssertEqual(consent["isEssential"] as! Bool, true)
 
             XCTAssertEqual(self.bannerProxy.showSecondLayerCount, 1)
-            XCTAssertEqual(self.bannerProxy.showSecondLayerBannerSettingsArg?.generalStyleSettings?.links, LegalLinksSettings.none)
+            XCTAssertEqual(self.bannerProxy.showSecondLayerBannerSettingsArg?.generalStyleSettings?.links, LegalLinksSettings.hidden)
             XCTAssertEqual(self.bannerProxy.showSecondLayerBannerSettingsArg?.secondLayerStyleSettings?.showCloseButton, true)
 
             expectation.fulfill()
@@ -81,7 +81,7 @@ class ShowSecondLayerBridgeTest: XCTestCase, BaseBridgeTestProtocol {
                     "showCloseButton": true,
                 ],
                 "generalStyleSettings": [
-                    "links": "NONE"
+                    "links": "HIDDEN"
                 ]
             ],
         ]
diff --git a/example/lib/customization_example_2.dart b/example/lib/customization_example_2.dart
@@ -56,6 +56,7 @@ const _general = GeneralStyleSettings(
   bordersColor: _grey,
   layerBackgroundColor: _dark,
   layerBackgroundSecondaryColor: _grey,
+  disableSystemBackButton: false,
 );
 
 final bannerSettingsCustomizationExample2 = BannerSettings(
diff --git a/ios/Classes/Serializer/LegalLinksSettingsSerializer.swift b/ios/Classes/Serializer/LegalLinksSettingsSerializer.swift
@@ -9,8 +9,8 @@ extension LegalLinksSettings {
             return LegalLinksSettings.secondLayerOnly
         case "BOTH":
             return LegalLinksSettings.both
-        case "NONE":
-            return LegalLinksSettings.none
+        case "HIDDEN":
+            return LegalLinksSettings.hidden
         default:
             return nil
         }
diff --git a/ios/usercentrics_sdk.podspec b/ios/usercentrics_sdk.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'usercentrics_sdk'
-  s.version          = '2.7.8'
+  s.version          = '2.7.9'
   s.summary          = 'Usercentrics Flutter SDK.'
   s.description      = <<-DESC
   Usercentrics Flutter SDK.
diff --git a/lib/src/internal/serializer/general_style_settings_serializer.dart b/lib/src/internal/serializer/general_style_settings_serializer.dart
@@ -21,6 +21,7 @@ class GeneralStyleSettingsSerializer {
           'font': _serializeFont(value.font),
           'logo': value.logo?.assetPath,
           'links': LegalLinksSettingsSerializer.serialize(value.links),
+          'disableSystemBackButton': value.disableSystemBackButton,
         };
 
   static dynamic _serializeFont(BannerFont? customFont) {
diff --git a/lib/src/internal/serializer/legal_links_settings_serializer.dart b/lib/src/internal/serializer/legal_links_settings_serializer.dart
@@ -11,8 +11,8 @@ class LegalLinksSettingsSerializer {
         return 'SECOND_LAYER_ONLY';
       case LegalLinksSettings.both:
         return 'BOTH';
-      case LegalLinksSettings.none:
-        return 'NONE';
+      case LegalLinksSettings.hidden:
+        return 'HIDDEN';
     }
   }
 }
diff --git a/lib/src/model/general_style_settings.dart b/lib/src/model/general_style_settings.dart
@@ -16,6 +16,7 @@ class GeneralStyleSettings {
     this.font,
     this.logo,
     this.links,
+    this.disableSystemBackButton,
   });
 
   /// The text color.
@@ -48,6 +49,8 @@ class GeneralStyleSettings {
   /// The Legal Links Settings.
   final LegalLinksSettings? links;
 
+  final bool? disableSystemBackButton;
+
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
@@ -63,7 +66,8 @@ class GeneralStyleSettings {
           toggleStyleSettings == other.toggleStyleSettings &&
           font == other.font &&
           logo == other.logo &&
-          links == other.links;
+          links == other.links &&
+          disableSystemBackButton == other.disableSystemBackButton;
 
   @override
   int get hashCode =>
@@ -76,11 +80,12 @@ class GeneralStyleSettings {
       toggleStyleSettings.hashCode ^
       font.hashCode ^
       logo.hashCode ^
-      links.hashCode;
+      links.hashCode ^
+      disableSystemBackButton.hashCode;
 
   @override
   String toString() {
-    return 'GeneralStyleSettings{textColor: $textColor, layerBackgroundColor: $layerBackgroundColor, layerBackgroundSecondaryColor: $layerBackgroundSecondaryColor, linkColor: $linkColor, tabColor: $tabColor, bordersColor: $bordersColor, toggleStyleSettings: $toggleStyleSettings, font: $font, logo: $logo, links: $links}';
+    return 'GeneralStyleSettings{textColor: $textColor, layerBackgroundColor: $layerBackgroundColor, layerBackgroundSecondaryColor: $layerBackgroundSecondaryColor, linkColor: $linkColor, tabColor: $tabColor, bordersColor: $bordersColor, toggleStyleSettings: $toggleStyleSettings, font: $font, logo: $logo, links: $links, disableSystemBackButton: $disableSystemBackButton}';
   }
 }
 
@@ -98,7 +103,7 @@ class ToggleStyleSettings {
   /// The active background color.
   final Color? activeBackgroundColor;
 
-  /// The inactive backgroun color.
+  /// The inactive background color.
   final Color? inactiveBackgroundColor;
 
   /// The disabled background color.
diff --git a/lib/src/model/legal_links_settings.dart b/lib/src/model/legal_links_settings.dart
@@ -1 +1 @@
-enum LegalLinksSettings { firstLayerOnly, secondLayerOnly, both, none }
+enum LegalLinksSettings { firstLayerOnly, secondLayerOnly, both, hidden }
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -9,7 +9,7 @@ repository: https://github.com/Usercentrics/flutter-sdk/
 #  [X] android/build.gradle
 #  [X] ios/usercentrics_sdk.podspec + pod install/update
 #  [X] CHANGELOG
-version: 2.7.8
+version: 2.7.9
 
 environment:
   sdk: ">=2.17.1 <3.0.0"
diff --git a/test/internal/bridge/show_first_layer_bridge_test.mock.dart b/test/internal/bridge/show_first_layer_bridge_test.mock.dart
@@ -111,7 +111,8 @@ const expectedArguments = {
         'fontSize': 20.0
       },
       'logo': 'images/flutter-logo.png',
-      'links': 'BOTH'
+      'links': 'BOTH',
+      'disableSystemBackButton': false,
     },
     "variantName": "variantA"
   },
@@ -162,6 +163,9 @@ const mockFont = BannerFont(
   boldFontAssetPath: "fonts/Lora-Bold.ttf",
   fontSize: 20,
 );
+
+const mockDisableSystemBackButton = false;
+
 const mockLogo = BannerImage(
   assetPath: "images/flutter-logo.png",
 );
@@ -170,6 +174,7 @@ const mockGeneralStyleSettings = GeneralStyleSettings(
   font: mockFont,
   logo: mockLogo,
   links: LegalLinksSettings.both,
+  disableSystemBackButton: mockDisableSystemBackButton,
 );
 
 const mockVariant = "variantA";
diff --git a/test/internal/bridge/show_second_layer_bridge_test.mock.dart b/test/internal/bridge/show_second_layer_bridge_test.mock.dart
@@ -87,7 +87,8 @@ const expectedArguments = {
         'fontSize': 20.0
       },
       'logo': 'images/flutter-logo.png',
-      'links': 'NONE'
+      'links': 'HIDDEN',
+      'disableSystemBackButton': false
     },
     "variantName": 'variantA'
   }
@@ -100,6 +101,8 @@ const mockFont = BannerFont(
 const mockLogo = BannerImage(
   assetPath: "images/flutter-logo.png",
 );
+const mockDisableSystemBackButton = false;
+
 final mockSecondLayerSettings = SecondLayerStyleSettings(
   showCloseButton: true,
   buttonLayout: ButtonLayout.row(buttons: [
@@ -113,6 +116,10 @@ final mockSecondLayerSettings = SecondLayerStyleSettings(
 );
 
 const mockGeneralStyleSettings = GeneralStyleSettings(
-    font: mockFont, logo: mockLogo, links: LegalLinksSettings.none);
+  font: mockFont,
+  logo: mockLogo,
+  links: LegalLinksSettings.hidden,
+  disableSystemBackButton: mockDisableSystemBackButton,
+);
 
 const mockVariant = "variantA";

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-def usercentrics_version = "2.7.8"`
	`1`	`+def usercentrics_version = "2.7.9"`
`2`	`2`
`3`	`3`	`group 'com.usercentrics.sdk.flutter'`
`4`	`4`	`version usercentrics_version`
Original file line number	Diff line number	Diff line change
`@@ -22,5 +22,6 @@ internal fun Any?.deserializeGeneralStyleSettings(`
`22`	`22`	`logo = this["logo"].deserializeImage(assetsProvider, activityProvider),`
`23`	`23`	`font = this["font"].deserializeBannerFont(assetsProvider, activityProvider),`
`24`	`24`	`links = this["links"].deserializeLegalLinksSettings(),`
	`25`	`+ disableSystemBackButton = this["disableSystemBackButton"] as? Boolean,`
`25`	`26`	`)`
`26`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@ class LegalLinksSettingsSerializer {`
`11`	`11`	`return 'SECOND_LAYER_ONLY';`
`12`	`12`	`case LegalLinksSettings.both:`
`13`	`13`	`return 'BOTH';`
`14`		`- case LegalLinksSettings.none:`
`15`		`- return 'NONE';`
	`14`	`+ case LegalLinksSettings.hidden:`
	`15`	`+ return 'HIDDEN';`
`16`	`16`	`}`
`17`	`17`	`}`
`18`	`18`	`}`