@internetarchive/collection-browser 3.4.1 → 3.4.2-alpha-webdev7761.0

package/dist/src/data-source/collection-browser-data-source.js

@@ -1,6 +1,6 @@
 import { FilterConstraint, FilterMapBuilder, SearchType, } from '@internetarchive/search-service';
 import { prefixFilterAggregationKeys, TileModel, SortField, SORT_OPTIONS, } from '../models';
-import { FACETLESS_PAGE_ELEMENTS } from './models';
+import { FACETLESS_PAGE_ELEMENTS, } from './models';
 import { sha1 } from '../utils/sha1';
 import { log } from '../utils/log';
 import { mergeSelectedFacets } from '../utils/facet-utils';
@@ -81,6 +81,10 @@ export class CollectionBrowserDataSource {
          * @inheritdoc
          */
         this.collectionTitles = new Map();
+        /**
+         * @inheritdoc
+         */
+        this.tvChannelMaps = {};
         /**
          * @inheritdoc
          */
@@ -286,7 +290,6 @@ export class CollectionBrowserDataSource {
      * @inheritdoc
      */
     getTileModelAt(index) {
-        var _a, _b;
         const offsetIndex = index + this.offset;
         const expectedPageNum = Math.floor(offsetIndex / this.pageSize) + 1;
         const expectedIndexOnPage = offsetIndex % this.pageSize;
@@ -296,7 +299,7 @@ export class CollectionBrowserDataSource {
             if (!this.pages[page]) {
                 // If we encounter a missing page, either we're past all the results or the page data is sparse.
                 // So just return the tile at the expected position if it exists.
-                return (_a = this.pages[expectedPageNum]) === null || _a === void 0 ? void 0 : _a[expectedIndexOnPage];
+                return this.pages[expectedPageNum]?.[expectedIndexOnPage];
             }
             if (tilesSeen + this.pages[page].length > offsetIndex) {
                 return this.pages[page][offsetIndex - tilesSeen];
@@ -304,7 +307,7 @@ export class CollectionBrowserDataSource {
             tilesSeen += this.pages[page].length;
             page += 1;
         }
-        return (_b = this.pages[expectedPageNum]) === null || _b === void 0 ? void 0 : _b[expectedIndexOnPage];
+        return this.pages[expectedPageNum]?.[expectedIndexOnPage];
     }
     /**
      * @inheritdoc
@@ -390,7 +393,6 @@ export class CollectionBrowserDataSource {
      * (i.e., they aren't suppressed or already loading, etc.)
      */
     get canFetchFacets() {
-        var _a;
         // Don't fetch facets if they are suppressed entirely or not required for the current profile page element
         if (this.host.facetLoadStrategy === 'off')
             return false;
@@ -401,7 +403,7 @@ export class CollectionBrowserDataSource {
         if (this.host.facetLoadStrategy !== 'eager' && !this.facetsReadyToLoad)
             return false;
         // Don't fetch facets again if they are already fetched or pending
-        const facetsAlreadyFetched = Object.keys((_a = this.aggregations) !== null && _a !== void 0 ? _a : {}).length > 0;
+        const facetsAlreadyFetched = Object.keys(this.aggregations ?? {}).length > 0;
         if (this.facetsLoading || facetsAlreadyFetched)
             return false;
         return true;
@@ -447,12 +449,11 @@ export class CollectionBrowserDataSource {
      * @inheritdoc
      */
     get canPerformSearch() {
-        var _a, _b;
         if (!this.host.searchService)
             return false;
-        const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
+        const trimmedQuery = this.host.baseQuery?.trim();
         const hasNonEmptyQuery = !!trimmedQuery;
-        const hasIdentifiers = !!((_b = this.host.identifiers) === null || _b === void 0 ? void 0 : _b.length);
+        const hasIdentifiers = !!this.host.identifiers?.length;
         const isCollectionSearch = !!this.host.withinCollection;
         const isProfileSearch = !!this.host.withinProfile;
         const hasProfileElement = !!this.host.profileElement;
@@ -521,11 +522,10 @@ export class CollectionBrowserDataSource {
      * no longer relevant. Not meant to be human-readable.
      */
     get pageFetchQueryKey() {
-        var _a, _b, _c;
         const profileKey = `pf;${this.host.withinProfile}--pe;${this.host.profileElement}`;
-        const pageTarget = (_a = this.host.withinCollection) !== null && _a !== void 0 ? _a : profileKey;
-        const sortField = (_b = this.host.selectedSort) !== null && _b !== void 0 ? _b : 'none';
-        const sortDirection = (_c = this.host.sortDirection) !== null && _c !== void 0 ? _c : 'none';
+        const pageTarget = this.host.withinCollection ?? profileKey;
+        const sortField = this.host.selectedSort ?? 'none';
+        const sortDirection = this.host.sortDirection ?? 'none';
         return `fq:${this.fullQuery}-pt:${pageTarget}-st:${this.host.searchType}-sf:${sortField}-sd:${sortDirection}`;
     }
     /**
@@ -533,9 +533,8 @@ export class CollectionBrowserDataSource {
      * are not relevant in determining aggregation queries.
      */
     get facetFetchQueryKey() {
-        var _a;
         const profileKey = `pf;${this.host.withinProfile}--pe;${this.host.profileElement}`;
-        const pageTarget = (_a = this.host.withinCollection) !== null && _a !== void 0 ? _a : profileKey;
+        const pageTarget = this.host.withinCollection ?? profileKey;
         return `facets-fq:${this.fullQuery}-pt:${pageTarget}-st:${this.host.searchType}`;
     }
     /**
@@ -579,23 +578,6 @@ export class CollectionBrowserDataSource {
         if (selectedCreatorFilter) {
             builder.addFilter('firstCreator', selectedCreatorFilter, FilterConstraint.INCLUDE);
         }
-        // Add any TV clip type filter, if applicable
-        if (this.host.searchType === SearchType.TV) {
-            switch (this.host.tvClipFilter) {
-                case 'commercials':
-                    builder.addFilter('ad_id', '*', FilterConstraint.INCLUDE);
-                    break;
-                case 'factchecks':
-                    builder.addFilter('factcheck', '*', FilterConstraint.INCLUDE);
-                    break;
-                case 'quotes':
-                    builder.addFilter('clip', '1', FilterConstraint.INCLUDE);
-                    break;
-                case 'all':
-                default:
-                    break;
-            }
-        }
         const filterMap = builder.build();
         return filterMap;
     }
@@ -609,7 +591,6 @@ export class CollectionBrowserDataSource {
      * @returns A Promise resolving to the uid to apply to the request
      */
     async requestUID(params, kind) {
-        var _a;
         const paramsToHash = JSON.stringify({
             pageType: params.pageType,
             pageTarget: params.pageTarget,
@@ -621,7 +602,7 @@ export class CollectionBrowserDataSource {
         });
         const fullQueryHash = (await sha1(paramsToHash)).slice(0, 20); // First 80 bits of SHA-1 are plenty for this
         const sessionId = (await this.host.getSessionId()).slice(0, 20); // Likewise
-        const page = (_a = params.page) !== null && _a !== void 0 ? _a : 0;
+        const page = params.page ?? 0;
         const kindPrefix = kind.charAt(0); // f = full, h = hits, a = aggregations
         const currentTime = Date.now();
         return `R:${fullQueryHash}-S:${sessionId}-P:${page}-K:${kindPrefix}-T:${currentTime}`;
@@ -630,8 +611,7 @@ export class CollectionBrowserDataSource {
      * @inheritdoc
      */
     get pageSpecifierParams() {
-        var _a;
-        if ((_a = this.host.identifiers) === null || _a === void 0 ? void 0 : _a.length) {
+        if (this.host.identifiers?.length) {
             return {
                 pageType: 'client_document_fetch',
             };
@@ -657,9 +637,8 @@ export class CollectionBrowserDataSource {
      * The full query, including year facets and date range clauses
      */
     get fullQuery() {
-        var _a;
         const parts = [];
-        const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
+        const trimmedQuery = this.host.baseQuery?.trim();
         if (trimmedQuery)
             parts.push(trimmedQuery);
         if (this.host.identifiers) {
@@ -680,14 +659,13 @@ export class CollectionBrowserDataSource {
      * Example: `mediatype:("collection" OR "audio" OR -"etree") AND year:("2000" OR "2001")`
      */
     get facetQuery() {
-        var _a;
         if (!this.host.selectedFacets)
             return undefined;
         const facetClauses = [];
         for (const [facetName, facetValues] of Object.entries(this.host.selectedFacets)) {
             facetClauses.push(this.buildFacetClause(facetName, facetValues));
         }
-        return (_a = this.joinFacetClauses(facetClauses)) === null || _a === void 0 ? void 0 : _a.trim();
+        return this.joinFacetClauses(facetClauses)?.trim();
     }
     get dateRangeQueryClause() {
         if (!this.host.minSelectedDate || !this.host.maxSelectedDate) {
@@ -775,8 +753,7 @@ export class CollectionBrowserDataSource {
      * the current search state.
      */
     async fetchFacets() {
-        var _a, _b, _c, _d, _e, _f, _g;
-        const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
+        const trimmedQuery = this.host.baseQuery?.trim();
         if (!this.canPerformSearch)
             return;
         const { facetFetchQueryKey } = this;
@@ -797,8 +774,8 @@ export class CollectionBrowserDataSource {
             // The default aggregations for the search_results page type should be what we need here.
         };
         params.uid = await this.requestUID({ ...params, sort: sortParams }, 'aggregations');
-        const searchResponse = await ((_b = this.host.searchService) === null || _b === void 0 ? void 0 : _b.search(params, this.host.searchType));
-        const success = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success;
+        const searchResponse = await this.host.searchService?.search(params, this.host.searchType);
+        const success = searchResponse?.success;
         // This is checking to see if the query has changed since the data was fetched.
         // If so, we just want to discard this set of aggregations because they are
         // likely no longer valid for the newer query.
@@ -807,11 +784,11 @@ export class CollectionBrowserDataSource {
         if (queryChangedSinceFetch)
             return;
         if (!success) {
-            const errorMsg = (_c = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _c === void 0 ? void 0 : _c.message;
-            const detailMsg = (_e = (_d = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _d === void 0 ? void 0 : _d.details) === null || _e === void 0 ? void 0 : _e.message;
+            const errorMsg = searchResponse?.error?.message;
+            const detailMsg = searchResponse?.error?.details?.message;
             if (!errorMsg && !detailMsg) {
                 // @ts-expect-error: Property 'Sentry' does not exist on type 'Window & typeof globalThis'
-                (_g = (_f = window === null || window === void 0 ? void 0 : window.Sentry) === null || _f === void 0 ? void 0 : _f.captureMessage) === null || _g === void 0 ? void 0 : _g.call(_f, 'Missing or malformed facet response from backend', 'error');
+                window?.Sentry?.captureMessage?.('Missing or malformed facet response from backend', 'error');
             }
             this.setFacetsLoading(false);
             return;
@@ -820,8 +797,8 @@ export class CollectionBrowserDataSource {
         this.aggregations = aggregations;
         this.histogramAggregation =
             this.host.searchType === SearchType.TV
-                ? aggregations === null || aggregations === void 0 ? void 0 : aggregations.date_histogram
-                : aggregations === null || aggregations === void 0 ? void 0 : aggregations.year_histogram;
+                ? aggregations?.date_histogram
+                : aggregations?.year_histogram;
         if (collectionTitles) {
             for (const [id, title] of Object.entries(collectionTitles)) {
                 this.collectionTitles.set(id, title);
@@ -852,8 +829,7 @@ export class CollectionBrowserDataSource {
      *  if `pageNumber != 1`, defaulting to a single page.
      */
     async fetchPage(pageNumber, numInitialPages = 1) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
-        const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
+        const trimmedQuery = this.host.baseQuery?.trim();
         // reset loading status
         if (!this.canPerformSearch) {
             this.setSearchResultsLoading(false);
@@ -904,9 +880,9 @@ export class CollectionBrowserDataSource {
         };
         params.uid = await this.requestUID(params, 'hits');
         // log('=== FIRING PAGE REQUEST ===', params);
-        const searchResponse = await ((_b = this.host.searchService) === null || _b === void 0 ? void 0 : _b.search(params, this.host.searchType));
+        const searchResponse = await this.host.searchService?.search(params, this.host.searchType);
         // log('=== RECEIVED PAGE RESPONSE IN CB ===', searchResponse);
-        const success = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success;
+        const success = searchResponse?.success;
         // This is checking to see if the fetch has been invalidated since it was fired off.
         // If so, we just want to discard the response since it is for an obsolete query state.
         if (!this.fetchesInProgress.has(currentPageKey))
@@ -915,13 +891,13 @@ export class CollectionBrowserDataSource {
             this.fetchesInProgress.delete(`${pageFetchQueryKey}-p:${pageNumber + i}`);
         }
         if (!success) {
-            const errorMsg = (_c = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _c === void 0 ? void 0 : _c.message;
-            const detailMsg = (_e = (_d = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _d === void 0 ? void 0 : _d.details) === null || _e === void 0 ? void 0 : _e.message;
-            this.queryErrorMessage = `${errorMsg !== null && errorMsg !== void 0 ? errorMsg : ''}${detailMsg ? `; ${detailMsg}` : ''}`;
+            const errorMsg = searchResponse?.error?.message;
+            const detailMsg = searchResponse?.error?.details?.message;
+            this.queryErrorMessage = `${errorMsg ?? ''}${detailMsg ? `; ${detailMsg}` : ''}`;
             if (!this.queryErrorMessage) {
                 this.queryErrorMessage = 'Missing or malformed response from backend';
                 // @ts-expect-error: Property 'Sentry' does not exist on type 'Window & typeof globalThis'
-                (_g = (_f = window === null || window === void 0 ? void 0 : window.Sentry) === null || _f === void 0 ? void 0 : _f.captureMessage) === null || _g === void 0 ? void 0 : _g.call(_f, this.queryErrorMessage, 'error');
+                window?.Sentry?.captureMessage?.(this.queryErrorMessage, 'error');
             }
             this.setSearchResultsLoading(false);
             this.requestHostUpdate();
@@ -942,10 +918,10 @@ export class CollectionBrowserDataSource {
                 this.host.applyDefaultCollectionSort(this.collectionExtraInfo);
             }
             if (this.collectionExtraInfo) {
-                this.parentCollections = [].concat((_j = (_h = this.collectionExtraInfo.public_metadata) === null || _h === void 0 ? void 0 : _h.collection) !== null && _j !== void 0 ? _j : []);
+                this.parentCollections = [].concat(this.collectionExtraInfo.public_metadata?.collection ?? []);
                 // Update the TV collection status now that we know the parent collections
                 this.host.isTVCollection =
-                    ((_k = this.host.withinCollection) === null || _k === void 0 ? void 0 : _k.startsWith('TV-')) ||
+                    this.host.withinCollection?.startsWith('TV-') ||
                         this.host.withinCollection === 'tvnews' ||
                         this.host.withinCollection === 'tvarchive' ||
                         this.parentCollections.includes('tvnews') ||
@@ -965,7 +941,7 @@ export class CollectionBrowserDataSource {
                     this.collectionTitles.set(id, title);
                 }
                 // Also add the target collection's title if available
-                const targetTitle = (_m = (_l = this.collectionExtraInfo) === null || _l === void 0 ? void 0 : _l.public_metadata) === null || _m === void 0 ? void 0 : _m.title;
+                const targetTitle = this.collectionExtraInfo?.public_metadata?.title;
                 if (withinCollection && targetTitle) {
                     this.collectionTitles.set(withinCollection, targetTitle);
                 }
@@ -1024,7 +1000,7 @@ export class CollectionBrowserDataSource {
     addFetchedResultsToDataSource(pageNumber, results, needsReload = true) {
         const tiles = [];
         const requestSource = this.hitRequestSource;
-        results === null || results === void 0 ? void 0 : results.forEach(result => {
+        results?.forEach(result => {
             if (!result.identifier)
                 return;
             tiles.push(new TileModel(result, requestSource));
@@ -1038,8 +1014,7 @@ export class CollectionBrowserDataSource {
      * Fetches the aggregation buckets for the given prefix filter type.
      */
     async fetchPrefixFilterBuckets(filterType) {
-        var _a, _b, _c, _d, _e, _f, _g;
-        const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
+        const trimmedQuery = this.host.baseQuery?.trim();
         if (!this.canPerformSearch)
             return [];
         const filterAggregationKey = prefixFilterAggregationKeys[filterType];
@@ -1056,8 +1031,8 @@ export class CollectionBrowserDataSource {
             aggregationsSize: 26,
         };
         params.uid = await this.requestUID({ ...params, sort: sortParams }, 'aggregations');
-        const searchResponse = await ((_b = this.host.searchService) === null || _b === void 0 ? void 0 : _b.search(params, this.host.searchType));
-        return ((_g = (_f = (_e = (_d = (_c = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success) === null || _c === void 0 ? void 0 : _c.response) === null || _d === void 0 ? void 0 : _d.aggregations) === null || _e === void 0 ? void 0 : _e[filterAggregationKey]) === null || _f === void 0 ? void 0 : _f.buckets) !== null && _g !== void 0 ? _g : []);
+        const searchResponse = await this.host.searchService?.search(params, this.host.searchType);
+        return (searchResponse?.success?.response?.aggregations?.[filterAggregationKey]?.buckets ?? []);
     }
     /**
      * Fetches and caches the prefix filter counts for the given filter type.
@@ -1099,5 +1074,36 @@ export class CollectionBrowserDataSource {
         this.updatePrefixFiltersForCurrentSort();
         this.requestHostUpdate();
     }
+    /**
+     * @inheritdoc
+     */
+    populateTVChannelMaps() {
+        // To ensure that we only make these requests once, cache the Promise returned by the
+        // first call, and return the same Promise on repeated calls.
+        // Resolves once both maps have been retrieved and saved in the data source.
+        if (!this._tvMapsPromise) {
+            this._tvMapsPromise = this._fetchTVChannelMaps();
+        }
+        return this._tvMapsPromise;
+    }
+    /**
+     * Internal function implementing the actual fetches for TV channel mappings.
+     * This should only called by the public populateTVChannelMaps method, which is guarded so
+     * that we do not make extra requests for these rather large mappings.
+     */
+    async _fetchTVChannelMaps() {
+        const baseURL = 'https://av.archive.org/etc';
+        const dateStr = new Date().toISOString().slice(0, 10); // YYYY-MM-DD
+        const chan2networkPromise = fetch(`${baseURL}/chan2network.json?date=${dateStr}`);
+        const program2chansPromise = fetch(`${baseURL}/program2chans.json?date=${dateStr}`);
+        const [chan2networkResponse, program2chansResponse] = await Promise.all([
+            chan2networkPromise,
+            program2chansPromise,
+        ]);
+        this.tvChannelMaps.channelToNetwork = new Map(Object.entries(await chan2networkResponse.json()));
+        this.tvChannelMaps.programToChannels = new Map(Object.entries(await program2chansResponse.json()));
+        this.requestHostUpdate();
+        return this.tvChannelMaps;
+    }
 }
 //# sourceMappingURL=collection-browser-data-source.js.map