@internetarchive/collection-browser 0.2.22 → 0.3.0-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 (220) 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 +42 -39
  12. package/dist/src/app-root.js +236 -203
  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 +235 -233
  69. package/dist/src/collection-browser.js +1032 -1046
  70. package/dist/src/collection-browser.js.map +1 -1
  71. package/dist/src/collection-facets/facets-template.d.ts +16 -16
  72. package/dist/src/collection-facets/facets-template.js +125 -125
  73. package/dist/src/collection-facets/facets-util.d.ts +10 -10
  74. package/dist/src/collection-facets/facets-util.js +19 -19
  75. package/dist/src/collection-facets/more-facets-content.d.ts +84 -83
  76. package/dist/src/collection-facets/more-facets-content.js +353 -351
  77. package/dist/src/collection-facets/more-facets-content.js.map +1 -1
  78. package/dist/src/collection-facets/more-facets-pagination.d.ts +36 -36
  79. package/dist/src/collection-facets/more-facets-pagination.js +192 -192
  80. package/dist/src/collection-facets.d.ts +71 -79
  81. package/dist/src/collection-facets.js +325 -338
  82. package/dist/src/collection-facets.js.map +1 -1
  83. package/dist/src/empty-placeholder.d.ts +11 -11
  84. package/dist/src/empty-placeholder.js +42 -42
  85. package/dist/src/language-code-handler/language-code-handler.d.ts +37 -37
  86. package/dist/src/language-code-handler/language-code-handler.js +26 -26
  87. package/dist/src/language-code-handler/language-code-mapping.d.ts +1 -1
  88. package/dist/src/language-code-handler/language-code-mapping.js +562 -562
  89. package/dist/src/mediatype/mediatype-config.d.ts +3 -3
  90. package/dist/src/mediatype/mediatype-config.js +85 -85
  91. package/dist/src/models.d.ts +90 -89
  92. package/dist/src/models.js +85 -85
  93. package/dist/src/models.js.map +1 -1
  94. package/dist/src/restoration-state-handler.d.ts +38 -38
  95. package/dist/src/restoration-state-handler.js +202 -202
  96. package/dist/src/sort-filter-bar/alpha-bar.d.ts +9 -9
  97. package/dist/src/sort-filter-bar/alpha-bar.js +41 -41
  98. package/dist/src/sort-filter-bar/img/compact.d.ts +1 -1
  99. package/dist/src/sort-filter-bar/img/compact.js +2 -2
  100. package/dist/src/sort-filter-bar/img/list.d.ts +1 -1
  101. package/dist/src/sort-filter-bar/img/list.js +2 -2
  102. package/dist/src/sort-filter-bar/img/sort-triangle.d.ts +1 -1
  103. package/dist/src/sort-filter-bar/img/sort-triangle.js +2 -2
  104. package/dist/src/sort-filter-bar/img/tile.d.ts +1 -1
  105. package/dist/src/sort-filter-bar/img/tile.js +2 -2
  106. package/dist/src/sort-filter-bar/sort-filter-bar.d.ts +107 -107
  107. package/dist/src/sort-filter-bar/sort-filter-bar.js +423 -423
  108. package/dist/src/styles/item-image-styles.d.ts +8 -8
  109. package/dist/src/styles/item-image-styles.js +9 -9
  110. package/dist/src/tiles/collection-browser-loading-tile.d.ts +5 -5
  111. package/dist/src/tiles/collection-browser-loading-tile.js +15 -15
  112. package/dist/src/tiles/grid/account-tile.d.ts +8 -8
  113. package/dist/src/tiles/grid/account-tile.js +20 -20
  114. package/dist/src/tiles/grid/collection-tile.d.ts +7 -7
  115. package/dist/src/tiles/grid/collection-tile.js +23 -23
  116. package/dist/src/tiles/grid/item-tile.d.ts +24 -24
  117. package/dist/src/tiles/grid/item-tile.js +87 -87
  118. package/dist/src/tiles/grid/tile-stats.d.ts +10 -10
  119. package/dist/src/tiles/grid/tile-stats.js +35 -35
  120. package/dist/src/tiles/image-block.d.ts +17 -17
  121. package/dist/src/tiles/image-block.js +73 -73
  122. package/dist/src/tiles/item-image.d.ts +31 -31
  123. package/dist/src/tiles/item-image.js +103 -103
  124. package/dist/src/tiles/list/account-label.d.ts +1 -1
  125. package/dist/src/tiles/list/account-label.js +6 -6
  126. package/dist/src/tiles/list/date-label.d.ts +1 -1
  127. package/dist/src/tiles/list/date-label.js +12 -12
  128. package/dist/src/tiles/list/tile-list-compact-header.d.ts +12 -12
  129. package/dist/src/tiles/list/tile-list-compact-header.js +41 -41
  130. package/dist/src/tiles/list/tile-list-compact.d.ts +20 -20
  131. package/dist/src/tiles/list/tile-list-compact.js +87 -87
  132. package/dist/src/tiles/list/tile-list.d.ts +50 -50
  133. package/dist/src/tiles/list/tile-list.js +263 -263
  134. package/dist/src/tiles/mediatype-icon.d.ts +9 -9
  135. package/dist/src/tiles/mediatype-icon.js +47 -47
  136. package/dist/src/tiles/overlay/icon-overlay.d.ts +7 -7
  137. package/dist/src/tiles/overlay/icon-overlay.js +31 -31
  138. package/dist/src/tiles/overlay/text-overlay.d.ts +8 -8
  139. package/dist/src/tiles/overlay/text-overlay.js +31 -31
  140. package/dist/src/tiles/text-snippet-block.d.ts +29 -29
  141. package/dist/src/tiles/text-snippet-block.js +81 -81
  142. package/dist/src/tiles/text-snippet-block.js.map +1 -1
  143. package/dist/src/tiles/tile-dispatcher.d.ts +36 -36
  144. package/dist/src/tiles/tile-dispatcher.js +128 -128
  145. package/dist/src/utils/analytics-events.d.ts +18 -18
  146. package/dist/src/utils/analytics-events.js +20 -20
  147. package/dist/src/utils/format-count.d.ts +7 -7
  148. package/dist/src/utils/format-count.js +75 -75
  149. package/dist/src/utils/format-date.d.ts +2 -2
  150. package/dist/src/utils/format-date.js +23 -23
  151. package/dist/test/collection-browser.test.d.ts +1 -1
  152. package/dist/test/collection-browser.test.js +328 -200
  153. package/dist/test/collection-browser.test.js.map +1 -1
  154. package/dist/test/collection-facets/facets-template.test.d.ts +1 -1
  155. package/dist/test/collection-facets/facets-template.test.js +62 -62
  156. package/dist/test/collection-facets/facets-util.test.d.ts +1 -1
  157. package/dist/test/collection-facets/facets-util.test.js +12 -12
  158. package/dist/test/collection-facets/more-facets-content.test.d.ts +1 -1
  159. package/dist/test/collection-facets/more-facets-content.test.js +92 -91
  160. package/dist/test/collection-facets/more-facets-content.test.js.map +1 -1
  161. package/dist/test/collection-facets/more-facets-pagination.test.d.ts +1 -1
  162. package/dist/test/collection-facets/more-facets-pagination.test.js +117 -117
  163. package/dist/test/collection-facets.test.d.ts +2 -2
  164. package/dist/test/collection-facets.test.js +182 -181
  165. package/dist/test/collection-facets.test.js.map +1 -1
  166. package/dist/test/empty-placeholder.test.d.ts +1 -1
  167. package/dist/test/empty-placeholder.test.js +33 -33
  168. package/dist/test/icon-overlay.test.d.ts +1 -1
  169. package/dist/test/icon-overlay.test.js +24 -24
  170. package/dist/test/item-image.test.d.ts +1 -1
  171. package/dist/test/item-image.test.js +56 -56
  172. package/dist/test/mediatype-config.test.d.ts +1 -1
  173. package/dist/test/mediatype-config.test.js +16 -16
  174. package/dist/test/mocks/mock-analytics-handler.d.ts +10 -10
  175. package/dist/test/mocks/mock-analytics-handler.js +15 -15
  176. package/dist/test/mocks/mock-collection-name-cache.d.ts +7 -7
  177. package/dist/test/mocks/mock-collection-name-cache.js +13 -13
  178. package/dist/test/mocks/mock-search-responses.d.ts +5 -4
  179. package/dist/test/mocks/mock-search-responses.js +103 -57
  180. package/dist/test/mocks/mock-search-responses.js.map +1 -1
  181. package/dist/test/mocks/mock-search-service.d.ts +13 -8
  182. package/dist/test/mocks/mock-search-service.js +25 -19
  183. package/dist/test/mocks/mock-search-service.js.map +1 -1
  184. package/dist/test/sort-filter-bar/sort-filter-bar.test.d.ts +1 -1
  185. package/dist/test/sort-filter-bar/sort-filter-bar.test.js +113 -113
  186. package/dist/test/text-overlay.test.d.ts +1 -1
  187. package/dist/test/text-overlay.test.js +41 -41
  188. package/dist/test/text-snippet-block.test.d.ts +1 -1
  189. package/dist/test/text-snippet-block.test.js +57 -45
  190. package/dist/test/text-snippet-block.test.js.map +1 -1
  191. package/dist/test/tile-stats.test.d.ts +1 -1
  192. package/dist/test/tile-stats.test.js +33 -33
  193. package/dist/test/tiles/grid/item-tile.test.d.ts +1 -1
  194. package/dist/test/tiles/grid/item-tile.test.js +107 -107
  195. package/dist/test/tiles/list/tile-list.test.d.ts +1 -1
  196. package/dist/test/tiles/list/tile-list.test.js +36 -36
  197. package/dist/test/utils/format-count.test.d.ts +1 -1
  198. package/dist/test/utils/format-count.test.js +23 -23
  199. package/dist/test/utils/format-date.test.d.ts +1 -1
  200. package/dist/test/utils/format-date.test.js +17 -17
  201. package/index.html +24 -24
  202. package/local.archive.org.cert +86 -86
  203. package/local.archive.org.key +27 -27
  204. package/package.json +115 -115
  205. package/renovate.json +6 -6
  206. package/src/app-root.ts +49 -11
  207. package/src/collection-browser.ts +76 -86
  208. package/src/collection-facets/more-facets-content.ts +35 -27
  209. package/src/collection-facets.ts +9 -26
  210. package/src/models.ts +2 -0
  211. package/src/tiles/text-snippet-block.ts +1 -1
  212. package/test/collection-browser.test.ts +192 -0
  213. package/test/collection-facets/more-facets-content.test.ts +5 -5
  214. package/test/collection-facets.test.ts +16 -15
  215. package/test/mocks/mock-search-responses.ts +83 -34
  216. package/test/mocks/mock-search-service.ts +27 -17
  217. package/test/text-snippet-block.test.ts +17 -0
  218. package/tsconfig.json +21 -21
  219. package/web-dev-server.config.mjs +30 -30
  220. 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,89 +1,90 @@
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
- loginRequired: boolean;
27
- contentWarning: boolean;
28
- }
29
- export declare type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';
30
- export declare type TileDisplayMode = 'grid' | 'list-compact' | 'list-detail' | 'list-header';
31
- /**
32
- * This is mainly used to set the cookies for the collection display mode.
33
- *
34
- * It allows the user to set different modes for different contexts (collection page, search page, etc).
35
- */
36
- export declare type CollectionBrowserContext = 'collection' | 'search';
37
- /**
38
- * The sort fields shown in the sort filter bar
39
- */
40
- export declare enum SortField {
41
- 'relevance' = "relevance",
42
- 'alltimeview' = "alltimeview",
43
- 'weeklyview' = "weeklyview",
44
- 'title' = "title",
45
- 'datearchived' = "datearchived",
46
- 'date' = "date",
47
- 'datereviewed' = "datereviewed",
48
- 'dateadded' = "dateadded",
49
- 'creator' = "creator"
50
- }
51
- /**
52
- * The metadata fields we sort by that map to the SortFields above
53
- */
54
- export declare type MetadataSortField = 'downloads' | 'week' | 'titleSorter' | 'date' | 'creatorSorter' | 'publicdate' | 'reviewdate' | 'addeddate';
55
- export declare const SortFieldDisplayName: {
56
- [key in SortField]: string;
57
- };
58
- /**
59
- * Maps the SortField above to the corresponding Metadata field in the API.
60
- */
61
- export declare const SortFieldToMetadataField: {
62
- [key in SortField]: MetadataSortField | null;
63
- };
64
- /**
65
- * Maps the Metadata field to the corresponding SortField field in the API.
66
- */
67
- export declare const MetadataFieldToSortField: {
68
- [key in MetadataSortField]: SortField;
69
- };
70
- export declare type FacetOption = 'subject' | 'mediatype' | 'language' | 'creator' | 'collection' | 'year';
71
- export declare type SelectedFacetState = 'selected' | 'hidden';
72
- export declare type FacetState = SelectedFacetState | 'none';
73
- export interface FacetBucket {
74
- displayText?: string;
75
- key: string;
76
- count: number;
77
- state: FacetState;
78
- }
79
- export interface FacetGroup {
80
- title: string;
81
- key: FacetOption;
82
- buckets: FacetBucket[];
83
- }
84
- export declare type FacetValue = string;
85
- export declare type SelectedFacets = Record<FacetOption, Record<FacetValue, FacetBucket>>;
86
- export declare const defaultSelectedFacets: SelectedFacets;
87
- export declare const facetDisplayOrder: FacetOption[];
88
- export declare const aggregationToFacetOption: Record<string, FacetOption>;
89
- export declare const facetTitles: Record<FacetOption, string>;
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
+ loginRequired: boolean;
27
+ contentWarning: boolean;
28
+ }
29
+ export declare type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';
30
+ export declare type TileDisplayMode = 'grid' | 'list-compact' | 'list-detail' | 'list-header';
31
+ /**
32
+ * This is mainly used to set the cookies for the collection display mode.
33
+ *
34
+ * It allows the user to set different modes for different contexts (collection page, search page, etc).
35
+ */
36
+ export declare type CollectionBrowserContext = 'collection' | 'search';
37
+ /**
38
+ * The sort fields shown in the sort filter bar
39
+ */
40
+ export declare enum SortField {
41
+ 'relevance' = "relevance",
42
+ 'alltimeview' = "alltimeview",
43
+ 'weeklyview' = "weeklyview",
44
+ 'title' = "title",
45
+ 'datearchived' = "datearchived",
46
+ 'date' = "date",
47
+ 'datereviewed' = "datereviewed",
48
+ 'dateadded' = "dateadded",
49
+ 'creator' = "creator"
50
+ }
51
+ /**
52
+ * The metadata fields we sort by that map to the SortFields above
53
+ */
54
+ export declare type MetadataSortField = 'downloads' | 'week' | 'titleSorter' | 'date' | 'creatorSorter' | 'publicdate' | 'reviewdate' | 'addeddate';
55
+ export declare const SortFieldDisplayName: {
56
+ [key in SortField]: string;
57
+ };
58
+ /**
59
+ * Maps the SortField above to the corresponding Metadata field in the API.
60
+ */
61
+ export declare const SortFieldToMetadataField: {
62
+ [key in SortField]: MetadataSortField | null;
63
+ };
64
+ /**
65
+ * Maps the Metadata field to the corresponding SortField field in the API.
66
+ */
67
+ export declare const MetadataFieldToSortField: {
68
+ [key in MetadataSortField]: SortField;
69
+ };
70
+ export declare type FacetOption = 'subject' | 'mediatype' | 'language' | 'creator' | 'collection' | 'year';
71
+ export declare type SelectedFacetState = 'selected' | 'hidden';
72
+ export declare type FacetState = SelectedFacetState | 'none';
73
+ export interface FacetBucket {
74
+ displayText?: string;
75
+ key: string;
76
+ count: number;
77
+ state: FacetState;
78
+ }
79
+ export interface FacetGroup {
80
+ title: string;
81
+ key: FacetOption;
82
+ buckets: FacetBucket[];
83
+ }
84
+ export declare type FacetValue = string;
85
+ export declare type SelectedFacets = Record<FacetOption, Record<FacetValue, FacetBucket>>;
86
+ export declare type SearchTarget = 'metadata' | 'fulltext';
87
+ export declare const defaultSelectedFacets: SelectedFacets;
88
+ export declare const facetDisplayOrder: FacetOption[];
89
+ export declare const aggregationToFacetOption: Record<string, FacetOption>;
90
+ export declare const facetTitles: Record<FacetOption, string>;
@@ -1,86 +1,86 @@
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
- export const defaultSelectedFacets = {
55
- subject: {},
56
- mediatype: {},
57
- language: {},
58
- creator: {},
59
- collection: {},
60
- year: {},
61
- };
62
- export const facetDisplayOrder = [
63
- 'mediatype',
64
- 'year',
65
- 'subject',
66
- 'collection',
67
- 'creator',
68
- 'language',
69
- ];
70
- export const aggregationToFacetOption = {
71
- subjectSorter: 'subject',
72
- mediatypeSorter: 'mediatype',
73
- languageSorter: 'language',
74
- creatorSorter: 'creator',
75
- collection: 'collection',
76
- year: 'year',
77
- };
78
- export const facetTitles = {
79
- subject: 'Subject',
80
- mediatype: 'Media Type',
81
- language: 'Language',
82
- creator: 'Creator',
83
- collection: 'Collection',
84
- year: 'Year',
85
- };
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
+ export const defaultSelectedFacets = {
55
+ subject: {},
56
+ mediatype: {},
57
+ language: {},
58
+ creator: {},
59
+ collection: {},
60
+ year: {},
61
+ };
62
+ export const facetDisplayOrder = [
63
+ 'mediatype',
64
+ 'year',
65
+ 'subject',
66
+ 'collection',
67
+ 'creator',
68
+ 'language',
69
+ ];
70
+ export const aggregationToFacetOption = {
71
+ subjectSorter: 'subject',
72
+ mediatypeSorter: 'mediatype',
73
+ languageSorter: 'language',
74
+ creatorSorter: 'creator',
75
+ collection: 'collection',
76
+ year: 'year',
77
+ };
78
+ export const facetTitles = {
79
+ subject: 'Subject',
80
+ mediatype: 'Media Type',
81
+ language: 'Language',
82
+ creator: 'Creator',
83
+ collection: 'Collection',
84
+ year: 'Year',
85
+ };
86
86
  //# sourceMappingURL=models.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AA6CA;;GAEG;AACH,MAAM,CAAN,IAAY,SAUX;AAVD,WAAY,SAAS;IACnB,oCAAyB,CAAA;IACzB,wCAA6B,CAAA;IAC7B,sCAA2B,CAAA;IAC3B,4BAAiB,CAAA;IACjB,0CAA+B,CAAA;IAC/B,0BAAe,CAAA;IACf,0CAA+B,CAAA;IAC/B,oCAAyB,CAAA;IACzB,gCAAqB,CAAA;AACvB,CAAC,EAVW,SAAS,KAAT,SAAS,QAUpB;AAeD,MAAM,CAAC,MAAM,oBAAoB,GAE7B;IACF,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,gBAAgB;IAC7B,UAAU,EAAE,cAAc;IAC1B,KAAK,EAAE,OAAO;IACd,YAAY,EAAE,eAAe;IAC7B,IAAI,EAAE,gBAAgB;IACtB,YAAY,EAAE,eAAe;IAC7B,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,SAAS;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,MAAM;IAClB,KAAK,EAAE,aAAa;IACpB,YAAY,EAAE,YAAY;IAC1B,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,YAAY;IAC1B,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,eAAe;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,IAAI,EAAE,SAAS,CAAC,UAAU;IAC1B,SAAS,EAAE,SAAS,CAAC,WAAW;IAChC,WAAW,EAAE,SAAS,CAAC,KAAK;IAC5B,IAAI,EAAE,SAAS,CAAC,IAAI;IACpB,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,SAAS,EAAE,SAAS,CAAC,SAAS;IAC9B,aAAa,EAAE,SAAS,CAAC,OAAO;CACjC,CAAC;AAmCF,MAAM,CAAC,MAAM,qBAAqB,GAAmB;IACnD,OAAO,EAAE,EAAE;IACX,SAAS,EAAE,EAAE;IACb,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,EAAE;IACX,UAAU,EAAE,EAAE;IACd,IAAI,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAkB;IAC9C,WAAW;IACX,MAAM;IACN,SAAS;IACT,YAAY;IACZ,SAAS;IACT,UAAU;CACX,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAgC;IACnE,aAAa,EAAE,SAAS;IACxB,eAAe,EAAE,WAAW;IAC5B,cAAc,EAAE,UAAU;IAC1B,aAAa,EAAE,SAAS;IACxB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;CACb,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAgC;IACtD,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,YAAY;IACvB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;CACb,CAAC","sourcesContent":["import type { MediaType } from '@internetarchive/field-parsers';\n\nexport interface TileModel {\n averageRating?: number;\n collectionIdentifier?: string;\n collectionName?: string;\n collections: string[];\n commentCount: number;\n creator?: string;\n creators: string[];\n dateAdded?: Date; // Date added to public search (software-defined) [from: addeddate]\n dateArchived?: Date; // Date archived (software-defined) item created on archive.org [from: publicdate]\n datePublished?: Date; // Date work published in the world (user-defined) [from: date]\n dateReviewed?: Date; // Date reviewed (user-created) most recent review [from: reviewdate]\n description?: string;\n favCount: number;\n identifier: string;\n issue?: string;\n itemCount: number;\n mediatype: MediaType;\n source?: string;\n snippets?: string[];\n subjects: string[];\n title: string;\n viewCount: number;\n volume?: string;\n loginRequired: boolean;\n contentWarning: boolean;\n}\n\nexport type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';\n\nexport type TileDisplayMode =\n | 'grid'\n | 'list-compact'\n | 'list-detail'\n | 'list-header';\n\n/**\n * This is mainly used to set the cookies for the collection display mode.\n *\n * It allows the user to set different modes for different contexts (collection page, search page, etc).\n */\nexport type CollectionBrowserContext = 'collection' | 'search';\n\n/**\n * The sort fields shown in the sort filter bar\n */\nexport enum SortField {\n 'relevance' = 'relevance',\n 'alltimeview' = 'alltimeview',\n 'weeklyview' = 'weeklyview',\n 'title' = 'title',\n 'datearchived' = 'datearchived',\n 'date' = 'date',\n 'datereviewed' = 'datereviewed',\n 'dateadded' = 'dateadded',\n 'creator' = 'creator',\n}\n\n/**\n * The metadata fields we sort by that map to the SortFields above\n */\nexport type MetadataSortField =\n | 'downloads'\n | 'week'\n | 'titleSorter'\n | 'date'\n | 'creatorSorter'\n | 'publicdate'\n | 'reviewdate'\n | 'addeddate';\n\nexport const SortFieldDisplayName: {\n [key in SortField]: string;\n} = {\n relevance: 'Relevance',\n alltimeview: 'All-time Views',\n weeklyview: 'Weekly Views',\n title: 'Title',\n datearchived: 'Date Archived',\n date: 'Date Published',\n datereviewed: 'Date Reviewed',\n dateadded: 'Date Added',\n creator: 'Creator',\n};\n\n/**\n * Maps the SortField above to the corresponding Metadata field in the API.\n */\nexport const SortFieldToMetadataField: {\n [key in SortField]: MetadataSortField | null;\n} = {\n relevance: null,\n alltimeview: 'downloads',\n weeklyview: 'week',\n title: 'titleSorter',\n datearchived: 'publicdate',\n date: 'date',\n datereviewed: 'reviewdate',\n dateadded: 'addeddate',\n creator: 'creatorSorter',\n};\n\n/**\n * Maps the Metadata field to the corresponding SortField field in the API.\n */\nexport const MetadataFieldToSortField: {\n [key in MetadataSortField]: SortField;\n} = {\n week: SortField.weeklyview,\n downloads: SortField.alltimeview,\n titleSorter: SortField.title,\n date: SortField.date,\n publicdate: SortField.datearchived,\n reviewdate: SortField.datereviewed,\n addeddate: SortField.dateadded,\n creatorSorter: SortField.creator,\n};\n\nexport type FacetOption =\n | 'subject'\n | 'mediatype'\n | 'language'\n | 'creator'\n | 'collection'\n | 'year';\n\nexport type SelectedFacetState = 'selected' | 'hidden';\n\nexport type FacetState = SelectedFacetState | 'none';\n\nexport interface FacetBucket {\n // for some facets, we augment the key with a display value\n displayText?: string;\n key: string;\n count: number;\n state: FacetState;\n}\n\nexport interface FacetGroup {\n title: string;\n key: FacetOption;\n buckets: FacetBucket[];\n}\n\nexport type FacetValue = string;\n\nexport type SelectedFacets = Record<\n FacetOption,\n Record<FacetValue, FacetBucket>\n>;\n\nexport const defaultSelectedFacets: SelectedFacets = {\n subject: {},\n mediatype: {},\n language: {},\n creator: {},\n collection: {},\n year: {},\n};\n\nexport const facetDisplayOrder: FacetOption[] = [\n 'mediatype',\n 'year',\n 'subject',\n 'collection',\n 'creator',\n 'language',\n];\n\nexport const aggregationToFacetOption: Record<string, FacetOption> = {\n subjectSorter: 'subject',\n mediatypeSorter: 'mediatype',\n languageSorter: 'language',\n creatorSorter: 'creator',\n collection: 'collection',\n year: 'year',\n};\n\nexport const facetTitles: Record<FacetOption, string> = {\n subject: 'Subject',\n mediatype: 'Media Type',\n language: 'Language',\n creator: 'Creator',\n collection: 'Collection',\n year: 'Year',\n};\n"]}
1
+ {"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AA6CA;;GAEG;AACH,MAAM,CAAN,IAAY,SAUX;AAVD,WAAY,SAAS;IACnB,oCAAyB,CAAA;IACzB,wCAA6B,CAAA;IAC7B,sCAA2B,CAAA;IAC3B,4BAAiB,CAAA;IACjB,0CAA+B,CAAA;IAC/B,0BAAe,CAAA;IACf,0CAA+B,CAAA;IAC/B,oCAAyB,CAAA;IACzB,gCAAqB,CAAA;AACvB,CAAC,EAVW,SAAS,KAAT,SAAS,QAUpB;AAeD,MAAM,CAAC,MAAM,oBAAoB,GAE7B;IACF,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,gBAAgB;IAC7B,UAAU,EAAE,cAAc;IAC1B,KAAK,EAAE,OAAO;IACd,YAAY,EAAE,eAAe;IAC7B,IAAI,EAAE,gBAAgB;IACtB,YAAY,EAAE,eAAe;IAC7B,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,SAAS;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,MAAM;IAClB,KAAK,EAAE,aAAa;IACpB,YAAY,EAAE,YAAY;IAC1B,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,YAAY;IAC1B,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,eAAe;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,IAAI,EAAE,SAAS,CAAC,UAAU;IAC1B,SAAS,EAAE,SAAS,CAAC,WAAW;IAChC,WAAW,EAAE,SAAS,CAAC,KAAK;IAC5B,IAAI,EAAE,SAAS,CAAC,IAAI;IACpB,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,SAAS,EAAE,SAAS,CAAC,SAAS;IAC9B,aAAa,EAAE,SAAS,CAAC,OAAO;CACjC,CAAC;AAqCF,MAAM,CAAC,MAAM,qBAAqB,GAAmB;IACnD,OAAO,EAAE,EAAE;IACX,SAAS,EAAE,EAAE;IACb,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,EAAE;IACX,UAAU,EAAE,EAAE;IACd,IAAI,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAkB;IAC9C,WAAW;IACX,MAAM;IACN,SAAS;IACT,YAAY;IACZ,SAAS;IACT,UAAU;CACX,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAgC;IACnE,aAAa,EAAE,SAAS;IACxB,eAAe,EAAE,WAAW;IAC5B,cAAc,EAAE,UAAU;IAC1B,aAAa,EAAE,SAAS;IACxB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;CACb,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAgC;IACtD,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,YAAY;IACvB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;CACb,CAAC","sourcesContent":["import type { MediaType } from '@internetarchive/field-parsers';\n\nexport interface TileModel {\n averageRating?: number;\n collectionIdentifier?: string;\n collectionName?: string;\n collections: string[];\n commentCount: number;\n creator?: string;\n creators: string[];\n dateAdded?: Date; // Date added to public search (software-defined) [from: addeddate]\n dateArchived?: Date; // Date archived (software-defined) item created on archive.org [from: publicdate]\n datePublished?: Date; // Date work published in the world (user-defined) [from: date]\n dateReviewed?: Date; // Date reviewed (user-created) most recent review [from: reviewdate]\n description?: string;\n favCount: number;\n identifier: string;\n issue?: string;\n itemCount: number;\n mediatype: MediaType;\n source?: string;\n snippets?: string[];\n subjects: string[];\n title: string;\n viewCount: number;\n volume?: string;\n loginRequired: boolean;\n contentWarning: boolean;\n}\n\nexport type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';\n\nexport type TileDisplayMode =\n | 'grid'\n | 'list-compact'\n | 'list-detail'\n | 'list-header';\n\n/**\n * This is mainly used to set the cookies for the collection display mode.\n *\n * It allows the user to set different modes for different contexts (collection page, search page, etc).\n */\nexport type CollectionBrowserContext = 'collection' | 'search';\n\n/**\n * The sort fields shown in the sort filter bar\n */\nexport enum SortField {\n 'relevance' = 'relevance',\n 'alltimeview' = 'alltimeview',\n 'weeklyview' = 'weeklyview',\n 'title' = 'title',\n 'datearchived' = 'datearchived',\n 'date' = 'date',\n 'datereviewed' = 'datereviewed',\n 'dateadded' = 'dateadded',\n 'creator' = 'creator',\n}\n\n/**\n * The metadata fields we sort by that map to the SortFields above\n */\nexport type MetadataSortField =\n | 'downloads'\n | 'week'\n | 'titleSorter'\n | 'date'\n | 'creatorSorter'\n | 'publicdate'\n | 'reviewdate'\n | 'addeddate';\n\nexport const SortFieldDisplayName: {\n [key in SortField]: string;\n} = {\n relevance: 'Relevance',\n alltimeview: 'All-time Views',\n weeklyview: 'Weekly Views',\n title: 'Title',\n datearchived: 'Date Archived',\n date: 'Date Published',\n datereviewed: 'Date Reviewed',\n dateadded: 'Date Added',\n creator: 'Creator',\n};\n\n/**\n * Maps the SortField above to the corresponding Metadata field in the API.\n */\nexport const SortFieldToMetadataField: {\n [key in SortField]: MetadataSortField | null;\n} = {\n relevance: null,\n alltimeview: 'downloads',\n weeklyview: 'week',\n title: 'titleSorter',\n datearchived: 'publicdate',\n date: 'date',\n datereviewed: 'reviewdate',\n dateadded: 'addeddate',\n creator: 'creatorSorter',\n};\n\n/**\n * Maps the Metadata field to the corresponding SortField field in the API.\n */\nexport const MetadataFieldToSortField: {\n [key in MetadataSortField]: SortField;\n} = {\n week: SortField.weeklyview,\n downloads: SortField.alltimeview,\n titleSorter: SortField.title,\n date: SortField.date,\n publicdate: SortField.datearchived,\n reviewdate: SortField.datereviewed,\n addeddate: SortField.dateadded,\n creatorSorter: SortField.creator,\n};\n\nexport type FacetOption =\n | 'subject'\n | 'mediatype'\n | 'language'\n | 'creator'\n | 'collection'\n | 'year';\n\nexport type SelectedFacetState = 'selected' | 'hidden';\n\nexport type FacetState = SelectedFacetState | 'none';\n\nexport interface FacetBucket {\n // for some facets, we augment the key with a display value\n displayText?: string;\n key: string;\n count: number;\n state: FacetState;\n}\n\nexport interface FacetGroup {\n title: string;\n key: FacetOption;\n buckets: FacetBucket[];\n}\n\nexport type FacetValue = string;\n\nexport type SelectedFacets = Record<\n FacetOption,\n Record<FacetValue, FacetBucket>\n>;\n\nexport type SearchTarget = 'metadata' | 'fulltext';\n\nexport const defaultSelectedFacets: SelectedFacets = {\n subject: {},\n mediatype: {},\n language: {},\n creator: {},\n collection: {},\n year: {},\n};\n\nexport const facetDisplayOrder: FacetOption[] = [\n 'mediatype',\n 'year',\n 'subject',\n 'collection',\n 'creator',\n 'language',\n];\n\nexport const aggregationToFacetOption: Record<string, FacetOption> = {\n subjectSorter: 'subject',\n mediatypeSorter: 'mediatype',\n languageSorter: 'language',\n creatorSorter: 'creator',\n collection: 'collection',\n year: 'year',\n};\n\nexport const facetTitles: Record<FacetOption, string> = {\n subject: 'Subject',\n mediatype: 'Media Type',\n language: 'Language',\n creator: 'Creator',\n collection: 'Collection',\n year: 'Year',\n};\n"]}
@@ -1,38 +1,38 @@
1
- import type { SortDirection, SortParam } from '@internetarchive/search-service';
2
- import { CollectionBrowserContext, CollectionDisplayMode, SelectedFacets, SortField } from './models';
3
- export interface RestorationState {
4
- displayMode?: CollectionDisplayMode;
5
- sortParam?: SortParam;
6
- selectedSort?: SortField;
7
- sortDirection?: SortDirection;
8
- selectedFacets: SelectedFacets;
9
- baseQuery?: string;
10
- currentPage?: number;
11
- dateRangeQueryClause?: string;
12
- titleQuery?: string;
13
- creatorQuery?: string;
14
- minSelectedDate?: string;
15
- maxSelectedDate?: string;
16
- selectedTitleFilter?: string;
17
- selectedCreatorFilter?: string;
18
- }
19
- export interface RestorationStateHandlerInterface {
20
- persistState(state: RestorationState): void;
21
- getRestorationState(): RestorationState;
22
- }
23
- export declare class RestorationStateHandler implements RestorationStateHandlerInterface {
24
- private context;
25
- private cookieDomain;
26
- private cookieExpiration;
27
- private cookiePath;
28
- constructor(options: {
29
- context: CollectionBrowserContext;
30
- });
31
- persistState(state: RestorationState): void;
32
- getRestorationState(): RestorationState;
33
- private persistViewStateToCookies;
34
- private loadTileViewStateFromCookies;
35
- private persistQueryStateToUrl;
36
- private loadQueryStateFromUrl;
37
- private stripQuotes;
38
- }
1
+ import type { SortDirection, SortParam } from '@internetarchive/search-service';
2
+ import { CollectionBrowserContext, CollectionDisplayMode, SelectedFacets, SortField } from './models';
3
+ export interface RestorationState {
4
+ displayMode?: CollectionDisplayMode;
5
+ sortParam?: SortParam;
6
+ selectedSort?: SortField;
7
+ sortDirection?: SortDirection;
8
+ selectedFacets: SelectedFacets;
9
+ baseQuery?: string;
10
+ currentPage?: number;
11
+ dateRangeQueryClause?: string;
12
+ titleQuery?: string;
13
+ creatorQuery?: string;
14
+ minSelectedDate?: string;
15
+ maxSelectedDate?: string;
16
+ selectedTitleFilter?: string;
17
+ selectedCreatorFilter?: string;
18
+ }
19
+ export interface RestorationStateHandlerInterface {
20
+ persistState(state: RestorationState): void;
21
+ getRestorationState(): RestorationState;
22
+ }
23
+ export declare class RestorationStateHandler implements RestorationStateHandlerInterface {
24
+ private context;
25
+ private cookieDomain;
26
+ private cookieExpiration;
27
+ private cookiePath;
28
+ constructor(options: {
29
+ context: CollectionBrowserContext;
30
+ });
31
+ persistState(state: RestorationState): void;
32
+ getRestorationState(): RestorationState;
33
+ private persistViewStateToCookies;
34
+ private loadTileViewStateFromCookies;
35
+ private persistQueryStateToUrl;
36
+ private loadQueryStateFromUrl;
37
+ private stripQuotes;
38
+ }