Merge pull request #1605 from ychin/sparkle-2.8.0

Sparkle 2.8.0

Author: ychin

src/MacVim/Sparkle_2.framework/Versions/B/Autoupdate

@@ -37,6 +37,8 @@ NS_ASSUME_NONNULL_BEGIN
  It also allows hooking up the updater's and user driver's delegates.
  
  If you need more control over what bundle you want to update, or you want to provide a custom user interface (via `SPUUserDriver`), please use `SPUUpdater` directly instead.
+ 
+ This class must be used on the main thread.
   */
 SU_EXPORT @interface SPUStandardUpdaterController : NSObject
 {

src/MacVim/Sparkle_2.framework/Versions/B/Headers/SPUStandardUpdaterController.h

@@ -42,6 +42,8 @@ NS_ASSUME_NONNULL_BEGIN
  - `feedURL`
  
  Please view the documentation on each of these properties for more detail if you are to configure them dynamically.
+ 
+ This class must be used on the main thread.
  */
 SU_EXPORT @interface SPUUpdater : NSObject
 
@@ -96,11 +98,13 @@ SU_EXPORT @interface SPUUpdater : NSObject
  
  If an update hasn't started, the user may be shown that a new check for updates is occurring.
  If an update has already been downloaded or begun installing from a previous session, the user may be presented to install that update.
- If the user is already being presented with an update, that update will be shown to the user in active focus.
+ If the user is already being presented with an update or update permission prompt, that notice may be shown to the user in active focus
+ (as long as the user driver is the standard `SPUStandardUserDriver` or if it implements `-[SPUUserDriver showUpdateInFocus]`).
  
  This will find updates that the user has previously opted into skipping.
- 
  See `canCheckForUpdates` property which can determine when this method may be invoked.
+
+ This must be called on the main thread.
  */
 - (void)checkForUpdates;
 
@@ -126,6 +130,8 @@ SU_EXPORT @interface SPUUpdater : NSObject
  This will not find updates that the user has opted into skipping.
  
  This method does not do anything if there is a `sessionInProgress`.
+
+ This must be called on the main thread.
  */
 - (void)checkForUpdatesInBackground;
 
@@ -144,13 +150,18 @@ SU_EXPORT @interface SPUUpdater : NSObject
  Updates that have been skipped by the user will not be found.
  
  This method does not do anything if there is a `sessionInProgress`.
+
+ This must be called on the main thread.
  */
 - (void)checkForUpdateInformation;
 
 /**
  A property indicating whether or not updates can be checked by the user.
  
- An update check can be made by the user when an update session isn't in progress, or when an update or its progress is being shown to the user.
+ An update check can be made by the user when an update session isn't in progress.
+ An update check can also be made when an update or its progress is being shown to the user
+ (as long as the user driver is the standard `SPUStandardUserDriver` or if it implements `-[SPUUserDriver showUpdateInFocus]`).
+ 
  A user cannot check for updates when data (such as the feed or an update) is still being downloaded automatically in the background.
  
  This property is suitable to use for menu item validation for seeing if `-checkForUpdates` can be invoked.
@@ -194,7 +205,9 @@ SU_EXPORT @interface SPUUpdater : NSObject
  to your app's command line arguments instead of setting this property.
  
  The update schedule cycle will be reset in a short delay after the property's new value is set.
- This is to allow reverting this property without kicking off a schedule change immediately
+ This is to allow reverting this property without kicking off a schedule change immediately.
+ 
+ This property is KVO compliant. This property must be called on the main thread.
  */
 @property (nonatomic) BOOL automaticallyChecksForUpdates;
 
@@ -209,7 +222,9 @@ SU_EXPORT @interface SPUUpdater : NSObject
  Do not always set it on launch unless you want to ignore the user's preference.
  
  The update schedule cycle will be reset in a short delay after the property's new value is set.
- This is to allow reverting this property without kicking off a schedule change immediately
+ This is to allow reverting this property without kicking off a schedule change immediately.
+ 
+ This property is KVO compliant. This property must be called on the main thread.
  */
 @property (nonatomic) NSTimeInterval updateCheckInterval;
 
@@ -231,6 +246,8 @@ SU_EXPORT @interface SPUUpdater : NSObject
  Hence developers shouldn't maintain an additional user default for this property.
  Only set this property if the user wants to change the default via a user settings option.
  Do not always set it on launch unless you want to ignore the user's preference.
+ 
+ This property is KVO compliant. This property must be called on the main thread.
  */
 @property (nonatomic) BOOL automaticallyDownloadsUpdates;
 
@@ -322,6 +339,8 @@ SU_EXPORT @interface SPUUpdater : NSObject
  A property indicating whether or not the user's system profile information is sent when checking for updates.
 
  Setting this property will persist in the host bundle's user defaults.
+ 
+ This property is KVO compliant. This property must be called on the main thread.
  */
 @property (nonatomic) BOOL sendsSystemProfile;
 
@@ -331,6 +350,8 @@ SU_EXPORT @interface SPUUpdater : NSObject
  For testing purposes, the last update check is stored in the `SULastCheckTime` key in the host bundle's user defaults.
  For example, `defaults delete my-bundle-id SULastCheckTime` can be invoked to clear the last update check time and test
  if update checks are automatically scheduled.
+ 
+ This property must be called on the main thread.
  */
 @property (nonatomic, readonly, copy, nullable) NSDate *lastUpdateCheckDate;
 
@@ -342,6 +363,8 @@ SU_EXPORT @interface SPUUpdater : NSObject
  If the `updateCheckInterval` or `automaticallyChecksForUpdates` properties are changed, this method is automatically invoked after a short delay using `-resetUpdateCycleAfterShortDelay`. In these cases, manually resetting the update cycle is not necessary.
  
  See also `-resetUpdateCycleAfterShortDelay` which gives the user a short delay before triggering a cycle reset.
+ 
+ This must be called on the main thread.
  */
 - (void)resetUpdateCycle;
 
@@ -355,6 +378,8 @@ SU_EXPORT @interface SPUUpdater : NSObject
  no cycle reset will be done.
  
  If the `updateCheckInterval` or `automaticallyChecksForUpdates` properties are changed, this method is automatically invoked. In these cases, manually resetting the update cycle is not necessary.
+ 
+ This must be called on the main thread.
  */
 - (void)resetUpdateCycleAfterShortDelay;
 

src/MacVim/Sparkle_2.framework/Versions/B/Headers/SPUUpdater.h

@@ -21,24 +21,30 @@
 NS_ASSUME_NONNULL_BEGIN
 
 /**
- This class can be used for reading certain updater settings.
+ This class can be used for reading and updating updater settings.
  
  It retrieves the settings by first looking into the host's user defaults.
  If the setting is not found in there, then the host's Info.plist file is looked at.
+ 
+ For updating updater settings, changes are made in the host's user defaults.
  */
 SU_EXPORT @interface SPUUpdaterSettings : NSObject
 
 - (instancetype)initWithHostBundle:(NSBundle *)hostBundle;
 
 /**
  * Indicates whether or not automatic update checks are enabled.
+ *
+ * This property is KVO compliant. This property must be called on the main thread.
  */
-@property (readonly, nonatomic) BOOL automaticallyChecksForUpdates;
+@property (nonatomic) BOOL automaticallyChecksForUpdates;
 
 /**
  * The regular update check interval.
+ *
+ * This property is KVO compliant. This property must be called on the main thread.
  */
-@property (readonly, nonatomic) NSTimeInterval updateCheckInterval;
+@property (nonatomic) NSTimeInterval updateCheckInterval;
 
 /**
  * Indicates whether or not automatically downloading updates is allowed to be turned on by the user.
@@ -56,13 +62,17 @@ SU_EXPORT @interface SPUUpdaterSettings : NSObject
  *
  * Note this does not indicate whether or not automatic downloading of updates is allowable.
  * See `-allowsAutomaticUpdates` property for that.
+ *
+ * This property is KVO compliant. This property must be called on the main thread.
  */
-@property (readonly, nonatomic) BOOL automaticallyDownloadsUpdates;
+@property (nonatomic) BOOL automaticallyDownloadsUpdates;
 
 /**
  * Indicates whether or not anonymous system profile information is sent when checking for updates.
+ *
+ * This property is KVO compliant. This property must be called on the main thread.
  */
-@property (readonly, nonatomic) BOOL sendsSystemProfile;
+@property (nonatomic) BOOL sendsSystemProfile;
 
 @end
 

src/MacVim/Sparkle_2.framework/Versions/B/Headers/SPUUpdaterSettings.h

@@ -256,14 +256,6 @@ SU_EXPORT @protocol SPUUserDriver <NSObject>
  */
 - (void)showUpdateInstalledAndRelaunched:(BOOL)relaunched acknowledgement:(void (^)(void))acknowledgement;
 
-/**
- * Show the user the current presented update or its progress in utmost focus
- *
- * The user wishes to check for updates while the user is being shown update progress.
- * Bring whatever is on screen to frontmost focus (permission request, update information, downloading or extraction status, choice to install update, etc).
- */
-- (void)showUpdateInFocus;
-
 /**
  * Dismiss the current update installation
  *
@@ -273,12 +265,22 @@ SU_EXPORT @protocol SPUUserDriver <NSObject>
  */
 - (void)dismissUpdateInstallation;
 
+@optional
+
+/**
+ * Show the user the current presented update or its progress in utmost focus
+ *
+ * The user wishes to check for updates while the user is being shown update progress.
+ * Bring whatever is on screen to frontmost focus (permission request, update information, downloading or extraction status, choice to install update, etc).
+ * Implementing this method is optional.
+ */
+- (void)showUpdateInFocus;
+
 /*
  * Below are deprecated methods that have been replaced by better alternatives.
  * The deprecated methods will be used if the alternatives have not been implemented yet.
  * In the future support for using these deprecated methods may be removed however.
  */
-@optional
 
 // Clients should move to non-deprecated methods
 // Deprecated methods are only (temporarily) kept around for compatibility reasons

src/MacVim/Sparkle_2.framework/Versions/B/Headers/SPUUserDriver.h

@@ -235,8 +235,7 @@ SU_EXPORT @interface SUAppcastItem : NSObject<NSSecureCoding>
  
  This may be:
  - @c application - indicates this is a regular application update.
- - @c package - indicates this is a guided package installer update.
- - @c interactive-package - indicates this is an interactive package installer update (deprecated; use "package" instead)
+ - @c package - indicates this is a package installer update.
  
  This is extracted from the @c sparkle:installationType attribute in the @c <enclosure> element.
  

src/MacVim/Sparkle_2.framework/Versions/B/Headers/SUAppcastItem.h

@@ -67,7 +67,7 @@ typedef NS_ENUM(OSStatus, SUError) {
     SUInstallationAuthorizeLaterError = 4008,
     SUNotValidUpdateError = 4009,
     SUAgentInvalidationError = 4010,
-    SUInstallationRootInteractiveError = 4011,
+    //SUInstallationRootInteractiveError = 4011,
     SUInstallationWriteNoPermissionError = 4012,
 
     // API misuse errors.

src/MacVim/Sparkle_2.framework/Versions/B/Headers/SUErrors.h

@@ -0,0 +1,38 @@
+//
+//  Sparkle.private.modulemap
+//  Sparkle
+//
+//  Created on 4/30/25.
+//  Copyright © 2025 Sparkle Project. All rights reserved.
+//
+
+framework module Sparkle_Private {
+    // Nothing exported here
+}
+
+explicit module Sparkle_Private.SPUStandardUserDriver {
+    header "SPUStandardUserDriver+Private.h"
+    export *
+}
+
+explicit module Sparkle_Private.SPUGentleUserDriverReminders {
+    header "SPUGentleUserDriverReminders.h"
+    export *
+}
+
+explicit module Sparkle_Private.SPUUserAgent {
+    header "SPUUserAgent+Private.h"
+    export *
+}
+
+explicit module Sparkle_Private.SUAppcastItem {
+    header "SUAppcastItem+Private.h"
+    header "SPUAppcastItemStateResolver.h"
+    export *
+}
+
+explicit module Sparkle_Private.SUInstallerLauncher {
+    header "SUInstallerLauncher+Private.h"
+    header "SPUInstallationType.h"
+    export *
+}

src/MacVim/Sparkle_2.framework/Versions/B/Modules/module.private.modulemap

@@ -13,7 +13,7 @@
 #define SPUInstallationTypeGuidedPackage @"package" // the preferred installation type for package installations
 #define SPUInstallationTypeInteractivePackage @"interactive-package" // the deprecated installation type; use guided package instead
 
-#define SPUInstallationTypesArray (@[SPUInstallationTypeApplication, SPUInstallationTypeGuidedPackage, SPUInstallationTypeInteractivePackage])
+#define SPUInstallationTypesArray (@[SPUInstallationTypeApplication, SPUInstallationTypeGuidedPackage])
 #define SPUValidInstallationType(x) ((x != nil) && [SPUInstallationTypesArray containsObject:(NSString * _Nonnull)x])
 
 #endif /* SPUInstallationType_h */