Merge pull request #125 from chirag729/app_uri_handler_support

Add support for extension windows.appUriHandler
YehudaKremer · May 4, 2022 · c240fa2 · c240fa2
2 parents d758ce8 + 37b9196
commit c240fa2
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.6.0
+
+- added [apps for websites](https://docs.microsoft.com/en-us/windows/uwp/launch-resume/web-to-app-linking) ([#125](https://github.com/YehudaKremer/msix/pull/125))
+
 ## 3.5.1
 
 - added two new command `msix:build` and `msix:pack` for [unsupported features](https://github.com/YehudaKremer/msix#heavy_exclamation_mark-unsupported-features) ([#120](https://github.com/YehudaKremer/msix/issues/120))

diff --git a/README.md b/README.md
@@ -71,6 +71,7 @@ See [Configurations Examples And Use Cases].
 | `languages`              | `--languages`                        | Declares the language resources contained in the package.                                                                                             | `en-us, ja-jp`                                                                                  |
 | `file_extension`         | `--file-extension` `-f`              | File extensions that the app may be registered to open.                                                                                               | `.picture, .image`                                                                              |
 | `protocol_activation`    | `--protocol-activation`              | [Protocols activation] that will activate the app.                                                                                                         | `http,https`                                                                                         |
+| `app_uri_handler_hosts`    | `--app-uri-handler-hosts`              | Enable [apps for websites] using app URI handlers app.                                                                                                         | `test.com, test2.info`                                                                                         |
 | `execution_alias`    | `--execution-alias`              | [Execution alias] command (cmd) that will activate the app. | `myapp`                                                                                          |
 | `enable_at_startup`    | `--enable-at-startup`              | App start at startup or user log-in. | `true`                                                                                          |
 | `store`                  | `--store`                            | Generate a MSIX file for publishing to the Microsoft Store.                                                                                           | `false`                                                                                         |
@@ -219,4 +220,5 @@ Tags: `msi` `windows` `win10` `win11` `windows10` `windows11` `windows store` `w
 [self signed]: https://docs.microsoft.com/en-us/windows/msix/package/create-certificate-package-signing#create-a-self-signed-certificate
 [Configurations Examples And Use Cases]: https://pub.dev/packages/msix/example
 [see how the msix version is determined]: https://github.com/YehudaKremer/msix/blob/main/doc/msix_version.md
-[Toast Notifications configuration]: https://github.com/YehudaKremer/msix/blob/main/doc/toast_notifications_configuration.md
+[Toast Notifications configuration]: https://github.com/YehudaKremer/msix/blob/main/doc/toast_notifications_configuration.md
+[apps for websites]: https://docs.microsoft.com/en-us/windows/uwp/launch-resume/web-to-app-linking
diff --git a/lib/src/appx_manifest.dart b/lib/src/appx_manifest.dart
@@ -85,13 +85,16 @@ class AppxManifest {
         _config.protocolActivation.isNotEmpty ||
         !_config.fileExtension.isNull ||
         !_config.toastActivatorCLSID.isNull ||
+        (_config.appUriHandlerHosts != null &&
+            _config.appUriHandlerHosts!.isNotEmpty) ||
         _config.enableAtStartup) {
       return '''<Extensions>
       ${!_config.executionAlias.isNull ? _getExecutionAliasExtension() : ''}
       ${_config.protocolActivation.isNotEmpty ? _getProtocolActivationExtension() : ''}
       ${!_config.fileExtension.isNull ? _getFileAssociationsExtension() : ''}
       ${!_config.toastActivatorCLSID.isNull ? _getToastNotificationActivationExtension() : ''}
       ${_config.enableAtStartup ? _getStartupTaskExtension() : ''}
+      ${_config.appUriHandlerHosts != null && _config.appUriHandlerHosts!.isNotEmpty ? _getAppUriHandlerHostExtension() : ''}
         </Extensions>''';
     } else {
       return '';
@@ -154,6 +157,16 @@ class AppxManifest {
       </desktop:Extension>''';
   }
 
+  String _getAppUriHandlerHostExtension() {
+    return '''  <uap3:Extension Category="windows.appUriHandler">
+            <uap3:AppUriHandler>
+              ${_config.appUriHandlerHosts!.map((hostName) {
+              return '<uap3:Host Name="$hostName" />';
+            }).toList().join('\n                ')}
+          </uap3:AppUriHandler>
+          </uap3:Extension>''';
+  }
+
   String _normalizeCapability(String capability) {
     capability = capability.trim();
     var firstLetter = capability.substring(0, 1).toLowerCase();

diff --git a/lib/src/configuration.dart b/lib/src/configuration.dart
@@ -51,6 +51,7 @@ class Configuration {
   bool trimLogo = true;
   bool createWithDebugBuildFiles = false;
   bool enableAtStartup = false;
+  Iterable<String>? appUriHandlerHosts;
   Iterable<String>? languages;
   String get defaultsIconsFolderPath => '$msixAssetsPath/icons';
   String get msixToolkitPath => '$msixAssetsPath/MSIX-Toolkit';
@@ -121,6 +122,7 @@ class Configuration {
     architecture = _args['architecture'] ?? yaml['architecture'];
     capabilities = _args['capabilities'] ?? yaml['capabilities'];
     languages = _getLanguages(yaml);
+    appUriHandlerHosts = _getAppUriHandlerHosts(yaml);
     enableAtStartup = _args.wasParsed('enable-at-startup') ||
         yaml['enable_at_startup']?.toString().toLowerCase() == 'true';
 
@@ -286,6 +288,7 @@ class Configuration {
       ..addOption('publish-folder-path')
       ..addOption('hours-between-update-checks')
       ..addOption('build-windows')
+      ..addOption('app-uri-handler-hosts')
       ..addFlag('store')
       ..addFlag('enable-at-startup')
       ..addFlag('debug')
@@ -362,6 +365,14 @@ class Configuration {
           .map((e) => e.trim())
           .where((element) => element.isNotEmpty);
 
+  /// Get the app uri handler hosts list
+  Iterable<String>? _getAppUriHandlerHosts(dynamic config) =>
+      ((_args['app-uri-handler-hosts'] ?? config['app_uri_handler_hosts'])
+              as String?)
+          ?.split(',')
+          .map((e) => e.trim())
+          .where((element) => element.isNotEmpty);
+
   /// Get the protocol activation list
   Iterable<String> _getProtocolsActivation(dynamic config) =>
       ((_args['protocol-activation'] ?? config['protocol_activation'])

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: msix
 description: A command-line tool that create Msix installer from your flutter windows-build files.
-version: 3.5.1
+version: 3.6.0
 maintainer: Yehuda Kremer (yehudakremer@gmail.com)
 homepage: https://github.com/YehudaKremer/msix