@robotical/webapp-types 3.16.16 → 3.16.18

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

@@ -51,6 +51,7 @@ import { useTranslation } from "react-i18next";
 import modalState from "../../../state-observables/modal/ModalState";
 import { submitFeedback, } from "../../../utils/feedback/submitFeedback";
 import { getFeedbackPromptPageFromContext, markFeedbackPromptSubmitted, } from "../../../utils/feedback/feedbackPromptPolicy";
+import { FEEDBACK_REQUIRES_ROBOT_CONNECTION_MESSAGE } from "../../../utils/feedback/feedbackConnectionEligibility";
 import styles from "./styles.module.css";
 import SimpleButton from "../../disposables/buttons/SimpleButton";
 export default function DetailedFeedbackModal(_a) {
@@ -89,7 +90,10 @@ export default function DetailedFeedbackModal(_a) {
                     return [2 /*return*/, true];
                 case 3:
                     error_1 = _c.sent();
-                    (_b = (_a = window.applicationManager) === null || _a === void 0 ? void 0 : _a.toaster) === null || _b === void 0 ? void 0 : _b.error("There was an error sending your feedback. Please try again later.");
+                    (_b = (_a = window.applicationManager) === null || _a === void 0 ? void 0 : _a.toaster) === null || _b === void 0 ? void 0 : _b.error(error_1 instanceof Error &&
+                        error_1.message === FEEDBACK_REQUIRES_ROBOT_CONNECTION_MESSAGE
+                        ? FEEDBACK_REQUIRES_ROBOT_CONNECTION_MESSAGE
+                        : "There was an error sending your feedback. Please try again later.");
                     return [2 /*return*/, false];
                 case 4: return [2 /*return*/];
             }
@@ -156,7 +160,10 @@ export default function DetailedFeedbackModal(_a) {
                     return [3 /*break*/, 5];
                 case 3:
                     error_2 = _c.sent();
-                    (_b = (_a = window.applicationManager) === null || _a === void 0 ? void 0 : _a.toaster) === null || _b === void 0 ? void 0 : _b.error("There was an error sending your feedback. Please try again later.");
+                    (_b = (_a = window.applicationManager) === null || _a === void 0 ? void 0 : _a.toaster) === null || _b === void 0 ? void 0 : _b.error(error_2 instanceof Error &&
+                        error_2.message === FEEDBACK_REQUIRES_ROBOT_CONNECTION_MESSAGE
+                        ? FEEDBACK_REQUIRES_ROBOT_CONNECTION_MESSAGE
+                        : "There was an error sending your feedback. Please try again later.");
                     return [3 /*break*/, 5];
                 case 4:
                     setIsSubmitting(false);

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

@@ -0,0 +1,22 @@
+import { RaftTypeE } from "../../types/raft";
+type ApplicationManagerWithConnections = {
+    connectedRafts?: Record<string, ConnectedRaftEntity | undefined>;
+    connectedRaftsContext?: Array<{
+        id?: string;
+        type?: RaftTypeE;
+        isSelected?: boolean;
+    }>;
+};
+type ConnectedRaftEntity = {
+    type?: RaftTypeE;
+    getSerialNumber?: () => string;
+};
+export type FeedbackRobotConnectionDetails = {
+    selectedRaftType: RaftTypeE.MARTY | RaftTypeE.COG;
+    selectedRaftSerialNumber: string | null;
+};
+export declare const FEEDBACK_REQUIRES_ROBOT_CONNECTION_MESSAGE = "Please connect to a robot before sending feedback.";
+export declare function hasActiveRobotConnection(applicationManager?: ApplicationManagerWithConnections | undefined): boolean;
+export declare function getActiveFeedbackRobotConnection(applicationManager?: ApplicationManagerWithConnections | undefined): FeedbackRobotConnectionDetails | null;
+export declare function isRobotConnectionRequiredForFeedbackSource(source: string): boolean;
+export {};

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

@@ -0,0 +1,90 @@
+import { RaftTypeE } from "../../types/raft";
+export var FEEDBACK_REQUIRES_ROBOT_CONNECTION_MESSAGE = "Please connect to a robot before sending feedback.";
+function getApplicationManager() {
+    if (typeof window === "undefined") {
+        return undefined;
+    }
+    return window.applicationManager;
+}
+export function hasActiveRobotConnection(applicationManager) {
+    if (applicationManager === void 0) { applicationManager = getApplicationManager(); }
+    return getActiveFeedbackRobotConnection(applicationManager) !== null;
+}
+function isFeedbackRobotType(raftType) {
+    return raftType === RaftTypeE.MARTY || raftType === RaftTypeE.COG;
+}
+function normalizeSerialNumber(serialNumber) {
+    return typeof serialNumber === "string" && serialNumber.trim()
+        ? serialNumber.trim()
+        : null;
+}
+function getRaftSerialNumber(connectedRaft) {
+    var _a;
+    try {
+        return normalizeSerialNumber((_a = connectedRaft === null || connectedRaft === void 0 ? void 0 : connectedRaft.getSerialNumber) === null || _a === void 0 ? void 0 : _a.call(connectedRaft));
+    }
+    catch (error) {
+        return null;
+    }
+}
+function getConnectionDetails(raftType, connectedRaft) {
+    var selectedRaftType = isFeedbackRobotType(raftType)
+        ? raftType
+        : connectedRaft === null || connectedRaft === void 0 ? void 0 : connectedRaft.type;
+    if (!isFeedbackRobotType(selectedRaftType)) {
+        return null;
+    }
+    return {
+        selectedRaftType: selectedRaftType,
+        selectedRaftSerialNumber: getRaftSerialNumber(connectedRaft),
+    };
+}
+export function getActiveFeedbackRobotConnection(applicationManager) {
+    if (applicationManager === void 0) { applicationManager = getApplicationManager(); }
+    var connectedRafts = applicationManager === null || applicationManager === void 0 ? void 0 : applicationManager.connectedRafts;
+    if (!connectedRafts || typeof connectedRafts !== "object") {
+        return null;
+    }
+    var connectedRaftEntries = Object.entries(connectedRafts).filter(function (_a) {
+        var connectedRaft = _a[1];
+        return Boolean(connectedRaft);
+    });
+    if (connectedRaftEntries.length === 0) {
+        return null;
+    }
+    var connectedRaftsContext = applicationManager === null || applicationManager === void 0 ? void 0 : applicationManager.connectedRaftsContext;
+    if (Array.isArray(connectedRaftsContext)) {
+        var selectedRaft = connectedRaftsContext.find(function (connectedRaft) {
+            return Boolean(connectedRaft.id &&
+                connectedRaft.isSelected &&
+                connectedRafts[connectedRaft.id]);
+        });
+        var selectedDetails = selectedRaft
+            ? getConnectionDetails(selectedRaft.type, selectedRaft.id ? connectedRafts[selectedRaft.id] : undefined)
+            : null;
+        if (selectedDetails) {
+            return selectedDetails;
+        }
+        for (var _i = 0, connectedRaftsContext_1 = connectedRaftsContext; _i < connectedRaftsContext_1.length; _i++) {
+            var connectedRaft = connectedRaftsContext_1[_i];
+            if (!connectedRaft.id || !connectedRafts[connectedRaft.id]) {
+                continue;
+            }
+            var details = getConnectionDetails(connectedRaft.type, connectedRafts[connectedRaft.id]);
+            if (details) {
+                return details;
+            }
+        }
+    }
+    for (var _a = 0, connectedRaftEntries_1 = connectedRaftEntries; _a < connectedRaftEntries_1.length; _a++) {
+        var _b = connectedRaftEntries_1[_a], connectedRaft = _b[1];
+        var details = getConnectionDetails(connectedRaft === null || connectedRaft === void 0 ? void 0 : connectedRaft.type, connectedRaft);
+        if (details) {
+            return details;
+        }
+    }
+    return null;
+}
+export function isRobotConnectionRequiredForFeedbackSource(source) {
+    return source === "emoji-modal" || source === "detailed-feedback";
+}

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

@@ -46,6 +46,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 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";
 var SHOW_LOGS = true;
@@ -171,13 +172,28 @@ export function buildFeedbackText(record) {
     var page = record.context && typeof record.context.page === "string"
         ? record.context.page
         : null;
+    var selectedRaftType = record.context && typeof record.context.selectedRaftType === "string"
+        ? record.context.selectedRaftType
+        : null;
+    var selectedRaftSerialNumber = record.context &&
+        typeof record.context.selectedRaftSerialNumber === "string"
+        ? record.context.selectedRaftSerialNumber
+        : null;
     if (page) {
         lines.push("Page: ".concat(page));
     }
+    if (selectedRaftType) {
+        lines.push("Robot type: ".concat(selectedRaftType));
+    }
+    if (selectedRaftSerialNumber) {
+        lines.push("Robot serial number: ".concat(selectedRaftSerialNumber));
+    }
     if (record.context) {
         var contextWithoutPage = Object.fromEntries(Object.entries(record.context).filter(function (_a) {
             var key = _a[0];
-            return key !== "page";
+            return key !== "page" &&
+                key !== "selectedRaftType" &&
+                key !== "selectedRaftSerialNumber";
         }));
         if (Object.keys(contextWithoutPage).length > 0) {
             lines.push("Context: ".concat(JSON.stringify(contextWithoutPage)));
@@ -212,12 +228,21 @@ export function createFeedbackRecord(input) {
     return record;
 }
 export function submitFeedback(input) {
+    var _a;
     return __awaiter(this, void 0, void 0, function () {
-        var record, firebaseResponse, errorText, slackDelivered, slackResponse, errorText, error_1;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
+        var requiresRobotConnection, robotConnection, record, firebaseResponse, errorText, slackDelivered, slackResponse, errorText, error_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
                 case 0:
-                    record = createFeedbackRecord(input);
+                    requiresRobotConnection = isRobotConnectionRequiredForFeedbackSource(input.source);
+                    robotConnection = requiresRobotConnection
+                        ? getActiveFeedbackRobotConnection()
+                        : null;
+                    if (requiresRobotConnection && !robotConnection) {
+                        throw new Error(FEEDBACK_REQUIRES_ROBOT_CONNECTION_MESSAGE);
+                    }
+                    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"), {
                             method: "PATCH",
                             headers: {
@@ -227,18 +252,18 @@ export function submitFeedback(input) {
                             body: JSON.stringify(record),
                         })];
                 case 1:
-                    firebaseResponse = _a.sent();
+                    firebaseResponse = _b.sent();
                     if (!!firebaseResponse.ok) return [3 /*break*/, 3];
                     return [4 /*yield*/, firebaseResponse.text()];
                 case 2:
-                    errorText = _a.sent();
+                    errorText = _b.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;
-                    _a.label = 4;
+                    _b.label = 4;
                 case 4:
-                    _a.trys.push([4, 8, , 9]);
+                    _b.trys.push([4, 8, , 9]);
                     return [4 /*yield*/, fetch(WEB_APP_FEEDBACK_SLACK_WEBHOOK_URL, {
                             method: "POST",
                             headers: {
@@ -247,15 +272,15 @@ export function submitFeedback(input) {
                             body: JSON.stringify({ text: record.text }),
                         })];
                 case 5:
-                    slackResponse = _a.sent();
+                    slackResponse = _b.sent();
                     if (!!slackResponse.ok) return [3 /*break*/, 7];
                     return [4 /*yield*/, slackResponse.text()];
                 case 6:
-                    errorText = _a.sent();
+                    errorText = _b.sent();
                     throw new Error("Failed Slack response: ".concat(slackResponse.status, " ").concat(errorText));
                 case 7: return [3 /*break*/, 9];
                 case 8:
-                    error_1 = _a.sent();
+                    error_1 = _b.sent();
                     slackDelivered = false;
                     Logger.error(SHOW_LOGS, TAG, "Failed to submit feedback to Slack", error_1);
                     return [3 /*break*/, 9];

package/package.json

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