Fixed issue with cached observer for image compressor.

michaelsharman · Jun 25, 2024 · 1771649 · 1771649
1 parent b7790c7
commit 1771649
Show file tree

Hide file tree

Showing 40 changed files with 403 additions and 211 deletions.
diff --git a/dist/authoring/index.js b/dist/authoring/index.js
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/module-Assessment_Activity.html b/docs/module-Assessment_Activity.html
diff --git a/docs/module-Assessment_App.html b/docs/module-Assessment_App.html
diff --git a/docs/module-Assessment_Diagnostics.html b/docs/module-Assessment_Diagnostics.html
diff --git a/docs/module-Assessment_Items.html b/docs/module-Assessment_Items.html
diff --git a/docs/module-Assessment_Player.html b/docs/module-Assessment_Player.html
diff --git a/docs/module-Assessment_Questions.html b/docs/module-Assessment_Questions.html
diff --git a/docs/module-Assessment_Sections.html b/docs/module-Assessment_Sections.html
diff --git a/docs/module-Authoring_App.html b/docs/module-Authoring_App.html
diff --git a/docs/module-Authoring_Diagnostics.html b/docs/module-Authoring_Diagnostics.html
diff --git a/docs/module-Authoring_Navigation.html b/docs/module-Authoring_Navigation.html
diff --git a/docs/module-Authoring_Widgets.html b/docs/module-Authoring_Widgets.html
diff --git a/docs/module-Extensions_Assessment_ariaCountOnNav.html b/docs/module-Extensions_Assessment_ariaCountOnNav.html
diff --git a/docs/module-Extensions_Assessment_blockGrammarChecks.html b/docs/module-Extensions_Assessment_blockGrammarChecks.html
diff --git a/docs/module-Extensions_Assessment_checkAnswerValidation.html b/docs/module-Extensions_Assessment_checkAnswerValidation.html
diff --git a/docs/module-Extensions_Assessment_columnResizer.html b/docs/module-Extensions_Assessment_columnResizer.html
diff --git a/docs/module-Extensions_Assessment_essayLimitByCharacter.html b/docs/module-Extensions_Assessment_essayLimitByCharacter.html
diff --git a/docs/module-Extensions_Assessment_hideAlternatives.html b/docs/module-Extensions_Assessment_hideAlternatives.html
diff --git a/docs/module-Extensions_Assessment_keyboardShortcuts.html b/docs/module-Extensions_Assessment_keyboardShortcuts.html
diff --git a/docs/module-Extensions_Assessment_magnifier.html b/docs/module-Extensions_Assessment_magnifier.html
diff --git a/docs/module-Extensions_Assessment_mcqLabelPrefix.html b/docs/module-Extensions_Assessment_mcqLabelPrefix.html
diff --git a/docs/module-Extensions_Assessment_networkStatus.html b/docs/module-Extensions_Assessment_networkStatus.html
diff --git a/docs/module-Extensions_Assessment_pageOverlay.html b/docs/module-Extensions_Assessment_pageOverlay.html
diff --git a/docs/module-Extensions_Assessment_renderPDF.html b/docs/module-Extensions_Assessment_renderPDF.html
diff --git a/docs/module-Extensions_Assessment_resetResponse.html b/docs/module-Extensions_Assessment_resetResponse.html
diff --git a/docs/module-Extensions_Assessment_themes_juniorQuest.html b/docs/module-Extensions_Assessment_themes_juniorQuest.html
diff --git a/docs/module-Extensions_Assessment_toggleTimer.html b/docs/module-Extensions_Assessment_toggleTimer.html
diff --git a/docs/module-Extensions_Assessment_whiteNoise.html b/docs/module-Extensions_Assessment_whiteNoise.html
diff --git a/docs/module-Extensions_Authoring_contentTabs.html b/docs/module-Extensions_Authoring_contentTabs.html
diff --git a/docs/module-Extensions_Authoring_essayMaxLength.html b/docs/module-Extensions_Authoring_essayMaxLength.html
diff --git a/docs/module-Extensions_Authoring_imageUploader.html b/docs/module-Extensions_Authoring_imageUploader.html
diff --git a/docs/module-Extensions_Authoring_languageTextDirection.html b/docs/module-Extensions_Authoring_languageTextDirection.html
diff --git a/docs/module-Extensions_Authoring_renderPDF.html b/docs/module-Extensions_Authoring_renderPDF.html
diff --git a/docs/module-Extensions_Authoring_ssmlEditor.html b/docs/module-Extensions_Authoring_ssmlEditor.html
diff --git a/docs/module-Utils_Logger.html b/docs/module-Utils_Logger.html
diff --git a/docs/module-Utils_Validation.html b/docs/module-Utils_Validation.html
diff --git a/src/assessment/extensions/ui/themes/juniorQuest/index.js b/src/assessment/extensions/ui/themes/juniorQuest/index.js
@@ -7,6 +7,49 @@ import './sass/index.scss';
  * --
  *
  * This script loads a custom UI theme for Items API.
+ *
+ * Use the following custom region configuration to load this theme:
+ *
+ * ```
+ * {
+ *     "config": {
+ *         "regions": {
+ *             "bottom-left": [
+ *                 {
+ *                     "type": "previous_button",
+ *                     "show_label_option": true
+ *                 }
+ *             ],
+ *             "bottom-right": [
+ *                 {
+ *                     "type": "next_button"
+ *                 }
+ *             ],
+ *             "items": [
+ *                 {
+ *                     "type": "items_progress_element",
+ *                     "shown": false
+ *                 },
+ *                 {
+ *                     "type": "slider_element"
+ *                 }
+ *             ],
+ *             "right": [
+ *                 {
+ *                     "type": "verticaltoc_element"
+ *                 }
+ *             ],
+ *             "top-left": [
+ *                 {
+ *                     "type": "title_element"
+ *                 }
+ *             ]
+ *         }
+ *     }
+ * }
+ * ```
+ *
+ * <p><img src="https://raw.githubusercontent.com/michaelsharman/LT/main/src/assets/images/themes/theme-juniorquest.png" alt="" width="900"></p>
  * @module Extensions/Assessment/themes/juniorQuest
  */
 
@@ -15,12 +58,14 @@ const state = {
 };
 
 /**
- * Loads the `Sydney` theme for Items API (the player).
+ * Loads the `Junior Quest` theme for Items API (the player).
+ *
+ *
  * @example
  * import { LT } from '@caspingus/lt/src/assessment/core';
  *
  * LT.init(itemsApp); // Set up LT with the Items API application instance variable
- * LT.extensions.themes.sydney.run();
+ * LT.extensions.themes.juniorQuest.run();
  * @since 2.13.0
  */
 export function run() {

diff --git a/src/assets/images/themes/theme-juniorquest.png b/src/assets/images/themes/theme-juniorquest.png
diff --git a/src/authoring/extensions/ui/imageUploader/index.js b/src/authoring/extensions/ui/imageUploader/index.js
@@ -103,7 +103,7 @@ import spinner from './assets/spinner.svg';
  * @module Extensions/Authoring/imageUploader
  */
 
-const LOG_LEVEL = 'ERROR';
+const LOG_LEVEL = 'DEBUG';
 
 const state = {
     observer: null,
@@ -162,14 +162,15 @@ export function run(security, request, options = {}) {
 function setupModalObserver() {
     logger.debug('setupModalObserver()', LOG_LEVEL);
 
+    clearObserver();
+
     const callback = mutationsList => {
         for (const mutation of mutationsList) {
             if (mutation.type === 'childList') {
                 const modal = document.querySelector('[data-authorapi-selector="asset-uploader-iframe-outlet"]');
                 if (modal) {
                     logger.debug('Disconnecting observer', LOG_LEVEL);
-                    state.observer.disconnect();
-                    state.observedElements.clear();
+                    clearObserver();
                     setupUploderUI();
                     break;
                 }
@@ -182,6 +183,8 @@ function setupModalObserver() {
         state.observer = new MutationObserver(callback);
 
         activateObserver();
+    } else {
+        logger.debug('Observed elements full', LOG_LEVEL);
     }
 }
 
@@ -192,15 +195,26 @@ function setupModalObserver() {
  * @ignore
  */
 function activateObserver() {
+    logger.debug('Looking to activate observer', LOG_LEVEL);
     const parentElement = document.querySelector('.lrn-author-item');
 
     if (!state.observedElements.has(parentElement)) {
-        logger.debug('Activate observer', LOG_LEVEL);
+        logger.debug('Activated observer', LOG_LEVEL);
         state.observer.observe(parentElement, { childList: true, subtree: true });
         state.observedElements.set(parentElement, state.observer);
     }
 }
 
+/**
+ * Clears the modal observer and disconnects it.
+ * @since 2.13.0
+ * @ignore
+ */
+function clearObserver() {
+    if (state.observer) state.observer.disconnect();
+    state.observedElements.clear();
+}
+
 /**
  * Hides the Learnosity upload UI (iframe) and
  * injects the custom uploader.
@@ -445,9 +459,12 @@ function uploadImage(fileId) {
 function prepareModalButtons(modalParent) {
     const elCloseButtons = ['lrn-modal-button-close', 'lrn-btn-default', 'lrn-btn-primary-legacy'];
 
+    removeHandler();
+
     for (let btn of elCloseButtons) {
         let elBtn = modalParent.querySelector(`.lrn-modal-dialog button.${btn}`);
         if (elBtn) {
+            logger.debug(`Adding clickHanders for: ${btn}`, LOG_LEVEL);
             elBtn.addEventListener('click', clickHandler);
         }
     }
@@ -466,7 +483,7 @@ function prepareModalButtons(modalParent) {
         for (let btn of elCloseButtons) {
             let elBtn = modalParent.querySelector(`.lrn-modal-dialog button.${btn}`);
             if (elBtn) {
-                logger.debug('Removed click event', LOG_LEVEL);
+                logger.debug('Removed clickHandler', LOG_LEVEL);
                 elBtn.removeEventListener('click', clickHandler);
             }
         }