@coveo/relay 0.3.3 → 0.4.0

package/lib/relay.cjs

@@ -26,18 +26,6 @@ async function emit(params) {
     await callEventApi(params);
 }
 
-/**
- * @todo LENS-1059: The clientId should be a value that is persisted over time on a device.
- */
-function getClientId(environment) {
-    return environment.generateUUID();
-}
-function createClientIdManager(environment) {
-    return {
-        clientId: getClientId(environment),
-    };
-}
-
 const rnds8Pool = new Uint8Array(256); // # of random values to pre-allocate
 
 let poolPtr = rnds8Pool.length;
@@ -50,6 +38,12 @@ function rng() {
   return rnds8Pool.slice(poolPtr, poolPtr += 16);
 }
 
+var REGEX = /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000)$/i;
+
+function validate$1(uuid) {
+  return typeof uuid === 'string' && REGEX.test(uuid);
+}
+
 /**
  * Convert array of 16 byte values to UUID string format of the form:
  * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
@@ -95,6 +89,70 @@ function v4(options, buf, offset) {
   return unsafeStringify(rnds);
 }
 
+function getClientId(environment) {
+    const storage = environment.storage;
+    const key = "visitorId";
+    const existingClientId = storage.getItem(key);
+    const clientId = existingClientId && validate$1(existingClientId)
+        ? existingClientId
+        : environment.generateUUID();
+    storage.setItem(key, clientId);
+    return clientId;
+}
+function createClientIdManager(environment) {
+    return {
+        clientId: getClientId(environment),
+    };
+}
+
+const cookieManager = createCookieManager();
+function createCookieManager() {
+    const prefix = "coveo_";
+    const getDomain = (host) => {
+        const parts = host.split(".").slice(-2);
+        return parts.length == 2 ? parts.join(".") : "";
+    };
+    return {
+        getItem(key) {
+            const cookiePrefix = `${prefix}${key}=`;
+            const cookieArray = document.cookie.split(";");
+            for (const cookie of cookieArray) {
+                const prettifyCookie = cookie.replace(/^\s+/, "");
+                if (prettifyCookie.lastIndexOf(cookiePrefix, 0) === 0) {
+                    return prettifyCookie.substring(cookiePrefix.length, prettifyCookie.length);
+                }
+            }
+            return null;
+        },
+        setItem(key, data, expire) {
+            const domain = getDomain(window.location.hostname);
+            const expireSection = `;expires=${new Date(new Date().getTime() + expire).toUTCString()}`;
+            const domainSection = domain ? `;domain=${domain}` : "";
+            document.cookie = `${prefix}${key}=${data}${expireSection}${domainSection};path=/;SameSite=Lax`;
+        },
+        removeItem(key) {
+            this.setItem(key, "", -1);
+        },
+    };
+}
+
+function createBrowserStorage() {
+    return {
+        getItem(key) {
+            return cookieManager.getItem(key) || localStorage.getItem(key);
+        },
+        removeItem(key) {
+            cookieManager.removeItem(key);
+            localStorage.removeItem(key);
+        },
+        setItem(key, data) {
+            const oneYear = 31556952000;
+            localStorage.setItem(key, data);
+            cookieManager.setItem(key, data, oneYear);
+        },
+    };
+}
+
 function getReferrerUrl() {
     const referrer = document.referrer;
     return referrer === "" ? null : referrer;
@@ -107,6 +165,21 @@ function buildBrowserEnvironment() {
         getUrl: () => window.location.href,
         getUserAgent: () => navigator.userAgent,
         generateUUID: () => v4(),
+        storage: createBrowserStorage(),
+    };
+}
+
+function createNullStorage() {
+    return {
+        getItem() {
+            return null;
+        },
+        removeItem() {
+            return;
+        },
+        setItem() {
+            return;
+        },
     };
 }
 
@@ -118,6 +191,7 @@ function buildNodeEnvironment() {
         getUrl: () => null,
         getUserAgent: () => null,
         generateUUID: () => v4(),
+        storage: createNullStorage(),
     };
 }
 
@@ -133,7 +207,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.3.3" ;
+const version = "0.4.0" ;
 
 function getEventConfig(config) {
     const { trackingId } = config;

package/lib/relay.js

@@ -22,18 +22,6 @@ async function emit(params) {
     await callEventApi(params);
 }
 
-/**
- * @todo LENS-1059: The clientId should be a value that is persisted over time on a device.
- */
-function getClientId(environment) {
-    return environment.generateUUID();
-}
-function createClientIdManager(environment) {
-    return {
-        clientId: getClientId(environment),
-    };
-}
-
 // Unique ID creation requires a high quality random # generator. In the browser we therefore
 // require the crypto API and do not support built-in fallback to lower quality random number
 // generators (like Math.random()).
@@ -53,6 +41,12 @@ function rng() {
   return getRandomValues(rnds8);
 }
 
+var REGEX = /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000)$/i;
+
+function validate$1(uuid) {
+  return typeof uuid === 'string' && REGEX.test(uuid);
+}
+
 /**
  * Convert array of 16 byte values to UUID string format of the form:
  * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
@@ -99,6 +93,70 @@ function v4(options, buf, offset) {
   return unsafeStringify(rnds);
 }
 
+function getClientId(environment) {
+    const storage = environment.storage;
+    const key = "visitorId";
+    const existingClientId = storage.getItem(key);
+    const clientId = existingClientId && validate$1(existingClientId)
+        ? existingClientId
+        : environment.generateUUID();
+    storage.setItem(key, clientId);
+    return clientId;
+}
+function createClientIdManager(environment) {
+    return {
+        clientId: getClientId(environment),
+    };
+}
+
+const cookieManager = createCookieManager();
+function createCookieManager() {
+    const prefix = "coveo_";
+    const getDomain = (host) => {
+        const parts = host.split(".").slice(-2);
+        return parts.length == 2 ? parts.join(".") : "";
+    };
+    return {
+        getItem(key) {
+            const cookiePrefix = `${prefix}${key}=`;
+            const cookieArray = document.cookie.split(";");
+            for (const cookie of cookieArray) {
+                const prettifyCookie = cookie.replace(/^\s+/, "");
+                if (prettifyCookie.lastIndexOf(cookiePrefix, 0) === 0) {
+                    return prettifyCookie.substring(cookiePrefix.length, prettifyCookie.length);
+                }
+            }
+            return null;
+        },
+        setItem(key, data, expire) {
+            const domain = getDomain(window.location.hostname);
+            const expireSection = `;expires=${new Date(new Date().getTime() + expire).toUTCString()}`;
+            const domainSection = domain ? `;domain=${domain}` : "";
+            document.cookie = `${prefix}${key}=${data}${expireSection}${domainSection};path=/;SameSite=Lax`;
+        },
+        removeItem(key) {
+            this.setItem(key, "", -1);
+        },
+    };
+}
+
+function createBrowserStorage() {
+    return {
+        getItem(key) {
+            return cookieManager.getItem(key) || localStorage.getItem(key);
+        },
+        removeItem(key) {
+            cookieManager.removeItem(key);
+            localStorage.removeItem(key);
+        },
+        setItem(key, data) {
+            const oneYear = 31556952000;
+            localStorage.setItem(key, data);
+            cookieManager.setItem(key, data, oneYear);
+        },
+    };
+}
+
 function getReferrerUrl() {
     const referrer = document.referrer;
     return referrer === "" ? null : referrer;
@@ -111,6 +169,21 @@ function buildBrowserEnvironment() {
         getUrl: () => window.location.href,
         getUserAgent: () => navigator.userAgent,
         generateUUID: () => v4(),
+        storage: createBrowserStorage(),
+    };
+}
+
+function createNullStorage() {
+    return {
+        getItem() {
+            return null;
+        },
+        removeItem() {
+            return;
+        },
+        setItem() {
+            return;
+        },
     };
 }
 
@@ -122,6 +195,7 @@ function buildNodeEnvironment() {
         getUrl: () => null,
         getUserAgent: () => null,
         generateUUID: () => v4(),
+        storage: createNullStorage(),
     };
 }
 
@@ -137,7 +211,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.3.3" ;
+const version = "0.4.0" ;
 
 function getEventConfig(config) {
     const { trackingId } = config;

package/lib/relay.mjs

@@ -24,18 +24,6 @@ async function emit(params) {
     await callEventApi(params);
 }
 
-/**
- * @todo LENS-1059: The clientId should be a value that is persisted over time on a device.
- */
-function getClientId(environment) {
-    return environment.generateUUID();
-}
-function createClientIdManager(environment) {
-    return {
-        clientId: getClientId(environment),
-    };
-}
-
 const rnds8Pool = new Uint8Array(256); // # of random values to pre-allocate
 
 let poolPtr = rnds8Pool.length;
@@ -48,6 +36,12 @@ function rng() {
   return rnds8Pool.slice(poolPtr, poolPtr += 16);
 }
 
+var REGEX = /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000)$/i;
+
+function validate$1(uuid) {
+  return typeof uuid === 'string' && REGEX.test(uuid);
+}
+
 /**
  * Convert array of 16 byte values to UUID string format of the form:
  * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
@@ -93,6 +87,70 @@ function v4(options, buf, offset) {
   return unsafeStringify(rnds);
 }
 
+function getClientId(environment) {
+    const storage = environment.storage;
+    const key = "visitorId";
+    const existingClientId = storage.getItem(key);
+    const clientId = existingClientId && validate$1(existingClientId)
+        ? existingClientId
+        : environment.generateUUID();
+    storage.setItem(key, clientId);
+    return clientId;
+}
+function createClientIdManager(environment) {
+    return {
+        clientId: getClientId(environment),
+    };
+}
+
+const cookieManager = createCookieManager();
+function createCookieManager() {
+    const prefix = "coveo_";
+    const getDomain = (host) => {
+        const parts = host.split(".").slice(-2);
+        return parts.length == 2 ? parts.join(".") : "";
+    };
+    return {
+        getItem(key) {
+            const cookiePrefix = `${prefix}${key}=`;
+            const cookieArray = document.cookie.split(";");
+            for (const cookie of cookieArray) {
+                const prettifyCookie = cookie.replace(/^\s+/, "");
+                if (prettifyCookie.lastIndexOf(cookiePrefix, 0) === 0) {
+                    return prettifyCookie.substring(cookiePrefix.length, prettifyCookie.length);
+                }
+            }
+            return null;
+        },
+        setItem(key, data, expire) {
+            const domain = getDomain(window.location.hostname);
+            const expireSection = `;expires=${new Date(new Date().getTime() + expire).toUTCString()}`;
+            const domainSection = domain ? `;domain=${domain}` : "";
+            document.cookie = `${prefix}${key}=${data}${expireSection}${domainSection};path=/;SameSite=Lax`;
+        },
+        removeItem(key) {
+            this.setItem(key, "", -1);
+        },
+    };
+}
+
+function createBrowserStorage() {
+    return {
+        getItem(key) {
+            return cookieManager.getItem(key) || localStorage.getItem(key);
+        },
+        removeItem(key) {
+            cookieManager.removeItem(key);
+            localStorage.removeItem(key);
+        },
+        setItem(key, data) {
+            const oneYear = 31556952000;
+            localStorage.setItem(key, data);
+            cookieManager.setItem(key, data, oneYear);
+        },
+    };
+}
+
 function getReferrerUrl() {
     const referrer = document.referrer;
     return referrer === "" ? null : referrer;
@@ -105,6 +163,21 @@ function buildBrowserEnvironment() {
         getUrl: () => window.location.href,
         getUserAgent: () => navigator.userAgent,
         generateUUID: () => v4(),
+        storage: createBrowserStorage(),
+    };
+}
+
+function createNullStorage() {
+    return {
+        getItem() {
+            return null;
+        },
+        removeItem() {
+            return;
+        },
+        setItem() {
+            return;
+        },
     };
 }
 
@@ -116,6 +189,7 @@ function buildNodeEnvironment() {
         getUrl: () => null,
         getUserAgent: () => null,
         generateUUID: () => v4(),
+        storage: createNullStorage(),
     };
 }
 
@@ -131,7 +205,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.3.3" ;
+const version = "0.4.0" ;
 
 function getEventConfig(config) {
     const { trackingId } = config;

package/lib/types/client-id/client-id.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client-id.d.ts","sourceRoot":"","sources":["../../../src/client-id/client-id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAEzD,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;CAClB;AASD,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,WAAW,GACvB,eAAe,CAIjB"}
+{"version":3,"file":"client-id.d.ts","sourceRoot":"","sources":["../../../src/client-id/client-id.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAEzD,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAeD,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,WAAW,GACvB,eAAe,CAIjB"}

package/lib/types/environment/browser/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../src/environment/browser/browser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAQ7C,wBAAgB,uBAAuB,IAAI,WAAW,CASrD"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../src/environment/browser/browser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAS7C,wBAAgB,uBAAuB,IAAI,WAAW,CAUrD"}

package/lib/types/environment/browser/storage/cookie.d.ts

@@ -0,0 +1,7 @@
+export interface CookieManager {
+    getItem: (key: string) => string | null;
+    removeItem: (key: string) => void;
+    setItem: (key: string, data: string, expire: number) => void;
+}
+export declare const cookieManager: CookieManager;
+//# sourceMappingURL=cookie.d.ts.map

package/lib/types/environment/browser/storage/cookie.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cookie.d.ts","sourceRoot":"","sources":["../../../../../src/environment/browser/storage/cookie.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC;IACxC,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9D;AAED,eAAO,MAAM,aAAa,EAAE,aAAqC,CAAC"}

package/lib/types/environment/browser/storage/storage.d.ts

@@ -0,0 +1,3 @@
+import { Storage } from "../../storage";
+export declare function createBrowserStorage(): Storage;
+//# sourceMappingURL=storage.d.ts.map

package/lib/types/environment/browser/storage/storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../../../src/environment/browser/storage/storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAGxC,wBAAgB,oBAAoB,IAAI,OAAO,CAiB9C"}

package/lib/types/environment/environment.d.ts

@@ -1,3 +1,4 @@
+import { Storage } from "./storage";
 export interface Environment {
     runtime: "browser" | "node";
     fetch: (url: string, init?: RequestInit) => Promise<Response>;
@@ -5,6 +6,7 @@ export interface Environment {
     getUrl: () => string | null;
     getUserAgent: () => string | null;
     generateUUID: () => string;
+    storage: Storage;
 }
 export declare function currentEnvironment(): Environment;
 //# sourceMappingURL=environment.d.ts.map

package/lib/types/environment/environment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../src/environment/environment.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC;IAC5B,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9D,cAAc,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IACpC,MAAM,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IAClC,YAAY,EAAE,MAAM,MAAM,CAAC;CAC5B;AAED,wBAAgB,kBAAkB,IAAI,WAAW,CAEhD"}
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../src/environment/environment.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC;IAC5B,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9D,cAAc,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IACpC,MAAM,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IAClC,YAAY,EAAE,MAAM,MAAM,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,wBAAgB,kBAAkB,IAAI,WAAW,CAEhD"}

package/lib/types/environment/node/node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../../src/environment/node/node.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,wBAAgB,oBAAoB,IAAI,WAAW,CASlD"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../../src/environment/node/node.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,wBAAgB,oBAAoB,IAAI,WAAW,CAUlD"}

package/lib/types/environment/storage.d.ts

@@ -0,0 +1,7 @@
+export interface Storage {
+    getItem: (key: string) => string | null;
+    removeItem: (key: string) => void;
+    setItem: (key: string, data: string) => void;
+}
+export declare function createNullStorage(): Storage;
+//# sourceMappingURL=storage.d.ts.map

package/lib/types/environment/storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../src/environment/storage.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACtB,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC;IACxC,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9C;AAED,wBAAgB,iBAAiB,IAAI,OAAO,CAY3C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/relay",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "A library for sending analytics events using Coveo's Event protocol.",
   "files": [
     "lib/**/*"