@nyaruka/temba-components 0.139.0 → 0.141.0

package/test/actions/say_msg.test.ts

@@ -0,0 +1,196 @@
+import { expect } from '@open-wc/testing';
+import { say_msg } from '../../src/flow/actions/say_msg';
+import { SayMsg } from '../../src/store/flow-definition';
+import { ActionTest } from '../ActionHelper';
+
+/**
+ * Test suite for the say_msg action configuration.
+ */
+describe('say_msg action config', () => {
+  const helper = new ActionTest(say_msg, 'say_msg');
+
+  describe('basic properties', () => {
+    helper.testBasicProperties();
+
+    it('has correct name', () => {
+      expect(say_msg.name).to.equal('Say Message');
+    });
+
+    it('is voice-only', () => {
+      expect(say_msg.flowTypes).to.deep.equal(['voice']);
+    });
+  });
+
+  describe('action scenarios', () => {
+    helper.testAction(
+      {
+        uuid: 'test-say-1',
+        type: 'say_msg',
+        text: 'Hello, welcome to our service.'
+      } as SayMsg,
+      'simple-text'
+    );
+
+    helper.testAction(
+      {
+        uuid: 'test-say-2',
+        type: 'say_msg',
+        text: 'Press 1 for sales.\nPress 2 for support.\nPress 3 to leave a message.'
+      } as SayMsg,
+      'multiline-text'
+    );
+
+    helper.testAction(
+      {
+        uuid: 'test-say-3',
+        type: 'say_msg',
+        text: 'Please listen to the following recording.',
+        audio_url: 'https://example.com/greeting.mp3'
+      } as SayMsg,
+      'text-with-audio-url'
+    );
+  });
+
+  describe('data transformation', () => {
+    it('converts action to form data', () => {
+      const action: SayMsg = {
+        uuid: 'test-action',
+        type: 'say_msg',
+        text: 'Hello world',
+        audio_url: 'https://example.com/audio.mp3'
+      };
+
+      const formData = say_msg.toFormData!(action);
+      expect(formData.uuid).to.equal('test-action');
+      expect(formData.text).to.equal('Hello world');
+      expect(formData.audio_url).to.equal('https://example.com/audio.mp3');
+    });
+
+    it('handles missing audio_url in toFormData', () => {
+      const action: SayMsg = {
+        uuid: 'test-action',
+        type: 'say_msg',
+        text: 'Hello'
+      } as SayMsg;
+
+      const formData = say_msg.toFormData!(action);
+      expect(formData.audio_url).to.equal('');
+    });
+
+    it('converts form data to action', () => {
+      const formData = {
+        uuid: 'test-action',
+        text: 'Hello world',
+        audio_url: 'https://example.com/audio.mp3'
+      };
+
+      const action = say_msg.fromFormData!(formData) as SayMsg;
+      expect(action.uuid).to.equal('test-action');
+      expect(action.type).to.equal('say_msg');
+      expect(action.text).to.equal('Hello world');
+      expect(action.audio_url).to.equal('https://example.com/audio.mp3');
+    });
+
+    it('omits empty audio_url in fromFormData', () => {
+      const formData = {
+        uuid: 'test-action',
+        text: 'Hello world',
+        audio_url: ''
+      };
+
+      const action = say_msg.fromFormData!(formData) as SayMsg;
+      expect(action.audio_url).to.be.undefined;
+    });
+
+    it('trims whitespace from audio_url', () => {
+      const formData = {
+        uuid: 'test-action',
+        text: 'Hello',
+        audio_url: '  https://example.com/audio.mp3  '
+      };
+
+      const action = say_msg.fromFormData!(formData) as SayMsg;
+      expect(action.audio_url).to.equal('https://example.com/audio.mp3');
+    });
+  });
+
+  describe('sanitize', () => {
+    it('trims text whitespace', () => {
+      const formData = { text: '  Hello world  ' };
+      say_msg.sanitize!(formData);
+      expect(formData.text).to.equal('Hello world');
+    });
+  });
+
+  describe('localization', () => {
+    it('converts localization to form data', () => {
+      const action: SayMsg = {
+        uuid: 'test-action',
+        type: 'say_msg',
+        text: 'Hello',
+        audio_url: 'https://example.com/en.mp3'
+      };
+
+      const localization = {
+        text: ['Hola'],
+        audio_url: ['https://example.com/es.mp3']
+      };
+
+      const formData = say_msg.toLocalizationFormData!(action, localization);
+      expect(formData.text).to.equal('Hola');
+      expect(formData.audio_url).to.equal('https://example.com/es.mp3');
+    });
+
+    it('handles missing localization fields', () => {
+      const action: SayMsg = {
+        uuid: 'test-action',
+        type: 'say_msg',
+        text: 'Hello'
+      } as SayMsg;
+
+      const formData = say_msg.toLocalizationFormData!(action, {});
+      expect(formData.text).to.equal('');
+      expect(formData.audio_url).to.equal('');
+    });
+
+    it('converts form data to localization', () => {
+      const action: SayMsg = {
+        uuid: 'test-action',
+        type: 'say_msg',
+        text: 'Hello',
+        audio_url: 'https://example.com/en.mp3'
+      };
+
+      const formData = {
+        uuid: 'test-action',
+        text: 'Hola',
+        audio_url: 'https://example.com/es.mp3'
+      };
+
+      const localization = say_msg.fromLocalizationFormData!(formData, action);
+      expect(localization.text).to.deep.equal(['Hola']);
+      expect(localization.audio_url).to.deep.equal([
+        'https://example.com/es.mp3'
+      ]);
+    });
+
+    it('omits unchanged localization fields', () => {
+      const action: SayMsg = {
+        uuid: 'test-action',
+        type: 'say_msg',
+        text: 'Hello',
+        audio_url: 'https://example.com/en.mp3'
+      };
+
+      const formData = {
+        uuid: 'test-action',
+        text: 'Hello', // same as original
+        audio_url: 'https://example.com/en.mp3' // same as original
+      };
+
+      const localization = say_msg.fromLocalizationFormData!(formData, action);
+      expect(localization.text).to.be.undefined;
+      expect(localization.audio_url).to.be.undefined;
+    });
+  });
+});

package/test/actions/send_broadcast.test.ts

@@ -188,5 +188,49 @@ describe('send_broadcast action config', () => {
 
       expect(formData.text).to.equal('Test message');
     });
+
+    it('should strip superfluous API metadata from contacts and groups', () => {
+      const formData = {
+        uuid: 'test-uuid',
+        recipients: [
+          {
+            uuid: 'contact-1',
+            name: 'Alice',
+            status: 'active',
+            language: 'eng',
+            urns: ['tel:+250788123456'],
+            groups: [{ uuid: 'g-1', name: 'G1' }],
+            fields: { age: '30' },
+            created_on: '2024-01-01T00:00:00.000Z',
+            modified_on: '2024-06-15T12:00:00.000Z',
+            last_seen_on: '2024-06-14T10:00:00.000Z'
+          },
+          {
+            uuid: 'group-1',
+            name: 'Subscribers',
+            group: true,
+            query: null,
+            status: 'ready',
+            count: 500,
+            system: false
+          }
+        ],
+        text: 'Hello!',
+        attachments: []
+      };
+
+      const action = send_broadcast.fromFormData(formData) as SendBroadcast;
+
+      expect(action.contacts).to.have.lengthOf(1);
+      expect(action.contacts[0]).to.deep.equal({
+        uuid: 'contact-1',
+        name: 'Alice'
+      });
+      expect(action.groups).to.have.lengthOf(1);
+      expect(action.groups[0]).to.deep.equal({
+        uuid: 'group-1',
+        name: 'Subscribers'
+      });
+    });
   });
 });

package/test/actions/set_contact_channel.test.ts

@@ -0,0 +1,88 @@
+import { expect } from '@open-wc/testing';
+import { set_contact_channel } from '../../src/flow/actions/set_contact_channel';
+import { SetContactChannel } from '../../src/store/flow-definition';
+import { ActionTest } from '../ActionHelper';
+
+/**
+ * Test suite for the set_contact_channel action configuration.
+ */
+describe('set_contact_channel action config', () => {
+  const helper = new ActionTest(set_contact_channel, 'set_contact_channel');
+
+  describe('basic properties', () => {
+    helper.testBasicProperties();
+
+    it('has correct name', () => {
+      expect(set_contact_channel.name).to.equal('Update Channel');
+    });
+  });
+
+  describe('action scenarios', () => {
+    helper.testAction(
+      {
+        uuid: 'test-action-1',
+        type: 'set_contact_channel',
+        channel: { uuid: 'channel-1', name: 'WhatsApp Channel' }
+      } as SetContactChannel,
+      'whatsapp-channel'
+    );
+
+    helper.testAction(
+      {
+        uuid: 'test-action-2',
+        type: 'set_contact_channel',
+        channel: { uuid: 'channel-2', name: 'Twilio SMS' }
+      } as SetContactChannel,
+      'sms-channel'
+    );
+  });
+
+  describe('metadata stripping', () => {
+    it('should strip superfluous API metadata from channel', () => {
+      const formData = {
+        uuid: 'test-uuid',
+        channel: [
+          {
+            uuid: 'channel-1',
+            name: 'WhatsApp Channel',
+            address: '+250788123456',
+            country: 'RW',
+            schemes: ['whatsapp'],
+            roles: ['send', 'receive'],
+            created_on: '2024-01-01T00:00:00.000Z'
+          }
+        ]
+      };
+
+      const action = set_contact_channel.fromFormData(
+        formData
+      ) as SetContactChannel;
+
+      expect(action.channel).to.deep.equal({
+        uuid: 'channel-1',
+        name: 'WhatsApp Channel'
+      });
+    });
+
+    it('should handle channel selected via value key', () => {
+      const formData = {
+        uuid: 'test-uuid',
+        channel: [
+          {
+            value: 'channel-1',
+            name: 'WhatsApp Channel'
+          }
+        ]
+      };
+
+      const action = set_contact_channel.fromFormData(
+        formData
+      ) as SetContactChannel;
+
+      expect(action.channel).to.deep.equal({
+        uuid: 'channel-1',
+        name: 'WhatsApp Channel'
+      });
+    });
+  });
+});

package/test/actions/set_contact_field.test.ts

@@ -0,0 +1,68 @@
+import { expect } from '@open-wc/testing';
+import { set_contact_field } from '../../src/flow/actions/set_contact_field';
+import { SetContactField } from '../../src/store/flow-definition';
+import { ActionTest } from '../ActionHelper';
+
+/**
+ * Test suite for the set_contact_field action configuration.
+ */
+describe('set_contact_field action config', () => {
+  const helper = new ActionTest(set_contact_field, 'set_contact_field');
+
+  describe('basic properties', () => {
+    helper.testBasicProperties();
+
+    it('has correct name', () => {
+      expect(set_contact_field.name).to.equal('Update Field');
+    });
+  });
+
+  describe('action scenarios', () => {
+    helper.testAction(
+      {
+        uuid: 'test-action-1',
+        type: 'set_contact_field',
+        field: { key: 'favorite_color', name: 'Favorite Color' },
+        value: 'Blue'
+      } as SetContactField,
+      'set-value'
+    );
+
+    helper.testAction(
+      {
+        uuid: 'test-action-2',
+        type: 'set_contact_field',
+        field: { key: 'age', name: 'Age' },
+        value: ''
+      } as SetContactField,
+      'clear-value'
+    );
+  });
+
+  describe('metadata stripping', () => {
+    it('should strip superfluous API metadata from field', () => {
+      const formData = {
+        uuid: 'test-uuid',
+        field: [
+          {
+            key: 'favorite_color',
+            name: 'Favorite Color',
+            value_type: 'text',
+            featured: true,
+            usages: { campaign_events: 0, flows: 3, groups: 1 }
+          }
+        ],
+        value: 'Red'
+      };
+
+      const action = set_contact_field.fromFormData(
+        formData
+      ) as SetContactField;
+
+      expect(action.field).to.deep.equal({
+        key: 'favorite_color',
+        name: 'Favorite Color'
+      });
+    });
+  });
+});

package/test/actions/set_contact_language.test.ts

@@ -0,0 +1,55 @@
+import { expect } from '@open-wc/testing';
+import { set_contact_language } from '../../src/flow/actions/set_contact_language';
+import { SetContactLanguage } from '../../src/store/flow-definition';
+import { ActionTest } from '../ActionHelper';
+
+/**
+ * Test suite for the set_contact_language action configuration.
+ */
+describe('set_contact_language action config', () => {
+  const helper = new ActionTest(set_contact_language, 'set_contact_language');
+
+  describe('basic properties', () => {
+    helper.testBasicProperties();
+
+    it('has correct name', () => {
+      expect(set_contact_language.name).to.equal('Update Language');
+    });
+  });
+
+  describe('action scenarios', () => {
+    helper.testAction(
+      {
+        uuid: 'test-action-1',
+        type: 'set_contact_language',
+        language: 'eng'
+      } as SetContactLanguage,
+      'english'
+    );
+
+    helper.testAction(
+      {
+        uuid: 'test-action-2',
+        type: 'set_contact_language',
+        language: 'fra'
+      } as SetContactLanguage,
+      'french'
+    );
+  });
+
+  describe('round-trip', () => {
+    it('should extract language code from select option', () => {
+      const formData = {
+        uuid: 'test-uuid',
+        language: [{ value: 'spa', name: 'Spanish' }]
+      };
+
+      const action = set_contact_language.fromFormData(
+        formData
+      ) as SetContactLanguage;
+
+      expect(action.language).to.equal('spa');
+      expect(action.type).to.equal('set_contact_language');
+    });
+  });
+});

package/test/actions/set_contact_name.test.ts

@@ -0,0 +1,39 @@
+import { expect } from '@open-wc/testing';
+import { set_contact_name } from '../../src/flow/actions/set_contact_name';
+import { SetContactName } from '../../src/store/flow-definition';
+import { ActionTest } from '../ActionHelper';
+
+/**
+ * Test suite for the set_contact_name action configuration.
+ */
+describe('set_contact_name action config', () => {
+  const helper = new ActionTest(set_contact_name, 'set_contact_name');
+
+  describe('basic properties', () => {
+    helper.testBasicProperties();
+
+    it('has correct name', () => {
+      expect(set_contact_name.name).to.equal('Update Name');
+    });
+  });
+
+  describe('action scenarios', () => {
+    helper.testAction(
+      {
+        uuid: 'test-action-1',
+        type: 'set_contact_name',
+        name: 'Alice Johnson'
+      } as SetContactName,
+      'static-name'
+    );
+
+    helper.testAction(
+      {
+        uuid: 'test-action-2',
+        type: 'set_contact_name',
+        name: '@(title(input))'
+      } as SetContactName,
+      'expression-name'
+    );
+  });
+});

package/test/actions/set_contact_status.test.ts

@@ -0,0 +1,64 @@
+import { expect } from '@open-wc/testing';
+import { set_contact_status } from '../../src/flow/actions/set_contact_status';
+import { SetContactStatus } from '../../src/store/flow-definition';
+import { ActionTest } from '../ActionHelper';
+
+/**
+ * Test suite for the set_contact_status action configuration.
+ */
+describe('set_contact_status action config', () => {
+  const helper = new ActionTest(set_contact_status, 'set_contact_status');
+
+  describe('basic properties', () => {
+    helper.testBasicProperties();
+
+    it('has correct name', () => {
+      expect(set_contact_status.name).to.equal('Update Status');
+    });
+  });
+
+  describe('action scenarios', () => {
+    helper.testAction(
+      {
+        uuid: 'test-action-1',
+        type: 'set_contact_status',
+        status: 'active'
+      } as SetContactStatus,
+      'active'
+    );
+
+    helper.testAction(
+      {
+        uuid: 'test-action-2',
+        type: 'set_contact_status',
+        status: 'blocked'
+      } as SetContactStatus,
+      'blocked'
+    );
+
+    helper.testAction(
+      {
+        uuid: 'test-action-3',
+        type: 'set_contact_status',
+        status: 'archived'
+      } as SetContactStatus,
+      'archived'
+    );
+  });
+
+  describe('round-trip', () => {
+    it('should extract status value from select option', () => {
+      const formData = {
+        uuid: 'test-uuid',
+        status: [{ value: 'stopped', name: 'Stopped' }]
+      };
+
+      const action = set_contact_status.fromFormData(
+        formData
+      ) as SetContactStatus;
+
+      expect(action.status).to.equal('stopped');
+      expect(action.type).to.equal('set_contact_status');
+    });
+  });
+});

package/test/actions/set_run_result.test.ts

@@ -0,0 +1,61 @@
+import { expect } from '@open-wc/testing';
+import { set_run_result } from '../../src/flow/actions/set_run_result';
+import { SetRunResult } from '../../src/store/flow-definition';
+import { ActionTest } from '../ActionHelper';
+
+/**
+ * Test suite for the set_run_result action configuration.
+ */
+describe('set_run_result action config', () => {
+  const helper = new ActionTest(set_run_result, 'set_run_result');
+
+  describe('basic properties', () => {
+    helper.testBasicProperties();
+
+    it('has correct name', () => {
+      expect(set_run_result.name).to.equal('Save Flow Result');
+    });
+  });
+
+  describe('action scenarios', () => {
+    helper.testAction(
+      {
+        uuid: 'test-action-1',
+        type: 'set_run_result',
+        name: 'Score',
+        value: '100',
+        category: 'High'
+      } as SetRunResult,
+      'with-category'
+    );
+
+    helper.testAction(
+      {
+        uuid: 'test-action-2',
+        type: 'set_run_result',
+        name: 'Response',
+        value: '@input.text',
+        category: ''
+      } as SetRunResult,
+      'expression-value'
+    );
+  });
+
+  describe('round-trip', () => {
+    it('should extract name from select option array', () => {
+      const formData = {
+        uuid: 'test-uuid',
+        name: [{ value: 'Score', name: 'Score' }],
+        value: '42',
+        category: 'Medium'
+      };
+
+      const action = set_run_result.fromFormData(formData) as SetRunResult;
+
+      expect(action.name).to.equal('Score');
+      expect(action.value).to.equal('42');
+      expect(action.category).to.equal('Medium');
+      expect(action.type).to.equal('set_run_result');
+    });
+  });
+});