chore: Add auto_updater_macos package

Author: lijy91

packages/auto_updater/example/lib/pages/home.dart

@@ -1,5 +1,6 @@
 import 'package:auto_updater/auto_updater.dart';
 import 'package:bot_toast/bot_toast.dart';
+import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:preference_list/preference_list.dart';
 
@@ -10,16 +11,23 @@ class HomePage extends StatefulWidget {
   State<HomePage> createState() => _HomePageState();
 }
 
-class _HomePageState extends State<HomePage> {
+class _HomePageState extends State<HomePage> with UpdaterListener {
   final String _feedURL = 'http://localhost:5002/appcast.xml';
 
   bool _isFeedURLSetted = false;
 
   @override
   void initState() {
+    autoUpdater.addListener(this);
     super.initState();
   }
 
+  @override
+  void dispose() {
+    autoUpdater.removeListener(this);
+    super.dispose();
+  }
+
   Future<void> _handleClickSetFeedURL() async {
     await autoUpdater.setFeedURL(_feedURL);
     _isFeedURLSetted = true;
@@ -87,4 +95,46 @@ class _HomePageState extends State<HomePage> {
       body: _buildBody(context),
     );
   }
+
+  @override
+  void onUpdaterError(UpdaterError? error) {
+    if (kDebugMode) {
+      print('onUpdaterError: $error');
+    }
+  }
+
+  @override
+  void onUpdaterCheckingForUpdate(Appcast? appcast) {
+    if (kDebugMode) {
+      print('onUpdaterCheckingForUpdate: ${appcast?.toJson()}');
+    }
+  }
+
+  @override
+  void onUpdaterUpdateAvailable(AppcastItem? item) {
+    if (kDebugMode) {
+      print('onUpdaterUpdateAvailable: ${item?.toJson()}');
+    }
+  }
+
+  @override
+  void onUpdaterUpdateNotAvailable(UpdaterError? error) {
+    if (kDebugMode) {
+      print('onUpdaterUpdateNotAvailable: $error');
+    }
+  }
+
+  @override
+  void onUpdaterUpdateDownloaded(AppcastItem? item) {
+    if (kDebugMode) {
+      print('onUpdaterUpdateDownloaded: ${item?.toJson()}');
+    }
+  }
+
+  @override
+  void onUpdaterBeforeQuitForUpdate(AppcastItem? item) {
+    if (kDebugMode) {
+      print('onUpdaterBeforeQuitForUpdate: ${item?.toJson()}');
+    }
+  }
 }

packages/auto_updater/example/macos/Flutter/GeneratedPluginRegistrant.swift

@@ -5,12 +5,12 @@
 import FlutterMacOS
 import Foundation
 
-import auto_updater
+import auto_updater_macos
 import screen_retriever
 import window_manager
 
 func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
-  AutoUpdaterPlugin.register(with: registry.registrar(forPlugin: "AutoUpdaterPlugin"))
+  AutoUpdaterMacosPlugin.register(with: registry.registrar(forPlugin: "AutoUpdaterMacosPlugin"))
   ScreenRetrieverPlugin.register(with: registry.registrar(forPlugin: "ScreenRetrieverPlugin"))
   WindowManagerPlugin.register(with: registry.registrar(forPlugin: "WindowManagerPlugin"))
 }

packages/auto_updater/example/macos/Podfile.lock

@@ -1,16 +1,16 @@
 PODS:
-  - auto_updater (0.0.1):
+  - auto_updater_macos (0.0.1):
     - FlutterMacOS
     - Sparkle
   - FlutterMacOS (1.0.0)
   - screen_retriever (0.0.1):
     - FlutterMacOS
-  - Sparkle (2.0.0)
+  - Sparkle (2.5.2)
   - window_manager (0.2.0):
     - FlutterMacOS
 
 DEPENDENCIES:
-  - auto_updater (from `Flutter/ephemeral/.symlinks/plugins/auto_updater/macos`)
+  - auto_updater_macos (from `Flutter/ephemeral/.symlinks/plugins/auto_updater_macos/macos`)
   - FlutterMacOS (from `Flutter/ephemeral`)
   - screen_retriever (from `Flutter/ephemeral/.symlinks/plugins/screen_retriever/macos`)
   - window_manager (from `Flutter/ephemeral/.symlinks/plugins/window_manager/macos`)
@@ -20,8 +20,8 @@ SPEC REPOS:
     - Sparkle
 
 EXTERNAL SOURCES:
-  auto_updater:
-    :path: Flutter/ephemeral/.symlinks/plugins/auto_updater/macos
+  auto_updater_macos:
+    :path: Flutter/ephemeral/.symlinks/plugins/auto_updater_macos/macos
   FlutterMacOS:
     :path: Flutter/ephemeral
   screen_retriever:
@@ -30,10 +30,10 @@ EXTERNAL SOURCES:
     :path: Flutter/ephemeral/.symlinks/plugins/window_manager/macos
 
 SPEC CHECKSUMS:
-  auto_updater: d3c03e9e5f2a00ec78572d9f7473cb8c9a6c0273
+  auto_updater_macos: 3e3462c418fe4e731917eacd8d28eef7af84086d
   FlutterMacOS: 8f6f14fa908a6fb3fba0cd85dbd81ec4b251fb24
   screen_retriever: 59634572a57080243dd1bf715e55b6c54f241a38
-  Sparkle: 128c668ddd0780beb08576ce18460d2a37f64f9f
+  Sparkle: 0e335e5c704ac28dbea18cc0383e15a3927c28dc
   window_manager: 3a1844359a6295ab1e47659b1a777e36773cd6e8
 
 PODFILE CHECKSUM: 353c8bcc5d5b0994e508d035b5431cfe18c1dea7

packages/auto_updater/lib/auto_updater.dart

@@ -1 +1,6 @@
+library auto_updater;
+
+export 'src/appcast.dart';
 export 'src/auto_updater.dart';
+export 'src/updater_error.dart';
+export 'src/updater_listener.dart';

packages/auto_updater/lib/src/appcast.dart

@@ -0,0 +1,65 @@
+import 'package:json_annotation/json_annotation.dart';
+
+part 'appcast.g.dart';
+
+@JsonSerializable()
+class Appcast {
+  const Appcast({
+    required this.items,
+  });
+
+  factory Appcast.fromJson(Map<String, dynamic> json) {
+    json['items'] = (json['items'] as List)
+        .map((e) => (e as Map).cast<String, dynamic>())
+        .toList();
+    return _$AppcastFromJson(json);
+  }
+
+  final List<AppcastItem> items;
+
+  Map<String, dynamic> toJson() => _$AppcastToJson(this);
+}
+
+@JsonSerializable()
+class AppcastItem {
+  const AppcastItem({
+    this.versionString,
+    this.displayVersionString,
+    this.fileURL,
+    this.contentLength,
+    this.infoURL,
+    this.title,
+    this.dateString,
+    this.releaseNotesURL,
+    this.itemDescription,
+    this.itemDescriptionFormat,
+    this.fullReleaseNotesURL,
+    this.minimumSystemVersion,
+    this.minimumOperatingSystemVersionIsOK,
+    this.maximumSystemVersion,
+    this.maximumOperatingSystemVersionIsOK,
+    this.channel,
+  });
+
+  factory AppcastItem.fromJson(Map<String, dynamic> json) =>
+      _$AppcastItemFromJson(json);
+
+  final String? versionString;
+  final String? displayVersionString;
+  final String? fileURL;
+  final int? contentLength;
+  final String? infoURL;
+  final String? title;
+  final String? dateString;
+  final String? releaseNotesURL;
+  final String? itemDescription;
+  final String? itemDescriptionFormat;
+  final String? fullReleaseNotesURL;
+  final String? minimumSystemVersion;
+  final bool? minimumOperatingSystemVersionIsOK;
+  final String? maximumSystemVersion;
+  final bool? maximumOperatingSystemVersionIsOK;
+  final String? channel;
+
+  Map<String, dynamic> toJson() => _$AppcastItemToJson(this);
+}

packages/auto_updater/lib/src/appcast.g.dart

@@ -1,50 +1,101 @@
 import 'dart:async';
 
-import 'package:flutter/services.dart';
+import 'package:auto_updater/src/appcast.dart';
+import 'package:auto_updater/src/updater_error.dart';
+import 'package:auto_updater/src/updater_listener.dart';
+import 'package:auto_updater_platform_interface/auto_updater_platform_interface.dart';
 
 class AutoUpdater {
   AutoUpdater._() {
-    _channel.setMethodCallHandler(_methodCallHandler);
+    _platform.sparkleEvents.listen(_handleSparkleEvents);
   }
 
   /// The shared instance of [AutoUpdater].
   static final AutoUpdater instance = AutoUpdater._();
 
-  /// Event stream for sparkle/winsparkle events
-  final _eventController = StreamController<String>.broadcast();
-  Stream<String> get sparkleEvents => _eventController.stream;
+  AutoUpdaterPlatform get _platform => AutoUpdaterPlatform.instance;
 
-  final MethodChannel _channel = const MethodChannel('auto_updater');
+  final List<UpdaterListener> _listeners = [];
 
-  Future<void> _methodCallHandler(MethodCall call) async {
-    if (call.method != 'onEvent') throw UnimplementedError();
-    if (!call.arguments.containsKey('eventName')) throw UnimplementedError();
+  void _handleSparkleEvents(event) {
+    UpdaterError? updaterError;
+    Appcast? appcast;
+    AppcastItem? appcastItem;
 
-    _eventController.add(call.arguments['eventName']);
+    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);
+  }
+
+  /// Removes a listener from the auto updater.
+  void removeListener(UpdaterListener listener) {
+    _listeners.remove(listener);
   }
 
   /// Sets the url and initialize the auto updater.
-  Future<void> setFeedURL(String feedUrl) async {
-    final Map<String, dynamic> arguments = {
-      'feedURL': feedUrl,
-    };
-    await _channel.invokeMethod('setFeedURL', arguments);
+  Future<void> setFeedURL(String feedUrl) {
+    return _platform.setFeedURL(feedUrl);
   }
 
   /// Asks the server whether there is an update. You must call setFeedURL before using this API.
-  Future<void> checkForUpdates({bool? inBackground}) async {
-    final Map<String, dynamic> arguments = {
-      'inBackground': inBackground ?? false,
-    };
-    await _channel.invokeMethod('checkForUpdates', arguments);
+  Future<void> checkForUpdates({bool? inBackground}) {
+    return _platform.checkForUpdates(
+      inBackground: inBackground,
+    );
   }
 
   /// Sets the auto update check interval, default 86400, minimum 3600, 0 to disable update
-  Future<void> setScheduledCheckInterval(int interval) async {
-    final Map<String, dynamic> arguments = {
-      'interval': interval,
-    };
-    await _channel.invokeMethod('setScheduledCheckInterval', arguments);
+  Future<void> setScheduledCheckInterval(int interval) {
+    return _platform.setScheduledCheckInterval(interval);
   }
 }