Merge ca7336e into 57e452a

__tests__/actions/base64Encode.spec.ts

@@ -0,0 +1,72 @@
+import { base64Encode } from '../../src/actions';
+
+describe('base64Encode function', () => {
+
+  it('is a function', () => {
+    expect(typeof base64Encode).toBe('function');
+  });
+
+  it('builds a base64Encode action (encode with no line break)', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.base64encode',
+      WFWorkflowActionParameters: {
+        WFEncodeMode: 'Encode',
+        WFBase64LineBreakMode: 'None',
+      },
+    };
+    const actual = base64Encode({
+      encodeMode: 'Encode',
+      lineBreakMode: 'None',
+    });
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('builds a base64Encode action (encode with 64-char line break)', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.base64encode',
+      WFWorkflowActionParameters: {
+        WFEncodeMode: 'Encode',
+        WFBase64LineBreakMode: 'Every 64 Characters',
+      },
+    };
+    const actual = base64Encode({
+      encodeMode: 'Encode',
+      lineBreakMode: 'Every 64 Characters',
+    });
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('builds a base64Encode action (encode with 76-char line break)', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.base64encode',
+      WFWorkflowActionParameters: {
+        WFEncodeMode: 'Encode',
+        WFBase64LineBreakMode: 'Every 76 Characters',
+      },
+    };
+    const actual = base64Encode({
+      encodeMode: 'Encode',
+      lineBreakMode: 'Every 76 Characters',
+    });
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('builds a base64Encode action (decode)', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.base64encode',
+      WFWorkflowActionParameters: {
+        WFEncodeMode: 'Decode',
+        WFBase64LineBreakMode: 'Every 76 Characters',
+      },
+    };
+    const actual = base64Encode({
+      encodeMode: 'Decode',
+    });
+
+    expect(actual).toEqual(expected);
+  });
+
+});

src/actions/base64Encode.ts

@@ -0,0 +1,41 @@
+import { withActionOutput } from '../utils';
+
+import WFBase64LineBreakMode from '../interfaces/WF/WFBase64LineBreakMode';
+import WFEncodeMode from '../interfaces/WF/WFEncodeMode';
+import WFSerialization from '../interfaces/WF/WFSerialization';
+import WFWorkflowAction from '../interfaces/WF/WFWorkflowAction';
+
+/**
+ * Base 64 Encode Action. Base 64-encode content.
+ *
+ * ```js
+ * base64Encode({
+ *   encodeMode: 'Encode',
+ *   lineBreakMode: 'Every 76 Characters',
+ * });
+ * ```
+ */
+const base64Encode = (
+  options: {
+    /** The encoding mode to use */
+    encodeMode?: WFEncodeMode,
+
+    /** The line break mode to use */
+    lineBreakMode?: WFSerialization | WFBase64LineBreakMode,
+  },
+): WFWorkflowAction => {
+  const {
+    encodeMode = 'Encode',
+    lineBreakMode = 'Every 76 Characters',
+  } = options;
+
+  return {
+    WFWorkflowActionIdentifier: 'is.workflow.actions.base64encode',
+    WFWorkflowActionParameters: {
+      WFEncodeMode: encodeMode,
+      WFBase64LineBreakMode: lineBreakMode,
+    },
+  };
+};
+
+export default withActionOutput(base64Encode);

src/actions/index.ts

@@ -1,5 +1,6 @@
 import addToVariable from './addToVariable';
 import ask from './ask';
+import base64Encode from './base64Encode';
 import calculate from './calculate';
 import chooseFromMenu from './chooseFromMenu';
 import comment from './comment';
@@ -38,6 +39,7 @@ import waitToReturn from './waitToReturn';
 export {
   addToVariable,
   ask,
+  base64Encode,
   calculate,
   chooseFromMenu,
   comment,

src/interfaces/WF/WFBase64LineBreakMode.ts

@@ -0,0 +1,7 @@
+type WFBase64LineBreakMode = (
+  'None'
+  | 'Every 64 Characters'
+  | 'Every 76 Characters'
+);
+
+export default WFBase64LineBreakMode;

src/interfaces/WF/WFEncodeMode.ts

@@ -0,0 +1,6 @@
+type WFEncodeMode = (
+  'Encode'
+  | 'Decode'
+);
+
+export default WFEncodeMode;

src/interfaces/WF/WFWorkflowActionIdentifier.ts

@@ -2,6 +2,7 @@ type WFWorkflowActionIdentifier = (
   'is.workflow.actions.appendvariable'
   | 'is.workflow.actions.airplanemode.set'
   | 'is.workflow.actions.ask'
+  | 'is.workflow.actions.base64encode'
   | 'is.workflow.actions.bluetooth.set'
   | 'is.workflow.actions.cellulardata.set'
   | 'is.workflow.actions.choosefrommenu'

src/interfaces/WF/WFWorkflowActionParameters.ts

@@ -1,6 +1,8 @@
 import WFAskActionDateGranularity from './WFAskActionDateGranularity';
+import WFBase64LineBreakMode from './WFBase64LineBreakMode';
 import WFCondition from './WFCondition';
 import WFCountType from './WFCountType';
+import WFEncodeMode from './WFEncodeMode';
 import WFFlashlightSetting from './WFFlashlightSetting';
 import WFGetDictionaryValueType from './WFGetDictionaryValueType';
 import WFHTTPBodyType from './WFHTTPBodyType';
@@ -22,6 +24,7 @@ interface WFWorkflowActionParameters {
   WFAskActionDateGranularity?: WFAskActionDateGranularity;
   WFAskActionDefaultAnswer?: WFSerialization | string;
   WFAskActionPrompt?: WFSerialization | string;
+  WFBase64LineBreakMode?: WFSerialization | WFBase64LineBreakMode;
   WFBrightness?: number;
   WFCommentActionText?: string;
   WFCondition?: WFCondition;
@@ -31,6 +34,7 @@ interface WFWorkflowActionParameters {
   WFDelayTime?: number;
   WFDictionaryKey?: string;
   WFDontIncludeFileExtension?: boolean;
+  WFEncodeMode?: WFEncodeMode;
   WFFlashlightSetting?: WFFlashlightSetting;
   WFFormValues?: WFSerialization;
   WFGetDictionaryValueType?: WFGetDictionaryValueType;