@fluid-topics/ft-search-context 1.2.37 → 1.2.39

package/build/store/FtAnalyticsSearchEventManager.d.ts

@@ -1,7 +1,7 @@
 import { FtSearchPageState } from "./model";
 import { FtReduxStore, ReduxWatcher } from "@fluid-topics/ft-wc-utils";
 import { FtSearchPageStateReducers } from "./redux";
-import { FtAnalyticsEventPublication, FtSearchResultCluster } from "@fluid-topics/public-api";
+import { FtAnalyticsEventPublication, FtSearchResultCluster, FtSearchResultClusterEntry } from "@fluid-topics/public-api";
 import { FtAnalyticsEventsService } from "@fluid-topics/ft-app-context";
 export declare class FtAnalyticsSearchEventManager {
     readonly store: FtReduxStore<FtSearchPageState, FtSearchPageStateReducers>;
@@ -10,8 +10,8 @@ export declare class FtAnalyticsSearchEventManager {
     ignoreEmptyQuery: boolean;
     openExternalDocumentInNewTab: boolean;
     enableAnalyticsEvents: boolean;
-    appName: string;
-    appVersion: string;
+    appName: string | undefined;
+    appVersion: string | undefined;
     publication: FtAnalyticsEventPublication | undefined;
     protected readonly resultsWatcher: ReduxWatcher<FtSearchPageState, FtSearchResultCluster[] | undefined>;
     constructor(store: FtReduxStore<FtSearchPageState, FtSearchPageStateReducers>, eventService?: FtAnalyticsEventsService);
@@ -19,7 +19,11 @@ export declare class FtAnalyticsSearchEventManager {
     setAppName(appName: string): void;
     setAppVersion(appVersion: string): void;
     setDocumentSearch(publication: FtAnalyticsEventPublication): void;
+    private canSendEvent;
     private sendEvent;
     private sendKhubSearchEvent;
     private sendDocumentSearchEvent;
+    sendResultClickedEvent(result: FtSearchResultClusterEntry, rank: number): void;
+    private convertDocument;
+    private convertExternalLink;
 }

package/build/store/FtAnalyticsSearchEventManager.js

@@ -1,4 +1,5 @@
 import { watch } from "@fluid-topics/ft-wc-utils";
+import { FtAnalyticsEventName, FtAnalyticsPublicationType, FtSearchResultType } from "@fluid-topics/public-api";
 import { FtAnalyticsEventsService, ftAppInfoStore } from "@fluid-topics/ft-app-context";
 import { convertMetadataFilterToAnalyticsFacet, getAnalyticsLastUpdate } from "./utils/analytics-utils";
 export class FtAnalyticsSearchEventManager {
@@ -7,22 +8,19 @@ export class FtAnalyticsSearchEventManager {
         this.ignoreEmptyQuery = false;
         this.openExternalDocumentInNewTab = false;
         this.enableAnalyticsEvents = true;
-        this.appName = "search-context";
-        this.appVersion = "1.0";
+        this.appName = undefined;
+        this.appVersion = undefined;
         this.publication = undefined;
         this.sendEvent = (results) => {
-            if (!this.enableAnalyticsEvents || !results) {
+            if (!this.canSendEvent() || !results) {
                 return;
             }
-            const { editorMode } = ftAppInfoStore.getState();
-            if (!editorMode) {
-                const request = this.store.getState().request;
-                if (this.publication == undefined) {
-                    this.sendKhubSearchEvent(request, results);
-                }
-                else {
-                    this.sendDocumentSearchEvent(request, results);
-                }
+            const request = this.store.getState().request;
+            if (this.publication == undefined) {
+                this.sendKhubSearchEvent(request, results);
+            }
+            else {
+                this.sendDocumentSearchEvent(request, results);
             }
         };
         this.eventsService = eventService !== null && eventService !== void 0 ? eventService : new FtAnalyticsEventsService();
@@ -40,12 +38,20 @@ export class FtAnalyticsSearchEventManager {
     setDocumentSearch(publication) {
         this.publication = publication;
     }
+    canSendEvent() {
+        if (this.appName == undefined || this.appVersion == undefined) {
+            console.debug("ft-search-context.eventManager is not initialized. No events will be sent!");
+            return false;
+        }
+        const { editorMode } = ftAppInfoStore.getState();
+        return this.enableAnalyticsEvents && !editorMode;
+    }
     sendKhubSearchEvent(request, results) {
         const event = {
             offline: false,
             appVersion: this.appVersion,
             appName: this.appName,
-            name: "KHUB__SEARCH",
+            name: FtAnalyticsEventName.KHUB__SEARCH,
             searchResponse: {
                 autocorrect: this.store.getState().spellcheck != undefined,
                 nbResults: results.length
@@ -64,7 +70,7 @@ export class FtAnalyticsSearchEventManager {
             offline: false,
             appVersion: this.appVersion,
             appName: this.appName,
-            name: "DOCUMENT__SEARCH",
+            name: FtAnalyticsEventName.DOCUMENT__SEARCH,
             searchResponse: {
                 autocorrect: this.store.getState().spellcheck != undefined,
                 nbResults: results.length
@@ -79,4 +85,69 @@ export class FtAnalyticsSearchEventManager {
         };
         this.eventsService.sendDocumentSearchEvent(event);
     }
+    sendResultClickedEvent(result, rank) {
+        if (!this.canSendEvent()) {
+            return;
+        }
+        const request = this.store.getState().request;
+        let topic = undefined;
+        if (result.type == FtSearchResultType.TOPIC) {
+            topic = {
+                tocId: result.topic.tocId,
+                title: result.topic.title
+            };
+        }
+        const event = {
+            offline: false,
+            appVersion: this.appVersion,
+            appName: this.appName,
+            name: FtAnalyticsEventName.SEARCH_PAGE__SELECT,
+            searchQuery: {
+                terms: request.query,
+                searchType: request.virtualField,
+                lastUpdate: getAnalyticsLastUpdate(request.metadataFilters),
+                facets: request.metadataFilters.map(facet => convertMetadataFilterToAnalyticsFacet(facet))
+            },
+            searchResult: {
+                rank: rank,
+                type: result.type,
+                document: this.convertDocument(result),
+                topic: topic
+            },
+            externalLink: this.convertExternalLink(result)
+        };
+        this.eventsService.sendSearchPageSelectEvent(event);
+    }
+    convertDocument(result) {
+        switch (result.type) {
+            case FtSearchResultType.MAP:
+                return {
+                    id: result.map.mapId,
+                    title: result.map.title,
+                    type: FtAnalyticsPublicationType.STRUCTURED_DOCUMENT,
+                    metadata: result.map.metadata
+                };
+            case FtSearchResultType.TOPIC:
+                return {
+                    id: result.topic.mapId,
+                    title: result.topic.mapTitle,
+                    type: FtAnalyticsPublicationType.STRUCTURED_DOCUMENT,
+                    metadata: result.topic.metadata
+                };
+            case FtSearchResultType.DOCUMENT:
+                return {
+                    id: result.document.documentId,
+                    title: result.document.title,
+                    type: FtAnalyticsPublicationType.UNSTRUCTURED_DOCUMENT,
+                    metadata: result.document.metadata,
+                    mimeType: result.document.mimeType
+                };
+            default:
+                throw new TypeError("Unknown type " + result.type);
+        }
+    }
+    convertExternalLink(result) {
+        var _a, _b, _c, _d, _e;
+        return (_d = (_b = (_a = result.map) === null || _a === void 0 ? void 0 : _a.originUrl) !== null && _b !== void 0 ? _b : (_c = result.topic) === null || _c === void 0 ? void 0 : _c.originUrl) !== null && _d !== void 0 ? _d : (_e = result.document) === null || _e === void 0 ? void 0 : _e.originUrl;
+    }
 }

package/build/utils.d.ts

@@ -0,0 +1,7 @@
+import { FtSearchResultClusterEntry } from "@fluid-topics/public-api";
+export declare class SearchResultClickEvent extends CustomEvent<{
+    result: FtSearchResultClusterEntry;
+    rank: number;
+}> {
+    constructor(result: FtSearchResultClusterEntry, rank: number);
+}

package/build/utils.js

@@ -0,0 +1,5 @@
+export class SearchResultClickEvent extends CustomEvent {
+    constructor(result, rank) {
+        super("ft-search-result-click", { detail: { result, rank }, bubbles: true, composed: true });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-topics/ft-search-context",
-  "version": "1.2.37",
+  "version": "1.2.39",
   "description": "Context block for integrated search components",
   "keywords": [
     "Lit"
@@ -19,12 +19,12 @@
     "url": "ssh://git@scm.mrs.antidot.net:2222/fluidtopics/ft-web-components.git"
   },
   "dependencies": {
-    "@fluid-topics/ft-app-context": "1.2.37",
-    "@fluid-topics/ft-wc-utils": "1.2.37",
+    "@fluid-topics/ft-app-context": "1.2.39",
+    "@fluid-topics/ft-wc-utils": "1.2.39",
     "lit": "3.1.0"
   },
   "devDependencies": {
     "@fluid-topics/public-api": "1.0.88"
   },
-  "gitHead": "5e3e862fb02153f9318a9ac3439617694151a43c"
+  "gitHead": "b5772ed3ef0ed0ffc2465cfb8307593eacb6ad27"
 }