@hellotext/hellotext 1.7.8 → 1.8.0

package/README.md

@@ -123,8 +123,8 @@ Hellotext.initialize('HELLOTEXT_BUSINESS_ID', configurationOptions)
 
 #### Configuration Options
 
-| Property            | Description                                                                                                                                                                                     | Type    | Default |
-|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---------|
-| session             | A valid Hellotext session which was stored previously. When not set, Hellotext attempts to retrieve the stored value from `document.cookie` when available, otherwise it creates a new session. | String  | null    |
-| autoGenerateSession | Whether the library should automatically generate a session when no session is found in the query or the cookies                                                                                | Boolean | true    |
-| autoMountForms      | Whether the library should automatically mount forms collected or not                                                                                                                           | Boolean | true    |
+| Property            | Description                                                                                                                                                                                     | Type    | Default                                   |
+|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-------------------------------------------|
+| session             | A valid Hellotext session which was stored previously. When not set, Hellotext attempts to retrieve the stored value from `document.cookie` when available, otherwise it creates a new session. | String  | null                                      |
+| autoGenerateSession | Whether the library should automatically generate a session when no session is found in the query or the cookies                                                                                | Boolean | true                                      |
+| forms               | An object that controls how Hellotext should control the forms on the page. See [Forms](/docs/forms.md) documentation for more information.                                                     | Object  | { autoMount: true, successMessage: true } |

package/__tests__/core/configuration/forms_test.js

@@ -0,0 +1,30 @@
+import { Forms } from '../../../src/core/configuration/forms'
+
+describe('Forms', () => {
+  describe('.autoMount', () => {
+    it('is true by default', () => {
+      expect(Forms.autoMount).toEqual(true)
+    })
+
+    it('can be set to false', () => {
+      Forms.autoMount = false
+      expect(Forms.autoMount).toEqual(false)
+    })
+  })
+
+  describe('.successMessage', () => {
+    it('is true by default', () => {
+      expect(Forms.successMessage).toEqual(true)
+    })
+
+    it('can be set to false', () => {
+      Forms.successMessage = false
+      expect(Forms.successMessage).toEqual(false)
+    })
+
+    it('can be set to a string', () => {
+      Forms.successMessage = 'Thank you for your submission'
+      expect(Forms.successMessage).toEqual('Thank you for your submission')
+    })
+  })
+})

package/__tests__/core/configuration_test.js

@@ -0,0 +1,28 @@
+import { Configuration } from '../../src/core'
+
+describe('Configuration', () => {
+  describe('.autoGenerateSession', () => {
+    it('is true by default', () => {
+      expect(Configuration.autoGenerateSession).toEqual(true)
+    })
+
+    it('can be set to false', () => {
+      Configuration.autoGenerateSession = false
+      expect(Configuration.autoGenerateSession).toEqual(false)
+    })
+  })
+
+  describe('.forms', () => {
+    it('has default values', () => {
+      expect(Configuration.forms.autoMount).toEqual(true)
+      expect(Configuration.forms.successMessage).toEqual(true)
+    });
+
+    it('can be modified', () => {
+      Configuration.assign({ forms: { autoMount: false, successMessage: false } })
+
+      expect(Configuration.forms.autoMount).toEqual(false)
+      expect(Configuration.forms.successMessage).toEqual(false)
+    })
+  })
+})

package/__tests__/models/form_collection_test.js

@@ -10,7 +10,9 @@ beforeEach(() => {
 
   Hellotext.initialize('M01az53K', {
     autoGenerateSession: false,
-    autoMountForms: false
+    forms: {
+      autoMount: false,
+    }
   })
 })
 

package/__tests__/models/form_test.js

@@ -79,3 +79,53 @@ describe('markAsCompleted', () => {
     expect(emit).toHaveBeenCalledWith('form:completed', { id: 1 })
   })
 })
+
+describe('localeAuthKey', () => {
+  it('is email when the first step has an email input', () => {
+    const form = new Form({
+      steps: [
+        {
+          inputs: [{ kind: 'email' }]
+        }
+      ]
+    })
+
+    expect(form.localeAuthKey).toBe('email')
+  })
+
+  it('is phone when the first step has a phone input', () => {
+    const form = new Form({
+      steps: [
+        {
+          inputs: [{ kind: 'phone' }]
+        }
+      ]
+    })
+
+    expect(form.localeAuthKey).toBe('phone')
+  })
+
+  it('is phone_and_email when the first step has both email and phone inputs', () => {
+    const form = new Form({
+      steps: [
+        {
+          inputs: [{ kind: 'email' }, { kind: 'phone' }]
+        }
+      ]
+    })
+
+    expect(form.localeAuthKey).toBe('phone_and_email')
+  })
+
+  it('is none when the first step has neither email nor phone inputs', () => {
+    const form = new Form({
+      steps: [
+        {
+          inputs: [{ kind: 'first_name' }]
+        }
+      ]
+    })
+
+    expect(form.localeAuthKey).toBe('none')
+  })
+})