@robotical/webapp-types 3.25.24 → 3.26.0

package/dist-types/package.json

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

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

@@ -1,7 +1,9 @@
 import { FeedbackRating } from "../../../utils/feedback/submitFeedback";
+import type { FeedbackReason } from "../../../utils/feedback/feedbackReasons";
 type Props = {
     otherInfoObject?: Record<string, unknown>;
     rating?: FeedbackRating;
+    reason?: FeedbackReason;
 };
-export default function DetailedFeedbackModal({ otherInfoObject, rating, }: Props): import("react/jsx-runtime").JSX.Element;
+export default function DetailedFeedbackModal({ otherInfoObject, rating, reason, }: Props): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -56,7 +56,7 @@ import styles from "./styles.module.css";
 import SimpleButton from "../../disposables/buttons/SimpleButton";
 export default function DetailedFeedbackModal(_a) {
     var _this = this;
-    var otherInfoObject = _a.otherInfoObject, rating = _a.rating;
+    var otherInfoObject = _a.otherInfoObject, rating = _a.rating, reason = _a.reason;
     var t = useTranslation().t;
     var _b = useState(""), report = _b[0], setReport = _b[1];
     var _c = useState(""), email = _c[0], setEmail = _c[1];
@@ -75,11 +75,7 @@ export default function DetailedFeedbackModal(_a) {
                     _c.label = 1;
                 case 1:
                     _c.trys.push([1, 3, , 4]);
-                    return [4 /*yield*/, submitFeedback({
-                            rating: rating,
-                            context: otherInfoObject,
-                            source: "emoji-modal",
-                        })];
+                    return [4 /*yield*/, submitFeedback(__assign(__assign({ rating: rating }, (reason ? { reason: reason } : {})), { context: otherInfoObject, source: "emoji-modal" }))];
                 case 2:
                     _c.sent();
                     page = getFeedbackPromptPageFromContext(otherInfoObject);
@@ -140,13 +136,7 @@ export default function DetailedFeedbackModal(_a) {
                     _c.label = 1;
                 case 1:
                     _c.trys.push([1, 3, 4, 5]);
-                    return [4 /*yield*/, submitFeedback({
-                            rating: rating,
-                            message: report,
-                            email: email,
-                            context: otherInfoObject,
-                            source: "detailed-feedback",
-                        })];
+                    return [4 /*yield*/, submitFeedback(__assign(__assign({ rating: rating }, (reason ? { reason: reason } : {})), { message: report, email: email, context: otherInfoObject, source: "detailed-feedback" }))];
                 case 2:
                     _c.sent();
                     page = getFeedbackPromptPageFromContext(otherInfoObject);

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

@@ -0,0 +1,21 @@
+export declare const FEEDBACK_REASONS: readonly [{
+    readonly value: "connection";
+    readonly label: "Connection";
+}, {
+    readonly value: "loading";
+    readonly label: "Loading";
+}, {
+    readonly value: "controls";
+    readonly label: "Controls";
+}, {
+    readonly value: "difficulty";
+    readonly label: "Difficulty";
+}, {
+    readonly value: "bug";
+    readonly label: "Bug";
+}, {
+    readonly value: "other";
+    readonly label: "Other";
+}];
+export type FeedbackReason = typeof FEEDBACK_REASONS[number]["value"];
+export declare function normalizeFeedbackReason(rating: number | null | undefined, reason: unknown): FeedbackReason | null;

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

@@ -0,0 +1,15 @@
+export var FEEDBACK_REASONS = [
+    { value: "connection", label: "Connection" },
+    { value: "loading", label: "Loading" },
+    { value: "controls", label: "Controls" },
+    { value: "difficulty", label: "Difficulty" },
+    { value: "bug", label: "Bug" },
+    { value: "other", label: "Other" },
+];
+export function normalizeFeedbackReason(rating, reason) {
+    var _a, _b;
+    if (rating !== 1 && rating !== 2) {
+        return null;
+    }
+    return (_b = (_a = FEEDBACK_REASONS.find(function (option) { return option.value === reason; })) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : null;
+}

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

@@ -1,4 +1,5 @@
 import type { UserDeviceInfo } from "../../types/userDeviceInfo";
+import { type FeedbackReason } from "./feedbackReasons";
 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";
@@ -27,6 +28,7 @@ export type FeedbackEnvironment = {
 };
 export type SubmitFeedbackInput = {
     rating?: FeedbackRating;
+    reason?: FeedbackReason;
     message?: string;
     email?: string;
     context?: Record<string, unknown> | null;
@@ -36,6 +38,7 @@ export type SubmitFeedbackInput = {
 };
 export type FeedbackRecord = {
     rating: FeedbackRating | null;
+    reason: FeedbackReason | null;
     message: string | null;
     email: string | null;
     source: FeedbackSource;

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

@@ -49,6 +49,7 @@ import Logger from "../../services/logger/Logger";
 import { FEEDBACK_REQUIRES_ROBOT_CONNECTION_MESSAGE, getActiveFeedbackRobotConnection, isRobotConnectionRequiredForFeedbackSource, } from "./feedbackConnectionEligibility";
 import randomHashGenerator from "../helpers/randomHashGenerator";
 import isPhoneApp from "../phone-app-communication/is-phone-app";
+import { FEEDBACK_REASONS, normalizeFeedbackReason, } from "./feedbackReasons";
 var SHOW_LOGS = true;
 var TAG = "submitFeedback";
 var WEB_APP_FEEDBACK_DB_URL = "https://web-app-bug-reports-default-rtdb.europe-west1.firebasedatabase.app/";
@@ -167,6 +168,7 @@ function getEnvironmentTextLines(environment) {
     return lines.concat(deviceLines);
 }
 export function buildFeedbackText(record) {
+    var _a;
     var lines = ["Source: ".concat(record.source)];
     lines.push.apply(lines, getEnvironmentTextLines(record.environment));
     var page = record.context && typeof record.context.page === "string"
@@ -202,6 +204,13 @@ export function buildFeedbackText(record) {
     if (record.rating) {
         lines.push("Rating: ".concat(record.rating, "/5"));
     }
+    if (record.reason) {
+        var label = (_a = FEEDBACK_REASONS.find(function (_a) {
+            var value = _a.value;
+            return value === record.reason;
+        })) === null || _a === void 0 ? void 0 : _a.label;
+        lines.push("Reason: ".concat(label));
+    }
     if (record.screenshots.length > 0) {
         lines.push("Screenshots: ".concat(record.screenshots.length, " (view in Marty Web App Insights)"));
     }
@@ -219,6 +228,7 @@ export function createFeedbackRecord(input) {
     var environment = (_a = input.environment) !== null && _a !== void 0 ? _a : collectFeedbackEnvironment();
     var record = {
         rating: (_b = input.rating) !== null && _b !== void 0 ? _b : null,
+        reason: normalizeFeedbackReason(input.rating, input.reason),
         message: normalizedMessage,
         email: normalizedEmail,
         source: input.source,

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

@@ -1,5 +1,7 @@
 import { type AppUpdateSnapshot } from "../../types/communication-between-apps/wrapper-communication";
 type UpdateListener = (snapshot: AppUpdateSnapshot) => void;
+export declare const UPDATE_REQUEST_TIMEOUT_MS = 20000;
+export declare const UPDATE_CHECK_STALE_MS = 30000;
 export declare const isAppUpdateSnapshot: (value: unknown) => value is AppUpdateSnapshot;
 export declare const publishPhoneAppUpdateState: (value: unknown) => void;
 export declare const subscribeToPhoneAppUpdates: (listener: UpdateListener) => () => void;

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

@@ -50,6 +50,10 @@ import isPhoneApp from "./is-phone-app";
 import { useEffect, useState } from "react";
 var listeners = new Set();
 var latestSnapshot = null;
+export var UPDATE_REQUEST_TIMEOUT_MS = 20000;
+export var UPDATE_CHECK_STALE_MS = 30000;
+var readyRequest = null;
+var checkRequest = null;
 var isNativeUpdate = function (value) {
     if (!value || typeof value !== "object") {
         return false;
@@ -97,13 +101,44 @@ export var subscribeToPhoneAppUpdates = function (listener) {
         listeners.delete(listener);
     };
 };
+var useCheckingDeadline = function (kind, status) {
+    useEffect(function () {
+        if (status !== 'checking') {
+            return;
+        }
+        var deadline = Date.now() + UPDATE_CHECK_STALE_MS;
+        var expire = function () {
+            var _a;
+            var _b;
+            if (Date.now() < deadline || ((_b = latestSnapshot === null || latestSnapshot === void 0 ? void 0 : latestSnapshot.checks) === null || _b === void 0 ? void 0 : _b[kind]) !== 'checking') {
+                return;
+            }
+            publishPhoneAppUpdateState(__assign(__assign({}, latestSnapshot), { checks: __assign(__assign({}, latestSnapshot.checks), (_a = {}, _a[kind] = 'unknown', _a)) }));
+        };
+        var timer = setTimeout(expire, UPDATE_CHECK_STALE_MS);
+        // WebView timers can pause in the background. Check elapsed time on return.
+        var onVisible = function () { if (!document.hidden) {
+            expire();
+        } };
+        document.addEventListener('visibilitychange', onVisible);
+        window.addEventListener('pageshow', expire);
+        return function () {
+            clearTimeout(timer);
+            document.removeEventListener('visibilitychange', onVisible);
+            window.removeEventListener('pageshow', expire);
+        };
+    }, [kind, status]);
+};
 export var usePhoneAppUpdates = function () {
-    var _a = useState(latestSnapshot), snapshot = _a[0], setSnapshot = _a[1];
+    var _a, _b;
+    var _c = useState(latestSnapshot), snapshot = _c[0], setSnapshot = _c[1];
     useEffect(function () { return subscribeToPhoneAppUpdates(setSnapshot); }, []);
+    useCheckingDeadline('native', (_a = snapshot === null || snapshot === void 0 ? void 0 : snapshot.checks) === null || _a === void 0 ? void 0 : _a.native);
+    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 snapshot, _a;
+    var timer, snapshot, _a;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
@@ -112,8 +147,11 @@ var requestUpdateState = function (message) { return __awaiter(void 0, void 0, v
                 }
                 _b.label = 1;
             case 1:
-                _b.trys.push([1, 3, , 4]);
-                return [4 /*yield*/, window.wrapperCommunicator.sendMessageAndWait(message, {})];
+                _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); }),
+                    ])];
             case 2:
                 snapshot = _b.sent();
                 if (!isAppUpdateSnapshot(snapshot)) {
@@ -124,30 +162,47 @@ var requestUpdateState = function (message) { return __awaiter(void 0, void 0, v
             case 3:
                 _a = _b.sent();
                 return [2 /*return*/, null];
-            case 4: return [2 /*return*/];
+            case 4:
+                clearTimeout(timer);
+                return [7 /*endfinally*/];
+            case 5: return [2 /*return*/];
         }
     });
 }); };
 export var announcePhoneAppUpdateUiReady = function () {
-    return requestUpdateState(AppSentMessage.UPDATE_UI_READY);
+    if (!readyRequest) {
+        readyRequest = requestUpdateState(AppSentMessage.UPDATE_UI_READY).finally(function () { readyRequest = null; });
+    }
+    return readyRequest;
 };
 export var getPhoneAppUpdateState = function () {
     return requestUpdateState(AppSentMessage.UPDATE_GET_STATE);
 };
-export var checkPhoneAppUpdates = function () { return __awaiter(void 0, void 0, void 0, function () {
-    var supportsChecks, result, _a, native, web;
-    return __generator(this, function (_b) {
-        switch (_b.label) {
+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) {
             case 0:
+                _a = !latestSnapshot;
+                if (!_a) return [3 /*break*/, 2];
+                return [4 /*yield*/, announcePhoneAppUpdateUiReady()];
+            case 1:
+                _a = !(_c.sent());
+                _c.label = 2;
+            case 2:
+                // A lost cold-start reply must not permanently remove access to update checks.
+                if (_a) {
+                    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 1:
-                result = _b.sent();
+            case 3:
+                result = _c.sent();
                 if (!result && (latestSnapshot === null || latestSnapshot === void 0 ? void 0 : latestSnapshot.checks)) {
-                    _a = latestSnapshot.checks, native = _a.native, web = _a.web;
+                    _b = latestSnapshot.checks, native = _b.native, web = _b.web;
                     publishPhoneAppUpdateState(__assign(__assign({}, latestSnapshot), { checks: {
                             native: native === "checking" ? "unknown" : native,
                             web: web === "checking" ? "unknown" : web,
@@ -157,6 +212,12 @@ export var checkPhoneAppUpdates = function () { return __awaiter(void 0, void 0,
         }
     });
 }); };
+export var checkPhoneAppUpdates = function () {
+    if (!checkRequest) {
+        checkRequest = performUpdateCheck().finally(function () { checkRequest = null; });
+    }
+    return checkRequest;
+};
 export var applyPhoneWebUpdate = function () { return __awaiter(void 0, void 0, void 0, function () {
     var response, _a;
     return __generator(this, function (_b) {

package/package.json

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