coveo.analytics 2.30.55 → 2.31.0

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.
Files changed (86) hide show
  1. package/README.md +37 -43
  2. package/dist/browser.mjs +525 -357
  3. package/dist/coveoua.browser.js +1 -1
  4. package/dist/coveoua.browser.js.map +1 -1
  5. package/dist/coveoua.debug.js +559 -359
  6. package/dist/coveoua.debug.js.map +1 -1
  7. package/dist/coveoua.js +1 -1
  8. package/dist/coveoua.js.map +1 -1
  9. package/dist/definitions/client/analytics.d.ts +3 -2
  10. package/dist/definitions/client/runtimeEnvironment.d.ts +1 -1
  11. package/dist/definitions/donottrack.d.ts +1 -0
  12. package/dist/definitions/react-native/index.d.ts +1 -1
  13. package/dist/definitions/searchPage/searchPageClient.d.ts +3 -1
  14. package/dist/definitions/searchPage/searchPageEvents.d.ts +6 -0
  15. package/dist/definitions/version.d.ts +1 -1
  16. package/dist/library.cjs +15367 -3699
  17. package/dist/library.es.js +525 -357
  18. package/dist/library.js +15367 -3699
  19. package/dist/library.mjs +15367 -3699
  20. package/dist/react-native.es.js +646 -460
  21. package/modules/package.json +9 -9
  22. package/package.json +60 -91
  23. package/react-native/package.json +7 -7
  24. package/src/caseAssist/caseAssistActions.ts +51 -50
  25. package/src/caseAssist/caseAssistClient.spec.ts +328 -297
  26. package/src/caseAssist/caseAssistClient.ts +201 -185
  27. package/src/client/analytics.spec.ts +724 -703
  28. package/src/client/analytics.ts +677 -602
  29. package/src/client/analyticsBeaconClient.spec.ts +195 -188
  30. package/src/client/analyticsBeaconClient.ts +99 -88
  31. package/src/client/analyticsFetchClient.ts +77 -61
  32. package/src/client/analyticsRequestClient.ts +17 -17
  33. package/src/client/location.ts +3 -3
  34. package/src/client/measurementProtocolMapper.ts +54 -45
  35. package/src/client/measurementProtocolMapping/baseMeasurementProtocolMapper.ts +48 -44
  36. package/src/client/measurementProtocolMapping/commerceMeasurementProtocolMapper.ts +133 -121
  37. package/src/client/measurementProtocolMapping/serviceMeasurementProtocolMapper.ts +17 -17
  38. package/src/client/noopAnalytics.ts +80 -68
  39. package/src/client/runtimeEnvironment.ts +50 -41
  40. package/src/client/utils.spec.ts +112 -97
  41. package/src/client/utils.ts +39 -39
  42. package/src/cookieutils.spec.ts +59 -0
  43. package/src/cookieutils.ts +40 -39
  44. package/src/coveoua/browser.ts +14 -12
  45. package/src/coveoua/library.ts +4 -4
  46. package/src/coveoua/plugins.ts +36 -34
  47. package/src/coveoua/simpleanalytics.spec.ts +467 -452
  48. package/src/coveoua/simpleanalytics.ts +146 -140
  49. package/src/detector.ts +17 -17
  50. package/src/donottrack.spec.ts +199 -121
  51. package/src/donottrack.ts +31 -8
  52. package/src/events.ts +86 -79
  53. package/src/formatting/format-array-for-coveo-custom-data.spec.ts +13 -12
  54. package/src/formatting/format-array-for-coveo-custom-data.ts +18 -18
  55. package/src/formatting/format-omnibox-metadata.ts +16 -12
  56. package/src/history.spec.ts +197 -195
  57. package/src/history.ts +143 -133
  58. package/src/hook/addDefaultValues.ts +13 -8
  59. package/src/hook/enhanceViewEvent.ts +17 -17
  60. package/src/insight/insightClient.spec.ts +1848 -1717
  61. package/src/insight/insightClient.ts +866 -761
  62. package/src/insight/insightEvents.ts +57 -56
  63. package/src/plugins/BasePlugin.ts +125 -121
  64. package/src/plugins/ec.spec.ts +457 -429
  65. package/src/plugins/ec.ts +202 -199
  66. package/src/plugins/link.spec.ts +183 -159
  67. package/src/plugins/link.ts +88 -85
  68. package/src/plugins/svc.spec.ts +161 -155
  69. package/src/plugins/svc.ts +93 -91
  70. package/src/react-native/index.ts +5 -1
  71. package/src/react-native/react-native-runtime.ts +33 -33
  72. package/src/react-native/react-native-utils.ts +1 -1
  73. package/src/react-native/react-native.spec.ts +22 -21
  74. package/src/searchPage/searchPageClient.spec.ts +1944 -1766
  75. package/src/searchPage/searchPageClient.ts +1261 -1029
  76. package/src/searchPage/searchPageEvents.ts +529 -500
  77. package/src/storage.spec.ts +51 -51
  78. package/src/storage.ts +47 -47
  79. package/dist/definitions/bundle/browser-fetch.d.ts +0 -1
  80. package/dist/definitions/src/coveoua/browser.d.ts +0 -6
  81. package/dist/definitions/src/coveoua/headless.d.ts +0 -6
  82. package/dist/definitions/src/coveoua/library.d.ts +0 -17
  83. package/dist/definitions/src/coveoua/plugins.d.ts +0 -10
  84. package/dist/definitions/src/coveoua/simpleanalytics.d.ts +0 -33
  85. package/dist/definitions/src/react-native/index.d.ts +0 -3
  86. package/dist/definitions/src/react-native/react-native-runtime.d.ts +0 -19
@@ -1,11 +1,11 @@
1
1
  {
2
- "name": "modules",
3
- "private": true,
4
- "main": "../dist/library.cjs",
5
- "module": "../dist/library.mjs",
6
- "browser": "../dist/browser.mjs",
7
- "types": "../dist/definitions/coveoua/library.d.ts",
8
- "files": [
9
- "../dist"
10
- ]
2
+ "name": "modules",
3
+ "private": true,
4
+ "files": [
5
+ "../dist"
6
+ ],
7
+ "main": "../dist/library.cjs",
8
+ "module": "../dist/library.mjs",
9
+ "browser": "../dist/browser.mjs",
10
+ "types": "../dist/definitions/coveoua/library.d.ts"
11
11
  }
package/package.json CHANGED
@@ -1,92 +1,61 @@
1
1
  {
2
- "name": "coveo.analytics",
3
- "version": "2.30.55",
4
- "description": "📈 Coveo analytics client (node and browser compatible) ",
5
- "main": "dist/library.cjs",
6
- "module": "dist/browser.mjs",
7
- "browser": "dist/coveoua.browser.js",
8
- "types": "dist/definitions/coveoua/library.d.ts",
9
- "scripts": {
10
- "lint:check": "prettier --check .",
11
- "lint:fix": "prettier --write .",
12
- "build": "rollup -c",
13
- "start": "rollup -c -w --environment SERVE",
14
- "test": "jest --clearCache && jest --coverage --silent",
15
- "test:watch": "jest --clearCache && jest --watch --silent",
16
- "prepare-deploy": "mkdir -p deploy && cp dist/coveoua*.js dist/coveoua*.js.map deploy",
17
- "clean": "rimraf -rf dist dist_test coverage"
18
- },
19
- "author": "Coveo",
20
- "repository": {
21
- "type": "git",
22
- "url": "https://github.com/coveo/coveo.analytics.js.git"
23
- },
24
- "license": "MIT",
25
- "dependencies": {
26
- "@types/uuid": "^9.0.0",
27
- "cross-fetch": "^3.1.5",
28
- "react-native-get-random-values": "^1.11.0",
29
- "uuid": "^9.0.0"
30
- },
31
- "devDependencies": {
32
- "@actions/core": "1.10.1",
33
- "@actions/github": "6.0.0",
34
- "@babel/core": "^7.23.2",
35
- "@babel/preset-env": "7.23.2",
36
- "@babel/register": "^7.22.15",
37
- "@octokit/rest": "^20.1.2",
38
- "@rollup/plugin-alias": "^5.0.0",
39
- "@rollup/plugin-commonjs": "^24.1.0",
40
- "@rollup/plugin-json": "^6.0.0",
41
- "@rollup/plugin-node-resolve": "^15.0.2",
42
- "@rollup/plugin-replace": "^5.0.2",
43
- "@rollup/plugin-terser": "^0.4.1",
44
- "@types/fetch-mock": "^7.3.5",
45
- "@types/jest": "^29.1.0",
46
- "@types/jsdom": "^21.1.1",
47
- "@types/mime": "0.0.29",
48
- "@types/node": "^6.0.45",
49
- "@types/uuid": "^9.0.0",
50
- "coveralls-next": "^5.0.0",
51
- "exports-loader": "0.6.4",
52
- "fetch-mock": "^9.11.0",
53
- "husky": "^4.3.0",
54
- "jest": "^29.1.0",
55
- "jest-environment-jsdom": "^29.5.0",
56
- "jsdom": "^27.0.0",
57
- "lint-staged": "^13.2.1",
58
- "prettier": "^3.6.2",
59
- "rimraf": "^6.0.1",
60
- "rollup": "^3.29.5",
61
- "rollup-plugin-copy": "^3.5.0",
62
- "rollup-plugin-serve": "^1.0.1",
63
- "rollup-plugin-typescript2": "^0.34.0",
64
- "stylelint": "^16.23.1",
65
- "ts-jest": "^29.1.0",
66
- "typescript": "^5.0.4"
67
- },
68
- "overrides": {
69
- "plist": "3.0.5"
70
- },
71
- "files": [
72
- "modules/",
73
- "dist/**/*.d.ts",
74
- "dist/**/*.js",
75
- "dist/**/*.mjs",
76
- "dist/**/*.cjs",
77
- "dist/**/*.js.map",
78
- "dist/**/*.mjs.map",
79
- "dist/**/*.cjs.map",
80
- "src/**/*.ts",
81
- "react-native/",
82
- "LICENSE"
83
- ],
84
- "husky": {
85
- "hooks": {
86
- "pre-commit": "lint-staged"
87
- }
88
- },
89
- "lint-staged": {
90
- "*": "prettier --write"
91
- }
92
- }
2
+ "name": "coveo.analytics",
3
+ "version": "2.31.0",
4
+ "description": "📈 Coveo analytics client (node and browser compatible) ",
5
+ "license": "MIT",
6
+ "author": "Coveo",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "git+https://github.com/coveo/ui-kit.git",
10
+ "directory": "packages/coveo-analytics"
11
+ },
12
+ "files": [
13
+ "modules/",
14
+ "dist/**/*.d.ts",
15
+ "dist/**/*.js",
16
+ "dist/**/*.mjs",
17
+ "dist/**/*.cjs",
18
+ "dist/**/*.js.map",
19
+ "dist/**/*.mjs.map",
20
+ "dist/**/*.cjs.map",
21
+ "src/**/*.ts",
22
+ "react-native/",
23
+ "LICENSE"
24
+ ],
25
+ "main": "dist/library.cjs",
26
+ "module": "dist/browser.mjs",
27
+ "browser": "dist/coveoua.browser.js",
28
+ "types": "dist/definitions/coveoua/library.d.ts",
29
+ "dependencies": {
30
+ "cross-fetch": "3.2.0",
31
+ "react-native-get-random-values": "1.11.0",
32
+ "uuid": "14.0.1"
33
+ },
34
+ "devDependencies": {
35
+ "@rollup/plugin-alias": "5.1.1",
36
+ "@rollup/plugin-commonjs": "29.0.3",
37
+ "@rollup/plugin-json": "6.1.0",
38
+ "@rollup/plugin-node-resolve": "16.0.3",
39
+ "@rollup/plugin-replace": "6.0.3",
40
+ "@rollup/plugin-terser": "1.0.0",
41
+ "@rollup/plugin-typescript": "12.3.0",
42
+ "@types/node": "24.12.4",
43
+ "fetch-mock": "9.11.0",
44
+ "jsdom": "28.1.0",
45
+ "node-fetch": "2.7.0",
46
+ "rollup": "4.62.2",
47
+ "rollup-plugin-copy": "3.5.0",
48
+ "rollup-plugin-serve": "1.1.1",
49
+ "tslib": "2.8.1",
50
+ "typescript": "6.0.3",
51
+ "vitest": "4.1.9"
52
+ },
53
+ "scripts": {
54
+ "build": "rollup -c",
55
+ "start": "rollup -c -w --environment SERVE",
56
+ "test": "vitest run",
57
+ "test:watch": "vitest",
58
+ "prepare-deploy": "mkdir -p deploy && cp dist/coveoua*.js dist/coveoua*.js.map deploy",
59
+ "clean": "node ../../utils/ci/rm-rf.mjs dist coverage"
60
+ }
61
+ }
@@ -1,9 +1,9 @@
1
1
  {
2
- "private": true,
3
- "name": "react-native",
4
- "description": "Coveo analytics client for React Native",
5
- "main": "../dist/react-native.es.js",
6
- "module": "../dist/react-native.es.js",
7
- "types": "../dist/definitions/react-native/index.d.ts",
8
- "license": "MIT"
2
+ "name": "react-native",
3
+ "private": true,
4
+ "description": "Coveo analytics client for React Native",
5
+ "license": "MIT",
6
+ "main": "../dist/react-native.es.js",
7
+ "module": "../dist/react-native.es.js",
8
+ "types": "../dist/definitions/react-native/index.d.ts"
9
9
  }
@@ -1,93 +1,94 @@
1
1
  import {TicketProperties} from '../plugins/svc';
2
2
 
3
3
  export enum CaseAssistEvents {
4
- click = 'click',
5
- flowStart = 'flowStart',
4
+ click = 'click',
5
+ flowStart = 'flowStart',
6
6
  }
7
7
 
8
8
  export enum CaseAssistActions {
9
- enterInterface = 'ticket_create_start',
10
- fieldUpdate = 'ticket_field_update',
11
- fieldSuggestionClick = 'ticket_classification_click',
12
- documentSuggestionClick = 'documentSuggestionClick',
13
- documentSuggestionQuickview = 'documentSuggestionQuickview',
14
- suggestionRate = 'suggestion_rate',
15
- nextCaseStep = 'ticket_next_stage',
16
- caseCancelled = 'ticket_cancel',
17
- caseSolved = 'ticket_cancel',
18
- caseCreated = 'ticket_create',
9
+ enterInterface = 'ticket_create_start',
10
+ fieldUpdate = 'ticket_field_update',
11
+ fieldSuggestionClick = 'ticket_classification_click',
12
+ documentSuggestionClick = 'documentSuggestionClick',
13
+ documentSuggestionQuickview = 'documentSuggestionQuickview',
14
+ suggestionRate = 'suggestion_rate',
15
+ nextCaseStep = 'ticket_next_stage',
16
+ // oxlint-disable-next-line typescript/no-duplicate-enum-values
17
+ caseCancelled = 'ticket_cancel',
18
+ caseSolved = 'ticket_cancel',
19
+ caseCreated = 'ticket_create',
19
20
  }
20
21
 
21
22
  export enum CaseCancelledReasons {
22
- quit = 'Quit',
23
- solved = 'Solved',
23
+ quit = 'Quit',
24
+ solved = 'Solved',
24
25
  }
25
26
 
26
27
  export interface EnterInterfaceMetadata {
27
- ticket: TicketProperties;
28
+ ticket: TicketProperties;
28
29
  }
29
30
 
30
31
  export interface UpdateCaseFieldMetadata {
31
- fieldName: string;
32
- ticket: TicketProperties;
32
+ fieldName: string;
33
+ ticket: TicketProperties;
33
34
  }
34
35
 
35
36
  export interface SelectFieldSuggestionMetadata {
36
- suggestion: FieldSuggestion;
37
- ticket: TicketProperties;
37
+ suggestion: FieldSuggestion;
38
+ ticket: TicketProperties;
38
39
  }
39
40
 
40
41
  export interface SelectDocumentSuggestionMetadata {
41
- suggestion: DocumentSuggestion;
42
- ticket: TicketProperties;
42
+ suggestion: DocumentSuggestion;
43
+ ticket: TicketProperties;
43
44
  }
44
45
 
45
46
  export interface RateDocumentSuggestionMetadata {
46
- rating: number;
47
- suggestion: DocumentSuggestion;
48
- ticket: TicketProperties;
47
+ rating: number;
48
+ suggestion: DocumentSuggestion;
49
+ ticket: TicketProperties;
49
50
  }
50
51
 
51
52
  export interface MoveToNextCaseStepMetadata {
52
- ticket: TicketProperties;
53
- stage?: string;
53
+ ticket: TicketProperties;
54
+ stage?: string;
54
55
  }
55
56
 
56
57
  export interface CaseCancelledMetadata {
57
- ticket: TicketProperties;
58
+ ticket: TicketProperties;
58
59
  }
59
60
 
60
61
  export interface CaseSolvedMetadata {
61
- ticket: TicketProperties;
62
+ ticket: TicketProperties;
62
63
  }
63
64
 
64
65
  export interface CaseCreatedMetadata {
65
- ticket: TicketProperties;
66
+ ticket: TicketProperties;
66
67
  }
67
68
 
68
69
  export interface FieldSuggestion {
69
- classificationId: string;
70
- responseId: string;
71
- fieldName: string;
72
- classification: {
73
- value: string;
74
- confidence: number;
75
- };
76
- autoSelection?: boolean;
70
+ classificationId: string;
71
+ responseId: string;
72
+ fieldName: string;
73
+ classification: {
74
+ value: string;
75
+ confidence: number;
76
+ };
77
+ autoSelection?: boolean;
77
78
  }
78
79
 
79
80
  export interface DocumentSuggestion {
80
- suggestionId: string;
81
- responseId: string;
82
- permanentId: string;
83
- suggestion: {
84
- documentUri: string;
85
- documentUriHash: string;
86
- documentTitle: string;
87
- documentUrl: string;
88
- documentPosition: number;
89
- sourceName: string;
90
- };
91
- fromQuickview?: boolean;
92
- openDocument?: boolean;
81
+ suggestionId: string;
82
+ responseId: string;
83
+ permanentId: string;
84
+ suggestion: {
85
+ documentUri: string;
86
+ documentUriHash: string;
87
+ documentTitle: string;
88
+ documentUrl: string;
89
+ documentPosition: number;
90
+ sourceName: string;
91
+ };
92
+ fromQuickview?: boolean;
93
+ openDocument?: boolean;
93
94
  }