@coveo/relay 1.0.0 → 1.1.1

package/lib/docs/relay-docs.json

@@ -1,1862 +0,0 @@
-{
-	"id": 0,
-	"name": "@coveo/relay",
-	"variant": "project",
-	"kind": 1,
-	"flags": {},
-	"children": [
-		{
-			"id": 41,
-			"name": "EventConfig",
-			"variant": "declaration",
-			"kind": 256,
-			"flags": {},
-			"comment": {
-				"summary": [
-					{
-						"kind": "text",
-						"text": "The "
-					},
-					{
-						"kind": "code",
-						"text": "`EventConfig`"
-					},
-					{
-						"kind": "text",
-						"text": " object provides additonal information for the configuration associated with the event."
-					}
-				]
-			},
-			"children": [
-				{
-					"id": 42,
-					"name": "trackingId",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "The unique identifier of a web property. See [What's a tracking ID?](https://docs.coveo.com/en/n8tg0567/)."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "event/meta/meta.ts",
-							"line": 13,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/meta/meta.ts#L13"
-						}
-					],
-					"type": {
-						"type": "intrinsic",
-						"name": "string"
-					}
-				}
-			],
-			"groups": [
-				{
-					"title": "Properties",
-					"children": [
-						42
-					]
-				}
-			],
-			"sources": [
-				{
-					"fileName": "event/meta/meta.ts",
-					"line": 9,
-					"character": 17,
-					"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/meta/meta.ts#L9"
-				}
-			]
-		},
-		{
-			"id": 32,
-			"name": "Meta",
-			"variant": "declaration",
-			"kind": 256,
-			"flags": {},
-			"comment": {
-				"summary": [
-					{
-						"kind": "text",
-						"text": "The "
-					},
-					{
-						"kind": "code",
-						"text": "`Meta`"
-					},
-					{
-						"kind": "text",
-						"text": " object provides a structured representation of metadata associated with an emitted event.\nThis object is auto-populated by Relay."
-					}
-				]
-			},
-			"children": [
-				{
-					"id": 37,
-					"name": "clientId",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Persistent unique identifier of a device."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "event/meta/meta.ts",
-							"line": 44,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/meta/meta.ts#L44"
-						}
-					],
-					"type": {
-						"type": "intrinsic",
-						"name": "string"
-					}
-				},
-				{
-					"id": 34,
-					"name": "config",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Configuration associated with the event."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "event/meta/meta.ts",
-							"line": 29,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/meta/meta.ts#L29"
-						}
-					],
-					"type": {
-						"type": "reference",
-						"target": 41,
-						"name": "EventConfig",
-						"package": "@coveo/relay"
-					}
-				},
-				{
-					"id": 40,
-					"name": "location",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Browser Location's [href](https://developer.mozilla.org/en-US/docs/Web/API/Location/href) property if set."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "event/meta/meta.ts",
-							"line": 59,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/meta/meta.ts#L59"
-						}
-					],
-					"type": {
-						"type": "union",
-						"types": [
-							{
-								"type": "literal",
-								"value": null
-							},
-							{
-								"type": "intrinsic",
-								"name": "string"
-							}
-						]
-					}
-				},
-				{
-					"id": 39,
-					"name": "referrer",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Browser Document's [referrer](https://developer.mozilla.org/en-US/docs/Web/API/Document/referrer) property if set."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "event/meta/meta.ts",
-							"line": 54,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/meta/meta.ts#L54"
-						}
-					],
-					"type": {
-						"type": "union",
-						"types": [
-							{
-								"type": "literal",
-								"value": null
-							},
-							{
-								"type": "intrinsic",
-								"name": "string"
-							}
-						]
-					}
-				},
-				{
-					"id": 36,
-					"name": "source",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Names and versions of the client side libraries which built and emitted this event."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "event/meta/meta.ts",
-							"line": 39,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/meta/meta.ts#L39"
-						}
-					],
-					"type": {
-						"type": "array",
-						"elementType": {
-							"type": "intrinsic",
-							"name": "string"
-						}
-					}
-				},
-				{
-					"id": 35,
-					"name": "ts",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Timestamp when the event was emitted."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "event/meta/meta.ts",
-							"line": 34,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/meta/meta.ts#L34"
-						}
-					],
-					"type": {
-						"type": "intrinsic",
-						"name": "number"
-					}
-				},
-				{
-					"id": 33,
-					"name": "type",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Event's type that was emitted."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "event/meta/meta.ts",
-							"line": 24,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/meta/meta.ts#L24"
-						}
-					],
-					"type": {
-						"type": "intrinsic",
-						"name": "string"
-					}
-				},
-				{
-					"id": 38,
-					"name": "userAgent",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Browser Navigator's [user agent](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/userAgent) property if set."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "event/meta/meta.ts",
-							"line": 49,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/meta/meta.ts#L49"
-						}
-					],
-					"type": {
-						"type": "union",
-						"types": [
-							{
-								"type": "literal",
-								"value": null
-							},
-							{
-								"type": "intrinsic",
-								"name": "string"
-							}
-						]
-					}
-				}
-			],
-			"groups": [
-				{
-					"title": "Properties",
-					"children": [
-						37,
-						34,
-						40,
-						39,
-						36,
-						35,
-						33,
-						38
-					]
-				}
-			],
-			"sources": [
-				{
-					"fileName": "event/meta/meta.ts",
-					"line": 20,
-					"character": 17,
-					"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/meta/meta.ts#L20"
-				}
-			]
-		},
-		{
-			"id": 7,
-			"name": "Relay",
-			"variant": "declaration",
-			"kind": 256,
-			"flags": {},
-			"comment": {
-				"summary": [
-					{
-						"kind": "text",
-						"text": "Relay instance.\nThis object provides a comprehensive set of variables and methods for interacting with the Event API."
-					}
-				]
-			},
-			"children": [
-				{
-					"id": 8,
-					"name": "emit",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Sends an event to the Event API."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "relay.ts",
-							"line": 29,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L29"
-						}
-					],
-					"type": {
-						"type": "reflection",
-						"declaration": {
-							"id": 9,
-							"name": "__type",
-							"variant": "declaration",
-							"kind": 65536,
-							"flags": {},
-							"sources": [
-								{
-									"fileName": "relay.ts",
-									"line": 29,
-									"character": 8,
-									"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L29"
-								}
-							],
-							"signatures": [
-								{
-									"id": 10,
-									"name": "__type",
-									"variant": "signature",
-									"kind": 4096,
-									"flags": {},
-									"comment": {
-										"summary": [],
-										"blockTags": [
-											{
-												"tag": "@returns",
-												"content": []
-											}
-										]
-									},
-									"sources": [
-										{
-											"fileName": "relay.ts",
-											"line": 29,
-											"character": 8,
-											"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L29"
-										}
-									],
-									"parameters": [
-										{
-											"id": 11,
-											"name": "type",
-											"variant": "param",
-											"kind": 32768,
-											"flags": {},
-											"comment": {
-												"summary": [
-													{
-														"kind": "text",
-														"text": "event's type to be emitted."
-													}
-												]
-											},
-											"type": {
-												"type": "intrinsic",
-												"name": "string"
-											}
-										},
-										{
-											"id": 12,
-											"name": "payload",
-											"variant": "param",
-											"kind": 32768,
-											"flags": {},
-											"comment": {
-												"summary": [
-													{
-														"kind": "text",
-														"text": "payload to include within the event."
-													}
-												]
-											},
-											"type": {
-												"type": "reference",
-												"target": {
-													"sourceFileName": "../../node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts",
-													"qualifiedName": "Record"
-												},
-												"typeArguments": [
-													{
-														"type": "intrinsic",
-														"name": "string"
-													},
-													{
-														"type": "intrinsic",
-														"name": "any"
-													}
-												],
-												"name": "Record",
-												"package": "typescript"
-											}
-										}
-									],
-									"type": {
-										"type": "intrinsic",
-										"name": "void"
-									}
-								}
-							]
-						}
-					}
-				},
-				{
-					"id": 13,
-					"name": "getMeta",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Gets the client-side generated meta object."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "relay.ts",
-							"line": 36,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L36"
-						}
-					],
-					"type": {
-						"type": "reflection",
-						"declaration": {
-							"id": 14,
-							"name": "__type",
-							"variant": "declaration",
-							"kind": 65536,
-							"flags": {},
-							"sources": [
-								{
-									"fileName": "relay.ts",
-									"line": 36,
-									"character": 11,
-									"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L36"
-								}
-							],
-							"signatures": [
-								{
-									"id": 15,
-									"name": "__type",
-									"variant": "signature",
-									"kind": 4096,
-									"flags": {},
-									"comment": {
-										"summary": [],
-										"blockTags": [
-											{
-												"tag": "@returns",
-												"content": []
-											}
-										]
-									},
-									"sources": [
-										{
-											"fileName": "relay.ts",
-											"line": 36,
-											"character": 11,
-											"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L36"
-										}
-									],
-									"parameters": [
-										{
-											"id": 16,
-											"name": "type",
-											"variant": "param",
-											"kind": 32768,
-											"flags": {},
-											"comment": {
-												"summary": [
-													{
-														"kind": "text",
-														"text": "event's type that will be included in the meta object."
-													}
-												]
-											},
-											"type": {
-												"type": "intrinsic",
-												"name": "string"
-											}
-										}
-									],
-									"type": {
-										"type": "reference",
-										"target": 32,
-										"name": "Meta",
-										"package": "@coveo/relay"
-									}
-								}
-							]
-						}
-					}
-				},
-				{
-					"id": 22,
-					"name": "off",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Detach callback(s) from events.\nIf only the \"type\" parameter is set, all callbacks for the specified type will be removed."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "relay.ts",
-							"line": 57,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L57"
-						}
-					],
-					"type": {
-						"type": "reflection",
-						"declaration": {
-							"id": 23,
-							"name": "__type",
-							"variant": "declaration",
-							"kind": 65536,
-							"flags": {},
-							"sources": [
-								{
-									"fileName": "relay.ts",
-									"line": 57,
-									"character": 7,
-									"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L57"
-								}
-							],
-							"signatures": [
-								{
-									"id": 24,
-									"name": "__type",
-									"variant": "signature",
-									"kind": 4096,
-									"flags": {},
-									"comment": {
-										"summary": [],
-										"blockTags": [
-											{
-												"tag": "@returns",
-												"content": []
-											}
-										]
-									},
-									"sources": [
-										{
-											"fileName": "relay.ts",
-											"line": 57,
-											"character": 7,
-											"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L57"
-										}
-									],
-									"parameters": [
-										{
-											"id": 25,
-											"name": "type",
-											"variant": "param",
-											"kind": 32768,
-											"flags": {},
-											"comment": {
-												"summary": [
-													{
-														"kind": "text",
-														"text": "event's type."
-													}
-												]
-											},
-											"type": {
-												"type": "intrinsic",
-												"name": "string"
-											}
-										},
-										{
-											"id": 26,
-											"name": "callback",
-											"variant": "param",
-											"kind": 32768,
-											"flags": {
-												"isOptional": true
-											},
-											"comment": {
-												"summary": [
-													{
-														"kind": "text",
-														"text": "callback that should be removed."
-													}
-												]
-											},
-											"type": {
-												"type": "reference",
-												"target": 43,
-												"name": "EventCallback",
-												"package": "@coveo/relay"
-											}
-										}
-									],
-									"type": {
-										"type": "intrinsic",
-										"name": "void"
-									}
-								}
-							]
-						}
-					}
-				},
-				{
-					"id": 17,
-					"name": "on",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Attaches an event callback to either all event types or a specific one.\nThe callback set will be called when an event with the specified type is emitted.\nIt’s not possible to modify the payload of the event sent to Coveo using this listener.\nSetting type as \"*\" will trigger the callback for all event types.\nReturns the \"off\" function to detach the event callback."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "relay.ts",
-							"line": 48,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L48"
-						}
-					],
-					"type": {
-						"type": "reflection",
-						"declaration": {
-							"id": 18,
-							"name": "__type",
-							"variant": "declaration",
-							"kind": 65536,
-							"flags": {},
-							"sources": [
-								{
-									"fileName": "relay.ts",
-									"line": 48,
-									"character": 6,
-									"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L48"
-								}
-							],
-							"signatures": [
-								{
-									"id": 19,
-									"name": "__type",
-									"variant": "signature",
-									"kind": 4096,
-									"flags": {},
-									"comment": {
-										"summary": [],
-										"blockTags": [
-											{
-												"tag": "@returns",
-												"content": []
-											}
-										]
-									},
-									"sources": [
-										{
-											"fileName": "relay.ts",
-											"line": 48,
-											"character": 6,
-											"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L48"
-										}
-									],
-									"parameters": [
-										{
-											"id": 20,
-											"name": "type",
-											"variant": "param",
-											"kind": 32768,
-											"flags": {},
-											"comment": {
-												"summary": [
-													{
-														"kind": "text",
-														"text": "event's type."
-													}
-												]
-											},
-											"type": {
-												"type": "intrinsic",
-												"name": "string"
-											}
-										},
-										{
-											"id": 21,
-											"name": "callback",
-											"variant": "param",
-											"kind": 32768,
-											"flags": {},
-											"comment": {
-												"summary": [
-													{
-														"kind": "text",
-														"text": "callback that should be called when the event is emitted."
-													}
-												]
-											},
-											"type": {
-												"type": "reference",
-												"target": 43,
-												"name": "EventCallback",
-												"package": "@coveo/relay"
-											}
-										}
-									],
-									"type": {
-										"type": "reference",
-										"target": 4,
-										"name": "Off",
-										"package": "@coveo/relay"
-									}
-								}
-							]
-						}
-					}
-				},
-				{
-					"id": 27,
-					"name": "updateConfig",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Updates Relay's configuration after its initialization."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "relay.ts",
-							"line": 64,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L64"
-						}
-					],
-					"type": {
-						"type": "reflection",
-						"declaration": {
-							"id": 28,
-							"name": "__type",
-							"variant": "declaration",
-							"kind": 65536,
-							"flags": {},
-							"sources": [
-								{
-									"fileName": "relay.ts",
-									"line": 64,
-									"character": 16,
-									"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L64"
-								}
-							],
-							"signatures": [
-								{
-									"id": 29,
-									"name": "__type",
-									"variant": "signature",
-									"kind": 4096,
-									"flags": {},
-									"comment": {
-										"summary": [],
-										"blockTags": [
-											{
-												"tag": "@returns",
-												"content": []
-											}
-										]
-									},
-									"sources": [
-										{
-											"fileName": "relay.ts",
-											"line": 64,
-											"character": 16,
-											"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L64"
-										}
-									],
-									"parameters": [
-										{
-											"id": 30,
-											"name": "config",
-											"variant": "param",
-											"kind": 32768,
-											"flags": {},
-											"comment": {
-												"summary": [
-													{
-														"kind": "text",
-														"text": "configuration that should be updated."
-													}
-												]
-											},
-											"type": {
-												"type": "reference",
-												"target": {
-													"sourceFileName": "../../node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts",
-													"qualifiedName": "Partial"
-												},
-												"typeArguments": [
-													{
-														"type": "reference",
-														"target": 47,
-														"name": "RelayConfig",
-														"package": "@coveo/relay"
-													}
-												],
-												"name": "Partial",
-												"package": "typescript"
-											}
-										}
-									],
-									"type": {
-										"type": "intrinsic",
-										"name": "void"
-									}
-								}
-							]
-						}
-					}
-				},
-				{
-					"id": 31,
-					"name": "version",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Current version of the Relay library."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "relay.ts",
-							"line": 69,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L69"
-						}
-					],
-					"type": {
-						"type": "intrinsic",
-						"name": "string"
-					}
-				}
-			],
-			"groups": [
-				{
-					"title": "Properties",
-					"children": [
-						8,
-						13,
-						22,
-						17,
-						27,
-						31
-					]
-				}
-			],
-			"sources": [
-				{
-					"fileName": "relay.ts",
-					"line": 22,
-					"character": 10,
-					"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L22"
-				}
-			]
-		},
-		{
-			"id": 47,
-			"name": "RelayConfig",
-			"variant": "declaration",
-			"kind": 256,
-			"flags": {},
-			"comment": {
-				"summary": [
-					{
-						"kind": "text",
-						"text": "The "
-					},
-					{
-						"kind": "code",
-						"text": "`RelayConfig`"
-					},
-					{
-						"kind": "text",
-						"text": " object defines the configuration options for initializing a Relay instance."
-					}
-				]
-			},
-			"children": [
-				{
-					"id": 51,
-					"name": "mode",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {
-						"isOptional": true
-					},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Defines the library mode. The available modes are "
-							},
-							{
-								"kind": "code",
-								"text": "`emit`"
-							},
-							{
-								"kind": "text",
-								"text": " and "
-							},
-							{
-								"kind": "code",
-								"text": "`disabled`"
-							},
-							{
-								"kind": "text",
-								"text": ".\n"
-							},
-							{
-								"kind": "code",
-								"text": "`emit`"
-							},
-							{
-								"kind": "text",
-								"text": " sends analytics events to Coveo to be stored.\n"
-							},
-							{
-								"kind": "code",
-								"text": "`disabled`"
-							},
-							{
-								"kind": "text",
-								"text": " prevents the emission of events and does not trigger callbacks."
-							}
-						],
-						"blockTags": [
-							{
-								"tag": "@default",
-								"content": [
-									{
-										"kind": "code",
-										"text": "```ts\nemit\n```"
-									}
-								]
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "config/config.ts",
-							"line": 26,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/config/config.ts#L26"
-						}
-					],
-					"type": {
-						"type": "union",
-						"types": [
-							{
-								"type": "literal",
-								"value": "emit"
-							},
-							{
-								"type": "literal",
-								"value": "disabled"
-							}
-						]
-					}
-				},
-				{
-					"id": 52,
-					"name": "source",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {
-						"isOptional": true
-					},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Optionally allows a Relay integration to specify the name(s) of software package(s) relay is\nbeing called from. These names will be transmitted with each event, along with Relay's own\nversion. The recommendation is to specify them using a 'softwarename@softwareversion' string."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "config/config.ts",
-							"line": 33,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/config/config.ts#L33"
-						}
-					],
-					"type": {
-						"type": "array",
-						"elementType": {
-							"type": "intrinsic",
-							"name": "string"
-						}
-					}
-				},
-				{
-					"id": 49,
-					"name": "token",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Token to authorize the access to the Event API endpoint."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "config/config.ts",
-							"line": 13,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/config/config.ts#L13"
-						}
-					],
-					"type": {
-						"type": "intrinsic",
-						"name": "string"
-					}
-				},
-				{
-					"id": 50,
-					"name": "trackingId",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "The unique identifier of a web property. See [What's a tracking ID?](https://docs.coveo.com/en/n8tg0567/)."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "config/config.ts",
-							"line": 18,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/config/config.ts#L18"
-						}
-					],
-					"type": {
-						"type": "intrinsic",
-						"name": "string"
-					}
-				},
-				{
-					"id": 48,
-					"name": "url",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Endpoint defined to communicate with the Event API."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "config/config.ts",
-							"line": 8,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/config/config.ts#L8"
-						}
-					],
-					"type": {
-						"type": "intrinsic",
-						"name": "string"
-					}
-				}
-			],
-			"groups": [
-				{
-					"title": "Properties",
-					"children": [
-						51,
-						52,
-						49,
-						50,
-						48
-					]
-				}
-			],
-			"sources": [
-				{
-					"fileName": "config/config.ts",
-					"line": 4,
-					"character": 17,
-					"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/config/config.ts#L4"
-				}
-			]
-		},
-		{
-			"id": 54,
-			"name": "RelayEvent",
-			"variant": "declaration",
-			"kind": 256,
-			"flags": {},
-			"comment": {
-				"summary": [
-					{
-						"kind": "text",
-						"text": "Defines the structure of a RelayEvent, extending the RelayPayload."
-					}
-				]
-			},
-			"children": [
-				{
-					"id": 55,
-					"name": "meta",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Read-only "
-							},
-							{
-								"kind": "code",
-								"text": "`meta`"
-							},
-							{
-								"kind": "text",
-								"text": " property of Meta type."
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "event/relay-event.ts",
-							"line": 14,
-							"character": 2,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/relay-event.ts#L14"
-						}
-					],
-					"type": {
-						"type": "reference",
-						"target": {
-							"sourceFileName": "../../node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts",
-							"qualifiedName": "Readonly"
-						},
-						"typeArguments": [
-							{
-								"type": "reference",
-								"target": 32,
-								"name": "Meta",
-								"package": "@coveo/relay"
-							}
-						],
-						"name": "Readonly",
-						"package": "typescript"
-					}
-				}
-			],
-			"groups": [
-				{
-					"title": "Properties",
-					"children": [
-						55
-					]
-				}
-			],
-			"sources": [
-				{
-					"fileName": "event/relay-event.ts",
-					"line": 10,
-					"character": 17,
-					"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/event/relay-event.ts#L10"
-				}
-			],
-			"extendedTypes": [
-				{
-					"type": "reference",
-					"target": 53,
-					"name": "RelayPayload",
-					"package": "@coveo/relay"
-				}
-			]
-		},
-		{
-			"id": 43,
-			"name": "EventCallback",
-			"variant": "declaration",
-			"kind": 2097152,
-			"flags": {},
-			"comment": {
-				"summary": [
-					{
-						"kind": "text",
-						"text": "Callback to perform an action when a specified event is emitted."
-					}
-				]
-			},
-			"sources": [
-				{
-					"fileName": "listener/listener.ts",
-					"line": 11,
-					"character": 12,
-					"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/listener/listener.ts#L11"
-				}
-			],
-			"type": {
-				"type": "reflection",
-				"declaration": {
-					"id": 44,
-					"name": "__type",
-					"variant": "declaration",
-					"kind": 65536,
-					"flags": {},
-					"sources": [
-						{
-							"fileName": "listener/listener.ts",
-							"line": 11,
-							"character": 28,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/listener/listener.ts#L11"
-						}
-					],
-					"signatures": [
-						{
-							"id": 45,
-							"name": "__type",
-							"variant": "signature",
-							"kind": 4096,
-							"flags": {},
-							"comment": {
-								"summary": [],
-								"blockTags": [
-									{
-										"tag": "@returns",
-										"content": []
-									}
-								]
-							},
-							"parameters": [
-								{
-									"id": 46,
-									"name": "event",
-									"variant": "param",
-									"kind": 32768,
-									"flags": {},
-									"comment": {
-										"summary": [
-											{
-												"kind": "text",
-												"text": "the Relay event payload that triggered the callback."
-											}
-										]
-									},
-									"type": {
-										"type": "reference",
-										"target": 54,
-										"name": "RelayEvent",
-										"package": "@coveo/relay"
-									}
-								}
-							],
-							"type": {
-								"type": "intrinsic",
-								"name": "void"
-							}
-						}
-					]
-				}
-			}
-		},
-		{
-			"id": 4,
-			"name": "Off",
-			"variant": "declaration",
-			"kind": 2097152,
-			"flags": {},
-			"comment": {
-				"summary": [
-					{
-						"kind": "text",
-						"text": "Function that detaches an event callback."
-					}
-				]
-			},
-			"sources": [
-				{
-					"fileName": "relay.ts",
-					"line": 16,
-					"character": 12,
-					"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L16"
-				}
-			],
-			"type": {
-				"type": "reflection",
-				"declaration": {
-					"id": 5,
-					"name": "__type",
-					"variant": "declaration",
-					"kind": 65536,
-					"flags": {},
-					"sources": [
-						{
-							"fileName": "relay.ts",
-							"line": 16,
-							"character": 18,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L16"
-						}
-					],
-					"signatures": [
-						{
-							"id": 6,
-							"name": "__type",
-							"variant": "signature",
-							"kind": 4096,
-							"flags": {},
-							"comment": {
-								"summary": [],
-								"blockTags": [
-									{
-										"tag": "@returns",
-										"content": []
-									}
-								]
-							},
-							"type": {
-								"type": "intrinsic",
-								"name": "void"
-							}
-						}
-					]
-				}
-			}
-		},
-		{
-			"id": 53,
-			"name": "RelayPayload",
-			"variant": "declaration",
-			"kind": 2097152,
-			"flags": {},
-			"comment": {
-				"summary": [
-					{
-						"kind": "text",
-						"text": "Represents the payload sent with Relay.\nIt is a object with string keys and values of any type."
-					}
-				]
-			},
-			"sources": [
-				{
-					"fileName": "relay-payload.ts",
-					"line": 5,
-					"character": 12,
-					"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay-payload.ts#L5"
-				}
-			],
-			"type": {
-				"type": "reference",
-				"target": {
-					"sourceFileName": "../../node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts",
-					"qualifiedName": "Record"
-				},
-				"typeArguments": [
-					{
-						"type": "intrinsic",
-						"name": "string"
-					},
-					{
-						"type": "intrinsic",
-						"name": "any"
-					}
-				],
-				"name": "Record",
-				"package": "typescript"
-			},
-			"extendedBy": [
-				{
-					"type": "reference",
-					"target": 54,
-					"name": "RelayEvent"
-				}
-			]
-		},
-		{
-			"id": 1,
-			"name": "createRelay",
-			"variant": "declaration",
-			"kind": 64,
-			"flags": {},
-			"sources": [
-				{
-					"fileName": "relay.ts",
-					"line": 77,
-					"character": 16,
-					"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L77"
-				}
-			],
-			"signatures": [
-				{
-					"id": 2,
-					"name": "createRelay",
-					"variant": "signature",
-					"kind": 4096,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "Initializes the Relay library object."
-							}
-						],
-						"blockTags": [
-							{
-								"tag": "@returns",
-								"content": []
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "relay.ts",
-							"line": 77,
-							"character": 16,
-							"url": "https://github.com/coveo-platform/relay/blob/bcd1b028a071583b747ff4919f61570855068484/packages/relay/src/relay.ts#L77"
-						}
-					],
-					"parameters": [
-						{
-							"id": 3,
-							"name": "initialConfig",
-							"variant": "param",
-							"kind": 32768,
-							"flags": {},
-							"type": {
-								"type": "reference",
-								"target": 47,
-								"name": "RelayConfig",
-								"package": "@coveo/relay"
-							}
-						}
-					],
-					"type": {
-						"type": "reference",
-						"target": 7,
-						"name": "Relay",
-						"package": "@coveo/relay"
-					}
-				}
-			]
-		}
-	],
-	"groups": [
-		{
-			"title": "Interfaces",
-			"children": [
-				41,
-				32,
-				7,
-				47,
-				54
-			]
-		},
-		{
-			"title": "Type Aliases",
-			"children": [
-				43,
-				4,
-				53
-			]
-		},
-		{
-			"title": "Functions",
-			"children": [
-				1
-			]
-		}
-	],
-	"packageName": "@coveo/relay",
-	"packageVersion": "1.0.0",
-	"readme": [
-		{
-			"kind": "text",
-			"text": "# @coveo/relay\n\nRelay is a compact library for emitting Event Protocol analytics events. It simplifies tracking relevant user interactions. This analytics data powers reports and helps train Coveo Machine Learning models.\n\n## Usage\n\nFirst, create an instance of Relay in your project. This instance can then be used to emit an event or perform other actions.\n\n"
-		},
-		{
-			"kind": "code",
-			"text": "```js\nimport { createRelay } from \"@coveo/relay\";\n\nconst config = {...};\nconst relay = createRelay(config);\n\nconst payload = {...};\nrelay.emit('itemView', payload);\n```"
-		},
-		{
-			"kind": "text",
-			"text": "\n\n## Official documentation\n\n- [Learn more about Relay](https://docs.coveo.com/en/relay/latest/)\n- [List of Event API schemas and reference types](https://docs.coveo.com/en/n9da0377/build-a-search-ui/event-api-reference)"
-		}
-	],
-	"symbolIdMap": {
-		"0": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": ""
-		},
-		"1": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "createRelay"
-		},
-		"2": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "createRelay"
-		},
-		"3": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "initialConfig"
-		},
-		"4": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "Off"
-		},
-		"5": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"6": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"7": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "Relay"
-		},
-		"8": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "Relay.emit"
-		},
-		"9": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"10": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"11": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "type"
-		},
-		"12": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "payload"
-		},
-		"13": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "Relay.getMeta"
-		},
-		"14": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"15": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"16": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "type"
-		},
-		"17": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "Relay.on"
-		},
-		"18": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"19": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"20": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "type"
-		},
-		"21": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "callback"
-		},
-		"22": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "Relay.off"
-		},
-		"23": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"24": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"25": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "type"
-		},
-		"26": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "callback"
-		},
-		"27": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "Relay.updateConfig"
-		},
-		"28": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"29": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "__type"
-		},
-		"30": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "config"
-		},
-		"31": {
-			"sourceFileName": "src/relay.ts",
-			"qualifiedName": "Relay.version"
-		},
-		"32": {
-			"sourceFileName": "src/event/meta/meta.ts",
-			"qualifiedName": "Meta"
-		},
-		"33": {
-			"sourceFileName": "src/event/meta/meta.ts",
-			"qualifiedName": "Meta.type"
-		},
-		"34": {
-			"sourceFileName": "src/event/meta/meta.ts",
-			"qualifiedName": "Meta.config"
-		},
-		"35": {
-			"sourceFileName": "src/event/meta/meta.ts",
-			"qualifiedName": "Meta.ts"
-		},
-		"36": {
-			"sourceFileName": "src/event/meta/meta.ts",
-			"qualifiedName": "Meta.source"
-		},
-		"37": {
-			"sourceFileName": "src/event/meta/meta.ts",
-			"qualifiedName": "Meta.clientId"
-		},
-		"38": {
-			"sourceFileName": "src/event/meta/meta.ts",
-			"qualifiedName": "Meta.userAgent"
-		},
-		"39": {
-			"sourceFileName": "src/event/meta/meta.ts",
-			"qualifiedName": "Meta.referrer"
-		},
-		"40": {
-			"sourceFileName": "src/event/meta/meta.ts",
-			"qualifiedName": "Meta.location"
-		},
-		"41": {
-			"sourceFileName": "src/event/meta/meta.ts",
-			"qualifiedName": "EventConfig"
-		},
-		"42": {
-			"sourceFileName": "src/event/meta/meta.ts",
-			"qualifiedName": "EventConfig.trackingId"
-		},
-		"43": {
-			"sourceFileName": "src/listener/listener.ts",
-			"qualifiedName": "EventCallback"
-		},
-		"44": {
-			"sourceFileName": "src/listener/listener.ts",
-			"qualifiedName": "__type"
-		},
-		"45": {
-			"sourceFileName": "src/listener/listener.ts",
-			"qualifiedName": "__type"
-		},
-		"46": {
-			"sourceFileName": "src/listener/listener.ts",
-			"qualifiedName": "event"
-		},
-		"47": {
-			"sourceFileName": "src/config/config.ts",
-			"qualifiedName": "RelayConfig"
-		},
-		"48": {
-			"sourceFileName": "src/config/config.ts",
-			"qualifiedName": "RelayConfig.url"
-		},
-		"49": {
-			"sourceFileName": "src/config/config.ts",
-			"qualifiedName": "RelayConfig.token"
-		},
-		"50": {
-			"sourceFileName": "src/config/config.ts",
-			"qualifiedName": "RelayConfig.trackingId"
-		},
-		"51": {
-			"sourceFileName": "src/config/config.ts",
-			"qualifiedName": "RelayConfig.mode"
-		},
-		"52": {
-			"sourceFileName": "src/config/config.ts",
-			"qualifiedName": "RelayConfig.source"
-		},
-		"53": {
-			"sourceFileName": "src/relay-payload.ts",
-			"qualifiedName": "RelayPayload"
-		},
-		"54": {
-			"sourceFileName": "src/event/relay-event.ts",
-			"qualifiedName": "RelayEvent"
-		},
-		"55": {
-			"sourceFileName": "src/event/relay-event.ts",
-			"qualifiedName": "RelayEvent.meta"
-		}
-	},
-	"files": {
-		"entries": {
-			"1": "src/relay.ts"
-		},
-		"reflections": {
-			"1": 0
-		}
-	}
-}