Move update event handler to templated code to prepare for extra templates.

Author: SQL-MisterMagoo

Blazor.PWA.MSBuild.Tasks/Blazor.PWA.MSBuild.Tasks.csproj

@@ -68,6 +68,10 @@ I will add more network caching strategies, but for now it has just one - cache
 
   </ItemGroup>
 
+  <ItemGroup>
+    <None Remove="Templates\ServiceWorker\sw_register-update-alert.template.js" />
+  </ItemGroup>
+
   <ItemGroup>
     <Folder Include="Templates\Images\" />
   </ItemGroup>

Blazor.PWA.MSBuild.Tasks/Templates/ServiceWorker/sw_register-update-alert.template.js

@@ -0,0 +1,7 @@
+
+window['updateAvailable']
+    .then(isAvailable => {
+        if (isAvailable) {
+            alert(updateAlertMessage);
+        }
+    });

Blazor.PWA.MSBuild.Tasks/Templates/ServiceWorker/sw_register.template.js

@@ -23,12 +23,6 @@
                 console.log('Service worker registration failed, error:', error));
     }
 });
-window['updateAvailable']
-    .then(isAvailable => {
-        if (isAvailable) {
-            alert("Update available. Reload the page when convenient.");
-        }
-    });
 
 window.addEventListener('beforeinstallprompt', function (e) {
     // Prevent Chrome 67 and earlier from automatically showing the prompt

Blazor.PWA.MSBuild.Tasks/build/BlazorPWA.MSBuild.ServiceWorkerRegister.targets

@@ -26,20 +26,28 @@
       <ServiceWorkerRegisterTemplatePath Condition="'$(ServiceWorkerRegisterTemplatePath)' == ''">$(MSBuildThisFileDirectory)..\Templates\ServiceWorker\</ServiceWorkerRegisterTemplatePath>
       <!-- The file that contains template code for the service worker register file -->
       <ServiceWorkerRegisterTemplate Condition="'$(ServiceWorkerRegisterTemplate)' == ''">$(ServiceWorkerRegisterTemplatePath)sw_register.template.js</ServiceWorkerRegisterTemplate>
+      <!-- The file that contains template code for the service worker "update available"  -->
+      <ServiceWorkerRegisterUpdateNotificationTemplate Condition="'$(ServiceWorkerRegisterUpdateNotificationTemplate)' == ''">$(ServiceWorkerRegisterTemplatePath)sw_register-update-alert.template.js</ServiceWorkerRegisterUpdateNotificationTemplate>
     </PropertyGroup>
 
     <PropertyGroup Label="Implementation">
       <!-- event fired by browser when the service worker has installed ** probably never change **-->
       <ServiceWorkerInstalledEvent Condition="'$(ServiceWorkerInstalledEvent)'==''">installed</ServiceWorkerInstalledEvent>
+      <!-- Text to display when an update is available -->
+      <ServiceWorkerUpdateAlertText Condition="'$(ServiceWorkerUpdateAlertText)'==''">Update available. Reload the page when convenient.</ServiceWorkerUpdateAlertText>
+      <!-- Update available alert type -->
+      <ServiceWorkerUpdateNotificationType Condition="'$(ServiceWorkerUpdateNotificationType)'==''">update-alert</ServiceWorkerUpdateNotificationType>
       <!-- Setup the declarations for the Service Worker Register -->
       <ServiceWorkerRegisterConstants Condition="'$(ServiceWorkerConstants)' == ''">
         const serviceWorkerFileName = '$(ServiceWorkerBaseURL)$(ServiceWorkerFileName)'%3B;
         const swInstalledEvent = '$(ServiceWorkerInstalledEvent)'%3B;
         const staticCachePrefix = '$(ServiceWorkerCacheName)-v'%3B;
+        const updateAlertMessage = '$(ServiceWorkerUpdateAlertText)'%3B; 
       </ServiceWorkerRegisterConstants>
     </PropertyGroup>
     <ItemGroup>
       <ServiceWorkerRegisterTemplateLines Include="$([System.IO.File]::ReadAllText($(ServiceWorkerRegisterTemplate)))"/>
+      <ServiceWorkerRegisterTemplateLines Include="$([System.IO.File]::ReadAllText($(ServiceWorkerRegisterUpdateNotificationTemplate)))"/>
     </ItemGroup>
     <WriteLinesToFile
       File="$(WWWRoot)$(ServiceWorkerRegisterFileName)"

Blazor.PWA.MSBuild.sln

@@ -7,6 +7,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Blazor.PWA.MSBuild.Tasks",
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{BCE600C8-35D7-4AA4-9FFB-156E4526097E}"
 	ProjectSection(SolutionItems) = preProject
+		CHANGELOG.md = CHANGELOG.md
 		LICENSE.txt = LICENSE.txt
 		README.md = README.md
 	EndProjectSection

CHANGELOG.md

@@ -0,0 +1,7 @@
+#### 09/08/2019 
+
+- Added new **Property** **`ServiceWorkerUpdateAlertText`** - used to change the default text in the "Update available alert".
+- Added new **Property** **`ServiceWorkerRegisterUpdateNotificationTemplate`** - The name of the template file for the "update available" event.
+- Moved the "Updated available alert" to it's own template so we can have alternates
+ 
+#### 08/08/2019 Initial Release

README.md

@@ -10,6 +10,12 @@ It currently includes a simple banner to notify the user that your application c
 
 This is to be considered a Beta release - I am looking for feedback/issues/requests.
 
+### Browser compatibility
+
+Note that chromium browsers will prompt you to install a PWA on a desktop computer.
+Firefox does not currently provide this experience on desktop.
+I don't have a Mac, but I believe Safari does not prompt on desktop either.
+
 ## Installation
 
 Install the nuget BlazorPWA.MsBuild