@internetarchive/collection-browser 1.8.0 → 1.9.0-alpha1

package/dist/src/restoration-state-handler.d.ts

@@ -1,63 +1,70 @@
-import { SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
-import { CollectionBrowserContext, CollectionDisplayMode, SelectedFacets, SortField } from './models';
-export interface RestorationState {
-    displayMode?: CollectionDisplayMode;
-    searchType?: SearchType;
-    sortParam?: SortParam;
-    selectedSort?: SortField;
-    sortDirection?: SortDirection;
-    selectedFacets: SelectedFacets;
-    baseQuery?: string;
-    currentPage?: number;
-    titleQuery?: string;
-    creatorQuery?: string;
-    minSelectedDate?: string;
-    maxSelectedDate?: string;
-    selectedTitleFilter?: string;
-    selectedCreatorFilter?: string;
-}
-export interface RestorationStateHandlerInterface {
-    persistState(state: RestorationState): void;
-    getRestorationState(): RestorationState;
-}
-export declare class RestorationStateHandler implements RestorationStateHandlerInterface {
-    private context;
-    private cookieDomain;
-    private cookieExpiration;
-    private cookiePath;
-    constructor(options: {
-        context: CollectionBrowserContext;
-    });
-    persistState(state: RestorationState): void;
-    getRestorationState(): RestorationState;
-    private persistViewStateToCookies;
-    private loadTileViewStateFromCookies;
-    private persistQueryStateToUrl;
-    private loadQueryStateFromUrl;
-    private stripQuotes;
-    /**
-     * Returns whether the two given URLSearchParams objects have
-     * identical values for all of the given param keys. If either
-     * object contains more than one value for a given key, then
-     * all of the values for that key must match (disregarding order).
-     */
-    private paramsMatch;
-    /**
-     * Deletes any params from the given URLSearchParams object that are recognized
-     * when loading state from the URL.
-     */
-    private removeRecognizedParams;
-    /**
-     * Returns whether the given URLSearchParams object contains a param that is
-     * only recognized as a holdover from legacy search, and should not be
-     * persisted to the URL.
-     */
-    private hasLegacyParam;
-    /**
-     * Sets the facet state for the given field & value to the given state,
-     * creating any previously-undefined buckets as needed.
-     */
-    private setSelectedFacetState;
-    /** Returns a default bucket with the given key, count of 0, and state 'none'. */
-    private getDefaultBucket;
-}
+import { SearchType, SortDirection } from '@internetarchive/search-service';
+import { CollectionBrowserContext, CollectionDisplayMode, SelectedFacets, SortField } from './models';
+export interface RestorationState {
+    displayMode?: CollectionDisplayMode;
+    searchType?: SearchType;
+    selectedSort?: SortField;
+    sortDirection?: SortDirection;
+    selectedFacets: SelectedFacets;
+    baseQuery?: string;
+    currentPage?: number;
+    titleQuery?: string;
+    creatorQuery?: string;
+    minSelectedDate?: string;
+    maxSelectedDate?: string;
+    selectedTitleFilter?: string;
+    selectedCreatorFilter?: string;
+}
+export interface RestorationStateHandlerInterface {
+    persistState(state: RestorationState): void;
+    getRestorationState(): RestorationState;
+}
+export declare class RestorationStateHandler implements RestorationStateHandlerInterface {
+    private context;
+    private cookieDomain;
+    private cookieExpiration;
+    private cookiePath;
+    constructor(options: {
+        context: CollectionBrowserContext;
+    });
+    persistState(state: RestorationState): void;
+    getRestorationState(): RestorationState;
+    private persistViewStateToCookies;
+    private loadTileViewStateFromCookies;
+    private persistQueryStateToUrl;
+    private loadQueryStateFromUrl;
+    /**
+     * Converts a URL sort param into a field/direction pair, if possible.
+     * Either or both may be undefined if the param is not in a recognized format.
+     */
+    private getSortFieldAndDirection;
+    /** Returns the `-` prefix for `desc` sort, or the empty string otherwise. */
+    private sortDirectionPrefix;
+    /** Remove optional opening and closing quotes from a string */
+    private stripQuotes;
+    /**
+     * Returns whether the two given URLSearchParams objects have
+     * identical values for all of the given param keys. If either
+     * object contains more than one value for a given key, then
+     * all of the values for that key must match (disregarding order).
+     */
+    private paramsMatch;
+    /**
+     * Deletes any params from the given URLSearchParams object that are recognized
+     * when loading state from the URL.
+     */
+    private removeRecognizedParams;
+    /**
+     * Returns whether the given URLSearchParams object contains a param that is
+     * only recognized as a holdover from legacy search, and should not be
+     * persisted to the URL.
+     */
+    private hasLegacyParam;
+    /**
+     * Sets the facet state for the given field & value to the given state,
+     * creating any previously-undefined buckets as needed.
+     */
+    private setSelectedFacetState;
+    /** Returns a default bucket with the given key, count of 0, and state 'none'. */
+    private getDefaultBucket;
+}