@internetarchive/ia-topnav 1.3.8 → 1.3.10-webdev-7394.0

package/src/data/{menus.js → menus.ts}

@@ -1,6 +1,8 @@
 // @see https://git.archive.org/www/offshoot/-/blob/main/guides/update-top-nav.md
 
-export const defaultTopNavConfig = {
+import { IATopNavConfig, IATopNavMenuConfig } from '../models';
+
+export const defaultTopNavConfig: IATopNavConfig = {
   // Google Analytics event category
   eventCategory: 'TopNav',
   // Array of strings representing the values of options that should be hidden from search options
@@ -9,7 +11,6 @@ export const defaultTopNavConfig = {
   waybackPagesArchived: '740 billion',
 };
 
-
 /**
  * Creates archive.org top navigation configuration
  * @param { string } userid archive.org account (immutable) userid
@@ -22,135 +23,144 @@ export const defaultTopNavConfig = {
  * @param { string } itemIdentifier The current item being viewed, to populate admin menu items
  * @returns { object }
  */
-export function buildTopNavMenus(userid = '___USERID___', localLinks = true, waybackPagesArchived = '', itemIdentifier = '') {
+export function buildTopNavMenus(
+  userid: string = '___USERID___',
+  baseHost: string = 'https://archive.org',
+  waybackPagesArchived: string = '',
+  itemIdentifier: string = '',
+): IATopNavMenuConfig {
   if (waybackPagesArchived)
-    defaultTopNavConfig.waybackPagesArchived = waybackPagesArchived // update to more accurate val
-
+    defaultTopNavConfig.waybackPagesArchived = waybackPagesArchived; // update to more accurate val
 
-  const prefix = localLinks ? '' : 'https://archive.org'
   return {
     audio: {
       heading: 'Internet Archive Audio',
       iconLinks: [
         {
-          icon: `${prefix}/services/img/etree`,
+          icon: `${baseHost}/services/img/etree`,
           title: 'Live Music Archive',
-          url: `${prefix}/details/etree`,
+          url: `${baseHost}/details/etree`,
         },
         {
-          icon: `${prefix}/services/img/librivoxaudio`,
+          icon: `${baseHost}/services/img/librivoxaudio`,
           title: 'Librivox Free Audio',
-          url: `${prefix}/details/librivoxaudio`,
+          url: `${baseHost}/details/librivoxaudio`,
         },
       ],
       featuredLinks: [
         {
           title: 'All Audio',
-          url: `${prefix}/details/audio`,
+          url: `${baseHost}/details/audio`,
         },
         {
           title: 'Grateful Dead',
-          url: `${prefix}/details/GratefulDead`,
+          url: `${baseHost}/details/GratefulDead`,
         },
         {
           title: 'Netlabels',
-          url: `${prefix}/details/netlabels`,
+          url: `${baseHost}/details/netlabels`,
         },
         {
           title: 'Old Time Radio',
-          url: `${prefix}/details/oldtimeradio`,
+          url: `${baseHost}/details/oldtimeradio`,
         },
         {
           title: '78 RPMs and Cylinder Recordings',
-          url: `${prefix}/details/78rpm`,
+          url: `${baseHost}/details/78rpm`,
         },
       ],
       links: [
         {
           title: 'Audio Books & Poetry',
-          url: `${prefix}/details/audio_bookspoetry`,
+          url: `${baseHost}/details/audio_bookspoetry`,
         },
         {
           title: 'Computers, Technology and Science',
-          url: `${prefix}/details/audio_tech`,
+          url: `${baseHost}/details/audio_tech`,
         },
         {
           title: 'Music, Arts & Culture',
-          url: `${prefix}/details/audio_music`,
+          url: `${baseHost}/details/audio_music`,
         },
         {
           title: 'News & Public Affairs',
-          url: `${prefix}/details/audio_news`,
+          url: `${baseHost}/details/audio_news`,
         },
         {
           title: 'Spirituality & Religion',
-          url: `${prefix}/details/audio_religion`,
+          url: `${baseHost}/details/audio_religion`,
         },
         {
           title: 'Podcasts',
-          url: `${prefix}/details/podcasts`,
+          url: `${baseHost}/details/podcasts`,
         },
         {
           title: 'Radio News Archive',
-          url: `${prefix}/details/radio`,
+          url: `${baseHost}/details/radio`,
         },
       ],
+      mobileAppsLinks: [],
+      browserExtensionsLinks: [],
+      archiveItLinks: [],
     },
     images: {
       heading: 'Images',
       iconLinks: [
         {
-          icon: `${prefix}/services/img/metropolitanmuseumofart-gallery`,
+          icon: `${baseHost}/services/img/metropolitanmuseumofart-gallery`,
           title: 'Metropolitan Museum',
-          url: `${prefix}/details/metropolitanmuseumofart-gallery`,
+          url: `${baseHost}/details/metropolitanmuseumofart-gallery`,
         },
         {
-          icon: `${prefix}/services/img/clevelandart`,
+          icon: `${baseHost}/services/img/clevelandart`,
           title: 'Cleveland Museum of Art',
-          url: `${prefix}/details/clevelandart`,
+          url: `${baseHost}/details/clevelandart`,
         },
       ],
       featuredLinks: [
         {
           title: 'All Images',
-          url: `${prefix}/details/image`,
+          url: `${baseHost}/details/image`,
         },
         {
           title: 'Flickr Commons',
-          url: `${prefix}/details/flickrcommons`,
+          url: `${baseHost}/details/flickrcommons`,
         },
         {
           title: 'Occupy Wall Street Flickr',
-          url: `${prefix}/details/flickr-ows`,
+          url: `${baseHost}/details/flickr-ows`,
         },
         {
           title: 'Cover Art',
-          url: `${prefix}/details/coverartarchive`,
+          url: `${baseHost}/details/coverartarchive`,
         },
         {
           title: 'USGS Maps',
-          url: `${prefix}/details/maps_usgs`,
+          url: `${baseHost}/details/maps_usgs`,
         },
       ],
       links: [
         {
           title: 'NASA Images',
-          url: `${prefix}/details/nasa`,
+          url: `${baseHost}/details/nasa`,
         },
         {
           title: 'Solar System Collection',
-          url: `${prefix}/details/solarsystemcollection`,
+          url: `${baseHost}/details/solarsystemcollection`,
         },
         {
           title: 'Ames Research Center',
-          url: `${prefix}/details/amesresearchcenterimagelibrary`,
+          url: `${baseHost}/details/amesresearchcenterimagelibrary`,
         },
       ],
+      mobileAppsLinks: [],
+      browserExtensionsLinks: [],
+      archiveItLinks: [],
     },
     more: [
       {
         title: 'About',
-        url: `${prefix}/about/`,
+        url: `${baseHost}/about/`,
       },
       {
         title: 'Blog',
@@ -158,198 +168,204 @@ export function buildTopNavMenus(userid = '___USERID___', localLinks = true, way
       },
       {
         title: 'Projects',
-        url: `${prefix}/projects/`,
+        url: `${baseHost}/projects/`,
       },
       {
         title: 'Help',
-        url: `${prefix}/about/faqs.php`,
+        url: `${baseHost}/about/faqs.php`,
       },
       {
         title: 'Donate',
-        url: `${prefix}/donate?origin=iawww-TopNavDonateButton`,
+        url: `${baseHost}/donate?origin=iawww-TopNavDonateButton`,
       },
       {
         title: 'Contact',
-        url: `${prefix}/about/contact`,
+        url: `${baseHost}/about/contact`,
       },
       {
         title: 'Jobs',
-        url: `${prefix}/about/jobs`,
+        url: `${baseHost}/about/jobs`,
       },
       {
         title: 'Volunteer',
-        url: `${prefix}/about/volunteer-positions`,
+        url: `${baseHost}/about/volunteer-positions`,
       },
       {
         title: 'People',
-        url: `${prefix}/about/bios`,
+        url: `${baseHost}/about/bios`,
       },
     ],
     software: {
       heading: 'Software',
       iconLinks: [
         {
-          icon: `${prefix}/services/img/internetarcade`,
+          icon: `${baseHost}/services/img/internetarcade`,
           title: 'Internet Arcade',
-          url: `${prefix}/details/internetarcade`,
+          url: `${baseHost}/details/internetarcade`,
         },
         {
-          icon: `${prefix}/services/img/consolelivingroom`,
+          icon: `${baseHost}/services/img/consolelivingroom`,
           title: 'Console Living Room',
-          url: `${prefix}/details/consolelivingroom`,
+          url: `${baseHost}/details/consolelivingroom`,
         },
       ],
       featuredLinks: [
         {
           title: 'All Software',
-          url: `${prefix}/details/software`,
+          url: `${baseHost}/details/software`,
         },
         {
           title: 'Old School Emulation',
-          url: `${prefix}/details/tosec`,
+          url: `${baseHost}/details/tosec`,
         },
         {
           title: 'MS-DOS Games',
-          url: `${prefix}/details/softwarelibrary_msdos_games`,
+          url: `${baseHost}/details/softwarelibrary_msdos_games`,
         },
         {
           title: 'Historical Software',
-          url: `${prefix}/details/historicalsoftware`,
+          url: `${baseHost}/details/historicalsoftware`,
         },
         {
           title: 'Classic PC Games',
-          url: `${prefix}/details/classicpcgames`,
+          url: `${baseHost}/details/classicpcgames`,
         },
         {
           title: 'Software Library',
-          url: `${prefix}/details/softwarelibrary`,
+          url: `${baseHost}/details/softwarelibrary`,
         },
       ],
       links: [
         {
           title: 'Kodi Archive and Support File',
-          url: `${prefix}/details/kodi_archive`,
+          url: `${baseHost}/details/kodi_archive`,
         },
         {
           title: 'Vintage Software',
-          url: `${prefix}/details/vintagesoftware`,
+          url: `${baseHost}/details/vintagesoftware`,
         },
         {
           title: 'APK',
-          url: `${prefix}/details/apkarchive`,
+          url: `${baseHost}/details/apkarchive`,
         },
         {
           title: 'MS-DOS',
-          url: `${prefix}/details/softwarelibrary_msdos`,
+          url: `${baseHost}/details/softwarelibrary_msdos`,
         },
         {
           title: 'CD-ROM Software',
-          url: `${prefix}/details/cd-roms`,
+          url: `${baseHost}/details/cd-roms`,
         },
         {
           title: 'CD-ROM Software Library',
-          url: `${prefix}/details/cdromsoftware`,
+          url: `${baseHost}/details/cdromsoftware`,
         },
         {
           title: 'Software Sites',
-          url: `${prefix}/details/softwaresites`,
+          url: `${baseHost}/details/softwaresites`,
         },
         {
           title: 'Tucows Software Library',
-          url: `${prefix}/details/tucows`,
+          url: `${baseHost}/details/tucows`,
         },
         {
           title: 'Shareware CD-ROMs',
-          url: `${prefix}/details/cdbbsarchive`,
+          url: `${baseHost}/details/cdbbsarchive`,
         },
         {
           title: 'Software Capsules Compilation',
-          url: `${prefix}/details/softwarecapsules`,
+          url: `${baseHost}/details/softwarecapsules`,
         },
         {
           title: 'CD-ROM Images',
-          url: `${prefix}/details/cdromimages`,
+          url: `${baseHost}/details/cdromimages`,
         },
         {
           title: 'ZX Spectrum',
-          url: `${prefix}/details/softwarelibrary_zx_spectrum`,
+          url: `${baseHost}/details/softwarelibrary_zx_spectrum`,
         },
         {
           title: 'DOOM Level CD',
-          url: `${prefix}/details/doom-cds`,
+          url: `${baseHost}/details/doom-cds`,
         },
       ],
+      mobileAppsLinks: [],
+      browserExtensionsLinks: [],
+      archiveItLinks: [],
     },
     texts: {
       heading: 'Texts',
       iconLinks: [
         {
           title: 'Open Library',
-          icon: `${prefix}/images/widgetOL.png`,
+          icon: `${baseHost}/images/widgetOL.png`,
           url: 'https://openlibrary.org/',
         },
         {
           title: 'American Libraries',
-          icon: `${prefix}/services/img/americana`,
-          url: `${prefix}/details/americana`,
+          icon: `${baseHost}/services/img/americana`,
+          url: `${baseHost}/details/americana`,
         },
       ],
       featuredLinks: [
         {
           title: 'All Texts',
-          url: `${prefix}/details/texts`,
+          url: `${baseHost}/details/texts`,
         },
         {
           title: 'Smithsonian Libraries',
-          url: `${prefix}/details/smithsonian`,
+          url: `${baseHost}/details/smithsonian`,
         },
         {
           title: 'FEDLINK (US)',
-          url: `${prefix}/details/fedlink`,
+          url: `${baseHost}/details/fedlink`,
         },
         {
           title: 'Genealogy',
-          url: `${prefix}/details/genealogy`,
+          url: `${baseHost}/details/genealogy`,
         },
         {
           title: 'Lincoln Collection',
-          url: `${prefix}/details/lincolncollection`,
+          url: `${baseHost}/details/lincolncollection`,
         },
       ],
       links: [
         {
           title: 'American Libraries',
-          url: `${prefix}/details/americana`,
+          url: `${baseHost}/details/americana`,
         },
         {
           title: 'Canadian Libraries',
-          url: `${prefix}/details/toronto`,
+          url: `${baseHost}/details/toronto`,
         },
         {
           title: 'Universal Library',
-          url: `${prefix}/details/universallibrary`,
+          url: `${baseHost}/details/universallibrary`,
         },
         {
           title: 'Project Gutenberg',
-          url: `${prefix}/details/gutenberg`,
+          url: `${baseHost}/details/gutenberg`,
         },
         {
           title: "Children's Library",
-          url: `${prefix}/details/iacl`,
+          url: `${baseHost}/details/iacl`,
         },
         {
           title: 'Biodiversity Heritage Library',
-          url: `${prefix}/details/biodiversity`,
+          url: `${baseHost}/details/biodiversity`,
         },
         {
           title: 'Books by Language',
-          url: `${prefix}/details/booksbylanguage`,
+          url: `${baseHost}/details/booksbylanguage`,
         },
         {
           title: 'Additional Collections',
-          url: `${prefix}/details/additional_collections`,
+          url: `${baseHost}/details/additional_collections`,
         },
       ],
+      mobileAppsLinks: [],
+      browserExtensionsLinks: [],
+      archiveItLinks: [],
     },
     web: {
       mobileAppsLinks: [
@@ -403,137 +419,144 @@ export function buildTopNavMenus(userid = '___USERID___', localLinks = true, way
           external: true,
         },
       ],
+      heading: '',
+      iconLinks: [],
+      featuredLinks: [],
+      links: [],
     },
     video: {
       heading: 'Video',
       iconLinks: [
         {
-          icon: `${prefix}/services/img/tv`,
+          icon: `${baseHost}/services/img/tv`,
           title: 'TV News',
-          url: `${prefix}/details/tv`,
+          url: `${baseHost}/details/tv`,
         },
         {
-          icon: `${prefix}/services/img/911`,
+          icon: `${baseHost}/services/img/911`,
           title: 'Understanding 9/11',
-          url: `${prefix}/details/911`,
+          url: `${baseHost}/details/911`,
         },
       ],
       featuredLinks: [
         {
           title: 'All Video',
-          url: `${prefix}/details/movies`,
+          url: `${baseHost}/details/movies`,
         },
         {
           title: 'Prelinger Archives',
-          url: `${prefix}/details/prelinger`,
+          url: `${baseHost}/details/prelinger`,
         },
         {
           title: 'Democracy Now!',
-          url: `${prefix}/details/democracy_now_vid`,
+          url: `${baseHost}/details/democracy_now_vid`,
         },
         {
           title: 'Occupy Wall Street',
-          url: `${prefix}/details/occupywallstreet`,
+          url: `${baseHost}/details/occupywallstreet`,
         },
         {
           title: 'TV NSA Clip Library',
-          url: `${prefix}/details/nsa`,
+          url: `${baseHost}/details/nsa`,
         },
       ],
       links: [
         {
           title: 'Animation & Cartoons',
-          url: `${prefix}/details/animationandcartoons`,
+          url: `${baseHost}/details/animationandcartoons`,
         },
         {
           title: 'Arts & Music',
-          url: `${prefix}/details/artsandmusicvideos`,
+          url: `${baseHost}/details/artsandmusicvideos`,
         },
         {
           title: 'Computers & Technology',
-          url: `${prefix}/details/computersandtechvideos`,
+          url: `${baseHost}/details/computersandtechvideos`,
         },
         {
           title: 'Cultural & Academic Films',
-          url: `${prefix}/details/culturalandacademicfilms`,
+          url: `${baseHost}/details/culturalandacademicfilms`,
         },
         {
           title: 'Ephemeral Films',
-          url: `${prefix}/details/ephemera`,
+          url: `${baseHost}/details/ephemera`,
         },
         {
           title: 'Movies',
-          url: `${prefix}/details/moviesandfilms`,
+          url: `${baseHost}/details/moviesandfilms`,
         },
         {
           title: 'News & Public Affairs',
-          url: `${prefix}/details/newsandpublicaffairs`,
+          url: `${baseHost}/details/newsandpublicaffairs`,
         },
         {
           title: 'Spirituality & Religion',
-          url: `${prefix}/details/spiritualityandreligion`,
+          url: `${baseHost}/details/spiritualityandreligion`,
         },
         {
           title: 'Sports Videos',
-          url: `${prefix}/details/sports`,
+          url: `${baseHost}/details/sports`,
         },
         {
           title: 'Television',
-          url: `${prefix}/details/television`,
+          url: `${baseHost}/details/television`,
         },
         {
           title: 'Videogame Videos',
-          url: `${prefix}/details/gamevideos`,
+          url: `${baseHost}/details/gamevideos`,
         },
         {
           title: 'Vlogs',
-          url: `${prefix}/details/vlogs`,
+          url: `${baseHost}/details/vlogs`,
         },
         {
           title: 'Youth Media',
-          url: `${prefix}/details/youth_media`,
+          url: `${baseHost}/details/youth_media`,
         },
       ],
+      mobileAppsLinks: [],
+      browserExtensionsLinks: [],
+      archiveItLinks: [],
     },
     user: [
       {
-        url: `${prefix}/create`,
+        url: `${baseHost}/create`,
         title: 'Upload files',
         analyticsEvent: 'UserUpload',
         class: 'mobile-upload',
       },
       {
-        url: `${prefix}/details/@${userid}`,
+        url: `${baseHost}/details/@${userid}`,
         title: 'My uploads',
         analyticsEvent: 'UserLibrary',
       },
       {
-        url: `${prefix}/details/@${userid}/loans`,
+        url: `${baseHost}/details/@${userid}/loans`,
         title: 'My loans',
         analyticsEvent: 'UserLoans',
       },
       {
-        url: `${prefix}/details/fav-${userid}`,
+        url: `${baseHost}/details/fav-${userid}`,
         title: 'My favorites',
         analyticsEvent: 'UserFavorites',
       },
       {
-        url: `${prefix}/details/@${userid}/lists`,
+        url: `${baseHost}/details/@${userid}/lists`,
         title: 'My lists',
         analyticsEvent: 'UserLists',
       },
       {
-        url: `${prefix}/details/@${userid}/collections`,
+        url: `${baseHost}/details/@${userid}/collections`,
         title: 'My collections',
         analyticsEvent: 'UserCollections',
       },
       {
-        url: `${prefix}/details/@${userid}/web-archive`,
+        url: `${baseHost}/details/@${userid}/web-archive`,
         title: 'My web archives',
         analyticsEvent: 'UserWebArchive',
       },
       {
-        url: `${prefix}/account/index.php?settings=1`,
+        url: `${baseHost}/account/index.php?settings=1`,
         title: 'Account settings',
         analyticsEvent: 'UserSettings',
       },
@@ -543,7 +566,7 @@ export function buildTopNavMenus(userid = '___USERID___', localLinks = true, way
         analyticsEvent: 'UserHelp',
       },
       {
-        url: `${prefix}/account/logout`,
+        url: `${baseHost}/account/logout`,
         title: 'Log out',
         analyticsEvent: 'UserLogOut',
       },
@@ -556,22 +579,22 @@ export function buildTopNavMenus(userid = '___USERID___', localLinks = true, way
         title: 'item:',
       },
       {
-        url: `${prefix}/editxml/${itemIdentifier}`,
+        url: `${baseHost}/editxml/${itemIdentifier}`,
         title: 'edit xml',
         analyticsEvent: 'AdminUserEditXML',
       },
       {
-        url: `${prefix}/edit.php?redir=1&identifier=${itemIdentifier}`,
+        url: `${baseHost}/edit.php?redir=1&identifier=${itemIdentifier}`,
         title: 'edit files',
         analyticsEvent: 'AdminUserEditFiles',
       },
       {
-        url: `${prefix}/download/${itemIdentifier}/`,
+        url: `${baseHost}/download/${itemIdentifier}/`,
         title: 'download',
         analyticsEvent: 'AdminUserDownload',
       },
       {
-        url: `${prefix}/metadata/${itemIdentifier}/`,
+        url: `${baseHost}/metadata/${itemIdentifier}/`,
         title: 'metadata',
         analyticsEvent: 'AdminUserMetadata',
       },
@@ -581,63 +604,77 @@ export function buildTopNavMenus(userid = '___USERID___', localLinks = true, way
         analyticsEvent: 'AdminUserHistory',
       },
       {
-        url: `${prefix}/manage/${itemIdentifier}`,
+        url: `${baseHost}/manage/${itemIdentifier}`,
         title: 'manage',
         analyticsEvent: 'AdminUserManager',
       },
       {
-        url: `${prefix}/manage/${itemIdentifier}#make_dark`,
+        url: `${baseHost}/manage/${itemIdentifier}#make_dark`,
         title: 'curate',
         analyticsEvent: 'AdminUserCurate',
       },
       {
-        url: `${prefix}/manage/${itemIdentifier}#modify_xml`,
+        url: `${baseHost}/manage/${itemIdentifier}#modify_xml`,
         title: 'modify xml',
         analyticsEvent: 'AdminUserModifyXML',
       },
     ],
     userAdminFlags: [
       {
-        url: `${prefix}/services/flags/admin.php?identifier=${itemIdentifier}`,
+        url: `${baseHost}/services/flags/admin.php?identifier=${itemIdentifier}`,
         title: 'manage flags',
         analyticsEvent: 'AdminUserManageFlags',
       },
     ],
     signedOut: [
       {
-        url: `${prefix}/account/signup`,
+        url: `${baseHost}/account/signup`,
         title: 'Sign up for free',
         analyticsEvent: 'AvatarMenu-Signup',
       },
       {
-        url: `${prefix}/account/login`,
+        url: `${baseHost}/account/login`,
         title: 'Log in',
         analyticsEvent: 'AvatarMenu-Login',
       },
     ],
   };
-};
-
+}
 
-let waybackPagesArchivedCached
+let waybackPagesArchivedCached: string | undefined;
 
 /**
  * Fetches accurate count of number of pages in WayBack Machine
  * @returns { string }
  */
-export async function waybackPagesArchivedFN() {
-  if (waybackPagesArchivedCached)
-    return waybackPagesArchivedCached;
+export async function waybackPagesArchivedFN(): Promise<string> {
+  if (waybackPagesArchivedCached) return waybackPagesArchivedCached;
 
-  const counts = await (await fetch('https://archive.org/services/offshoot/home-page/mediacounts.php')).json();
+  const counts = await (
+    await fetch(
+      'https://archive.org/services/offshoot/home-page/mediacounts.php',
+    )
+  ).json();
   if (counts.success) {
-    let label = ''
+    let label = '';
     let n = parseInt(counts.value.counts.web, 10);
-    if (n > 1000) { n /= 1000; label = 'thousand'; }
-    if (n > 1000) { n /= 1000; label = 'million'; }
-    if (n > 1000) { n /= 1000; label = 'billion'; }
-    if (n > 1000) { n /= 1000; label = 'trillion'; }
-    waybackPagesArchivedCached = `${Math.round(n)} ${label}`
+    if (n > 1000) {
+      n /= 1000;
+      label = 'thousand';
+    }
+    if (n > 1000) {
+      n /= 1000;
+      label = 'million';
+    }
+    if (n > 1000) {
+      n /= 1000;
+      label = 'billion';
+    }
+    if (n > 1000) {
+      n /= 1000;
+      label = 'trillion';
+    }
+    waybackPagesArchivedCached = `${Math.round(n)} ${label}`;
   } else {
     waybackPagesArchivedCached = '741 billion';
   }