@zzish/sdk-js 0.5.3 → 0.5.6

package/package.json

@@ -1,24 +1,30 @@
 {
-    "name": "@zzish/sdk-js",
-    "version": "0.5.3",
-    "description": "SDK for Zzish API",
-    "main": "zzish.js",
-    "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/zzishdev/zzishsdk-js.git"
-    },
-    "keywords": [
-        "zzish",
-        "api",
-        "sdk"
-    ],
-    "author": "Zzish Developers <developers@zzish.com> (http://www.zzish.com)",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/zzish/zzishsdk-js/issues"
-    },
-    "homepage": "https://github.com/zzish/zzishsdk-js"
+  "name": "@zzish/sdk-js",
+  "version": "0.5.6",
+  "description": "SDK for Zzish API",
+  "main": "zzish.js",
+  "files": [
+    "zzish.js"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zzish/zzishsdk-js.git"
+  },
+  "keywords": [
+    "zzish",
+    "api",
+    "sdk"
+  ],
+  "author": "Zzish Developers <developers@zzish.com> (http://www.zzish.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/zzish/zzishsdk-js/issues"
+  },
+  "homepage": "https://github.com/zzish/zzishsdk-js"
 }

package/zzish.js

@@ -153,20 +153,8 @@
         return originalValue;
     }
 
-    var sendEvent = function(event, callback) {
-        var request = {
-            method: "POST",
-            url: getBaseUrl() + "statements/events",
-            data: {
-                platform : "js",
-                action: "START",
-                appId: appId
-            }
-        };
-        sendData(request, function (err, data) {
-            callCallBack(err, data, callback);
-        });
-    }
+    // REMOVED: sendEvent() function - AppEvents functionality disabled to reduce MongoDB costs
+    // var sendEvent = function(event, callback) { ... } // No longer needed
 
     /**
      * Initialise Zzish instance
@@ -202,7 +190,7 @@
             socketUrl = getConfigValue(config,'socketUrl',socketUrl);
             setDataValue("appConfig",JSON.stringify(config));
         }
-        sendEvent("START");
+        // REMOVED: sendEvent("START") - AppEvents disabled to reduce MongoDB costs
     };
 
 
@@ -211,7 +199,7 @@
      */
     Zzish.stop = function (callback) {
         //generate a device if we don't have one
-        sendEvent("STOP");
+        // REMOVED: sendEvent("STOP") - AppEvents disabled to reduce MongoDB costs
     };
 
     var params = getQueryParams();
@@ -456,7 +444,7 @@
      * @param callback - A callback to be called after message is sent (returns error,message)
      */
     Zzish.startActivityWithObjects = function (userId, parameters, callback) {
-        sendEvent("START_ACTIVITY");
+        // REMOVED: sendEvent("START_ACTIVITY") - AppEvents disabled
         if (!currentUser || !stateful() || userId!=currentUser.id) {
             currentUser = {
                 uuid: userId
@@ -478,7 +466,7 @@
      *
      */
     Zzish.stopActivity = function (activityId, states, callback) {
-        sendEvent("STOP_ACTIVITY");
+        // REMOVED: sendEvent("STOP_ACTIVITY") - AppEvents disabled
         var pro = undefined;
         var haveState = false;
         if (states!=undefined && states.proficiency!=undefined) {
@@ -501,6 +489,30 @@
         }, { states: haveState?stateMap:undefined},callback)
     };
 
+    /**
+     * Stop Activity with full parameters object (preserves activityDefinition)
+     *
+     * @param activityId - The activity id (returned from startActivity) (required)
+     * @param parameters - Object that may contain activityDefinition, states, extensions
+     * @param callback - A callback to be called after message is sent (returns error,message)
+     *
+     * Prefer this over stopActivity({}) so the resulting xAPI Statement carries
+     * object.definition.type. Spring Data 4.x strict mode rejects POST /api/statements
+     * payloads where definition.type is null when the historical ActivityDef
+     * collection contains multiple type=null rows for the app.
+     */
+    Zzish.stopActivityWithObjects = function (activityId, parameters, callback) {
+        var params = parameters || {};
+        sendMessage({
+            verb: "http://activitystrea.ms/schema/1.0/complete",
+            activityUuid: activityId
+        }, {
+            activityDefinition: params.activityDefinition,
+            states: params.states,
+            extensions: params.extensions
+        }, callback);
+    };
+
     /** *  Update an activity instance with images
      *
      * @param activityId - The activity instance id of activity
@@ -526,19 +538,42 @@
      *
      */
     Zzish.cancelActivity = function (activityId, callback) {
-        sendEvent("CANCEL_ACTIVITY");
+        // REMOVED: sendEvent("CANCEL_ACTIVITY") - AppEvents disabled
         sendMessage({
             verb: "http://activitystrea.ms/schema/1.0/cancel",
             activityUuid: activityId
         }, {}, callback)
     };
 
+    /**
+     * Cancel Activity with full parameters object (preserves activityDefinition)
+     *
+     * @param activityId - The activity id (returned from startActivity) (required)
+     * @param parameters - Object that may contain activityDefinition, states, extensions
+     * @param callback - A callback to be called after message is sent (returns error,message)
+     *
+     * Prefer this over cancelActivity() so the resulting xAPI Statement carries
+     * object.definition.type. Same rationale as stopActivityWithObjects.
+     */
+    Zzish.cancelActivityWithObjects = function (activityId, parameters, callback) {
+        var params = parameters || {};
+        sendMessage({
+            verb: "http://activitystrea.ms/schema/1.0/cancel",
+            activityUuid: activityId
+        }, {
+            activityDefinition: params.activityDefinition,
+            states: params.states,
+            extensions: params.extensions
+        }, callback);
+    };
+
     /**
      * Log an Action
      *
      * @param activityId - The activity id (returned from startActivity) (required)
      * @param actionName - The name of the action (required)
      * @param response - A string representation of the action (optional)
+     * @param responseOption - A string representation of the action option, e.g. "A", "B", etc (optional)
      * @param score - A float score (optional)
      * @param duration - A long duration (optional)
      * @param attempts - The number of attempts
@@ -546,7 +581,7 @@
      * @param callback - A callback to be called after message is sent (returns error,message)
      *
      */
-    Zzish.logAction = function (activityId, actionName, response, score, correct, duration, attempts, attributes, callback) {
+    Zzish.logAction = function (activityId, actionName, response, responseOption, score, correct, duration, attempts, attributes, callback) {
         var definition = {
             type: actionName
         };
@@ -554,6 +589,9 @@
         if (response != undefined) {
             result["response"] = response;
         }
+        if (responseOption != undefined) {
+            result["responseOption"] = responseOption;
+        }
         if (score != undefined) {
             result["score"] = parseFloat(score);
         }
@@ -570,7 +608,7 @@
     };
 
     Zzish.logActionWithObjects = function (activityId, parameters, callback) {
-        sendEvent("ACTION");
+        // REMOVED: sendEvent("ACTION") - AppEvents disabled
         if (parameters.definition==undefined) {
             parameters.definition = {};
         }
@@ -599,8 +637,17 @@
         return action;
     }
 
-    Zzish.logActions = function (activityId, parameters, actionObjects, callback) {
-        sendEvent("ACTION");
+    Zzish.logActions = function (activityId, parameters, actionObjects /*, [isComplete], callback */) {
+        // REMOVED: sendEvent("ACTION") - AppEvents disabled
+        // Accept both legacy 4-arg (callback at position 4) and the 5-arg
+        // (isComplete at position 4, callback at position 5) shape that
+        // quiz-player has been calling for years — the 5-arg variant was
+        // silently dropping its callback before this fix.
+        var callback;
+        var lastArg = arguments[arguments.length - 1];
+        if (typeof lastArg === "function") {
+            callback = lastArg;
+        }
         var actions = actionObjects.map(function(action) {
             return createActionObject(action);
         });
@@ -1661,7 +1708,7 @@
 
 
     function loadLoginWithToken(type,params,callback) {
-        sendEvent("LOGIN");
+        // REMOVED: sendEvent("LOGIN") - AppEvents disabled
         var url = webUrl + 'account/applogin?token='+params.token;
         if (type=="pop") {
             var win = window.open(url, 'Zzish Login', 'width=800, height=600');
@@ -1755,7 +1802,7 @@
     };
 
     Zzish.getCurrentUser = function(token,callback) {
-        sendEvent("LAUNCH");
+        // REMOVED: sendEvent("LAUNCH") - AppEvents disabled
         if (token==undefined) {
             //see if we can get token from query params
             token = getQueryParams()["token"];

package/3rdparty.html

@@ -1,87 +0,0 @@
-<!doctype html>
-
-<html lang="en">
-<head>
-  <meta charset="utf-8">
-
-    <title>Zzish Quick Javascript Client SDK</title>
-
-    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
-    <script src="https://code.jquery.com/jquery-1.11.2.min.js"></script>
-
-    <script src="zzish.js"></script>
-    <script>
-        var init = false;
-        var loggedIn = false;
-        var token;
-        var href;
-
-        function initApp() {
-            if (init) return true;
-            if ($("#appId").val()!="") {
-                var initParams = $("#appId").val();
-                Zzish.init(initParams);
-                init = true;
-                console.log("App Initalized with id",$("#appId").val());
-                return true;
-            }
-            else {
-                alert ("Please enter your API KEY from http://www.zzish.co.uk/developer/")
-                return false;
-            }
-        }
-
-        function registerWithZzish() {
-            var uuid = $("#uuid").val();
-            var email = $("#email").val();
-            var name = $("#name").val();
-
-            if (initApp()) {
-                Zzish.registerUserWithZzish(uuid, email, name, function(err, message) {
-                    console.log("Result from register", err, message);
-                });
-            }
-        }
-
-        function loadUser() {
-            if (initApp()) {
-                var uuid = $("#uuid").val();
-                var redirect = $("#redirect").val();
-                Zzish.getTokenForUser(uuid, function(err, url) {
-                    if (err == 400) {
-                        alert("Either the user doesn't exist or the user has not authorized this email")
-                    }
-                    else {
-                        href = url;
-                        console.log("Result from register", err, url);
-                        $("#dashboard").attr("href",url + "/" + redirect);
-                    }
-                });
-            }
-        }
-
-        function updateTarget() {
-            $("#dashboard").attr("href",href + "/" + $("#redirect").val());
-        }
-    </script>
-</head>
-
-<body>
-<input type="text" id="appId" name="appId" placeholder="Your API Key" value="" size="40"/><br/>
-<h1>Login</h1>
-<div id="loginButtons">
-<input type="text" id="uuid" name="uuid" placeholder="UUID (Required)"/><br/>
-<input type="text" id="email" name="email" placeholder="Email (Required)"/><br/>
-<input type="text" id="name" name="name" placeholder="Name (Optional)"/><br/><br/>
-<input type="button" onclick="registerWithZzish()" value="RegisterWithZzish"/><br/><br/>
-<input type="button" onclick="loadUser()" value="LoadUser"/><br/><br/>
-<select id="redirect" onchange="updateTarget()">
-    <option value="">Nothing defaults to home</option>
-    <option value="home">Home</option>
-    <option value="dashboard">Teacher Dashboard</option>
-</select>
-<a id="dashboard" target=_blank>Open Dashboard</a>
-<br/><br/>
-</div>
-</body>
-</html>

package/content.html

@@ -1,162 +0,0 @@
-<!doctype html>
-
-<html lang="en">
-<head>
-  <meta charset="utf-8">
-
-    <title>Zzish Quick Javascript Client SDK</title>
-
-    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
-    <script src="https://code.jquery.com/jquery-1.11.2.min.js"></script>
-
-    <script src="zzish.js"></script>
-    <script>
-        var userId;
-        var init = false;
-
-        function initApp() {
-            if (!init) {
-                if ($("#appId").val()!="") {                    
-                    Zzish.init({
-                        api: $("#appId").val(),
-                        protocol: "http://",
-                        baseUrl: "localhost:8080/zzishapi/api/",
-                        webUrl: "http://localhost:3000/",
-                        header: "X-ApplicationId",
-                        headerprefix: "",
-                        logEnabled: true
-                    });
-                    //Zzish.init($("#appId").val());
-                    init = true;    
-                    console.log("App Initalized with id",$("#appId").val());
-                }
-                else {
-                    alert ("Please enter your API KEY from http://www.zzish.co.uk/developer/")
-                }
-            }
-            return init;
-        }
-
-        function createUser() {
-            if (initApp()) {
-                Zzish.getUser($("#userId").val(),$("#name").val(),function(err,message) {
-                    userId = message.uuid;
-                    console.log("User created with status" + message.uuid);    
-                });
-                
-            }
-        }
-
-        function postContent() {
-            if (initApp()) {            
-                //postContent = function(profileId,id,name,content,callback)
-                var JSON_val = JSON.parse($("#cjson").val());
-                var content = {
-                    uuid: $("#cid").val(),
-                    name: $("#cname").val(),
-                    payload: JSON_val
-                };
-                Zzish.postContent(userId,content,function(err,message) {
-                    console.log("Content created with status" + err);    
-                });
-            }
-        }
-
-        function getContent() {
-            if (initApp()) {                        
-                Zzish.getContent(userId,$("#gcid").val(),function(err,message) {
-                    $("#getContentOutput").html(JSON.stringify(message));
-                });
-            }
-        }
-
-        function listContent() {
-            if (initApp()) {     
-                Zzish.listContent(userId,function(err,message) {
-                    $("#listContentOutput").html(JSON.stringify(message));
-                });
-            }
-        } 
-
-        function deleteContent() {
-            if (initApp()) {     
-                Zzish.deleteContent(userId,$("#dcid").val(),function(err,message) {
-                    console.log("")
-                });
-            }
-        } 
-
-        function publishContent() {
-            if (initApp()) {     
-                Zzish.publishContentToGroup(userId,$("#pemail").val(),$("#pid").val(),$("#pcode").val(),function(err,message) {
-                    $("#publishContentOutput").html(JSON.stringify(message));
-                });
-            }
-            else {
-                alert ("Please init with your APP_ID from http://www.zzish.co.uk/developer/")
-            }
-        }  
-
-        function unpublishContent() {
-            if (initApp()) {     
-                Zzish.unpublishContent(userId,$("#pid").val(),$("#pcode").val(),function(err,message) {
-                    $("#publishContentOutput").html(JSON.stringify(message));
-                });
-            }
-            else {
-                alert ("Please init with your APP_ID from http://www.zzish.co.uk/developer/")
-            }
-        }   
-
-        function republishContent() {
-            if (initApp()) {     
-                Zzish.republishContent(userId,$("#pid").val(),$("#pcode").val(),function(err,message) {
-                    $("#publishContentOutput").html(JSON.stringify(message));
-                });
-            }
-            else {
-                alert ("Please init with your APP_ID from http://www.zzish.co.uk/developer/")
-            }
-        }                 
-    </script>
-</head>
-
-<body>
-<input type="text" id="appId" name="appId" placeholder="Your API Key" value="" size="40"/><br/>
-<h1>Create user</h1>
-<input type="text" id="userId" name="userId" placeholder="userId" value=""/><br/>
-<input type="text" id="name" name="name" placeholder="Name" value=""/><br/>
-<input type="button" onclick="createUser()" value="Create User"/><br/>
-<br/>
-<h1>Create Content</h1>
-<input type="text" id="cid" name="cid" placeholder="Content Id" value=""/><br/>
-<input type="text" id="cname" name="cname" placeholder="Content Name" value=""/><br/>
-<textarea id="cjson" name="cjson" placeholder="Content JSON" rows="10" cols="40"></textarea><br/>
-<input type="button" onclick="postContent()" value="Create Content"/><br/>
-<h1>Get Content</h1>
-<input type="text" id="gcid" name="gcid" placeholder="Content Id" value=""/><br/>
-<input type="button" onclick="getContent()" value="Get Content"/><br/>
-<h2>Output</h2>
-<div id="getContentOutput"></div>
-<br/>
-<h1>List Content</h1>
-<input type="button" onclick="listContent()" value="Get Content"/><br/>
-<h2>Output</h2>
-<div id="listContentOutput"></div>
-<br/>
-<h1>Publish Content</h1>
-<input type="text" id="pid" name="pid" placeholder="Content Id" value=""/><br/>
-<input type="text" id="pemail" name="pemail" placeholder="Email Address of Creator" value=""/><br/>
-<input type="text" id="pcode" name="pcode" placeholder="Group Code" value=""/><br/>
-<input type="button" onclick="publishContent()" value="Publish Content"/><br/>
-<input type="button" onclick="unpublishContent()" value="Unpublish Content"/><br/>
-<input type="button" onclick="republishContent()" value="Republish Content"/><br/>
-<h2>Output</h2>
-<div id="publishContentOutput"></div>
-<h1>Delete Content</h1>
-<input type="text" id="dcid" name="dcid" placeholder="Content Id" value=""/><br/>
-<input type="button" onclick="deleteContent()" value="Delete Content"/><br/>
-<input type="button" onclick="publishContent()" value="Publish Content"/><br/>
-
-</body>
-</html>