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

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

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

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

@@ -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/src/data-source/collection-browser-data-source-interface.ts

@@ -254,6 +254,12 @@ export interface CollectionBrowserDataSourceInterface
    */
   setPageSize(pageSize: number): void;
 
+  /**
+   * Sets the total number of pages that should be batched together on each initial fetch.
+   * @param pages How many initial pages to batch
+   */
+  setNumInitialPages(numPages: number): void;
+
   /**
    * Sets the total result count for this data source to the given value.
    * @param count The number of total results to set

package/src/data-source/collection-browser-data-source.ts

@@ -49,6 +49,12 @@ export class CollectionBrowserDataSource
    */
   private numTileModels = 0;
 
+  /**
+   * How many consecutive pages should be batched together on the initial page fetch.
+   * Defaults to 2 pages.
+   */
+  private numInitialPages = 2;
+
   /**
    * A set of fetch IDs that are valid for the current query state
    */
@@ -360,6 +366,13 @@ export class CollectionBrowserDataSource
     this.pageSize = pageSize;
   }
 
+  /**
+   * @inheritdoc
+   */
+  setNumInitialPages(numPages: number): void {
+    this.numInitialPages = numPages;
+  }
+
   /**
    * @inheritdoc
    */
@@ -997,7 +1010,7 @@ export class CollectionBrowserDataSource
   private async doInitialPageFetch(): Promise<void> {
     this.setSearchResultsLoading(true);
     // Try to batch 2 initial page requests when possible
-    await this.fetchPage(this.host.initialPageNumber, 2);
+    await this.fetchPage(this.host.initialPageNumber, this.numInitialPages);
   }
 
   /**

package/test/collection-browser.test.ts

@@ -1830,6 +1830,30 @@ describe('Collection Browser', () => {
     expect(el.dataSource.uncheckedTileModels.length).to.equal(2);
   });
 
+  it('emits event when manage view state changes', async () => {
+    const spy = sinon.spy();
+    const searchService = new MockSearchService();
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser
+        .searchService=${searchService}
+        .baseNavigationUrl=${''}
+        @manageModeChanged=${spy}
+      ></collection-browser>`,
+    );
+
+    el.isManageView = true;
+    await el.updateComplete;
+
+    expect(spy.callCount).to.equal(1);
+    expect(spy.args[0][0]?.detail).to.be.true;
+
+    el.isManageView = false;
+    await el.updateComplete;
+
+    expect(spy.callCount).to.equal(2);
+    expect(spy.args[1][0]?.detail).to.be.false;
+  });
+
   it('emits event when item removal requested', async () => {
     const spy = sinon.spy();
     const searchService = new MockSearchService();

package/test/data-source/collection-browser-data-source.test.ts

@@ -101,6 +101,20 @@ describe('Collection Browser Data Source', () => {
     expect(pageFetchSpy.callCount).to.equal(0);
   });
 
+  it('can set its initial page batch size', async () => {
+    host.searchService = new MockSearchService();
+
+    const pageFetchSpy = sinon.spy();
+    const dataSource = new CollectionBrowserDataSource(host);
+    dataSource.setNumInitialPages(10);
+    dataSource.fetchPage = pageFetchSpy;
+
+    dataSource.handleQueryChange();
+
+    // Uses specified number of initial pages
+    expect(pageFetchSpy.args[0][1]).to.equal(10);
+  });
+
   it('refreshes prefix filter counts', () => {
     const dataSource = new CollectionBrowserDataSource(host);
     dataSource.addPage(1, dataPage);

package/web-dev-server.config.mjs

@@ -1,30 +1,30 @@
-// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
-
-/** Use Hot Module replacement by adding --hmr to the start command */
-const hmr = process.argv.includes('--hmr');
-
-export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
-  nodeResolve: true,
-  open: '/',
-  watch: !hmr,
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto'
-
-  /** Set appIndex to enable SPA routing */
-  // appIndex: 'demo/index.html',
-
-  /** Confgure bare import resolve plugin */
-  // nodeResolve: {
-  //   exportConditions: ['browser', 'development']
-  // },
-
-  plugins: [
-    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
-    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
-  ],
-
-  http2: true,
-  sslCert: './local.archive.org.cert',
-  sslKey: './local.archive.org.key',
-});
+// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
+
+/** Use Hot Module replacement by adding --hmr to the start command */
+const hmr = process.argv.includes('--hmr');
+
+export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
+  nodeResolve: true,
+  open: '/',
+  watch: !hmr,
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto'
+
+  /** Set appIndex to enable SPA routing */
+  // appIndex: 'demo/index.html',
+
+  /** Confgure bare import resolve plugin */
+  // nodeResolve: {
+  //   exportConditions: ['browser', 'development']
+  // },
+
+  plugins: [
+    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
+    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
+  ],
+
+  http2: true,
+  sslCert: './local.archive.org.cert',
+  sslKey: './local.archive.org.key',
+});

package/web-test-runner.config.mjs

@@ -1,41 +1,41 @@
-// import { playwrightLauncher } from '@web/test-runner-playwright';
-
-const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
-
-export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
-  /** Test files to run */
-  files: 'dist/test/**/*.test.js',
-
-  /** Resolve bare module imports */
-  nodeResolve: {
-    exportConditions: ['browser', 'development'],
-  },
-
-  /** Filter out lit dev mode logs */
-  filterBrowserLogs(log) {
-    for (const arg of log.args) {
-      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
-        return false;
-      }
-    }
-    return true;
-  },
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto',
-
-  /** Amount of browsers to run concurrently */
-  // concurrentBrowsers: 2,
-
-  /** Amount of test files per browser to test concurrently */
-  // concurrency: 1,
-
-  /** Browsers to run tests on */
-  // browsers: [
-  //   playwrightLauncher({ product: 'chromium' }),
-  //   playwrightLauncher({ product: 'firefox' }),
-  //   playwrightLauncher({ product: 'webkit' }),
-  // ],
-
-  // See documentation for all available options
-});
+// import { playwrightLauncher } from '@web/test-runner-playwright';
+
+const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
+
+export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
+  /** Test files to run */
+  files: 'dist/test/**/*.test.js',
+
+  /** Resolve bare module imports */
+  nodeResolve: {
+    exportConditions: ['browser', 'development'],
+  },
+
+  /** Filter out lit dev mode logs */
+  filterBrowserLogs(log) {
+    for (const arg of log.args) {
+      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
+        return false;
+      }
+    }
+    return true;
+  },
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto',
+
+  /** Amount of browsers to run concurrently */
+  // concurrentBrowsers: 2,
+
+  /** Amount of test files per browser to test concurrently */
+  // concurrency: 1,
+
+  /** Browsers to run tests on */
+  // browsers: [
+  //   playwrightLauncher({ product: 'chromium' }),
+  //   playwrightLauncher({ product: 'firefox' }),
+  //   playwrightLauncher({ product: 'webkit' }),
+  // ],
+
+  // See documentation for all available options
+});

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

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

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

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

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

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