@algolia/client-insights 5.0.0-alpha.72 → 5.0.0-alpha.75

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 (64) hide show
  1. package/dist/client-insights.cjs.js +20 -22
  2. package/dist/client-insights.esm.browser.js +20 -20
  3. package/dist/client-insights.esm.node.js +20 -20
  4. package/dist/client-insights.umd.js +2 -2
  5. package/dist/model/clickEvent.d.ts +2 -0
  6. package/dist/model/clickEvent.d.ts.map +1 -0
  7. package/dist/model/clickedFilters.d.ts +28 -0
  8. package/dist/model/clickedFilters.d.ts.map +1 -0
  9. package/dist/model/clickedObjectIDs.d.ts +28 -0
  10. package/dist/model/clickedObjectIDs.d.ts.map +1 -0
  11. package/dist/model/clickedObjectIDsAfterSearch.d.ts +36 -0
  12. package/dist/model/clickedObjectIDsAfterSearch.d.ts.map +1 -0
  13. package/dist/model/clientMethodProps.d.ts +10 -10
  14. package/dist/model/conversionEvent.d.ts +2 -0
  15. package/dist/model/conversionEvent.d.ts.map +1 -0
  16. package/dist/model/convertedFilters.d.ts +25 -0
  17. package/dist/model/convertedFilters.d.ts.map +1 -0
  18. package/dist/model/convertedObjectIDs.d.ts +28 -0
  19. package/dist/model/convertedObjectIDs.d.ts.map +1 -0
  20. package/dist/model/convertedObjectIDsAfterSearch.d.ts +32 -0
  21. package/dist/model/convertedObjectIDsAfterSearch.d.ts.map +1 -0
  22. package/dist/model/eventsItems.d.ts +10 -0
  23. package/dist/model/eventsItems.d.ts.map +1 -0
  24. package/dist/model/eventsResponse.d.ts +14 -0
  25. package/dist/model/eventsResponse.d.ts.map +1 -0
  26. package/dist/model/index.d.ts +14 -4
  27. package/dist/model/index.d.ts.map +1 -1
  28. package/dist/model/insightsEvents.d.ts +8 -0
  29. package/dist/model/insightsEvents.d.ts.map +1 -0
  30. package/dist/model/viewEvent.d.ts +2 -0
  31. package/dist/model/viewEvent.d.ts.map +1 -0
  32. package/dist/model/viewedFilters.d.ts +28 -0
  33. package/dist/model/viewedFilters.d.ts.map +1 -0
  34. package/dist/model/viewedObjectIDs.d.ts +28 -0
  35. package/dist/model/viewedObjectIDs.d.ts.map +1 -0
  36. package/dist/src/insightsClient.d.ts +17 -17
  37. package/dist/src/insightsClient.d.ts.map +1 -1
  38. package/model/{eventType.ts → clickEvent.ts} +1 -1
  39. package/model/clickedFilters.ts +35 -0
  40. package/model/clickedObjectIDs.ts +35 -0
  41. package/model/clickedObjectIDsAfterSearch.ts +45 -0
  42. package/model/clientMethodProps.ts +10 -10
  43. package/model/{pushEventsResponse.ts → conversionEvent.ts} +1 -6
  44. package/model/convertedFilters.ts +32 -0
  45. package/model/convertedObjectIDs.ts +35 -0
  46. package/model/convertedObjectIDsAfterSearch.ts +40 -0
  47. package/model/eventsItems.ts +20 -0
  48. package/model/eventsResponse.ts +16 -0
  49. package/model/index.ts +14 -4
  50. package/model/insightsEvents.ts +10 -0
  51. package/model/viewEvent.ts +3 -0
  52. package/model/viewedFilters.ts +35 -0
  53. package/model/viewedObjectIDs.ts +35 -0
  54. package/package.json +8 -7
  55. package/dist/model/eventType.d.ts +0 -2
  56. package/dist/model/eventType.d.ts.map +0 -1
  57. package/dist/model/insightEvent.d.ts +0 -40
  58. package/dist/model/insightEvent.d.ts.map +0 -1
  59. package/dist/model/insightEvents.d.ts +0 -11
  60. package/dist/model/insightEvents.d.ts.map +0 -1
  61. package/dist/model/pushEventsResponse.d.ts +0 -7
  62. package/dist/model/pushEventsResponse.d.ts.map +0 -1
  63. package/model/insightEvent.ts +0 -50
  64. package/model/insightEvents.ts +0 -13
@@ -1,12 +1,10 @@
1
1
  'use strict';
2
2
 
3
- Object.defineProperty(exports, '__esModule', { value: true });
4
-
5
3
  var clientCommon = require('@algolia/client-common');
6
4
  var requesterNodeHttp = require('@algolia/requester-node-http');
7
5
 
8
6
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
9
- const apiClientVersion = '5.0.0-alpha.72';
7
+ const apiClientVersion = '5.0.0-alpha.75';
10
8
  const REGIONS = ['de', 'us'];
11
9
  function getDefaultHosts(region) {
12
10
  const url = !region
@@ -70,8 +68,8 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
70
68
  *
71
69
  * @summary Send requests to the Algolia REST API.
72
70
  * @param del - The del object.
73
- * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
74
- * @param del.parameters - Query parameters to be applied to the current query.
71
+ * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
72
+ * @param del.parameters - Query parameters to apply to the current query.
75
73
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
76
74
  */
77
75
  del({ path, parameters }, requestOptions) {
@@ -94,8 +92,8 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
94
92
  *
95
93
  * @summary Send requests to the Algolia REST API.
96
94
  * @param get - The get object.
97
- * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
98
- * @param get.parameters - Query parameters to be applied to the current query.
95
+ * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
96
+ * @param get.parameters - Query parameters to apply to the current query.
99
97
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
100
98
  */
101
99
  get({ path, parameters }, requestOptions) {
@@ -118,9 +116,9 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
118
116
  *
119
117
  * @summary Send requests to the Algolia REST API.
120
118
  * @param post - The post object.
121
- * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
122
- * @param post.parameters - Query parameters to be applied to the current query.
123
- * @param post.body - The parameters to send with the custom request.
119
+ * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
120
+ * @param post.parameters - Query parameters to apply to the current query.
121
+ * @param post.body - Parameters to send with the custom request.
124
122
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
125
123
  */
126
124
  post({ path, parameters, body }, requestOptions) {
@@ -140,18 +138,18 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
140
138
  return transporter.request(request, requestOptions);
141
139
  },
142
140
  /**
143
- * This command pushes an array of events. An event is - an action: `eventName` - performed in a context: `eventType` - at some point in time provided: `timestamp` - by an end user: `userToken` - on something: `index` Notes: - To be accepted, all events sent must be valid. - The size of the body must be *less than 2 MB*. - When an event is tied to an Algolia search, it must also provide a `queryID`. If that event is a `click`, their absolute `positions` should also be passed. - We consider that an `index` provides access to 2 resources: objects and filters. An event can only interact with a single resource type, but not necessarily on a single item. As such an event will accept an array of `objectIDs` or `filters`.
141
+ * Send a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
144
142
  *
145
- * @summary Push events.
146
- * @param insightEvents - The insightEvents object.
143
+ * @summary Send events.
144
+ * @param insightsEvents - The insightsEvents object.
147
145
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
148
146
  */
149
- pushEvents(insightEvents, requestOptions) {
150
- if (!insightEvents) {
151
- throw new Error('Parameter `insightEvents` is required when calling `pushEvents`.');
147
+ pushEvents(insightsEvents, requestOptions) {
148
+ if (!insightsEvents) {
149
+ throw new Error('Parameter `insightsEvents` is required when calling `pushEvents`.');
152
150
  }
153
- if (!insightEvents.events) {
154
- throw new Error('Parameter `insightEvents.events` is required when calling `pushEvents`.');
151
+ if (!insightsEvents.events) {
152
+ throw new Error('Parameter `insightsEvents.events` is required when calling `pushEvents`.');
155
153
  }
156
154
  const requestPath = '/1/events';
157
155
  const headers = {};
@@ -161,7 +159,7 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
161
159
  path: requestPath,
162
160
  queryParameters,
163
161
  headers,
164
- data: insightEvents,
162
+ data: insightsEvents,
165
163
  };
166
164
  return transporter.request(request, requestOptions);
167
165
  },
@@ -170,9 +168,9 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
170
168
  *
171
169
  * @summary Send requests to the Algolia REST API.
172
170
  * @param put - The put object.
173
- * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
174
- * @param put.parameters - Query parameters to be applied to the current query.
175
- * @param put.body - The parameters to send with the custom request.
171
+ * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
172
+ * @param put.parameters - Query parameters to apply to the current query.
173
+ * @param put.body - Parameters to send with the custom request.
176
174
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
177
175
  */
178
176
  put({ path, parameters, body }, requestOptions) {
@@ -662,7 +662,7 @@ function createXhrRequester() {
662
662
  }
663
663
 
664
664
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
665
- const apiClientVersion = '5.0.0-alpha.72';
665
+ const apiClientVersion = '5.0.0-alpha.75';
666
666
  const REGIONS = ['de', 'us'];
667
667
  function getDefaultHosts(region) {
668
668
  const url = !region
@@ -726,8 +726,8 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
726
726
  *
727
727
  * @summary Send requests to the Algolia REST API.
728
728
  * @param del - The del object.
729
- * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
730
- * @param del.parameters - Query parameters to be applied to the current query.
729
+ * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
730
+ * @param del.parameters - Query parameters to apply to the current query.
731
731
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
732
732
  */
733
733
  del({ path, parameters }, requestOptions) {
@@ -750,8 +750,8 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
750
750
  *
751
751
  * @summary Send requests to the Algolia REST API.
752
752
  * @param get - The get object.
753
- * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
754
- * @param get.parameters - Query parameters to be applied to the current query.
753
+ * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
754
+ * @param get.parameters - Query parameters to apply to the current query.
755
755
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
756
756
  */
757
757
  get({ path, parameters }, requestOptions) {
@@ -774,9 +774,9 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
774
774
  *
775
775
  * @summary Send requests to the Algolia REST API.
776
776
  * @param post - The post object.
777
- * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
778
- * @param post.parameters - Query parameters to be applied to the current query.
779
- * @param post.body - The parameters to send with the custom request.
777
+ * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
778
+ * @param post.parameters - Query parameters to apply to the current query.
779
+ * @param post.body - Parameters to send with the custom request.
780
780
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
781
781
  */
782
782
  post({ path, parameters, body }, requestOptions) {
@@ -796,18 +796,18 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
796
796
  return transporter.request(request, requestOptions);
797
797
  },
798
798
  /**
799
- * This command pushes an array of events. An event is - an action: `eventName` - performed in a context: `eventType` - at some point in time provided: `timestamp` - by an end user: `userToken` - on something: `index` Notes: - To be accepted, all events sent must be valid. - The size of the body must be *less than 2 MB*. - When an event is tied to an Algolia search, it must also provide a `queryID`. If that event is a `click`, their absolute `positions` should also be passed. - We consider that an `index` provides access to 2 resources: objects and filters. An event can only interact with a single resource type, but not necessarily on a single item. As such an event will accept an array of `objectIDs` or `filters`.
799
+ * Send a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
800
800
  *
801
- * @summary Push events.
802
- * @param insightEvents - The insightEvents object.
801
+ * @summary Send events.
802
+ * @param insightsEvents - The insightsEvents object.
803
803
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
804
804
  */
805
- pushEvents(insightEvents, requestOptions) {
806
- if (!insightEvents) {
807
- throw new Error('Parameter `insightEvents` is required when calling `pushEvents`.');
805
+ pushEvents(insightsEvents, requestOptions) {
806
+ if (!insightsEvents) {
807
+ throw new Error('Parameter `insightsEvents` is required when calling `pushEvents`.');
808
808
  }
809
- if (!insightEvents.events) {
810
- throw new Error('Parameter `insightEvents.events` is required when calling `pushEvents`.');
809
+ if (!insightsEvents.events) {
810
+ throw new Error('Parameter `insightsEvents.events` is required when calling `pushEvents`.');
811
811
  }
812
812
  const requestPath = '/1/events';
813
813
  const headers = {};
@@ -817,7 +817,7 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
817
817
  path: requestPath,
818
818
  queryParameters,
819
819
  headers,
820
- data: insightEvents,
820
+ data: insightsEvents,
821
821
  };
822
822
  return transporter.request(request, requestOptions);
823
823
  },
@@ -826,9 +826,9 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
826
826
  *
827
827
  * @summary Send requests to the Algolia REST API.
828
828
  * @param put - The put object.
829
- * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
830
- * @param put.parameters - Query parameters to be applied to the current query.
831
- * @param put.body - The parameters to send with the custom request.
829
+ * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
830
+ * @param put.parameters - Query parameters to apply to the current query.
831
+ * @param put.body - Parameters to send with the custom request.
832
832
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
833
833
  */
834
834
  put({ path, parameters, body }, requestOptions) {
@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, DEFAULT_CONNECT_TIMEOUT
2
2
  import { createHttpRequester } from '@algolia/requester-node-http';
3
3
 
4
4
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
5
- const apiClientVersion = '5.0.0-alpha.72';
5
+ const apiClientVersion = '5.0.0-alpha.75';
6
6
  const REGIONS = ['de', 'us'];
7
7
  function getDefaultHosts(region) {
8
8
  const url = !region
@@ -66,8 +66,8 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
66
66
  *
67
67
  * @summary Send requests to the Algolia REST API.
68
68
  * @param del - The del object.
69
- * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
70
- * @param del.parameters - Query parameters to be applied to the current query.
69
+ * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
70
+ * @param del.parameters - Query parameters to apply to the current query.
71
71
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
72
72
  */
73
73
  del({ path, parameters }, requestOptions) {
@@ -90,8 +90,8 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
90
90
  *
91
91
  * @summary Send requests to the Algolia REST API.
92
92
  * @param get - The get object.
93
- * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
94
- * @param get.parameters - Query parameters to be applied to the current query.
93
+ * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
94
+ * @param get.parameters - Query parameters to apply to the current query.
95
95
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
96
96
  */
97
97
  get({ path, parameters }, requestOptions) {
@@ -114,9 +114,9 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
114
114
  *
115
115
  * @summary Send requests to the Algolia REST API.
116
116
  * @param post - The post object.
117
- * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
118
- * @param post.parameters - Query parameters to be applied to the current query.
119
- * @param post.body - The parameters to send with the custom request.
117
+ * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
118
+ * @param post.parameters - Query parameters to apply to the current query.
119
+ * @param post.body - Parameters to send with the custom request.
120
120
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
121
121
  */
122
122
  post({ path, parameters, body }, requestOptions) {
@@ -136,18 +136,18 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
136
136
  return transporter.request(request, requestOptions);
137
137
  },
138
138
  /**
139
- * This command pushes an array of events. An event is - an action: `eventName` - performed in a context: `eventType` - at some point in time provided: `timestamp` - by an end user: `userToken` - on something: `index` Notes: - To be accepted, all events sent must be valid. - The size of the body must be *less than 2 MB*. - When an event is tied to an Algolia search, it must also provide a `queryID`. If that event is a `click`, their absolute `positions` should also be passed. - We consider that an `index` provides access to 2 resources: objects and filters. An event can only interact with a single resource type, but not necessarily on a single item. As such an event will accept an array of `objectIDs` or `filters`.
139
+ * Send a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
140
140
  *
141
- * @summary Push events.
142
- * @param insightEvents - The insightEvents object.
141
+ * @summary Send events.
142
+ * @param insightsEvents - The insightsEvents object.
143
143
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
144
144
  */
145
- pushEvents(insightEvents, requestOptions) {
146
- if (!insightEvents) {
147
- throw new Error('Parameter `insightEvents` is required when calling `pushEvents`.');
145
+ pushEvents(insightsEvents, requestOptions) {
146
+ if (!insightsEvents) {
147
+ throw new Error('Parameter `insightsEvents` is required when calling `pushEvents`.');
148
148
  }
149
- if (!insightEvents.events) {
150
- throw new Error('Parameter `insightEvents.events` is required when calling `pushEvents`.');
149
+ if (!insightsEvents.events) {
150
+ throw new Error('Parameter `insightsEvents.events` is required when calling `pushEvents`.');
151
151
  }
152
152
  const requestPath = '/1/events';
153
153
  const headers = {};
@@ -157,7 +157,7 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
157
157
  path: requestPath,
158
158
  queryParameters,
159
159
  headers,
160
- data: insightEvents,
160
+ data: insightsEvents,
161
161
  };
162
162
  return transporter.request(request, requestOptions);
163
163
  },
@@ -166,9 +166,9 @@ function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMo
166
166
  *
167
167
  * @summary Send requests to the Algolia REST API.
168
168
  * @param put - The put object.
169
- * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
170
- * @param put.parameters - Query parameters to be applied to the current query.
171
- * @param put.body - The parameters to send with the custom request.
169
+ * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
170
+ * @param put.parameters - Query parameters to apply to the current query.
171
+ * @param put.body - Parameters to send with the custom request.
172
172
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
173
173
  */
174
174
  put({ path, parameters, body }, requestOptions) {
@@ -1,2 +1,2 @@
1
- /*! client-insights.umd.js | 5.0.0-alpha.72 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */
2
- !function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self)["@algolia/client-insights"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function s(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function a(){return JSON.parse(s().getItem(r)||"{}")}return{get:(e,t,r={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>{const r=JSON.stringify(e),s=a()[r];return Promise.all([s||t(),void 0!==s])})).then((([e,t])=>Promise.all([e,t||r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const n=a();return n[JSON.stringify(e)]=t,s().setItem(r,JSON.stringify(n)),t})),delete:e=>Promise.resolve().then((()=>{const t=a();delete t[JSON.stringify(e)],s().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{s().removeItem(r)}))}}function r(e){const t=[...e.caches],s=t.shift();return void 0===s?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,a,n={miss:()=>Promise.resolve()})=>s.get(e,a,n).catch((()=>r({caches:t}).get(e,a,n))),set:(e,a)=>s.set(e,a).catch((()=>r({caches:t}).set(e,a))),delete:e=>s.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>s.clear().catch((()=>r({caches:t}).clear()))}}function s(e={serializable:!0}){let t={};return{get(r,s,a={miss:()=>Promise.resolve()}){const n=JSON.stringify(r);if(n in t)return Promise.resolve(e.serializable?JSON.parse(t[n]):t[n]);const o=s();return o.then((e=>a.miss(e))).then((()=>o))},set:(r,s)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(s):s,Promise.resolve(s)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const a=12e4;function n(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>a},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=a}}}function o(e,t,r){return(t=function(e){var t=function(e,t){if("object"!=typeof e||null===e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var s=r.call(e,t||"default");if("object"!=typeof s)return s;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:String(t)}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class i extends Error{constructor(e,t){super(e),o(this,"name","AlgoliaError"),t&&(this.name=t)}}class c extends i{constructor(e,t,r){super(e,r),o(this,"stackTrace",void 0),this.stackTrace=t}}class u extends c{constructor(e){super("Unreachable hosts - your application id may be incorrect. If the error persists, contact support@algolia.com.",e,"RetryError")}}class l extends c{constructor(e,t,r,s="ApiError"){super(e,r,s),o(this,"status",void 0),this.status=t}}class h extends i{constructor(e,t){super(e,"DeserializationError"),o(this,"response",void 0),this.response=t}}class d extends l{constructor(e,t,r,s){super(e,t,s,"DetailedApiError"),o(this,"error",void 0),this.error=r}}function m(e,t,r){const s=function(e){const t=e=>"[object Object]"===Object.prototype.toString.call(e)||"[object Array]"===Object.prototype.toString.call(e);return Object.keys(e).map((r=>`${r}=${encodeURIComponent(t(e[r])?JSON.stringify(e[r]):e[r])}`)).join("&")}(r);let a=`${e.protocol}://${e.url}/${"/"===t.charAt(0)?t.substr(1):t}`;return s.length&&(a+=`?${s}`),a}function p(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function g({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:s,algoliaAgent:a,timeouts:o,requester:i,requestsCache:c,responsesCache:g}){async function f(c,g,f=!0){const y=[],v=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(c,g),P=function(e,t,r){const s={Accept:"application/json",...e,...t,...r},a={};return Object.keys(s).forEach((e=>{const t=s[e];a[e.toLowerCase()]=t})),a}(r,c.headers,g.headers),w="GET"===c.method?{...c.data,...g.data}:{},b={...s,...c.queryParameters,...w};if(a.value&&(b["x-algolia-agent"]=a.value),g&&g.queryParameters)for(const e of Object.keys(g.queryParameters))g.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(g.queryParameters[e])?b[e]=g.queryParameters[e].toString():b[e]=g.queryParameters[e];let q=0;const O=async(e,r)=>{const s=e.pop();if(void 0===s)throw new u(function(e){return e.map((e=>p(e)))}(y));let a=g.timeout;void 0===a&&(a=f?o.read:o.write);const w={data:v,headers:P,method:c.method,url:m(s,c.path,b),connectTimeout:r(q,o.connect),responseTimeout:r(q,a)},T=t=>{const r={request:w,response:t,host:s,triesLeft:e.length};return y.push(r),r},E=await i.send(w);if(function({isTimedOut:e,status:t}){return e||function({isTimedOut:e,status:t}){return!e&&0==~~t}({isTimedOut:e,status:t})||2!=~~(t/100)&&4!=~~(t/100)}(E)){const a=T(E);return E.isTimedOut&&q++,console.log("Retryable failure",p(a)),await t.set(s,n(s,E.isTimedOut?"timed out":"down")),O(e,r)}if(function({status:e}){return 2==~~(e/100)}(E))return function(e){try{return JSON.parse(e.content)}catch(t){throw new h(t.message,e)}}(E);throw T(E),function({content:e,status:t},r){try{const s=JSON.parse(e);return"error"in s?new d(s.message,t,s.error,r):new l(s.message,t,r)}catch(e){}return new l(e,t,r)}(E,y)},T=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),E=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(n(e))))))),s=r.filter((e=>e.isUp())),a=r.filter((e=>e.isTimedOut())),o=[...s,...a];return{hosts:o.length>0?o:e,getTimeout:(e,t)=>(0===a.length&&0===e?1:a.length+3+e)*t}}(T);return O([...E.hosts].reverse(),E.getTimeout)}return{hostsCache:t,requester:i,timeouts:o,algoliaAgent:a,baseHeaders:r,baseQueryParameters:s,hosts:e,request:function(e,t={}){const a=e.useReadTransporter||"GET"===e.method;if(!a)return f(e,t,a);const n=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return n();const o={request:e,requestOptions:t,transporter:{queryParameters:s,headers:r}};return g.get(o,(()=>c.get(o,(()=>c.set(o,n()).then((e=>Promise.all([c.delete(o),e])),(e=>Promise.all([c.delete(o),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>g.set(o,e)})},requestsCache:c,responsesCache:g}}function f({algoliaAgents:e,client:t,version:r}){const s=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>s.add(e))),s}const y="5.0.0-alpha.72",v=["de","us"];e.apiClientVersion=y,e.insightsClient=function(e,a,n,o){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!a||"string"!=typeof a)throw new Error("`apiKey` is missing.");if(n&&("string"!=typeof n||!v.includes(n)))throw new Error(`\`region\` must be one of the following: ${v.join(", ")}`);return function({appId:e,apiKey:t,authMode:r,algoliaAgents:s,region:a,...n}){const o=function(e,t,r="WithinHeaders"){const s={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?s:{},queryParameters:()=>"WithinQueryParameters"===r?s:{}}}(e,t,r),i=g({hosts:(c=a,[{url:c?"insights.{region}.algolia.io".replace("{region}",c):"insights.algolia.io",accept:"readWrite",protocol:"https"}]),...n,algoliaAgent:f({algoliaAgents:s,client:"Insights",version:y}),baseHeaders:{"content-type":"text/plain",...o.headers(),...n.baseHeaders},baseQueryParameters:{...o.queryParameters(),...n.baseQueryParameters}});var c;return{transporter:i,appId:e,clearCache:()=>Promise.all([i.requestsCache.clear(),i.responsesCache.clear()]).then((()=>{})),get _ua(){return i.algoliaAgent.value},addAlgoliaAgent(e,t){i.algoliaAgent.add({segment:e,version:t})},del({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `del`.");const s={method:"DELETE",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},get({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `get`.");const s={method:"GET",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},post({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `post`.");const a={method:"POST",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},pushEvents(e,t){if(!e)throw new Error("Parameter `insightEvents` is required when calling `pushEvents`.");if(!e.events)throw new Error("Parameter `insightEvents.events` is required when calling `pushEvents`.");const r={method:"POST",path:"/1/events",queryParameters:{},headers:{},data:e};return i.request(r,t)},put({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `put`.");const a={method:"PUT",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)}}}({appId:e,apiKey:a,region:n,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const s=(e,s)=>setTimeout((()=>{r.abort(),t({status:0,content:s,isTimedOut:!0})}),e),a=s(e.connectTimeout,"Connection timeout");let n;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===n&&(clearTimeout(a),n=s(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(a),clearTimeout(n),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(a),clearTimeout(n),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:s(),requestsCache:s({serializable:!1}),hostsCache:r({caches:[t({key:`${y}-${e}`}),s()]}),...o})}}));
1
+ /*! client-insights.umd.js | 5.0.0-alpha.75 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */
2
+ !function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self)["@algolia/client-insights"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function s(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function a(){return JSON.parse(s().getItem(r)||"{}")}return{get:(e,t,r={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>{const r=JSON.stringify(e),s=a()[r];return Promise.all([s||t(),void 0!==s])})).then((([e,t])=>Promise.all([e,t||r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const n=a();return n[JSON.stringify(e)]=t,s().setItem(r,JSON.stringify(n)),t})),delete:e=>Promise.resolve().then((()=>{const t=a();delete t[JSON.stringify(e)],s().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{s().removeItem(r)}))}}function r(e){const t=[...e.caches],s=t.shift();return void 0===s?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,a,n={miss:()=>Promise.resolve()})=>s.get(e,a,n).catch((()=>r({caches:t}).get(e,a,n))),set:(e,a)=>s.set(e,a).catch((()=>r({caches:t}).set(e,a))),delete:e=>s.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>s.clear().catch((()=>r({caches:t}).clear()))}}function s(e={serializable:!0}){let t={};return{get(r,s,a={miss:()=>Promise.resolve()}){const n=JSON.stringify(r);if(n in t)return Promise.resolve(e.serializable?JSON.parse(t[n]):t[n]);const o=s();return o.then((e=>a.miss(e))).then((()=>o))},set:(r,s)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(s):s,Promise.resolve(s)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const a=12e4;function n(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>a},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=a}}}function o(e,t,r){return(t=function(e){var t=function(e,t){if("object"!=typeof e||null===e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var s=r.call(e,t||"default");if("object"!=typeof s)return s;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:String(t)}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class i extends Error{constructor(e,t){super(e),o(this,"name","AlgoliaError"),t&&(this.name=t)}}class c extends i{constructor(e,t,r){super(e,r),o(this,"stackTrace",void 0),this.stackTrace=t}}class u extends c{constructor(e){super("Unreachable hosts - your application id may be incorrect. If the error persists, contact support@algolia.com.",e,"RetryError")}}class l extends c{constructor(e,t,r,s="ApiError"){super(e,r,s),o(this,"status",void 0),this.status=t}}class h extends i{constructor(e,t){super(e,"DeserializationError"),o(this,"response",void 0),this.response=t}}class d extends l{constructor(e,t,r,s){super(e,t,s,"DetailedApiError"),o(this,"error",void 0),this.error=r}}function m(e,t,r){const s=function(e){const t=e=>"[object Object]"===Object.prototype.toString.call(e)||"[object Array]"===Object.prototype.toString.call(e);return Object.keys(e).map((r=>`${r}=${encodeURIComponent(t(e[r])?JSON.stringify(e[r]):e[r])}`)).join("&")}(r);let a=`${e.protocol}://${e.url}/${"/"===t.charAt(0)?t.substr(1):t}`;return s.length&&(a+=`?${s}`),a}function p(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function g({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:s,algoliaAgent:a,timeouts:o,requester:i,requestsCache:c,responsesCache:g}){async function f(c,g,f=!0){const y=[],v=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(c,g),P=function(e,t,r){const s={Accept:"application/json",...e,...t,...r},a={};return Object.keys(s).forEach((e=>{const t=s[e];a[e.toLowerCase()]=t})),a}(r,c.headers,g.headers),w="GET"===c.method?{...c.data,...g.data}:{},b={...s,...c.queryParameters,...w};if(a.value&&(b["x-algolia-agent"]=a.value),g&&g.queryParameters)for(const e of Object.keys(g.queryParameters))g.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(g.queryParameters[e])?b[e]=g.queryParameters[e].toString():b[e]=g.queryParameters[e];let q=0;const O=async(e,r)=>{const s=e.pop();if(void 0===s)throw new u(function(e){return e.map((e=>p(e)))}(y));let a=g.timeout;void 0===a&&(a=f?o.read:o.write);const w={data:v,headers:P,method:c.method,url:m(s,c.path,b),connectTimeout:r(q,o.connect),responseTimeout:r(q,a)},T=t=>{const r={request:w,response:t,host:s,triesLeft:e.length};return y.push(r),r},E=await i.send(w);if(function({isTimedOut:e,status:t}){return e||function({isTimedOut:e,status:t}){return!e&&0==~~t}({isTimedOut:e,status:t})||2!=~~(t/100)&&4!=~~(t/100)}(E)){const a=T(E);return E.isTimedOut&&q++,console.log("Retryable failure",p(a)),await t.set(s,n(s,E.isTimedOut?"timed out":"down")),O(e,r)}if(function({status:e}){return 2==~~(e/100)}(E))return function(e){try{return JSON.parse(e.content)}catch(t){throw new h(t.message,e)}}(E);throw T(E),function({content:e,status:t},r){try{const s=JSON.parse(e);return"error"in s?new d(s.message,t,s.error,r):new l(s.message,t,r)}catch(e){}return new l(e,t,r)}(E,y)},T=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),E=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(n(e))))))),s=r.filter((e=>e.isUp())),a=r.filter((e=>e.isTimedOut())),o=[...s,...a];return{hosts:o.length>0?o:e,getTimeout:(e,t)=>(0===a.length&&0===e?1:a.length+3+e)*t}}(T);return O([...E.hosts].reverse(),E.getTimeout)}return{hostsCache:t,requester:i,timeouts:o,algoliaAgent:a,baseHeaders:r,baseQueryParameters:s,hosts:e,request:function(e,t={}){const a=e.useReadTransporter||"GET"===e.method;if(!a)return f(e,t,a);const n=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return n();const o={request:e,requestOptions:t,transporter:{queryParameters:s,headers:r}};return g.get(o,(()=>c.get(o,(()=>c.set(o,n()).then((e=>Promise.all([c.delete(o),e])),(e=>Promise.all([c.delete(o),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>g.set(o,e)})},requestsCache:c,responsesCache:g}}function f({algoliaAgents:e,client:t,version:r}){const s=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>s.add(e))),s}const y="5.0.0-alpha.75",v=["de","us"];e.apiClientVersion=y,e.insightsClient=function(e,a,n,o){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!a||"string"!=typeof a)throw new Error("`apiKey` is missing.");if(n&&("string"!=typeof n||!v.includes(n)))throw new Error(`\`region\` must be one of the following: ${v.join(", ")}`);return function({appId:e,apiKey:t,authMode:r,algoliaAgents:s,region:a,...n}){const o=function(e,t,r="WithinHeaders"){const s={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?s:{},queryParameters:()=>"WithinQueryParameters"===r?s:{}}}(e,t,r),i=g({hosts:(c=a,[{url:c?"insights.{region}.algolia.io".replace("{region}",c):"insights.algolia.io",accept:"readWrite",protocol:"https"}]),...n,algoliaAgent:f({algoliaAgents:s,client:"Insights",version:y}),baseHeaders:{"content-type":"text/plain",...o.headers(),...n.baseHeaders},baseQueryParameters:{...o.queryParameters(),...n.baseQueryParameters}});var c;return{transporter:i,appId:e,clearCache:()=>Promise.all([i.requestsCache.clear(),i.responsesCache.clear()]).then((()=>{})),get _ua(){return i.algoliaAgent.value},addAlgoliaAgent(e,t){i.algoliaAgent.add({segment:e,version:t})},del({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `del`.");const s={method:"DELETE",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},get({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `get`.");const s={method:"GET",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},post({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `post`.");const a={method:"POST",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},pushEvents(e,t){if(!e)throw new Error("Parameter `insightsEvents` is required when calling `pushEvents`.");if(!e.events)throw new Error("Parameter `insightsEvents.events` is required when calling `pushEvents`.");const r={method:"POST",path:"/1/events",queryParameters:{},headers:{},data:e};return i.request(r,t)},put({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `put`.");const a={method:"PUT",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)}}}({appId:e,apiKey:a,region:n,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const s=(e,s)=>setTimeout((()=>{r.abort(),t({status:0,content:s,isTimedOut:!0})}),e),a=s(e.connectTimeout,"Connection timeout");let n;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===n&&(clearTimeout(a),n=s(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(a),clearTimeout(n),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(a),clearTimeout(n),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:s(),requestsCache:s({serializable:!1}),hostsCache:r({caches:[t({key:`${y}-${e}`}),s()]}),...o})}}));
@@ -0,0 +1,2 @@
1
+ export type ClickEvent = 'click';
2
+ //# sourceMappingURL=clickEvent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"clickEvent.d.ts","sourceRoot":"","sources":["../../model/clickEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC"}
@@ -0,0 +1,28 @@
1
+ import type { ClickEvent } from './clickEvent';
2
+ /**
3
+ * Use this event to track when users click facet filters in your user interface.
4
+ */
5
+ export type ClickedFilters = {
6
+ /**
7
+ * Can contain up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
8
+ */
9
+ eventName: string;
10
+ eventType: ClickEvent;
11
+ /**
12
+ * Name of the Algolia index.
13
+ */
14
+ index: string;
15
+ /**
16
+ * Facet filters. Each facet filter string must be URL-encoded, such as, `discount:10%25`.
17
+ */
18
+ filters: string[];
19
+ /**
20
+ * Anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable information in user tokens.
21
+ */
22
+ userToken: string;
23
+ /**
24
+ * Time of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
25
+ */
26
+ timestamp?: number;
27
+ };
28
+ //# sourceMappingURL=clickedFilters.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"clickedFilters.d.ts","sourceRoot":"","sources":["../../model/clickedFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,UAAU,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}
@@ -0,0 +1,28 @@
1
+ import type { ClickEvent } from './clickEvent';
2
+ /**
3
+ * Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don\'t use Algolia to build your category pages, use this event. To track click events related to Algolia requests, use the \"Clicked object IDs after search\" event.
4
+ */
5
+ export type ClickedObjectIDs = {
6
+ /**
7
+ * Can contain up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
8
+ */
9
+ eventName: string;
10
+ eventType: ClickEvent;
11
+ /**
12
+ * Name of the Algolia index.
13
+ */
14
+ index: string;
15
+ /**
16
+ * List of object identifiers for items of an Algolia index.
17
+ */
18
+ objectIDs: string[];
19
+ /**
20
+ * Anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable information in user tokens.
21
+ */
22
+ userToken: string;
23
+ /**
24
+ * Time of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
25
+ */
26
+ timestamp?: number;
27
+ };
28
+ //# sourceMappingURL=clickedObjectIDs.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"clickedObjectIDs.d.ts","sourceRoot":"","sources":["../../model/clickedObjectIDs.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,UAAU,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}
@@ -0,0 +1,36 @@
1
+ import type { ClickEvent } from './clickEvent';
2
+ /**
3
+ * Click event after an Algolia request. Use this event to track when users click items in the search results. If you\'re building your category pages with Algolia, you\'ll also use this event.
4
+ */
5
+ export type ClickedObjectIDsAfterSearch = {
6
+ /**
7
+ * Can contain up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
8
+ */
9
+ eventName: string;
10
+ eventType: ClickEvent;
11
+ /**
12
+ * Name of the Algolia index.
13
+ */
14
+ index: string;
15
+ /**
16
+ * List of object identifiers for items of an Algolia index.
17
+ */
18
+ objectIDs: string[];
19
+ /**
20
+ * Position of the clicked objects in the search results. The first search result has a position of 1 (not 0). You must provide 1 `position` for each `objectID`.
21
+ */
22
+ positions: number[];
23
+ /**
24
+ * Unique identifier for a search query. The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response.
25
+ */
26
+ queryID: string;
27
+ /**
28
+ * Anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable information in user tokens.
29
+ */
30
+ userToken: string;
31
+ /**
32
+ * Time of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
33
+ */
34
+ timestamp?: number;
35
+ };
36
+ //# sourceMappingURL=clickedObjectIDsAfterSearch.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"clickedObjectIDsAfterSearch.d.ts","sourceRoot":"","sources":["../../model/clickedObjectIDsAfterSearch.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,UAAU,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}
@@ -3,11 +3,11 @@
3
3
  */
4
4
  export type DelProps = {
5
5
  /**
6
- * The path of the API endpoint to target, anything after the /1 needs to be specified.
6
+ * Path of the endpoint, anything after \"/1\" must be specified.
7
7
  */
8
8
  path: string;
9
9
  /**
10
- * Query parameters to be applied to the current query.
10
+ * Query parameters to apply to the current query.
11
11
  */
12
12
  parameters?: Record<string, any>;
13
13
  };
@@ -16,11 +16,11 @@ export type DelProps = {
16
16
  */
17
17
  export type GetProps = {
18
18
  /**
19
- * The path of the API endpoint to target, anything after the /1 needs to be specified.
19
+ * Path of the endpoint, anything after \"/1\" must be specified.
20
20
  */
21
21
  path: string;
22
22
  /**
23
- * Query parameters to be applied to the current query.
23
+ * Query parameters to apply to the current query.
24
24
  */
25
25
  parameters?: Record<string, any>;
26
26
  };
@@ -29,15 +29,15 @@ export type GetProps = {
29
29
  */
30
30
  export type PostProps = {
31
31
  /**
32
- * The path of the API endpoint to target, anything after the /1 needs to be specified.
32
+ * Path of the endpoint, anything after \"/1\" must be specified.
33
33
  */
34
34
  path: string;
35
35
  /**
36
- * Query parameters to be applied to the current query.
36
+ * Query parameters to apply to the current query.
37
37
  */
38
38
  parameters?: Record<string, any>;
39
39
  /**
40
- * The parameters to send with the custom request.
40
+ * Parameters to send with the custom request.
41
41
  */
42
42
  body?: Record<string, any>;
43
43
  };
@@ -46,15 +46,15 @@ export type PostProps = {
46
46
  */
47
47
  export type PutProps = {
48
48
  /**
49
- * The path of the API endpoint to target, anything after the /1 needs to be specified.
49
+ * Path of the endpoint, anything after \"/1\" must be specified.
50
50
  */
51
51
  path: string;
52
52
  /**
53
- * Query parameters to be applied to the current query.
53
+ * Query parameters to apply to the current query.
54
54
  */
55
55
  parameters?: Record<string, any>;
56
56
  /**
57
- * The parameters to send with the custom request.
57
+ * Parameters to send with the custom request.
58
58
  */
59
59
  body?: Record<string, any>;
60
60
  };
@@ -0,0 +1,2 @@
1
+ export type ConversionEvent = 'conversion';
2
+ //# sourceMappingURL=conversionEvent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"conversionEvent.d.ts","sourceRoot":"","sources":["../../model/conversionEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG,YAAY,CAAC"}
@@ -0,0 +1,25 @@
1
+ import type { ConversionEvent } from './conversionEvent';
2
+ export type ConvertedFilters = {
3
+ /**
4
+ * Can contain up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
5
+ */
6
+ eventName: string;
7
+ eventType: ConversionEvent;
8
+ /**
9
+ * Name of the Algolia index.
10
+ */
11
+ index: string;
12
+ /**
13
+ * Facet filters. Each facet filter string must be URL-encoded, such as, `discount:10%25`.
14
+ */
15
+ filters: string[];
16
+ /**
17
+ * Anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable information in user tokens.
18
+ */
19
+ userToken: string;
20
+ /**
21
+ * Time of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
22
+ */
23
+ timestamp?: number;
24
+ };
25
+ //# sourceMappingURL=convertedFilters.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"convertedFilters.d.ts","sourceRoot":"","sources":["../../model/convertedFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}
@@ -0,0 +1,28 @@
1
+ import type { ConversionEvent } from './conversionEvent';
2
+ /**
3
+ * Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you don\'t use Algolia to build your category pages, use this event. To track conversion events related to Algolia requests, use the \"Converted object IDs after search\" event.
4
+ */
5
+ export type ConvertedObjectIDs = {
6
+ /**
7
+ * Can contain up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
8
+ */
9
+ eventName: string;
10
+ eventType: ConversionEvent;
11
+ /**
12
+ * Name of the Algolia index.
13
+ */
14
+ index: string;
15
+ /**
16
+ * List of object identifiers for items of an Algolia index.
17
+ */
18
+ objectIDs: string[];
19
+ /**
20
+ * Anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable information in user tokens.
21
+ */
22
+ userToken: string;
23
+ /**
24
+ * Time of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
25
+ */
26
+ timestamp?: number;
27
+ };
28
+ //# sourceMappingURL=convertedObjectIDs.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"convertedObjectIDs.d.ts","sourceRoot":"","sources":["../../model/convertedObjectIDs.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}