Merge 665f21a into 3a90ca6

__tests__/actions/getDeviceDetails.spec.ts

@@ -0,0 +1,33 @@
+import { getDeviceDetails } from '../../src/actions';
+
+describe('getDeviceDetails function', () => {
+
+  it('is a function', () => {
+    expect(typeof getDeviceDetails).toBe('function');
+  });
+
+  it('builds a getDeviceDetails action', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.getdevicedetails',
+      WFWorkflowActionParameters: {
+        WFDeviceDetail: 'Device Name',
+      },
+    };
+    const actual = getDeviceDetails({});
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('builds a getDeviceDetails action when a detail is passed', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.getdevicedetails',
+      WFWorkflowActionParameters: {
+        WFDeviceDetail: 'System Version',
+      },
+    };
+    const actual = getDeviceDetails({ detail: 'System Version' });
+
+    expect(actual).toEqual(expected);
+  });
+
+});

src/actions/getDeviceDetails.ts

@@ -0,0 +1,34 @@
+import { withActionOutput } from '../utils';
+
+import WFDeviceDetail from '../interfaces/WF/WFDeviceDetail';
+import WFSerialization from '../interfaces/WF/WFSerialization';
+import WFWorkflowAction from '../interfaces/WF/WFWorkflowAction';
+
+/**
+ * Get Device Details Action. Returns a particular property of the device.
+ *
+ * ```js
+ * getDeviceDetails({
+ *   detail: 'Device Name',
+ * });
+ * ```
+ */
+const getDeviceDetails = (
+  options: {
+    /** The particular detail to retrieve */
+    detail?: WFSerialization | WFDeviceDetail,
+  },
+): WFWorkflowAction => {
+  const {
+    detail = 'Device Name',
+  } = options;
+
+  return {
+    WFWorkflowActionIdentifier: 'is.workflow.actions.getdevicedetails',
+    WFWorkflowActionParameters: {
+      WFDeviceDetail: detail,
+    },
+  };
+};
+
+export default withActionOutput(getDeviceDetails);

src/actions/getNetworkDetails.ts

@@ -0,0 +1,53 @@
+import { withActionOutput } from '../utils';
+
+import WFCellularDetail from '../interfaces/WF/WFCellularDetail';
+import WFNetworkDetailsNetwork from '../interfaces/WF/WFNetworkDetailsNetwork';
+import WFSerialization from '../interfaces/WF/WFSerialization';
+import WFWiFiDetail from '../interfaces/WF/WFWiFiDetail';
+import WFWorkflowAction from '../interfaces/WF/WFWorkflowAction';
+
+/**
+ * Get Network Details Action. Gets various network-related information from
+ * the device.
+ *
+ * ```js
+ * getNetworkDetails({
+ *   network: 'Wi-Fi',
+ *   get: 'Network Name',
+ * });
+ *
+ * getNetworkDetails({
+ *   network: 'Cellular',
+ *   get: 'Carrier Name',
+ * });
+ * ```
+ */
+const getNetworkDetails = (
+  options: {
+    /** The type of network to look at */
+    network?: WFNetworkDetailsNetwork,
+
+    /** The particular network detail to retrieve */
+    attribute?: WFSerialization | WFWiFiDetail | WFCellularDetail,
+  },
+): WFWorkflowAction => {
+  const {
+    network = 'Wi-Fi',
+    attribute = 'Network Name',
+  } = options;
+
+  let detailKey = 'WFWiFiDetail';
+  if (network === 'Cellular') {
+    detailKey = 'WFCellularDetail';
+  }
+
+  return {
+    WFWorkflowActionIdentifier: 'is.workflow.actions.getwifi',
+    WFWorkflowActionParameters: {
+      WFNetworkDetailsNetwork: network,
+      [detailKey]: attribute,
+    },
+  };
+};
+
+export default withActionOutput(getNetworkDetails);

src/actions/index.ts

@@ -10,8 +10,10 @@ import exitShortcut from './exitShortcut';
 import getBatteryLevel from './getBatteryLevel';
 import getContentsOfUrl from './getContentsOfUrl';
 import getCurrentIpAddress from './getCurrentIpAddress';
+import getDeviceDetails from './getDeviceDetails';
 import getDictionaryValue from './getDictionaryValue';
 import getName from './getName';
+import getNetworkDetails from './getNetworkDetails';
 import getType from './getType';
 import getVariable from './getVariable';
 import nothing from './nothing';
@@ -48,8 +50,10 @@ export {
   getBatteryLevel,
   getContentsOfUrl,
   getCurrentIpAddress,
+  getDeviceDetails,
   getDictionaryValue,
   getName,
+  getNetworkDetails,
   getType,
   getVariable,
   nothing,

src/interfaces/WF/WFCellularDetail.ts

@@ -0,0 +1,8 @@
+type WFCellularDetail = (
+  'Carrier Name'
+  | 'Radio Technology'
+  | 'Country Code'
+  | 'WFTextTokenAttachment'
+);
+
+export default WFCellularDetail;

src/interfaces/WF/WFDeviceDetail.ts

@@ -0,0 +1,11 @@
+type WFDeviceDetail = (
+  'Device Name'
+  | 'Device Model'
+  | 'System Version'
+  | 'Screen Width'
+  | 'Screen Height'
+  | 'Current Volume'
+  | 'Current Brightness'
+);
+
+export default WFDeviceDetail;

src/interfaces/WF/WFNetworkDetailsNetwork.ts

@@ -0,0 +1,6 @@
+type WFNetworkDetailsNetwork = (
+  'Wi-Fi'
+  | 'Cellular'
+);
+
+export default WFNetworkDetailsNetwork;

src/interfaces/WF/WFWiFiDetail.ts

@@ -0,0 +1,6 @@
+type WFWiFiDetail = (
+  'Network Name'
+  | 'BSSID'
+);
+
+export default WFWiFiDetail;

src/interfaces/WF/WFWorkflowActionIdentifier.ts

@@ -14,11 +14,13 @@ type WFWorkflowActionIdentifier = (
   | 'is.workflow.actions.flashlight'
   | 'is.workflow.actions.getbatterylevel'
   | 'is.workflow.actions.getipaddress'
+  | 'is.workflow.actions.getdevicedetails'
   | 'is.workflow.actions.getitemname'
   | 'is.workflow.actions.getitemtype'
   | 'is.workflow.actions.gettext'
   | 'is.workflow.actions.getvalueforkey'
   | 'is.workflow.actions.getvariable'
+  | 'is.workflow.actions.getwifi'
   | 'is.workflow.actions.handoff'
   | 'is.workflow.actions.lowpowermode.set'
   | 'is.workflow.actions.math'

src/interfaces/WF/WFWorkflowActionParameters.ts

@@ -1,6 +1,7 @@
 import WFAskActionDateGranularity from './WFAskActionDateGranularity';
 import WFCondition from './WFCondition';
 import WFCountType from './WFCountType';
+import WFDeviceDetail from './WFDeviceDetail';
 import WFFlashlightSetting from './WFFlashlightSetting';
 import WFGetDictionaryValueType from './WFGetDictionaryValueType';
 import WFHTTPBodyType from './WFHTTPBodyType';
@@ -9,6 +10,7 @@ import WFInputType from './WFInputType';
 import WFIPAddressSourceOption from './WFIPAddressSourceOption';
 import WFIPAddressTypeOption from './WFIPAddressTypeOption';
 import WFMathOperation from './WFMathOperation';
+import WFNetworkDetailsNetwork from './WFNetworkDetailsNetwork';
 import WFSerialization from './WFSerialization';
 
 interface WFWorkflowActionParameters {
@@ -29,6 +31,7 @@ interface WFWorkflowActionParameters {
   WFControlFlowMode?: number;
   WFCountType?: WFCountType;
   WFDelayTime?: number;
+  WFDeviceDetail?: WFSerialization | WFDeviceDetail;
   WFDictionaryKey?: string;
   WFDontIncludeFileExtension?: boolean;
   WFFlashlightSetting?: WFFlashlightSetting;
@@ -37,24 +40,25 @@ interface WFWorkflowActionParameters {
   WFHTTPBodyType?: WFHTTPBodyType;
   WFHTTPHeaders?: WFSerialization;
   WFHTTPMethod?: WFHTTPMethod;
-  WFInputType?: WFInputType;
   WFIPAddressSourceOption?: WFIPAddressSourceOption;
   WFIPAddressTypeOption?: WFIPAddressTypeOption;
+  WFInputType?: WFInputType;
   WFJSONValues?: WFSerialization;
   WFMathOperand?: number;
   WFMathOperation?: WFMathOperation;
-  WFMenuItems?: string[];
   WFMenuItemTitle?: string;
+  WFMenuItems?: string[];
   WFMenuPrompt?: string;
   WFName?: string;
+  WFNetworkDetailsNetwork?: WFNetworkDetailsNetwork;
   WFNumberActionNumber?: number;
   WFNumberValue?: number;
-  WFShowWorkflow?: boolean;
   WFSSHHost?: WFSerialization | string;
   WFSSHPassword?: WFSerialization | string;
   WFSSHPort?: WFSerialization | string;
   WFSSHScript?: WFSerialization | string;
   WFSSHUser?: WFSerialization | string;
+  WFShowWorkflow?: boolean;
   WFTextActionText?: WFSerialization | string;
   WFURLActionURL?: string;
   WFVariable?: WFSerialization | string;