@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,46 +1,46 @@
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
- dateRangeQueryClause?: string;
13
- titleQuery?: string;
14
- creatorQuery?: string;
15
- minSelectedDate?: string;
16
- maxSelectedDate?: string;
17
- selectedTitleFilter?: string;
18
- selectedCreatorFilter?: string;
19
- }
20
- export interface RestorationStateHandlerInterface {
21
- persistState(state: RestorationState): void;
22
- getRestorationState(): RestorationState;
23
- }
24
- export declare class RestorationStateHandler implements RestorationStateHandlerInterface {
25
- private context;
26
- private cookieDomain;
27
- private cookieExpiration;
28
- private cookiePath;
29
- constructor(options: {
30
- context: CollectionBrowserContext;
31
- });
32
- persistState(state: RestorationState): void;
33
- getRestorationState(): RestorationState;
34
- private persistViewStateToCookies;
35
- private loadTileViewStateFromCookies;
36
- private persistQueryStateToUrl;
37
- private loadQueryStateFromUrl;
38
- private stripQuotes;
39
- /**
40
- * Sets the facet state for the given field & value to the given state,
41
- * creating any previously-undefined buckets as needed.
42
- */
43
- private setSelectedFacetState;
44
- /** Returns a default bucket with the given key, count of 0, and state 'none'. */
45
- private getDefaultBucket;
46
- }
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
+ dateRangeQueryClause?: string;
13
+ titleQuery?: string;
14
+ creatorQuery?: string;
15
+ minSelectedDate?: string;
16
+ maxSelectedDate?: string;
17
+ selectedTitleFilter?: string;
18
+ selectedCreatorFilter?: string;
19
+ }
20
+ export interface RestorationStateHandlerInterface {
21
+ persistState(state: RestorationState): void;
22
+ getRestorationState(): RestorationState;
23
+ }
24
+ export declare class RestorationStateHandler implements RestorationStateHandlerInterface {
25
+ private context;
26
+ private cookieDomain;
27
+ private cookieExpiration;
28
+ private cookiePath;
29
+ constructor(options: {
30
+ context: CollectionBrowserContext;
31
+ });
32
+ persistState(state: RestorationState): void;
33
+ getRestorationState(): RestorationState;
34
+ private persistViewStateToCookies;
35
+ private loadTileViewStateFromCookies;
36
+ private persistQueryStateToUrl;
37
+ private loadQueryStateFromUrl;
38
+ private stripQuotes;
39
+ /**
40
+ * Sets the facet state for the given field & value to the given state,
41
+ * creating any previously-undefined buckets as needed.
42
+ */
43
+ private setSelectedFacetState;
44
+ /** Returns a default bucket with the given key, count of 0, and state 'none'. */
45
+ private getDefaultBucket;
46
+ }
@@ -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.dateRangeQueryClause) {
91
- searchParams.append('and[]', state.dateRangeQueryClause);
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
- dateRange: state.dateRangeQueryClause,
106
- }, '', url);
107
- }
108
- loadQueryStateFromUrl() {
109
- const url = new URL(window.location.href);
110
- const searchInside = url.searchParams.get('sin');
111
- const pageNumber = url.searchParams.get('page');
112
- const searchQuery = url.searchParams.get('query');
113
- const sortQuery = url.searchParams.get('sort');
114
- const facetAnds = url.searchParams.getAll('and[]');
115
- const facetNots = url.searchParams.getAll('not[]');
116
- const restorationState = {
117
- selectedFacets: {
118
- subject: {},
119
- lending: {},
120
- creator: {},
121
- mediatype: {},
122
- language: {},
123
- collection: {},
124
- year: {},
125
- },
126
- };
127
- if (searchInside) {
128
- restorationState.searchType =
129
- searchInside === 'TXT' ? SearchType.FULLTEXT : SearchType.METADATA;
130
- }
131
- if (pageNumber) {
132
- const parsed = parseInt(pageNumber, 10);
133
- restorationState.currentPage = parsed;
134
- }
135
- else {
136
- restorationState.currentPage = 1;
137
- }
138
- if (searchQuery) {
139
- restorationState.baseQuery = searchQuery;
140
- }
141
- if (sortQuery) {
142
- // check for two different sort formats: `date desc` and `-date`
143
- const hasSpace = sortQuery.indexOf(' ') > -1;
144
- if (hasSpace) {
145
- const [field, direction] = sortQuery.split(' ');
146
- const metadataField = MetadataFieldToSortField[field];
147
- if (metadataField) {
148
- restorationState.selectedSort = metadataField;
149
- }
150
- if (direction === 'desc' || direction === 'asc') {
151
- restorationState.sortDirection = direction;
152
- }
153
- }
154
- else {
155
- const sortDirection = sortQuery.startsWith('-') ? 'desc' : 'asc';
156
- const sortField = sortQuery.startsWith('-')
157
- ? sortQuery.slice(1)
158
- : sortQuery;
159
- const metadataField = MetadataFieldToSortField[sortField];
160
- if (metadataField)
161
- restorationState.selectedSort = metadataField;
162
- restorationState.sortDirection = sortDirection;
163
- }
164
- }
165
- if (facetAnds) {
166
- facetAnds.forEach(and => {
167
- const [field, value] = and.split(':');
168
- switch (field) {
169
- case 'year': {
170
- const [minDate, maxDate] = value.split(' TO ');
171
- // we have two potential ways of filtering by date:
172
- // the range with "date TO date" or the single date with "date"
173
- // this is checking for the range case and if we don't have those, fall
174
- // back to the single date case
175
- if (minDate && maxDate) {
176
- restorationState.minSelectedDate = minDate.substring(1, minDate.length);
177
- restorationState.maxSelectedDate = maxDate.substring(0, maxDate.length - 1);
178
- restorationState.dateRangeQueryClause = `year:${value}`;
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.dateRangeQueryClause) {
91
+ searchParams.append('and[]', state.dateRangeQueryClause);
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
+ dateRange: state.dateRangeQueryClause,
106
+ }, '', url);
107
+ }
108
+ loadQueryStateFromUrl() {
109
+ const url = new URL(window.location.href);
110
+ const searchInside = url.searchParams.get('sin');
111
+ const pageNumber = url.searchParams.get('page');
112
+ const searchQuery = url.searchParams.get('query');
113
+ const sortQuery = url.searchParams.get('sort');
114
+ const facetAnds = url.searchParams.getAll('and[]');
115
+ const facetNots = url.searchParams.getAll('not[]');
116
+ const restorationState = {
117
+ selectedFacets: {
118
+ subject: {},
119
+ lending: {},
120
+ creator: {},
121
+ mediatype: {},
122
+ language: {},
123
+ collection: {},
124
+ year: {},
125
+ },
126
+ };
127
+ if (searchInside) {
128
+ restorationState.searchType =
129
+ searchInside === 'TXT' ? SearchType.FULLTEXT : SearchType.METADATA;
130
+ }
131
+ if (pageNumber) {
132
+ const parsed = parseInt(pageNumber, 10);
133
+ restorationState.currentPage = parsed;
134
+ }
135
+ else {
136
+ restorationState.currentPage = 1;
137
+ }
138
+ if (searchQuery) {
139
+ restorationState.baseQuery = searchQuery;
140
+ }
141
+ if (sortQuery) {
142
+ // check for two different sort formats: `date desc` and `-date`
143
+ const hasSpace = sortQuery.indexOf(' ') > -1;
144
+ if (hasSpace) {
145
+ const [field, direction] = sortQuery.split(' ');
146
+ const metadataField = MetadataFieldToSortField[field];
147
+ if (metadataField) {
148
+ restorationState.selectedSort = metadataField;
149
+ }
150
+ if (direction === 'desc' || direction === 'asc') {
151
+ restorationState.sortDirection = direction;
152
+ }
153
+ }
154
+ else {
155
+ const sortDirection = sortQuery.startsWith('-') ? 'desc' : 'asc';
156
+ const sortField = sortQuery.startsWith('-')
157
+ ? sortQuery.slice(1)
158
+ : sortQuery;
159
+ const metadataField = MetadataFieldToSortField[sortField];
160
+ if (metadataField)
161
+ restorationState.selectedSort = metadataField;
162
+ restorationState.sortDirection = sortDirection;
163
+ }
164
+ }
165
+ if (facetAnds) {
166
+ facetAnds.forEach(and => {
167
+ const [field, value] = and.split(':');
168
+ switch (field) {
169
+ case 'year': {
170
+ const [minDate, maxDate] = value.split(' TO ');
171
+ // we have two potential ways of filtering by date:
172
+ // the range with "date TO date" or the single date with "date"
173
+ // this is checking for the range case and if we don't have those, fall
174
+ // back to the single date case
175
+ if (minDate && maxDate) {
176
+ restorationState.minSelectedDate = minDate.substring(1, minDate.length);
177
+ restorationState.maxSelectedDate = maxDate.substring(0, maxDate.length - 1);
178
+ restorationState.dateRangeQueryClause = `year:${value}`;
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,9 +1,9 @@
1
- import { LitElement } from 'lit';
2
- export declare class AlphaBar extends LitElement {
3
- selectedLetter: string | null;
4
- private get selectedUppercaseLetter();
5
- render(): import("lit-html").TemplateResult<1>;
6
- private letterClicked;
7
- private readonly alphabet;
8
- static styles: import("lit").CSSResult;
9
- }
1
+ import { LitElement } from 'lit';
2
+ export declare class AlphaBar extends LitElement {
3
+ selectedLetter: string | null;
4
+ private get selectedUppercaseLetter();
5
+ render(): import("lit-html").TemplateResult<1>;
6
+ private letterClicked;
7
+ private readonly alphabet;
8
+ static styles: import("lit").CSSResult;
9
+ }