@fluid-topics/ft-wc-utils 1.2.22 → 1.2.24

package/build/ClusteringHelper.d.ts

@@ -5,22 +5,29 @@ export interface FlatMetadata {
     label: string;
     value: Optional<string>;
     displayValue: string;
+    displayTooltipValue: string;
 }
 export interface ClusterItem {
     metadata: FlatMetadata;
     result: FtSearchResultClusterEntry;
 }
+export interface ExtractResultMetadataOptions {
+    result: FtSearchResultClusterEntry;
+    key?: string;
+    hierarchicalValueTruncatingLevel?: number;
+    dateFormatter?: ((value: string) => string);
+}
 export declare class ClusteringHelper {
     private allResults;
     private selectedResult;
     private clusteringMetadata;
     private metadataDescriptors;
     constructor(allResults: Array<FtSearchResultClusterEntry>, selectedResult: FtSearchResultClusterEntry, clusteringMetadata: Set<string>, metadataDescriptors: Array<FtMetadataDescriptor>);
-    static extractResultMetadata(result: FtSearchResultClusterEntry): FlatMetadata[];
-    static extractResultMetadata(result: FtSearchResultClusterEntry, key: string): Optional<FlatMetadata>;
-    static flattenMetadata(metadata: Optional<FtMetadata>[]): FlatMetadata[];
-    static flattenMetadata(metadata: Optional<FtMetadata>): Optional<FlatMetadata>;
-    computeClustersItemsForMetadata(key: string, locale: string, undefinedDisplayValue?: string): ClusterItem[];
+    static extractResultMetadata(options: Omit<ExtractResultMetadataOptions, "key">): FlatMetadata[];
+    static extractResultMetadata(options: ExtractResultMetadataOptions): Optional<FlatMetadata>;
+    static flattenMetadata(metadata: Optional<FtMetadata>[], hierarchicalValueTruncatingLevel?: number, dateFormatter?: ((value: string) => string)): FlatMetadata[];
+    static flattenMetadata(metadata: Optional<FtMetadata>, hierarchicalValueTruncatingLevel?: number, dateFormatter?: ((value: string) => string)): Optional<FlatMetadata>;
+    computeClustersItemsForMetadata(key: string, locale: string, undefinedDisplayValue?: string, hierarchicalValueTruncatingLevel?: number, dateFormatter?: ((value: string) => string)): ClusterItem[];
     private compareMetadata;
     getMetadataDescriptor(key: string): FtMetadataDescriptor | undefined;
     private findBestResultForMetadataValue;

package/build/ClusteringHelper.js

@@ -5,17 +5,17 @@ export class ClusteringHelper {
         this.clusteringMetadata = clusteringMetadata;
         this.metadataDescriptors = metadataDescriptors;
     }
-    static extractResultMetadata(result, key) {
-        var _a, _b;
-        let metadata = ((_b = (_a = result === null || result === void 0 ? void 0 : result.map) !== null && _a !== void 0 ? _a : result === null || result === void 0 ? void 0 : result.document) !== null && _b !== void 0 ? _b : result === null || result === void 0 ? void 0 : result.topic).metadata;
-        if (key == null) {
-            return ClusteringHelper.flattenMetadata(metadata);
+    static extractResultMetadata(options) {
+        var _a, _b, _c, _d, _e;
+        let metadata = ((_d = (_b = (_a = options.result) === null || _a === void 0 ? void 0 : _a.map) !== null && _b !== void 0 ? _b : (_c = options.result) === null || _c === void 0 ? void 0 : _c.document) !== null && _d !== void 0 ? _d : (_e = options.result) === null || _e === void 0 ? void 0 : _e.topic).metadata;
+        if (options.key == null) {
+            return ClusteringHelper.flattenMetadata(metadata, options.hierarchicalValueTruncatingLevel, options.dateFormatter);
         }
-        return ClusteringHelper.flattenMetadata(metadata.find(m => m.key === key));
+        return ClusteringHelper.flattenMetadata(metadata.find(m => m.key === options.key), options.hierarchicalValueTruncatingLevel, options.dateFormatter);
     }
-    static flattenMetadata(metadata) {
+    static flattenMetadata(metadata, hierarchicalValueTruncatingLevel, dateFormatter) {
         if (Array.isArray(metadata)) {
-            return metadata.map(m => ClusteringHelper.flattenMetadata(m)).filter(m => m != null);
+            return metadata.map(m => ClusteringHelper.flattenMetadata(m, hierarchicalValueTruncatingLevel, dateFormatter)).filter(m => m != null);
         }
         const isHierarchical = (metadata === null || metadata === void 0 ? void 0 : metadata.hierarchicalValues) != null && metadata.hierarchicalValues.length > 0;
         if (metadata == null || (metadata.values.length == 0 && !isHierarchical)) {
@@ -26,7 +26,7 @@ export class ClusteringHelper {
             const displayValues = [];
             metadata.hierarchicalValues.forEach(tree => {
                 values.push(tree.join(" > "));
-                if (tree.length > 2) {
+                if (hierarchicalValueTruncatingLevel && hierarchicalValueTruncatingLevel > 1 && tree.length >= hierarchicalValueTruncatingLevel) {
                     displayValues.push(`... > ${tree[tree.length - 1]}`);
                 }
                 else {
@@ -37,25 +37,31 @@ export class ClusteringHelper {
                 key: metadata.key,
                 label: metadata.label,
                 value: values.join(", "),
-                displayValue: displayValues.join(", ")
+                displayValue: displayValues.join(", "),
+                displayTooltipValue: values.join(", "),
             };
         }
         else {
+            // Date metadata cannot be hierarchical
             const value = metadata.values.join(", ");
+            const displayValue = metadata.values
+                .map(value => dateFormatter ? dateFormatter(value) : value)
+                .join(", ");
             return {
                 key: metadata.key,
                 label: metadata.label,
                 value: value,
-                displayValue: value
+                displayValue: displayValue,
+                displayTooltipValue: displayValue,
             };
         }
     }
-    computeClustersItemsForMetadata(key, locale, undefinedDisplayValue = "No value") {
+    computeClustersItemsForMetadata(key, locale, undefinedDisplayValue = "No value", hierarchicalValueTruncatingLevel, dateFormatter) {
         var _a, _b;
-        let currentResultMetadataTargeted = ClusteringHelper.extractResultMetadata(this.selectedResult, key);
+        let currentResultMetadataTargeted = ClusteringHelper.extractResultMetadata({ result: this.selectedResult, key, dateFormatter });
         let metadataLabel = (_a = currentResultMetadataTargeted === null || currentResultMetadataTargeted === void 0 ? void 0 : currentResultMetadataTargeted.label) !== null && _a !== void 0 ? _a : (_b = this.getMetadataDescriptor(key)) === null || _b === void 0 ? void 0 : _b.label;
         const otherValues = this.allResults
-            .map(result => ClusteringHelper.extractResultMetadata(result, key))
+            .map(result => ClusteringHelper.extractResultMetadata({ result, key, hierarchicalValueTruncatingLevel, dateFormatter }))
             .map(m => m !== null && m !== void 0 ? m : { key: key, label: metadataLabel, value: undefined, displayValue: undefinedDisplayValue })
             .filter(m => m.value != (currentResultMetadataTargeted === null || currentResultMetadataTargeted === void 0 ? void 0 : currentResultMetadataTargeted.value))
             .filter((flatMeta, index, array) => array.findIndex(i => i.value === flatMeta.value) === index); // for unicity
@@ -85,8 +91,8 @@ export class ClusteringHelper {
     }
     findBestResultForMetadataValue(key, value) {
         const resultsMatchingRequiredValue = this.allResults
-            .filter(result => { var _a; return ((_a = ClusteringHelper.extractResultMetadata(result, key)) === null || _a === void 0 ? void 0 : _a.value) == value; });
-        let currentResultMetadata = ClusteringHelper.extractResultMetadata(this.selectedResult)
+            .filter(result => { var _a; return ((_a = ClusteringHelper.extractResultMetadata({ result, key })) === null || _a === void 0 ? void 0 : _a.value) == value; });
+        let currentResultMetadata = ClusteringHelper.extractResultMetadata({ result: this.selectedResult })
             .filter(m => this.clusteringMetadata.has(m.key));
         let wishedMetadata = [...currentResultMetadata.filter(m => m.key !== key)];
         let bestResult;
@@ -104,7 +110,7 @@ export class ClusteringHelper {
         return bestResult;
     }
     countMatchingMetadata(result, expectedMetadata) {
-        return ClusteringHelper.extractResultMetadata(result)
+        return ClusteringHelper.extractResultMetadata({ result })
             .filter(m => expectedMetadata.some(em => em.key === m.key && em.value === m.value)).length;
     }
 }