Feature Request: Version label in the Sync success callback #23

Author: EddyVerbruggen

README.md

@@ -162,12 +162,12 @@ AppSync.sync({
       mandatoryContinueButtonLabel: isIOS ? "Exit now" : "Restart now", // On Android we can kill and restart the app, but on iOS that's not possible so the user has to manually restart it. That's why we provide a different label in this example.
       appendReleaseDescription: true // appends the description you (optionally) provided when releasing a new version to AppSync
     }
-  }, (syncStatus: SyncStatus): void => {
+  }, (syncStatus: SyncStatus, updateLabel?: string): void => {
     console.log("AppSync syncStatus: " + syncStatus);
     if (syncStatus === SyncStatus.UP_TO_DATE) {
-      console.log("AppSync: no pending updates; you're running the latest version!");
+      console.log(`AppSync: no pending updates; you're running the latest version, which is ${updateLabel}`);
     } else if (syncStatus === SyncStatus.UPDATE_INSTALLED) {
-      console.log("AppSync: update installed - it will be activated upon next cold boot");
+      console.log(`AppSync: update installed (${updateLabel}) - it will be activated upon next cold boot`);
     }
 });
 ```
@@ -193,11 +193,11 @@ AppSync.sync({
       mandatoryContinueButtonLabel: platform.isIOS ? "Exit now" : "Restart now",
       appendReleaseDescription: true // appends the description you (optionally) provided when releasing a new version to AppSync
     }
-}, function (syncStatus) {
+}, function (syncStatus, updateLabel) {
     if (syncStatus === SyncStatus.UP_TO_DATE) {
-      console.log("AppSync: no pending updates; you're running the latest version!");
+      console.log("AppSync: no pending updates; you're running the latest version, which is: " + updateLabel);
     } else if (syncStatus === SyncStatus.UPDATE_INSTALLED) {
-      console.log("AppSync: update installed - it will be activated upon next cold boot");
+      console.log("AppSync: update (" + updateLabel + ") installed - it will be activated upon next cold boot");
     }
 });
 ```

demo/demoapp/main-view-model.ts

@@ -81,11 +81,11 @@ export class HelloWorldModel extends Observable {
         mandatoryContinueButtonLabel: isIOS ? "Exit now" : "Restart now",
         appendReleaseDescription: true // appends the description you (optionally) provided when releasing a new version to AppSync
       }
-    }, (syncStatus: SyncStatus): void => {
+    }, (syncStatus: SyncStatus, updateLabel?: string): void => {
       if (syncStatus === SyncStatus.UP_TO_DATE) {
-        this.set("message", "AppSync: up to date");
+        this.set("message", `AppSync: up to date: ${updateLabel}`);
       } else if (syncStatus === SyncStatus.UPDATE_INSTALLED) {
-        this.set("message", "AppSync: update installed");
+        this.set("message", `AppSync: update installed: ${updateLabel}`);
       }
     });
   }

demo/package.json

@@ -31,7 +31,7 @@
     "ci.tslint": "npm i && tslint --config '../tslint.json' 'demoapp/**/*.ts' --exclude '**/node_modules/**' --exclude '**/typings/**'"
   },
   "dependencies": {
-    "nativescript-app-sync": "file:../publish/package/nativescript-app-sync-1.0.2.tgz",
+    "nativescript-app-sync": "file:../publish/package/nativescript-app-sync-1.0.3.tgz",
     "nativescript-theme-core": "~1.0.4",
     "nativescript-unit-test-runner": "^0.3.4",
     "tns-core-modules": "~5.4.2"

src/TNSLocalPackage.ts

@@ -29,7 +29,7 @@ export class TNSLocalPackage implements ILocalPackage {
   failedInstall: boolean;
   serverUrl: string;
 
-  install(installSuccess: SuccessCallback<InstallMode>, errorCallback?: ErrorCallback, installOptions?: InstallOptions): void {
+  install(installSuccess: Function, errorCallback?: ErrorCallback, installOptions?: InstallOptions): void {
     let appFolderPath = fs.knownFolders.documents().path + "/app";
     let unzipFolderPath = fs.knownFolders.documents().path + "/AppSync-Unzipped/" + this.packageHash;
     let appSyncFolder = fs.knownFolders.documents().path + "/AppSync";

src/app-sync.ts

@@ -144,7 +144,7 @@ export class AppSync {
               this.killApp(false);
             };
 
-            syncCallback && syncCallback(SyncStatus.UPDATE_INSTALLED);
+            syncCallback && syncCallback(SyncStatus.UPDATE_INSTALLED, remotePackage.label);
 
             const installMode = options.installMode || InstallMode.ON_NEXT_RESTART;
             const mandatoryInstallMode = options.mandatoryInstallMode || InstallMode.ON_NEXT_RESUME;
@@ -182,11 +182,11 @@ export class AppSync {
           };
 
           const onDownloadSuccess = (localPackage: ILocalPackage) => {
-            syncCallback && syncCallback(SyncStatus.INSTALLING_UPDATE);
+            syncCallback && syncCallback(SyncStatus.INSTALLING_UPDATE, remotePackage.label);
             localPackage.install(onInstallSuccess, onError);
           };
 
-          syncCallback && syncCallback(SyncStatus.DOWNLOADING_PACKAGE);
+          syncCallback && syncCallback(SyncStatus.DOWNLOADING_PACKAGE, remotePackage.label);
 
           remotePackage.download(
               onDownloadSuccess,

src/code-push-lib.d.ts

@@ -126,7 +126,7 @@ interface NativeUpdateNotification {
 }
 
 interface Callback<T> { (error: Error, parameter: T): void; }
-interface SuccessCallback<T> { (result?: T): void; }
+interface SuccessCallback<T> { (result: T, updateLabel?: string): void; }
 interface ErrorCallback { (error?: Error): void; }
 
 interface Configuration {

src/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nativescript-app-sync",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Use AppSync to hot deploy updates to your app.",
   "main": "app-sync",
   "typings": "index.d.ts",