coveo.analytics 2.18.52 → 2.18.53

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

@@ -0,0 +1,72 @@
+import { TicketProperties } from '../plugins/svc';
+export declare enum CaseAssistEvents {
+    click = "click",
+    flowStart = "flowStart"
+}
+export declare enum CaseAssistActions {
+    enterInterface = "ticket_create_start",
+    fieldUpdate = "ticket_field_update",
+    fieldSuggestionClick = "ticket_classification_click",
+    suggestionClick = "suggestion_click",
+    suggestionRate = "suggestion_rate",
+    nextCaseStep = "ticket_next_stage",
+    caseCancelled = "ticket_cancel",
+    caseSolved = "ticket_cancel",
+    caseCreated = "ticket_create"
+}
+export declare enum CaseCancelledReasons {
+    quit = "Quit",
+    solved = "Solved"
+}
+export interface EnterInterfaceMetadata {
+    ticket: TicketProperties;
+}
+export interface UpdateCaseFieldMetadata {
+    fieldName: string;
+    ticket: TicketProperties;
+}
+export interface SelectFieldSuggestionMetadata {
+    suggestion: FieldSuggestion;
+    ticket: TicketProperties;
+}
+export interface SelectDocumentSuggestionMetadata {
+    suggestion: DocumentSuggestion;
+    ticket: TicketProperties;
+}
+export interface RateDocumentSuggestionMetadata {
+    rating: number;
+    suggestion: DocumentSuggestion;
+    ticket: TicketProperties;
+}
+export interface MoveToNextCaseStepMetadata {
+    ticket: TicketProperties;
+}
+export interface CaseCancelledMetadata {
+    ticket: TicketProperties;
+}
+export interface CaseSolvedMetadata {
+    ticket: TicketProperties;
+}
+export interface CaseCreatedMetadata {
+    ticket: TicketProperties;
+}
+export interface FieldSuggestion {
+    classificationId: string;
+    responseId: string;
+    fieldName: string;
+    classification: {
+        value: string;
+        confidence: number;
+    };
+}
+export interface DocumentSuggestion {
+    suggestionId: string;
+    responseId: string;
+    suggestion: {
+        documentUri: string;
+        documentUriHash: string;
+        documentTitle: string;
+        documentUrl: string;
+        documentPosition: number;
+    };
+}

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

@@ -0,0 +1,24 @@
+import { AnalyticsClient, ClientOptions } from '../client/analytics';
+import { CaseCancelledMetadata, CaseCreatedMetadata, CaseSolvedMetadata, EnterInterfaceMetadata, MoveToNextCaseStepMetadata, RateDocumentSuggestionMetadata, SelectDocumentSuggestionMetadata, SelectFieldSuggestionMetadata, UpdateCaseFieldMetadata } from './caseAssistActions';
+export interface CaseAssistClientOptions extends ClientOptions {
+    enableAnalytics?: boolean;
+}
+export declare class CaseAssistClient {
+    private options;
+    coveoAnalyticsClient: AnalyticsClient;
+    private svc;
+    constructor(options: Partial<CaseAssistClientOptions>);
+    disable(): void;
+    enable(): void;
+    logEnterInterface(meta: EnterInterfaceMetadata): Promise<void | import("../events").SearchEventResponse | import("../events").ClickEventResponse | import("../events").CustomEventResponse | import("../events").ViewEventResponse>;
+    logUpdateCaseField(meta: UpdateCaseFieldMetadata): Promise<void | import("../events").SearchEventResponse | import("../events").ClickEventResponse | import("../events").CustomEventResponse | import("../events").ViewEventResponse>;
+    logSelectFieldSuggestion(meta: SelectFieldSuggestionMetadata): Promise<void | import("../events").SearchEventResponse | import("../events").ClickEventResponse | import("../events").CustomEventResponse | import("../events").ViewEventResponse>;
+    logSelectDocumentSuggestion(meta: SelectDocumentSuggestionMetadata): Promise<void | import("../events").SearchEventResponse | import("../events").ClickEventResponse | import("../events").CustomEventResponse | import("../events").ViewEventResponse>;
+    logRateDocumentSuggestion(meta: RateDocumentSuggestionMetadata): Promise<void | import("../events").SearchEventResponse | import("../events").ClickEventResponse | import("../events").CustomEventResponse | import("../events").ViewEventResponse>;
+    logMoveToNextCaseStep(meta: MoveToNextCaseStepMetadata): Promise<void | import("../events").SearchEventResponse | import("../events").ClickEventResponse | import("../events").CustomEventResponse | import("../events").ViewEventResponse>;
+    logCaseCancelled(meta: CaseCancelledMetadata): Promise<void | import("../events").SearchEventResponse | import("../events").ClickEventResponse | import("../events").CustomEventResponse | import("../events").ViewEventResponse>;
+    logCaseSolved(meta: CaseSolvedMetadata): Promise<void | import("../events").SearchEventResponse | import("../events").ClickEventResponse | import("../events").CustomEventResponse | import("../events").ViewEventResponse>;
+    logCaseCreated(meta: CaseCreatedMetadata): Promise<void | import("../events").SearchEventResponse | import("../events").ClickEventResponse | import("../events").CustomEventResponse | import("../events").ViewEventResponse>;
+    private sendFlowStartEvent;
+    private sendClickEvent;
+}

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

@@ -1,4 +1,5 @@
 export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
+export { CaseAssistClient } 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,4 +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 { analytics, donottrack, history, SimpleAnalytics, storage };

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

@@ -1,4 +1,5 @@
 export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
+export { CaseAssistClient } 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,4 +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 { analytics, donottrack, history, SimpleAnalytics, storage };

package/dist/library.es.js

@@ -365,6 +365,14 @@ const serviceActionsKeysMapping = {
     svcAction: 'svc_action',
     svcActionData: 'svc_action_data',
 };
+const convertTicketToMeasurementProtocol = (ticket) => {
+    return keysOf(ticket)
+        .filter((key) => ticket[key] !== undefined)
+        .reduce((mappedTicket, key) => {
+        const newKey = ticketKeysMapping[key] || key;
+        return Object.assign(Object.assign({}, mappedTicket), { [newKey]: ticket[key] });
+    }, {});
+};
 const isTicketKey = (key) => ticketKeyRegex.test(key);
 const isServiceKey = [isTicketKey];
 
@@ -1450,4 +1458,247 @@ class CoveoSearchPageClient {
     }
 }
 
-export { CoveoAnalyticsClient, CoveoSearchPageClient, history };
+const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
+
+const BasePluginEventTypes = {
+    pageview: 'pageview',
+    event: 'event',
+};
+class BasePlugin {
+    constructor({ client, uuidGenerator = uuidv4 }) {
+        this.actionData = {};
+        this.client = client;
+        this.uuidGenerator = uuidGenerator;
+        this.pageViewId = uuidGenerator();
+        this.nextPageViewId = this.pageViewId;
+        this.currentLocation = getFormattedLocation(window.location);
+        this.lastReferrer = document.referrer;
+        this.addHooks();
+    }
+    setAction(action, options) {
+        this.action = action;
+        this.actionData = options;
+    }
+    clearData() {
+        this.clearPluginData();
+        this.action = undefined;
+        this.actionData = {};
+    }
+    getLocationInformation(eventType, payload) {
+        return Object.assign({ hitType: eventType }, this.getNextValues(eventType, payload));
+    }
+    updateLocationInformation(eventType, payload) {
+        this.updateLocationForNextPageView(eventType, payload);
+    }
+    getDefaultContextInformation(eventType) {
+        const documentContext = {
+            title: document.title,
+            encoding: document.characterSet,
+        };
+        const screenContext = {
+            screenResolution: `${screen.width}x${screen.height}`,
+            screenColor: `${screen.colorDepth}-bit`,
+        };
+        const navigatorContext = {
+            language: navigator.language,
+            userAgent: navigator.userAgent,
+        };
+        const eventContext = {
+            time: Date.now().toString(),
+            eventId: this.uuidGenerator(),
+        };
+        return Object.assign(Object.assign(Object.assign(Object.assign({}, eventContext), screenContext), navigatorContext), documentContext);
+    }
+    updateLocationForNextPageView(eventType, payload) {
+        const { pageViewId, referrer, location } = this.getNextValues(eventType, payload);
+        this.lastReferrer = referrer;
+        this.pageViewId = pageViewId;
+        this.currentLocation = location;
+        if (eventType === BasePluginEventTypes.pageview) {
+            this.nextPageViewId = this.uuidGenerator();
+            this.hasSentFirstPageView = true;
+        }
+    }
+    getNextValues(eventType, payload) {
+        return {
+            pageViewId: eventType === BasePluginEventTypes.pageview ? this.nextPageViewId : this.pageViewId,
+            referrer: eventType === BasePluginEventTypes.pageview && this.hasSentFirstPageView
+                ? this.currentLocation
+                : this.lastReferrer,
+            location: eventType === BasePluginEventTypes.pageview
+                ? this.getCurrentLocationFromPayload(payload)
+                : this.currentLocation,
+        };
+    }
+    getCurrentLocationFromPayload(payload) {
+        if (!!payload.page) {
+            const removeStartingSlash = (page) => page.replace(/^\/?(.*)$/, '/$1');
+            const extractHostnamePart = (location) => location.split('/').slice(0, 3).join('/');
+            return `${extractHostnamePart(this.currentLocation)}${removeStartingSlash(payload.page)}`;
+        }
+        else {
+            return getFormattedLocation(window.location);
+        }
+    }
+}
+
+const SVCPluginEventTypes = Object.assign({}, BasePluginEventTypes);
+const allSVCEventTypes = Object.keys(SVCPluginEventTypes).map((key) => SVCPluginEventTypes[key]);
+class SVCPlugin extends BasePlugin {
+    constructor({ client, uuidGenerator = uuidv4 }) {
+        super({ client, uuidGenerator });
+        this.ticket = {};
+    }
+    addHooks() {
+        this.addHooksForEvent();
+        this.addHooksForPageView();
+        this.addHooksForSVCEvents();
+    }
+    setTicket(ticket) {
+        this.ticket = ticket;
+    }
+    clearPluginData() {
+        this.ticket = {};
+    }
+    addHooksForSVCEvents() {
+        this.client.registerBeforeSendEventHook((eventType, ...[payload]) => {
+            return allSVCEventTypes.indexOf(eventType) !== -1 ? this.addSVCDataToPayload(eventType, payload) : payload;
+        });
+        this.client.registerAfterSendEventHook((eventType, ...[payload]) => {
+            if (allSVCEventTypes.indexOf(eventType) !== -1) {
+                this.updateLocationInformation(eventType, payload);
+            }
+            return payload;
+        });
+    }
+    addHooksForPageView() {
+        this.client.addEventTypeMapping(SVCPluginEventTypes.pageview, {
+            newEventType: EventType.collect,
+            variableLengthArgumentsNames: ['page'],
+            addVisitorIdParameter: true,
+            usesMeasurementProtocol: true,
+        });
+    }
+    addHooksForEvent() {
+        this.client.addEventTypeMapping(SVCPluginEventTypes.event, {
+            newEventType: EventType.collect,
+            variableLengthArgumentsNames: ['eventCategory', 'eventAction', 'eventLabel', 'eventValue'],
+            addVisitorIdParameter: true,
+            usesMeasurementProtocol: true,
+        });
+    }
+    addSVCDataToPayload(eventType, payload) {
+        var _a;
+        const svcPayload = Object.assign(Object.assign(Object.assign(Object.assign({}, this.getLocationInformation(eventType, payload)), this.getDefaultContextInformation(eventType)), (this.action ? { svcAction: this.action } : {})), (Object.keys((_a = this.actionData) !== null && _a !== void 0 ? _a : {}).length > 0 ? { svcActionData: this.actionData } : {}));
+        const ticketPayload = this.getTicketPayload();
+        this.clearData();
+        return Object.assign(Object.assign(Object.assign({}, ticketPayload), svcPayload), payload);
+    }
+    getTicketPayload() {
+        return convertTicketToMeasurementProtocol(this.ticket);
+    }
+}
+SVCPlugin.Id = 'svc';
+
+var CaseAssistEvents;
+(function (CaseAssistEvents) {
+    CaseAssistEvents["click"] = "click";
+    CaseAssistEvents["flowStart"] = "flowStart";
+})(CaseAssistEvents || (CaseAssistEvents = {}));
+var CaseAssistActions;
+(function (CaseAssistActions) {
+    CaseAssistActions["enterInterface"] = "ticket_create_start";
+    CaseAssistActions["fieldUpdate"] = "ticket_field_update";
+    CaseAssistActions["fieldSuggestionClick"] = "ticket_classification_click";
+    CaseAssistActions["suggestionClick"] = "suggestion_click";
+    CaseAssistActions["suggestionRate"] = "suggestion_rate";
+    CaseAssistActions["nextCaseStep"] = "ticket_next_stage";
+    CaseAssistActions["caseCancelled"] = "ticket_cancel";
+    CaseAssistActions["caseSolved"] = "ticket_cancel";
+    CaseAssistActions["caseCreated"] = "ticket_create";
+})(CaseAssistActions || (CaseAssistActions = {}));
+var CaseCancelledReasons;
+(function (CaseCancelledReasons) {
+    CaseCancelledReasons["quit"] = "Quit";
+    CaseCancelledReasons["solved"] = "Solved";
+})(CaseCancelledReasons || (CaseCancelledReasons = {}));
+
+class CaseAssistClient {
+    constructor(options) {
+        var _a;
+        this.options = options;
+        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 });
+    }
+    disable() {
+        if (this.coveoAnalyticsClient instanceof CoveoAnalyticsClient) {
+            this.coveoAnalyticsClient.clear();
+        }
+        this.coveoAnalyticsClient = new NoopAnalytics();
+        this.svc = new SVCPlugin({ client: this.coveoAnalyticsClient });
+    }
+    enable() {
+        this.coveoAnalyticsClient = new CoveoAnalyticsClient(this.options);
+        this.svc = new SVCPlugin({ client: this.coveoAnalyticsClient });
+    }
+    logEnterInterface(meta) {
+        this.svc.setAction(CaseAssistActions.enterInterface);
+        this.svc.setTicket(meta.ticket);
+        return this.sendFlowStartEvent();
+    }
+    logUpdateCaseField(meta) {
+        this.svc.setAction(CaseAssistActions.fieldUpdate, {
+            fieldName: meta.fieldName,
+        });
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    }
+    logSelectFieldSuggestion(meta) {
+        this.svc.setAction(CaseAssistActions.fieldSuggestionClick, meta.suggestion);
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    }
+    logSelectDocumentSuggestion(meta) {
+        this.svc.setAction(CaseAssistActions.suggestionClick, meta.suggestion);
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    }
+    logRateDocumentSuggestion(meta) {
+        this.svc.setAction(CaseAssistActions.suggestionRate, Object.assign({ rate: meta.rating }, meta.suggestion));
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    }
+    logMoveToNextCaseStep(meta) {
+        this.svc.setAction(CaseAssistActions.nextCaseStep);
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    }
+    logCaseCancelled(meta) {
+        this.svc.setAction(CaseAssistActions.caseCancelled, {
+            reason: CaseCancelledReasons.quit,
+        });
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    }
+    logCaseSolved(meta) {
+        this.svc.setAction(CaseAssistActions.caseSolved, {
+            reason: CaseCancelledReasons.solved,
+        });
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    }
+    logCaseCreated(meta) {
+        this.svc.setAction(CaseAssistActions.caseCreated);
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    }
+    sendFlowStartEvent() {
+        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.flowStart);
+    }
+    sendClickEvent() {
+        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.click);
+    }
+}
+
+export { CaseAssistClient, CoveoAnalyticsClient, CoveoSearchPageClient, history };

package/dist/library.js

@@ -4277,6 +4277,109 @@ var CoveoSearchPageClient = (function () {
     return CoveoSearchPageClient;
 }());
 
+var CaseAssistEvents;
+(function (CaseAssistEvents) {
+    CaseAssistEvents["click"] = "click";
+    CaseAssistEvents["flowStart"] = "flowStart";
+})(CaseAssistEvents || (CaseAssistEvents = {}));
+var CaseAssistActions;
+(function (CaseAssistActions) {
+    CaseAssistActions["enterInterface"] = "ticket_create_start";
+    CaseAssistActions["fieldUpdate"] = "ticket_field_update";
+    CaseAssistActions["fieldSuggestionClick"] = "ticket_classification_click";
+    CaseAssistActions["suggestionClick"] = "suggestion_click";
+    CaseAssistActions["suggestionRate"] = "suggestion_rate";
+    CaseAssistActions["nextCaseStep"] = "ticket_next_stage";
+    CaseAssistActions["caseCancelled"] = "ticket_cancel";
+    CaseAssistActions["caseSolved"] = "ticket_cancel";
+    CaseAssistActions["caseCreated"] = "ticket_create";
+})(CaseAssistActions || (CaseAssistActions = {}));
+var CaseCancelledReasons;
+(function (CaseCancelledReasons) {
+    CaseCancelledReasons["quit"] = "Quit";
+    CaseCancelledReasons["solved"] = "Solved";
+})(CaseCancelledReasons || (CaseCancelledReasons = {}));
+
+var CaseAssistClient = (function () {
+    function CaseAssistClient(options) {
+        var _a;
+        this.options = options;
+        var 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 });
+    }
+    CaseAssistClient.prototype.disable = function () {
+        if (this.coveoAnalyticsClient instanceof CoveoAnalyticsClient) {
+            this.coveoAnalyticsClient.clear();
+        }
+        this.coveoAnalyticsClient = new NoopAnalytics();
+        this.svc = new SVCPlugin({ client: this.coveoAnalyticsClient });
+    };
+    CaseAssistClient.prototype.enable = function () {
+        this.coveoAnalyticsClient = new CoveoAnalyticsClient(this.options);
+        this.svc = new SVCPlugin({ client: this.coveoAnalyticsClient });
+    };
+    CaseAssistClient.prototype.logEnterInterface = function (meta) {
+        this.svc.setAction(CaseAssistActions.enterInterface);
+        this.svc.setTicket(meta.ticket);
+        return this.sendFlowStartEvent();
+    };
+    CaseAssistClient.prototype.logUpdateCaseField = function (meta) {
+        this.svc.setAction(CaseAssistActions.fieldUpdate, {
+            fieldName: meta.fieldName,
+        });
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    };
+    CaseAssistClient.prototype.logSelectFieldSuggestion = function (meta) {
+        this.svc.setAction(CaseAssistActions.fieldSuggestionClick, meta.suggestion);
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    };
+    CaseAssistClient.prototype.logSelectDocumentSuggestion = function (meta) {
+        this.svc.setAction(CaseAssistActions.suggestionClick, meta.suggestion);
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    };
+    CaseAssistClient.prototype.logRateDocumentSuggestion = function (meta) {
+        this.svc.setAction(CaseAssistActions.suggestionRate, tslib.exports.__assign({ rate: meta.rating }, meta.suggestion));
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    };
+    CaseAssistClient.prototype.logMoveToNextCaseStep = function (meta) {
+        this.svc.setAction(CaseAssistActions.nextCaseStep);
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    };
+    CaseAssistClient.prototype.logCaseCancelled = function (meta) {
+        this.svc.setAction(CaseAssistActions.caseCancelled, {
+            reason: CaseCancelledReasons.quit,
+        });
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    };
+    CaseAssistClient.prototype.logCaseSolved = function (meta) {
+        this.svc.setAction(CaseAssistActions.caseSolved, {
+            reason: CaseCancelledReasons.solved,
+        });
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    };
+    CaseAssistClient.prototype.logCaseCreated = function (meta) {
+        this.svc.setAction(CaseAssistActions.caseCreated);
+        this.svc.setTicket(meta.ticket);
+        return this.sendClickEvent();
+    };
+    CaseAssistClient.prototype.sendFlowStartEvent = function () {
+        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.flowStart);
+    };
+    CaseAssistClient.prototype.sendClickEvent = function () {
+        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.click);
+    };
+    return CaseAssistClient;
+}());
+
+exports.CaseAssistClient = CaseAssistClient;
 exports.CoveoAnalyticsClient = CoveoAnalyticsClient;
 exports.CoveoSearchPageClient = CoveoSearchPageClient;
 exports.CoveoUA = CoveoUA;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.18.52",
+    "version": "2.18.53",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

package/src/caseAssist/caseAssistActions.ts

@@ -0,0 +1,86 @@
+import {TicketProperties} from '../plugins/svc';
+
+export enum CaseAssistEvents {
+    click = 'click',
+    flowStart = 'flowStart',
+}
+
+export enum CaseAssistActions {
+    enterInterface = 'ticket_create_start',
+    fieldUpdate = 'ticket_field_update',
+    fieldSuggestionClick = 'ticket_classification_click',
+    suggestionClick = 'suggestion_click',
+    suggestionRate = 'suggestion_rate',
+    nextCaseStep = 'ticket_next_stage',
+    caseCancelled = 'ticket_cancel',
+    caseSolved = 'ticket_cancel',
+    caseCreated = 'ticket_create',
+}
+
+export enum CaseCancelledReasons {
+    quit = 'Quit',
+    solved = 'Solved',
+}
+
+export interface EnterInterfaceMetadata {
+    ticket: TicketProperties;
+}
+
+export interface UpdateCaseFieldMetadata {
+    fieldName: string;
+    ticket: TicketProperties;
+}
+
+export interface SelectFieldSuggestionMetadata {
+    suggestion: FieldSuggestion;
+    ticket: TicketProperties;
+}
+
+export interface SelectDocumentSuggestionMetadata {
+    suggestion: DocumentSuggestion;
+    ticket: TicketProperties;
+}
+
+export interface RateDocumentSuggestionMetadata {
+    rating: number;
+    suggestion: DocumentSuggestion;
+    ticket: TicketProperties;
+}
+
+export interface MoveToNextCaseStepMetadata {
+    ticket: TicketProperties;
+}
+
+export interface CaseCancelledMetadata {
+    ticket: TicketProperties;
+}
+
+export interface CaseSolvedMetadata {
+    ticket: TicketProperties;
+}
+
+export interface CaseCreatedMetadata {
+    ticket: TicketProperties;
+}
+
+export interface FieldSuggestion {
+    classificationId: string;
+    responseId: string;
+    fieldName: string;
+    classification: {
+        value: string;
+        confidence: number;
+    };
+}
+
+export interface DocumentSuggestion {
+    suggestionId: string;
+    responseId: string;
+    suggestion: {
+        documentUri: string;
+        documentUriHash: string;
+        documentTitle: string;
+        documentUrl: string;
+        documentPosition: number;
+    };
+}