feat: support skip version and cancel update callback

Author: LucasXu0

packages/auto_updater/analysis_options.yaml

@@ -1 +1,34 @@
-include: package:mostly_reasonable_lints/analysis_options.yaml
+include: package:flutter_lints/flutter.yaml
+
+analyzer:
+  exclude:
+    - "**/*.g.dart"
+    - "**/*.freezed.dart"
+
+linter:
+  rules:
+    - require_trailing_commas
+
+    - prefer_collection_literals
+    - prefer_final_fields
+    - prefer_final_in_for_each
+    - prefer_final_locals
+
+    - sized_box_for_whitespace
+    - use_decorated_box
+
+    - unnecessary_parenthesis
+    - unnecessary_await_in_return
+    - unnecessary_raw_strings
+
+    - avoid_unnecessary_containers
+    - avoid_redundant_argument_values
+    - avoid_unused_constructor_parameters
+
+    - always_declare_return_types
+
+    - sort_constructors_first
+    - unawaited_futures
+
+errors:
+  invalid_annotation_target: ignore

packages/auto_updater/bin/generate_keys.dart

@@ -7,7 +7,7 @@ Future<void> main(List<String> arguments) async {
     throw UnsupportedError('auto_updater:generate_keys');
   }
 
-  String executable = Platform.isMacOS
+  final String executable = Platform.isMacOS
       ? '${Directory.current.path}/macos/Pods/Sparkle/bin/generate_keys'
       : p.joinAll(
           [
@@ -24,7 +24,7 @@ Future<void> main(List<String> arguments) async {
           ],
         );
 
-  Process process = await Process.start(
+  final Process process = await Process.start(
     executable,
     arguments,
   );

packages/auto_updater/bin/sign_update.dart

@@ -12,7 +12,7 @@ class SignUpdateResult {
 }
 
 SignUpdateResult signUpdate(List<String> args) {
-  String executable = Platform.isMacOS
+  final String executable = Platform.isMacOS
       ? '${Directory.current.path}/macos/Pods/Sparkle/bin/sign_update'
       : p.joinAll(
           [
@@ -28,19 +28,19 @@ SignUpdateResult signUpdate(List<String> args) {
             'sign_update.bat',
           ],
         );
-  List<String> arguments = List<String>.from(args);
+  final List<String> arguments = List<String>.from(args);
   if (Platform.isWindows) {
     if (arguments.length == 1) {
       arguments.add(p.join('dsa_priv.pem'));
     }
   }
 
-  ProcessResult processResult = Process.runSync(
+  final ProcessResult processResult = Process.runSync(
     executable,
     arguments,
   );
 
-  int exitCode = processResult.exitCode;
+  final int exitCode = processResult.exitCode;
 
   String? signUpdateOutput;
   if (exitCode == 0) {
@@ -54,8 +54,8 @@ SignUpdateResult signUpdate(List<String> args) {
     stderr.write(processResult.stderr);
   }
 
-  RegExp regex = RegExp(r'sparkle:(dsa|ed)Signature="([^"]+)" length="(\d+)"');
-  RegExpMatch? match = regex.firstMatch(signUpdateOutput!);
+  final RegExp regex = RegExp(r'sparkle:(dsa|ed)Signature="([^"]+)" length="(\d+)"');
+  final RegExpMatch? match = regex.firstMatch(signUpdateOutput!);
 
   if (match == null) {
     throw Exception('Failed to sign update');

packages/auto_updater/example/windows/flutter/generated_plugin_registrant.cc

@@ -7,14 +7,14 @@
 #include "generated_plugin_registrant.h"
 
 #include <auto_updater_windows/auto_updater_windows_plugin_c_api.h>
-#include <screen_retriever/screen_retriever_plugin.h>
+#include <screen_retriever_windows/screen_retriever_windows_plugin_c_api.h>
 #include <window_manager/window_manager_plugin.h>
 
 void RegisterPlugins(flutter::PluginRegistry* registry) {
   AutoUpdaterWindowsPluginCApiRegisterWithRegistrar(
       registry->GetRegistrarForPlugin("AutoUpdaterWindowsPluginCApi"));
-  ScreenRetrieverPluginRegisterWithRegistrar(
-      registry->GetRegistrarForPlugin("ScreenRetrieverPlugin"));
+  ScreenRetrieverWindowsPluginCApiRegisterWithRegistrar(
+      registry->GetRegistrarForPlugin("ScreenRetrieverWindowsPluginCApi"));
   WindowManagerPluginRegisterWithRegistrar(
       registry->GetRegistrarForPlugin("WindowManagerPlugin"));
 }

packages/auto_updater/example/windows/flutter/generated_plugins.cmake

@@ -4,7 +4,7 @@
 
 list(APPEND FLUTTER_PLUGIN_LIST
   auto_updater_windows
-  screen_retriever
+  screen_retriever_windows
   window_manager
 )
 

packages/auto_updater/lib/auto_updater.dart

@@ -2,5 +2,7 @@ library auto_updater;
 
 export 'src/appcast.dart';
 export 'src/auto_updater.dart';
+export 'src/events.dart';
 export 'src/updater_error.dart';
 export 'src/updater_listener.dart';
+export 'src/user_update_choice.dart';

packages/auto_updater/lib/src/auto_updater.dart

@@ -1,8 +1,10 @@
 import 'dart:async';
 
 import 'package:auto_updater/src/appcast.dart';
+import 'package:auto_updater/src/events.dart';
 import 'package:auto_updater/src/updater_error.dart';
 import 'package:auto_updater/src/updater_listener.dart';
+import 'package:auto_updater/src/user_update_choice.dart';
 import 'package:auto_updater_platform_interface/auto_updater_platform_interface.dart';
 
 class AutoUpdater {
@@ -17,84 +19,78 @@ class AutoUpdater {
 
   final List<UpdaterListener> _listeners = [];
 
-  void _handleSparkleEvents(event) {
-    UpdaterError? updaterError;
-    Appcast? appcast;
-    AppcastItem? appcastItem;
-
-    String type = event['type'] as String;
-    Map<Object?, Object?>? data;
-    if (event['data'] != null) {
-      data = event['data'] as Map;
-      if (data['error'] != null) {
-        updaterError = UpdaterError(
-          data['error'].toString(),
-        );
-      }
-      if (data['appcast'] != null) {
-        appcast = Appcast.fromJson(
-          Map<String, dynamic>.from(
-            (data['appcast'] as Map).cast<String, dynamic>(),
-          ),
-        );
-      }
-      if (data['appcastItem'] != null) {
-        appcastItem = AppcastItem.fromJson(
-          Map<String, dynamic>.from(
-            (data['appcastItem'] as Map).cast<String, dynamic>(),
-          ),
-        );
-      }
-    }
-    for (var listener in _listeners) {
-      switch (type) {
-        case 'error':
-          listener.onUpdaterError(updaterError);
-          break;
-        case 'checking-for-update':
-          listener.onUpdaterCheckingForUpdate(appcast);
-          break;
-        case 'update-available':
-          listener.onUpdaterUpdateAvailable(appcastItem);
-          break;
-        case 'update-not-available':
-          listener.onUpdaterUpdateNotAvailable(updaterError);
-          break;
-        case 'update-downloaded':
-          listener.onUpdaterUpdateDownloaded(appcastItem);
-          break;
-        case 'before-quit-for-update':
-          listener.onUpdaterBeforeQuitForUpdate(appcastItem);
-          break;
-      }
-    }
-  }
-
   /// Adds a listener to the auto updater.
-  void addListener(UpdaterListener listener) {
-    _listeners.add(listener);
-  }
+  void addListener(UpdaterListener listener) => _listeners.add(listener);
 
   /// Removes a listener from the auto updater.
-  void removeListener(UpdaterListener listener) {
-    _listeners.remove(listener);
-  }
+  void removeListener(UpdaterListener listener) => _listeners.remove(listener);
 
   /// Sets the url and initialize the auto updater.
-  Future<void> setFeedURL(String feedUrl) {
-    return _platform.setFeedURL(feedUrl);
-  }
+  Future<void> setFeedURL(String feedUrl) => _platform.setFeedURL(feedUrl);
 
   /// Asks the server whether there is an update. You must call setFeedURL before using this API.
-  Future<void> checkForUpdates({bool? inBackground}) {
-    return _platform.checkForUpdates(
-      inBackground: inBackground,
-    );
-  }
+  Future<void> checkForUpdates({bool? inBackground}) =>
+      _platform.checkForUpdates(inBackground: inBackground);
 
   /// Sets the auto update check interval, default 86400, minimum 3600, 0 to disable update
-  Future<void> setScheduledCheckInterval(int interval) {
-    return _platform.setScheduledCheckInterval(interval);
+  Future<void> setScheduledCheckInterval(int interval) =>
+      _platform.setScheduledCheckInterval(interval);
+
+  /// Checks for update information.
+  Future<void> checkForUpdateInformation() =>
+      _platform.checkForUpdateInformation();
+
+  void _handleSparkleEvents(dynamic event) {
+    final type = event['type'] as String;
+    final eventType = UpdaterEvent.fromString(type);
+    final eventData = event['data'] as Map<Object?, Object?>?;
+
+    if (eventData == null) return;
+
+    // Parse event data
+    final updaterError = eventData['error'] != null
+        ? UpdaterError(eventData['error'].toString())
+        : null;
+
+    final appcast = eventData['appcast'] is Map
+        ? Appcast.fromJson(
+            Map<String, dynamic>.from(
+              (eventData['appcast'] as Map).cast<String, dynamic>(),
+            ),
+          )
+        : null;
+
+    final appcastItem = eventData['appcastItem'] is Map
+        ? AppcastItem.fromJson(
+            Map<String, dynamic>.from(
+              (eventData['appcastItem'] as Map).cast<String, dynamic>(),
+            ),
+          )
+        : null;
+
+    final userUpdateChoice = eventData['choice'] is int
+        ? UserUpdateChoice.values[eventData['choice'] as int]
+        : null;
+
+    // Notify listeners
+    for (final listener in _listeners) {
+      switch (eventType) {
+        case UpdaterEvent.error:
+          listener.onUpdaterError(updaterError);
+        case UpdaterEvent.checkingForUpdate:
+          listener.onUpdaterCheckingForUpdate(appcast);
+        case UpdaterEvent.updateAvailable:
+          listener.onUpdaterUpdateAvailable(appcastItem);
+        case UpdaterEvent.updateNotAvailable:
+          listener.onUpdaterUpdateNotAvailable(updaterError);
+        case UpdaterEvent.updateDownloaded:
+          listener.onUpdaterUpdateDownloaded(appcastItem);
+        case UpdaterEvent.beforeQuitForUpdate:
+          listener.onUpdaterBeforeQuitForUpdate(appcastItem);
+        case UpdaterEvent.userUpdateChoice:
+          listener.onUpdaterUserUpdateChoice(userUpdateChoice, appcastItem);
+      }
+    }
   }
 }
 

packages/auto_updater/lib/src/events.dart

@@ -0,0 +1,30 @@
+enum UpdaterEvent {
+  error,
+  checkingForUpdate,
+  updateAvailable,
+  updateNotAvailable,
+  updateDownloaded,
+  beforeQuitForUpdate,
+  userUpdateChoice;
+
+  static UpdaterEvent fromString(String name) {
+    switch (name) {
+      case 'error':
+        return UpdaterEvent.error;
+      case 'checking-for-update':
+        return UpdaterEvent.checkingForUpdate;
+      case 'update-available':
+        return UpdaterEvent.updateAvailable;
+      case 'update-not-available':
+        return UpdaterEvent.updateNotAvailable;
+      case 'update-downloaded':
+        return UpdaterEvent.updateDownloaded;
+      case 'before-quit-for-update':
+        return UpdaterEvent.beforeQuitForUpdate;
+      case 'user-update-choice':
+        return UpdaterEvent.userUpdateChoice;
+      default:
+        throw ArgumentError('Invalid event name: $name');
+    }
+  }
+}

packages/auto_updater/lib/src/updater_listener.dart

@@ -7,4 +7,8 @@ abstract mixin class UpdaterListener {
   void onUpdaterUpdateNotAvailable(UpdaterError? error);
   void onUpdaterUpdateDownloaded(AppcastItem? appcastItem);
   void onUpdaterBeforeQuitForUpdate(AppcastItem? appcastItem);
+  void onUpdaterUserUpdateChoice(
+    UserUpdateChoice? choice,
+    AppcastItem? appcastItem,
+  );
 }

packages/auto_updater/lib/src/user_update_choice.dart

@@ -0,0 +1,5 @@
+enum UserUpdateChoice {
+  skip,
+  install,
+  dismiss,
+}