@hellotext/hellotext 1.3.4 → 1.4.0

package/README.md

@@ -212,7 +212,7 @@ Hellotext.removeEventListener(eventName, callback)
 
 ## Understanding Sessions
 
-The library looks for a session identifier present on the `hellotext_session` query parameter. If the session is not present as a cookie neither it will create a new random session identifier. 
+The library looks for a session identifier present on the `hellotext_session` query parameter. If the session is not present as a cookie neither it will create a new random session identifier, you can disable this default behaviour via the configuration, see [Configuration Options](#configuration-options) for more information. 
 The session is automatically sent to Hellotext any time the `Hellotext.track` method is called. 
 
 Short links redirections attaches a session identifier to the destination url as `hellotext_session` query parameter. This will identify all the events back to the customer who opened the link.
@@ -246,3 +246,17 @@ Hellotext.on("session-set", (session) => {
 ```
 
 You may want to store the session on your backend when customers are unidentified so you can later [attach it to a profile](https://www.hellotext.com/api#attach_session) when it becomes known.
+
+### Configuration 
+
+When initializing the library, you may pass an optional configuration object as the second argument. 
+
+```javascript
+Hellotext.initialize("HELLOTEXT_BUSINESS_ID", configurationOptions);
+```
+
+#### Configuration Options
+
+| Property            | Description                                                                                                      | Type    | Default |
+|---------------------|------------------------------------------------------------------------------------------------------------------|---------| --- |
+| autogenerateSession | Whether the library should automatically generate a session when no session is found in the query or the cookies | Boolean | true

package/__tests__/hellotext_test.js

@@ -91,6 +91,15 @@ describe("when the class is initialized successfully", () => {
         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)
+    })
   });
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hellotext/hellotext",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "description": "Hellotext JavaScript Client",
   "source": "src/index.js",
   "main": "lib/index.js",

package/src/hellotext.js

@@ -6,20 +6,29 @@ import Query from "./query";
 import { NotInitializedError } from './errors/notInitializedError'
 import { InvalidEvent } from "./errors/invalidEvent"
 
+/**
+ * @typedef {Object} Config
+ * @property {Boolean} autogenerateSession
+ */
+
+
 class Hellotext {
   static __apiURL = 'https://api.hellotext.com/v1/'
 
   static #session
   static #business
+  static #config
   static #eventEmitter = new EventEmitter()
   static #query
 
   /**
    * initialize the module.
    * @param business public business id
+   * @param { Config } config
    */
-  static initialize(business) {
+  static initialize(business, config = { autogenerateSession: true }) {
     this.#business = business
+    this.#config = config
 
     this.#query = new Query(window.location.search)
 
@@ -30,7 +39,7 @@ class Hellotext {
     if (session && session !== "undefined" && session !== "null") {
       this.#session = session
       this.#setSessionCookie()
-    } else {
+    } else if(config.autogenerateSession) {
       this.#mintAnonymousSession()
         .then(response => {
           this.#session = response.id