@coveo/relay-event-types 18.0.0 → 18.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/relay-event-types",
3
- "version": "18.0.0",
3
+ "version": "18.0.2",
4
4
  "description": "Typescript types for Coveo Events, intended to be used with the Relay package.",
5
5
  "types": "./relay-event-types.d.ts",
6
6
  "author": "Coveo",
@@ -17,7 +17,7 @@ interface Base {
17
17
 
18
18
  interface BaseItemClick extends Base {
19
19
  /**
20
- * A unique identifier for the response of a service which returned the list of relevant items. E.g. a searchId or similar.
20
+ * A unique identifier for the response of a service which returned the list of relevant items. For example, a searchId or similar.
21
21
  */
22
22
  responseId?: UuidNotNull;
23
23
  /**
@@ -32,7 +32,7 @@ interface BaseItemClick extends Base {
32
32
  }
33
33
 
34
34
  /**
35
- * The itemClick event is emitted when sending data related to a user's click on an item returned by Coveo.
35
+ * The itemClick event is emitted when a user clicks an item returned by Coveo.
36
36
  */
37
37
  export interface ItemClick extends BaseItemClick {
38
38
  }
@@ -139,7 +139,7 @@ export namespace CaseAssist {
139
139
  }
140
140
 
141
141
  /**
142
- * The caseAssist.documentSuggestionClick event is emitted when a user clicks on a Case Assist document suggestion.
142
+ * The caseAssist.documentSuggestionClick event is emitted when a user clicks a Case Assist document suggestion.
143
143
  */
144
144
  export interface DocumentSuggestionClick extends Base {
145
145
  /**
@@ -330,7 +330,7 @@ export namespace InsightPanel {
330
330
  */
331
331
  context: Context;
332
332
  /**
333
- * The id of the item in the source repository (ex: A knowledge article record ID in Saleforce).
333
+ * The id of the item in the source repository (ex: A knowledge article record ID in Salesforce).
334
334
  */
335
335
  sourceEntityId?: string;
336
336
  }