mousehunt-improved 0.97.1 → 0.98.1

package/src/modules/settings/index.js

@@ -1,653 +0,0 @@
-import {
-  addIconToMenu,
-  addStyles,
-  clearCaches,
-  createPopup,
-  dataSet,
-  dbDeleteAll,
-  getCurrentLocation,
-  getCurrentPage,
-  getCurrentTab,
-  getFlag,
-  getSetting,
-  getSettings,
-  makeElement,
-  makeMhButton,
-  onEvent,
-  parseEncodedValue,
-  saveSetting,
-  setPage,
-  showErrorMessage,
-  showSuccessMessage
-} from '@utils';
-
-import settingsSettings from './settings';
-
-import icons from './icons.css';
-import styles from './styles.css';
-
-/**
- * Prepare settings for exporting.
- *
- * @param {Object} settingValues The settings to prepare.
- *
- * @return {Object} The prepared settings.
- */
-const normalizeSettingsForExport = (settingValues = {}) => {
-  const exportableSettings = { ...settingValues };
-
-  if (
-    exportableSettings['override-styles'] &&
-    'string' === typeof exportableSettings['override-styles'] &&
-    ! exportableSettings['override-styles'].startsWith('data:')
-  ) {
-    exportableSettings['override-styles'] = `data:text/css;base64,${btoa(exportableSettings['override-styles'])}`;
-  }
-
-  return exportableSettings;
-};
-
-/**
- * Parse settings text and normalize imported values.
- *
- * @param {string} settingText JSON settings text.
- *
- * @return {Object} The parsed settings object.
- */
-const parseSettingsText = (settingText) => {
-  const parsedSettings = JSON.parse(settingText);
-
-  if (
-    parsedSettings &&
-    parsedSettings['override-styles'] &&
-    'string' === typeof parsedSettings['override-styles'] &&
-    parsedSettings['override-styles'].startsWith('data:')
-  ) {
-    parsedSettings['override-styles'] = parseEncodedValue(parsedSettings['override-styles']);
-  }
-
-  return parsedSettings;
-};
-
-/**
- * Add the export settings button.
- *
- * @param {HTMLElement} append The element to append to.
- *
- * @return {HTMLElement} The export settings button.
- */
-const addExportSettings = (append) => {
-  const existing = document.querySelector('.mousehunt-improved-export-settings');
-  if (existing) {
-    existing.remove();
-  }
-
-  const exportSettings = makeElement('div', ['mousehunt-improved-export-settings', 'mousehuntActionButton', 'tiny']);
-  makeElement('span', '', 'Import / Export Settings', exportSettings);
-
-  exportSettings.addEventListener('click', (e) => {
-    e.preventDefault();
-    e.stopPropagation();
-
-    const settings = JSON.stringify(normalizeSettingsForExport(getSettings()), null, 2);
-    const content = `<div class="mousehunt-improved-settings-export-popup-content">
-    <div class="mousehunt-improved-settings-export-popup-tip">
-      Import settings by dragging a file here or pasting text into the box.
-    </div>
-    <textarea id="mousehunt-improved-settings-text" spellcheck="false">${settings}</textarea>
-    <div class="mousehunt-improved-settings-export-popup-buttons">
-      <div class="mousehunt-improved-settings-export-details">
-        <a href="#" class="export-copy">Copy to clipboard</a>
-        <a href="#" class="export-download">Download JSON file</a>
-        <hr>
-        <a href="#" class="export-upload">Import from file</a>
-        <a href="#" class="export-format">Format</a>
-        <a href="#" class="export-reset">Reset to default</a>
-      </div>
-      <div class="mousehunt-improved-settings-export-popup-buttons-buttons">
-        <div class="mousehuntActionButton save">
-          <span>Save</span>
-        </div>
-        <div class="mousehuntActionButton cancel">
-          <span>Cancel</span>
-        </div>
-      </div>
-    </div>`;
-
-    /* eslint-disable @wordpress/no-unused-vars-before-return */
-    const popup = createPopup({
-      title: `MouseHunt Improved Settings <code>v${mhImprovedVersion}</code>`,
-      content,
-      className: 'mousehunt-improved-settings-export-popup',
-      show: true,
-    });
-    /* eslint-enable @wordpress/no-unused-vars-before-return */
-
-    // Save the current settings to the backup.
-    if (! window.location.search.includes('safe-mode')) {
-      localStorage.setItem('mousehunt-improved-settings-backup', JSON.stringify(getSettings()));
-    }
-
-    const popupElement = document.querySelector('.mousehunt-improved-settings-export-popup');
-    if (! popupElement) {
-      return;
-    }
-
-    const textarea = popupElement.querySelector('textarea');
-
-    textarea.addEventListener('dragover', (dragevent) => {
-      dragevent.preventDefault();
-      textarea.classList.add('dragover');
-    });
-
-    // Add the drop event listener
-    textarea.addEventListener('drop', (dropevent) => {
-      dropevent.preventDefault();
-
-      textarea.classList.remove('dragover');
-
-      // Get the file
-      if (! dropevent.dataTransfer?.files?.length) {
-        return;
-      }
-
-      const file = dropevent.dataTransfer.files[0];
-      const reader = new FileReader();
-
-      /**
-       * When the file is loaded, set the textarea value to the file contents.
-       *
-       * @param {Event} loadEvent The load event.
-       */
-      reader.onload = (loadEvent) => {
-        textarea.value = loadEvent.target.result;
-      };
-
-      reader.readAsText(file);
-    });
-
-    const uploadButton = popupElement.querySelector('.export-upload');
-    uploadButton.addEventListener('click', (evt) => {
-      evt.preventDefault();
-
-      // prompt the user to select a file
-      const input = document.createElement('input');
-      input.type = 'file';
-      input.accept = '.json';
-      input.addEventListener('change', (changeEvent) => {
-        if (! changeEvent?.target?.files?.length) {
-          return;
-        }
-
-        const file = changeEvent.target.files[0];
-        const reader = new FileReader();
-
-        /**
-         * When the file is loaded, set the textarea value to the file contents.
-         *
-         * @param {Event} loadEvent The load event.
-         */
-        reader.onload = (loadEvent) => {
-          textarea.value = loadEvent.target.result;
-        };
-
-        reader.readAsText(file);
-      });
-
-      input.click();
-    });
-
-    const resetButton = popupElement.querySelector('.export-reset');
-    resetButton.addEventListener('click', (evt) => {
-      evt.preventDefault();
-      textarea.value = JSON.stringify({
-        'mh-improved-platform': mhImprovedPlatform,
-        'mh-improved-version': mhImprovedVersion,
-      }, null, 2);
-    });
-
-    const formatButton = popupElement.querySelector('.export-format');
-    formatButton.addEventListener('click', (evt) => {
-      evt.preventDefault();
-
-      let currentSettings = {};
-      try {
-        currentSettings = parseSettingsText(textarea.value);
-      } catch {
-        showErrorMessage({
-          message: 'Invalid JSON. Unable to format settings.',
-          append: formatButton,
-          after: true,
-          classname: 'settings-export-format-error',
-        });
-
-        return;
-      }
-
-      // sort the keys alphabetically, with the mh-improved keys at the top
-      const sorted = Object.keys(currentSettings).sort((a, b) => {
-        if (a.startsWith('mh-improved') && ! b.startsWith('mh-improved')) {
-          return -1;
-        }
-
-        if (b.startsWith('mh-improved') && ! a.startsWith('mh-improved')) {
-          return 1;
-        }
-
-        return a.localeCompare(b);
-      });
-
-      const newSettings = {};
-      sorted.forEach((key) => {
-        newSettings[key] = currentSettings[key];
-      });
-
-      textarea.value = JSON.stringify(newSettings, null, 2);
-    });
-
-    const saveButton = popupElement.querySelector('.mousehuntActionButton.save');
-    saveButton.addEventListener('click', () => {
-      let newSettings = {};
-
-      // Verify that the settings are valid JSON
-      try {
-        newSettings = parseSettingsText(textarea.value);
-      } catch (error) {
-        showErrorMessage({
-          message: 'Invalid JSON. Settings not saved.',
-          append: saveButton,
-          after: true,
-          classname: 'settings-export-save-error',
-        });
-
-        console.error(error); // eslint-disable-line no-console
-
-        return;
-      }
-
-      localStorage.setItem('mousehunt-improved-settings-backup', localStorage.getItem('mousehunt-improved-settings'));
-      localStorage.setItem('mousehunt-improved-settings', JSON.stringify(newSettings));
-
-      showSuccessMessage({
-        message: 'Settings saved. Refreshing…',
-        append: saveButton,
-        after: true,
-        classname: 'settings-export-save-success',
-      });
-
-      setTimeout(() => window.location.reload(), 0);
-    });
-
-    const copyButton = popupElement.querySelector('.export-copy');
-    copyButton.addEventListener('click', (evt) => {
-      evt.preventDefault();
-      navigator.clipboard.writeText(textarea.value);
-      showSuccessMessage({
-        message: 'Settings copied to clipboard.',
-        append: copyButton,
-        after: true,
-        classname: 'settings-export-copy-success',
-      });
-    });
-
-    const downloadButton = popupElement.querySelector('.export-download');
-    downloadButton.addEventListener('click', (evt) => {
-      evt.preventDefault();
-      const link = document.createElement('a');
-      link.download = 'mousehunt-improved-settings.json';
-      link.href = `data:application/json;base64,${btoa(textarea.value)}`;
-      link.click();
-    });
-
-    const cancelButton = popupElement.querySelector('.mousehuntActionButton.cancel');
-    cancelButton.addEventListener('click', () => {
-      popup.hide();
-    });
-  });
-
-  append.append(exportSettings);
-
-  return exportSettings;
-};
-
-/**
- * Add the advanced settings buttons.
- */
-const addAdvancedSettingsButtons = () => {
-  const settingInput = document.querySelector('#mousehunt-improved-settings-advanced-mh-improved-advanced-settings .PagePreferences__setting');
-  if (settingInput) {
-    addExportSettings(settingInput);
-  }
-
-  const settingWrapper = document.querySelector('#mousehunt-improved-settings-advanced-wrapper');
-  if (! settingWrapper) {
-    return;
-  }
-
-  const existing = document.querySelector('.mousehunt-improved-advanced-buttons');
-  if (existing) {
-    existing.remove();
-  }
-
-  const buttonsWrapper = makeElement('div', 'mousehunt-improved-advanced-buttons');
-
-  const clearCachedDataLink = makeElement('a', 'clear-cache-link', 'Clear Cached Data');
-  clearCachedDataLink.href = '#';
-  clearCachedDataLink.addEventListener('click', async (e) => {
-    e.preventDefault();
-    if (window.confirm('Are you sure you want to clear the cached data?')) { // eslint-disable-line no-alert
-      await clearCaches();
-
-      // Delete all the mh-improved keys that are in session storage.
-      for (const key of Object.keys(sessionStorage)) {
-        if (key.startsWith('mh-improved')) {
-          sessionStorage.removeItem(key);
-        }
-      }
-
-      // Clear the ar
-      localStorage.removeItem(`mh-improved-cached-ar-v${mhImprovedVersion}`);
-
-      window.location.reload();
-    }
-  });
-  buttonsWrapper.append(clearCachedDataLink);
-
-  const resetJournalLink = makeElement('a', 'reset-link', 'Reset Journal History');
-  resetJournalLink.href = '#';
-  resetJournalLink.addEventListener('click', async (e) => {
-    e.preventDefault();
-    if (window.confirm('Are you sure you want to reset your journal history?')) { // eslint-disable-line no-alert
-      await dbDeleteAll('journal');
-      window.location.reload();
-    }
-  });
-  buttonsWrapper.append(resetJournalLink);
-
-  const resetDashboardLink = makeElement('a', 'reset-link', 'Reset Location Dashboard');
-  resetDashboardLink.href = '#';
-  resetDashboardLink.addEventListener('click', async (e) => {
-    e.preventDefault();
-    if (window.confirm('Are you sure you want to reset your dashboard data?')) { // eslint-disable-line no-alert
-      await dataSet('quests', {});
-      window.location.reload();
-    }
-  });
-  buttonsWrapper.append(resetDashboardLink);
-
-  settingWrapper.append(buttonsWrapper);
-};
-
-/**
- * Highlight the current location in the location hud settings.
- */
-const highlightLocationHud = () => {
-  const locationHudSettings = document.querySelector(`#mousehunt-improved-settings-location-hud-location-huds-enabled-${getCurrentLocation()}`);
-  if (locationHudSettings) {
-    locationHudSettings.classList.add('highlight');
-  }
-};
-
-/**
- * Add toggles to the settings page headers.
- */
-const addTogglesToSettings = () => {
-  const settingsPage = document.querySelectorAll('.PagePreferences .mousehuntHud-page-tabContent.game_settings.mousehunt-improved-settings .PagePreferences__section');
-  if (! settingsPage) {
-    return;
-  }
-
-  const toggles = document.querySelectorAll('.mhui-setting-toggle');
-  toggles.forEach((toggle) => {
-    toggle.remove();
-  });
-
-  // Beta section is default hidden.
-  let toggledSections = getSetting('settings.toggled-sections', ['mousehunt-improved-settings-beta', 'mousehunt-improved-settings-advanced']);
-
-  settingsPage.forEach((setting) => {
-    // Append an svg to toggle the class
-    const toggle = makeElement('div', 'mhui-setting-toggle');
-    const titleText = setting.querySelector('.PagePreferences__titleText');
-    if (titleText.childNodes.length > 1) {
-      titleText.insertBefore(toggle, titleText.childNodes[1]);
-    } else {
-      titleText.append(toggle);
-    }
-
-    // add the event listener to toggle the class
-    titleText.addEventListener('click', (event) => {
-      if (event.target.tagName === 'A') {
-        return;
-      }
-
-      event.preventDefault();
-
-      toggledSections = getSetting('settings.toggled-sections', ['mousehunt-improved-settings-beta', 'mousehunt-improved-settings-advanced']);
-
-      const toggled = setting.classList.contains('toggled');
-      if (toggled) {
-        setting.classList.remove('toggled');
-        toggle.classList.remove('toggled');
-
-        // save to session storage
-        toggledSections = toggledSections.filter((section) => section !== setting.id);
-      } else {
-        setting.classList.add('toggled');
-        toggle.classList.add('toggled');
-
-        // save to session storage
-        toggledSections.push(setting.id);
-      }
-
-      saveSetting('settings.toggled-sections', toggledSections);
-    });
-
-    if (toggledSections.includes(setting.id)) {
-      setting.classList.add('toggled');
-      toggle.classList.add('toggled');
-    } else {
-      setting.classList.remove('toggled');
-      toggle.classList.remove('toggled');
-    }
-  });
-};
-
-/**
- * Move the tab to the end.
- */
-const moveTabToEnd = () => {
-  const mhImprovedTab = document.querySelector('#mousehunt-improved-settings');
-  if (! mhImprovedTab) {
-    return;
-  }
-
-  const userscriptTab = document.querySelector('#userscript-settings');
-  if (! userscriptTab) {
-    return;
-  }
-
-  userscriptTab.after(mhImprovedTab);
-};
-
-const addHeaderToSettings = () => {
-  const settingsPage = document.querySelector('.mousehuntHud-page-tabContent.game_settings.mousehunt-improved-settings.active');
-  if (! settingsPage) {
-    return;
-  }
-
-  const existingHeader = document.querySelector('.mhui-settings-header');
-  if (existingHeader) {
-    return;
-  }
-
-  const header = makeElement('div', 'mhui-settings-header');
-  const title = makeElement('div', 'mhui-settings-header-title', `MouseHunt Improved <a title="View release notes" href="https://github.com/MHCommunity/mousehunt-improved/releases/tag/v${mhImprovedVersion}" target="_blank" rel="noopener noreferrer">v${mhImprovedVersion}</a>`);
-  header.append(title);
-
-  const searchWrapper = makeElement('div', 'mhui-settings-header-wrapper');
-
-  const searchLabel = makeElement('label', 'mhui-settings-header-search-label', 'Search:');
-  searchWrapper.append(searchLabel);
-
-  const searchField = makeElement('input', 'mhui-settings-header-search');
-  searchField.type = 'text';
-  searchField.placeholder = 'Search settings…';
-  searchField.autocomplete = 'off';
-  searchField.autofocus = true;
-  searchField.addEventListener('input', (e) => {
-    const searchTerm = e.target.value.toLowerCase();
-
-    if (searchTerm) {
-      settingsPage.classList.add('mhui-settings-search-active');
-    } else {
-      settingsPage.classList.remove('mhui-settings-search-active');
-    }
-
-    const settingSections = settingsPage.querySelectorAll('.PagePreferences__section');
-    settingSections.forEach((section) => {
-      const sectionTitle = section.querySelector('.PagePreferences__titleText').textContent.toLowerCase();
-      let sectionMatches = sectionTitle.includes(searchTerm);
-
-      const settings = section.querySelectorAll('.PagePreferences__sectionWrapper > .PagePreferences__settingsList');
-      settings.forEach((setting) => {
-        let settingText = setting.textContent.toLowerCase();
-        const settingTextInInput = setting.querySelectorAll('.multiSelect');
-        if (settingTextInInput && settingTextInInput.length) {
-          settingTextInInput.forEach((inputEl) => {
-            settingText = settingText.replace(inputEl.textContent.toLowerCase(), '');
-          });
-        }
-        const settingMatches = settingText.includes(searchTerm);
-
-        if (settingMatches) {
-          setting.style.display = '';
-          sectionMatches = true;
-        } else {
-          setting.style.display = 'none';
-        }
-      });
-
-      section.style.display = sectionMatches ? '' : 'none';
-    });
-  });
-  searchWrapper.append(searchField);
-  header.append(searchWrapper);
-
-  settingsPage.prepend(header);
-};
-
-const addTableOfContents = () => {
-  const settingsPage = document.querySelector('.mousehuntHud-page-tabContent.game_settings.mousehunt-improved-settings.active');
-  if (! settingsPage) {
-    return;
-  }
-
-  const existingToc = document.querySelector('.mhui-settings-toc-wrapper');
-  if (existingToc) {
-    return;
-  }
-
-  const tocWrapper = makeElement('div', 'mhui-settings-toc-wrapper');
-
-  const tocText = makeElement('div', 'mhui-settings-toc-text', 'Jump to:');
-  tocWrapper.append(tocText);
-
-  const tocList = makeElement('ul', 'mhui-settings-toc-list');
-
-  const sections = settingsPage.querySelectorAll('.PagePreferences__section');
-  sections.forEach((section) => {
-    const sectionId = section.id;
-    const sectionTitleEl = section.querySelector('.PagePreferences__titleText');
-    if (sectionId && sectionTitleEl) {
-      const sectionTitle = sectionTitleEl.textContent.trim();
-      const tocItem = makeElement('li', 'mhui-settings-toc-item');
-      makeMhButton({
-        text: sectionTitle,
-        className: 'mhui-settings-toc-link',
-        href: `#${sectionId}`,
-        callback: (e) => {
-          const targetSection = document.querySelector(`#${sectionId}`);
-          if (targetSection) {
-            e.preventDefault();
-            targetSection.scrollIntoView({ behavior: 'smooth' });
-          }
-        },
-        appendTo: tocItem,
-      });
-      tocList.append(tocItem);
-    }
-  });
-
-  tocWrapper.append(tocList);
-
-  const header = document.querySelector('.mhui-settings-header');
-  if (header) {
-    header.after(tocWrapper);
-  } else {
-    settingsPage.prepend(tocWrapper);
-  }
-};
-
-/**
- * Add the icon to the menu.
- */
-const addMhImprovedIconToMenu = () => {
-  addIconToMenu({
-    id: 'mousehunt-improved-icon-menu',
-    href: 'https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings',
-    title: 'MouseHunt Improved Settings',
-    position: 'append',
-
-    /**
-     * The action to perform when the icon is clicked.
-     *
-     * @param {Event} e The event.
-     */
-    action: (e) => {
-      if ('preferences' === getCurrentPage() && 'mousehunt-improved-settings' === getCurrentTab()) {
-        e.preventDefault();
-        setPage('Camp');
-      }
-    },
-  });
-};
-
-/**
- * Initialize the module.
- */
-const init = async () => {
-  addStyles([
-    styles,
-    icons,
-  ], 'mousehunt-improved-settings');
-
-  addMhImprovedIconToMenu();
-
-  moveTabToEnd();
-  addHeaderToSettings();
-
-  onEvent('mh-improved-setting-added-to-page', (module) => {
-    // this is the last setting added, so we can run our final setup.
-    if (module?.key === 'error-reporting') {
-      if (getFlag('settings-table-of-contents')) {
-        addTableOfContents();
-      }
-
-      highlightLocationHud();
-      addAdvancedSettingsButtons();
-      addTogglesToSettings();
-    }
-  });
-};
-
-/**
- * Initialize the module.
- */
-export default {
-  id: '_settings',
-  type: 'advanced',
-  alwaysLoad: true,
-  load: init,
-  settings: settingsSettings,
-};

package/src/modules/settings/settings/index.js

@@ -1,16 +0,0 @@
-/**
- * Add settings for the module.
- *
- * @return {Array} The settings for the module.
- */
-export default async () => {
-  return [{
-    id: 'mh-improved-advanced-settings',
-    title: '',
-    default: true,
-    description: '',
-    settings: {
-      type: 'blank',
-    }
-  }];
-};