[TS migration] Migrate 'Device' lib to TypeScript

src/libs/actions/Device/generateDeviceID/index.android.js → src/libs/actions/Device/generateDeviceID/index.android.ts

@@ -23,9 +23,9 @@ const uniqueID = Str.guid(deviceID);
  * Furthermore, the deviceID prefix is not unique to a specific device, but is likely to change from one type of device to another.
  * Including this prefix will tell us with a reasonable degree of confidence if the user just uninstalled and reinstalled the app, or if they got a new device.
  *
- * @returns {Promise<String>}
+ * @returns - deviceID
  */
-function generateDeviceID() {
+function generateDeviceID(): Promise<string> {
     return Promise.resolve(uniqueID);
 }
 

src/libs/actions/Device/generateDeviceID/index.desktop.js → src/libs/actions/Device/generateDeviceID/index.desktop.ts

@@ -3,9 +3,10 @@ import ELECTRON_EVENTS from '../../../../../desktop/ELECTRON_EVENTS';
 /**
  * Get the unique ID of the current device. This should remain the same even if the user uninstalls and reinstalls the app.
  *
- * @returns {Promise<String>}
+ * @returns - device ID
  */
-function generateDeviceID() {
+
+function generateDeviceID(): Promise<string> {
     return window.electron.invoke(ELECTRON_EVENTS.REQUEST_DEVICE_ID);
 }
 

src/libs/actions/Device/generateDeviceID/index.ios.js → src/libs/actions/Device/generateDeviceID/index.ios.ts

@@ -5,10 +5,10 @@ const deviceID = DeviceInfo.getDeviceId();
 /**
  * Get the unique ID of the current device. This should remain the same even if the user uninstalls and reinstalls the app.
  *
- * @returns {Promise<String>}
+ * @returns - device ID
  */
-function generateDeviceID() {
-    return DeviceInfo.getUniqueId().then((uniqueID) => `${deviceID}_${uniqueID}`);
+function generateDeviceID(): Promise<string> {
+    return DeviceInfo.getUniqueId().then((uniqueID: string) => `${deviceID}_${uniqueID}`);
 }
 
 export default generateDeviceID;

src/libs/actions/Device/generateDeviceID/index.website.js → src/libs/actions/Device/generateDeviceID/index.website.ts

@@ -14,9 +14,9 @@ const uniqueID = Str.guid();
  * While this isn't perfect, it's just as good as any other obvious web solution, such as this one https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo/deviceId
  * which is also different/reset under the same circumstances
  *
- * @returns {Promise<String>}
+ * @returns - device ID
  */
-function generateDeviceID() {
+function generateDeviceID(): Promise<string> {
     return Promise.resolve(uniqueID);
 }
 

src/libs/actions/Device/getDeviceInfo/getBaseInfo.ts

@@ -0,0 +1,16 @@
+import packageConfig from '../../../../../package.json';
+import {OSAndName} from "./getOSAndName/index.native";
+
+export type BaseInfo = {
+    app_version: string;
+    timestamp: string;
+};
+
+export type DeviceInfo = BaseInfo & OSAndName & {os?: string, device_name?: string, device_version?: string};
+
+export default function getBaseInfo(): BaseInfo {
+    return {
+        app_version: packageConfig.version,
+        timestamp: new Date().toISOString().slice(0, 19),
+    };
+}

src/libs/actions/Device/getDeviceInfo/getOSAndName/index.native.js → src/libs/actions/Device/getDeviceInfo/getOSAndName/index.native.ts

@@ -1,7 +1,11 @@
 import Str from 'expensify-common/lib/str';
 import RNDeviceInfo from 'react-native-device-info';
 
-export default function getOSAndName() {
+export type OSAndName = {
+    device_name: string;
+    os_version: string;
+}
+export default function getOSAndName(): OSAndName {
     const deviceName = RNDeviceInfo.getDeviceNameSync();
     const prettyName = `${Str.UCFirst(RNDeviceInfo.getManufacturerSync() || '')} ${deviceName}`;
     return {

src/libs/actions/Device/getDeviceInfo/index.android.ts

@@ -0,0 +1,10 @@
+import getBaseInfo, {DeviceInfo} from './getBaseInfo';
+import getOSAndName from './getOSAndName/index.native';
+
+export default function getDeviceInfo(): DeviceInfo {
+    return {
+        ...getBaseInfo(),
+        ...getOSAndName(),
+        os: 'Android',
+    };
+}

src/libs/actions/Device/getDeviceInfo/index.desktop.ts

@@ -0,0 +1,9 @@
+import getBaseInfo, {DeviceInfo} from './getBaseInfo';
+import getOSAndName from './getOSAndName/index.native';
+export default function getDeviceInfo(): DeviceInfo {
+    return {
+        ...getBaseInfo(),
+        ...getOSAndName(),
+        device_name: 'Desktop',
+    };
+}

src/libs/actions/Device/getDeviceInfo/index.ios.ts

@@ -0,0 +1,10 @@
+import getBaseInfo, {DeviceInfo} from './getBaseInfo';
+import getOSAndName from './getOSAndName/index.native';
+
+export default function getDeviceInfo(): DeviceInfo {
+    return {
+        ...getBaseInfo(),
+        ...getOSAndName(),
+        os: 'iOS',
+    };
+}

src/libs/actions/Device/getDeviceInfo/index.ts

@@ -0,0 +1,18 @@
+import getBaseInfo, {DeviceInfo} from './getBaseInfo';
+import getOSAndName from './getOSAndName/index.native';
+
+/**
+ * @typedef DeviceInfo
+ * @type {object}
+
+ */
+
+/**
+ * @returns {DeviceInfo}
+ */
+export default function getDeviceInfo(): DeviceInfo {
+    return {
+        ...getBaseInfo(),
+        ...getOSAndName(),
+    };
+}

src/libs/actions/Device/index.js → src/libs/actions/Device/index.ts

@@ -1,23 +1,23 @@
-import Onyx from 'react-native-onyx';
+import Onyx, {OnyxEntry} from 'react-native-onyx';
 import ONYXKEYS from '../../../ONYXKEYS';
 import Log from '../../Log';
-import generateDeviceID from './generateDeviceID';
-import getDeviceInfo from './getDeviceInfo';
+import generateDeviceID from './generateDeviceID/index.ios';
+import getDeviceInfo from './getDeviceInfo/index.ios';
 
-let deviceID;
+let deviceID: string | null = null;
 
 /**
- * @returns {Promise<String>}
+ * @returns - device ID string or null in case of failure
  */
-function getDeviceID() {
+function getDeviceID(): Promise<string | null> {
     return new Promise((resolve) => {
         if (deviceID) {
             return resolve(deviceID);
         }
 
         const connectionID = Onyx.connect({
             key: ONYXKEYS.DEVICE_ID,
-            callback: (ID) => {
+            callback: (ID: OnyxEntry<string>) => {
                 Onyx.disconnect(connectionID);
                 deviceID = ID;
                 return resolve(ID);
@@ -29,7 +29,7 @@ function getDeviceID() {
 /**
  * Saves a unique deviceID into Onyx.
  */
-function setDeviceID() {
+function setDeviceID(): void {
     getDeviceID()
         .then((existingDeviceID) => {
             if (!existingDeviceID) {
@@ -38,7 +38,7 @@ function setDeviceID() {
             throw new Error(existingDeviceID);
         })
         .then(generateDeviceID)
-        .then((uniqueID) => {
+        .then((uniqueID: string) => {
             Log.info('Got new deviceID', false, uniqueID);
             Onyx.set(ONYXKEYS.DEVICE_ID, uniqueID);
         })
@@ -47,9 +47,9 @@ function setDeviceID() {
 
 /**
  * Returns a string object with device info and uniqueID
- * @returns {Promise<string>}
+ * @returns - device info with ID
  */
-function getDeviceInfoWithID() {
+function getDeviceInfoWithID(): Promise<string> {
     return new Promise((resolve) => {
         getDeviceID().then((currentDeviceID) =>
             resolve(

src/types/global.d.ts

@@ -16,4 +16,12 @@ declare module '*.svg' {
     export default content;
 }
 
+declare global {
+    interface Window {
+        electron: Electron.IpcRenderer
+    }
+}
+
 declare module 'react-native-device-info/jest/react-native-device-info-mock';
+
+export {}