New methods for dynamic sessions, and try again. Also renamed toggleF…

…lag() to flag()
michaelsharman · Feb 1, 2024 · 3af800b · 3af800b
1 parent cb12ac2
commit 3af800b
Show file tree

Hide file tree

Showing 24 changed files with 444 additions and 117 deletions.
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/module-Activity.html b/docs/module-Activity.html
diff --git a/docs/module-App.html b/docs/module-App.html
diff --git a/docs/module-Diagnostics.html b/docs/module-Diagnostics.html
diff --git a/docs/module-Items.html b/docs/module-Items.html
diff --git a/docs/module-Logger.html b/docs/module-Logger.html
diff --git a/docs/module-Player.html b/docs/module-Player.html
diff --git a/docs/module-Questions.html b/docs/module-Questions.html
diff --git a/docs/module-Sections.html b/docs/module-Sections.html
diff --git a/docs/module-_Extensions_ariaCountOnNav.html b/docs/module-_Extensions_ariaCountOnNav.html
diff --git a/docs/module-_Extensions_blockGrammarChecks.html b/docs/module-_Extensions_blockGrammarChecks.html
diff --git a/docs/module-_Extensions_columnResizer.html b/docs/module-_Extensions_columnResizer.html
diff --git a/docs/module-_Extensions_essayLimitByCharacter.html b/docs/module-_Extensions_essayLimitByCharacter.html
diff --git a/docs/module-_Extensions_hideAlternatives.html b/docs/module-_Extensions_hideAlternatives.html
diff --git a/docs/module-_Extensions_keyboardShortcuts.html b/docs/module-_Extensions_keyboardShortcuts.html
diff --git a/docs/module-_Extensions_magnifier.html b/docs/module-_Extensions_magnifier.html
diff --git a/docs/module-_Extensions_mcqLabelPrefix.html b/docs/module-_Extensions_mcqLabelPrefix.html
diff --git a/docs/module-_Extensions_pageOverlay.html b/docs/module-_Extensions_pageOverlay.html
diff --git a/docs/module-_Extensions_resetResponse.html b/docs/module-_Extensions_resetResponse.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": "1.3.1",
+    "version": "1.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/assessment/activity.js b/src/assessment/activity.js
@@ -173,6 +173,15 @@ export function hasSections() {
     return activity().hasOwnProperty('sections');
 }
 
+/**
+ * Whether the activity has try again enabled.
+ * @since 1.4.0
+ * @returns {boolean}
+ */
+export function hasTryAgain() {
+    return activity()?.dynamic_items.hasOwnProperty('try_again');
+}
+
 /**
  * Whether this activity is adaptive.
  * @since 0.1.0

diff --git a/src/assessment/items.js b/src/assessment/items.js
@@ -8,6 +8,36 @@ import * as sections from './sections';
  * @module Items
  */
 
+/**
+ * The dynamic object for the current item. Useful when
+ * using dynamic content with try again.
+ * https://reference.learnosity.com/items-api/methods/item/dynamic
+ * @since 1.4.0
+ * @returns {object}
+ */
+export function dynamic() {
+    const reference = itemReference();
+    return app.assessApp().item(reference).dynamic;
+}
+
+/**
+ * Toggles the `user_flagged` state on the current item.
+ * @since 1.4.0
+ */
+export function flag() {
+    const reference = itemReference();
+    app.assessApp().item(reference).flag();
+}
+
+/**
+ * Whether the current item has dynamic content.
+ * @since 1.4.0
+ * @returns {boolean}
+ */
+export function isDynamicItem() {
+    return item()?.source.hasOwnProperty('data_table_seed');
+}
+
 /**
  * Whether the current item is the first item in the activity.
  * This ignores sections, so will be a global check.
@@ -190,14 +220,3 @@ export function itemPosition() {
 export function itemReference() {
     return app.appInstance().getCurrentItem().reference;
 }
-
-/**
- * Toggles the `user_flagged` state on the current item.
- * @since 0.4.0
- */
-export function toggleFlag() {
-    const el = document.querySelector('.flag-item');
-    if (el) {
-        el.click();
-    }
-}
diff --git a/src/extensions/accessibility/ux/keyboardShortcuts.js b/src/extensions/accessibility/ux/keyboardShortcuts.js
@@ -333,6 +333,6 @@ function setResponseMask(bindings) {
  */
 function toggleFlag(bindings) {
     Mousetrap.bind(bindings, (e, combo) => {
-        items.toggleFlag();
+        items.flag();
     });
 }