@internetarchive/collection-browser 3.0.0 → 3.0.1

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

@@ -1,63 +1,63 @@
-import type {
-  CollectionExtraInfo,
-  PageElementName,
-  SearchServiceInterface,
-  SearchType,
-  SortDirection,
-  SortParam,
-} from '@internetarchive/search-service';
-import type {
-  FacetLoadStrategy,
-  SelectedFacets,
-  SortField,
-  TvClipFilterType,
-} from '../models';
-import type { CollectionBrowserDataSourceInterface } from './collection-browser-data-source-interface';
-
-/**
- * Properties of collection browser that affect the overall search query
- */
-export interface CollectionBrowserQueryState {
-  baseQuery?: string;
-  withinCollection?: string;
-  withinProfile?: string;
-  profileElement?: PageElementName;
-  searchType: SearchType;
-  selectedFacets?: SelectedFacets;
-  internalFilters?: SelectedFacets;
-  minSelectedDate?: string;
-  maxSelectedDate?: string;
-  selectedTitleFilter: string | null;
-  selectedCreatorFilter: string | null;
-  tvClipFilter?: TvClipFilterType;
-  selectedSort?: SortField;
-  sortDirection: SortDirection | null;
-}
-
-/**
- * Interface representing search-related state and operations required by the
- * data source on its host component.
- */
-export interface CollectionBrowserSearchInterface
-  extends CollectionBrowserQueryState {
-  searchService?: SearchServiceInterface;
-  isTVCollection: boolean;
-  readonly sortParam: SortParam | null;
-  readonly defaultSortField: SortField | null;
-  readonly facetLoadStrategy: FacetLoadStrategy;
-  readonly initialPageNumber: number;
-  readonly maxPagesToManage: number;
-  readonly currentVisiblePageNumbers: number[];
-  readonly clearResultsOnEmptyQuery?: boolean;
-  readonly dataSource?: CollectionBrowserDataSourceInterface;
-
-  getSessionId(): Promise<string>;
-  setSearchResultsLoading(loading: boolean): void;
-  setFacetsLoading(loading: boolean): void;
-  setTotalResultCount(count: number): void;
-  setTileCount(count: number): void;
-  applyDefaultCollectionSort(collectionInfo?: CollectionExtraInfo): void;
-  emitEmptyResults(): void;
-  emitQueryStateChanged(): void;
-  refreshVisibleResults(): void;
-}
+import type {
+  CollectionExtraInfo,
+  PageElementName,
+  SearchServiceInterface,
+  SearchType,
+  SortDirection,
+  SortParam,
+} from '@internetarchive/search-service';
+import type {
+  FacetLoadStrategy,
+  SelectedFacets,
+  SortField,
+  TvClipFilterType,
+} from '../models';
+import type { CollectionBrowserDataSourceInterface } from './collection-browser-data-source-interface';
+
+/**
+ * Properties of collection browser that affect the overall search query
+ */
+export interface CollectionBrowserQueryState {
+  baseQuery?: string;
+  withinCollection?: string;
+  withinProfile?: string;
+  profileElement?: PageElementName;
+  searchType: SearchType;
+  selectedFacets?: SelectedFacets;
+  internalFilters?: SelectedFacets;
+  minSelectedDate?: string;
+  maxSelectedDate?: string;
+  selectedTitleFilter: string | null;
+  selectedCreatorFilter: string | null;
+  tvClipFilter?: TvClipFilterType;
+  selectedSort?: SortField;
+  sortDirection: SortDirection | null;
+}
+
+/**
+ * Interface representing search-related state and operations required by the
+ * data source on its host component.
+ */
+export interface CollectionBrowserSearchInterface
+  extends CollectionBrowserQueryState {
+  searchService?: SearchServiceInterface;
+  isTVCollection: boolean;
+  readonly sortParam: SortParam | null;
+  readonly defaultSortField: SortField | null;
+  readonly facetLoadStrategy: FacetLoadStrategy;
+  readonly initialPageNumber: number;
+  readonly maxPagesToManage: number;
+  readonly currentVisiblePageNumbers: number[];
+  readonly clearResultsOnEmptyQuery?: boolean;
+  readonly dataSource?: CollectionBrowserDataSourceInterface;
+
+  getSessionId(): Promise<string>;
+  setSearchResultsLoading(loading: boolean): void;
+  setFacetsLoading(loading: boolean): void;
+  setTotalResultCount(count: number): void;
+  setTileCount(count: number): void;
+  applyDefaultCollectionSort(collectionInfo?: CollectionExtraInfo): void;
+  emitEmptyResults(): void;
+  emitQueryStateChanged(): void;
+  refreshVisibleResults(): void;
+}

package/src/data-source/models.ts

@@ -1,43 +1,43 @@
-import type {
-  PageElementName,
-  PageType,
-} from '@internetarchive/search-service';
-
-/**
- * A Map from collection identifiers to their corresponding collection titles.
- */
-export type CollectionTitles = Map<string, string>;
-
-/**
- * A Map from channel names to their corresponding, more human-readable network name.
- */
-export type TVChannelAliases = Map<string, string>;
-
-/**
- * The subset of search service params that uniquely specify the type of results
- * that are sought by an instance of collection browser.
- */
-export type PageSpecifierParams = {
-  /**
-   * What high-level type of page is being fetched for (search results, collection, or profile)
-   */
-  pageType: PageType;
-  /**
-   * The target identifier for collection or profile pages (e.g., "prelinger", "@brewster", ...)
-   */
-  pageTarget: string;
-  /**
-   * Which specific elements of a profile page to fetch. Corresponds to individual tab data
-   * (e.g., "uploads", "reviews", ...)
-   */
-  pageElements?: PageElementName[];
-};
-
-/**
- * List of profile page elements that do not currently allow faceting
- */
-export const FACETLESS_PAGE_ELEMENTS: PageElementName[] = [
-  'forum_posts',
-  'lending',
-  'web_archives',
-];
+import type {
+  PageElementName,
+  PageType,
+} from '@internetarchive/search-service';
+
+/**
+ * A Map from collection identifiers to their corresponding collection titles.
+ */
+export type CollectionTitles = Map<string, string>;
+
+/**
+ * A Map from channel names to their corresponding, more human-readable network name.
+ */
+export type TVChannelAliases = Map<string, string>;
+
+/**
+ * The subset of search service params that uniquely specify the type of results
+ * that are sought by an instance of collection browser.
+ */
+export type PageSpecifierParams = {
+  /**
+   * What high-level type of page is being fetched for (search results, collection, or profile)
+   */
+  pageType: PageType;
+  /**
+   * The target identifier for collection or profile pages (e.g., "prelinger", "@brewster", ...)
+   */
+  pageTarget: string;
+  /**
+   * Which specific elements of a profile page to fetch. Corresponds to individual tab data
+   * (e.g., "uploads", "reviews", ...)
+   */
+  pageElements?: PageElementName[];
+};
+
+/**
+ * List of profile page elements that do not currently allow faceting
+ */
+export const FACETLESS_PAGE_ELEMENTS: PageElementName[] = [
+  'forum_posts',
+  'lending',
+  'web_archives',
+];