Upgrader

https://pub.dev/packages/upgrader
Admin
A Flutter package for prompting users to upgrade when there is a newer version of the app in the...
Tokens:38,697
Snippets:667
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Enable Upgrader Debug Logging Output

Source: https://pub.dev/packages/upgrader

Example of the log output generated when debugLogging is set to true.

```text
flutter: upgrader: operatingSystem: ios, version: Version 17.0.1 (Build 21A342)
flutter: upgrader: packageInfo packageName: com.google.Maps
flutter: upgrader: packageInfo appName: Upgrader
flutter: upgrader: packageInfo version: 1.0.0
flutter: upgrader: current locale: en_US
flutter: upgrader: countryCode: US
flutter: upgrader: languageCode: en
flutter: upgrader: download: https://itunes.apple.com/lookup?bundleId=com.google.Maps&country=US&_cb=1708305624824631
flutter: upgrader: response statusCode: 200
flutter: upgrader: UpgraderAppStore: version info: appStoreListingURL: https://apps.apple.com/us/app/google-maps/id585027354?uo=4, appStoreVersion: 6.102.3, installedVersion: 1.0.0, isCriticalUpdate: null, minAppVersion: null, releaseNotes: Thanks for using Google Maps! This release brings bug fixes that improve our product to help you discover new places and navigate to them.
flutter: upgrader: need to evaluate version
flutter: upgrader: blocked: false
flutter: upgrader: debugDisplayAlways: false
flutter: upgrader: debugDisplayOnce: false
flutter: upgrader: hasAlerted: false
flutter: upgrader: installedVersion: 1.0.0
flutter: upgrader: minAppVersion: null
flutter: upgrader: isUpdateAvailable: true
flutter: upgrader: shouldDisplayUpgrade: true
flutter: upgrader: shouldDisplayReleaseNotes: true
flutter: upgrader: current locale: en_US
flutter: upgrader: languageCode: en
flutter: upgrader: showTheDialog title: Update App?
flutter: upgrader: showTheDialog message: A new version of Upgrader is available! Version 6.102.3 is now available-you have 1.0.0.
flutter: upgrader: showTheDialog releaseNotes: Thanks for using Google Maps! This release brings bug fixes that improve our product to help you discover new places and navigate to them.
```

--------------------------------

### iTunes Lookup Output

Source: https://pub.dev/packages/upgrader

Example output format returned by the itunes_lookup command-line tool.

```text
upgrader: download: https://itunes.apple.com/lookup?bundleId=com.google.Maps
upgrader: response statusCode: 200
itunes_lookup bundleId: com.google.Maps
itunes_lookup releaseNotes: Thanks for using Google Maps!
itunes_lookup trackViewUrl: https://apps.apple.com/us/app/google-maps-transit-food/id585027354?uo=4
itunes_lookup version: 5.58
itunes_lookup all results:
{resultCount: 1, results:
...
```

--------------------------------

### Google Play Store Lookup Output

Source: https://pub.dev/packages/upgrader

Example output format returned by the playstore_lookup command-line tool.

```text
playstore_lookup releaseNotes: • Support plus.codes URLs• Bug fixes
playstore_lookup version: 152.0.0
...
```

--------------------------------

### Initialize Upgrader in main.dart

Source: https://pub.dev/packages/upgrader/versions/6.2.0/example

Demonstrates the basic setup for the Upgrader package. Use clearSavedSettings() only during testing to reset internal state.

```dart
/*
 * Copyright (c) 2019-2023 Larry Aasen. All rights reserved.
 */

import 'package:flutter/material.dart';
import 'package:upgrader/upgrader.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // Only call clearSavedSettings() during testing to reset internal values.
  await Upgrader.clearSavedSettings(); // REMOVE this for release builds

  // On Android, the default behavior will be to use the Google Play Store
  // version of the app.
  // On iOS, the default behavior will be to use the App Store version of
  // the app, so update the Bundle Identifier in example/ios/Runner with a
  // valid identifier already in the App Store.
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Upgrader Example',
      home: UpgradeAlert(
          child: Scaffold(
        appBar: AppBar(title: Text('Upgrader Example')),
        body: Center(child: Text('Checking...')),
      )),
    );
  }
}
```

--------------------------------

### Appcast XML Sample

Source: https://pub.dev/packages/upgrader

Example structure of an RSS feed used as an Appcast for version management.

```xml
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle">
    <channel>
        <title>Debt Now App - Appcast</title>
        <item>
            <title>Version 1.15.0</title>
            <description>Minor updates and improvements.</description>
            <pubDate>Sun, 30 Dec 2018 12:00:00 +0000</pubDate>
            <enclosure url="https://play.google.com/store/apps/details?id=com.moonwink.treasury" sparkle:version="1.15.0" sparkle:os="android" />
        </item>
    </channel>
</rss>
```

--------------------------------

### Initialize and display UpgradeAlert in Flutter

Source: https://pub.dev/packages/upgrader/versions/4.10.0/example

Demonstrates the basic setup for the upgrader package, including clearing settings for testing and wrapping the app content with UpgradeAlert.

```dart
/*
 * Copyright (c) 2019-2022 Larry Aasen. All rights reserved.
 */

import 'package:flutter/material.dart';
import 'package:upgrader/upgrader.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // Only call clearSavedSettings() during testing to reset internal values.
  await Upgrader.clearSavedSettings(); // REMOVE this for release builds

  // On Android, the default behavior will be to use the Google Play Store
  // version of the app.
  // On iOS, the default behavior will be to use the App Store version of
  // the app, so update the Bundle Identifier in example/ios/Runner with a
  // valid identifier already in the App Store.
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Upgrader Example',
      home: Scaffold(
          appBar: AppBar(title: Text('Upgrader Example')),
          body: UpgradeAlert(
            child: Center(child: Text('Checking...')),
          )),
    );
  }
}
```

--------------------------------

### Configure Upgrader with Appcast Store

Source: https://pub.dev/packages/upgrader

Example of overriding the default iOS store controller to use an Appcast source.

```dart
const appcastURL = 'https://raw.githubusercontent.com/larryaasen/upgrader/main/test/testappcast.xml';
final upgrader = Upgrader(
  storeController: UpgraderStoreController(
    onAndroid: () => UpgraderPlayStore(),
    oniOS: () => UpgraderAppcastStore(appcastURL: appcastURL, osVersion: Version(0, 0, 0)),
  ),
);
```

--------------------------------

### Implement UpgradeAlert in Flutter

Source: https://pub.dev/packages/upgrader/versions/3.2.1/example

Demonstrates the basic setup of the Upgrader package, including clearing saved settings for testing and configuring an Appcast for Android.

```dart
/*
 * Copyright (c) 2019 Larry Aasen. All rights reserved.
 */

import 'package:flutter/material.dart';
import 'package:upgrader/upgrader.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  MyApp({
    Key key,
  }) : super(key: key);

  @override
  Widget build(BuildContext context) {
    // Only call clearSavedSettings() during testing to reset internal values.
    Upgrader().clearSavedSettings(); // Remove this for release builds

    // On Android, setup the Appcast.
    // On iOS, the default behavior will be to use the App Store version of
    // the app, so update the Bundle Identifier in example/ios/Runner with a
    // valid identifier already in the Store.
    final appcastURL =
        'https://raw.githubusercontent.com/larryaasen/upgrader/master/test/testappcast.xml';
    final cfg = AppcastConfiguration(url: appcastURL, supportedOS: ['android']);

    return MaterialApp(
      title: 'Upgrader Example',
      home: Scaffold(
          appBar: AppBar(
            title: Text('Upgrader Example'),
          ),
          body: UpgradeAlert(
            appcastConfig: cfg,
            debugLogging: true,
            child: Center(child: Text('Checking...')),
          )),
    );
  }
}
```

--------------------------------

### Extract Upgrader Version from pubspec.lock

Source: https://pub.dev/packages/upgrader

Example of the entry format for the upgrader package within the pubspec.lock file.

```yaml
  upgrader:
    dependency: "direct main"
    description:
      path: ".."
      relative: true
    source: path
    version: "3.6.0"
```

--------------------------------

### Implement UpgradeAlert in Flutter

Source: https://pub.dev/packages/upgrader/versions/2.7.1/example

Demonstrates the basic setup of the UpgradeAlert widget within a MaterialApp. Use clearSavedSettings() only during testing to reset internal state.

```dart
/*
 * Copyright (c) 2019 Larry Aasen. All rights reserved.
 */

import 'package:flutter/material.dart';
import 'package:upgrader/upgrader.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  MyApp({
    Key key,
  }) : super(key: key);

  @override
  Widget build(BuildContext context) {
    // Only call clearSavedSettings() during testing to reset internal values.
    Upgrader().clearSavedSettings();

    // On Android, setup the Appcast.
    // On iOS, the default behavior will be to use the App Store version of
    // the app, so update the Bundle Identifier in example/ios/Runner with a
    // valid identifier already in the App Store.
    final appcastURL =
        'https://raw.githubusercontent.com/larryaasen/upgrader/master/test/testappcast.xml';
    final cfg = AppcastConfiguration(url: appcastURL, supportedOS: ['android']);

    return MaterialApp(
      title: 'Upgrader Example',
      home: Scaffold(
          appBar: AppBar(
            title: Text('Upgrader Example'),
          ),
          body: UpgradeAlert(
            // appcastConfig: cfg,
            debugLogging: true,
            minAppVersion: '0.00.20',
            child: Center(child: Text('Checking...')),
          )),
    );
  }
}
```

--------------------------------

### Lookup iTunes App Details via CLI

Source: https://pub.dev/packages/upgrader

Run the itunes_lookup.dart script to retrieve app metadata from the iTunes Search API.

```bash
$ dart itunes_lookup.dart bundleid=com.google.Maps
```

--------------------------------

### Android URL Launcher Error Log

Source: https://pub.dev/packages/upgrader

Example of the error log observed on Android when the URL launcher fails to find a component.

```text
I/UrlLauncher(11833): component name for https://www.google.com/ is null
```

--------------------------------

### Configure Android Manifest for URL Launching

Source: https://pub.dev/packages/upgrader

Adds the necessary queries to AndroidManifest.xml to allow the app to launch browser intents.

```xml
    <queries>
      <intent>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data android:scheme="https" />
      </intent>
    </queries>
```

--------------------------------

### Configure Minimum App Version for Android

Source: https://pub.dev/packages/upgrader

Add this string to the bottom of the full description field in the Google Play Console.

```text
[Minimum supported app version: 1.2.3]
```

--------------------------------

### Check for Outdated Dependencies

Source: https://pub.dev/packages/upgrader/versions/11.5.1/score

Run this command to identify packages that have newer versions available while respecting current constraints.

```bash
dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides
```

--------------------------------

### Add upgrader dependency via CLI

Source: https://pub.dev/packages/upgrader/versions/0.1.0/install

Run this command in your terminal to add the package to your project.

```bash
$ flutter pub add upgrader
```

--------------------------------

### Lookup Google Play Store App Details via CLI

Source: https://pub.dev/packages/upgrader

Run the playstore_lookup.dart script to retrieve app metadata from the Google Play Store.

```bash
$ cd bin
$ dart playstore_lookup.dart id=com.google.android.apps.mapslite
```

--------------------------------

### Configure Minimum App Version for iOS

Source: https://pub.dev/packages/upgrader

Add this string to the bottom of the description field in App Store Connect.

```text
[:mav: 1.2.3]
```

--------------------------------

### Enable Debug Logging

Source: https://pub.dev/packages/upgrader

Enables verbose logging in the Upgrader constructor to inspect parsing behavior.

```dart
debugLogging: true
```

--------------------------------

### Initialize Upgrader in Flutter

Source: https://pub.dev/packages/upgrader/versions/0.1.0/example

Configures the Upgrader settings and wraps the application UI with UpgradeAlert to handle version checking.

```dart
/*
 * Copyright (c) 2018 Larry Aasen. All rights reserved.
 */

import 'package:flutter/material.dart';
import 'package:upgrader/upgrader.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  MyApp({
    Key key,
  }) : super(key: key) {
    Upgrader().clearSavedSettings();
    Upgrader().installAppStoreVersion('1.1.0');
    Upgrader().installAppStoreListingURL(
        'https://itunes.apple.com/us/app/google-maps-transit-food/id585027354?mt=8&uo=4');
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Upgrader Example',
      home: Scaffold(
          appBar: AppBar(
            title: Text('Upgrader Example'),
          ),
          body: UpgradeAlert(
            child: Center(child: Text('Checking...')),
          )),
    );
  }
}
```

--------------------------------

### Set Minimum App Version in Store Descriptions

Source: https://pub.dev/packages/upgrader/versions/13.0.0

Add these strings to the app store description fields to enforce a minimum version. This overrides the minAppVersion parameter and hides Ignore/Later buttons.

```text
[Minimum supported app version: 1.2.3]
```

```text
[:mav: 1.2.3]
```
Tokens:
Raw