@fluid-topics/ft-search-context 1.3.5 → 1.3.7

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 { FtAnalyticsEventDocument, FtSearchResultCluster, FtSearchResultClusterEntry } from "@fluid-topics/public-api";
+import { FtAnalyticsEventDocument, FtMap, FtSearchResultCluster, FtSearchResultClusterEntry } from "@fluid-topics/public-api";
 import { FtAnalyticsEventsService } from "@fluid-topics/ft-app-context";
 export declare class FtAnalyticsSearchEventManager {
     readonly store: FtReduxStore<FtSearchPageState, FtSearchPageStateReducers>;
@@ -19,6 +19,9 @@ export declare class FtAnalyticsSearchEventManager {
     setAppName(appName: string): void;
     setAppVersion(appVersion: string): void;
     setDocumentSearch(document: FtAnalyticsEventDocument): void;
+    setDocumentSearchFromMap(map: FtMap): void;
+    initAppInfo(): void;
+    private convertToAnalyticsMap;
     private canSendEvent;
     private sendEvent;
     private sendKhubSearchEvent;

package/build/store/FtAnalyticsSearchEventManager.js

@@ -38,6 +38,34 @@ export class FtAnalyticsSearchEventManager {
     setDocumentSearch(document) {
         this.document = document;
     }
+    setDocumentSearchFromMap(map) {
+        this.setDocumentSearch(this.convertToAnalyticsMap(map));
+    }
+    initAppInfo() {
+        const { apiIntegrationIdentifier, apiIntegrationAppVersion } = ftAppInfoStore.getState();
+        this.setAppName(apiIntegrationIdentifier !== null && apiIntegrationIdentifier !== void 0 ? apiIntegrationIdentifier : "unknown");
+        this.setAppVersion(apiIntegrationAppVersion !== null && apiIntegrationAppVersion !== void 0 ? apiIntegrationAppVersion : "unknown");
+    }
+    convertToAnalyticsMap(map) {
+        let documentType;
+        switch (map.editorialType) {
+            case "BOOK":
+                documentType = "STRUCTURED_DOCUMENT";
+                break;
+            case "SHARED_BOOK":
+                documentType = "SHARED_PERSONAL_BOOK";
+                break;
+            case "ARTICLE":
+                documentType = "RESOURCE";
+                break;
+        }
+        return {
+            id: map.id,
+            title: map.title,
+            type: documentType,
+            metadata: map.metadata,
+        };
+    }
     canSendEvent() {
         if (this.appName == undefined || this.appVersion == undefined) {
             console.debug("ft-search-context.eventManager is not initialized. No events will be sent!");
@@ -54,36 +82,42 @@ export class FtAnalyticsSearchEventManager {
             name: FtAnalyticsEventName.KHUB__SEARCH,
             searchResponse: {
                 autocorrect: this.store.getState().spellcheck != undefined,
-                nbResults: results.length
+                nbResults: results.length,
             },
             searchQuery: {
                 terms: request.query,
                 searchType: request.virtualField,
                 lastUpdate: getAnalyticsLastUpdate(request.metadataFilters),
-                facets: request.metadataFilters.map(facet => convertMetadataFilterToAnalyticsFacet(facet))
-            }
+                facets: request.metadataFilters.map(facet => convertMetadataFilterToAnalyticsFacet(facet)),
+            },
         };
         this.eventsService.sendKhubSearchEvent(event);
     }
     sendDocumentSearchEvent(request, results) {
-        const event = {
-            offline: false,
-            appVersion: this.appVersion,
-            appName: this.appName,
-            name: FtAnalyticsEventName.DOCUMENT__SEARCH,
-            searchResponse: {
-                autocorrect: this.store.getState().spellcheck != undefined,
-                nbResults: results.length
-            },
-            searchQuery: {
-                terms: request.query,
-                searchType: request.virtualField,
-                lastUpdate: getAnalyticsLastUpdate(request.metadataFilters),
-                facets: request.metadataFilters.map(facet => convertMetadataFilterToAnalyticsFacet(facet))
-            },
-            document: this.document
-        };
-        this.eventsService.sendDocumentSearchEvent(event);
+        const isRequestForThisDocument = request.metadataFilters.find((f) => {
+            var _a;
+            return f.key === "ft:publicationId" && ((_a = f.valueFilter) === null || _a === void 0 ? void 0 : _a.values[0]) === this.document.id;
+        }) !== undefined;
+        if (isRequestForThisDocument) {
+            const event = {
+                offline: false,
+                appVersion: this.appVersion,
+                appName: this.appName,
+                name: FtAnalyticsEventName.DOCUMENT__SEARCH,
+                searchResponse: {
+                    autocorrect: this.store.getState().spellcheck != undefined,
+                    nbResults: results.length,
+                },
+                searchQuery: {
+                    terms: request.query,
+                    searchType: request.virtualField,
+                    lastUpdate: getAnalyticsLastUpdate(request.metadataFilters),
+                    facets: request.metadataFilters.map(facet => convertMetadataFilterToAnalyticsFacet(facet)),
+                },
+                document: this.document,
+            };
+            this.eventsService.sendDocumentSearchEvent(event);
+        }
     }
     sendResultClickedEvent(result, rank) {
         if (!this.canSendEvent()) {
@@ -94,7 +128,7 @@ export class FtAnalyticsSearchEventManager {
         if (result.type == FtSearchResultType.TOPIC) {
             topic = {
                 tocId: result.topic.tocId,
-                title: result.topic.title
+                title: result.topic.title,
             };
         }
         const event = {
@@ -106,15 +140,15 @@ export class FtAnalyticsSearchEventManager {
                 terms: request.query,
                 searchType: request.virtualField,
                 lastUpdate: getAnalyticsLastUpdate(request.metadataFilters),
-                facets: request.metadataFilters.map(facet => convertMetadataFilterToAnalyticsFacet(facet))
+                facets: request.metadataFilters.map(facet => convertMetadataFilterToAnalyticsFacet(facet)),
             },
             searchResult: {
                 rank: rank,
                 type: result.type,
                 document: this.convertDocument(result),
-                topic: topic
+                topic: topic,
             },
-            externalLink: this.convertExternalLink(result)
+            externalLink: this.convertExternalLink(result),
         };
         this.eventsService.sendSearchPageSelectEvent(event);
     }
@@ -127,7 +161,7 @@ export class FtAnalyticsSearchEventManager {
         if (result.type == FtSearchResultType.TOPIC) {
             topic = {
                 tocId: result.topic.tocId,
-                title: result.topic.title
+                title: result.topic.title,
             };
         }
         const event = {
@@ -139,15 +173,15 @@ export class FtAnalyticsSearchEventManager {
                 terms: request.query,
                 searchType: request.virtualField,
                 lastUpdate: getAnalyticsLastUpdate(request.metadataFilters),
-                facets: request.metadataFilters.map(facet => convertMetadataFilterToAnalyticsFacet(facet))
+                facets: request.metadataFilters.map(facet => convertMetadataFilterToAnalyticsFacet(facet)),
             },
             searchResult: {
                 rank: rank,
                 type: result.type,
                 document: this.convertDocument(result),
-                topic: topic
+                topic: topic,
             },
-            externalLink: this.convertExternalLink(result)
+            externalLink: this.convertExternalLink(result),
         };
         this.eventsService.sendSearchResultOpenContextMenuEvent(event);
     }
@@ -158,14 +192,14 @@ export class FtAnalyticsSearchEventManager {
                     id: result.map.mapId,
                     title: result.map.title,
                     type: FtAnalyticsPublicationType.STRUCTURED_DOCUMENT,
-                    metadata: result.map.metadata
+                    metadata: result.map.metadata,
                 };
             case FtSearchResultType.TOPIC:
                 return {
                     id: result.topic.mapId,
                     title: result.topic.mapTitle,
                     type: FtAnalyticsPublicationType.STRUCTURED_DOCUMENT,
-                    metadata: result.topic.metadata
+                    metadata: result.topic.metadata,
                 };
             case FtSearchResultType.DOCUMENT:
                 return {
@@ -173,7 +207,7 @@ export class FtAnalyticsSearchEventManager {
                     title: result.document.title,
                     type: FtAnalyticsPublicationType.UNSTRUCTURED_DOCUMENT,
                     metadata: result.document.metadata,
-                    mimeType: result.document.mimeType
+                    mimeType: result.document.mimeType,
                 };
             default:
                 throw new TypeError("Unknown type " + result.type);

package/build/store/utils/FtSearchService.d.ts

@@ -6,6 +6,4 @@ export declare class FtSearchService extends FtServiceWithCache {
     launchSuggest(request: FtSuggestRequest): Promise<FtSuggestResults>;
     getAvailableSearchLocales(): Promise<FtSearchLocales>;
     private sortFilters;
-    private sortObjectFields;
-    hash(object: any): string;
 }

package/build/store/utils/FtSearchService.js

@@ -2,13 +2,6 @@ import { FtServiceWithCache } from "@fluid-topics/ft-app-context";
 export class FtSearchService extends FtServiceWithCache {
     constructor(overrideApi) {
         super(true, overrideApi);
-        this.sortObjectFields = (_, value) => {
-            if (typeof value !== "object" || value == null || Array.isArray(value)) {
-                return value;
-            }
-            return Object.fromEntries(Object.entries(value)
-                .sort(([ka], [kb]) => ka.localeCompare(kb)));
-        };
     }
     async launchSearch(request) {
         const sortedRequest = {
@@ -39,8 +32,4 @@ export class FtSearchService extends FtServiceWithCache {
         })
             .sort((a, b) => a.key.localeCompare(b.key));
     }
-    hash(object) {
-        return String(Array.from(JSON.stringify(object, this.sortObjectFields))
-            .reduce((hash, char) => 0 | (31 * hash + char.charCodeAt(0)), 0));
-    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-topics/ft-search-context",
-  "version": "1.3.5",
+  "version": "1.3.7",
   "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.3.5",
-    "@fluid-topics/ft-wc-utils": "1.3.5",
+    "@fluid-topics/ft-app-context": "1.3.7",
+    "@fluid-topics/ft-wc-utils": "1.3.7",
     "lit": "3.1.0"
   },
   "devDependencies": {
     "@fluid-topics/public-api": "1.0.99"
   },
-  "gitHead": "87377b99617257593de238b08c41d2638617f501"
+  "gitHead": "83a6f0c292e6669cc067b7aa40fea8a4a0a61b7f"
 }