@coveo/relay 0.7.4 → 0.7.5

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.4";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),s=c&&("string"==typeof(a=c)&&e.test(a))?c:r.generateUUID();var a;return o.setItem(n,s),s},clear:()=>{t.get().storage.removeItem(n)}}}const n="0.7.5";function r(e){return(e.source||[]).concat([`relay@${n}`])}function o(e,t,n,o){const{getReferrer:c,getLocation:s,getUserAgent:a}=n,i=function(e){const{trackingId:t,user:n}=e;return{trackingId:t,user:n||{id:null}}}(t),u=o.getClientId();return Object.freeze({type:e,config:i,ts:Date.now(),source:r(t),clientId:u,userAgent:a(),referrer:c(),location:s()})}const c="*";function s(){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 a({url:e,token:t,trackingId:n,...r}){return Object.freeze({url:e,token:t,trackingId:n,...!!r.user&&{user:r.user},...!!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()}`,s=o?`;domain=${o}`:"";document.cookie=`${e}${t}=${n}${c}${s};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=a(e);return{get:()=>t,update:e=>{t=a({...t,...e})}}}(e),c=s(),i=function(e){return{get:()=>Object.freeze(l(e))}}(r),u=t(i);return{emit:(e,t)=>{const n=r.get(),s=i.get(),a=function(e,t,n,r,c){return{...t,meta:o(e,n,r,c)}}(e,t,n,s,u);return function({config:e,environment:t,event:n,listenerManager:r}){const{url:o,token:c,mode:s}=e;"disabled"!==s&&(r.call(n),t.send(o,c,n))}({config:n,environment:s,event:a,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/cdn/relay.min.js.map

@@ -1 +1 @@
-{"version":3,"file":"relay.min.js","sources":["../../../../node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/esm-browser/regex.js","../../src/client-id/client-id.ts","../../../../node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/esm-browser/validate.js","../../src/version.ts","../../src/event/meta/meta.ts","../../src/listener/listener.ts","../../src/config/config.ts","../../src/environment/browser/storage/cookie.ts","../../src/environment/browser/browser.ts","../../../../node_modules/.pnpm/@coveo+explorer-messenger@0.1.1/node_modules/@coveo/explorer-messenger/dist/messenger.js","../../src/environment/browser/storage/storage.ts","../../src/environment/manager/manager.ts","../../src/environment/null/null.ts","../../src/environment/storage.ts","../../src/relay.ts","../../src/event/relay-event.ts","../../src/emit/emit.ts"],"sourcesContent":["export default /^(?:[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;","import { validate } from \"uuid\";\nimport { EnvironmentManager } from \"../environment/manager/manager\";\n\nexport interface ClientIdManager {\n  getClientId: () => string;\n  clear: () => void;\n}\n\nexport function createClientIdManager(\n  environmentManager: EnvironmentManager\n): ClientIdManager {\n  const key = \"visitorId\";\n\n  return {\n    getClientId: () => {\n      const environment = environmentManager.get();\n      const storage = environment.storage;\n\n      const existingClientId = storage.getItem(key);\n      const clientId =\n        existingClientId && validate(existingClientId)\n          ? existingClientId\n          : environment.generateUUID();\n      storage.setItem(key, clientId);\n      return clientId;\n    },\n    clear: () => {\n      environmentManager.get().storage.removeItem(key);\n    },\n  };\n}\n","import REGEX from './regex.js';\n\nfunction validate(uuid) {\n  return typeof uuid === 'string' && REGEX.test(uuid);\n}\n\nexport default validate;","export const version = \"process.env.VERSION\";\n","import { ClientIdManager } from \"../../client-id/client-id\";\nimport { Environment } from \"../../environment/environment\";\nimport { RelayConfig, User } from \"../../config/config\";\nimport { version } from \"../../version\";\n\n/**\n * The `EventConfig` object provides additonal information for the configuration associated with the event.\n */\nexport interface EventConfig {\n  /**\n   * The unique identifier of a web property. See [Tracking ID](https://docs.coveo.com/en/n8tg0567/).\n   */\n  trackingId: string;\n\n  /**\n   * Named user identity which logged this event.\n   */\n  user: User | null;\n}\n\n/**\n * The `Meta` object provides a structured representation of metadata associated with an emitted event.\n * This object is auto-populated by Relay.\n */\nexport interface Meta {\n  /**\n   * Event's type that was emitted.\n   */\n  type: string;\n\n  /**\n   * Configuration associated with the event.\n   */\n  config: EventConfig;\n\n  /**\n   * Timestamp when the event was emitted.\n   */\n  ts: number;\n\n  /**\n   * Names and versions of the client side libraries which built and emitted this event.\n   */\n  source: string[];\n\n  /**\n   * Persistent unique identifier of a device.\n   */\n  clientId: string;\n\n  /**\n   * Browser Navigator's [user agent](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/userAgent) property if set.\n   */\n  userAgent: string | null;\n\n  /**\n   * Browser Document's [referrer](https://developer.mozilla.org/en-US/docs/Web/API/Document/referrer) property if set.\n   */\n  referrer: string | null;\n\n  /**\n   * Browser Location's [href](https://developer.mozilla.org/en-US/docs/Web/API/Location/href) property if set.\n   */\n  location: string | null;\n}\n\nfunction getEventConfig(config: RelayConfig): EventConfig {\n  const { trackingId } = config;\n  return { trackingId, user: null };\n}\n\nfunction getSource(config: RelayConfig): string[] {\n  return (config.source || []).concat([`relay@${version}`]);\n}\n\nexport function createMeta(\n  type: string,\n  config: RelayConfig,\n  environment: Environment,\n  clientIdManager: ClientIdManager\n): Readonly<Meta> {\n  const { getReferrer, getLocation, getUserAgent } = environment;\n  const eventConfig = getEventConfig(config);\n  const clientId = clientIdManager.getClientId();\n\n  return Object.freeze<Meta>({\n    type,\n    config: eventConfig,\n    ts: Date.now(),\n    source: getSource(config),\n    clientId,\n    userAgent: getUserAgent(),\n    referrer: getReferrer(),\n    location: getLocation(),\n  });\n}\n","import { RelayEvent } from \"../event/relay-event\";\n\nconst ANY_EVENT_TYPE = \"*\";\n\n/**\n * Callback to perform an action when a specified event is emitted.\n * @typedef {function} EventCallback\n * @param {RelayEvent} event - the Relay event payload that triggered the callback.\n * @returns {void}\n */\nexport type EventCallback = (event: RelayEvent) => void;\n\ninterface Listener {\n  type: string;\n  callback: EventCallback;\n}\n\nexport interface ListenerManager {\n  add: (listener: Listener) => () => void;\n  call: (event: RelayEvent) => void;\n  remove: (type: string, callback?: EventCallback) => void;\n}\n\nexport function createListenerManager(): ListenerManager {\n  const listeners: Listener[] = [];\n\n  function getListenerIndex({ type, callback }: Listener): number {\n    return listeners.findIndex(\n      (listener) => listener.type === type && listener.callback === callback\n    );\n  }\n\n  function isMatchesType(listener: Listener, type: string): boolean {\n    return listener.type === \"*\" || type === listener.type;\n  }\n\n  function add(listener: Listener): () => void {\n    if (getListenerIndex(listener) < 0) {\n      listeners.push(listener);\n    }\n    return () => remove(listener.type, listener.callback);\n  }\n\n  function call(event: RelayEvent) {\n    listeners.forEach((listener) => {\n      if (isMatchesType(listener, event.meta.type)) {\n        try {\n          listener.callback(event);\n        } catch (e) {\n          console.error(e);\n        }\n      }\n    });\n  }\n\n  function removeMultiple(type: string) {\n    if (type === ANY_EVENT_TYPE) {\n      listeners.length = 0;\n    } else {\n      for (let i = listeners.length - 1; i >= 0; i--) {\n        if (listeners[i].type === type) {\n          listeners.splice(i, 1);\n        }\n      }\n    }\n  }\n\n  function removeOne(listener: Listener) {\n    const index = getListenerIndex(listener);\n    if (index >= 0) {\n      listeners.splice(index, 1);\n    }\n  }\n\n  function remove(type: string, callback?: EventCallback) {\n    callback ? removeOne({ type, callback }) : removeMultiple(type);\n  }\n\n  return {\n    add,\n    call,\n    remove,\n  };\n}\n","/**\n * The `RelayConfig` object defines the configuration options for initializing a Relay instance.\n */\nexport interface RelayConfig {\n  /**\n   * Endpoint defined to communicate with the Event API.\n   */\n  url: string;\n\n  /**\n   * Token to authorize the access to the Event API endpoint.\n   */\n  token: string;\n\n  /**\n   * The unique identifier of a web property. See [Tracking ID](https://docs.coveo.com/en/n8tg0567/).\n   */\n  trackingId: string;\n\n  /**\n   * Defines the library mode. The available modes are `emit` and `disabled`.\n   * `emit` sends analytics events to Coveo to be stored.\n   * `disabled` prevents the emission of events and does not trigger callbacks.\n   * @default emit\n   */\n  mode?: \"emit\" | \"disabled\";\n\n  /**\n   * Optionally allows a Relay integration to specify the name(s) of software package(s) relay is\n   * being called from. These names will be transmitted with each event, along with Relay's own\n   * version. The recommendation is to specify them using a 'softwarename@softwareversion' string.\n   */\n  source?: string[];\n}\n\n/**\n * User which logged the event.\n */\nexport interface User {\n  /**\n   * The application's user identifier.\n   */\n  id: string;\n}\n\nexport interface ConfigManager {\n  get: () => Readonly<RelayConfig>;\n  update: (updatedConfig: Partial<RelayConfig>) => void;\n}\n\nfunction pick({\n  url,\n  token,\n  trackingId,\n  ...rest\n}: RelayConfig): Readonly<RelayConfig> {\n  return Object.freeze({\n    url,\n    token,\n    trackingId,\n    ...(!!rest.mode && { mode: rest.mode }),\n    ...(!!rest.source && { source: rest.source }),\n  });\n}\n\nexport function createConfigManager(\n  initialConfig: RelayConfig\n): Readonly<ConfigManager> {\n  let _config: Readonly<RelayConfig> = pick(initialConfig);\n\n  return {\n    get: () => _config,\n    update: (updatedConfig: Partial<RelayConfig>) => {\n      _config = pick({ ..._config, ...updatedConfig });\n    },\n  };\n}\n","export interface CookieManager {\n  getItem: (key: string) => string | null;\n  removeItem: (key: string) => void;\n  setItem: (key: string, data: string, expire: number) => void;\n}\n\nexport const cookieManager: CookieManager = createCookieManager();\n\nfunction createCookieManager(): CookieManager {\n  const prefix = \"coveo_\";\n  const getDomain = (host: string) => {\n    const parts = host.split(\".\").slice(-2);\n    return parts.length == 2 ? parts.join(\".\") : \"\";\n  };\n\n  return {\n    getItem(key: string): string | null {\n      const cookiePrefix = `${prefix}${key}=`;\n      const cookieArray = document.cookie.split(\";\");\n      for (const cookie of cookieArray) {\n        const prettifyCookie = cookie.replace(/^\\s+/, \"\");\n        if (prettifyCookie.lastIndexOf(cookiePrefix, 0) === 0) {\n          return prettifyCookie.substring(\n            cookiePrefix.length,\n            prettifyCookie.length\n          );\n        }\n      }\n      return null;\n    },\n    setItem(key: string, data: string, expire: number): void {\n      const domain = getDomain(window.location.hostname);\n      const expireSection = `;expires=${new Date(\n        new Date().getTime() + expire\n      ).toUTCString()}`;\n      const domainSection = domain ? `;domain=${domain}` : \"\";\n      document.cookie = `${prefix}${key}=${data}${expireSection}${domainSection};path=/;SameSite=Lax`;\n    },\n\n    removeItem(key: string): void {\n      this.setItem(key, \"\", -1);\n    },\n  };\n}\n","import { createExplorerMessenger } from \"@coveo/explorer-messenger\";\nimport { Environment } from \"../environment\";\nimport { createBrowserStorage } from \"./storage/storage\";\nimport { RelayEvent } from \"../../event/relay-event\";\n\nfunction getReferrer() {\n  const referrer = document.referrer;\n\n  return referrer === \"\" ? null : referrer;\n}\n\nexport function buildBrowserEnvironment(): Environment {\n  return {\n    runtime: \"browser\",\n    send: (url: string, token: string, event: RelayEvent) => {\n      const response = navigator.sendBeacon(\n        `${url}?access_token=${token}`,\n        new Blob([JSON.stringify([event])], {\n          type: \"application/json\",\n        })\n      );\n\n      const messenger = createExplorerMessenger();\n      messenger.sendMessage({ kind: \"EVENT_PROTOCOL\", event, url, token });\n\n      if (!response) {\n        throw new Error(\n          `Failed to send the event(s) because the payload size exceeded the maximum allowed size (32 KB). Please contact support if the problem persists.`\n        );\n      }\n    },\n    getReferrer: () => getReferrer(),\n    getLocation: () => window.location.href,\n    getUserAgent: () => navigator.userAgent,\n    generateUUID: () => crypto.randomUUID(),\n    storage: createBrowserStorage(),\n  };\n}\n","function createExplorerMessenger() {\n  const isBrowser = typeof window !== \"undefined\";\n  return {\n    sendMessage(message) {\n      isBrowser && window.postMessage(message, \"*\");\n    }\n  };\n}\nexport {\n  createExplorerMessenger\n};\n","import { Storage } from \"../../storage\";\nimport { cookieManager } from \"./cookie\";\n\nexport function createBrowserStorage(): Storage {\n  return {\n    getItem(key: string): string | null {\n      return cookieManager.getItem(key) || localStorage.getItem(key);\n    },\n\n    removeItem(key: string): void {\n      cookieManager.removeItem(key);\n      localStorage.removeItem(key);\n    },\n\n    setItem(key: string, data: string): void {\n      const oneYear = 31556952000;\n      localStorage.setItem(key, data);\n      cookieManager.setItem(key, data, oneYear);\n    },\n  };\n}\n","import { ConfigManager } from \"../../config/config\";\nimport { buildBrowserEnvironment } from \"../browser/browser\";\nimport { Environment } from \"../environment\";\nimport { buildNullEnvironment } from \"../null/null\";\n\nexport interface EnvironmentManager {\n  get: () => Readonly<Environment>;\n}\n\nfunction buildEnvironment(configManager: ConfigManager) {\n  const active = configManager.get().mode !== \"disabled\";\n\n  if (active && isBrowser()) {\n    return buildBrowserEnvironment();\n  }\n\n  return buildNullEnvironment();\n}\n\nfunction isBrowser() {\n  try {\n    return typeof window === \"object\";\n  } catch (e) {\n    return false;\n  }\n}\n\nexport function createEnvironmentManager(\n  configManager: ConfigManager\n): Readonly<EnvironmentManager> {\n  return {\n    get: () => Object.freeze(buildEnvironment(configManager)),\n  };\n}\n","import { Environment } from \"../environment\";\nimport { createNullStorage } from \"../storage\";\n\nexport function buildNullEnvironment(): Environment {\n  return {\n    runtime: \"null\",\n    send: () => undefined,\n    getReferrer: () => null,\n    getLocation: () => null,\n    getUserAgent: () => null,\n    generateUUID: () => \"\",\n    storage: createNullStorage(),\n  };\n}\n","export interface Storage {\n  getItem: (key: string) => string | null;\n  removeItem: (key: string) => void;\n  setItem: (key: string, data: string) => void;\n}\n\nexport function createNullStorage(): Storage {\n  return {\n    getItem(): string | null {\n      return null;\n    },\n    removeItem(): void {\n      return;\n    },\n    setItem(): void {\n      return;\n    },\n  };\n}\n","import { emit } from \"./emit/emit\";\nimport { createClientIdManager } from \"./client-id/client-id\";\nimport { createRelayEvent, RelayEvent } from \"./event/relay-event\";\nimport { version } from \"./version\";\nimport { createMeta, Meta, EventConfig } from \"./event/meta/meta\";\nimport { createListenerManager, EventCallback } from \"./listener/listener\";\nimport { createConfigManager, RelayConfig, User } from \"./config/config\";\nimport { createEnvironmentManager } from \"./environment/manager/manager\";\nimport { RelayPayload } from \"./relay-payload\";\n\n/**\n * Function that detaches an event callback.\n * @typedef {function} Off\n * @returns {void}\n */\nexport type Off = () => void;\n\n/**\n * Relay instance.\n * This object provides a comprehensive set of variables and methods for interacting with the Event API.\n */\ninterface Relay {\n  /**\n   * Sends an event to the Event API.\n   * @param {string} type - event's type to be emitted.\n   * @param {Record<string,any>} payload - payload to include within the event.\n   * @returns {void}\n   */\n  emit: (type: string, payload: Record<string, any>) => void;\n\n  /**\n   * Gets the client-side generated meta object.\n   * @param {string} type - event's type that will be included in the meta object.\n   * @returns {Meta}\n   */\n  getMeta: (type: string) => Meta;\n\n  /**\n   * Attaches an event callback to either all event types or a specific one.\n   * The callback set will be called when an event with the specified type is emitted.\n   * It’s not possible to modify the payload of the event sent to Coveo using this listener.\n   * Setting type as \"*\" will trigger the callback for all event types.\n   * Returns the \"off\" function to detach the event callback.\n   * @param {string} type - event's type.\n   * @param {EventCallback} callback - callback that should be called when the event is emitted.\n   * @returns {Off}\n   */\n  on: (type: string, callback: EventCallback) => Off;\n\n  /**\n   * Detach callback(s) from events.\n   * If only the \"type\" parameter is set, all callbacks for the specified type will be removed.\n   * @param {string} type - event's type.\n   * @param {EventCallback} callback - callback that should be removed.\n   * @returns {void}\n   */\n  off: (type: string, callback?: EventCallback) => void;\n\n  /**\n   * Updates Relay's configuration after its initialization.\n   * @param {Partial<RelayConfig>} config - configuration that should be updated.\n   * @returns {void}\n   */\n  updateConfig: (config: Partial<RelayConfig>) => void;\n\n  /**\n   * Current version of the Relay library.\n   */\n  version: string;\n\n  /**\n   * Removes the visitorId cookie and localStorage key.\n   * @returns {void}\n   */\n  clearStorage: () => void;\n}\n\n/**\n * Initializes the Relay library object.\n * @param {RelayConfig} initialConfig\n * @returns {Relay}\n */\nexport function createRelay(initialConfig: RelayConfig): Relay {\n  const configManager = createConfigManager(initialConfig);\n  const listenerManager = createListenerManager();\n  const environmentManager = createEnvironmentManager(configManager);\n  const clientIdManager = createClientIdManager(environmentManager);\n\n  return {\n    emit: (type: string, payload: Record<string, any>) => {\n      const config = configManager.get();\n      const environment = environmentManager.get();\n\n      const event = createRelayEvent(\n        type,\n        payload,\n        config,\n        environment,\n        clientIdManager\n      );\n\n      return emit({\n        config,\n        environment,\n        event,\n        listenerManager,\n      });\n    },\n    getMeta: (type: string) =>\n      createMeta(\n        type,\n        configManager.get(),\n        environmentManager.get(),\n        clientIdManager\n      ),\n    on: (type: string, callback: EventCallback) =>\n      listenerManager.add({ type, callback }),\n    off: (type: string, callback?: EventCallback) =>\n      listenerManager.remove(type, callback),\n    updateConfig: (config: Partial<RelayConfig>) =>\n      configManager.update(config),\n    version,\n    clearStorage: () => {\n      clientIdManager.clear();\n    },\n  };\n}\n\nexport type {\n  Relay,\n  Meta,\n  EventConfig,\n  EventCallback,\n  RelayConfig,\n  User,\n  RelayPayload,\n  RelayEvent,\n};\n","import { ClientIdManager } from \"../client-id/client-id\";\nimport { Environment } from \"../environment/environment\";\nimport { RelayPayload } from \"../relay-payload\";\nimport { RelayConfig } from \"../relay\";\nimport { createMeta, Meta } from \"./meta/meta\";\n\n/**\n * Defines the structure of a RelayEvent, extending the RelayPayload.\n */\nexport interface RelayEvent extends RelayPayload {\n  /**\n   * Read-only `meta` property of Meta type.\n   */\n  meta: Readonly<Meta>;\n}\n\nexport function createRelayEvent(\n  type: string,\n  payload: RelayPayload,\n  config: RelayConfig,\n  environment: Environment,\n  clientIdManager: ClientIdManager\n): Readonly<RelayEvent> {\n  return {\n    ...payload,\n    meta: createMeta(type, config, environment, clientIdManager),\n  };\n}\n","import { Environment } from \"../environment/environment\";\nimport { ListenerManager } from \"../listener/listener\";\nimport { RelayEvent } from \"../event/relay-event\";\nimport { RelayConfig } from \"../relay\";\n\nexport interface EmitParams {\n  config: RelayConfig;\n  environment: Environment;\n  event: RelayEvent;\n  listenerManager: ListenerManager;\n}\n\nexport function emit({\n  config,\n  environment,\n  event,\n  listenerManager,\n}: EmitParams) {\n  const { url, token, mode } = config;\n  const isEnabled = mode !== \"disabled\";\n\n  if (isEnabled) {\n    listenerManager.call(event);\n    environment.send(url, token, event);\n  }\n}\n"],"names":["REGEX","createClientIdManager","environmentManager","key","getClientId","environment","get","storage","existingClientId","getItem","clientId","uuid","test","generateUUID","setItem","clear","removeItem","version","getSource","config","source","concat","createMeta","type","clientIdManager","getReferrer","getLocation","getUserAgent","eventConfig","trackingId","user","getEventConfig","Object","freeze","ts","Date","now","userAgent","referrer","location","ANY_EVENT_TYPE","createListenerManager","listeners","getListenerIndex","callback","findIndex","listener","remove","index","splice","removeOne","length","i","removeMultiple","add","push","call","event","forEach","isMatchesType","meta","e","console","error","pick","url","token","rest","mode","cookieManager","prefix","cookiePrefix","cookieArray","document","cookie","split","prettifyCookie","replace","lastIndexOf","substring","data","expire","domain","host","parts","slice","join","getDomain","window","hostname","expireSection","getTime","toUTCString","domainSection","this","createCookieManager","buildBrowserEnvironment","runtime","send","response","navigator","sendBeacon","Blob","JSON","stringify","messenger","isBrowser","sendMessage","message","postMessage","createExplorerMessenger","kind","Error","href","crypto","randomUUID","localStorage","buildEnvironment","configManager","createRelay","initialConfig","_config","update","updatedConfig","createConfigManager","listenerManager","createEnvironmentManager","emit","payload","createRelayEvent","getMeta","on","off","updateConfig","clearStorage"],"mappings":"AAAA,IAAAA,EAAe,sHCQT,SAAUC,EACdC,GAEA,MAAMC,EAAM,YAEZ,MAAO,CACLC,YAAa,KACX,MAAMC,EAAcH,EAAmBI,MACjCC,EAAUF,EAAYE,QAEtBC,EAAmBD,EAAQE,QAAQN,GACnCO,EACJF,ICjBiB,iBADPG,EDkBmBH,ICjBAR,EAAMY,KAAKD,IDkBpCH,EACAH,EAAYQ,eCpBxB,IAAkBF,EDsBZ,OADAJ,EAAQO,QAAQX,EAAKO,GACdA,CAAQ,EAEjBK,MAAO,KACLb,EAAmBI,MAAMC,QAAQS,WAAWb,EAAI,EAGtD,CE9BO,MAAMc,EAAU,QCuEvB,SAASC,EAAUC,GACjB,OAAQA,EAAOC,QAAU,IAAIC,OAAO,CAAC,SAASJ,KAChD,CAEM,SAAUK,EACdC,EACAJ,EACAd,EACAmB,GAEA,MAAMC,YAAEA,EAAWC,YAAEA,EAAWC,aAAEA,GAAiBtB,EAC7CuB,EAhBR,SAAwBT,GACtB,MAAMU,WAAEA,GAAeV,EACvB,MAAO,CAAEU,aAAYC,KAAM,KAC7B,CAasBC,CAAeZ,GAC7BT,EAAWc,EAAgBpB,cAEjC,OAAO4B,OAAOC,OAAa,CACzBV,OACAJ,OAAQS,EACRM,GAAIC,KAAKC,MACThB,OAAQF,EAAUC,GAClBT,WACA2B,UAAWV,IACXW,SAAUb,IACVc,SAAUb,KAEd,CC7FA,MAAMc,EAAiB,aAqBPC,IACd,MAAMC,EAAwB,GAE9B,SAASC,GAAiBpB,KAAEA,EAAIqB,SAAEA,IAChC,OAAOF,EAAUG,WACdC,GAAaA,EAASvB,OAASA,GAAQuB,EAASF,WAAaA,GAEjE,CA4CD,SAASG,EAAOxB,EAAcqB,GAC5BA,EARF,SAAmBE,GACjB,MAAME,EAAQL,EAAiBG,GAC3BE,GAAS,GACXN,EAAUO,OAAOD,EAAO,EAE3B,CAGYE,CAAU,CAAE3B,OAAMqB,aApB/B,SAAwBrB,GACtB,GAAIA,IAASiB,EACXE,EAAUS,OAAS,OAEnB,IAAK,IAAIC,EAAIV,EAAUS,OAAS,EAAGC,GAAK,EAAGA,IACrCV,EAAUU,GAAG7B,OAASA,GACxBmB,EAAUO,OAAOG,EAAG,EAI3B,CAU4CC,CAAe9B,EAC3D,CAED,MAAO,CACL+B,IA3CF,SAAaR,GAIX,OAHIH,EAAiBG,GAAY,GAC/BJ,EAAUa,KAAKT,GAEV,IAAMC,EAAOD,EAASvB,KAAMuB,EAASF,SAC7C,EAuCCY,KArCF,SAAcC,GACZf,EAAUgB,SAASZ,IACjB,GAbJ,SAAuBA,EAAoBvB,GACzC,MAAyB,MAAlBuB,EAASvB,MAAgBA,IAASuB,EAASvB,IACnD,CAWOoC,CAAcb,EAAUW,EAAMG,KAAKrC,MACrC,IACEuB,EAASF,SAASa,EACnB,CAAC,MAAOI,GACPC,QAAQC,MAAMF,EACf,CACF,GAEJ,EA4BCd,SAEJ,CCjCA,SAASiB,GAAKC,IACZA,EAAGC,MACHA,EAAKrC,WACLA,KACGsC,IAEH,OAAOnC,OAAOC,OAAO,CACnBgC,MACAC,QACArC,kBACMsC,EAAKC,MAAQ,CAAEA,KAAMD,EAAKC,WAC1BD,EAAK/C,QAAU,CAAEA,OAAQ+C,EAAK/C,SAExC,CCzDO,MAAMiD,EAEb,WACE,MAAMC,EAAS,SAMf,MAAO,CACL,OAAA7D,CAAQN,GACN,MAAMoE,EAAe,GAAGD,IAASnE,KAC3BqE,EAAcC,SAASC,OAAOC,MAAM,KAC1C,IAAK,MAAMD,KAAUF,EAAa,CAChC,MAAMI,EAAiBF,EAAOG,QAAQ,OAAQ,IAC9C,GAAoD,IAAhDD,EAAeE,YAAYP,EAAc,GAC3C,OAAOK,EAAeG,UACpBR,EAAapB,OACbyB,EAAezB,OAGpB,CACD,OAAO,IACR,EACD,OAAArC,CAAQX,EAAa6E,EAAcC,GACjC,MAAMC,EArBQ,CAACC,IACjB,MAAMC,EAAQD,EAAKR,MAAM,KAAKU,OAAO,GACrC,OAAuB,GAAhBD,EAAMjC,OAAciC,EAAME,KAAK,KAAO,EAAE,EAmB9BC,CAAUC,OAAOjD,SAASkD,UACnCC,EAAgB,YAAY,IAAIvD,MACpC,IAAIA,MAAOwD,UAAYV,GACvBW,gBACIC,EAAgBX,EAAS,WAAWA,IAAW,GACrDT,SAASC,OAAS,GAAGJ,IAASnE,KAAO6E,IAAOU,IAAgBG,uBAC7D,EAED,UAAA7E,CAAWb,GACT2F,KAAKhF,QAAQX,EAAK,IAAK,EACxB,EAEL,CArC4C4F,YCK5BC,IACd,MAAO,CACLC,QAAS,UACTC,KAAM,CAACjC,EAAaC,EAAeT,KACjC,MAAM0C,EAAWC,UAAUC,WACzB,GAAGpC,kBAAoBC,IACvB,IAAIoC,KAAK,CAACC,KAAKC,UAAU,CAAC/C,KAAU,CAClClC,KAAM,sBAIJkF,ECtBZ,WACE,MAAMC,EAA8B,oBAAXlB,OACzB,MAAO,CACL,WAAAmB,CAAYC,GACVF,GAAalB,OAAOqB,YAAYD,EAAS,IAC1C,EAEL,CDewBE,GAGlB,GAFAL,EAAUE,YAAY,CAAEI,KAAM,iBAAkBtD,QAAOQ,MAAKC,WAEvDiC,EACH,MAAM,IAAIa,MACR,kJAEH,EAEHvF,YAAa,IA1BjB,WACE,MAAMa,EAAWmC,SAASnC,SAE1B,MAAoB,KAAbA,EAAkB,KAAOA,CAClC,CAsBuBb,GACnBC,YAAa,IAAM8D,OAAOjD,SAAS0E,KACnCtF,aAAc,IAAMyE,UAAU/D,UAC9BxB,aAAc,IAAMqG,OAAOC,aAC3B5G,QE/BK,CACLE,QAAQN,GACCkE,EAAc5D,QAAQN,IAAQiH,aAAa3G,QAAQN,GAG5D,UAAAa,CAAWb,GACTkE,EAAcrD,WAAWb,GACzBiH,aAAapG,WAAWb,EACzB,EAED,OAAAW,CAAQX,EAAa6E,GAEnBoC,aAAatG,QAAQX,EAAK6E,GAC1BX,EAAcvD,QAAQX,EAAK6E,EAFX,WAGjB,GFmBL,CG5BA,SAASqC,EAAiBC,GAGxB,MAF4C,aAA7BA,EAAchH,MAAM8D,MASrC,WACE,IACE,MAAyB,iBAAXoB,MACf,CAAC,MAAO3B,GACP,OAAO,CACR,CACH,CAbgB6C,GACLV,ICTF,CACLC,QAAS,OACTC,KAAM,KAAe,EACrBzE,YAAa,IAAM,KACnBC,YAAa,IAAM,KACnBC,aAAc,IAAM,KACpBd,aAAc,IAAM,GACpBN,QCJK,CACLE,QAAO,IACE,KAET,UAAAO,GAEC,EACD,OAAAF,GAEC,GFCL,CGiEM,SAAUyG,EAAYC,GAC1B,MAAMF,ERlBF,SACJE,GAEA,IAAIC,EAAiCzD,EAAKwD,GAE1C,MAAO,CACLlH,IAAK,IAAMmH,EACXC,OAASC,IACPF,EAAUzD,EAAK,IAAKyD,KAAYE,GAAgB,EAGtD,CQOwBC,CAAoBJ,GACpCK,EAAkBpF,IAClBvC,EH1DF,SACJoH,GAEA,MAAO,CACLhH,IAAK,IAAM0B,OAAOC,OAAOoF,EAAiBC,IAE9C,CGoD6BQ,CAAyBR,GAC9C9F,EAAkBvB,EAAsBC,GAE9C,MAAO,CACL6H,KAAM,CAACxG,EAAcyG,KACnB,MAAM7G,EAASmG,EAAchH,MACvBD,EAAcH,EAAmBI,MAEjCmD,EC7EN,SACJlC,EACAyG,EACA7G,EACAd,EACAmB,GAEA,MAAO,IACFwG,EACHpE,KAAMtC,EAAWC,EAAMJ,EAAQd,EAAamB,GAEhD,CDkEoByG,CACZ1G,EACAyG,EACA7G,EACAd,EACAmB,GAGF,OEzFA,UAAeL,OACnBA,EAAMd,YACNA,EAAWoD,MACXA,EAAKoE,gBACLA,IAEA,MAAM5D,IAAEA,EAAGC,MAAEA,EAAKE,KAAEA,GAASjD,EACF,aAATiD,IAGhByD,EAAgBrE,KAAKC,GACrBpD,EAAY6F,KAAKjC,EAAKC,EAAOT,GAEjC,CF4EasE,CAAK,CACV5G,SACAd,cACAoD,QACAoE,mBACA,EAEJK,QAAU3G,GACRD,EACEC,EACA+F,EAAchH,MACdJ,EAAmBI,MACnBkB,GAEJ2G,GAAI,CAAC5G,EAAcqB,IACjBiF,EAAgBvE,IAAI,CAAE/B,OAAMqB,aAC9BwF,IAAK,CAAC7G,EAAcqB,IAClBiF,EAAgB9E,OAAOxB,EAAMqB,GAC/ByF,aAAelH,GACbmG,EAAcI,OAAOvG,GACvBF,UACAqH,aAAc,KACZ9G,EAAgBT,OAAO,EAG7B","x_google_ignoreList":[0,2,9]}
+{"version":3,"file":"relay.min.js","sources":["../../../../node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/esm-browser/regex.js","../../src/client-id/client-id.ts","../../../../node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/esm-browser/validate.js","../../src/version.ts","../../src/event/meta/meta.ts","../../src/listener/listener.ts","../../src/config/config.ts","../../src/environment/browser/storage/cookie.ts","../../src/environment/browser/browser.ts","../../../../node_modules/.pnpm/@coveo+explorer-messenger@0.1.1/node_modules/@coveo/explorer-messenger/dist/messenger.js","../../src/environment/browser/storage/storage.ts","../../src/environment/manager/manager.ts","../../src/environment/null/null.ts","../../src/environment/storage.ts","../../src/relay.ts","../../src/event/relay-event.ts","../../src/emit/emit.ts"],"sourcesContent":["export default /^(?:[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;","import { validate } from \"uuid\";\nimport { EnvironmentManager } from \"../environment/manager/manager\";\n\nexport interface ClientIdManager {\n  getClientId: () => string;\n  clear: () => void;\n}\n\nexport function createClientIdManager(\n  environmentManager: EnvironmentManager\n): ClientIdManager {\n  const key = \"visitorId\";\n\n  return {\n    getClientId: () => {\n      const environment = environmentManager.get();\n      const storage = environment.storage;\n\n      const existingClientId = storage.getItem(key);\n      const clientId =\n        existingClientId && validate(existingClientId)\n          ? existingClientId\n          : environment.generateUUID();\n      storage.setItem(key, clientId);\n      return clientId;\n    },\n    clear: () => {\n      environmentManager.get().storage.removeItem(key);\n    },\n  };\n}\n","import REGEX from './regex.js';\n\nfunction validate(uuid) {\n  return typeof uuid === 'string' && REGEX.test(uuid);\n}\n\nexport default validate;","export const version = \"process.env.VERSION\";\n","import { ClientIdManager } from \"../../client-id/client-id\";\nimport { Environment } from \"../../environment/environment\";\nimport { RelayConfig, User } from \"../../config/config\";\nimport { version } from \"../../version\";\n\n/**\n * The `EventConfig` object provides additonal information for the configuration associated with the event.\n */\nexport interface EventConfig {\n  /**\n   * The unique identifier of a web property. See [Tracking ID](https://docs.coveo.com/en/n8tg0567/).\n   */\n  trackingId: string;\n\n  /**\n   * Named user identity which logged this event.\n   */\n  user: User;\n}\n\n/**\n * The `Meta` object provides a structured representation of metadata associated with an emitted event.\n * This object is auto-populated by Relay.\n */\nexport interface Meta {\n  /**\n   * Event's type that was emitted.\n   */\n  type: string;\n\n  /**\n   * Configuration associated with the event.\n   */\n  config: EventConfig;\n\n  /**\n   * Timestamp when the event was emitted.\n   */\n  ts: number;\n\n  /**\n   * Names and versions of the client side libraries which built and emitted this event.\n   */\n  source: string[];\n\n  /**\n   * Persistent unique identifier of a device.\n   */\n  clientId: string;\n\n  /**\n   * Browser Navigator's [user agent](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/userAgent) property if set.\n   */\n  userAgent: string | null;\n\n  /**\n   * Browser Document's [referrer](https://developer.mozilla.org/en-US/docs/Web/API/Document/referrer) property if set.\n   */\n  referrer: string | null;\n\n  /**\n   * Browser Location's [href](https://developer.mozilla.org/en-US/docs/Web/API/Location/href) property if set.\n   */\n  location: string | null;\n}\n\nfunction getEventConfig(config: RelayConfig): EventConfig {\n  const { trackingId, user } = config;\n  return { trackingId, user: user || { id: null } };\n}\n\nfunction getSource(config: RelayConfig): string[] {\n  return (config.source || []).concat([`relay@${version}`]);\n}\n\nexport function createMeta(\n  type: string,\n  config: RelayConfig,\n  environment: Environment,\n  clientIdManager: ClientIdManager\n): Readonly<Meta> {\n  const { getReferrer, getLocation, getUserAgent } = environment;\n  const eventConfig = getEventConfig(config);\n  const clientId = clientIdManager.getClientId();\n\n  return Object.freeze<Meta>({\n    type,\n    config: eventConfig,\n    ts: Date.now(),\n    source: getSource(config),\n    clientId,\n    userAgent: getUserAgent(),\n    referrer: getReferrer(),\n    location: getLocation(),\n  });\n}\n","import { RelayEvent } from \"../event/relay-event\";\n\nconst ANY_EVENT_TYPE = \"*\";\n\n/**\n * Callback to perform an action when a specified event is emitted.\n * @typedef {function} EventCallback\n * @param {RelayEvent} event - the Relay event payload that triggered the callback.\n * @returns {void}\n */\nexport type EventCallback = (event: RelayEvent) => void;\n\ninterface Listener {\n  type: string;\n  callback: EventCallback;\n}\n\nexport interface ListenerManager {\n  add: (listener: Listener) => () => void;\n  call: (event: RelayEvent) => void;\n  remove: (type: string, callback?: EventCallback) => void;\n}\n\nexport function createListenerManager(): ListenerManager {\n  const listeners: Listener[] = [];\n\n  function getListenerIndex({ type, callback }: Listener): number {\n    return listeners.findIndex(\n      (listener) => listener.type === type && listener.callback === callback\n    );\n  }\n\n  function isMatchesType(listener: Listener, type: string): boolean {\n    return listener.type === \"*\" || type === listener.type;\n  }\n\n  function add(listener: Listener): () => void {\n    if (getListenerIndex(listener) < 0) {\n      listeners.push(listener);\n    }\n    return () => remove(listener.type, listener.callback);\n  }\n\n  function call(event: RelayEvent) {\n    listeners.forEach((listener) => {\n      if (isMatchesType(listener, event.meta.type)) {\n        try {\n          listener.callback(event);\n        } catch (e) {\n          console.error(e);\n        }\n      }\n    });\n  }\n\n  function removeMultiple(type: string) {\n    if (type === ANY_EVENT_TYPE) {\n      listeners.length = 0;\n    } else {\n      for (let i = listeners.length - 1; i >= 0; i--) {\n        if (listeners[i].type === type) {\n          listeners.splice(i, 1);\n        }\n      }\n    }\n  }\n\n  function removeOne(listener: Listener) {\n    const index = getListenerIndex(listener);\n    if (index >= 0) {\n      listeners.splice(index, 1);\n    }\n  }\n\n  function remove(type: string, callback?: EventCallback) {\n    callback ? removeOne({ type, callback }) : removeMultiple(type);\n  }\n\n  return {\n    add,\n    call,\n    remove,\n  };\n}\n","/**\n * The `RelayConfig` object defines the configuration options for initializing a Relay instance.\n */\nexport interface RelayConfig {\n  /**\n   * Endpoint defined to communicate with the Event API.\n   */\n  url: string;\n\n  /**\n   * Token to authorize the access to the Event API endpoint.\n   */\n  token: string;\n\n  /**\n   * The unique identifier of a web property. See [Tracking ID](https://docs.coveo.com/en/n8tg0567/).\n   */\n  trackingId: string;\n\n  /**\n   * The application's user identity. If not set in the config, Relay will assume the identity matches\n   * the identity in the authentication or anonymous otherwise.\n   */\n  user?: User;\n\n  /**\n   * Defines the library mode. The available modes are `emit` and `disabled`.\n   * `emit` sends analytics events to Coveo to be stored.\n   * `disabled` prevents the emission of events and does not trigger callbacks.\n   * @default emit\n   */\n  mode?: \"emit\" | \"disabled\";\n\n  /**\n   * Optionally allows a Relay integration to specify the name(s) of software package(s) relay is\n   * being called from. These names will be transmitted with each event, along with Relay's own\n   * version. The recommendation is to specify them using a 'softwarename@softwareversion' string.\n   */\n  source?: string[];\n}\n\n/**\n * User which logged the event.\n */\nexport interface User {\n  /**\n   * The application's user identifier. An id of 'anonymous' assumes the user is explicitly anonymous. An id of null indicates\n   * the identity is equal to the identity in the authentication or anonymous.\n   */\n  id: string | null;\n}\n\nexport interface ConfigManager {\n  get: () => Readonly<RelayConfig>;\n  update: (updatedConfig: Partial<RelayConfig>) => void;\n}\n\nfunction pick({\n  url,\n  token,\n  trackingId,\n  ...rest\n}: RelayConfig): Readonly<RelayConfig> {\n  return Object.freeze({\n    url,\n    token,\n    trackingId,\n    ...(!!rest.user && { user: rest.user }),\n    ...(!!rest.mode && { mode: rest.mode }),\n    ...(!!rest.source && { source: rest.source }),\n  });\n}\n\nexport function createConfigManager(\n  initialConfig: RelayConfig\n): Readonly<ConfigManager> {\n  let _config: Readonly<RelayConfig> = pick(initialConfig);\n\n  return {\n    get: () => _config,\n    update: (updatedConfig: Partial<RelayConfig>) => {\n      _config = pick({ ..._config, ...updatedConfig });\n    },\n  };\n}\n","export interface CookieManager {\n  getItem: (key: string) => string | null;\n  removeItem: (key: string) => void;\n  setItem: (key: string, data: string, expire: number) => void;\n}\n\nexport const cookieManager: CookieManager = createCookieManager();\n\nfunction createCookieManager(): CookieManager {\n  const prefix = \"coveo_\";\n  const getDomain = (host: string) => {\n    const parts = host.split(\".\").slice(-2);\n    return parts.length == 2 ? parts.join(\".\") : \"\";\n  };\n\n  return {\n    getItem(key: string): string | null {\n      const cookiePrefix = `${prefix}${key}=`;\n      const cookieArray = document.cookie.split(\";\");\n      for (const cookie of cookieArray) {\n        const prettifyCookie = cookie.replace(/^\\s+/, \"\");\n        if (prettifyCookie.lastIndexOf(cookiePrefix, 0) === 0) {\n          return prettifyCookie.substring(\n            cookiePrefix.length,\n            prettifyCookie.length\n          );\n        }\n      }\n      return null;\n    },\n    setItem(key: string, data: string, expire: number): void {\n      const domain = getDomain(window.location.hostname);\n      const expireSection = `;expires=${new Date(\n        new Date().getTime() + expire\n      ).toUTCString()}`;\n      const domainSection = domain ? `;domain=${domain}` : \"\";\n      document.cookie = `${prefix}${key}=${data}${expireSection}${domainSection};path=/;SameSite=Lax`;\n    },\n\n    removeItem(key: string): void {\n      this.setItem(key, \"\", -1);\n    },\n  };\n}\n","import { createExplorerMessenger } from \"@coveo/explorer-messenger\";\nimport { Environment } from \"../environment\";\nimport { createBrowserStorage } from \"./storage/storage\";\nimport { RelayEvent } from \"../../event/relay-event\";\n\nfunction getReferrer() {\n  const referrer = document.referrer;\n\n  return referrer === \"\" ? null : referrer;\n}\n\nexport function buildBrowserEnvironment(): Environment {\n  return {\n    runtime: \"browser\",\n    send: (url: string, token: string, event: RelayEvent) => {\n      const response = navigator.sendBeacon(\n        `${url}?access_token=${token}`,\n        new Blob([JSON.stringify([event])], {\n          type: \"application/json\",\n        })\n      );\n\n      const messenger = createExplorerMessenger();\n      messenger.sendMessage({ kind: \"EVENT_PROTOCOL\", event, url, token });\n\n      if (!response) {\n        throw new Error(\n          `Failed to send the event(s) because the payload size exceeded the maximum allowed size (32 KB). Please contact support if the problem persists.`\n        );\n      }\n    },\n    getReferrer: () => getReferrer(),\n    getLocation: () => window.location.href,\n    getUserAgent: () => navigator.userAgent,\n    generateUUID: () => crypto.randomUUID(),\n    storage: createBrowserStorage(),\n  };\n}\n","function createExplorerMessenger() {\n  const isBrowser = typeof window !== \"undefined\";\n  return {\n    sendMessage(message) {\n      isBrowser && window.postMessage(message, \"*\");\n    }\n  };\n}\nexport {\n  createExplorerMessenger\n};\n","import { Storage } from \"../../storage\";\nimport { cookieManager } from \"./cookie\";\n\nexport function createBrowserStorage(): Storage {\n  return {\n    getItem(key: string): string | null {\n      return cookieManager.getItem(key) || localStorage.getItem(key);\n    },\n\n    removeItem(key: string): void {\n      cookieManager.removeItem(key);\n      localStorage.removeItem(key);\n    },\n\n    setItem(key: string, data: string): void {\n      const oneYear = 31556952000;\n      localStorage.setItem(key, data);\n      cookieManager.setItem(key, data, oneYear);\n    },\n  };\n}\n","import { ConfigManager } from \"../../config/config\";\nimport { buildBrowserEnvironment } from \"../browser/browser\";\nimport { Environment } from \"../environment\";\nimport { buildNullEnvironment } from \"../null/null\";\n\nexport interface EnvironmentManager {\n  get: () => Readonly<Environment>;\n}\n\nfunction buildEnvironment(configManager: ConfigManager) {\n  const active = configManager.get().mode !== \"disabled\";\n\n  if (active && isBrowser()) {\n    return buildBrowserEnvironment();\n  }\n\n  return buildNullEnvironment();\n}\n\nfunction isBrowser() {\n  try {\n    return typeof window === \"object\";\n  } catch (e) {\n    return false;\n  }\n}\n\nexport function createEnvironmentManager(\n  configManager: ConfigManager\n): Readonly<EnvironmentManager> {\n  return {\n    get: () => Object.freeze(buildEnvironment(configManager)),\n  };\n}\n","import { Environment } from \"../environment\";\nimport { createNullStorage } from \"../storage\";\n\nexport function buildNullEnvironment(): Environment {\n  return {\n    runtime: \"null\",\n    send: () => undefined,\n    getReferrer: () => null,\n    getLocation: () => null,\n    getUserAgent: () => null,\n    generateUUID: () => \"\",\n    storage: createNullStorage(),\n  };\n}\n","export interface Storage {\n  getItem: (key: string) => string | null;\n  removeItem: (key: string) => void;\n  setItem: (key: string, data: string) => void;\n}\n\nexport function createNullStorage(): Storage {\n  return {\n    getItem(): string | null {\n      return null;\n    },\n    removeItem(): void {\n      return;\n    },\n    setItem(): void {\n      return;\n    },\n  };\n}\n","import { emit } from \"./emit/emit\";\nimport { createClientIdManager } from \"./client-id/client-id\";\nimport { createRelayEvent, RelayEvent } from \"./event/relay-event\";\nimport { version } from \"./version\";\nimport { createMeta, Meta, EventConfig } from \"./event/meta/meta\";\nimport { createListenerManager, EventCallback } from \"./listener/listener\";\nimport { createConfigManager, RelayConfig, User } from \"./config/config\";\nimport { createEnvironmentManager } from \"./environment/manager/manager\";\nimport { RelayPayload } from \"./relay-payload\";\n\n/**\n * Function that detaches an event callback.\n * @typedef {function} Off\n * @returns {void}\n */\nexport type Off = () => void;\n\n/**\n * Relay instance.\n * This object provides a comprehensive set of variables and methods for interacting with the Event API.\n */\ninterface Relay {\n  /**\n   * Sends an event to the Event API.\n   * @param {string} type - event's type to be emitted.\n   * @param {Record<string,any>} payload - payload to include within the event.\n   * @returns {void}\n   */\n  emit: (type: string, payload: Record<string, any>) => void;\n\n  /**\n   * Gets the client-side generated meta object.\n   * @param {string} type - event's type that will be included in the meta object.\n   * @returns {Meta}\n   */\n  getMeta: (type: string) => Meta;\n\n  /**\n   * Attaches an event callback to either all event types or a specific one.\n   * The callback set will be called when an event with the specified type is emitted.\n   * It’s not possible to modify the payload of the event sent to Coveo using this listener.\n   * Setting type as \"*\" will trigger the callback for all event types.\n   * Returns the \"off\" function to detach the event callback.\n   * @param {string} type - event's type.\n   * @param {EventCallback} callback - callback that should be called when the event is emitted.\n   * @returns {Off}\n   */\n  on: (type: string, callback: EventCallback) => Off;\n\n  /**\n   * Detach callback(s) from events.\n   * If only the \"type\" parameter is set, all callbacks for the specified type will be removed.\n   * @param {string} type - event's type.\n   * @param {EventCallback} callback - callback that should be removed.\n   * @returns {void}\n   */\n  off: (type: string, callback?: EventCallback) => void;\n\n  /**\n   * Updates Relay's configuration after its initialization.\n   * @param {Partial<RelayConfig>} config - configuration that should be updated.\n   * @returns {void}\n   */\n  updateConfig: (config: Partial<RelayConfig>) => void;\n\n  /**\n   * Current version of the Relay library.\n   */\n  version: string;\n\n  /**\n   * Removes the visitorId cookie and localStorage key.\n   * @returns {void}\n   */\n  clearStorage: () => void;\n}\n\n/**\n * Initializes the Relay library object.\n * @param {RelayConfig} initialConfig\n * @returns {Relay}\n */\nexport function createRelay(initialConfig: RelayConfig): Relay {\n  const configManager = createConfigManager(initialConfig);\n  const listenerManager = createListenerManager();\n  const environmentManager = createEnvironmentManager(configManager);\n  const clientIdManager = createClientIdManager(environmentManager);\n\n  return {\n    emit: (type: string, payload: Record<string, any>) => {\n      const config = configManager.get();\n      const environment = environmentManager.get();\n\n      const event = createRelayEvent(\n        type,\n        payload,\n        config,\n        environment,\n        clientIdManager\n      );\n\n      return emit({\n        config,\n        environment,\n        event,\n        listenerManager,\n      });\n    },\n    getMeta: (type: string) =>\n      createMeta(\n        type,\n        configManager.get(),\n        environmentManager.get(),\n        clientIdManager\n      ),\n    on: (type: string, callback: EventCallback) =>\n      listenerManager.add({ type, callback }),\n    off: (type: string, callback?: EventCallback) =>\n      listenerManager.remove(type, callback),\n    updateConfig: (config: Partial<RelayConfig>) =>\n      configManager.update(config),\n    version,\n    clearStorage: () => {\n      clientIdManager.clear();\n    },\n  };\n}\n\nexport type {\n  Relay,\n  Meta,\n  EventConfig,\n  EventCallback,\n  RelayConfig,\n  User,\n  RelayPayload,\n  RelayEvent,\n};\n","import { ClientIdManager } from \"../client-id/client-id\";\nimport { Environment } from \"../environment/environment\";\nimport { RelayPayload } from \"../relay-payload\";\nimport { RelayConfig } from \"../relay\";\nimport { createMeta, Meta } from \"./meta/meta\";\n\n/**\n * Defines the structure of a RelayEvent, extending the RelayPayload.\n */\nexport interface RelayEvent extends RelayPayload {\n  /**\n   * Read-only `meta` property of Meta type.\n   */\n  meta: Readonly<Meta>;\n}\n\nexport function createRelayEvent(\n  type: string,\n  payload: RelayPayload,\n  config: RelayConfig,\n  environment: Environment,\n  clientIdManager: ClientIdManager\n): Readonly<RelayEvent> {\n  return {\n    ...payload,\n    meta: createMeta(type, config, environment, clientIdManager),\n  };\n}\n","import { Environment } from \"../environment/environment\";\nimport { ListenerManager } from \"../listener/listener\";\nimport { RelayEvent } from \"../event/relay-event\";\nimport { RelayConfig } from \"../relay\";\n\nexport interface EmitParams {\n  config: RelayConfig;\n  environment: Environment;\n  event: RelayEvent;\n  listenerManager: ListenerManager;\n}\n\nexport function emit({\n  config,\n  environment,\n  event,\n  listenerManager,\n}: EmitParams) {\n  const { url, token, mode } = config;\n  const isEnabled = mode !== \"disabled\";\n\n  if (isEnabled) {\n    listenerManager.call(event);\n    environment.send(url, token, event);\n  }\n}\n"],"names":["REGEX","createClientIdManager","environmentManager","key","getClientId","environment","get","storage","existingClientId","getItem","clientId","uuid","test","generateUUID","setItem","clear","removeItem","version","getSource","config","source","concat","createMeta","type","clientIdManager","getReferrer","getLocation","getUserAgent","eventConfig","trackingId","user","id","getEventConfig","Object","freeze","ts","Date","now","userAgent","referrer","location","ANY_EVENT_TYPE","createListenerManager","listeners","getListenerIndex","callback","findIndex","listener","remove","index","splice","removeOne","length","i","removeMultiple","add","push","call","event","forEach","isMatchesType","meta","e","console","error","pick","url","token","rest","mode","cookieManager","prefix","cookiePrefix","cookieArray","document","cookie","split","prettifyCookie","replace","lastIndexOf","substring","data","expire","domain","host","parts","slice","join","getDomain","window","hostname","expireSection","getTime","toUTCString","domainSection","this","createCookieManager","buildBrowserEnvironment","runtime","send","response","navigator","sendBeacon","Blob","JSON","stringify","messenger","isBrowser","sendMessage","message","postMessage","createExplorerMessenger","kind","Error","href","crypto","randomUUID","localStorage","buildEnvironment","configManager","createRelay","initialConfig","_config","update","updatedConfig","createConfigManager","listenerManager","createEnvironmentManager","emit","payload","createRelayEvent","getMeta","on","off","updateConfig","clearStorage"],"mappings":"AAAA,IAAAA,EAAe,sHCQT,SAAUC,EACdC,GAEA,MAAMC,EAAM,YAEZ,MAAO,CACLC,YAAa,KACX,MAAMC,EAAcH,EAAmBI,MACjCC,EAAUF,EAAYE,QAEtBC,EAAmBD,EAAQE,QAAQN,GACnCO,EACJF,ICjBiB,iBADPG,EDkBmBH,ICjBAR,EAAMY,KAAKD,IDkBpCH,EACAH,EAAYQ,eCpBxB,IAAkBF,EDsBZ,OADAJ,EAAQO,QAAQX,EAAKO,GACdA,CAAQ,EAEjBK,MAAO,KACLb,EAAmBI,MAAMC,QAAQS,WAAWb,EAAI,EAGtD,CE9BO,MAAMc,EAAU,QCuEvB,SAASC,EAAUC,GACjB,OAAQA,EAAOC,QAAU,IAAIC,OAAO,CAAC,SAASJ,KAChD,CAEM,SAAUK,EACdC,EACAJ,EACAd,EACAmB,GAEA,MAAMC,YAAEA,EAAWC,YAAEA,EAAWC,aAAEA,GAAiBtB,EAC7CuB,EAhBR,SAAwBT,GACtB,MAAMU,WAAEA,EAAUC,KAAEA,GAASX,EAC7B,MAAO,CAAEU,aAAYC,KAAMA,GAAQ,CAAEC,GAAI,MAC3C,CAasBC,CAAeb,GAC7BT,EAAWc,EAAgBpB,cAEjC,OAAO6B,OAAOC,OAAa,CACzBX,OACAJ,OAAQS,EACRO,GAAIC,KAAKC,MACTjB,OAAQF,EAAUC,GAClBT,WACA4B,UAAWX,IACXY,SAAUd,IACVe,SAAUd,KAEd,CC7FA,MAAMe,EAAiB,aAqBPC,IACd,MAAMC,EAAwB,GAE9B,SAASC,GAAiBrB,KAAEA,EAAIsB,SAAEA,IAChC,OAAOF,EAAUG,WACdC,GAAaA,EAASxB,OAASA,GAAQwB,EAASF,WAAaA,GAEjE,CA4CD,SAASG,EAAOzB,EAAcsB,GAC5BA,EARF,SAAmBE,GACjB,MAAME,EAAQL,EAAiBG,GAC3BE,GAAS,GACXN,EAAUO,OAAOD,EAAO,EAE3B,CAGYE,CAAU,CAAE5B,OAAMsB,aApB/B,SAAwBtB,GACtB,GAAIA,IAASkB,EACXE,EAAUS,OAAS,OAEnB,IAAK,IAAIC,EAAIV,EAAUS,OAAS,EAAGC,GAAK,EAAGA,IACrCV,EAAUU,GAAG9B,OAASA,GACxBoB,EAAUO,OAAOG,EAAG,EAI3B,CAU4CC,CAAe/B,EAC3D,CAED,MAAO,CACLgC,IA3CF,SAAaR,GAIX,OAHIH,EAAiBG,GAAY,GAC/BJ,EAAUa,KAAKT,GAEV,IAAMC,EAAOD,EAASxB,KAAMwB,EAASF,SAC7C,EAuCCY,KArCF,SAAcC,GACZf,EAAUgB,SAASZ,IACjB,GAbJ,SAAuBA,EAAoBxB,GACzC,MAAyB,MAAlBwB,EAASxB,MAAgBA,IAASwB,EAASxB,IACnD,CAWOqC,CAAcb,EAAUW,EAAMG,KAAKtC,MACrC,IACEwB,EAASF,SAASa,EACnB,CAAC,MAAOI,GACPC,QAAQC,MAAMF,EACf,CACF,GAEJ,EA4BCd,SAEJ,CC1BA,SAASiB,GAAKC,IACZA,EAAGC,MACHA,EAAKtC,WACLA,KACGuC,IAEH,OAAOnC,OAAOC,OAAO,CACnBgC,MACAC,QACAtC,kBACMuC,EAAKtC,MAAQ,CAAEA,KAAMsC,EAAKtC,WAC1BsC,EAAKC,MAAQ,CAAEA,KAAMD,EAAKC,WAC1BD,EAAKhD,QAAU,CAAEA,OAAQgD,EAAKhD,SAExC,CCjEO,MAAMkD,EAEb,WACE,MAAMC,EAAS,SAMf,MAAO,CACL,OAAA9D,CAAQN,GACN,MAAMqE,EAAe,GAAGD,IAASpE,KAC3BsE,EAAcC,SAASC,OAAOC,MAAM,KAC1C,IAAK,MAAMD,KAAUF,EAAa,CAChC,MAAMI,EAAiBF,EAAOG,QAAQ,OAAQ,IAC9C,GAAoD,IAAhDD,EAAeE,YAAYP,EAAc,GAC3C,OAAOK,EAAeG,UACpBR,EAAapB,OACbyB,EAAezB,OAGpB,CACD,OAAO,IACR,EACD,OAAAtC,CAAQX,EAAa8E,EAAcC,GACjC,MAAMC,EArBQ,CAACC,IACjB,MAAMC,EAAQD,EAAKR,MAAM,KAAKU,OAAO,GACrC,OAAuB,GAAhBD,EAAMjC,OAAciC,EAAME,KAAK,KAAO,EAAE,EAmB9BC,CAAUC,OAAOjD,SAASkD,UACnCC,EAAgB,YAAY,IAAIvD,MACpC,IAAIA,MAAOwD,UAAYV,GACvBW,gBACIC,EAAgBX,EAAS,WAAWA,IAAW,GACrDT,SAASC,OAAS,GAAGJ,IAASpE,KAAO8E,IAAOU,IAAgBG,uBAC7D,EAED,UAAA9E,CAAWb,GACT4F,KAAKjF,QAAQX,EAAK,IAAK,EACxB,EAEL,CArC4C6F,YCK5BC,IACd,MAAO,CACLC,QAAS,UACTC,KAAM,CAACjC,EAAaC,EAAeT,KACjC,MAAM0C,EAAWC,UAAUC,WACzB,GAAGpC,kBAAoBC,IACvB,IAAIoC,KAAK,CAACC,KAAKC,UAAU,CAAC/C,KAAU,CAClCnC,KAAM,sBAIJmF,ECtBZ,WACE,MAAMC,EAA8B,oBAAXlB,OACzB,MAAO,CACL,WAAAmB,CAAYC,GACVF,GAAalB,OAAOqB,YAAYD,EAAS,IAC1C,EAEL,CDewBE,GAGlB,GAFAL,EAAUE,YAAY,CAAEI,KAAM,iBAAkBtD,QAAOQ,MAAKC,WAEvDiC,EACH,MAAM,IAAIa,MACR,kJAEH,EAEHxF,YAAa,IA1BjB,WACE,MAAMc,EAAWmC,SAASnC,SAE1B,MAAoB,KAAbA,EAAkB,KAAOA,CAClC,CAsBuBd,GACnBC,YAAa,IAAM+D,OAAOjD,SAAS0E,KACnCvF,aAAc,IAAM0E,UAAU/D,UAC9BzB,aAAc,IAAMsG,OAAOC,aAC3B7G,QE/BK,CACLE,QAAQN,GACCmE,EAAc7D,QAAQN,IAAQkH,aAAa5G,QAAQN,GAG5D,UAAAa,CAAWb,GACTmE,EAActD,WAAWb,GACzBkH,aAAarG,WAAWb,EACzB,EAED,OAAAW,CAAQX,EAAa8E,GAEnBoC,aAAavG,QAAQX,EAAK8E,GAC1BX,EAAcxD,QAAQX,EAAK8E,EAFX,WAGjB,GFmBL,CG5BA,SAASqC,EAAiBC,GAGxB,MAF4C,aAA7BA,EAAcjH,MAAM+D,MASrC,WACE,IACE,MAAyB,iBAAXoB,MACf,CAAC,MAAO3B,GACP,OAAO,CACR,CACH,CAbgB6C,GACLV,ICTF,CACLC,QAAS,OACTC,KAAM,KAAe,EACrB1E,YAAa,IAAM,KACnBC,YAAa,IAAM,KACnBC,aAAc,IAAM,KACpBd,aAAc,IAAM,GACpBN,QCJK,CACLE,QAAO,IACE,KAET,UAAAO,GAEC,EACD,OAAAF,GAEC,GFCL,CGiEM,SAAU0G,EAAYC,GAC1B,MAAMF,ERVF,SACJE,GAEA,IAAIC,EAAiCzD,EAAKwD,GAE1C,MAAO,CACLnH,IAAK,IAAMoH,EACXC,OAASC,IACPF,EAAUzD,EAAK,IAAKyD,KAAYE,GAAgB,EAGtD,CQDwBC,CAAoBJ,GACpCK,EAAkBpF,IAClBxC,EH1DF,SACJqH,GAEA,MAAO,CACLjH,IAAK,IAAM2B,OAAOC,OAAOoF,EAAiBC,IAE9C,CGoD6BQ,CAAyBR,GAC9C/F,EAAkBvB,EAAsBC,GAE9C,MAAO,CACL8H,KAAM,CAACzG,EAAc0G,KACnB,MAAM9G,EAASoG,EAAcjH,MACvBD,EAAcH,EAAmBI,MAEjCoD,EC7EN,SACJnC,EACA0G,EACA9G,EACAd,EACAmB,GAEA,MAAO,IACFyG,EACHpE,KAAMvC,EAAWC,EAAMJ,EAAQd,EAAamB,GAEhD,CDkEoB0G,CACZ3G,EACA0G,EACA9G,EACAd,EACAmB,GAGF,OEzFA,UAAeL,OACnBA,EAAMd,YACNA,EAAWqD,MACXA,EAAKoE,gBACLA,IAEA,MAAM5D,IAAEA,EAAGC,MAAEA,EAAKE,KAAEA,GAASlD,EACF,aAATkD,IAGhByD,EAAgBrE,KAAKC,GACrBrD,EAAY8F,KAAKjC,EAAKC,EAAOT,GAEjC,CF4EasE,CAAK,CACV7G,SACAd,cACAqD,QACAoE,mBACA,EAEJK,QAAU5G,GACRD,EACEC,EACAgG,EAAcjH,MACdJ,EAAmBI,MACnBkB,GAEJ4G,GAAI,CAAC7G,EAAcsB,IACjBiF,EAAgBvE,IAAI,CAAEhC,OAAMsB,aAC9BwF,IAAK,CAAC9G,EAAcsB,IAClBiF,EAAgB9E,OAAOzB,EAAMsB,GAC/ByF,aAAenH,GACboG,EAAcI,OAAOxG,GACvBF,UACAsH,aAAc,KACZ/G,EAAgBT,OAAO,EAG7B","x_google_ignoreList":[0,2,9]}

package/lib/cdn/types/config/config.d.ts

@@ -14,6 +14,11 @@ export interface RelayConfig {
      * The unique identifier of a web property. See [Tracking ID](https://docs.coveo.com/en/n8tg0567/).
      */
     trackingId: string;
+    /**
+     * The application's user identity. If not set in the config, Relay will assume the identity matches
+     * the identity in the authentication or anonymous otherwise.
+     */
+    user?: User;
     /**
      * Defines the library mode. The available modes are `emit` and `disabled`.
      * `emit` sends analytics events to Coveo to be stored.
@@ -33,9 +38,10 @@ export interface RelayConfig {
  */
 export interface User {
     /**
-     * The application's user identifier.
+     * The application's user identifier. An id of 'anonymous' assumes the user is explicitly anonymous. An id of null indicates
+     * the identity is equal to the identity in the authentication or anonymous.
      */
-    id: string;
+    id: string | null;
 }
 export interface ConfigManager {
     get: () => Readonly<RelayConfig>;

package/lib/cdn/types/config/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/config/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;IACjC,MAAM,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;CACvD;AAiBD,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,WAAW,GACzB,QAAQ,CAAC,aAAa,CAAC,CASzB"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/config/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;IACjC,MAAM,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;CACvD;AAkBD,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,WAAW,GACzB,QAAQ,CAAC,aAAa,CAAC,CASzB"}

package/lib/cdn/types/event/meta/meta.d.ts

@@ -12,7 +12,7 @@ export interface EventConfig {
     /**
      * Named user identity which logged this event.
      */
-    user: User | null;
+    user: User;
 }
 /**
  * The `Meta` object provides a structured representation of metadata associated with an emitted event.

package/lib/cdn/types/event/meta/meta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../../src/event/meta/meta.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAWD,wBAAgB,UAAU,CACxB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAAC,IAAI,CAAC,CAehB"}
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../../src/event/meta/meta.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAWD,wBAAgB,UAAU,CACxB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAAC,IAAI,CAAC,CAehB"}

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/36744a6/packages/relay/src/event/meta/meta.ts#L13"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L13"
 						}
 					],
 					"type": {
@@ -74,23 +74,14 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 18,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/meta/meta.ts#L18"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L18"
 						}
 					],
 					"type": {
-						"type": "union",
-						"types": [
-							{
-								"type": "literal",
-								"value": null
-							},
-							{
-								"type": "reference",
-								"target": 57,
-								"name": "User",
-								"package": "@coveo/relay"
-							}
-						]
+						"type": "reference",
+						"target": 58,
+						"name": "User",
+						"package": "@coveo/relay"
 					}
 				}
 			],
@@ -108,7 +99,7 @@
 					"fileName": "event/meta/meta.ts",
 					"line": 9,
 					"character": 17,
-					"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/meta/meta.ts#L9"
+					"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L9"
 				}
 			]
 		},
@@ -154,7 +145,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 49,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/meta/meta.ts#L49"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L49"
 						}
 					],
 					"type": {
@@ -181,7 +172,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 34,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/meta/meta.ts#L34"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L34"
 						}
 					],
 					"type": {
@@ -210,7 +201,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 64,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/meta/meta.ts#L64"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L64"
 						}
 					],
 					"type": {
@@ -246,7 +237,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 59,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/meta/meta.ts#L59"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L59"
 						}
 					],
 					"type": {
@@ -282,7 +273,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 44,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/meta/meta.ts#L44"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L44"
 						}
 					],
 					"type": {
@@ -312,7 +303,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 39,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/meta/meta.ts#L39"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L39"
 						}
 					],
 					"type": {
@@ -339,7 +330,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 29,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/meta/meta.ts#L29"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L29"
 						}
 					],
 					"type": {
@@ -366,7 +357,7 @@
 							"fileName": "event/meta/meta.ts",
 							"line": 54,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/meta/meta.ts#L54"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L54"
 						}
 					],
 					"type": {
@@ -404,7 +395,7 @@
 					"fileName": "event/meta/meta.ts",
 					"line": 25,
 					"character": 17,
-					"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/meta/meta.ts#L25"
+					"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/meta/meta.ts#L25"
 				}
 			]
 		},
@@ -434,7 +425,7 @@
 							"fileName": "relay.ts",
 							"line": 75,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L75"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L75"
 						}
 					],
 					"type": {
@@ -450,7 +441,7 @@
 									"fileName": "relay.ts",
 									"line": 75,
 									"character": 16,
-									"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L75"
+									"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L75"
 								}
 							],
 							"signatures": [
@@ -479,7 +470,7 @@
 											"fileName": "relay.ts",
 											"line": 75,
 											"character": 16,
-											"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L75"
+											"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L75"
 										}
 									],
 									"type": {
@@ -502,7 +493,7 @@
 							"fileName": "relay.ts",
 							"line": 29,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L29"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L29"
 						}
 					],
 					"type": {
@@ -518,7 +509,7 @@
 									"fileName": "relay.ts",
 									"line": 29,
 									"character": 8,
-									"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L29"
+									"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L29"
 								}
 							],
 							"signatures": [
@@ -547,7 +538,7 @@
 											"fileName": "relay.ts",
 											"line": 29,
 											"character": 8,
-											"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L29"
+											"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L29"
 										}
 									],
 									"parameters": [
@@ -625,7 +616,7 @@
 							"fileName": "relay.ts",
 							"line": 36,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L36"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L36"
 						}
 					],
 					"type": {
@@ -641,7 +632,7 @@
 									"fileName": "relay.ts",
 									"line": 36,
 									"character": 11,
-									"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L36"
+									"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L36"
 								}
 							],
 							"signatures": [
@@ -670,7 +661,7 @@
 											"fileName": "relay.ts",
 											"line": 36,
 											"character": 11,
-											"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L36"
+											"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L36"
 										}
 									],
 									"parameters": [
@@ -716,7 +707,7 @@
 							"fileName": "relay.ts",
 							"line": 57,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L57"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L57"
 						}
 					],
 					"type": {
@@ -732,7 +723,7 @@
 									"fileName": "relay.ts",
 									"line": 57,
 									"character": 7,
-									"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L57"
+									"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L57"
 								}
 							],
 							"signatures": [
@@ -761,7 +752,7 @@
 											"fileName": "relay.ts",
 											"line": 57,
 											"character": 7,
-											"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L57"
+											"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L57"
 										}
 									],
 									"parameters": [
@@ -828,7 +819,7 @@
 							"fileName": "relay.ts",
 							"line": 48,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L48"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L48"
 						}
 					],
 					"type": {
@@ -844,7 +835,7 @@
 									"fileName": "relay.ts",
 									"line": 48,
 									"character": 6,
-									"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L48"
+									"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L48"
 								}
 							],
 							"signatures": [
@@ -873,7 +864,7 @@
 											"fileName": "relay.ts",
 											"line": 48,
 											"character": 6,
-											"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L48"
+											"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L48"
 										}
 									],
 									"parameters": [
@@ -940,7 +931,7 @@
 							"fileName": "relay.ts",
 							"line": 64,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L64"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L64"
 						}
 					],
 					"type": {
@@ -956,7 +947,7 @@
 									"fileName": "relay.ts",
 									"line": 64,
 									"character": 16,
-									"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L64"
+									"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L64"
 								}
 							],
 							"signatures": [
@@ -985,7 +976,7 @@
 											"fileName": "relay.ts",
 											"line": 64,
 											"character": 16,
-											"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L64"
+											"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L64"
 										}
 									],
 									"parameters": [
@@ -1050,7 +1041,7 @@
 							"fileName": "relay.ts",
 							"line": 69,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L69"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L69"
 						}
 					],
 					"type": {
@@ -1078,7 +1069,7 @@
 					"fileName": "relay.ts",
 					"line": 22,
 					"character": 10,
-					"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L22"
+					"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L22"
 				}
 			]
 		},
@@ -1106,7 +1097,7 @@
 			},
 			"children": [
 				{
-					"id": 55,
+					"id": 56,
 					"name": "mode",
 					"variant": "declaration",
 					"kind": 1024,
@@ -1167,9 +1158,9 @@
 					"sources": [
 						{
 							"fileName": "config/config.ts",
-							"line": 26,
+							"line": 32,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/config/config.ts#L26"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/config/config.ts#L32"
 						}
 					],
 					"type": {
@@ -1187,7 +1178,7 @@
 					}
 				},
 				{
-					"id": 56,
+					"id": 57,
 					"name": "source",
 					"variant": "declaration",
 					"kind": 1024,
@@ -1205,9 +1196,9 @@
 					"sources": [
 						{
 							"fileName": "config/config.ts",
-							"line": 33,
+							"line": 39,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/config/config.ts#L33"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/config/config.ts#L39"
 						}
 					],
 					"type": {
@@ -1237,7 +1228,7 @@
 							"fileName": "config/config.ts",
 							"line": 13,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/config/config.ts#L13"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/config/config.ts#L13"
 						}
 					],
 					"type": {
@@ -1264,7 +1255,7 @@
 							"fileName": "config/config.ts",
 							"line": 18,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/config/config.ts#L18"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/config/config.ts#L18"
 						}
 					],
 					"type": {
@@ -1291,24 +1282,56 @@
 							"fileName": "config/config.ts",
 							"line": 8,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/config/config.ts#L8"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/config/config.ts#L8"
 						}
 					],
 					"type": {
 						"type": "intrinsic",
 						"name": "string"
 					}
+				},
+				{
+					"id": 55,
+					"name": "user",
+					"variant": "declaration",
+					"kind": 1024,
+					"flags": {
+						"isOptional": true
+					},
+					"comment": {
+						"summary": [
+							{
+								"kind": "text",
+								"text": "The application's user identity. If not set in the config, Relay will assume the identity matches\nthe identity in the authentication or anonymous otherwise."
+							}
+						]
+					},
+					"sources": [
+						{
+							"fileName": "config/config.ts",
+							"line": 24,
+							"character": 2,
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/config/config.ts#L24"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"target": 58,
+						"name": "User",
+						"package": "@coveo/relay"
+					}
 				}
 			],
 			"groups": [
 				{
 					"title": "Properties",
 					"children": [
-						55,
 						56,
+						57,
 						53,
 						54,
-						52
+						52,
+						55
 					]
 				}
 			],
@@ -1317,12 +1340,12 @@
 					"fileName": "config/config.ts",
 					"line": 4,
 					"character": 17,
-					"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/config/config.ts#L4"
+					"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/config/config.ts#L4"
 				}
 			]
 		},
 		{
-			"id": 60,
+			"id": 61,
 			"name": "RelayEvent",
 			"variant": "declaration",
 			"kind": 256,
@@ -1337,7 +1360,7 @@
 			},
 			"children": [
 				{
-					"id": 61,
+					"id": 62,
 					"name": "meta",
 					"variant": "declaration",
 					"kind": 1024,
@@ -1363,7 +1386,7 @@
 							"fileName": "event/relay-event.ts",
 							"line": 14,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/relay-event.ts#L14"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/relay-event.ts#L14"
 						}
 					],
 					"type": {
@@ -1389,7 +1412,7 @@
 				{
 					"title": "Properties",
 					"children": [
-						61
+						62
 					]
 				}
 			],
@@ -1398,20 +1421,20 @@
 					"fileName": "event/relay-event.ts",
 					"line": 10,
 					"character": 17,
-					"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/event/relay-event.ts#L10"
+					"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/event/relay-event.ts#L10"
 				}
 			],
 			"extendedTypes": [
 				{
 					"type": "reference",
-					"target": 59,
+					"target": 60,
 					"name": "RelayPayload",
 					"package": "@coveo/relay"
 				}
 			]
 		},
 		{
-			"id": 57,
+			"id": 58,
 			"name": "User",
 			"variant": "declaration",
 			"kind": 256,
@@ -1426,7 +1449,7 @@
 			},
 			"children": [
 				{
-					"id": 58,
+					"id": 59,
 					"name": "id",
 					"variant": "declaration",
 					"kind": 1024,
@@ -1435,21 +1458,30 @@
 						"summary": [
 							{
 								"kind": "text",
-								"text": "The application's user identifier."
+								"text": "The application's user identifier. An id of 'anonymous' assumes the user is explicitly anonymous. An id of null indicates\nthe identity is equal to the identity in the authentication or anonymous."
 							}
 						]
 					},
 					"sources": [
 						{
 							"fileName": "config/config.ts",
-							"line": 43,
+							"line": 50,
 							"character": 2,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/config/config.ts#L43"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/config/config.ts#L50"
 						}
 					],
 					"type": {
-						"type": "intrinsic",
-						"name": "string"
+						"type": "union",
+						"types": [
+							{
+								"type": "literal",
+								"value": null
+							},
+							{
+								"type": "intrinsic",
+								"name": "string"
+							}
+						]
 					}
 				}
 			],
@@ -1457,16 +1489,16 @@
 				{
 					"title": "Properties",
 					"children": [
-						58
+						59
 					]
 				}
 			],
 			"sources": [
 				{
 					"fileName": "config/config.ts",
-					"line": 39,
+					"line": 45,
 					"character": 17,
-					"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/config/config.ts#L39"
+					"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/config/config.ts#L45"
 				}
 			]
 		},
@@ -1481,7 +1513,7 @@
 					"fileName": "listener/listener.ts",
 					"line": 11,
 					"character": 12,
-					"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/listener/listener.ts#L11"
+					"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/listener/listener.ts#L11"
 				}
 			],
 			"type": {
@@ -1497,7 +1529,7 @@
 							"fileName": "listener/listener.ts",
 							"line": 11,
 							"character": 28,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/listener/listener.ts#L11"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/listener/listener.ts#L11"
 						}
 					],
 					"signatures": [
@@ -1538,7 +1570,7 @@
 									},
 									"type": {
 										"type": "reference",
-										"target": 60,
+										"target": 61,
 										"name": "RelayEvent",
 										"package": "@coveo/relay"
 									}
@@ -1564,7 +1596,7 @@
 					"fileName": "relay.ts",
 					"line": 16,
 					"character": 12,
-					"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L16"
+					"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L16"
 				}
 			],
 			"type": {
@@ -1580,7 +1612,7 @@
 							"fileName": "relay.ts",
 							"line": 16,
 							"character": 18,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L16"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L16"
 						}
 					],
 					"signatures": [
@@ -1614,7 +1646,7 @@
 			}
 		},
 		{
-			"id": 59,
+			"id": 60,
 			"name": "RelayPayload",
 			"variant": "declaration",
 			"kind": 2097152,
@@ -1632,7 +1664,7 @@
 					"fileName": "relay-payload.ts",
 					"line": 5,
 					"character": 12,
-					"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay-payload.ts#L5"
+					"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay-payload.ts#L5"
 				}
 			],
 			"type": {
@@ -1657,7 +1689,7 @@
 			"extendedBy": [
 				{
 					"type": "reference",
-					"target": 60,
+					"target": 61,
 					"name": "RelayEvent"
 				}
 			]
@@ -1673,7 +1705,7 @@
 					"fileName": "relay.ts",
 					"line": 83,
 					"character": 16,
-					"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L83"
+					"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L83"
 				}
 			],
 			"signatures": [
@@ -1702,7 +1734,7 @@
 							"fileName": "relay.ts",
 							"line": 83,
 							"character": 16,
-							"url": "https://github.com/coveo/relay/blob/36744a6/packages/relay/src/relay.ts#L83"
+							"url": "https://github.com/coveo/relay/blob/1f22674/packages/relay/src/relay.ts#L83"
 						}
 					],
 					"parameters": [
@@ -1738,8 +1770,8 @@
 				35,
 				7,
 				51,
-				60,
-				57
+				61,
+				58
 			]
 		},
 		{
@@ -1747,7 +1779,7 @@
 			"children": [
 				47,
 				4,
-				59
+				60
 			]
 		},
 		{
@@ -1758,7 +1790,7 @@
 		}
 	],
 	"packageName": "@coveo/relay",
-	"packageVersion": "0.7.4",
+	"packageVersion": "0.7.5",
 	"readme": [
 		{
 			"kind": "text",
@@ -1996,29 +2028,33 @@
 		},
 		"55": {
 			"sourceFileName": "src/config/config.ts",
-			"qualifiedName": "RelayConfig.mode"
+			"qualifiedName": "RelayConfig.user"
 		},
 		"56": {
 			"sourceFileName": "src/config/config.ts",
-			"qualifiedName": "RelayConfig.source"
+			"qualifiedName": "RelayConfig.mode"
 		},
 		"57": {
 			"sourceFileName": "src/config/config.ts",
-			"qualifiedName": "User"
+			"qualifiedName": "RelayConfig.source"
 		},
 		"58": {
 			"sourceFileName": "src/config/config.ts",
-			"qualifiedName": "User.id"
+			"qualifiedName": "User"
 		},
 		"59": {
+			"sourceFileName": "src/config/config.ts",
+			"qualifiedName": "User.id"
+		},
+		"60": {
 			"sourceFileName": "src/relay-payload.ts",
 			"qualifiedName": "RelayPayload"
 		},
-		"60": {
+		"61": {
 			"sourceFileName": "src/event/relay-event.ts",
 			"qualifiedName": "RelayEvent"
 		},
-		"61": {
+		"62": {
 			"sourceFileName": "src/event/relay-event.ts",
 			"qualifiedName": "RelayEvent.meta"
 		}

package/lib/relay.cjs

@@ -34,11 +34,11 @@ function createClientIdManager(environmentManager) {
     };
 }
 
-const version = "0.7.4";
+const version = "0.7.5";
 
 function getEventConfig(config) {
-    const { trackingId } = config;
-    return { trackingId, user: null };
+    const { trackingId, user } = config;
+    return { trackingId, user: user || { id: null } };
 }
 function getSource(config) {
     return (config.source || []).concat([`relay@${version}`]);
@@ -126,6 +126,7 @@ function pick({ url, token, trackingId, ...rest }) {
         url,
         token,
         trackingId,
+        ...(!!rest.user && { user: rest.user }),
         ...(!!rest.mode && { mode: rest.mode }),
         ...(!!rest.source && { source: rest.source }),
     });

package/lib/relay.js

@@ -32,11 +32,11 @@ function createClientIdManager(environmentManager) {
     };
 }
 
-const version = "0.7.4";
+const version = "0.7.5";
 
 function getEventConfig(config) {
-    const { trackingId } = config;
-    return { trackingId, user: null };
+    const { trackingId, user } = config;
+    return { trackingId, user: user || { id: null } };
 }
 function getSource(config) {
     return (config.source || []).concat([`relay@${version}`]);
@@ -124,6 +124,7 @@ function pick({ url, token, trackingId, ...rest }) {
         url,
         token,
         trackingId,
+        ...(!!rest.user && { user: rest.user }),
         ...(!!rest.mode && { mode: rest.mode }),
         ...(!!rest.source && { source: rest.source }),
     });

package/lib/relay.mjs

@@ -32,11 +32,11 @@ function createClientIdManager(environmentManager) {
     };
 }
 
-const version = "0.7.4";
+const version = "0.7.5";
 
 function getEventConfig(config) {
-    const { trackingId } = config;
-    return { trackingId, user: null };
+    const { trackingId, user } = config;
+    return { trackingId, user: user || { id: null } };
 }
 function getSource(config) {
     return (config.source || []).concat([`relay@${version}`]);
@@ -124,6 +124,7 @@ function pick({ url, token, trackingId, ...rest }) {
         url,
         token,
         trackingId,
+        ...(!!rest.user && { user: rest.user }),
         ...(!!rest.mode && { mode: rest.mode }),
         ...(!!rest.source && { source: rest.source }),
     });

package/lib/types/config/config.d.ts

@@ -14,6 +14,11 @@ export interface RelayConfig {
      * The unique identifier of a web property. See [Tracking ID](https://docs.coveo.com/en/n8tg0567/).
      */
     trackingId: string;
+    /**
+     * The application's user identity. If not set in the config, Relay will assume the identity matches
+     * the identity in the authentication or anonymous otherwise.
+     */
+    user?: User;
     /**
      * Defines the library mode. The available modes are `emit` and `disabled`.
      * `emit` sends analytics events to Coveo to be stored.
@@ -33,9 +38,10 @@ export interface RelayConfig {
  */
 export interface User {
     /**
-     * The application's user identifier.
+     * The application's user identifier. An id of 'anonymous' assumes the user is explicitly anonymous. An id of null indicates
+     * the identity is equal to the identity in the authentication or anonymous.
      */
-    id: string;
+    id: string | null;
 }
 export interface ConfigManager {
     get: () => Readonly<RelayConfig>;

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

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/config/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;IACjC,MAAM,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;CACvD;AAiBD,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,WAAW,GACzB,QAAQ,CAAC,aAAa,CAAC,CASzB"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/config/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;IACjC,MAAM,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;CACvD;AAkBD,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,WAAW,GACzB,QAAQ,CAAC,aAAa,CAAC,CASzB"}

package/lib/types/event/meta/meta.d.ts

@@ -12,7 +12,7 @@ export interface EventConfig {
     /**
      * Named user identity which logged this event.
      */
-    user: User | null;
+    user: User;
 }
 /**
  * The `Meta` object provides a structured representation of metadata associated with an emitted event.

package/lib/types/event/meta/meta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../../src/event/meta/meta.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAWD,wBAAgB,UAAU,CACxB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAAC,IAAI,CAAC,CAehB"}
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../../src/event/meta/meta.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAWD,wBAAgB,UAAU,CACxB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAAC,IAAI,CAAC,CAehB"}

package/package.json

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