@internetarchive/collection-browser 1.14.17-alpha.30 → 1.14.17-alpha.32

package/dist/src/data-source/collection-browser-data-source-interface.d.ts

@@ -0,0 +1,190 @@
+import type { FilterMap, Aggregation, CollectionExtraInfo, AccountExtraInfo, PageElementMap } from "@internetarchive/search-service";
+import type { ReactiveController } from "lit";
+import type { PrefixFilterType, PrefixFilterCounts, TileModel } from "../models";
+import type { PageSpecifierParams, CollectionTitles } from "./models";
+export interface CollectionBrowserDataSourceInterface extends ReactiveController {
+    /**
+     * How many tile models are present in this data source
+     */
+    readonly size: number;
+    /**
+     * How many results there are in the full result set for the current query
+     * (not necessarily all loaded yet).
+     */
+    readonly totalResults: number;
+    /**
+     * Whether the host has a valid set of properties for performing a search.
+     * For instance, on the search page this requires a valid search service and a
+     * non-empty query, while collection pages allow searching with an empty query
+     * for MDS but not FTS.
+     */
+    readonly canPerformSearch: boolean;
+    /**
+     * Whether the end of the set of results for the current query state has been
+     * encountered (i.e., the last page of results).
+     */
+    readonly endOfDataReached: boolean;
+    /**
+     * True if the initial work for a new query state has been completed (i.e., firing initial
+     * page/facet requests). False otherwise.
+     */
+    readonly queryInitialized: boolean;
+    /**
+     * A string key compactly representing the current full search state, which can
+     * be used to determine, e.g., when a new search is required or whether an arriving
+     * response is outdated.
+     */
+    readonly pageFetchQueryKey: string;
+    /**
+     * Similar to `pageFetchQueryKey`, but excluding properties that do not affect
+     * the validity of a set of facets (e.g., sort).
+     */
+    readonly facetFetchQueryKey: string;
+    /**
+     * An object representing any collection- or profile-specific properties to be passed along
+     * to the search service, specifying the exact page/tab to fetch results for.
+     */
+    readonly pageSpecifierParams: PageSpecifierParams | null;
+    /**
+     * A FilterMap object representing all filters applied to the current search,
+     * including any facets, letter filters, and date ranges.
+     */
+    readonly filterMap: FilterMap;
+    /**
+     * The full set of aggregations retrieved for the current search.
+     */
+    readonly aggregations?: Record<string, Aggregation>;
+    /**
+     * The `year_histogram` aggregation retrieved for the current search.
+     */
+    readonly yearHistogramAggregation?: Aggregation;
+    /**
+     * A map from collection identifiers that appear on hits or aggregations for the
+     * current search, to their human-readable collection titles.
+     */
+    readonly collectionTitles: CollectionTitles;
+    /**
+     * The "extra info" package provided by the PPS for collection pages, including details
+     * used to populate the target collection header & About tab content.
+     */
+    readonly collectionExtraInfo?: CollectionExtraInfo;
+    /**
+     * The "extra info" package provided by the PPS for profile pages, including details
+     * used to populate the profile header.
+     */
+    readonly accountExtraInfo?: AccountExtraInfo;
+    /**
+     * The set of requested page elements for profile pages, if applicable. These represent
+     * any content specific to the current profile tab.
+     */
+    readonly pageElements?: PageElementMap;
+    /**
+     * An array of the current target collection's parent collections. Should include *all*
+     * ancestors in the collection hierarchy, not just the immediate parent.
+     */
+    readonly parentCollections?: string[];
+    /**
+     * An object storing result counts for the current search bucketed by letter prefix.
+     * Keys are the result field on which the prefixes are considered (e.g., title/creator)
+     * and values are a Record mapping letters to their counts.
+     */
+    readonly prefixFilterCountMap: Partial<Record<PrefixFilterType, PrefixFilterCounts>>;
+    /**
+     * An array of all the tile models whose management checkboxes are checked
+     */
+    readonly checkedTileModels: TileModel[];
+    /**
+     * An array of all the tile models whose management checkboxes are unchecked
+     */
+    readonly uncheckedTileModels: TileModel[];
+    /**
+     * A Promise which, after each query change, resolves once the fetches for the initial
+     * search have completed. Waits for *both* the hits and aggregations fetches to finish.
+     *
+     * Ensure you await this component's `updateComplete` promise before awaiting this
+     * one, to ensure you do not await an obsolete promise from the previous update.
+     */
+    readonly initialSearchComplete: Promise<boolean>;
+    /**
+     * Resets the data source to its empty state, with no result pages, aggregations, etc.
+     */
+    reset(): void;
+    /**
+     * Adds the given page of tile models to the data source.
+     * If the given page number already exists, that page will be overwritten.
+     * @param pageNum Which page number to add (indexed starting from 1)
+     * @param pageTiles The array of tile models for the new page
+     */
+    addPage(pageNum: number, pageTiles: TileModel[]): void;
+    /**
+     * Returns the given page of tile models from the data source.
+     * @param pageNum Which page number to get (indexed starting from 1)
+     */
+    getPage(pageNum: number): TileModel[];
+    /**
+     * Returns the full set of paged tile models stored in this data source.
+     */
+    getAllPages(): Record<string, TileModel[]>;
+    /**
+     * Whether the data source contains any tiles for the given page number.
+     * @param pageNum Which page number to query (indexed starting from 1)
+     */
+    hasPage(pageNum: number): boolean;
+    /**
+     * Returns the single tile model appearing at the given index in the
+     * data source, with respect to the current page size. Returns `undefined` if
+     * the corresponding page is not present on the data source or if it does not
+     * contain a tile model at the corresponding index.
+     * @param index The 0-based index (within the full data source) of the tile to get
+     */
+    getTileModelAt(index: number): TileModel | undefined;
+    /**
+     * Returns the first numeric tile index corresponding to the given tile model object,
+     * or -1 if the given tile model is not present.
+     * @param tile The tile model to search for in the data source
+     */
+    indexOf(tile: TileModel): number;
+    /**
+     * Requests that the data source fire a backend request for the given page of results.
+     * @param pageNum Which page number to fetch results for
+     * @param numInitialPages How many pages should be batched together on an initial fetch
+     */
+    fetchPage(pageNum: number, numInitialPages?: number): Promise<void>;
+    /**
+     * Requests that the data source update its prefix bucket result counts for the given
+     * type of prefix filter.
+     * @param filterType Which prefixable field to update the buckets for (e.g., title/creator)
+     */
+    updatePrefixFilterCounts(filterType: PrefixFilterType): Promise<void>;
+    /**
+     * Changes the page size used by the data source, discarding any previously-fetched pages.
+     *
+     * **Note: this operation will reset any data stored in the data source!**
+     * @param pageSize
+     */
+    setPageSize(pageSize: number): void;
+    /**
+     * Notifies the data source that a query change has occurred, which may trigger a data
+     * reset & new fetches.
+     */
+    handleQueryChange(): void;
+    /**
+     * Applies the given map function to all of the tile models in every page of the data
+     * source.
+     * @param callback A callback function to apply on each tile model, as with Array.map
+     */
+    map(callback: (model: TileModel, index: number, array: TileModel[]) => TileModel): void;
+    /**
+     * Checks every tile's management checkbox
+     */
+    checkAllTiles(): void;
+    /**
+     * Unchecks every tile's management checkbox
+     */
+    uncheckAllTiles(): void;
+    /**
+     * Removes all tile models that are currently checked & adjusts the paging
+     * of the data source to account for any new gaps in the data.
+     */
+    removeCheckedTiles(): void;
+}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=collection-browser-data-source-interface.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"collection-browser-data-source-interface.js","sourceRoot":"","sources":["../../../src/data-source/collection-browser-data-source-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { FilterMap, Aggregation, CollectionExtraInfo, AccountExtraInfo, PageElementMap } from \"@internetarchive/search-service\";\nimport type { ReactiveController } from \"lit\";\nimport type { PrefixFilterType, PrefixFilterCounts, TileModel } from \"../models\";\nimport type { PageSpecifierParams, CollectionTitles } from \"./models\";\n\nexport interface CollectionBrowserDataSourceInterface\n  extends ReactiveController {\n  /**\n   * How many tile models are present in this data source\n   */\n  readonly size: number;\n\n  /**\n   * How many results there are in the full result set for the current query\n   * (not necessarily all loaded yet).\n   */\n  readonly totalResults: number;\n\n  /**\n   * Whether the host has a valid set of properties for performing a search.\n   * For instance, on the search page this requires a valid search service and a\n   * non-empty query, while collection pages allow searching with an empty query\n   * for MDS but not FTS.\n   */\n  readonly canPerformSearch: boolean;\n\n  /**\n   * Whether the end of the set of results for the current query state has been\n   * encountered (i.e., the last page of results).\n   */\n  readonly endOfDataReached: boolean;\n\n  /**\n   * True if the initial work for a new query state has been completed (i.e., firing initial\n   * page/facet requests). False otherwise.\n   */\n  readonly queryInitialized: boolean;\n\n  /**\n   * A string key compactly representing the current full search state, which can\n   * be used to determine, e.g., when a new search is required or whether an arriving\n   * response is outdated.\n   */\n  readonly pageFetchQueryKey: string;\n\n  /**\n   * Similar to `pageFetchQueryKey`, but excluding properties that do not affect\n   * the validity of a set of facets (e.g., sort).\n   */\n  readonly facetFetchQueryKey: string;\n\n  /**\n   * An object representing any collection- or profile-specific properties to be passed along\n   * to the search service, specifying the exact page/tab to fetch results for.\n   */\n  readonly pageSpecifierParams: PageSpecifierParams | null;\n\n  /**\n   * A FilterMap object representing all filters applied to the current search,\n   * including any facets, letter filters, and date ranges.\n   */\n  readonly filterMap: FilterMap;\n\n  /**\n   * The full set of aggregations retrieved for the current search.\n   */\n  readonly aggregations?: Record<string, Aggregation>;\n\n  /**\n   * The `year_histogram` aggregation retrieved for the current search.\n   */\n  readonly yearHistogramAggregation?: Aggregation;\n\n  /**\n   * A map from collection identifiers that appear on hits or aggregations for the\n   * current search, to their human-readable collection titles.\n   */\n  readonly collectionTitles: CollectionTitles;\n\n  /**\n   * The \"extra info\" package provided by the PPS for collection pages, including details\n   * used to populate the target collection header & About tab content.\n   */\n  readonly collectionExtraInfo?: CollectionExtraInfo;\n\n  /**\n   * The \"extra info\" package provided by the PPS for profile pages, including details\n   * used to populate the profile header.\n   */\n  readonly accountExtraInfo?: AccountExtraInfo;\n\n  /**\n   * The set of requested page elements for profile pages, if applicable. These represent\n   * any content specific to the current profile tab.\n   */\n  readonly pageElements?: PageElementMap;\n\n  /**\n   * An array of the current target collection's parent collections. Should include *all*\n   * ancestors in the collection hierarchy, not just the immediate parent.\n   */\n  readonly parentCollections?: string[];\n\n  /**\n   * An object storing result counts for the current search bucketed by letter prefix.\n   * Keys are the result field on which the prefixes are considered (e.g., title/creator)\n   * and values are a Record mapping letters to their counts.\n   */\n  readonly prefixFilterCountMap: Partial<\n    Record<PrefixFilterType, PrefixFilterCounts>\n  >;\n\n  /**\n   * An array of all the tile models whose management checkboxes are checked\n   */\n  readonly checkedTileModels: TileModel[];\n\n  /**\n   * An array of all the tile models whose management checkboxes are unchecked\n   */\n  readonly uncheckedTileModels: TileModel[];\n\n  /**\n   * A Promise which, after each query change, resolves once the fetches for the initial\n   * search have completed. Waits for *both* the hits and aggregations fetches to finish.\n   *\n   * Ensure you await this component's `updateComplete` promise before awaiting this\n   * one, to ensure you do not await an obsolete promise from the previous update.\n   */\n  readonly initialSearchComplete: Promise<boolean>;\n\n  /**\n   * Resets the data source to its empty state, with no result pages, aggregations, etc.\n   */\n  reset(): void;\n\n  /**\n   * Adds the given page of tile models to the data source.\n   * If the given page number already exists, that page will be overwritten.\n   * @param pageNum Which page number to add (indexed starting from 1)\n   * @param pageTiles The array of tile models for the new page\n   */\n  addPage(pageNum: number, pageTiles: TileModel[]): void;\n\n  /**\n   * Returns the given page of tile models from the data source.\n   * @param pageNum Which page number to get (indexed starting from 1)\n   */\n  getPage(pageNum: number): TileModel[];\n\n  /**\n   * Returns the full set of paged tile models stored in this data source.\n   */\n  getAllPages(): Record<string, TileModel[]>;\n\n  /**\n   * Whether the data source contains any tiles for the given page number.\n   * @param pageNum Which page number to query (indexed starting from 1)\n   */\n  hasPage(pageNum: number): boolean;\n\n  /**\n   * Returns the single tile model appearing at the given index in the\n   * data source, with respect to the current page size. Returns `undefined` if\n   * the corresponding page is not present on the data source or if it does not\n   * contain a tile model at the corresponding index.\n   * @param index The 0-based index (within the full data source) of the tile to get\n   */\n  getTileModelAt(index: number): TileModel | undefined;\n\n  /**\n   * Returns the first numeric tile index corresponding to the given tile model object,\n   * or -1 if the given tile model is not present.\n   * @param tile The tile model to search for in the data source\n   */\n  indexOf(tile: TileModel): number;\n\n  /**\n   * Requests that the data source fire a backend request for the given page of results.\n   * @param pageNum Which page number to fetch results for\n   * @param numInitialPages How many pages should be batched together on an initial fetch\n   */\n  fetchPage(pageNum: number, numInitialPages?: number): Promise<void>;\n\n  /**\n   * Requests that the data source update its prefix bucket result counts for the given\n   * type of prefix filter.\n   * @param filterType Which prefixable field to update the buckets for (e.g., title/creator)\n   */\n  updatePrefixFilterCounts(filterType: PrefixFilterType): Promise<void>;\n\n  /**\n   * Changes the page size used by the data source, discarding any previously-fetched pages.\n   *\n   * **Note: this operation will reset any data stored in the data source!**\n   * @param pageSize\n   */\n  setPageSize(pageSize: number): void;\n\n  /**\n   * Notifies the data source that a query change has occurred, which may trigger a data\n   * reset & new fetches.\n   */\n  handleQueryChange(): void;\n\n  /**\n   * Applies the given map function to all of the tile models in every page of the data\n   * source.\n   * @param callback A callback function to apply on each tile model, as with Array.map\n   */\n  map(\n    callback: (model: TileModel, index: number, array: TileModel[]) => TileModel\n  ): void;\n\n  /**\n   * Checks every tile's management checkbox\n   */\n  checkAllTiles(): void;\n\n  /**\n   * Unchecks every tile's management checkbox\n   */\n  uncheckAllTiles(): void;\n\n  /**\n   * Removes all tile models that are currently checked & adjusts the paging\n   * of the data source to account for any new gaps in the data.\n   */\n  removeCheckedTiles(): void;\n}"]}

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

@@ -1,188 +1,8 @@
-import type { ReactiveController, ReactiveControllerHost } from 'lit';
+import type { ReactiveControllerHost } from 'lit';
 import { AccountExtraInfo, Aggregation, CollectionExtraInfo, FilterMap, PageElementMap, SearchParams } from '@internetarchive/search-service';
 import { type PrefixFilterType, TileModel, PrefixFilterCounts, RequestKind } from '../models';
-import type { CollectionBrowserSearchInterface, CollectionTitles, PageSpecifierParams } from './models';
-export interface CollectionBrowserDataSourceInterface extends ReactiveController {
-    /**
-     * How many tile models are present in this data source
-     */
-    readonly size: number;
-    /**
-     * Whether the host has a valid set of properties for performing a search.
-     * For instance, on the search page this requires a valid search service and a
-     * non-empty query, while collection pages allow searching with an empty query
-     * for MDS but not FTS.
-     */
-    readonly canPerformSearch: boolean;
-    /**
-     * Whether the end of the set of results for the current query state has been
-     * encountered (i.e., the last page of results).
-     */
-    readonly endOfDataReached: boolean;
-    /**
-     * True if the initial work for a new query state has been completed (i.e., firing initial
-     * page/facet requests). False otherwise.
-     */
-    readonly queryInitialized: boolean;
-    /**
-     * A string key compactly representing the current full search state, which can
-     * be used to determine, e.g., when a new search is required or whether an arriving
-     * response is outdated.
-     */
-    readonly pageFetchQueryKey: string;
-    /**
-     * Similar to `pageFetchQueryKey`, but excluding properties that do not affect
-     * the validity of a set of facets (e.g., sort).
-     */
-    readonly facetFetchQueryKey: string;
-    /**
-     * An object representing any collection- or profile-specific properties to be passed along
-     * to the search service, specifying the exact page/tab to fetch results for.
-     */
-    readonly pageSpecifierParams: PageSpecifierParams | null;
-    /**
-     * A FilterMap object representing all filters applied to the current search,
-     * including any facets, letter filters, and date ranges.
-     */
-    readonly filterMap: FilterMap;
-    /**
-     * The full set of aggregations retrieved for the current search.
-     */
-    readonly aggregations?: Record<string, Aggregation>;
-    /**
-     * The `year_histogram` aggregation retrieved for the current search.
-     */
-    readonly yearHistogramAggregation?: Aggregation;
-    /**
-     * A map from collection identifiers that appear on hits or aggregations for the
-     * current search, to their human-readable collection titles.
-     */
-    readonly collectionTitles: CollectionTitles;
-    /**
-     * The "extra info" package provided by the PPS for collection pages, including details
-     * used to populate the target collection header & About tab content.
-     */
-    readonly collectionExtraInfo?: CollectionExtraInfo;
-    /**
-     * The "extra info" package provided by the PPS for profile pages, including details
-     * used to populate the profile header.
-     */
-    readonly accountExtraInfo?: AccountExtraInfo;
-    /**
-     * The set of requested page elements for profile pages, if applicable. These represent
-     * any content specific to the current profile tab.
-     */
-    readonly pageElements?: PageElementMap;
-    /**
-     * An array of the current target collection's parent collections. Should include *all*
-     * ancestors in the collection hierarchy, not just the immediate parent.
-     */
-    readonly parentCollections?: string[];
-    /**
-     * An object storing result counts for the current search bucketed by letter prefix.
-     * Keys are the result field on which the prefixes are considered (e.g., title/creator)
-     * and values are a Record mapping letters to their counts.
-     */
-    readonly prefixFilterCountMap: Partial<Record<PrefixFilterType, PrefixFilterCounts>>;
-    /**
-     * An array of all the tile models whose management checkboxes are checked
-     */
-    readonly checkedTileModels: TileModel[];
-    /**
-     * An array of all the tile models whose management checkboxes are unchecked
-     */
-    readonly uncheckedTileModels: TileModel[];
-    /**
-     * A Promise which, after each query change, resolves once the fetches for the initial
-     * search have completed. Waits for *both* the hits and aggregations fetches to finish.
-     *
-     * Ensure you await this component's `updateComplete` promise before awaiting this
-     * one, to ensure you do not await an obsolete promise from the previous update.
-     */
-    readonly initialSearchComplete: Promise<boolean>;
-    /**
-     * Resets the data source to its empty state, with no result pages, aggregations, etc.
-     */
-    reset(): void;
-    /**
-     * Adds the given page of tile models to the data source.
-     * If the given page number already exists, that page will be overwritten.
-     * @param pageNum Which page number to add (indexed starting from 1)
-     * @param pageTiles The array of tile models for the new page
-     */
-    addPage(pageNum: number, pageTiles: TileModel[]): void;
-    /**
-     * Returns the given page of tile models from the data source.
-     * @param pageNum Which page number to get (indexed starting from 1)
-     */
-    getPage(pageNum: number): TileModel[];
-    /**
-     * Returns the full set of paged tile models stored in this data source.
-     */
-    getAllPages(): Record<string, TileModel[]>;
-    /**
-     * Whether the data source contains any tiles for the given page number.
-     * @param pageNum Which page number to query (indexed starting from 1)
-     */
-    hasPage(pageNum: number): boolean;
-    /**
-     * Returns the single tile model appearing at the given index in the
-     * data source, with respect to the current page size. Returns `undefined` if
-     * the corresponding page is not present on the data source or if it does not
-     * contain a tile model at the corresponding index.
-     * @param index The 0-based index (within the full data source) of the tile to get
-     */
-    getTileModelAt(index: number): TileModel | undefined;
-    /**
-     * Returns the first numeric tile index corresponding to the given tile model object,
-     * or -1 if the given tile model is not present.
-     * @param tile The tile model to search for in the data source
-     */
-    indexOf(tile: TileModel): number;
-    /**
-     * Requests that the data source fire a backend request for the given page of results.
-     * @param pageNum Which page number to fetch results for
-     * @param numInitialPages How many pages should be batched together on an initial fetch
-     */
-    fetchPage(pageNum: number, numInitialPages?: number): Promise<void>;
-    /**
-     * Requests that the data source update its prefix bucket result counts for the given
-     * type of prefix filter.
-     * @param filterType Which prefixable field to update the buckets for (e.g., title/creator)
-     */
-    updatePrefixFilterCounts(filterType: PrefixFilterType): Promise<void>;
-    /**
-     * Changes the page size used by the data source, discarding any previously-fetched pages.
-     *
-     * **Note: this operation will reset any data stored in the data source!**
-     * @param pageSize
-     */
-    setPageSize(pageSize: number): void;
-    /**
-     * Notifies the data source that a query change has occurred, which may trigger a data
-     * reset & new fetches.
-     */
-    handleQueryChange(): void;
-    /**
-     * Applies the given map function to all of the tile models in every page of the data
-     * source.
-     * @param callback A callback function to apply on each tile model, as with Array.map
-     */
-    map(callback: (model: TileModel, index: number, array: TileModel[]) => TileModel): void;
-    /**
-     * Checks every tile's management checkbox
-     */
-    checkAllTiles(): void;
-    /**
-     * Unchecks every tile's management checkbox
-     */
-    uncheckAllTiles(): void;
-    /**
-     * Removes all tile models that are currently checked & adjusts the paging
-     * of the data source to account for any new gaps in the data.
-     */
-    removeCheckedTiles(): void;
-}
+import type { CollectionBrowserSearchInterface, PageSpecifierParams } from './models';
+import type { CollectionBrowserDataSourceInterface } from './collection-browser-data-source-interface';
 export declare class CollectionBrowserDataSource implements CollectionBrowserDataSourceInterface {
     /** The host element to which this controller should attach listeners */
     private readonly host;