@internetarchive/collection-browser 0.3.1-alpha.2 → 0.3.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 (214) 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 +43 -43
  12. package/dist/src/app-root.js +233 -233
  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 +236 -236
  68. package/dist/src/collection-browser.js +1406 -1402
  69. package/dist/src/collection-browser.js.map +1 -1
  70. package/dist/src/collection-facets/facets-template.d.ts +16 -16
  71. package/dist/src/collection-facets/facets-template.js +132 -130
  72. package/dist/src/collection-facets/facets-template.js.map +1 -1
  73. package/dist/src/collection-facets/more-facets-content.d.ts +74 -74
  74. package/dist/src/collection-facets/more-facets-content.js +350 -339
  75. package/dist/src/collection-facets/more-facets-content.js.map +1 -1
  76. package/dist/src/collection-facets/more-facets-pagination.d.ts +36 -36
  77. package/dist/src/collection-facets/more-facets-pagination.js +192 -192
  78. package/dist/src/collection-facets.d.ts +71 -71
  79. package/dist/src/collection-facets.js +496 -496
  80. package/dist/src/collection-facets.js.map +1 -1
  81. package/dist/src/empty-placeholder.d.ts +11 -11
  82. package/dist/src/empty-placeholder.js +42 -42
  83. package/dist/src/language-code-handler/language-code-handler.d.ts +37 -37
  84. package/dist/src/language-code-handler/language-code-handler.js +26 -26
  85. package/dist/src/language-code-handler/language-code-mapping.d.ts +1 -1
  86. package/dist/src/language-code-handler/language-code-mapping.js +562 -562
  87. package/dist/src/mediatype/mediatype-config.d.ts +3 -3
  88. package/dist/src/mediatype/mediatype-config.js +85 -85
  89. package/dist/src/models.d.ts +97 -97
  90. package/dist/src/models.js +100 -100
  91. package/dist/src/models.js.map +1 -1
  92. package/dist/src/restoration-state-handler.d.ts +45 -46
  93. package/dist/src/restoration-state-handler.js +220 -231
  94. package/dist/src/restoration-state-handler.js.map +1 -1
  95. package/dist/src/sort-filter-bar/alpha-bar.d.ts +9 -9
  96. package/dist/src/sort-filter-bar/alpha-bar.js +41 -41
  97. package/dist/src/sort-filter-bar/img/compact.d.ts +1 -1
  98. package/dist/src/sort-filter-bar/img/compact.js +2 -2
  99. package/dist/src/sort-filter-bar/img/list.d.ts +1 -1
  100. package/dist/src/sort-filter-bar/img/list.js +2 -2
  101. package/dist/src/sort-filter-bar/img/sort-triangle.d.ts +1 -1
  102. package/dist/src/sort-filter-bar/img/sort-triangle.js +2 -2
  103. package/dist/src/sort-filter-bar/img/tile.d.ts +1 -1
  104. package/dist/src/sort-filter-bar/img/tile.js +2 -2
  105. package/dist/src/sort-filter-bar/sort-filter-bar.d.ts +107 -107
  106. package/dist/src/sort-filter-bar/sort-filter-bar.js +423 -423
  107. package/dist/src/styles/item-image-styles.d.ts +8 -8
  108. package/dist/src/styles/item-image-styles.js +9 -9
  109. package/dist/src/tiles/collection-browser-loading-tile.d.ts +5 -5
  110. package/dist/src/tiles/collection-browser-loading-tile.js +15 -15
  111. package/dist/src/tiles/grid/account-tile.d.ts +8 -8
  112. package/dist/src/tiles/grid/account-tile.js +20 -20
  113. package/dist/src/tiles/grid/collection-tile.d.ts +7 -7
  114. package/dist/src/tiles/grid/collection-tile.js +23 -23
  115. package/dist/src/tiles/grid/item-tile.d.ts +24 -24
  116. package/dist/src/tiles/grid/item-tile.js +87 -87
  117. package/dist/src/tiles/grid/tile-stats.d.ts +10 -10
  118. package/dist/src/tiles/grid/tile-stats.js +35 -35
  119. package/dist/src/tiles/image-block.d.ts +17 -17
  120. package/dist/src/tiles/image-block.js +73 -73
  121. package/dist/src/tiles/item-image.d.ts +31 -31
  122. package/dist/src/tiles/item-image.js +103 -103
  123. package/dist/src/tiles/list/account-label.d.ts +1 -1
  124. package/dist/src/tiles/list/account-label.js +6 -6
  125. package/dist/src/tiles/list/date-label.d.ts +1 -1
  126. package/dist/src/tiles/list/date-label.js +12 -12
  127. package/dist/src/tiles/list/tile-list-compact-header.d.ts +12 -12
  128. package/dist/src/tiles/list/tile-list-compact-header.js +41 -41
  129. package/dist/src/tiles/list/tile-list-compact.d.ts +20 -20
  130. package/dist/src/tiles/list/tile-list-compact.js +87 -87
  131. package/dist/src/tiles/list/tile-list.d.ts +50 -50
  132. package/dist/src/tiles/list/tile-list.js +264 -263
  133. package/dist/src/tiles/list/tile-list.js.map +1 -1
  134. package/dist/src/tiles/mediatype-icon.d.ts +9 -9
  135. package/dist/src/tiles/mediatype-icon.js +47 -47
  136. package/dist/src/tiles/overlay/icon-overlay.d.ts +7 -7
  137. package/dist/src/tiles/overlay/icon-overlay.js +31 -31
  138. package/dist/src/tiles/overlay/text-overlay.d.ts +8 -8
  139. package/dist/src/tiles/overlay/text-overlay.js +31 -31
  140. package/dist/src/tiles/text-snippet-block.d.ts +29 -29
  141. package/dist/src/tiles/text-snippet-block.js +81 -81
  142. package/dist/src/tiles/tile-dispatcher.d.ts +36 -36
  143. package/dist/src/tiles/tile-dispatcher.js +128 -128
  144. package/dist/src/utils/analytics-events.d.ts +18 -18
  145. package/dist/src/utils/analytics-events.js +20 -20
  146. package/dist/src/utils/format-count.d.ts +7 -7
  147. package/dist/src/utils/format-count.js +76 -75
  148. package/dist/src/utils/format-count.js.map +1 -1
  149. package/dist/src/utils/format-date.d.ts +2 -2
  150. package/dist/src/utils/format-date.js +23 -23
  151. package/dist/test/collection-browser.test.d.ts +1 -1
  152. package/dist/test/collection-browser.test.js +344 -344
  153. package/dist/test/collection-browser.test.js.map +1 -1
  154. package/dist/test/collection-facets/facets-template.test.d.ts +1 -1
  155. package/dist/test/collection-facets/facets-template.test.js +62 -62
  156. package/dist/test/collection-facets/more-facets-content.test.d.ts +1 -1
  157. package/dist/test/collection-facets/more-facets-content.test.js +91 -91
  158. package/dist/test/collection-facets/more-facets-pagination.test.d.ts +1 -1
  159. package/dist/test/collection-facets/more-facets-pagination.test.js +117 -117
  160. package/dist/test/collection-facets.test.d.ts +2 -2
  161. package/dist/test/collection-facets.test.js +385 -182
  162. package/dist/test/collection-facets.test.js.map +1 -1
  163. package/dist/test/empty-placeholder.test.d.ts +1 -1
  164. package/dist/test/empty-placeholder.test.js +33 -33
  165. package/dist/test/icon-overlay.test.d.ts +1 -1
  166. package/dist/test/icon-overlay.test.js +24 -24
  167. package/dist/test/item-image.test.d.ts +1 -1
  168. package/dist/test/item-image.test.js +56 -56
  169. package/dist/test/mediatype-config.test.d.ts +1 -1
  170. package/dist/test/mediatype-config.test.js +16 -16
  171. package/dist/test/mocks/mock-analytics-handler.d.ts +10 -10
  172. package/dist/test/mocks/mock-analytics-handler.js +15 -15
  173. package/dist/test/mocks/mock-collection-name-cache.d.ts +7 -7
  174. package/dist/test/mocks/mock-collection-name-cache.js +13 -13
  175. package/dist/test/mocks/mock-search-responses.d.ts +5 -5
  176. package/dist/test/mocks/mock-search-responses.js +103 -103
  177. package/dist/test/mocks/mock-search-service.d.ts +13 -13
  178. package/dist/test/mocks/mock-search-service.js +25 -25
  179. package/dist/test/restoration-state-handler.test.d.ts +1 -1
  180. package/dist/test/restoration-state-handler.test.js +117 -117
  181. package/dist/test/sort-filter-bar/sort-filter-bar.test.d.ts +1 -1
  182. package/dist/test/sort-filter-bar/sort-filter-bar.test.js +113 -113
  183. package/dist/test/text-overlay.test.d.ts +1 -1
  184. package/dist/test/text-overlay.test.js +41 -41
  185. package/dist/test/text-snippet-block.test.d.ts +1 -1
  186. package/dist/test/text-snippet-block.test.js +57 -57
  187. package/dist/test/tile-stats.test.d.ts +1 -1
  188. package/dist/test/tile-stats.test.js +33 -33
  189. package/dist/test/tiles/grid/item-tile.test.d.ts +1 -1
  190. package/dist/test/tiles/grid/item-tile.test.js +107 -107
  191. package/dist/test/tiles/list/tile-list.test.d.ts +1 -1
  192. package/dist/test/tiles/list/tile-list.test.js +36 -36
  193. package/dist/test/utils/format-count.test.d.ts +1 -1
  194. package/dist/test/utils/format-count.test.js +23 -23
  195. package/dist/test/utils/format-date.test.d.ts +1 -1
  196. package/dist/test/utils/format-date.test.js +17 -17
  197. package/index.html +24 -24
  198. package/local.archive.org.cert +86 -86
  199. package/local.archive.org.key +27 -27
  200. package/package.json +115 -115
  201. package/renovate.json +6 -6
  202. package/src/collection-browser.ts +1530 -1526
  203. package/src/collection-facets/facets-template.ts +7 -5
  204. package/src/collection-facets/more-facets-content.ts +21 -10
  205. package/src/collection-facets.ts +569 -569
  206. package/src/models.ts +216 -216
  207. package/src/restoration-state-handler.ts +302 -314
  208. package/src/tiles/list/tile-list.ts +1 -0
  209. package/src/utils/format-count.ts +1 -0
  210. package/test/collection-browser.test.ts +490 -490
  211. package/test/collection-facets.test.ts +264 -1
  212. package/tsconfig.json +21 -21
  213. package/web-dev-server.config.mjs +30 -30
  214. package/web-test-runner.config.mjs +41 -41
@@ -1,104 +1,104 @@
1
- import { ItemHit, } from '@internetarchive/search-service';
2
- export const mockSuccessSingleResult = {
3
- success: {
4
- request: {
5
- clientParameters: {
6
- user_query: 'collection:foo',
7
- sort: [],
8
- },
9
- finalizedParameters: {
10
- user_query: 'collection:foo',
11
- sort: [],
12
- },
13
- },
14
- rawResponse: {},
15
- response: {
16
- totalResults: 1,
17
- returnedCount: 1,
18
- results: [
19
- new ItemHit({
20
- fields: {
21
- identifier: 'foo',
22
- collection: ['foo', 'bar'],
23
- },
24
- }),
25
- ],
26
- },
27
- responseHeader: {
28
- succeeded: true,
29
- query_time: 0,
30
- },
31
- },
32
- };
33
- export const getMockSuccessSingleResultWithSort = (resultsSpy) => ({
34
- success: {
35
- request: {
36
- clientParameters: {
37
- user_query: 'with-sort',
38
- sort: ['foo:asc'],
39
- },
40
- finalizedParameters: {
41
- user_query: 'with-sort',
42
- sort: ['foo:asc'],
43
- },
44
- },
45
- rawResponse: {},
46
- response: {
47
- totalResults: 1,
48
- returnedCount: 1,
49
- get results() {
50
- resultsSpy();
51
- return [
52
- new ItemHit({
53
- fields: {
54
- identifier: 'foo',
55
- collection: ['foo', 'bar'],
56
- },
57
- }),
58
- ];
59
- },
60
- },
61
- responseHeader: {
62
- succeeded: true,
63
- query_time: 0,
64
- },
65
- },
66
- });
67
- export const mockSuccessMultipleResults = {
68
- success: {
69
- request: {
70
- clientParameters: {
71
- user_query: 'collection:foo',
72
- sort: [],
73
- },
74
- finalizedParameters: {
75
- user_query: 'collection:foo',
76
- sort: [],
77
- },
78
- },
79
- rawResponse: {},
80
- response: {
81
- totalResults: 2,
82
- returnedCount: 2,
83
- results: [
84
- new ItemHit({
85
- fields: {
86
- identifier: 'foo',
87
- collection: ['foo', 'bar'],
88
- },
89
- }),
90
- new ItemHit({
91
- fields: {
92
- identifier: 'bar',
93
- collection: ['baz', 'boop'],
94
- },
95
- }),
96
- ],
97
- },
98
- responseHeader: {
99
- succeeded: true,
100
- query_time: 0,
101
- },
102
- },
103
- };
1
+ import { ItemHit, } from '@internetarchive/search-service';
2
+ export const mockSuccessSingleResult = {
3
+ success: {
4
+ request: {
5
+ clientParameters: {
6
+ user_query: 'collection:foo',
7
+ sort: [],
8
+ },
9
+ finalizedParameters: {
10
+ user_query: 'collection:foo',
11
+ sort: [],
12
+ },
13
+ },
14
+ rawResponse: {},
15
+ response: {
16
+ totalResults: 1,
17
+ returnedCount: 1,
18
+ results: [
19
+ new ItemHit({
20
+ fields: {
21
+ identifier: 'foo',
22
+ collection: ['foo', 'bar'],
23
+ },
24
+ }),
25
+ ],
26
+ },
27
+ responseHeader: {
28
+ succeeded: true,
29
+ query_time: 0,
30
+ },
31
+ },
32
+ };
33
+ export const getMockSuccessSingleResultWithSort = (resultsSpy) => ({
34
+ success: {
35
+ request: {
36
+ clientParameters: {
37
+ user_query: 'with-sort',
38
+ sort: ['foo:asc'],
39
+ },
40
+ finalizedParameters: {
41
+ user_query: 'with-sort',
42
+ sort: ['foo:asc'],
43
+ },
44
+ },
45
+ rawResponse: {},
46
+ response: {
47
+ totalResults: 1,
48
+ returnedCount: 1,
49
+ get results() {
50
+ resultsSpy();
51
+ return [
52
+ new ItemHit({
53
+ fields: {
54
+ identifier: 'foo',
55
+ collection: ['foo', 'bar'],
56
+ },
57
+ }),
58
+ ];
59
+ },
60
+ },
61
+ responseHeader: {
62
+ succeeded: true,
63
+ query_time: 0,
64
+ },
65
+ },
66
+ });
67
+ export const mockSuccessMultipleResults = {
68
+ success: {
69
+ request: {
70
+ clientParameters: {
71
+ user_query: 'collection:foo',
72
+ sort: [],
73
+ },
74
+ finalizedParameters: {
75
+ user_query: 'collection:foo',
76
+ sort: [],
77
+ },
78
+ },
79
+ rawResponse: {},
80
+ response: {
81
+ totalResults: 2,
82
+ returnedCount: 2,
83
+ results: [
84
+ new ItemHit({
85
+ fields: {
86
+ identifier: 'foo',
87
+ collection: ['foo', 'bar'],
88
+ },
89
+ }),
90
+ new ItemHit({
91
+ fields: {
92
+ identifier: 'bar',
93
+ collection: ['baz', 'boop'],
94
+ },
95
+ }),
96
+ ],
97
+ },
98
+ responseHeader: {
99
+ succeeded: true,
100
+ query_time: 0,
101
+ },
102
+ },
103
+ };
104
104
  //# sourceMappingURL=mock-search-responses.js.map
@@ -1,13 +1,13 @@
1
- import type { Result } from '@internetarchive/result-type';
2
- import type { SearchParams, SearchResponse, SearchServiceInterface, SearchServiceError, SearchType } from '@internetarchive/search-service';
3
- export declare class MockSearchService implements SearchServiceInterface {
4
- searchParams?: SearchParams;
5
- searchType?: SearchType;
6
- asyncResponse: boolean;
7
- resultsSpy: Function;
8
- constructor({ asyncResponse, resultsSpy }?: {
9
- asyncResponse?: boolean | undefined;
10
- resultsSpy?: (() => void) | undefined;
11
- });
12
- search(params: SearchParams, searchType: SearchType): Promise<Result<SearchResponse, SearchServiceError>>;
13
- }
1
+ import type { Result } from '@internetarchive/result-type';
2
+ import type { SearchParams, SearchResponse, SearchServiceInterface, SearchServiceError, SearchType } from '@internetarchive/search-service';
3
+ export declare class MockSearchService implements SearchServiceInterface {
4
+ searchParams?: SearchParams;
5
+ searchType?: SearchType;
6
+ asyncResponse: boolean;
7
+ resultsSpy: Function;
8
+ constructor({ asyncResponse, resultsSpy }?: {
9
+ asyncResponse?: boolean | undefined;
10
+ resultsSpy?: (() => void) | undefined;
11
+ });
12
+ search(params: SearchParams, searchType: SearchType): Promise<Result<SearchResponse, SearchServiceError>>;
13
+ }
@@ -1,26 +1,26 @@
1
- import { mockSuccessSingleResult, mockSuccessMultipleResults, getMockSuccessSingleResultWithSort, } from './mock-search-responses';
2
- export class MockSearchService {
3
- constructor({ asyncResponse = false, resultsSpy = () => { } } = {}) {
4
- this.asyncResponse = asyncResponse;
5
- this.resultsSpy = resultsSpy;
6
- }
7
- async search(params, searchType) {
8
- var _a, _b;
9
- this.searchParams = params;
10
- this.searchType = searchType;
11
- if (this.asyncResponse) {
12
- // Add an artificial 1-tick delay
13
- await new Promise(res => {
14
- setTimeout(res, 0);
15
- });
16
- }
17
- if (((_a = this.searchParams) === null || _a === void 0 ? void 0 : _a.query) === 'single-result') {
18
- return mockSuccessSingleResult;
19
- }
20
- if (((_b = this.searchParams) === null || _b === void 0 ? void 0 : _b.query) === 'with-sort') {
21
- return getMockSuccessSingleResultWithSort(this.resultsSpy);
22
- }
23
- return mockSuccessMultipleResults;
24
- }
25
- }
1
+ import { mockSuccessSingleResult, mockSuccessMultipleResults, getMockSuccessSingleResultWithSort, } from './mock-search-responses';
2
+ export class MockSearchService {
3
+ constructor({ asyncResponse = false, resultsSpy = () => { } } = {}) {
4
+ this.asyncResponse = asyncResponse;
5
+ this.resultsSpy = resultsSpy;
6
+ }
7
+ async search(params, searchType) {
8
+ var _a, _b;
9
+ this.searchParams = params;
10
+ this.searchType = searchType;
11
+ if (this.asyncResponse) {
12
+ // Add an artificial 1-tick delay
13
+ await new Promise(res => {
14
+ setTimeout(res, 0);
15
+ });
16
+ }
17
+ if (((_a = this.searchParams) === null || _a === void 0 ? void 0 : _a.query) === 'single-result') {
18
+ return mockSuccessSingleResult;
19
+ }
20
+ if (((_b = this.searchParams) === null || _b === void 0 ? void 0 : _b.query) === 'with-sort') {
21
+ return getMockSuccessSingleResultWithSort(this.resultsSpy);
22
+ }
23
+ return mockSuccessMultipleResults;
24
+ }
25
+ }
26
26
  //# sourceMappingURL=mock-search-service.js.map
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,118 +1,118 @@
1
- import { expect } from '@open-wc/testing';
2
- import { RestorationStateHandler } from '../src/restoration-state-handler';
3
- describe('Restoration state handler', () => {
4
- it('should restore query from URL', async () => {
5
- const handler = new RestorationStateHandler({ context: 'search' });
6
- const url = new URL(window.location.href);
7
- url.search = '?query=boop';
8
- window.history.replaceState({ path: url.href }, '', url.href);
9
- const restorationState = handler.getRestorationState();
10
- expect(restorationState.baseQuery).to.equal('boop');
11
- });
12
- it('should restore page number from URL', async () => {
13
- const handler = new RestorationStateHandler({ context: 'search' });
14
- const url = new URL(window.location.href);
15
- url.search = '?page=42';
16
- window.history.replaceState({ path: url.href }, '', url.href);
17
- const restorationState = handler.getRestorationState();
18
- expect(restorationState.currentPage).to.equal(42);
19
- });
20
- it('should restore selected year facets from URL', async () => {
21
- const handler = new RestorationStateHandler({ context: 'search' });
22
- const url = new URL(window.location.href);
23
- url.search = '?and[]=year:"2018"';
24
- window.history.replaceState({ path: url.href }, '', url.href);
25
- const restorationState = handler.getRestorationState();
26
- expect(restorationState.selectedFacets.year['2018'].state).to.equal('selected');
27
- });
28
- it('should restore selected date range facets from URL', async () => {
29
- const handler = new RestorationStateHandler({ context: 'search' });
30
- const url = new URL(window.location.href);
31
- url.search = '?and[]=year:"2018+TO+2021"';
32
- window.history.replaceState({ path: url.href }, '', url.href);
33
- const restorationState = handler.getRestorationState();
34
- expect(restorationState.minSelectedDate).to.equal('2018');
35
- expect(restorationState.maxSelectedDate).to.equal('2021');
36
- expect(restorationState.dateRangeQueryClause).to.equal('year:"2018 TO 2021"');
37
- });
38
- it('should restore creator filter from URL', async () => {
39
- const handler = new RestorationStateHandler({ context: 'search' });
40
- const url = new URL(window.location.href);
41
- url.search = '?and[]=firstCreator:F';
42
- window.history.replaceState({ path: url.href }, '', url.href);
43
- const restorationState = handler.getRestorationState();
44
- expect(restorationState.selectedCreatorFilter).to.equal('F');
45
- });
46
- it('should restore title filter from URL', async () => {
47
- const handler = new RestorationStateHandler({ context: 'search' });
48
- const url = new URL(window.location.href);
49
- url.search = '?and[]=firstTitle:F';
50
- window.history.replaceState({ path: url.href }, '', url.href);
51
- const restorationState = handler.getRestorationState();
52
- expect(restorationState.selectedTitleFilter).to.equal('F');
53
- });
54
- it('should restore other selected facets from URL', async () => {
55
- const handler = new RestorationStateHandler({ context: 'search' });
56
- const url = new URL(window.location.href);
57
- url.search = '?and[]=subject:"foo"';
58
- window.history.replaceState({ path: url.href }, '', url.href);
59
- const restorationState = handler.getRestorationState();
60
- expect(restorationState.selectedFacets.subject.foo.state).to.equal('selected');
61
- });
62
- it('should restore negative facets from URL', async () => {
63
- const handler = new RestorationStateHandler({ context: 'search' });
64
- const url = new URL(window.location.href);
65
- url.search = '?not[]=year:2018';
66
- window.history.replaceState({ path: url.href }, '', url.href);
67
- const restorationState = handler.getRestorationState();
68
- expect(restorationState.selectedFacets.year['2018'].state).to.equal('hidden');
69
- });
70
- it('should restore multiple selected/negative facets from URL', async () => {
71
- const handler = new RestorationStateHandler({ context: 'search' });
72
- const url = new URL(window.location.href);
73
- url.search =
74
- '?and[]=collection:"foo"&and[]=collection:"bar"&not[]=collection:"baz"&not[]=collection:"boop"';
75
- window.history.replaceState({ path: url.href }, '', url.href);
76
- const restorationState = handler.getRestorationState();
77
- expect(restorationState.selectedFacets.collection.foo.state).to.equal('selected');
78
- expect(restorationState.selectedFacets.collection.bar.state).to.equal('selected');
79
- expect(restorationState.selectedFacets.collection.baz.state).to.equal('hidden');
80
- expect(restorationState.selectedFacets.collection.boop.state).to.equal('hidden');
81
- });
82
- it('negative facets take precedence if both present in URL', async () => {
83
- const handler = new RestorationStateHandler({ context: 'search' });
84
- const url = new URL(window.location.href);
85
- url.search = '?and[]=collection:"foo"&not[]=collection:"foo"';
86
- window.history.replaceState({ path: url.href }, '', url.href);
87
- const restorationState = handler.getRestorationState();
88
- expect(restorationState.selectedFacets.collection.foo.state).to.equal('hidden');
89
- });
90
- it('should restore sort from URL (space format)', async () => {
91
- const handler = new RestorationStateHandler({ context: 'search' });
92
- const url = new URL(window.location.href);
93
- url.search = '?sort=date+desc';
94
- window.history.replaceState({ path: url.href }, '', url.href);
95
- const restorationState = handler.getRestorationState();
96
- expect(restorationState.selectedSort).to.equal('date');
97
- expect(restorationState.sortDirection).to.equal('desc');
98
- });
99
- it('should restore sort from URL (prefix format, desc)', async () => {
100
- const handler = new RestorationStateHandler({ context: 'search' });
101
- const url = new URL(window.location.href);
102
- url.search = '?sort=-date';
103
- window.history.replaceState({ path: url.href }, '', url.href);
104
- const restorationState = handler.getRestorationState();
105
- expect(restorationState.selectedSort).to.equal('date');
106
- expect(restorationState.sortDirection).to.equal('desc');
107
- });
108
- it('should restore sort from URL (prefix format, asc)', async () => {
109
- const handler = new RestorationStateHandler({ context: 'search' });
110
- const url = new URL(window.location.href);
111
- url.search = '?sort=date';
112
- window.history.replaceState({ path: url.href }, '', url.href);
113
- const restorationState = handler.getRestorationState();
114
- expect(restorationState.selectedSort).to.equal('date');
115
- expect(restorationState.sortDirection).to.equal('asc');
116
- });
117
- });
1
+ import { expect } from '@open-wc/testing';
2
+ import { RestorationStateHandler } from '../src/restoration-state-handler';
3
+ describe('Restoration state handler', () => {
4
+ it('should restore query from URL', async () => {
5
+ const handler = new RestorationStateHandler({ context: 'search' });
6
+ const url = new URL(window.location.href);
7
+ url.search = '?query=boop';
8
+ window.history.replaceState({ path: url.href }, '', url.href);
9
+ const restorationState = handler.getRestorationState();
10
+ expect(restorationState.baseQuery).to.equal('boop');
11
+ });
12
+ it('should restore page number from URL', async () => {
13
+ const handler = new RestorationStateHandler({ context: 'search' });
14
+ const url = new URL(window.location.href);
15
+ url.search = '?page=42';
16
+ window.history.replaceState({ path: url.href }, '', url.href);
17
+ const restorationState = handler.getRestorationState();
18
+ expect(restorationState.currentPage).to.equal(42);
19
+ });
20
+ it('should restore selected year facets from URL', async () => {
21
+ const handler = new RestorationStateHandler({ context: 'search' });
22
+ const url = new URL(window.location.href);
23
+ url.search = '?and[]=year:"2018"';
24
+ window.history.replaceState({ path: url.href }, '', url.href);
25
+ const restorationState = handler.getRestorationState();
26
+ expect(restorationState.selectedFacets.year['2018'].state).to.equal('selected');
27
+ });
28
+ it('should restore selected date range facets from URL', async () => {
29
+ const handler = new RestorationStateHandler({ context: 'search' });
30
+ const url = new URL(window.location.href);
31
+ url.search = '?and[]=year:"2018+TO+2021"';
32
+ window.history.replaceState({ path: url.href }, '', url.href);
33
+ const restorationState = handler.getRestorationState();
34
+ expect(restorationState.minSelectedDate).to.equal('2018');
35
+ expect(restorationState.maxSelectedDate).to.equal('2021');
36
+ expect(restorationState.dateRangeQueryClause).to.equal('year:"2018 TO 2021"');
37
+ });
38
+ it('should restore creator filter from URL', async () => {
39
+ const handler = new RestorationStateHandler({ context: 'search' });
40
+ const url = new URL(window.location.href);
41
+ url.search = '?and[]=firstCreator:F';
42
+ window.history.replaceState({ path: url.href }, '', url.href);
43
+ const restorationState = handler.getRestorationState();
44
+ expect(restorationState.selectedCreatorFilter).to.equal('F');
45
+ });
46
+ it('should restore title filter from URL', async () => {
47
+ const handler = new RestorationStateHandler({ context: 'search' });
48
+ const url = new URL(window.location.href);
49
+ url.search = '?and[]=firstTitle:F';
50
+ window.history.replaceState({ path: url.href }, '', url.href);
51
+ const restorationState = handler.getRestorationState();
52
+ expect(restorationState.selectedTitleFilter).to.equal('F');
53
+ });
54
+ it('should restore other selected facets from URL', async () => {
55
+ const handler = new RestorationStateHandler({ context: 'search' });
56
+ const url = new URL(window.location.href);
57
+ url.search = '?and[]=subject:"foo"';
58
+ window.history.replaceState({ path: url.href }, '', url.href);
59
+ const restorationState = handler.getRestorationState();
60
+ expect(restorationState.selectedFacets.subject.foo.state).to.equal('selected');
61
+ });
62
+ it('should restore negative facets from URL', async () => {
63
+ const handler = new RestorationStateHandler({ context: 'search' });
64
+ const url = new URL(window.location.href);
65
+ url.search = '?not[]=year:2018';
66
+ window.history.replaceState({ path: url.href }, '', url.href);
67
+ const restorationState = handler.getRestorationState();
68
+ expect(restorationState.selectedFacets.year['2018'].state).to.equal('hidden');
69
+ });
70
+ it('should restore multiple selected/negative facets from URL', async () => {
71
+ const handler = new RestorationStateHandler({ context: 'search' });
72
+ const url = new URL(window.location.href);
73
+ url.search =
74
+ '?and[]=collection:"foo"&and[]=collection:"bar"&not[]=collection:"baz"&not[]=collection:"boop"';
75
+ window.history.replaceState({ path: url.href }, '', url.href);
76
+ const restorationState = handler.getRestorationState();
77
+ expect(restorationState.selectedFacets.collection.foo.state).to.equal('selected');
78
+ expect(restorationState.selectedFacets.collection.bar.state).to.equal('selected');
79
+ expect(restorationState.selectedFacets.collection.baz.state).to.equal('hidden');
80
+ expect(restorationState.selectedFacets.collection.boop.state).to.equal('hidden');
81
+ });
82
+ it('negative facets take precedence if both present in URL', async () => {
83
+ const handler = new RestorationStateHandler({ context: 'search' });
84
+ const url = new URL(window.location.href);
85
+ url.search = '?and[]=collection:"foo"&not[]=collection:"foo"';
86
+ window.history.replaceState({ path: url.href }, '', url.href);
87
+ const restorationState = handler.getRestorationState();
88
+ expect(restorationState.selectedFacets.collection.foo.state).to.equal('hidden');
89
+ });
90
+ it('should restore sort from URL (space format)', async () => {
91
+ const handler = new RestorationStateHandler({ context: 'search' });
92
+ const url = new URL(window.location.href);
93
+ url.search = '?sort=date+desc';
94
+ window.history.replaceState({ path: url.href }, '', url.href);
95
+ const restorationState = handler.getRestorationState();
96
+ expect(restorationState.selectedSort).to.equal('date');
97
+ expect(restorationState.sortDirection).to.equal('desc');
98
+ });
99
+ it('should restore sort from URL (prefix format, desc)', async () => {
100
+ const handler = new RestorationStateHandler({ context: 'search' });
101
+ const url = new URL(window.location.href);
102
+ url.search = '?sort=-date';
103
+ window.history.replaceState({ path: url.href }, '', url.href);
104
+ const restorationState = handler.getRestorationState();
105
+ expect(restorationState.selectedSort).to.equal('date');
106
+ expect(restorationState.sortDirection).to.equal('desc');
107
+ });
108
+ it('should restore sort from URL (prefix format, asc)', async () => {
109
+ const handler = new RestorationStateHandler({ context: 'search' });
110
+ const url = new URL(window.location.href);
111
+ url.search = '?sort=date';
112
+ window.history.replaceState({ path: url.href }, '', url.href);
113
+ const restorationState = handler.getRestorationState();
114
+ expect(restorationState.selectedSort).to.equal('date');
115
+ expect(restorationState.sortDirection).to.equal('asc');
116
+ });
117
+ });
118
118
  //# sourceMappingURL=restoration-state-handler.test.js.map
@@ -1 +1 @@
1
- import '../../src/sort-filter-bar/sort-filter-bar';
1
+ import '../../src/sort-filter-bar/sort-filter-bar';