@internetarchive/collection-browser 0.4.6 → 0.4.8-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (231) hide show
  1. package/.editorconfig +29 -29
  2. package/.github/workflows/ci.yml +26 -26
  3. package/.github/workflows/gh-pages-main.yml +39 -39
  4. package/.github/workflows/npm-publish.yml +39 -39
  5. package/.github/workflows/pr-preview.yml +38 -38
  6. package/.husky/pre-commit +4 -4
  7. package/LICENSE +661 -661
  8. package/README.md +83 -83
  9. package/dist/index.d.ts +9 -9
  10. package/dist/index.js +9 -9
  11. package/dist/src/app-root.d.ts +50 -50
  12. package/dist/src/app-root.js +278 -278
  13. package/dist/src/assets/img/icons/arrow-left.d.ts +2 -2
  14. package/dist/src/assets/img/icons/arrow-left.js +2 -2
  15. package/dist/src/assets/img/icons/arrow-right.d.ts +2 -2
  16. package/dist/src/assets/img/icons/arrow-right.js +2 -2
  17. package/dist/src/assets/img/icons/chevron.d.ts +2 -2
  18. package/dist/src/assets/img/icons/chevron.js +2 -2
  19. package/dist/src/assets/img/icons/empty-query.d.ts +2 -2
  20. package/dist/src/assets/img/icons/empty-query.js +2 -2
  21. package/dist/src/assets/img/icons/eye-closed.d.ts +2 -2
  22. package/dist/src/assets/img/icons/eye-closed.js +2 -2
  23. package/dist/src/assets/img/icons/eye.d.ts +2 -2
  24. package/dist/src/assets/img/icons/eye.js +2 -2
  25. package/dist/src/assets/img/icons/favorite-filled.d.ts +1 -1
  26. package/dist/src/assets/img/icons/favorite-filled.js +2 -2
  27. package/dist/src/assets/img/icons/login-required.d.ts +1 -1
  28. package/dist/src/assets/img/icons/login-required.js +2 -2
  29. package/dist/src/assets/img/icons/mediatype/account.d.ts +1 -1
  30. package/dist/src/assets/img/icons/mediatype/account.js +2 -2
  31. package/dist/src/assets/img/icons/mediatype/audio.d.ts +1 -1
  32. package/dist/src/assets/img/icons/mediatype/audio.js +2 -2
  33. package/dist/src/assets/img/icons/mediatype/collection.d.ts +1 -1
  34. package/dist/src/assets/img/icons/mediatype/collection.js +2 -2
  35. package/dist/src/assets/img/icons/mediatype/data.d.ts +1 -1
  36. package/dist/src/assets/img/icons/mediatype/data.js +2 -2
  37. package/dist/src/assets/img/icons/mediatype/etree.d.ts +1 -1
  38. package/dist/src/assets/img/icons/mediatype/etree.js +2 -2
  39. package/dist/src/assets/img/icons/mediatype/film.d.ts +1 -1
  40. package/dist/src/assets/img/icons/mediatype/film.js +2 -2
  41. package/dist/src/assets/img/icons/mediatype/images.d.ts +1 -1
  42. package/dist/src/assets/img/icons/mediatype/images.js +2 -2
  43. package/dist/src/assets/img/icons/mediatype/radio.d.ts +1 -1
  44. package/dist/src/assets/img/icons/mediatype/radio.js +2 -2
  45. package/dist/src/assets/img/icons/mediatype/software.d.ts +1 -1
  46. package/dist/src/assets/img/icons/mediatype/software.js +2 -2
  47. package/dist/src/assets/img/icons/mediatype/texts.d.ts +1 -1
  48. package/dist/src/assets/img/icons/mediatype/texts.js +2 -2
  49. package/dist/src/assets/img/icons/mediatype/tv.d.ts +1 -1
  50. package/dist/src/assets/img/icons/mediatype/tv.js +2 -2
  51. package/dist/src/assets/img/icons/mediatype/video.d.ts +1 -1
  52. package/dist/src/assets/img/icons/mediatype/video.js +2 -2
  53. package/dist/src/assets/img/icons/mediatype/web.d.ts +1 -1
  54. package/dist/src/assets/img/icons/mediatype/web.js +2 -2
  55. package/dist/src/assets/img/icons/null-result.d.ts +2 -2
  56. package/dist/src/assets/img/icons/null-result.js +2 -2
  57. package/dist/src/assets/img/icons/restricted.d.ts +1 -1
  58. package/dist/src/assets/img/icons/restricted.js +2 -2
  59. package/dist/src/assets/img/icons/reviews.d.ts +1 -1
  60. package/dist/src/assets/img/icons/reviews.js +2 -2
  61. package/dist/src/assets/img/icons/upload.d.ts +1 -1
  62. package/dist/src/assets/img/icons/upload.js +2 -2
  63. package/dist/src/assets/img/icons/views.d.ts +1 -1
  64. package/dist/src/assets/img/icons/views.js +2 -2
  65. package/dist/src/circular-activity-indicator.d.ts +5 -5
  66. package/dist/src/circular-activity-indicator.js +17 -17
  67. package/dist/src/collection-browser.d.ts +277 -277
  68. package/dist/src/collection-browser.js +1195 -1194
  69. package/dist/src/collection-browser.js.map +1 -1
  70. package/dist/src/collection-facets/facet-tombstone-row.d.ts +5 -5
  71. package/dist/src/collection-facets/facet-tombstone-row.js +15 -15
  72. package/dist/src/collection-facets/facets-template.d.ts +16 -16
  73. package/dist/src/collection-facets/facets-template.js +125 -125
  74. package/dist/src/collection-facets/more-facets-content.d.ts +77 -77
  75. package/dist/src/collection-facets/more-facets-content.js +376 -365
  76. package/dist/src/collection-facets/more-facets-content.js.map +1 -1
  77. package/dist/src/collection-facets/more-facets-pagination.d.ts +36 -36
  78. package/dist/src/collection-facets/more-facets-pagination.js +192 -192
  79. package/dist/src/collection-facets.d.ts +77 -78
  80. package/dist/src/collection-facets.js +383 -400
  81. package/dist/src/collection-facets.js.map +1 -1
  82. package/dist/src/empty-placeholder.d.ts +11 -11
  83. package/dist/src/empty-placeholder.js +42 -42
  84. package/dist/src/language-code-handler/language-code-handler.d.ts +37 -37
  85. package/dist/src/language-code-handler/language-code-handler.js +26 -26
  86. package/dist/src/language-code-handler/language-code-mapping.d.ts +1 -1
  87. package/dist/src/language-code-handler/language-code-mapping.js +562 -562
  88. package/dist/src/mediatype/mediatype-config.d.ts +3 -3
  89. package/dist/src/mediatype/mediatype-config.js +85 -85
  90. package/dist/src/models.d.ts +114 -114
  91. package/dist/src/models.js +125 -125
  92. package/dist/src/restoration-state-handler.d.ts +45 -45
  93. package/dist/src/restoration-state-handler.js +230 -230
  94. package/dist/src/sort-filter-bar/alpha-bar.d.ts +12 -12
  95. package/dist/src/sort-filter-bar/alpha-bar.js +52 -52
  96. package/dist/src/sort-filter-bar/img/compact.d.ts +1 -1
  97. package/dist/src/sort-filter-bar/img/compact.js +2 -2
  98. package/dist/src/sort-filter-bar/img/list.d.ts +1 -1
  99. package/dist/src/sort-filter-bar/img/list.js +2 -2
  100. package/dist/src/sort-filter-bar/img/sort-triangle.d.ts +1 -1
  101. package/dist/src/sort-filter-bar/img/sort-triangle.js +2 -2
  102. package/dist/src/sort-filter-bar/img/tile.d.ts +1 -1
  103. package/dist/src/sort-filter-bar/img/tile.js +2 -2
  104. package/dist/src/sort-filter-bar/sort-filter-bar.d.ts +108 -108
  105. package/dist/src/sort-filter-bar/sort-filter-bar.js +438 -438
  106. package/dist/src/styles/item-image-styles.d.ts +8 -8
  107. package/dist/src/styles/item-image-styles.js +9 -9
  108. package/dist/src/tiles/collection-browser-loading-tile.d.ts +5 -5
  109. package/dist/src/tiles/collection-browser-loading-tile.js +15 -15
  110. package/dist/src/tiles/grid/account-tile.d.ts +17 -17
  111. package/dist/src/tiles/grid/account-tile.js +46 -46
  112. package/dist/src/tiles/grid/collection-tile.d.ts +14 -14
  113. package/dist/src/tiles/grid/collection-tile.js +53 -53
  114. package/dist/src/tiles/grid/item-tile.d.ts +29 -29
  115. package/dist/src/tiles/grid/item-tile.js +108 -108
  116. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.d.ts +1 -1
  117. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.js +7 -7
  118. package/dist/src/tiles/grid/tile-stats.d.ts +10 -10
  119. package/dist/src/tiles/grid/tile-stats.js +40 -40
  120. package/dist/src/tiles/hover/hover-pane-controller.d.ts +197 -197
  121. package/dist/src/tiles/hover/hover-pane-controller.js +331 -331
  122. package/dist/src/tiles/hover/tile-hover-pane.d.ts +15 -15
  123. package/dist/src/tiles/hover/tile-hover-pane.js +38 -38
  124. package/dist/src/tiles/image-block.d.ts +17 -17
  125. package/dist/src/tiles/image-block.js +72 -72
  126. package/dist/src/tiles/item-image.d.ts +35 -35
  127. package/dist/src/tiles/item-image.js +117 -117
  128. package/dist/src/tiles/list/account-label.d.ts +1 -1
  129. package/dist/src/tiles/list/account-label.js +6 -6
  130. package/dist/src/tiles/list/date-label.d.ts +1 -1
  131. package/dist/src/tiles/list/date-label.js +12 -12
  132. package/dist/src/tiles/list/tile-list-compact-header.d.ts +12 -12
  133. package/dist/src/tiles/list/tile-list-compact-header.js +41 -41
  134. package/dist/src/tiles/list/tile-list-compact.d.ts +21 -21
  135. package/dist/src/tiles/list/tile-list-compact.js +99 -99
  136. package/dist/src/tiles/list/tile-list.d.ts +55 -55
  137. package/dist/src/tiles/list/tile-list.js +297 -296
  138. package/dist/src/tiles/list/tile-list.js.map +1 -1
  139. package/dist/src/tiles/mediatype-icon.d.ts +9 -9
  140. package/dist/src/tiles/mediatype-icon.js +47 -47
  141. package/dist/src/tiles/overlay/icon-overlay.d.ts +10 -10
  142. package/dist/src/tiles/overlay/icon-overlay.js +40 -40
  143. package/dist/src/tiles/overlay/icon-text-overlay.d.ts +9 -9
  144. package/dist/src/tiles/overlay/icon-text-overlay.js +38 -38
  145. package/dist/src/tiles/overlay/text-overlay.d.ts +10 -10
  146. package/dist/src/tiles/overlay/text-overlay.js +42 -42
  147. package/dist/src/tiles/text-snippet-block.d.ts +27 -27
  148. package/dist/src/tiles/text-snippet-block.js +73 -73
  149. package/dist/src/tiles/tile-dispatcher.d.ts +55 -55
  150. package/dist/src/tiles/tile-dispatcher.js +176 -176
  151. package/dist/src/utils/analytics-events.d.ts +22 -22
  152. package/dist/src/utils/analytics-events.js +24 -24
  153. package/dist/src/utils/format-count.d.ts +7 -7
  154. package/dist/src/utils/format-count.js +76 -76
  155. package/dist/src/utils/format-date.d.ts +2 -2
  156. package/dist/src/utils/format-date.js +23 -23
  157. package/dist/src/utils/format-unit-size.d.ts +2 -2
  158. package/dist/src/utils/format-unit-size.js +33 -33
  159. package/dist/test/collection-browser.test.d.ts +1 -1
  160. package/dist/test/collection-browser.test.js +584 -584
  161. package/dist/test/collection-facets/facets-template.test.d.ts +1 -1
  162. package/dist/test/collection-facets/facets-template.test.js +62 -62
  163. package/dist/test/collection-facets/more-facets-content.test.d.ts +1 -1
  164. package/dist/test/collection-facets/more-facets-content.test.js +114 -114
  165. package/dist/test/collection-facets/more-facets-pagination.test.d.ts +1 -1
  166. package/dist/test/collection-facets/more-facets-pagination.test.js +117 -117
  167. package/dist/test/collection-facets.test.d.ts +2 -2
  168. package/dist/test/collection-facets.test.js +508 -544
  169. package/dist/test/collection-facets.test.js.map +1 -1
  170. package/dist/test/empty-placeholder.test.d.ts +1 -1
  171. package/dist/test/empty-placeholder.test.js +33 -33
  172. package/dist/test/icon-overlay.test.d.ts +1 -1
  173. package/dist/test/icon-overlay.test.js +24 -24
  174. package/dist/test/image-block.test.d.ts +1 -1
  175. package/dist/test/image-block.test.js +48 -48
  176. package/dist/test/item-image.test.d.ts +1 -1
  177. package/dist/test/item-image.test.js +84 -84
  178. package/dist/test/mediatype-config.test.d.ts +1 -1
  179. package/dist/test/mediatype-config.test.js +16 -16
  180. package/dist/test/mocks/mock-analytics-handler.d.ts +10 -10
  181. package/dist/test/mocks/mock-analytics-handler.js +15 -15
  182. package/dist/test/mocks/mock-collection-name-cache.d.ts +7 -7
  183. package/dist/test/mocks/mock-collection-name-cache.js +13 -13
  184. package/dist/test/mocks/mock-search-responses.d.ts +12 -12
  185. package/dist/test/mocks/mock-search-responses.js +341 -341
  186. package/dist/test/mocks/mock-search-service.d.ts +13 -13
  187. package/dist/test/mocks/mock-search-service.js +40 -40
  188. package/dist/test/restoration-state-handler.test.d.ts +1 -1
  189. package/dist/test/restoration-state-handler.test.js +125 -125
  190. package/dist/test/sort-filter-bar/alpha-bar.test.d.ts +1 -1
  191. package/dist/test/sort-filter-bar/alpha-bar.test.js +43 -43
  192. package/dist/test/sort-filter-bar/sort-filter-bar.test.d.ts +1 -1
  193. package/dist/test/sort-filter-bar/sort-filter-bar.test.js +197 -197
  194. package/dist/test/text-overlay.test.d.ts +1 -1
  195. package/dist/test/text-overlay.test.js +48 -48
  196. package/dist/test/text-snippet-block.test.d.ts +1 -1
  197. package/dist/test/text-snippet-block.test.js +57 -57
  198. package/dist/test/tile-stats.test.d.ts +1 -1
  199. package/dist/test/tile-stats.test.js +33 -33
  200. package/dist/test/tiles/grid/account-tile.test.d.ts +1 -1
  201. package/dist/test/tiles/grid/account-tile.test.js +60 -60
  202. package/dist/test/tiles/grid/collection-tile.test.d.ts +1 -1
  203. package/dist/test/tiles/grid/collection-tile.test.js +57 -57
  204. package/dist/test/tiles/grid/item-tile.test.d.ts +1 -1
  205. package/dist/test/tiles/grid/item-tile.test.js +142 -142
  206. package/dist/test/tiles/hover/hover-pane-controller.test.d.ts +1 -1
  207. package/dist/test/tiles/hover/hover-pane-controller.test.js +257 -257
  208. package/dist/test/tiles/hover/tile-hover-pane.test.d.ts +1 -1
  209. package/dist/test/tiles/hover/tile-hover-pane.test.js +13 -13
  210. package/dist/test/tiles/list/tile-list-compact.test.d.ts +1 -1
  211. package/dist/test/tiles/list/tile-list-compact.test.js +92 -92
  212. package/dist/test/tiles/list/tile-list.test.d.ts +1 -1
  213. package/dist/test/tiles/list/tile-list.test.js +153 -153
  214. package/dist/test/utils/format-count.test.d.ts +1 -1
  215. package/dist/test/utils/format-count.test.js +23 -23
  216. package/dist/test/utils/format-date.test.d.ts +1 -1
  217. package/dist/test/utils/format-date.test.js +17 -17
  218. package/dist/test/utils/format-unit-size.test.d.ts +1 -1
  219. package/dist/test/utils/format-unit-size.test.js +17 -17
  220. package/local.archive.org.cert +86 -86
  221. package/local.archive.org.key +27 -27
  222. package/package.json +1 -1
  223. package/renovate.json +6 -6
  224. package/src/collection-browser.ts +1 -0
  225. package/src/collection-facets/more-facets-content.ts +24 -16
  226. package/src/collection-facets.ts +0 -20
  227. package/src/tiles/list/tile-list.ts +3 -1
  228. package/test/collection-facets.test.ts +0 -46
  229. package/tsconfig.json +21 -21
  230. package/web-dev-server.config.mjs +30 -30
  231. package/web-test-runner.config.mjs +41 -41
@@ -1,3 +1,3 @@
1
- export declare const mediatypeConfig: {
2
- [key: string]: any;
3
- };
1
+ export declare const mediatypeConfig: {
2
+ [key: string]: any;
3
+ };
@@ -1,86 +1,86 @@
1
- import { accountIcon } from '../assets/img/icons/mediatype/account';
2
- import { audioIcon } from '../assets/img/icons/mediatype/audio';
3
- import { collectionIcon } from '../assets/img/icons/mediatype/collection';
4
- import { dataIcon } from '../assets/img/icons/mediatype/data';
5
- import { etreeIcon } from '../assets/img/icons/mediatype/etree';
6
- import { imagesIcon } from '../assets/img/icons/mediatype/images';
7
- import { filmIcon } from '../assets/img/icons/mediatype/film';
8
- import { radioIcon } from '../assets/img/icons/mediatype/radio';
9
- import { softwareIcon } from '../assets/img/icons/mediatype/software';
10
- import { textsIcon } from '../assets/img/icons/mediatype/texts';
11
- import { tvIcon } from '../assets/img/icons/mediatype/tv';
12
- import { videoIcon } from '../assets/img/icons/mediatype/video';
13
- import { webIcon } from '../assets/img/icons/mediatype/web';
14
- export const mediatypeConfig = {
15
- account: {
16
- color: '#000000',
17
- icon: accountIcon,
18
- text: 'Account',
19
- },
20
- audio: {
21
- color: '#00adef',
22
- icon: audioIcon,
23
- text: 'Audio',
24
- },
25
- collection: {
26
- color: '#4666ff',
27
- icon: collectionIcon,
28
- text: 'Collection',
29
- },
30
- data: {
31
- color: '#333333',
32
- icon: dataIcon,
33
- text: 'Data',
34
- },
35
- etree: {
36
- color: '#00adef',
37
- icon: etreeIcon,
38
- text: 'E-tree',
39
- },
40
- film: {
41
- color: '#bf1b2c',
42
- icon: filmIcon,
43
- text: 'Film',
44
- },
45
- image: {
46
- color: '#aa99c9',
47
- icon: imagesIcon,
48
- text: 'Image',
49
- },
50
- movies: {
51
- color: '#f1644b',
52
- icon: filmIcon,
53
- text: 'Movie',
54
- },
55
- radio: {
56
- color: '#8fdaef',
57
- icon: radioIcon,
58
- text: 'Radio',
59
- },
60
- software: {
61
- color: '#9ecc4f',
62
- icon: softwareIcon,
63
- text: 'Software',
64
- },
65
- texts: {
66
- color: '#faab3c',
67
- icon: textsIcon,
68
- text: 'Text',
69
- },
70
- tv: {
71
- color: '#f1644b',
72
- icon: tvIcon,
73
- text: 'TV',
74
- },
75
- video: {
76
- color: '#f1644b',
77
- icon: videoIcon,
78
- text: 'Video',
79
- },
80
- web: {
81
- color: '#ffcd27',
82
- icon: webIcon,
83
- text: 'Web',
84
- },
85
- };
1
+ import { accountIcon } from '../assets/img/icons/mediatype/account';
2
+ import { audioIcon } from '../assets/img/icons/mediatype/audio';
3
+ import { collectionIcon } from '../assets/img/icons/mediatype/collection';
4
+ import { dataIcon } from '../assets/img/icons/mediatype/data';
5
+ import { etreeIcon } from '../assets/img/icons/mediatype/etree';
6
+ import { imagesIcon } from '../assets/img/icons/mediatype/images';
7
+ import { filmIcon } from '../assets/img/icons/mediatype/film';
8
+ import { radioIcon } from '../assets/img/icons/mediatype/radio';
9
+ import { softwareIcon } from '../assets/img/icons/mediatype/software';
10
+ import { textsIcon } from '../assets/img/icons/mediatype/texts';
11
+ import { tvIcon } from '../assets/img/icons/mediatype/tv';
12
+ import { videoIcon } from '../assets/img/icons/mediatype/video';
13
+ import { webIcon } from '../assets/img/icons/mediatype/web';
14
+ export const mediatypeConfig = {
15
+ account: {
16
+ color: '#000000',
17
+ icon: accountIcon,
18
+ text: 'Account',
19
+ },
20
+ audio: {
21
+ color: '#00adef',
22
+ icon: audioIcon,
23
+ text: 'Audio',
24
+ },
25
+ collection: {
26
+ color: '#4666ff',
27
+ icon: collectionIcon,
28
+ text: 'Collection',
29
+ },
30
+ data: {
31
+ color: '#333333',
32
+ icon: dataIcon,
33
+ text: 'Data',
34
+ },
35
+ etree: {
36
+ color: '#00adef',
37
+ icon: etreeIcon,
38
+ text: 'E-tree',
39
+ },
40
+ film: {
41
+ color: '#bf1b2c',
42
+ icon: filmIcon,
43
+ text: 'Film',
44
+ },
45
+ image: {
46
+ color: '#aa99c9',
47
+ icon: imagesIcon,
48
+ text: 'Image',
49
+ },
50
+ movies: {
51
+ color: '#f1644b',
52
+ icon: filmIcon,
53
+ text: 'Movie',
54
+ },
55
+ radio: {
56
+ color: '#8fdaef',
57
+ icon: radioIcon,
58
+ text: 'Radio',
59
+ },
60
+ software: {
61
+ color: '#9ecc4f',
62
+ icon: softwareIcon,
63
+ text: 'Software',
64
+ },
65
+ texts: {
66
+ color: '#faab3c',
67
+ icon: textsIcon,
68
+ text: 'Text',
69
+ },
70
+ tv: {
71
+ color: '#f1644b',
72
+ icon: tvIcon,
73
+ text: 'TV',
74
+ },
75
+ video: {
76
+ color: '#f1644b',
77
+ icon: videoIcon,
78
+ text: 'Video',
79
+ },
80
+ web: {
81
+ color: '#ffcd27',
82
+ icon: webIcon,
83
+ text: 'Web',
84
+ },
85
+ };
86
86
  //# sourceMappingURL=mediatype-config.js.map
@@ -1,114 +1,114 @@
1
- import type { MediaType } from '@internetarchive/field-parsers';
2
- export interface TileModel {
3
- averageRating?: number;
4
- collectionIdentifier?: string;
5
- collectionName?: string;
6
- collectionFilesCount: number;
7
- collections: string[];
8
- collectionSize: number;
9
- commentCount: number;
10
- creator?: string;
11
- creators: string[];
12
- dateAdded?: Date;
13
- dateArchived?: Date;
14
- datePublished?: Date;
15
- dateReviewed?: Date;
16
- description?: string;
17
- favCount: number;
18
- identifier: string;
19
- issue?: string;
20
- itemCount: number;
21
- mediatype: MediaType;
22
- source?: string;
23
- snippets?: string[];
24
- subjects: string[];
25
- title: string;
26
- viewCount: number;
27
- volume?: string;
28
- weeklyViewCount?: number;
29
- loginRequired: boolean;
30
- contentWarning: boolean;
31
- }
32
- export declare type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';
33
- export declare type TileDisplayMode = 'grid' | 'list-compact' | 'list-detail' | 'list-header';
34
- /**
35
- * This is mainly used to set the cookies for the collection display mode.
36
- *
37
- * It allows the user to set different modes for different contexts (collection page, search page, etc).
38
- */
39
- export declare type CollectionBrowserContext = 'collection' | 'search';
40
- /**
41
- * The sort fields shown in the sort filter bar
42
- */
43
- export declare enum SortField {
44
- 'relevance' = "relevance",
45
- 'alltimeview' = "alltimeview",
46
- 'weeklyview' = "weeklyview",
47
- 'title' = "title",
48
- 'datearchived' = "datearchived",
49
- 'date' = "date",
50
- 'datereviewed' = "datereviewed",
51
- 'dateadded' = "dateadded",
52
- 'creator' = "creator"
53
- }
54
- /**
55
- * The metadata fields we sort by that map to the SortFields above
56
- */
57
- export declare type MetadataSortField = 'downloads' | 'week' | 'titleSorter' | 'date' | 'creatorSorter' | 'publicdate' | 'reviewdate' | 'addeddate';
58
- export declare const SortFieldDisplayName: {
59
- [key in SortField]: string;
60
- };
61
- /**
62
- * Maps the SortField above to the corresponding Metadata field in the API.
63
- */
64
- export declare const SortFieldToMetadataField: {
65
- [key in SortField]: MetadataSortField | null;
66
- };
67
- /**
68
- * Maps the Metadata field to the corresponding SortField field in the API.
69
- */
70
- export declare const MetadataFieldToSortField: {
71
- [key in MetadataSortField]: SortField;
72
- };
73
- /** A union of the fields that permit prefix filtering (e.g., alphabetical filtering) */
74
- export declare type PrefixFilterType = 'title' | 'creator';
75
- /** A map from prefixes (e.g., initial letters) to the number of items matching that prefix */
76
- export declare type PrefixFilterCounts = Record<string, number>;
77
- /**
78
- * A map from prefix filter types to the corresponding aggregation keys
79
- * that are needed to fetch the filter counts from the backend.
80
- */
81
- export declare const prefixFilterAggregationKeys: Record<PrefixFilterType, string>;
82
- export declare type FacetOption = 'subject' | 'lending' | 'mediatype' | 'language' | 'creator' | 'collection' | 'year';
83
- export declare type SelectedFacetState = 'selected' | 'hidden';
84
- export declare type FacetState = SelectedFacetState | 'none';
85
- export interface FacetBucket {
86
- displayText?: string;
87
- key: string;
88
- count: number;
89
- state: FacetState;
90
- }
91
- export interface FacetGroup {
92
- title: string;
93
- key: FacetOption;
94
- buckets: FacetBucket[];
95
- }
96
- export declare type FacetValue = string;
97
- export declare type SelectedFacets = Record<FacetOption, Record<FacetValue, FacetBucket>>;
98
- export declare const defaultSelectedFacets: SelectedFacets;
99
- export declare const facetDisplayOrder: FacetOption[];
100
- export declare const facetTitles: Record<FacetOption, string>;
101
- export declare type LendingFacetKey = 'is_lendable' | 'is_borrowable' | 'available_to_borrow' | 'is_browsable' | 'available_to_browse' | 'is_readable' | 'available_to_waitlist';
102
- /**
103
- * Maps valid lending keys to whether they should be visible in the facet sidebar
104
- */
105
- export declare const lendingFacetKeysVisibility: Record<LendingFacetKey, boolean>;
106
- /**
107
- * Maps valid, visible lending keys to their facet sidebar display text
108
- */
109
- export declare const lendingFacetDisplayNames: Partial<Record<LendingFacetKey, string>>;
110
- /**
111
- * A record of which admin-only collections should be suppressed from being displayed
112
- * as facets or in an item's list of collections.
113
- */
114
- export declare const suppressedCollections: Record<string, boolean>;
1
+ import type { MediaType } from '@internetarchive/field-parsers';
2
+ export interface TileModel {
3
+ averageRating?: number;
4
+ collectionIdentifier?: string;
5
+ collectionName?: string;
6
+ collectionFilesCount: number;
7
+ collections: string[];
8
+ collectionSize: number;
9
+ commentCount: number;
10
+ creator?: string;
11
+ creators: string[];
12
+ dateAdded?: Date;
13
+ dateArchived?: Date;
14
+ datePublished?: Date;
15
+ dateReviewed?: Date;
16
+ description?: string;
17
+ favCount: number;
18
+ identifier: string;
19
+ issue?: string;
20
+ itemCount: number;
21
+ mediatype: MediaType;
22
+ source?: string;
23
+ snippets?: string[];
24
+ subjects: string[];
25
+ title: string;
26
+ viewCount: number;
27
+ volume?: string;
28
+ weeklyViewCount?: number;
29
+ loginRequired: boolean;
30
+ contentWarning: boolean;
31
+ }
32
+ export declare type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';
33
+ export declare type TileDisplayMode = 'grid' | 'list-compact' | 'list-detail' | 'list-header';
34
+ /**
35
+ * This is mainly used to set the cookies for the collection display mode.
36
+ *
37
+ * It allows the user to set different modes for different contexts (collection page, search page, etc).
38
+ */
39
+ export declare type CollectionBrowserContext = 'collection' | 'search';
40
+ /**
41
+ * The sort fields shown in the sort filter bar
42
+ */
43
+ export declare enum SortField {
44
+ 'relevance' = "relevance",
45
+ 'alltimeview' = "alltimeview",
46
+ 'weeklyview' = "weeklyview",
47
+ 'title' = "title",
48
+ 'datearchived' = "datearchived",
49
+ 'date' = "date",
50
+ 'datereviewed' = "datereviewed",
51
+ 'dateadded' = "dateadded",
52
+ 'creator' = "creator"
53
+ }
54
+ /**
55
+ * The metadata fields we sort by that map to the SortFields above
56
+ */
57
+ export declare type MetadataSortField = 'downloads' | 'week' | 'titleSorter' | 'date' | 'creatorSorter' | 'publicdate' | 'reviewdate' | 'addeddate';
58
+ export declare const SortFieldDisplayName: {
59
+ [key in SortField]: string;
60
+ };
61
+ /**
62
+ * Maps the SortField above to the corresponding Metadata field in the API.
63
+ */
64
+ export declare const SortFieldToMetadataField: {
65
+ [key in SortField]: MetadataSortField | null;
66
+ };
67
+ /**
68
+ * Maps the Metadata field to the corresponding SortField field in the API.
69
+ */
70
+ export declare const MetadataFieldToSortField: {
71
+ [key in MetadataSortField]: SortField;
72
+ };
73
+ /** A union of the fields that permit prefix filtering (e.g., alphabetical filtering) */
74
+ export declare type PrefixFilterType = 'title' | 'creator';
75
+ /** A map from prefixes (e.g., initial letters) to the number of items matching that prefix */
76
+ export declare type PrefixFilterCounts = Record<string, number>;
77
+ /**
78
+ * A map from prefix filter types to the corresponding aggregation keys
79
+ * that are needed to fetch the filter counts from the backend.
80
+ */
81
+ export declare const prefixFilterAggregationKeys: Record<PrefixFilterType, string>;
82
+ export declare type FacetOption = 'subject' | 'lending' | 'mediatype' | 'language' | 'creator' | 'collection' | 'year';
83
+ export declare type SelectedFacetState = 'selected' | 'hidden';
84
+ export declare type FacetState = SelectedFacetState | 'none';
85
+ export interface FacetBucket {
86
+ displayText?: string;
87
+ key: string;
88
+ count: number;
89
+ state: FacetState;
90
+ }
91
+ export interface FacetGroup {
92
+ title: string;
93
+ key: FacetOption;
94
+ buckets: FacetBucket[];
95
+ }
96
+ export declare type FacetValue = string;
97
+ export declare type SelectedFacets = Record<FacetOption, Record<FacetValue, FacetBucket>>;
98
+ export declare const defaultSelectedFacets: SelectedFacets;
99
+ export declare const facetDisplayOrder: FacetOption[];
100
+ export declare const facetTitles: Record<FacetOption, string>;
101
+ export declare type LendingFacetKey = 'is_lendable' | 'is_borrowable' | 'available_to_borrow' | 'is_browsable' | 'available_to_browse' | 'is_readable' | 'available_to_waitlist';
102
+ /**
103
+ * Maps valid lending keys to whether they should be visible in the facet sidebar
104
+ */
105
+ export declare const lendingFacetKeysVisibility: Record<LendingFacetKey, boolean>;
106
+ /**
107
+ * Maps valid, visible lending keys to their facet sidebar display text
108
+ */
109
+ export declare const lendingFacetDisplayNames: Partial<Record<LendingFacetKey, string>>;
110
+ /**
111
+ * A record of which admin-only collections should be suppressed from being displayed
112
+ * as facets or in an item's list of collections.
113
+ */
114
+ export declare const suppressedCollections: Record<string, boolean>;
@@ -1,126 +1,126 @@
1
- /**
2
- * The sort fields shown in the sort filter bar
3
- */
4
- export var SortField;
5
- (function (SortField) {
6
- SortField["relevance"] = "relevance";
7
- SortField["alltimeview"] = "alltimeview";
8
- SortField["weeklyview"] = "weeklyview";
9
- SortField["title"] = "title";
10
- SortField["datearchived"] = "datearchived";
11
- SortField["date"] = "date";
12
- SortField["datereviewed"] = "datereviewed";
13
- SortField["dateadded"] = "dateadded";
14
- SortField["creator"] = "creator";
15
- })(SortField || (SortField = {}));
16
- export const SortFieldDisplayName = {
17
- relevance: 'Relevance',
18
- alltimeview: 'All-time Views',
19
- weeklyview: 'Weekly Views',
20
- title: 'Title',
21
- datearchived: 'Date Archived',
22
- date: 'Date Published',
23
- datereviewed: 'Date Reviewed',
24
- dateadded: 'Date Added',
25
- creator: 'Creator',
26
- };
27
- /**
28
- * Maps the SortField above to the corresponding Metadata field in the API.
29
- */
30
- export const SortFieldToMetadataField = {
31
- relevance: null,
32
- alltimeview: 'downloads',
33
- weeklyview: 'week',
34
- title: 'titleSorter',
35
- datearchived: 'publicdate',
36
- date: 'date',
37
- datereviewed: 'reviewdate',
38
- dateadded: 'addeddate',
39
- creator: 'creatorSorter',
40
- };
41
- /**
42
- * Maps the Metadata field to the corresponding SortField field in the API.
43
- */
44
- export const MetadataFieldToSortField = {
45
- week: SortField.weeklyview,
46
- downloads: SortField.alltimeview,
47
- titleSorter: SortField.title,
48
- date: SortField.date,
49
- publicdate: SortField.datearchived,
50
- reviewdate: SortField.datereviewed,
51
- addeddate: SortField.dateadded,
52
- creatorSorter: SortField.creator,
53
- };
54
- /**
55
- * A map from prefix filter types to the corresponding aggregation keys
56
- * that are needed to fetch the filter counts from the backend.
57
- */
58
- export const prefixFilterAggregationKeys = {
59
- title: 'firstTitle',
60
- creator: 'firstCreator',
61
- };
62
- export const defaultSelectedFacets = {
63
- subject: {},
64
- lending: {},
65
- mediatype: {},
66
- language: {},
67
- creator: {},
68
- collection: {},
69
- year: {},
70
- };
71
- export const facetDisplayOrder = [
72
- 'mediatype',
73
- 'lending',
74
- 'year',
75
- 'subject',
76
- 'collection',
77
- 'creator',
78
- 'language',
79
- ];
80
- export const facetTitles = {
81
- subject: 'Subject',
82
- lending: 'Availability',
83
- mediatype: 'Media Type',
84
- language: 'Language',
85
- creator: 'Creator',
86
- collection: 'Collection',
87
- year: 'Year',
88
- };
89
- /**
90
- * Maps valid lending keys to whether they should be visible in the facet sidebar
91
- */
92
- export const lendingFacetKeysVisibility = {
93
- is_lendable: true,
94
- is_borrowable: false,
95
- available_to_borrow: true,
96
- is_browsable: false,
97
- available_to_browse: false,
98
- is_readable: true,
99
- available_to_waitlist: false,
100
- };
101
- /**
102
- * Maps valid, visible lending keys to their facet sidebar display text
103
- */
104
- export const lendingFacetDisplayNames = {
105
- is_lendable: 'Lending Library',
106
- available_to_borrow: 'Borrow 14 Days',
107
- is_readable: 'Always Available',
108
- };
109
- /**
110
- * A record of which admin-only collections should be suppressed from being displayed
111
- * as facets or in an item's list of collections.
112
- */
113
- export const suppressedCollections = {
114
- deemphasize: true,
115
- community: true,
116
- stream_only: true,
117
- samples_only: true,
118
- test_collection: true,
119
- printdisabled: true,
120
- 'openlibrary-ol': true,
121
- nationalemergencylibrary: true,
122
- china: true,
123
- americana: true,
124
- toronto: true,
125
- };
1
+ /**
2
+ * The sort fields shown in the sort filter bar
3
+ */
4
+ export var SortField;
5
+ (function (SortField) {
6
+ SortField["relevance"] = "relevance";
7
+ SortField["alltimeview"] = "alltimeview";
8
+ SortField["weeklyview"] = "weeklyview";
9
+ SortField["title"] = "title";
10
+ SortField["datearchived"] = "datearchived";
11
+ SortField["date"] = "date";
12
+ SortField["datereviewed"] = "datereviewed";
13
+ SortField["dateadded"] = "dateadded";
14
+ SortField["creator"] = "creator";
15
+ })(SortField || (SortField = {}));
16
+ export const SortFieldDisplayName = {
17
+ relevance: 'Relevance',
18
+ alltimeview: 'All-time Views',
19
+ weeklyview: 'Weekly Views',
20
+ title: 'Title',
21
+ datearchived: 'Date Archived',
22
+ date: 'Date Published',
23
+ datereviewed: 'Date Reviewed',
24
+ dateadded: 'Date Added',
25
+ creator: 'Creator',
26
+ };
27
+ /**
28
+ * Maps the SortField above to the corresponding Metadata field in the API.
29
+ */
30
+ export const SortFieldToMetadataField = {
31
+ relevance: null,
32
+ alltimeview: 'downloads',
33
+ weeklyview: 'week',
34
+ title: 'titleSorter',
35
+ datearchived: 'publicdate',
36
+ date: 'date',
37
+ datereviewed: 'reviewdate',
38
+ dateadded: 'addeddate',
39
+ creator: 'creatorSorter',
40
+ };
41
+ /**
42
+ * Maps the Metadata field to the corresponding SortField field in the API.
43
+ */
44
+ export const MetadataFieldToSortField = {
45
+ week: SortField.weeklyview,
46
+ downloads: SortField.alltimeview,
47
+ titleSorter: SortField.title,
48
+ date: SortField.date,
49
+ publicdate: SortField.datearchived,
50
+ reviewdate: SortField.datereviewed,
51
+ addeddate: SortField.dateadded,
52
+ creatorSorter: SortField.creator,
53
+ };
54
+ /**
55
+ * A map from prefix filter types to the corresponding aggregation keys
56
+ * that are needed to fetch the filter counts from the backend.
57
+ */
58
+ export const prefixFilterAggregationKeys = {
59
+ title: 'firstTitle',
60
+ creator: 'firstCreator',
61
+ };
62
+ export const defaultSelectedFacets = {
63
+ subject: {},
64
+ lending: {},
65
+ mediatype: {},
66
+ language: {},
67
+ creator: {},
68
+ collection: {},
69
+ year: {},
70
+ };
71
+ export const facetDisplayOrder = [
72
+ 'mediatype',
73
+ 'lending',
74
+ 'year',
75
+ 'subject',
76
+ 'collection',
77
+ 'creator',
78
+ 'language',
79
+ ];
80
+ export const facetTitles = {
81
+ subject: 'Subject',
82
+ lending: 'Availability',
83
+ mediatype: 'Media Type',
84
+ language: 'Language',
85
+ creator: 'Creator',
86
+ collection: 'Collection',
87
+ year: 'Year',
88
+ };
89
+ /**
90
+ * Maps valid lending keys to whether they should be visible in the facet sidebar
91
+ */
92
+ export const lendingFacetKeysVisibility = {
93
+ is_lendable: true,
94
+ is_borrowable: false,
95
+ available_to_borrow: true,
96
+ is_browsable: false,
97
+ available_to_browse: false,
98
+ is_readable: true,
99
+ available_to_waitlist: false,
100
+ };
101
+ /**
102
+ * Maps valid, visible lending keys to their facet sidebar display text
103
+ */
104
+ export const lendingFacetDisplayNames = {
105
+ is_lendable: 'Lending Library',
106
+ available_to_borrow: 'Borrow 14 Days',
107
+ is_readable: 'Always Available',
108
+ };
109
+ /**
110
+ * A record of which admin-only collections should be suppressed from being displayed
111
+ * as facets or in an item's list of collections.
112
+ */
113
+ export const suppressedCollections = {
114
+ deemphasize: true,
115
+ community: true,
116
+ stream_only: true,
117
+ samples_only: true,
118
+ test_collection: true,
119
+ printdisabled: true,
120
+ 'openlibrary-ol': true,
121
+ nationalemergencylibrary: true,
122
+ china: true,
123
+ americana: true,
124
+ toronto: true,
125
+ };
126
126
  //# sourceMappingURL=models.js.map