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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (231) hide show
  1. package/.editorconfig +29 -29
  2. package/.github/workflows/ci.yml +26 -26
  3. package/.github/workflows/gh-pages-main.yml +39 -39
  4. package/.github/workflows/npm-publish.yml +39 -39
  5. package/.github/workflows/pr-preview.yml +38 -38
  6. package/.husky/pre-commit +4 -4
  7. package/LICENSE +661 -661
  8. package/README.md +83 -83
  9. package/dist/index.d.ts +9 -9
  10. package/dist/index.js +9 -9
  11. package/dist/src/app-root.d.ts +50 -50
  12. package/dist/src/app-root.js +278 -278
  13. package/dist/src/assets/img/icons/arrow-left.d.ts +2 -2
  14. package/dist/src/assets/img/icons/arrow-left.js +2 -2
  15. package/dist/src/assets/img/icons/arrow-right.d.ts +2 -2
  16. package/dist/src/assets/img/icons/arrow-right.js +2 -2
  17. package/dist/src/assets/img/icons/chevron.d.ts +2 -2
  18. package/dist/src/assets/img/icons/chevron.js +2 -2
  19. package/dist/src/assets/img/icons/empty-query.d.ts +2 -2
  20. package/dist/src/assets/img/icons/empty-query.js +2 -2
  21. package/dist/src/assets/img/icons/eye-closed.d.ts +2 -2
  22. package/dist/src/assets/img/icons/eye-closed.js +2 -2
  23. package/dist/src/assets/img/icons/eye.d.ts +2 -2
  24. package/dist/src/assets/img/icons/eye.js +2 -2
  25. package/dist/src/assets/img/icons/favorite-filled.d.ts +1 -1
  26. package/dist/src/assets/img/icons/favorite-filled.js +2 -2
  27. package/dist/src/assets/img/icons/login-required.d.ts +1 -1
  28. package/dist/src/assets/img/icons/login-required.js +2 -2
  29. package/dist/src/assets/img/icons/mediatype/account.d.ts +1 -1
  30. package/dist/src/assets/img/icons/mediatype/account.js +2 -2
  31. package/dist/src/assets/img/icons/mediatype/audio.d.ts +1 -1
  32. package/dist/src/assets/img/icons/mediatype/audio.js +2 -2
  33. package/dist/src/assets/img/icons/mediatype/collection.d.ts +1 -1
  34. package/dist/src/assets/img/icons/mediatype/collection.js +2 -2
  35. package/dist/src/assets/img/icons/mediatype/data.d.ts +1 -1
  36. package/dist/src/assets/img/icons/mediatype/data.js +2 -2
  37. package/dist/src/assets/img/icons/mediatype/etree.d.ts +1 -1
  38. package/dist/src/assets/img/icons/mediatype/etree.js +2 -2
  39. package/dist/src/assets/img/icons/mediatype/film.d.ts +1 -1
  40. package/dist/src/assets/img/icons/mediatype/film.js +2 -2
  41. package/dist/src/assets/img/icons/mediatype/images.d.ts +1 -1
  42. package/dist/src/assets/img/icons/mediatype/images.js +2 -2
  43. package/dist/src/assets/img/icons/mediatype/radio.d.ts +1 -1
  44. package/dist/src/assets/img/icons/mediatype/radio.js +2 -2
  45. package/dist/src/assets/img/icons/mediatype/software.d.ts +1 -1
  46. package/dist/src/assets/img/icons/mediatype/software.js +2 -2
  47. package/dist/src/assets/img/icons/mediatype/texts.d.ts +1 -1
  48. package/dist/src/assets/img/icons/mediatype/texts.js +2 -2
  49. package/dist/src/assets/img/icons/mediatype/tv.d.ts +1 -1
  50. package/dist/src/assets/img/icons/mediatype/tv.js +2 -2
  51. package/dist/src/assets/img/icons/mediatype/video.d.ts +1 -1
  52. package/dist/src/assets/img/icons/mediatype/video.js +2 -2
  53. package/dist/src/assets/img/icons/mediatype/web.d.ts +1 -1
  54. package/dist/src/assets/img/icons/mediatype/web.js +2 -2
  55. package/dist/src/assets/img/icons/null-result.d.ts +2 -2
  56. package/dist/src/assets/img/icons/null-result.js +2 -2
  57. package/dist/src/assets/img/icons/restricted.d.ts +1 -1
  58. package/dist/src/assets/img/icons/restricted.js +2 -2
  59. package/dist/src/assets/img/icons/reviews.d.ts +1 -1
  60. package/dist/src/assets/img/icons/reviews.js +2 -2
  61. package/dist/src/assets/img/icons/upload.d.ts +1 -1
  62. package/dist/src/assets/img/icons/upload.js +2 -2
  63. package/dist/src/assets/img/icons/views.d.ts +1 -1
  64. package/dist/src/assets/img/icons/views.js +2 -2
  65. package/dist/src/circular-activity-indicator.d.ts +5 -5
  66. package/dist/src/circular-activity-indicator.js +17 -17
  67. package/dist/src/collection-browser.d.ts +277 -277
  68. package/dist/src/collection-browser.js +1195 -1194
  69. package/dist/src/collection-browser.js.map +1 -1
  70. package/dist/src/collection-facets/facet-tombstone-row.d.ts +5 -5
  71. package/dist/src/collection-facets/facet-tombstone-row.js +15 -15
  72. package/dist/src/collection-facets/facets-template.d.ts +16 -16
  73. package/dist/src/collection-facets/facets-template.js +125 -125
  74. package/dist/src/collection-facets/more-facets-content.d.ts +77 -77
  75. package/dist/src/collection-facets/more-facets-content.js +376 -365
  76. package/dist/src/collection-facets/more-facets-content.js.map +1 -1
  77. package/dist/src/collection-facets/more-facets-pagination.d.ts +36 -36
  78. package/dist/src/collection-facets/more-facets-pagination.js +192 -192
  79. package/dist/src/collection-facets.d.ts +77 -78
  80. package/dist/src/collection-facets.js +383 -400
  81. package/dist/src/collection-facets.js.map +1 -1
  82. package/dist/src/empty-placeholder.d.ts +11 -11
  83. package/dist/src/empty-placeholder.js +42 -42
  84. package/dist/src/language-code-handler/language-code-handler.d.ts +37 -37
  85. package/dist/src/language-code-handler/language-code-handler.js +26 -26
  86. package/dist/src/language-code-handler/language-code-mapping.d.ts +1 -1
  87. package/dist/src/language-code-handler/language-code-mapping.js +562 -562
  88. package/dist/src/mediatype/mediatype-config.d.ts +3 -3
  89. package/dist/src/mediatype/mediatype-config.js +85 -85
  90. package/dist/src/models.d.ts +114 -114
  91. package/dist/src/models.js +125 -125
  92. package/dist/src/restoration-state-handler.d.ts +45 -45
  93. package/dist/src/restoration-state-handler.js +230 -230
  94. package/dist/src/sort-filter-bar/alpha-bar.d.ts +12 -12
  95. package/dist/src/sort-filter-bar/alpha-bar.js +52 -52
  96. package/dist/src/sort-filter-bar/img/compact.d.ts +1 -1
  97. package/dist/src/sort-filter-bar/img/compact.js +2 -2
  98. package/dist/src/sort-filter-bar/img/list.d.ts +1 -1
  99. package/dist/src/sort-filter-bar/img/list.js +2 -2
  100. package/dist/src/sort-filter-bar/img/sort-triangle.d.ts +1 -1
  101. package/dist/src/sort-filter-bar/img/sort-triangle.js +2 -2
  102. package/dist/src/sort-filter-bar/img/tile.d.ts +1 -1
  103. package/dist/src/sort-filter-bar/img/tile.js +2 -2
  104. package/dist/src/sort-filter-bar/sort-filter-bar.d.ts +108 -108
  105. package/dist/src/sort-filter-bar/sort-filter-bar.js +438 -438
  106. package/dist/src/styles/item-image-styles.d.ts +8 -8
  107. package/dist/src/styles/item-image-styles.js +9 -9
  108. package/dist/src/tiles/collection-browser-loading-tile.d.ts +5 -5
  109. package/dist/src/tiles/collection-browser-loading-tile.js +15 -15
  110. package/dist/src/tiles/grid/account-tile.d.ts +17 -17
  111. package/dist/src/tiles/grid/account-tile.js +46 -46
  112. package/dist/src/tiles/grid/collection-tile.d.ts +14 -14
  113. package/dist/src/tiles/grid/collection-tile.js +53 -53
  114. package/dist/src/tiles/grid/item-tile.d.ts +29 -29
  115. package/dist/src/tiles/grid/item-tile.js +108 -108
  116. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.d.ts +1 -1
  117. package/dist/src/tiles/grid/styles/tile-grid-shared-styles.js +7 -7
  118. package/dist/src/tiles/grid/tile-stats.d.ts +10 -10
  119. package/dist/src/tiles/grid/tile-stats.js +40 -40
  120. package/dist/src/tiles/hover/hover-pane-controller.d.ts +197 -197
  121. package/dist/src/tiles/hover/hover-pane-controller.js +331 -331
  122. package/dist/src/tiles/hover/tile-hover-pane.d.ts +15 -15
  123. package/dist/src/tiles/hover/tile-hover-pane.js +38 -38
  124. package/dist/src/tiles/image-block.d.ts +17 -17
  125. package/dist/src/tiles/image-block.js +72 -72
  126. package/dist/src/tiles/item-image.d.ts +35 -35
  127. package/dist/src/tiles/item-image.js +117 -117
  128. package/dist/src/tiles/list/account-label.d.ts +1 -1
  129. package/dist/src/tiles/list/account-label.js +6 -6
  130. package/dist/src/tiles/list/date-label.d.ts +1 -1
  131. package/dist/src/tiles/list/date-label.js +12 -12
  132. package/dist/src/tiles/list/tile-list-compact-header.d.ts +12 -12
  133. package/dist/src/tiles/list/tile-list-compact-header.js +41 -41
  134. package/dist/src/tiles/list/tile-list-compact.d.ts +21 -21
  135. package/dist/src/tiles/list/tile-list-compact.js +99 -99
  136. package/dist/src/tiles/list/tile-list.d.ts +55 -55
  137. package/dist/src/tiles/list/tile-list.js +297 -296
  138. package/dist/src/tiles/list/tile-list.js.map +1 -1
  139. package/dist/src/tiles/mediatype-icon.d.ts +9 -9
  140. package/dist/src/tiles/mediatype-icon.js +47 -47
  141. package/dist/src/tiles/overlay/icon-overlay.d.ts +10 -10
  142. package/dist/src/tiles/overlay/icon-overlay.js +40 -40
  143. package/dist/src/tiles/overlay/icon-text-overlay.d.ts +9 -9
  144. package/dist/src/tiles/overlay/icon-text-overlay.js +38 -38
  145. package/dist/src/tiles/overlay/text-overlay.d.ts +10 -10
  146. package/dist/src/tiles/overlay/text-overlay.js +42 -42
  147. package/dist/src/tiles/text-snippet-block.d.ts +27 -27
  148. package/dist/src/tiles/text-snippet-block.js +73 -73
  149. package/dist/src/tiles/tile-dispatcher.d.ts +55 -55
  150. package/dist/src/tiles/tile-dispatcher.js +176 -176
  151. package/dist/src/utils/analytics-events.d.ts +22 -22
  152. package/dist/src/utils/analytics-events.js +24 -24
  153. package/dist/src/utils/format-count.d.ts +7 -7
  154. package/dist/src/utils/format-count.js +76 -76
  155. package/dist/src/utils/format-date.d.ts +2 -2
  156. package/dist/src/utils/format-date.js +23 -23
  157. package/dist/src/utils/format-unit-size.d.ts +2 -2
  158. package/dist/src/utils/format-unit-size.js +33 -33
  159. package/dist/test/collection-browser.test.d.ts +1 -1
  160. package/dist/test/collection-browser.test.js +584 -584
  161. package/dist/test/collection-facets/facets-template.test.d.ts +1 -1
  162. package/dist/test/collection-facets/facets-template.test.js +62 -62
  163. package/dist/test/collection-facets/more-facets-content.test.d.ts +1 -1
  164. package/dist/test/collection-facets/more-facets-content.test.js +114 -114
  165. package/dist/test/collection-facets/more-facets-pagination.test.d.ts +1 -1
  166. package/dist/test/collection-facets/more-facets-pagination.test.js +117 -117
  167. package/dist/test/collection-facets.test.d.ts +2 -2
  168. package/dist/test/collection-facets.test.js +508 -544
  169. package/dist/test/collection-facets.test.js.map +1 -1
  170. package/dist/test/empty-placeholder.test.d.ts +1 -1
  171. package/dist/test/empty-placeholder.test.js +33 -33
  172. package/dist/test/icon-overlay.test.d.ts +1 -1
  173. package/dist/test/icon-overlay.test.js +24 -24
  174. package/dist/test/image-block.test.d.ts +1 -1
  175. package/dist/test/image-block.test.js +48 -48
  176. package/dist/test/item-image.test.d.ts +1 -1
  177. package/dist/test/item-image.test.js +84 -84
  178. package/dist/test/mediatype-config.test.d.ts +1 -1
  179. package/dist/test/mediatype-config.test.js +16 -16
  180. package/dist/test/mocks/mock-analytics-handler.d.ts +10 -10
  181. package/dist/test/mocks/mock-analytics-handler.js +15 -15
  182. package/dist/test/mocks/mock-collection-name-cache.d.ts +7 -7
  183. package/dist/test/mocks/mock-collection-name-cache.js +13 -13
  184. package/dist/test/mocks/mock-search-responses.d.ts +12 -12
  185. package/dist/test/mocks/mock-search-responses.js +341 -341
  186. package/dist/test/mocks/mock-search-service.d.ts +13 -13
  187. package/dist/test/mocks/mock-search-service.js +40 -40
  188. package/dist/test/restoration-state-handler.test.d.ts +1 -1
  189. package/dist/test/restoration-state-handler.test.js +125 -125
  190. package/dist/test/sort-filter-bar/alpha-bar.test.d.ts +1 -1
  191. package/dist/test/sort-filter-bar/alpha-bar.test.js +43 -43
  192. package/dist/test/sort-filter-bar/sort-filter-bar.test.d.ts +1 -1
  193. package/dist/test/sort-filter-bar/sort-filter-bar.test.js +197 -197
  194. package/dist/test/text-overlay.test.d.ts +1 -1
  195. package/dist/test/text-overlay.test.js +48 -48
  196. package/dist/test/text-snippet-block.test.d.ts +1 -1
  197. package/dist/test/text-snippet-block.test.js +57 -57
  198. package/dist/test/tile-stats.test.d.ts +1 -1
  199. package/dist/test/tile-stats.test.js +33 -33
  200. package/dist/test/tiles/grid/account-tile.test.d.ts +1 -1
  201. package/dist/test/tiles/grid/account-tile.test.js +60 -60
  202. package/dist/test/tiles/grid/collection-tile.test.d.ts +1 -1
  203. package/dist/test/tiles/grid/collection-tile.test.js +57 -57
  204. package/dist/test/tiles/grid/item-tile.test.d.ts +1 -1
  205. package/dist/test/tiles/grid/item-tile.test.js +142 -142
  206. package/dist/test/tiles/hover/hover-pane-controller.test.d.ts +1 -1
  207. package/dist/test/tiles/hover/hover-pane-controller.test.js +257 -257
  208. package/dist/test/tiles/hover/tile-hover-pane.test.d.ts +1 -1
  209. package/dist/test/tiles/hover/tile-hover-pane.test.js +13 -13
  210. package/dist/test/tiles/list/tile-list-compact.test.d.ts +1 -1
  211. package/dist/test/tiles/list/tile-list-compact.test.js +92 -92
  212. package/dist/test/tiles/list/tile-list.test.d.ts +1 -1
  213. package/dist/test/tiles/list/tile-list.test.js +153 -153
  214. package/dist/test/utils/format-count.test.d.ts +1 -1
  215. package/dist/test/utils/format-count.test.js +23 -23
  216. package/dist/test/utils/format-date.test.d.ts +1 -1
  217. package/dist/test/utils/format-date.test.js +17 -17
  218. package/dist/test/utils/format-unit-size.test.d.ts +1 -1
  219. package/dist/test/utils/format-unit-size.test.js +17 -17
  220. package/local.archive.org.cert +86 -86
  221. package/local.archive.org.key +27 -27
  222. package/package.json +1 -1
  223. package/renovate.json +6 -6
  224. package/src/collection-browser.ts +1 -0
  225. package/src/collection-facets/more-facets-content.ts +24 -16
  226. package/src/collection-facets.ts +0 -20
  227. package/src/tiles/list/tile-list.ts +3 -1
  228. package/test/collection-facets.test.ts +0 -46
  229. package/tsconfig.json +21 -21
  230. package/web-dev-server.config.mjs +30 -30
  231. package/web-test-runner.config.mjs +41 -41
@@ -1,45 +1,45 @@
1
- import { SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
2
- import { CollectionBrowserContext, CollectionDisplayMode, SelectedFacets, SortField } from './models';
3
- export interface RestorationState {
4
- displayMode?: CollectionDisplayMode;
5
- searchType?: SearchType;
6
- sortParam?: SortParam;
7
- selectedSort?: SortField;
8
- sortDirection?: SortDirection;
9
- selectedFacets: SelectedFacets;
10
- baseQuery?: string;
11
- currentPage?: number;
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
- /**
39
- * Sets the facet state for the given field & value to the given state,
40
- * creating any previously-undefined buckets as needed.
41
- */
42
- private setSelectedFacetState;
43
- /** Returns a default bucket with the given key, count of 0, and state 'none'. */
44
- private getDefaultBucket;
45
- }
1
+ import { SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
2
+ import { CollectionBrowserContext, CollectionDisplayMode, SelectedFacets, SortField } from './models';
3
+ export interface RestorationState {
4
+ displayMode?: CollectionDisplayMode;
5
+ searchType?: SearchType;
6
+ sortParam?: SortParam;
7
+ selectedSort?: SortField;
8
+ sortDirection?: SortDirection;
9
+ selectedFacets: SelectedFacets;
10
+ baseQuery?: string;
11
+ currentPage?: number;
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
+ /**
39
+ * Sets the facet state for the given field & value to the given state,
40
+ * creating any previously-undefined buckets as needed.
41
+ */
42
+ private setSelectedFacetState;
43
+ /** Returns a default bucket with the given key, count of 0, and state 'none'. */
44
+ private getDefaultBucket;
45
+ }
@@ -1,231 +1,231 @@
1
- import { SearchType, } from '@internetarchive/search-service';
2
- import { getCookie, setCookie } from 'typescript-cookie';
3
- import { MetadataFieldToSortField, } from './models';
4
- export class RestorationStateHandler {
5
- constructor(options) {
6
- this.cookieDomain = '.archive.org';
7
- this.cookieExpiration = 30;
8
- this.cookiePath = '/';
9
- this.context = options.context;
10
- }
11
- persistState(state) {
12
- if (state.displayMode)
13
- this.persistViewStateToCookies(state.displayMode);
14
- this.persistQueryStateToUrl(state);
15
- }
16
- getRestorationState() {
17
- const restorationState = this.loadQueryStateFromUrl();
18
- const displayMode = this.loadTileViewStateFromCookies();
19
- restorationState.displayMode = displayMode;
20
- return restorationState;
21
- }
22
- persistViewStateToCookies(displayMode) {
23
- const gridState = displayMode === 'grid' ? 'tiles' : 'lists';
24
- setCookie(`view-${this.context}`, gridState, {
25
- domain: this.cookieDomain,
26
- expires: this.cookieExpiration,
27
- path: this.cookiePath,
28
- });
29
- const detailsState = displayMode === 'list-detail' ? 'showdetails' : '';
30
- setCookie(`showdetails-${this.context}`, detailsState, {
31
- domain: this.cookieDomain,
32
- expires: this.cookieExpiration,
33
- path: this.cookiePath,
34
- });
35
- }
36
- loadTileViewStateFromCookies() {
37
- const viewState = getCookie(`view-${this.context}`);
38
- const detailsState = getCookie(`showdetails-${this.context}`);
39
- if (viewState === 'tiles' || viewState === undefined)
40
- return 'grid';
41
- if (detailsState === 'showdetails')
42
- return 'list-detail';
43
- return 'list-compact';
44
- }
45
- persistQueryStateToUrl(state) {
46
- const url = new URL(window.location.href);
47
- const { searchParams } = url;
48
- searchParams.delete('sin');
49
- searchParams.delete('sort');
50
- searchParams.delete('query');
51
- searchParams.delete('page');
52
- searchParams.delete('and[]');
53
- searchParams.delete('not[]');
54
- if (state.searchType) {
55
- searchParams.set('sin', state.searchType === SearchType.FULLTEXT ? 'TXT' : '');
56
- }
57
- if (state.sortParam) {
58
- const prefix = state.sortParam.direction === 'desc' ? '-' : '';
59
- searchParams.set('sort', `${prefix}${state.sortParam.field}`);
60
- }
61
- if (state.baseQuery) {
62
- searchParams.set('query', state.baseQuery);
63
- }
64
- if (state.currentPage) {
65
- if (state.currentPage > 1) {
66
- searchParams.set('page', state.currentPage.toString());
67
- }
68
- else {
69
- searchParams.delete('page');
70
- }
71
- }
72
- if (state.selectedFacets) {
73
- for (const [facetName, facetValues] of Object.entries(state.selectedFacets)) {
74
- const facetEntries = Object.entries(facetValues);
75
- // eslint-disable-next-line no-continue
76
- if (facetEntries.length === 0)
77
- continue;
78
- for (const [key, data] of facetEntries) {
79
- const notValue = data.state === 'hidden';
80
- const paramValue = `${facetName}:"${key}"`;
81
- if (notValue) {
82
- searchParams.append('not[]', paramValue);
83
- }
84
- else {
85
- searchParams.append('and[]', paramValue);
86
- }
87
- }
88
- }
89
- }
90
- if (state.minSelectedDate && state.maxSelectedDate) {
91
- searchParams.append('and[]', `year:[${state.minSelectedDate} TO ${state.maxSelectedDate}]`);
92
- }
93
- if (state.titleQuery) {
94
- searchParams.append('and[]', state.titleQuery);
95
- }
96
- if (state.creatorQuery) {
97
- searchParams.append('and[]', state.creatorQuery);
98
- }
99
- window.history.pushState({
100
- sort: state.sortParam,
101
- query: state.baseQuery,
102
- page: state.currentPage,
103
- and: state.selectedFacets,
104
- not: state.selectedFacets,
105
- minDate: state.minSelectedDate,
106
- maxDate: state.maxSelectedDate,
107
- }, '', url);
108
- }
109
- loadQueryStateFromUrl() {
110
- const url = new URL(window.location.href);
111
- const searchInside = url.searchParams.get('sin');
112
- const pageNumber = url.searchParams.get('page');
113
- const searchQuery = url.searchParams.get('query');
114
- const sortQuery = url.searchParams.get('sort');
115
- const facetAnds = url.searchParams.getAll('and[]');
116
- const facetNots = url.searchParams.getAll('not[]');
117
- const restorationState = {
118
- selectedFacets: {
119
- subject: {},
120
- lending: {},
121
- creator: {},
122
- mediatype: {},
123
- language: {},
124
- collection: {},
125
- year: {},
126
- },
127
- };
128
- if (searchInside) {
129
- restorationState.searchType =
130
- searchInside === 'TXT' ? SearchType.FULLTEXT : SearchType.METADATA;
131
- }
132
- if (pageNumber) {
133
- const parsed = parseInt(pageNumber, 10);
134
- restorationState.currentPage = parsed;
135
- }
136
- else {
137
- restorationState.currentPage = 1;
138
- }
139
- if (searchQuery) {
140
- restorationState.baseQuery = searchQuery;
141
- }
142
- if (sortQuery) {
143
- // check for two different sort formats: `date desc` and `-date`
144
- const hasSpace = sortQuery.indexOf(' ') > -1;
145
- if (hasSpace) {
146
- const [field, direction] = sortQuery.split(' ');
147
- const metadataField = MetadataFieldToSortField[field];
148
- if (metadataField) {
149
- restorationState.selectedSort = metadataField;
150
- }
151
- if (direction === 'desc' || direction === 'asc') {
152
- restorationState.sortDirection = direction;
153
- }
154
- }
155
- else {
156
- const sortDirection = sortQuery.startsWith('-') ? 'desc' : 'asc';
157
- const sortField = sortQuery.startsWith('-')
158
- ? sortQuery.slice(1)
159
- : sortQuery;
160
- const metadataField = MetadataFieldToSortField[sortField];
161
- if (metadataField)
162
- restorationState.selectedSort = metadataField;
163
- restorationState.sortDirection = sortDirection;
164
- }
165
- }
166
- if (facetAnds) {
167
- facetAnds.forEach(and => {
168
- const [field, value] = and.split(':');
169
- switch (field) {
170
- case 'year': {
171
- const [minDate, maxDate] = value.split(' TO ');
172
- // we have two potential ways of filtering by date:
173
- // the range with "date TO date" or the single date with "date"
174
- // this is checking for the range case and if we don't have those, fall
175
- // back to the single date case
176
- if (minDate && maxDate) {
177
- restorationState.minSelectedDate = minDate.substring(1, minDate.length);
178
- restorationState.maxSelectedDate = maxDate.substring(0, maxDate.length - 1);
179
- }
180
- else {
181
- this.setSelectedFacetState(restorationState.selectedFacets, field, value, 'selected');
182
- }
183
- break;
184
- }
185
- case 'firstTitle':
186
- restorationState.selectedTitleFilter = value;
187
- break;
188
- case 'firstCreator':
189
- restorationState.selectedCreatorFilter = value;
190
- break;
191
- default:
192
- this.setSelectedFacetState(restorationState.selectedFacets, field, value, 'selected');
193
- }
194
- });
195
- }
196
- if (facetNots) {
197
- facetNots.forEach(not => {
198
- const [field, value] = not.split(':');
199
- this.setSelectedFacetState(restorationState.selectedFacets, field, value, 'hidden');
200
- });
201
- }
202
- return restorationState;
203
- }
204
- // remove optional opening and closing quotes from a string
205
- stripQuotes(value) {
206
- if (value.startsWith('"') && value.endsWith('"')) {
207
- return value.substring(1, value.length - 1);
208
- }
209
- return value;
210
- }
211
- /**
212
- * Sets the facet state for the given field & value to the given state,
213
- * creating any previously-undefined buckets as needed.
214
- */
215
- setSelectedFacetState(selectedFacets, field, value, state) {
216
- var _a;
217
- const facet = selectedFacets[field];
218
- const unQuotedValue = this.stripQuotes(value);
219
- (_a = facet[unQuotedValue]) !== null && _a !== void 0 ? _a : (facet[unQuotedValue] = this.getDefaultBucket(value));
220
- facet[unQuotedValue].state = state;
221
- }
222
- /** Returns a default bucket with the given key, count of 0, and state 'none'. */
223
- getDefaultBucket(key) {
224
- return {
225
- key,
226
- count: 0,
227
- state: 'none',
228
- };
229
- }
230
- }
1
+ import { SearchType, } from '@internetarchive/search-service';
2
+ import { getCookie, setCookie } from 'typescript-cookie';
3
+ import { MetadataFieldToSortField, } from './models';
4
+ export class RestorationStateHandler {
5
+ constructor(options) {
6
+ this.cookieDomain = '.archive.org';
7
+ this.cookieExpiration = 30;
8
+ this.cookiePath = '/';
9
+ this.context = options.context;
10
+ }
11
+ persistState(state) {
12
+ if (state.displayMode)
13
+ this.persistViewStateToCookies(state.displayMode);
14
+ this.persistQueryStateToUrl(state);
15
+ }
16
+ getRestorationState() {
17
+ const restorationState = this.loadQueryStateFromUrl();
18
+ const displayMode = this.loadTileViewStateFromCookies();
19
+ restorationState.displayMode = displayMode;
20
+ return restorationState;
21
+ }
22
+ persistViewStateToCookies(displayMode) {
23
+ const gridState = displayMode === 'grid' ? 'tiles' : 'lists';
24
+ setCookie(`view-${this.context}`, gridState, {
25
+ domain: this.cookieDomain,
26
+ expires: this.cookieExpiration,
27
+ path: this.cookiePath,
28
+ });
29
+ const detailsState = displayMode === 'list-detail' ? 'showdetails' : '';
30
+ setCookie(`showdetails-${this.context}`, detailsState, {
31
+ domain: this.cookieDomain,
32
+ expires: this.cookieExpiration,
33
+ path: this.cookiePath,
34
+ });
35
+ }
36
+ loadTileViewStateFromCookies() {
37
+ const viewState = getCookie(`view-${this.context}`);
38
+ const detailsState = getCookie(`showdetails-${this.context}`);
39
+ if (viewState === 'tiles' || viewState === undefined)
40
+ return 'grid';
41
+ if (detailsState === 'showdetails')
42
+ return 'list-detail';
43
+ return 'list-compact';
44
+ }
45
+ persistQueryStateToUrl(state) {
46
+ const url = new URL(window.location.href);
47
+ const { searchParams } = url;
48
+ searchParams.delete('sin');
49
+ searchParams.delete('sort');
50
+ searchParams.delete('query');
51
+ searchParams.delete('page');
52
+ searchParams.delete('and[]');
53
+ searchParams.delete('not[]');
54
+ if (state.searchType) {
55
+ searchParams.set('sin', state.searchType === SearchType.FULLTEXT ? 'TXT' : '');
56
+ }
57
+ if (state.sortParam) {
58
+ const prefix = state.sortParam.direction === 'desc' ? '-' : '';
59
+ searchParams.set('sort', `${prefix}${state.sortParam.field}`);
60
+ }
61
+ if (state.baseQuery) {
62
+ searchParams.set('query', state.baseQuery);
63
+ }
64
+ if (state.currentPage) {
65
+ if (state.currentPage > 1) {
66
+ searchParams.set('page', state.currentPage.toString());
67
+ }
68
+ else {
69
+ searchParams.delete('page');
70
+ }
71
+ }
72
+ if (state.selectedFacets) {
73
+ for (const [facetName, facetValues] of Object.entries(state.selectedFacets)) {
74
+ const facetEntries = Object.entries(facetValues);
75
+ // eslint-disable-next-line no-continue
76
+ if (facetEntries.length === 0)
77
+ continue;
78
+ for (const [key, data] of facetEntries) {
79
+ const notValue = data.state === 'hidden';
80
+ const paramValue = `${facetName}:"${key}"`;
81
+ if (notValue) {
82
+ searchParams.append('not[]', paramValue);
83
+ }
84
+ else {
85
+ searchParams.append('and[]', paramValue);
86
+ }
87
+ }
88
+ }
89
+ }
90
+ if (state.minSelectedDate && state.maxSelectedDate) {
91
+ searchParams.append('and[]', `year:[${state.minSelectedDate} TO ${state.maxSelectedDate}]`);
92
+ }
93
+ if (state.titleQuery) {
94
+ searchParams.append('and[]', state.titleQuery);
95
+ }
96
+ if (state.creatorQuery) {
97
+ searchParams.append('and[]', state.creatorQuery);
98
+ }
99
+ window.history.pushState({
100
+ sort: state.sortParam,
101
+ query: state.baseQuery,
102
+ page: state.currentPage,
103
+ and: state.selectedFacets,
104
+ not: state.selectedFacets,
105
+ minDate: state.minSelectedDate,
106
+ maxDate: state.maxSelectedDate,
107
+ }, '', url);
108
+ }
109
+ loadQueryStateFromUrl() {
110
+ const url = new URL(window.location.href);
111
+ const searchInside = url.searchParams.get('sin');
112
+ const pageNumber = url.searchParams.get('page');
113
+ const searchQuery = url.searchParams.get('query');
114
+ const sortQuery = url.searchParams.get('sort');
115
+ const facetAnds = url.searchParams.getAll('and[]');
116
+ const facetNots = url.searchParams.getAll('not[]');
117
+ const restorationState = {
118
+ selectedFacets: {
119
+ subject: {},
120
+ lending: {},
121
+ creator: {},
122
+ mediatype: {},
123
+ language: {},
124
+ collection: {},
125
+ year: {},
126
+ },
127
+ };
128
+ if (searchInside) {
129
+ restorationState.searchType =
130
+ searchInside === 'TXT' ? SearchType.FULLTEXT : SearchType.METADATA;
131
+ }
132
+ if (pageNumber) {
133
+ const parsed = parseInt(pageNumber, 10);
134
+ restorationState.currentPage = parsed;
135
+ }
136
+ else {
137
+ restorationState.currentPage = 1;
138
+ }
139
+ if (searchQuery) {
140
+ restorationState.baseQuery = searchQuery;
141
+ }
142
+ if (sortQuery) {
143
+ // check for two different sort formats: `date desc` and `-date`
144
+ const hasSpace = sortQuery.indexOf(' ') > -1;
145
+ if (hasSpace) {
146
+ const [field, direction] = sortQuery.split(' ');
147
+ const metadataField = MetadataFieldToSortField[field];
148
+ if (metadataField) {
149
+ restorationState.selectedSort = metadataField;
150
+ }
151
+ if (direction === 'desc' || direction === 'asc') {
152
+ restorationState.sortDirection = direction;
153
+ }
154
+ }
155
+ else {
156
+ const sortDirection = sortQuery.startsWith('-') ? 'desc' : 'asc';
157
+ const sortField = sortQuery.startsWith('-')
158
+ ? sortQuery.slice(1)
159
+ : sortQuery;
160
+ const metadataField = MetadataFieldToSortField[sortField];
161
+ if (metadataField)
162
+ restorationState.selectedSort = metadataField;
163
+ restorationState.sortDirection = sortDirection;
164
+ }
165
+ }
166
+ if (facetAnds) {
167
+ facetAnds.forEach(and => {
168
+ const [field, value] = and.split(':');
169
+ switch (field) {
170
+ case 'year': {
171
+ const [minDate, maxDate] = value.split(' TO ');
172
+ // we have two potential ways of filtering by date:
173
+ // the range with "date TO date" or the single date with "date"
174
+ // this is checking for the range case and if we don't have those, fall
175
+ // back to the single date case
176
+ if (minDate && maxDate) {
177
+ restorationState.minSelectedDate = minDate.substring(1, minDate.length);
178
+ restorationState.maxSelectedDate = maxDate.substring(0, maxDate.length - 1);
179
+ }
180
+ else {
181
+ this.setSelectedFacetState(restorationState.selectedFacets, field, value, 'selected');
182
+ }
183
+ break;
184
+ }
185
+ case 'firstTitle':
186
+ restorationState.selectedTitleFilter = value;
187
+ break;
188
+ case 'firstCreator':
189
+ restorationState.selectedCreatorFilter = value;
190
+ break;
191
+ default:
192
+ this.setSelectedFacetState(restorationState.selectedFacets, field, value, 'selected');
193
+ }
194
+ });
195
+ }
196
+ if (facetNots) {
197
+ facetNots.forEach(not => {
198
+ const [field, value] = not.split(':');
199
+ this.setSelectedFacetState(restorationState.selectedFacets, field, value, 'hidden');
200
+ });
201
+ }
202
+ return restorationState;
203
+ }
204
+ // remove optional opening and closing quotes from a string
205
+ stripQuotes(value) {
206
+ if (value.startsWith('"') && value.endsWith('"')) {
207
+ return value.substring(1, value.length - 1);
208
+ }
209
+ return value;
210
+ }
211
+ /**
212
+ * Sets the facet state for the given field & value to the given state,
213
+ * creating any previously-undefined buckets as needed.
214
+ */
215
+ setSelectedFacetState(selectedFacets, field, value, state) {
216
+ var _a;
217
+ const facet = selectedFacets[field];
218
+ const unQuotedValue = this.stripQuotes(value);
219
+ (_a = facet[unQuotedValue]) !== null && _a !== void 0 ? _a : (facet[unQuotedValue] = this.getDefaultBucket(value));
220
+ facet[unQuotedValue].state = state;
221
+ }
222
+ /** Returns a default bucket with the given key, count of 0, and state 'none'. */
223
+ getDefaultBucket(key) {
224
+ return {
225
+ key,
226
+ count: 0,
227
+ state: 'none',
228
+ };
229
+ }
230
+ }
231
231
  //# sourceMappingURL=restoration-state-handler.js.map
@@ -1,12 +1,12 @@
1
- import { LitElement } from 'lit';
2
- import type { PrefixFilterCounts } from '../models';
3
- export declare class AlphaBar extends LitElement {
4
- selectedLetter: string | null;
5
- letterCounts?: PrefixFilterCounts;
6
- private get selectedUppercaseLetter();
7
- render(): import("lit-html").TemplateResult<1>;
8
- private letterLinkTemplate;
9
- private letterClicked;
10
- private readonly alphabet;
11
- static styles: import("lit").CSSResult;
12
- }
1
+ import { LitElement } from 'lit';
2
+ import type { PrefixFilterCounts } from '../models';
3
+ export declare class AlphaBar extends LitElement {
4
+ selectedLetter: string | null;
5
+ letterCounts?: PrefixFilterCounts;
6
+ private get selectedUppercaseLetter();
7
+ render(): import("lit-html").TemplateResult<1>;
8
+ private letterLinkTemplate;
9
+ private letterClicked;
10
+ private readonly alphabet;
11
+ static styles: import("lit").CSSResult;
12
+ }