@internetarchive/collection-browser 4.1.2 → 4.1.3-alpha-webdev8257.0

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 (43) hide show
  1. package/dist/index.d.ts +1 -0
  2. package/dist/index.js.map +1 -1
  3. package/dist/src/app-root.d.ts +8 -0
  4. package/dist/src/app-root.js +31 -0
  5. package/dist/src/app-root.js.map +1 -1
  6. package/dist/src/collection-browser.d.ts +3 -0
  7. package/dist/src/collection-browser.js +12 -3
  8. package/dist/src/collection-browser.js.map +1 -1
  9. package/dist/src/data-source/collection-browser-data-source.js +3 -2
  10. package/dist/src/data-source/collection-browser-data-source.js.map +1 -1
  11. package/dist/src/models.js +1 -0
  12. package/dist/src/models.js.map +1 -1
  13. package/dist/src/tiles/hover/hover-pane-controller.js +28 -28
  14. package/dist/src/tiles/hover/hover-pane-controller.js.map +1 -1
  15. package/dist/src/tiles/models.d.ts +14 -0
  16. package/dist/src/tiles/models.js.map +1 -1
  17. package/dist/src/tiles/tile-dispatcher.d.ts +12 -1
  18. package/dist/src/tiles/tile-dispatcher.js +330 -216
  19. package/dist/src/tiles/tile-dispatcher.js.map +1 -1
  20. package/dist/src/tiles/tile-display-value-provider.js.map +1 -1
  21. package/dist/test/mocks/mock-search-responses.js.map +1 -1
  22. package/dist/test/tiles/grid/item-tile.test.js +77 -77
  23. package/dist/test/tiles/grid/item-tile.test.js.map +1 -1
  24. package/dist/test/tiles/list/tile-list.test.js +126 -126
  25. package/dist/test/tiles/list/tile-list.test.js.map +1 -1
  26. package/dist/test/tiles/tile-dispatcher.test.js +87 -87
  27. package/dist/test/tiles/tile-dispatcher.test.js.map +1 -1
  28. package/dist/test/tiles/tile-display-value-provider.test.js.map +1 -1
  29. package/index.ts +1 -0
  30. package/package.json +2 -2
  31. package/src/app-root.ts +35 -0
  32. package/src/collection-browser.ts +13 -3
  33. package/src/data-source/collection-browser-data-source.ts +3 -2
  34. package/src/models.ts +1 -0
  35. package/src/tiles/hover/hover-pane-controller.ts +628 -628
  36. package/src/tiles/models.ts +16 -0
  37. package/src/tiles/tile-dispatcher.ts +649 -527
  38. package/src/tiles/tile-display-value-provider.ts +124 -124
  39. package/test/mocks/mock-search-responses.ts +1364 -1364
  40. package/test/tiles/grid/item-tile.test.ts +520 -520
  41. package/test/tiles/list/tile-list.test.ts +552 -552
  42. package/test/tiles/tile-dispatcher.test.ts +300 -300
  43. package/test/tiles/tile-display-value-provider.test.ts +172 -172
@@ -1,124 +1,124 @@
1
- import { TemplateResult, html, nothing } from 'lit';
2
- import { msg, str } from '@lit/localize';
3
- import type { SortParam } from '@internetarchive/search-service';
4
- import type { TileModel } from '../models';
5
- import { formatDate } from '../utils/format-date';
6
-
7
- /**
8
- * A class encapsulating shared logic for converting model values into display values
9
- * across different types of tiles.
10
- */
11
- export class TileDisplayValueProvider {
12
- private model?: TileModel;
13
-
14
- private baseNavigationUrl?: string;
15
-
16
- private collectionPagePath?: string;
17
-
18
- private sortParam?: SortParam;
19
-
20
- private creatorFilter?: string;
21
-
22
- constructor(
23
- options: {
24
- model?: TileModel;
25
- baseNavigationUrl?: string;
26
- collectionPagePath?: string;
27
- sortParam?: SortParam;
28
- creatorFilter?: string;
29
- } = {},
30
- ) {
31
- this.model = options.model;
32
- this.baseNavigationUrl = options.baseNavigationUrl;
33
- this.collectionPagePath = options.collectionPagePath ?? '/details/';
34
- this.sortParam = options.sortParam;
35
- this.creatorFilter = options.creatorFilter;
36
- }
37
-
38
- /**
39
- * Examines the creator(s) for the given tile model, returning
40
- * the first creator whose name matches the provided filter
41
- * (or simply the first creator overall if no filter is provided).
42
- */
43
- get firstCreatorMatchingFilter(): string | undefined {
44
- let matchingCreator;
45
-
46
- // If we're filtering by creator initial and have multiple creators, we want
47
- // to surface the first creator who matches the filter.
48
- if (this.creatorFilter && this.model?.creators.length) {
49
- const firstLetter = this.creatorFilter; // This is just to satisfy tsc
50
- matchingCreator = this.model.creators.find(creator =>
51
- // Decompose combining characters first, so that e.g., filtering on E matches É too.
52
- // Then remove anything that isn't strictly alphabetic, since our filters currently
53
- // only handle A-Z. The first such letter (if one exists) is what needs to match.
54
- creator
55
- .normalize('NFD')
56
- .replace(/[^A-Z]+/gi, '')
57
- .toUpperCase()
58
- .startsWith(firstLetter),
59
- );
60
- }
61
-
62
- return matchingCreator ?? this.model?.creator;
63
- }
64
-
65
- /**
66
- * The label indicating what year an account item was created.
67
- * E.g., "Archivist since 2015"
68
- */
69
- get accountLabel(): string {
70
- return this.model?.dateAdded
71
- ? msg(str`Archivist since ${this.model.dateAdded.getFullYear()}`)
72
- : '';
73
- }
74
-
75
- /**
76
- * The readable label for the current sort if it is a type of date sort,
77
- * or the empty string otherwise.
78
- */
79
- get dateLabel(): string {
80
- switch (this.sortParam?.field) {
81
- case 'publicdate':
82
- return msg('Archived');
83
- case 'reviewdate':
84
- return msg('Reviewed');
85
- case 'addeddate':
86
- return msg('Added');
87
- case 'date':
88
- return msg('Published');
89
- default:
90
- return '';
91
- }
92
- }
93
-
94
- /**
95
- * Produces a URL pointing at the item page for the given identifier,
96
- * using the current base URL and the correct path based on whether the
97
- * item is specified to be a collection (default false).
98
- */
99
- itemPageUrl(
100
- identifier?: string,
101
- isCollection = false,
102
- ): string | typeof nothing {
103
- if (!identifier || this.baseNavigationUrl == null) return nothing;
104
- const basePath = isCollection ? this.collectionPagePath : '/details/';
105
- return `${this.baseNavigationUrl}${basePath}${identifier}`;
106
- }
107
-
108
- /**
109
- * Produces a template for a link to a single web capture of the given URL and date
110
- */
111
- webArchivesCaptureLink(url: string, date: Date): TemplateResult {
112
- // Convert the date into the format used to identify wayback captures (e.g., '20150102124550')
113
- const captureDateStr = date
114
- .toISOString()
115
- .replace(/[TZ:-]/g, '')
116
- .replace(/\..*/, '');
117
- const captureHref = `https://web.archive.org/web/${captureDateStr}/${encodeURIComponent(
118
- url,
119
- )}`;
120
- const captureText = formatDate(date, 'long');
121
-
122
- return html` <a href=${captureHref}> ${captureText} </a> `;
123
- }
124
- }
1
+ import { TemplateResult, html, nothing } from 'lit';
2
+ import { msg, str } from '@lit/localize';
3
+ import type { SortParam } from '@internetarchive/search-service';
4
+ import type { TileModel } from '../models';
5
+ import { formatDate } from '../utils/format-date';
6
+
7
+ /**
8
+ * A class encapsulating shared logic for converting model values into display values
9
+ * across different types of tiles.
10
+ */
11
+ export class TileDisplayValueProvider {
12
+ private model?: TileModel;
13
+
14
+ private baseNavigationUrl?: string;
15
+
16
+ private collectionPagePath?: string;
17
+
18
+ private sortParam?: SortParam;
19
+
20
+ private creatorFilter?: string;
21
+
22
+ constructor(
23
+ options: {
24
+ model?: TileModel;
25
+ baseNavigationUrl?: string;
26
+ collectionPagePath?: string;
27
+ sortParam?: SortParam;
28
+ creatorFilter?: string;
29
+ } = {},
30
+ ) {
31
+ this.model = options.model;
32
+ this.baseNavigationUrl = options.baseNavigationUrl;
33
+ this.collectionPagePath = options.collectionPagePath ?? '/details/';
34
+ this.sortParam = options.sortParam;
35
+ this.creatorFilter = options.creatorFilter;
36
+ }
37
+
38
+ /**
39
+ * Examines the creator(s) for the given tile model, returning
40
+ * the first creator whose name matches the provided filter
41
+ * (or simply the first creator overall if no filter is provided).
42
+ */
43
+ get firstCreatorMatchingFilter(): string | undefined {
44
+ let matchingCreator;
45
+
46
+ // If we're filtering by creator initial and have multiple creators, we want
47
+ // to surface the first creator who matches the filter.
48
+ if (this.creatorFilter && this.model?.creators.length) {
49
+ const firstLetter = this.creatorFilter; // This is just to satisfy tsc
50
+ matchingCreator = this.model.creators.find(creator =>
51
+ // Decompose combining characters first, so that e.g., filtering on E matches É too.
52
+ // Then remove anything that isn't strictly alphabetic, since our filters currently
53
+ // only handle A-Z. The first such letter (if one exists) is what needs to match.
54
+ creator
55
+ .normalize('NFD')
56
+ .replace(/[^A-Z]+/gi, '')
57
+ .toUpperCase()
58
+ .startsWith(firstLetter),
59
+ );
60
+ }
61
+
62
+ return matchingCreator ?? this.model?.creator;
63
+ }
64
+
65
+ /**
66
+ * The label indicating what year an account item was created.
67
+ * E.g., "Archivist since 2015"
68
+ */
69
+ get accountLabel(): string {
70
+ return this.model?.dateAdded
71
+ ? msg(str`Archivist since ${this.model.dateAdded.getFullYear()}`)
72
+ : '';
73
+ }
74
+
75
+ /**
76
+ * The readable label for the current sort if it is a type of date sort,
77
+ * or the empty string otherwise.
78
+ */
79
+ get dateLabel(): string {
80
+ switch (this.sortParam?.field) {
81
+ case 'publicdate':
82
+ return msg('Archived');
83
+ case 'reviewdate':
84
+ return msg('Reviewed');
85
+ case 'addeddate':
86
+ return msg('Added');
87
+ case 'date':
88
+ return msg('Published');
89
+ default:
90
+ return '';
91
+ }
92
+ }
93
+
94
+ /**
95
+ * Produces a URL pointing at the item page for the given identifier,
96
+ * using the current base URL and the correct path based on whether the
97
+ * item is specified to be a collection (default false).
98
+ */
99
+ itemPageUrl(
100
+ identifier?: string,
101
+ isCollection = false,
102
+ ): string | typeof nothing {
103
+ if (!identifier || this.baseNavigationUrl == null) return nothing;
104
+ const basePath = isCollection ? this.collectionPagePath : '/details/';
105
+ return `${this.baseNavigationUrl}${basePath}${identifier}`;
106
+ }
107
+
108
+ /**
109
+ * Produces a template for a link to a single web capture of the given URL and date
110
+ */
111
+ webArchivesCaptureLink(url: string, date: Date): TemplateResult {
112
+ // Convert the date into the format used to identify wayback captures (e.g., '20150102124550')
113
+ const captureDateStr = date
114
+ .toISOString()
115
+ .replace(/[TZ:-]/g, '')
116
+ .replace(/\..*/, '');
117
+ const captureHref = `https://web.archive.org/web/${captureDateStr}/${encodeURIComponent(
118
+ url,
119
+ )}`;
120
+ const captureText = formatDate(date, 'long');
121
+
122
+ return html` <a href=${captureHref}> ${captureText} </a> `;
123
+ }
124
+ }