@internetarchive/collection-browser 2.7.12 → 2.7.13-alpha1

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

@@ -1,83 +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[];
+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

@@ -1,146 +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)
-    });
-}
+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

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

@@ -1 +1 @@
-{"version":3,"file":"facet-utils.js","sourceRoot":"","sources":["../../../src/utils/facet-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAEL,wBAAwB,GAGzB,MAAM,WAAW,CAAC;AAEnB,iFAAiF;AACjF,+DAA+D;AAE/D;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,kBAAkB,CAChC,cAA0C,EAC1C,EAKY;IAEZ,IAAI,CAAC,cAAc;QAAE,OAAO;IAC5B,KAAK,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;QACtE,KAAK,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YAC9D,EAAE,CAAC,SAAwB,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;SACjE;KACF;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,yBAAyB,CACvC,cAA0C,EAC1C,SAAsB,EACtB,MAAmB,EACnB,aAAa,GAAG,KAAK;IAErB,MAAM,uBAAuB,GAAG,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,wBAAwB,EAAE,CAAC;IAC7E,MAAM,SAAS,GAAG;QAChB,GAAG,uBAAuB;QAC1B,CAAC,SAAS,CAAC,EAAE;YACX,GAAG,uBAAuB,CAAC,SAAS,CAAC;YACrC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM;SACrB;KACF,CAAC;IAEF,IAAI,aAAa,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,EAAE;QAC5C,OAAO,SAAS,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;KACzC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,mBAAmB,CACjC,cAA0C;IAE1C,MAAM,WAAW,GAAG,wBAAwB,EAAE,CAAC;IAC/C,kBAAkB,CAAC,cAAc,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE;QAClE,WAAW,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;IAC7C,CAAC,CAAC,CAAC;IACH,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,mBAAmB,CACjC,WAAuC,EACvC,MAAkC;IAElC,MAAM,WAAW,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACrD,kBAAkB,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE;QAC1D,WAAW,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,gFAAgF;IAChF,kBAAkB,CAAC,WAAW,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE;QAC/D,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,EAAE;YAC3B,OAAO,WAAW,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;SAC1C;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,MAAM,kBAAkB,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,2BAA2B,CACzC,OAAsB,EACtB,IAAI,GAAG,mBAAmB,CAAC,KAAK;IAEhC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAC3B,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACxD,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACxD,MAAM,SAAS,GAAG,WAAW,GAAG,WAAW,CAAC,CAAC,0EAA0E;QAEvH,IAAI,aAAa,CAAC;QAClB,IAAI,IAAI,KAAK,mBAAmB,CAAC,YAAY,EAAE;YAC7C,aAAa,GAAG,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,yCAAyC;SACtF;aAAM,IAAI,IAAI,KAAK,mBAAmB,CAAC,OAAO,EAAE;YAC/C,aAAa,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,uCAAuC;SACvF;aAAM;YACL,aAAa,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,6BAA6B;SACjE;QAED,OAAO,SAAS,IAAI,aAAa,CAAC,CAAC,gGAAgG;IACrI,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { AggregationSortType } from '@internetarchive/search-service';\nimport {\n  FacetOption,\n  getDefaultSelectedFacets,\n  type FacetBucket,\n  type SelectedFacets,\n} from '../models';\n\n// This file contains several helper functions designed to make working immutably\n// with SelectedFacet objects and FacetGroups cleaner & easier.\n\n/**\n * Calls the given function for each FacetBucket specified in the given SelectedFacets\n * object. The function is always called with the facet type, bucket key, bucket object,\n * and the given SelectedFacets object.\n *\n * @param selectedFacets The SelectedFacets object whose buckets should be iterated over\n * @param fn The function to apply to each facet bucket.\n *\n * @example\n * forEachFacetBucket(\n *   myFacets,\n *   (facetType, bucketKey, bucket) => {\n *     if (facetType === 'collection' && bucket.state === 'hidden') {\n *       console.log(`Excluding any results in the ${bucketKey} collection`);\n *     }\n *   }\n * );\n */\nexport function forEachFacetBucket(\n  selectedFacets: SelectedFacets | undefined,\n  fn: (\n    facetType: FacetOption,\n    bucketKey: string,\n    bucket: FacetBucket,\n    selectedFacets: SelectedFacets\n  ) => unknown\n): void {\n  if (!selectedFacets) return;\n  for (const [facetType, facetBuckets] of Object.entries(selectedFacets)) {\n    for (const [bucketKey, bucket] of Object.entries(facetBuckets)) {\n      fn(facetType as FacetOption, bucketKey, bucket, selectedFacets);\n    }\n  }\n}\n\n/**\n * Returns a new SelectedFacets object having only the specified bucket changed to\n * reflect its new provided value. The bucket key is determined from the provided\n * `bucket` itself.\n * @param selectedFacets The SelectedFacets object to produce an updated clone of\n * @param facetType The type of facet to be modified (e.g., 'mediatype', 'subject', ...)\n * @param bucket The new bucket that should be present on the result\n * @param omitNoneState If set to true, the returned object will omit the given\n * bucket entirely if it is updated to state `'none'`. Default is false, which leaves\n * the `'none'` state in place.\n */\nexport function updateSelectedFacetBucket(\n  selectedFacets: SelectedFacets | undefined,\n  facetType: FacetOption,\n  bucket: FacetBucket,\n  omitNoneState = false\n): SelectedFacets {\n  const defaultedSelectedFacets = selectedFacets ?? getDefaultSelectedFacets();\n  const newFacets = {\n    ...defaultedSelectedFacets,\n    [facetType]: {\n      ...defaultedSelectedFacets[facetType],\n      [bucket.key]: bucket,\n    },\n  };\n\n  if (omitNoneState && bucket.state === 'none') {\n    delete newFacets[facetType][bucket.key];\n  }\n\n  return newFacets;\n}\n\n/**\n * Creates a clone of the given SelectedFacets object.\n *\n * Note that the underlying FacetBucket objects are not deep-cloned -- they will\n * be references to the same objects as in the input. However, the objects\n * containing the FacetBuckets for each FacetOption are created anew.\n *\n * If the provided argument is undefined, returns an empty SelectedFacets object.\n *\n * @param selectedFacets The SelectedFacets object to be cloned\n */\nexport function cloneSelectedFacets(\n  selectedFacets: SelectedFacets | undefined\n): SelectedFacets {\n  const cloneResult = getDefaultSelectedFacets();\n  forEachFacetBucket(selectedFacets, (facetType, bucketKey, bucket) => {\n    cloneResult[facetType][bucketKey] = bucket;\n  });\n  return cloneResult;\n}\n\n/**\n * Creates a new SelectedFacets object representing a merge of the `source` facets object\n * into the `destination` facets object. Any facets existing in `source` take precedence\n * over those in `destination` in the event of conflicts.\n *\n * The resulting SelectedFacets object is normalized to omit any facet buckets whose\n * state is `'none'` in the merged result. Consequently, any facets buckets with state\n * `'none'` in `source` will always be absent from the end result. Likewise, any facet\n * buckets with state `'none'` in `destination` will be absent _unless_ they are also\n * present in `source` with a state of `'selected'` or `'hidden'` (in which case `source`\n * takes precedence as usual).\n *\n * @param source The source of the new facets to merge in. Any facet buckets existing in\n * this `source` object will take precedence over those in `destination` having the same\n * key, if they exist in both. Any facet buckets that are _not_ present in `source` will\n * remain unmodified from their state in `destination`, if they are present there at all.\n * @param destination The destination onto which facets should be merged. Note that this\n * object is _not_ re-used for the return value, but it is conceptually the \"existing base\"\n * onto which the source facets are merged.\n */\nexport function mergeSelectedFacets(\n  destination: SelectedFacets | undefined,\n  source: SelectedFacets | undefined\n): SelectedFacets {\n  const mergeResult = cloneSelectedFacets(destination);\n  forEachFacetBucket(source, (facetType, bucketKey, bucket) => {\n    mergeResult[facetType][bucketKey] = bucket;\n  });\n\n  // Normalize any 'none' states on the result (from either source or destination)\n  forEachFacetBucket(mergeResult, (facetType, bucketKey, bucket) => {\n    if (bucket.state === 'none') {\n      delete mergeResult[facetType][bucketKey];\n    }\n  });\n\n  return mergeResult;\n}\n\n/**\n * Defines the order of states in which to display SelectedFacets buckets\n */\nconst BUCKET_STATE_ORDER = ['selected', 'hidden', 'none'];\n\n/**\n * Sorts the provided FacetBuckets so that:\n * - Any selected items come first\n * - Any hidden items come after all the selected items\n * - Any unselected / unhidden items come last\n *\n * Within each of the above groups, the buckets will be sorted according to\n * the provided sort type, or by their bucket count by default.\n *\n * The sort is performed in-place using `Array.sort`, so the return value is\n * a reference to the same array that was passed in, only sorted.\n *\n * @param buckets The array of facet buckets to sort\n * @param sort (Optional) How buckets within each state group should be sorted.\n * Defaults to `AggregationSortType.COUNT` (i.e., descending by bucket count).\n */\nexport function sortBucketsBySelectionState(\n  buckets: FacetBucket[],\n  sort = AggregationSortType.COUNT\n) {\n  return buckets.sort((a, b) => {\n    const aStateIndex = BUCKET_STATE_ORDER.indexOf(a.state);\n    const bStateIndex = BUCKET_STATE_ORDER.indexOf(b.state);\n    const stateDiff = aStateIndex - bStateIndex; // Sort bucket states primarily in the order defined by BUCKET_STATE_ORDER\n\n    let secondaryDiff;\n    if (sort === AggregationSortType.ALPHABETICAL) {\n      secondaryDiff = a.key.localeCompare(b.key); // Ascending alphabetically by bucket key\n    } else if (sort === AggregationSortType.NUMERIC) {\n      secondaryDiff = Number(b.key) - Number(a.key); // Descending numerically by bucket key\n    } else {\n      secondaryDiff = b.count - a.count; // Descending by bucket count\n    }\n\n    return stateDiff || secondaryDiff; // Primary sort on state, secondary sort on the given sort type (defaulting to descending count)\n  });\n}\n"]}
+{"version":3,"file":"facet-utils.js","sourceRoot":"","sources":["../../../src/utils/facet-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAEL,wBAAwB,GAGzB,MAAM,WAAW,CAAC;AAEnB,iFAAiF;AACjF,+DAA+D;AAE/D;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,kBAAkB,CAChC,cAA0C,EAC1C,EAKY;IAEZ,IAAI,CAAC,cAAc;QAAE,OAAO;IAC5B,KAAK,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;QACvE,KAAK,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YAC/D,EAAE,CAAC,SAAwB,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,yBAAyB,CACvC,cAA0C,EAC1C,SAAsB,EACtB,MAAmB,EACnB,aAAa,GAAG,KAAK;IAErB,MAAM,uBAAuB,GAAG,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,wBAAwB,EAAE,CAAC;IAC7E,MAAM,SAAS,GAAG;QAChB,GAAG,uBAAuB;QAC1B,CAAC,SAAS,CAAC,EAAE;YACX,GAAG,uBAAuB,CAAC,SAAS,CAAC;YACrC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM;SACrB;KACF,CAAC;IAEF,IAAI,aAAa,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;QAC7C,OAAO,SAAS,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,mBAAmB,CACjC,cAA0C;IAE1C,MAAM,WAAW,GAAG,wBAAwB,EAAE,CAAC;IAC/C,kBAAkB,CAAC,cAAc,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE;QAClE,WAAW,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;IAC7C,CAAC,CAAC,CAAC;IACH,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,mBAAmB,CACjC,WAAuC,EACvC,MAAkC;IAElC,MAAM,WAAW,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACrD,kBAAkB,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE;QAC1D,WAAW,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,gFAAgF;IAChF,kBAAkB,CAAC,WAAW,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE;QAC/D,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;YAC5B,OAAO,WAAW,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,MAAM,kBAAkB,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,2BAA2B,CACzC,OAAsB,EACtB,IAAI,GAAG,mBAAmB,CAAC,KAAK;IAEhC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAC3B,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACxD,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACxD,MAAM,SAAS,GAAG,WAAW,GAAG,WAAW,CAAC,CAAC,0EAA0E;QAEvH,IAAI,aAAa,CAAC;QAClB,IAAI,IAAI,KAAK,mBAAmB,CAAC,YAAY,EAAE,CAAC;YAC9C,aAAa,GAAG,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,yCAAyC;QACvF,CAAC;aAAM,IAAI,IAAI,KAAK,mBAAmB,CAAC,OAAO,EAAE,CAAC;YAChD,aAAa,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,uCAAuC;QACxF,CAAC;aAAM,CAAC;YACN,aAAa,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,6BAA6B;QAClE,CAAC;QAED,OAAO,SAAS,IAAI,aAAa,CAAC,CAAC,gGAAgG;IACrI,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { AggregationSortType } from '@internetarchive/search-service';\nimport {\n  FacetOption,\n  getDefaultSelectedFacets,\n  type FacetBucket,\n  type SelectedFacets,\n} from '../models';\n\n// This file contains several helper functions designed to make working immutably\n// with SelectedFacet objects and FacetGroups cleaner & easier.\n\n/**\n * Calls the given function for each FacetBucket specified in the given SelectedFacets\n * object. The function is always called with the facet type, bucket key, bucket object,\n * and the given SelectedFacets object.\n *\n * @param selectedFacets The SelectedFacets object whose buckets should be iterated over\n * @param fn The function to apply to each facet bucket.\n *\n * @example\n * forEachFacetBucket(\n *   myFacets,\n *   (facetType, bucketKey, bucket) => {\n *     if (facetType === 'collection' && bucket.state === 'hidden') {\n *       console.log(`Excluding any results in the ${bucketKey} collection`);\n *     }\n *   }\n * );\n */\nexport function forEachFacetBucket(\n  selectedFacets: SelectedFacets | undefined,\n  fn: (\n    facetType: FacetOption,\n    bucketKey: string,\n    bucket: FacetBucket,\n    selectedFacets: SelectedFacets,\n  ) => unknown,\n): void {\n  if (!selectedFacets) return;\n  for (const [facetType, facetBuckets] of Object.entries(selectedFacets)) {\n    for (const [bucketKey, bucket] of Object.entries(facetBuckets)) {\n      fn(facetType as FacetOption, bucketKey, bucket, selectedFacets);\n    }\n  }\n}\n\n/**\n * Returns a new SelectedFacets object having only the specified bucket changed to\n * reflect its new provided value. The bucket key is determined from the provided\n * `bucket` itself.\n * @param selectedFacets The SelectedFacets object to produce an updated clone of\n * @param facetType The type of facet to be modified (e.g., 'mediatype', 'subject', ...)\n * @param bucket The new bucket that should be present on the result\n * @param omitNoneState If set to true, the returned object will omit the given\n * bucket entirely if it is updated to state `'none'`. Default is false, which leaves\n * the `'none'` state in place.\n */\nexport function updateSelectedFacetBucket(\n  selectedFacets: SelectedFacets | undefined,\n  facetType: FacetOption,\n  bucket: FacetBucket,\n  omitNoneState = false,\n): SelectedFacets {\n  const defaultedSelectedFacets = selectedFacets ?? getDefaultSelectedFacets();\n  const newFacets = {\n    ...defaultedSelectedFacets,\n    [facetType]: {\n      ...defaultedSelectedFacets[facetType],\n      [bucket.key]: bucket,\n    },\n  };\n\n  if (omitNoneState && bucket.state === 'none') {\n    delete newFacets[facetType][bucket.key];\n  }\n\n  return newFacets;\n}\n\n/**\n * Creates a clone of the given SelectedFacets object.\n *\n * Note that the underlying FacetBucket objects are not deep-cloned -- they will\n * be references to the same objects as in the input. However, the objects\n * containing the FacetBuckets for each FacetOption are created anew.\n *\n * If the provided argument is undefined, returns an empty SelectedFacets object.\n *\n * @param selectedFacets The SelectedFacets object to be cloned\n */\nexport function cloneSelectedFacets(\n  selectedFacets: SelectedFacets | undefined,\n): SelectedFacets {\n  const cloneResult = getDefaultSelectedFacets();\n  forEachFacetBucket(selectedFacets, (facetType, bucketKey, bucket) => {\n    cloneResult[facetType][bucketKey] = bucket;\n  });\n  return cloneResult;\n}\n\n/**\n * Creates a new SelectedFacets object representing a merge of the `source` facets object\n * into the `destination` facets object. Any facets existing in `source` take precedence\n * over those in `destination` in the event of conflicts.\n *\n * The resulting SelectedFacets object is normalized to omit any facet buckets whose\n * state is `'none'` in the merged result. Consequently, any facets buckets with state\n * `'none'` in `source` will always be absent from the end result. Likewise, any facet\n * buckets with state `'none'` in `destination` will be absent _unless_ they are also\n * present in `source` with a state of `'selected'` or `'hidden'` (in which case `source`\n * takes precedence as usual).\n *\n * @param source The source of the new facets to merge in. Any facet buckets existing in\n * this `source` object will take precedence over those in `destination` having the same\n * key, if they exist in both. Any facet buckets that are _not_ present in `source` will\n * remain unmodified from their state in `destination`, if they are present there at all.\n * @param destination The destination onto which facets should be merged. Note that this\n * object is _not_ re-used for the return value, but it is conceptually the \"existing base\"\n * onto which the source facets are merged.\n */\nexport function mergeSelectedFacets(\n  destination: SelectedFacets | undefined,\n  source: SelectedFacets | undefined,\n): SelectedFacets {\n  const mergeResult = cloneSelectedFacets(destination);\n  forEachFacetBucket(source, (facetType, bucketKey, bucket) => {\n    mergeResult[facetType][bucketKey] = bucket;\n  });\n\n  // Normalize any 'none' states on the result (from either source or destination)\n  forEachFacetBucket(mergeResult, (facetType, bucketKey, bucket) => {\n    if (bucket.state === 'none') {\n      delete mergeResult[facetType][bucketKey];\n    }\n  });\n\n  return mergeResult;\n}\n\n/**\n * Defines the order of states in which to display SelectedFacets buckets\n */\nconst BUCKET_STATE_ORDER = ['selected', 'hidden', 'none'];\n\n/**\n * Sorts the provided FacetBuckets so that:\n * - Any selected items come first\n * - Any hidden items come after all the selected items\n * - Any unselected / unhidden items come last\n *\n * Within each of the above groups, the buckets will be sorted according to\n * the provided sort type, or by their bucket count by default.\n *\n * The sort is performed in-place using `Array.sort`, so the return value is\n * a reference to the same array that was passed in, only sorted.\n *\n * @param buckets The array of facet buckets to sort\n * @param sort (Optional) How buckets within each state group should be sorted.\n * Defaults to `AggregationSortType.COUNT` (i.e., descending by bucket count).\n */\nexport function sortBucketsBySelectionState(\n  buckets: FacetBucket[],\n  sort = AggregationSortType.COUNT,\n) {\n  return buckets.sort((a, b) => {\n    const aStateIndex = BUCKET_STATE_ORDER.indexOf(a.state);\n    const bStateIndex = BUCKET_STATE_ORDER.indexOf(b.state);\n    const stateDiff = aStateIndex - bStateIndex; // Sort bucket states primarily in the order defined by BUCKET_STATE_ORDER\n\n    let secondaryDiff;\n    if (sort === AggregationSortType.ALPHABETICAL) {\n      secondaryDiff = a.key.localeCompare(b.key); // Ascending alphabetically by bucket key\n    } else if (sort === AggregationSortType.NUMERIC) {\n      secondaryDiff = Number(b.key) - Number(a.key); // Descending numerically by bucket key\n    } else {\n      secondaryDiff = b.count - a.count; // Descending by bucket count\n    }\n\n    return stateDiff || secondaryDiff; // Primary sort on state, secondary sort on the given sort type (defaulting to descending count)\n  });\n}\n"]}

package/dist/src/utils/format-count.d.ts

@@ -1,7 +1,7 @@
-export declare type NumberFormat = 'short' | 'long';
-export declare type LabelFormat = 'short' | 'long';
-/**
- * Format a "count" number into short "icon" or longer text string.
- * For positive numbers only.
- */
-export declare function formatCount(count: number | undefined, numberFormat?: NumberFormat, labelFormat?: LabelFormat, locale?: string): string;
+export type NumberFormat = 'short' | 'long';
+export type LabelFormat = 'short' | 'long';
+/**
+ * Format a "count" number into short "icon" or longer text string.
+ * For positive numbers only.
+ */
+export declare function formatCount(count: number | undefined, numberFormat?: NumberFormat, labelFormat?: LabelFormat, locale?: string): string;