feat(device): Add operatingSystem field (#2086)

Author: Southgarden116

android/capacitor/src/main/java/com/getcapacitor/plugin/Device.java

@@ -28,6 +28,7 @@ public void getInfo(PluginCall call) {
     r.put("diskFree", getDiskFree());
     r.put("diskTotal", getDiskTotal());
     r.put("model", android.os.Build.MODEL);
+    r.put("operatingSystem", "android");
     r.put("osVersion", android.os.Build.VERSION.RELEASE);
     r.put("appVersion", getAppVersion());
     r.put("appBuild", getAppBuild());

core/src/core-plugin-definitions.ts

@@ -401,6 +401,8 @@ export interface DevicePlugin extends Plugin {
   getLanguageCode(): Promise<DeviceLanguageCodeResult>;
 }
 
+export type OperatingSystem = 'ios' | 'android' | 'windows' | 'mac' | 'unknown';
+
 export interface DeviceInfo {
   /**
    * The device model. For example, "iPhone"
@@ -423,6 +425,10 @@ export interface DeviceInfo {
    * The current bundle build of the app
    */
   appBuild: string;
+  /**
+   * The operating system of the device
+   */
+  operatingSystem: OperatingSystem;
   /**
    * The version of the device OS
    */

core/src/web/device.ts

@@ -34,6 +34,7 @@ export class DevicePluginWeb extends WebPlugin implements DevicePlugin {
       platform: <'web'> 'web',
       appVersion: '',
       appBuild: '',
+      operatingSystem: uaFields.operatingSystem,
       osVersion: uaFields.osVersion,
       manufacturer: navigator.vendor,
       isVirtual: false,
@@ -74,6 +75,18 @@ export class DevicePluginWeb extends WebPlugin implements DevicePlugin {
       }
     }
 
+    if (/android/i.test(_ua)) {
+      uaFields.operatingSystem = 'android';
+    } else if (/iPad|iPhone|iPod/.test(_ua) && !window.MSStream) {
+      uaFields.operatingSystem = 'ios';
+    } else if (/Win/.test(_ua)) {
+      uaFields.operatingSystem = 'windows';
+    } else if (/Mac/i.test(_ua)) {
+      uaFields.operatingSystem = 'mac';
+    } else {
+      uaFields.operatingSystem = 'unknown';
+    }
+
     return uaFields;
   }
 

electron/src/electron/device.ts

@@ -1,4 +1,4 @@
-import { DeviceInfo, DeviceLanguageCodeResult, DevicePlugin, DevicePluginWeb,  WebPlugin } from "@capacitor/core";
+import { DeviceInfo, DeviceLanguageCodeResult, DevicePlugin, DevicePluginWeb, WebPlugin } from "@capacitor/core";
 
 declare var navigator: any;
 const webDevice = new DevicePluginWeb();
@@ -19,6 +19,7 @@ export class DevicePluginElectron extends WebPlugin implements DevicePlugin {
       platform: <'electron'> 'electron',
       appVersion: '',
       appBuild: '',
+      operatingSystem: info.operatingSystem,
       osVersion: info.osVersion,
       manufacturer: navigator.vendor,
       isVirtual: false,

ios/Capacitor/Capacitor/Plugins/Device.swift

@@ -23,6 +23,7 @@ public class CAPDevicePlugin: CAPPlugin {
       "diskFree": diskFree,
       "diskTotal": diskTotal,
       "model": UIDevice.current.model,
+      "operatingSystem": "ios",
       "osVersion": UIDevice.current.systemVersion,
       "appVersion": Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? "",
       "appBuild": Bundle.main.infoDictionary?["CFBundleVersion"] as? String ?? "",

site/docs-md/apis/device/index.md

@@ -31,6 +31,7 @@ console.log(info);
   "diskFree": 12228108288,
   "appVersion": "1.0.2",
   "appBuild": "123",
+  "operatingSystem": "ios",
   "osVersion": "11.2",
   "platform": "ios",
   "memUsed": 93851648,

site/src/assets/docs-content/apis/device/api.html

@@ -142,6 +142,14 @@ <h4 class="avc-code-interface-name">DeviceInfo</h4>
             </div>
           </div>
 
+          <div class="avc-code-interface-param">
+            <div class="avc-code-param-comment">// The operating system of the device</div>
+            <div class="avc-code-line"><span class="avc-code-param-name">operatingSystem</span>
+              :
+              <avc-code-type>'ios' | 'android' | 'windows' | 'mac' | 'unknown'</avc-code-type>;
+            </div>
+          </div>
+
           <div class="avc-code-interface-param">
             <div class="avc-code-param-comment">// The version of the device OS</div>
             <div class="avc-code-line"><span class="avc-code-param-name">osVersion</span>
@@ -154,7 +162,7 @@ <h4 class="avc-code-interface-name">DeviceInfo</h4>
             <div class="avc-code-param-comment">// The device platform (lowercase).</div>
             <div class="avc-code-line"><span class="avc-code-param-name">platform</span>
               :
-              <avc-code-type>any</avc-code-type>;
+              <avc-code-type>'ios' | 'android' | 'electron' | 'web'</avc-code-type>;
             </div>
           </div>