Merge pull request #1600 from Camc314/migrate-to-ES6-39

Migration of itemDetails/index, browser and itemHelper to ES6 module

package.json

@@ -119,6 +119,7 @@
           "src/components/imageUploader/imageUploader.js",
           "src/components/indicators/indicators.js",
           "src/components/itemContextMenu.js",
+          "src/components/itemHelper.js",
           "src/components/itemidentifier/itemidentifier.js",
           "src/components/itemMediaInfo/itemMediaInfo.js",
           "src/components/lazyLoader/lazyLoaderIntersectionObserver.js",
@@ -199,6 +200,7 @@
           "src/controllers/dashboard/users/userparentalcontrol.js",
           "src/controllers/dashboard/users/userpasswordpage.js",
           "src/controllers/dashboard/users/userprofilespage.js",
+          "src/controllers/itemDetails/index.js",
           "src/controllers/playback/queue/index.js",
           "src/controllers/playback/video/index.js",
           "src/controllers/searchpage.js",
@@ -248,6 +250,7 @@
           "src/plugins/youtubePlayer/plugin.js",
           "src/scripts/alphanumericshortcuts.js",
           "src/scripts/autoBackdrops.js",
+          "src/scripts/browser.js",
           "src/scripts/datetime.js",
           "src/scripts/deleteHelper.js",
           "src/scripts/dfnshelper.js",

src/components/itemHelper.js

@@ -1,7 +1,7 @@
-define(['apphost', 'globalize'], function (appHost, globalize) {
+import appHost from 'apphost';
-    'use strict';
+import globalize from 'globalize';
 
-    function getDisplayName(item, options = {}) {
+export function getDisplayName(item, options = {}) {
     if (!item) {
         throw new Error('null item passed into getDisplayName');
     }
@@ -10,7 +10,7 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
         item = item.ProgramInfo || item;
     }
 
-        var name = ((item.Type === 'Program' || item.Type === 'Recording') && (item.IsSeries || item.EpisodeTitle) ? item.EpisodeTitle : item.Name) || '';
+    let name = ((item.Type === 'Program' || item.Type === 'Recording') && (item.IsSeries || item.EpisodeTitle) ? item.EpisodeTitle : item.Name) || '';
 
     if (item.Type === 'TvChannel') {
         if (item.ChannelNumber) {
@@ -21,10 +21,10 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     if (item.Type === 'Episode' && item.ParentIndexNumber === 0) {
         name = globalize.translate('ValueSpecialEpisodeName', name);
     } else if ((item.Type === 'Episode' || item.Type === 'Program') && item.IndexNumber != null && item.ParentIndexNumber != null && options.includeIndexNumber !== false) {
-            var displayIndexNumber = item.IndexNumber;
+        let displayIndexNumber = item.IndexNumber;
 
-            var number = displayIndexNumber;
+        let number = displayIndexNumber;
-            var nameSeparator = ' - ';
+        let nameSeparator = ' - ';
 
         if (options.includeParentInfo !== false) {
             number = 'S' + item.ParentIndexNumber + ':E' + number;
@@ -43,10 +43,10 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return name;
-    }
+}
 
-    function supportsAddingToCollection(item) {
+export function supportsAddingToCollection(item) {
-        var invalidTypes = ['Genre', 'MusicGenre', 'Studio', 'UserView', 'CollectionFolder', 'Audio', 'Program', 'Timer', 'SeriesTimer'];
+    const invalidTypes = ['Genre', 'MusicGenre', 'Studio', 'UserView', 'CollectionFolder', 'Audio', 'Program', 'Timer', 'SeriesTimer'];
 
     if (item.Type === 'Recording') {
         if (item.Status !== 'Completed') {
@@ -55,9 +55,9 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return !item.CollectionType && invalidTypes.indexOf(item.Type) === -1 && item.MediaType !== 'Photo' && !isLocalItem(item);
-    }
+}
 
-    function supportsAddingToPlaylist(item) {
+export function supportsAddingToPlaylist(item) {
     if (item.Type === 'Program') {
         return false;
     }
@@ -88,10 +88,10 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return item.MediaType || item.IsFolder || item.Type === 'Genre' || item.Type === 'MusicGenre' || item.Type === 'MusicArtist';
-    }
+}
 
-    function canEdit(user, item) {
+export function canEdit(user, item) {
-        var itemType = item.Type;
+    const itemType = item.Type;
 
     if (itemType === 'UserRootFolder' || itemType === 'UserView') {
         return false;
@@ -120,24 +120,18 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return user.Policy.IsAdministrator;
-    }
+}
 
-    function isLocalItem(item) {
+export function isLocalItem(item) {
     if (item && item.Id && item.Id.indexOf('local') === 0) {
         return true;
     }
 
     return false;
-    }
+}
 
-    return {
+export function canIdentify (user, item) {
-        getDisplayName: getDisplayName,
+    const itemType = item.Type;
-        supportsAddingToCollection: supportsAddingToCollection,
-        supportsAddingToPlaylist: supportsAddingToPlaylist,
-        isLocalItem: isLocalItem,
-
-        canIdentify: function (user, item) {
-            var itemType = item.Type;
 
     if (itemType === 'Movie' ||
         itemType === 'Trailer' ||
@@ -156,12 +150,10 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return false;
-        },
+}
 
-        canEdit: canEdit,
+export function canEditImages (user, item) {
-
+    const itemType = item.Type;
-        canEditImages: function (user, item) {
-            var itemType = item.Type;
 
     if (item.MediaType === 'Photo') {
         return false;
@@ -182,9 +174,9 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return itemType !== 'Timer' && itemType !== 'SeriesTimer' && canEdit(user, item) && !isLocalItem(item);
-        },
+}
 
-        canSync: function (user, item) {
+export function canSync (user, item) {
     if (user && !user.Policy.EnableContentDownloading) {
         return false;
     }
@@ -194,9 +186,9 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return item.SupportsSync;
-        },
+}
 
-        canShare: function (item, user) {
+export function canShare (item, user) {
     if (item.Type === 'Program') {
         return false;
     }
@@ -218,13 +210,13 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
         return false;
     }
     return user.Policy.EnablePublicSharing && appHost.supports('sharing');
-        },
+}
 
-        enableDateAddedDisplay: function (item) {
+export function enableDateAddedDisplay (item) {
     return !item.IsFolder && item.MediaType && item.Type !== 'Program' && item.Type !== 'TvChannel' && item.Type !== 'Trailer';
-        },
+}
 
-        canMarkPlayed: function (item) {
+export function canMarkPlayed (item) {
     if (item.Type === 'Program') {
         return false;
     }
@@ -251,9 +243,9 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return false;
-        },
+}
 
-        canRate: function (item) {
+export function canRate (item) {
     if (item.Type === 'Program'
         || item.Type === 'Timer'
         || item.Type === 'SeriesTimer'
@@ -265,9 +257,9 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return true;
-        },
+}
 
-        canConvert: function (item, user) {
+export function canConvert (item, user) {
     if (!user.Policy.EnableMediaConversion) {
         return false;
     }
@@ -276,17 +268,17 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
         return false;
     }
 
-            var mediaType = item.MediaType;
+    const mediaType = item.MediaType;
     if (mediaType === 'Book' || mediaType === 'Photo' || mediaType === 'Audio') {
         return false;
     }
 
-            var collectionType = item.CollectionType;
+    const collectionType = item.CollectionType;
     if (collectionType === 'livetv') {
         return false;
     }
 
-            var type = item.Type;
+    const type = item.Type;
     if (type === 'Channel' || type === 'Person' || type === 'Year' || type === 'Program' || type === 'Timer' || type === 'SeriesTimer') {
         return false;
     }
@@ -300,11 +292,11 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return true;
-        },
+}
 
-        canRefreshMetadata: function (item, user) {
+export function canRefreshMetadata (item, user) {
     if (user.Policy.IsAdministrator) {
-                var collectionType = item.CollectionType;
+        const collectionType = item.CollectionType;
         if (collectionType === 'livetv') {
             return false;
         }
@@ -317,9 +309,9 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return false;
-        },
+}
 
-        supportsMediaSourceSelection: function (item) {
+export function supportsMediaSourceSelection (item) {
     if (item.MediaType !== 'Video') {
         return false;
     }
@@ -337,6 +329,22 @@ define(['apphost', 'globalize'], function (appHost, globalize) {
     }
 
     return true;
-        }
+}
-    };
+
-});
+export default {
+    getDisplayName: getDisplayName,
+    supportsAddingToCollection: supportsAddingToCollection,
+    supportsAddingToPlaylist: supportsAddingToPlaylist,
+    isLocalItem: isLocalItem,
+    canIdentify: canIdentify,
+    canEdit: canEdit,
+    canEditImages: canEditImages,
+    canSync: canSync,
+    canShare: canShare,
+    enableDateAddedDisplay: enableDateAddedDisplay,
+    canMarkPlayed: canMarkPlayed,
+    canRate: canRate,
+    canConvert: canConvert,
+    canRefreshMetadata: canRefreshMetadata,
+    supportsMediaSourceSelection: supportsMediaSourceSelection
+};

src/plugins/bookPlayer/plugin.js

@@ -222,7 +222,7 @@ export class BookPlayer {
         return new Promise((resolve, reject) => {
             import('epubjs').then(({default: epubjs}) => {
                 let downloadHref = apiClient.getItemDownloadUrl(item.Id);
-                let book = epubjs.default(downloadHref, {openAs: 'epub'});
+                let book = epubjs(downloadHref, {openAs: 'epub'});
                 let rendition = book.renderTo(elem, {width: '100%', height: '97%'});
 
                 this._currentSrc = downloadHref;

src/scripts/browser.js

@@ -1,9 +1,6 @@
-define([], function () {
+function isTv() {
-    'use strict';
-
-    function isTv() {
     // This is going to be really difficult to get right
-        var userAgent = navigator.userAgent.toLowerCase();
+    const userAgent = navigator.userAgent.toLowerCase();
 
     if (userAgent.indexOf('tv') !== -1) {
         return true;
@@ -22,10 +19,10 @@ define([], function () {
     }
 
     return false;
-    }
+}
 
-    function isMobile(userAgent) {
+function isMobile(userAgent) {
-        var terms = [
+    const terms = [
         'mobi',
         'ipad',
         'iphone',
@@ -37,18 +34,18 @@ define([], function () {
         'opera mini'
     ];
 
-        var lower = userAgent.toLowerCase();
+    const lower = userAgent.toLowerCase();
 
-        for (var i = 0, length = terms.length; i < length; i++) {
+    for (let i = 0, length = terms.length; i < length; i++) {
         if (lower.indexOf(terms[i]) !== -1) {
             return true;
         }
     }
 
     return false;
-    }
+}
 
-    function hasKeyboard(browser) {
+function hasKeyboard(browser) {
     if (browser.touch) {
         return true;
     }
@@ -73,20 +70,20 @@ define([], function () {
     }
 
     return false;
-    }
+}
 
-    function iOSversion() {
+function iOSversion() {
     // MacIntel: Apple iPad Pro 11 iOS 13.1
     if (/iP(hone|od|ad)|MacIntel/.test(navigator.platform)) {
         // supports iOS 2.0 and later: <http://bit.ly/TJjs1V>
-            var v = (navigator.appVersion).match(/OS (\d+)_(\d+)_?(\d+)?/);
+        const v = (navigator.appVersion).match(/OS (\d+)_(\d+)_?(\d+)?/);
         return [parseInt(v[1], 10), parseInt(v[2], 10), parseInt(v[3] || 0, 10)];
     }
-    }
+}
 
-    var _supportsCssAnimation;
+let _supportsCssAnimation;
-    var _supportsCssAnimationWithPrefix;
+let _supportsCssAnimationWithPrefix;
-    function supportsCssAnimation(allowPrefix) {
+function supportsCssAnimation(allowPrefix) {
     // TODO: Assess if this is still needed, as all of our targets should natively support CSS animations.
     if (allowPrefix) {
         if (_supportsCssAnimationWithPrefix === true || _supportsCssAnimationWithPrefix === false) {
@@ -98,16 +95,16 @@ define([], function () {
         }
     }
 
-        var animation = false;
+    let animation = false;
-        var domPrefixes = ['Webkit', 'O', 'Moz'];
+    const domPrefixes = ['Webkit', 'O', 'Moz'];
-        var elm = document.createElement('div');
+    const elm = document.createElement('div');
 
     if (elm.style.animationName !== undefined) {
         animation = true;
     }
 
     if (animation === false && allowPrefix) {
-            for (var i = 0; i < domPrefixes.length; i++) {
+        for (let i = 0; i < domPrefixes.length; i++) {
             if (elm.style[domPrefixes[i] + 'AnimationName'] !== undefined) {
                 animation = true;
                 break;
@@ -122,12 +119,12 @@ define([], function () {
         _supportsCssAnimation = animation;
         return _supportsCssAnimation;
     }
-    }
+}
 
-    var uaMatch = function (ua) {
+const uaMatch = function (ua) {
     ua = ua.toLowerCase();
 
-        var match = /(edg)[ \/]([\w.]+)/.exec(ua) ||
+    const match = /(edg)[ \/]([\w.]+)/.exec(ua) ||
         /(edga)[ \/]([\w.]+)/.exec(ua) ||
         /(edgios)[ \/]([\w.]+)/.exec(ua) ||
         /(edge)[ \/]([\w.]+)/.exec(ua) ||
@@ -139,15 +136,15 @@ define([], function () {
         ua.indexOf('compatible') < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
         [];
 
-        var versionMatch = /(version)[ \/]([\w.]+)/.exec(ua);
+    const versionMatch = /(version)[ \/]([\w.]+)/.exec(ua);
 
-        var platform_match = /(ipad)/.exec(ua) ||
+    let platform_match = /(ipad)/.exec(ua) ||
         /(iphone)/.exec(ua) ||
         /(windows)/.exec(ua) ||
         /(android)/.exec(ua) ||
         [];
 
-        var browser = match[1] || '';
+    let browser = match[1] || '';
 
     if (browser === 'edge') {
         platform_match = [''];
@@ -157,14 +154,14 @@ define([], function () {
         browser = 'opera';
     }
 
-        var version;
+    let version;
     if (versionMatch && versionMatch.length > 2) {
         version = versionMatch[2];
     }
 
     version = version || match[2] || '0';
 
-        var versionMajor = parseInt(version.split('.')[0]);
+    let versionMajor = parseInt(version.split('.')[0]);
 
     if (isNaN(versionMajor)) {
         versionMajor = 0;
@@ -176,85 +173,84 @@ define([], function () {
         platform: platform_match[0] || '',
         versionMajor: versionMajor
     };
-    };
+};
 
-    var userAgent = navigator.userAgent;
+const userAgent = navigator.userAgent;
 
-    var matched = uaMatch(userAgent);
+const matched = uaMatch(userAgent);
-    var browser = {};
+const browser = {};
 
-    if (matched.browser) {
+if (matched.browser) {
     browser[matched.browser] = true;
     browser.version = matched.version;
     browser.versionMajor = matched.versionMajor;
-    }
+}
 
-    if (matched.platform) {
+if (matched.platform) {
     browser[matched.platform] = true;
-    }
+}
 
-    browser.edgeChromium = browser.edg || browser.edga || browser.edgios;
+browser.edgeChromium = browser.edg || browser.edga || browser.edgios;
 
-    if (!browser.chrome && !browser.edgeChromium && !browser.edge && !browser.opera && userAgent.toLowerCase().indexOf('webkit') !== -1) {
+if (!browser.chrome && !browser.edgeChromium && !browser.edge && !browser.opera && userAgent.toLowerCase().indexOf('webkit') !== -1) {
     browser.safari = true;
-    }
+}
 
-    if (userAgent.toLowerCase().indexOf('playstation 4') !== -1) {
+if (userAgent.toLowerCase().indexOf('playstation 4') !== -1) {
     browser.ps4 = true;
     browser.tv = true;
-    }
+}
 
-    if (isMobile(userAgent)) {
+if (isMobile(userAgent)) {
     browser.mobile = true;
-    }
+}
 
-    if (userAgent.toLowerCase().indexOf('xbox') !== -1) {
+if (userAgent.toLowerCase().indexOf('xbox') !== -1) {
     browser.xboxOne = true;
     browser.tv = true;
-    }
+}
-    browser.animate = typeof document !== 'undefined' && document.documentElement.animate != null;
+browser.animate = typeof document !== 'undefined' && document.documentElement.animate != null;
-    browser.tizen = userAgent.toLowerCase().indexOf('tizen') !== -1 || self.tizen != null;
+browser.tizen = userAgent.toLowerCase().indexOf('tizen') !== -1 || self.tizen != null;
-    browser.web0s = userAgent.toLowerCase().indexOf('Web0S'.toLowerCase()) !== -1;
+browser.web0s = userAgent.toLowerCase().indexOf('Web0S'.toLowerCase()) !== -1;
-    browser.edgeUwp = browser.edge && (userAgent.toLowerCase().indexOf('msapphost') !== -1 || userAgent.toLowerCase().indexOf('webview') !== -1);
+browser.edgeUwp = browser.edge && (userAgent.toLowerCase().indexOf('msapphost') !== -1 || userAgent.toLowerCase().indexOf('webview') !== -1);
 
-    if (!browser.tizen) {
+if (!browser.tizen) {
     browser.orsay = userAgent.toLowerCase().indexOf('smarthub') !== -1;
-    } else {
+} else {
-        var v = (navigator.appVersion).match(/Tizen (\d+).(\d+)/);
+    const v = (navigator.appVersion).match(/Tizen (\d+).(\d+)/);
     browser.tizenVersion = parseInt(v[1]);
-    }
+}
 
-    if (browser.edgeUwp) {
+if (browser.edgeUwp) {
     browser.edge = true;
-    }
+}
 
-    browser.tv = isTv();
+browser.tv = isTv();
-    browser.operaTv = browser.tv && userAgent.toLowerCase().indexOf('opr/') !== -1;
+browser.operaTv = browser.tv && userAgent.toLowerCase().indexOf('opr/') !== -1;
 
-    if (browser.mobile || browser.tv) {
+if (browser.mobile || browser.tv) {
     browser.slow = true;
-    }
+}
 
-    if (typeof document !== 'undefined') {
+if (typeof document !== 'undefined') {
     /* eslint-disable-next-line compat/compat */
     if (('ontouchstart' in window) || (navigator.maxTouchPoints > 0)) {
         browser.touch = true;
     }
-    }
+}
 
-    browser.keyboard = hasKeyboard(browser);
+browser.keyboard = hasKeyboard(browser);
-    browser.supportsCssAnimation = supportsCssAnimation;
+browser.supportsCssAnimation = supportsCssAnimation;
 
-    browser.osx = userAgent.toLowerCase().indexOf('os x') !== -1;
+browser.osx = userAgent.toLowerCase().indexOf('os x') !== -1;
-    browser.iOS = browser.ipad || browser.iphone || browser.ipod;
+browser.iOS = browser.ipad || browser.iphone || browser.ipod;
 
-    if (browser.iOS) {
+if (browser.iOS) {
     browser.iOSVersion = iOSversion();
 
     if (browser.iOSVersion && browser.iOSVersion.length >= 2) {
         browser.iOSVersion = browser.iOSVersion[0] + (browser.iOSVersion[1] / 10);
     }
-    }
+}
 
-    return browser;
+export default browser;
-});