MOBILE-4910 mainmenu: Add open link method enum

Author: crazyserver

src/core/constants.ts

@@ -125,6 +125,13 @@ export const enum LMSBadgeStyle {
     INFO = 'info',
 }
 
+export enum CoreLinkOpenMethod {
+    APP = 'app',
+    INAPPBROWSER = 'inappbrowser',
+    BROWSER = 'browser',
+    EMBEDDED = 'embedded',
+}
+
 /**
  * Static class to contain all the core constants.
  */

src/core/directives/external-content.ts

@@ -32,7 +32,7 @@ import { CoreLogger } from '@singletons/logger';
 import { CoreError } from '@classes/errors/error';
 import { CoreSite } from '@classes/sites/site';
 import { CoreEventObserver, CoreEvents } from '@singletons/events';
-import { DownloadStatus } from '../constants';
+import { CoreLinkOpenMethod, DownloadStatus } from '../constants';
 import { CoreNetwork } from '@services/network';
 import { Translate } from '@singletons';
 import { AsyncDirective } from '@classes/async-directive';
@@ -370,7 +370,7 @@ export class CoreExternalContentDirective implements AfterViewInit, OnChanges, O
         const tagName = this.element.tagName;
         const openIn = tagName === 'A' && this.element.getAttribute('data-open-in');
 
-        if (openIn === 'app' || openIn === 'browser') {
+        if (openIn === CoreLinkOpenMethod.APP || openIn === CoreLinkOpenMethod.BROWSER) {
             // The file is meant to be opened in browser or InAppBrowser, don't use the downloaded URL because it won't work.
             if (!site.isSitePluginFileUrl(url)) {
                 return url;

src/core/directives/format-text.ts

@@ -53,7 +53,7 @@ import { MediaElementController } from '@classes/element-controllers/MediaElemen
 import { FrameElement, FrameElementController } from '@classes/element-controllers/FrameElementController';
 import { CoreUrl } from '@singletons/url';
 import { CoreIcons } from '@singletons/icons';
-import { ContextLevel } from '../constants';
+import { ContextLevel, CoreLinkOpenMethod } from '../constants';
 import { CoreWait } from '@singletons/wait';
 import { toBoolean } from '../transforms/boolean';
 import { CoreViewer } from '@features/viewer/services/viewer';
@@ -839,7 +839,7 @@ export class CoreFormatTextDirective implements OnDestroy, AsyncDirective {
                 // Try to convert the URL to absolute if needed.
                 url = CoreUrl.toAbsoluteURL(site.getURL(), url);
                 const confirmMessage = element.dataset.appUrlConfirm;
-                const openInApp = element.dataset.openIn === 'app';
+                const openInApp = element.dataset.openIn === CoreLinkOpenMethod.APP;
                 const refreshOnResume = element.dataset.appUrlResumeAction === 'refresh';
 
                 if (confirmMessage) {

src/core/directives/link.ts

@@ -19,7 +19,7 @@ import { CoreFileHelper } from '@services/file-helper';
 import { CoreSites } from '@services/sites';
 import { CoreUrl } from '@singletons/url';
 import { CoreOpener } from '@singletons/opener';
-import { CoreConstants } from '@/core/constants';
+import { CoreConstants, CoreLinkOpenMethod } from '@/core/constants';
 import { CoreContentLinksHelper } from '@features/contentlinks/services/contentlinks-helper';
 import { CoreCustomURLSchemes } from '@services/urlschemes';
 import { DomSanitizer } from '@singletons';
@@ -187,8 +187,8 @@ export class CoreLinkDirective implements OnInit {
     protected async openExternalLink(href: string, openIn?: string | null): Promise<void> {
         // Priority order is: core-link inApp attribute > forceOpenLinksIn setting > data-open-in HTML attribute.
         const openInApp = this.inApp ??
-            (CoreConstants.CONFIG.forceOpenLinksIn !== 'browser' &&
-                (CoreConstants.CONFIG.forceOpenLinksIn === 'app' || openIn === 'app'));
+            (CoreConstants.CONFIG.forceOpenLinksIn !== CoreLinkOpenMethod.BROWSER &&
+                (CoreConstants.CONFIG.forceOpenLinksIn === CoreLinkOpenMethod.APP || openIn === CoreLinkOpenMethod.APP));
 
         // Check if we need to auto-login.
         if (!CoreSites.isLoggedIn()) {

src/core/features/mainmenu/services/mainmenu.ts

@@ -16,7 +16,7 @@ import { Injectable } from '@angular/core';
 
 import { CoreLang, CoreLangFormat, CoreLangLanguage } from '@services/lang';
 import { CoreSites } from '@services/sites';
-import { CoreConstants } from '@/core/constants';
+import { CoreConstants, CoreLinkOpenMethod } from '@/core/constants';
 import { CoreMainMenuDelegate, CoreMainMenuHandlerToDisplay } from './mainmenu-delegate';
 import { Device, makeSingleton } from '@singletons';
 import { CoreText } from '@singletons/text';
@@ -113,7 +113,7 @@ export class CoreMainMenuProvider {
 
         let position = 0; // Position of each item, to keep the same order as it's configured.
 
-        if (!itemsString || typeof itemsString != 'string') {
+        if (!itemsString || typeof itemsString !== 'string') {
             // Setting not valid.
             return result;
         }
@@ -136,7 +136,9 @@ export class CoreMainMenuProvider {
             const id = `${url}#${type}`;
             if (!icon) {
                 // Icon not defined, use default one.
-                icon = type == 'embedded' ? 'fas-expand' : 'fas-link'; // @todo Find a better icon for embedded.
+                icon = type == CoreLinkOpenMethod.EMBEDDED
+                    ? 'fas-expand' // @todo Find a better icon for embedded.
+                    : 'fas-link';
             }
 
             if (!map[id]) {
@@ -283,7 +285,7 @@ export class CoreMainMenuProvider {
      * @returns Promise resolved with boolean: whether it's the root of a main menu tab.
      */
     async isMainMenuTab(pageName: string): Promise<boolean> {
-        if (pageName == MAIN_MENU_MORE_PAGE_NAME) {
+        if (pageName === MAIN_MENU_MORE_PAGE_NAME) {
             return true;
         }
 
@@ -330,7 +332,7 @@ export interface CoreMainMenuCustomItem {
     /**
      * Type of the item: app, inappbrowser, browser or embedded.
      */
-    type: string;
+    type: CoreLinkOpenMethod;
 
     /**
      * Url of the item.
@@ -360,7 +362,7 @@ export type CoreMainMenuLocalizedCustomItem = Omit<CoreMainMenuCustomItem, 'labe
  */
 type CustomMenuItemsMap = Record<string, {
     url: string;
-    type: string;
+    type: CoreLinkOpenMethod;
     position: number;
     labels: {
         [lang: string]: {