mousehunt-improved 0.97.1 → 0.98.1

package/src/modules/data-exporters/index.js

@@ -1,147 +0,0 @@
-import { addStyles, addSubmenuItem, createPopup, onEvent } from '@utils';
-
-import { exportFavoriteSetupsUserscript, hasFavoriteSetupsUserscript } from './exporters/export-favorite-setups-userscript';
-import { exportRankupForecaster, hasRankupForecaster } from './exporters/export-rankup-forecaster';
-
-import exportCrowns from './exporters/export-kings-crowns';
-import exportFavoriteSetups from './exporters/export-favorite-setups';
-import exportInventory from './exporters/export-inventory';
-import exportJournalEntries from './exporters/export-journal-entries';
-import exportMarketplace from './exporters/export-marketplace';
-import exportMice from './exporters/export-mice';
-import exportScoreboards from './exporters/export-scoreboards';
-
-import styles from './styles.css';
-
-/**
- * Export the data.
- */
-const exportDataPopup = () => {
-  const exporters = [
-    {
-      id: 'mouse-stats-by-group',
-      name: 'Mouse Stats by Group',
-      callback: () => exportMice('group'),
-    },
-    {
-      id: 'mouse-stats-by-region',
-      name: 'Mouse Stats by Region',
-      callback: () => exportMice('region'),
-    },
-    {
-      id: 'mouse-stats-by-location',
-      name: 'Mouse Stats by Location',
-      callback: () => exportMice('location'),
-    },
-    {
-      id: 'kings-crowns',
-      name: 'Mouse Stats by Crowns',
-      callback: exportCrowns,
-    },
-    {
-      id: 'inventory',
-      name: 'Inventory',
-      callback: exportInventory,
-    },
-    {
-      id: 'marketplace-transactions',
-      name: 'Marketplace Transactions',
-      callback: exportMarketplace,
-    },
-    {
-      id: 'scoreboard-rankings',
-      name: 'Scoreboard Rankings',
-      callback: exportScoreboards,
-    },
-    {
-      id: 'scoreboard-rankings-weekly',
-      name: 'Scoreboard Rankings (Weekly)',
-      callback: () => exportScoreboards({ useWeekly: true }),
-    },
-    {
-      id: 'scoreboard-rankings-friends',
-      name: 'Scoreboard Rankings (Friends)',
-      callback: () => exportScoreboards({ useFriendsOnly: true }),
-    },
-    {
-      id: 'scoreboard-rankings-weekly-friends',
-      name: 'Scoreboard Rankings (Weekly, Friends)',
-      callback: () => exportScoreboards({ useWeekly: true, useFriendsOnly: true }),
-    },
-    {
-      id: 'journal-entries',
-      name: 'Journal Entries',
-      callback: exportJournalEntries,
-    },
-    {
-      id: 'favorite-setups',
-      name: 'Favorite Setups',
-      callback: exportFavoriteSetups,
-    }
-  ];
-
-  if (hasFavoriteSetupsUserscript()) {
-    exporters.push({
-      id: 'favorite-setups-userscript',
-      name: 'Favorite Setups (userscript)',
-      callback: exportFavoriteSetupsUserscript,
-    });
-  }
-
-  if (hasRankupForecaster()) {
-    exporters.push({
-      id: 'rankup-forecaster-history',
-      name: 'Rankup Forecaster History',
-      callback: exportRankupForecaster,
-    });
-  }
-
-  let exporterList = '';
-  exporters.forEach(({ id, name }) => {
-    exporterList += `<li><a href="#" id="export-${id}">${name}</a></li>`;
-  });
-
-  createPopup({
-    title: 'Export Data',
-    content: `<ul class="mh-improved-export-data-landing">${exporterList}</ul>`,
-  });
-
-  exporters.forEach(({ id, callback }) => {
-    const button = document.querySelector(`#export-${id}`);
-    if (button) {
-      button.addEventListener('click', (e) => {
-        e.preventDefault();
-        callback();
-      });
-    }
-  });
-};
-
-/**
- * Initialize the module.
- */
-const init = () => {
-  addStyles(styles, 'data-exporters');
-
-  onEvent('show-export-data', exportDataPopup);
-
-  addSubmenuItem({
-    menu: 'kingdom',
-    label: 'Export Data',
-    icon: 'https://www.mousehuntgame.com/images/items/crafting_items/transparent_thumb/c6f39c2b522f114c788f5fb65e3ab8d7.png',
-    class: 'export-data',
-    callback: exportDataPopup,
-  });
-};
-
-/**
- * Initialize the module.
- */
-export default {
-  id: 'data-exporters',
-  name: 'Data Exporters',
-  type: 'feature',
-  default: true,
-  description: 'Export data from the game.',
-  load: init,
-};

package/src/modules/data-exporters/styles.css

@@ -1,113 +0,0 @@
-#custom-submenu-item-export-data .icon {
-  filter: sepia(1) brightness(0.7);
-}
-
-.export-wrapper {
-  display: flex;
-  flex-direction: column;
-  justify-content: space-around;
-}
-
-.export-items-wrapper {
-  max-height: 70vh;
-  overflow: auto;
-  border: 1px solid #7e7e7e;
-}
-
-.item-wrapper {
-  display: grid;
-  grid-template-columns: 2fr repeat(3, 1fr);
-  padding: 3px 5px;
-  margin-bottom: 2px;
-  font-size: 11px;
-}
-
-.inventory .item-wrapper,
-.scoreboard-rankings .item-wrapper,
-.rankup-forecaster-history .item-wrapper,
-.marketplace-transactions .item-wrapper {
-  grid-template-columns: 2fr 1fr;
-}
-
-.item-wrapper .total-items {
-  text-align: right;
-}
-
-.item-wrapper:nth-child(odd) {
-  background-color: #e2e2e2;
-}
-
-.item-wrapper.hidden {
-  display: none;
-}
-
-.item-wrapper.export-items-header,
-.item-wrapper.export-items-footer {
-  padding: 5px;
-  margin-bottom: 0;
-  font-size: 12px;
-  text-align: center;
-  background-color: #bcbcbc;
-  border: 1px solid #7e7e7e;
-}
-
-.item-wrapper.export-items-header {
-  border-bottom: none;
-}
-
-.item-wrapper.export-items-footer {
-  border-top: none;
-}
-
-.rankup-forecaster-history .item-wrapper,
-.marketplace-transactions .item-wrapper {
-  border-top: 1px solid #7e7e7e;
-}
-
-.export-items-header .region-name,
-.export-items-footer .region-name {
-  text-align: left;
-}
-
-.item-wrapper:last-child {
-  margin-bottom: 0;
-}
-
-.actions-wrapper {
-  display: grid;
-  grid-template-columns: 1fr 3fr 1fr 1fr 1fr;
-  place-items: center end;
-  margin-top: 10px;
-}
-
-.actions-wrapper .hidden {
-  display: block;
-  visibility: hidden;
-}
-
-.actions-wrapper #export-back {
-  justify-self: start;
-}
-
-.actions-wrapper .fetch-data {
-  justify-self: center;
-}
-
-.mh-improved-export-data-landing {
-  margin-left: 20px;
-  line-height: 2;
-  list-style: disc;
-}
-
-.item-wrapper .mice-caught,
-.item-wrapper .total-catches {
-  text-align: center;
-}
-
-.item-wrapper .total-weight {
-  text-align: right;
-}
-
-.mh-improved-export-data .extra-text {
-  text-align: center;
-}

package/src/modules/data-exporters/utils.js

@@ -1,355 +0,0 @@
-import { createPopup, doEvent } from '@utils';
-
-/**
- * Fetch data recursively.
- *
- * @param {Array}    data          The data to fetch.
- * @param {Function} callbackToRun The callback function to run.
- *
- * @return {Promise<Array>} Resolves with the results.
- */
-const recursiveFetch = (data, callbackToRun) => {
-  return data.reduce((promiseChain, item) => {
-    return promiseChain.then((chainResults) => {
-      return new Promise((resolve) => {
-        // eslint-disable-next-line promise/catch-or-return
-        callbackToRun(item).then((currentResult) => {
-          chainResults.push(currentResult);
-          resolve(chainResults);
-        });
-      });
-    });
-  }, Promise.resolve([]));
-};
-
-/**
- * Add a download button to the page.
- *
- * @param {Object}   opts                The options object.
- * @param {string}   opts.buttonSelector The selector for the button.
- * @param {Array}    opts.results        The results to download.
- * @param {string}   opts.filename       The filename to use.
- * @param {Function} opts.beforeDownload The function to run before downloading.
- * @param {Function} callback            The callback function to run.
- */
-const addDownloadToButton = (opts, callback) => {
-  let { buttonSelector, results, filename, beforeDownload } = opts;
-
-  const exportButton = document.querySelector(buttonSelector);
-  if (! exportButton) {
-    return;
-  }
-
-  exportButton.classList.remove('disabled');
-
-  // download the file when the export button is clicked
-  exportButton.addEventListener('click', () => {
-    if (beforeDownload) {
-      results = opts.beforeDownload();
-    }
-
-    callback(results, filename);
-  });
-};
-
-/**
- * Add a JSON download to the button.
- *
- * @param {Object}   opts                The options object.
- * @param {string}   opts.buttonSelector The selector for the button.
- * @param {Array}    opts.results        The results to download.
- * @param {string}   opts.filename       The filename to use.
- * @param {Function} opts.beforeDownload The function to run before downloading.
- */
-const addJsonDownloadToButton = (opts) => {
-  addDownloadToButton(opts, (results, filename) => {
-    const data = JSON.stringify({
-      type: opts.type,
-      generated: new Date().toISOString(),
-      data: results,
-    });
-
-    const blob = new Blob([data], { type: 'application/json' });
-    const url = URL.createObjectURL(blob);
-    const link = document.createElement('a');
-    link.download = `${filename}.json`;
-    link.href = url;
-    link.click();
-
-    // cleanup
-    URL.revokeObjectURL(url);
-  });
-};
-
-/**
- * Add a CSV download to the button.
- *
- * @param {Object}   opts                The options object.
- * @param {string}   opts.buttonSelector The selector for the button.
- * @param {Array}    opts.results        The results to download.
- * @param {string}   opts.filename       The filename to use.
- * @param {Array}    opts.headers        The headers for the CSV.
- * @param {Function} opts.reduceResults  The function to reduce the results.
- */
-const addCsvDownloadToButton = (opts) => {
-  addDownloadToButton(opts, (results, filename) => {
-    // reduce the results if needed
-    if (opts.reduceResults) {
-      results = resultReducer(results);
-    }
-
-    let csv = results
-      .map((row) => {
-        return Object.values(row)
-          .map((value) => `"${value}"`)
-          .join(',');
-      })
-      .join('\n');
-
-    if (opts.headers) {
-      csv = `${opts.headers.join(',')}\n${csv}`;
-    }
-
-    const blob = new Blob([csv], { type: 'text/csv' });
-    const url = URL.createObjectURL(blob);
-    const link = document.createElement('a');
-    link.download = `${filename}.csv`;
-    link.href = url;
-    link.click();
-
-    // cleanup
-    URL.revokeObjectURL(url);
-  });
-};
-
-/**
- * Get the formatted date.
- *
- * @return {string} The formatted date.
- */
-const getFormattedDate = () => {
-  const date = new Date();
-  return `${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}`;
-};
-
-/**
- * Add download buttons to the page.
- *
- * @param {Object}   opts               The options object.
- * @param {string}   opts.type          The type of data.
- * @param {Array}    opts.results       The results to download.
- * @param {Array}    opts.headers       The headers for the CSV.
- * @param {Function} opts.reduceResults The function to reduce the results.
- */
-const addDownloadButtons = (opts) => {
-  const { type, results, headers, reduceResults } = opts;
-
-  const filename = `${type}-${getFormattedDate()}`;
-  const buttonSelector = `#export-${type}`;
-
-  addJsonDownloadToButton({
-    buttonSelector,
-    type,
-    results,
-    filename,
-  });
-
-  addCsvDownloadToButton({
-    buttonSelector: `${buttonSelector}-csv`,
-    results,
-    filename,
-    headers,
-    reduceResults,
-  });
-};
-
-const addCopyButton = ({ type, results }) => {
-  const copyButton = document.querySelector(`#copy-${type}`);
-  if (! copyButton) {
-    return;
-  }
-
-  const copyText = copyButton.querySelector('span');
-  if (! copyText) {
-    return;
-  }
-
-  copyButton.classList.remove('disabled');
-
-  copyButton.addEventListener('click', () => {
-    copyButton.classList.add('disabled');
-    const formattedResults = results.join('\n');
-
-    navigator.clipboard.writeText(formattedResults).then(() => {
-      copyButton.classList.remove('disabled');
-      copyText.textContent = 'Copied!';
-      setTimeout(() => {
-        copyText.textContent = 'Copy Data';
-      }, 2000);
-    }).catch(() => {
-      copyButton.classList.remove('disabled');
-      copyText.textContent = 'Copy Failed';
-      setTimeout(() => {
-        copyText.textContent = 'Copy Data';
-      }, 2000);
-    });
-  });
-};
-
-/**
- * Reduce the results.
- *
- * @param {Array} results The results to reduce.
- *
- * @return {Array} The reduced results.
- */
-const resultReducer = (results) => {
-  return results.reduce((acc, { category, items }) => {
-    items.forEach((data) => {
-      acc.push({
-        region: category,
-        ...data,
-      });
-    });
-
-    return acc;
-  }, []);
-};
-
-/**
- * Update the total items count.
- *
- * @param {Array} results The results to process.
- */
-const updateSingleTotalEl = (results) => {
-  const totalItemsEl = document.querySelector('.export-items-footer .total-items');
-  if (! totalItemsEl) {
-    return;
-  }
-
-  // reduce the results to get the totals
-  const totalItems = results.reduce((acc, { items }) => {
-    return acc + items.length;
-  }, 0);
-
-  totalItemsEl.textContent = totalItems.toLocaleString();
-};
-
-/**
- * Show the export popup.
- *
- * @param {Object}   opts                       The options object.
- * @param {string}   opts.type                  The type of data.
- * @param {string}   opts.text                  The text to display.
- * @param {string}   opts.headerMarkup          The header markup.
- * @param {string}   opts.itemsMarkup           The items markup.
- * @param {string}   opts.footerMarkup          The footer markup.
- * @param {Function} opts.fetch                 The fetch function.
- * @param {Function} opts.afterFetch            Function to run after fetching.
- * @param {Function} opts.download              Function to download the data.
- * @param {Function} opts.updateSingleTotal     The update single total function.
- * @param {boolean}  opts.dataIsAvailable       If the data is available.
- * @param {boolean}  opts.copyInsteadOfDownload Shows a copy button instead of download buttons.
- * @param {string}   opts.extraText             Extra text to display below the buttons.
- */
-const exportPopup = ({
-  type,
-  text,
-  headerMarkup,
-  itemsMarkup,
-  footerMarkup,
-  fetch,
-  afterFetch,
-  download,
-  updateSingleTotal,
-  dataIsAvailable,
-  copyInsteadOfDownload = false,
-  extraText = '',
-}) => {
-  createPopup({
-    title: `Export ${text}`,
-    className: 'mh-improved-export-data',
-    content: `
-    <div class="export-wrapper ${type}">
-      <div class="export-items-header item-wrapper ${headerMarkup ? '' : 'hidden'}">
-        ${headerMarkup || ''}
-      </div>
-      <div class="export-items-wrapper ${itemsMarkup ? '' : 'hidden'}">
-        ${itemsMarkup || ''}
-      </div>
-      <div class="export-items-footer item-wrapper ${footerMarkup ? '' : 'hidden'}">
-        ${footerMarkup || ''}
-      </div>
-      <div class="actions-wrapper">
-        <div class="mousehuntActionButton tiny lightBlue" id="export-back">
-          <span>Back</span>
-        </div>
-        <div class="mousehuntActionButton tiny fetch-data ${dataIsAvailable ? 'hidden' : ''}" id="fetch-${type}">
-          <span>Fetch ${text}</span>
-        </div>
-        <div class="mousehuntActionButton copy-data ${dataIsAvailable ? '' : 'disabled'} ${copyInsteadOfDownload ? '' : 'hidden'}" id="copy-${type}">
-          <span>Copy Data</span>
-        </div>
-        <div class="mousehuntActionButton tiny ${dataIsAvailable ? '' : 'disabled'} ${copyInsteadOfDownload ? 'hidden' : ''} export-json" id="export-${type}">
-          <span>Export as JSON</span>
-        </div>
-        <div class="mousehuntActionButton tiny ${dataIsAvailable ? '' : 'disabled'} ${copyInsteadOfDownload ? 'hidden' : ''} export-csv" id="export-${type}-csv">
-          <span>Export as CSV</span>
-        </div>
-      </div>
-    </div>
-    ${extraText ? `<div class="extra-text">${extraText}</div>` : ''}`
-  });
-
-  const exportBackButton = document.querySelector('#export-back');
-  if (! exportBackButton) {
-    return;
-  }
-
-  exportBackButton.addEventListener('click', () => {
-    doEvent('show-export-data');
-  });
-
-  const fetchButton = document.querySelector(`#fetch-${type}`);
-  if (! fetchButton) {
-    return;
-  }
-
-  fetchButton.addEventListener('click', () => {
-    fetchButton.classList.add('disabled');
-
-    // eslint-disable-next-line promise/catch-or-return
-    fetch().then((results) => {
-      if (afterFetch) {
-        afterFetch(results);
-      }
-
-      if (updateSingleTotal) {
-        updateSingleTotalEl(results);
-      }
-
-      addDownloadButtons({
-        results,
-        type,
-        ...download,
-      });
-
-      addCopyButton({
-        type,
-        results,
-      });
-
-      fetchButton.classList.remove('disabled');
-    });
-  });
-
-  if (dataIsAvailable) {
-    fetchButton.click();
-  }
-};
-
-export {
-  recursiveFetch,
-  addDownloadButtons,
-  exportPopup
-};