@constructor-io/constructorio-client-javascript 2.34.1 → 2.34.3

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 (12) hide show
  1. package/lib/constructorio.js +4 -1
  2. package/lib/modules/quizzes.js +7 -7
  3. package/lib/types/autocomplete.d.ts +46 -54
  4. package/lib/types/browse.d.ts +120 -113
  5. package/lib/types/constructorio.d.ts +23 -22
  6. package/lib/types/event-dispatcher.d.ts +15 -9
  7. package/lib/types/index.d.ts +154 -0
  8. package/lib/types/quizzes.d.ts +85 -0
  9. package/lib/types/recommendations.d.ts +54 -63
  10. package/lib/types/search.d.ts +85 -93
  11. package/lib/types/tracker.d.ts +172 -159
  12. package/package.json +5 -2
package/lib/types/tracker.d.ts CHANGED
@@ -1,162 +1,175 @@
1
- import { ConstructorClientOptions } from "./types";
2
- import EventEmitter = require("events");
3
- import RequestQueue = require("../utils/request-queue");
1
+ import EventEmitter = require('events');
2
+ import { ConstructorClientOptions, NetworkParameters } from '.';
3
+ import RequestQueue = require('../utils/request-queue');
4
4
 
5
- export = Tracker;
5
+ export default Tracker;
6
6
 
7
- /******************
8
- *
9
- * Tracker
10
- *
11
- *****************/
12
7
  declare class Tracker {
13
- constructor(options: ConstructorClientOptions);
14
- private options: ConstructorClientOptions;
15
- private eventemitter: EventEmitter;
16
- private requests: RequestQueue;
17
-
18
- trackSessionStart(networkParameters?: {
19
- timeout?: number;
20
- }): (true | Error);
21
-
22
- trackInputFocus(networkParameters?: {
23
- timeout?: number;
24
- }): (true | Error);
25
-
26
- trackItemDetailLoad(parameters: {
27
- item_name: string;
28
- item_id: string;
29
- variation_id?: string;
30
- }, networkParameters?: {
31
- timeout?: number;
32
- }): (true | Error);
33
-
34
- trackAutocompleteSelect(term: string, parameters: {
35
- original_query: string;
36
- section: string;
37
- tr?: string;
38
- group_id?: string;
39
- display_name?: string;
40
- }, networkParameters?: {
41
- timeout?: number;
42
- }): (true | Error);
43
-
44
- trackSearchSubmit(term: string, parameters: {
45
- original_query: string;
46
- group_id?: string;
47
- display_name?: string;
48
- }, networkParameters?: {
49
- timeout?: number;
50
- }): (true | Error);
51
-
52
- trackSearchResultsLoaded(term: string, parameters: {
53
- num_results: number;
54
- item_ids?: string[];
55
- }, networkParameters?: {
56
- timeout?: number;
57
- }): (true | Error);
58
-
59
- trackSearchResultClick(term: string, parameters: {
60
- item_name: string;
61
- item_id: string;
62
- variation_id?: string;
63
- result_id?: string;
64
- item_is_convertible?: string;
65
- }, networkParameters?: {
66
- timeout?: number;
67
- }): (true | Error);
68
-
69
- trackConversion(term?: string, parameters: {
70
- item_id: string;
71
- revenue?: number;
72
- item_name?: string;
73
- variation_id?: string;
74
- type?: string;
75
- is_custom_type?: boolean;
76
- display_name?: string;
77
- result_id?: string;
78
- section?: string;
79
- }, networkParameters?: {
80
- timeout?: number;
81
- }): (true | Error);
82
-
83
- trackPurchase(parameters: {
84
- items: object[];
85
- revenue: number;
86
- order_id?: string;
87
- section?: string;
88
- }, networkParameters?: {
89
- timeout?: number;
90
- }): (true | Error);
91
-
92
- trackRecommendationView(parameters: {
93
- url: string;
94
- pod_id: string;
95
- num_results_viewed: number;
96
- items?: object[];
97
- result_count?: number;
98
- result_page?: number;
99
- result_id?: string;
100
- section?: string;
101
- }, networkParameters?: {
102
- timeout?: number;
103
- }): (true | Error);
104
-
105
- trackRecommendationClick(parameters: {
106
- pod_id: string;
107
- strategy_id: string;
108
- item_id: string;
109
- variation_id?: string;
110
- section?: string;
111
- result_id?: string;
112
- result_count?: number;
113
- result_page?: number;
114
- result_position_on_page?: number;
115
- num_results_per_page?: number;
116
- }, networkParameters?: {
117
- timeout?: number;
118
- }): (true | Error);
119
-
120
- trackBrowseResultsLoaded(parameters: {
121
- url: string;
122
- filter_name: string;
123
- filter_value: string;
124
- section?: string;
125
- result_count?: number;
126
- result_page?: number;
127
- result_id?: string;
128
- selected_filters?: object;
129
- sort_order?: string;
130
- sort_by?: string;
131
- items?: object[];
132
- }, networkParameters?: {
133
- timeout?: number;
134
- }): (true | Error);
135
-
136
- trackBrowseResultClick(parameters: {
137
- filter_name: string;
138
- filter_value: string;
139
- item_id: string;
140
- section?: string;
141
- variation_id?: string;
142
- result_id?: string;
143
- result_count?: number;
144
- result_page?: number;
145
- result_position_on_page?: number;
146
- num_results_per_page?: number;
147
- selected_filters?: object;
148
- }, networkParameters?: {
149
- timeout?: number;
150
- }): (true | Error);
151
-
152
- trackGenericResultClick(parameters: {
153
- item_id: string;
154
- item_name?: string;
155
- variation_id?: string;
156
- section?: string;
157
- }, networkParameters?: {
158
- timeout?: number;
159
- }): (true | Error);
160
-
161
- on(messageType: string, callback: Function): (true | Error);
162
- }
8
+ constructor(options: ConstructorClientOptions);
9
+
10
+ private options: ConstructorClientOptions;
11
+
12
+ private eventemitter: EventEmitter;
13
+
14
+ private requests: RequestQueue;
15
+
16
+ trackSessionStart(networkParameters?: NetworkParameters): true | Error;
17
+
18
+ trackInputFocus(networkParameters?: NetworkParameters): true | Error;
19
+
20
+ trackItemDetailLoad(
21
+ parameters: {
22
+ item_name: string;
23
+ item_id: string;
24
+ variation_id?: string;
25
+ },
26
+ networkParameters?: NetworkParameters
27
+ ): true | Error;
28
+
29
+ trackAutocompleteSelect(
30
+ term: string,
31
+ parameters: {
32
+ original_query: string;
33
+ section: string;
34
+ tr?: string;
35
+ group_id?: string;
36
+ display_name?: string;
37
+ },
38
+ networkParameters?: NetworkParameters
39
+ ): true | Error;
40
+
41
+ trackSearchSubmit(
42
+ term: string,
43
+ parameters: {
44
+ original_query: string;
45
+ group_id?: string;
46
+ display_name?: string;
47
+ },
48
+ networkParameters?: NetworkParameters
49
+ ): true | Error;
50
+
51
+ trackSearchResultsLoaded(
52
+ term: string,
53
+ parameters: {
54
+ num_results: number;
55
+ item_ids?: string[];
56
+ },
57
+ networkParameters?: NetworkParameters
58
+ ): true | Error;
59
+
60
+ trackSearchResultClick(
61
+ term: string,
62
+ parameters: {
63
+ item_name: string;
64
+ item_id: string;
65
+ variation_id?: string;
66
+ result_id?: string;
67
+ item_is_convertible?: string;
68
+ section?: string;
69
+ },
70
+ networkParameters?: NetworkParameters
71
+ ): true | Error;
72
+
73
+ trackConversion(
74
+ term?: string,
75
+ parameters: {
76
+ item_id: string;
77
+ revenue?: number;
78
+ item_name?: string;
79
+ variation_id?: string;
80
+ type?: string;
81
+ is_custom_type?: boolean;
82
+ display_name?: string;
83
+ result_id?: string;
84
+ section?: string;
85
+ },
86
+ networkParameters?: NetworkParameters
87
+ ): true | Error;
88
+
89
+ trackPurchase(
90
+ parameters: {
91
+ items: object[];
92
+ revenue: number;
93
+ order_id?: string;
94
+ section?: string;
95
+ },
96
+ networkParameters?: NetworkParameters
97
+ ): true | Error;
98
+
99
+ trackRecommendationView(
100
+ parameters: {
101
+ url: string;
102
+ pod_id: string;
103
+ num_results_viewed: number;
104
+ items?: object[];
105
+ result_count?: number;
106
+ result_page?: number;
107
+ result_id?: string;
108
+ section?: string;
109
+ },
110
+ networkParameters?: NetworkParameters
111
+ ): true | Error;
112
+
113
+ trackRecommendationClick(
114
+ parameters: {
115
+ pod_id: string;
116
+ strategy_id: string;
117
+ item_id: string;
118
+ item_name: string;
119
+ variation_id?: string;
120
+ section?: string;
121
+ result_id?: string;
122
+ result_count?: number;
123
+ result_page?: number;
124
+ result_position_on_page?: number;
125
+ num_results_per_page?: number;
126
+ },
127
+ networkParameters?: NetworkParameters
128
+ ): true | Error;
129
+
130
+ trackBrowseResultsLoaded(
131
+ parameters: {
132
+ url: string;
133
+ filter_name: string;
134
+ filter_value: string;
135
+ section?: string;
136
+ result_count?: number;
137
+ result_page?: number;
138
+ result_id?: string;
139
+ selected_filters?: object;
140
+ sort_order?: string;
141
+ sort_by?: string;
142
+ items?: object[];
143
+ },
144
+ networkParameters?: NetworkParameters
145
+ ): true | Error;
146
+
147
+ trackBrowseResultClick(
148
+ parameters: {
149
+ filter_name: string;
150
+ filter_value: string;
151
+ item_id: string;
152
+ section?: string;
153
+ variation_id?: string;
154
+ result_id?: string;
155
+ result_count?: number;
156
+ result_page?: number;
157
+ result_position_on_page?: number;
158
+ num_results_per_page?: number;
159
+ selected_filters?: object;
160
+ },
161
+ networkParameters?: NetworkParameters
162
+ ): true | Error;
163
+
164
+ trackGenericResultClick(
165
+ parameters: {
166
+ item_id: string;
167
+ item_name?: string;
168
+ variation_id?: string;
169
+ section?: string;
170
+ },
171
+ networkParameters?: NetworkParameters
172
+ ): true | Error;
173
+
174
+ on(messageType: string, callback: Function): true | Error;
175
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@constructor-io/constructorio-client-javascript",
3
- "version": "2.34.1",
3
+ "version": "2.34.3",
4
4
  "description": "Constructor.io JavaScript client",
5
5
  "main": "lib/constructorio.js",
6
6
  "types": "lib/types/constructorio.d.ts",
@@ -8,7 +8,7 @@
8
8
  "clean": "sudo rm -rf node_modules package-lock.json",
9
9
  "version": "chmod +x ./scripts/verify-node-version.sh && ./scripts/verify-node-version.sh && npm run docs && git add ./docs/* && npm run bundle && git add -A ./dist",
10
10
  "check-lisc": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;MIT'",
11
- "lint": "eslint 'src/**/*.js' 'spec/**/*.js'",
11
+ "lint": "eslint 'src/**/*.js' 'spec/**/*.js' 'src/**/*.d.ts'",
12
12
  "test": "npm run compile && mkdir -p test && cp -rf lib/* test && mocha ./spec/*",
13
13
  "test:types": "tsd .",
14
14
  "test:parallel": "npm run compile && mkdir -p test && cp -rf lib/* test && mocha --parallel ./spec/*",
@@ -47,6 +47,9 @@
47
47
  "@babel/preset-env": "^7.15.8",
48
48
  "@babel/register": "^7.15.3",
49
49
  "@cspell/eslint-plugin": "^6.8.2",
50
+ "@types/events": "^3.0.0",
51
+ "@typescript-eslint/eslint-plugin": "^5.48.1",
52
+ "@typescript-eslint/parser": "^5.48.1",
50
53
  "chai": "^4.2.0",
51
54
  "chai-as-promised": "^7.1.1",
52
55
  "dotenv": "^8.6.0",