Merge 5476ed0 into 4af9986

__tests__/actions/generateHash.spec.ts

@@ -0,0 +1,77 @@
+import { generateHash } from '../../src/actions';
+
+describe('generateHash function', () => {
+
+  it('is a function', () => {
+    expect(typeof generateHash).toBe('function');
+  });
+
+  it('builds a generateHash action', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.hash',
+      WFWorkflowActionParameters: {
+        WFHashType: 'MD5',
+      },
+    };
+    const actual = generateHash({});
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('builds a generateHash action (MD5)', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.hash',
+      WFWorkflowActionParameters: {
+        WFHashType: 'MD5',
+      },
+    };
+    const actual = generateHash({
+      type: 'MD5',
+    });
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('builds a generateHash action (SHA1)', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.hash',
+      WFWorkflowActionParameters: {
+        WFHashType: 'SHA1',
+      },
+    };
+    const actual = generateHash({
+      type: 'SHA1',
+    });
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('builds a generateHash action (SHA256)', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.hash',
+      WFWorkflowActionParameters: {
+        WFHashType: 'SHA256',
+      },
+    };
+    const actual = generateHash({
+      type: 'SHA256',
+    });
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('builds a generateHash action (SHA512)', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.hash',
+      WFWorkflowActionParameters: {
+        WFHashType: 'SHA512',
+      },
+    };
+    const actual = generateHash({
+      type: 'SHA512',
+    });
+
+    expect(actual).toEqual(expected);
+  });
+
+});

src/actions/generateHash.ts

@@ -0,0 +1,34 @@
+import { withActionOutput } from '../utils';
+
+import WFHashType from '../interfaces/WF/WFHashType';
+import WFSerialization from '../interfaces/WF/WFSerialization';
+import WFWorkflowAction from '../interfaces/WF/WFWorkflowAction';
+
+/**
+ * Generate Hash Action. Generates a MD5/SHA1 hash from the input.
+ *
+ * ```js
+ * generateHash({
+ *   type: 'MD5'
+ * });
+ * ```
+ */
+const generateHash = (
+  options: {
+    /** The type of hash to use */
+    type?: WFSerialization | WFHashType,
+  },
+): WFWorkflowAction => {
+  const {
+    type = 'MD5',
+  } = options;
+
+  return {
+    WFWorkflowActionIdentifier: 'is.workflow.actions.hash',
+    WFWorkflowActionParameters: {
+      WFHashType: type,
+    },
+  };
+};
+
+export default withActionOutput(generateHash);

src/actions/index.ts

@@ -7,6 +7,7 @@ import conditional from './conditional';
 import continueShortcutInApp from './continueShortcutInApp';
 import count from './count';
 import exitShortcut from './exitShortcut';
+import generateHash from './generateHash';
 import getBatteryLevel from './getBatteryLevel';
 import getContentsOfUrl from './getContentsOfUrl';
 import getCurrentIpAddress from './getCurrentIpAddress';
@@ -48,6 +49,7 @@ export {
   continueShortcutInApp,
   count,
   exitShortcut,
+  generateHash,
   getBatteryLevel,
   getContentsOfUrl,
   getCurrentIpAddress,

src/interfaces/WF/WFHashType.ts

@@ -0,0 +1,8 @@
+type WFHashType = (
+  'MD5'
+  | 'SHA1'
+  | 'SHA256'
+  | 'SHA512'
+);
+
+export default WFHashType;

src/interfaces/WF/WFWorkflowActionIdentifier.ts

@@ -21,6 +21,7 @@ type WFWorkflowActionIdentifier = (
   | 'is.workflow.actions.getvalueforkey'
   | 'is.workflow.actions.getvariable'
   | 'is.workflow.actions.handoff'
+  | 'is.workflow.actions.hash'
   | 'is.workflow.actions.lowpowermode.set'
   | 'is.workflow.actions.math'
   | 'is.workflow.actions.nothing'

src/interfaces/WF/WFWorkflowActionParameters.ts

@@ -3,6 +3,7 @@ import WFCondition from './WFCondition';
 import WFCountType from './WFCountType';
 import WFFlashlightSetting from './WFFlashlightSetting';
 import WFGetDictionaryValueType from './WFGetDictionaryValueType';
+import WFHashType from './WFHashType';
 import WFHTTPBodyType from './WFHTTPBodyType';
 import WFHTTPMethod from './WFHTTPMethod';
 import WFInputType from './WFInputType';
@@ -34,6 +35,7 @@ interface WFWorkflowActionParameters {
   WFFlashlightSetting?: WFFlashlightSetting;
   WFFormValues?: WFSerialization;
   WFGetDictionaryValueType?: WFGetDictionaryValueType;
+  WFHashType?: WFSerialization | WFHashType;
   WFHTTPBodyType?: WFHTTPBodyType;
   WFHTTPHeaders?: WFSerialization;
   WFHTTPMethod?: WFHTTPMethod;