fcad-core-dragon 2.0.0-beta.3 → 2.0.0-beta.5

package/src/module/xapi/Statement/index.js

@@ -1,259 +1,259 @@
-import { Agent } from './agent'
-import { Group } from './group'
-import { StatementRef } from './statementRef'
-import { SubStatement } from './substatement'
-import { Activity } from './activity'
-import { Verb } from './verb'
-//import { xapiStatement } from '../xapiStatement'
-
-/*******************************************************************************
- * XAPIStatement - a convenience class to wrap statement objects
- *
- * This sub-API is supposed to make it easier to author valid xAPI statements
- * by adding constructors and encouraging best practices. All objects in this
- * API are fully JSON-compatible, so anything expecting an xAPI statement can
- * take an improved statement and vice versa.
- *
- * A working knowledge of what exactly the LRS expects is still expected,
- * but it's easier to map an 'I did this' statement to xAPI now.
- *
- * Tech note: All constructors also double as shallow clone functions. E.g.
- *
- *   var activity1 = new Activity('A walk in the park');
- *   var activity2 = new Activity(activity1);
- *   var activity3 = new Activity(stmt_from_lrs.object);
- *
- *******************************************************************************/
-
-/*
- * A convenient JSON-compatible xAPI statement wrapper
- * All args are optional, but the statement may not be complete or valid
- * Can also pass an Agent IFI, Verb ID, and an Activity ID in lieu of these args
- * @param {string} [actor]   The Agent or Group committing the action described by the statement
- * @param {string} [verb]   The Verb for the action described by the statement
- * @param {string} [object]   The receiver of the action. An Agent, Group, Activity, SubStatement, or StatementRef
- * @example
- * var stmt = new ADL.XAPIStatement(
- *     'mailto:steve.vergenz.ctr@adlnet.gov',
- *    'http://adlnet.gov/expapi/verbs/launched',
- *    'http://vwf.adlnet.gov/xapi/virtual_world_sandbox'
- * );
- * >> {
- * "actor": {
- *     "objectType": "Agent",
- *     "mbox": "mailto:steve.vergenz.ctr@adlnet.gov" },
- * "verb": {
- *     "id": "http://adlnet.gov/expapi/verbs/launched" },
- * "object": {
- *     "objectType": "Activity",
- *     "id": "http://vwf.adlnet.gov/xapi/virtual_world_sandbox" },
- * "result": {
- *      "An optional property that represents a measured outcome related to the Statement in which it is included."}}
- */
-
-const Statement = function (actor, verb, object, result) {
-  this.Agent = Agent
-  this.Activity = Activity
-  this.Group = Group
-  this.StatementRef = StatementRef
-  this.SubStatement = SubStatement
-  this.Verb = Verb
-
-  // if first arg is an xapi statement, parse
-  if (actor && actor.actor && actor.verb && actor.object) {
-    var stmt = actor
-    for (var i in stmt) {
-      if (i != 'actor' && i != 'verb' && i != 'object') this[i] = stmt[i]
-    }
-    actor = stmt.actor
-    verb = stmt.verb
-    object = stmt.object
-  }
-
-  if (actor) {
-    if (actor instanceof Agent) this.actor = actor
-    else if (actor.objectType === 'Agent' || !actor.objectType)
-      this.actor = new Agent(actor)
-    else if (actor.objectType === 'Group') this.actor = new Group(actor)
-  } else this.actor = null
-
-  if (verb) {
-    if (verb instanceof Verb) this.verb = verb
-    else this.verb = new Verb(verb)
-  } else this.verb = null
-
-  // decide what kind of object was passed
-  if (object) {
-    if (object.objectType === 'Activity' || !object.objectType) {
-      if (object instanceof Activity) this.object = object
-      else this.object = new Activity(object)
-    } else if (object.objectType === 'Agent') {
-      if (object instanceof Agent) this.object = object
-      else this.object = new Agent(object)
-    } else if (object.objectType === 'Group') {
-      if (object instanceof Group) this.object = object
-      else this.object = new Group(object)
-    } else if (object.objectType === 'StatementRef') {
-      if (object instanceof StatementRef) this.object = object
-      else this.object = new StatementRef(object)
-    } else if (object.objectType === 'SubStatement') {
-      if (object instanceof SubStatement) this.object = object
-      else this.object = new SubStatement(object)
-    } else this.object = null
-  } else this.object = null
-
-  // add support for result object
-  if (result) {
-    this.result = result
-  }
-
-  //======================== FUNCTIONS===========================//
-  function _getobj(obj, path) {
-    var parts = path.split('.')
-
-    var part = parts[0]
-    path = parts.slice(1).join('.')
-
-    if (!obj[part]) {
-      if (/\[\]$/.test(part)) {
-        part = part.slice(0, -2)
-        if (!Array.isArray(obj[part])) {
-          obj[part] = []
-        }
-      } else obj[part] = {}
-    }
-
-    if (!path) return obj[part]
-    else return _getobj(obj[part], path)
-  }
-
-  function toString() {
-    return (
-      this.actor.toString() +
-      ' ' +
-      this.verb.toString() +
-      ' ' +
-      this.object.toString() +
-      ' ' +
-      this.result.toString()
-    )
-  }
-
-  function isValid() {
-    return (
-      this.actor &&
-      this.actor.isValid() &&
-      this.verb &&
-      this.verb.isValid() &&
-      this.object &&
-      this.object.isValid() &&
-      this.result &&
-      this.result.isValid()
-    )
-  }
-  function generateRegistration() {
-    this._getobj(this, 'context').registration = ADL.ruuid()
-  }
-
-  function addParentActivity(activity) {
-    this._getobj(this, 'context.contextActivities.parent[]').push(
-      new Activity(activity)
-    )
-  }
-
-  function addGroupingActivity(activity) {
-    this._getobj(this, 'context.contextActivities.grouping[]').push(
-      new Activity(activity)
-    )
-  }
-
-  function addOtherContextActivity(activity) {
-    this._getobj(this, 'context.contextActivities.other[]').push(
-      new Activity(activity)
-    )
-  }
-
-  function generateId() {
-    this.id = ADL.ruuid()
-  }
-
-  function setActor(email, name, objectType) {
-    var actor = {
-      mbox: 'mailto:' + email,
-      name: name,
-      objectType: ''
-    }
-    actor.objectType = objectType || 'Agent'
-
-    this.actor = actor
-  }
-
-  function setVerb(verb) {
-    //this.verb = this.verb[verb]
-    //return this;
-  }
-
-  function setObject(objectId, objectName, objectDescription, objectType) {
-    var object = {
-      id: objectId,
-      definition: {
-        name: {
-          'en-US': objectName,
-          'fr-FR': objectName
-        },
-        description: {
-          'en-US': objectDescription,
-          'fr-FR': objectDescription
-        }
-      },
-      objectType: ''
-    }
-    object.objectType = objectType || 'Activity'
-
-    this.object = object
-  }
-
-  function setResultScore(score, scoreScale, scoreMin, scoreMax) {
-    if (!this.result) this.result = {}
-    this.result.score = {
-      scaled: scoreScale || 1,
-      min: scoreMin,
-      max: scoreMax,
-      raw: score
-    }
-  }
-
-  function setResultKey(key, value) {
-    if (!this.result) this.result = {} //define the result key
-    //define the extra keys of the result
-    if (key == 'success') this.result.success = value
-    else if (key == 'response') this.result.response = value
-    else if (key == 'duration') this.result.duration = value
-    else if (key == 'extensions') this.result.extensions = value
-    else if (key == 'completion') this.result.completion = value
-  }
-
-  function setContextKey(key, value) {
-    if (!this.context) this.context = {}
-    if (key == 'instructor') this.context.instructor = value
-    else if (key == 'contextActivities') this.context.contextActivities = value
-  }
-
-  // customize(key, lang) {
-  //   let lang = lang
-  //   if (key == 'description') {
-  //     //this.
-  //   }
-  // }
-
-  function getStatement() {
-    return this
-  }
-
-  //setContext(key, value) {
-  //  if (key == "context ") return;
-  //  else if (key == " contextActivities") return;
-  //};
-}
-
-export { Statement as xapiStatement }
+import { Agent } from './agent'
+import { Group } from './group'
+import { StatementRef } from './statementRef'
+import { SubStatement } from './substatement'
+import { Activity } from './activity'
+import { Verb } from './verb'
+//import { xapiStatement } from '../xapiStatement'
+
+/*******************************************************************************
+ * XAPIStatement - a convenience class to wrap statement objects
+ *
+ * This sub-API is supposed to make it easier to author valid xAPI statements
+ * by adding constructors and encouraging best practices. All objects in this
+ * API are fully JSON-compatible, so anything expecting an xAPI statement can
+ * take an improved statement and vice versa.
+ *
+ * A working knowledge of what exactly the LRS expects is still expected,
+ * but it's easier to map an 'I did this' statement to xAPI now.
+ *
+ * Tech note: All constructors also double as shallow clone functions. E.g.
+ *
+ *   var activity1 = new Activity('A walk in the park');
+ *   var activity2 = new Activity(activity1);
+ *   var activity3 = new Activity(stmt_from_lrs.object);
+ *
+ *******************************************************************************/
+
+/*
+ * A convenient JSON-compatible xAPI statement wrapper
+ * All args are optional, but the statement may not be complete or valid
+ * Can also pass an Agent IFI, Verb ID, and an Activity ID in lieu of these args
+ * @param {string} [actor]   The Agent or Group committing the action described by the statement
+ * @param {string} [verb]   The Verb for the action described by the statement
+ * @param {string} [object]   The receiver of the action. An Agent, Group, Activity, SubStatement, or StatementRef
+ * @example
+ * var stmt = new ADL.XAPIStatement(
+ *     'mailto:steve.vergenz.ctr@adlnet.gov',
+ *    'http://adlnet.gov/expapi/verbs/launched',
+ *    'http://vwf.adlnet.gov/xapi/virtual_world_sandbox'
+ * );
+ * >> {
+ * "actor": {
+ *     "objectType": "Agent",
+ *     "mbox": "mailto:steve.vergenz.ctr@adlnet.gov" },
+ * "verb": {
+ *     "id": "http://adlnet.gov/expapi/verbs/launched" },
+ * "object": {
+ *     "objectType": "Activity",
+ *     "id": "http://vwf.adlnet.gov/xapi/virtual_world_sandbox" },
+ * "result": {
+ *      "An optional property that represents a measured outcome related to the Statement in which it is included."}}
+ */
+
+const Statement = function (actor, verb, object, result) {
+  this.Agent = Agent
+  this.Activity = Activity
+  this.Group = Group
+  this.StatementRef = StatementRef
+  this.SubStatement = SubStatement
+  this.Verb = Verb
+
+  // if first arg is an xapi statement, parse
+  if (actor && actor.actor && actor.verb && actor.object) {
+    var stmt = actor
+    for (var i in stmt) {
+      if (i != 'actor' && i != 'verb' && i != 'object') this[i] = stmt[i]
+    }
+    actor = stmt.actor
+    verb = stmt.verb
+    object = stmt.object
+  }
+
+  if (actor) {
+    if (actor instanceof Agent) this.actor = actor
+    else if (actor.objectType === 'Agent' || !actor.objectType)
+      this.actor = new Agent(actor)
+    else if (actor.objectType === 'Group') this.actor = new Group(actor)
+  } else this.actor = null
+
+  if (verb) {
+    if (verb instanceof Verb) this.verb = verb
+    else this.verb = new Verb(verb)
+  } else this.verb = null
+
+  // decide what kind of object was passed
+  if (object) {
+    if (object.objectType === 'Activity' || !object.objectType) {
+      if (object instanceof Activity) this.object = object
+      else this.object = new Activity(object)
+    } else if (object.objectType === 'Agent') {
+      if (object instanceof Agent) this.object = object
+      else this.object = new Agent(object)
+    } else if (object.objectType === 'Group') {
+      if (object instanceof Group) this.object = object
+      else this.object = new Group(object)
+    } else if (object.objectType === 'StatementRef') {
+      if (object instanceof StatementRef) this.object = object
+      else this.object = new StatementRef(object)
+    } else if (object.objectType === 'SubStatement') {
+      if (object instanceof SubStatement) this.object = object
+      else this.object = new SubStatement(object)
+    } else this.object = null
+  } else this.object = null
+
+  // add support for result object
+  if (result) {
+    this.result = result
+  }
+
+  //======================== FUNCTIONS===========================//
+  function _getobj(obj, path) {
+    var parts = path.split('.')
+
+    var part = parts[0]
+    path = parts.slice(1).join('.')
+
+    if (!obj[part]) {
+      if (/\[\]$/.test(part)) {
+        part = part.slice(0, -2)
+        if (!Array.isArray(obj[part])) {
+          obj[part] = []
+        }
+      } else obj[part] = {}
+    }
+
+    if (!path) return obj[part]
+    else return _getobj(obj[part], path)
+  }
+
+  function toString() {
+    return (
+      this.actor.toString() +
+      ' ' +
+      this.verb.toString() +
+      ' ' +
+      this.object.toString() +
+      ' ' +
+      this.result.toString()
+    )
+  }
+
+  function isValid() {
+    return (
+      this.actor &&
+      this.actor.isValid() &&
+      this.verb &&
+      this.verb.isValid() &&
+      this.object &&
+      this.object.isValid() &&
+      this.result &&
+      this.result.isValid()
+    )
+  }
+  function generateRegistration() {
+    this._getobj(this, 'context').registration = ADL.ruuid()
+  }
+
+  function addParentActivity(activity) {
+    this._getobj(this, 'context.contextActivities.parent[]').push(
+      new Activity(activity)
+    )
+  }
+
+  function addGroupingActivity(activity) {
+    this._getobj(this, 'context.contextActivities.grouping[]').push(
+      new Activity(activity)
+    )
+  }
+
+  function addOtherContextActivity(activity) {
+    this._getobj(this, 'context.contextActivities.other[]').push(
+      new Activity(activity)
+    )
+  }
+
+  function generateId() {
+    this.id = ADL.ruuid()
+  }
+
+  function setActor(email, name, objectType) {
+    var actor = {
+      mbox: 'mailto:' + email,
+      name: name,
+      objectType: ''
+    }
+    actor.objectType = objectType || 'Agent'
+
+    this.actor = actor
+  }
+
+  function setVerb(verb) {
+    //this.verb = this.verb[verb]
+    //return this;
+  }
+
+  function setObject(objectId, objectName, objectDescription, objectType) {
+    var object = {
+      id: objectId,
+      definition: {
+        name: {
+          'en-US': objectName,
+          'fr-FR': objectName
+        },
+        description: {
+          'en-US': objectDescription,
+          'fr-FR': objectDescription
+        }
+      },
+      objectType: ''
+    }
+    object.objectType = objectType || 'Activity'
+
+    this.object = object
+  }
+
+  function setResultScore(score, scoreScale, scoreMin, scoreMax) {
+    if (!this.result) this.result = {}
+    this.result.score = {
+      scaled: scoreScale || 1,
+      min: scoreMin,
+      max: scoreMax,
+      raw: score
+    }
+  }
+
+  function setResultKey(key, value) {
+    if (!this.result) this.result = {} //define the result key
+    //define the extra keys of the result
+    if (key == 'success') this.result.success = value
+    else if (key == 'response') this.result.response = value
+    else if (key == 'duration') this.result.duration = value
+    else if (key == 'extensions') this.result.extensions = value
+    else if (key == 'completion') this.result.completion = value
+  }
+
+  function setContextKey(key, value) {
+    if (!this.context) this.context = {}
+    if (key == 'instructor') this.context.instructor = value
+    else if (key == 'contextActivities') this.context.contextActivities = value
+  }
+
+  // customize(key, lang) {
+  //   let lang = lang
+  //   if (key == 'description') {
+  //     //this.
+  //   }
+  // }
+
+  function getStatement() {
+    return this
+  }
+
+  //setContext(key, value) {
+  //  if (key == "context ") return;
+  //  else if (key == " contextActivities") return;
+  //};
+}
+
+export { Statement as xapiStatement }