@robotical/webapp-types 3.16.11 → 3.16.13

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

@@ -1,11 +1,26 @@
+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 FeedbackEnvironment = {
+    appRuntime: FeedbackAppRuntime;
+    isPhoneApp: boolean;
+    deviceInfo: Partial<UserDeviceInfo> | null;
+    userAgent: string | null;
+    language: string | null;
+    viewport: {
+        width: number;
+        height: number;
+        devicePixelRatio: number;
+    } | null;
+};
 export type SubmitFeedbackInput = {
     rating?: FeedbackRating;
     message?: string;
     email?: string;
     context?: Record<string, unknown> | null;
     source: FeedbackSource;
+    environment?: FeedbackEnvironment;
 };
 export type FeedbackRecord = {
     rating: FeedbackRating | null;
@@ -13,6 +28,7 @@ export type FeedbackRecord = {
     email: string | null;
     source: FeedbackSource;
     context: Record<string, unknown> | null;
+    environment: FeedbackEnvironment;
     timestamp: string;
     text: string;
 };
@@ -20,6 +36,7 @@ export type SubmitFeedbackResult = {
     record: FeedbackRecord;
     slackDelivered: boolean;
 };
+export declare function collectFeedbackEnvironment(): FeedbackEnvironment;
 export declare function buildFeedbackText(record: FeedbackRecord): string;
 export declare function createFeedbackRecord(input: SubmitFeedbackInput): FeedbackRecord;
 export declare function submitFeedback(input: SubmitFeedbackInput): Promise<SubmitFeedbackResult>;

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

@@ -1,3 +1,14 @@
+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);
+};
 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) {
@@ -36,6 +47,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 import Logger from "../../services/logger/Logger";
 import randomHashGenerator from "../helpers/randomHashGenerator";
+import isPhoneApp from "../phone-app-communication/is-phone-app";
 var SHOW_LOGS = true;
 var TAG = "submitFeedback";
 var WEB_APP_FEEDBACK_DB_URL = "https://web-app-bug-reports-default-rtdb.europe-west1.firebasedatabase.app/";
@@ -44,8 +56,118 @@ function normalizeOptionalString(value) {
     var trimmedValue = value === null || value === void 0 ? void 0 : value.trim();
     return trimmedValue ? trimmedValue : null;
 }
+function normalizeOptionalRecordString(value) {
+    var _a;
+    if (typeof value !== "string") {
+        return null;
+    }
+    return (_a = normalizeOptionalString(value)) !== null && _a !== void 0 ? _a : null;
+}
+function getNavigatorValue(reader) {
+    if (typeof navigator === "undefined") {
+        return null;
+    }
+    return reader(navigator);
+}
+function getWindowValue(reader) {
+    if (typeof window === "undefined") {
+        return null;
+    }
+    return reader(window);
+}
+export function collectFeedbackEnvironment() {
+    var _a, _b;
+    var runningInPhoneApp = (_a = getWindowValue(function () { return isPhoneApp(); })) !== null && _a !== void 0 ? _a : false;
+    var deviceInfo = (_b = getWindowValue(function (windowObject) { var _a; return (_a = windowObject.applicationManager) === null || _a === void 0 ? void 0 : _a.deviceInfo; })) !== null && _b !== void 0 ? _b : null;
+    var viewport = getWindowValue(function (windowObject) { return ({
+        width: windowObject.innerWidth,
+        height: windowObject.innerHeight,
+        devicePixelRatio: windowObject.devicePixelRatio || 1,
+    }); });
+    return {
+        appRuntime: runningInPhoneApp ? "phone-app" : "web-app",
+        isPhoneApp: runningInPhoneApp,
+        deviceInfo: deviceInfo ? __assign({}, deviceInfo) : null,
+        userAgent: getNavigatorValue(function (navigatorObject) { return navigatorObject.userAgent; }),
+        language: getNavigatorValue(function (navigatorObject) { return navigatorObject.language; }),
+        viewport: viewport,
+    };
+}
+function getRuntimeLabel(appRuntime) {
+    return appRuntime === "phone-app" ? "Phone app" : "Web app";
+}
+function getPhoneDeviceLines(deviceInfo) {
+    var manufacturer = normalizeOptionalRecordString(deviceInfo.manufacturer);
+    var model = normalizeOptionalRecordString(deviceInfo.model);
+    var deviceName = normalizeOptionalRecordString(deviceInfo.deviceName);
+    var systemName = normalizeOptionalRecordString(deviceInfo.systemName);
+    var systemVersion = normalizeOptionalRecordString(deviceInfo.systemVersion);
+    var appVersion = normalizeOptionalRecordString(deviceInfo.appVersion);
+    var buildNumber = normalizeOptionalRecordString(deviceInfo.buildNumber);
+    var deviceId = normalizeOptionalRecordString(deviceInfo.deviceId);
+    var lines = [];
+    var deviceLabel = [manufacturer, model].filter(Boolean).join(" ").trim();
+    if (deviceLabel) {
+        lines.push("Device: ".concat(deviceLabel));
+    }
+    if (deviceName && deviceName !== deviceLabel) {
+        lines.push("Device name: ".concat(deviceName));
+    }
+    var osLabel = [systemName, systemVersion].filter(Boolean).join(" ").trim();
+    if (osLabel) {
+        lines.push("OS: ".concat(osLabel));
+    }
+    var appVersionLabel = [appVersion, buildNumber ? "(".concat(buildNumber, ")") : null]
+        .filter(Boolean)
+        .join(" ");
+    if (appVersionLabel) {
+        lines.push("App version: ".concat(appVersionLabel));
+    }
+    if (deviceId) {
+        lines.push("Device ID: ".concat(deviceId));
+    }
+    return lines;
+}
+function getWebDeviceLines(deviceInfo, environment) {
+    var browserVersion = normalizeOptionalRecordString(deviceInfo === null || deviceInfo === void 0 ? void 0 : deviceInfo.version);
+    var systemName = normalizeOptionalRecordString(deviceInfo === null || deviceInfo === void 0 ? void 0 : deviceInfo.systemName);
+    var appVersion = normalizeOptionalRecordString(deviceInfo === null || deviceInfo === void 0 ? void 0 : deviceInfo.appVersion);
+    var deviceId = normalizeOptionalRecordString(deviceInfo === null || deviceInfo === void 0 ? void 0 : deviceInfo.deviceId);
+    var host = normalizeOptionalRecordString(deviceInfo === null || deviceInfo === void 0 ? void 0 : deviceInfo.bundleId);
+    var lines = [];
+    if (browserVersion) {
+        lines.push("Browser: ".concat([browserVersion, systemName ? "on ".concat(systemName) : null]
+            .filter(Boolean)
+            .join(" ")));
+    }
+    else if (environment.userAgent) {
+        lines.push("Browser: ".concat(environment.userAgent));
+    }
+    if (!browserVersion && systemName) {
+        lines.push("OS: ".concat(systemName));
+    }
+    if (host) {
+        lines.push("Host: ".concat(host));
+    }
+    if (appVersion) {
+        lines.push("App version: ".concat(appVersion));
+    }
+    if (deviceId) {
+        lines.push("Device ID: ".concat(deviceId));
+    }
+    return lines;
+}
+function getEnvironmentTextLines(environment) {
+    var _a;
+    var lines = ["App: ".concat(getRuntimeLabel(environment.appRuntime))];
+    var deviceLines = environment.appRuntime === "phone-app"
+        ? getPhoneDeviceLines((_a = environment.deviceInfo) !== null && _a !== void 0 ? _a : {})
+        : getWebDeviceLines(environment.deviceInfo, environment);
+    return lines.concat(deviceLines);
+}
 export function buildFeedbackText(record) {
     var lines = ["Source: ".concat(record.source)];
+    lines.push.apply(lines, getEnvironmentTextLines(record.environment));
     var page = record.context && typeof record.context.page === "string"
         ? record.context.page
         : null;
@@ -71,16 +193,18 @@ export function buildFeedbackText(record) {
     return lines.join("\n");
 }
 export function createFeedbackRecord(input) {
-    var _a;
+    var _a, _b;
     var normalizedMessage = normalizeOptionalString(input.message);
     var normalizedEmail = normalizeOptionalString(input.email);
     var timestamp = new Date().toISOString();
+    var environment = (_a = input.environment) !== null && _a !== void 0 ? _a : collectFeedbackEnvironment();
     var record = {
-        rating: (_a = input.rating) !== null && _a !== void 0 ? _a : null,
+        rating: (_b = input.rating) !== null && _b !== void 0 ? _b : null,
         message: normalizedMessage,
         email: normalizedEmail,
         source: input.source,
         context: input.context || null,
+        environment: environment,
         timestamp: timestamp,
         text: "",
     };

package/package.json

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