@coveo/relay 0.6.2 → 0.6.4

package/lib/cdn/relay.min.js

@@ -1,2 +1,2 @@
-async function e(e){const{listenerManager:t,event:n,config:r}=e;return"disabled"!==r.mode&&t.call(n),"validate"===r.mode?async function({config:e,environment:t,event:n}){const{url:r,token:o}=e,a={"Content-Type":"application/json",Authorization:`Bearer ${o}`},c=await t.fetch(`${r}/validate`,{method:"POST",body:JSON.stringify([n]),headers:a}),i=await c.json();if(!c.ok)throw new Error({...i});if(!i)return{valid:!1,errors:[{type:"",message:"disabled",path:""}]};const{valid:s,errors:l}=i[0];return{valid:s,errors:l??[]}}(e):async function({event:e,config:t,environment:n}){const{url:r,token:o}=t;return n.send(r,o,JSON.stringify([e]))}(e)}var t=/^(?:[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 n(e){const n="visitorId";return{getClientId:()=>{const r=e.storage,o=r.getItem(n),a=o&&("string"==typeof(c=o)&&t.test(c))?o:e.generateUUID();var c;return r.setItem(n,a),a},clear:()=>{e.storage.removeItem(n)}}}const r=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),a=`;expires=${new Date((new Date).getTime()+r).toUTCString()}`,c=o?`;domain=${o}`:"";document.cookie=`${e}${t}=${n}${a}${c};path=/;SameSite=Lax`},removeItem(e){this.setItem(e,"",-1)}}}();async function o(e,t){return fetch(e,t).catch((e=>{throw new Error(`${e.message}: The "host" value is invalid or a network error occured, according to the FetchAPI's response.`,{cause:e})}))}function a(){return{runtime:"browser",fetch:(e,t)=>o(e,t),send:async(e,t,n)=>{if(!navigator.sendBeacon(`${e}?access_token=${t}`,new Blob([n],{type:"application/json"})))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.");return null},getReferrerUrl:()=>function(){const e=document.referrer;return""===e?null:e}(),getUrl:()=>window.location.href,getUserAgent:()=>navigator.userAgent,generateUUID:()=>crypto.randomUUID(),storage:{getItem:e=>r.getItem(e)||localStorage.getItem(e),removeItem(e){r.removeItem(e),localStorage.removeItem(e)},setItem(e,t){localStorage.setItem(e,t),r.setItem(e,t,31556952e3)}}}}function c(){return{getItem:()=>null,removeItem(){},setItem(){}}}function i(){return function(){try{return"object"==typeof window}catch(e){return!1}}()?a():{runtime:"node",fetch:(e,t)=>o(e,t),send:async(e,t,n)=>(o(e,{method:"POST",body:n,headers:{"Content-Type":"application/json",Authorization:`Bearer ${t}`}}),null),getReferrerUrl:()=>null,getUrl:()=>null,getUserAgent:()=>null,generateUUID:()=>crypto.randomUUID(),storage:c()}}const s="0.6.2";function l(e,t,n,r){const{getReferrerUrl:o,getUrl:a,getUserAgent:c}=n,i=function(e){const{trackingId:t}=e;return{trackingId:t}}(t),l=r.getClientId();return Object.freeze({type:e,config:i,ts:Date.now(),source:`relay@${s}`,clientId:l,userAgent:c(),referrerUrl:o(),url:a()})}const u="*";function g(){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===u)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 f({url:e,token:t,trackingId:n,...r}){return Object.freeze({url:e,token:t,trackingId:n,...!!r.mode&&{mode:r.mode}})}function d(t){const r=function(e){let t=f(e);return{get:()=>t,update:e=>{t=f({...t,...e})}}}(t),o=g(),a=()=>"disabled"==r.get().mode?{runtime:"null",fetch:()=>Promise.resolve(new Response(JSON.stringify(""))),send:async()=>null,getReferrerUrl:()=>null,getUrl:()=>null,getUserAgent:()=>null,generateUUID:()=>"",storage:c()}:i(),u=n(a());return{emit:(t,n)=>{const c=r.get(),i=a(),s=function(e,t,n,r,o){return{...t,meta:l(e,n,r,o)}}(t,n,c,i,u);return e({config:c,environment:i,event:s,listenerManager:o})},getMeta:e=>l(e,r.get(),a(),u),on:(e,t)=>o.add({type:e,callback:t}),off:(e,t)=>o.remove(e,t),updateConfig:e=>r.update(e),version:s,clearStorage:()=>{u.clear()}}}export{d as createRelay};
+async function e(e){const{listenerManager:t,event:n,config:r}=e;return"disabled"!==r.mode&&t.call(n),"validate"===r.mode?async function({config:e,environment:t,event:n}){const{url:r,token:o}=e,a={"Content-Type":"application/json",Authorization:`Bearer ${o}`},c=await t.fetch(`${r}/validate`,{method:"POST",body:JSON.stringify([n]),headers:a}),i=await c.json();if(!c.ok)throw new Error({...i});if(!i)return{valid:!1,errors:[{type:"",message:"disabled",path:""}]};const{valid:s,errors:l}=i[0];return{valid:s,errors:l??[]}}(e):async function({event:e,config:t,environment:n}){const{url:r,token:o}=t;return n.send(r,o,JSON.stringify([e]))}(e)}var t=/^(?:[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 n(e){const n="visitorId";return{getClientId:()=>{const r=e.storage,o=r.getItem(n),a=o&&("string"==typeof(c=o)&&t.test(c))?o:e.generateUUID();var c;return r.setItem(n,a),a},clear:()=>{e.storage.removeItem(n)}}}const r=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),a=`;expires=${new Date((new Date).getTime()+r).toUTCString()}`,c=o?`;domain=${o}`:"";document.cookie=`${e}${t}=${n}${a}${c};path=/;SameSite=Lax`},removeItem(e){this.setItem(e,"",-1)}}}();async function o(e,t){return fetch(e,t).catch((e=>{throw new Error(`${e.message}: The "host" value is invalid or a network error occured, according to the FetchAPI's response.`,{cause:e})}))}function a(){return{runtime:"browser",fetch:(e,t)=>o(e,t),send:async(e,t,n)=>{if(!navigator.sendBeacon(`${e}?access_token=${t}`,new Blob([n],{type:"application/json"})))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.");return null},getReferrer:()=>function(){const e=document.referrer;return""===e?null:e}(),getLocation:()=>window.location.href,getUserAgent:()=>navigator.userAgent,generateUUID:()=>crypto.randomUUID(),storage:{getItem:e=>r.getItem(e)||localStorage.getItem(e),removeItem(e){r.removeItem(e),localStorage.removeItem(e)},setItem(e,t){localStorage.setItem(e,t),r.setItem(e,t,31556952e3)}}}}function c(){return{getItem:()=>null,removeItem(){},setItem(){}}}function i(){return function(){try{return"object"==typeof window}catch(e){return!1}}()?a():{runtime:"node",fetch:(e,t)=>o(e,t),send:async(e,t,n)=>(o(e,{method:"POST",body:n,headers:{"Content-Type":"application/json",Authorization:`Bearer ${t}`}}),null),getReferrer:()=>null,getLocation:()=>null,getUserAgent:()=>null,generateUUID:()=>crypto.randomUUID(),storage:c()}}const s="0.6.4";function l(e,t,n,r){const{getReferrer:o,getLocation:a,getUserAgent:c}=n,i=function(e){const{trackingId:t}=e;return{trackingId:t}}(t),l=r.getClientId();return Object.freeze({type:e,config:i,ts:Date.now(),source:`relay@${s}`,clientId:l,userAgent:c(),referrer:o(),location:a()})}const u="*";function g(){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===u)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 f({url:e,token:t,trackingId:n,...r}){return Object.freeze({url:e,token:t,trackingId:n,...!!r.mode&&{mode:r.mode}})}function d(t){const r=function(e){let t=f(e);return{get:()=>t,update:e=>{t=f({...t,...e})}}}(t),o=g(),a=()=>"disabled"==r.get().mode?{runtime:"null",fetch:()=>Promise.resolve(new Response(JSON.stringify(""))),send:async()=>null,getReferrer:()=>null,getLocation:()=>null,getUserAgent:()=>null,generateUUID:()=>"",storage:c()}:i(),u=n(a());return{emit:(t,n)=>{const c=r.get(),i=a(),s=function(e,t,n,r,o){return{...t,meta:l(e,n,r,o)}}(t,n,c,i,u);return e({config:c,environment:i,event:s,listenerManager:o})},getMeta:e=>l(e,r.get(),a(),u),on:(e,t)=>o.add({type:e,callback:t}),off:(e,t)=>o.remove(e,t),updateConfig:e=>r.update(e),version:s,clearStorage:()=>{u.clear()}}}export{d as createRelay};
 //# sourceMappingURL=relay.min.js.map

package/lib/cdn/relay.min.js.map

@@ -1 +1 @@
-{"version":3,"file":"relay.min.js","sources":["../../src/emit/emit.ts","../../src/validate/validate.ts","../../../../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/environment/browser/storage/cookie.ts","../../src/environment/utils/fetch.ts","../../src/environment/browser/browser.ts","../../src/environment/browser/storage/storage.ts","../../src/environment/storage.ts","../../src/environment/environment.ts","../../src/environment/node/node.ts","../../src/version.ts","../../src/event/meta/meta.ts","../../src/listener/listener.ts","../../src/config/config.ts","../../src/relay.ts","../../src/environment/null/null.ts","../../src/event/relay-event.ts"],"sourcesContent":["import { Environment } from \"../environment/environment\";\nimport { ListenerManager } from \"../listener/listener\";\nimport { validate } from \"../validate/validate\";\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 async function emit(params: EmitParams) {\n  const { listenerManager, event, config } = params;\n  const isEnabled = config.mode !== \"disabled\";\n\n  isEnabled && listenerManager.call(event);\n  return config.mode === \"validate\" ? validate(params) : emitEvent(params);\n}\n\nexport async function emitEvent({\n  event,\n  config,\n  environment,\n}: EmitParams): Promise<null> {\n  const { url, token } = config;\n\n  return environment.send(url, token, JSON.stringify([event]));\n}\n","import { Environment } from \"../environment/environment\";\nimport { RelayEvent } from \"../event/relay-event\";\nimport { RelayConfig } from \"../relay\";\n\nexport interface ValidateParams {\n  config: RelayConfig;\n  environment: Environment;\n  event: Readonly<RelayEvent>;\n}\n\nexport interface ValidationError {\n  type: string;\n  message: string;\n  path: string;\n}\n\nexport interface ValidationResponse {\n  valid: boolean;\n  errors: ValidationError[];\n}\n\nexport async function validate({\n  config,\n  environment,\n  event,\n}: ValidateParams): Promise<Readonly<ValidationResponse>> {\n  const { url, token } = config;\n  const headers = {\n    \"Content-Type\": \"application/json\",\n    Authorization: `Bearer ${token}`,\n  };\n\n  const response = await environment.fetch(`${url}/validate`, {\n    method: \"POST\",\n    body: JSON.stringify([event]),\n    headers,\n  });\n  const data = await response.json();\n\n  if (!response.ok) {\n    throw new Error({\n      ...data,\n    });\n  }\n\n  if (!data) {\n    return {\n      valid: false,\n      errors: [{ type: \"\", message: \"disabled\", path: \"\" }],\n    };\n  }\n\n  const { valid, errors } = data[0];\n\n  return { valid, errors: errors ?? [] };\n}\n","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 { Environment } from \"../environment/environment\";\n\nexport interface ClientIdManager {\n  getClientId: () => string;\n  clear: () => void;\n}\n\nexport function createClientIdManager(\n  environment: Environment\n): ClientIdManager {\n  const key = \"visitorId\";\n  return {\n    getClientId: () => {\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      environment.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 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","export async function fetchAPI(\n  url: string,\n  init?: RequestInit\n): Promise<Response> {\n  return fetch(url, init).catch((err: Error) => {\n    throw new Error(\n      `${err.message}: The \"host\" value is invalid or a network error occured, according to the FetchAPI's response.`,\n      { cause: err }\n    );\n  });\n}\n","import { Environment } from \"../environment\";\nimport { createBrowserStorage } from \"./storage/storage\";\nimport { fetchAPI } from \"../utils/fetch\";\n\nfunction getReferrerUrl() {\n  const referrer = document.referrer;\n\n  return referrer === \"\" ? null : referrer;\n}\n\nexport function buildBrowserEnvironment(): Environment {\n  return {\n    runtime: \"browser\",\n    fetch: (url: string, init?: RequestInit) => fetchAPI(url, init),\n    send: async (url: string, token: string, body: string) => {\n      const response = navigator.sendBeacon(\n        `${url}?access_token=${token}`,\n        new Blob([body], {\n          type: \"application/json\",\n        })\n      );\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      return null;\n    },\n    getReferrerUrl: () => getReferrerUrl(),\n    getUrl: () => window.location.href,\n    getUserAgent: () => navigator.userAgent,\n    generateUUID: () => crypto.randomUUID(),\n    storage: createBrowserStorage(),\n  };\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","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 { buildBrowserEnvironment } from \"./browser/browser\";\nimport { buildNodeEnvironment } from \"./node/node\";\nimport { Storage } from \"./storage\";\n\nexport interface Environment {\n  runtime: \"browser\" | \"node\" | \"null\";\n  fetch: (url: string, init?: RequestInit) => Promise<Response>;\n  send: (url: string, token: string, body: string) => Promise<null>;\n  getReferrerUrl: () => string | null;\n  getUrl: () => string | null;\n  getUserAgent: () => string | null;\n  generateUUID: () => string;\n  storage: Storage;\n}\n\nexport function currentEnvironment(): Environment {\n  return isBrowser() ? buildBrowserEnvironment() : buildNodeEnvironment();\n}\n\nfunction isBrowser() {\n  try {\n    return typeof window === \"object\";\n  } catch (e) {\n    return false;\n  }\n}\n","import { Environment } from \"../environment\";\nimport { createNullStorage } from \"../storage\";\nimport { fetchAPI } from \"../utils/fetch\";\n\nexport function buildNodeEnvironment(): Environment {\n  return {\n    runtime: \"node\",\n    fetch: (url: string, init?: RequestInit) => fetchAPI(url, init),\n    send: async (url: string, token: string, body: string) => {\n      const headers = {\n        \"Content-Type\": \"application/json\",\n        Authorization: `Bearer ${token}`,\n      };\n      fetchAPI(url, {\n        method: \"POST\",\n        body,\n        headers,\n      });\n      return null;\n    },\n    getReferrerUrl: () => null,\n    getUrl: () => null,\n    getUserAgent: () => null,\n    generateUUID: () => crypto.randomUUID(),\n    storage: createNullStorage(),\n  };\n}\n","export const version: string = process.env.VERSION ?? \"\";\n","import { ClientIdManager } from \"../../client-id/client-id\";\nimport { Environment } from \"../../environment/environment\";\nimport { RelayConfig } from \"../../config/config\";\nimport { version } from \"../../version\";\n\ninterface EventConfig {\n  trackingId: string;\n}\n\nexport interface Meta {\n  type: string;\n  config: EventConfig;\n  ts: number;\n  source: string;\n  clientId: string;\n  userAgent: string | null;\n  referrerUrl: string | null;\n  url: string | null;\n}\n\nfunction getEventConfig(config: RelayConfig): EventConfig {\n  const { trackingId } = config;\n  return { trackingId };\n}\n\nfunction getSource(): string {\n  return `relay@${version}`;\n}\n\nexport function createMeta(\n  type: string,\n  config: RelayConfig,\n  environment: Environment,\n  clientIdManager: ClientIdManager\n): Readonly<Meta> {\n  const { getReferrerUrl, getUrl, getUserAgent } = environment;\n  const eventConfig = getEventConfig(config);\n  const clientId = clientIdManager.getClientId();\n\n  return Object.freeze({\n    type,\n    config: eventConfig,\n    ts: Date.now(),\n    source: getSource(),\n    clientId,\n    userAgent: getUserAgent(),\n    referrerUrl: getReferrerUrl(),\n    url: getUrl(),\n  });\n}\n","import { RelayEvent } from \"../event/relay-event\";\n\nconst ANY_EVENT_TYPE = \"*\";\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","export type RelayMode = \"emit\" | \"validate\" | \"disabled\";\n\nexport interface RelayConfig {\n  url: string;\n  token: string;\n  trackingId: string;\n  mode?: RelayMode;\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  });\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","import { emit } from \"./emit/emit\";\nimport { createClientIdManager } from \"./client-id/client-id\";\nimport { currentEnvironment } from \"./environment/environment\";\nimport { createRelayEvent } from \"./event/relay-event\";\nimport { version } from \"./version\";\nimport { createMeta, Meta } from \"./event/meta/meta\";\nimport { createListenerManager, EventCallback } from \"./listener/listener\";\nimport { createConfigManager, RelayConfig } from \"./config/config\";\nimport { ValidationError, ValidationResponse } from \"./validate/validate\";\nimport { buildNullEnvironment } from \"./environment/null/null\";\n\ntype RelayPayload = Record<string, unknown>;\ntype Off = () => void;\n\ninterface Relay {\n  emit: (\n    type: string,\n    payload: RelayPayload\n  ) => Promise<ValidationResponse | null>;\n  getMeta: (type: string) => Meta;\n  on: (type: string, callback: EventCallback) => Off;\n  off: (type: string, callback?: EventCallback) => void;\n  updateConfig: (config: Partial<RelayConfig>) => void;\n  version: string;\n  clearStorage: () => void;\n}\n\nexport function createRelay(initialConfig: RelayConfig): Relay {\n  const configManager = createConfigManager(initialConfig);\n  const listenerManager = createListenerManager();\n\n  const getEnvironment = () =>\n    configManager.get().mode == \"disabled\"\n      ? buildNullEnvironment()\n      : currentEnvironment();\n  const clientIdManager = createClientIdManager(getEnvironment());\n\n  return {\n    emit: (type: string, payload: RelayPayload) => {\n      const config = configManager.get();\n      const environment = getEnvironment();\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(type, configManager.get(), getEnvironment(), clientIdManager),\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 { RelayPayload, RelayConfig, ValidationError, ValidationResponse };\n","import { Environment } from \"../environment\";\nimport { createNullStorage } from \"../storage\";\n\nexport function buildNullEnvironment(): Environment {\n  return {\n    runtime: \"null\",\n    fetch: () => Promise.resolve(new Response(JSON.stringify(\"\"))),\n    send: async () => null,\n    getReferrerUrl: () => null,\n    getUrl: () => null,\n    getUserAgent: () => null,\n    generateUUID: () => \"\",\n    storage: createNullStorage(),\n  };\n}\n","import { ClientIdManager } from \"../client-id/client-id\";\nimport { Environment } from \"../environment/environment\";\nimport { RelayConfig, RelayPayload } from \"../relay\";\nimport { createMeta, Meta } from \"./meta/meta\";\n\nexport interface RelayEvent extends RelayPayload {\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"],"names":["async","emit","params","listenerManager","event","config","mode","call","environment","url","token","headers","Authorization","response","fetch","method","body","JSON","stringify","data","json","ok","Error","valid","errors","type","message","path","validate","send","emitEvent","REGEX","createClientIdManager","key","getClientId","storage","existingClientId","getItem","clientId","uuid","test","generateUUID","setItem","clear","removeItem","cookieManager","prefix","cookiePrefix","cookieArray","document","cookie","split","prettifyCookie","replace","lastIndexOf","substring","length","expire","domain","host","parts","slice","join","getDomain","window","location","hostname","expireSection","Date","getTime","toUTCString","domainSection","this","createCookieManager","fetchAPI","init","catch","err","cause","buildBrowserEnvironment","runtime","navigator","sendBeacon","Blob","getReferrerUrl","referrer","getUrl","href","getUserAgent","userAgent","crypto","randomUUID","localStorage","createNullStorage","currentEnvironment","e","isBrowser","version","createMeta","clientIdManager","eventConfig","trackingId","getEventConfig","Object","freeze","ts","now","source","referrerUrl","ANY_EVENT_TYPE","createListenerManager","listeners","getListenerIndex","callback","findIndex","listener","remove","index","splice","removeOne","i","removeMultiple","add","push","forEach","isMatchesType","meta","console","error","pick","rest","createRelay","initialConfig","configManager","_config","get","update","updatedConfig","createConfigManager","getEnvironment","Promise","resolve","Response","payload","createRelayEvent","getMeta","on","off","updateConfig","clearStorage"],"mappings":"AAaOA,eAAeC,EAAKC,GACzB,MAAMC,gBAAEA,EAAeC,MAAEA,EAAKC,OAAEA,GAAWH,EAI3C,MAHkC,aAAhBG,EAAOC,MAEZH,EAAgBI,KAAKH,GACX,aAAhBC,EAAOC,KCGTN,gBAAwBK,OAC7BA,EAAMG,YACNA,EAAWJ,MACXA,IAEA,MAAMK,IAAEA,EAAGC,MAAEA,GAAUL,EACjBM,EAAU,CACd,eAAgB,mBAChBC,cAAe,UAAUF,KAGrBG,QAAiBL,EAAYM,MAAM,GAAGL,aAAgB,CAC1DM,OAAQ,OACRC,KAAMC,KAAKC,UAAU,CAACd,IACtBO,YAEIQ,QAAaN,EAASO,OAE5B,IAAKP,EAASQ,GACZ,MAAM,IAAIC,MAAM,IACXH,IAIP,IAAKA,EACH,MAAO,CACLI,OAAO,EACPC,OAAQ,CAAC,CAAEC,KAAM,GAAIC,QAAS,WAAYC,KAAM,MAIpD,MAAMJ,MAAEA,EAAKC,OAAEA,GAAWL,EAAK,GAE/B,MAAO,CAAEI,QAAOC,OAAQA,GAAU,GACpC,CDrCsCI,CAAS1B,GAGxCF,gBAAyBI,MAC9BA,EAAKC,OACLA,EAAMG,YACNA,IAEA,MAAMC,IAAEA,EAAGC,MAAEA,GAAUL,EAEvB,OAAOG,EAAYqB,KAAKpB,EAAKC,EAAOO,KAAKC,UAAU,CAACd,IACtD,CAXyD0B,CAAU5B,EACnE,CEnBA,IAAA6B,EAAe,sHCQT,SAAUC,EACdxB,GAEA,MAAMyB,EAAM,YACZ,MAAO,CACLC,YAAa,KACX,MAAMC,EAAU3B,EAAY2B,QAEtBC,EAAmBD,EAAQE,QAAQJ,GACnCK,EACJF,ICfiB,iBADPG,EDgBmBH,ICfAL,EAAMS,KAAKD,IDgBpCH,EACA5B,EAAYiC,eClBxB,IAAkBF,EDoBZ,OADAJ,EAAQO,QAAQT,EAAKK,GACdA,CAAQ,EAEjBK,MAAO,KACLnC,EAAY2B,QAAQS,WAAWX,EAAI,EAGzC,CEtBO,MAAMY,EAEb,WACE,MAAMC,EAAS,SAMf,MAAO,CACL,OAAAT,CAAQJ,GACN,MAAMc,EAAe,GAAGD,IAASb,KAC3Be,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,EAAaS,OACbJ,EAAeI,OAGpB,CACD,OAAO,IACR,EACD,OAAAd,CAAQT,EAAad,EAAcsC,GACjC,MAAMC,EArBQ,CAACC,IACjB,MAAMC,EAAQD,EAAKR,MAAM,KAAKU,OAAO,GACrC,OAAuB,GAAhBD,EAAMJ,OAAcI,EAAME,KAAK,KAAO,EAAE,EAmB9BC,CAAUC,OAAOC,SAASC,UACnCC,EAAgB,YAAY,IAAIC,MACpC,IAAIA,MAAOC,UAAYZ,GACvBa,gBACIC,EAAgBb,EAAS,WAAWA,IAAW,GACrDT,SAASC,OAAS,GAAGJ,IAASb,KAAOd,IAAOgD,IAAgBI,uBAC7D,EAED,UAAA3B,CAAWX,GACTuC,KAAK9B,QAAQT,EAAK,IAAK,EACxB,EAEL,CArC4CwC,GCNrCzE,eAAe0E,EACpBjE,EACAkE,GAEA,OAAO7D,MAAML,EAAKkE,GAAMC,OAAOC,IAC7B,MAAM,IAAIvD,MACR,GAAGuD,EAAInD,yGACP,CAAEoD,MAAOD,GACV,GAEL,UCAgBE,IACd,MAAO,CACLC,QAAS,UACTlE,MAAO,CAACL,EAAakE,IAAuBD,EAASjE,EAAKkE,GAC1D9C,KAAM7B,MAAOS,EAAaC,EAAeM,KAQvC,IAPiBiE,UAAUC,WACzB,GAAGzE,kBAAoBC,IACvB,IAAIyE,KAAK,CAACnE,GAAO,CACfS,KAAM,sBAKR,MAAM,IAAIH,MACR,mJAIJ,OAAO,IAAI,EAEb8D,eAAgB,IA1BpB,WACE,MAAMC,EAAWpC,SAASoC,SAE1B,MAAoB,KAAbA,EAAkB,KAAOA,CAClC,CAsB0BD,GACtBE,OAAQ,IAAMtB,OAAOC,SAASsB,KAC9BC,aAAc,IAAMP,UAAUQ,UAC9BhD,aAAc,IAAMiD,OAAOC,aAC3BxD,QC9BK,CACLE,QAAQJ,GACCY,EAAcR,QAAQJ,IAAQ2D,aAAavD,QAAQJ,GAG5D,UAAAW,CAAWX,GACTY,EAAcD,WAAWX,GACzB2D,aAAahD,WAAWX,EACzB,EAED,OAAAS,CAAQT,EAAad,GAEnByE,aAAalD,QAAQT,EAAKd,GAC1B0B,EAAcH,QAAQT,EAAKd,EAFX,WAGjB,GDkBL,UE9BgB0E,IACd,MAAO,CACLxD,QAAO,IACE,KAET,UAAAO,GAEC,EACD,OAAAF,GAEC,EAEL,UCHgBoD,IACd,OAGF,WACE,IACE,MAAyB,iBAAX9B,MACf,CAAC,MAAO+B,GACP,OAAO,CACR,CACH,CATSC,GAAcjB,ICXd,CACLC,QAAS,OACTlE,MAAO,CAACL,EAAakE,IAAuBD,EAASjE,EAAKkE,GAC1D9C,KAAM7B,MAAOS,EAAaC,EAAeM,KAKvC0D,EAASjE,EAAK,CACZM,OAAQ,OACRC,OACAL,QAPc,CACd,eAAgB,mBAChBC,cAAe,UAAUF,OAOpB,MAET0E,eAAgB,IAAM,KACtBE,OAAQ,IAAM,KACdE,aAAc,IAAM,KACpB/C,aAAc,IAAMiD,OAAOC,aAC3BxD,QAAS0D,IDPb,CEjBO,MAAMI,EAAkB,QC6BzB,SAAUC,EACdzE,EACApB,EACAG,EACA2F,GAEA,MAAMf,eAAEA,EAAcE,OAAEA,EAAME,aAAEA,GAAiBhF,EAC3C4F,EAhBR,SAAwB/F,GACtB,MAAMgG,WAAEA,GAAehG,EACvB,MAAO,CAAEgG,aACX,CAasBC,CAAejG,GAC7BiC,EAAW6D,EAAgBjE,cAEjC,OAAOqE,OAAOC,OAAO,CACnB/E,OACApB,OAAQ+F,EACRK,GAAIrC,KAAKsC,MACTC,OAjBK,SAASV,IAkBd3D,WACAmD,UAAWD,IACXoB,YAAaxB,IACb3E,IAAK6E,KAET,CC/CA,MAAMuB,EAAiB,aAePC,IACd,MAAMC,EAAwB,GAE9B,SAASC,GAAiBvF,KAAEA,EAAIwF,SAAEA,IAChC,OAAOF,EAAUG,WACdC,GAAaA,EAAS1F,OAASA,GAAQ0F,EAASF,WAAaA,GAEjE,CA4CD,SAASG,EAAO3F,EAAcwF,GAC1BA,EARJ,SAAmBE,GACjB,MAAME,EAAQL,EAAiBG,GAC3BE,GAAS,GACXN,EAAUO,OAAOD,EAAO,EAE3B,CAGcE,CAAU,CAAE9F,OAAMwF,aApBjC,SAAwBxF,GACtB,GAAIA,IAASoF,EACXE,EAAUvD,OAAS,OAEnB,IAAK,IAAIgE,EAAIT,EAAUvD,OAAS,EAAGgE,GAAK,EAAGA,IACrCT,EAAUS,GAAG/F,OAASA,GACxBsF,EAAUO,OAAOE,EAAG,EAI3B,CAU8CC,CAAehG,EAC7D,CAED,MAAO,CACLiG,IA3CF,SAAaP,GAIX,OAHIH,EAAiBG,GAAY,GAC/BJ,EAAUY,KAAKR,GAEV,IAAMC,EAAOD,EAAS1F,KAAM0F,EAASF,SAC7C,EAuCC1G,KArCF,SAAcH,GACZ2G,EAAUa,SAAST,IACjB,GAbJ,SAAuBA,EAAoB1F,GACzC,MAAyB,MAAlB0F,EAAS1F,MAAgBA,IAAS0F,EAAS1F,IACnD,CAWOoG,CAAcV,EAAU/G,EAAM0H,KAAKrG,MACrC,IACE0F,EAASF,SAAS7G,EACnB,CAAC,MAAO2F,GACPgC,QAAQC,MAAMjC,EACf,CACF,GAEJ,EA4BCqB,SAEJ,CC/DA,SAASa,GAAKxH,IACZA,EAAGC,MACHA,EAAK2F,WACLA,KACG6B,IAEH,OAAO3B,OAAOC,OAAO,CACnB/F,MACAC,QACA2F,kBACM6B,EAAK5H,MAAQ,CAAEA,KAAM4H,EAAK5H,OAEpC,CCCM,SAAU6H,EAAYC,GAC1B,MAAMC,EDAF,SACJD,GAEA,IAAIE,EAAiCL,EAAKG,GAE1C,MAAO,CACLG,IAAK,IAAMD,EACXE,OAASC,IACPH,EAAUL,EAAK,IAAKK,KAAYG,GAAgB,EAGtD,CCXwBC,CAAoBN,GACpCjI,EAAkB2G,IAElB6B,EAAiB,IACO,YAA5BN,EAAcE,MAAMjI,KC5Bf,CACL0E,QAAS,OACTlE,MAAO,IAAM8H,QAAQC,QAAQ,IAAIC,SAAS7H,KAAKC,UAAU,MACzDW,KAAM7B,SAAY,KAClBoF,eAAgB,IAAM,KACtBE,OAAQ,IAAM,KACdE,aAAc,IAAM,KACpB/C,aAAc,IAAM,GACpBN,QAAS0D,KDsBLC,IACAK,EAAkBnE,EAAsB2G,KAE9C,MAAO,CACL1I,KAAM,CAACwB,EAAcsH,KACnB,MAAM1I,EAASgI,EAAcE,MACvB/H,EAAcmI,IAEdvI,EEjCN,SACJqB,EACAsH,EACA1I,EACAG,EACA2F,GAEA,MAAO,IACF4C,EACHjB,KAAM5B,EAAWzE,EAAMpB,EAAQG,EAAa2F,GAEhD,CFsBoB6C,CACZvH,EACAsH,EACA1I,EACAG,EACA2F,GAGF,OAAOlG,EAAK,CACVI,SACAG,cACAJ,QACAD,mBACA,EAEJ8I,QAAUxH,GACRyE,EAAWzE,EAAM4G,EAAcE,MAAOI,IAAkBxC,GAC1D+C,GAAI,CAACzH,EAAcwF,IACjB9G,EAAgBuH,IAAI,CAAEjG,OAAMwF,aAC9BkC,IAAK,CAAC1H,EAAcwF,IAClB9G,EAAgBiH,OAAO3F,EAAMwF,GAC/BmC,aAAe/I,GACbgI,EAAcG,OAAOnI,GACvB4F,UACAoD,aAAc,KACZlD,EAAgBxD,OAAO,EAG7B","x_google_ignoreList":[2,4]}
+{"version":3,"file":"relay.min.js","sources":["../../src/emit/emit.ts","../../src/validate/validate.ts","../../../../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/environment/browser/storage/cookie.ts","../../src/environment/utils/fetch.ts","../../src/environment/browser/browser.ts","../../src/environment/browser/storage/storage.ts","../../src/environment/storage.ts","../../src/environment/environment.ts","../../src/environment/node/node.ts","../../src/version.ts","../../src/event/meta/meta.ts","../../src/listener/listener.ts","../../src/config/config.ts","../../src/relay.ts","../../src/environment/null/null.ts","../../src/event/relay-event.ts"],"sourcesContent":["import { Environment } from \"../environment/environment\";\nimport { ListenerManager } from \"../listener/listener\";\nimport { validate } from \"../validate/validate\";\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 async function emit(params: EmitParams) {\n  const { listenerManager, event, config } = params;\n  const isEnabled = config.mode !== \"disabled\";\n\n  isEnabled && listenerManager.call(event);\n  return config.mode === \"validate\" ? validate(params) : emitEvent(params);\n}\n\nexport async function emitEvent({\n  event,\n  config,\n  environment,\n}: EmitParams): Promise<null> {\n  const { url, token } = config;\n\n  return environment.send(url, token, JSON.stringify([event]));\n}\n","import { Environment } from \"../environment/environment\";\nimport { RelayEvent } from \"../event/relay-event\";\nimport { RelayConfig } from \"../relay\";\n\nexport interface ValidateParams {\n  config: RelayConfig;\n  environment: Environment;\n  event: Readonly<RelayEvent>;\n}\n\nexport interface ValidationError {\n  /**\n   * Type of syntax error of an event's property.\n   */\n  type: string;\n\n  /**\n   * Message describing the syntax error of an event's property.\n   */\n  message: string;\n\n  /**\n   * Path of the property with a syntax error in the event's payload.\n   */\n  path: string;\n}\n\nexport interface ValidationResponse {\n  /**\n   * Indicates whether the payload is valid.\n   */\n  valid: boolean;\n\n  /**\n   * List of syntax errors found in the emitted event(s).\n   * Each syntax error for a given property in a given event will be represented as a single ValidationError object.\n   */\n  errors: ValidationError[];\n}\n\nexport async function validate({\n  config,\n  environment,\n  event,\n}: ValidateParams): Promise<Readonly<ValidationResponse>> {\n  const { url, token } = config;\n  const headers = {\n    \"Content-Type\": \"application/json\",\n    Authorization: `Bearer ${token}`,\n  };\n\n  const response = await environment.fetch(`${url}/validate`, {\n    method: \"POST\",\n    body: JSON.stringify([event]),\n    headers,\n  });\n  const data = await response.json();\n\n  if (!response.ok) {\n    throw new Error({\n      ...data,\n    });\n  }\n\n  if (!data) {\n    return {\n      valid: false,\n      errors: [{ type: \"\", message: \"disabled\", path: \"\" }],\n    };\n  }\n\n  const { valid, errors } = data[0];\n\n  return { valid, errors: errors ?? [] };\n}\n","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 { Environment } from \"../environment/environment\";\n\nexport interface ClientIdManager {\n  getClientId: () => string;\n  clear: () => void;\n}\n\nexport function createClientIdManager(\n  environment: Environment\n): ClientIdManager {\n  const key = \"visitorId\";\n  return {\n    getClientId: () => {\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      environment.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 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","export async function fetchAPI(\n  url: string,\n  init?: RequestInit\n): Promise<Response> {\n  return fetch(url, init).catch((err: Error) => {\n    throw new Error(\n      `${err.message}: The \"host\" value is invalid or a network error occured, according to the FetchAPI's response.`,\n      { cause: err }\n    );\n  });\n}\n","import { Environment } from \"../environment\";\nimport { createBrowserStorage } from \"./storage/storage\";\nimport { fetchAPI } from \"../utils/fetch\";\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    fetch: (url: string, init?: RequestInit) => fetchAPI(url, init),\n    send: async (url: string, token: string, body: string) => {\n      const response = navigator.sendBeacon(\n        `${url}?access_token=${token}`,\n        new Blob([body], {\n          type: \"application/json\",\n        })\n      );\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      return null;\n    },\n    getReferrer: () => getReferrer(),\n    getLocation: () => window.location.href,\n    getUserAgent: () => navigator.userAgent,\n    generateUUID: () => crypto.randomUUID(),\n    storage: createBrowserStorage(),\n  };\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","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 { buildBrowserEnvironment } from \"./browser/browser\";\nimport { buildNodeEnvironment } from \"./node/node\";\nimport { Storage } from \"./storage\";\n\nexport interface Environment {\n  runtime: \"browser\" | \"node\" | \"null\";\n  fetch: (url: string, init?: RequestInit) => Promise<Response>;\n  send: (url: string, token: string, body: string) => Promise<null>;\n  getReferrer: () => string | null;\n  getLocation: () => string | null;\n  getUserAgent: () => string | null;\n  generateUUID: () => string;\n  storage: Storage;\n}\n\nexport function currentEnvironment(): Environment {\n  return isBrowser() ? buildBrowserEnvironment() : buildNodeEnvironment();\n}\n\nfunction isBrowser() {\n  try {\n    return typeof window === \"object\";\n  } catch (e) {\n    return false;\n  }\n}\n","import { Environment } from \"../environment\";\nimport { createNullStorage } from \"../storage\";\nimport { fetchAPI } from \"../utils/fetch\";\n\nexport function buildNodeEnvironment(): Environment {\n  return {\n    runtime: \"node\",\n    fetch: (url: string, init?: RequestInit) => fetchAPI(url, init),\n    send: async (url: string, token: string, body: string) => {\n      const headers = {\n        \"Content-Type\": \"application/json\",\n        Authorization: `Bearer ${token}`,\n      };\n      fetchAPI(url, {\n        method: \"POST\",\n        body,\n        headers,\n      });\n      return null;\n    },\n    getReferrer: () => null,\n    getLocation: () => null,\n    getUserAgent: () => null,\n    generateUUID: () => crypto.randomUUID(),\n    storage: createNullStorage(),\n  };\n}\n","export const version: string = process.env.VERSION ?? \"\";\n","import { ClientIdManager } from \"../../client-id/client-id\";\nimport { Environment } from \"../../environment/environment\";\nimport { RelayConfig } from \"../../config/config\";\nimport { version } from \"../../version\";\n\ninterface 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\nexport interface Meta {\n  /**\n   * Event's type that was emitted.\n   */\n  type: string;\n  config: EventConfig;\n\n  /**\n   * Timestamp when the event was emitted.\n   */\n  ts: number;\n\n  /**\n   * Library and version in which the event is built and emitted.\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 };\n}\n\nfunction getSource(): string {\n  return `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({\n    type,\n    config: eventConfig,\n    ts: Date.now(),\n    source: getSource(),\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\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","export type RelayMode = \"emit\" | \"validate\" | \"disabled\";\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 possible values are:\n   * \"emit\": Sends analytics events to Coveo to be stored.\n   * \"validate\": Validates events without storing them. This mode is for debugging and development purposes only and should not be used in production.\n   * \"disabled\": Prevents the emission of events and does not trigger callbacks.\n   * @default emit\n   */\n  mode?: RelayMode;\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  });\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","import { emit } from \"./emit/emit\";\nimport { createClientIdManager } from \"./client-id/client-id\";\nimport { currentEnvironment } from \"./environment/environment\";\nimport { createRelayEvent } from \"./event/relay-event\";\nimport { version } from \"./version\";\nimport { createMeta, Meta } from \"./event/meta/meta\";\nimport { createListenerManager, EventCallback } from \"./listener/listener\";\nimport { createConfigManager, RelayConfig } from \"./config/config\";\nimport { ValidationError, ValidationResponse } from \"./validate/validate\";\nimport { buildNullEnvironment } from \"./environment/null/null\";\n\ntype RelayPayload = Record<string, unknown>;\ntype Off = () => void;\n\ninterface Relay {\n  /**\n   * Sends an event to the Event API.\n   * @param {string} type - event's type to be emitted.\n   * @param {RelayPayload} payload - payload to include within the event.\n   * @returns {Promise<ValidationResponse | null>} the return value is typed ValidationResponse if the library configuration's mode is validate.\n   */\n  emit: (\n    type: string,\n    payload: RelayPayload\n  ) => Promise<ValidationResponse | null>;\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   * 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\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\n  const getEnvironment = () =>\n    configManager.get().mode == \"disabled\"\n      ? buildNullEnvironment()\n      : currentEnvironment();\n  const clientIdManager = createClientIdManager(getEnvironment());\n\n  return {\n    emit: (type: string, payload: RelayPayload) => {\n      const config = configManager.get();\n      const environment = getEnvironment();\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(type, configManager.get(), getEnvironment(), clientIdManager),\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 { RelayPayload, RelayConfig, ValidationError, ValidationResponse };\n","import { Environment } from \"../environment\";\nimport { createNullStorage } from \"../storage\";\n\nexport function buildNullEnvironment(): Environment {\n  return {\n    runtime: \"null\",\n    fetch: () => Promise.resolve(new Response(JSON.stringify(\"\"))),\n    send: async () => null,\n    getReferrer: () => null,\n    getLocation: () => null,\n    getUserAgent: () => null,\n    generateUUID: () => \"\",\n    storage: createNullStorage(),\n  };\n}\n","import { ClientIdManager } from \"../client-id/client-id\";\nimport { Environment } from \"../environment/environment\";\nimport { RelayConfig, RelayPayload } from \"../relay\";\nimport { createMeta, Meta } from \"./meta/meta\";\n\nexport interface RelayEvent extends RelayPayload {\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"],"names":["async","emit","params","listenerManager","event","config","mode","call","environment","url","token","headers","Authorization","response","fetch","method","body","JSON","stringify","data","json","ok","Error","valid","errors","type","message","path","validate","send","emitEvent","REGEX","createClientIdManager","key","getClientId","storage","existingClientId","getItem","clientId","uuid","test","generateUUID","setItem","clear","removeItem","cookieManager","prefix","cookiePrefix","cookieArray","document","cookie","split","prettifyCookie","replace","lastIndexOf","substring","length","expire","domain","host","parts","slice","join","getDomain","window","location","hostname","expireSection","Date","getTime","toUTCString","domainSection","this","createCookieManager","fetchAPI","init","catch","err","cause","buildBrowserEnvironment","runtime","navigator","sendBeacon","Blob","getReferrer","referrer","getLocation","href","getUserAgent","userAgent","crypto","randomUUID","localStorage","createNullStorage","currentEnvironment","e","isBrowser","version","createMeta","clientIdManager","eventConfig","trackingId","getEventConfig","Object","freeze","ts","now","source","ANY_EVENT_TYPE","createListenerManager","listeners","getListenerIndex","callback","findIndex","listener","remove","index","splice","removeOne","i","removeMultiple","add","push","forEach","isMatchesType","meta","console","error","pick","rest","createRelay","initialConfig","configManager","_config","get","update","updatedConfig","createConfigManager","getEnvironment","Promise","resolve","Response","payload","createRelayEvent","getMeta","on","off","updateConfig","clearStorage"],"mappings":"AAaOA,eAAeC,EAAKC,GACzB,MAAMC,gBAAEA,EAAeC,MAAEA,EAAKC,OAAEA,GAAWH,EAI3C,MAHkC,aAAhBG,EAAOC,MAEZH,EAAgBI,KAAKH,GACX,aAAhBC,EAAOC,KCsBTN,gBAAwBK,OAC7BA,EAAMG,YACNA,EAAWJ,MACXA,IAEA,MAAMK,IAAEA,EAAGC,MAAEA,GAAUL,EACjBM,EAAU,CACd,eAAgB,mBAChBC,cAAe,UAAUF,KAGrBG,QAAiBL,EAAYM,MAAM,GAAGL,aAAgB,CAC1DM,OAAQ,OACRC,KAAMC,KAAKC,UAAU,CAACd,IACtBO,YAEIQ,QAAaN,EAASO,OAE5B,IAAKP,EAASQ,GACZ,MAAM,IAAIC,MAAM,IACXH,IAIP,IAAKA,EACH,MAAO,CACLI,OAAO,EACPC,OAAQ,CAAC,CAAEC,KAAM,GAAIC,QAAS,WAAYC,KAAM,MAIpD,MAAMJ,MAAEA,EAAKC,OAAEA,GAAWL,EAAK,GAE/B,MAAO,CAAEI,QAAOC,OAAQA,GAAU,GACpC,CDxDsCI,CAAS1B,GAGxCF,gBAAyBI,MAC9BA,EAAKC,OACLA,EAAMG,YACNA,IAEA,MAAMC,IAAEA,EAAGC,MAAEA,GAAUL,EAEvB,OAAOG,EAAYqB,KAAKpB,EAAKC,EAAOO,KAAKC,UAAU,CAACd,IACtD,CAXyD0B,CAAU5B,EACnE,CEnBA,IAAA6B,EAAe,sHCQT,SAAUC,EACdxB,GAEA,MAAMyB,EAAM,YACZ,MAAO,CACLC,YAAa,KACX,MAAMC,EAAU3B,EAAY2B,QAEtBC,EAAmBD,EAAQE,QAAQJ,GACnCK,EACJF,ICfiB,iBADPG,EDgBmBH,ICfAL,EAAMS,KAAKD,IDgBpCH,EACA5B,EAAYiC,eClBxB,IAAkBF,EDoBZ,OADAJ,EAAQO,QAAQT,EAAKK,GACdA,CAAQ,EAEjBK,MAAO,KACLnC,EAAY2B,QAAQS,WAAWX,EAAI,EAGzC,CEtBO,MAAMY,EAEb,WACE,MAAMC,EAAS,SAMf,MAAO,CACL,OAAAT,CAAQJ,GACN,MAAMc,EAAe,GAAGD,IAASb,KAC3Be,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,EAAaS,OACbJ,EAAeI,OAGpB,CACD,OAAO,IACR,EACD,OAAAd,CAAQT,EAAad,EAAcsC,GACjC,MAAMC,EArBQ,CAACC,IACjB,MAAMC,EAAQD,EAAKR,MAAM,KAAKU,OAAO,GACrC,OAAuB,GAAhBD,EAAMJ,OAAcI,EAAME,KAAK,KAAO,EAAE,EAmB9BC,CAAUC,OAAOC,SAASC,UACnCC,EAAgB,YAAY,IAAIC,MACpC,IAAIA,MAAOC,UAAYZ,GACvBa,gBACIC,EAAgBb,EAAS,WAAWA,IAAW,GACrDT,SAASC,OAAS,GAAGJ,IAASb,KAAOd,IAAOgD,IAAgBI,uBAC7D,EAED,UAAA3B,CAAWX,GACTuC,KAAK9B,QAAQT,EAAK,IAAK,EACxB,EAEL,CArC4CwC,GCNrCzE,eAAe0E,EACpBjE,EACAkE,GAEA,OAAO7D,MAAML,EAAKkE,GAAMC,OAAOC,IAC7B,MAAM,IAAIvD,MACR,GAAGuD,EAAInD,yGACP,CAAEoD,MAAOD,GACV,GAEL,UCAgBE,IACd,MAAO,CACLC,QAAS,UACTlE,MAAO,CAACL,EAAakE,IAAuBD,EAASjE,EAAKkE,GAC1D9C,KAAM7B,MAAOS,EAAaC,EAAeM,KAQvC,IAPiBiE,UAAUC,WACzB,GAAGzE,kBAAoBC,IACvB,IAAIyE,KAAK,CAACnE,GAAO,CACfS,KAAM,sBAKR,MAAM,IAAIH,MACR,mJAIJ,OAAO,IAAI,EAEb8D,YAAa,IA1BjB,WACE,MAAMC,EAAWpC,SAASoC,SAE1B,MAAoB,KAAbA,EAAkB,KAAOA,CAClC,CAsBuBD,GACnBE,YAAa,IAAMtB,OAAOC,SAASsB,KACnCC,aAAc,IAAMP,UAAUQ,UAC9BhD,aAAc,IAAMiD,OAAOC,aAC3BxD,QC9BK,CACLE,QAAQJ,GACCY,EAAcR,QAAQJ,IAAQ2D,aAAavD,QAAQJ,GAG5D,UAAAW,CAAWX,GACTY,EAAcD,WAAWX,GACzB2D,aAAahD,WAAWX,EACzB,EAED,OAAAS,CAAQT,EAAad,GAEnByE,aAAalD,QAAQT,EAAKd,GAC1B0B,EAAcH,QAAQT,EAAKd,EAFX,WAGjB,GDkBL,UE9BgB0E,IACd,MAAO,CACLxD,QAAO,IACE,KAET,UAAAO,GAEC,EACD,OAAAF,GAEC,EAEL,UCHgBoD,IACd,OAGF,WACE,IACE,MAAyB,iBAAX9B,MACf,CAAC,MAAO+B,GACP,OAAO,CACR,CACH,CATSC,GAAcjB,ICXd,CACLC,QAAS,OACTlE,MAAO,CAACL,EAAakE,IAAuBD,EAASjE,EAAKkE,GAC1D9C,KAAM7B,MAAOS,EAAaC,EAAeM,KAKvC0D,EAASjE,EAAK,CACZM,OAAQ,OACRC,OACAL,QAPc,CACd,eAAgB,mBAChBC,cAAe,UAAUF,OAOpB,MAET0E,YAAa,IAAM,KACnBE,YAAa,IAAM,KACnBE,aAAc,IAAM,KACpB/C,aAAc,IAAMiD,OAAOC,aAC3BxD,QAAS0D,IDPb,CEjBO,MAAMI,EAAkB,QC2DzB,SAAUC,EACdzE,EACApB,EACAG,EACA2F,GAEA,MAAMf,YAAEA,EAAWE,YAAEA,EAAWE,aAAEA,GAAiBhF,EAC7C4F,EAhBR,SAAwB/F,GACtB,MAAMgG,WAAEA,GAAehG,EACvB,MAAO,CAAEgG,aACX,CAasBC,CAAejG,GAC7BiC,EAAW6D,EAAgBjE,cAEjC,OAAOqE,OAAOC,OAAO,CACnB/E,OACApB,OAAQ+F,EACRK,GAAIrC,KAAKsC,MACTC,OAjBK,SAASV,IAkBd3D,WACAmD,UAAWD,IACXH,SAAUD,IACVnB,SAAUqB,KAEd,CC7EA,MAAMsB,EAAiB,aAqBPC,IACd,MAAMC,EAAwB,GAE9B,SAASC,GAAiBtF,KAAEA,EAAIuF,SAAEA,IAChC,OAAOF,EAAUG,WACdC,GAAaA,EAASzF,OAASA,GAAQyF,EAASF,WAAaA,GAEjE,CA4CD,SAASG,EAAO1F,EAAcuF,GAC1BA,EARJ,SAAmBE,GACjB,MAAME,EAAQL,EAAiBG,GAC3BE,GAAS,GACXN,EAAUO,OAAOD,EAAO,EAE3B,CAGcE,CAAU,CAAE7F,OAAMuF,aApBjC,SAAwBvF,GACtB,GAAIA,IAASmF,EACXE,EAAUtD,OAAS,OAEnB,IAAK,IAAI+D,EAAIT,EAAUtD,OAAS,EAAG+D,GAAK,EAAGA,IACrCT,EAAUS,GAAG9F,OAASA,GACxBqF,EAAUO,OAAOE,EAAG,EAI3B,CAU8CC,CAAe/F,EAC7D,CAED,MAAO,CACLgG,IA3CF,SAAaP,GAIX,OAHIH,EAAiBG,GAAY,GAC/BJ,EAAUY,KAAKR,GAEV,IAAMC,EAAOD,EAASzF,KAAMyF,EAASF,SAC7C,EAuCCzG,KArCF,SAAcH,GACZ0G,EAAUa,SAAST,IACjB,GAbJ,SAAuBA,EAAoBzF,GACzC,MAAyB,MAAlByF,EAASzF,MAAgBA,IAASyF,EAASzF,IACnD,CAWOmG,CAAcV,EAAU9G,EAAMyH,KAAKpG,MACrC,IACEyF,EAASF,SAAS5G,EACnB,CAAC,MAAO2F,GACP+B,QAAQC,MAAMhC,EACf,CACF,GAEJ,EA4BCoB,SAEJ,CClDA,SAASa,GAAKvH,IACZA,EAAGC,MACHA,EAAK2F,WACLA,KACG4B,IAEH,OAAO1B,OAAOC,OAAO,CACnB/F,MACAC,QACA2F,kBACM4B,EAAK3H,MAAQ,CAAEA,KAAM2H,EAAK3H,OAEpC,CCgCM,SAAU4H,EAAYC,GAC1B,MAAMC,ED/BF,SACJD,GAEA,IAAIE,EAAiCL,EAAKG,GAE1C,MAAO,CACLG,IAAK,IAAMD,EACXE,OAASC,IACPH,EAAUL,EAAK,IAAKK,KAAYG,GAAgB,EAGtD,CCoBwBC,CAAoBN,GACpChI,EAAkB0G,IAElB6B,EAAiB,IACO,YAA5BN,EAAcE,MAAMhI,KC9Ef,CACL0E,QAAS,OACTlE,MAAO,IAAM6H,QAAQC,QAAQ,IAAIC,SAAS5H,KAAKC,UAAU,MACzDW,KAAM7B,SAAY,KAClBoF,YAAa,IAAM,KACnBE,YAAa,IAAM,KACnBE,aAAc,IAAM,KACpB/C,aAAc,IAAM,GACpBN,QAAS0D,KDwELC,IACAK,EAAkBnE,EAAsB0G,KAE9C,MAAO,CACLzI,KAAM,CAACwB,EAAcqH,KACnB,MAAMzI,EAAS+H,EAAcE,MACvB9H,EAAckI,IAEdtI,EEnFN,SACJqB,EACAqH,EACAzI,EACAG,EACA2F,GAEA,MAAO,IACF2C,EACHjB,KAAM3B,EAAWzE,EAAMpB,EAAQG,EAAa2F,GAEhD,CFwEoB4C,CACZtH,EACAqH,EACAzI,EACAG,EACA2F,GAGF,OAAOlG,EAAK,CACVI,SACAG,cACAJ,QACAD,mBACA,EAEJ6I,QAAUvH,GACRyE,EAAWzE,EAAM2G,EAAcE,MAAOI,IAAkBvC,GAC1D8C,GAAI,CAACxH,EAAcuF,IACjB7G,EAAgBsH,IAAI,CAAEhG,OAAMuF,aAC9BkC,IAAK,CAACzH,EAAcuF,IAClB7G,EAAgBgH,OAAO1F,EAAMuF,GAC/BmC,aAAe9I,GACb+H,EAAcG,OAAOlI,GACvB4F,UACAmD,aAAc,KACZjD,EAAgBxD,OAAO,EAG7B","x_google_ignoreList":[2,4]}

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

@@ -1,8 +1,24 @@
 export type RelayMode = "emit" | "validate" | "disabled";
 export interface RelayConfig {
+    /**
+     * Endpoint defined to communicate with the Event API.
+     */
     url: string;
+    /**
+     * Token to authorize the access to the Event API endpoint.
+     */
     token: string;
+    /**
+     * The unique identifier of a web property. See [Tracking ID](https://docs.coveo.com/en/n8tg0567/).
+     */
     trackingId: string;
+    /**
+     * Defines the library mode. The possible values are:
+     * "emit": Sends analytics events to Coveo to be stored.
+     * "validate": Validates events without storing them. This mode is for debugging and development purposes only and should not be used in production.
+     * "disabled": Prevents the emission of events and does not trigger callbacks.
+     * @default emit
+     */
     mode?: RelayMode;
 }
 export interface ConfigManager {

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,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,CAAC;AAEzD,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;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;AAgBD,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,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,CAAC;AAEzD,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;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;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;AAgBD,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,WAAW,GACzB,QAAQ,CAAC,aAAa,CAAC,CASzB"}

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

@@ -3,8 +3,8 @@ export interface Environment {
     runtime: "browser" | "node" | "null";
     fetch: (url: string, init?: RequestInit) => Promise<Response>;
     send: (url: string, token: string, body: string) => Promise<null>;
-    getReferrerUrl: () => string | null;
-    getUrl: () => string | null;
+    getReferrer: () => string | null;
+    getLocation: () => string | null;
     getUserAgent: () => string | null;
     generateUUID: () => string;
     storage: Storage;

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

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

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

@@ -2,17 +2,41 @@ import { ClientIdManager } from "../../client-id/client-id";
 import { Environment } from "../../environment/environment";
 import { RelayConfig } from "../../config/config";
 interface EventConfig {
+    /**
+     * The unique identifier of a web property. See [Tracking ID](https://docs.coveo.com/en/n8tg0567/).
+     */
     trackingId: string;
 }
 export interface Meta {
+    /**
+     * Event's type that was emitted.
+     */
     type: string;
     config: EventConfig;
+    /**
+     * Timestamp when the event was emitted.
+     */
     ts: number;
+    /**
+     * Library and version in which the event is built and emitted.
+     */
     source: string;
+    /**
+     * Persistent unique identifier of a device.
+     */
     clientId: string;
+    /**
+     * Browser Navigator's [user agent](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/userAgent) property if set.
+     */
     userAgent: string | null;
-    referrerUrl: string | null;
-    url: string | null;
+    /**
+     * Browser Document's [referrer](https://developer.mozilla.org/en-US/docs/Web/API/Document/referrer) property if set.
+     */
+    referrer: string | null;
+    /**
+     * Browser Location's [href](https://developer.mozilla.org/en-US/docs/Web/API/Location/href) property if set.
+     */
+    location: string | null;
 }
 export declare function createMeta(type: string, config: RelayConfig, environment: Environment, clientIdManager: ClientIdManager): Readonly<Meta>;
 export {};

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,MAAM,qBAAqB,CAAC;AAGlD,UAAU,WAAW;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;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,MAAM,qBAAqB,CAAC;AAGlD,UAAU,WAAW;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC;IAEpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;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/cdn/types/listener/listener.d.ts

@@ -1,4 +1,10 @@
 import { RelayEvent } from "../event/relay-event";
+/**
+ * Callback to perform an action when a specified event is emitted.
+ * @typedef {function} EventCallback
+ * @param {RelayEvent} event
+ * @returns {void}
+ */
 export type EventCallback = (event: RelayEvent) => void;
 interface Listener {
     type: string;

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

@@ -1 +1 @@
-{"version":3,"file":"listener.d.ts","sourceRoot":"","sources":["../../../src/listener/listener.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIlD,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;AAExD,UAAU,QAAQ;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,IAAI,CAAC;IACxC,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IAClC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;CAC1D;AAED,wBAAgB,qBAAqB,IAAI,eAAe,CA4DvD"}
+{"version":3,"file":"listener.d.ts","sourceRoot":"","sources":["../../../src/listener/listener.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIlD;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;AAExD,UAAU,QAAQ;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,IAAI,CAAC;IACxC,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IAClC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;CAC1D;AAED,wBAAgB,qBAAqB,IAAI,eAAe,CA4DvD"}

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

@@ -5,14 +5,58 @@ import { ValidationError, ValidationResponse } from "./validate/validate";
 type RelayPayload = Record<string, unknown>;
 type Off = () => void;
 interface Relay {
+    /**
+     * Sends an event to the Event API.
+     * @param {string} type - event's type to be emitted.
+     * @param {RelayPayload} payload - payload to include within the event.
+     * @returns {Promise<ValidationResponse | null>} the return value is typed ValidationResponse if the library configuration's mode is validate.
+     */
     emit: (type: string, payload: RelayPayload) => Promise<ValidationResponse | null>;
+    /**
+     * Gets the client-side generated meta object.
+     * @param {string} type - event's type that will be included in the meta object.
+     * @returns {Meta}
+     */
     getMeta: (type: string) => Meta;
+    /**
+     * Attaches an event callback to either all event types or a specific one.
+     * The callback set will be called when an event with the specified type is emitted.
+     * Setting type as "*" will trigger the callback for all event types.
+     * Returns the "off" function to detach the event callback.
+     * @param {string} type - event's type.
+     * @param {EventCallback} callback
+     * @returns {Off}
+     */
     on: (type: string, callback: EventCallback) => Off;
+    /**
+     * Detach callback(s) from events.
+     * If only the "type" parameter is set, all callbacks for the specified type will be removed.
+     * @param {string} type - event's type.
+     * @param {EventCallback} callback - callback that should be removed.
+     * @returns {void}
+     */
     off: (type: string, callback?: EventCallback) => void;
+    /**
+     * Updates Relay's configuration after its initialization.
+     * @param {Partial<RelayConfig>} config - configuration that should be updated.
+     * @returns {void}
+     */
     updateConfig: (config: Partial<RelayConfig>) => void;
+    /**
+     * Current version of the Relay library.
+     */
     version: string;
+    /**
+     * Removes the visitorId cookie and localStorage key.
+     * @returns {void}
+     */
     clearStorage: () => void;
 }
+/**
+ * Initializes the Relay library object.
+ * @param {RelayConfig} initialConfig
+ * @returns {Relay}
+ */
 export declare function createRelay(initialConfig: RelayConfig): Relay;
 export type { RelayPayload, RelayConfig, ValidationError, ValidationResponse };
 //# sourceMappingURL=relay.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"relay.d.ts","sourceRoot":"","sources":["../../src/relay.ts"],"names":[],"mappings":"AAKA,OAAO,EAAc,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAyB,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAuB,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAG1E,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC5C,KAAK,GAAG,GAAG,MAAM,IAAI,CAAC;AAEtB,UAAU,KAAK;IACb,IAAI,EAAE,CACJ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,YAAY,KAClB,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IACxC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,KAAK,GAAG,CAAC;IACnD,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;IACtD,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;IACrD,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,IAAI,CAAC;CAC1B;AAED,wBAAgB,WAAW,CAAC,aAAa,EAAE,WAAW,GAAG,KAAK,CA2C7D;AAED,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC"}
+{"version":3,"file":"relay.d.ts","sourceRoot":"","sources":["../../src/relay.ts"],"names":[],"mappings":"AAKA,OAAO,EAAc,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAyB,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAuB,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAG1E,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC5C,KAAK,GAAG,GAAG,MAAM,IAAI,CAAC;AAEtB,UAAU,KAAK;IACb;;;;;OAKG;IACH,IAAI,EAAE,CACJ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,YAAY,KAClB,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhC;;;;;;;;OAQG;IACH,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,KAAK,GAAG,CAAC;IAEnD;;;;;;OAMG;IACH,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;IAEtD;;;;OAIG;IACH,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;IAErD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,YAAY,EAAE,MAAM,IAAI,CAAC;CAC1B;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,aAAa,EAAE,WAAW,GAAG,KAAK,CA2C7D;AAED,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC"}

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

@@ -7,12 +7,28 @@ export interface ValidateParams {
     event: Readonly<RelayEvent>;
 }
 export interface ValidationError {
+    /**
+     * Type of syntax error of an event's property.
+     */
     type: string;
+    /**
+     * Message describing the syntax error of an event's property.
+     */
     message: string;
+    /**
+     * Path of the property with a syntax error in the event's payload.
+     */
     path: string;
 }
 export interface ValidationResponse {
+    /**
+     * Indicates whether the payload is valid.
+     */
     valid: boolean;
+    /**
+     * List of syntax errors found in the emitted event(s).
+     * Each syntax error for a given property in a given event will be represented as a single ValidationError object.
+     */
     errors: ValidationError[];
 }
 export declare function validate({ config, environment, event, }: ValidateParams): Promise<Readonly<ValidationResponse>>;

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

@@ -1 +1 @@
-{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/validate/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,wBAAsB,QAAQ,CAAC,EAC7B,MAAM,EACN,WAAW,EACX,KAAK,GACN,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CA8BxD"}
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/validate/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,wBAAsB,QAAQ,CAAC,EAC7B,MAAM,EACN,WAAW,EACX,KAAK,GACN,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CA8BxD"}

package/lib/relay.cjs

@@ -116,7 +116,7 @@ async function fetchAPI(url, init) {
     });
 }
 
-function getReferrerUrl() {
+function getReferrer() {
     const referrer = document.referrer;
     return referrer === "" ? null : referrer;
 }
@@ -133,8 +133,8 @@ function buildBrowserEnvironment() {
             }
             return null;
         },
-        getReferrerUrl: () => getReferrerUrl(),
-        getUrl: () => window.location.href,
+        getReferrer: () => getReferrer(),
+        getLocation: () => window.location.href,
         getUserAgent: () => navigator.userAgent,
         generateUUID: () => crypto.randomUUID(),
         storage: createBrowserStorage(),
@@ -171,8 +171,8 @@ function buildNodeEnvironment() {
             });
             return null;
         },
-        getReferrerUrl: () => null,
-        getUrl: () => null,
+        getReferrer: () => null,
+        getLocation: () => null,
         getUserAgent: () => null,
         generateUUID: () => crypto.randomUUID(),
         storage: createNullStorage(),
@@ -191,7 +191,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.6.2" ;
+const version = "0.6.4" ;
 
 function getEventConfig(config) {
     const { trackingId } = config;
@@ -201,7 +201,7 @@ function getSource() {
     return `relay@${version}`;
 }
 function createMeta(type, config, environment, clientIdManager) {
-    const { getReferrerUrl, getUrl, getUserAgent } = environment;
+    const { getReferrer, getLocation, getUserAgent } = environment;
     const eventConfig = getEventConfig(config);
     const clientId = clientIdManager.getClientId();
     return Object.freeze({
@@ -211,8 +211,8 @@ function createMeta(type, config, environment, clientIdManager) {
         source: getSource(),
         clientId,
         userAgent: getUserAgent(),
-        referrerUrl: getReferrerUrl(),
-        url: getUrl(),
+        referrer: getReferrer(),
+        location: getLocation(),
     });
 }
 
@@ -301,14 +301,19 @@ function buildNullEnvironment() {
         runtime: "null",
         fetch: () => Promise.resolve(new Response(JSON.stringify(""))),
         send: async () => null,
-        getReferrerUrl: () => null,
-        getUrl: () => null,
+        getReferrer: () => null,
+        getLocation: () => null,
         getUserAgent: () => null,
         generateUUID: () => "",
         storage: createNullStorage(),
     };
 }
 
+/**
+ * Initializes the Relay library object.
+ * @param {RelayConfig} initialConfig
+ * @returns {Relay}
+ */
 function createRelay(initialConfig) {
     const configManager = createConfigManager(initialConfig);
     const listenerManager = createListenerManager();

package/lib/relay.js

@@ -114,7 +114,7 @@ async function fetchAPI(url, init) {
     });
 }
 
-function getReferrerUrl() {
+function getReferrer() {
     const referrer = document.referrer;
     return referrer === "" ? null : referrer;
 }
@@ -131,8 +131,8 @@ function buildBrowserEnvironment() {
             }
             return null;
         },
-        getReferrerUrl: () => getReferrerUrl(),
-        getUrl: () => window.location.href,
+        getReferrer: () => getReferrer(),
+        getLocation: () => window.location.href,
         getUserAgent: () => navigator.userAgent,
         generateUUID: () => crypto.randomUUID(),
         storage: createBrowserStorage(),
@@ -169,8 +169,8 @@ function buildNodeEnvironment() {
             });
             return null;
         },
-        getReferrerUrl: () => null,
-        getUrl: () => null,
+        getReferrer: () => null,
+        getLocation: () => null,
         getUserAgent: () => null,
         generateUUID: () => crypto.randomUUID(),
         storage: createNullStorage(),
@@ -189,7 +189,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.6.2" ;
+const version = "0.6.4" ;
 
 function getEventConfig(config) {
     const { trackingId } = config;
@@ -199,7 +199,7 @@ function getSource() {
     return `relay@${version}`;
 }
 function createMeta(type, config, environment, clientIdManager) {
-    const { getReferrerUrl, getUrl, getUserAgent } = environment;
+    const { getReferrer, getLocation, getUserAgent } = environment;
     const eventConfig = getEventConfig(config);
     const clientId = clientIdManager.getClientId();
     return Object.freeze({
@@ -209,8 +209,8 @@ function createMeta(type, config, environment, clientIdManager) {
         source: getSource(),
         clientId,
         userAgent: getUserAgent(),
-        referrerUrl: getReferrerUrl(),
-        url: getUrl(),
+        referrer: getReferrer(),
+        location: getLocation(),
     });
 }
 
@@ -299,14 +299,19 @@ function buildNullEnvironment() {
         runtime: "null",
         fetch: () => Promise.resolve(new Response(JSON.stringify(""))),
         send: async () => null,
-        getReferrerUrl: () => null,
-        getUrl: () => null,
+        getReferrer: () => null,
+        getLocation: () => null,
         getUserAgent: () => null,
         generateUUID: () => "",
         storage: createNullStorage(),
     };
 }
 
+/**
+ * Initializes the Relay library object.
+ * @param {RelayConfig} initialConfig
+ * @returns {Relay}
+ */
 function createRelay(initialConfig) {
     const configManager = createConfigManager(initialConfig);
     const listenerManager = createListenerManager();

package/lib/relay.mjs

@@ -114,7 +114,7 @@ async function fetchAPI(url, init) {
     });
 }
 
-function getReferrerUrl() {
+function getReferrer() {
     const referrer = document.referrer;
     return referrer === "" ? null : referrer;
 }
@@ -131,8 +131,8 @@ function buildBrowserEnvironment() {
             }
             return null;
         },
-        getReferrerUrl: () => getReferrerUrl(),
-        getUrl: () => window.location.href,
+        getReferrer: () => getReferrer(),
+        getLocation: () => window.location.href,
         getUserAgent: () => navigator.userAgent,
         generateUUID: () => crypto.randomUUID(),
         storage: createBrowserStorage(),
@@ -169,8 +169,8 @@ function buildNodeEnvironment() {
             });
             return null;
         },
-        getReferrerUrl: () => null,
-        getUrl: () => null,
+        getReferrer: () => null,
+        getLocation: () => null,
         getUserAgent: () => null,
         generateUUID: () => crypto.randomUUID(),
         storage: createNullStorage(),
@@ -189,7 +189,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.6.2" ;
+const version = "0.6.4" ;
 
 function getEventConfig(config) {
     const { trackingId } = config;
@@ -199,7 +199,7 @@ function getSource() {
     return `relay@${version}`;
 }
 function createMeta(type, config, environment, clientIdManager) {
-    const { getReferrerUrl, getUrl, getUserAgent } = environment;
+    const { getReferrer, getLocation, getUserAgent } = environment;
     const eventConfig = getEventConfig(config);
     const clientId = clientIdManager.getClientId();
     return Object.freeze({
@@ -209,8 +209,8 @@ function createMeta(type, config, environment, clientIdManager) {
         source: getSource(),
         clientId,
         userAgent: getUserAgent(),
-        referrerUrl: getReferrerUrl(),
-        url: getUrl(),
+        referrer: getReferrer(),
+        location: getLocation(),
     });
 }
 
@@ -299,14 +299,19 @@ function buildNullEnvironment() {
         runtime: "null",
         fetch: () => Promise.resolve(new Response(JSON.stringify(""))),
         send: async () => null,
-        getReferrerUrl: () => null,
-        getUrl: () => null,
+        getReferrer: () => null,
+        getLocation: () => null,
         getUserAgent: () => null,
         generateUUID: () => "",
         storage: createNullStorage(),
     };
 }
 
+/**
+ * Initializes the Relay library object.
+ * @param {RelayConfig} initialConfig
+ * @returns {Relay}
+ */
 function createRelay(initialConfig) {
     const configManager = createConfigManager(initialConfig);
     const listenerManager = createListenerManager();

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

@@ -1,8 +1,24 @@
 export type RelayMode = "emit" | "validate" | "disabled";
 export interface RelayConfig {
+    /**
+     * Endpoint defined to communicate with the Event API.
+     */
     url: string;
+    /**
+     * Token to authorize the access to the Event API endpoint.
+     */
     token: string;
+    /**
+     * The unique identifier of a web property. See [Tracking ID](https://docs.coveo.com/en/n8tg0567/).
+     */
     trackingId: string;
+    /**
+     * Defines the library mode. The possible values are:
+     * "emit": Sends analytics events to Coveo to be stored.
+     * "validate": Validates events without storing them. This mode is for debugging and development purposes only and should not be used in production.
+     * "disabled": Prevents the emission of events and does not trigger callbacks.
+     * @default emit
+     */
     mode?: RelayMode;
 }
 export interface ConfigManager {

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,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,CAAC;AAEzD,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;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;AAgBD,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,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,CAAC;AAEzD,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;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;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;AAgBD,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,WAAW,GACzB,QAAQ,CAAC,aAAa,CAAC,CASzB"}

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

@@ -3,8 +3,8 @@ export interface Environment {
     runtime: "browser" | "node" | "null";
     fetch: (url: string, init?: RequestInit) => Promise<Response>;
     send: (url: string, token: string, body: string) => Promise<null>;
-    getReferrerUrl: () => string | null;
-    getUrl: () => string | null;
+    getReferrer: () => string | null;
+    getLocation: () => string | null;
     getUserAgent: () => string | null;
     generateUUID: () => string;
     storage: Storage;

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

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

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

@@ -2,17 +2,41 @@ import { ClientIdManager } from "../../client-id/client-id";
 import { Environment } from "../../environment/environment";
 import { RelayConfig } from "../../config/config";
 interface EventConfig {
+    /**
+     * The unique identifier of a web property. See [Tracking ID](https://docs.coveo.com/en/n8tg0567/).
+     */
     trackingId: string;
 }
 export interface Meta {
+    /**
+     * Event's type that was emitted.
+     */
     type: string;
     config: EventConfig;
+    /**
+     * Timestamp when the event was emitted.
+     */
     ts: number;
+    /**
+     * Library and version in which the event is built and emitted.
+     */
     source: string;
+    /**
+     * Persistent unique identifier of a device.
+     */
     clientId: string;
+    /**
+     * Browser Navigator's [user agent](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/userAgent) property if set.
+     */
     userAgent: string | null;
-    referrerUrl: string | null;
-    url: string | null;
+    /**
+     * Browser Document's [referrer](https://developer.mozilla.org/en-US/docs/Web/API/Document/referrer) property if set.
+     */
+    referrer: string | null;
+    /**
+     * Browser Location's [href](https://developer.mozilla.org/en-US/docs/Web/API/Location/href) property if set.
+     */
+    location: string | null;
 }
 export declare function createMeta(type: string, config: RelayConfig, environment: Environment, clientIdManager: ClientIdManager): Readonly<Meta>;
 export {};

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,MAAM,qBAAqB,CAAC;AAGlD,UAAU,WAAW;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;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,MAAM,qBAAqB,CAAC;AAGlD,UAAU,WAAW;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC;IAEpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;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/types/listener/listener.d.ts

@@ -1,4 +1,10 @@
 import { RelayEvent } from "../event/relay-event";
+/**
+ * Callback to perform an action when a specified event is emitted.
+ * @typedef {function} EventCallback
+ * @param {RelayEvent} event
+ * @returns {void}
+ */
 export type EventCallback = (event: RelayEvent) => void;
 interface Listener {
     type: string;

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

@@ -1 +1 @@
-{"version":3,"file":"listener.d.ts","sourceRoot":"","sources":["../../../src/listener/listener.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIlD,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;AAExD,UAAU,QAAQ;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,IAAI,CAAC;IACxC,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IAClC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;CAC1D;AAED,wBAAgB,qBAAqB,IAAI,eAAe,CA4DvD"}
+{"version":3,"file":"listener.d.ts","sourceRoot":"","sources":["../../../src/listener/listener.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIlD;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;AAExD,UAAU,QAAQ;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,IAAI,CAAC;IACxC,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IAClC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;CAC1D;AAED,wBAAgB,qBAAqB,IAAI,eAAe,CA4DvD"}

package/lib/types/relay.d.ts

@@ -5,14 +5,58 @@ import { ValidationError, ValidationResponse } from "./validate/validate";
 type RelayPayload = Record<string, unknown>;
 type Off = () => void;
 interface Relay {
+    /**
+     * Sends an event to the Event API.
+     * @param {string} type - event's type to be emitted.
+     * @param {RelayPayload} payload - payload to include within the event.
+     * @returns {Promise<ValidationResponse | null>} the return value is typed ValidationResponse if the library configuration's mode is validate.
+     */
     emit: (type: string, payload: RelayPayload) => Promise<ValidationResponse | null>;
+    /**
+     * Gets the client-side generated meta object.
+     * @param {string} type - event's type that will be included in the meta object.
+     * @returns {Meta}
+     */
     getMeta: (type: string) => Meta;
+    /**
+     * Attaches an event callback to either all event types or a specific one.
+     * The callback set will be called when an event with the specified type is emitted.
+     * Setting type as "*" will trigger the callback for all event types.
+     * Returns the "off" function to detach the event callback.
+     * @param {string} type - event's type.
+     * @param {EventCallback} callback
+     * @returns {Off}
+     */
     on: (type: string, callback: EventCallback) => Off;
+    /**
+     * Detach callback(s) from events.
+     * If only the "type" parameter is set, all callbacks for the specified type will be removed.
+     * @param {string} type - event's type.
+     * @param {EventCallback} callback - callback that should be removed.
+     * @returns {void}
+     */
     off: (type: string, callback?: EventCallback) => void;
+    /**
+     * Updates Relay's configuration after its initialization.
+     * @param {Partial<RelayConfig>} config - configuration that should be updated.
+     * @returns {void}
+     */
     updateConfig: (config: Partial<RelayConfig>) => void;
+    /**
+     * Current version of the Relay library.
+     */
     version: string;
+    /**
+     * Removes the visitorId cookie and localStorage key.
+     * @returns {void}
+     */
     clearStorage: () => void;
 }
+/**
+ * Initializes the Relay library object.
+ * @param {RelayConfig} initialConfig
+ * @returns {Relay}
+ */
 export declare function createRelay(initialConfig: RelayConfig): Relay;
 export type { RelayPayload, RelayConfig, ValidationError, ValidationResponse };
 //# sourceMappingURL=relay.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"relay.d.ts","sourceRoot":"","sources":["../../src/relay.ts"],"names":[],"mappings":"AAKA,OAAO,EAAc,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAyB,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAuB,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAG1E,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC5C,KAAK,GAAG,GAAG,MAAM,IAAI,CAAC;AAEtB,UAAU,KAAK;IACb,IAAI,EAAE,CACJ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,YAAY,KAClB,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IACxC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,KAAK,GAAG,CAAC;IACnD,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;IACtD,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;IACrD,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,IAAI,CAAC;CAC1B;AAED,wBAAgB,WAAW,CAAC,aAAa,EAAE,WAAW,GAAG,KAAK,CA2C7D;AAED,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC"}
+{"version":3,"file":"relay.d.ts","sourceRoot":"","sources":["../../src/relay.ts"],"names":[],"mappings":"AAKA,OAAO,EAAc,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAyB,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAuB,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAG1E,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC5C,KAAK,GAAG,GAAG,MAAM,IAAI,CAAC;AAEtB,UAAU,KAAK;IACb;;;;;OAKG;IACH,IAAI,EAAE,CACJ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,YAAY,KAClB,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhC;;;;;;;;OAQG;IACH,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,KAAK,GAAG,CAAC;IAEnD;;;;;;OAMG;IACH,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;IAEtD;;;;OAIG;IACH,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;IAErD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,YAAY,EAAE,MAAM,IAAI,CAAC;CAC1B;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,aAAa,EAAE,WAAW,GAAG,KAAK,CA2C7D;AAED,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC"}

package/lib/types/validate/validate.d.ts

@@ -7,12 +7,28 @@ export interface ValidateParams {
     event: Readonly<RelayEvent>;
 }
 export interface ValidationError {
+    /**
+     * Type of syntax error of an event's property.
+     */
     type: string;
+    /**
+     * Message describing the syntax error of an event's property.
+     */
     message: string;
+    /**
+     * Path of the property with a syntax error in the event's payload.
+     */
     path: string;
 }
 export interface ValidationResponse {
+    /**
+     * Indicates whether the payload is valid.
+     */
     valid: boolean;
+    /**
+     * List of syntax errors found in the emitted event(s).
+     * Each syntax error for a given property in a given event will be represented as a single ValidationError object.
+     */
     errors: ValidationError[];
 }
 export declare function validate({ config, environment, event, }: ValidateParams): Promise<Readonly<ValidationResponse>>;

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

@@ -1 +1 @@
-{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/validate/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,wBAAsB,QAAQ,CAAC,EAC7B,MAAM,EACN,WAAW,EACX,KAAK,GACN,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CA8BxD"}
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/validate/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,wBAAsB,QAAQ,CAAC,EAC7B,MAAM,EACN,WAAW,EACX,KAAK,GACN,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CA8BxD"}

package/package.json

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