@internetarchive/collection-browser 0.3.5-alpha.1 → 0.3.5

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 (236) 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 +47 -43
  12. package/dist/src/app-root.js +331 -285
  13. package/dist/src/app-root.js.map +1 -1
  14. package/dist/src/assets/img/icons/arrow-left.d.ts +2 -2
  15. package/dist/src/assets/img/icons/arrow-left.js +2 -2
  16. package/dist/src/assets/img/icons/arrow-right.d.ts +2 -2
  17. package/dist/src/assets/img/icons/arrow-right.js +2 -2
  18. package/dist/src/assets/img/icons/chevron.d.ts +2 -2
  19. package/dist/src/assets/img/icons/chevron.js +2 -2
  20. package/dist/src/assets/img/icons/empty-query.d.ts +2 -2
  21. package/dist/src/assets/img/icons/empty-query.js +2 -2
  22. package/dist/src/assets/img/icons/eye-closed.d.ts +2 -2
  23. package/dist/src/assets/img/icons/eye-closed.js +2 -2
  24. package/dist/src/assets/img/icons/eye.d.ts +2 -2
  25. package/dist/src/assets/img/icons/eye.js +2 -2
  26. package/dist/src/assets/img/icons/favorite-filled.d.ts +1 -1
  27. package/dist/src/assets/img/icons/favorite-filled.js +2 -2
  28. package/dist/src/assets/img/icons/login-required.d.ts +1 -1
  29. package/dist/src/assets/img/icons/login-required.js +2 -2
  30. package/dist/src/assets/img/icons/mediatype/account.d.ts +1 -1
  31. package/dist/src/assets/img/icons/mediatype/account.js +2 -2
  32. package/dist/src/assets/img/icons/mediatype/audio.d.ts +1 -1
  33. package/dist/src/assets/img/icons/mediatype/audio.js +2 -2
  34. package/dist/src/assets/img/icons/mediatype/collection.d.ts +1 -1
  35. package/dist/src/assets/img/icons/mediatype/collection.js +2 -2
  36. package/dist/src/assets/img/icons/mediatype/data.d.ts +1 -1
  37. package/dist/src/assets/img/icons/mediatype/data.js +2 -2
  38. package/dist/src/assets/img/icons/mediatype/etree.d.ts +1 -1
  39. package/dist/src/assets/img/icons/mediatype/etree.js +2 -2
  40. package/dist/src/assets/img/icons/mediatype/film.d.ts +1 -1
  41. package/dist/src/assets/img/icons/mediatype/film.js +2 -2
  42. package/dist/src/assets/img/icons/mediatype/images.d.ts +1 -1
  43. package/dist/src/assets/img/icons/mediatype/images.js +2 -2
  44. package/dist/src/assets/img/icons/mediatype/radio.d.ts +1 -1
  45. package/dist/src/assets/img/icons/mediatype/radio.js +2 -2
  46. package/dist/src/assets/img/icons/mediatype/software.d.ts +1 -1
  47. package/dist/src/assets/img/icons/mediatype/software.js +2 -2
  48. package/dist/src/assets/img/icons/mediatype/texts.d.ts +1 -1
  49. package/dist/src/assets/img/icons/mediatype/texts.js +2 -2
  50. package/dist/src/assets/img/icons/mediatype/tv.d.ts +1 -1
  51. package/dist/src/assets/img/icons/mediatype/tv.js +2 -2
  52. package/dist/src/assets/img/icons/mediatype/video.d.ts +1 -1
  53. package/dist/src/assets/img/icons/mediatype/video.js +2 -2
  54. package/dist/src/assets/img/icons/mediatype/web.d.ts +1 -1
  55. package/dist/src/assets/img/icons/mediatype/web.js +2 -2
  56. package/dist/src/assets/img/icons/null-result.d.ts +2 -2
  57. package/dist/src/assets/img/icons/null-result.js +2 -2
  58. package/dist/src/assets/img/icons/restricted.d.ts +1 -1
  59. package/dist/src/assets/img/icons/restricted.js +2 -2
  60. package/dist/src/assets/img/icons/reviews.d.ts +1 -1
  61. package/dist/src/assets/img/icons/reviews.js +2 -2
  62. package/dist/src/assets/img/icons/upload.d.ts +1 -1
  63. package/dist/src/assets/img/icons/upload.js +2 -2
  64. package/dist/src/assets/img/icons/views.d.ts +1 -1
  65. package/dist/src/assets/img/icons/views.js +2 -2
  66. package/dist/src/circular-activity-indicator.d.ts +5 -5
  67. package/dist/src/circular-activity-indicator.js +17 -17
  68. package/dist/src/collection-browser.d.ts +246 -245
  69. package/dist/src/collection-browser.js +1370 -1359
  70. package/dist/src/collection-browser.js.map +1 -1
  71. package/dist/src/collection-facets/facet-tombstone-row.d.ts +5 -5
  72. package/dist/src/collection-facets/facet-tombstone-row.js +42 -42
  73. package/dist/src/collection-facets/facet-tombstone-row.js.map +1 -1
  74. package/dist/src/collection-facets/facets-template.d.ts +16 -16
  75. package/dist/src/collection-facets/facets-template.js +130 -128
  76. package/dist/src/collection-facets/facets-template.js.map +1 -1
  77. package/dist/src/collection-facets/more-facets-content.d.ts +76 -76
  78. package/dist/src/collection-facets/more-facets-content.js +353 -353
  79. package/dist/src/collection-facets/more-facets-pagination.d.ts +36 -36
  80. package/dist/src/collection-facets/more-facets-pagination.js +192 -192
  81. package/dist/src/collection-facets.d.ts +77 -77
  82. package/dist/src/collection-facets.js +551 -551
  83. package/dist/src/collection-facets.js.map +1 -1
  84. package/dist/src/empty-placeholder.d.ts +11 -11
  85. package/dist/src/empty-placeholder.js +42 -42
  86. package/dist/src/language-code-handler/language-code-handler.d.ts +37 -37
  87. package/dist/src/language-code-handler/language-code-handler.js +26 -26
  88. package/dist/src/language-code-handler/language-code-mapping.d.ts +1 -1
  89. package/dist/src/language-code-handler/language-code-mapping.js +562 -562
  90. package/dist/src/mediatype/mediatype-config.d.ts +3 -3
  91. package/dist/src/mediatype/mediatype-config.js +85 -85
  92. package/dist/src/models.d.ts +103 -102
  93. package/dist/src/models.js +117 -117
  94. package/dist/src/models.js.map +1 -1
  95. package/dist/src/restoration-state-handler.d.ts +46 -45
  96. package/dist/src/restoration-state-handler.js +230 -220
  97. package/dist/src/restoration-state-handler.js.map +1 -1
  98. package/dist/src/sort-filter-bar/alpha-bar.d.ts +9 -9
  99. package/dist/src/sort-filter-bar/alpha-bar.js +41 -41
  100. package/dist/src/sort-filter-bar/img/compact.d.ts +1 -1
  101. package/dist/src/sort-filter-bar/img/compact.js +2 -2
  102. package/dist/src/sort-filter-bar/img/list.d.ts +1 -1
  103. package/dist/src/sort-filter-bar/img/list.js +2 -2
  104. package/dist/src/sort-filter-bar/img/sort-triangle.d.ts +1 -1
  105. package/dist/src/sort-filter-bar/img/sort-triangle.js +2 -2
  106. package/dist/src/sort-filter-bar/img/tile.d.ts +1 -1
  107. package/dist/src/sort-filter-bar/img/tile.js +2 -2
  108. package/dist/src/sort-filter-bar/sort-filter-bar.d.ts +107 -107
  109. package/dist/src/sort-filter-bar/sort-filter-bar.js +423 -423
  110. package/dist/src/styles/item-image-styles.d.ts +8 -8
  111. package/dist/src/styles/item-image-styles.js +9 -9
  112. package/dist/src/tiles/collection-browser-loading-tile.d.ts +5 -5
  113. package/dist/src/tiles/collection-browser-loading-tile.js +15 -15
  114. package/dist/src/tiles/grid/account-tile.d.ts +8 -8
  115. package/dist/src/tiles/grid/account-tile.js +20 -20
  116. package/dist/src/tiles/grid/collection-tile.d.ts +7 -7
  117. package/dist/src/tiles/grid/collection-tile.js +23 -23
  118. package/dist/src/tiles/grid/item-tile.d.ts +24 -24
  119. package/dist/src/tiles/grid/item-tile.js +87 -87
  120. package/dist/src/tiles/grid/tile-stats.d.ts +10 -10
  121. package/dist/src/tiles/grid/tile-stats.js +46 -40
  122. package/dist/src/tiles/grid/tile-stats.js.map +1 -1
  123. package/dist/src/tiles/image-block.d.ts +17 -17
  124. package/dist/src/tiles/image-block.js +69 -69
  125. package/dist/src/tiles/item-image.d.ts +31 -31
  126. package/dist/src/tiles/item-image.js +103 -103
  127. package/dist/src/tiles/list/account-label.d.ts +1 -1
  128. package/dist/src/tiles/list/account-label.js +6 -6
  129. package/dist/src/tiles/list/date-label.d.ts +1 -1
  130. package/dist/src/tiles/list/date-label.js +12 -12
  131. package/dist/src/tiles/list/tile-list-compact-header.d.ts +12 -12
  132. package/dist/src/tiles/list/tile-list-compact-header.js +41 -41
  133. package/dist/src/tiles/list/tile-list-compact.d.ts +21 -20
  134. package/dist/src/tiles/list/tile-list-compact.js +94 -90
  135. package/dist/src/tiles/list/tile-list-compact.js.map +1 -1
  136. package/dist/src/tiles/list/tile-list.d.ts +50 -50
  137. package/dist/src/tiles/list/tile-list.js +271 -268
  138. package/dist/src/tiles/list/tile-list.js.map +1 -1
  139. package/dist/src/tiles/mediatype-icon.d.ts +9 -9
  140. package/dist/src/tiles/mediatype-icon.js +49 -47
  141. package/dist/src/tiles/mediatype-icon.js.map +1 -1
  142. package/dist/src/tiles/overlay/icon-overlay.d.ts +7 -7
  143. package/dist/src/tiles/overlay/icon-overlay.js +30 -30
  144. package/dist/src/tiles/overlay/text-overlay.d.ts +8 -8
  145. package/dist/src/tiles/overlay/text-overlay.js +31 -31
  146. package/dist/src/tiles/text-snippet-block.d.ts +29 -29
  147. package/dist/src/tiles/text-snippet-block.js +81 -81
  148. package/dist/src/tiles/tile-dispatcher.d.ts +36 -36
  149. package/dist/src/tiles/tile-dispatcher.js +128 -128
  150. package/dist/src/utils/analytics-events.d.ts +22 -22
  151. package/dist/src/utils/analytics-events.js +24 -24
  152. package/dist/src/utils/format-count.d.ts +7 -7
  153. package/dist/src/utils/format-count.js +76 -76
  154. package/dist/src/utils/format-date.d.ts +2 -2
  155. package/dist/src/utils/format-date.js +23 -23
  156. package/dist/test/collection-browser.test.d.ts +1 -1
  157. package/dist/test/collection-browser.test.js +481 -415
  158. package/dist/test/collection-browser.test.js.map +1 -1
  159. package/dist/test/collection-facets/facets-template.test.d.ts +1 -1
  160. package/dist/test/collection-facets/facets-template.test.js +62 -62
  161. package/dist/test/collection-facets/facets-template.test.js.map +1 -1
  162. package/dist/test/collection-facets/more-facets-content.test.d.ts +1 -1
  163. package/dist/test/collection-facets/more-facets-content.test.js +114 -114
  164. package/dist/test/collection-facets/more-facets-pagination.test.d.ts +1 -1
  165. package/dist/test/collection-facets/more-facets-pagination.test.js +117 -117
  166. package/dist/test/collection-facets.test.d.ts +2 -2
  167. package/dist/test/collection-facets.test.js +498 -498
  168. package/dist/test/empty-placeholder.test.d.ts +1 -1
  169. package/dist/test/empty-placeholder.test.js +33 -33
  170. package/dist/test/icon-overlay.test.d.ts +1 -1
  171. package/dist/test/icon-overlay.test.js +24 -24
  172. package/dist/test/image-block.test.d.ts +1 -1
  173. package/dist/test/image-block.test.js +48 -48
  174. package/dist/test/item-image.test.d.ts +1 -1
  175. package/dist/test/item-image.test.js +56 -56
  176. package/dist/test/mediatype-config.test.d.ts +1 -1
  177. package/dist/test/mediatype-config.test.js +16 -16
  178. package/dist/test/mocks/mock-analytics-handler.d.ts +10 -10
  179. package/dist/test/mocks/mock-analytics-handler.js +15 -15
  180. package/dist/test/mocks/mock-collection-name-cache.d.ts +7 -7
  181. package/dist/test/mocks/mock-collection-name-cache.js +13 -13
  182. package/dist/test/mocks/mock-search-responses.d.ts +8 -8
  183. package/dist/test/mocks/mock-search-responses.js +198 -198
  184. package/dist/test/mocks/mock-search-responses.js.map +1 -1
  185. package/dist/test/mocks/mock-search-service.d.ts +13 -13
  186. package/dist/test/mocks/mock-search-service.js +32 -32
  187. package/dist/test/mocks/mock-search-service.js.map +1 -1
  188. package/dist/test/restoration-state-handler.test.d.ts +1 -1
  189. package/dist/test/restoration-state-handler.test.js +126 -117
  190. package/dist/test/restoration-state-handler.test.js.map +1 -1
  191. package/dist/test/sort-filter-bar/sort-filter-bar.test.d.ts +1 -1
  192. package/dist/test/sort-filter-bar/sort-filter-bar.test.js +113 -113
  193. package/dist/test/text-overlay.test.d.ts +1 -1
  194. package/dist/test/text-overlay.test.js +41 -41
  195. package/dist/test/text-snippet-block.test.d.ts +1 -1
  196. package/dist/test/text-snippet-block.test.js +57 -57
  197. package/dist/test/tile-stats.test.d.ts +1 -1
  198. package/dist/test/tile-stats.test.js +33 -33
  199. package/dist/test/tiles/grid/item-tile.test.d.ts +1 -1
  200. package/dist/test/tiles/grid/item-tile.test.js +107 -107
  201. package/dist/test/tiles/list/tile-list-compact.test.d.ts +1 -1
  202. package/dist/test/tiles/list/tile-list-compact.test.js +125 -26
  203. package/dist/test/tiles/list/tile-list-compact.test.js.map +1 -1
  204. package/dist/test/tiles/list/tile-list.test.d.ts +1 -1
  205. package/dist/test/tiles/list/tile-list.test.js +79 -47
  206. package/dist/test/tiles/list/tile-list.test.js.map +1 -1
  207. package/dist/test/utils/format-count.test.d.ts +1 -1
  208. package/dist/test/utils/format-count.test.js +23 -23
  209. package/dist/test/utils/format-date.test.d.ts +1 -1
  210. package/dist/test/utils/format-date.test.js +17 -17
  211. package/index.html +24 -24
  212. package/local.archive.org.cert +86 -86
  213. package/local.archive.org.key +27 -27
  214. package/package.json +115 -115
  215. package/renovate.json +6 -6
  216. package/src/app-root.ts +104 -55
  217. package/src/collection-browser.ts +1503 -1488
  218. package/src/collection-facets/facet-tombstone-row.ts +40 -40
  219. package/src/collection-facets/facets-template.ts +5 -3
  220. package/src/collection-facets.ts +635 -635
  221. package/src/models.ts +1 -0
  222. package/src/restoration-state-handler.ts +19 -1
  223. package/src/tiles/grid/tile-stats.ts +18 -5
  224. package/src/tiles/list/tile-list-compact.ts +7 -3
  225. package/src/tiles/list/tile-list.ts +6 -1
  226. package/src/tiles/mediatype-icon.ts +2 -0
  227. package/test/collection-browser.test.ts +679 -599
  228. package/test/collection-facets/facets-template.test.ts +5 -3
  229. package/test/mocks/mock-search-responses.ts +226 -226
  230. package/test/mocks/mock-search-service.ts +61 -61
  231. package/test/restoration-state-handler.test.ts +12 -0
  232. package/test/tiles/list/tile-list-compact.test.ts +110 -0
  233. package/test/tiles/list/tile-list.test.ts +36 -0
  234. package/tsconfig.json +21 -21
  235. package/web-dev-server.config.mjs +30 -30
  236. package/web-test-runner.config.mjs +41 -41
@@ -1 +1 @@
1
- {"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AA6CA;;GAEG;AACH,MAAM,CAAN,IAAY,SAUX;AAVD,WAAY,SAAS;IACnB,oCAAyB,CAAA;IACzB,wCAA6B,CAAA;IAC7B,sCAA2B,CAAA;IAC3B,4BAAiB,CAAA;IACjB,0CAA+B,CAAA;IAC/B,0BAAe,CAAA;IACf,0CAA+B,CAAA;IAC/B,oCAAyB,CAAA;IACzB,gCAAqB,CAAA;AACvB,CAAC,EAVW,SAAS,KAAT,SAAS,QAUpB;AAeD,MAAM,CAAC,MAAM,oBAAoB,GAE7B;IACF,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,gBAAgB;IAC7B,UAAU,EAAE,cAAc;IAC1B,KAAK,EAAE,OAAO;IACd,YAAY,EAAE,eAAe;IAC7B,IAAI,EAAE,gBAAgB;IACtB,YAAY,EAAE,eAAe;IAC7B,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,SAAS;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,MAAM;IAClB,KAAK,EAAE,aAAa;IACpB,YAAY,EAAE,YAAY;IAC1B,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,YAAY;IAC1B,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,eAAe;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,IAAI,EAAE,SAAS,CAAC,UAAU;IAC1B,SAAS,EAAE,SAAS,CAAC,WAAW;IAChC,WAAW,EAAE,SAAS,CAAC,KAAK;IAC5B,IAAI,EAAE,SAAS,CAAC,IAAI;IACpB,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,SAAS,EAAE,SAAS,CAAC,SAAS;IAC9B,aAAa,EAAE,SAAS,CAAC,OAAO;CACjC,CAAC;AAoCF,MAAM,CAAC,MAAM,qBAAqB,GAAmB;IACnD,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,EAAE;IACX,SAAS,EAAE,EAAE;IACb,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,EAAE;IACX,UAAU,EAAE,EAAE;IACd,IAAI,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAkB;IAC9C,WAAW;IACX,SAAS;IACT,MAAM;IACN,SAAS;IACT,YAAY;IACZ,SAAS;IACT,UAAU;CACX,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAgC;IACtD,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,cAAc;IACvB,SAAS,EAAE,YAAY;IACvB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;CACb,CAAC;AAWF;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAqC;IAC1E,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,KAAK;IACpB,mBAAmB,EAAE,IAAI;IACzB,YAAY,EAAE,KAAK;IACnB,mBAAmB,EAAE,KAAK;IAC1B,WAAW,EAAE,IAAI;IACjB,qBAAqB,EAAE,KAAK;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,WAAW,EAAE,iBAAiB;IAC9B,mBAAmB,EAAE,gBAAgB;IACrC,WAAW,EAAE,kBAAkB;CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAA4B;IAC5D,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;IAClB,eAAe,EAAE,IAAI;IACrB,aAAa,EAAE,IAAI;IACnB,gBAAgB,EAAE,IAAI;IACtB,wBAAwB,EAAE,IAAI;IAC9B,KAAK,EAAE,IAAI;IACX,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,IAAI;CACd,CAAC","sourcesContent":["import type { MediaType } from '@internetarchive/field-parsers';\n\nexport interface TileModel {\n averageRating?: number;\n collectionIdentifier?: string;\n collectionName?: string;\n collections: string[];\n commentCount: number;\n creator?: string;\n creators: string[];\n dateAdded?: Date; // Date added to public search (software-defined) [from: addeddate]\n dateArchived?: Date; // Date archived (software-defined) item created on archive.org [from: publicdate]\n datePublished?: Date; // Date work published in the world (user-defined) [from: date]\n dateReviewed?: Date; // Date reviewed (user-created) most recent review [from: reviewdate]\n description?: string;\n favCount: number;\n identifier: string;\n issue?: string;\n itemCount: number;\n mediatype: MediaType;\n source?: string;\n snippets?: string[];\n subjects: string[];\n title: string;\n viewCount: number;\n volume?: string;\n loginRequired: boolean;\n contentWarning: boolean;\n}\n\nexport type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';\n\nexport type TileDisplayMode =\n | 'grid'\n | 'list-compact'\n | 'list-detail'\n | 'list-header';\n\n/**\n * This is mainly used to set the cookies for the collection display mode.\n *\n * It allows the user to set different modes for different contexts (collection page, search page, etc).\n */\nexport type CollectionBrowserContext = 'collection' | 'search';\n\n/**\n * The sort fields shown in the sort filter bar\n */\nexport enum SortField {\n 'relevance' = 'relevance',\n 'alltimeview' = 'alltimeview',\n 'weeklyview' = 'weeklyview',\n 'title' = 'title',\n 'datearchived' = 'datearchived',\n 'date' = 'date',\n 'datereviewed' = 'datereviewed',\n 'dateadded' = 'dateadded',\n 'creator' = 'creator',\n}\n\n/**\n * The metadata fields we sort by that map to the SortFields above\n */\nexport type MetadataSortField =\n | 'downloads'\n | 'week'\n | 'titleSorter'\n | 'date'\n | 'creatorSorter'\n | 'publicdate'\n | 'reviewdate'\n | 'addeddate';\n\nexport const SortFieldDisplayName: {\n [key in SortField]: string;\n} = {\n relevance: 'Relevance',\n alltimeview: 'All-time Views',\n weeklyview: 'Weekly Views',\n title: 'Title',\n datearchived: 'Date Archived',\n date: 'Date Published',\n datereviewed: 'Date Reviewed',\n dateadded: 'Date Added',\n creator: 'Creator',\n};\n\n/**\n * Maps the SortField above to the corresponding Metadata field in the API.\n */\nexport const SortFieldToMetadataField: {\n [key in SortField]: MetadataSortField | null;\n} = {\n relevance: null,\n alltimeview: 'downloads',\n weeklyview: 'week',\n title: 'titleSorter',\n datearchived: 'publicdate',\n date: 'date',\n datereviewed: 'reviewdate',\n dateadded: 'addeddate',\n creator: 'creatorSorter',\n};\n\n/**\n * Maps the Metadata field to the corresponding SortField field in the API.\n */\nexport const MetadataFieldToSortField: {\n [key in MetadataSortField]: SortField;\n} = {\n week: SortField.weeklyview,\n downloads: SortField.alltimeview,\n titleSorter: SortField.title,\n date: SortField.date,\n publicdate: SortField.datearchived,\n reviewdate: SortField.datereviewed,\n addeddate: SortField.dateadded,\n creatorSorter: SortField.creator,\n};\n\nexport type FacetOption =\n | 'subject'\n | 'lending'\n | 'mediatype'\n | 'language'\n | 'creator'\n | 'collection'\n | 'year';\n\nexport type SelectedFacetState = 'selected' | 'hidden';\n\nexport type FacetState = SelectedFacetState | 'none';\n\nexport interface FacetBucket {\n // for some facets, we augment the key with a display value\n displayText?: string;\n key: string;\n count: number;\n state: FacetState;\n}\n\nexport interface FacetGroup {\n title: string;\n key: FacetOption;\n buckets: FacetBucket[];\n}\n\nexport type FacetValue = string;\n\nexport type SelectedFacets = Record<\n FacetOption,\n Record<FacetValue, FacetBucket>\n>;\n\nexport const defaultSelectedFacets: SelectedFacets = {\n subject: {},\n lending: {},\n mediatype: {},\n language: {},\n creator: {},\n collection: {},\n year: {},\n};\n\nexport const facetDisplayOrder: FacetOption[] = [\n 'mediatype',\n 'lending',\n 'year',\n 'subject',\n 'collection',\n 'creator',\n 'language',\n];\n\nexport const facetTitles: Record<FacetOption, string> = {\n subject: 'Subject',\n lending: 'Availability',\n mediatype: 'Media Type',\n language: 'Language',\n creator: 'Creator',\n collection: 'Collection',\n year: 'Year',\n};\n\nexport type LendingFacetKey =\n | 'is_lendable'\n | 'is_borrowable'\n | 'available_to_borrow'\n | 'is_browsable'\n | 'available_to_browse'\n | 'is_readable'\n | 'available_to_waitlist';\n\n/**\n * Maps valid lending keys to whether they should be visible in the facet sidebar\n */\nexport const lendingFacetKeysVisibility: Record<LendingFacetKey, boolean> = {\n is_lendable: true,\n is_borrowable: false,\n available_to_borrow: true,\n is_browsable: false,\n available_to_browse: false,\n is_readable: true,\n available_to_waitlist: false,\n};\n\n/**\n * Maps valid, visible lending keys to their facet sidebar display text\n */\nexport const lendingFacetDisplayNames: Partial<\n Record<LendingFacetKey, string>\n> = {\n is_lendable: 'Lending Library',\n available_to_borrow: 'Borrow 14 Days',\n is_readable: 'Always Available',\n};\n\n/**\n * A record of which admin-only collections should be suppressed from being displayed\n * as facets or in an item's list of collections.\n */\nexport const suppressedCollections: Record<string, boolean> = {\n deemphasize: true,\n community: true,\n stream_only: true,\n samples_only: true,\n test_collection: true,\n printdisabled: true,\n 'openlibrary-ol': true,\n nationalemergencylibrary: true,\n china: true,\n americana: true,\n toronto: true,\n};\n"]}
1
+ {"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AA8CA;;GAEG;AACH,MAAM,CAAN,IAAY,SAUX;AAVD,WAAY,SAAS;IACnB,oCAAyB,CAAA;IACzB,wCAA6B,CAAA;IAC7B,sCAA2B,CAAA;IAC3B,4BAAiB,CAAA;IACjB,0CAA+B,CAAA;IAC/B,0BAAe,CAAA;IACf,0CAA+B,CAAA;IAC/B,oCAAyB,CAAA;IACzB,gCAAqB,CAAA;AACvB,CAAC,EAVW,SAAS,KAAT,SAAS,QAUpB;AAeD,MAAM,CAAC,MAAM,oBAAoB,GAE7B;IACF,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,gBAAgB;IAC7B,UAAU,EAAE,cAAc;IAC1B,KAAK,EAAE,OAAO;IACd,YAAY,EAAE,eAAe;IAC7B,IAAI,EAAE,gBAAgB;IACtB,YAAY,EAAE,eAAe;IAC7B,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,SAAS;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,MAAM;IAClB,KAAK,EAAE,aAAa;IACpB,YAAY,EAAE,YAAY;IAC1B,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,YAAY;IAC1B,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,eAAe;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,IAAI,EAAE,SAAS,CAAC,UAAU;IAC1B,SAAS,EAAE,SAAS,CAAC,WAAW;IAChC,WAAW,EAAE,SAAS,CAAC,KAAK;IAC5B,IAAI,EAAE,SAAS,CAAC,IAAI;IACpB,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,UAAU,EAAE,SAAS,CAAC,YAAY;IAClC,SAAS,EAAE,SAAS,CAAC,SAAS;IAC9B,aAAa,EAAE,SAAS,CAAC,OAAO;CACjC,CAAC;AAoCF,MAAM,CAAC,MAAM,qBAAqB,GAAmB;IACnD,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,EAAE;IACX,SAAS,EAAE,EAAE;IACb,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,EAAE;IACX,UAAU,EAAE,EAAE;IACd,IAAI,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAkB;IAC9C,WAAW;IACX,SAAS;IACT,MAAM;IACN,SAAS;IACT,YAAY;IACZ,SAAS;IACT,UAAU;CACX,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAgC;IACtD,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,cAAc;IACvB,SAAS,EAAE,YAAY;IACvB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;CACb,CAAC;AAWF;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAqC;IAC1E,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,KAAK;IACpB,mBAAmB,EAAE,IAAI;IACzB,YAAY,EAAE,KAAK;IACnB,mBAAmB,EAAE,KAAK;IAC1B,WAAW,EAAE,IAAI;IACjB,qBAAqB,EAAE,KAAK;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAEjC;IACF,WAAW,EAAE,iBAAiB;IAC9B,mBAAmB,EAAE,gBAAgB;IACrC,WAAW,EAAE,kBAAkB;CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAA4B;IAC5D,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;IAClB,eAAe,EAAE,IAAI;IACrB,aAAa,EAAE,IAAI;IACnB,gBAAgB,EAAE,IAAI;IACtB,wBAAwB,EAAE,IAAI;IAC9B,KAAK,EAAE,IAAI;IACX,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,IAAI;CACd,CAAC","sourcesContent":["import type { MediaType } from '@internetarchive/field-parsers';\n\nexport interface TileModel {\n averageRating?: number;\n collectionIdentifier?: string;\n collectionName?: string;\n collections: string[];\n commentCount: number;\n creator?: string;\n creators: string[];\n dateAdded?: Date; // Date added to public search (software-defined) [from: addeddate]\n dateArchived?: Date; // Date archived (software-defined) item created on archive.org [from: publicdate]\n datePublished?: Date; // Date work published in the world (user-defined) [from: date]\n dateReviewed?: Date; // Date reviewed (user-created) most recent review [from: reviewdate]\n description?: string;\n favCount: number;\n identifier: string;\n issue?: string;\n itemCount: number;\n mediatype: MediaType;\n source?: string;\n snippets?: string[];\n subjects: string[];\n title: string;\n viewCount: number;\n volume?: string;\n weeklyViewCount?: number;\n loginRequired: boolean;\n contentWarning: boolean;\n}\n\nexport type CollectionDisplayMode = 'grid' | 'list-compact' | 'list-detail';\n\nexport type TileDisplayMode =\n | 'grid'\n | 'list-compact'\n | 'list-detail'\n | 'list-header';\n\n/**\n * This is mainly used to set the cookies for the collection display mode.\n *\n * It allows the user to set different modes for different contexts (collection page, search page, etc).\n */\nexport type CollectionBrowserContext = 'collection' | 'search';\n\n/**\n * The sort fields shown in the sort filter bar\n */\nexport enum SortField {\n 'relevance' = 'relevance',\n 'alltimeview' = 'alltimeview',\n 'weeklyview' = 'weeklyview',\n 'title' = 'title',\n 'datearchived' = 'datearchived',\n 'date' = 'date',\n 'datereviewed' = 'datereviewed',\n 'dateadded' = 'dateadded',\n 'creator' = 'creator',\n}\n\n/**\n * The metadata fields we sort by that map to the SortFields above\n */\nexport type MetadataSortField =\n | 'downloads'\n | 'week'\n | 'titleSorter'\n | 'date'\n | 'creatorSorter'\n | 'publicdate'\n | 'reviewdate'\n | 'addeddate';\n\nexport const SortFieldDisplayName: {\n [key in SortField]: string;\n} = {\n relevance: 'Relevance',\n alltimeview: 'All-time Views',\n weeklyview: 'Weekly Views',\n title: 'Title',\n datearchived: 'Date Archived',\n date: 'Date Published',\n datereviewed: 'Date Reviewed',\n dateadded: 'Date Added',\n creator: 'Creator',\n};\n\n/**\n * Maps the SortField above to the corresponding Metadata field in the API.\n */\nexport const SortFieldToMetadataField: {\n [key in SortField]: MetadataSortField | null;\n} = {\n relevance: null,\n alltimeview: 'downloads',\n weeklyview: 'week',\n title: 'titleSorter',\n datearchived: 'publicdate',\n date: 'date',\n datereviewed: 'reviewdate',\n dateadded: 'addeddate',\n creator: 'creatorSorter',\n};\n\n/**\n * Maps the Metadata field to the corresponding SortField field in the API.\n */\nexport const MetadataFieldToSortField: {\n [key in MetadataSortField]: SortField;\n} = {\n week: SortField.weeklyview,\n downloads: SortField.alltimeview,\n titleSorter: SortField.title,\n date: SortField.date,\n publicdate: SortField.datearchived,\n reviewdate: SortField.datereviewed,\n addeddate: SortField.dateadded,\n creatorSorter: SortField.creator,\n};\n\nexport type FacetOption =\n | 'subject'\n | 'lending'\n | 'mediatype'\n | 'language'\n | 'creator'\n | 'collection'\n | 'year';\n\nexport type SelectedFacetState = 'selected' | 'hidden';\n\nexport type FacetState = SelectedFacetState | 'none';\n\nexport interface FacetBucket {\n // for some facets, we augment the key with a display value\n displayText?: string;\n key: string;\n count: number;\n state: FacetState;\n}\n\nexport interface FacetGroup {\n title: string;\n key: FacetOption;\n buckets: FacetBucket[];\n}\n\nexport type FacetValue = string;\n\nexport type SelectedFacets = Record<\n FacetOption,\n Record<FacetValue, FacetBucket>\n>;\n\nexport const defaultSelectedFacets: SelectedFacets = {\n subject: {},\n lending: {},\n mediatype: {},\n language: {},\n creator: {},\n collection: {},\n year: {},\n};\n\nexport const facetDisplayOrder: FacetOption[] = [\n 'mediatype',\n 'lending',\n 'year',\n 'subject',\n 'collection',\n 'creator',\n 'language',\n];\n\nexport const facetTitles: Record<FacetOption, string> = {\n subject: 'Subject',\n lending: 'Availability',\n mediatype: 'Media Type',\n language: 'Language',\n creator: 'Creator',\n collection: 'Collection',\n year: 'Year',\n};\n\nexport type LendingFacetKey =\n | 'is_lendable'\n | 'is_borrowable'\n | 'available_to_borrow'\n | 'is_browsable'\n | 'available_to_browse'\n | 'is_readable'\n | 'available_to_waitlist';\n\n/**\n * Maps valid lending keys to whether they should be visible in the facet sidebar\n */\nexport const lendingFacetKeysVisibility: Record<LendingFacetKey, boolean> = {\n is_lendable: true,\n is_borrowable: false,\n available_to_borrow: true,\n is_browsable: false,\n available_to_browse: false,\n is_readable: true,\n available_to_waitlist: false,\n};\n\n/**\n * Maps valid, visible lending keys to their facet sidebar display text\n */\nexport const lendingFacetDisplayNames: Partial<\n Record<LendingFacetKey, string>\n> = {\n is_lendable: 'Lending Library',\n available_to_borrow: 'Borrow 14 Days',\n is_readable: 'Always Available',\n};\n\n/**\n * A record of which admin-only collections should be suppressed from being displayed\n * as facets or in an item's list of collections.\n */\nexport const suppressedCollections: Record<string, boolean> = {\n deemphasize: true,\n community: true,\n stream_only: true,\n samples_only: true,\n test_collection: true,\n printdisabled: true,\n 'openlibrary-ol': true,\n nationalemergencylibrary: true,\n china: true,\n americana: true,\n toronto: true,\n};\n"]}
@@ -1,45 +1,46 @@
1
- import type { SortDirection, SortParam } from '@internetarchive/search-service';
2
- import { CollectionBrowserContext, CollectionDisplayMode, SelectedFacets, SortField } from './models';
3
- export interface RestorationState {
4
- displayMode?: CollectionDisplayMode;
5
- sortParam?: SortParam;
6
- selectedSort?: SortField;
7
- sortDirection?: SortDirection;
8
- selectedFacets: SelectedFacets;
9
- baseQuery?: string;
10
- currentPage?: number;
11
- dateRangeQueryClause?: string;
12
- titleQuery?: string;
13
- creatorQuery?: string;
14
- minSelectedDate?: string;
15
- maxSelectedDate?: string;
16
- selectedTitleFilter?: string;
17
- selectedCreatorFilter?: string;
18
- }
19
- export interface RestorationStateHandlerInterface {
20
- persistState(state: RestorationState): void;
21
- getRestorationState(): RestorationState;
22
- }
23
- export declare class RestorationStateHandler implements RestorationStateHandlerInterface {
24
- private context;
25
- private cookieDomain;
26
- private cookieExpiration;
27
- private cookiePath;
28
- constructor(options: {
29
- context: CollectionBrowserContext;
30
- });
31
- persistState(state: RestorationState): void;
32
- getRestorationState(): RestorationState;
33
- private persistViewStateToCookies;
34
- private loadTileViewStateFromCookies;
35
- private persistQueryStateToUrl;
36
- private loadQueryStateFromUrl;
37
- private stripQuotes;
38
- /**
39
- * Sets the facet state for the given field & value to the given state,
40
- * creating any previously-undefined buckets as needed.
41
- */
42
- private setSelectedFacetState;
43
- /** Returns a default bucket with the given key, count of 0, and state 'none'. */
44
- private getDefaultBucket;
45
- }
1
+ import { SearchType, SortDirection, SortParam } from '@internetarchive/search-service';
2
+ import { CollectionBrowserContext, CollectionDisplayMode, SelectedFacets, SortField } from './models';
3
+ export interface RestorationState {
4
+ displayMode?: CollectionDisplayMode;
5
+ searchType?: SearchType;
6
+ sortParam?: SortParam;
7
+ selectedSort?: SortField;
8
+ sortDirection?: SortDirection;
9
+ selectedFacets: SelectedFacets;
10
+ baseQuery?: string;
11
+ currentPage?: number;
12
+ 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,221 +1,231 @@
1
- import { getCookie, setCookie } from 'typescript-cookie';
2
- import { MetadataFieldToSortField, } from './models';
3
- export class RestorationStateHandler {
4
- constructor(options) {
5
- this.cookieDomain = '.archive.org';
6
- this.cookieExpiration = 30;
7
- this.cookiePath = '/';
8
- this.context = options.context;
9
- }
10
- persistState(state) {
11
- if (state.displayMode)
12
- this.persistViewStateToCookies(state.displayMode);
13
- this.persistQueryStateToUrl(state);
14
- }
15
- getRestorationState() {
16
- const restorationState = this.loadQueryStateFromUrl();
17
- const displayMode = this.loadTileViewStateFromCookies();
18
- restorationState.displayMode = displayMode;
19
- return restorationState;
20
- }
21
- persistViewStateToCookies(displayMode) {
22
- const gridState = displayMode === 'grid' ? 'tiles' : 'lists';
23
- setCookie(`view-${this.context}`, gridState, {
24
- domain: this.cookieDomain,
25
- expires: this.cookieExpiration,
26
- path: this.cookiePath,
27
- });
28
- const detailsState = displayMode === 'list-detail' ? 'showdetails' : '';
29
- setCookie(`showdetails-${this.context}`, detailsState, {
30
- domain: this.cookieDomain,
31
- expires: this.cookieExpiration,
32
- path: this.cookiePath,
33
- });
34
- }
35
- loadTileViewStateFromCookies() {
36
- const viewState = getCookie(`view-${this.context}`);
37
- const detailsState = getCookie(`showdetails-${this.context}`);
38
- if (viewState === 'tiles' || viewState === undefined)
39
- return 'grid';
40
- if (detailsState === 'showdetails')
41
- return 'list-detail';
42
- return 'list-compact';
43
- }
44
- persistQueryStateToUrl(state) {
45
- const url = new URL(window.location.href);
46
- const { searchParams } = url;
47
- searchParams.delete('sort');
48
- searchParams.delete('query');
49
- searchParams.delete('page');
50
- searchParams.delete('and[]');
51
- searchParams.delete('not[]');
52
- if (state.sortParam) {
53
- const prefix = state.sortParam.direction === 'desc' ? '-' : '';
54
- searchParams.set('sort', `${prefix}${state.sortParam.field}`);
55
- }
56
- if (state.baseQuery) {
57
- searchParams.set('query', state.baseQuery);
58
- }
59
- if (state.currentPage) {
60
- if (state.currentPage > 1) {
61
- searchParams.set('page', state.currentPage.toString());
62
- }
63
- else {
64
- searchParams.delete('page');
65
- }
66
- }
67
- if (state.selectedFacets) {
68
- for (const [facetName, facetValues] of Object.entries(state.selectedFacets)) {
69
- const facetEntries = Object.entries(facetValues);
70
- // eslint-disable-next-line no-continue
71
- if (facetEntries.length === 0)
72
- continue;
73
- for (const [key, data] of facetEntries) {
74
- const notValue = data.state === 'hidden';
75
- const paramValue = `${facetName}:"${key}"`;
76
- if (notValue) {
77
- searchParams.append('not[]', paramValue);
78
- }
79
- else {
80
- searchParams.append('and[]', paramValue);
81
- }
82
- }
83
- }
84
- }
85
- if (state.dateRangeQueryClause) {
86
- searchParams.append('and[]', state.dateRangeQueryClause);
87
- }
88
- if (state.titleQuery) {
89
- searchParams.append('and[]', state.titleQuery);
90
- }
91
- if (state.creatorQuery) {
92
- searchParams.append('and[]', state.creatorQuery);
93
- }
94
- window.history.pushState({
95
- sort: state.sortParam,
96
- query: state.baseQuery,
97
- page: state.currentPage,
98
- and: state.selectedFacets,
99
- not: state.selectedFacets,
100
- dateRange: state.dateRangeQueryClause,
101
- }, '', url);
102
- }
103
- loadQueryStateFromUrl() {
104
- const url = new URL(window.location.href);
105
- const pageNumber = url.searchParams.get('page');
106
- const searchQuery = url.searchParams.get('query');
107
- const sortQuery = url.searchParams.get('sort');
108
- const facetAnds = url.searchParams.getAll('and[]');
109
- const facetNots = url.searchParams.getAll('not[]');
110
- const restorationState = {
111
- selectedFacets: {
112
- subject: {},
113
- lending: {},
114
- creator: {},
115
- mediatype: {},
116
- language: {},
117
- collection: {},
118
- year: {},
119
- },
120
- };
121
- if (pageNumber) {
122
- const parsed = parseInt(pageNumber, 10);
123
- restorationState.currentPage = parsed;
124
- }
125
- else {
126
- restorationState.currentPage = 1;
127
- }
128
- if (searchQuery) {
129
- restorationState.baseQuery = searchQuery;
130
- }
131
- if (sortQuery) {
132
- // check for two different sort formats: `date desc` and `-date`
133
- const hasSpace = sortQuery.indexOf(' ') > -1;
134
- if (hasSpace) {
135
- const [field, direction] = sortQuery.split(' ');
136
- const metadataField = MetadataFieldToSortField[field];
137
- if (metadataField) {
138
- restorationState.selectedSort = metadataField;
139
- }
140
- if (direction === 'desc' || direction === 'asc') {
141
- restorationState.sortDirection = direction;
142
- }
143
- }
144
- else {
145
- const sortDirection = sortQuery.startsWith('-') ? 'desc' : 'asc';
146
- const sortField = sortQuery.startsWith('-')
147
- ? sortQuery.slice(1)
148
- : sortQuery;
149
- const metadataField = MetadataFieldToSortField[sortField];
150
- if (metadataField)
151
- restorationState.selectedSort = metadataField;
152
- restorationState.sortDirection = sortDirection;
153
- }
154
- }
155
- if (facetAnds) {
156
- facetAnds.forEach(and => {
157
- const [field, value] = and.split(':');
158
- switch (field) {
159
- case 'year': {
160
- const [minDate, maxDate] = value.split(' TO ');
161
- // we have two potential ways of filtering by date:
162
- // the range with "date TO date" or the single date with "date"
163
- // this is checking for the range case and if we don't have those, fall
164
- // back to the single date case
165
- if (minDate && maxDate) {
166
- restorationState.minSelectedDate = minDate.substring(1, minDate.length);
167
- restorationState.maxSelectedDate = maxDate.substring(0, maxDate.length - 1);
168
- restorationState.dateRangeQueryClause = `year:${value}`;
169
- }
170
- else {
171
- this.setSelectedFacetState(restorationState.selectedFacets, field, value, 'selected');
172
- }
173
- break;
174
- }
175
- case 'firstTitle':
176
- restorationState.selectedTitleFilter = value;
177
- break;
178
- case 'firstCreator':
179
- restorationState.selectedCreatorFilter = value;
180
- break;
181
- default:
182
- this.setSelectedFacetState(restorationState.selectedFacets, field, value, 'selected');
183
- }
184
- });
185
- }
186
- if (facetNots) {
187
- facetNots.forEach(not => {
188
- const [field, value] = not.split(':');
189
- this.setSelectedFacetState(restorationState.selectedFacets, field, value, 'hidden');
190
- });
191
- }
192
- return restorationState;
193
- }
194
- // remove optional opening and closing quotes from a string
195
- stripQuotes(value) {
196
- if (value.startsWith('"') && value.endsWith('"')) {
197
- return value.substring(1, value.length - 1);
198
- }
199
- return value;
200
- }
201
- /**
202
- * Sets the facet state for the given field & value to the given state,
203
- * creating any previously-undefined buckets as needed.
204
- */
205
- setSelectedFacetState(selectedFacets, field, value, state) {
206
- var _a;
207
- const facet = selectedFacets[field];
208
- const unQuotedValue = this.stripQuotes(value);
209
- (_a = facet[unQuotedValue]) !== null && _a !== void 0 ? _a : (facet[unQuotedValue] = this.getDefaultBucket(value));
210
- facet[unQuotedValue].state = state;
211
- }
212
- /** Returns a default bucket with the given key, count of 0, and state 'none'. */
213
- getDefaultBucket(key) {
214
- return {
215
- key,
216
- count: 0,
217
- state: 'none',
218
- };
219
- }
220
- }
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
+ }
221
231
  //# sourceMappingURL=restoration-state-handler.js.map