@fluid-topics/ft-search-context 1.2.28 → 1.2.30

package/build/index.d.ts

@@ -2,3 +2,4 @@ export * from "./ft-search-context.styles";
 export * from "./ft-search-context.properties";
 export * from "./ft-search-context";
 export * from "./store/FtSearchStateManager";
+export * from "./store/utils/analytics-utils";

package/build/index.js

@@ -4,4 +4,5 @@ export * from "./ft-search-context.styles";
 export * from "./ft-search-context.properties";
 export * from "./ft-search-context";
 export * from "./store/FtSearchStateManager";
+export * from "./store/utils/analytics-utils";
 customElement("ft-search-context")(FtSearchContext);

package/build/store/FtAnalyticsSearchEventManager.d.ts

@@ -0,0 +1,25 @@
+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 { FtAnalyticsEventsService } from "@fluid-topics/ft-app-context";
+export declare class FtAnalyticsSearchEventManager {
+    readonly store: FtReduxStore<FtSearchPageState, FtSearchPageStateReducers>;
+    readonly eventsService: FtAnalyticsEventsService;
+    errorHandler?: (e: Error) => void;
+    ignoreEmptyQuery: boolean;
+    openExternalDocumentInNewTab: boolean;
+    enableAnalyticsEvents: boolean;
+    appName: string;
+    appVersion: string;
+    publication: FtAnalyticsEventPublication | undefined;
+    protected readonly resultsWatcher: ReduxWatcher<FtSearchPageState, FtSearchResultCluster[] | undefined>;
+    constructor(store: FtReduxStore<FtSearchPageState, FtSearchPageStateReducers>, eventService?: FtAnalyticsEventsService);
+    setEnableAnalyticsEvents(enableAnalyticsEvents: boolean): void;
+    setAppName(appName: string): void;
+    setAppVersion(appVersion: string): void;
+    setDocumentSearch(publication: FtAnalyticsEventPublication): void;
+    private sendEvent;
+    private sendKhubSearchEvent;
+    private sendDocumentSearchEvent;
+}

package/build/store/FtAnalyticsSearchEventManager.js

@@ -0,0 +1,84 @@
+import { watch } from "@fluid-topics/ft-wc-utils";
+import { FtAnalyticsEventsService, ftAppInfoStore } from "@fluid-topics/ft-app-context";
+import { convertMetadataFilterToAnalyticsFacet, getAnalyticsLastUpdate } from "./utils/analytics-utils";
+export class FtAnalyticsSearchEventManager {
+    constructor(store, eventService) {
+        this.store = store;
+        this.ignoreEmptyQuery = false;
+        this.openExternalDocumentInNewTab = false;
+        this.enableAnalyticsEvents = true;
+        this.appName = "search-context";
+        this.appVersion = "1.0";
+        this.publication = undefined;
+        this.sendEvent = (results) => {
+            if (!this.enableAnalyticsEvents || !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);
+                }
+            }
+        };
+        this.eventsService = eventService !== null && eventService !== void 0 ? eventService : new FtAnalyticsEventsService();
+        this.resultsWatcher = watch(store, (s) => s.results, this.sendEvent);
+    }
+    setEnableAnalyticsEvents(enableAnalyticsEvents) {
+        this.enableAnalyticsEvents = enableAnalyticsEvents;
+    }
+    setAppName(appName) {
+        this.appName = appName;
+    }
+    setAppVersion(appVersion) {
+        this.appVersion = appVersion;
+    }
+    setDocumentSearch(publication) {
+        this.publication = publication;
+    }
+    sendKhubSearchEvent(request, results) {
+        const event = {
+            offline: false,
+            appVersion: this.appVersion,
+            appName: this.appName,
+            name: "KHUB__SEARCH",
+            version: "1.0",
+            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))
+            }
+        };
+        this.eventsService.sendKhubSearchEvent(event);
+    }
+    sendDocumentSearchEvent(request, results) {
+        const event = {
+            offline: false,
+            appVersion: this.appVersion,
+            appName: this.appName,
+            name: "DOCUMENT__SEARCH",
+            version: "1.0",
+            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))
+            },
+            publication: this.publication
+        };
+        this.eventsService.sendDocumentSearchEvent(event);
+    }
+}

package/build/store/utils/analytics-utils.d.ts

@@ -0,0 +1,3 @@
+import { FtAnalyticsSearchFacet, FtMetadataFilter } from "@fluid-topics/public-api";
+export declare function getAnalyticsLastUpdate(facets: FtMetadataFilter[]): string | undefined;
+export declare function convertMetadataFilterToAnalyticsFacet(facet: FtMetadataFilter): FtAnalyticsSearchFacet;

package/build/store/utils/analytics-utils.js

@@ -0,0 +1,35 @@
+export function getAnalyticsLastUpdate(facets) {
+    return facets
+        .filter(f => f.key === 'ft:lastEdition')
+        .filter(f => !f.valueFilter)
+        .map(f => {
+        if (f.dateFilter) {
+            return f.dateFilter.type;
+        }
+        return 'CUSTOM';
+    }).shift();
+}
+export function convertMetadataFilterToAnalyticsFacet(facet) {
+    var _a;
+    if (facet.dateFilter) {
+        return {
+            key: facet.key,
+            type: "DATE",
+            dateValue: facet.dateFilter.type
+        };
+    }
+    else if (facet.rangeFilter) {
+        return {
+            key: facet.key,
+            type: "RANGE",
+            from: facet.rangeFilter.from,
+            to: facet.rangeFilter.to
+        };
+    }
+    else {
+        return {
+            key: facet.key,
+            values: (_a = facet.valueFilter) === null || _a === void 0 ? void 0 : _a.values
+        };
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-topics/ft-search-context",
-  "version": "1.2.28",
+  "version": "1.2.30",
   "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.28",
-    "@fluid-topics/ft-wc-utils": "1.2.28",
+    "@fluid-topics/ft-app-context": "1.2.30",
+    "@fluid-topics/ft-wc-utils": "1.2.30",
     "lit": "3.1.0"
   },
   "devDependencies": {
     "@fluid-topics/public-api": "1.0.87"
   },
-  "gitHead": "88ea7068b85224127e464694674854c7796017ea"
+  "gitHead": "ac166f46dbdc65614893826ca64bbfc51e2e2b94"
 }