@robotical/webapp-types 3.19.2 → 3.20.0

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/package.json

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