mousehunt-improved 0.97.1 → 0.98.1

package/src/utils/flags.js

@@ -1,39 +0,0 @@
-import { getSetting } from './settings';
-
-let flags = null;
-const settings = {};
-
-/**
- * Check if the given flag is enabled.
- *
- * @param {string} flag Flag to check.
- *
- * @return {boolean} Whether the flag is enabled.
- */
-const getFlag = (flag) => {
-  if (flag in settings) {
-    return settings[flag];
-  }
-
-  const value = getSetting(`experiments.${flag}`, getFlags().includes(flag));
-  settings[flag] = value;
-  return value;
-};
-
-/**
- * Get the list of enabled flags.
- *
- * @return {Array} List of enabled flags.
- */
-const getFlags = () => {
-  if (! flags) {
-    flags = getSetting('override-flags', '').toLowerCase().replaceAll(' ', '').split(',');
-  }
-
-  return flags;
-};
-
-export {
-  getFlag,
-  getFlags
-};

package/src/utils/global.js

@@ -1,37 +0,0 @@
-/**
- * Helper function to add a key and value to the global object.
- *
- * @param {string} key   Key to add.
- * @param {any}    value Value to add.
- */
-const setGlobal = (key, value) => {
-  if (! app.mhui) {
-    app.mhui = {};
-  }
-
-  app.mhui[key] = value;
-};
-
-/**
- * Helper function to get a key from the global object.
- *
- * @param {string} key Key to get.
- *
- * @return {any|boolean} Value of the key or false if not found.
- */
-const getGlobal = (key) => {
-  if (app?.mhui && app.mhui[key]) {
-    return app.mhui[key];
-  }
-
-  if (window?.mhui && window.mhui[key]) {
-    return window.mhui[key];
-  }
-
-  return false;
-};
-
-export {
-  setGlobal,
-  getGlobal
-};

package/src/utils/horn.js

@@ -1,187 +0,0 @@
-import { makeElement } from './elements';
-
-/**
- * Show a message in the horn dialog.
- *
- * Type can be: bait_empty unknown_error bait_disarmed recent_turn recent_linked_turn puzzle info error warning success.
- * Available colors: blue, cyan, cyan-alt, green, green-alt, grey, orange, orange-alt, pink, purple, red, red-alt, yellow.
- *
- * @param {Object}   options               Options for the message.
- * @param {string}   options.title         Title of the message. Keep it under 50 characters.
- * @param {string}   options.text          Text of the message. Keep it under 90 characters.
- * @param {string}   options.button        Text of the button.
- * @param {Function} options.action        Callback for the button.
- * @param {number}   options.dismiss       Time to dismiss the message.
- * @param {string}   options.type          Type of the message. Controls the type of message displayed.
- * @param {string}   options.color         Color of the message.
- * @param {string}   options.classname     Classname of the message.
- * @param {string}   options.image         URL of the image to display.
- * @param {string}   options.imageLink     URL for the image link.
- * @param {Function} options.imageCallback Callback for the image click.
- *
- * @example
- * ```js
- * showHornMessage({
- *  title: 'This is a reminder',
- *  text: 'Maybe it tells you to do something',
- *  button: 'Got it!',
- *  action: () => { doSomething(); },
- *  dismiss: 5000,
- *  color: 'pink',
- * });
- * ```
- *
- * @return {HTMLElement|false} The message element if successful, false if the horn dialog is not available.
- */
-const showHornMessage = (options) => {
-  const huntersHornView = document.querySelector('.huntersHornView__messageContainer');
-  if (! huntersHornView) {
-    return false;
-  }
-
-  const settings = {
-    title: options.title || 'Hunters Horn',
-    text: options.text || 'This is a message from the Hunters Horn',
-    button: options.button || 'OK',
-    action: options.action || (() => {}),
-    dismiss: options.dismiss || null,
-    type: options.type || (options.color ? 'bait_disarmed' : 'recent_linked_turn'),
-    color: options.color || false,
-    classname: options.classname || '',
-    image: options.image || null,
-    imageLink: options.imageLink || null,
-    imageCallback: options.imageCallback || null,
-  };
-
-  if ('info' === settings.type) {
-    settings.type = 'bait_disarmed';
-  } else if ('error' === settings.type) {
-    settings.type = 'bait_disarmed';
-    settings.color = 'red';
-  } else if ('warning' === settings.type) {
-    settings.type = 'bait_disarmed';
-    settings.color = 'yellow';
-  } else if ('success' === settings.type) {
-    settings.type = 'bait_disarmed';
-    settings.color = 'green';
-  }
-
-  // do the other effects
-  const backdrop = document.querySelector('.huntersHornView__backdrop');
-  if (backdrop) {
-    backdrop.classList.add('huntersHornView__backdrop--active');
-  }
-
-  const gameInfo = document.querySelector('.mousehuntHud-gameInfo');
-  if (gameInfo) {
-    gameInfo.classList.add('blur');
-  }
-
-  const fragment = document.createDocumentFragment();
-
-  const messageWrapper = makeElement('div', ['huntersHornView__message huntersHornView__message--active', settings.classname]);
-  const message = makeElement('div', [
-    'huntersHornMessageView',
-    'huntersHornMessageView--shadow',
-    `huntersHornMessageView--${settings.type}`,
-    settings.color ? `huntersHornMessageView--color-${settings.color}` : ''
-  ]);
-
-  makeElement('div', 'huntersHornMessageView__title', settings.title, message);
-  const content = makeElement('div', 'huntersHornMessageView__content');
-
-  if (settings.image) {
-    if ('recent_turn' === settings.type || 'recent_linked_turn' === settings.type) {
-      const imgWrapper = makeElement('div', 'huntersHornMessageView__friend');
-      const img = makeElement('a', 'huntersHornMessageView__friendProfilePic');
-      if (settings.imageLink) {
-        img.href = settings.imageLink;
-      } else if (settings.imageCallback) {
-        img.addEventListener('click', settings.imageCallback);
-      } else {
-        img.href = '#';
-      }
-
-      img.style.backgroundImage = `url(${settings.image})`;
-
-      imgWrapper.append(img);
-      content.append(imgWrapper);
-    } else {
-      content.classList.add('huntersHornMessageView__content--image');
-      content.setAttribute('style', `--bg-image: url(${settings.image})`);
-    }
-  }
-
-  makeElement('div', 'huntersHornMessageView__text', settings.text, content);
-  const buttonSpacer = makeElement('div', 'huntersHornMessageView__buttonSpacer');
-  const button = makeElement('button', 'huntersHornMessageView__action');
-  const buttonLabel = makeElement('div', 'huntersHornMessageView__actionLabel');
-  makeElement('span', 'huntersHornMessageView__actionText', settings.button, buttonLabel);
-
-  button.append(buttonLabel);
-
-  button.addEventListener('click', () => {
-    if (settings.action) {
-      settings.action();
-    }
-
-    messageWrapper.innerHTML = '';
-    backdrop.classList.remove('huntersHornView__backdrop--active');
-    gameInfo.classList.remove('blur');
-  });
-
-  buttonSpacer.append(button);
-  content.append(buttonSpacer);
-
-  message.append(content);
-
-  if (settings.dismiss) {
-    const countdown = makeElement('button', ['huntersHornMessageView__countdown']);
-    makeElement('div', 'huntersHornMessageView__countdownButtonImage', '', countdown);
-
-    const svgMarkup = `<svg class="huntersHornMessageView__countdownSVG">
-        <circle r="46%" cx="50%" cy="50%" class="huntersHornMessageView__countdownCircleTrack"></circle>
-        <circle r="46%" cx="50%" cy="50%" class="huntersHornMessageView__countdownCircle" style="animation-duration: ${settings.dismiss}ms;"></circle>
-    </svg>`;
-    countdown.innerHTML += svgMarkup;
-
-    countdown.addEventListener('click', () => {
-      countdown.classList.add('huntersHornMessageView__countdown--complete');
-      messageWrapper.innerHTML = '';
-      backdrop.classList.remove('huntersHornView__backdrop--active');
-      gameInfo.classList.remove('blur');
-    });
-
-    message.append(countdown);
-  }
-
-  messageWrapper.append(message);
-
-  // remove any existing messages
-  const existingMessages = huntersHornView.querySelector('.huntersHornView__message');
-  if (existingMessages) {
-    existingMessages.remove();
-  }
-
-  fragment.append(messageWrapper);
-
-  huntersHornView.append(fragment);
-
-  if (settings.dismiss) {
-    setTimeout(() => {
-      const countdown = messageWrapper.querySelector('.huntersHornMessageView__countdown');
-      if (countdown) {
-        countdown.classList.add('huntersHornMessageView__countdown--complete');
-      }
-      messageWrapper.innerHTML = '';
-      backdrop.classList.remove('huntersHornView__backdrop--active');
-      gameInfo.classList.remove('blur');
-    }, settings.dismiss);
-  }
-
-  return messageWrapper;
-};
-
-export {
-  showHornMessage
-};

package/src/utils/humanizer.js

@@ -1,62 +0,0 @@
-/**
- * Convert a time duration to a human readable string.
- *
- * @param {number}   time                              The duration in milliseconds.
- * @param {Object}   [options]                         Formatting options.
- * @param {string[]} [options.units=['d','h','m','s']] The units to include in the result.
- * @param {string}   [options.spacer=' ']              Separator between value and unit.
- * @param {string}   [options.delimiter=' ']           Delimiter between each unit.
- *
- * @return {string} The formatted duration.
- */
-function humanizeTime(time, options = {}) {
-  const {
-    units = ['d', 'h', 'm', 's'],
-    spacer = ' ',
-    delimiter = ' ',
-  } = options || {};
-
-  const unitMs = {
-    y: 365 * 24 * 60 * 60 * 1000,
-    mo: 30 * 24 * 60 * 60 * 1000,
-    w: 7 * 24 * 60 * 60 * 1000,
-    d: 24 * 60 * 60 * 1000,
-    h: 60 * 60 * 1000,
-    m: 60 * 1000,
-    s: 1000,
-    ms: 1,
-  };
-
-  const unitLabels = {
-    y: 'year',
-    mo: 'month',
-    w: 'week',
-    d: 'day',
-    h: 'hour',
-    m: 'minute',
-    s: 'second',
-  };
-
-  let remaining = time;
-  const parts = [];
-
-  for (const unit of units) {
-    const value = Math.floor(remaining / unitMs[unit]);
-    if (value > 0 || (unit === units.at(-1) && parts.length === 0)) {
-      parts.push(`${value}${spacer}${unitLabels[unit]}${value > 1 ? 's' : ''}`);
-      remaining -= value * unitMs[unit];
-    }
-  }
-
-  return parts.join(delimiter).trim();
-}
-
-// Alias for compatibility
-const humanizer = humanizeTime;
-const plainHumanizer = humanizeTime;
-
-export {
-  humanizeTime,
-  humanizer,
-  plainHumanizer
-};

package/src/utils/index.js

@@ -1,28 +0,0 @@
-export * from './blueprint';
-export * from './db';
-export * from './data';
-export * from './debug';
-export * from './draggable';
-export * from './elements';
-export * from './events';
-export * from './event-registry';
-export * from './flags';
-export * from './global';
-export * from './horn';
-export * from './humanizer';
-export * from './json';
-export * from './journal';
-export * from './links';
-export * from './location';
-export * from './location-current';
-export * from './maps';
-export * from './messages';
-export * from './onboarding';
-export * from './page';
-export * from './page-current';
-export * from './settings';
-export * from './settings-markup';
-export * from './styles';
-export * from './templates';
-export * from './user';
-export * from './utils';

package/src/utils/journal.js

@@ -1,222 +0,0 @@
-import { dbGet, dbSet } from './db';
-import { getCurrentLocationName } from './location-current';
-
-/**
- * Replace a journal entry with new content.
- *
- * @param {Element}  entry           The entry to replace.
- * @param {Object}   [opts]          The options for the new entry.
- * @param {Array}    [opts.classes]  The classes to add to the entry.
- * @param {string}   [opts.image]    The image to display.
- * @param {string}   [opts.text]     The text to display.
- * @param {string}   [opts.time]     The time to display.
- * @param {string}   [opts.location] The location to display.
- * @param {Function} [opts.callback] The callback to run after replacing the entry.
- */
-const replaceJournalEntry = (entry, opts = {}) => {
-  const {
-    classes = ['short'],
-    image = false,
-    text = 'Hello, world!',
-    time = false,
-    location = false,
-    callback = () => {},
-  } = opts;
-
-  let date = false;
-
-  if (time && location) {
-    date = `${time} - ${location}`;
-  } else if (time) {
-    date = time;
-  } else if (location) {
-    date = location;
-  }
-
-  entry.outerHTML = `<div class="entry ${classes.join(' ')}" data-entry-id="journal-entry-${opts.id}">
-    ${image ? `<div class="journalimage"><img src="${image}" alt="" /></div>` : ''}
-    <div class="journalbody">
-      ${date ? `<div class="journaldate">${date}</div>` : ''}
-      <div class="journaltext">${text}</div>
-    </div>
-  </div>`;
-
-  callback(entry);
-};
-
-/**
- * Create a new journal entry.
- *
- * @param {Object}  [opts]          The options for the new entry.
- * @param {string}  opts.id         The ID of the new entry.
- * @param {Array}   [opts.classes]  The classes to add to the entry.
- * @param {string}  [opts.image]    The image to display.
- * @param {string}  [opts.text]     The text to display.
- * @param {string}  [opts.time]     The time to display.
- * @param {string}  [opts.location] The location to display.
- * @param {boolean} [opts.noDate]   Whether to include a date or not.
- */
-const makeJournalEntry = (opts = {}) => {
-  const existingEntry = document.querySelector(`.journalEntries .entry[data-entry-id="journal-entry-${opts.id}"]`);
-  if (existingEntry) {
-    return;
-  }
-
-  const entry = document.querySelector(`.journalEntries .entry${opts.before ? `[data-entry-id="${opts.before}"]` : ''}`);
-  if (! entry) {
-    return;
-  }
-
-  const newEntry = entry.cloneNode(true);
-  newEntry.classList.remove('animated', 'newEntry');
-  entry.before(newEntry);
-  replaceJournalEntry(newEntry, opts);
-};
-
-/**
- * Get the ID of the latest journal entry.
- *
- * @return {string} The ID of the latest journal entry.
- */
-const getLatestJournalEntryId = () => {
-  const entries = document.querySelectorAll('.journalEntries .entry');
-  if (! entries || entries.length === 0) {
-    return 0;
-  }
-
-  const entry = [...entries].find((search) => search.getAttribute('data-entry-id'));
-  return entry ? entry.getAttribute('data-entry-id') : 0;
-};
-
-/**
- * Add a new journal entry.
- *
- * @param {Object}  [opts]          The options for the new entry.
- * @param {string}  opts.id         The ID of the new entry.
- * @param {Array}   [opts.classes]  The classes to add to the entry.
- * @param {string}  [opts.image]    The image to display.
- * @param {string}  [opts.text]     The text to display.
- * @param {string}  [opts.time]     The time to display.
- * @param {string}  [opts.location] The location to display.
- * @param {boolean} [opts.noDate]   Whether to include a date or not.
- * @param {string}  [opts.before]   The ID of the entry to insert the new entry before.
- */
-const addJournalEntry = async (opts = {}) => {
-  const previousEntryData = await dbGet('data', `journal-entry-${opts.id}`);
-  const previousEntryId = previousEntryData ? previousEntryData.data?.previous : null;
-
-  if (! previousEntryId) {
-    const data = {
-      id: `journal-entry-${opts.id}`,
-      previous: getLatestJournalEntryId(),
-    };
-
-    if (! opts.noDate) {
-      if (! opts.time) {
-        const now = new Date();
-        opts.time = `${now.getHours()}:${now.getMinutes()} ${now.getHours() >= 12 ? 'pm' : 'am'}`;
-      }
-
-      if (! opts.location) {
-        opts.location = getCurrentLocationName();
-      }
-    }
-
-    makeJournalEntry(opts);
-
-    await dbSet('data', data);
-  }
-
-  document.addEventListener('journal-entry', (e) => {
-    if (e.detail && e.detail.getAttribute('data-entry-id') === previousEntryId) {
-      const existingEntry = document.querySelector(`.journalEntries .entry[data-entry-id="journal-entry-${opts.id}"]`);
-      if (existingEntry) {
-        return;
-      }
-
-      makeJournalEntry({
-        ...opts,
-        ...previousEntryData.data,
-        id: `journal-entry-${opts.id}`,
-        before: previousEntryId,
-      });
-    }
-  });
-};
-
-const callbacks = [];
-let hasAddedJournalEventListener = false;
-
-let numberOfEntries = 0;
-let numberOfProcessedEntries = 0;
-const finishedProcessingCallbacks = [];
-
-/**
- * Add the event listener for journal entries.
- */
-const addJournalEventListener = () => {
-  document.addEventListener('journal-entry', async (e) => {
-    const entryId = e.detail ? e.detail.getAttribute('data-entry-id') : null;
-
-    for (const { callback } of callbacks) {
-      try {
-        const entry = document.querySelector(`.journalEntries .entry[data-entry-id="${entryId}"]`);
-        await callback(entry);
-      } catch (error) {
-        console.error('Error in journal callback:', error); // eslint-disable-line no-console
-      }
-    }
-
-    numberOfProcessedEntries = numberOfProcessedEntries + 1;
-    if (numberOfProcessedEntries >= numberOfEntries) {
-      for (const finishedCallback of finishedProcessingCallbacks) {
-        try {
-          await finishedCallback();
-        } catch (error) {
-          console.error('Error in journal finished processing callback:', error); // eslint-disable-line no-console
-        }
-      }
-
-      // reset counts
-      numberOfEntries = 0;
-      numberOfProcessedEntries = 0;
-    }
-  });
-};
-
-/**
- * Helper function to add a callback to the journal entry event with a weight.
- *
- * @param {Function}      callback  The callback to run when the event is fired.
- * @param {Object|number} [options] The options for the callback or a number representing the weight.
- */
-const onJournalEntry = (callback, options = {}) => {
-  // if a number is passed as the second argument, treat it as weight for backwards compatibility
-  const weight = typeof options === 'number' ? options : (options.weight || 0);
-  const id = options.id || (callback.name ? `journal-callback-${callback.name}` : `journal-callback-${Math.random().toString(36).slice(2, 15)}`);
-
-  if (! hasAddedJournalEventListener) {
-    addJournalEventListener();
-    hasAddedJournalEventListener = true;
-  }
-
-  callbacks.push({ callback, id, weight });
-
-  callbacks.sort((a, b) => a.weight - b.weight);
-};
-
-const onJournalEntriesProcessed = (callback) => {
-  document.addEventListener('journal-entries-processing', (data) => {
-    numberOfEntries = data.detail.length * 3; // We run the processing 3 times.
-  });
-
-  finishedProcessingCallbacks.push(callback);
-};
-
-export {
-  replaceJournalEntry,
-  makeJournalEntry,
-  addJournalEntry,
-  onJournalEntry,
-  onJournalEntriesProcessed
-};

package/src/utils/json.js

@@ -1,32 +0,0 @@
-/**
- * Safely parse a JSON string.
- *
- * @param {*}        value        The value to parse.
- * @param {*}        defaultValue The fallback value if parsing fails.
- * @param {Function} onError      Optional callback to run on parse failure.
- *
- * @return {*} The parsed value or the fallback value.
- */
-const safeJsonParse = (value, defaultValue = null, onError = null) => {
-  if (null === value || undefined === value) {
-    return defaultValue;
-  }
-
-  if ('string' !== typeof value) {
-    return value;
-  }
-
-  try {
-    return JSON.parse(value);
-  } catch (error) {
-    if ('function' === typeof onError) {
-      onError(error);
-    }
-
-    return defaultValue;
-  }
-};
-
-export {
-  safeJsonParse
-};