@robotical/webapp-types 3.19.1 → 3.20.0

package/dist-types/src/application/ApplicationManager/ApplicationManager.d.ts

@@ -58,6 +58,7 @@ export default class ApplicationManager {
     isPhoneApp: () => boolean;
     constructor();
     getDeviceInfo(): Promise<void>;
+    ensureWifiConnectionSupported(): Promise<boolean>;
     updateRaftNameInAllStates(raftId: string, name: string): Promise<boolean>;
     private getConnectedRaftName;
     /**

package/dist-types/src/application/ApplicationManager/ApplicationManager.js

@@ -68,12 +68,14 @@ import draggableModalState from "../../state-observables/modal/DraggableModalSta
 import SensorsDashboardModal from "../../components/modals/ SensorsDashboardModal";
 import LEDLightsOrQRVerificationModal from "../../components/modals/LEDLightsOrQRVerificationModal";
 import WifiConnectionModal from "../../components/modals/WifiConnectionModal";
+import WifiPhoneAppUpdateRequiredModal from "../../components/modals/WifiPhoneAppUpdateRequiredModal";
 import { CarouselNavigatorManager } from "../../utils/CarouselNavigatorManager";
 import i18n from "../../i18n";
 import InUnpluggedModalContent from "../../components/modals/InUnplugged";
 import { cogKeepAwakeManager, } from "../../features/cog-keep-awake";
 import { normalizeWifiLocator } from "../../utils/wifi-connection";
-import { ConnectionMethodPreference, getConnectionMethodPreference, } from "../../store/ConnectionMethodPreference";
+import { ConnectionMethodPreference, getConnectionMethodPreference, setConnectionMethodPreference, } from "../../store/ConnectionMethodPreference";
+import { MINIMUM_PHONE_APP_WIFI_VERSION, isPhoneWrapperWifiSupported, } from "../../utils/phone-app-communication/wifi-connection-support";
 var SHOW_LOGS = true;
 var TAG = "ApplicationManager";
 var UNSUPPORTED_WEB_BLUETOOTH_BROWSER_MESSAGE = "This browser can't connect to Marty or Cog over Bluetooth. Please use Chrome or Edge, or use the iPad app.";
@@ -188,6 +190,49 @@ var ApplicationManager = /** @class */ (function () {
             });
         });
     };
+    ApplicationManager.prototype.ensureWifiConnectionSupported = function () {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function () {
+            var error_1;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        if (!isPhoneApp()) {
+                            return [2 /*return*/, true];
+                        }
+                        if (!!this.deviceInfo) return [3 /*break*/, 4];
+                        _e.label = 1;
+                    case 1:
+                        _e.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.getDeviceInfo()];
+                    case 2:
+                        _e.sent();
+                        return [3 /*break*/, 4];
+                    case 3:
+                        error_1 = _e.sent();
+                        Logger.warn(SHOW_LOGS, TAG, "Failed to determine phone app version for Wi-Fi: ".concat(error_1));
+                        return [3 /*break*/, 4];
+                    case 4:
+                        if (isPhoneWrapperWifiSupported((_a = this.deviceInfo) === null || _a === void 0 ? void 0 : _a.appVersion)) {
+                            return [2 /*return*/, true];
+                        }
+                        // Fail closed on old, missing, or malformed wrapper versions. Resetting
+                        // the preference also covers a stale Wi-Fi choice left in localStorage.
+                        setConnectionMethodPreference(ConnectionMethodPreference.BLUETOOTH);
+                        return [4 /*yield*/, modalState.setModal(createElement(WifiPhoneAppUpdateRequiredModal, {
+                                systemName: (_b = this.deviceInfo) === null || _b === void 0 ? void 0 : _b.systemName,
+                                showUpdateAction: isPhoneWrapperWifiSupported((_c = this.deviceInfo) === null || _c === void 0 ? void 0 : _c.latestAppVersion),
+                            }), i18n.t("connection.wifi_phone_update_title", {
+                                defaultValue: "Update required for Wi-Fi",
+                            }), "robotical", true, false)];
+                    case 5:
+                        _e.sent();
+                        Logger.warn(SHOW_LOGS, TAG, "Wi-Fi requires phone app ".concat(MINIMUM_PHONE_APP_WIFI_VERSION, " or later; received ").concat(((_d = this.deviceInfo) === null || _d === void 0 ? void 0 : _d.appVersion) || "unknown"));
+                        return [2 /*return*/, false];
+                }
+            });
+        });
+    };
     ApplicationManager.prototype.updateRaftNameInAllStates = function (raftId, name) {
         return __awaiter(this, void 0, void 0, function () {
             var raft, wasSuccessful;
@@ -224,7 +269,7 @@ var ApplicationManager = /** @class */ (function () {
     };
     ApplicationManager.prototype.getConnectedRaftName = function (raft) {
         return __awaiter(this, void 0, void 0, function () {
-            var cachedName, error_1;
+            var cachedName, error_2;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -238,8 +283,8 @@ var ApplicationManager = /** @class */ (function () {
                         return [4 /*yield*/, raft.getRaftName()];
                     case 2: return [2 /*return*/, (_a.sent()) || ""];
                     case 3:
-                        error_1 = _a.sent();
-                        Logger.warn(SHOW_LOGS, TAG, "Failed to read RAFT name for ".concat(raft.id, ": ").concat(error_1));
+                        error_2 = _a.sent();
+                        Logger.warn(SHOW_LOGS, TAG, "Failed to read RAFT name for ".concat(raft.id, ": ").concat(error_2));
                         return [2 /*return*/, ""];
                     case 4: return [2 /*return*/];
                 }
@@ -282,7 +327,7 @@ var ApplicationManager = /** @class */ (function () {
     };
     ApplicationManager.prototype.confirmQrVerifiedConnection = function (raft) {
         return __awaiter(this, void 0, void 0, function () {
-            var didPublishVerifiedEvent, error_2;
+            var didPublishVerifiedEvent, error_3;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, Promise.resolve()];
@@ -303,8 +348,8 @@ var ApplicationManager = /** @class */ (function () {
                         }
                         return [3 /*break*/, 5];
                     case 4:
-                        error_2 = _a.sent();
-                        Logger.warn(SHOW_LOGS, TAG, "Failed to publish QR verified event for ".concat(raft.id, ": ").concat(error_2));
+                        error_3 = _a.sent();
+                        Logger.warn(SHOW_LOGS, TAG, "Failed to publish QR verified event for ".concat(raft.id, ": ").concat(error_3));
                         this.publishLocalVerifiedConnection(raft);
                         return [3 /*break*/, 5];
                     case 5: return [2 /*return*/];
@@ -632,9 +677,9 @@ var ApplicationManager = /** @class */ (function () {
     };
     ApplicationManager.prototype._resolveConnectOptions = function (options) {
         return __awaiter(this, void 0, void 0, function () {
-            var method, expectedRaftType, bluetoothMethod, locator, modalLocator;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var method, expectedRaftType, bluetoothMethod, _a, locator, modalLocator;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         method = options.method;
                         expectedRaftType = options.expectedRaftType;
@@ -647,6 +692,16 @@ var ApplicationManager = /** @class */ (function () {
                                 ? RaftConnectionMethod.WEB_SOCKET
                                 : bluetoothMethod;
                         }
+                        _a = method === RaftConnectionMethod.WEB_SOCKET;
+                        if (!_a) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.ensureWifiConnectionSupported()];
+                    case 1:
+                        _a = !(_b.sent());
+                        _b.label = 2;
+                    case 2:
+                        if (_a) {
+                            return [2 /*return*/, null];
+                        }
                         if (expectedRaftType === RaftTypeE.COG &&
                             method === RaftConnectionMethod.WEB_SOCKET) {
                             this.toaster.error(i18n.t("connection.cog_wifi_unsupported", {
@@ -671,18 +726,18 @@ var ApplicationManager = /** @class */ (function () {
                             return [2 /*return*/, null];
                         }
                         locator = options.locator;
-                        if (!!locator) return [3 /*break*/, 2];
+                        if (!!locator) return [3 /*break*/, 4];
                         return [4 /*yield*/, modalState.setModal(createElement(WifiConnectionModal, { raftType: expectedRaftType }), i18n.t("connection.wifi_connection_title", {
                                 defaultValue: "Connect over Wi-Fi",
                             }), getModalLogoForRaftType(expectedRaftType), true, false)];
-                    case 1:
-                        modalLocator = _a.sent();
+                    case 3:
+                        modalLocator = _b.sent();
                         if (!modalLocator) {
                             return [2 /*return*/, null];
                         }
                         locator = modalLocator;
-                        _a.label = 2;
-                    case 2:
+                        _b.label = 4;
+                    case 4:
                         if (!locator) {
                             return [2 /*return*/, null];
                         }

package/dist-types/src/components/modals/WifiPhoneAppUpdateRequiredModal/index.d.ts

@@ -0,0 +1,6 @@
+type WifiPhoneAppUpdateRequiredModalProps = {
+    systemName?: string;
+    showUpdateAction?: boolean;
+};
+export default function WifiPhoneAppUpdateRequiredModal({ systemName, showUpdateAction, }: WifiPhoneAppUpdateRequiredModalProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist-types/src/components/modals/WifiPhoneAppUpdateRequiredModal/index.js

@@ -0,0 +1,44 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { useTranslation } from "react-i18next";
+import modalState from "../../../state-observables/modal/ModalState";
+import { PALE_BLUE } from "../../../styles/colors";
+import openNewTab from "../../../utils/open-new-tab";
+import SimpleButton from "../../disposables/buttons/SimpleButton";
+import styles from "./styles.module.css";
+var IOS_APP_STORE_URL = "https://apps.apple.com/app/robotical/id6739531583";
+var ANDROID_PLAY_STORE_URL = "https://play.google.com/store/apps/details?id=com.marty";
+var getStoreUrl = function (systemName) {
+    var platform = "".concat(systemName || "", " ").concat(navigator.userAgent).toLowerCase();
+    return platform.includes("android")
+        ? ANDROID_PLAY_STORE_URL
+        : IOS_APP_STORE_URL;
+};
+export default function WifiPhoneAppUpdateRequiredModal(_a) {
+    var systemName = _a.systemName, _b = _a.showUpdateAction, showUpdateAction = _b === void 0 ? false : _b;
+    var t = useTranslation().t;
+    var keepUsingBluetooth = function () {
+        modalState.closeModal(false);
+    };
+    var updateApp = function () {
+        openNewTab(getStoreUrl(systemName));
+        modalState.closeModal(false);
+    };
+    return (_jsxs("div", __assign({ className: styles.container }, { children: [_jsx("p", __assign({ className: styles.message }, { children: t("connection.wifi_phone_update_message", {
+                    defaultValue: "Wi-Fi connections require Robotical app 2.4.4 or later. You can continue connecting with Bluetooth.",
+                }) })), _jsxs("div", __assign({ className: styles.actions }, { children: [_jsx(SimpleButton, { title: t("connection.keep_using_bluetooth", {
+                            defaultValue: "Keep using Bluetooth",
+                        }), onClick: keepUsingBluetooth, colour: PALE_BLUE }), showUpdateAction ? (_jsx(SimpleButton, { title: t("connection.update_phone_app", {
+                            defaultValue: "Update app",
+                        }), onClick: updateApp })) : null] }))] })));
+}

package/dist-types/src/utils/feedback/submitFeedback.d.ts

@@ -2,6 +2,17 @@ import type { UserDeviceInfo } from "../../types/userDeviceInfo";
 export type FeedbackRating = 1 | 2 | 3 | 4 | 5;
 export type FeedbackSource = "emoji-modal" | "detailed-feedback" | "help-bug-report";
 export type FeedbackAppRuntime = "phone-app" | "web-app";
+export type FeedbackScreenshot = {
+    id: string;
+    fileName: string;
+    mimeType: string;
+    sizeBytes: number;
+    width: number;
+    height: number;
+};
+export type FeedbackScreenshotUpload = FeedbackScreenshot & {
+    dataUrl: string;
+};
 export type FeedbackEnvironment = {
     appRuntime: FeedbackAppRuntime;
     isPhoneApp: boolean;
@@ -21,6 +32,7 @@ export type SubmitFeedbackInput = {
     context?: Record<string, unknown> | null;
     source: FeedbackSource;
     environment?: FeedbackEnvironment;
+    screenshots?: FeedbackScreenshotUpload[];
 };
 export type FeedbackRecord = {
     rating: FeedbackRating | null;
@@ -29,6 +41,7 @@ export type FeedbackRecord = {
     source: FeedbackSource;
     context: Record<string, unknown> | null;
     environment: FeedbackEnvironment;
+    screenshots: FeedbackScreenshot[];
     timestamp: string;
     text: string;
 };

package/dist-types/src/utils/feedback/submitFeedback.js

@@ -202,6 +202,9 @@ export function buildFeedbackText(record) {
     if (record.rating) {
         lines.push("Rating: ".concat(record.rating, "/5"));
     }
+    if (record.screenshots.length > 0) {
+        lines.push("Screenshots: ".concat(record.screenshots.length, " (view in Marty Web App Insights)"));
+    }
     lines.push("Email: ".concat(record.email || "Anonymous"));
     if (record.message) {
         lines.push("Message: ".concat(record.message));
@@ -209,7 +212,7 @@ export function buildFeedbackText(record) {
     return lines.join("\n");
 }
 export function createFeedbackRecord(input) {
-    var _a, _b;
+    var _a, _b, _c;
     var normalizedMessage = normalizeOptionalString(input.message);
     var normalizedEmail = normalizeOptionalString(input.email);
     var timestamp = new Date().toISOString();
@@ -221,6 +224,14 @@ export function createFeedbackRecord(input) {
         source: input.source,
         context: input.context || null,
         environment: environment,
+        screenshots: ((_c = input.screenshots) !== null && _c !== void 0 ? _c : []).map(function (screenshot) { return ({
+            id: screenshot.id,
+            fileName: screenshot.fileName,
+            mimeType: screenshot.mimeType,
+            sizeBytes: screenshot.sizeBytes,
+            width: screenshot.width,
+            height: screenshot.height,
+        }); }),
         timestamp: timestamp,
         text: "",
     };
@@ -228,11 +239,12 @@ export function createFeedbackRecord(input) {
     return record;
 }
 export function submitFeedback(input) {
-    var _a;
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function () {
-        var requiresRobotConnection, robotConnection, record, firebaseResponse, errorText, slackDelivered, slackResponse, errorText, error_1;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
+        var requiresRobotConnection, robotConnection, record, feedbackId, firebaseUpdates, _i, _c, screenshot, firebaseResponse, errorText, slackDelivered, slackResponse, errorText, error_1;
+        var _d;
+        return __generator(this, function (_e) {
+            switch (_e.label) {
                 case 0:
                     requiresRobotConnection = isRobotConnectionRequiredForFeedbackSource(input.source);
                     robotConnection = requiresRobotConnection
@@ -243,27 +255,35 @@ export function submitFeedback(input) {
                     }
                     record = createFeedbackRecord(__assign(__assign({}, input), { context: robotConnection
                             ? __assign(__assign({}, ((_a = input.context) !== null && _a !== void 0 ? _a : {})), robotConnection) : input.context }));
-                    return [4 /*yield*/, fetch("".concat(WEB_APP_FEEDBACK_DB_URL).concat(randomHashGenerator(), ".json"), {
+                    feedbackId = randomHashGenerator();
+                    firebaseUpdates = (_d = {},
+                        _d[feedbackId] = record,
+                        _d);
+                    for (_i = 0, _c = (_b = input.screenshots) !== null && _b !== void 0 ? _b : []; _i < _c.length; _i++) {
+                        screenshot = _c[_i];
+                        firebaseUpdates["~screenshots/".concat(feedbackId, "/").concat(screenshot.id)] = screenshot.dataUrl;
+                    }
+                    return [4 /*yield*/, fetch("".concat(WEB_APP_FEEDBACK_DB_URL, ".json?print=silent"), {
                             method: "PATCH",
                             headers: {
                                 Application: "application/json",
                                 "Content-Type": "application/json",
                             },
-                            body: JSON.stringify(record),
+                            body: JSON.stringify(firebaseUpdates),
                         })];
                 case 1:
-                    firebaseResponse = _b.sent();
+                    firebaseResponse = _e.sent();
                     if (!!firebaseResponse.ok) return [3 /*break*/, 3];
                     return [4 /*yield*/, firebaseResponse.text()];
                 case 2:
-                    errorText = _b.sent();
+                    errorText = _e.sent();
                     Logger.error(SHOW_LOGS, TAG, "Failed to submit feedback to Firebase: ".concat(firebaseResponse.status, " ").concat(errorText));
                     throw new Error("Failed to submit feedback");
                 case 3:
                     slackDelivered = true;
-                    _b.label = 4;
+                    _e.label = 4;
                 case 4:
-                    _b.trys.push([4, 8, , 9]);
+                    _e.trys.push([4, 8, , 9]);
                     return [4 /*yield*/, fetch(WEB_APP_FEEDBACK_SLACK_WEBHOOK_URL, {
                             method: "POST",
                             headers: {
@@ -272,15 +292,15 @@ export function submitFeedback(input) {
                             body: JSON.stringify({ text: record.text }),
                         })];
                 case 5:
-                    slackResponse = _b.sent();
+                    slackResponse = _e.sent();
                     if (!!slackResponse.ok) return [3 /*break*/, 7];
                     return [4 /*yield*/, slackResponse.text()];
                 case 6:
-                    errorText = _b.sent();
+                    errorText = _e.sent();
                     throw new Error("Failed Slack response: ".concat(slackResponse.status, " ").concat(errorText));
                 case 7: return [3 /*break*/, 9];
                 case 8:
-                    error_1 = _b.sent();
+                    error_1 = _e.sent();
                     slackDelivered = false;
                     Logger.error(SHOW_LOGS, TAG, "Failed to submit feedback to Slack", error_1);
                     return [3 /*break*/, 9];

package/dist-types/src/utils/open-new-tab.d.ts

@@ -0,0 +1 @@
+export default function openNewTab(url: string): void;

package/dist-types/src/utils/open-new-tab.js

@@ -0,0 +1,5 @@
+export default function openNewTab(url) {
+    var res = window.open(url, "_blank");
+    res && res.focus();
+}
+;

package/dist-types/src/utils/phone-app-communication/wifi-connection-support.d.ts

@@ -0,0 +1,2 @@
+export declare const MINIMUM_PHONE_APP_WIFI_VERSION = "2.4.4";
+export declare const isPhoneWrapperWifiSupported: (appVersion: string | null | undefined) => boolean;

package/dist-types/src/utils/phone-app-communication/wifi-connection-support.js

@@ -0,0 +1,13 @@
+import semverGte from "semver/functions/gte";
+export var MINIMUM_PHONE_APP_WIFI_VERSION = "2.4.4";
+export var isPhoneWrapperWifiSupported = function (appVersion) {
+    if (typeof appVersion !== "string" || !appVersion.trim()) {
+        return false;
+    }
+    try {
+        return semverGte(appVersion.trim(), MINIMUM_PHONE_APP_WIFI_VERSION);
+    }
+    catch (_a) {
+        return false;
+    }
+};

package/package.json

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