npm - @internetarchive/collection-browser - Versions diffs - 2.8.0 → 2.8.1-alpha-webdev7002.0 - Mend

@internetarchive/collection-browser 2.8.0 → 2.8.1-alpha-webdev7002.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

package/dist/index.d.ts CHANGED Viewed

@@ -3,7 +3,7 @@ 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';
@@ -11,3 +11,6 @@ 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';

package/dist/index.js CHANGED Viewed

@@ -1,7 +1,7 @@
 export { CollectionBrowser } from './src/collection-browser';
 export { CollectionBrowserDataSource } from './src/data-source/collection-browser-data-source';
 export { SortFilterBar } from './src/sort-filter-bar/sort-filter-bar';
-export { SortField, TileModel } from './src/models';
+export { SortField, TileModel, 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';
@@ -9,4 +9,6 @@ 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 * from './src/collection-facets/smart-facets/heuristics/index';
+export { SmartQueryHeuristicGroup } from './src/collection-facets/smart-facets/smart-facet-heuristics';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kDAAkD,CAAC;AAG/F,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,~~EAAyB~~,SAAS,~~EAAE~~,SAAS,~~EAAE~~,MAAM,cAAc,CAAC;~~AAC3E~~,OAAO,EAAE,4BAA4B,EAAE,MAAM,6CAA6C,CAAC;AAC3F,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC","sourcesContent":["export { CollectionBrowser } from './src/collection-browser';\nexport { CollectionBrowserDataSource } from './src/data-source/collection-browser-data-source';\nexport { CollectionBrowserDataSourceInterface } from './src/data-source/collection-browser-data-source-interface';\nexport { CollectionBrowserQueryState } from './src/data-source/collection-browser-query-state';\nexport { SortFilterBar } from './src/sort-filter-bar/sort-filter-bar';\nexport { CollectionDisplayMode, SortField, TileModel } from './src/models';\nexport { CollectionBrowserLoadingTile } from './src/tiles/collection-browser-loading-tile';\nexport { CollectionTile } from './src/tiles/grid/collection-tile';\nexport { AccountTile } from './src/tiles/grid/account-tile';\nexport { ItemTile } from './src/tiles/grid/item-tile';\nexport { TileList } from './src/tiles/list/tile-list';\nexport { TileListCompact } from './src/tiles/list/tile-list-compact';\nexport { TileDispatcher } from './src/tiles/tile-dispatcher';\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kDAAkD,CAAC;AAG/F,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAEL,SAAS,EACT,SAAS,EAGT,wBAAwB,GACzB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,4BAA4B,EAAE,MAAM,6CAA6C,CAAC;AAC3F,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAM7D,cAAc,uDAAuD,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,6DAA6D,CAAC","sourcesContent":["export { CollectionBrowser } from './src/collection-browser';\nexport { CollectionBrowserDataSource } from './src/data-source/collection-browser-data-source';\nexport { CollectionBrowserDataSourceInterface } from './src/data-source/collection-browser-data-source-interface';\nexport { CollectionBrowserQueryState } from './src/data-source/collection-browser-query-state';\nexport { SortFilterBar } from './src/sort-filter-bar/sort-filter-bar';\nexport {\n CollectionDisplayMode,\n SortField,\n TileModel,\n FacetOption,\n SelectedFacets,\n getDefaultSelectedFacets,\n} from './src/models';\nexport { CollectionBrowserLoadingTile } from './src/tiles/collection-browser-loading-tile';\nexport { CollectionTile } from './src/tiles/grid/collection-tile';\nexport { AccountTile } from './src/tiles/grid/account-tile';\nexport { ItemTile } from './src/tiles/grid/item-tile';\nexport { TileList } from './src/tiles/list/tile-list';\nexport { TileListCompact } from './src/tiles/list/tile-list-compact';\nexport { TileDispatcher } from './src/tiles/tile-dispatcher';\nexport {\n SmartQueryHeuristic,\n KeywordFacetMap,\n SmartFacet,\n} from './src/collection-facets/smart-facets/models';\nexport * from './src/collection-facets/smart-facets/heuristics/index';\nexport { SmartQueryHeuristicGroup } from './src/collection-facets/smart-facets/smart-facet-heuristics';\n"]}

package/dist/src/collection-facets/smart-facets/heuristics/{browser-language-heuristic.d.ts → browser-language/browser-language-heuristic.d.ts} RENAMED Viewed

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

package/dist/src/collection-facets/smart-facets/heuristics/browser-language/browser-language-heuristic.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"browser-language-heuristic.js","sourceRoot":"","sources":["../../../../../../src/collection-facets/smart-facets/heuristics/browser-language/browser-language-heuristic.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,wBAAwB;IACnC,KAAK,CAAC,oBAAoB;QACxB,MAAM,mBAAmB,GAAG,SAAS,CAAC,QAAQ,CAAC;QAC/C,MAAM,YAAY,GAChB,wBAAwB,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;QACvE,IAAI,CAAC,YAAY;YAAE,OAAO,EAAE,CAAC;QAE7B,OAAO;YACL;gBACE,MAAM,EAAE;oBACN;wBACE,SAAS,EAAE,UAAU;wBACrB,SAAS,EAAE,YAAY;qBACxB;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,QAAgB;QACpD,mEAAmE;QACnE,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC;IAC9E,CAAC;CACF","sourcesContent":["import type { SmartQueryHeuristic, SmartFacet } from '../../models';\n\nexport class BrowserLanguageHeuristic implements SmartQueryHeuristic {\n async getRecommendedFacets(): Promise<SmartFacet[]> {\n const browserLanguageCode = navigator.language;\n const languageName =\n BrowserLanguageHeuristic.getLanguageDisplayName(browserLanguageCode);\n if (!languageName) return [];\n\n return [\n {\n facets: [\n {\n facetType: 'language',\n bucketKey: languageName,\n },\n ],\n },\n ];\n }\n\n private static getLanguageDisplayName(langCode: string): string | undefined {\n // Strip off any script/region/variant codes for greater generality\n const languageOnly = langCode.split('-')[0];\n return new Intl.DisplayNames(['en'], { type: 'language' }).of(languageOnly);\n }\n}\n"]}

package/dist/src/collection-facets/smart-facets/heuristics/index.d.ts ADDED Viewed

@@ -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';

package/dist/src/collection-facets/smart-facets/heuristics/index.js ADDED Viewed

@@ -0,0 +1,4 @@
+export { BrowserLanguageHeuristic } from './browser-language/browser-language-heuristic';
+export { QueryKeywordsHeuristic } from './query-keywords/query-keywords-heuristic';
+export { WikidataHeuristic } from './wikidata/wikidata-heuristic';
+//# sourceMappingURL=index.js.map

package/dist/src/collection-facets/smart-facets/heuristics/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/collection-facets/smart-facets/heuristics/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,EAAE,sBAAsB,EAAE,MAAM,2CAA2C,CAAC;AACnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC","sourcesContent":["export { BrowserLanguageHeuristic } from './browser-language/browser-language-heuristic';\nexport { QueryKeywordsHeuristic } from './query-keywords/query-keywords-heuristic';\nexport { WikidataHeuristic } from './wikidata/wikidata-heuristic';\n"]}

package/dist/src/collection-facets/smart-facets/heuristics/{query-keywords-heuristic.d.ts → query-keywords/query-keywords-heuristic.d.ts} RENAMED Viewed

@@ -1,5 +1,4 @@
-import type { SmartQueryHeuristic, SmartFacet } from '../models';
+import type { SmartQueryHeuristic, SmartFacet } from '../../models';
 export declare class QueryKeywordsHeuristic implements SmartQueryHeuristic {
-    private static readonly KEYWORDS;
     getRecommendedFacets(query: string): Promise<SmartFacet[]>;
 }

package/dist/src/collection-facets/smart-facets/heuristics/query-keywords/query-keywords-heuristic.js ADDED Viewed

@@ -0,0 +1,14 @@
+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 {
+    async getRecommendedFacets(query) {
+        const recommendations = [];
+        for (const [keyword, facets] of Object.entries(QUERY_KEYWORDS)) {
+            if (query.includes(keyword)) {
+                recommendations.push(...facets);
+            }
+        }
+        return recommendations;
+    }
+}
+//# sourceMappingURL=query-keywords-heuristic.js.map

package/dist/src/collection-facets/smart-facets/heuristics/query-keywords/query-keywords-heuristic.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"query-keywords-heuristic.js","sourceRoot":"","sources":["../../../../../../src/collection-facets/smart-facets/heuristics/query-keywords/query-keywords-heuristic.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,gFAAgF;AAChF,MAAM,OAAO,sBAAsB;IACjC,KAAK,CAAC,oBAAoB,CAAC,KAAa;QACtC,MAAM,eAAe,GAAiB,EAAE,CAAC;QAEzC,KAAK,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YAC/D,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5B,eAAe,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;CACF","sourcesContent":["import type { SmartQueryHeuristic, SmartFacet } from '../../models';\nimport { QUERY_KEYWORDS } from './query-keywords-map';\n\n// If the query contains X keyword but Y facet isn't selected, recommend facet Y\nexport class QueryKeywordsHeuristic implements SmartQueryHeuristic {\n async getRecommendedFacets(query: string): Promise<SmartFacet[]> {\n const recommendations: SmartFacet[] = [];\n\n for (const [keyword, facets] of Object.entries(QUERY_KEYWORDS)) {\n if (query.includes(keyword)) {\n recommendations.push(...facets);\n }\n }\n\n return recommendations;\n }\n}\n"]}

package/dist/src/collection-facets/smart-facets/heuristics/query-keywords/query-keywords-map.d.ts ADDED Viewed

@@ -0,0 +1,6 @@
+import type { KeywordFacetMap } from '../../models';
+/**
+ * Map from keywords found in the search query to an array of
+ * likely-relevant "smart facets" for those keywords.
+ */
+export declare const QUERY_KEYWORDS: Readonly<KeywordFacetMap>;

package/dist/src/collection-facets/smart-facets/heuristics/{query-keywords-heuristic.js → query-keywords/query-keywords-map.js} RENAMED Viewed

@@ -1,16 +1,8 @@
-// If the query contains X word but Y facet isn't selected, recommend facet Y
-export class QueryKeywordsHeuristic {
-    async getRecommendedFacets(query) {
-        const recommendations = [];
-        for (const [keyword, facets] of Object.entries(QueryKeywordsHeuristic.KEYWORDS)) {
-            if (query.includes(keyword)) {
-                recommendations.push(...facets);
-            }
-        }
-        return recommendations;
-    }
-}
-QueryKeywordsHeuristic.KEYWORDS = {
+/**
+ * Map from keywords found in the search query to an array of
+ * likely-relevant "smart facets" for those keywords.
+ */
+export const QUERY_KEYWORDS = {
     text: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
     book: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
     pdf: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
@@ -37,9 +29,7 @@ QueryKeywordsHeuristic.KEYWORDS = {
     game: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],
     etree: [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],
     concert: [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],
-    'live music': [
-        { facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] },
-    ],
+    'live music': [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],
     dataset: [{ facets: [{ facetType: 'mediatype', bucketKey: 'data' }] }],
 };
-//# sourceMappingURL=query-keywords-heuristic.js.map
+//# sourceMappingURL=query-keywords-map.js.map

package/dist/src/collection-facets/smart-facets/heuristics/query-keywords/query-keywords-map.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"query-keywords-map.js","sourceRoot":"","sources":["../../../../../../src/collection-facets/smart-facets/heuristics/query-keywords/query-keywords-map.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAA8B;IACvD,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACpE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACpE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACnE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACpE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACpE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACtE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACvE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,MAAM,EAAE;QACN,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;QAC5D,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE;KAC9D;IACD,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IACtE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IACtE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IACrE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACvE,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IAC3E,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IACtE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IAC1E,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IACvE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACvE,YAAY,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IAC5E,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;CACvE,CAAC","sourcesContent":["import type { KeywordFacetMap } from '../../models';\n\n/**\n * Map from keywords found in the search query to an array of\n * likely-relevant \"smart facets\" for those keywords.\n */\nexport const QUERY_KEYWORDS: Readonly<KeywordFacetMap> = {\n text: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n book: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n pdf: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n epub: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n audio: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n song: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n music: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n listen: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n podcast: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n radio: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n stream: [\n { facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] },\n { facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] },\n ],\n video: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],\n movie: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],\n film: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],\n image: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],\n photo: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],\n picture: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],\n software: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],\n app: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],\n program: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],\n game: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],\n etree: [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],\n concert: [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],\n 'live music': [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],\n dataset: [{ facets: [{ facetType: 'mediatype', bucketKey: 'data' }] }],\n};\n"]}

package/dist/src/collection-facets/smart-facets/heuristics/wikidata/wikidata-entity-map.d.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import type { KeywordFacetMap } from '../../models';
+/**
+ * Map from Wikidata description keywords for a given entity to a
+ * set of likely-relevant "smart facets" for that query.
+ *
+ * The placeholder string "__QUERY" should be substituted for the actual
+ * queried entity when generating facet values.
+ */
+export declare const WIKIDATA_ENTITIES: Readonly<KeywordFacetMap>;

package/dist/src/collection-facets/smart-facets/heuristics/{wikidata-heuristic.js → wikidata/wikidata-entity-map.js} RENAMED Viewed

@@ -1,51 +1,11 @@
-// If wikidata describes the top query result as X, recommend facet Y, e.g.:
-// X              Y
-// written work   mt:texts
-// film           mt:movies
-// author         mt:texts and creator:<query>
-// filmmaker      mt:movies and creator:<query>
-// photographer   mt:image and creator:<query>
-// visual artist  mt:image and creator:<query>
-// etc.
-export class WikidataHeuristic {
-    async getRecommendedFacets(query) {
-        var _a;
-        const recommendations = [];
-        try {
-            const urlQuery = encodeURIComponent(query);
-            const wikidataResponse = await fetch(`https://www.wikidata.org/w/api.php?action=wbsearchentities&search=${urlQuery}&format=json&language=en&uselang=en&origin=*&type=item&limit=5`);
-            const searchResults = await wikidataResponse.json();
-            for (const [keyword, facets] of Object.entries(WikidataHeuristic.ENTITIES)) {
-                const keywordRegex = new RegExp(`\\b${keyword}\\b`);
-                if (keywordRegex.test((_a = searchResults.search[0]) === null || _a === void 0 ? void 0 : _a.description)) {
-                    const entityName = searchResults.search[0].label;
-                    recommendations.push(...facets.map(sf => {
-                        var _a;
-                        return ({
-                            label: (_a = sf.label) === null || _a === void 0 ? void 0 : _a.replace('__QUERY', entityName),
-                            facets: sf.facets.map(f => {
-                                var _a;
-                                const replaced = {
-                                    ...f,
-                                    bucketKey: f.bucketKey.replace('__QUERY', query),
-                                };
-                                if (f.displayText) {
-                                    replaced.displayText = (_a = replaced.displayText) === null || _a === void 0 ? void 0 : _a.replace('__QUERY', entityName);
-                                }
-                                return replaced;
-                            }),
-                        });
-                    }));
-                }
-            }
-            return recommendations;
-        }
-        catch (_b) {
-            return [];
-        }
-    }
-}
-WikidataHeuristic.ENTITIES = {
+/**
+ * Map from Wikidata description keywords for a given entity to a
+ * set of likely-relevant "smart facets" for that query.
+ *
+ * The placeholder string "__QUERY" should be substituted for the actual
+ * queried entity when generating facet values.
+ */
+export const WIKIDATA_ENTITIES = {
     'written work': [
         { facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] },
     ],
@@ -170,4 +130,4 @@ WikidataHeuristic.ENTITIES = {
         },
     ],
 };
-//# sourceMappingURL=wikidata-heuristic.js.map
+//# sourceMappingURL=wikidata-entity-map.js.map

package/dist/src/collection-facets/smart-facets/heuristics/wikidata/wikidata-entity-map.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"wikidata-entity-map.js","sourceRoot":"","sources":["../../../../../../src/collection-facets/smart-facets/heuristics/wikidata/wikidata-entity-map.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAA8B;IAC1D,cAAc,EAAE;QACd,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;KAC7D;IACD,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IAC1E,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACpE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,SAAS,EAAE;QACT;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE;gBAC/C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,MAAM,EAAE;QACN;YACE,KAAK,EAAE,oBAAoB;YAC3B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,MAAM,EAAE;QACN;YACE,KAAK,EAAE,oBAAoB;YAC3B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,IAAI,EAAE;QACJ;YACE,KAAK,EAAE,oBAAoB;YAC3B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,YAAY,EAAE;QACZ;YACE,KAAK,EAAE,mBAAmB;YAC1B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,OAAO,EAAE;QACP;YACE,KAAK,EAAE,mBAAmB;YAC1B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,eAAe,EAAE;QACf;YACE,KAAK,EAAE,mBAAmB;YAC1B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,gBAAgB,EAAE;QAChB;YACE,KAAK,EAAE,mBAAmB;YAC1B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,MAAM,EAAE;QACN;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,UAAU,EAAE;QACV;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,QAAQ,EAAE;QACR;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,QAAQ,EAAE;QACR;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,OAAO,EAAE;QACP;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;CACF,CAAC","sourcesContent":["import type { KeywordFacetMap } from '../../models';\n\n/**\n * Map from Wikidata description keywords for a given entity to a\n * set of likely-relevant \"smart facets\" for that query.\n *\n * The placeholder string \"__QUERY\" should be substituted for the actual\n * queried entity when generating facet values.\n */\nexport const WIKIDATA_ENTITIES: Readonly<KeywordFacetMap> = {\n 'written work': [\n { facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] },\n ],\n literature: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n book: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n novel: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n filmmaker: [\n {\n label: 'Films by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'movies' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n author: [\n {\n label: 'Writing by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'texts' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n writer: [\n {\n label: 'Writing by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'texts' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n poet: [\n {\n label: 'Writing by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'texts' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n photographer: [\n {\n label: 'Images by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'image' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n painter: [\n {\n label: 'Images by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'image' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n 'visual artist': [\n {\n label: 'Images by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'image' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n 'graphic artist': [\n {\n label: 'Images by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'image' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n singer: [\n {\n label: 'Music by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'audio' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n songwriter: [\n {\n label: 'Music by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'audio' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n musician: [\n {\n label: 'Music by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'audio' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n composer: [\n {\n label: 'Music by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'audio' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n pianist: [\n {\n label: 'Music by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'audio' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n};\n"]}

package/dist/src/collection-facets/smart-facets/heuristics/wikidata/wikidata-heuristic.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+import type { SmartQueryHeuristic, SmartFacet } from '../../models';
+export declare class WikidataHeuristic implements SmartQueryHeuristic {
+    private readonly WIKIDATA_BASE_URL;
+    private readonly WIKIDATA_DEFAULT_ARGS;
+    /**
+     * Returns the full URL for a Wikidata search for the given query
+     * @param query The query to search for
+     */
+    private getWikidataURL;
+    /**
+     * Replaces query placeholders with an actual query string, within a collection of smart facets
+     * @param smartFacets The array of smart facets
+     * @param query The query string to replace placeholders with
+     * @returns A new array of smart facets with all query placeholders replaced
+     */
+    private replaceQueryPlaceholders;
+    /**
+     * @inheritdoc
+     */
+    getRecommendedFacets(query: string): Promise<SmartFacet[]>;
+}

package/dist/src/collection-facets/smart-facets/heuristics/wikidata/wikidata-heuristic.js ADDED Viewed

@@ -0,0 +1,75 @@
+import { WIKIDATA_ENTITIES } from './wikidata-entity-map';
+// If wikidata describes the top query result as X, recommend facet Y, e.g.:
+// X              Y
+// written work   mt:texts
+// film           mt:movies
+// author         mt:texts and creator:<query>
+// filmmaker      mt:movies and creator:<query>
+// photographer   mt:image and creator:<query>
+// visual artist  mt:image and creator:<query>
+// etc.
+export class WikidataHeuristic {
+    constructor() {
+        this.WIKIDATA_BASE_URL = 'https://www.wikidata.org/w/api.php';
+        this.WIKIDATA_DEFAULT_ARGS = '?action=wbsearchentities&format=json&language=en&uselang=en&origin=*&type=item&limit=5';
+    }
+    /**
+     * Returns the full URL for a Wikidata search for the given query
+     * @param query The query to search for
+     */
+    getWikidataURL(query) {
+        const urlQuery = encodeURIComponent(query);
+        return `${this.WIKIDATA_BASE_URL}${this.WIKIDATA_DEFAULT_ARGS}&search=${urlQuery}`;
+    }
+    /**
+     * Replaces query placeholders with an actual query string, within a collection of smart facets
+     * @param smartFacets The array of smart facets
+     * @param query The query string to replace placeholders with
+     * @returns A new array of smart facets with all query placeholders replaced
+     */
+    replaceQueryPlaceholders(smartFacets, query) {
+        return smartFacets.map(smartFacet => {
+            var _a;
+            return ({
+                // Replace placeholders within the smart facet label
+                label: (_a = smartFacet.label) === null || _a === void 0 ? void 0 : _a.replace('__QUERY', query),
+                // Replace placeholders within the facets themselves (buckets & display text)
+                facets: smartFacet.facets.map(facet => {
+                    var _a;
+                    const replaced = {
+                        ...facet,
+                        bucketKey: facet.bucketKey.replace('__QUERY', query),
+                    };
+                    if (facet.displayText) {
+                        replaced.displayText = (_a = replaced.displayText) === null || _a === void 0 ? void 0 : _a.replace('__QUERY', query);
+                    }
+                    return replaced;
+                }),
+            });
+        });
+    }
+    /**
+     * @inheritdoc
+     */
+    async getRecommendedFacets(query) {
+        var _a;
+        const recommendations = [];
+        try {
+            const wikidataURL = this.getWikidataURL(query);
+            const wikidataResponse = await fetch(wikidataURL);
+            const searchResults = await wikidataResponse.json();
+            for (const [keyword, facets] of Object.entries(WIKIDATA_ENTITIES)) {
+                const keywordRegex = new RegExp(`\\b${keyword}\\b`);
+                if (keywordRegex.test((_a = searchResults.search[0]) === null || _a === void 0 ? void 0 : _a.description)) {
+                    const entityName = searchResults.search[0].label;
+                    recommendations.push(...this.replaceQueryPlaceholders(facets, entityName));
+                }
+            }
+            return recommendations;
+        }
+        catch (err) {
+            return [];
+        }
+    }
+}
+//# sourceMappingURL=wikidata-heuristic.js.map

package/dist/src/collection-facets/smart-facets/heuristics/wikidata/wikidata-heuristic.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"wikidata-heuristic.js","sourceRoot":"","sources":["../../../../../../src/collection-facets/smart-facets/heuristics/wikidata/wikidata-heuristic.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE1D,4EAA4E;AAC5E,mBAAmB;AACnB,0BAA0B;AAC1B,2BAA2B;AAC3B,8CAA8C;AAC9C,+CAA+C;AAC/C,8CAA8C;AAC9C,8CAA8C;AAC9C,OAAO;AACP,MAAM,OAAO,iBAAiB;IAA9B;QACmB,sBAAiB,GAAG,oCAAoC,CAAC;QAEzD,0BAAqB,GACpC,wFAAwF,CAAC;IAwE7F,CAAC;IAtEC;;;OAGG;IACK,cAAc,CAAC,KAAa;QAClC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC3C,OAAO,GAAG,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,qBAAqB,WAAW,QAAQ,EAAE,CAAC;IACrF,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAC9B,WAAyB,EACzB,KAAa;QAEb,OAAO,WAAW,CAAC,GAAG,CACpB,UAAU,CAAC,EAAE;;YACX,OAAA,CAAC;gBACC,oDAAoD;gBACpD,KAAK,EAAE,MAAA,UAAU,CAAC,KAAK,0CAAE,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC;gBAClD,6EAA6E;gBAC7E,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;;oBACpC,MAAM,QAAQ,GAAG;wBACf,GAAG,KAAK;wBACR,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC;qBACrD,CAAC;oBAEF,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;wBACtB,QAAQ,CAAC,WAAW,GAAG,MAAA,QAAQ,CAAC,WAAW,0CAAE,OAAO,CAClD,SAAS,EACT,KAAK,CACN,CAAC;oBACJ,CAAC;oBAED,OAAO,QAAQ,CAAC;gBAClB,CAAC,CAAC;aACH,CAAe,CAAA;SAAA,CACnB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB,CAAC,KAAa;;QACtC,MAAM,eAAe,GAAiB,EAAE,CAAC;QAEzC,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC/C,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,WAAW,CAAC,CAAC;YAClD,MAAM,aAAa,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,CAAC;YAEpD,KAAK,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBAClE,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,MAAM,OAAO,KAAK,CAAC,CAAC;gBACpD,IAAI,YAAY,CAAC,IAAI,CAAC,MAAA,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,0CAAE,WAAW,CAAC,EAAE,CAAC;oBAC5D,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;oBACjD,eAAe,CAAC,IAAI,CAClB,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,UAAU,CAAC,CACrD,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,OAAO,eAAe,CAAC;QACzB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;CACF","sourcesContent":["import type { SmartQueryHeuristic, SmartFacet } from '../../models';\nimport { WIKIDATA_ENTITIES } from './wikidata-entity-map';\n\n// If wikidata describes the top query result as X, recommend facet Y, e.g.:\n// X Y\n// written work mt:texts\n// film mt:movies\n// author mt:texts and creator:<query>\n// filmmaker mt:movies and creator:<query>\n// photographer mt:image and creator:<query>\n// visual artist mt:image and creator:<query>\n// etc.\nexport class WikidataHeuristic implements SmartQueryHeuristic {\n private readonly WIKIDATA_BASE_URL = 'https://www.wikidata.org/w/api.php';\n\n private readonly WIKIDATA_DEFAULT_ARGS =\n '?action=wbsearchentities&format=json&language=en&uselang=en&origin=*&type=item&limit=5';\n\n /**\n * Returns the full URL for a Wikidata search for the given query\n * @param query The query to search for\n */\n private getWikidataURL(query: string): string {\n const urlQuery = encodeURIComponent(query);\n return `${this.WIKIDATA_BASE_URL}${this.WIKIDATA_DEFAULT_ARGS}&search=${urlQuery}`;\n }\n\n /**\n * Replaces query placeholders with an actual query string, within a collection of smart facets\n * @param smartFacets The array of smart facets\n * @param query The query string to replace placeholders with\n * @returns A new array of smart facets with all query placeholders replaced\n */\n private replaceQueryPlaceholders(\n smartFacets: SmartFacet[],\n query: string,\n ): SmartFacet[] {\n return smartFacets.map(\n smartFacet =>\n ({\n // Replace placeholders within the smart facet label\n label: smartFacet.label?.replace('__QUERY', query),\n // Replace placeholders within the facets themselves (buckets & display text)\n facets: smartFacet.facets.map(facet => {\n const replaced = {\n ...facet,\n bucketKey: facet.bucketKey.replace('__QUERY', query),\n };\n\n if (facet.displayText) {\n replaced.displayText = replaced.displayText?.replace(\n '__QUERY',\n query,\n );\n }\n\n return replaced;\n }),\n }) as SmartFacet,\n );\n }\n\n /**\n * @inheritdoc\n */\n async getRecommendedFacets(query: string): Promise<SmartFacet[]> {\n const recommendations: SmartFacet[] = [];\n\n try {\n const wikidataURL = this.getWikidataURL(query);\n const wikidataResponse = await fetch(wikidataURL);\n const searchResults = await wikidataResponse.json();\n\n for (const [keyword, facets] of Object.entries(WIKIDATA_ENTITIES)) {\n const keywordRegex = new RegExp(`\\\\b${keyword}\\\\b`);\n if (keywordRegex.test(searchResults.search[0]?.description)) {\n const entityName = searchResults.search[0].label;\n recommendations.push(\n ...this.replaceQueryPlaceholders(facets, entityName),\n );\n }\n }\n\n return recommendations;\n } catch (err) {\n return [];\n }\n }\n}\n"]}

package/dist/src/collection-facets/smart-facets/models.d.ts CHANGED Viewed

@@ -21,6 +21,10 @@ export interface SmartFacetEvent {
 }
 export type KeywordFacetMap = Record<string, SmartFacet[]>;
 export interface SmartQueryHeuristic {
+    /**
+     * Resolves to a recommended set of facets to apply for the given query
+     * @param query The search query to recommend facets for
+     */
     getRecommendedFacets(query: string): Promise<SmartFacet[]>;
 }
 export {};

package/dist/src/collection-facets/smart-facets/models.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../src/collection-facets/smart-facets/models.ts"],"names":[],"mappings":"","sourcesContent":["import type { FacetEventDetails, FacetOption } from '../../models';\n\nexport interface FacetRef {\n facetType: FacetOption;\n bucketKey: string;\n displayText?: string;\n}\n\ninterface LabeledSmartFacet {\n label: string;\n facets: FacetRef[];\n selected?: boolean;\n}\n\ninterface UnlabeledSmartFacet {\n label?: string;\n facets: [FacetRef];\n selected?: boolean;\n}\n\nexport type SmartFacet = LabeledSmartFacet \| UnlabeledSmartFacet;\n\nexport interface SmartFacetEvent {\n smartFacet: SmartFacet;\n details: FacetEventDetails[];\n}\n\nexport type KeywordFacetMap = Record<string, SmartFacet[]>;\n\nexport interface SmartQueryHeuristic {\n getRecommendedFacets(query: string): Promise<SmartFacet[]>;\n}\n"]}
1	+ {"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../src/collection-facets/smart-facets/models.ts"],"names":[],"mappings":"","sourcesContent":["import type { FacetEventDetails, FacetOption } from '../../models';\n\nexport interface FacetRef {\n facetType: FacetOption;\n bucketKey: string;\n displayText?: string;\n}\n\ninterface LabeledSmartFacet {\n label: string;\n facets: FacetRef[];\n selected?: boolean;\n}\n\ninterface UnlabeledSmartFacet {\n label?: string;\n facets: [FacetRef];\n selected?: boolean;\n}\n\nexport type SmartFacet = LabeledSmartFacet \| UnlabeledSmartFacet;\n\nexport interface SmartFacetEvent {\n smartFacet: SmartFacet;\n details: FacetEventDetails[];\n}\n\nexport type KeywordFacetMap = Record<string, SmartFacet[]>;\n\nexport interface SmartQueryHeuristic {\n /*\n Resolves to a recommended set of facets to apply for the given query\n * @param query The search query to recommend facets for\n */\n getRecommendedFacets(query: string): Promise<SmartFacet[]>;\n}\n"]}

package/dist/src/collection-facets/smart-facets/smart-facet-heuristics.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 import type { SmartFacet, SmartQueryHeuristic } from './models';
 export declare class SmartQueryHeuristicGroup implements SmartQueryHeuristic {
-    private static readonly HEURISTICS;
-    getRecommendedFacets(query: string): Promise<SmartFacet[]>;
+    private static readonly DEFAULT_HEURISTICS;
+    getRecommendedFacets(query: string, heuristics?: (new () => SmartQueryHeuristic)[]): Promise<SmartFacet[]>;
 }

package/dist/src/collection-facets/smart-facets/smart-facet-heuristics.js CHANGED Viewed

@@ -1,16 +1,18 @@
 import { dedupe } from './dedupe';
-import { BrowserLanguageHeuristic } from './heuristics/browser-language-heuristic';
-import { QueryKeywordsHeuristic } from './heuristics/query-keywords-heuristic';
-import { WikidataHeuristic } from './heuristics/wikidata-heuristic';
+import { BrowserLanguageHeuristic } from './heuristics/browser-language/browser-language-heuristic';
+import { QueryKeywordsHeuristic } from './heuristics/query-keywords/query-keywords-heuristic';
+import { WikidataHeuristic } from './heuristics/wikidata/wikidata-heuristic';
 export class SmartQueryHeuristicGroup {
-    async getRecommendedFacets(query) {
-        const promises = SmartQueryHeuristicGroup.HEURISTICS.map(HeuristicCtor => new HeuristicCtor().getRecommendedFacets(query));
+    async getRecommendedFacets(query, heuristics = SmartQueryHeuristicGroup.DEFAULT_HEURISTICS) {
+        const promises = heuristics.map(HeuristicCtor => new HeuristicCtor().getRecommendedFacets(query));
         return dedupe((await Promise.all(promises)).flat());
     }
 }
-SmartQueryHeuristicGroup.HEURISTICS = [
+// Avoid collapsing the array onto one line
+// prettier-ignore
+SmartQueryHeuristicGroup.DEFAULT_HEURISTICS = [
     QueryKeywordsHeuristic,
     WikidataHeuristic,
-    BrowserLanguageHeuristic,
+    BrowserLanguageHeuristic
 ];
 //# sourceMappingURL=smart-facet-heuristics.js.map

package/dist/src/collection-facets/smart-facets/smart-facet-heuristics.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"smart-facet-heuristics.js","sourceRoot":"","sources":["../../../../src/collection-facets/smart-facets/smart-facet-heuristics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,wBAAwB,EAAE,MAAM,~~yCAAyC~~,CAAC;~~AACnF~~,OAAO,EAAE,sBAAsB,EAAE,MAAM,~~uCAAuC~~,CAAC;~~AAC/E~~,OAAO,EAAE,iBAAiB,EAAE,MAAM,~~iCAAiC~~,CAAC;~~AAGpE~~,MAAM,OAAO,wBAAwB;~~IAOnC~~,KAAK,CAAC,oBAAoB,~~CAAC~~,KAAa~~;QACtC~~,~~MAAM~~,~~QAAQ~~,GAAG,wBAAwB,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,~~CACvE~~,IAAI,aAAa,EAAE,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAChD,CAAC;QAEF,OAAO,MAAM,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC;;~~AAZuB~~,~~mCAAU~~,~~GAAG~~;~~IACnC~~,sBAAsB;IACtB,iBAAiB;IACjB,wBAAwB;CACzB,CAAC","sourcesContent":["import { dedupe } from './dedupe';\nimport { BrowserLanguageHeuristic } from './heuristics/browser-language-heuristic';\nimport { QueryKeywordsHeuristic } from './heuristics/query-keywords-heuristic';\nimport { WikidataHeuristic } from './heuristics/wikidata-heuristic';\nimport type { SmartFacet, SmartQueryHeuristic } from './models';\n\nexport class SmartQueryHeuristicGroup implements SmartQueryHeuristic {\n private static readonly ~~HEURISTICS~~ = [\n QueryKeywordsHeuristic,\n WikidataHeuristic,\n BrowserLanguageHeuristic,\n ];\n\n async getRecommendedFacets(query: string): Promise<SmartFacet[]> {\n const promises = ~~SmartQueryHeuristicGroup~~.~~HEURISTICS.~~map(HeuristicCtor =>\n new HeuristicCtor().getRecommendedFacets(query),\n );\n\n return dedupe((await Promise.all(promises)).flat());\n }\n}\n"]}
1	+ {"version":3,"file":"smart-facet-heuristics.js","sourceRoot":"","sources":["../../../../src/collection-facets/smart-facets/smart-facet-heuristics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,wBAAwB,EAAE,MAAM,0DAA0D,CAAC;AACpG,OAAO,EAAE,sBAAsB,EAAE,MAAM,sDAAsD,CAAC;AAC9F,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAG7E,MAAM,OAAO,wBAAwB;IASnC,KAAK,CAAC,oBAAoB,CACxB,KAAa,EACb,UAAU,GAAG,wBAAwB,CAAC,kBAAkB;QAExD,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAC9C,IAAI,aAAa,EAAE,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAChD,CAAC;QAEF,OAAO,MAAM,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC;;AAjBD,2CAA2C;AAC3C,kBAAkB;AACM,2CAAkB,GAAsC;IAC9E,sBAAsB;IACtB,iBAAiB;IACjB,wBAAwB;CACzB,CAAC","sourcesContent":["import { dedupe } from './dedupe';\nimport { BrowserLanguageHeuristic } from './heuristics/browser-language/browser-language-heuristic';\nimport { QueryKeywordsHeuristic } from './heuristics/query-keywords/query-keywords-heuristic';\nimport { WikidataHeuristic } from './heuristics/wikidata/wikidata-heuristic';\nimport type { SmartFacet, SmartQueryHeuristic } from './models';\n\nexport class SmartQueryHeuristicGroup implements SmartQueryHeuristic {\n // Avoid collapsing the array onto one line\n // prettier-ignore\n private static readonly DEFAULT_HEURISTICS: (new () => SmartQueryHeuristic)[] = [\n QueryKeywordsHeuristic,\n WikidataHeuristic,\n BrowserLanguageHeuristic\n ];\n\n async getRecommendedFacets(\n query: string,\n heuristics = SmartQueryHeuristicGroup.DEFAULT_HEURISTICS\n ): Promise<SmartFacet[]> {\n const promises = heuristics.map(HeuristicCtor =>\n new HeuristicCtor().getRecommendedFacets(query)\n );\n\n return dedupe((await Promise.all(promises)).flat());\n }\n}\n"]}

package/index.ts CHANGED Viewed

@@ -3,7 +3,14 @@ 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';
@@ -11,3 +18,10 @@ 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';

package/package.json CHANGED Viewed

@@ -3,7 +3,7 @@
   "description": "The Internet Archive Collection Browser.",
   "license": "AGPL-3.0-only",
   "author": "Internet Archive",
-  "version": "2.8.0",
+  "version": "2.8.1-alpha-webdev7002.0",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "scripts": {

package/src/collection-facets/smart-facets/heuristics/{browser-language-heuristic.ts → browser-language/browser-language-heuristic.ts} RENAMED Viewed

@@ -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[]> {

package/src/collection-facets/smart-facets/heuristics/index.ts ADDED Viewed

@@ -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';

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

@@ -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;
+  }
+}

package/src/collection-facets/smart-facets/heuristics/query-keywords/query-keywords-map.ts ADDED Viewed

@@ -0,0 +1,36 @@
+import type { KeywordFacetMap } from '../../models';
+/**
+ * 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: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
+  book: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
+  pdf: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
+  epub: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
+  audio: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
+  song: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
+  music: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
+  listen: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
+  podcast: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
+  radio: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
+  stream: [
+    { facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] },
+    { facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] },
+  ],
+  video: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],
+  movie: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],
+  film: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],
+  image: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],
+  photo: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],
+  picture: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],
+  software: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],
+  app: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],
+  program: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],
+  game: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],
+  etree: [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],
+  concert: [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],
+  'live music': [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],
+  dataset: [{ facets: [{ facetType: 'mediatype', bucketKey: 'data' }] }],
+};

package/src/collection-facets/smart-facets/heuristics/wikidata/wikidata-entity-map.ts ADDED Viewed

@@ -0,0 +1,134 @@
+import type { KeywordFacetMap } from '../../models';
+/**
+ * Map from Wikidata description keywords for a given entity to a
+ * set of likely-relevant "smart facets" for that query.
+ *
+ * The placeholder string "__QUERY" should be substituted for the actual
+ * queried entity when generating facet values.
+ */
+export const WIKIDATA_ENTITIES: Readonly<KeywordFacetMap> = {
+  'written work': [
+    { facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] },
+  ],
+  literature: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
+  book: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
+  novel: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
+  filmmaker: [
+    {
+      label: 'Films by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'movies' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  author: [
+    {
+      label: 'Writing by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'texts' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  writer: [
+    {
+      label: 'Writing by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'texts' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  poet: [
+    {
+      label: 'Writing by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'texts' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  photographer: [
+    {
+      label: 'Images by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'image' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  painter: [
+    {
+      label: 'Images by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'image' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  'visual artist': [
+    {
+      label: 'Images by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'image' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  'graphic artist': [
+    {
+      label: 'Images by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'image' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  singer: [
+    {
+      label: 'Music by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'audio' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  songwriter: [
+    {
+      label: 'Music by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'audio' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  musician: [
+    {
+      label: 'Music by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'audio' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  composer: [
+    {
+      label: 'Music by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'audio' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+  pianist: [
+    {
+      label: 'Music by __QUERY',
+      facets: [
+        { facetType: 'mediatype', bucketKey: 'audio' },
+        { facetType: 'creator', bucketKey: '__QUERY' },
+      ],
+    },
+  ],
+};

package/src/collection-facets/smart-facets/heuristics/wikidata/wikidata-heuristic.ts ADDED Viewed

@@ -0,0 +1,89 @@
+import type { SmartQueryHeuristic, SmartFacet } from '../../models';
+import { WIKIDATA_ENTITIES } from './wikidata-entity-map';
+// If wikidata describes the top query result as X, recommend facet Y, e.g.:
+// X              Y
+// written work   mt:texts
+// film           mt:movies
+// author         mt:texts and creator:<query>
+// filmmaker      mt:movies and creator:<query>
+// photographer   mt:image and creator:<query>
+// visual artist  mt:image and creator:<query>
+// etc.
+export class WikidataHeuristic implements SmartQueryHeuristic {
+  private readonly WIKIDATA_BASE_URL = 'https://www.wikidata.org/w/api.php';
+  private readonly WIKIDATA_DEFAULT_ARGS =
+    '?action=wbsearchentities&format=json&language=en&uselang=en&origin=*&type=item&limit=5';
+  /**
+   * Returns the full URL for a Wikidata search for the given query
+   * @param query The query to search for
+   */
+  private getWikidataURL(query: string): string {
+    const urlQuery = encodeURIComponent(query);
+    return `${this.WIKIDATA_BASE_URL}${this.WIKIDATA_DEFAULT_ARGS}&search=${urlQuery}`;
+  }
+  /**
+   * Replaces query placeholders with an actual query string, within a collection of smart facets
+   * @param smartFacets The array of smart facets
+   * @param query The query string to replace placeholders with
+   * @returns A new array of smart facets with all query placeholders replaced
+   */
+  private replaceQueryPlaceholders(
+    smartFacets: SmartFacet[],
+    query: string,
+  ): SmartFacet[] {
+    return smartFacets.map(
+      smartFacet =>
+        ({
+          // Replace placeholders within the smart facet label
+          label: smartFacet.label?.replace('__QUERY', query),
+          // Replace placeholders within the facets themselves (buckets & display text)
+          facets: smartFacet.facets.map(facet => {
+            const replaced = {
+              ...facet,
+              bucketKey: facet.bucketKey.replace('__QUERY', query),
+            };
+            if (facet.displayText) {
+              replaced.displayText = replaced.displayText?.replace(
+                '__QUERY',
+                query,
+              );
+            }
+            return replaced;
+          }),
+        }) as SmartFacet,
+    );
+  }
+  /**
+   * @inheritdoc
+   */
+  async getRecommendedFacets(query: string): Promise<SmartFacet[]> {
+    const recommendations: SmartFacet[] = [];
+    try {
+      const wikidataURL = this.getWikidataURL(query);
+      const wikidataResponse = await fetch(wikidataURL);
+      const searchResults = await wikidataResponse.json();
+      for (const [keyword, facets] of Object.entries(WIKIDATA_ENTITIES)) {
+        const keywordRegex = new RegExp(`\\b${keyword}\\b`);
+        if (keywordRegex.test(searchResults.search[0]?.description)) {
+          const entityName = searchResults.search[0].label;
+          recommendations.push(
+            ...this.replaceQueryPlaceholders(facets, entityName),
+          );
+        }
+      }
+      return recommendations;
+    } catch (err) {
+      return [];
+    }
+  }
+}

package/src/collection-facets/smart-facets/models.ts CHANGED Viewed

@@ -28,5 +28,9 @@ export interface SmartFacetEvent {
 export type KeywordFacetMap = Record<string, SmartFacet[]>;
 export interface SmartQueryHeuristic {
+  /**
+   * Resolves to a recommended set of facets to apply for the given query
+   * @param query The search query to recommend facets for
+   */
   getRecommendedFacets(query: string): Promise<SmartFacet[]>;
 }

package/src/collection-facets/smart-facets/smart-facet-heuristics.ts CHANGED Viewed

@@ -1,19 +1,24 @@
 import { dedupe } from './dedupe';
-import { BrowserLanguageHeuristic } from './heuristics/browser-language-heuristic';
-import { QueryKeywordsHeuristic } from './heuristics/query-keywords-heuristic';
-import { WikidataHeuristic } from './heuristics/wikidata-heuristic';
+import { BrowserLanguageHeuristic } from './heuristics/browser-language/browser-language-heuristic';
+import { QueryKeywordsHeuristic } from './heuristics/query-keywords/query-keywords-heuristic';
+import { WikidataHeuristic } from './heuristics/wikidata/wikidata-heuristic';
 import type { SmartFacet, SmartQueryHeuristic } from './models';
 export class SmartQueryHeuristicGroup implements SmartQueryHeuristic {
-  private static readonly HEURISTICS = [
+  // Avoid collapsing the array onto one line
+  // prettier-ignore
+  private static readonly DEFAULT_HEURISTICS: (new () => SmartQueryHeuristic)[] = [
     QueryKeywordsHeuristic,
     WikidataHeuristic,
-    BrowserLanguageHeuristic,
+    BrowserLanguageHeuristic
   ];
-  async getRecommendedFacets(query: string): Promise<SmartFacet[]> {
-    const promises = SmartQueryHeuristicGroup.HEURISTICS.map(HeuristicCtor =>
-      new HeuristicCtor().getRecommendedFacets(query),
+  async getRecommendedFacets(
+    query: string,
+    heuristics = SmartQueryHeuristicGroup.DEFAULT_HEURISTICS
+  ): Promise<SmartFacet[]> {
+    const promises = heuristics.map(HeuristicCtor =>
+      new HeuristicCtor().getRecommendedFacets(query)
     );
     return dedupe((await Promise.all(promises)).flat());

package/dist/src/collection-facets/smart-facets/heuristics/browser-language-heuristic.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"browser-language-heuristic.js","sourceRoot":"","sources":["../../../../../src/collection-facets/smart-facets/heuristics/browser-language-heuristic.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,wBAAwB;IACnC,KAAK,CAAC,oBAAoB;QACxB,MAAM,mBAAmB,GAAG,SAAS,CAAC,QAAQ,CAAC;QAC/C,MAAM,YAAY,GAChB,wBAAwB,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;QACvE,IAAI,CAAC,YAAY;YAAE,OAAO,EAAE,CAAC;QAE7B,OAAO;YACL;gBACE,MAAM,EAAE;oBACN;wBACE,SAAS,EAAE,UAAU;wBACrB,SAAS,EAAE,YAAY;qBACxB;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,QAAgB;QACpD,mEAAmE;QACnE,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC;IAC9E,CAAC;CACF","sourcesContent":["import type { SmartQueryHeuristic, SmartFacet } from '../models';\n\nexport class BrowserLanguageHeuristic implements SmartQueryHeuristic {\n async getRecommendedFacets(): Promise<SmartFacet[]> {\n const browserLanguageCode = navigator.language;\n const languageName =\n BrowserLanguageHeuristic.getLanguageDisplayName(browserLanguageCode);\n if (!languageName) return [];\n\n return [\n {\n facets: [\n {\n facetType: 'language',\n bucketKey: languageName,\n },\n ],\n },\n ];\n }\n\n private static getLanguageDisplayName(langCode: string): string | undefined {\n // Strip off any script/region/variant codes for greater generality\n const languageOnly = langCode.split('-')[0];\n return new Intl.DisplayNames(['en'], { type: 'language' }).of(languageOnly);\n }\n}\n"]}

package/dist/src/collection-facets/smart-facets/heuristics/query-keywords-heuristic.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"query-keywords-heuristic.js","sourceRoot":"","sources":["../../../../../src/collection-facets/smart-facets/heuristics/query-keywords-heuristic.ts"],"names":[],"mappings":"AAMA,6EAA6E;AAC7E,MAAM,OAAO,sBAAsB;IAkCjC,KAAK,CAAC,oBAAoB,CAAC,KAAa;QACtC,MAAM,eAAe,GAAiB,EAAE,CAAC;QAEzC,KAAK,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAC5C,sBAAsB,CAAC,QAAQ,CAChC,EAAE,CAAC;YACF,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5B,eAAe,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;;AA7CuB,+BAAQ,GAAoB;IAClD,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACpE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACpE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACnE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACpE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACpE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACtE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACvE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,MAAM,EAAE;QACN,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;QAC5D,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE;KAC9D;IACD,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IACtE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IACtE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IACrE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACvE,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IAC3E,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IACtE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IAC1E,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IACvE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACvE,YAAY,EAAE;QACZ,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;KAC7D;IACD,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;CACvE,CAAC","sourcesContent":["import type {\n SmartQueryHeuristic,\n KeywordFacetMap,\n SmartFacet,\n} from '../models';\n\n// If the query contains X word but Y facet isn't selected, recommend facet Y\nexport class QueryKeywordsHeuristic implements SmartQueryHeuristic {\n private static readonly KEYWORDS: KeywordFacetMap = {\n text: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n book: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n pdf: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n epub: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n audio: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n song: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n music: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n listen: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n podcast: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n radio: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],\n stream: [\n { facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] },\n { facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] },\n ],\n video: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],\n movie: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],\n film: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],\n image: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],\n photo: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],\n picture: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],\n software: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],\n app: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],\n program: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],\n game: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],\n etree: [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],\n concert: [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],\n 'live music': [\n { facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] },\n ],\n dataset: [{ facets: [{ facetType: 'mediatype', bucketKey: 'data' }] }],\n };\n\n async getRecommendedFacets(query: string): Promise<SmartFacet[]> {\n const recommendations: SmartFacet[] = [];\n\n for (const [keyword, facets] of Object.entries(\n QueryKeywordsHeuristic.KEYWORDS,\n )) {\n if (query.includes(keyword)) {\n recommendations.push(...facets);\n }\n }\n\n return recommendations;\n }\n}\n"]}

package/dist/src/collection-facets/smart-facets/heuristics/wikidata-heuristic.d.ts DELETED Viewed

@@ -1,5 +0,0 @@
-import type { SmartQueryHeuristic, SmartFacet } from '../models';
-export declare class WikidataHeuristic implements SmartQueryHeuristic {
-    private static readonly ENTITIES;
-    getRecommendedFacets(query: string): Promise<SmartFacet[]>;
-}

package/dist/src/collection-facets/smart-facets/heuristics/wikidata-heuristic.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"wikidata-heuristic.js","sourceRoot":"","sources":["../../../../../src/collection-facets/smart-facets/heuristics/wikidata-heuristic.ts"],"names":[],"mappings":"AAMA,4EAA4E;AAC5E,mBAAmB;AACnB,0BAA0B;AAC1B,2BAA2B;AAC3B,8CAA8C;AAC9C,+CAA+C;AAC/C,8CAA8C;AAC9C,8CAA8C;AAC9C,OAAO;AACP,MAAM,OAAO,iBAAiB;IA+H5B,KAAK,CAAC,oBAAoB,CAAC,KAAa;;QACtC,MAAM,eAAe,GAAiB,EAAE,CAAC;QAEzC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAE3C,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAClC,qEAAqE,QAAQ,gEAAgE,CAC9I,CAAC;YACF,MAAM,aAAa,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,CAAC;YAEpD,KAAK,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAC5C,iBAAiB,CAAC,QAAQ,CAC3B,EAAE,CAAC;gBACF,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,MAAM,OAAO,KAAK,CAAC,CAAC;gBACpD,IAAI,YAAY,CAAC,IAAI,CAAC,MAAA,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,0CAAE,WAAW,CAAC,EAAE,CAAC;oBAC5D,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;oBACjD,eAAe,CAAC,IAAI,CAClB,GAAG,MAAM,CAAC,GAAG,CACX,EAAE,CAAC,EAAE;;wBACH,OAAA,CAAC;4BACC,KAAK,EAAE,MAAA,EAAE,CAAC,KAAK,0CAAE,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC;4BAC/C,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;;gCACxB,MAAM,QAAQ,GAAG;oCACf,GAAG,CAAC;oCACJ,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC;iCACjD,CAAC;gCAEF,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;oCAClB,QAAQ,CAAC,WAAW,GAAG,MAAA,QAAQ,CAAC,WAAW,0CAAE,OAAO,CAClD,SAAS,EACT,UAAU,CACX,CAAC;gCACJ,CAAC;gCAED,OAAO,QAAQ,CAAC;4BAClB,CAAC,CAAC;yBACH,CAAe,CAAA;qBAAA,CACnB,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,OAAO,eAAe,CAAC;QACzB,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;;AA7KuB,0BAAQ,GAAoB;IAClD,cAAc,EAAE;QACd,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;KAC7D;IACD,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IAC1E,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACpE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACrE,SAAS,EAAE;QACT;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE;gBAC/C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,MAAM,EAAE;QACN;YACE,KAAK,EAAE,oBAAoB;YAC3B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,MAAM,EAAE;QACN;YACE,KAAK,EAAE,oBAAoB;YAC3B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,IAAI,EAAE;QACJ;YACE,KAAK,EAAE,oBAAoB;YAC3B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,YAAY,EAAE;QACZ;YACE,KAAK,EAAE,mBAAmB;YAC1B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,OAAO,EAAE;QACP;YACE,KAAK,EAAE,mBAAmB;YAC1B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,eAAe,EAAE;QACf;YACE,KAAK,EAAE,mBAAmB;YAC1B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,gBAAgB,EAAE;QAChB;YACE,KAAK,EAAE,mBAAmB;YAC1B,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,MAAM,EAAE;QACN;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,UAAU,EAAE;QACV;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,QAAQ,EAAE;QACR;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,QAAQ,EAAE;QACR;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;IACD,OAAO,EAAE;QACP;YACE,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE;gBAC9C,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;aAC/C;SACF;KACF;CACF,CAAC","sourcesContent":["import type {\n SmartQueryHeuristic,\n KeywordFacetMap,\n SmartFacet,\n} from '../models';\n\n// If wikidata describes the top query result as X, recommend facet Y, e.g.:\n// X Y\n// written work mt:texts\n// film mt:movies\n// author mt:texts and creator:<query>\n// filmmaker mt:movies and creator:<query>\n// photographer mt:image and creator:<query>\n// visual artist mt:image and creator:<query>\n// etc.\nexport class WikidataHeuristic implements SmartQueryHeuristic {\n private static readonly ENTITIES: KeywordFacetMap = {\n 'written work': [\n { facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] },\n ],\n literature: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n book: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n novel: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],\n filmmaker: [\n {\n label: 'Films by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'movies' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n author: [\n {\n label: 'Writing by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'texts' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n writer: [\n {\n label: 'Writing by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'texts' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n poet: [\n {\n label: 'Writing by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'texts' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n photographer: [\n {\n label: 'Images by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'image' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n painter: [\n {\n label: 'Images by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'image' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n 'visual artist': [\n {\n label: 'Images by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'image' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n 'graphic artist': [\n {\n label: 'Images by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'image' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n singer: [\n {\n label: 'Music by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'audio' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n songwriter: [\n {\n label: 'Music by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'audio' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n musician: [\n {\n label: 'Music by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'audio' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n composer: [\n {\n label: 'Music by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'audio' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n pianist: [\n {\n label: 'Music by __QUERY',\n facets: [\n { facetType: 'mediatype', bucketKey: 'audio' },\n { facetType: 'creator', bucketKey: '__QUERY' },\n ],\n },\n ],\n };\n\n async getRecommendedFacets(query: string): Promise<SmartFacet[]> {\n const recommendations: SmartFacet[] = [];\n\n try {\n const urlQuery = encodeURIComponent(query);\n\n const wikidataResponse = await fetch(\n `https://www.wikidata.org/w/api.php?action=wbsearchentities&search=${urlQuery}&format=json&language=en&uselang=en&origin=*&type=item&limit=5`,\n );\n const searchResults = await wikidataResponse.json();\n\n for (const [keyword, facets] of Object.entries(\n WikidataHeuristic.ENTITIES,\n )) {\n const keywordRegex = new RegExp(`\\\\b${keyword}\\\\b`);\n if (keywordRegex.test(searchResults.search[0]?.description)) {\n const entityName = searchResults.search[0].label;\n recommendations.push(\n ...facets.map(\n sf =>\n ({\n label: sf.label?.replace('__QUERY', entityName),\n facets: sf.facets.map(f => {\n const replaced = {\n ...f,\n bucketKey: f.bucketKey.replace('__QUERY', query),\n };\n\n if (f.displayText) {\n replaced.displayText = replaced.displayText?.replace(\n '__QUERY',\n entityName,\n );\n }\n\n return replaced;\n }),\n }) as SmartFacet,\n ),\n );\n }\n }\n\n return recommendations;\n } catch {\n return [];\n }\n }\n}\n"]}

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

@@ -1,55 +0,0 @@
-import type {
-  SmartQueryHeuristic,
-  KeywordFacetMap,
-  SmartFacet,
-} from '../models';
-// If the query contains X word but Y facet isn't selected, recommend facet Y
-export class QueryKeywordsHeuristic implements SmartQueryHeuristic {
-  private static readonly KEYWORDS: KeywordFacetMap = {
-    text: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
-    book: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
-    pdf: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
-    epub: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
-    audio: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
-    song: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
-    music: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
-    listen: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
-    podcast: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
-    radio: [{ facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] }],
-    stream: [
-      { facets: [{ facetType: 'mediatype', bucketKey: 'audio' }] },
-      { facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] },
-    ],
-    video: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],
-    movie: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],
-    film: [{ facets: [{ facetType: 'mediatype', bucketKey: 'movies' }] }],
-    image: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],
-    photo: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],
-    picture: [{ facets: [{ facetType: 'mediatype', bucketKey: 'image' }] }],
-    software: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],
-    app: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],
-    program: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],
-    game: [{ facets: [{ facetType: 'mediatype', bucketKey: 'software' }] }],
-    etree: [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],
-    concert: [{ facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] }],
-    'live music': [
-      { facets: [{ facetType: 'mediatype', bucketKey: 'etree' }] },
-    ],
-    dataset: [{ facets: [{ facetType: 'mediatype', bucketKey: 'data' }] }],
-  };
-  async getRecommendedFacets(query: string): Promise<SmartFacet[]> {
-    const recommendations: SmartFacet[] = [];
-    for (const [keyword, facets] of Object.entries(
-      QueryKeywordsHeuristic.KEYWORDS,
-    )) {
-      if (query.includes(keyword)) {
-        recommendations.push(...facets);
-      }
-    }
-    return recommendations;
-  }
-}

package/src/collection-facets/smart-facets/heuristics/wikidata-heuristic.ts DELETED Viewed

@@ -1,191 +0,0 @@
-import type {
-  SmartQueryHeuristic,
-  KeywordFacetMap,
-  SmartFacet,
-} from '../models';
-// If wikidata describes the top query result as X, recommend facet Y, e.g.:
-// X              Y
-// written work   mt:texts
-// film           mt:movies
-// author         mt:texts and creator:<query>
-// filmmaker      mt:movies and creator:<query>
-// photographer   mt:image and creator:<query>
-// visual artist  mt:image and creator:<query>
-// etc.
-export class WikidataHeuristic implements SmartQueryHeuristic {
-  private static readonly ENTITIES: KeywordFacetMap = {
-    'written work': [
-      { facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] },
-    ],
-    literature: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
-    book: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
-    novel: [{ facets: [{ facetType: 'mediatype', bucketKey: 'texts' }] }],
-    filmmaker: [
-      {
-        label: 'Films by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'movies' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    author: [
-      {
-        label: 'Writing by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'texts' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    writer: [
-      {
-        label: 'Writing by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'texts' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    poet: [
-      {
-        label: 'Writing by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'texts' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    photographer: [
-      {
-        label: 'Images by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'image' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    painter: [
-      {
-        label: 'Images by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'image' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    'visual artist': [
-      {
-        label: 'Images by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'image' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    'graphic artist': [
-      {
-        label: 'Images by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'image' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    singer: [
-      {
-        label: 'Music by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'audio' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    songwriter: [
-      {
-        label: 'Music by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'audio' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    musician: [
-      {
-        label: 'Music by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'audio' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    composer: [
-      {
-        label: 'Music by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'audio' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-    pianist: [
-      {
-        label: 'Music by __QUERY',
-        facets: [
-          { facetType: 'mediatype', bucketKey: 'audio' },
-          { facetType: 'creator', bucketKey: '__QUERY' },
-        ],
-      },
-    ],
-  };
-  async getRecommendedFacets(query: string): Promise<SmartFacet[]> {
-    const recommendations: SmartFacet[] = [];
-    try {
-      const urlQuery = encodeURIComponent(query);
-      const wikidataResponse = await fetch(
-        `https://www.wikidata.org/w/api.php?action=wbsearchentities&search=${urlQuery}&format=json&language=en&uselang=en&origin=*&type=item&limit=5`,
-      );
-      const searchResults = await wikidataResponse.json();
-      for (const [keyword, facets] of Object.entries(
-        WikidataHeuristic.ENTITIES,
-      )) {
-        const keywordRegex = new RegExp(`\\b${keyword}\\b`);
-        if (keywordRegex.test(searchResults.search[0]?.description)) {
-          const entityName = searchResults.search[0].label;
-          recommendations.push(
-            ...facets.map(
-              sf =>
-                ({
-                  label: sf.label?.replace('__QUERY', entityName),
-                  facets: sf.facets.map(f => {
-                    const replaced = {
-                      ...f,
-                      bucketKey: f.bucketKey.replace('__QUERY', query),
-                    };
-                    if (f.displayText) {
-                      replaced.displayText = replaced.displayText?.replace(
-                        '__QUERY',
-                        entityName,
-                      );
-                    }
-                    return replaced;
-                  }),
-                }) as SmartFacet,
-            ),
-          );
-        }
-      }
-      return recommendations;
-    } catch {
-      return [];
-    }
-  }
-}

/package/dist/src/collection-facets/smart-facets/heuristics/{browser-language-heuristic.js → browser-language/browser-language-heuristic.js} RENAMED Viewed

File without changes