@internetarchive/collection-browser 3.3.2 → 3.3.3

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

@@ -0,0 +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,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,GAAmB;QAChC,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;QACtC,MAAA,SAAS,CAAC,SAAS,CAAC,+CAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IAC5C,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,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;YAAE,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;QACzD,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,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;YAAE,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;QACzD,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;YACrB,MAAA,WAAW,CAAC,SAAS,CAAC,+CAAG,SAAS,CAAC,CAAC;QAC7C,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: SelectedFacets = {\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    if (!cloneResult[facetType]) cloneResult[facetType] = {};\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    if (!mergeResult[facetType]) mergeResult[facetType] = {};\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

@@ -0,0 +1,7 @@
+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;

package/dist/src/utils/format-count.js

@@ -0,0 +1,76 @@
+/*
+ * Replaces Petabox www/common/Util::number_format()
+ * For positive numbers only.
+ */
+import { msg, str } from '@lit/localize';
+/**
+ * Return the magnitude of a number.
+ */
+function magnitude(number, numberFormat) {
+    let divisor = 1;
+    if (number >= 1000000000) {
+        divisor = 1000000000;
+    }
+    else if (number >= 1000000) {
+        divisor = 1000000;
+    }
+    else if (number >= 1000 && numberFormat === 'short') {
+        divisor = 1000;
+    }
+    return divisor;
+}
+/**
+ * Round a number given passed magnitude.
+ * Significant digits of value less than 10 get a decimal.
+ */
+function round(number = 0, divisor) {
+    const result = number / divisor;
+    const roundToOne = result < 10;
+    let rounded = 0;
+    if (roundToOne) {
+        rounded = Math.round((result + Number.EPSILON) * 10) / 10;
+    }
+    else {
+        rounded = Math.round(result);
+    }
+    return rounded;
+}
+/**
+ * Return a label for a number and format.
+ */
+function labelize(rounded, divisor, format, locale) {
+    switch (divisor) {
+        case 1000000000:
+            if (format === 'short') {
+                return msg(str `${rounded}B`);
+            }
+            return msg(str `${rounded} billion`);
+        case 1000000:
+            if (format === 'short') {
+                return msg(str `${rounded}M`);
+            }
+            return msg(str `${rounded} million`);
+        case 1000:
+            if (format === 'short') {
+                return msg(str `${rounded}K`);
+            }
+            return msg(str `${rounded} thousand`);
+        default:
+            return new Intl.NumberFormat(locale).format(rounded);
+    }
+}
+/**
+ * Format a "count" number into short "icon" or longer text string.
+ * For positive numbers only.
+ */
+export function formatCount(count, numberFormat = 'long', labelFormat = 'short', locale = 'en-US') {
+    // Return blank if undefined
+    const number = count !== null && count !== void 0 ? count : -1;
+    if (number < 0) {
+        return '';
+    }
+    const divisor = magnitude(number, numberFormat);
+    const rounded = round(number, divisor);
+    return labelize(rounded, divisor, labelFormat, locale);
+}
+//# sourceMappingURL=format-count.js.map

package/dist/src/utils/format-count.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-count.js","sourceRoot":"","sources":["../../../src/utils/format-count.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAUzC;;GAEG;AACH,SAAS,SAAS,CAAC,MAAc,EAAE,YAA0B;IAC3D,IAAI,OAAO,GAAY,CAAC,CAAC;IACzB,IAAI,MAAM,IAAI,UAAa,EAAE,CAAC;QAC5B,OAAO,GAAG,UAAa,CAAC;IAC1B,CAAC;SAAM,IAAI,MAAM,IAAI,OAAS,EAAE,CAAC;QAC/B,OAAO,GAAG,OAAS,CAAC;IACtB,CAAC;SAAM,IAAI,MAAM,IAAI,IAAK,IAAI,YAAY,KAAK,OAAO,EAAE,CAAC;QACvD,OAAO,GAAG,IAAK,CAAC;IAClB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,SAAS,KAAK,CAAC,SAAiB,CAAC,EAAE,OAAgB;IACjD,MAAM,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAChC,MAAM,UAAU,GAAG,MAAM,GAAG,EAAE,CAAC;IAC/B,IAAI,OAAO,GAAW,CAAC,CAAC;IACxB,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC;IAC5D,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,SAAS,QAAQ,CACf,OAAe,EACf,OAAgB,EAChB,MAAmB,EACnB,MAAc;IAEd,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,UAAa;YAChB,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC,GAAG,CAAA,GAAG,OAAO,GAAG,CAAC,CAAC;YAC/B,CAAC;YACD,OAAO,GAAG,CAAC,GAAG,CAAA,GAAG,OAAO,UAAU,CAAC,CAAC;QACtC,KAAK,OAAS;YACZ,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC,GAAG,CAAA,GAAG,OAAO,GAAG,CAAC,CAAC;YAC/B,CAAC;YACD,OAAO,GAAG,CAAC,GAAG,CAAA,GAAG,OAAO,UAAU,CAAC,CAAC;QACtC,KAAK,IAAK;YACR,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC,GAAG,CAAA,GAAG,OAAO,GAAG,CAAC,CAAC;YAC/B,CAAC;YACD,OAAO,GAAG,CAAC,GAAG,CAAA,GAAG,OAAO,WAAW,CAAC,CAAC;QAEvC;YACE,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CACzB,KAAyB,EACzB,eAA6B,MAAM,EACnC,cAA2B,OAAO,EAClC,SAAiB,OAAO;IAExB,4BAA4B;IAC5B,MAAM,MAAM,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,CAAC,CAAC,CAAC;IAC3B,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QACf,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,OAAO,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC","sourcesContent":["/*\n * Replaces Petabox www/common/Util::number_format()\n * For positive numbers only.\n */\nimport { msg, str } from '@lit/localize';\n\nexport type NumberFormat =\n  | 'short' // 1.2 [K | thousand]\n  | 'long'; // 1,200 [No label for numbers < 1,000,000]\nexport type LabelFormat =\n  | 'short' // [1.2]K\n  | 'long'; // [1.2] thousand\ntype Divisor = 1_000_000_000 | 1_000_000 | 1_000 | 1;\n\n/**\n * Return the magnitude of a number.\n */\nfunction magnitude(number: number, numberFormat: NumberFormat): Divisor {\n  let divisor: Divisor = 1;\n  if (number >= 1_000_000_000) {\n    divisor = 1_000_000_000;\n  } else if (number >= 1_000_000) {\n    divisor = 1_000_000;\n  } else if (number >= 1_000 && numberFormat === 'short') {\n    divisor = 1_000;\n  }\n  return divisor;\n}\n\n/**\n * Round a number given passed magnitude.\n * Significant digits of value less than 10 get a decimal.\n */\nfunction round(number: number = 0, divisor: Divisor): number {\n  const result = number / divisor;\n  const roundToOne = result < 10;\n  let rounded: number = 0;\n  if (roundToOne) {\n    rounded = Math.round((result + Number.EPSILON) * 10) / 10;\n  } else {\n    rounded = Math.round(result);\n  }\n  return rounded;\n}\n\n/**\n * Return a label for a number and format.\n */\nfunction labelize(\n  rounded: number,\n  divisor: Divisor,\n  format: LabelFormat,\n  locale: string,\n): string {\n  switch (divisor) {\n    case 1_000_000_000:\n      if (format === 'short') {\n        return msg(str`${rounded}B`);\n      }\n      return msg(str`${rounded} billion`);\n    case 1_000_000:\n      if (format === 'short') {\n        return msg(str`${rounded}M`);\n      }\n      return msg(str`${rounded} million`);\n    case 1_000:\n      if (format === 'short') {\n        return msg(str`${rounded}K`);\n      }\n      return msg(str`${rounded} thousand`);\n\n    default:\n      return new Intl.NumberFormat(locale).format(rounded);\n  }\n}\n\n/**\n * Format a \"count\" number into short \"icon\" or longer text string.\n * For positive numbers only.\n */\nexport function formatCount(\n  count: number | undefined,\n  numberFormat: NumberFormat = 'long',\n  labelFormat: LabelFormat = 'short',\n  locale: string = 'en-US',\n): string {\n  // Return blank if undefined\n  const number = count ?? -1;\n  if (number < 0) {\n    return '';\n  }\n  const divisor = magnitude(number, numberFormat);\n  const rounded = round(number, divisor);\n  return labelize(rounded, divisor, labelFormat, locale);\n}\n"]}

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

@@ -0,0 +1,16 @@
+export type DateFormat = 'year-only' | 'short' | 'long';
+/**
+ * Extra options accepted by the `formatDate` function
+ */
+export type FormatDateOptions = {
+    /**
+     * Which locale to format the date string for (default `'en-US'`)
+     */
+    locale?: string;
+    /**
+     * Whether to display the date in the browser's local time zone.
+     * Default is `false`, displaying the dates in UTC.
+     */
+    useLocalTime?: boolean;
+};
+export declare function formatDate(date: Date | undefined, format?: DateFormat, { locale, useLocalTime }?: FormatDateOptions): string;

package/dist/src/utils/format-date.js

@@ -0,0 +1,33 @@
+export function formatDate(date, format = 'short', { locale = 'en-US', useLocalTime = false } = {}) {
+    // Return blank if undefined
+    if (!date)
+        return '';
+    // The dates provided by the backend are assumed to already be with respect to UTC,
+    // and by default we specify that they should be rendered as such. If the
+    // `useLocalTime` option was set, we omit the UTC time zone from our format options
+    // so that the browser's local time zone is used instead.
+    const options = useLocalTime
+        ? {}
+        : { timeZone: 'UTC' };
+    switch (format) {
+        case 'year-only':
+            // If we're only using the year, ensure we output the correct UTC year and not
+            // the local year. If the local timezone is used, we can get strange off-by-one
+            // errors due to quirks of timezone handling for older years.
+            return `${date.getUTCFullYear()}`;
+        case 'short':
+            options.month = 'short';
+            options.year = 'numeric';
+            break;
+        case 'long':
+            options.year = 'numeric';
+            options.month = 'short';
+            options.day = '2-digit';
+            break;
+        default:
+            break;
+    }
+    const dateFormatter = new Intl.DateTimeFormat(locale, options);
+    return dateFormatter.format(date);
+}
+//# sourceMappingURL=format-date.js.map

package/dist/src/utils/format-date.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-date.js","sourceRoot":"","sources":["../../../src/utils/format-date.ts"],"names":[],"mappings":"AAwBA,MAAM,UAAU,UAAU,CACxB,IAAsB,EACtB,SAAqB,OAAO,EAC5B,EAAE,MAAM,GAAG,OAAO,EAAE,YAAY,GAAG,KAAK,KAAwB,EAAE;IAElE,4BAA4B;IAC5B,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IAErB,mFAAmF;IACnF,yEAAyE;IACzE,mFAAmF;IACnF,yDAAyD;IACzD,MAAM,OAAO,GAA+B,YAAY;QACtD,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IAExB,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,WAAW;YACd,8EAA8E;YAC9E,+EAA+E;YAC/E,6DAA6D;YAC7D,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;QACpC,KAAK,OAAO;YACV,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC;YACxB,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;YACzB,MAAM;QACR,KAAK,MAAM;YACT,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;YACzB,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC;YACxB,OAAO,CAAC,GAAG,GAAG,SAAS,CAAC;YACxB,MAAM;QACR;YACE,MAAM;IACV,CAAC;IAED,MAAM,aAAa,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/D,OAAO,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACpC,CAAC","sourcesContent":["/*\r\n * Display date\r\n * Override browser timezone to always display same date as in data\r\n */\r\nexport type DateFormat =\r\n  | 'year-only' // 2020\r\n  | 'short' // Dec 2020\r\n  | 'long'; // Dec 20, 2020\r\n\r\n/**\r\n * Extra options accepted by the `formatDate` function\r\n */\r\nexport type FormatDateOptions = {\r\n  /**\r\n   * Which locale to format the date string for (default `'en-US'`)\r\n   */\r\n  locale?: string;\r\n  /**\r\n   * Whether to display the date in the browser's local time zone.\r\n   * Default is `false`, displaying the dates in UTC.\r\n   */\r\n  useLocalTime?: boolean;\r\n};\r\n\r\nexport function formatDate(\r\n  date: Date | undefined,\r\n  format: DateFormat = 'short',\r\n  { locale = 'en-US', useLocalTime = false }: FormatDateOptions = {},\r\n): string {\r\n  // Return blank if undefined\r\n  if (!date) return '';\r\n\r\n  // The dates provided by the backend are assumed to already be with respect to UTC,\r\n  // and by default we specify that they should be rendered as such. If the\r\n  // `useLocalTime` option was set, we omit the UTC time zone from our format options\r\n  // so that the browser's local time zone is used instead.\r\n  const options: Intl.DateTimeFormatOptions = useLocalTime\r\n    ? {}\r\n    : { timeZone: 'UTC' };\r\n\r\n  switch (format) {\r\n    case 'year-only':\r\n      // If we're only using the year, ensure we output the correct UTC year and not\r\n      // the local year. If the local timezone is used, we can get strange off-by-one\r\n      // errors due to quirks of timezone handling for older years.\r\n      return `${date.getUTCFullYear()}`;\r\n    case 'short':\r\n      options.month = 'short';\r\n      options.year = 'numeric';\r\n      break;\r\n    case 'long':\r\n      options.year = 'numeric';\r\n      options.month = 'short';\r\n      options.day = '2-digit';\r\n      break;\r\n    default:\r\n      break;\r\n  }\r\n\r\n  const dateFormatter = new Intl.DateTimeFormat(locale, options);\r\n  return dateFormatter.format(date);\r\n}\r\n"]}

package/dist/src/utils/format-unit-size.d.ts

@@ -0,0 +1,2 @@
+import { nothing } from 'lit';
+export declare function formatUnitSize(size: number | undefined, nDecimals: number, separator?: string): string | typeof nothing;

package/dist/src/utils/format-unit-size.js

@@ -0,0 +1,34 @@
+/*
+ * Replaces Petabox www/common/Util::humanSize()
+ */
+import { nothing } from 'lit';
+var unitSizes;
+(function (unitSizes) {
+    unitSizes[unitSizes["bytes"] = 0] = "bytes";
+    unitSizes[unitSizes["kilobytes"] = 1] = "kilobytes";
+    unitSizes[unitSizes["megabytes"] = 2] = "megabytes";
+    unitSizes[unitSizes["gigabytes"] = 3] = "gigabytes";
+    unitSizes[unitSizes["terabytes"] = 4] = "terabytes";
+    unitSizes[unitSizes["petabytes"] = 5] = "petabytes";
+    unitSizes[unitSizes["exabytes"] = 6] = "exabytes";
+    unitSizes[unitSizes["zettabytes"] = 7] = "zettabytes";
+    unitSizes[unitSizes["yottabytes"] = 8] = "yottabytes";
+})(unitSizes || (unitSizes = {}));
+export function formatUnitSize(size, nDecimals, separator = ' ') {
+    let itemSize = size;
+    if (itemSize === undefined)
+        return nothing; // early return.
+    let unitIndex = 0;
+    // convert byte to highest possible unit
+    while (itemSize > 1024) {
+        itemSize /= 1024;
+        unitIndex += 1;
+    }
+    const magnitude = 10 ** nDecimals;
+    itemSize = Math.round(itemSize * magnitude) / magnitude;
+    let unitText = unitSizes[unitIndex];
+    // convert plural to singular.
+    unitText = itemSize === 1 ? unitText.slice(0, -1) : unitText;
+    return `${itemSize.toLocaleString() + separator + unitText}`;
+}
+//# sourceMappingURL=format-unit-size.js.map

package/dist/src/utils/format-unit-size.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-unit-size.js","sourceRoot":"","sources":["../../../src/utils/format-unit-size.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAE9B,IAAK,SAUJ;AAVD,WAAK,SAAS;IACZ,2CAAO,CAAA;IACP,mDAAW,CAAA;IACX,mDAAW,CAAA;IACX,mDAAW,CAAA;IACX,mDAAW,CAAA;IACX,mDAAW,CAAA;IACX,iDAAU,CAAA;IACV,qDAAY,CAAA;IACZ,qDAAY,CAAA;AACd,CAAC,EAVI,SAAS,KAAT,SAAS,QAUb;AAED,MAAM,UAAU,cAAc,CAC5B,IAAwB,EACxB,SAAiB,EACjB,YAAoB,GAAG;IAEvB,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC,CAAC,gBAAgB;IAE5D,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,wCAAwC;IACxC,OAAO,QAAQ,GAAG,IAAI,EAAE,CAAC;QACvB,QAAQ,IAAI,IAAI,CAAC;QACjB,SAAS,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,MAAM,SAAS,GAAG,EAAE,IAAI,SAAS,CAAC;IAClC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAExD,IAAI,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;IAEpC,8BAA8B;IAC9B,QAAQ,GAAG,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAE7D,OAAO,GAAG,QAAQ,CAAC,cAAc,EAAE,GAAG,SAAS,GAAG,QAAQ,EAAE,CAAC;AAC/D,CAAC","sourcesContent":["/*\n * Replaces Petabox www/common/Util::humanSize()\n */\nimport { nothing } from 'lit';\n\nenum unitSizes {\n  'bytes',\n  'kilobytes',\n  'megabytes',\n  'gigabytes',\n  'terabytes',\n  'petabytes',\n  'exabytes',\n  'zettabytes',\n  'yottabytes',\n}\n\nexport function formatUnitSize(\n  size: number | undefined,\n  nDecimals: number,\n  separator: string = ' ',\n) {\n  let itemSize = size;\n  if (itemSize === undefined) return nothing; // early return.\n\n  let unitIndex = 0;\n\n  // convert byte to highest possible unit\n  while (itemSize > 1024) {\n    itemSize /= 1024;\n    unitIndex += 1;\n  }\n\n  const magnitude = 10 ** nDecimals;\n  itemSize = Math.round(itemSize * magnitude) / magnitude;\n\n  let unitText = unitSizes[unitIndex];\n\n  // convert plural to singular.\n  unitText = itemSize === 1 ? unitText.slice(0, -1) : unitText;\n\n  return `${itemSize.toLocaleString() + separator + unitText}`;\n}\n"]}

package/dist/src/utils/local-date-from-utc.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts a given UTC date into the equivalent local-timestamp one.
+ */
+export declare function localDateFromUTC(date: Date): Date;
+/**
+ * Returns whether a given UTC date corresponds to the first
+ * millisecond of the year (e.g., Jan 1 at exactly midnight).
+ */
+export declare function isFirstMillisecondOfUTCYear(date?: Date): boolean;

package/dist/src/utils/local-date-from-utc.js

@@ -0,0 +1,16 @@
+/**
+ * Converts a given UTC date into the equivalent local-timestamp one.
+ */
+export function localDateFromUTC(date) {
+    return new Date(date.getTime() - date.getTimezoneOffset() * 1000 * 60);
+}
+/**
+ * Returns whether a given UTC date corresponds to the first
+ * millisecond of the year (e.g., Jan 1 at exactly midnight).
+ */
+export function isFirstMillisecondOfUTCYear(date) {
+    if (!date)
+        return false;
+    return date.toISOString().endsWith('-01-01T00:00:00.000Z');
+}
+//# sourceMappingURL=local-date-from-utc.js.map

package/dist/src/utils/local-date-from-utc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-date-from-utc.js","sourceRoot":"","sources":["../../../src/utils/local-date-from-utc.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAU;IACzC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,iBAAiB,EAAE,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC;AACzE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CAAC,IAAW;IACrD,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IACxB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC;AAC7D,CAAC","sourcesContent":["/**\n * Converts a given UTC date into the equivalent local-timestamp one.\n */\nexport function localDateFromUTC(date: Date): Date {\n  return new Date(date.getTime() - date.getTimezoneOffset() * 1000 * 60);\n}\n\n/**\n * Returns whether a given UTC date corresponds to the first\n * millisecond of the year (e.g., Jan 1 at exactly midnight).\n */\nexport function isFirstMillisecondOfUTCYear(date?: Date): boolean {\n  if (!date) return false;\n  return date.toISOString().endsWith('-01-01T00:00:00.000Z');\n}\n"]}

package/dist/src/utils/log.d.ts

@@ -0,0 +1,7 @@
+/**
+ * console.log() utility -- production ignores 'log()' JS calls; dev invokes 'console.log()'
+ */
+export declare const log: {
+    (...data: any[]): void;
+    (message?: any, ...optionalParams: any[]): void;
+};

package/dist/src/utils/log.js

@@ -0,0 +1,14 @@
+/**
+ * console.log() utility -- production ignores 'log()' JS calls; dev invokes 'console.log()'
+ */
+export const log = window.location &&
+    (window.location.hostname === 'localhost' ||
+        window.location.host.match(/^(www|cat)-[a-z0-9]+\.archive\.org$/) ||
+        window.location.host.match(/\.code\.archive\.org$/) ||
+        window.location.host.match(/\.dev\.archive\.org$/) ||
+        window.location.host.match(/^ia-petabox-/) ||
+        window.location.host.match(/^local\.archive\.org/) ||
+        window.location.host.match(/^internetarchive\.github\.io$/))
+    ? console.log.bind(console) // convenient, no?  Stateless function
+    : () => { };
+//# sourceMappingURL=log.js.map

package/dist/src/utils/log.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../../../src/utils/log.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,GAAG,GACd,MAAM,CAAC,QAAQ;IACf,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,KAAK,WAAW;QACvC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,qCAAqC,CAAC;QACjE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC;QACnD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC;QAClD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;QAC1C,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC;QAClD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAC5D,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,sCAAsC;IAClE,CAAC,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC","sourcesContent":["/**\n * console.log() utility -- production ignores 'log()' JS calls; dev invokes 'console.log()'\n */\nexport const log =\n  window.location &&\n  (window.location.hostname === 'localhost' ||\n    window.location.host.match(/^(www|cat)-[a-z0-9]+\\.archive\\.org$/) ||\n    window.location.host.match(/\\.code\\.archive\\.org$/) ||\n    window.location.host.match(/\\.dev\\.archive\\.org$/) ||\n    window.location.host.match(/^ia-petabox-/) ||\n    window.location.host.match(/^local\\.archive\\.org/) ||\n    window.location.host.match(/^internetarchive\\.github\\.io$/))\n    ? console.log.bind(console) // convenient, no?  Stateless function\n    : () => {};\n"]}

package/dist/src/utils/resolve-mediatype.d.ts

@@ -0,0 +1,8 @@
+import type { MediaType } from '@internetarchive/field-parsers';
+import type { SearchResult } from '@internetarchive/search-service';
+/**
+ * Returns the mediatype string for the given search result, taking into account
+ * the special `favorited_search` hit type.
+ * @param result The search result to extract a mediatype from
+ */
+export declare function resolveMediatype(result: SearchResult): MediaType;

package/dist/src/utils/resolve-mediatype.js

@@ -0,0 +1,24 @@
+/**
+ * Returns the mediatype string for the given search result, taking into account
+ * the special `favorited_search` hit type.
+ * @param result The search result to extract a mediatype from
+ */
+export function resolveMediatype(result) {
+    var _a, _b, _c;
+    /**
+     * hit_type == 'favorited_search' is basically a new hit_type
+     * - we are getting from PPS.
+     * - which gives response for fav- collection
+     * - having favorited items like account/collection/item etc..
+     * - as user can also favorite a search result (a search page)
+     * - so we need to have response (having fav- items and fav- search results)
+     *
+     * if backend hit_type == 'favorited_search'
+     * - let's assume a "search" as new mediatype
+     */
+    if (((_a = result === null || result === void 0 ? void 0 : result.rawMetadata) === null || _a === void 0 ? void 0 : _a.hit_type) === 'favorited_search') {
+        return 'search';
+    }
+    return (_c = (_b = result.mediatype) === null || _b === void 0 ? void 0 : _b.value) !== null && _c !== void 0 ? _c : 'data';
+}
+//# sourceMappingURL=resolve-mediatype.js.map

package/dist/src/utils/resolve-mediatype.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-mediatype.js","sourceRoot":"","sources":["../../../src/utils/resolve-mediatype.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAoB;;IACnD;;;;;;;;;;OAUG;IACH,IAAI,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,0CAAE,QAAQ,MAAK,kBAAkB,EAAE,CAAC;QACzD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,MAAA,MAAA,MAAM,CAAC,SAAS,0CAAE,KAAK,mCAAI,MAAM,CAAC;AAC3C,CAAC","sourcesContent":["import type { MediaType } from '@internetarchive/field-parsers';\nimport type { SearchResult } from '@internetarchive/search-service';\n\n/**\n * Returns the mediatype string for the given search result, taking into account\n * the special `favorited_search` hit type.\n * @param result The search result to extract a mediatype from\n */\nexport function resolveMediatype(result: SearchResult): MediaType {\n  /**\n   * hit_type == 'favorited_search' is basically a new hit_type\n   * - we are getting from PPS.\n   * - which gives response for fav- collection\n   * - having favorited items like account/collection/item etc..\n   * - as user can also favorite a search result (a search page)\n   * - so we need to have response (having fav- items and fav- search results)\n   *\n   * if backend hit_type == 'favorited_search'\n   * - let's assume a \"search\" as new mediatype\n   */\n  if (result?.rawMetadata?.hit_type === 'favorited_search') {\n    return 'search';\n  }\n\n  return result.mediatype?.value ?? 'data';\n}\n"]}

package/dist/src/utils/sha1.d.ts

@@ -0,0 +1,2 @@
+/** Returns (asynchronously) the hex-encoded SHA-1 hash of the input string */
+export declare function sha1(input: string): Promise<string>;

package/dist/src/utils/sha1.js

@@ -0,0 +1,9 @@
+const encoder = new TextEncoder();
+/** Returns (asynchronously) the hex-encoded SHA-1 hash of the input string */
+export async function sha1(input) {
+    const hashBuffer = await crypto.subtle.digest('SHA-1', encoder.encode(input));
+    return [...new Uint8Array(hashBuffer)]
+        .map(byte => byte.toString(16).padStart(2, '0'))
+        .join('');
+}
+//# sourceMappingURL=sha1.js.map

package/dist/src/utils/sha1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sha1.js","sourceRoot":"","sources":["../../../src/utils/sha1.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAElC,8EAA8E;AAC9E,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,KAAa;IACtC,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9E,OAAO,CAAC,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;SACnC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;SAC/C,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC","sourcesContent":["const encoder = new TextEncoder();\n\n/** Returns (asynchronously) the hex-encoded SHA-1 hash of the input string */\nexport async function sha1(input: string): Promise<string> {\n  const hashBuffer = await crypto.subtle.digest('SHA-1', encoder.encode(input));\n  return [...new Uint8Array(hashBuffer)]\n    .map(byte => byte.toString(16).padStart(2, '0'))\n    .join('');\n}\n"]}

package/dist/test/collection-browser.test.d.ts

@@ -0,0 +1 @@
+import '../src/collection-browser';