@robotical/webapp-types 3.22.3 → 3.23.0

package/dist-types/package.json

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

package/dist-types/src/application/communicators/WrapperCommunicator.js

@@ -40,6 +40,7 @@ import randomHashGenerator from "../../utils/helpers/randomHashGenerator";
 import isPhoneApp from "../../utils/phone-app-communication/is-phone-app";
 import SelfdestructiveMessagePromise from "./SelfdestructiveMessagePromise";
 import { RaftConnectionMethod } from "../../types/raft";
+import { publishPhoneAppUpdateState } from "../../utils/phone-app-communication/app-updates";
 var SHOW_LOGS = true;
 var TAG = "WrapperAppCommunicator";
 var WrapperCommunicator = /** @class */ (function () {
@@ -137,6 +138,9 @@ var receivedMessageHandler = function (receivedMessage, data, messagePromiseId)
             case WrapperSentMessage.RAFT_PUBLISHED_EVENT:
                 window.applicationManager.receivedRICEvent(data.raftId, data.eventType, data.eventEnum, data.eventName, data.eventData);
                 break;
+            case WrapperSentMessage.UPDATE_STATE_CHANGED:
+                publishPhoneAppUpdateState(data);
+                break;
             default:
                 console.log("Unhandled message");
         }

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

@@ -39,12 +39,31 @@ export declare enum AppSentMessage {
     MARTY_CALIBRATE_COLOUR_SENSOR = "MARTY_CALIBRATE_COLOUR_SENSOR",
     MARTY_RESET_COLOUR_SENSOR_OFFSETS = "MARTY_RESET_COLOUR_SENSOR_OFFSETS",
     GET_DEVICE_INFO = "GET_DEVICE_INFO",
+    UPDATE_UI_READY = "UPDATE_UI_READY",
+    UPDATE_GET_STATE = "UPDATE_GET_STATE",
+    UPDATE_APPLY_WEB = "UPDATE_APPLY_WEB",
+    UPDATE_OPEN_NATIVE_STORE = "UPDATE_OPEN_NATIVE_STORE",
     SEND_ATOMIC_READ_OPERATION_TO_MARTY = "SEND_ATOMIC_READ_OPERATION_TO_MARTY"
 }
 export declare enum WrapperSentMessage {
     RAFT_PUBLISHED_EVENT = "RAFT_PUBLISHED_EVENT",
-    RAFT_CONNECTED_RESULTS = "RAFT_CONNECTED_RESULTS"
+    RAFT_CONNECTED_RESULTS = "RAFT_CONNECTED_RESULTS",
+    UPDATE_STATE_CHANGED = "UPDATE_STATE_CHANGED"
 }
+export declare const UPDATE_UI_CAPABILITY: "updateUi:v1";
+export type NativeAppUpdate = {
+    currentVersion: string;
+    latestVersion: string;
+    platform: "ios" | "android";
+};
+export type WebAppUpdate = {
+    webappVersion: string;
+};
+export type AppUpdateSnapshot = {
+    capability: typeof UPDATE_UI_CAPABILITY;
+    nativeUpdate: NativeAppUpdate | null;
+    webUpdate: WebAppUpdate | null;
+};
 export interface WRAPPER_RESPONSE_BASE {
     success: boolean;
     error?: string;

package/dist-types/src/types/communication-between-apps/wrapper-communication.js

@@ -27,10 +27,16 @@ export var AppSentMessage;
     AppSentMessage["MARTY_CALIBRATE_COLOUR_SENSOR"] = "MARTY_CALIBRATE_COLOUR_SENSOR";
     AppSentMessage["MARTY_RESET_COLOUR_SENSOR_OFFSETS"] = "MARTY_RESET_COLOUR_SENSOR_OFFSETS";
     AppSentMessage["GET_DEVICE_INFO"] = "GET_DEVICE_INFO";
+    AppSentMessage["UPDATE_UI_READY"] = "UPDATE_UI_READY";
+    AppSentMessage["UPDATE_GET_STATE"] = "UPDATE_GET_STATE";
+    AppSentMessage["UPDATE_APPLY_WEB"] = "UPDATE_APPLY_WEB";
+    AppSentMessage["UPDATE_OPEN_NATIVE_STORE"] = "UPDATE_OPEN_NATIVE_STORE";
     AppSentMessage["SEND_ATOMIC_READ_OPERATION_TO_MARTY"] = "SEND_ATOMIC_READ_OPERATION_TO_MARTY";
 })(AppSentMessage || (AppSentMessage = {}));
 export var WrapperSentMessage;
 (function (WrapperSentMessage) {
     WrapperSentMessage["RAFT_PUBLISHED_EVENT"] = "RAFT_PUBLISHED_EVENT";
     WrapperSentMessage["RAFT_CONNECTED_RESULTS"] = "RAFT_CONNECTED_RESULTS";
+    WrapperSentMessage["UPDATE_STATE_CHANGED"] = "UPDATE_STATE_CHANGED";
 })(WrapperSentMessage || (WrapperSentMessage = {}));
+export var UPDATE_UI_CAPABILITY = "updateUi:v1";

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

@@ -0,0 +1,10 @@
+import { type AppUpdateSnapshot } from "../../types/communication-between-apps/wrapper-communication";
+type UpdateListener = (snapshot: AppUpdateSnapshot) => void;
+export declare const isAppUpdateSnapshot: (value: unknown) => value is AppUpdateSnapshot;
+export declare const publishPhoneAppUpdateState: (value: unknown) => void;
+export declare const subscribeToPhoneAppUpdates: (listener: UpdateListener) => () => void;
+export declare const announcePhoneAppUpdateUiReady: () => Promise<AppUpdateSnapshot | null>;
+export declare const getPhoneAppUpdateState: () => Promise<AppUpdateSnapshot | null>;
+export declare const applyPhoneWebUpdate: () => Promise<"restarting" | "unavailable">;
+export declare const openPhoneNativeStore: () => Promise<boolean>;
+export {};

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

@@ -0,0 +1,141 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { AppSentMessage, UPDATE_UI_CAPABILITY, } from "../../types/communication-between-apps/wrapper-communication";
+import isPhoneApp from "./is-phone-app";
+var listeners = new Set();
+var isNativeUpdate = function (value) {
+    if (!value || typeof value !== "object") {
+        return false;
+    }
+    var update = value;
+    return (typeof update.currentVersion === "string" &&
+        typeof update.latestVersion === "string" &&
+        (update.platform === "ios" || update.platform === "android"));
+};
+var isWebUpdate = function (value) {
+    if (!value || typeof value !== "object") {
+        return false;
+    }
+    return typeof value.webappVersion === "string";
+};
+export var isAppUpdateSnapshot = function (value) {
+    if (!value || typeof value !== "object") {
+        return false;
+    }
+    var candidate = value;
+    return (candidate.capability === UPDATE_UI_CAPABILITY &&
+        (candidate.nativeUpdate === null || isNativeUpdate(candidate.nativeUpdate)) &&
+        (candidate.webUpdate === null || isWebUpdate(candidate.webUpdate)));
+};
+export var publishPhoneAppUpdateState = function (value) {
+    if (!isAppUpdateSnapshot(value)) {
+        return;
+    }
+    listeners.forEach(function (listener) { return listener(value); });
+};
+export var subscribeToPhoneAppUpdates = function (listener) {
+    listeners.add(listener);
+    return function () {
+        listeners.delete(listener);
+    };
+};
+var requestUpdateState = function (message) { return __awaiter(void 0, void 0, void 0, function () {
+    var snapshot, _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                if (!isPhoneApp()) {
+                    return [2 /*return*/, null];
+                }
+                _b.label = 1;
+            case 1:
+                _b.trys.push([1, 3, , 4]);
+                return [4 /*yield*/, window.wrapperCommunicator.sendMessageAndWait(message, {})];
+            case 2:
+                snapshot = _b.sent();
+                if (!isAppUpdateSnapshot(snapshot)) {
+                    return [2 /*return*/, null];
+                }
+                publishPhoneAppUpdateState(snapshot);
+                return [2 /*return*/, snapshot];
+            case 3:
+                _a = _b.sent();
+                return [2 /*return*/, null];
+            case 4: return [2 /*return*/];
+        }
+    });
+}); };
+export var announcePhoneAppUpdateUiReady = function () {
+    return requestUpdateState(AppSentMessage.UPDATE_UI_READY);
+};
+export var getPhoneAppUpdateState = function () {
+    return requestUpdateState(AppSentMessage.UPDATE_GET_STATE);
+};
+export var applyPhoneWebUpdate = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var response, _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                _b.trys.push([0, 2, , 3]);
+                return [4 /*yield*/, window.wrapperCommunicator.sendMessageAndWait(AppSentMessage.UPDATE_APPLY_WEB, {})];
+            case 1:
+                response = _b.sent();
+                return [2 /*return*/, (response === null || response === void 0 ? void 0 : response.status) === "restarting" ? "restarting" : "unavailable"];
+            case 2:
+                _a = _b.sent();
+                return [2 /*return*/, "unavailable"];
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };
+export var openPhoneNativeStore = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var response, _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                _b.trys.push([0, 2, , 3]);
+                return [4 /*yield*/, window.wrapperCommunicator.sendMessageAndWait(AppSentMessage.UPDATE_OPEN_NATIVE_STORE, {})];
+            case 1:
+                response = _b.sent();
+                return [2 /*return*/, (response === null || response === void 0 ? void 0 : response.opened) === true];
+            case 2:
+                _a = _b.sent();
+                return [2 /*return*/, false];
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };

package/package.json

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