qti3-item-player-vue3 0.2.19 → 0.2.20

package/dist/assets/pci/pci.html

@@ -127,25 +127,39 @@ let qtiCustomInteractionContext = {
    * }
    */
   setRenderingProperties (instance, properties) {
-    if ((typeof instance.setRenderingProperties !== 'undefined') && typeof instance.setRenderingProperties == 'function') {
+    if ((typeof instance.setRenderingProperties !== 'undefined') && (typeof instance.setRenderingProperties == 'function')) {
       console.log('[PCI Context] Interaction SetRenderingProperties:', properties)
       instance.setRenderingProperties(properties)
     }
   },
 
   /**
-   * Allow the delivery engine to check the validity of PCI instance.
+   * Allow the delivery engine to check the validity of the PCI instance.
    * If the PCI provides a checkValidity function then use that function.
    * Otherwise, return boolean true (is valid).
    * @param {Object} instance The Custom Interaction Instance.
    */
-   checkValidity (instance) {
+  checkValidity (instance) {
     // default to true
     let isValid = true
-    if ((typeof instance.checkValidity !== 'undefined') && typeof instance.checkValidity == 'function') {
+    if ((typeof instance.checkValidity !== 'undefined') && (typeof instance.checkValidity == 'function')) {
       isValid = instance.checkValidity()
     }
     return isValid
+  },
+
+  /**
+   * Allow the delivery engine to get the custom validity message of the PCI instance.
+   * If the PCI provides a getCustomValidity function then use that function.
+   * Otherwise, return the empty string.
+   * @param {Object} instance The Custom Interaction Instance.
+   */
+  getCustomValidityMessage (instance) {
+    let message = ''
+    if ((typeof instance.getCustomValidity !== 'undefined') && (typeof instance.getCustomValidity == 'function')) {
+      message = instance.getCustomValidity()
+    }
+    return message
   }
 
 }
@@ -494,6 +508,10 @@ const QTI_PCI_API = {
     return qtiCustomInteractionContext.checkValidity(this.getInstance())
   },
 
+  getCustomValidityMessage () {
+    return qtiCustomInteractionContext.getCustomValidityMessage(this.getInstance())
+  },
+
   NotifyPciChildLoaded () {
     if (self == top) return
 
@@ -510,12 +528,21 @@ const QTI_PCI_API = {
     if (self == top) return
 
     const isValid = this.checkValidity()
+    const invalidResponseMessage = this.getCustomValidityMessage()
     const height = this.getDom().clientHeight
     const computedHeight = (height) ? height : 0
     const width = this.getDom().clientWidth
     const computedWidth = (width) ? width : 0
 
-    window.parent.postMessage({ message: 'PciReady', identifier: this.getResponseIdentifier(), valid: isValid, width: computedWidth, height: computedHeight, success: true },'*')
+    window.parent.postMessage({
+        message: 'PciReady',
+        identifier: this.getResponseIdentifier(),
+        valid: isValid,
+        invalidResponseMessage: invalidResponseMessage,
+        width: computedWidth,
+        height: computedHeight,
+        success: true 
+      },'*')
   },
 
   NotifyPciDone (instance, response, state, status) {
@@ -610,12 +637,12 @@ const QTI_PCI_API = {
       return
     }
 
-    // event.detail has four required properties:
+    // event.detail has two required properties and two optional properties
     // {
-    //   interaction: <instance>,
-    //   responseIdentifier: <interaction response identifer>,
-    //   valid: <validity boolean>,
-    //   value: <response value>
+    //   interaction: <instance>, (req)
+    //   responseIdentifier: <interaction response identifer>, (req)
+    //   valid: <validity boolean>, (opt)
+    //   value: <response value> (opt)
     // }
     if (typeof event.detail.interaction === 'undefined') {
       console.log('[QtiInteractionChanged][Engine][Module Error]: event detail is missing required "interaction" property', event.detail)
@@ -625,15 +652,6 @@ const QTI_PCI_API = {
       console.log('[QtiInteractionChanged][Engine][Module Error]: event detail is missing required "responseIdentifier" property', event.detail)
       return
     }
-    if (typeof event.detail.valid === 'undefined') {
-      console.log('[QtiInteractionChanged][Engine][Module Error]: event detail is missing required "valid" property', event.detail)
-      return
-    }
-    if (typeof event.detail.value === 'undefined') {
-      console.log('[QtiInteractionChanged][Engine][Module Error]: event detail is missing required "value" property', event.detail)
-      return
-    }
-
     console.log('[QtiInteractionChanged][Engine]', event.detail)
     this.NotifyPciInteractionChanged(event.detail.valid, event.detail.value)
   }