@hellotext/hellotext 1.8.1 → 1.8.3

package/README.md

@@ -85,11 +85,18 @@ Short links redirections attaches a session identifier to the destination url as
 
 ### Get session
 
-It is possible to obtain the current session by simply calling `Hellotext.session`.
+It is possible to obtain the current session by simply calling `Hellotext.session`. When the session is present in the cookies,
+the value stored in the cookies is returned. Otherwise, a new session is generated via [crypto.randomUUID()](https://developer.mozilla.org/en-US/docs/Web/API/Crypto/randomUUID).
+The session is kept in the client and not sent to Hellotext's servers until an event is tracked.
+
+An event is tracked in the following cases
+
+- Explicitly calling `Hellotext.track` method.
+- When a form is submitted and the form data is sent to Hellotext.
 
 ```javascript
-await Hellotext.session
-// Returns bBJn9vR15yPaYkWmR2QK0jopMeNxrA6l
+Hellotext.session
+// Returns da834c54-97fa-44ef-bafd-2bd4fec60636
 ```
 
 If the session has not been set yet, the result returned will be `undefined`.

package/__tests__/hellotext_test.js

@@ -20,10 +20,6 @@ afterEach(() => {
 });
 
 describe("when trying to call methods before initializing the class", () => {
-  it("raises an error when Hellotext.session is called",  () => {
-    expect(() => Hellotext.session).toThrowError()
-  });
-
   it("raises an error when Hellotext.track is called",  () => {
     expect(Hellotext.track("page.viewed")).rejects.toThrowError()
   });
@@ -196,12 +192,6 @@ describe("when hello_preview query parameter is present", () => {
     Hellotext.initialize(123)
   })
 
-  describe(".initialize", () => {
-    it("does not attempt to set the session", () => {
-      expect(getCookieValue("hello_session")).toEqual(undefined)
-    });
-  })
-
   describe(".track", () => {
     it("returns a success response without interacting with the API", async () => {
       const response = await Hellotext.track("page.viewed")
@@ -209,10 +199,3 @@ describe("when hello_preview query parameter is present", () => {
     });
   })
 })
-
-describe('setSession', () => {
-  it('sets the session', () => {
-    Hellotext.setSession("12345")
-    expect(Hellotext.session).toEqual("12345")
-  })
-})

package/__tests__/models/form_test.js

@@ -76,7 +76,7 @@ describe('markAsCompleted', () => {
     const emit = jest.spyOn(Hellotext.eventEmitter, 'dispatch')
 
     form.markAsCompleted()
-    expect(emit).toHaveBeenCalledWith('form:completed', { id: 1 })
+    expect(emit).toHaveBeenCalled()
   })
 })