fcad-core-dragon 2.0.0-beta.0

package/src/module/xapi/launch.js

@@ -0,0 +1,157 @@
+export default function(obj) {
+  const getQueryVariable = (variable) => {
+    var query = window.location.search.substring(1)
+    var vars = query.split('&')
+    for (var i = 0; i < vars.length; i++) {
+      var pair = vars[i].split('=')
+      if (decodeURIComponent(pair[0]) == variable) {
+        return decodeURIComponent(pair[1])
+      }
+    }
+  }
+
+  const cb_wrap = (cb) => {
+    return function() {
+      var args = arguments
+      window.setTimeout(function() {
+        var callerArgs = []
+        for (var i = 0; i < args.length; i++) {
+          callerArgs.push(args[i])
+        }
+        cb.apply(window, callerArgs)
+      }, 0)
+    }
+  }
+
+  //The library will append the necessary launch info to each new A that is linked to the page.
+  //NOTE: This cannot work if you programmatically change the window location. If you do, you must
+  //execute the logic in setupCourseLinks to send the initialization data to the new location (if
+  //you wish that new location to track as part of this session)
+  const observeForNewLinks = () => {
+    // select the target node
+    var target = document.body
+    // create an observer instance
+    var observer = new MutationObserver(function(mutations) {
+      mutations.forEach(function(mutation) {
+        for (var i in mutation.addedNodes) {
+          //if (mutation.addedNodes.hasOwnProperty(i)) {
+          if (Object.prototype.hasOwnProperty.call(mutation.addedNodes, i)) {
+            if (mutation.addedNodes[i].constructor == HTMLAnchorElement) {
+              var node = mutation.addedNodes[i]
+              setupCourseLinks([node])
+            }
+          }
+        }
+      })
+    })
+    // configuration of the observer:
+    var config = {
+      attributes: true,
+      childList: true,
+      subtree: true
+    }
+    // pass in the target node, as well as the observer options
+    observer.observe(target, config)
+    // later, you can stop observing
+    ///  observer.disconnect();
+  }
+  //This library will init all links in the DOM that include the attribute "courseLink = true"
+  //with the information necessary for the document at that link to track as part of this session.
+  const setupCourseLinks = (_nodes) => {
+    var launchToken = getQueryVariable('xAPILaunchKey')
+    var launchEndpoint = getQueryVariable('xAPILaunchService')
+    var encrypted = getQueryVariable('encrypted')
+    var query =
+      'xAPILaunchKey=' + launchToken + '&xAPILaunchService=' + launchEndpoint
+    if (encrypted) {
+      query += '&encrypted=true'
+    }
+    for (var i = 0; i < _nodes.length; i++) {
+      var link = _nodes[i]
+      var href = link.href
+      var courseLink = link.attributes.getNamedItem('courselink')
+      if (courseLink && courseLink.value == 'true') {
+        if (href.indexOf('?') > -1) {
+          href = href + '&' + query
+        } else href = href + '?' + query
+        link.href = href
+      }
+    }
+  }
+
+  const xAPILaunch = (cb, terminate_on_unload, strict_callbacks) => {
+    cb = cb_wrap(cb)
+
+    try {
+      var launchToken = getQueryVariable('xAPILaunchKey')
+      var launchEndpoint = getQueryVariable('xAPILaunchService')
+      var encrypted = getQueryVariable('encrypted')
+      if (encrypted) {
+        //here, we'd have to implement decryption for the data. This makes little sense in a client side only course
+      }
+
+      xAPILaunch.terminate = function(message) {
+        var launch = new URL(launchEndpoint)
+        launch.pathname += 'launch/' + launchToken + '/terminate'
+        var xhr2 = new XMLHttpRequest()
+        xhr2.withCredentials = true
+        xhr2.crossDomain = true
+
+        xhr2.open('POST', launch.toString(), false)
+        xhr2.setRequestHeader('Content-type', 'application/json')
+        xhr2.send(
+          JSON.stringify({
+            code: 0,
+            description: message || 'User closed content'
+          })
+        )
+      }
+
+      if (!launchToken || !launchEndpoint)
+        return cb('invalid launch parameters')
+      var launch = new URL(launchEndpoint)
+      launch.pathname += 'launch/' + launchToken
+      var xhr = new XMLHttpRequest()
+      xhr.withCredentials = true
+      xhr.crossDomain = true
+      xhr.onerror = function(err) {
+        //exit the try catch so inner execptions in the callback don't trigger this catch
+        window.setTimeout(function() {
+          return cb(err)
+        })
+      }
+      xhr.onload = function(e) {
+        e
+        if (xhr.status !== 200) {
+          return xhr.onerror(xhr.responseText)
+        }
+        var body = JSON.parse(xhr.responseText)
+        var launchData = body
+
+        var conf = {}
+        conf['endpoint'] = launchData.endpoint
+        conf['actor'] = launchData.actor
+        conf.withCredentials = true
+        conf.strictCallbacks = strict_callbacks || false
+
+        window.onunload = function() {
+          if (!terminate_on_unload) return
+          xAPILaunch.terminate('User closed content')
+        }
+        const wrapper = new obj.XAPIWrapper.constructor()
+
+        wrapper.changeConfig(conf)
+        //Links that include "courseLink='true'"
+        setupCourseLinks(document.body.querySelectorAll('a'))
+        //Also, if links are added dynamically, we will do the same logic for those links.
+        observeForNewLinks()
+        return cb(null, body, wrapper)
+      }
+      xhr.open('POST', launch.toString(), true)
+      xhr.send()
+    } catch (e) {
+      cb(e)
+    }
+  }
+  obj.launch = xAPILaunch
+}

package/src/module/xapi/utils.js

@@ -0,0 +1,167 @@
+export const defineUtils = function(obj = {}) {
+  let ADL = obj
+  let onBrowser = false
+  if (typeof window !== 'undefined') {
+    ADL = window.ADL = obj.ADL || {}
+    onBrowser = true
+  }
+
+  const getObjDefName = function(o) {
+    if (o.definition && o.definition.name) {
+      return ADL.xapiutil.getLangVal(o.definition.name)
+    }
+    return undefined
+  }
+
+  const getSubStatementDisplay = function(o) {
+    if (o.objectType !== 'SubStatement') return
+    if (o.object.objectType === 'SubStatement') return
+    if (o.id || o.stored || o.version || o.authority) return
+    const disp =
+      ADL.xapiutil.getActorId(o.actor) +
+      ':' +
+      ADL.xapiutil.getVerbDisplay(o.verb) +
+      ':' +
+      ADL.xapiutil.getObjectId(o.object)
+    return disp
+  }
+
+  ADL.xapiutil = {}
+
+  ADL.xapiutil.getLang = function() {
+    let lang
+    if (typeof navigator !== 'undefined')
+      lang =
+        navigator.language ||
+        navigator.browserLanguage ||
+        navigator.systemLanguage ||
+        navigator.userLanguage
+    else if (
+      typeof process !== 'undefined' &&
+      typeof process.env !== 'undefined' &&
+      typeof process.env.LANG !== 'undefined'
+    ) {
+      const str = process.env.LANG
+      lang = str.slice(0, str.indexOf('.'))
+      lang = lang.replace(/_/, '-')
+    }
+    return lang || 'en-US'
+  }
+
+  ADL.xapiutil.getLangVal = function(langprop) {
+    if (!langprop) return
+
+    const options = Object.keys(langprop)
+    // test that langprop is a dict (obj)
+    // skips if not a dict(obj) and returns
+    if (options.length == 0) return undefined
+
+    let lang = ADL.xapiutil.getLang(),
+      ret,
+      dispGotten = false
+
+    do {
+      //test and retest
+      if (langprop[lang]) {
+        ret = langprop[lang]
+        dispGotten = true
+      } else if (lang.indexOf('-')) {
+        lang = lang.substring(0, lang.lastIndexOf('-'))
+      }
+    } while (!dispGotten && lang !== '')
+
+    return ret
+  }
+
+  ADL.xapiutil.getMoreStatements = function(
+    iterations,
+    callback,
+    searchParams
+  ) {
+    if (!onBrowser) throw new Error('Node not supported.')
+
+    let stmts = []
+
+    ADL.XAPIWrapper.getStatements(searchParams, null, function getMore(r) {
+      if (!(r && r.response)) return
+      const res = JSON.parse(r.response)
+      if (!res.statements) return
+      stmts = stmts.concat(res.statements)
+
+      if (iterations-- <= 0) {
+        callback(stmts)
+      } else {
+        if (res.more && res.more !== '') {
+          ADL.XAPIWrapper.getStatements(searchParams, res.more, getMore)
+        } else if (res.more === '') {
+          callback(stmts)
+        }
+      }
+    })
+  }
+
+  ADL.xapiutil.getActorId = function(a) {
+    return a.mbox || a.openid || a.mbox_sha1sum || a.account
+  }
+
+  ADL.xapiutil.getActorIdString = function(a) {
+    let id = a.mbox || a.openid || a.mbox_sha1sum
+    if (!id) {
+      if (a.account) id = a.account.homePage + ':' + a.account.name
+      else if (a.member) id = 'Anon Group ' + a.member
+      else id = 'unknown'
+    }
+    return id
+  }
+
+  ADL.xapiutil.getActorDisplay = function(a) {
+    return a.name || ADL.xapiutil.getActorIdString(a)
+  }
+
+  ADL.xapiutil.getVerbDisplay = function(v) {
+    if (!v) return
+    if (v.display) {
+      return ADL.xapiutil.getLangVal(v.display) || v.id
+    }
+    return v.id
+  }
+
+  ADL.xapiutil.getObjectType = function(o) {
+    return o.objectType || (o.id ? 'Activity' : 'Agent')
+  }
+
+  ADL.xapiutil.getObjectId = function(o) {
+    if (o.id) return o.id
+    const type = ADL.xapiutil.getObjectType(o)
+    if (type === 'Agent' || type === 'Group') return ADL.xapiutil.getActorId(o)
+    return undefined
+  }
+
+  ADL.xapiutil.getObjectIdString = function(o) {
+    if (!o) return 'unknown'
+    if (o.id) return o.id
+    const type = ADL.xapiutil.getObjectType(o)
+    if (type === 'Agent' || type === 'Group')
+      return ADL.xapiutil.getActorIdString(o)
+    else if (type == 'SubStatement') {
+      return getSubStatementDisplay(o)
+    }
+    return 'unknown'
+  }
+
+  ADL.xapiutil.getObjectDisplay = function(o) {
+    if (!o) return 'unknown'
+    let disp = getObjDefName(o) || o.name || o.id
+    if (!disp) {
+      const type = ADL.xapiutil.getObjectType(o)
+      if (type === 'Agent' || type == 'Group')
+        disp = ADL.xapiutil.getActorDisplay(o)
+      else if (type == 'SubStatement') {
+        disp = getSubStatementDisplay(o)
+      }
+    }
+
+    return disp
+  }
+  return ADL.xapiutil
+}

package/src/module/xapi/verbs.js

@@ -0,0 +1,294 @@
+export default {
+  abandoned: {
+    id: 'https://w3id.org/xapi/adl/verbs/abandoned',
+    display: { 'en-US': 'abandoned' }
+  },
+  answered: {
+    id: 'http://adlnet.gov/expapi/verbs/answered',
+    display: {
+      'de-DE': 'beantwortete',
+      'en-US': 'answered',
+      'fr-FR': 'a répondu',
+      'es-ES': 'contestó',
+      'ar-AR': 'أجاب'
+    }
+  },
+  asked: {
+    id: 'http://adlnet.gov/expapi/verbs/asked',
+    display: {
+      'de-DE': 'fragte',
+      'en-US': 'asked',
+      'fr-FR': 'a demandé',
+      'es-ES': 'preguntó',
+      'ar-AR': 'طلب'
+    }
+  },
+  attempted: {
+    id: 'http://adlnet.gov/expapi/verbs/attempted',
+    display: {
+      'de-DE': 'versuchte',
+      'en-US': 'attempted',
+      'fr-FR': 'a essayé',
+      'es-ES': 'intentó',
+      'ar-AR': 'حاول'
+    }
+  },
+  attended: {
+    id: 'http://adlnet.gov/expapi/verbs/attended',
+    display: {
+      'de-DE': 'nahm teil an',
+      'en-US': 'attended',
+      'fr-FR': 'a suivi',
+      'es-ES': 'asistió',
+      'ar-AR': 'حضر'
+    }
+  },
+  commented: {
+    id: 'http://adlnet.gov/expapi/verbs/commented',
+    display: {
+      'de-DE': 'kommentierte',
+      'en-US': 'commented',
+      'fr-FR': 'a commenté',
+      'es-ES': 'comentó',
+      'ar-AR': 'علق'
+    }
+  },
+  completed: {
+    id: 'http://adlnet.gov/expapi/verbs/completed',
+    display: {
+      'de-DE': 'beendete',
+      'en-US': 'completed',
+      'fr-FR': 'a terminé',
+      'es-ES': 'completó',
+      'ar-AR': 'أكمل'
+    }
+  },
+  exited: {
+    id: 'http://adlnet.gov/expapi/verbs/exited',
+    display: {
+      'de-DE': 'verließ',
+      'en-US': 'exited',
+      'fr-FR': 'a quitté',
+      'es-ES': 'salió',
+      'ar-AR': 'خرج'
+    }
+  },
+  experienced: {
+    id: 'http://adlnet.gov/expapi/verbs/experienced',
+    display: {
+      'de-DE': 'erlebte',
+      'en-US': 'experienced',
+      'fr-FR': 'a éprouvé',
+      'es-ES': 'experimentó',
+      'ar-AR': 'شاهد'
+    }
+  },
+  failed: {
+    id: 'http://adlnet.gov/expapi/verbs/failed',
+    display: {
+      'de-DE': 'verfehlte',
+      'en-US': 'failed',
+      'fr-FR': 'a échoué',
+      'es-ES': 'fracasó',
+      'ar-AR': 'فشل'
+    }
+  },
+  imported: {
+    id: 'http://adlnet.gov/expapi/verbs/imported',
+    display: {
+      'de-DE': 'importierte',
+      'en-US': 'imported',
+      'fr-FR': 'a importé',
+      'es-ES': 'importó',
+      'ar-AR': 'مستورد'
+    }
+  },
+  initialized: {
+    id: 'http://adlnet.gov/expapi/verbs/initialized',
+    display: {
+      'de-DE': 'initialisierte',
+      'en-US': 'initialized',
+      'fr-FR': 'a initialisé',
+      'es-ES': 'inicializó',
+      'ar-AR': 'بدأ'
+    }
+  },
+  interacted: {
+    id: 'http://adlnet.gov/expapi/verbs/interacted',
+    display: {
+      'de-DE': 'interagierte',
+      'en-US': 'interacted',
+      'fr-FR': 'a interagi',
+      'es-ES': 'interactuó',
+      'ar-AR': 'تفاعل'
+    }
+  },
+  launched: {
+    id: 'http://adlnet.gov/expapi/verbs/launched',
+    display: {
+      'de-DE': 'startete',
+      'en-US': 'launched',
+      'fr-FR': 'a lancé',
+      'es-ES': 'lanzó',
+      'ar-AR': 'أطلق'
+    }
+  },
+  mastered: {
+    id: 'http://adlnet.gov/expapi/verbs/mastered',
+    display: {
+      'de-DE': 'meisterte',
+      'en-US': 'mastered',
+      'fr-FR': 'a maîtrisé',
+      'es-ES': 'dominó',
+      'ar-AR': 'أتقن'
+    }
+  },
+  passed: {
+    id: 'http://adlnet.gov/expapi/verbs/passed',
+    display: {
+      'de-DE': 'bestand',
+      'en-US': 'passed',
+      'fr-FR': 'a réussi',
+      'es-ES': 'aprobó',
+      'ar-AR': 'نجح'
+    }
+  },
+  played: {
+    id: 'http://adlnet.gov/expapi/verbs/played',
+    display: {
+      'de-DE': '',
+      'en-US': 'played',
+      'fr-FR': 'a joué',
+      'es-ES': '',
+      'ar-AR': ''
+    }
+  },
+  preferred: {
+    id: 'http://adlnet.gov/expapi/verbs/preferred',
+    display: {
+      'de-DE': 'bevorzugte',
+      'en-US': 'preferred',
+      'fr-FR': 'a préféré',
+      'es-ES': 'prefirió',
+      'ar-AR': 'فضل'
+    }
+  },
+  progressed: {
+    id: 'http://adlnet.gov/expapi/verbs/progressed',
+    display: {
+      'de-DE': 'machte Fortschritt mit',
+      'en-US': 'progressed',
+      'fr-FR': 'a progressé',
+      'es-ES': 'progresó',
+      'ar-AR': 'تقدم'
+    }
+  },
+  registered: {
+    id: 'http://adlnet.gov/expapi/verbs/registered',
+    display: {
+      'de-DE': 'registrierte',
+      'en-US': 'registered',
+      'fr-FR': 'a enregistré',
+      'es-ES': 'registró',
+      'ar-AR': 'سجل'
+    }
+  },
+  responded: {
+    id: 'http://adlnet.gov/expapi/verbs/responded',
+    display: {
+      'de-DE': 'reagierte',
+      'en-US': 'responded',
+      'fr-FR': 'a répondu',
+      'es-ES': 'respondió',
+      'ar-AR': 'استجاب'
+    }
+  },
+  resumed: {
+    id: 'http://adlnet.gov/expapi/verbs/resumed',
+    display: {
+      'de-DE': 'setzte fort',
+      'en-US': 'resumed',
+      'fr-FR': 'a repris',
+      'es-ES': 'continuó',
+      'ar-AR': 'استأنف'
+    }
+  },
+  satisfied: {
+    id: 'https://w3id.org/xapi/adl/verbs/satisfied',
+    display: {
+      'de-DE': 'befriedigt',
+      'en-US': 'satisfied',
+      'fr-FR': 'satisfaite',
+      'es-ES': 'satisfecho',
+      'ar-AR': 'راض'
+    }
+  },
+  scored: {
+    id: 'http://adlnet.gov/expapi/verbs/scored',
+    display: {
+      'de-DE': 'erreichte',
+      'en-US': 'scored',
+      'fr-FR': 'a marqué',
+      'es-ES': 'anotó',
+      'ar-AR': 'سحل النقاط'
+    }
+  },
+  shared: {
+    id: 'http://adlnet.gov/expapi/verbs/shared',
+    display: {
+      'de-DE': 'teilte',
+      'en-US': 'shared',
+      'fr-FR': 'a partagé',
+      'es-ES': 'compartió',
+      'ar-AR': 'شارك'
+    }
+  },
+  started: {
+    id: 'http://activitystrea.ms/schema/1.0/start',
+    display: {
+      'en-US': 'started',
+      'fr-FR': 'a débuté',
+      'es-ES': 'empezado'
+    }
+  },
+  suspended: {
+    id: 'http://adlnet.gov/expapi/verbs/suspended',
+    display: {
+      'de-DE': 'pausierte',
+      'en-US': 'suspended',
+      'fr-FR': 'a suspendu',
+      'es-ES': 'aplazó',
+      'ar-AR': 'علق'
+    }
+  },
+  terminated: {
+    id: 'http://adlnet.gov/expapi/verbs/terminated',
+    display: {
+      'de-DE': 'beendete',
+      'en-US': 'terminated',
+      'fr-FR': 'a terminé',
+      'es-ES': 'terminó',
+      'ar-AR': 'أنهى'
+    }
+  },
+  voided: {
+    id: 'http://adlnet.gov/expapi/verbs/voided',
+    display: {
+      'de-DE': 'entwertete',
+      'en-US': 'voided',
+      'fr-FR': 'a annulé',
+      'es-ES': 'anuló',
+      'ar-AR': 'فرغ'
+    }
+  },
+  waived: {
+    id: 'https://w3id.org/xapi/adl/verbs/waived',
+    display: {
+      'de-DE': 'verzichtet',
+      'en-US': 'waived',
+      'fr-FR': 'renoncé',
+      'es-ES': 'renunciado',
+      'ar-AR': 'تخلى'
+    }
+  }
+}