Added custom authoring validation for to only accept numbers.

michaelsharman · Feb 26, 2024 · e37591e · e37591e
1 parent 4fdb2d7
commit e37591e
Show file tree

Hide file tree

Showing 33 changed files with 649 additions and 30 deletions.
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-Utils_Logger.html b/docs/module-Utils_Logger.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_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_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_Authoring_contentTabs.html b/docs/module-_Extensions_Authoring_contentTabs.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_validation_essayMaxLength.html b/docs/module-_Extensions_Authoring_validation_essayMaxLength.html
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@caspingus/lt",
-    "version": "2.3.0",
+    "version": "2.4.0",
     "description": "A utility library of helpers and tools for working with Learnosity APIs.",
     "main": "src/index.js",
     "author": "michael@learnosity.com",

diff --git a/src/authoring/core.js b/src/authoring/core.js
@@ -1,6 +1,7 @@
 import * as app from './core/app';
 import * as diagnostics from './core/diagnostics';
 import * as navigation from './core/navigation';
+import * as widgets from './core/widgets';
 import logger from '../utils/logger';
 
 const utils = {
@@ -9,4 +10,4 @@ const utils = {
     },
 };
 
-export const LT = { ...app, ...diagnostics, ...navigation, ...utils };
+export const LT = { ...app, ...diagnostics, ...navigation, ...widgets, ...utils };
diff --git a/src/authoring/extensions/validation/essayMaxLength/index.js b/src/authoring/extensions/validation/essayMaxLength/index.js
@@ -0,0 +1,82 @@
+import * as app from '../../../core/app';
+import * as widgets from '../../../core/widgets';
+
+/**
+ * Extensions add specific functionality to Learnosity APIs.
+ * They rely on modules within LT being available.
+ *
+ * --
+ *
+ * Adds custom validation to ensure that only numbers are added
+ * to the `max_length` field for the listed types.
+ *
+ * The extension will strip any invalid characters. Eg:
+ * ```
+ * 10.5
+ * ```
+ *
+ * Will be changed to:
+ * ```
+ * 10
+ * ```
+ *
+ * @module _Extensions/Authoring/validation/essayMaxLength
+ */
+
+const state = {
+    validTypes: ['longtextV2', 'plaintext'],
+};
+
+/**
+ * Extension constructor.
+ * @example
+ * import { LT } from '@caspingus/lt/src/authoring/index';
+ *
+ * LT.init(authorApp); // Set up LT with the Author API application instance variable
+ * LT.extensions.essayMaxLength.run();
+ * @since 2.4.0
+ */
+export function run() {
+    setupListeners();
+}
+
+/**
+ * Sets up listeners to add input validation.
+ * @since 2.4.0
+ * @ignore
+ */
+function setupListeners() {
+    app.appInstance().on('widgetedit:editor:ready', () => {
+        // Race condition with the event firing and the instance
+        // actually being loaded
+        setTimeout(() => {
+            const widgetType = widgets.type();
+
+            if (state.validTypes.includes(widgetType)) {
+                const elMaxLength = document.querySelector('[data-lrn-qe-input-path="max_length"] input.lrn-qe-input');
+
+                if (elMaxLength) {
+                    elMaxLength.addEventListener('input', () => {
+                        validateInput(elMaxLength);
+                    });
+                }
+            }
+        }, 500);
+    });
+}
+
+/**
+ * Inspects the value of the passed DOM element. If the
+ * value contains non-numeric values (including period)
+ * those invalid characters are removed.
+ * @since 2.4.0
+ * @param {*} el
+ * @ignore
+ */
+function validateInput(el) {
+    const regex = /^\d+$/;
+
+    if (!regex.test(el.value)) {
+        el.value = el.value.replace(/[^0-9]/g, '');
+    }
+}
diff --git a/src/authoring/index.js b/src/authoring/index.js
@@ -10,10 +10,12 @@ import { LT as core } from './core';
 import * as contentTabs from './extensions/ui/contentTabs/index';
 import * as languageTextDirection from './extensions/ui/languageTextDirection/index';
 import * as renderPDF from './extensions/ui/renderPDF/index';
+import * as essayMaxLength from './extensions/validation/essayMaxLength/index';
 
 const extensions = {
     extensions: {
         contentTabs: { ...contentTabs },
+        essayMaxLength: { ...essayMaxLength },
         languageTextDirection: { ...languageTextDirection },
         renderPDF: { ...renderPDF },
     },