@coveo/relay 0.7.2 → 0.7.3

package/README.md

@@ -0,0 +1,22 @@
+# @coveo/relay
+
+Relay is a compact library for emitting Event Protocol analytics events. It simplifies tracking relevant user interactions. This analytics data powers reports and helps train Coveo Machine Learning models.
+
+## Usage
+
+First, create an instance of Relay in your project. This instance can then be used to emit an event or perform other actions.
+
+```js
+import { createRelay } from "@coveo/relay";
+
+const config = {...};
+const relay = createRelay(config);
+
+const payload = {...};
+relay.emit('itemView', payload);
+```
+
+## Official documentation
+
+- [Learn more about Relay](https://docs.coveo.com/en/relay/latest/)
+- [List of Event API schemas and reference types](https://docs.coveo.com/en/n9da0377/build-a-search-ui/event-api-reference)

package/lib/cdn/relay.min.js

@@ -1,2 +1,2 @@
-var e=/^(?:[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 t(t){const n="visitorId";return{getClientId:()=>{const r=t.get(),o=r.storage,c=o.getItem(n),a=c&&("string"==typeof(s=c)&&e.test(s))?c:r.generateUUID();var s;return o.setItem(n,a),a},clear:()=>{t.get().storage.removeItem(n)}}}const n="0.7.2";function r(e){return(e.source||[]).concat([`relay@${n}`])}function o(e,t,n,o){const{getReferrer:c,getLocation:a,getUserAgent:s}=n,i=function(e){const{trackingId:t}=e;return{trackingId:t,user:null}}(t),u=o.getClientId();return Object.freeze({type:e,config:i,ts:Date.now(),source:r(t),clientId:u,userAgent:s(),referrer:c(),location:a()})}const c="*";function a(){const e=[];function t({type:t,callback:n}){return e.findIndex((e=>e.type===t&&e.callback===n))}function n(n,r){r?function(n){const r=t(n);r>=0&&e.splice(r,1)}({type:n,callback:r}):function(t){if(t===c)e.length=0;else for(let n=e.length-1;n>=0;n--)e[n].type===t&&e.splice(n,1)}(n)}return{add:function(r){return t(r)<0&&e.push(r),()=>n(r.type,r.callback)},call:function(t){e.forEach((e=>{if(function(e,t){return"*"===e.type||t===e.type}(e,t.meta.type))try{e.callback(t)}catch(e){console.error(e)}}))},remove:n}}function s({url:e,token:t,trackingId:n,...r}){return Object.freeze({url:e,token:t,trackingId:n,...!!r.mode&&{mode:r.mode},...!!r.source&&{source:r.source}})}const i=function(){const e="coveo_";return{getItem(t){const n=`${e}${t}=`,r=document.cookie.split(";");for(const e of r){const t=e.replace(/^\s+/,"");if(0===t.lastIndexOf(n,0))return t.substring(n.length,t.length)}return null},setItem(t,n,r){const o=(e=>{const t=e.split(".").slice(-2);return 2==t.length?t.join("."):""})(window.location.hostname),c=`;expires=${new Date((new Date).getTime()+r).toUTCString()}`,a=o?`;domain=${o}`:"";document.cookie=`${e}${t}=${n}${c}${a};path=/;SameSite=Lax`},removeItem(e){this.setItem(e,"",-1)}}}();function u(){return{runtime:"browser",send:(e,t,n)=>{const r=navigator.sendBeacon(`${e}?access_token=${t}`,new Blob([JSON.stringify([n])],{type:"application/json"})),o=function(){const e="undefined"!=typeof window;return{sendMessage(t){e&&window.postMessage(t,"*")}}}();if(o.sendMessage({kind:"EVENT_PROTOCOL",event:n,url:e,token:t}),!r)throw new Error("Failed to send the event(s) because the payload size exceeded the maximum allowed size (32 KB). Please contact support if the problem persists.")},getReferrer:()=>function(){const e=document.referrer;return""===e?null:e}(),getLocation:()=>window.location.href,getUserAgent:()=>navigator.userAgent,generateUUID:()=>crypto.randomUUID(),storage:{getItem:e=>i.getItem(e)||localStorage.getItem(e),removeItem(e){i.removeItem(e),localStorage.removeItem(e)},setItem(e,t){localStorage.setItem(e,t),i.setItem(e,t,31556952e3)}}}}function l(e){return"disabled"!==e.get().mode&&function(){try{return"object"==typeof window}catch(e){return!1}}()?u():{runtime:"null",send:()=>{},getReferrer:()=>null,getLocation:()=>null,getUserAgent:()=>null,generateUUID:()=>"",storage:{getItem:()=>null,removeItem(){},setItem(){}}}}function g(e){const r=function(e){let t=s(e);return{get:()=>t,update:e=>{t=s({...t,...e})}}}(e),c=a(),i=function(e){return{get:()=>Object.freeze(l(e))}}(r),u=t(i);return{emit:(e,t)=>{const n=r.get(),a=i.get(),s=function(e,t,n,r,c){return{...t,meta:o(e,n,r,c)}}(e,t,n,a,u);return function({config:e,environment:t,event:n,listenerManager:r}){const{url:o,token:c,mode:a}=e;"disabled"!==a&&(r.call(n),t.send(o,c,n))}({config:n,environment:a,event:s,listenerManager:c})},getMeta:e=>o(e,r.get(),i.get(),u),on:(e,t)=>c.add({type:e,callback:t}),off:(e,t)=>c.remove(e,t),updateConfig:e=>r.update(e),version:n,clearStorage:()=>{u.clear()}}}export{g as createRelay};
+var e=/^(?:[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 t(t){const n="visitorId";return{getClientId:()=>{const r=t.get(),o=r.storage,c=o.getItem(n),a=c&&("string"==typeof(s=c)&&e.test(s))?c:r.generateUUID();var s;return o.setItem(n,a),a},clear:()=>{t.get().storage.removeItem(n)}}}const n="0.7.3";function r(e){return(e.source||[]).concat([`relay@${n}`])}function o(e,t,n,o){const{getReferrer:c,getLocation:a,getUserAgent:s}=n,i=function(e){const{trackingId:t}=e;return{trackingId:t,user:null}}(t),u=o.getClientId();return Object.freeze({type:e,config:i,ts:Date.now(),source:r(t),clientId:u,userAgent:s(),referrer:c(),location:a()})}const c="*";function a(){const e=[];function t({type:t,callback:n}){return e.findIndex((e=>e.type===t&&e.callback===n))}function n(n,r){r?function(n){const r=t(n);r>=0&&e.splice(r,1)}({type:n,callback:r}):function(t){if(t===c)e.length=0;else for(let n=e.length-1;n>=0;n--)e[n].type===t&&e.splice(n,1)}(n)}return{add:function(r){return t(r)<0&&e.push(r),()=>n(r.type,r.callback)},call:function(t){e.forEach((e=>{if(function(e,t){return"*"===e.type||t===e.type}(e,t.meta.type))try{e.callback(t)}catch(e){console.error(e)}}))},remove:n}}function s({url:e,token:t,trackingId:n,...r}){return Object.freeze({url:e,token:t,trackingId:n,...!!r.mode&&{mode:r.mode},...!!r.source&&{source:r.source}})}const i=function(){const e="coveo_";return{getItem(t){const n=`${e}${t}=`,r=document.cookie.split(";");for(const e of r){const t=e.replace(/^\s+/,"");if(0===t.lastIndexOf(n,0))return t.substring(n.length,t.length)}return null},setItem(t,n,r){const o=(e=>{const t=e.split(".").slice(-2);return 2==t.length?t.join("."):""})(window.location.hostname),c=`;expires=${new Date((new Date).getTime()+r).toUTCString()}`,a=o?`;domain=${o}`:"";document.cookie=`${e}${t}=${n}${c}${a};path=/;SameSite=Lax`},removeItem(e){this.setItem(e,"",-1)}}}();function u(){return{runtime:"browser",send:(e,t,n)=>{const r=navigator.sendBeacon(`${e}?access_token=${t}`,new Blob([JSON.stringify([n])],{type:"application/json"})),o=function(){const e="undefined"!=typeof window;return{sendMessage(t){e&&window.postMessage(t,"*")}}}();if(o.sendMessage({kind:"EVENT_PROTOCOL",event:n,url:e,token:t}),!r)throw new Error("Failed to send the event(s) because the payload size exceeded the maximum allowed size (32 KB). Please contact support if the problem persists.")},getReferrer:()=>function(){const e=document.referrer;return""===e?null:e}(),getLocation:()=>window.location.href,getUserAgent:()=>navigator.userAgent,generateUUID:()=>crypto.randomUUID(),storage:{getItem:e=>i.getItem(e)||localStorage.getItem(e),removeItem(e){i.removeItem(e),localStorage.removeItem(e)},setItem(e,t){localStorage.setItem(e,t),i.setItem(e,t,31556952e3)}}}}function l(e){return"disabled"!==e.get().mode&&function(){try{return"object"==typeof window}catch(e){return!1}}()?u():{runtime:"null",send:()=>{},getReferrer:()=>null,getLocation:()=>null,getUserAgent:()=>null,generateUUID:()=>"",storage:{getItem:()=>null,removeItem(){},setItem(){}}}}function g(e){const r=function(e){let t=s(e);return{get:()=>t,update:e=>{t=s({...t,...e})}}}(e),c=a(),i=function(e){return{get:()=>Object.freeze(l(e))}}(r),u=t(i);return{emit:(e,t)=>{const n=r.get(),a=i.get(),s=function(e,t,n,r,c){return{...t,meta:o(e,n,r,c)}}(e,t,n,a,u);return function({config:e,environment:t,event:n,listenerManager:r}){const{url:o,token:c,mode:a}=e;"disabled"!==a&&(r.call(n),t.send(o,c,n))}({config:n,environment:a,event:s,listenerManager:c})},getMeta:e=>o(e,r.get(),i.get(),u),on:(e,t)=>c.add({type:e,callback:t}),off:(e,t)=>c.remove(e,t),updateConfig:e=>r.update(e),version:n,clearStorage:()=>{u.clear()}}}export{g as createRelay};
 //# sourceMappingURL=relay.min.js.map

package/lib/docs/relay-docs.json

@@ -47,7 +47,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 13,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L13"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L13"
 						}
 					],
 					"type": {
@@ -74,7 +74,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 18,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L18"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L18"
 						}
 					],
 					"type": {
@@ -111,7 +111,7 @@
 					"fileName": "event/meta/meta.ts",
 					"line": 9,
 					"character": 17,
-					"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L9"
+					"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L9"
 				}
 			]
 		},
@@ -157,7 +157,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 48,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L48"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L48"
 						}
 					],
 					"type": {
@@ -184,7 +184,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 33,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L33"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L33"
 						}
 					],
 					"type": {
@@ -213,7 +213,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 63,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L63"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L63"
 						}
 					],
 					"type": {
@@ -249,7 +249,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 58,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L58"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L58"
 						}
 					],
 					"type": {
@@ -285,7 +285,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 43,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L43"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L43"
 						}
 					],
 					"type": {
@@ -315,7 +315,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 38,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L38"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L38"
 						}
 					],
 					"type": {
@@ -342,7 +342,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 28,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L28"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L28"
 						}
 					],
 					"type": {
@@ -369,7 +369,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 53,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L53"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L53"
 						}
 					],
 					"type": {
@@ -407,7 +407,7 @@
 					"fileName": "event/meta/meta.ts",
 					"line": 24,
 					"character": 17,
-					"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/event/meta/meta.ts#L24"
+					"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/event/meta/meta.ts#L24"
 				}
 			]
 		},
@@ -437,7 +437,7 @@
 							"fileName": "relay.ts",
 							"line": 68,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L68"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L68"
 						}
 					],
 					"type": {
@@ -453,7 +453,7 @@
 									"fileName": "relay.ts",
 									"line": 68,
 									"character": 16,
-									"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L68"
+									"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L68"
 								}
 							],
 							"signatures": [
@@ -482,7 +482,7 @@
 											"fileName": "relay.ts",
 											"line": 68,
 											"character": 16,
-											"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L68"
+											"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L68"
 										}
 									],
 									"type": {
@@ -505,7 +505,7 @@
 							"fileName": "relay.ts",
 							"line": 23,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L23"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L23"
 						}
 					],
 					"type": {
@@ -521,7 +521,7 @@
 									"fileName": "relay.ts",
 									"line": 23,
 									"character": 8,
-									"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L23"
+									"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L23"
 								}
 							],
 							"signatures": [
@@ -550,7 +550,7 @@
 											"fileName": "relay.ts",
 											"line": 23,
 											"character": 8,
-											"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L23"
+											"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L23"
 										}
 									],
 									"parameters": [
@@ -628,7 +628,7 @@
 							"fileName": "relay.ts",
 							"line": 30,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L30"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L30"
 						}
 					],
 					"type": {
@@ -644,7 +644,7 @@
 									"fileName": "relay.ts",
 									"line": 30,
 									"character": 11,
-									"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L30"
+									"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L30"
 								}
 							],
 							"signatures": [
@@ -673,7 +673,7 @@
 											"fileName": "relay.ts",
 											"line": 30,
 											"character": 11,
-											"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L30"
+											"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L30"
 										}
 									],
 									"parameters": [
@@ -719,7 +719,7 @@
 							"fileName": "relay.ts",
 							"line": 50,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L50"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L50"
 						}
 					],
 					"type": {
@@ -735,7 +735,7 @@
 									"fileName": "relay.ts",
 									"line": 50,
 									"character": 7,
-									"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L50"
+									"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L50"
 								}
 							],
 							"signatures": [
@@ -764,7 +764,7 @@
 											"fileName": "relay.ts",
 											"line": 50,
 											"character": 7,
-											"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L50"
+											"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L50"
 										}
 									],
 									"parameters": [
@@ -831,7 +831,7 @@
 							"fileName": "relay.ts",
 							"line": 41,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L41"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L41"
 						}
 					],
 					"type": {
@@ -847,7 +847,7 @@
 									"fileName": "relay.ts",
 									"line": 41,
 									"character": 6,
-									"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L41"
+									"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L41"
 								}
 							],
 							"signatures": [
@@ -876,7 +876,7 @@
 											"fileName": "relay.ts",
 											"line": 41,
 											"character": 6,
-											"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L41"
+											"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L41"
 										}
 									],
 									"parameters": [
@@ -938,7 +938,7 @@
 							"fileName": "relay.ts",
 							"line": 57,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L57"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L57"
 						}
 					],
 					"type": {
@@ -954,7 +954,7 @@
 									"fileName": "relay.ts",
 									"line": 57,
 									"character": 16,
-									"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L57"
+									"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L57"
 								}
 							],
 							"signatures": [
@@ -983,7 +983,7 @@
 											"fileName": "relay.ts",
 											"line": 57,
 											"character": 16,
-											"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L57"
+											"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L57"
 										}
 									],
 									"parameters": [
@@ -1048,7 +1048,7 @@
 							"fileName": "relay.ts",
 							"line": 62,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L62"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L62"
 						}
 					],
 					"type": {
@@ -1076,7 +1076,7 @@
 					"fileName": "relay.ts",
 					"line": 16,
 					"character": 10,
-					"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L16"
+					"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L16"
 				}
 			]
 		},
@@ -1135,7 +1135,7 @@
 							"fileName": "config/config.ts",
 							"line": 28,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/config/config.ts#L28"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/config/config.ts#L28"
 						}
 					],
 					"type": {
@@ -1169,7 +1169,7 @@
 							"fileName": "config/config.ts",
 							"line": 35,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/config/config.ts#L35"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/config/config.ts#L35"
 						}
 					],
 					"type": {
@@ -1199,7 +1199,7 @@
 							"fileName": "config/config.ts",
 							"line": 15,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/config/config.ts#L15"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/config/config.ts#L15"
 						}
 					],
 					"type": {
@@ -1226,7 +1226,7 @@
 							"fileName": "config/config.ts",
 							"line": 20,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/config/config.ts#L20"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/config/config.ts#L20"
 						}
 					],
 					"type": {
@@ -1253,7 +1253,7 @@
 							"fileName": "config/config.ts",
 							"line": 10,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/config/config.ts#L10"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/config/config.ts#L10"
 						}
 					],
 					"type": {
@@ -1279,7 +1279,7 @@
 					"fileName": "config/config.ts",
 					"line": 6,
 					"character": 17,
-					"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/config/config.ts#L6"
+					"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/config/config.ts#L6"
 				}
 			]
 		},
@@ -1294,7 +1294,7 @@
 					"fileName": "listener/listener.ts",
 					"line": 11,
 					"character": 12,
-					"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/listener/listener.ts#L11"
+					"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/listener/listener.ts#L11"
 				}
 			],
 			"type": {
@@ -1310,7 +1310,7 @@
 							"fileName": "listener/listener.ts",
 							"line": 11,
 							"character": 28,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/listener/listener.ts#L11"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/listener/listener.ts#L11"
 						}
 					],
 					"signatures": [
@@ -1372,7 +1372,7 @@
 					"fileName": "relay.ts",
 					"line": 76,
 					"character": 16,
-					"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L76"
+					"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L76"
 				}
 			],
 			"signatures": [
@@ -1401,7 +1401,7 @@
 							"fileName": "relay.ts",
 							"line": 76,
 							"character": 16,
-							"url": "https://github.com/coveo/relay/blob/d9c8da6/packages/relay/src/relay.ts#L76"
+							"url": "https://github.com/coveo/relay/blob/05ba89b/packages/relay/src/relay.ts#L76"
 						}
 					],
 					"parameters": [
@@ -1453,51 +1453,19 @@
 		}
 	],
 	"packageName": "@coveo/relay",
-	"packageVersion": "0.7.2",
+	"packageVersion": "0.7.3",
 	"readme": [
 		{
 			"kind": "text",
-			"text": "# Relay\n\nThe Relay repository contains a client-side library and set of related tools for sending events from the browser using Coveo's Event protocol. It consists of multiple components:\n\n- The core relay library in "
+			"text": "# @coveo/relay\n\nRelay is a compact library for emitting Event Protocol analytics events. It simplifies tracking relevant user interactions. This analytics data powers reports and helps train Coveo Machine Learning models.\n\n## Usage\n\nFirst, create an instance of Relay in your project. This instance can then be used to emit an event or perform other actions.\n\n"
 		},
 		{
 			"kind": "code",
-			"text": "`packages/relay`"
+			"text": "```js\nimport { createRelay } from \"@coveo/relay\";\n\nconst config = {...};\nconst relay = createRelay(config);\n\nconst payload = {...};\nrelay.emit('itemView', payload);\n```"
 		},
 		{
 			"kind": "text",
-			"text": ": Relay is an event agnostic library which is responsible for enriching, packaging and sending browser event streams into Coveo's backend.\n- The relay playground in "
-		},
-		{
-			"kind": "code",
-			"text": "`apps/playground`"
-		},
-		{
-			"kind": "text",
-			"text": ": The playground is a sample webpage that can be used to experiment with and validate Event Protocol payloads.\n\nRelay can be used standalone, or be embedded in Coveo front end packages as the main client-side logging component.\n\n## Relay design principles and scope\n\nThe core relay library should adhere to a few core design principles:\n\n- Relay is responsible for handling any concerns that are relevant to generic event logging, including but not limited to:\n  - Enriching events with information that is only present in the browser (e.g. userAgent, local time).\n  - Tracking and persisting a unique identifier for a user (e.g. clientId)\n  - Configuration of, and authentication with logging endpoints.\n  - Privacy considerations (e.g. do not track, disable logging).\n- Relay is event-agnostic, meaning Relay has no knowledge on the contents of specific type of event payload that is being transmitted. It only handles event content, when that content is applicable to all logged events. In practice this means the following:\n  - Relay event modification code is typically confined to the generic 'meta' key only.\n  - Relay will not validate or modify event payloads, since it has no knowledge of the content of individual events.\n  - Code should **not** contain event-type specific switches: e.g. "
-		},
-		{
-			"kind": "code",
-			"text": "`if (event_type = <sometype>) then`"
-		},
-		{
-			"kind": "text",
-			"text": " code is highly suspect.\n  - Code should **not** contain line of business specific switches: e.g. "
-		},
-		{
-			"kind": "code",
-			"text": "`if (lob = service) then`"
-		},
-		{
-			"kind": "text",
-			"text": " code is highly suspect.\n- While Relay provides hooks which can be used to listen to the emission of events, it will not allow you to modify event content prior to logging. In practice, this functionality will be abused to \"fix up\" payloads or add \"business logic\" which makes it really hard to reason about payloads.\n- Relay supports all relevant Javascript based environments, including cross-browser support, node support and React native support.\n- Relay is **not** responsible for storing the TypeScript definitions of individual event types. Please use the [@coveo/relay-event-types](https://www.npmjs.com/package/@coveo/relay-event-types) package instead.\n\n## Event structure\n\nThe basic event structure for a generic client side event is as follows:\n\n"
-		},
-		{
-			"kind": "code",
-			"text": "```\n{\n  <event parameters>\n  meta: {\n    type: the event type\n    <dynamic meta data added by relay>\n    config: {\n      <subset of static relay config parameters>\n    }\n   }\n}\n```"
-		},
-		{
-			"kind": "text",
-			"text": "\n\nThis means an event payload can be freely defined, with the exception of the reserved keyword 'meta', which is exclusively intended to contain event metadata populated by Relay. Prior to logging events with the Coveo platform, ensure that you create appropriate event schemas in the [schema repository](https://github.com/coveo/analytics_schema).\n\nIf you want to log information from a Coveo owned backend service, do not use Relay. Instead, log them on the appropriate server side endpoint, see [this guide](https://coveord.atlassian.net/wiki/spaces/DATA/pages/3175383082/Server+side+event+logging)\n\n## Contributing\n\nPrior to contributing to the project, kindly review the guidelines outlined in [CONTRIBUTING.md](CONTRIBUTING.md)."
+			"text": "\n\n## Official documentation\n\n- [Learn more about Relay](https://docs.coveo.com/en/relay/latest/)\n- [List of Event API schemas and reference types](https://docs.coveo.com/en/n9da0377/build-a-search-ui/event-api-reference)"
 		}
 	],
 	"symbolIdMap": {

package/lib/relay.cjs

@@ -34,7 +34,7 @@ function createClientIdManager(environmentManager) {
     };
 }
 
-const version = "0.7.2";
+const version = "0.7.3";
 
 function getEventConfig(config) {
     const { trackingId } = config;

package/lib/relay.js

@@ -32,7 +32,7 @@ function createClientIdManager(environmentManager) {
     };
 }
 
-const version = "0.7.2";
+const version = "0.7.3";
 
 function getEventConfig(config) {
     const { trackingId } = config;

package/lib/relay.mjs

@@ -32,7 +32,7 @@ function createClientIdManager(environmentManager) {
     };
 }
 
-const version = "0.7.2";
+const version = "0.7.3";
 
 function getEventConfig(config) {
     const { trackingId } = config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/relay",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "A library for sending analytics events using Coveo's Event protocol.",
   "files": [
     "lib/**/*"
@@ -29,7 +29,8 @@
   "keywords": [
     "Coveo",
     "analytics",
-    "event"
+    "event",
+    "Event Protocol"
   ],
   "author": "Coveo",
   "license": "Apache-2.0",
@@ -53,8 +54,8 @@
     "ts-jest": "^29.1.1",
     "typedoc": "^0.25.3",
     "typescript": "^5.1.6",
-    "tsconfig": "0.0.0",
-    "eslint-config-custom": "0.0.0"
+    "eslint-config-custom": "0.0.0",
+    "tsconfig": "0.0.0"
   },
   "dependencies": {
     "@coveo/explorer-messenger": "^0.1.1",