coveo.analytics 2.19.3 → 2.19.6

package/dist/definitions/caseAssist/caseAssistClient.d.ts

@@ -1,13 +1,17 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { CaseCancelledMetadata, CaseCreatedMetadata, CaseSolvedMetadata, EnterInterfaceMetadata, MoveToNextCaseStepMetadata, RateDocumentSuggestionMetadata, SelectDocumentSuggestionMetadata, SelectFieldSuggestionMetadata, UpdateCaseFieldMetadata } from './caseAssistActions';
+export interface CaseAssistClientProvider {
+    getOriginLevel1: () => string;
+}
 export interface CaseAssistClientOptions extends ClientOptions {
     enableAnalytics?: boolean;
 }
 export declare class CaseAssistClient {
     private options;
+    private provider?;
     coveoAnalyticsClient: AnalyticsClient;
     private svc;
-    constructor(options: Partial<CaseAssistClientOptions>);
+    constructor(options: Partial<CaseAssistClientOptions>, provider?: CaseAssistClientProvider | undefined);
     disable(): void;
     enable(): void;
     logEnterInterface(meta: EnterInterfaceMetadata): Promise<void | import("../events").SearchEventResponse | import("../events").ClickEventResponse | import("../events").CustomEventResponse | import("../events").ViewEventResponse>;

package/dist/definitions/client/measurementProtocolMapping/commerceMeasurementProtocolMapper.d.ts

@@ -1,8 +1,8 @@
-import { ImpressionList } from '../../plugins/ec';
+import { Product, ImpressionList } from '../../plugins/ec';
 export declare const commerceActionKeysMappingPerAction: Record<string, {
     [name: string]: string;
 }>;
-export declare const convertProductToMeasurementProtocol: (product: (Pick<import("../../plugins/ec").ProductProperties, "brand" | "category" | "variant" | "price" | "quantity" | "coupon" | "position" | "custom" | "group"> & Required<Pick<import("../../plugins/ec").ProductProperties, "id">> & Partial<Pick<import("../../plugins/ec").ProductProperties, "name">>) | (Pick<import("../../plugins/ec").ProductProperties, "brand" | "category" | "variant" | "price" | "quantity" | "coupon" | "position" | "custom" | "group"> & Required<Pick<import("../../plugins/ec").ProductProperties, "name">> & Partial<Pick<import("../../plugins/ec").ProductProperties, "id">>), index: number) => {};
+export declare const convertProductToMeasurementProtocol: (product: Product, index: number) => {};
 export declare const convertImpressionListToMeasurementProtocol: (impressionList: ImpressionList, listIndex: number, prefix: string) => {
     [name: string]: any;
 };

package/dist/definitions/client/measurementProtocolMapping/serviceMeasurementProtocolMapper.d.ts

@@ -1,5 +1,6 @@
+import { Ticket } from '../../plugins/svc';
 export declare const serviceActionsKeysMapping: {
     [name: string]: string;
 };
-export declare const convertTicketToMeasurementProtocol: (ticket: import("../../plugins/svc").TicketProperties) => {};
+export declare const convertTicketToMeasurementProtocol: (ticket: Ticket) => {};
 export declare const isServiceKey: ((key: string) => boolean)[];

package/dist/definitions/coveoua/headless.d.ts

@@ -1,5 +1,5 @@
 export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
-export { CaseAssistClient } from '../caseAssist/caseAssistClient';
+export { CaseAssistClient, CaseAssistClientProvider } from '../caseAssist/caseAssistClient';
 export { CoveoAnalyticsClient, AnalyticsClientSendEventHook } from '../client/analytics';
 export { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
 export * as history from '../history';

package/dist/definitions/coveoua/library.d.ts

@@ -8,5 +8,5 @@ export { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
 export { IRuntimeEnvironment } from '../client/runtimeEnvironment';
 export { CoveoUA, getCurrentClient, handleOneAnalyticsEvent } from './simpleanalytics';
 export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
-export { CaseAssistClient } from '../caseAssist/caseAssistClient';
+export { CaseAssistClient, CaseAssistClientProvider } from '../caseAssist/caseAssistClient';
 export { analytics, donottrack, history, SimpleAnalytics, storage };

package/dist/definitions/searchPage/searchPageClient.d.ts

@@ -78,6 +78,7 @@ export declare class CoveoSearchPageClient {
     logSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): Promise<void | import("../events").CustomEventResponse>;
     logExpandSmartSnippetSuggestion(documentId: SmartSnippetSuggestionMeta): Promise<void | import("../events").CustomEventResponse>;
     logCollapseSmartSnippetSuggestion(documentId: SmartSnippetSuggestionMeta): Promise<void | import("../events").CustomEventResponse>;
+    logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | import("../events").ClickEventResponse>;
     logRecentQueryClick(): Promise<void | import("../events").SearchEventResponse>;
     logClearRecentQueries(): Promise<void | import("../events").CustomEventResponse>;
     logRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | import("../events").CustomEventResponse>;

package/dist/definitions/searchPage/searchPageEvents.d.ts

@@ -53,6 +53,7 @@ export declare enum SearchPageEvents {
     sendSmartSnippetReason = "sendSmartSnippetReason",
     expandSmartSnippetSuggestion = "expandSmartSnippetSuggestion",
     collapseSmartSnippetSuggestion = "collapseSmartSnippetSuggestion",
+    openSmartSnippetSource = "openSmartSnippetSource",
     recentQueryClick = "recentQueriesClick",
     clearRecentQueries = "clearRecentQueries",
     recentResultClick = "recentResultClick",

package/dist/definitions/src/coveoua/headless.d.ts

@@ -1,5 +1,5 @@
 export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
-export { CaseAssistClient } from '../caseAssist/caseAssistClient';
+export { CaseAssistClient, CaseAssistClientProvider } from '../caseAssist/caseAssistClient';
 export { CoveoAnalyticsClient, AnalyticsClientSendEventHook } from '../client/analytics';
 export { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
 export * as history from '../history';

package/dist/definitions/src/coveoua/library.d.ts

@@ -8,5 +8,5 @@ export { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
 export { IRuntimeEnvironment } from '../client/runtimeEnvironment';
 export { CoveoUA, getCurrentClient, handleOneAnalyticsEvent } from './simpleanalytics';
 export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
-export { CaseAssistClient } from '../caseAssist/caseAssistClient';
+export { CaseAssistClient, CaseAssistClientProvider } from '../caseAssist/caseAssistClient';
 export { analytics, donottrack, history, SimpleAnalytics, storage };

package/dist/library.es.js

@@ -1,16 +1,16 @@
 /*! *****************************************************************************
-Copyright (c) Microsoft Corporation. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
+Copyright (c) Microsoft Corporation.
 
-THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
-WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
-MERCHANTABLITY OR NON-INFRINGEMENT.
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
 
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+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.
 ***************************************************************************** */
 
 function __rest(s, e) {
@@ -1111,6 +1111,7 @@ var SearchPageEvents;
     SearchPageEvents["sendSmartSnippetReason"] = "sendSmartSnippetReason";
     SearchPageEvents["expandSmartSnippetSuggestion"] = "expandSmartSnippetSuggestion";
     SearchPageEvents["collapseSmartSnippetSuggestion"] = "collapseSmartSnippetSuggestion";
+    SearchPageEvents["openSmartSnippetSource"] = "openSmartSnippetSource";
     SearchPageEvents["recentQueryClick"] = "recentQueriesClick";
     SearchPageEvents["clearRecentQueries"] = "clearRecentQueries";
     SearchPageEvents["recentResultClick"] = "recentResultClick";
@@ -1411,6 +1412,9 @@ class CoveoSearchPageClient {
     logCollapseSmartSnippetSuggestion(documentId) {
         return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, { documentId });
     }
+    logOpenSmartSnippetSource(info, identifier) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);
+    }
     logRecentQueryClick() {
         return this.logSearchEvent(SearchPageEvents.recentQueryClick);
     }
@@ -1650,9 +1654,10 @@ var CaseCancelledReasons;
 })(CaseCancelledReasons || (CaseCancelledReasons = {}));
 
 class CaseAssistClient {
-    constructor(options) {
+    constructor(options, provider) {
         var _a;
         this.options = options;
+        this.provider = provider;
         const analyticsEnabled = (_a = options.enableAnalytics) !== null && _a !== void 0 ? _a : true;
         this.coveoAnalyticsClient = analyticsEnabled ? new CoveoAnalyticsClient(options) : new NoopAnalytics();
         this.svc = new SVCPlugin({ client: this.coveoAnalyticsClient });
@@ -1720,10 +1725,18 @@ class CaseAssistClient {
         return this.sendClickEvent();
     }
     sendFlowStartEvent() {
-        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.flowStart);
+        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.flowStart, this.provider
+            ? {
+                searchHub: this.provider.getOriginLevel1(),
+            }
+            : null);
     }
     sendClickEvent() {
-        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.click);
+        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.click, this.provider
+            ? {
+                searchHub: this.provider.getOriginLevel1(),
+            }
+            : null);
     }
 }