Development/dependencies and comments (crowdin#29)

Author: FlutterOd

lib/src/crowdin.dart

@@ -45,6 +45,7 @@ class Crowdin {
 
   static final _api = CrowdinApi();
 
+  /// if _withRealTimeUpdates = true, real-time preview is enabled and authentication is required
   static bool _withRealTimeUpdates = false;
 
   static bool get withRealTimeUpdates => _withRealTimeUpdates;
@@ -54,8 +55,10 @@ class Crowdin {
     _withRealTimeUpdates = value;
   }
 
+  /// contains configuration for real-time preview functionality
   static late CrowdinPreviewManager crowdinPreviewManager;
 
+  /// contains all parameters needed for OAuth authentication
   static late CrowdinAuthConfig? _authConfig;
 
   /// Crowdin SDK initialization

lib/src/gen/crowdin_generator.dart

@@ -7,8 +7,6 @@ import 'package:path/path.dart' as path;
 import '../common/gen_l10n_types.dart';
 import 'l10n_config.dart';
 
-///todo refactor to reuse getKeys in real-time preview
-
 class CrowdinGenerator {
   static Future<void> generate() async {
     final String projectDirectory = Directory.current.path;

lib/src/real_time_preview/crowdin_preview_manager.dart

@@ -39,6 +39,7 @@ class CrowdinPreviewManager {
 
   late AppResourceBundle previewArb;
 
+  // set preview arb when locale changes
   void setPreviewArb(AppResourceBundle distributionArb) {
     previewArb = distributionArb;
 
@@ -63,6 +64,7 @@ class CrowdinPreviewManager {
     }
   }
 
+  // sort only needed key-value pairs
   Map<String, String> getFinalMappingData(
       Map<String, dynamic> mappingData, Map<String, String> currentMap) {
     var data = mappingData;
@@ -136,6 +138,7 @@ class CrowdinPreviewManager {
     }
   }
 
+  // update preview arb when translation change received
   @visibleForTesting
   void updatePreviewArb({
     required String id,

lib/src/real_time_preview/crowdin_real_time_preview_widget.dart

@@ -2,6 +2,8 @@ import 'package:flutter/material.dart';
 
 import '../../crowdin_sdk.dart';
 
+/// Wrap your app root widget with the CrowdinRealTimePreviewWidget to provide UI updates after
+/// translation updates receiving
 class CrowdinRealTimePreviewWidget extends StatefulWidget {
   final Widget child;
 
@@ -30,6 +32,7 @@ class _CrowdinRealTimePreviewWidgetState
     }
   }
 
+  // rebuild every widget in the tree without calling setState()
   void _rebuildTree(String textKey) {
     (context as Element).visitChildElements(
         (element) => _elementRebuildVisitor(element, textKey));

pubspec.yaml

@@ -11,17 +11,17 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  http: ^0.13.3
+  http: '>=0.13.3 <2.0.0'
   intl: '>=0.17.0 <0.19.0'
   shared_preferences: ^2.0.4
-  connectivity_plus: '>=2.1.0 <3.9.0'
+  connectivity_plus: '>=2.1.0 <5.0.0'
   yaml: ^3.1.1
   meta: ^1.7.0
   path: ^1.8.1
   oauth2: ^2.0.1
-  url_launcher: ^6.1.10
+  url_launcher: ^6.1.0
   uni_links: ^0.5.1
-  web_socket_channel: ^2.4.0
+  web_socket_channel: ^2.2.0
 
   flutter_localizations:
     sdk: flutter