@internetarchive/collection-browser 0.3.1-alpha.3 → 0.3.2-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 (30) hide show
  1. package/dist/src/collection-browser.d.ts +6 -0
  2. package/dist/src/collection-browser.js +346 -341
  3. package/dist/src/collection-browser.js.map +1 -1
  4. package/dist/src/collection-facets/facets-template.js +150 -150
  5. package/dist/src/collection-facets/facets-template.js.map +1 -1
  6. package/dist/src/collection-facets/more-facets-content.js +134 -134
  7. package/dist/src/collection-facets/more-facets-content.js.map +1 -1
  8. package/dist/src/collection-facets.d.ts +2 -0
  9. package/dist/src/collection-facets.js +158 -147
  10. package/dist/src/collection-facets.js.map +1 -1
  11. package/dist/src/models.js.map +1 -1
  12. package/dist/src/restoration-state-handler.js.map +1 -1
  13. package/dist/src/tiles/list/tile-list.js +204 -204
  14. package/dist/src/tiles/list/tile-list.js.map +1 -1
  15. package/dist/src/utils/format-count.js.map +1 -1
  16. package/dist/test/collection-browser.test.js +26 -26
  17. package/dist/test/collection-browser.test.js.map +1 -1
  18. package/dist/test/collection-facets.test.js +2 -2
  19. package/dist/test/collection-facets.test.js.map +1 -1
  20. package/package.json +1 -1
  21. package/src/collection-browser.ts +1539 -1530
  22. package/src/collection-facets/facets-template.ts +294 -294
  23. package/src/collection-facets/more-facets-content.ts +518 -518
  24. package/src/collection-facets.ts +582 -569
  25. package/src/models.ts +216 -216
  26. package/src/restoration-state-handler.ts +302 -302
  27. package/src/tiles/list/tile-list.ts +509 -509
  28. package/src/utils/format-count.ts +96 -96
  29. package/test/collection-browser.test.ts +490 -490
  30. package/test/collection-facets.test.ts +510 -510
@@ -1,490 +1,490 @@
1
- /* eslint-disable import/no-duplicates */
2
- import { expect, fixture } from '@open-wc/testing';
3
- import { html } from 'lit';
4
- import sinon from 'sinon';
5
- import type { InfiniteScroller } from '@internetarchive/infinite-scroller';
6
- import { SearchType } from '@internetarchive/search-service';
7
- import type { CollectionBrowser } from '../src/collection-browser';
8
- import '../src/collection-browser';
9
- import {
10
- defaultSelectedFacets,
11
- FacetBucket,
12
- SelectedFacets,
13
- SortField,
14
- } from '../src/models';
15
- import { MockSearchService } from './mocks/mock-search-service';
16
- import { MockCollectionNameCache } from './mocks/mock-collection-name-cache';
17
- import { MockAnalyticsHandler } from './mocks/mock-analytics-handler';
18
- import { analyticsCategories } from '../src/utils/analytics-events';
19
-
20
- describe('Collection Browser', () => {
21
- it('clear existing filter for facets & sort-bar', async () => {
22
- const el = await fixture<CollectionBrowser>(
23
- html`<collection-browser></collection-browser>`
24
- );
25
-
26
- el.selectedSort = 'title' as SortField;
27
- await el.updateComplete;
28
- el.clearFilters();
29
-
30
- expect(el.selectedFacets).to.equal(defaultSelectedFacets);
31
- expect(el.selectedSort).to.equal('relevance');
32
- expect(el.sortDirection).to.null;
33
- expect(el.sortParam).to.null;
34
- expect(el.selectedCreatorFilter).to.null;
35
- expect(el.selectedTitleFilter).to.null;
36
- });
37
-
38
- it('filterBy creator with analytics', async () => {
39
- const mockAnalyticsHandler = new MockAnalyticsHandler();
40
- const el = await fixture<CollectionBrowser>(
41
- html`<collection-browser .analyticsHandler=${mockAnalyticsHandler}>
42
- </collection-browser>`
43
- );
44
-
45
- el.searchContext = 'betaSearchService';
46
- el.selectedCreatorFilter = 'A';
47
- await el.updateComplete;
48
-
49
- expect(mockAnalyticsHandler.callCategory).to.equal('betaSearchService');
50
- expect(mockAnalyticsHandler.callAction).to.equal('filterByCreator');
51
- expect(mockAnalyticsHandler.callLabel).to.equal('start-A');
52
-
53
- el.clearFilters();
54
- await el.updateComplete;
55
-
56
- expect(el.selectedTitleFilter).to.null;
57
- expect(mockAnalyticsHandler.callCategory).to.equal('betaSearchService');
58
- expect(mockAnalyticsHandler.callAction).to.equal('filterByCreator');
59
- expect(mockAnalyticsHandler.callLabel).to.equal('clear-A');
60
- });
61
-
62
- it('filterBy title with analytics', async () => {
63
- const mockAnalyticsHandler = new MockAnalyticsHandler();
64
- const el = await fixture<CollectionBrowser>(
65
- html`<collection-browser .analyticsHandler=${mockAnalyticsHandler}>
66
- </collection-browser>`
67
- );
68
-
69
- el.searchContext = 'beta-search-service';
70
- el.selectedSort = 'title' as SortField;
71
- el.selectedTitleFilter = 'A';
72
- await el.updateComplete;
73
-
74
- expect(mockAnalyticsHandler.callCategory).to.equal('beta-search-service');
75
- expect(mockAnalyticsHandler.callAction).to.equal('filterByTitle');
76
- expect(mockAnalyticsHandler.callLabel).to.equal('start-A');
77
-
78
- el.clearFilters();
79
- await el.updateComplete;
80
-
81
- expect(el.selectedTitleFilter).to.null;
82
- expect(mockAnalyticsHandler.callCategory).to.equal('beta-search-service');
83
- expect(mockAnalyticsHandler.callAction).to.equal('filterByTitle');
84
- expect(mockAnalyticsHandler.callLabel).to.equal('clear-A');
85
- });
86
-
87
- it('selected facets with analytics - not negative facets', async () => {
88
- const mockAnalyticsHandler = new MockAnalyticsHandler();
89
- const mediaTypeBucket = { count: 123, state: 'selected' } as FacetBucket;
90
- const mockedSelectedFacets: SelectedFacets = {
91
- subject: {},
92
- lending: {},
93
- mediatype: { data: mediaTypeBucket },
94
- language: {},
95
- creator: {},
96
- collection: {},
97
- year: {},
98
- };
99
-
100
- const el = await fixture<CollectionBrowser>(
101
- html`<collection-browser .analyticsHandler=${mockAnalyticsHandler}>
102
- </collection-browser>`
103
- );
104
-
105
- el.searchContext = 'search-service';
106
- el.selectedFacets = mockedSelectedFacets;
107
- await el.updateComplete;
108
-
109
- el.facetClickHandler('mediatype', true, false);
110
- expect(mockAnalyticsHandler.callCategory).to.equal('search-service');
111
- expect(mockAnalyticsHandler.callAction).to.equal('facetSelected');
112
- expect(mockAnalyticsHandler.callLabel).to.equal('mediatype');
113
-
114
- el.facetClickHandler('mediatype', false, false);
115
- expect(el.selectedFacets).to.equal(mockedSelectedFacets);
116
- expect(mockAnalyticsHandler.callCategory).to.equal('search-service');
117
- expect(mockAnalyticsHandler.callAction).to.equal('facetDeselected');
118
- expect(mockAnalyticsHandler.callLabel).to.equal('mediatype');
119
- });
120
-
121
- it('selected facets with analytics - negative facets', async () => {
122
- const mockAnalyticsHandler = new MockAnalyticsHandler();
123
- const mediaTypeBucket = { count: 123, state: 'selected' } as FacetBucket;
124
- const mockedSelectedFacets: SelectedFacets = {
125
- subject: {},
126
- lending: {},
127
- mediatype: { data: mediaTypeBucket },
128
- language: {},
129
- creator: {},
130
- collection: {},
131
- year: {},
132
- };
133
-
134
- const el = await fixture<CollectionBrowser>(
135
- html`<collection-browser .analyticsHandler=${mockAnalyticsHandler}>
136
- </collection-browser>`
137
- );
138
-
139
- el.searchContext = 'beta-search-service';
140
- el.selectedFacets = mockedSelectedFacets;
141
- await el.updateComplete;
142
-
143
- el.facetClickHandler('mediatype', true, true);
144
- expect(mockAnalyticsHandler.callCategory).to.equal('beta-search-service');
145
- expect(mockAnalyticsHandler.callAction).to.equal('facetNegativeSelected');
146
- expect(mockAnalyticsHandler.callLabel).to.equal('mediatype');
147
-
148
- el.facetClickHandler('mediatype', false, true);
149
- expect(el.selectedFacets).to.equal(mockedSelectedFacets);
150
- expect(mockAnalyticsHandler.callCategory).to.equal('beta-search-service');
151
- expect(mockAnalyticsHandler.callAction).to.equal('facetNegativeDeselected');
152
- expect(mockAnalyticsHandler.callLabel).to.equal('mediatype');
153
- });
154
-
155
- it('should render with a sort bar, facets, and infinite scroller', async () => {
156
- const el = await fixture<CollectionBrowser>(
157
- html`<collection-browser></collection-browser>`
158
- );
159
-
160
- el.baseQuery = 'hello';
161
- await el.updateComplete;
162
-
163
- const facets = el.shadowRoot?.querySelector('collection-facets');
164
- const sortBar = el.shadowRoot?.querySelector('sort-filter-bar');
165
- const infiniteScroller = el.shadowRoot?.querySelector('infinite-scroller');
166
- expect(facets).to.exist;
167
- expect(sortBar).to.exist;
168
- expect(infiniteScroller).to.exist;
169
- });
170
-
171
- it('queries the search service when given a base query', async () => {
172
- const searchService = new MockSearchService();
173
-
174
- const el = await fixture<CollectionBrowser>(
175
- html`<collection-browser .searchService=${searchService}>
176
- </collection-browser>`
177
- );
178
-
179
- el.baseQuery = 'collection:foo';
180
- await el.updateComplete;
181
-
182
- expect(searchService.searchParams?.query).to.equal('collection:foo');
183
- expect(
184
- el.shadowRoot?.querySelector('#big-results-label')?.textContent
185
- ).to.contains('Results');
186
- });
187
-
188
- it('queries the search service with a metadata search', async () => {
189
- const searchService = new MockSearchService();
190
-
191
- const el = await fixture<CollectionBrowser>(
192
- html` <collection-browser
193
- .searchService=${searchService}
194
- .searchType=${SearchType.METADATA}
195
- >
196
- </collection-browser>`
197
- );
198
-
199
- el.baseQuery = 'collection:foo';
200
- await el.updateComplete;
201
-
202
- expect(searchService.searchParams?.query).to.equal('collection:foo');
203
- expect(searchService.searchType).to.equal(SearchType.METADATA);
204
- expect(
205
- el.shadowRoot?.querySelector('#big-results-label')?.textContent
206
- ).to.contains('Results');
207
- });
208
-
209
- it('queries the search service with a fulltext search', async () => {
210
- const searchService = new MockSearchService();
211
-
212
- const el = await fixture<CollectionBrowser>(
213
- html` <collection-browser
214
- .searchService=${searchService}
215
- .searchType=${SearchType.FULLTEXT}
216
- >
217
- </collection-browser>`
218
- );
219
-
220
- el.baseQuery = 'collection:foo';
221
- await el.updateComplete;
222
-
223
- expect(searchService.searchParams?.query).to.equal('collection:foo');
224
- expect(searchService.searchType).to.equal(SearchType.FULLTEXT);
225
- expect(
226
- el.shadowRoot?.querySelector('#big-results-label')?.textContent
227
- ).to.contains('Results');
228
- });
229
-
230
- it('queries for collection names after a fetch', async () => {
231
- const searchService = new MockSearchService();
232
- const collectionNameCache = new MockCollectionNameCache();
233
-
234
- const el = await fixture<CollectionBrowser>(
235
- html`<collection-browser
236
- .searchService=${searchService}
237
- .collectionNameCache=${collectionNameCache}
238
- >
239
- </collection-browser>`
240
- );
241
-
242
- el.baseQuery = 'blahblah';
243
- await el.updateComplete;
244
-
245
- expect(collectionNameCache.preloadIdentifiersRequested).to.deep.equal([
246
- 'foo',
247
- 'bar',
248
- 'baz',
249
- 'boop',
250
- ]);
251
- });
252
-
253
- it('keeps search results from fetch if no change to query or sort param', async () => {
254
- const resultsSpy = sinon.spy();
255
- const searchService = new MockSearchService({
256
- asyncResponse: true,
257
- resultsSpy,
258
- });
259
-
260
- const el = await fixture<CollectionBrowser>(
261
- html`<collection-browser .searchService=${searchService}>
262
- </collection-browser>`
263
- );
264
-
265
- el.baseQuery = 'with-sort';
266
- el.sortParam = { field: 'foo', direction: 'asc' };
267
- await el.updateComplete;
268
-
269
- await el.fetchPage(2);
270
-
271
- // If there is no change to the query or sort param during the fetch, the results
272
- // should be read.
273
- expect(resultsSpy.callCount).to.be.greaterThanOrEqual(1);
274
- });
275
-
276
- it('discards obsolete search results if sort params changed before arrival', async () => {
277
- const resultsSpy = sinon.spy();
278
- const searchService = new MockSearchService({
279
- asyncResponse: true,
280
- resultsSpy,
281
- });
282
-
283
- const el = await fixture<CollectionBrowser>(
284
- html`<collection-browser .searchService=${searchService}>
285
- </collection-browser>`
286
- );
287
-
288
- el.baseQuery = 'with-sort';
289
- el.sortParam = { field: 'foo', direction: 'asc' };
290
- await el.updateComplete;
291
-
292
- const fetchPromise = el.fetchPage(2);
293
- el.sortParam = { field: 'foo', direction: 'desc' };
294
- await fetchPromise;
295
-
296
- // If the different sort param causes the results to be discarded,
297
- // the results array should never be read.
298
- expect(resultsSpy.callCount).to.equal(0);
299
- });
300
-
301
- it('discards obsolete search results if sort param added before arrival', async () => {
302
- const resultsSpy = sinon.spy();
303
- const searchService = new MockSearchService({
304
- asyncResponse: true,
305
- resultsSpy,
306
- });
307
-
308
- const el = await fixture<CollectionBrowser>(
309
- html`<collection-browser .searchService=${searchService}>
310
- </collection-browser>`
311
- );
312
-
313
- el.baseQuery = 'single-result';
314
- await el.updateComplete;
315
-
316
- const fetchPromise = el.fetchPage(2);
317
- el.sortParam = { field: 'foo', direction: 'asc' };
318
- await fetchPromise;
319
-
320
- // If the different sort param causes the results to be discarded,
321
- // the results array should never be read.
322
- expect(resultsSpy.callCount).to.equal(0);
323
- });
324
-
325
- it('discards obsolete search results if sort param cleared before arrival', async () => {
326
- const resultsSpy = sinon.spy();
327
- const searchService = new MockSearchService({
328
- asyncResponse: true,
329
- resultsSpy,
330
- });
331
-
332
- const el = await fixture<CollectionBrowser>(
333
- html`<collection-browser .searchService=${searchService}>
334
- </collection-browser>`
335
- );
336
-
337
- el.baseQuery = 'with-sort';
338
- await el.updateComplete;
339
-
340
- const fetchPromise = el.fetchPage(2);
341
- el.sortParam = null;
342
- await fetchPromise;
343
-
344
- // If the different sort param causes the results to be discarded,
345
- // the results array should never be read.
346
- expect(resultsSpy.callCount).to.equal(0);
347
- });
348
-
349
- it('sets sort properties when user changes sort', async () => {
350
- const el = await fixture<CollectionBrowser>(
351
- html`<collection-browser></collection-browser>`
352
- );
353
-
354
- expect(el.selectedSort).to.equal(SortField.relevance);
355
-
356
- el.baseQuery = 'foo';
357
- await el.updateComplete;
358
-
359
- const sortBar = el.shadowRoot?.querySelector('sort-filter-bar');
360
- const sortSelector = sortBar?.shadowRoot?.querySelector(
361
- '#desktop-sort-selector'
362
- );
363
- expect(sortSelector).to.exist;
364
-
365
- // Click the title sorter
366
- [...(sortSelector?.children as HTMLCollection & Iterable<any>)] // tsc doesn't know children is iterable
367
- .find(child => child.textContent?.trim() === 'Title')
368
- ?.querySelector('a[href]')
369
- ?.click();
370
-
371
- await el.updateComplete;
372
-
373
- expect(el.selectedSort).to.equal(SortField.title);
374
- });
375
-
376
- it('scrolls to page', async () => {
377
- const el = await fixture<CollectionBrowser>(
378
- html`<collection-browser></collection-browser>`
379
- );
380
-
381
- const infiniteScroller = el.shadowRoot?.querySelector(
382
- 'infinite-scroller'
383
- ) as InfiniteScroller;
384
- expect(infiniteScroller).to.exist;
385
-
386
- const oldScrollToCell = infiniteScroller.scrollToCell;
387
- const spy = sinon.spy();
388
- infiniteScroller.scrollToCell = spy;
389
-
390
- el.goToPage(1);
391
-
392
- // Give it a second to scroll
393
- await new Promise(res => {
394
- setTimeout(res, 1000);
395
- });
396
-
397
- expect(spy.callCount).to.equal(1);
398
-
399
- infiniteScroller.scrollToCell = oldScrollToCell;
400
- });
401
-
402
- it('refreshes when certain properties change - with some analytics event sampling', async () => {
403
- const mockAnalyticsHandler = new MockAnalyticsHandler();
404
- const searchService = new MockSearchService();
405
- const collectionNameCache = new MockCollectionNameCache();
406
- const el = await fixture<CollectionBrowser>(
407
- html`<collection-browser
408
- .analyticsHandler=${mockAnalyticsHandler}
409
- .searchService=${searchService}
410
- .collectionNameCache=${collectionNameCache}
411
- ></collection-browser>`
412
- );
413
- const infiniteScrollerRefreshSpy = sinon.spy();
414
-
415
- const infiniteScroller = el.shadowRoot?.querySelector('infinite-scroller');
416
- (infiniteScroller as InfiniteScroller).reload = infiniteScrollerRefreshSpy;
417
- expect(infiniteScrollerRefreshSpy.called).to.be.false;
418
- expect(infiniteScrollerRefreshSpy.callCount).to.equal(0);
419
-
420
- // testing: `loggedIn`
421
- el.loggedIn = true;
422
- await el.updateComplete;
423
- expect(infiniteScrollerRefreshSpy.called).to.be.true;
424
- expect(infiniteScrollerRefreshSpy.callCount).to.equal(1);
425
-
426
- el.loggedIn = false;
427
- await el.updateComplete;
428
- expect(infiniteScrollerRefreshSpy.callCount).to.equal(2);
429
-
430
- // testing: `displayMode`
431
- el.displayMode = 'list-compact';
432
- el.searchContext = 'beta-search';
433
- await el.updateComplete;
434
- expect(infiniteScrollerRefreshSpy.callCount).to.equal(3);
435
-
436
- expect(mockAnalyticsHandler.callCategory).to.equal('beta-search');
437
- expect(mockAnalyticsHandler.callAction).to.equal('displayMode');
438
- expect(mockAnalyticsHandler.callLabel).to.equal('list-compact');
439
-
440
- el.displayMode = 'list-detail';
441
- await el.updateComplete;
442
- expect(infiniteScrollerRefreshSpy.callCount).to.equal(4);
443
-
444
- expect(mockAnalyticsHandler.callCategory).to.equal('beta-search');
445
- expect(mockAnalyticsHandler.callAction).to.equal('displayMode');
446
- expect(mockAnalyticsHandler.callLabel).to.equal('list-detail');
447
-
448
- // testing: `baseNavigationUrl`
449
- el.baseNavigationUrl = 'https://funtestsite.com';
450
- await el.updateComplete;
451
- expect(infiniteScrollerRefreshSpy.callCount).to.equal(5);
452
-
453
- // testing: `baseImageUrl`
454
- el.baseImageUrl = 'https://funtestsiteforimages.com';
455
- await el.updateComplete;
456
- expect(infiniteScrollerRefreshSpy.callCount).to.equal(6);
457
- });
458
-
459
- it('query the search service for single result', async () => {
460
- const searchService = new MockSearchService();
461
-
462
- const el = await fixture<CollectionBrowser>(
463
- html`<collection-browser .searchService=${searchService}>
464
- </collection-browser>`
465
- );
466
-
467
- el.baseQuery = 'single-result';
468
- await el.updateComplete;
469
-
470
- expect(
471
- el.shadowRoot?.querySelector('#big-results-label')?.textContent
472
- ).to.contains('Result');
473
- });
474
-
475
- it('`searchContext` prop helps describe where component is being used', async () => {
476
- const el = await fixture<CollectionBrowser>(
477
- html`<collection-browser></collection-browser>`
478
- );
479
-
480
- expect(el.searchContext).to.equal(analyticsCategories.default);
481
-
482
- el.searchContext = 'unicorn-search';
483
- await el.updateComplete;
484
-
485
- expect(el.searchContext).to.equal('unicorn-search');
486
-
487
- // property is reflected as attribute
488
- expect(el.getAttribute('searchcontext')).to.equal('unicorn-search');
489
- });
490
- });
1
+ /* eslint-disable import/no-duplicates */
2
+ import { expect, fixture } from '@open-wc/testing';
3
+ import { html } from 'lit';
4
+ import sinon from 'sinon';
5
+ import type { InfiniteScroller } from '@internetarchive/infinite-scroller';
6
+ import { SearchType } from '@internetarchive/search-service';
7
+ import type { CollectionBrowser } from '../src/collection-browser';
8
+ import '../src/collection-browser';
9
+ import {
10
+ defaultSelectedFacets,
11
+ FacetBucket,
12
+ SelectedFacets,
13
+ SortField,
14
+ } from '../src/models';
15
+ import { MockSearchService } from './mocks/mock-search-service';
16
+ import { MockCollectionNameCache } from './mocks/mock-collection-name-cache';
17
+ import { MockAnalyticsHandler } from './mocks/mock-analytics-handler';
18
+ import { analyticsCategories } from '../src/utils/analytics-events';
19
+
20
+ describe('Collection Browser', () => {
21
+ it('clear existing filter for facets & sort-bar', async () => {
22
+ const el = await fixture<CollectionBrowser>(
23
+ html`<collection-browser></collection-browser>`
24
+ );
25
+
26
+ el.selectedSort = 'title' as SortField;
27
+ await el.updateComplete;
28
+ el.clearFilters();
29
+
30
+ expect(el.selectedFacets).to.equal(defaultSelectedFacets);
31
+ expect(el.selectedSort).to.equal('relevance');
32
+ expect(el.sortDirection).to.null;
33
+ expect(el.sortParam).to.null;
34
+ expect(el.selectedCreatorFilter).to.null;
35
+ expect(el.selectedTitleFilter).to.null;
36
+ });
37
+
38
+ it('filterBy creator with analytics', async () => {
39
+ const mockAnalyticsHandler = new MockAnalyticsHandler();
40
+ const el = await fixture<CollectionBrowser>(
41
+ html`<collection-browser .analyticsHandler=${mockAnalyticsHandler}>
42
+ </collection-browser>`
43
+ );
44
+
45
+ el.searchContext = 'betaSearchService';
46
+ el.selectedCreatorFilter = 'A';
47
+ await el.updateComplete;
48
+
49
+ expect(mockAnalyticsHandler.callCategory).to.equal('betaSearchService');
50
+ expect(mockAnalyticsHandler.callAction).to.equal('filterByCreator');
51
+ expect(mockAnalyticsHandler.callLabel).to.equal('start-A');
52
+
53
+ el.clearFilters();
54
+ await el.updateComplete;
55
+
56
+ expect(el.selectedTitleFilter).to.null;
57
+ expect(mockAnalyticsHandler.callCategory).to.equal('betaSearchService');
58
+ expect(mockAnalyticsHandler.callAction).to.equal('filterByCreator');
59
+ expect(mockAnalyticsHandler.callLabel).to.equal('clear-A');
60
+ });
61
+
62
+ it('filterBy title with analytics', async () => {
63
+ const mockAnalyticsHandler = new MockAnalyticsHandler();
64
+ const el = await fixture<CollectionBrowser>(
65
+ html`<collection-browser .analyticsHandler=${mockAnalyticsHandler}>
66
+ </collection-browser>`
67
+ );
68
+
69
+ el.searchContext = 'beta-search-service';
70
+ el.selectedSort = 'title' as SortField;
71
+ el.selectedTitleFilter = 'A';
72
+ await el.updateComplete;
73
+
74
+ expect(mockAnalyticsHandler.callCategory).to.equal('beta-search-service');
75
+ expect(mockAnalyticsHandler.callAction).to.equal('filterByTitle');
76
+ expect(mockAnalyticsHandler.callLabel).to.equal('start-A');
77
+
78
+ el.clearFilters();
79
+ await el.updateComplete;
80
+
81
+ expect(el.selectedTitleFilter).to.null;
82
+ expect(mockAnalyticsHandler.callCategory).to.equal('beta-search-service');
83
+ expect(mockAnalyticsHandler.callAction).to.equal('filterByTitle');
84
+ expect(mockAnalyticsHandler.callLabel).to.equal('clear-A');
85
+ });
86
+
87
+ it('selected facets with analytics - not negative facets', async () => {
88
+ const mockAnalyticsHandler = new MockAnalyticsHandler();
89
+ const mediaTypeBucket = { count: 123, state: 'selected' } as FacetBucket;
90
+ const mockedSelectedFacets: SelectedFacets = {
91
+ subject: {},
92
+ lending: {},
93
+ mediatype: { data: mediaTypeBucket },
94
+ language: {},
95
+ creator: {},
96
+ collection: {},
97
+ year: {},
98
+ };
99
+
100
+ const el = await fixture<CollectionBrowser>(
101
+ html`<collection-browser .analyticsHandler=${mockAnalyticsHandler}>
102
+ </collection-browser>`
103
+ );
104
+
105
+ el.searchContext = 'search-service';
106
+ el.selectedFacets = mockedSelectedFacets;
107
+ await el.updateComplete;
108
+
109
+ el.facetClickHandler('mediatype', true, false);
110
+ expect(mockAnalyticsHandler.callCategory).to.equal('search-service');
111
+ expect(mockAnalyticsHandler.callAction).to.equal('facetSelected');
112
+ expect(mockAnalyticsHandler.callLabel).to.equal('mediatype');
113
+
114
+ el.facetClickHandler('mediatype', false, false);
115
+ expect(el.selectedFacets).to.equal(mockedSelectedFacets);
116
+ expect(mockAnalyticsHandler.callCategory).to.equal('search-service');
117
+ expect(mockAnalyticsHandler.callAction).to.equal('facetDeselected');
118
+ expect(mockAnalyticsHandler.callLabel).to.equal('mediatype');
119
+ });
120
+
121
+ it('selected facets with analytics - negative facets', async () => {
122
+ const mockAnalyticsHandler = new MockAnalyticsHandler();
123
+ const mediaTypeBucket = { count: 123, state: 'selected' } as FacetBucket;
124
+ const mockedSelectedFacets: SelectedFacets = {
125
+ subject: {},
126
+ lending: {},
127
+ mediatype: { data: mediaTypeBucket },
128
+ language: {},
129
+ creator: {},
130
+ collection: {},
131
+ year: {},
132
+ };
133
+
134
+ const el = await fixture<CollectionBrowser>(
135
+ html`<collection-browser .analyticsHandler=${mockAnalyticsHandler}>
136
+ </collection-browser>`
137
+ );
138
+
139
+ el.searchContext = 'beta-search-service';
140
+ el.selectedFacets = mockedSelectedFacets;
141
+ await el.updateComplete;
142
+
143
+ el.facetClickHandler('mediatype', true, true);
144
+ expect(mockAnalyticsHandler.callCategory).to.equal('beta-search-service');
145
+ expect(mockAnalyticsHandler.callAction).to.equal('facetNegativeSelected');
146
+ expect(mockAnalyticsHandler.callLabel).to.equal('mediatype');
147
+
148
+ el.facetClickHandler('mediatype', false, true);
149
+ expect(el.selectedFacets).to.equal(mockedSelectedFacets);
150
+ expect(mockAnalyticsHandler.callCategory).to.equal('beta-search-service');
151
+ expect(mockAnalyticsHandler.callAction).to.equal('facetNegativeDeselected');
152
+ expect(mockAnalyticsHandler.callLabel).to.equal('mediatype');
153
+ });
154
+
155
+ it('should render with a sort bar, facets, and infinite scroller', async () => {
156
+ const el = await fixture<CollectionBrowser>(
157
+ html`<collection-browser></collection-browser>`
158
+ );
159
+
160
+ el.baseQuery = 'hello';
161
+ await el.updateComplete;
162
+
163
+ const facets = el.shadowRoot?.querySelector('collection-facets');
164
+ const sortBar = el.shadowRoot?.querySelector('sort-filter-bar');
165
+ const infiniteScroller = el.shadowRoot?.querySelector('infinite-scroller');
166
+ expect(facets).to.exist;
167
+ expect(sortBar).to.exist;
168
+ expect(infiniteScroller).to.exist;
169
+ });
170
+
171
+ it('queries the search service when given a base query', async () => {
172
+ const searchService = new MockSearchService();
173
+
174
+ const el = await fixture<CollectionBrowser>(
175
+ html`<collection-browser .searchService=${searchService}>
176
+ </collection-browser>`
177
+ );
178
+
179
+ el.baseQuery = 'collection:foo';
180
+ await el.updateComplete;
181
+
182
+ expect(searchService.searchParams?.query).to.equal('collection:foo');
183
+ expect(
184
+ el.shadowRoot?.querySelector('#big-results-label')?.textContent
185
+ ).to.contains('Results');
186
+ });
187
+
188
+ it('queries the search service with a metadata search', async () => {
189
+ const searchService = new MockSearchService();
190
+
191
+ const el = await fixture<CollectionBrowser>(
192
+ html` <collection-browser
193
+ .searchService=${searchService}
194
+ .searchType=${SearchType.METADATA}
195
+ >
196
+ </collection-browser>`
197
+ );
198
+
199
+ el.baseQuery = 'collection:foo';
200
+ await el.updateComplete;
201
+
202
+ expect(searchService.searchParams?.query).to.equal('collection:foo');
203
+ expect(searchService.searchType).to.equal(SearchType.METADATA);
204
+ expect(
205
+ el.shadowRoot?.querySelector('#big-results-label')?.textContent
206
+ ).to.contains('Results');
207
+ });
208
+
209
+ it('queries the search service with a fulltext search', async () => {
210
+ const searchService = new MockSearchService();
211
+
212
+ const el = await fixture<CollectionBrowser>(
213
+ html` <collection-browser
214
+ .searchService=${searchService}
215
+ .searchType=${SearchType.FULLTEXT}
216
+ >
217
+ </collection-browser>`
218
+ );
219
+
220
+ el.baseQuery = 'collection:foo';
221
+ await el.updateComplete;
222
+
223
+ expect(searchService.searchParams?.query).to.equal('collection:foo');
224
+ expect(searchService.searchType).to.equal(SearchType.FULLTEXT);
225
+ expect(
226
+ el.shadowRoot?.querySelector('#big-results-label')?.textContent
227
+ ).to.contains('Results');
228
+ });
229
+
230
+ it('queries for collection names after a fetch', async () => {
231
+ const searchService = new MockSearchService();
232
+ const collectionNameCache = new MockCollectionNameCache();
233
+
234
+ const el = await fixture<CollectionBrowser>(
235
+ html`<collection-browser
236
+ .searchService=${searchService}
237
+ .collectionNameCache=${collectionNameCache}
238
+ >
239
+ </collection-browser>`
240
+ );
241
+
242
+ el.baseQuery = 'blahblah';
243
+ await el.updateComplete;
244
+
245
+ expect(collectionNameCache.preloadIdentifiersRequested).to.deep.equal([
246
+ 'foo',
247
+ 'bar',
248
+ 'baz',
249
+ 'boop',
250
+ ]);
251
+ });
252
+
253
+ it('keeps search results from fetch if no change to query or sort param', async () => {
254
+ const resultsSpy = sinon.spy();
255
+ const searchService = new MockSearchService({
256
+ asyncResponse: true,
257
+ resultsSpy,
258
+ });
259
+
260
+ const el = await fixture<CollectionBrowser>(
261
+ html`<collection-browser .searchService=${searchService}>
262
+ </collection-browser>`
263
+ );
264
+
265
+ el.baseQuery = 'with-sort';
266
+ el.sortParam = { field: 'foo', direction: 'asc' };
267
+ await el.updateComplete;
268
+
269
+ await el.fetchPage(2);
270
+
271
+ // If there is no change to the query or sort param during the fetch, the results
272
+ // should be read.
273
+ expect(resultsSpy.callCount).to.be.greaterThanOrEqual(1);
274
+ });
275
+
276
+ it('discards obsolete search results if sort params changed before arrival', async () => {
277
+ const resultsSpy = sinon.spy();
278
+ const searchService = new MockSearchService({
279
+ asyncResponse: true,
280
+ resultsSpy,
281
+ });
282
+
283
+ const el = await fixture<CollectionBrowser>(
284
+ html`<collection-browser .searchService=${searchService}>
285
+ </collection-browser>`
286
+ );
287
+
288
+ el.baseQuery = 'with-sort';
289
+ el.sortParam = { field: 'foo', direction: 'asc' };
290
+ await el.updateComplete;
291
+
292
+ const fetchPromise = el.fetchPage(2);
293
+ el.sortParam = { field: 'foo', direction: 'desc' };
294
+ await fetchPromise;
295
+
296
+ // If the different sort param causes the results to be discarded,
297
+ // the results array should never be read.
298
+ expect(resultsSpy.callCount).to.equal(0);
299
+ });
300
+
301
+ it('discards obsolete search results if sort param added before arrival', async () => {
302
+ const resultsSpy = sinon.spy();
303
+ const searchService = new MockSearchService({
304
+ asyncResponse: true,
305
+ resultsSpy,
306
+ });
307
+
308
+ const el = await fixture<CollectionBrowser>(
309
+ html`<collection-browser .searchService=${searchService}>
310
+ </collection-browser>`
311
+ );
312
+
313
+ el.baseQuery = 'single-result';
314
+ await el.updateComplete;
315
+
316
+ const fetchPromise = el.fetchPage(2);
317
+ el.sortParam = { field: 'foo', direction: 'asc' };
318
+ await fetchPromise;
319
+
320
+ // If the different sort param causes the results to be discarded,
321
+ // the results array should never be read.
322
+ expect(resultsSpy.callCount).to.equal(0);
323
+ });
324
+
325
+ it('discards obsolete search results if sort param cleared before arrival', async () => {
326
+ const resultsSpy = sinon.spy();
327
+ const searchService = new MockSearchService({
328
+ asyncResponse: true,
329
+ resultsSpy,
330
+ });
331
+
332
+ const el = await fixture<CollectionBrowser>(
333
+ html`<collection-browser .searchService=${searchService}>
334
+ </collection-browser>`
335
+ );
336
+
337
+ el.baseQuery = 'with-sort';
338
+ await el.updateComplete;
339
+
340
+ const fetchPromise = el.fetchPage(2);
341
+ el.sortParam = null;
342
+ await fetchPromise;
343
+
344
+ // If the different sort param causes the results to be discarded,
345
+ // the results array should never be read.
346
+ expect(resultsSpy.callCount).to.equal(0);
347
+ });
348
+
349
+ it('sets sort properties when user changes sort', async () => {
350
+ const el = await fixture<CollectionBrowser>(
351
+ html`<collection-browser></collection-browser>`
352
+ );
353
+
354
+ expect(el.selectedSort).to.equal(SortField.relevance);
355
+
356
+ el.baseQuery = 'foo';
357
+ await el.updateComplete;
358
+
359
+ const sortBar = el.shadowRoot?.querySelector('sort-filter-bar');
360
+ const sortSelector = sortBar?.shadowRoot?.querySelector(
361
+ '#desktop-sort-selector'
362
+ );
363
+ expect(sortSelector).to.exist;
364
+
365
+ // Click the title sorter
366
+ [...(sortSelector?.children as HTMLCollection & Iterable<any>)] // tsc doesn't know children is iterable
367
+ .find(child => child.textContent?.trim() === 'Title')
368
+ ?.querySelector('a[href]')
369
+ ?.click();
370
+
371
+ await el.updateComplete;
372
+
373
+ expect(el.selectedSort).to.equal(SortField.title);
374
+ });
375
+
376
+ it('scrolls to page', async () => {
377
+ const el = await fixture<CollectionBrowser>(
378
+ html`<collection-browser></collection-browser>`
379
+ );
380
+
381
+ const infiniteScroller = el.shadowRoot?.querySelector(
382
+ 'infinite-scroller'
383
+ ) as InfiniteScroller;
384
+ expect(infiniteScroller).to.exist;
385
+
386
+ const oldScrollToCell = infiniteScroller.scrollToCell;
387
+ const spy = sinon.spy();
388
+ infiniteScroller.scrollToCell = spy;
389
+
390
+ el.goToPage(1);
391
+
392
+ // Give it a second to scroll
393
+ await new Promise(res => {
394
+ setTimeout(res, 1000);
395
+ });
396
+
397
+ expect(spy.callCount).to.equal(1);
398
+
399
+ infiniteScroller.scrollToCell = oldScrollToCell;
400
+ });
401
+
402
+ it('refreshes when certain properties change - with some analytics event sampling', async () => {
403
+ const mockAnalyticsHandler = new MockAnalyticsHandler();
404
+ const searchService = new MockSearchService();
405
+ const collectionNameCache = new MockCollectionNameCache();
406
+ const el = await fixture<CollectionBrowser>(
407
+ html`<collection-browser
408
+ .analyticsHandler=${mockAnalyticsHandler}
409
+ .searchService=${searchService}
410
+ .collectionNameCache=${collectionNameCache}
411
+ ></collection-browser>`
412
+ );
413
+ const infiniteScrollerRefreshSpy = sinon.spy();
414
+
415
+ const infiniteScroller = el.shadowRoot?.querySelector('infinite-scroller');
416
+ (infiniteScroller as InfiniteScroller).reload = infiniteScrollerRefreshSpy;
417
+ expect(infiniteScrollerRefreshSpy.called).to.be.false;
418
+ expect(infiniteScrollerRefreshSpy.callCount).to.equal(0);
419
+
420
+ // testing: `loggedIn`
421
+ el.loggedIn = true;
422
+ await el.updateComplete;
423
+ expect(infiniteScrollerRefreshSpy.called).to.be.true;
424
+ expect(infiniteScrollerRefreshSpy.callCount).to.equal(1);
425
+
426
+ el.loggedIn = false;
427
+ await el.updateComplete;
428
+ expect(infiniteScrollerRefreshSpy.callCount).to.equal(2);
429
+
430
+ // testing: `displayMode`
431
+ el.displayMode = 'list-compact';
432
+ el.searchContext = 'beta-search';
433
+ await el.updateComplete;
434
+ expect(infiniteScrollerRefreshSpy.callCount).to.equal(3);
435
+
436
+ expect(mockAnalyticsHandler.callCategory).to.equal('beta-search');
437
+ expect(mockAnalyticsHandler.callAction).to.equal('displayMode');
438
+ expect(mockAnalyticsHandler.callLabel).to.equal('list-compact');
439
+
440
+ el.displayMode = 'list-detail';
441
+ await el.updateComplete;
442
+ expect(infiniteScrollerRefreshSpy.callCount).to.equal(4);
443
+
444
+ expect(mockAnalyticsHandler.callCategory).to.equal('beta-search');
445
+ expect(mockAnalyticsHandler.callAction).to.equal('displayMode');
446
+ expect(mockAnalyticsHandler.callLabel).to.equal('list-detail');
447
+
448
+ // testing: `baseNavigationUrl`
449
+ el.baseNavigationUrl = 'https://funtestsite.com';
450
+ await el.updateComplete;
451
+ expect(infiniteScrollerRefreshSpy.callCount).to.equal(5);
452
+
453
+ // testing: `baseImageUrl`
454
+ el.baseImageUrl = 'https://funtestsiteforimages.com';
455
+ await el.updateComplete;
456
+ expect(infiniteScrollerRefreshSpy.callCount).to.equal(6);
457
+ });
458
+
459
+ it('query the search service for single result', async () => {
460
+ const searchService = new MockSearchService();
461
+
462
+ const el = await fixture<CollectionBrowser>(
463
+ html`<collection-browser .searchService=${searchService}>
464
+ </collection-browser>`
465
+ );
466
+
467
+ el.baseQuery = 'single-result';
468
+ await el.updateComplete;
469
+
470
+ expect(
471
+ el.shadowRoot?.querySelector('#big-results-label')?.textContent
472
+ ).to.contains('Result');
473
+ });
474
+
475
+ it('`searchContext` prop helps describe where component is being used', async () => {
476
+ const el = await fixture<CollectionBrowser>(
477
+ html`<collection-browser></collection-browser>`
478
+ );
479
+
480
+ expect(el.searchContext).to.equal(analyticsCategories.default);
481
+
482
+ el.searchContext = 'unicorn-search';
483
+ await el.updateComplete;
484
+
485
+ expect(el.searchContext).to.equal('unicorn-search');
486
+
487
+ // property is reflected as attribute
488
+ expect(el.getAttribute('searchcontext')).to.equal('unicorn-search');
489
+ });
490
+ });