@internetarchive/collection-browser 0.4.3-alpha.9 → 0.4.4-alpha

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 (250) 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 -48
  12. package/dist/src/app-root.js +449 -412
  13. package/dist/src/app-root.js.map +1 -1
  14. package/dist/src/assets/img/icons/arrow-left.d.ts +2 -2
  15. package/dist/src/assets/img/icons/arrow-left.js +2 -2
  16. package/dist/src/assets/img/icons/arrow-right.d.ts +2 -2
  17. package/dist/src/assets/img/icons/arrow-right.js +2 -2
  18. package/dist/src/assets/img/icons/chevron.d.ts +2 -2
  19. package/dist/src/assets/img/icons/chevron.js +2 -2
  20. package/dist/src/assets/img/icons/empty-query.d.ts +2 -2
  21. package/dist/src/assets/img/icons/empty-query.js +2 -2
  22. package/dist/src/assets/img/icons/eye-closed.d.ts +2 -2
  23. package/dist/src/assets/img/icons/eye-closed.js +2 -2
  24. package/dist/src/assets/img/icons/eye.d.ts +2 -2
  25. package/dist/src/assets/img/icons/eye.js +2 -2
  26. package/dist/src/assets/img/icons/favorite-filled.d.ts +1 -1
  27. package/dist/src/assets/img/icons/favorite-filled.js +2 -2
  28. package/dist/src/assets/img/icons/login-required.d.ts +1 -1
  29. package/dist/src/assets/img/icons/login-required.js +2 -2
  30. package/dist/src/assets/img/icons/mediatype/account.d.ts +1 -1
  31. package/dist/src/assets/img/icons/mediatype/account.js +2 -2
  32. package/dist/src/assets/img/icons/mediatype/audio.d.ts +1 -1
  33. package/dist/src/assets/img/icons/mediatype/audio.js +2 -2
  34. package/dist/src/assets/img/icons/mediatype/collection.d.ts +1 -1
  35. package/dist/src/assets/img/icons/mediatype/collection.js +2 -2
  36. package/dist/src/assets/img/icons/mediatype/data.d.ts +1 -1
  37. package/dist/src/assets/img/icons/mediatype/data.js +2 -2
  38. package/dist/src/assets/img/icons/mediatype/etree.d.ts +1 -1
  39. package/dist/src/assets/img/icons/mediatype/etree.js +2 -2
  40. package/dist/src/assets/img/icons/mediatype/film.d.ts +1 -1
  41. package/dist/src/assets/img/icons/mediatype/film.js +2 -2
  42. package/dist/src/assets/img/icons/mediatype/images.d.ts +1 -1
  43. package/dist/src/assets/img/icons/mediatype/images.js +2 -2
  44. package/dist/src/assets/img/icons/mediatype/radio.d.ts +1 -1
  45. package/dist/src/assets/img/icons/mediatype/radio.js +2 -2
  46. package/dist/src/assets/img/icons/mediatype/software.d.ts +1 -1
  47. package/dist/src/assets/img/icons/mediatype/software.js +2 -2
  48. package/dist/src/assets/img/icons/mediatype/texts.d.ts +1 -1
  49. package/dist/src/assets/img/icons/mediatype/texts.js +2 -2
  50. package/dist/src/assets/img/icons/mediatype/tv.d.ts +1 -1
  51. package/dist/src/assets/img/icons/mediatype/tv.js +2 -2
  52. package/dist/src/assets/img/icons/mediatype/video.d.ts +1 -1
  53. package/dist/src/assets/img/icons/mediatype/video.js +2 -2
  54. package/dist/src/assets/img/icons/mediatype/web.d.ts +1 -1
  55. package/dist/src/assets/img/icons/mediatype/web.js +2 -2
  56. package/dist/src/assets/img/icons/null-result.d.ts +2 -2
  57. package/dist/src/assets/img/icons/null-result.js +2 -2
  58. package/dist/src/assets/img/icons/restricted.d.ts +1 -1
  59. package/dist/src/assets/img/icons/restricted.js +2 -2
  60. package/dist/src/assets/img/icons/reviews.d.ts +1 -1
  61. package/dist/src/assets/img/icons/reviews.js +2 -2
  62. package/dist/src/assets/img/icons/upload.d.ts +1 -1
  63. package/dist/src/assets/img/icons/upload.js +2 -2
  64. package/dist/src/assets/img/icons/views.d.ts +1 -1
  65. package/dist/src/assets/img/icons/views.js +2 -2
  66. package/dist/src/circular-activity-indicator.d.ts +5 -5
  67. package/dist/src/circular-activity-indicator.js +17 -17
  68. package/dist/src/collection-browser.d.ts +315 -276
  69. package/dist/src/collection-browser.js +1276 -1179
  70. package/dist/src/collection-browser.js.map +1 -1
  71. package/dist/src/collection-facets/facet-tombstone-row.d.ts +5 -5
  72. package/dist/src/collection-facets/facet-tombstone-row.js +15 -15
  73. package/dist/src/collection-facets/facets-template.d.ts +16 -16
  74. package/dist/src/collection-facets/facets-template.js +125 -125
  75. package/dist/src/collection-facets/more-facets-content.d.ts +77 -77
  76. package/dist/src/collection-facets/more-facets-content.js +357 -357
  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 +78 -78
  80. package/dist/src/collection-facets.js +391 -391
  81. package/dist/src/empty-placeholder.d.ts +11 -11
  82. package/dist/src/empty-placeholder.js +42 -42
  83. package/dist/src/language-code-handler/language-code-handler.d.ts +37 -37
  84. package/dist/src/language-code-handler/language-code-handler.js +26 -26
  85. package/dist/src/language-code-handler/language-code-mapping.d.ts +1 -1
  86. package/dist/src/language-code-handler/language-code-mapping.js +562 -562
  87. package/dist/src/mediatype/mediatype-config.d.ts +3 -3
  88. package/dist/src/mediatype/mediatype-config.js +85 -85
  89. package/dist/src/models.d.ts +114 -112
  90. package/dist/src/models.js +125 -125
  91. package/dist/src/models.js.map +1 -1
  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 +428 -428
  106. package/dist/src/styles/item-image-styles.d.ts +8 -8
  107. package/dist/src/styles/item-image-styles.js +22 -12
  108. package/dist/src/styles/item-image-styles.js.map +1 -1
  109. package/dist/src/tiles/collection-browser-loading-tile.d.ts +5 -5
  110. package/dist/src/tiles/collection-browser-loading-tile.js +16 -16
  111. package/dist/src/tiles/collection-browser-loading-tile.js.map +1 -1
  112. package/dist/src/tiles/grid/account-tile.d.ts +17 -17
  113. package/dist/src/tiles/grid/account-tile.js +48 -47
  114. package/dist/src/tiles/grid/account-tile.js.map +1 -1
  115. package/dist/src/tiles/grid/collection-tile.d.ts +14 -7
  116. package/dist/src/tiles/grid/collection-tile.js +112 -146
  117. package/dist/src/tiles/grid/collection-tile.js.map +1 -1
  118. package/dist/src/tiles/grid/item-tile.d.ts +29 -29
  119. package/dist/src/tiles/grid/item-tile.js +110 -105
  120. package/dist/src/tiles/grid/item-tile.js.map +1 -1
  121. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.d.ts +1 -1
  122. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.js +12 -8
  123. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.js.map +1 -1
  124. package/dist/src/tiles/grid/tile-stats.d.ts +10 -10
  125. package/dist/src/tiles/grid/tile-stats.js +41 -40
  126. package/dist/src/tiles/grid/tile-stats.js.map +1 -1
  127. package/dist/src/tiles/image-block.d.ts +17 -17
  128. package/dist/src/tiles/image-block.js +76 -72
  129. package/dist/src/tiles/image-block.js.map +1 -1
  130. package/dist/src/tiles/item-image.d.ts +35 -35
  131. package/dist/src/tiles/item-image.js +117 -116
  132. package/dist/src/tiles/item-image.js.map +1 -1
  133. package/dist/src/tiles/list/account-label.d.ts +1 -1
  134. package/dist/src/tiles/list/account-label.js +6 -6
  135. package/dist/src/tiles/list/date-label.d.ts +1 -1
  136. package/dist/src/tiles/list/date-label.js +12 -12
  137. package/dist/src/tiles/list/tile-list-compact-header.d.ts +12 -12
  138. package/dist/src/tiles/list/tile-list-compact-header.js +41 -41
  139. package/dist/src/tiles/list/tile-list-compact.d.ts +21 -21
  140. package/dist/src/tiles/list/tile-list-compact.js +93 -93
  141. package/dist/src/tiles/list/tile-list.d.ts +53 -53
  142. package/dist/src/tiles/list/tile-list.js +279 -279
  143. package/dist/src/tiles/mediatype-icon.d.ts +9 -9
  144. package/dist/src/tiles/mediatype-icon.js +47 -47
  145. package/dist/src/tiles/overlay/icon-overlay.d.ts +10 -10
  146. package/dist/src/tiles/overlay/icon-overlay.js +40 -40
  147. package/dist/src/tiles/overlay/icon-text-overlay.d.ts +9 -9
  148. package/dist/src/tiles/overlay/icon-text-overlay.js +38 -38
  149. package/dist/src/tiles/overlay/text-overlay.d.ts +10 -10
  150. package/dist/src/tiles/overlay/text-overlay.js +42 -42
  151. package/dist/src/tiles/text-snippet-block.d.ts +27 -27
  152. package/dist/src/tiles/text-snippet-block.js +73 -73
  153. package/dist/src/tiles/tile-dispatcher.d.ts +36 -36
  154. package/dist/src/tiles/tile-dispatcher.js +145 -128
  155. package/dist/src/tiles/tile-dispatcher.js.map +1 -1
  156. package/dist/src/utils/analytics-events.d.ts +22 -22
  157. package/dist/src/utils/analytics-events.js +24 -24
  158. package/dist/src/utils/format-count.d.ts +7 -7
  159. package/dist/src/utils/format-count.js +76 -76
  160. package/dist/src/utils/format-date.d.ts +2 -2
  161. package/dist/src/utils/format-date.js +23 -23
  162. package/dist/src/utils/format-unit-size.d.ts +2 -0
  163. package/dist/src/utils/format-unit-size.js +34 -0
  164. package/dist/src/utils/format-unit-size.js.map +1 -0
  165. package/dist/test/collection-browser.test.d.ts +1 -1
  166. package/dist/test/collection-browser.test.js +646 -646
  167. package/dist/test/collection-facets/facets-template.test.d.ts +1 -1
  168. package/dist/test/collection-facets/facets-template.test.js +62 -62
  169. package/dist/test/collection-facets/more-facets-content.test.d.ts +1 -1
  170. package/dist/test/collection-facets/more-facets-content.test.js +114 -114
  171. package/dist/test/collection-facets/more-facets-pagination.test.d.ts +1 -1
  172. package/dist/test/collection-facets/more-facets-pagination.test.js +117 -117
  173. package/dist/test/collection-facets.test.d.ts +2 -2
  174. package/dist/test/collection-facets.test.js +544 -544
  175. package/dist/test/empty-placeholder.test.d.ts +1 -1
  176. package/dist/test/empty-placeholder.test.js +33 -33
  177. package/dist/test/icon-overlay.test.d.ts +1 -1
  178. package/dist/test/icon-overlay.test.js +24 -24
  179. package/dist/test/image-block.test.d.ts +1 -1
  180. package/dist/test/image-block.test.js +48 -48
  181. package/dist/test/item-image.test.d.ts +1 -1
  182. package/dist/test/item-image.test.js +84 -80
  183. package/dist/test/item-image.test.js.map +1 -1
  184. package/dist/test/mediatype-config.test.d.ts +1 -1
  185. package/dist/test/mediatype-config.test.js +16 -16
  186. package/dist/test/mocks/mock-analytics-handler.d.ts +10 -10
  187. package/dist/test/mocks/mock-analytics-handler.js +15 -15
  188. package/dist/test/mocks/mock-collection-name-cache.d.ts +7 -7
  189. package/dist/test/mocks/mock-collection-name-cache.js +13 -13
  190. package/dist/test/mocks/mock-search-responses.d.ts +12 -12
  191. package/dist/test/mocks/mock-search-responses.js +341 -341
  192. package/dist/test/mocks/mock-search-service.d.ts +13 -13
  193. package/dist/test/mocks/mock-search-service.js +40 -40
  194. package/dist/test/restoration-state-handler.test.d.ts +1 -1
  195. package/dist/test/restoration-state-handler.test.js +125 -125
  196. package/dist/test/sort-filter-bar/alpha-bar.test.d.ts +1 -1
  197. package/dist/test/sort-filter-bar/alpha-bar.test.js +43 -43
  198. package/dist/test/sort-filter-bar/sort-filter-bar.test.d.ts +1 -1
  199. package/dist/test/sort-filter-bar/sort-filter-bar.test.js +141 -141
  200. package/dist/test/text-overlay.test.d.ts +1 -1
  201. package/dist/test/text-overlay.test.js +48 -48
  202. package/dist/test/text-snippet-block.test.d.ts +1 -1
  203. package/dist/test/text-snippet-block.test.js +57 -57
  204. package/dist/test/tile-stats.test.d.ts +1 -1
  205. package/dist/test/tile-stats.test.js +33 -33
  206. package/dist/test/tiles/grid/account-tile.test.d.ts +1 -1
  207. package/dist/test/tiles/grid/account-tile.test.js +60 -60
  208. package/dist/test/tiles/grid/collection-tile.test.d.ts +1 -0
  209. package/dist/test/tiles/grid/collection-tile.test.js +73 -0
  210. package/dist/test/tiles/grid/collection-tile.test.js.map +1 -0
  211. package/dist/test/tiles/grid/item-tile.test.d.ts +1 -1
  212. package/dist/test/tiles/grid/item-tile.test.js +142 -129
  213. package/dist/test/tiles/grid/item-tile.test.js.map +1 -1
  214. package/dist/test/tiles/list/tile-list-compact.test.d.ts +1 -1
  215. package/dist/test/tiles/list/tile-list-compact.test.js +92 -92
  216. package/dist/test/tiles/list/tile-list.test.d.ts +1 -1
  217. package/dist/test/tiles/list/tile-list.test.js +123 -123
  218. package/dist/test/utils/format-count.test.d.ts +1 -1
  219. package/dist/test/utils/format-count.test.js +23 -23
  220. package/dist/test/utils/format-date.test.d.ts +1 -1
  221. package/dist/test/utils/format-date.test.js +17 -17
  222. package/dist/test/utils/format-unit-size.test.d.ts +1 -0
  223. package/dist/test/utils/format-unit-size.test.js +18 -0
  224. package/dist/test/utils/format-unit-size.test.js.map +1 -0
  225. package/index.html +24 -24
  226. package/local.archive.org.cert +86 -86
  227. package/local.archive.org.key +27 -27
  228. package/package.json +2 -2
  229. package/renovate.json +6 -6
  230. package/src/app-root.ts +214 -169
  231. package/src/collection-browser.ts +122 -3
  232. package/src/models.ts +2 -0
  233. package/src/styles/item-image-styles.ts +13 -3
  234. package/src/tiles/collection-browser-loading-tile.ts +1 -1
  235. package/src/tiles/grid/account-tile.ts +4 -2
  236. package/src/tiles/grid/collection-tile.ts +106 -136
  237. package/src/tiles/grid/item-tile.ts +8 -2
  238. package/src/tiles/grid/styles/tile-grid-shared-styles.ts +6 -2
  239. package/src/tiles/grid/tile-stats.ts +1 -0
  240. package/src/tiles/image-block.ts +5 -2
  241. package/src/tiles/item-image.ts +4 -3
  242. package/src/tiles/tile-dispatcher.ts +17 -0
  243. package/src/utils/format-unit-size.ts +43 -0
  244. package/test/item-image.test.ts +4 -0
  245. package/test/tiles/grid/collection-tile.test.ts +85 -0
  246. package/test/tiles/grid/item-tile.test.ts +30 -4
  247. package/test/utils/format-unit-size.test.ts +21 -0
  248. package/tsconfig.json +21 -21
  249. package/web-dev-server.config.mjs +30 -30
  250. 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,112 +1,114 @@
1
- import type { MediaType } from '@internetarchive/field-parsers';
2
- export interface TileModel {
3
- averageRating?: number;
4
- collectionIdentifier?: string;
5
- collectionName?: string;
6
- collections: string[];
7
- commentCount: number;
8
- creator?: string;
9
- creators: string[];
10
- dateAdded?: Date;
11
- dateArchived?: Date;
12
- datePublished?: Date;
13
- dateReviewed?: Date;
14
- description?: string;
15
- favCount: number;
16
- identifier: string;
17
- issue?: string;
18
- itemCount: number;
19
- mediatype: MediaType;
20
- source?: string;
21
- snippets?: string[];
22
- subjects: string[];
23
- title: string;
24
- viewCount: number;
25
- volume?: string;
26
- weeklyViewCount?: number;
27
- loginRequired: boolean;
28
- contentWarning: boolean;
29
- }
30
- export declare type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';
31
- export declare type TileDisplayMode = 'grid' | 'list-compact' | 'list-detail' | 'list-header';
32
- /**
33
- * This is mainly used to set the cookies for the collection display mode.
34
- *
35
- * It allows the user to set different modes for different contexts (collection page, search page, etc).
36
- */
37
- export declare type CollectionBrowserContext = 'collection' | 'search';
38
- /**
39
- * The sort fields shown in the sort filter bar
40
- */
41
- export declare enum SortField {
42
- 'relevance' = "relevance",
43
- 'alltimeview' = "alltimeview",
44
- 'weeklyview' = "weeklyview",
45
- 'title' = "title",
46
- 'datearchived' = "datearchived",
47
- 'date' = "date",
48
- 'datereviewed' = "datereviewed",
49
- 'dateadded' = "dateadded",
50
- 'creator' = "creator"
51
- }
52
- /**
53
- * The metadata fields we sort by that map to the SortFields above
54
- */
55
- export declare type MetadataSortField = 'downloads' | 'week' | 'titleSorter' | 'date' | 'creatorSorter' | 'publicdate' | 'reviewdate' | 'addeddate';
56
- export declare const SortFieldDisplayName: {
57
- [key in SortField]: string;
58
- };
59
- /**
60
- * Maps the SortField above to the corresponding Metadata field in the API.
61
- */
62
- export declare const SortFieldToMetadataField: {
63
- [key in SortField]: MetadataSortField | null;
64
- };
65
- /**
66
- * Maps the Metadata field to the corresponding SortField field in the API.
67
- */
68
- export declare const MetadataFieldToSortField: {
69
- [key in MetadataSortField]: SortField;
70
- };
71
- /** A union of the fields that permit prefix filtering (e.g., alphabetical filtering) */
72
- export declare type PrefixFilterType = 'title' | 'creator';
73
- /** A map from prefixes (e.g., initial letters) to the number of items matching that prefix */
74
- export declare type PrefixFilterCounts = Record<string, number>;
75
- /**
76
- * A map from prefix filter types to the corresponding aggregation keys
77
- * that are needed to fetch the filter counts from the backend.
78
- */
79
- export declare const prefixFilterAggregationKeys: Record<PrefixFilterType, string>;
80
- export declare type FacetOption = 'subject' | 'lending' | 'mediatype' | 'language' | 'creator' | 'collection' | 'year';
81
- export declare type SelectedFacetState = 'selected' | 'hidden';
82
- export declare type FacetState = SelectedFacetState | 'none';
83
- export interface FacetBucket {
84
- displayText?: string;
85
- key: string;
86
- count: number;
87
- state: FacetState;
88
- }
89
- export interface FacetGroup {
90
- title: string;
91
- key: FacetOption;
92
- buckets: FacetBucket[];
93
- }
94
- export declare type FacetValue = string;
95
- export declare type SelectedFacets = Record<FacetOption, Record<FacetValue, FacetBucket>>;
96
- export declare const defaultSelectedFacets: SelectedFacets;
97
- export declare const facetDisplayOrder: FacetOption[];
98
- export declare const facetTitles: Record<FacetOption, string>;
99
- export declare type LendingFacetKey = 'is_lendable' | 'is_borrowable' | 'available_to_borrow' | 'is_browsable' | 'available_to_browse' | 'is_readable' | 'available_to_waitlist';
100
- /**
101
- * Maps valid lending keys to whether they should be visible in the facet sidebar
102
- */
103
- export declare const lendingFacetKeysVisibility: Record<LendingFacetKey, boolean>;
104
- /**
105
- * Maps valid, visible lending keys to their facet sidebar display text
106
- */
107
- export declare const lendingFacetDisplayNames: Partial<Record<LendingFacetKey, string>>;
108
- /**
109
- * A record of which admin-only collections should be suppressed from being displayed
110
- * as facets or in an item's list of collections.
111
- */
112
- 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>;