@robotical/webapp-types 3.26.0 → 3.26.2

package/dist-types/package.json

@@ -1,6 +1,6 @@
 {
     "name": "marty-web-app",
-    "version": "3.26.0",
+    "version": "3.26.2",
     "private": true,
     "engines": {
         "node": ">=20"

package/dist-types/src/types/communication-between-apps/wrapper-communication.d.ts

@@ -65,6 +65,10 @@ export type AppUpdateSnapshot = {
     capability: typeof UPDATE_UI_CAPABILITY;
     nativeUpdate: NativeAppUpdate | null;
     webUpdate: WebAppUpdate | null;
+    webDownload?: {
+        webappVersion: string;
+        progress?: number;
+    } | null;
     checks?: {
         native: "checking" | "current" | "unknown";
         web: "checking" | "current" | "unknown";

package/dist-types/src/utils/phone-app-communication/app-updates.js

@@ -54,6 +54,68 @@ export var UPDATE_REQUEST_TIMEOUT_MS = 20000;
 export var UPDATE_CHECK_STALE_MS = 30000;
 var readyRequest = null;
 var checkRequest = null;
+var requestDeadlines = new Set();
+// Called on native state messages too: WKWebView does not always emit browser
+// lifecycle events when its containing native application becomes active.
+var refreshRequestDeadlines = function () { return requestDeadlines.forEach(function (expire) { return expire(); }); };
+var boundedRequest = function (operation, onExpire) {
+    var deadline = Date.now() + UPDATE_REQUEST_TIMEOUT_MS;
+    var active = true;
+    var timer;
+    var expire;
+    var timeout = new Promise(function (resolve) { expire = function () { return resolve(null); }; });
+    var expireIfOverdue = function () {
+        if (!active || Date.now() < deadline) {
+            return false;
+        }
+        active = false;
+        expire();
+        onExpire === null || onExpire === void 0 ? void 0 : onExpire();
+        return true;
+    };
+    var checkDeadline = function () {
+        clearTimeout(timer);
+        if (!expireIfOverdue() && active) {
+            timer = setTimeout(checkDeadline, Math.max(0, deadline - Date.now()));
+        }
+    };
+    var onVisible = function () { if (!document.hidden) {
+        checkDeadline();
+    } };
+    requestDeadlines.add(expireIfOverdue);
+    document.addEventListener('visibilitychange', onVisible);
+    window.addEventListener('pageshow', checkDeadline);
+    window.addEventListener('focus', checkDeadline);
+    checkDeadline();
+    var isActive = function () { return active && Date.now() < deadline; };
+    var promise = (function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _b.trys.push([0, 2, 3, 4]);
+                    return [4 /*yield*/, Promise.race([operation(isActive), timeout])];
+                case 1:
+                    result = _b.sent();
+                    // Queued replies can run before pageshow/visibilitychange on resume.
+                    return [2 /*return*/, isActive() ? result : null];
+                case 2:
+                    _a = _b.sent();
+                    return [2 /*return*/, null];
+                case 3:
+                    active = false;
+                    clearTimeout(timer);
+                    requestDeadlines.delete(expireIfOverdue);
+                    document.removeEventListener('visibilitychange', onVisible);
+                    window.removeEventListener('pageshow', checkDeadline);
+                    window.removeEventListener('focus', checkDeadline);
+                    return [7 /*endfinally*/];
+                case 4: return [2 /*return*/];
+            }
+        });
+    }); })();
+    return { promise: promise, expireIfOverdue: expireIfOverdue };
+};
 var isNativeUpdate = function (value) {
     if (!value || typeof value !== "object") {
         return false;
@@ -83,12 +145,16 @@ export var isAppUpdateSnapshot = function (value) {
         }));
     return (candidate.capability === UPDATE_UI_CAPABILITY &&
         (candidate.nativeUpdate === null || isNativeUpdate(candidate.nativeUpdate)) &&
-        (candidate.webUpdate === null || isWebUpdate(candidate.webUpdate)) && validChecks);
+        (candidate.webUpdate === null || isWebUpdate(candidate.webUpdate)) && validChecks &&
+        (candidate.webDownload == null || (isWebUpdate(candidate.webDownload) &&
+            (candidate.webDownload.progress === undefined || (typeof candidate.webDownload.progress === 'number' &&
+                Number.isFinite(candidate.webDownload.progress) && candidate.webDownload.progress >= 0 && candidate.webDownload.progress <= 100)))));
 };
 export var publishPhoneAppUpdateState = function (value) {
     if (!isAppUpdateSnapshot(value)) {
         return;
     }
+    refreshRequestDeadlines();
     latestSnapshot = value;
     listeners.forEach(function (listener) { return listener(value); });
 };
@@ -137,8 +203,8 @@ export var usePhoneAppUpdates = function () {
     useCheckingDeadline('web', (_b = snapshot === null || snapshot === void 0 ? void 0 : snapshot.checks) === null || _b === void 0 ? void 0 : _b.web);
     return snapshot;
 };
-var requestUpdateState = function (message) { return __awaiter(void 0, void 0, void 0, function () {
-    var timer, snapshot, _a;
+var requestUpdateState = function (message, isActive) { return __awaiter(void 0, void 0, void 0, function () {
+    var snapshot, _a;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
@@ -147,14 +213,11 @@ var requestUpdateState = function (message) { return __awaiter(void 0, void 0, v
                 }
                 _b.label = 1;
             case 1:
-                _b.trys.push([1, 3, 4, 5]);
-                return [4 /*yield*/, Promise.race([
-                        window.wrapperCommunicator.sendMessageAndWait(message, {}),
-                        new Promise(function (resolve) { timer = setTimeout(function () { return resolve(null); }, UPDATE_REQUEST_TIMEOUT_MS); }),
-                    ])];
+                _b.trys.push([1, 3, , 4]);
+                return [4 /*yield*/, window.wrapperCommunicator.sendMessageAndWait(message, {})];
             case 2:
                 snapshot = _b.sent();
-                if (!isAppUpdateSnapshot(snapshot)) {
+                if (!isActive() || !isAppUpdateSnapshot(snapshot)) {
                     return [2 /*return*/, null];
                 }
                 publishPhoneAppUpdateState(snapshot);
@@ -162,61 +225,73 @@ var requestUpdateState = function (message) { return __awaiter(void 0, void 0, v
             case 3:
                 _a = _b.sent();
                 return [2 /*return*/, null];
-            case 4:
-                clearTimeout(timer);
-                return [7 /*endfinally*/];
-            case 5: return [2 /*return*/];
+            case 4: return [2 /*return*/];
         }
     });
 }); };
 export var announcePhoneAppUpdateUiReady = function () {
-    if (!readyRequest) {
-        readyRequest = requestUpdateState(AppSentMessage.UPDATE_UI_READY).finally(function () { readyRequest = null; });
+    if (!readyRequest || readyRequest.expireIfOverdue()) {
+        var request_1 = boundedRequest(function (active) { return requestUpdateState(AppSentMessage.UPDATE_UI_READY, active); });
+        readyRequest = request_1;
+        void request_1.promise.finally(function () { if (readyRequest === request_1) {
+            readyRequest = null;
+        } });
     }
-    return readyRequest;
+    return readyRequest.promise;
 };
 export var getPhoneAppUpdateState = function () {
-    return requestUpdateState(AppSentMessage.UPDATE_GET_STATE);
+    return boundedRequest(function (active) { return requestUpdateState(AppSentMessage.UPDATE_GET_STATE, active); }).promise;
 };
-var performUpdateCheck = function () { return __awaiter(void 0, void 0, void 0, function () {
-    var _a, supportsChecks, result, _b, native, web;
-    return __generator(this, function (_c) {
-        switch (_c.label) {
+var performUpdateCheck = function (isActive) { return __awaiter(void 0, void 0, void 0, function () {
+    var _a, supportsChecks;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
             case 0:
                 _a = !latestSnapshot;
                 if (!_a) return [3 /*break*/, 2];
                 return [4 /*yield*/, announcePhoneAppUpdateUiReady()];
             case 1:
-                _a = !(_c.sent());
-                _c.label = 2;
+                _a = !(_b.sent());
+                _b.label = 2;
             case 2:
                 // A lost cold-start reply must not permanently remove access to update checks.
                 if (_a) {
                     return [2 /*return*/, null];
                 }
+                if (!isActive()) {
+                    return [2 /*return*/, null];
+                }
                 supportsChecks = Boolean(latestSnapshot === null || latestSnapshot === void 0 ? void 0 : latestSnapshot.checks);
                 if (latestSnapshot && supportsChecks) {
                     publishPhoneAppUpdateState(__assign(__assign({}, latestSnapshot), { checks: { native: "checking", web: "checking" } }));
                 }
-                return [4 /*yield*/, requestUpdateState(supportsChecks ? AppSentMessage.UPDATE_CHECK_NOW : AppSentMessage.UPDATE_GET_STATE)];
-            case 3:
-                result = _c.sent();
-                if (!result && (latestSnapshot === null || latestSnapshot === void 0 ? void 0 : latestSnapshot.checks)) {
-                    _b = latestSnapshot.checks, native = _b.native, web = _b.web;
-                    publishPhoneAppUpdateState(__assign(__assign({}, latestSnapshot), { checks: {
-                            native: native === "checking" ? "unknown" : native,
-                            web: web === "checking" ? "unknown" : web,
-                        } }));
-                }
-                return [2 /*return*/, result];
+                return [2 /*return*/, requestUpdateState(supportsChecks ? AppSentMessage.UPDATE_CHECK_NOW : AppSentMessage.UPDATE_GET_STATE, isActive)];
         }
     });
 }); };
+var expireCheckingState = function () {
+    if (latestSnapshot === null || latestSnapshot === void 0 ? void 0 : latestSnapshot.checks) {
+        var _a = latestSnapshot.checks, native = _a.native, web = _a.web;
+        publishPhoneAppUpdateState(__assign(__assign({}, latestSnapshot), { checks: {
+                native: native === "checking" ? "unknown" : native,
+                web: web === "checking" ? "unknown" : web,
+            } }));
+    }
+};
 export var checkPhoneAppUpdates = function () {
-    if (!checkRequest) {
-        checkRequest = performUpdateCheck().finally(function () { checkRequest = null; });
+    if (!checkRequest || checkRequest.expireIfOverdue()) {
+        var request_2 = boundedRequest(performUpdateCheck, expireCheckingState);
+        checkRequest = request_2;
+        void request_2.promise.then(function (result) {
+            if (checkRequest === request_2) {
+                if (!result) {
+                    expireCheckingState();
+                }
+                checkRequest = null;
+            }
+        });
     }
-    return checkRequest;
+    return checkRequest.promise;
 };
 export var applyPhoneWebUpdate = function () { return __awaiter(void 0, void 0, void 0, function () {
     var response, _a;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robotical/webapp-types",
-  "version": "3.26.0",
+  "version": "3.26.2",
   "description": "Type definitions for the Application Manager",
   "main": "dist/application-manager.d.ts",
   "types": "dist/application-manager.d.ts",