@hellotext/hellotext 1.8.7 → 2.0.1

package/.prettierrc.json

@@ -1,18 +0,0 @@
-{
-  "arrowParens": "avoid",
-  "bracketSpacing": true,
-  "printWidth": 100,
-  "semi": false,
-  "singleQuote": true,
-  "tabWidth": 2,
-  "trailingComma": "all",
-  "useTabs": false,
-  "overrides": [
-    {
-      "files": "*.json",
-      "options": {
-        "printWidth": 200
-      }
-    }
-  ]
-}

package/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2022 HelloText
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/__tests__/builders/input_builder_test.js

@@ -1,117 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-
-import Hellotext from '../../src/hellotext'
-import { InputBuilder } from '../../src/builders/input_builder'
-
-describe('when the input is first_name', () => {
-  const data = {
-    label: 'First Name',
-    type: 'text',
-    required: true,
-    placeholder: 'Enter your first name',
-    kind: 'first_name',
-  }
-
-  it('builds an article element that contains a label and input elements', () => {
-    const article = InputBuilder.build(data)
-    const label = article.querySelector('label')
-    const input = article.querySelector('input')
-
-    expect(label.innerText).toEqual('First Name')
-    expect(label.getAttribute('for')).toEqual('first_name')
-
-    expect(input.id).toEqual('first_name')
-    expect(input.type).toEqual('text')
-    expect(input.required).toEqual(true)
-    expect(input.placeholder).toEqual('Enter your first name')
-    expect(input.name).toEqual('first_name')
-  })
-})
-
-describe('when the input is last_name', () => {
-  const data = {
-    label: 'Last Name',
-    type: 'text',
-    required: false,
-    placeholder: 'Enter your last name',
-    kind: 'last_name',
-  }
-
-  it('builds an article element that contains a label and input elements', () => {
-    const article = InputBuilder.build(data)
-    const label = article.querySelector('label')
-    const input = article.querySelector('input')
-
-    expect(label.innerText).toEqual('Last Name')
-    expect(label.getAttribute('for')).toEqual('last_name')
-
-    expect(input.id).toEqual('last_name')
-    expect(input.type).toEqual('text')
-    expect(input.required).toEqual(false)
-    expect(input.placeholder).toEqual('Enter your last name')
-    expect(input.name).toEqual('last_name')
-  })
-})
-
-describe('when the input belongs to a property', () => {
-  const data = {
-    label: 'Email',
-    type: 'email',
-    required: true,
-    placeholder: 'Enter your email',
-    kind: 'email',
-    property: 'xybz',
-  }
-
-  it('builds an article element that contains a label and input elements', () => {
-    const article = InputBuilder.build(data)
-    const label = article.querySelector('label')
-    const input = article.querySelector('input')
-
-    expect(label.innerText).toEqual('Email')
-    expect(label.getAttribute('for')).toEqual('email')
-
-    expect(input.id).toEqual('email')
-    expect(input.type).toEqual('email')
-    expect(input.required).toEqual(true)
-    expect(input.placeholder).toEqual('Enter your email')
-    expect(input.name).toEqual('email')
-  })
-})
-
-describe('when the input is a phone number', () => {
-  const data = {
-    label: 'Phone',
-    type: 'tel',
-    required: true,
-    placeholder: 'Enter your phone number',
-    kind: 'phone',
-  }
-
-  beforeEach(() => {
-    Hellotext.business = {
-      country: {
-        prefix: '598',
-        code: 'UY',
-      }
-    }
-  })
-
-  it('builds an article element that contains a label and input elements', () => {
-    const article = InputBuilder.build(data)
-    const label = article.querySelector('label')
-    const input = article.querySelector('input')
-
-    expect(label.innerText).toEqual('Phone')
-    expect(label.getAttribute('for')).toEqual('phone')
-
-    expect(input.id).toEqual('phone')
-    expect(input.type).toEqual('tel')
-    expect(input.required).toEqual(true)
-    expect(input.placeholder).toEqual('Enter your phone number')
-    expect(input.name).toEqual('phone')
-    expect(input.value).toEqual('+598')
-  })
-})

package/__tests__/core/configuration/forms_test.js

@@ -1,30 +0,0 @@
-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/webchat_test.js

@@ -1,163 +0,0 @@
-import { Webchat } from '../../../src/core/configuration/webchat'
-
-describe('Webchat', () => {
-  describe('behaviour', () => {
-    it('is POPOVER by default', () => {
-      expect(Webchat.behaviour).toEqual('popover')
-    });
-
-    it('can be set to modal', () => {
-      Webchat.behaviour = 'modal'
-      expect(Webchat.behaviour).toEqual('modal')
-    });
-
-    it('throws an exception when an invalid value is supplied', () => {
-      expect(() => {
-        Webchat.behaviour = 'invalid'
-      }).toThrowError('Invalid behaviour value: invalid')
-    });
-  })
-
-  describe('container', () => {
-    it('is body by default', () => {
-      expect(Webchat.container).toEqual('body')
-    });
-
-    it('can be set to any other value', () => {
-      Webchat.container = 'html'
-      expect(Webchat.container).toEqual('html')
-    });
-  })
-
-  describe('placement', () => {
-    it('is bottom-right by default', () => {
-      expect(Webchat.placement).toEqual('bottom-right')
-    });
-
-    it('can be set to any other value', () => {
-      Webchat.placement = 'top-left'
-      expect(Webchat.placement).toEqual('top-left')
-    });
-
-    it('throws an exception when an invalid value is supplied', () => {
-      expect(() => {
-        Webchat.placement = 'invalid'
-      }).toThrowError('Invalid placement value: invalid')
-    });
-  })
-
-  describe('classes', () => {
-    it('is an empty array by default', () => {
-      expect(Webchat.classes).toEqual([])
-    });
-
-    describe('setting value to a String', () => {
-      it('can be set to a string value', () => {
-        Webchat.classes = 'custom-class'
-      });
-
-      it('returns an array of the values', () => {
-        Webchat.classes = 'custom-class, another-class'
-        expect(Webchat.classes).toEqual(['custom-class', 'another-class'])
-      });
-    });
-
-    it('can be set to an Array', () => {
-      Webchat.classes = ['custom-class']
-      expect(Webchat.classes).toEqual(['custom-class'])
-    });
-
-    it('throws an exception when an invalid value is supplied', () => {
-      expect(() => {
-        Webchat.classes = { invalid: 'value' }
-      }).toThrowError('classes must be an array or a string')
-    });
-  })
-
-  describe('triggerClasses', () => {
-    it('is an empty array by default', () => {
-      expect(Webchat.triggerClasses).toEqual([undefined])
-    });
-
-    describe('setting value to a String', () => {
-      it('can be set to a string value', () => {
-        Webchat.triggerClasses = 'custom-class'
-      });
-
-      it('returns an array of the values', () => {
-        Webchat.triggerClasses = 'custom-class, another-class'
-        expect(Webchat.triggerClasses).toEqual(['custom-class', 'another-class'])
-      });
-    });
-
-    describe('when setting value to an Array', () => {
-      it('can be set', () => {
-        Webchat.triggerClasses = ['custom-class']
-      });
-
-      it('returns the value', () => {
-        Webchat.triggerClasses = ['custom-class', 'another-class']
-        expect(Webchat.triggerClasses).toEqual(['custom-class', 'another-class'])
-      });
-    })
-
-    it('throws an exception when an invalid value is supplied', () => {
-      expect(() => {
-        Webchat.triggerClasses = { invalid: 'value' }
-      }).toThrowError('triggerClasses must be an array or a string')
-    });
-  })
-
-  describe('styles', () => {
-    it('raises an exception when an invalid style is set', () => {
-      expect(() => {
-        Webchat.style = { fill: 'value' }
-      }).toThrowError('Invalid style property: fill')
-    })
-    describe('primaryColor', () => {
-      it('can be set to a hex string', () => {
-        Webchat.style = { primaryColor: '#EEEEEE' }
-        expect(Webchat.style.primaryColor).toEqual('#EEEEEE')
-      });
-
-      it('can be set to an rgb string', () => {
-        Webchat.style = { primaryColor: 'rgb(255, 255, 255)' }
-        expect(Webchat.style.primaryColor).toEqual('rgb(255, 255, 255)')
-      });
-
-      it('can be set to an rgba string', () => {
-        Webchat.style = { primaryColor: 'rgba(255, 255, 255, 0.5)' }
-        expect(Webchat.style.primaryColor).toEqual('rgba(255, 255, 255, 0.5)')
-      });
-
-      it('throws an exception when an invalid value is supplied', () => {
-        expect(() => {
-          Webchat.style = { primaryColor: 'red' }
-        }).toThrowError('Invalid color value: red for primaryColor. Colors must be hex or rgb/a.')
-      });
-    })
-
-    describe('secondaryColor', () => {
-      it('can be set to a hex string', () => {
-        Webchat.style = { secondaryColor: '#EEEEEE' }
-        expect(Webchat.style.secondaryColor).toEqual('#EEEEEE')
-      });
-
-      it('can be set to an rgb string', () => {
-        Webchat.style = { secondaryColor: 'rgb(255, 255, 255)' }
-        expect(Webchat.style.secondaryColor).toEqual('rgb(255, 255, 255)')
-      });
-
-      it('can be set to an rgba string', () => {
-        Webchat.style = { secondaryColor: 'rgba(255, 255, 255, 0.5)' }
-        expect(Webchat.style.secondaryColor).toEqual('rgba(255, 255, 255, 0.5)')
-      });
-
-      it('throws an exception when an invalid value is supplied', () => {
-        expect(() => {
-          Webchat.style = { secondaryColor: 'red' }
-        }).toThrowError('Invalid color value: red for secondaryColor. Colors must be hex or rgb/a.')
-      });
-    })
-  })
-})

package/__tests__/core/configuration_test.js

@@ -1,28 +0,0 @@
-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__/core/event_test.js

@@ -1,56 +0,0 @@
-import Event from "../../src/core/event"
-
-describe(".valid", function () {
-  it("is true when event name is a valid defined name", () => {
-    expect(Event.valid("session-set")).toEqual(true)
-  });
-
-  it("is false when event name is not defined", () =>  {
-    expect(Event.valid("undefined-event")).toEqual(false)
-  });
-});
-
-describe(".invalid", () => {
-  it("is true when event name is not defined", () =>  {
-    expect(Event.invalid("undefined-event")).toEqual(true)
-  });
-
-  it("is false when event name is a valid defined name", () => {
-    expect(Event.invalid("session-set")).toEqual(false)
-  });
-});
-
-describe("#addSubscriber", function () {
-  const instance = new Event()
-
-  it("adds the callback to the list of subscribers for an event", () => {
-    const callback = (session) => {}
-    instance.addSubscriber("session-set", callback)
-    expect(instance.subscribers["session-set"].length).toEqual(1)
-  });
-});
-
-describe("#removeSubscriber", function () {
-  const instance = new Event()
-
-  it("removes the callback from the list of subscribers for an event", () => {
-    const callback = (session) => {}
-    instance.addSubscriber("session-set", callback)
-    instance.removeSubscriber("session-set", callback)
-
-    expect(instance.subscribers["session-set"].length).toEqual(0)
-  });
-});
-
-describe("#dispatch", () => {
-  const instance = new Event()
-
-  it("notifies the listeners for an event", () => {
-    const callback = jest.fn()
-
-    instance.addSubscriber("session-set", callback)
-    instance.dispatch("session-set", "session_payload")
-
-    expect(callback).toHaveBeenCalledTimes(1)
-  });
-});

package/__tests__/hellotext_test.js

@@ -1,197 +0,0 @@
-import Hellotext from "../src/hellotext";
-import { Business } from "../src/models"
-
-const getCookieValue = name => document.cookie.match('(^|;)\\s*' + name + '\\s*=\\s*([^;]+)')?.pop()
-
-const expireSession = () => {
-  document.cookie = "hello_session=;expires=Thu, 01 Jan 1970 00:00:00 GMT"
-}
-
-beforeEach(() => {
-  Business.prototype.fetchPublicData = jest.fn().mockResolvedValue({ whitelist: 'disabled' })
-})
-
-afterEach(() => {
-  jest.clearAllMocks();
-});
-
-describe("when trying to call methods before initializing the class", () => {
-  it("raises an error when Hellotext.track is called",  () => {
-    expect(Hellotext.track("page.viewed")).rejects.toThrowError()
-  });
-})
-//
-describe("when the class is initialized successfully", () => {
-  const business_id = "xy76ks"
-
-  describe("when hello_session is present in the query params", () => {
-    beforeAll(() => {
-      const windowMock = {
-        location: { search: "?hello_session=session" },
-      }
-
-      jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMock)
-      Hellotext.initialize(business_id)
-    })
-
-    it("sets the cookie as value of the query parameter", () => {
-      expect(getCookieValue("hello_session")).toEqual("session")
-    });
-
-    it("returns the value when Hellotext.session is called", () => {
-      expect(Hellotext.session).toEqual("session")
-    });
-
-    describe("when tracking events", () => {
-      it("success attribute is true when response from the server is received successfully", async () => {
-        global.fetch = jest.fn().mockResolvedValue({
-          json: jest.fn().mockResolvedValue({received: "success"}),
-          status: 200
-        })
-
-        const response = await Hellotext.track("page.viewed")
-
-        expect(response.succeeded).toEqual(true)
-      });
-
-      it("success attribute is false when response from the server is rejected", async () => {
-        global.fetch = jest.fn().mockResolvedValue({
-          json: jest.fn().mockResolvedValue({}),
-          status: 422
-        })
-
-        const response = await Hellotext.track("page.viewed")
-
-        expect(response.failed).toEqual(true)
-      });
-    });
-  });
-
-  describe("when hello_session is not present in the query params", () => {
-    const business_id = "xy76ks"
-
-    beforeAll(() => {
-      const windowMock = {location: { search: "" },}
-      jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMock)
-    })
-
-    it("mints a new session token and sets the cookie as well", () => {
-      global.fetch = jest.fn().mockResolvedValue({
-        json: jest.fn().mockResolvedValue({id: "generated_token"}),
-        status: 200
-      })
-
-      Hellotext.initialize(business_id)
-
-      setTimeout(() => {
-        expect(getCookieValue("hello_session")).toEqual("generated_token")
-        expect(Hellotext.session).toEqual("generated_token")
-      }, 1000)
-    });
-
-    it("does not mint a new session token when autogenerateSession is set to false", () => {
-      Hellotext.initialize(business_id, { autogenerateSession: false })
-
-      setTimeout(() => {
-        expect(getCookieValue("hello_session")).toEqual(undefined)
-        expect(Hellotext.session).toEqual(undefined)
-      }, 1000)
-    })
-  });
-});
-//
-// describe(".isInitialized", () => {
-//   describe("when session is set", () => {
-//     beforeAll(() => {
-//       const windowMock = {location: { search: "?hello_session=session" }}
-//       jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMock)
-//       Hellotext.initialize("123")
-//     })
-//
-//     it("is true", () => {
-//       expect(Hellotext.isInitialized).toEqual(true)
-//     });
-//   });
-// });
-//
-// describe(".on", () => {
-//   const business_id = "xy76ks"
-//
-//   beforeAll(() => {
-//     const windowMock = {location: { search: "" },}
-//     jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMock)
-//   })
-//
-//   it("registers a callback that is called when the session is set", function () {
-//     global.fetch = jest.fn().mockResolvedValue({
-//       json: jest.fn().mockResolvedValue({id: "generated_token"}),
-//       status: 200
-//     })
-//
-//     const callback = jest.fn()
-//
-//     Hellotext.on("session-set", callback)
-//     Hellotext.initialize(business_id)
-//
-//     expect(callback).toHaveBeenCalledTimes(1)
-//   });
-//
-//   it("throws an error when event is invalid", () => {
-//     expect(
-//       () => Hellotext.on("undefined-event", () => {})
-//     ).toThrowError()
-//   });
-// });
-//
-// describe("when session is stored in the cookie", function () {
-//   beforeAll(() => {
-//     document.cookie = `hello_session=12345`
-//     Hellotext.initialize(123)
-//   })
-//
-//   it("Assigns session from cookie", function () {
-//     expect(Hellotext.session).toEqual("12345")
-//   });
-// });
-//
-//
-// describe(".removeEventListener", () => {
-//   beforeAll(() => {
-//     const windowMock = {location: { search: "?hello_session=123" },}
-//     jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMock)
-//
-//     Hellotext.initialize(123)
-//   })
-//
-//   it("throws an error when event is invalid", () => {
-//     expect(
-//       () => Hellotext.removeEventListener("undefined-event", () => {})
-//     ).toThrowError()
-//   });
-//
-//   it("removes the callback from the subscribers and will not be notified again", () => {
-//     const callback = jest.fn()
-//
-//     Hellotext.on("session-set", callback)
-//     Hellotext.removeEventListener("session-set", callback)
-//
-//     expect(callback).toHaveBeenCalledTimes(0)
-//   });
-// })
-//
-// describe("when hello_preview query parameter is present", () => {
-//   beforeAll(() => {
-//     const windowMock = {location: { search: "?hello_preview" },}
-//     jest.spyOn(global, 'window', 'get').mockImplementation(() => windowMock)
-//
-//     expireSession()
-//     Hellotext.initialize(123)
-//   })
-//
-//   describe(".track", () => {
-//     it("returns a success response without interacting with the API", async () => {
-//       const response = await Hellotext.track("page.viewed")
-//       expect(response.succeeded).toEqual(true)
-//     });
-//   })
-// })

package/__tests__/models/business_test.js

@@ -1,26 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-
-
-import { Business } from '../../src/models'
-
-describe('enabledWhitelist', () => {
-  beforeEach(() => {
-    global.fetch = jest.fn().mockResolvedValue({ json: jest.fn().mockResolvedValue({}) })
-  })
-
-  it('is true when the whitelist is an array', () => {
-    const business = new Business('123')
-    business.data = { whitelist: ['www.example.com'] }
-
-    expect(business.enabledWhitelist).toEqual(true)
-  })
-
-  it('is false when the whitelist is a string', () => {
-    const business = new Business('123')
-    business.data = { whitelist: 'disabled' }
-
-    expect(business.enabledWhitelist).toEqual(false)
-  })
-})

package/__tests__/models/cookies_test.js

@@ -1,25 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-
-import { Cookies } from '../../src/models'
-
-beforeEach(() => {
-  document.cookie = ''
-})
-
-describe('set', () => {
-  it('sets the value of a cookie', () => {
-    expect(Cookies.get('hello_session')).toEqual(undefined)
-
-    Cookies.set('hello_session', 'session')
-    expect(Cookies.get('hello_session')).toEqual('session')
-  })
-})
-
-describe('get', () => {
-  it('gets the value of a cookie', () => {
-    document.cookie = 'hello_session=session'
-    expect(Cookies.get('hello_session')).toEqual('session')
-  })
-})