@robotical/webapp-types 3.16.13 → 3.16.15

package/dist-types/src/application/RAFTs/RAFT.js

@@ -41,6 +41,7 @@ import { RaftConnEvent, RaftPublishEvent, } from "@robotical/raftjs";
 import Logger from "../../services/logger/Logger";
 import randomHashGenerator from "../../utils/helpers/randomHashGenerator";
 import { addRobotNameToSerialNumber, isSerialNumberRegistered } from "../../utils/warranty-service/warranty-service-utils";
+import { buildAnalyticsDeviceInfo } from "../../utils/analytics-device-info";
 var SHOW_LOGS = true;
 var TAG = "RAFT";
 var RAFT = /** @class */ (function () {
@@ -340,10 +341,11 @@ var RAFT = /** @class */ (function () {
                         return [3 /*break*/, 6];
                     case 1:
                         new Promise(function (resolve) { return __awaiter(_this, void 0, void 0, function () {
-                            var robotId, raftType, raftName, raftSerialNumber, deviceInfo, sessionId, deviceId;
+                            var robotId, raftType, raftName, raftSerialNumber, deviceInfo, _a, sessionId, deviceId, analyticsDeviceInfo, analyticsFacade;
                             var _this = this;
-                            return __generator(this, function (_a) {
-                                switch (_a.label) {
+                            var _b;
+                            return __generator(this, function (_c) {
+                                switch (_c.label) {
                                     case 0:
                                         robotId = this.id;
                                         raftType = this.type;
@@ -357,15 +359,24 @@ var RAFT = /** @class */ (function () {
                                         });
                                         window.applicationManager.AnalyticsFacade.setRaftType(raftType);
                                         window.applicationManager.AnalyticsFacade.setRobotId(robotId);
-                                        if (!!window.applicationManager.analyticsSessionId) return [3 /*break*/, 2];
-                                        return [4 /*yield*/, window.wrapperCommunicator.sendMessageAndWait(AppSentMessage.GET_DEVICE_INFO, {})];
-                                    case 1:
-                                        deviceInfo = _a.sent();
+                                        if (!!window.applicationManager.analyticsSessionId) return [3 /*break*/, 4];
+                                        if (!((_b = window.applicationManager.deviceInfo) !== null && _b !== void 0)) return [3 /*break*/, 1];
+                                        _a = _b;
+                                        return [3 /*break*/, 3];
+                                    case 1: return [4 /*yield*/, window.wrapperCommunicator.sendMessageAndWait(AppSentMessage.GET_DEVICE_INFO, {})];
+                                    case 2:
+                                        _a = _c.sent();
+                                        _c.label = 3;
+                                    case 3:
+                                        deviceInfo = _a;
+                                        window.applicationManager.deviceInfo = deviceInfo;
                                         sessionId = randomHashGenerator();
                                         deviceId = deviceInfo.deviceId;
-                                        window.applicationManager.AnalyticsFacade.startSession(sessionId, deviceId, robotId, raftType);
-                                        _a.label = 2;
-                                    case 2:
+                                        analyticsDeviceInfo = buildAnalyticsDeviceInfo(deviceInfo);
+                                        analyticsFacade = window.applicationManager.AnalyticsFacade;
+                                        analyticsFacade.startSession(sessionId, deviceId, robotId, raftType, analyticsDeviceInfo);
+                                        _c.label = 4;
+                                    case 4:
                                         resolve(void 0);
                                         return [2 /*return*/];
                                 }

package/dist-types/src/utils/analytics-device-info.d.ts

@@ -0,0 +1,15 @@
+import { UserDeviceInfo } from "../types/userDeviceInfo";
+export type AnalyticsAppRuntimeValue = "web-app" | "phone-app" | "unknown";
+export type AnalyticsDeviceFormFactorValue = "desktop" | "tablet" | "phone" | "unknown";
+export type AnalyticsDevicePlatformValue = "web-desktop" | "web-tablet" | "web-phone" | "ipad" | "ios-phone" | "android-tablet" | "android-phone" | "unknown";
+export type AnalyticsDeviceInfoPayload = {
+    runtime: AnalyticsAppRuntimeValue;
+    platform: AnalyticsDevicePlatformValue;
+    formFactor: AnalyticsDeviceFormFactorValue;
+    osName: string;
+    osVersionMajor?: string;
+    browserName?: string;
+    browserVersionMajor?: string;
+    appVersion?: string;
+};
+export declare function buildAnalyticsDeviceInfo(deviceInfo: Partial<UserDeviceInfo> | undefined, runningInPhoneApp?: boolean): AnalyticsDeviceInfoPayload;

package/dist-types/src/utils/analytics-device-info.js

@@ -0,0 +1,110 @@
+import isPhoneApp from "./phone-app-communication/is-phone-app";
+var UNKNOWN_OS_NAME = "Unknown";
+export function buildAnalyticsDeviceInfo(deviceInfo, runningInPhoneApp) {
+    if (runningInPhoneApp === void 0) { runningInPhoneApp = isPhoneApp(); }
+    var runtime = runningInPhoneApp ? "phone-app" : "web-app";
+    var osName = normalizeOSName(deviceInfo === null || deviceInfo === void 0 ? void 0 : deviceInfo.systemName);
+    var isTablet = (deviceInfo === null || deviceInfo === void 0 ? void 0 : deviceInfo.isTablet) === true;
+    var platform = getDevicePlatform(runtime, osName, isTablet);
+    var formFactor = getFormFactor(platform, isTablet);
+    var parsedBrowser = runtime === "web-app" ? parseBrowser(deviceInfo === null || deviceInfo === void 0 ? void 0 : deviceInfo.version) : {};
+    return removeUndefinedFields({
+        runtime: runtime,
+        platform: platform,
+        formFactor: formFactor,
+        osName: osName,
+        osVersionMajor: parseMajorVersion(deviceInfo === null || deviceInfo === void 0 ? void 0 : deviceInfo.systemVersion),
+        browserName: parsedBrowser.browserName,
+        browserVersionMajor: parsedBrowser.browserVersionMajor,
+        appVersion: normalizeOptionalString(deviceInfo === null || deviceInfo === void 0 ? void 0 : deviceInfo.appVersion),
+    });
+}
+function getDevicePlatform(runtime, osName, isTablet) {
+    var isIOS = osName === "iOS" || osName === "iPadOS";
+    var isAndroid = osName === "Android";
+    if (runtime === "phone-app") {
+        if (isIOS && isTablet)
+            return "ipad";
+        if (isIOS)
+            return "ios-phone";
+        if (isAndroid && isTablet)
+            return "android-tablet";
+        if (isAndroid)
+            return "android-phone";
+        return "unknown";
+    }
+    if (runtime === "web-app") {
+        if (isTablet)
+            return "web-tablet";
+        if (isIOS || isAndroid)
+            return "web-phone";
+        if (osName === "Windows" || osName === "MacOS" || osName === "Linux")
+            return "web-desktop";
+        return "unknown";
+    }
+    return "unknown";
+}
+function getFormFactor(platform, isTablet) {
+    if (platform === "web-desktop")
+        return "desktop";
+    if (platform === "web-tablet" || platform === "ipad" || platform === "android-tablet")
+        return "tablet";
+    if (platform === "web-phone" || platform === "ios-phone" || platform === "android-phone")
+        return "phone";
+    if (isTablet)
+        return "tablet";
+    return "unknown";
+}
+function normalizeOSName(value) {
+    var normalized = normalizeOptionalString(value);
+    if (!normalized)
+        return UNKNOWN_OS_NAME;
+    var lower = normalized.toLowerCase();
+    if (lower.includes("ipad"))
+        return "iPadOS";
+    if (lower.includes("ios") || lower.includes("iphone"))
+        return "iOS";
+    if (lower.includes("android"))
+        return "Android";
+    if (lower.includes("windows"))
+        return "Windows";
+    if (lower.includes("mac"))
+        return "MacOS";
+    if (lower.includes("linux"))
+        return "Linux";
+    return normalized;
+}
+function parseMajorVersion(value) {
+    var normalized = normalizeOptionalString(value);
+    var match = normalized === null || normalized === void 0 ? void 0 : normalized.match(/\d+/);
+    return match === null || match === void 0 ? void 0 : match[0];
+}
+function parseBrowser(value) {
+    var normalized = normalizeOptionalString(value);
+    if (!normalized || normalized.toLowerCase() === "unknown browser") {
+        return {};
+    }
+    var match = normalized.match(/^([a-z]+)[\s/]+(\d+)/i);
+    if (!match) {
+        return {};
+    }
+    return {
+        browserName: match[1].toLowerCase(),
+        browserVersionMajor: match[2],
+    };
+}
+function normalizeOptionalString(value) {
+    if (typeof value !== "string")
+        return undefined;
+    var trimmed = value.trim();
+    return trimmed.length > 0 ? trimmed : undefined;
+}
+function removeUndefinedFields(value) {
+    return Object.entries(value).reduce(function (acc, _a) {
+        var key = _a[0], entryValue = _a[1];
+        if (entryValue !== undefined) {
+            acc[key] = entryValue;
+        }
+        return acc;
+    }, {});
+}

package/dist-types/src/wrapper-app/utils/device-info.d.ts

@@ -1,4 +1,4 @@
 export declare const getOrGenerateDeviceId: () => string;
-export declare const getOSName: () => "Windows" | "MacOS" | "Linux" | "Android" | "iOS" | "Unknown OS";
+export declare const getOSName: () => "Windows" | "Android" | "iOS" | "MacOS" | "Linux" | "Unknown OS";
 export declare const getBrowserVersion: () => string;
 export declare const isTablet: () => boolean;

package/dist-types/src/wrapper-app/utils/device-info.js

@@ -13,16 +13,17 @@ export var getOrGenerateDeviceId = function () {
 };
 export var getOSName = function () {
     var userAgent = navigator.userAgent;
+    var isIPadOSBrowser = navigator.platform === "MacIntel" && navigator.maxTouchPoints > 1;
     if (userAgent.includes("Windows"))
         return "Windows";
+    if (userAgent.includes("Android"))
+        return "Android";
+    if (/iPad|iPhone|iPod/i.test(userAgent) || userAgent.includes("like Mac") || isIPadOSBrowser)
+        return "iOS";
     if (userAgent.includes("Mac"))
         return "MacOS";
     if (userAgent.includes("Linux"))
         return "Linux";
-    if (userAgent.includes("Android"))
-        return "Android";
-    if (userAgent.includes("like Mac"))
-        return "iOS";
     return "Unknown OS";
 };
 export var getBrowserVersion = function () {
@@ -31,5 +32,6 @@ export var getBrowserVersion = function () {
     return match[1] ? "".concat(match[1], " ").concat(match[2]) : "Unknown Browser";
 };
 export var isTablet = function () {
-    return /iPad|Tablet|Android(?!.*Mobile)/i.test(navigator.userAgent);
+    var isIPadOSBrowser = navigator.platform === "MacIntel" && navigator.maxTouchPoints > 1;
+    return isIPadOSBrowser || /iPad|Tablet|Android(?!.*Mobile)/i.test(navigator.userAgent);
 };

package/package.json

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