WEBDEV-7002 Improve organization & exports for smart query heuristics (#435)

* Add exports for smart query heuristics

* Reorganize heuristics

* Export required heuristics & types

* Fix imports

* Clean up some heuristic methods & docs

* Fix formatting & add keywords

* Log heuristic errors

* Better organized wikidata entity map

* Remove log statements

Author: latonv

index.ts

@@ -3,11 +3,25 @@ export { CollectionBrowserDataSource } from './src/data-source/collection-browse
 export { CollectionBrowserDataSourceInterface } from './src/data-source/collection-browser-data-source-interface';
 export { CollectionBrowserQueryState } from './src/data-source/collection-browser-query-state';
 export { SortFilterBar } from './src/sort-filter-bar/sort-filter-bar';
-export { CollectionDisplayMode, SortField, TileModel } from './src/models';
+export {
+  CollectionDisplayMode,
+  SortField,
+  TileModel,
+  FacetOption,
+  SelectedFacets,
+  getDefaultSelectedFacets,
+} from './src/models';
 export { CollectionBrowserLoadingTile } from './src/tiles/collection-browser-loading-tile';
 export { CollectionTile } from './src/tiles/grid/collection-tile';
 export { AccountTile } from './src/tiles/grid/account-tile';
 export { ItemTile } from './src/tiles/grid/item-tile';
 export { TileList } from './src/tiles/list/tile-list';
 export { TileListCompact } from './src/tiles/list/tile-list-compact';
 export { TileDispatcher } from './src/tiles/tile-dispatcher';
+export {
+  SmartQueryHeuristic,
+  KeywordFacetMap,
+  SmartFacet,
+} from './src/collection-facets/smart-facets/models';
+export * from './src/collection-facets/smart-facets/heuristics/index';
+export { SmartQueryHeuristicGroup } from './src/collection-facets/smart-facets/smart-facet-heuristics';

src/collection-facets/smart-facets/dedupe.ts

@@ -14,7 +14,8 @@ export function dedupe<T extends SmartFacet[] | SmartFacet[][]>(facets: T): T {
     const facetsUnnested = facets as SmartFacet[];
 
     let result: SmartFacet[] = [...facetsUnnested];
-    for (const curFacet of facetsUnnested) {
+    for (let i = 0; i < result.length; i++) {
+      const curFacet = result[i];
       result = result.filter(
         sf => curFacet === sf || !smartFacetEquals(curFacet, sf),
       );

src/collection-facets/smart-facets/heuristics/browser-language-heuristic.ts renamed to src/collection-facets/smart-facets/heuristics/browser-language/browser-language-heuristic.ts

@@ -1,4 +1,4 @@
-import type { SmartQueryHeuristic, SmartFacet } from '../models';
+import type { SmartQueryHeuristic, SmartFacet } from '../../models';
 
 export class BrowserLanguageHeuristic implements SmartQueryHeuristic {
   async getRecommendedFacets(): Promise<SmartFacet[]> {

src/collection-facets/smart-facets/heuristics/index.ts

@@ -0,0 +1,3 @@
+export { BrowserLanguageHeuristic } from './browser-language/browser-language-heuristic';
+export { QueryKeywordsHeuristic } from './query-keywords/query-keywords-heuristic';
+export { WikidataHeuristic } from './wikidata/wikidata-heuristic';

src/collection-facets/smart-facets/heuristics/query-keywords-heuristic.ts

@@ -0,0 +1,17 @@
+import type { SmartQueryHeuristic, SmartFacet } from '../../models';
+import { QUERY_KEYWORDS } from './query-keywords-map';
+
+// If the query contains X keyword but Y facet isn't selected, recommend facet Y
+export class QueryKeywordsHeuristic implements SmartQueryHeuristic {
+  async getRecommendedFacets(query: string): Promise<SmartFacet[]> {
+    const recommendations: SmartFacet[] = [];
+
+    for (const [keyword, facets] of Object.entries(QUERY_KEYWORDS)) {
+      if (query.includes(keyword)) {
+        recommendations.push(...facets);
+      }
+    }
+
+    return recommendations;
+  }
+}

src/collection-facets/smart-facets/heuristics/query-keywords/query-keywords-heuristic.ts

@@ -0,0 +1,70 @@
+import type { KeywordFacetMap, SmartFacet } from '../../models';
+
+const TEXTS: SmartFacet = {
+  facets: [{ facetType: 'mediatype', bucketKey: 'texts' }],
+};
+const AUDIO: SmartFacet = {
+  facets: [{ facetType: 'mediatype', bucketKey: 'audio' }],
+};
+const MOVIES: SmartFacet = {
+  facets: [{ facetType: 'mediatype', bucketKey: 'movies' }],
+};
+const IMAGE: SmartFacet = {
+  facets: [{ facetType: 'mediatype', bucketKey: 'image' }],
+};
+const SOFTWARE: SmartFacet = {
+  facets: [{ facetType: 'mediatype', bucketKey: 'software' }],
+};
+const ETREE: SmartFacet = {
+  facets: [{ facetType: 'mediatype', bucketKey: 'etree' }],
+};
+const WEB: SmartFacet = {
+  facets: [{ facetType: 'mediatype', bucketKey: 'web' }],
+};
+const DATA: SmartFacet = {
+  facets: [{ facetType: 'mediatype', bucketKey: 'data' }],
+};
+
+/**
+ * Map from keywords found in the search query to an array of
+ * likely-relevant "smart facets" for those keywords.
+ */
+export const QUERY_KEYWORDS: Readonly<KeywordFacetMap> = {
+  text: [TEXTS],
+  book: [TEXTS],
+  novel: [TEXTS],
+  magazine: [TEXTS],
+  newspaper: [TEXTS],
+  pdf: [TEXTS],
+  epub: [TEXTS],
+  audio: [AUDIO],
+  song: [AUDIO],
+  music: [AUDIO],
+  listen: [AUDIO],
+  podcast: [AUDIO],
+  radio: [AUDIO],
+  stream: [AUDIO, MOVIES],
+  video: [MOVIES],
+  movie: [MOVIES],
+  film: [MOVIES],
+  animation: [MOVIES],
+  youtube: [MOVIES],
+  image: [IMAGE],
+  photo: [IMAGE],
+  picture: [IMAGE],
+  painting: [IMAGE],
+  jpg: [IMAGE],
+  jpeg: [IMAGE],
+  png: [IMAGE],
+  gif: [IMAGE],
+  software: [SOFTWARE],
+  app: [SOFTWARE],
+  program: [SOFTWARE],
+  game: [SOFTWARE],
+  arcade: [SOFTWARE],
+  etree: [ETREE],
+  concert: [ETREE],
+  'live music': [ETREE],
+  'web crawl': [WEB],
+  dataset: [DATA],
+};