@internetarchive/collection-browser 2.3.0 → 2.4.0

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

@@ -1,43 +1,43 @@
-import type { CollectionExtraInfo, PageElementName, SearchServiceInterface, SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
-import type { FacetLoadStrategy, SelectedFacets, SortField } 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;
-    minSelectedDate?: string;
-    maxSelectedDate?: string;
-    selectedTitleFilter: string | null;
-    selectedCreatorFilter: string | null;
-    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;
-    readonly sortParam: SortParam | null;
-    readonly defaultSortParam: SortParam | null;
-    readonly facetLoadStrategy: FacetLoadStrategy;
-    readonly initialPageNumber: 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 } 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;
+    minSelectedDate?: string;
+    maxSelectedDate?: string;
+    selectedTitleFilter: string | null;
+    selectedCreatorFilter: string | null;
+    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;
+    readonly sortParam: SortParam | null;
+    readonly defaultSortParam: SortParam | null;
+    readonly facetLoadStrategy: FacetLoadStrategy;
+    readonly initialPageNumber: 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/dist/src/data-source/collection-browser-query-state.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=collection-browser-query-state.js.map

package/dist/src/data-source/models.d.ts

@@ -1,28 +1,28 @@
-import type { PageElementName, PageType } from '@internetarchive/search-service';
-/**
- * A Map from collection identifiers to their corresponding collection titles.
- */
-export declare type CollectionTitles = 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 declare 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 declare const FACETLESS_PAGE_ELEMENTS: PageElementName[];
+import type { PageElementName, PageType } from '@internetarchive/search-service';
+/**
+ * A Map from collection identifiers to their corresponding collection titles.
+ */
+export declare type CollectionTitles = 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 declare 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 declare const FACETLESS_PAGE_ELEMENTS: PageElementName[];

package/dist/src/data-source/models.js

@@ -1,9 +1,9 @@
-/**
- * List of profile page elements that do not currently allow faceting
- */
-export const FACETLESS_PAGE_ELEMENTS = [
-    'forum_posts',
-    'lending',
-    'web_archives',
-];
+/**
+ * List of profile page elements that do not currently allow faceting
+ */
+export const FACETLESS_PAGE_ELEMENTS = [
+    'forum_posts',
+    'lending',
+    'web_archives',
+];
 //# sourceMappingURL=models.js.map

package/dist/src/empty-placeholder.d.ts

@@ -1,23 +1,23 @@
-import { LitElement, CSSResultGroup, nothing, TemplateResult } from 'lit';
-export declare type PlaceholderType = 'empty-query' | 'empty-collection' | 'no-results' | 'query-error' | 'collection-error' | null;
-export declare class EmptyPlaceholder extends LitElement {
-    private static readonly MESSAGE_EMPTY_QUERY;
-    private static readonly MESSAGE_NO_SEARCH_RESULTS;
-    private static readonly MESSAGE_NO_COLLECTION_RESULTS;
-    private static readonly MESSAGE_NO_VIEWABLE_MEMBERS;
-    private static readonly MESSAGE_QUERY_ERROR;
-    private static readonly MESSAGE_COLLECTION_ERROR;
-    private static readonly QUERY_ERROR_DETAILS_MESSAGE;
-    placeholderType: PlaceholderType;
-    isMobileView?: false;
-    isCollection?: false;
-    detailMessage?: string;
-    render(): TemplateResult<1> | typeof nothing;
-    private get placeholderTemplate();
-    private get emptyQueryTemplate();
-    private get emptyCollectionTemplate();
-    private get noResultsTemplate();
-    private get queryErrorTemplate();
-    private get collectionErrorTemplate();
-    static get styles(): CSSResultGroup;
-}
+import { LitElement, CSSResultGroup, nothing, TemplateResult } from 'lit';
+export declare type PlaceholderType = 'empty-query' | 'empty-collection' | 'no-results' | 'query-error' | 'collection-error' | null;
+export declare class EmptyPlaceholder extends LitElement {
+    private static readonly MESSAGE_EMPTY_QUERY;
+    private static readonly MESSAGE_NO_SEARCH_RESULTS;
+    private static readonly MESSAGE_NO_COLLECTION_RESULTS;
+    private static readonly MESSAGE_NO_VIEWABLE_MEMBERS;
+    private static readonly MESSAGE_QUERY_ERROR;
+    private static readonly MESSAGE_COLLECTION_ERROR;
+    private static readonly QUERY_ERROR_DETAILS_MESSAGE;
+    placeholderType: PlaceholderType;
+    isMobileView?: false;
+    isCollection?: false;
+    detailMessage?: string;
+    render(): TemplateResult<1> | typeof nothing;
+    private get placeholderTemplate();
+    private get emptyQueryTemplate();
+    private get emptyCollectionTemplate();
+    private get noResultsTemplate();
+    private get queryErrorTemplate();
+    private get collectionErrorTemplate();
+    static get styles(): CSSResultGroup;
+}

package/dist/src/empty-placeholder.js

@@ -1,78 +1,78 @@
-var EmptyPlaceholder_1;
-import { __decorate } from "tslib";
-import { css, html, LitElement, nothing, } from 'lit';
-import { customElement, property } from 'lit/decorators.js';
-import { choose } from 'lit/directives/choose.js';
-import { msg } from '@lit/localize';
-import emptyQueryIcon from './assets/img/icons/empty-query';
-import nullResultIcon from './assets/img/icons/null-result';
-let EmptyPlaceholder = EmptyPlaceholder_1 = class EmptyPlaceholder extends LitElement {
-    constructor() {
-        super(...arguments);
-        this.placeholderType = null;
-        this.detailMessage = '';
-    }
-    render() {
-        return this.placeholderType ? html `${this.placeholderTemplate}` : nothing;
-    }
-    get placeholderTemplate() {
+var EmptyPlaceholder_1;
+import { __decorate } from "tslib";
+import { css, html, LitElement, nothing, } from 'lit';
+import { customElement, property } from 'lit/decorators.js';
+import { choose } from 'lit/directives/choose.js';
+import { msg } from '@lit/localize';
+import emptyQueryIcon from './assets/img/icons/empty-query';
+import nullResultIcon from './assets/img/icons/null-result';
+let EmptyPlaceholder = EmptyPlaceholder_1 = class EmptyPlaceholder extends LitElement {
+    constructor() {
+        super(...arguments);
+        this.placeholderType = null;
+        this.detailMessage = '';
+    }
+    render() {
+        return this.placeholderType ? html `${this.placeholderTemplate}` : nothing;
+    }
+    get placeholderTemplate() {
         return html `
       <div
-        class="placeholder ${this.placeholderType} ${this.isMobileView
-            ? 'mobile'
+        class="placeholder ${this.placeholderType} ${this.isMobileView
+            ? 'mobile'
             : 'desktop'}"
       >
-        ${choose(this.placeholderType, [
-            ['empty-query', () => this.emptyQueryTemplate],
-            ['empty-collection', () => this.emptyCollectionTemplate],
-            ['no-results', () => this.noResultsTemplate],
-            ['query-error', () => this.queryErrorTemplate],
-            ['collection-error', () => this.collectionErrorTemplate],
+        ${choose(this.placeholderType, [
+            ['empty-query', () => this.emptyQueryTemplate],
+            ['empty-collection', () => this.emptyCollectionTemplate],
+            ['no-results', () => this.noResultsTemplate],
+            ['query-error', () => this.queryErrorTemplate],
+            ['collection-error', () => this.collectionErrorTemplate],
         ])}
       </div>
-    `;
-    }
-    get emptyQueryTemplate() {
+    `;
+    }
+    get emptyQueryTemplate() {
         return html `
       <h2 class="title">${EmptyPlaceholder_1.MESSAGE_EMPTY_QUERY}</h2>
       <div>${emptyQueryIcon}</div>
-    `;
-    }
-    get emptyCollectionTemplate() {
+    `;
+    }
+    get emptyCollectionTemplate() {
         return html `
       <h2 class="title">${EmptyPlaceholder_1.MESSAGE_NO_VIEWABLE_MEMBERS}</h2>
       <div>${nullResultIcon}</div>
-    `;
-    }
-    get noResultsTemplate() {
+    `;
+    }
+    get noResultsTemplate() {
         return html `
       <h2 class="title">
-        ${this.isCollection
-            ? EmptyPlaceholder_1.MESSAGE_NO_COLLECTION_RESULTS
+        ${this.isCollection
+            ? EmptyPlaceholder_1.MESSAGE_NO_COLLECTION_RESULTS
             : EmptyPlaceholder_1.MESSAGE_NO_SEARCH_RESULTS}
       </h2>
       <div>${nullResultIcon}</div>
-    `;
-    }
-    get queryErrorTemplate() {
+    `;
+    }
+    get queryErrorTemplate() {
         return html `
       <h2 class="title">${EmptyPlaceholder_1.MESSAGE_QUERY_ERROR}</h2>
       <div>${nullResultIcon}</div>
       <p class="error-details">
         ${EmptyPlaceholder_1.QUERY_ERROR_DETAILS_MESSAGE} ${this.detailMessage}
       </p>
-    `;
-    }
-    get collectionErrorTemplate() {
+    `;
+    }
+    get collectionErrorTemplate() {
         return html `
       <h2 class="title">${EmptyPlaceholder_1.MESSAGE_COLLECTION_ERROR}</h2>
       <div>${nullResultIcon}</div>
       <p class="error-details">
         ${EmptyPlaceholder_1.QUERY_ERROR_DETAILS_MESSAGE} ${this.detailMessage}
       </p>
-    `;
-    }
-    static get styles() {
+    `;
+    }
+    static get styles() {
         return css `
       :host {
         text-align: center;
@@ -113,41 +113,41 @@ let EmptyPlaceholder = EmptyPlaceholder_1 = class EmptyPlaceholder extends LitEl
         font-size: 1.2rem;
         word-break: break-word;
       }
-    `;
-    }
-};
-EmptyPlaceholder.MESSAGE_EMPTY_QUERY = msg('To begin searching, enter a search term in the box above and hit "Go".');
-EmptyPlaceholder.MESSAGE_NO_SEARCH_RESULTS = msg('Your search did not match any items in the Archive. ' +
-    'Try different keywords or a more general search.');
-EmptyPlaceholder.MESSAGE_NO_COLLECTION_RESULTS = msg('Your search did not match any items in this collection. ' +
-    'Try different keywords or a more general search.');
-EmptyPlaceholder.MESSAGE_NO_VIEWABLE_MEMBERS = msg('This collection contains no viewable items.');
+    `;
+    }
+};
+EmptyPlaceholder.MESSAGE_EMPTY_QUERY = msg('To begin searching, enter a search term in the box above and hit "Go".');
+EmptyPlaceholder.MESSAGE_NO_SEARCH_RESULTS = msg('Your search did not match any items in the Archive. ' +
+    'Try different keywords or a more general search.');
+EmptyPlaceholder.MESSAGE_NO_COLLECTION_RESULTS = msg('Your search did not match any items in this collection. ' +
+    'Try different keywords or a more general search.');
+EmptyPlaceholder.MESSAGE_NO_VIEWABLE_MEMBERS = msg('This collection contains no viewable items.');
 EmptyPlaceholder.MESSAGE_QUERY_ERROR = msg(html `The search engine
     encountered an error, which might be related to your search query.
     <a
       href="https://help.archive.org/help/search-building-powerful-complex-queries/"
     >
       Tips for constructing search queries.
-    </a> `);
+    </a> `);
 EmptyPlaceholder.MESSAGE_COLLECTION_ERROR = msg(html `The search engine
     encountered an error while loading this collection. If the problem persists,
     please let us know at
-    <a href="mailto:info@archive.org">info@archive.org</a>.`);
-EmptyPlaceholder.QUERY_ERROR_DETAILS_MESSAGE = msg('Error details:');
-__decorate([
-    property({ type: String })
-], EmptyPlaceholder.prototype, "placeholderType", void 0);
-__decorate([
-    property({ type: Boolean })
-], EmptyPlaceholder.prototype, "isMobileView", void 0);
-__decorate([
-    property({ type: Boolean })
-], EmptyPlaceholder.prototype, "isCollection", void 0);
-__decorate([
-    property({ type: String })
-], EmptyPlaceholder.prototype, "detailMessage", void 0);
-EmptyPlaceholder = EmptyPlaceholder_1 = __decorate([
-    customElement('empty-placeholder')
-], EmptyPlaceholder);
-export { EmptyPlaceholder };
+    <a href="mailto:info@archive.org">info@archive.org</a>.`);
+EmptyPlaceholder.QUERY_ERROR_DETAILS_MESSAGE = msg('Error details:');
+__decorate([
+    property({ type: String })
+], EmptyPlaceholder.prototype, "placeholderType", void 0);
+__decorate([
+    property({ type: Boolean })
+], EmptyPlaceholder.prototype, "isMobileView", void 0);
+__decorate([
+    property({ type: Boolean })
+], EmptyPlaceholder.prototype, "isCollection", void 0);
+__decorate([
+    property({ type: String })
+], EmptyPlaceholder.prototype, "detailMessage", void 0);
+EmptyPlaceholder = EmptyPlaceholder_1 = __decorate([
+    customElement('empty-placeholder')
+], EmptyPlaceholder);
+export { EmptyPlaceholder };
 //# sourceMappingURL=empty-placeholder.js.map

package/dist/src/expanded-date-picker.d.ts

@@ -1,43 +1,43 @@
-import { LitElement, CSSResultGroup, TemplateResult } from 'lit';
-import type { ModalManagerInterface } from '@internetarchive/modal-manager';
-import type { AnalyticsManagerInterface } from '@internetarchive/analytics-manager';
-export declare class ExpandedDatePicker extends LitElement {
-    minDate?: string;
-    maxDate?: string;
-    minSelectedDate?: string;
-    maxSelectedDate?: string;
-    buckets?: number[];
-    modalManager?: ModalManagerInterface;
-    analyticsHandler?: AnalyticsManagerInterface;
-    render(): TemplateResult;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    /**
-     * Add an event listener to close the date picker modal when the Esc key is pressed
-     */
-    private setupEscapeListener;
-    /**
-     * Remove the Esc key listener that was previously added
-     */
-    private removeEscapeListener;
-    /**
-     * Closes the modal dialog if the given event is pressing the Esc key.
-     * Arrow function to ensure `this` remains bound to the current component.
-     */
-    private boundEscapeListener;
-    /**
-     * When the histogram is updated, keep track of the newly selected date range.
-     * We don't commit to the new range until the apply button is clicked.
-     */
-    private histogramDateRangeUpdated;
-    /**
-     * When the Apply button is clicked, emit the current date range and close the modal.
-     */
-    private applyBtnClicked;
-    /**
-     * Closes the modal associated with this component (if it exists) and dispatches a
-     * modalClosed event.
-     */
-    private closeModal;
-    static get styles(): CSSResultGroup;
-}
+import { LitElement, CSSResultGroup, TemplateResult } from 'lit';
+import type { ModalManagerInterface } from '@internetarchive/modal-manager';
+import type { AnalyticsManagerInterface } from '@internetarchive/analytics-manager';
+export declare class ExpandedDatePicker extends LitElement {
+    minDate?: string;
+    maxDate?: string;
+    minSelectedDate?: string;
+    maxSelectedDate?: string;
+    buckets?: number[];
+    modalManager?: ModalManagerInterface;
+    analyticsHandler?: AnalyticsManagerInterface;
+    render(): TemplateResult;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    /**
+     * Add an event listener to close the date picker modal when the Esc key is pressed
+     */
+    private setupEscapeListener;
+    /**
+     * Remove the Esc key listener that was previously added
+     */
+    private removeEscapeListener;
+    /**
+     * Closes the modal dialog if the given event is pressing the Esc key.
+     * Arrow function to ensure `this` remains bound to the current component.
+     */
+    private boundEscapeListener;
+    /**
+     * When the histogram is updated, keep track of the newly selected date range.
+     * We don't commit to the new range until the apply button is clicked.
+     */
+    private histogramDateRangeUpdated;
+    /**
+     * When the Apply button is clicked, emit the current date range and close the modal.
+     */
+    private applyBtnClicked;
+    /**
+     * Closes the modal associated with this component (if it exists) and dispatches a
+     * modalClosed event.
+     */
+    private closeModal;
+    static get styles(): CSSResultGroup;
+}