@internetarchive/collection-browser 2.4.1-e2e-test-1 → 2.5.0

package/dist/src/tiles/tile-display-value-provider.js

@@ -1,95 +1,95 @@
-import { html, nothing } from 'lit';
-import { msg, str } from '@lit/localize';
-import { formatDate } from '../utils/format-date';
-/**
- * A class encapsulating shared logic for converting model values into display values
- * across different types of tiles.
- */
-export class TileDisplayValueProvider {
-    constructor(options = {}) {
-        var _a;
-        this.model = options.model;
-        this.baseNavigationUrl = options.baseNavigationUrl;
-        this.collectionPagePath = (_a = options.collectionPagePath) !== null && _a !== void 0 ? _a : '/details/';
-        this.sortParam = options.sortParam;
-        this.creatorFilter = options.creatorFilter;
-    }
-    /**
-     * Examines the creator(s) for the given tile model, returning
-     * the first creator whose name matches the provided filter
-     * (or simply the first creator overall if no filter is provided).
-     */
-    get firstCreatorMatchingFilter() {
-        var _a, _b;
-        let matchingCreator;
-        // If we're filtering by creator initial and have multiple creators, we want
-        // to surface the first creator who matches the filter.
-        if (this.creatorFilter && ((_a = this.model) === null || _a === void 0 ? void 0 : _a.creators.length)) {
-            const firstLetter = this.creatorFilter; // This is just to satisfy tsc
-            matchingCreator = this.model.creators.find(creator => 
-            // Decompose combining characters first, so that e.g., filtering on E matches É too.
-            // Then remove anything that isn't strictly alphabetic, since our filters currently
-            // only handle A-Z. The first such letter (if one exists) is what needs to match.
-            creator
-                .normalize('NFD')
-                .replace(/[^A-Z]+/gi, '')
-                .toUpperCase()
-                .startsWith(firstLetter));
-        }
-        return matchingCreator !== null && matchingCreator !== void 0 ? matchingCreator : (_b = this.model) === null || _b === void 0 ? void 0 : _b.creator;
-    }
-    /**
-     * The label indicating what year an account item was created.
-     * E.g., "Archivist since 2015"
-     */
-    get accountLabel() {
-        var _a;
-        return ((_a = this.model) === null || _a === void 0 ? void 0 : _a.dateAdded)
-            ? msg(str `Archivist since ${this.model.dateAdded.getFullYear()}`)
-            : '';
-    }
-    /**
-     * The readable label for the current sort if it is a type of date sort,
-     * or the empty string otherwise.
-     */
-    get dateLabel() {
-        var _a;
-        switch ((_a = this.sortParam) === null || _a === void 0 ? void 0 : _a.field) {
-            case 'publicdate':
-                return msg('Archived');
-            case 'reviewdate':
-                return msg('Reviewed');
-            case 'addeddate':
-                return msg('Added');
-            case 'date':
-                return msg('Published');
-            default:
-                return '';
-        }
-    }
-    /**
-     * Produces a URL pointing at the item page for the given identifier,
-     * using the current base URL and the correct path based on whether the
-     * item is specified to be a collection (default false).
-     */
-    itemPageUrl(identifier, isCollection = false) {
-        if (!identifier || this.baseNavigationUrl == null)
-            return nothing;
-        const basePath = isCollection ? this.collectionPagePath : '/details/';
-        return `${this.baseNavigationUrl}${basePath}${identifier}`;
-    }
-    /**
-     * Produces a template for a link to a single web capture of the given URL and date
-     */
-    webArchivesCaptureLink(url, date) {
-        // Convert the date into the format used to identify wayback captures (e.g., '20150102124550')
-        const captureDateStr = date
-            .toISOString()
-            .replace(/[TZ:-]/g, '')
-            .replace(/\..*/, '');
-        const captureHref = `https://web.archive.org/web/${captureDateStr}/${encodeURIComponent(url)}`;
-        const captureText = formatDate(date, 'long');
-        return html ` <a href=${captureHref}> ${captureText} </a> `;
-    }
-}
+import { html, nothing } from 'lit';
+import { msg, str } from '@lit/localize';
+import { formatDate } from '../utils/format-date';
+/**
+ * A class encapsulating shared logic for converting model values into display values
+ * across different types of tiles.
+ */
+export class TileDisplayValueProvider {
+    constructor(options = {}) {
+        var _a;
+        this.model = options.model;
+        this.baseNavigationUrl = options.baseNavigationUrl;
+        this.collectionPagePath = (_a = options.collectionPagePath) !== null && _a !== void 0 ? _a : '/details/';
+        this.sortParam = options.sortParam;
+        this.creatorFilter = options.creatorFilter;
+    }
+    /**
+     * Examines the creator(s) for the given tile model, returning
+     * the first creator whose name matches the provided filter
+     * (or simply the first creator overall if no filter is provided).
+     */
+    get firstCreatorMatchingFilter() {
+        var _a, _b;
+        let matchingCreator;
+        // If we're filtering by creator initial and have multiple creators, we want
+        // to surface the first creator who matches the filter.
+        if (this.creatorFilter && ((_a = this.model) === null || _a === void 0 ? void 0 : _a.creators.length)) {
+            const firstLetter = this.creatorFilter; // This is just to satisfy tsc
+            matchingCreator = this.model.creators.find(creator => 
+            // Decompose combining characters first, so that e.g., filtering on E matches É too.
+            // Then remove anything that isn't strictly alphabetic, since our filters currently
+            // only handle A-Z. The first such letter (if one exists) is what needs to match.
+            creator
+                .normalize('NFD')
+                .replace(/[^A-Z]+/gi, '')
+                .toUpperCase()
+                .startsWith(firstLetter));
+        }
+        return matchingCreator !== null && matchingCreator !== void 0 ? matchingCreator : (_b = this.model) === null || _b === void 0 ? void 0 : _b.creator;
+    }
+    /**
+     * The label indicating what year an account item was created.
+     * E.g., "Archivist since 2015"
+     */
+    get accountLabel() {
+        var _a;
+        return ((_a = this.model) === null || _a === void 0 ? void 0 : _a.dateAdded)
+            ? msg(str `Archivist since ${this.model.dateAdded.getFullYear()}`)
+            : '';
+    }
+    /**
+     * The readable label for the current sort if it is a type of date sort,
+     * or the empty string otherwise.
+     */
+    get dateLabel() {
+        var _a;
+        switch ((_a = this.sortParam) === null || _a === void 0 ? void 0 : _a.field) {
+            case 'publicdate':
+                return msg('Archived');
+            case 'reviewdate':
+                return msg('Reviewed');
+            case 'addeddate':
+                return msg('Added');
+            case 'date':
+                return msg('Published');
+            default:
+                return '';
+        }
+    }
+    /**
+     * Produces a URL pointing at the item page for the given identifier,
+     * using the current base URL and the correct path based on whether the
+     * item is specified to be a collection (default false).
+     */
+    itemPageUrl(identifier, isCollection = false) {
+        if (!identifier || this.baseNavigationUrl == null)
+            return nothing;
+        const basePath = isCollection ? this.collectionPagePath : '/details/';
+        return `${this.baseNavigationUrl}${basePath}${identifier}`;
+    }
+    /**
+     * Produces a template for a link to a single web capture of the given URL and date
+     */
+    webArchivesCaptureLink(url, date) {
+        // Convert the date into the format used to identify wayback captures (e.g., '20150102124550')
+        const captureDateStr = date
+            .toISOString()
+            .replace(/[TZ:-]/g, '')
+            .replace(/\..*/, '');
+        const captureHref = `https://web.archive.org/web/${captureDateStr}/${encodeURIComponent(url)}`;
+        const captureText = formatDate(date, 'long');
+        return html ` <a href=${captureHref}> ${captureText} </a> `;
+    }
+}
 //# sourceMappingURL=tile-display-value-provider.js.map

package/dist/src/utils/analytics-events.d.ts

@@ -1,28 +1,28 @@
-/**
- * Analytics categories and events. Used when building actions in
- */
-export declare enum analyticsCategories {
-    default = "collection-browser"
-}
-export declare enum analyticsActions {
-    sortBy = "sortBy",
-    filterByCreator = "filterByCreator",
-    filterByTitle = "filterByTitle",
-    displayMode = "displayMode",
-    loadDesktopView = "loadDesktopView",
-    loadMobileView = "loadMobileView",
-    facetSelected = "facetSelected",
-    facetDeselected = "facetDeselected",
-    facetNegativeSelected = "facetNegativeSelected",
-    facetNegativeDeselected = "facetNegativeDeselected",
-    mobileFacetsToggled = "mobileFacetsToggled",
-    partOfCollectionClicked = "partOfCollectionClicked",
-    histogramChanged = "histogramChanged",
-    histogramChangedFromModal = "histogramChangedFromModal",
-    histogramExpanded = "histogramExpanded",
-    resultSelected = "resultSelected",
-    moreFacetsPageChange = "moreFacetsPageChange",
-    showMoreFacetsModal = "showMoreFacetsModal",
-    closeMoreFacetsModal = "closeMoreFacetsModal",
-    applyMoreFacetsModal = "applyMoreFacetsModal"
-}
+/**
+ * Analytics categories and events. Used when building actions in
+ */
+export declare enum analyticsCategories {
+    default = "collection-browser"
+}
+export declare enum analyticsActions {
+    sortBy = "sortBy",
+    filterByCreator = "filterByCreator",
+    filterByTitle = "filterByTitle",
+    displayMode = "displayMode",
+    loadDesktopView = "loadDesktopView",
+    loadMobileView = "loadMobileView",
+    facetSelected = "facetSelected",
+    facetDeselected = "facetDeselected",
+    facetNegativeSelected = "facetNegativeSelected",
+    facetNegativeDeselected = "facetNegativeDeselected",
+    mobileFacetsToggled = "mobileFacetsToggled",
+    partOfCollectionClicked = "partOfCollectionClicked",
+    histogramChanged = "histogramChanged",
+    histogramChangedFromModal = "histogramChangedFromModal",
+    histogramExpanded = "histogramExpanded",
+    resultSelected = "resultSelected",
+    moreFacetsPageChange = "moreFacetsPageChange",
+    showMoreFacetsModal = "showMoreFacetsModal",
+    closeMoreFacetsModal = "closeMoreFacetsModal",
+    applyMoreFacetsModal = "applyMoreFacetsModal"
+}

package/dist/src/utils/analytics-events.js

@@ -1,31 +1,31 @@
-/**
- * Analytics categories and events. Used when building actions in
- */
-export var analyticsCategories;
-(function (analyticsCategories) {
-    analyticsCategories["default"] = "collection-browser";
-})(analyticsCategories || (analyticsCategories = {}));
-export var analyticsActions;
-(function (analyticsActions) {
-    analyticsActions["sortBy"] = "sortBy";
-    analyticsActions["filterByCreator"] = "filterByCreator";
-    analyticsActions["filterByTitle"] = "filterByTitle";
-    analyticsActions["displayMode"] = "displayMode";
-    analyticsActions["loadDesktopView"] = "loadDesktopView";
-    analyticsActions["loadMobileView"] = "loadMobileView";
-    analyticsActions["facetSelected"] = "facetSelected";
-    analyticsActions["facetDeselected"] = "facetDeselected";
-    analyticsActions["facetNegativeSelected"] = "facetNegativeSelected";
-    analyticsActions["facetNegativeDeselected"] = "facetNegativeDeselected";
-    analyticsActions["mobileFacetsToggled"] = "mobileFacetsToggled";
-    analyticsActions["partOfCollectionClicked"] = "partOfCollectionClicked";
-    analyticsActions["histogramChanged"] = "histogramChanged";
-    analyticsActions["histogramChangedFromModal"] = "histogramChangedFromModal";
-    analyticsActions["histogramExpanded"] = "histogramExpanded";
-    analyticsActions["resultSelected"] = "resultSelected";
-    analyticsActions["moreFacetsPageChange"] = "moreFacetsPageChange";
-    analyticsActions["showMoreFacetsModal"] = "showMoreFacetsModal";
-    analyticsActions["closeMoreFacetsModal"] = "closeMoreFacetsModal";
-    analyticsActions["applyMoreFacetsModal"] = "applyMoreFacetsModal";
-})(analyticsActions || (analyticsActions = {}));
+/**
+ * Analytics categories and events. Used when building actions in
+ */
+export var analyticsCategories;
+(function (analyticsCategories) {
+    analyticsCategories["default"] = "collection-browser";
+})(analyticsCategories || (analyticsCategories = {}));
+export var analyticsActions;
+(function (analyticsActions) {
+    analyticsActions["sortBy"] = "sortBy";
+    analyticsActions["filterByCreator"] = "filterByCreator";
+    analyticsActions["filterByTitle"] = "filterByTitle";
+    analyticsActions["displayMode"] = "displayMode";
+    analyticsActions["loadDesktopView"] = "loadDesktopView";
+    analyticsActions["loadMobileView"] = "loadMobileView";
+    analyticsActions["facetSelected"] = "facetSelected";
+    analyticsActions["facetDeselected"] = "facetDeselected";
+    analyticsActions["facetNegativeSelected"] = "facetNegativeSelected";
+    analyticsActions["facetNegativeDeselected"] = "facetNegativeDeselected";
+    analyticsActions["mobileFacetsToggled"] = "mobileFacetsToggled";
+    analyticsActions["partOfCollectionClicked"] = "partOfCollectionClicked";
+    analyticsActions["histogramChanged"] = "histogramChanged";
+    analyticsActions["histogramChangedFromModal"] = "histogramChangedFromModal";
+    analyticsActions["histogramExpanded"] = "histogramExpanded";
+    analyticsActions["resultSelected"] = "resultSelected";
+    analyticsActions["moreFacetsPageChange"] = "moreFacetsPageChange";
+    analyticsActions["showMoreFacetsModal"] = "showMoreFacetsModal";
+    analyticsActions["closeMoreFacetsModal"] = "closeMoreFacetsModal";
+    analyticsActions["applyMoreFacetsModal"] = "applyMoreFacetsModal";
+})(analyticsActions || (analyticsActions = {}));
 //# sourceMappingURL=analytics-events.js.map

package/dist/src/utils/array-equals.d.ts

@@ -1,4 +1,4 @@
-/**
- * Determines whether two arrays have the same (shallow) contents in the same order
- */
-export declare function arrayEquals(arr1: unknown[], arr2: unknown[]): boolean;
+/**
+ * Determines whether two arrays have the same (shallow) contents in the same order
+ */
+export declare function arrayEquals(arr1: unknown[], arr2: unknown[]): boolean;

package/dist/src/utils/array-equals.js

@@ -1,11 +1,11 @@
-/**
- * Determines whether two arrays have the same (shallow) contents in the same order
- */
-export function arrayEquals(arr1, arr2) {
-    if (arr1 === arr2)
-        return true;
-    if (arr1.length !== arr2.length)
-        return false;
-    return arr1.every((val, i) => val === arr2[i]);
-}
+/**
+ * Determines whether two arrays have the same (shallow) contents in the same order
+ */
+export function arrayEquals(arr1, arr2) {
+    if (arr1 === arr2)
+        return true;
+    if (arr1.length !== arr2.length)
+        return false;
+    return arr1.every((val, i) => val === arr2[i]);
+}
 //# sourceMappingURL=array-equals.js.map

package/dist/src/utils/collapse-repeated-quotes.d.ts

@@ -1,11 +1,11 @@
-/**
- * Returns the input string, but removing one set of quotes from all instances of
- * ""clauses wrapped in two sets of quotes"". This assumes the quotes are already
- * URL-encoded.
- *
- * This should be a temporary measure to address the fact that the __href__ field
- * sometimes acquires extra quotation marks during query rewriting. Once there is a
- * full Lucene parser in place that handles quoted queries correctly, this can likely
- * be removed.
- */
-export declare function collapseRepeatedQuotes(str?: string): string | undefined;
+/**
+ * Returns the input string, but removing one set of quotes from all instances of
+ * ""clauses wrapped in two sets of quotes"". This assumes the quotes are already
+ * URL-encoded.
+ *
+ * This should be a temporary measure to address the fact that the __href__ field
+ * sometimes acquires extra quotation marks during query rewriting. Once there is a
+ * full Lucene parser in place that handles quoted queries correctly, this can likely
+ * be removed.
+ */
+export declare function collapseRepeatedQuotes(str?: string): string | undefined;

package/dist/src/utils/collapse-repeated-quotes.js

@@ -1,14 +1,14 @@
-/**
- * Returns the input string, but removing one set of quotes from all instances of
- * ""clauses wrapped in two sets of quotes"". This assumes the quotes are already
- * URL-encoded.
- *
- * This should be a temporary measure to address the fact that the __href__ field
- * sometimes acquires extra quotation marks during query rewriting. Once there is a
- * full Lucene parser in place that handles quoted queries correctly, this can likely
- * be removed.
- */
-export function collapseRepeatedQuotes(str) {
-    return str === null || str === void 0 ? void 0 : str.replace(/%22%22(?!%22%22)(.+?)%22%22/g, '%22$1%22');
-}
+/**
+ * Returns the input string, but removing one set of quotes from all instances of
+ * ""clauses wrapped in two sets of quotes"". This assumes the quotes are already
+ * URL-encoded.
+ *
+ * This should be a temporary measure to address the fact that the __href__ field
+ * sometimes acquires extra quotation marks during query rewriting. Once there is a
+ * full Lucene parser in place that handles quoted queries correctly, this can likely
+ * be removed.
+ */
+export function collapseRepeatedQuotes(str) {
+    return str === null || str === void 0 ? void 0 : str.replace(/%22%22(?!%22%22)(.+?)%22%22/g, '%22$1%22');
+}
 //# sourceMappingURL=collapse-repeated-quotes.js.map

package/dist/src/utils/facet-utils.d.ts

@@ -0,0 +1,83 @@
+import { AggregationSortType } from '@internetarchive/search-service';
+import { FacetOption, type FacetBucket, type SelectedFacets } from '../models';
+/**
+ * Calls the given function for each FacetBucket specified in the given SelectedFacets
+ * object. The function is always called with the facet type, bucket key, bucket object,
+ * and the given SelectedFacets object.
+ *
+ * @param selectedFacets The SelectedFacets object whose buckets should be iterated over
+ * @param fn The function to apply to each facet bucket.
+ *
+ * @example
+ * forEachFacetBucket(
+ *   myFacets,
+ *   (facetType, bucketKey, bucket) => {
+ *     if (facetType === 'collection' && bucket.state === 'hidden') {
+ *       console.log(`Excluding any results in the ${bucketKey} collection`);
+ *     }
+ *   }
+ * );
+ */
+export declare function forEachFacetBucket(selectedFacets: SelectedFacets | undefined, fn: (facetType: FacetOption, bucketKey: string, bucket: FacetBucket, selectedFacets: SelectedFacets) => unknown): void;
+/**
+ * Returns a new SelectedFacets object having only the specified bucket changed to
+ * reflect its new provided value. The bucket key is determined from the provided
+ * `bucket` itself.
+ * @param selectedFacets The SelectedFacets object to produce an updated clone of
+ * @param facetType The type of facet to be modified (e.g., 'mediatype', 'subject', ...)
+ * @param bucket The new bucket that should be present on the result
+ * @param omitNoneState If set to true, the returned object will omit the given
+ * bucket entirely if it is updated to state `'none'`. Default is false, which leaves
+ * the `'none'` state in place.
+ */
+export declare function updateSelectedFacetBucket(selectedFacets: SelectedFacets | undefined, facetType: FacetOption, bucket: FacetBucket, omitNoneState?: boolean): SelectedFacets;
+/**
+ * Creates a clone of the given SelectedFacets object.
+ *
+ * Note that the underlying FacetBucket objects are not deep-cloned -- they will
+ * be references to the same objects as in the input. However, the objects
+ * containing the FacetBuckets for each FacetOption are created anew.
+ *
+ * If the provided argument is undefined, returns an empty SelectedFacets object.
+ *
+ * @param selectedFacets The SelectedFacets object to be cloned
+ */
+export declare function cloneSelectedFacets(selectedFacets: SelectedFacets | undefined): SelectedFacets;
+/**
+ * Creates a new SelectedFacets object representing a merge of the `source` facets object
+ * into the `destination` facets object. Any facets existing in `source` take precedence
+ * over those in `destination` in the event of conflicts.
+ *
+ * The resulting SelectedFacets object is normalized to omit any facet buckets whose
+ * state is `'none'` in the merged result. Consequently, any facets buckets with state
+ * `'none'` in `source` will always be absent from the end result. Likewise, any facet
+ * buckets with state `'none'` in `destination` will be absent _unless_ they are also
+ * present in `source` with a state of `'selected'` or `'hidden'` (in which case `source`
+ * takes precedence as usual).
+ *
+ * @param source The source of the new facets to merge in. Any facet buckets existing in
+ * this `source` object will take precedence over those in `destination` having the same
+ * key, if they exist in both. Any facet buckets that are _not_ present in `source` will
+ * remain unmodified from their state in `destination`, if they are present there at all.
+ * @param destination The destination onto which facets should be merged. Note that this
+ * object is _not_ re-used for the return value, but it is conceptually the "existing base"
+ * onto which the source facets are merged.
+ */
+export declare function mergeSelectedFacets(destination: SelectedFacets | undefined, source: SelectedFacets | undefined): SelectedFacets;
+/**
+ * Sorts the provided FacetBuckets so that:
+ * - Any selected items come first
+ * - Any hidden items come after all the selected items
+ * - Any unselected / unhidden items come last
+ *
+ * Within each of the above groups, the buckets will be sorted according to
+ * the provided sort type, or by their bucket count by default.
+ *
+ * The sort is performed in-place using `Array.sort`, so the return value is
+ * a reference to the same array that was passed in, only sorted.
+ *
+ * @param buckets The array of facet buckets to sort
+ * @param sort (Optional) How buckets within each state group should be sorted.
+ * Defaults to `AggregationSortType.COUNT` (i.e., descending by bucket count).
+ */
+export declare function sortBucketsBySelectionState(buckets: FacetBucket[], sort?: AggregationSortType): FacetBucket[];

package/dist/src/utils/facet-utils.js

@@ -0,0 +1,146 @@
+import { AggregationSortType } from '@internetarchive/search-service';
+import { getDefaultSelectedFacets, } from '../models';
+// This file contains several helper functions designed to make working immutably
+// with SelectedFacet objects and FacetGroups cleaner & easier.
+/**
+ * Calls the given function for each FacetBucket specified in the given SelectedFacets
+ * object. The function is always called with the facet type, bucket key, bucket object,
+ * and the given SelectedFacets object.
+ *
+ * @param selectedFacets The SelectedFacets object whose buckets should be iterated over
+ * @param fn The function to apply to each facet bucket.
+ *
+ * @example
+ * forEachFacetBucket(
+ *   myFacets,
+ *   (facetType, bucketKey, bucket) => {
+ *     if (facetType === 'collection' && bucket.state === 'hidden') {
+ *       console.log(`Excluding any results in the ${bucketKey} collection`);
+ *     }
+ *   }
+ * );
+ */
+export function forEachFacetBucket(selectedFacets, fn) {
+    if (!selectedFacets)
+        return;
+    for (const [facetType, facetBuckets] of Object.entries(selectedFacets)) {
+        for (const [bucketKey, bucket] of Object.entries(facetBuckets)) {
+            fn(facetType, bucketKey, bucket, selectedFacets);
+        }
+    }
+}
+/**
+ * Returns a new SelectedFacets object having only the specified bucket changed to
+ * reflect its new provided value. The bucket key is determined from the provided
+ * `bucket` itself.
+ * @param selectedFacets The SelectedFacets object to produce an updated clone of
+ * @param facetType The type of facet to be modified (e.g., 'mediatype', 'subject', ...)
+ * @param bucket The new bucket that should be present on the result
+ * @param omitNoneState If set to true, the returned object will omit the given
+ * bucket entirely if it is updated to state `'none'`. Default is false, which leaves
+ * the `'none'` state in place.
+ */
+export function updateSelectedFacetBucket(selectedFacets, facetType, bucket, omitNoneState = false) {
+    const defaultedSelectedFacets = selectedFacets !== null && selectedFacets !== void 0 ? selectedFacets : getDefaultSelectedFacets();
+    const newFacets = {
+        ...defaultedSelectedFacets,
+        [facetType]: {
+            ...defaultedSelectedFacets[facetType],
+            [bucket.key]: bucket,
+        },
+    };
+    if (omitNoneState && bucket.state === 'none') {
+        delete newFacets[facetType][bucket.key];
+    }
+    return newFacets;
+}
+/**
+ * Creates a clone of the given SelectedFacets object.
+ *
+ * Note that the underlying FacetBucket objects are not deep-cloned -- they will
+ * be references to the same objects as in the input. However, the objects
+ * containing the FacetBuckets for each FacetOption are created anew.
+ *
+ * If the provided argument is undefined, returns an empty SelectedFacets object.
+ *
+ * @param selectedFacets The SelectedFacets object to be cloned
+ */
+export function cloneSelectedFacets(selectedFacets) {
+    const cloneResult = getDefaultSelectedFacets();
+    forEachFacetBucket(selectedFacets, (facetType, bucketKey, bucket) => {
+        cloneResult[facetType][bucketKey] = bucket;
+    });
+    return cloneResult;
+}
+/**
+ * Creates a new SelectedFacets object representing a merge of the `source` facets object
+ * into the `destination` facets object. Any facets existing in `source` take precedence
+ * over those in `destination` in the event of conflicts.
+ *
+ * The resulting SelectedFacets object is normalized to omit any facet buckets whose
+ * state is `'none'` in the merged result. Consequently, any facets buckets with state
+ * `'none'` in `source` will always be absent from the end result. Likewise, any facet
+ * buckets with state `'none'` in `destination` will be absent _unless_ they are also
+ * present in `source` with a state of `'selected'` or `'hidden'` (in which case `source`
+ * takes precedence as usual).
+ *
+ * @param source The source of the new facets to merge in. Any facet buckets existing in
+ * this `source` object will take precedence over those in `destination` having the same
+ * key, if they exist in both. Any facet buckets that are _not_ present in `source` will
+ * remain unmodified from their state in `destination`, if they are present there at all.
+ * @param destination The destination onto which facets should be merged. Note that this
+ * object is _not_ re-used for the return value, but it is conceptually the "existing base"
+ * onto which the source facets are merged.
+ */
+export function mergeSelectedFacets(destination, source) {
+    const mergeResult = cloneSelectedFacets(destination);
+    forEachFacetBucket(source, (facetType, bucketKey, bucket) => {
+        mergeResult[facetType][bucketKey] = bucket;
+    });
+    // Normalize any 'none' states on the result (from either source or destination)
+    forEachFacetBucket(mergeResult, (facetType, bucketKey, bucket) => {
+        if (bucket.state === 'none') {
+            delete mergeResult[facetType][bucketKey];
+        }
+    });
+    return mergeResult;
+}
+/**
+ * Defines the order of states in which to display SelectedFacets buckets
+ */
+const BUCKET_STATE_ORDER = ['selected', 'hidden', 'none'];
+/**
+ * Sorts the provided FacetBuckets so that:
+ * - Any selected items come first
+ * - Any hidden items come after all the selected items
+ * - Any unselected / unhidden items come last
+ *
+ * Within each of the above groups, the buckets will be sorted according to
+ * the provided sort type, or by their bucket count by default.
+ *
+ * The sort is performed in-place using `Array.sort`, so the return value is
+ * a reference to the same array that was passed in, only sorted.
+ *
+ * @param buckets The array of facet buckets to sort
+ * @param sort (Optional) How buckets within each state group should be sorted.
+ * Defaults to `AggregationSortType.COUNT` (i.e., descending by bucket count).
+ */
+export function sortBucketsBySelectionState(buckets, sort = AggregationSortType.COUNT) {
+    return buckets.sort((a, b) => {
+        const aStateIndex = BUCKET_STATE_ORDER.indexOf(a.state);
+        const bStateIndex = BUCKET_STATE_ORDER.indexOf(b.state);
+        const stateDiff = aStateIndex - bStateIndex; // Sort bucket states primarily in the order defined by BUCKET_STATE_ORDER
+        let secondaryDiff;
+        if (sort === AggregationSortType.ALPHABETICAL) {
+            secondaryDiff = a.key.localeCompare(b.key); // Ascending alphabetically by bucket key
+        }
+        else if (sort === AggregationSortType.NUMERIC) {
+            secondaryDiff = Number(b.key) - Number(a.key); // Descending numerically by bucket key
+        }
+        else {
+            secondaryDiff = b.count - a.count; // Descending by bucket count
+        }
+        return stateDiff || secondaryDiff; // Primary sort on state, secondary sort on the given sort type (defaulting to descending count)
+    });
+}
+//# sourceMappingURL=facet-utils.js.map