@internetarchive/collection-browser 0.3.8 → 0.3.9

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 (204) 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 +48 -48
  12. package/dist/src/app-root.js +258 -258
  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 +278 -278
  68. package/dist/src/collection-browser.js +1105 -1105
  69. package/dist/src/collection-facets/facet-tombstone-row.d.ts +5 -5
  70. package/dist/src/collection-facets/facet-tombstone-row.js +15 -15
  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/more-facets-content.d.ts +76 -76
  74. package/dist/src/collection-facets/more-facets-content.js +353 -353
  75. package/dist/src/collection-facets/more-facets-pagination.d.ts +36 -36
  76. package/dist/src/collection-facets/more-facets-pagination.js +192 -192
  77. package/dist/src/collection-facets.d.ts +77 -77
  78. package/dist/src/collection-facets.js +388 -388
  79. package/dist/src/empty-placeholder.d.ts +11 -11
  80. package/dist/src/empty-placeholder.js +42 -42
  81. package/dist/src/language-code-handler/language-code-handler.d.ts +37 -37
  82. package/dist/src/language-code-handler/language-code-handler.js +26 -26
  83. package/dist/src/language-code-handler/language-code-mapping.d.ts +1 -1
  84. package/dist/src/language-code-handler/language-code-mapping.js +562 -562
  85. package/dist/src/mediatype/mediatype-config.d.ts +3 -3
  86. package/dist/src/mediatype/mediatype-config.js +85 -85
  87. package/dist/src/models.d.ts +103 -103
  88. package/dist/src/models.js +117 -117
  89. package/dist/src/restoration-state-handler.d.ts +46 -46
  90. package/dist/src/restoration-state-handler.js +230 -230
  91. package/dist/src/sort-filter-bar/alpha-bar.d.ts +9 -9
  92. package/dist/src/sort-filter-bar/alpha-bar.js +41 -41
  93. package/dist/src/sort-filter-bar/img/compact.d.ts +1 -1
  94. package/dist/src/sort-filter-bar/img/compact.js +2 -2
  95. package/dist/src/sort-filter-bar/img/list.d.ts +1 -1
  96. package/dist/src/sort-filter-bar/img/list.js +2 -2
  97. package/dist/src/sort-filter-bar/img/sort-triangle.d.ts +1 -1
  98. package/dist/src/sort-filter-bar/img/sort-triangle.js +2 -2
  99. package/dist/src/sort-filter-bar/img/tile.d.ts +1 -1
  100. package/dist/src/sort-filter-bar/img/tile.js +2 -2
  101. package/dist/src/sort-filter-bar/sort-filter-bar.d.ts +107 -107
  102. package/dist/src/sort-filter-bar/sort-filter-bar.js +423 -423
  103. package/dist/src/styles/item-image-styles.d.ts +8 -8
  104. package/dist/src/styles/item-image-styles.js +9 -9
  105. package/dist/src/tiles/collection-browser-loading-tile.d.ts +5 -5
  106. package/dist/src/tiles/collection-browser-loading-tile.js +15 -15
  107. package/dist/src/tiles/grid/account-tile.d.ts +8 -8
  108. package/dist/src/tiles/grid/account-tile.js +20 -20
  109. package/dist/src/tiles/grid/collection-tile.d.ts +7 -7
  110. package/dist/src/tiles/grid/collection-tile.js +23 -23
  111. package/dist/src/tiles/grid/item-tile.d.ts +24 -24
  112. package/dist/src/tiles/grid/item-tile.js +87 -87
  113. package/dist/src/tiles/grid/tile-stats.d.ts +10 -10
  114. package/dist/src/tiles/grid/tile-stats.js +40 -40
  115. package/dist/src/tiles/image-block.d.ts +17 -17
  116. package/dist/src/tiles/image-block.js +69 -69
  117. package/dist/src/tiles/item-image.d.ts +31 -31
  118. package/dist/src/tiles/item-image.js +103 -103
  119. package/dist/src/tiles/list/account-label.d.ts +1 -1
  120. package/dist/src/tiles/list/account-label.js +6 -6
  121. package/dist/src/tiles/list/date-label.d.ts +1 -1
  122. package/dist/src/tiles/list/date-label.js +12 -12
  123. package/dist/src/tiles/list/tile-list-compact-header.d.ts +12 -12
  124. package/dist/src/tiles/list/tile-list-compact-header.js +41 -41
  125. package/dist/src/tiles/list/tile-list-compact.d.ts +21 -21
  126. package/dist/src/tiles/list/tile-list-compact.js +93 -93
  127. package/dist/src/tiles/list/tile-list.d.ts +50 -50
  128. package/dist/src/tiles/list/tile-list.js +280 -275
  129. package/dist/src/tiles/list/tile-list.js.map +1 -1
  130. package/dist/src/tiles/mediatype-icon.d.ts +9 -9
  131. package/dist/src/tiles/mediatype-icon.js +47 -47
  132. package/dist/src/tiles/overlay/icon-overlay.d.ts +7 -7
  133. package/dist/src/tiles/overlay/icon-overlay.js +30 -30
  134. package/dist/src/tiles/overlay/text-overlay.d.ts +8 -8
  135. package/dist/src/tiles/overlay/text-overlay.js +31 -31
  136. package/dist/src/tiles/text-snippet-block.d.ts +29 -29
  137. package/dist/src/tiles/text-snippet-block.js +81 -81
  138. package/dist/src/tiles/tile-dispatcher.d.ts +36 -36
  139. package/dist/src/tiles/tile-dispatcher.js +128 -128
  140. package/dist/src/utils/analytics-events.d.ts +22 -22
  141. package/dist/src/utils/analytics-events.js +24 -24
  142. package/dist/src/utils/format-count.d.ts +7 -7
  143. package/dist/src/utils/format-count.js +76 -76
  144. package/dist/src/utils/format-date.d.ts +2 -2
  145. package/dist/src/utils/format-date.js +23 -23
  146. package/dist/test/collection-browser.test.d.ts +1 -1
  147. package/dist/test/collection-browser.test.js +575 -575
  148. package/dist/test/collection-facets/facets-template.test.d.ts +1 -1
  149. package/dist/test/collection-facets/facets-template.test.js +62 -62
  150. package/dist/test/collection-facets/more-facets-content.test.d.ts +1 -1
  151. package/dist/test/collection-facets/more-facets-content.test.js +114 -114
  152. package/dist/test/collection-facets/more-facets-pagination.test.d.ts +1 -1
  153. package/dist/test/collection-facets/more-facets-pagination.test.js +117 -117
  154. package/dist/test/collection-facets.test.d.ts +2 -2
  155. package/dist/test/collection-facets.test.js +544 -544
  156. package/dist/test/empty-placeholder.test.d.ts +1 -1
  157. package/dist/test/empty-placeholder.test.js +33 -33
  158. package/dist/test/icon-overlay.test.d.ts +1 -1
  159. package/dist/test/icon-overlay.test.js +24 -24
  160. package/dist/test/image-block.test.d.ts +1 -1
  161. package/dist/test/image-block.test.js +48 -48
  162. package/dist/test/item-image.test.d.ts +1 -1
  163. package/dist/test/item-image.test.js +56 -56
  164. package/dist/test/mediatype-config.test.d.ts +1 -1
  165. package/dist/test/mediatype-config.test.js +16 -16
  166. package/dist/test/mocks/mock-analytics-handler.d.ts +10 -10
  167. package/dist/test/mocks/mock-analytics-handler.js +15 -15
  168. package/dist/test/mocks/mock-collection-name-cache.d.ts +7 -7
  169. package/dist/test/mocks/mock-collection-name-cache.js +13 -13
  170. package/dist/test/mocks/mock-search-responses.d.ts +10 -10
  171. package/dist/test/mocks/mock-search-responses.js +271 -271
  172. package/dist/test/mocks/mock-search-service.d.ts +13 -13
  173. package/dist/test/mocks/mock-search-service.js +36 -36
  174. package/dist/test/restoration-state-handler.test.d.ts +1 -1
  175. package/dist/test/restoration-state-handler.test.js +126 -126
  176. package/dist/test/sort-filter-bar/sort-filter-bar.test.d.ts +1 -1
  177. package/dist/test/sort-filter-bar/sort-filter-bar.test.js +113 -113
  178. package/dist/test/text-overlay.test.d.ts +1 -1
  179. package/dist/test/text-overlay.test.js +41 -41
  180. package/dist/test/text-snippet-block.test.d.ts +1 -1
  181. package/dist/test/text-snippet-block.test.js +57 -57
  182. package/dist/test/tile-stats.test.d.ts +1 -1
  183. package/dist/test/tile-stats.test.js +33 -33
  184. package/dist/test/tiles/grid/item-tile.test.d.ts +1 -1
  185. package/dist/test/tiles/grid/item-tile.test.js +107 -107
  186. package/dist/test/tiles/list/tile-list-compact.test.d.ts +1 -1
  187. package/dist/test/tiles/list/tile-list-compact.test.js +92 -92
  188. package/dist/test/tiles/list/tile-list.test.d.ts +1 -1
  189. package/dist/test/tiles/list/tile-list.test.js +136 -92
  190. package/dist/test/tiles/list/tile-list.test.js.map +1 -1
  191. package/dist/test/utils/format-count.test.d.ts +1 -1
  192. package/dist/test/utils/format-count.test.js +23 -23
  193. package/dist/test/utils/format-date.test.d.ts +1 -1
  194. package/dist/test/utils/format-date.test.js +17 -17
  195. package/index.html +24 -24
  196. package/local.archive.org.cert +86 -86
  197. package/local.archive.org.key +27 -27
  198. package/package.json +1 -1
  199. package/renovate.json +6 -6
  200. package/src/tiles/list/tile-list.ts +12 -5
  201. package/test/tiles/list/tile-list.test.ts +51 -0
  202. package/tsconfig.json +21 -21
  203. package/web-dev-server.config.mjs +30 -30
  204. 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,103 +1,103 @@
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
- export declare type FacetOption = 'subject' | 'lending' | 'mediatype' | 'language' | 'creator' | 'collection' | 'year';
72
- export declare type SelectedFacetState = 'selected' | 'hidden';
73
- export declare type FacetState = SelectedFacetState | 'none';
74
- export interface FacetBucket {
75
- displayText?: string;
76
- key: string;
77
- count: number;
78
- state: FacetState;
79
- }
80
- export interface FacetGroup {
81
- title: string;
82
- key: FacetOption;
83
- buckets: FacetBucket[];
84
- }
85
- export declare type FacetValue = string;
86
- export declare type SelectedFacets = Record<FacetOption, Record<FacetValue, FacetBucket>>;
87
- export declare const defaultSelectedFacets: SelectedFacets;
88
- export declare const facetDisplayOrder: FacetOption[];
89
- export declare const facetTitles: Record<FacetOption, string>;
90
- export declare type LendingFacetKey = 'is_lendable' | 'is_borrowable' | 'available_to_borrow' | 'is_browsable' | 'available_to_browse' | 'is_readable' | 'available_to_waitlist';
91
- /**
92
- * Maps valid lending keys to whether they should be visible in the facet sidebar
93
- */
94
- export declare const lendingFacetKeysVisibility: Record<LendingFacetKey, boolean>;
95
- /**
96
- * Maps valid, visible lending keys to their facet sidebar display text
97
- */
98
- export declare const lendingFacetDisplayNames: Partial<Record<LendingFacetKey, string>>;
99
- /**
100
- * A record of which admin-only collections should be suppressed from being displayed
101
- * as facets or in an item's list of collections.
102
- */
103
- 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
+ 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
+ export declare type FacetOption = 'subject' | 'lending' | 'mediatype' | 'language' | 'creator' | 'collection' | 'year';
72
+ export declare type SelectedFacetState = 'selected' | 'hidden';
73
+ export declare type FacetState = SelectedFacetState | 'none';
74
+ export interface FacetBucket {
75
+ displayText?: string;
76
+ key: string;
77
+ count: number;
78
+ state: FacetState;
79
+ }
80
+ export interface FacetGroup {
81
+ title: string;
82
+ key: FacetOption;
83
+ buckets: FacetBucket[];
84
+ }
85
+ export declare type FacetValue = string;
86
+ export declare type SelectedFacets = Record<FacetOption, Record<FacetValue, FacetBucket>>;
87
+ export declare const defaultSelectedFacets: SelectedFacets;
88
+ export declare const facetDisplayOrder: FacetOption[];
89
+ export declare const facetTitles: Record<FacetOption, string>;
90
+ export declare type LendingFacetKey = 'is_lendable' | 'is_borrowable' | 'available_to_borrow' | 'is_browsable' | 'available_to_browse' | 'is_readable' | 'available_to_waitlist';
91
+ /**
92
+ * Maps valid lending keys to whether they should be visible in the facet sidebar
93
+ */
94
+ export declare const lendingFacetKeysVisibility: Record<LendingFacetKey, boolean>;
95
+ /**
96
+ * Maps valid, visible lending keys to their facet sidebar display text
97
+ */
98
+ export declare const lendingFacetDisplayNames: Partial<Record<LendingFacetKey, string>>;
99
+ /**
100
+ * A record of which admin-only collections should be suppressed from being displayed
101
+ * as facets or in an item's list of collections.
102
+ */
103
+ export declare const suppressedCollections: Record<string, boolean>;
@@ -1,118 +1,118 @@
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
- lending: {},
57
- mediatype: {},
58
- language: {},
59
- creator: {},
60
- collection: {},
61
- year: {},
62
- };
63
- export const facetDisplayOrder = [
64
- 'mediatype',
65
- 'lending',
66
- 'year',
67
- 'subject',
68
- 'collection',
69
- 'creator',
70
- 'language',
71
- ];
72
- export const facetTitles = {
73
- subject: 'Subject',
74
- lending: 'Availability',
75
- mediatype: 'Media Type',
76
- language: 'Language',
77
- creator: 'Creator',
78
- collection: 'Collection',
79
- year: 'Year',
80
- };
81
- /**
82
- * Maps valid lending keys to whether they should be visible in the facet sidebar
83
- */
84
- export const lendingFacetKeysVisibility = {
85
- is_lendable: true,
86
- is_borrowable: false,
87
- available_to_borrow: true,
88
- is_browsable: false,
89
- available_to_browse: false,
90
- is_readable: true,
91
- available_to_waitlist: false,
92
- };
93
- /**
94
- * Maps valid, visible lending keys to their facet sidebar display text
95
- */
96
- export const lendingFacetDisplayNames = {
97
- is_lendable: 'Lending Library',
98
- available_to_borrow: 'Borrow 14 Days',
99
- is_readable: 'Always Available',
100
- };
101
- /**
102
- * A record of which admin-only collections should be suppressed from being displayed
103
- * as facets or in an item's list of collections.
104
- */
105
- export const suppressedCollections = {
106
- deemphasize: true,
107
- community: true,
108
- stream_only: true,
109
- samples_only: true,
110
- test_collection: true,
111
- printdisabled: true,
112
- 'openlibrary-ol': true,
113
- nationalemergencylibrary: true,
114
- china: true,
115
- americana: true,
116
- toronto: true,
117
- };
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
+ lending: {},
57
+ mediatype: {},
58
+ language: {},
59
+ creator: {},
60
+ collection: {},
61
+ year: {},
62
+ };
63
+ export const facetDisplayOrder = [
64
+ 'mediatype',
65
+ 'lending',
66
+ 'year',
67
+ 'subject',
68
+ 'collection',
69
+ 'creator',
70
+ 'language',
71
+ ];
72
+ export const facetTitles = {
73
+ subject: 'Subject',
74
+ lending: 'Availability',
75
+ mediatype: 'Media Type',
76
+ language: 'Language',
77
+ creator: 'Creator',
78
+ collection: 'Collection',
79
+ year: 'Year',
80
+ };
81
+ /**
82
+ * Maps valid lending keys to whether they should be visible in the facet sidebar
83
+ */
84
+ export const lendingFacetKeysVisibility = {
85
+ is_lendable: true,
86
+ is_borrowable: false,
87
+ available_to_borrow: true,
88
+ is_browsable: false,
89
+ available_to_browse: false,
90
+ is_readable: true,
91
+ available_to_waitlist: false,
92
+ };
93
+ /**
94
+ * Maps valid, visible lending keys to their facet sidebar display text
95
+ */
96
+ export const lendingFacetDisplayNames = {
97
+ is_lendable: 'Lending Library',
98
+ available_to_borrow: 'Borrow 14 Days',
99
+ is_readable: 'Always Available',
100
+ };
101
+ /**
102
+ * A record of which admin-only collections should be suppressed from being displayed
103
+ * as facets or in an item's list of collections.
104
+ */
105
+ export const suppressedCollections = {
106
+ deemphasize: true,
107
+ community: true,
108
+ stream_only: true,
109
+ samples_only: true,
110
+ test_collection: true,
111
+ printdisabled: true,
112
+ 'openlibrary-ol': true,
113
+ nationalemergencylibrary: true,
114
+ china: true,
115
+ americana: true,
116
+ toronto: true,
117
+ };
118
118
  //# sourceMappingURL=models.js.map