coveo.analytics 2.30.45 → 2.30.46

package/README.md

@@ -43,37 +43,37 @@ After the library has loaded sucessfully, you can interact with coveoua through
 
 ### Initialization
 
--   `coveoua('version')`: Returns the current version of the tracking library.
--   `coveoua('init', <COVEO_API_KEY>, <ENDPOINT>)`: Initializes the library with the given api key and endpoint. The following parameters are accepted
-    -   COVEO_API_KEY (mandatory): A valid api key.
-    -   ENDPOINT (optional): A string specifying the desired analytics endpoint. The default value is https://analytics.cloud.coveo.com/rest/ua. In case your organization is HIPAA enabled, you should override with https://analyticshipaa.cloud.coveo.com/rest/ua.
--   `coveoua('init', <COVEO_API_KEY>, {endpoint: <ENDPOINT>, isCustomEndpoint: <IS_CUSTOM_ENDPOINT>, plugins: <PLUGINS>})`: Initializes the library with the given api key, endpoint, isCustomEndpoint option and plugins. The following parameters are accepted
-    -   COVEO_API_KEY (mandatory): A valid api key.
-    -   ENDPOINT (optional): An object string specifying the desired analytics endpoint. The default value is https://analytics.cloud.coveo.com/rest/ua. In case your organization is HIPAA enabled, you should override with https://analyticshipaa.cloud.coveo.com/rest/ua.
-    -   IS_CUSTOM_ENDPOINT (optional): An boolean specifying if the desired analytics endpoint is custom. This means the library will not try to add any prefix logic like /rest/ua at the end of the provided endpoint. This can be useful when implementing analytics through a reverse-proxy solution like cloudfront.
-    -   PLUGINS (optional): An array of known plugin names. See [plugins](#plugins) for more information.
--   `coveoua('set', <NAME>, <VALUE>)`: Attempts to inject an attribute with given name and value on every logged event, overriding any existing value. Some payloads may reject attributes they do not support.
--   `coveoua('set', <OBJECT>)`: Attempts to inject all attributes and values of the given object on every logged event, overriding any existing value. Some payloads may reject attributes they do not support.
--   `coveoua('set', 'custom', <OBJECT>)`: Attempts to inject all attributes and values of the given object in the custom section of an object, overriding any existing value. Use this call to pass customer specific parameters on the payload.
--   `coveoua('onLoad', <CALLBACK>)`: Calls the specified function immediately, library initialization is not required.
--   `coveoua('reset')`: Resets the state of the logger to the state before initialization.
+- `coveoua('version')`: Returns the current version of the tracking library.
+- `coveoua('init', <COVEO_API_KEY>, <ENDPOINT>)`: Initializes the library with the given api key and endpoint. The following parameters are accepted
+    - COVEO_API_KEY (mandatory): A valid api key.
+    - ENDPOINT (optional): A string specifying the desired analytics endpoint. The default value is https://analytics.cloud.coveo.com/rest/ua. In case your organization is HIPAA enabled, you should override with https://analyticshipaa.cloud.coveo.com/rest/ua.
+- `coveoua('init', <COVEO_API_KEY>, {endpoint: <ENDPOINT>, isCustomEndpoint: <IS_CUSTOM_ENDPOINT>, plugins: <PLUGINS>})`: Initializes the library with the given api key, endpoint, isCustomEndpoint option and plugins. The following parameters are accepted
+    - COVEO_API_KEY (mandatory): A valid api key.
+    - ENDPOINT (optional): An object string specifying the desired analytics endpoint. The default value is https://analytics.cloud.coveo.com/rest/ua. In case your organization is HIPAA enabled, you should override with https://analyticshipaa.cloud.coveo.com/rest/ua.
+    - IS_CUSTOM_ENDPOINT (optional): An boolean specifying if the desired analytics endpoint is custom. This means the library will not try to add any prefix logic like /rest/ua at the end of the provided endpoint. This can be useful when implementing analytics through a reverse-proxy solution like cloudfront.
+    - PLUGINS (optional): An array of known plugin names. See [plugins](#plugins) for more information.
+- `coveoua('set', <NAME>, <VALUE>)`: Attempts to inject an attribute with given name and value on every logged event, overriding any existing value. Some payloads may reject attributes they do not support.
+- `coveoua('set', <OBJECT>)`: Attempts to inject all attributes and values of the given object on every logged event, overriding any existing value. Some payloads may reject attributes they do not support.
+- `coveoua('set', 'custom', <OBJECT>)`: Attempts to inject all attributes and values of the given object in the custom section of an object, overriding any existing value. Use this call to pass customer specific parameters on the payload.
+- `coveoua('onLoad', <CALLBACK>)`: Calls the specified function immediately, library initialization is not required.
+- `coveoua('reset')`: Resets the state of the logger to the state before initialization.
 
 ### Sending events
 
--   `coveoua('send', <EVENT_NAME>, <EVENT_PAYLOAD>)`: Sends an event with a given name and payload to the analytics endpoint.
+- `coveoua('send', <EVENT_NAME>, <EVENT_PAYLOAD>)`: Sends an event with a given name and payload to the analytics endpoint.
 
 ### Plugin control
 
--   `coveoua('provide', <PLUGIN_NAME>, <PLUGINCLASS>)`: Registers a given pluginClass with the analytics library under the provided name.
--   `coveoua('require', <PLUGIN_NAME>)`: Explicitly loads the plugin with the given name.
--   `coveoua('callPlugin', <PLUGIN_NAME>, <FUNCTION>, <PARAMS>)`: Executes the specified function with given arguments on the given plugin name. Can be shorthanded using a plugin action prefix `coveoua(<PLUGINNAME>:<FUNCTION>, <PARAMS>)`.
+- `coveoua('provide', <PLUGIN_NAME>, <PLUGINCLASS>)`: Registers a given pluginClass with the analytics library under the provided name.
+- `coveoua('require', <PLUGIN_NAME>)`: Explicitly loads the plugin with the given name.
+- `coveoua('callPlugin', <PLUGIN_NAME>, <FUNCTION>, <PARAMS>)`: Executes the specified function with given arguments on the given plugin name. Can be shorthanded using a plugin action prefix `coveoua(<PLUGINNAME>:<FUNCTION>, <PARAMS>)`.
 
 ## Plugins
 
 Coveoua is set up in a modular way with different plugins providing functionality that may be specific to a given usecase. This allows you to customize some of its behavior dynamically. By default, the following plugins are loaded at library initialization:
 
--   `ec`: eCommerce plugin which takes care of sending eCommerce specific events.
--   `svc`: Service plugin which takes care of sending customer service specific events.
+- `ec`: eCommerce plugin which takes care of sending eCommerce specific events.
+- `svc`: Service plugin which takes care of sending customer service specific events.
 
 Plugin actions extend the set of available actions. They can be executed either via the `callPlugin` action above, or via the shorthand. For example, to call the function `addImpression` on the `ec` plugin, you'd specify `coveoua('ec:addImpression', ...)`.
 
@@ -85,11 +85,11 @@ In most common integration usecases, you will be using Coveo pre-wired component
 
 When you are not using any specific Coveo web component, you need to send these events payloads explicitly, use the `send` action to transmit an assembled payload to the usage analytics backend. See the [Usage Analytics Events](https://docs.coveo.com/en/2949/analyze-usage-data/usage-analytics-events) documentation for description of the payload contents. The following event types are supported in coveoua:
 
--   `search`: sends a [client side search](https://docs.coveo.com/en/1502/build-a-search-ui/log-search-events) event.
--   `click`: sends a [click event](https://docs.coveo.com/en/2064/build-a-search-ui/log-click-events).
--   `view`: sends a [view event](https://docs.coveo.com/en/2651/build-a-search-ui/log-view-events).
--   `custom`: sends a [custom event](https://docs.coveo.com/en/2650/build-a-search-ui/log-custom-events).
--   `collect`: sends a [collect event](https://docs.coveo.com/en/l41i0031/build-a-search-ui/log-collect-events) payload. We strongly recommend you use the simplified api in the ecommerce plugin [to send these events instead](#sending-commerce-specific-events).
+- `search`: sends a [client side search](https://docs.coveo.com/en/1502/build-a-search-ui/log-search-events) event.
+- `click`: sends a [click event](https://docs.coveo.com/en/2064/build-a-search-ui/log-click-events).
+- `view`: sends a [view event](https://docs.coveo.com/en/2651/build-a-search-ui/log-view-events).
+- `custom`: sends a [custom event](https://docs.coveo.com/en/2650/build-a-search-ui/log-custom-events).
+- `collect`: sends a [collect event](https://docs.coveo.com/en/l41i0031/build-a-search-ui/log-collect-events) payload. We strongly recommend you use the simplified api in the ecommerce plugin [to send these events instead](#sending-commerce-specific-events).
 
 For example, in order to send a click event after a user has interacted with a Coveo provided result, first initialize the library with an api key and then send a click event with the appropriate payload. Refer to the [click event documentation](https://docs.coveo.com/en/2064/build-a-search-ui/log-click-events) for up to date information on event payloads.
 
@@ -103,14 +103,14 @@ You should be able to observe the click event being transmitted to the Coveo bac
 
 Commerce specific events such as product selections, shopping cart modifications and transactions are sent to Coveo in the compact [collect protocol](https://docs.coveo.com/en/l41i0031/build-a-search-ui/log-collect-events). Rather than explicitly assembling these payloads by hand, the eCommerce plugin provides APIs to assemble and transmit the payloads. The `event` is specific to the eCommerce plugin:
 
--   `event`: An event, which has been assembled through different plugin actions.
+- `event`: An event, which has been assembled through different plugin actions.
 
 The eCommerce plugin supports adding product data (`ec:addProduct`) as well as setting the [appropriate event action](https://docs.coveo.com/en/l29e0540/coveo-for-commerce/commerce-events-reference#product-action-type-reference) through `ec:setAction`. These calls can be used in series to assemble different types of payloads:
 
--   A [product detail view](https://docs.coveo.com/en/l2pd0522)
--   [Cart modification events](https://docs.coveo.com/en/n39h1594/)
--   A [cart purchase](https://docs.coveo.com/en/l39m0327/coveo-for-commerce/measure-a-purchase)
--   An [event on a search-driven listing-page](https://docs.coveo.com/en/l41a1037/coveo-for-commerce/measure-events-on-a-listing-or-search-page)
+- A [product detail view](https://docs.coveo.com/en/l2pd0522)
+- [Cart modification events](https://docs.coveo.com/en/n39h1594/)
+- A [cart purchase](https://docs.coveo.com/en/l39m0327/coveo-for-commerce/measure-a-purchase)
+- An [event on a search-driven listing-page](https://docs.coveo.com/en/l41a1037/coveo-for-commerce/measure-events-on-a-listing-or-search-page)
 
 As a sample, here is how a [cart modification event](https://docs.coveo.com/en/l3jg0266/coveo-for-commerce/measure-cart-page-events#measure-an-increase-in-item-quantity-in-cart) is assembled:
 
@@ -131,11 +131,11 @@ As a sample, here is how a [cart modification event](https://docs.coveo.com/en/l
 
 To help track a visitor across different domains, the library offers functionality to initialize a clientId from a URL query parameter. The query parameter is named `cvo_cid` with value `<clientid>.<timestamp>`. The clientId is encoded without dashes and the timestamp is encoded in seconds since epoch, both to save space in the url. Both are separated by a period. A sample parameter could be `cvo_cid=c0b48880743e484f8044d7c37910c55b.1676298678`. This query parameter will be picked up by the target page if the following conditions hold:
 
--   The target page has a equal or greater version of coveo.analytics.js loaded.
--   The current URL contains a `cvo_cid` query parameter
--   The parameter contains a valid uuid.
--   The parameter contains a valid timestamp, and that timestamp is no more than 120 seconds in the past.
--   The receiving page has specified a list of valid referrers and the current referrer host matches that list, using wildcards, including ports, specified using `coveoua('link:acceptFrom', [<referrers>])`.
+- The target page has a equal or greater version of coveo.analytics.js loaded.
+- The current URL contains a `cvo_cid` query parameter
+- The parameter contains a valid uuid.
+- The parameter contains a valid timestamp, and that timestamp is no more than 120 seconds in the past.
+- The receiving page has specified a list of valid referrers and the current referrer host matches that list, using wildcards, including ports, specified using `coveoua('link:acceptFrom', [<referrers>])`.
 
 Given that you want to ensure the clientId remains consistent when you navigate from a source page on http://foo.com/index.html to a target page http://bar.com/index.html, the following steps are needed.
 
@@ -185,9 +185,9 @@ To test out your changes, add `coveoua` function calls in the `public/index.html
 
 Coveo.analytics.js tracks interactions from the same browser client, through a client side provided uuid called a `clientId`. This clientId is initialized on first use and there are multiple options for persisting it's value:
 
--   Cookie storage, which supports top level domain storage. This means that the clientId for a.foo.com will be identical to the one on b.foo.com.
--   Local storage, which allows to store much more information client side, but has the drawback of not being able to access data across multiple top level domains.
--   Session storage, which has roughly the same limitation and capability as Local storage, except that it is cleared when the web browser tab is closed.
+- Cookie storage, which supports top level domain storage. This means that the clientId for a.foo.com will be identical to the one on b.foo.com.
+- Local storage, which allows to store much more information client side, but has the drawback of not being able to access data across multiple top level domains.
+- Session storage, which has roughly the same limitation and capability as Local storage, except that it is cleared when the web browser tab is closed.
 
 By default, coveoua will use both local storage and cookie storage to persist its clientId. If your environment does not support local persistence, it's possible to write your own storage abstraction.
 
@@ -195,9 +195,9 @@ By default, coveoua will use both local storage and cookie storage to persist it
 
 Since React Native does not run inside a browser, it cannot use cookies or the local/session storage that modern browsers provide. You must provide your own Storage implementation. Thankfully, there exist multiple packages to store data:
 
--   [React native community AsyncStorage](https://github.com/react-native-async-storage/async-storage) (recommended)
--   [React native AsyncStorage](https://reactnative.dev/docs/asyncstorage) (deprecated)
--   [Expo Secure Store](https://docs.expo.dev/versions/latest/sdk/securestore/)
+- [React native community AsyncStorage](https://github.com/react-native-async-storage/async-storage) (recommended)
+- [React native AsyncStorage](https://reactnative.dev/docs/asyncstorage) (deprecated)
+- [Expo Secure Store](https://docs.expo.dev/versions/latest/sdk/securestore/)
 
 A sample React native storage class implementation could look as follows
 

package/dist/browser.mjs

@@ -12,7 +12,7 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
-/* global Reflect, Promise */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
 
 
 function __rest(s, e) {
@@ -35,7 +35,12 @@ function __awaiter(thisArg, _arguments, P, generator) {
         function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
-}
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
 
 var EventType;
 (function (EventType) {
@@ -372,7 +377,7 @@ for (let i = 0; i < 256; ++i) {
 function unsafeStringify(arr, offset = 0) {
   // Note: Be careful editing this code!  It's been tuned for performance
   // and works in ways you may not expect. See https://github.com/uuidjs/uuid/pull/434
-  return (byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + '-' + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + '-' + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + '-' + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + '-' + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]]).toLowerCase();
+  return byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + '-' + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + '-' + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + '-' + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + '-' + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]];
 }
 
 function parse(uuid) {
@@ -598,7 +603,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.30.45" ;
+const libVersion = "2.30.46";
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1537,8 +1542,8 @@ class CoveoAnalyticsClient {
         });
     }
     sendSearchEvent(_a) {
-        var { searchQueryUid } = _a, preparedRequest = __rest(_a, ["searchQueryUid"]);
         return __awaiter(this, void 0, void 0, function* () {
+            var { searchQueryUid } = _a, preparedRequest = __rest(_a, ["searchQueryUid"]);
             return (yield this.makeSearchEvent(preparedRequest)).log({ searchQueryUid });
         });
     }
@@ -1548,8 +1553,8 @@ class CoveoAnalyticsClient {
         });
     }
     sendClickEvent(_a) {
-        var { searchQueryUid } = _a, preparedRequest = __rest(_a, ["searchQueryUid"]);
         return __awaiter(this, void 0, void 0, function* () {
+            var { searchQueryUid } = _a, preparedRequest = __rest(_a, ["searchQueryUid"]);
             return (yield this.makeClickEvent(preparedRequest)).log({ searchQueryUid });
         });
     }
@@ -1559,8 +1564,8 @@ class CoveoAnalyticsClient {
         });
     }
     sendCustomEvent(_a) {
-        var { lastSearchQueryUid } = _a, preparedRequest = __rest(_a, ["lastSearchQueryUid"]);
         return __awaiter(this, void 0, void 0, function* () {
+            var { lastSearchQueryUid } = _a, preparedRequest = __rest(_a, ["lastSearchQueryUid"]);
             return (yield this.makeCustomEvent(preparedRequest)).log({ lastSearchQueryUid });
         });
     }
@@ -1834,7 +1839,6 @@ const CustomEventsTypes = {
     [SearchPageEvents.triggerExecute]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerQuery]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerRedirect]: 'queryPipelineTriggers',
-    [SearchPageEvents.queryError]: 'errors',
     [SearchPageEvents.queryErrorBack]: 'errors',
     [SearchPageEvents.queryErrorClear]: 'errors',
     [SearchPageEvents.queryErrorRetry]: 'errors',
@@ -2582,8 +2586,8 @@ class CoveoSearchPageClient {
         var _a;
         return { actionCause, customData: (_a = preparedEvent.payload) === null || _a === void 0 ? void 0 : _a.customData };
     }
-    makeCustomEvent(event, metadata, eventType = CustomEventsTypes[event]) {
-        return __awaiter(this, void 0, void 0, function* () {
+    makeCustomEvent(event_1, metadata_1) {
+        return __awaiter(this, arguments, void 0, function* (event, metadata, eventType = CustomEventsTypes[event]) {
             this.coveoAnalyticsClient.getParameters;
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
             const request = Object.assign(Object.assign({}, (yield this.getBaseEventRequest(customData))), { eventType, eventValue: event });
@@ -2594,8 +2598,8 @@ class CoveoSearchPageClient {
             };
         });
     }
-    logCustomEvent(event, metadata, eventType = CustomEventsTypes[event]) {
-        return __awaiter(this, void 0, void 0, function* () {
+    logCustomEvent(event_1, metadata_1) {
+        return __awaiter(this, arguments, void 0, function* (event, metadata, eventType = CustomEventsTypes[event]) {
             return (yield this.makeCustomEvent(event, metadata, eventType)).log({ searchUID: this.provider.getSearchUID() });
         });
     }
@@ -2651,8 +2655,8 @@ class CoveoSearchPageClient {
         });
     }
     getBaseSearchEventRequest(event, metadata) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             return Object.assign(Object.assign(Object.assign({}, (yield this.getBaseEventRequest(Object.assign(Object.assign({}, metadata), (_b = (_a = this.provider).getGeneratedAnswerMetadata) === null || _b === void 0 ? void 0 : _b.call(_a))))), this.provider.getSearchEventRequestPayload()), { queryPipeline: this.provider.getPipeline(), actionCause: event });
         });
     }
@@ -3004,8 +3008,8 @@ class CaseAssistClient {
             : null);
     }
     getBaseEventRequest(metadata) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             const customData = Object.assign({}, metadata);
             return Object.assign(Object.assign({}, this.getOrigins()), { customData, language: (_a = this.provider) === null || _a === void 0 ? void 0 : _a.getLanguage(), anonymous: (_b = this.provider) === null || _b === void 0 ? void 0 : _b.getIsAnonymous(), clientId: yield this.getClientId() });
         });
@@ -3025,8 +3029,8 @@ class CaseAssistClient {
         };
     }
     logClickEvent(event, info, identifier, metadata) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             const payload = Object.assign(Object.assign(Object.assign({}, info), (yield this.getBaseEventRequest(Object.assign(Object.assign({}, identifier), metadata)))), { searchQueryUid: (_b = (_a = this.provider) === null || _a === void 0 ? void 0 : _a.getSearchUID()) !== null && _b !== void 0 ? _b : '', actionCause: event });
             return this.coveoAnalyticsClient.sendClickEvent(payload);
         });
@@ -3072,6 +3076,20 @@ class CoveoInsightClient {
         }
         return this.logSearchEvent(SearchPageEvents.interfaceLoad);
     }
+    logRecentQueryClick(metadata) {
+        if (metadata) {
+            const metadataToSend = generateMetadataToSend(metadata);
+            return this.logSearchEvent(SearchPageEvents.recentQueryClick, metadataToSend);
+        }
+        return this.logSearchEvent(SearchPageEvents.recentQueryClick);
+    }
+    logClearRecentQueries(metadata) {
+        if (metadata) {
+            const metadataToSend = generateMetadataToSend(metadata);
+            return this.logCustomEvent(SearchPageEvents.clearRecentQueries, metadataToSend);
+        }
+        return this.logCustomEvent(SearchPageEvents.clearRecentQueries);
+    }
     logInterfaceChange(metadata) {
         const metadataToSend = generateMetadataToSend(metadata);
         return this.logSearchEvent(SearchPageEvents.interfaceChange, metadataToSend);
@@ -3365,8 +3383,8 @@ class CoveoInsightClient {
         });
     }
     getBaseSearchEventRequest(event, metadata) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             return Object.assign(Object.assign(Object.assign({}, (yield this.getBaseEventRequest(Object.assign(Object.assign({}, metadata), (_b = (_a = this.provider).getGeneratedAnswerMetadata) === null || _b === void 0 ? void 0 : _b.call(_a))))), this.provider.getSearchEventRequestPayload()), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event });
         });
     }